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