sink.text.pretty: remove field filtering
[babeltrace.git] / src / plugins / text / pretty / print.c
1 /*
2 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
3 * Copyright 2016 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 *
5 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
6 *
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 * SOFTWARE.
24 */
25
26 #include <babeltrace2/babeltrace.h>
27 #include "compat/bitfield.h"
28 #include "common/common.h"
29 #include "common/uuid.h"
30 #include "compat/time.h"
31 #include "common/assert.h"
32 #include <inttypes.h>
33 #include <ctype.h>
34 #include <string.h>
35 #include "pretty.h"
36
37 #define NSEC_PER_SEC 1000000000LL
38
39 #define COLOR_NAME BT_COMMON_COLOR_BOLD
40 #define COLOR_FIELD_NAME BT_COMMON_COLOR_FG_CYAN
41 #define COLOR_RST BT_COMMON_COLOR_RESET
42 #define COLOR_STRING_VALUE BT_COMMON_COLOR_BOLD
43 #define COLOR_NUMBER_VALUE BT_COMMON_COLOR_BOLD
44 #define COLOR_ENUM_MAPPING_NAME BT_COMMON_COLOR_BOLD
45 #define COLOR_UNKNOWN BT_COMMON_COLOR_BOLD BT_COMMON_COLOR_FG_RED
46 #define COLOR_EVENT_NAME BT_COMMON_COLOR_BOLD BT_COMMON_COLOR_FG_MAGENTA
47 #define COLOR_TIMESTAMP BT_COMMON_COLOR_BOLD BT_COMMON_COLOR_FG_YELLOW
48
49 struct timestamp {
50 int64_t real_timestamp; /* Relative to UNIX epoch. */
51 uint64_t clock_snapshot; /* In cycles. */
52 };
53
54 static
55 int print_field(struct pretty_component *pretty,
56 const bt_field *field, bool print_names);
57
58 static
59 void print_name_equal(struct pretty_component *pretty, const char *name)
60 {
61 if (pretty->use_colors) {
62 g_string_append(pretty->string, COLOR_NAME);
63 g_string_append(pretty->string, name);
64 g_string_append(pretty->string, COLOR_RST);
65 } else {
66 g_string_append(pretty->string, name);
67 }
68 g_string_append(pretty->string, " = ");
69 }
70
71 static
72 void print_field_name_equal(struct pretty_component *pretty, const char *name)
73 {
74 if (pretty->use_colors) {
75 g_string_append(pretty->string, COLOR_FIELD_NAME);
76 g_string_append(pretty->string, name);
77 g_string_append(pretty->string, COLOR_RST);
78 } else {
79 g_string_append(pretty->string, name);
80 }
81 g_string_append(pretty->string, " = ");
82 }
83
84 static
85 void print_timestamp_cycles(struct pretty_component *pretty,
86 const bt_clock_snapshot *clock_snapshot, bool update_last)
87 {
88 uint64_t cycles;
89
90 cycles = bt_clock_snapshot_get_value(clock_snapshot);
91 bt_common_g_string_append_printf(pretty->string, "%020" PRIu64, cycles);
92
93 if (update_last) {
94 if (pretty->last_cycles_timestamp != -1ULL) {
95 pretty->delta_cycles = cycles - pretty->last_cycles_timestamp;
96 }
97
98 pretty->last_cycles_timestamp = cycles;
99 }
100 }
101
102 static
103 void print_timestamp_wall(struct pretty_component *pretty,
104 const bt_clock_snapshot *clock_snapshot, bool update_last)
105 {
106 int ret;
107 int64_t ts_nsec = 0; /* add configurable offset */
108 int64_t ts_sec = 0; /* add configurable offset */
109 uint64_t ts_sec_abs, ts_nsec_abs;
110 bool is_negative;
111
112 if (!clock_snapshot) {
113 g_string_append(pretty->string, "??:??:??.?????????");
114 return;
115 }
116
117 ret = bt_clock_snapshot_get_ns_from_origin(clock_snapshot, &ts_nsec);
118 if (ret) {
119 // TODO: log, this is unexpected
120 g_string_append(pretty->string, "Error");
121 return;
122 }
123
124 if (update_last) {
125 if (pretty->last_real_timestamp != -1ULL) {
126 pretty->delta_real_timestamp = ts_nsec - pretty->last_real_timestamp;
127 }
128
129 pretty->last_real_timestamp = ts_nsec;
130 }
131
132 ts_sec += ts_nsec / NSEC_PER_SEC;
133 ts_nsec = ts_nsec % NSEC_PER_SEC;
134
135 if (ts_sec >= 0 && ts_nsec >= 0) {
136 is_negative = false;
137 ts_sec_abs = ts_sec;
138 ts_nsec_abs = ts_nsec;
139 } else if (ts_sec > 0 && ts_nsec < 0) {
140 is_negative = false;
141 ts_sec_abs = ts_sec - 1;
142 ts_nsec_abs = NSEC_PER_SEC + ts_nsec;
143 } else if (ts_sec == 0 && ts_nsec < 0) {
144 is_negative = true;
145 ts_sec_abs = ts_sec;
146 ts_nsec_abs = -ts_nsec;
147 } else if (ts_sec < 0 && ts_nsec > 0) {
148 is_negative = true;
149 ts_sec_abs = -(ts_sec + 1);
150 ts_nsec_abs = NSEC_PER_SEC - ts_nsec;
151 } else if (ts_sec < 0 && ts_nsec == 0) {
152 is_negative = true;
153 ts_sec_abs = -ts_sec;
154 ts_nsec_abs = ts_nsec;
155 } else { /* (ts_sec < 0 && ts_nsec < 0) */
156 is_negative = true;
157 ts_sec_abs = -ts_sec;
158 ts_nsec_abs = -ts_nsec;
159 }
160
161 if (!pretty->options.clock_seconds) {
162 struct tm tm;
163 time_t time_s = (time_t) ts_sec_abs;
164
165 if (is_negative && !pretty->negative_timestamp_warning_done) {
166 // TODO: log instead
167 fprintf(stderr, "[warning] Fallback to [sec.ns] to print negative time value. Use --clock-seconds.\n");
168 pretty->negative_timestamp_warning_done = true;
169 goto seconds;
170 }
171
172 if (!pretty->options.clock_gmt) {
173 struct tm *res;
174
175 res = bt_localtime_r(&time_s, &tm);
176 if (!res) {
177 // TODO: log instead
178 fprintf(stderr, "[warning] Unable to get localtime.\n");
179 goto seconds;
180 }
181 } else {
182 struct tm *res;
183
184 res = bt_gmtime_r(&time_s, &tm);
185 if (!res) {
186 // TODO: log instead
187 fprintf(stderr, "[warning] Unable to get gmtime.\n");
188 goto seconds;
189 }
190 }
191 if (pretty->options.clock_date) {
192 char timestr[26];
193 size_t res;
194
195 /* Print date and time */
196 res = strftime(timestr, sizeof(timestr),
197 "%Y-%m-%d ", &tm);
198 if (!res) {
199 // TODO: log instead
200 fprintf(stderr, "[warning] Unable to print ascii time.\n");
201 goto seconds;
202 }
203
204 g_string_append(pretty->string, timestr);
205 }
206
207 /* Print time in HH:MM:SS.ns */
208 bt_common_g_string_append_printf(pretty->string,
209 "%02d:%02d:%02d.%09" PRIu64, tm.tm_hour, tm.tm_min,
210 tm.tm_sec, ts_nsec_abs);
211 goto end;
212 }
213 seconds:
214 bt_common_g_string_append_printf(pretty->string, "%s%" PRId64 ".%09" PRIu64,
215 is_negative ? "-" : "", ts_sec_abs, ts_nsec_abs);
216 end:
217 return;
218 }
219
220 static
221 int print_event_timestamp(struct pretty_component *pretty,
222 const bt_message *event_msg, bool *start_line)
223 {
224 bool print_names = pretty->options.print_header_field_names;
225 int ret = 0;
226 const bt_clock_snapshot *clock_snapshot = NULL;
227
228 if (!bt_message_event_borrow_stream_class_default_clock_class_const(
229 event_msg)) {
230 /* No default clock class: skip the timestamp without an error */
231 goto end;
232 }
233
234 clock_snapshot = bt_message_event_borrow_default_clock_snapshot_const(event_msg);
235
236 if (print_names) {
237 print_name_equal(pretty, "timestamp");
238 } else {
239 g_string_append(pretty->string, "[");
240 }
241 if (pretty->use_colors) {
242 g_string_append(pretty->string, COLOR_TIMESTAMP);
243 }
244 if (pretty->options.print_timestamp_cycles) {
245 print_timestamp_cycles(pretty, clock_snapshot, true);
246 } else {
247 print_timestamp_wall(pretty, clock_snapshot, true);
248 }
249 if (pretty->use_colors) {
250 g_string_append(pretty->string, COLOR_RST);
251 }
252
253 if (!print_names)
254 g_string_append(pretty->string, "] ");
255
256 if (pretty->options.print_delta_field) {
257 if (print_names) {
258 g_string_append(pretty->string, ", ");
259 print_name_equal(pretty, "delta");
260 } else {
261 g_string_append(pretty->string, "(");
262 }
263 if (pretty->options.print_timestamp_cycles) {
264 if (pretty->delta_cycles == -1ULL) {
265 g_string_append(pretty->string,
266 "+??????????\?\?"); /* Not a trigraph. */
267 } else {
268 bt_common_g_string_append_printf(pretty->string,
269 "+%012" PRIu64, pretty->delta_cycles);
270 }
271 } else {
272 if (pretty->delta_real_timestamp != -1ULL) {
273 uint64_t delta_sec, delta_nsec, delta;
274
275 delta = pretty->delta_real_timestamp;
276 delta_sec = delta / NSEC_PER_SEC;
277 delta_nsec = delta % NSEC_PER_SEC;
278 bt_common_g_string_append_printf(pretty->string,
279 "+%" PRIu64 ".%09" PRIu64,
280 delta_sec, delta_nsec);
281 } else {
282 g_string_append(pretty->string, "+?.?????????");
283 }
284 }
285 if (!print_names) {
286 g_string_append(pretty->string, ") ");
287 }
288 }
289 *start_line = !print_names;
290
291 end:
292 return ret;
293 }
294
295 static
296 int print_event_header(struct pretty_component *pretty,
297 const bt_message *event_msg)
298 {
299 bool print_names = pretty->options.print_header_field_names;
300 int ret = 0;
301 const bt_event_class *event_class = NULL;
302 const bt_stream *stream = NULL;
303 const bt_trace *trace = NULL;
304 const bt_event *event = bt_message_event_borrow_event_const(event_msg);
305 const char *ev_name;
306 int dom_print = 0;
307 bt_property_availability prop_avail;
308
309 event_class = bt_event_borrow_class_const(event);
310 stream = bt_event_borrow_stream_const(event);
311 trace = bt_stream_borrow_trace_const(stream);
312 ret = print_event_timestamp(pretty, event_msg, &pretty->start_line);
313 if (ret) {
314 goto end;
315 }
316 if (pretty->options.print_trace_field) {
317 const char *name;
318
319 name = bt_trace_get_name(trace);
320 if (name) {
321 if (!pretty->start_line) {
322 g_string_append(pretty->string, ", ");
323 }
324 if (print_names) {
325 print_name_equal(pretty, "trace");
326 }
327
328 g_string_append(pretty->string, name);
329
330 if (print_names) {
331 g_string_append(pretty->string, ", ");
332 }
333 }
334 }
335 if (pretty->options.print_trace_hostname_field) {
336 const bt_value *hostname_str;
337
338 hostname_str = bt_trace_borrow_environment_entry_value_by_name_const(
339 trace, "hostname");
340 if (hostname_str) {
341 const char *str;
342
343 if (!pretty->start_line) {
344 g_string_append(pretty->string, ", ");
345 }
346 if (print_names) {
347 print_name_equal(pretty, "trace:hostname");
348 }
349 str = bt_value_string_get(hostname_str);
350 g_string_append(pretty->string, str);
351 dom_print = 1;
352 }
353 }
354 if (pretty->options.print_trace_domain_field) {
355 const bt_value *domain_str;
356
357 domain_str = bt_trace_borrow_environment_entry_value_by_name_const(
358 trace, "domain");
359 if (domain_str) {
360 const char *str;
361
362 if (!pretty->start_line) {
363 g_string_append(pretty->string, ", ");
364 }
365 if (print_names) {
366 print_name_equal(pretty, "trace:domain");
367 } else if (dom_print) {
368 g_string_append(pretty->string, ":");
369 }
370 str = bt_value_string_get(domain_str);
371 g_string_append(pretty->string, str);
372 dom_print = 1;
373 }
374 }
375 if (pretty->options.print_trace_procname_field) {
376 const bt_value *procname_str;
377
378 procname_str = bt_trace_borrow_environment_entry_value_by_name_const(
379 trace, "procname");
380 if (procname_str) {
381 const char *str;
382
383 if (!pretty->start_line) {
384 g_string_append(pretty->string, ", ");
385 }
386 if (print_names) {
387 print_name_equal(pretty, "trace:procname");
388 } else if (dom_print) {
389 g_string_append(pretty->string, ":");
390 }
391 str = bt_value_string_get(procname_str);
392 g_string_append(pretty->string, str);
393 dom_print = 1;
394 }
395 }
396 if (pretty->options.print_trace_vpid_field) {
397 const bt_value *vpid_value;
398
399 vpid_value = bt_trace_borrow_environment_entry_value_by_name_const(
400 trace, "vpid");
401 if (vpid_value) {
402 int64_t value;
403
404 if (!pretty->start_line) {
405 g_string_append(pretty->string, ", ");
406 }
407 if (print_names) {
408 print_name_equal(pretty, "trace:vpid");
409 } else if (dom_print) {
410 g_string_append(pretty->string, ":");
411 }
412 value = bt_value_integer_signed_get(vpid_value);
413 bt_common_g_string_append_printf(pretty->string,
414 "(%" PRId64 ")", value);
415 dom_print = 1;
416 }
417 }
418 if (pretty->options.print_loglevel_field) {
419 static const char *log_level_names[] = {
420 [ BT_EVENT_CLASS_LOG_LEVEL_EMERGENCY ] = "TRACE_EMERG",
421 [ BT_EVENT_CLASS_LOG_LEVEL_ALERT ] = "TRACE_ALERT",
422 [ BT_EVENT_CLASS_LOG_LEVEL_CRITICAL ] = "TRACE_CRIT",
423 [ BT_EVENT_CLASS_LOG_LEVEL_ERROR ] = "TRACE_ERR",
424 [ BT_EVENT_CLASS_LOG_LEVEL_WARNING ] = "TRACE_WARNING",
425 [ BT_EVENT_CLASS_LOG_LEVEL_NOTICE ] = "TRACE_NOTICE",
426 [ BT_EVENT_CLASS_LOG_LEVEL_INFO ] = "TRACE_INFO",
427 [ BT_EVENT_CLASS_LOG_LEVEL_DEBUG_SYSTEM ] = "TRACE_DEBUG_SYSTEM",
428 [ BT_EVENT_CLASS_LOG_LEVEL_DEBUG_PROGRAM ] = "TRACE_DEBUG_PROGRAM",
429 [ BT_EVENT_CLASS_LOG_LEVEL_DEBUG_PROCESS ] = "TRACE_DEBUG_PROCESS",
430 [ BT_EVENT_CLASS_LOG_LEVEL_DEBUG_MODULE ] = "TRACE_DEBUG_MODULE",
431 [ BT_EVENT_CLASS_LOG_LEVEL_DEBUG_UNIT ] = "TRACE_DEBUG_UNIT",
432 [ BT_EVENT_CLASS_LOG_LEVEL_DEBUG_FUNCTION ] = "TRACE_DEBUG_FUNCTION",
433 [ BT_EVENT_CLASS_LOG_LEVEL_DEBUG_LINE ] = "TRACE_DEBUG_LINE",
434 [ BT_EVENT_CLASS_LOG_LEVEL_DEBUG ] = "TRACE_DEBUG",
435 };
436 bt_event_class_log_level log_level;
437 const char *log_level_str = NULL;
438
439 prop_avail = bt_event_class_get_log_level(event_class,
440 &log_level);
441 if (prop_avail == BT_PROPERTY_AVAILABILITY_AVAILABLE) {
442 log_level_str = log_level_names[log_level];
443 BT_ASSERT(log_level_str);
444
445 if (!pretty->start_line) {
446 g_string_append(pretty->string, ", ");
447 }
448 if (print_names) {
449 print_name_equal(pretty, "loglevel");
450 } else if (dom_print) {
451 g_string_append(pretty->string, ":");
452 }
453
454 g_string_append(pretty->string, log_level_str);
455 bt_common_g_string_append_printf(
456 pretty->string, " (%d)", (int) log_level);
457 dom_print = 1;
458 }
459 }
460 if (pretty->options.print_emf_field) {
461 const char *uri_str;
462
463 uri_str = bt_event_class_get_emf_uri(event_class);
464 if (uri_str) {
465 if (!pretty->start_line) {
466 g_string_append(pretty->string, ", ");
467 }
468 if (print_names) {
469 print_name_equal(pretty, "model.emf.uri");
470 } else if (dom_print) {
471 g_string_append(pretty->string, ":");
472 }
473
474 g_string_append(pretty->string, uri_str);
475 dom_print = 1;
476 }
477 }
478 if (dom_print && !print_names) {
479 g_string_append(pretty->string, " ");
480 }
481 if (!pretty->start_line) {
482 g_string_append(pretty->string, ", ");
483 }
484 pretty->start_line = true;
485 if (print_names) {
486 print_name_equal(pretty, "name");
487 }
488 ev_name = bt_event_class_get_name(event_class);
489 if (pretty->use_colors) {
490 if (ev_name) {
491 g_string_append(pretty->string, COLOR_EVENT_NAME);
492 } else {
493 g_string_append(pretty->string, COLOR_UNKNOWN);
494 }
495 }
496 if (ev_name) {
497 g_string_append(pretty->string, ev_name);
498 } else {
499 g_string_append(pretty->string, "<unknown>");
500 }
501 if (pretty->use_colors) {
502 g_string_append(pretty->string, COLOR_RST);
503 }
504 if (!print_names) {
505 g_string_append(pretty->string, ": ");
506 } else {
507 g_string_append(pretty->string, ", ");
508 }
509
510 end:
511 return ret;
512 }
513
514 static
515 int print_integer(struct pretty_component *pretty,
516 const bt_field *field)
517 {
518 int ret = 0;
519 bt_field_class_integer_preferred_display_base base;
520 const bt_field_class *int_fc;
521 union {
522 uint64_t u;
523 int64_t s;
524 } v;
525 bool rst_color = false;
526 bt_field_class_type ft_type;
527
528 int_fc = bt_field_borrow_class_const(field);
529 BT_ASSERT(int_fc);
530 ft_type = bt_field_get_class_type(field);
531 if (ft_type == BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER ||
532 ft_type == BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION) {
533 v.u = bt_field_integer_unsigned_get_value(field);
534 } else {
535 v.s = bt_field_integer_signed_get_value(field);
536 }
537
538 if (pretty->use_colors) {
539 g_string_append(pretty->string, COLOR_NUMBER_VALUE);
540 rst_color = true;
541 }
542
543 base = bt_field_class_integer_get_preferred_display_base(int_fc);
544 switch (base) {
545 case BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY:
546 {
547 int bitnr, len;
548
549 len = bt_field_class_integer_get_field_value_range(int_fc);
550 g_string_append(pretty->string, "0b");
551 _bt_safe_lshift(v.u, 64 - len);
552 for (bitnr = 0; bitnr < len; bitnr++) {
553 bt_common_g_string_append_printf(pretty->string, "%u", (v.u & (1ULL << 63)) ? 1 : 0);
554 _bt_safe_lshift(v.u, 1);
555 }
556 break;
557 }
558 case BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL:
559 {
560 if (ft_type == BT_FIELD_CLASS_TYPE_SIGNED_INTEGER ||
561 ft_type == BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION) {
562 int len;
563
564 len = bt_field_class_integer_get_field_value_range(
565 int_fc);
566 if (len < 64) {
567 size_t rounded_len;
568
569 BT_ASSERT(len != 0);
570 /* Round length to the nearest 3-bit */
571 rounded_len = (((len - 1) / 3) + 1) * 3;
572 v.u &= ((uint64_t) 1 << rounded_len) - 1;
573 }
574 }
575
576 bt_common_g_string_append_printf(pretty->string, "0%" PRIo64, v.u);
577 break;
578 }
579 case BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL:
580 if (ft_type == BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER ||
581 ft_type == BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION) {
582 bt_common_g_string_append_printf(pretty->string, "%" PRIu64, v.u);
583 } else {
584 bt_common_g_string_append_printf(pretty->string, "%" PRId64, v.s);
585 }
586 break;
587 case BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL:
588 {
589 int len;
590
591 len = bt_field_class_integer_get_field_value_range(int_fc);
592 if (len < 64) {
593 /* Round length to the nearest nibble */
594 uint8_t rounded_len = ((len + 3) & ~0x3);
595
596 v.u &= ((uint64_t) 1 << rounded_len) - 1;
597 }
598
599 bt_common_g_string_append_printf(pretty->string, "0x%" PRIX64, v.u);
600 break;
601 }
602 default:
603 ret = -1;
604 goto end;
605 }
606 end:
607 if (rst_color) {
608 g_string_append(pretty->string, COLOR_RST);
609 }
610 return ret;
611 }
612
613 static
614 void print_escape_string(struct pretty_component *pretty, const char *str)
615 {
616 int i;
617
618 g_string_append_c(pretty->string, '"');
619
620 for (i = 0; i < strlen(str); i++) {
621 /* Escape sequences not recognized by iscntrl(). */
622 switch (str[i]) {
623 case '\\':
624 g_string_append(pretty->string, "\\\\");
625 continue;
626 case '\'':
627 g_string_append(pretty->string, "\\\'");
628 continue;
629 case '\"':
630 g_string_append(pretty->string, "\\\"");
631 continue;
632 case '\?':
633 g_string_append(pretty->string, "\\\?");
634 continue;
635 }
636
637 /* Standard characters. */
638 if (!iscntrl(str[i])) {
639 g_string_append_c(pretty->string, str[i]);
640 continue;
641 }
642
643 switch (str[i]) {
644 case '\0':
645 g_string_append(pretty->string, "\\0");
646 break;
647 case '\a':
648 g_string_append(pretty->string, "\\a");
649 break;
650 case '\b':
651 g_string_append(pretty->string, "\\b");
652 break;
653 case '\e':
654 g_string_append(pretty->string, "\\e");
655 break;
656 case '\f':
657 g_string_append(pretty->string, "\\f");
658 break;
659 case '\n':
660 g_string_append(pretty->string, "\\n");
661 break;
662 case '\r':
663 g_string_append(pretty->string, "\\r");
664 break;
665 case '\t':
666 g_string_append(pretty->string, "\\t");
667 break;
668 case '\v':
669 g_string_append(pretty->string, "\\v");
670 break;
671 default:
672 /* Unhandled control-sequence, print as hex. */
673 bt_common_g_string_append_printf(pretty->string, "\\x%02x", str[i]);
674 break;
675 }
676 }
677
678 g_string_append_c(pretty->string, '"');
679 }
680
681 static
682 int print_enum(struct pretty_component *pretty,
683 const bt_field *field)
684 {
685 int ret = 0;
686 const bt_field_class *enumeration_field_class = NULL;
687 bt_field_class_enumeration_mapping_label_array label_array;
688 uint64_t label_count;
689 uint64_t i;
690
691 enumeration_field_class = bt_field_borrow_class_const(field);
692 if (!enumeration_field_class) {
693 ret = -1;
694 goto end;
695 }
696
697 switch (bt_field_get_class_type(field)) {
698 case BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION:
699 ret = bt_field_enumeration_unsigned_get_mapping_labels(field,
700 &label_array, &label_count);
701 break;
702 case BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION:
703 ret = bt_field_enumeration_signed_get_mapping_labels(field,
704 &label_array, &label_count);
705 break;
706 default:
707 abort();
708 }
709
710 if (ret) {
711 ret = -1;
712 goto end;
713 }
714
715 g_string_append(pretty->string, "( ");
716 if (label_count == 0) {
717 if (pretty->use_colors) {
718 g_string_append(pretty->string, COLOR_UNKNOWN);
719 }
720 g_string_append(pretty->string, "<unknown>");
721 if (pretty->use_colors) {
722 g_string_append(pretty->string, COLOR_RST);
723 }
724 goto skip_loop;
725 }
726 for (i = 0; i < label_count; i++) {
727 const char *mapping_name = label_array[i];
728
729 if (i != 0) {
730 g_string_append(pretty->string, ", ");
731 }
732 if (pretty->use_colors) {
733 g_string_append(pretty->string, COLOR_ENUM_MAPPING_NAME);
734 }
735 print_escape_string(pretty, mapping_name);
736 if (pretty->use_colors) {
737 g_string_append(pretty->string, COLOR_RST);
738 }
739 }
740 skip_loop:
741 g_string_append(pretty->string, " : container = ");
742 ret = print_integer(pretty, field);
743 if (ret != 0) {
744 goto end;
745 }
746 g_string_append(pretty->string, " )");
747 end:
748 return ret;
749 }
750
751 static
752 int print_struct_field(struct pretty_component *pretty,
753 const bt_field *_struct,
754 const bt_field_class *struct_class,
755 uint64_t i, bool print_names, uint64_t *nr_printed_fields)
756 {
757 int ret = 0;
758 const char *field_name;
759 const bt_field *field = NULL;
760 const bt_field_class_structure_member *member;
761
762 field = bt_field_structure_borrow_member_field_by_index_const(_struct, i);
763 if (!field) {
764 ret = -1;
765 goto end;
766 }
767
768 member = bt_field_class_structure_borrow_member_by_index_const(
769 struct_class, i);
770 field_name = bt_field_class_structure_member_get_name(member);
771
772 if (*nr_printed_fields > 0) {
773 g_string_append(pretty->string, ", ");
774 } else {
775 g_string_append(pretty->string, " ");
776 }
777 if (print_names) {
778 print_field_name_equal(pretty, field_name);
779 }
780 ret = print_field(pretty, field, print_names);
781 *nr_printed_fields += 1;
782
783 end:
784 return ret;
785 }
786
787 static
788 int print_struct(struct pretty_component *pretty,
789 const bt_field *_struct, bool print_names)
790 {
791 int ret = 0;
792 const bt_field_class *struct_class = NULL;
793 uint64_t nr_fields, i, nr_printed_fields;
794
795 struct_class = bt_field_borrow_class_const(_struct);
796 if (!struct_class) {
797 ret = -1;
798 goto end;
799 }
800
801 nr_fields = bt_field_class_structure_get_member_count(struct_class);
802
803 g_string_append(pretty->string, "{");
804 pretty->depth++;
805 nr_printed_fields = 0;
806 for (i = 0; i < nr_fields; i++) {
807 ret = print_struct_field(pretty, _struct, struct_class, i,
808 print_names, &nr_printed_fields);
809 if (ret != 0) {
810 goto end;
811 }
812 }
813 pretty->depth--;
814 g_string_append(pretty->string, " }");
815
816 end:
817 return ret;
818 }
819
820 static
821 int print_array_field(struct pretty_component *pretty,
822 const bt_field *array, uint64_t i, bool print_names)
823 {
824 const bt_field *field = NULL;
825
826 if (i != 0) {
827 g_string_append(pretty->string, ", ");
828 } else {
829 g_string_append(pretty->string, " ");
830 }
831 if (print_names) {
832 bt_common_g_string_append_printf(pretty->string, "[%" PRIu64 "] = ", i);
833 }
834
835 field = bt_field_array_borrow_element_field_by_index_const(array, i);
836 BT_ASSERT(field);
837 return print_field(pretty, field, print_names);
838 }
839
840 static
841 int print_array(struct pretty_component *pretty,
842 const bt_field *array, bool print_names)
843 {
844 int ret = 0;
845 const bt_field_class *array_class = NULL;
846 uint64_t len;
847 uint64_t i;
848
849 array_class = bt_field_borrow_class_const(array);
850 if (!array_class) {
851 ret = -1;
852 goto end;
853 }
854 len = bt_field_array_get_length(array);
855 g_string_append(pretty->string, "[");
856 pretty->depth++;
857 for (i = 0; i < len; i++) {
858 ret = print_array_field(pretty, array, i, print_names);
859 if (ret != 0) {
860 goto end;
861 }
862 }
863 pretty->depth--;
864 g_string_append(pretty->string, " ]");
865
866 end:
867 return ret;
868 }
869
870 static
871 int print_sequence_field(struct pretty_component *pretty,
872 const bt_field *seq, uint64_t i, bool print_names)
873 {
874 const bt_field *field = NULL;
875
876 if (i != 0) {
877 g_string_append(pretty->string, ", ");
878 } else {
879 g_string_append(pretty->string, " ");
880 }
881 if (print_names) {
882 bt_common_g_string_append_printf(pretty->string, "[%" PRIu64 "] = ", i);
883 }
884
885 field = bt_field_array_borrow_element_field_by_index_const(seq, i);
886 BT_ASSERT(field);
887 return print_field(pretty, field, print_names);
888 }
889
890 static
891 int print_sequence(struct pretty_component *pretty,
892 const bt_field *seq, bool print_names)
893 {
894 int ret = 0;
895 uint64_t len;
896 uint64_t i;
897
898 len = bt_field_array_get_length(seq);
899 g_string_append(pretty->string, "[");
900
901 pretty->depth++;
902 for (i = 0; i < len; i++) {
903 ret = print_sequence_field(pretty, seq, i, print_names);
904 if (ret != 0) {
905 goto end;
906 }
907 }
908 pretty->depth--;
909 g_string_append(pretty->string, " ]");
910
911 end:
912 return ret;
913 }
914
915 static
916 int print_variant(struct pretty_component *pretty,
917 const bt_field *variant, bool print_names)
918 {
919 int ret = 0;
920 const bt_field *field = NULL;
921
922 field = bt_field_variant_borrow_selected_option_field_const(variant);
923 BT_ASSERT(field);
924 g_string_append(pretty->string, "{ ");
925 pretty->depth++;
926 if (print_names) {
927 // TODO: find tag's name using field path
928 // print_field_name_equal(pretty, tag_choice);
929 }
930 ret = print_field(pretty, field, print_names);
931 if (ret != 0) {
932 goto end;
933 }
934 pretty->depth--;
935 g_string_append(pretty->string, " }");
936
937 end:
938 return ret;
939 }
940
941 static
942 int print_field(struct pretty_component *pretty,
943 const bt_field *field, bool print_names)
944 {
945 bt_field_class_type class_id;
946
947 class_id = bt_field_get_class_type(field);
948 switch (class_id) {
949 case BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER:
950 case BT_FIELD_CLASS_TYPE_SIGNED_INTEGER:
951 return print_integer(pretty, field);
952 case BT_FIELD_CLASS_TYPE_REAL:
953 {
954 double v;
955
956 v = bt_field_real_get_value(field);
957 if (pretty->use_colors) {
958 g_string_append(pretty->string, COLOR_NUMBER_VALUE);
959 }
960 bt_common_g_string_append_printf(pretty->string, "%g", v);
961 if (pretty->use_colors) {
962 g_string_append(pretty->string, COLOR_RST);
963 }
964 return 0;
965 }
966 case BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION:
967 case BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION:
968 return print_enum(pretty, field);
969 case BT_FIELD_CLASS_TYPE_STRING:
970 {
971 const char *str;
972
973 str = bt_field_string_get_value(field);
974 if (!str) {
975 return -1;
976 }
977
978 if (pretty->use_colors) {
979 g_string_append(pretty->string, COLOR_STRING_VALUE);
980 }
981 print_escape_string(pretty, str);
982 if (pretty->use_colors) {
983 g_string_append(pretty->string, COLOR_RST);
984 }
985 return 0;
986 }
987 case BT_FIELD_CLASS_TYPE_STRUCTURE:
988 return print_struct(pretty, field, print_names);
989 case BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR:
990 case BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_SELECTOR:
991 case BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_SELECTOR:
992 return print_variant(pretty, field, print_names);
993 case BT_FIELD_CLASS_TYPE_STATIC_ARRAY:
994 return print_array(pretty, field, print_names);
995 case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY:
996 return print_sequence(pretty, field, print_names);
997 default:
998 // TODO: log instead
999 fprintf(pretty->err, "[error] Unknown type id: %d\n", (int) class_id);
1000 return -1;
1001 }
1002 }
1003
1004 static
1005 int print_stream_packet_context(struct pretty_component *pretty,
1006 const bt_event *event)
1007 {
1008 int ret = 0;
1009 const bt_packet *packet = NULL;
1010 const bt_field *main_field = NULL;
1011
1012 packet = bt_event_borrow_packet_const(event);
1013 if (!packet) {
1014 goto end;
1015 }
1016 main_field = bt_packet_borrow_context_field_const(packet);
1017 if (!main_field) {
1018 goto end;
1019 }
1020 if (!pretty->start_line) {
1021 g_string_append(pretty->string, ", ");
1022 }
1023 pretty->start_line = false;
1024 if (pretty->options.print_scope_field_names) {
1025 print_name_equal(pretty, "stream.packet.context");
1026 }
1027 ret = print_field(pretty, main_field,
1028 pretty->options.print_context_field_names);
1029
1030 end:
1031 return ret;
1032 }
1033
1034 static
1035 int print_stream_event_context(struct pretty_component *pretty,
1036 const bt_event *event)
1037 {
1038 int ret = 0;
1039 const bt_field *main_field = NULL;
1040
1041 main_field = bt_event_borrow_common_context_field_const(event);
1042 if (!main_field) {
1043 goto end;
1044 }
1045 if (!pretty->start_line) {
1046 g_string_append(pretty->string, ", ");
1047 }
1048 pretty->start_line = false;
1049 if (pretty->options.print_scope_field_names) {
1050 print_name_equal(pretty, "stream.event.context");
1051 }
1052 ret = print_field(pretty, main_field,
1053 pretty->options.print_context_field_names);
1054
1055 end:
1056 return ret;
1057 }
1058
1059 static
1060 int print_event_context(struct pretty_component *pretty,
1061 const bt_event *event)
1062 {
1063 int ret = 0;
1064 const bt_field *main_field = NULL;
1065
1066 main_field = bt_event_borrow_specific_context_field_const(event);
1067 if (!main_field) {
1068 goto end;
1069 }
1070 if (!pretty->start_line) {
1071 g_string_append(pretty->string, ", ");
1072 }
1073 pretty->start_line = false;
1074 if (pretty->options.print_scope_field_names) {
1075 print_name_equal(pretty, "event.context");
1076 }
1077 ret = print_field(pretty, main_field,
1078 pretty->options.print_context_field_names);
1079
1080 end:
1081 return ret;
1082 }
1083
1084 static
1085 int print_event_payload(struct pretty_component *pretty,
1086 const bt_event *event)
1087 {
1088 int ret = 0;
1089 const bt_field *main_field = NULL;
1090
1091 main_field = bt_event_borrow_payload_field_const(event);
1092 if (!main_field) {
1093 goto end;
1094 }
1095 if (!pretty->start_line) {
1096 g_string_append(pretty->string, ", ");
1097 }
1098 pretty->start_line = false;
1099 if (pretty->options.print_scope_field_names) {
1100 print_name_equal(pretty, "event.fields");
1101 }
1102 ret = print_field(pretty, main_field,
1103 pretty->options.print_payload_field_names);
1104
1105 end:
1106 return ret;
1107 }
1108
1109 static
1110 int flush_buf(FILE *stream, struct pretty_component *pretty)
1111 {
1112 int ret = 0;
1113
1114 if (pretty->string->len == 0) {
1115 goto end;
1116 }
1117
1118 if (fwrite(pretty->string->str, pretty->string->len, 1, stream) != 1) {
1119 ret = -1;
1120 }
1121
1122 end:
1123 return ret;
1124 }
1125
1126 BT_HIDDEN
1127 int pretty_print_event(struct pretty_component *pretty,
1128 const bt_message *event_msg)
1129 {
1130 int ret;
1131 const bt_event *event =
1132 bt_message_event_borrow_event_const(event_msg);
1133
1134 BT_ASSERT(event);
1135 pretty->start_line = true;
1136 g_string_assign(pretty->string, "");
1137 ret = print_event_header(pretty, event_msg);
1138 if (ret != 0) {
1139 goto end;
1140 }
1141
1142 ret = print_stream_packet_context(pretty, event);
1143 if (ret != 0) {
1144 goto end;
1145 }
1146
1147 ret = print_stream_event_context(pretty, event);
1148 if (ret != 0) {
1149 goto end;
1150 }
1151
1152 ret = print_event_context(pretty, event);
1153 if (ret != 0) {
1154 goto end;
1155 }
1156
1157 ret = print_event_payload(pretty, event);
1158 if (ret != 0) {
1159 goto end;
1160 }
1161
1162 g_string_append_c(pretty->string, '\n');
1163 if (flush_buf(pretty->out, pretty)) {
1164 ret = -1;
1165 goto end;
1166 }
1167
1168 end:
1169 return ret;
1170 }
1171
1172 static
1173 int print_discarded_elements_msg(struct pretty_component *pretty,
1174 const bt_stream *stream,
1175 const bt_clock_snapshot *begin_clock_snapshot,
1176 const bt_clock_snapshot *end_clock_snapshot,
1177 uint64_t count, const char *elem_type)
1178 {
1179 int ret = 0;
1180 const bt_stream_class *stream_class = NULL;
1181 const bt_trace *trace = NULL;
1182 const char *stream_name;
1183 const char *trace_name;
1184 bt_uuid trace_uuid;
1185 int64_t stream_class_id;
1186 int64_t stream_id;
1187 const char *init_msg;
1188
1189 /* Stream name */
1190 stream_name = bt_stream_get_name(stream);
1191 if (!stream_name) {
1192 stream_name = "(unknown)";
1193 }
1194
1195 /* Stream class ID */
1196 stream_class = bt_stream_borrow_class_const(stream);
1197 BT_ASSERT(stream_class);
1198 stream_class_id = bt_stream_class_get_id(stream_class);
1199
1200 /* Stream ID */
1201 stream_id = bt_stream_get_id(stream);
1202
1203 /* Trace name */
1204 trace = bt_stream_borrow_trace_const(stream);
1205 BT_ASSERT(trace);
1206 trace_name = bt_trace_get_name(trace);
1207 if (!trace_name) {
1208 trace_name = "(unknown)";
1209 }
1210
1211 /* Trace UUID */
1212 trace_uuid = bt_trace_get_uuid(trace);
1213
1214 /* Format message */
1215 g_string_assign(pretty->string, "");
1216
1217 if (count == UINT64_C(-1)) {
1218 init_msg = "Tracer may have discarded";
1219 } else {
1220 init_msg = "Tracer discarded";
1221 }
1222
1223 bt_common_g_string_append_printf(pretty->string,
1224 "%s%sWARNING%s%s: %s ",
1225 bt_common_color_fg_yellow(),
1226 bt_common_color_bold(),
1227 bt_common_color_reset(),
1228 bt_common_color_fg_yellow(), init_msg);
1229
1230 if (count == UINT64_C(-1)) {
1231 bt_common_g_string_append_printf(pretty->string, "%ss", elem_type);
1232 } else {
1233 bt_common_g_string_append_printf(pretty->string,
1234 "%" PRIu64 " %s%s", count, elem_type,
1235 count == 1 ? "" : "s");
1236 }
1237
1238 g_string_append_c(pretty->string, ' ');
1239
1240 if (begin_clock_snapshot && end_clock_snapshot) {
1241 g_string_append(pretty->string, "between [");
1242 print_timestamp_wall(pretty, begin_clock_snapshot, false);
1243 g_string_append(pretty->string, "] and [");
1244 print_timestamp_wall(pretty, end_clock_snapshot, false);
1245 g_string_append(pretty->string, "]");
1246 } else {
1247 g_string_append(pretty->string, "(unknown time range)");
1248 }
1249
1250 bt_common_g_string_append_printf(pretty->string, " in trace \"%s\" ", trace_name);
1251
1252 if (trace_uuid) {
1253 bt_common_g_string_append_printf(pretty->string,
1254 "(UUID: " BT_UUID_FMT ") ",
1255 BT_UUID_FMT_VALUES(trace_uuid));
1256 } else {
1257 g_string_append(pretty->string, "(no UUID) ");
1258 }
1259
1260 bt_common_g_string_append_printf(pretty->string,
1261 "within stream \"%s\" (stream class ID: %" PRIu64 ", ",
1262 stream_name, stream_class_id);
1263
1264 if (stream_id >= 0) {
1265 bt_common_g_string_append_printf(pretty->string,
1266 "stream ID: %" PRIu64, stream_id);
1267 } else {
1268 g_string_append(pretty->string, "no stream ID");
1269 }
1270
1271 bt_common_g_string_append_printf(pretty->string, ").%s\n",
1272 bt_common_color_reset());
1273
1274 /*
1275 * Print to standard error stream to remain backward compatible
1276 * with Babeltrace 1.
1277 */
1278 if (flush_buf(stderr, pretty)) {
1279 ret = -1;
1280 }
1281
1282 return ret;
1283 }
1284
1285 BT_HIDDEN
1286 int pretty_print_discarded_items(struct pretty_component *pretty,
1287 const bt_message *msg)
1288 {
1289 const bt_clock_snapshot *begin = NULL;
1290 const bt_clock_snapshot *end = NULL;
1291 const bt_stream *stream;
1292 const bt_stream_class *stream_class;
1293 uint64_t count = UINT64_C(-1);
1294 const char *elem_type;
1295
1296 switch (bt_message_get_type(msg)) {
1297 case BT_MESSAGE_TYPE_DISCARDED_EVENTS:
1298 stream = bt_message_discarded_events_borrow_stream_const(msg);
1299
1300 if (bt_message_discarded_events_get_count(msg, &count) ==
1301 BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE) {
1302 count = UINT64_C(-1);
1303 }
1304
1305 elem_type = "event";
1306 break;
1307 case BT_MESSAGE_TYPE_DISCARDED_PACKETS:
1308 stream = bt_message_discarded_packets_borrow_stream_const(msg);
1309
1310 if (bt_message_discarded_packets_get_count(msg, &count) ==
1311 BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE) {
1312 count = UINT64_C(-1);
1313 }
1314
1315 elem_type = "packet";
1316 break;
1317 default:
1318 abort();
1319 }
1320
1321 BT_ASSERT(stream);
1322 stream_class = bt_stream_borrow_class_const(stream);
1323
1324 switch (bt_message_get_type(msg)) {
1325 case BT_MESSAGE_TYPE_DISCARDED_EVENTS:
1326 if (bt_stream_class_discarded_events_have_default_clock_snapshots(
1327 stream_class)) {
1328 begin = bt_message_discarded_events_borrow_beginning_default_clock_snapshot_const(
1329 msg);
1330 end = bt_message_discarded_events_borrow_end_default_clock_snapshot_const(
1331 msg);
1332 }
1333
1334 break;
1335 case BT_MESSAGE_TYPE_DISCARDED_PACKETS:
1336 if (bt_stream_class_discarded_packets_have_default_clock_snapshots(
1337 stream_class)) {
1338 begin = bt_message_discarded_packets_borrow_beginning_default_clock_snapshot_const(
1339 msg);
1340 end = bt_message_discarded_packets_borrow_end_default_clock_snapshot_const(
1341 msg);
1342 }
1343
1344 break;
1345 default:
1346 abort();
1347 }
1348
1349 print_discarded_elements_msg(pretty, stream, begin, end,
1350 count, elem_type);
1351 return 0;
1352 }
This page took 0.055715 seconds and 4 git commands to generate.