Add internal BT_ASSERT() and BT_ASSERT_PRE() helpers
[babeltrace.git] / plugins / text / pretty / print.c
CommitLineData
af9a82eb
JG
1/*
2 * print.c
3 *
4 * Babeltrace CTF Text Output Plugin Event Printing
5 *
6 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
f504043c 7 * Copyright 2016 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
af9a82eb
JG
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
9d408fca 30#include <babeltrace/babeltrace.h>
3d9990ac 31#include <babeltrace/bitfield-internal.h>
ad96d936 32#include <babeltrace/common-internal.h>
58a2480d 33#include <babeltrace/compat/time-internal.h>
6a18b281 34#include <inttypes.h>
93a4161c 35#include <ctype.h>
3228cc1d 36#include "pretty.h"
af9a82eb 37
1556a1af
JG
38#define NSEC_PER_SEC 1000000000LL
39
5280f742 40#define COLOR_NAME BT_COMMON_COLOR_BOLD
08899d39 41#define COLOR_FIELD_NAME BT_COMMON_COLOR_FG_CYAN
5280f742
PP
42#define COLOR_RST BT_COMMON_COLOR_RESET
43#define COLOR_STRING_VALUE BT_COMMON_COLOR_BOLD
44#define COLOR_NUMBER_VALUE BT_COMMON_COLOR_BOLD
45#define COLOR_ENUM_MAPPING_NAME BT_COMMON_COLOR_BOLD
46#define COLOR_UNKNOWN BT_COMMON_COLOR_BOLD BT_COMMON_COLOR_FG_RED
08899d39 47#define COLOR_EVENT_NAME BT_COMMON_COLOR_BOLD BT_COMMON_COLOR_FG_MAGENTA
5280f742 48#define COLOR_TIMESTAMP BT_COMMON_COLOR_BOLD BT_COMMON_COLOR_FG_YELLOW
ad96d936 49
af9a82eb
JG
50struct timestamp {
51 int64_t real_timestamp; /* Relative to UNIX epoch. */
52 uint64_t clock_value; /* In cycles. */
53};
54
6a18b281 55static
3228cc1d 56enum bt_component_status print_field(struct pretty_component *pretty,
50842bdc 57 struct bt_field *field, bool print_names,
2b4c4a7c 58 GQuark *filters_fields, int filter_array_len);
6a18b281 59
ad96d936 60static
3228cc1d 61void print_name_equal(struct pretty_component *pretty, const char *name)
ad96d936 62{
3228cc1d 63 if (pretty->use_colors) {
5280f742
PP
64 g_string_append_printf(pretty->string, "%s%s%s = ", COLOR_NAME,
65 name, COLOR_RST);
ad96d936 66 } else {
5280f742 67 g_string_append_printf(pretty->string, "%s = ", name);
ad96d936
PP
68 }
69}
70
71static
3228cc1d 72void print_field_name_equal(struct pretty_component *pretty, const char *name)
ad96d936 73{
3228cc1d 74 if (pretty->use_colors) {
5280f742
PP
75 g_string_append_printf(pretty->string, "%s%s%s = ",
76 COLOR_FIELD_NAME, name, COLOR_RST);
ad96d936 77 } else {
5280f742 78 g_string_append_printf(pretty->string, "%s = ", name);
ad96d936
PP
79 }
80}
81
af9a82eb 82static
3228cc1d 83void print_timestamp_cycles(struct pretty_component *pretty,
50842bdc
PP
84 struct bt_clock_class *clock_class,
85 struct bt_event *event)
af9a82eb 86{
1556a1af 87 int ret;
50842bdc 88 struct bt_clock_value *clock_value;
1556a1af
JG
89 uint64_t cycles;
90
50842bdc 91 clock_value = bt_event_get_clock_value(event, clock_class);
1556a1af 92 if (!clock_value) {
5280f742 93 g_string_append(pretty->string, "????????????????????");
1556a1af
JG
94 return;
95 }
96
50842bdc 97 ret = bt_clock_value_get_value(clock_value, &cycles);
1556a1af
JG
98 bt_put(clock_value);
99 if (ret) {
5280f742
PP
100 // TODO: log, this is unexpected
101 g_string_append(pretty->string, "Error");
1556a1af
JG
102 return;
103 }
5280f742
PP
104
105 g_string_append_printf(pretty->string, "%020" PRIu64, cycles);
3af83b5a 106
3228cc1d
PP
107 if (pretty->last_cycles_timestamp != -1ULL) {
108 pretty->delta_cycles = cycles - pretty->last_cycles_timestamp;
3af83b5a 109 }
3228cc1d 110 pretty->last_cycles_timestamp = cycles;
af9a82eb
JG
111}
112
113static
3228cc1d 114void print_timestamp_wall(struct pretty_component *pretty,
50842bdc 115 struct bt_clock_value *clock_value)
af9a82eb 116{
1556a1af 117 int ret;
1556a1af
JG
118 int64_t ts_nsec = 0; /* add configurable offset */
119 int64_t ts_sec = 0; /* add configurable offset */
120 uint64_t ts_sec_abs, ts_nsec_abs;
121 bool is_negative;
af9a82eb 122
1556a1af 123 if (!clock_value) {
5280f742 124 g_string_append(pretty->string, "??:??:??.?????????");
1556a1af
JG
125 return;
126 }
127
50842bdc 128 ret = bt_clock_value_get_value_ns_from_epoch(clock_value, &ts_nsec);
1556a1af 129 if (ret) {
5280f742
PP
130 // TODO: log, this is unexpected
131 g_string_append(pretty->string, "Error");
1556a1af
JG
132 return;
133 }
134
3228cc1d
PP
135 if (pretty->last_real_timestamp != -1ULL) {
136 pretty->delta_real_timestamp = ts_nsec - pretty->last_real_timestamp;
3af83b5a 137 }
3af83b5a 138
5280f742 139 pretty->last_real_timestamp = ts_nsec;
1556a1af
JG
140 ts_sec += ts_nsec / NSEC_PER_SEC;
141 ts_nsec = ts_nsec % NSEC_PER_SEC;
5280f742 142
1556a1af
JG
143 if (ts_sec >= 0 && ts_nsec >= 0) {
144 is_negative = false;
145 ts_sec_abs = ts_sec;
146 ts_nsec_abs = ts_nsec;
147 } else if (ts_sec > 0 && ts_nsec < 0) {
148 is_negative = false;
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 if (ts_sec < 0 && ts_nsec > 0) {
156 is_negative = true;
157 ts_sec_abs = -(ts_sec + 1);
158 ts_nsec_abs = NSEC_PER_SEC - ts_nsec;
159 } else if (ts_sec < 0 && ts_nsec == 0) {
160 is_negative = true;
161 ts_sec_abs = -ts_sec;
162 ts_nsec_abs = ts_nsec;
163 } else { /* (ts_sec < 0 && ts_nsec < 0) */
164 is_negative = true;
165 ts_sec_abs = -ts_sec;
166 ts_nsec_abs = -ts_nsec;
167 }
168
3228cc1d 169 if (!pretty->options.clock_seconds) {
1556a1af
JG
170 struct tm tm;
171 time_t time_s = (time_t) ts_sec_abs;
172
18adbd19 173 if (is_negative && !pretty->negative_timestamp_warning_done) {
5280f742 174 // TODO: log instead
1556a1af 175 fprintf(stderr, "[warning] Fallback to [sec.ns] to print negative time value. Use --clock-seconds.\n");
18adbd19 176 pretty->negative_timestamp_warning_done = true;
1556a1af
JG
177 goto seconds;
178 }
179
3228cc1d 180 if (!pretty->options.clock_gmt) {
1556a1af
JG
181 struct tm *res;
182
58a2480d 183 res = bt_localtime_r(&time_s, &tm);
1556a1af 184 if (!res) {
5280f742 185 // TODO: log instead
1556a1af
JG
186 fprintf(stderr, "[warning] Unable to get localtime.\n");
187 goto seconds;
188 }
189 } else {
190 struct tm *res;
191
58a2480d 192 res = bt_gmtime_r(&time_s, &tm);
1556a1af 193 if (!res) {
5280f742 194 // TODO: log instead
1556a1af
JG
195 fprintf(stderr, "[warning] Unable to get gmtime.\n");
196 goto seconds;
197 }
198 }
3228cc1d 199 if (pretty->options.clock_date) {
1556a1af
JG
200 char timestr[26];
201 size_t res;
202
203 /* Print date and time */
204 res = strftime(timestr, sizeof(timestr),
4d2a94f1 205 "%Y-%m-%d ", &tm);
1556a1af 206 if (!res) {
5280f742 207 // TODO: log instead
1556a1af
JG
208 fprintf(stderr, "[warning] Unable to print ascii time.\n");
209 goto seconds;
210 }
5280f742
PP
211
212 g_string_append(pretty->string, timestr);
1556a1af 213 }
5280f742 214
1556a1af 215 /* Print time in HH:MM:SS.ns */
5280f742
PP
216 g_string_append_printf(pretty->string,
217 "%02d:%02d:%02d.%09" PRIu64, tm.tm_hour, tm.tm_min,
218 tm.tm_sec, ts_nsec_abs);
1556a1af
JG
219 goto end;
220 }
221seconds:
5280f742
PP
222 g_string_append_printf(pretty->string, "%s%" PRId64 ".%09" PRIu64,
223 is_negative ? "-" : "", ts_sec_abs, ts_nsec_abs);
1556a1af
JG
224end:
225 return;
af9a82eb
JG
226}
227
228static
3228cc1d 229enum bt_component_status print_event_timestamp(struct pretty_component *pretty,
50842bdc 230 struct bt_event *event,
d9f65f09
PP
231 struct bt_clock_class_priority_map *cc_prio_map,
232 bool *start_line)
af9a82eb 233{
3228cc1d 234 bool print_names = pretty->options.print_header_field_names;
af9a82eb 235 enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
50842bdc
PP
236 struct bt_stream *stream = NULL;
237 struct bt_stream_class *stream_class = NULL;
238 struct bt_trace *trace = NULL;
239 struct bt_clock_class *clock_class = NULL;
af9a82eb 240
50842bdc 241 stream = bt_event_get_stream(event);
af9a82eb
JG
242 if (!stream) {
243 ret = BT_COMPONENT_STATUS_ERROR;
244 goto end;
245 }
246
50842bdc 247 stream_class = bt_stream_get_class(stream);
f504043c
MD
248 if (!stream_class) {
249 ret = BT_COMPONENT_STATUS_ERROR;
250 goto end;
251 }
50842bdc 252 trace = bt_stream_class_get_trace(stream_class);
f504043c
MD
253 if (!trace) {
254 ret = BT_COMPONENT_STATUS_ERROR;
255 goto end;
256 }
d9f65f09
PP
257
258 if (bt_clock_class_priority_map_get_clock_class_count(cc_prio_map) == 0) {
259 /* No clock class: skip the timestamp without an error */
260 goto end;
261 }
262
263 clock_class =
264 bt_clock_class_priority_map_get_highest_priority_clock_class(
265 cc_prio_map);
ac0c6bdd 266 if (!clock_class) {
f504043c
MD
267 ret = BT_COMPONENT_STATUS_ERROR;
268 goto end;
269 }
af9a82eb 270
ad96d936 271 if (print_names) {
3228cc1d 272 print_name_equal(pretty, "timestamp");
ad96d936 273 } else {
5280f742 274 g_string_append(pretty->string, "[");
ad96d936 275 }
3228cc1d 276 if (pretty->use_colors) {
5280f742 277 g_string_append(pretty->string, COLOR_TIMESTAMP);
ad96d936 278 }
3228cc1d
PP
279 if (pretty->options.print_timestamp_cycles) {
280 print_timestamp_cycles(pretty, clock_class, event);
af9a82eb 281 } else {
50842bdc
PP
282 struct bt_clock_value *clock_value =
283 bt_event_get_clock_value(event, clock_class);
08899d39
PP
284
285 print_timestamp_wall(pretty, clock_value);
286 bt_put(clock_value);
af9a82eb 287 }
3228cc1d 288 if (pretty->use_colors) {
5280f742 289 g_string_append(pretty->string, COLOR_RST);
ad96d936 290 }
af9a82eb 291
c3c30b08 292 if (!print_names)
5280f742 293 g_string_append(pretty->string, "] ");
c3c30b08 294
3228cc1d 295 if (pretty->options.print_delta_field) {
ad96d936 296 if (print_names) {
5280f742 297 g_string_append(pretty->string, ", ");
3228cc1d 298 print_name_equal(pretty, "delta");
ad96d936 299 } else {
5280f742 300 g_string_append(pretty->string, "(");
ad96d936 301 }
3228cc1d
PP
302 if (pretty->options.print_timestamp_cycles) {
303 if (pretty->delta_cycles == -1ULL) {
5280f742
PP
304 g_string_append(pretty->string,
305 "+??????????\?\?) "); /* Not a trigraph. */
3af83b5a 306 } else {
5280f742
PP
307 g_string_append_printf(pretty->string,
308 "+%012" PRIu64, pretty->delta_cycles);
3af83b5a
MD
309 }
310 } else {
3228cc1d 311 if (pretty->delta_real_timestamp != -1ULL) {
3af83b5a 312 uint64_t delta_sec, delta_nsec, delta;
f504043c 313
3228cc1d 314 delta = pretty->delta_real_timestamp;
3af83b5a
MD
315 delta_sec = delta / NSEC_PER_SEC;
316 delta_nsec = delta % NSEC_PER_SEC;
5280f742
PP
317 g_string_append_printf(pretty->string,
318 "+%" PRIu64 ".%09" PRIu64,
3af83b5a
MD
319 delta_sec, delta_nsec);
320 } else {
5280f742 321 g_string_append(pretty->string, "+?.?????????");
3af83b5a
MD
322 }
323 }
324 if (!print_names) {
5280f742 325 g_string_append(pretty->string, ") ");
3af83b5a
MD
326 }
327 }
328 *start_line = !print_names;
f504043c 329
af9a82eb
JG
330end:
331 bt_put(stream);
ac0c6bdd 332 bt_put(clock_class);
1556a1af
JG
333 bt_put(stream_class);
334 bt_put(trace);
af9a82eb
JG
335 return ret;
336}
337
6a18b281 338static
3228cc1d 339enum bt_component_status print_event_header(struct pretty_component *pretty,
50842bdc 340 struct bt_event *event,
d9f65f09 341 struct bt_clock_class_priority_map *cc_prio_map)
af9a82eb 342{
3228cc1d 343 bool print_names = pretty->options.print_header_field_names;
6a18b281 344 enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
50842bdc
PP
345 struct bt_event_class *event_class = NULL;
346 struct bt_stream_class *stream_class = NULL;
347 struct bt_trace *trace_class = NULL;
60535549 348 int dom_print = 0;
af9a82eb 349
50842bdc 350 event_class = bt_event_get_class(event);
6a18b281
MD
351 if (!event_class) {
352 ret = BT_COMPONENT_STATUS_ERROR;
353 goto end;
354 }
50842bdc 355 stream_class = bt_event_class_get_stream_class(event_class);
c3c30b08
MD
356 if (!stream_class) {
357 ret = BT_COMPONENT_STATUS_ERROR;
358 goto end;
359 }
50842bdc 360 trace_class = bt_stream_class_get_trace(stream_class);
c3c30b08
MD
361 if (!trace_class) {
362 ret = BT_COMPONENT_STATUS_ERROR;
363 goto end;
364 }
d9f65f09
PP
365 ret = print_event_timestamp(pretty, event, cc_prio_map,
366 &pretty->start_line);
af9a82eb
JG
367 if (ret != BT_COMPONENT_STATUS_OK) {
368 goto end;
369 }
3228cc1d 370 if (pretty->options.print_trace_field) {
c3c30b08
MD
371 const char *name;
372
50842bdc 373 name = bt_trace_get_name(trace_class);
c3c30b08 374 if (name) {
3228cc1d 375 if (!pretty->start_line) {
5280f742 376 g_string_append(pretty->string, ", ");
c3c30b08 377 }
c3c30b08 378 if (print_names) {
3228cc1d 379 print_name_equal(pretty, "trace");
c3c30b08 380 }
5280f742
PP
381
382 g_string_append(pretty->string, name);
383
60535549 384 if (!print_names) {
5280f742 385 g_string_append(pretty->string, " ");
60535549 386 }
c3c30b08
MD
387 }
388 }
3228cc1d 389 if (pretty->options.print_trace_hostname_field) {
c3c30b08
MD
390 struct bt_value *hostname_str;
391
50842bdc 392 hostname_str = bt_trace_get_environment_field_value_by_name(trace_class,
c3c30b08
MD
393 "hostname");
394 if (hostname_str) {
395 const char *str;
396
3228cc1d 397 if (!pretty->start_line) {
5280f742 398 g_string_append(pretty->string, ", ");
c3c30b08 399 }
c3c30b08 400 if (print_names) {
3228cc1d 401 print_name_equal(pretty, "trace:hostname");
c3c30b08
MD
402 }
403 if (bt_value_string_get(hostname_str, &str)
404 == BT_VALUE_STATUS_OK) {
5280f742 405 g_string_append(pretty->string, str);
c3c30b08
MD
406 }
407 bt_put(hostname_str);
60535549 408 dom_print = 1;
c3c30b08
MD
409 }
410 }
3228cc1d 411 if (pretty->options.print_trace_domain_field) {
c3c30b08
MD
412 struct bt_value *domain_str;
413
50842bdc 414 domain_str = bt_trace_get_environment_field_value_by_name(trace_class,
c3c30b08
MD
415 "domain");
416 if (domain_str) {
417 const char *str;
418
3228cc1d 419 if (!pretty->start_line) {
5280f742 420 g_string_append(pretty->string, ", ");
c3c30b08 421 }
c3c30b08 422 if (print_names) {
3228cc1d 423 print_name_equal(pretty, "trace:domain");
60535549 424 } else if (dom_print) {
5280f742 425 g_string_append(pretty->string, ":");
c3c30b08
MD
426 }
427 if (bt_value_string_get(domain_str, &str)
428 == BT_VALUE_STATUS_OK) {
5280f742 429 g_string_append(pretty->string, str);
c3c30b08
MD
430 }
431 bt_put(domain_str);
60535549 432 dom_print = 1;
c3c30b08
MD
433 }
434 }
3228cc1d 435 if (pretty->options.print_trace_procname_field) {
c3c30b08
MD
436 struct bt_value *procname_str;
437
50842bdc 438 procname_str = bt_trace_get_environment_field_value_by_name(trace_class,
c3c30b08
MD
439 "procname");
440 if (procname_str) {
441 const char *str;
442
3228cc1d 443 if (!pretty->start_line) {
5280f742 444 g_string_append(pretty->string, ", ");
c3c30b08 445 }
c3c30b08 446 if (print_names) {
3228cc1d 447 print_name_equal(pretty, "trace:procname");
60535549 448 } else if (dom_print) {
5280f742 449 g_string_append(pretty->string, ":");
c3c30b08
MD
450 }
451 if (bt_value_string_get(procname_str, &str)
452 == BT_VALUE_STATUS_OK) {
5280f742 453 g_string_append(pretty->string, str);
c3c30b08
MD
454 }
455 bt_put(procname_str);
60535549 456 dom_print = 1;
c3c30b08
MD
457 }
458 }
3228cc1d 459 if (pretty->options.print_trace_vpid_field) {
c3c30b08
MD
460 struct bt_value *vpid_value;
461
50842bdc 462 vpid_value = bt_trace_get_environment_field_value_by_name(trace_class,
c3c30b08
MD
463 "vpid");
464 if (vpid_value) {
465 int64_t value;
466
3228cc1d 467 if (!pretty->start_line) {
5280f742 468 g_string_append(pretty->string, ", ");
c3c30b08 469 }
c3c30b08 470 if (print_names) {
3228cc1d 471 print_name_equal(pretty, "trace:vpid");
60535549 472 } else if (dom_print) {
5280f742 473 g_string_append(pretty->string, ":");
c3c30b08
MD
474 }
475 if (bt_value_integer_get(vpid_value, &value)
476 == BT_VALUE_STATUS_OK) {
5280f742 477 g_string_append_printf(pretty->string, "(%" PRId64 ")", value);
c3c30b08
MD
478 }
479 bt_put(vpid_value);
60535549 480 dom_print = 1;
c3c30b08
MD
481 }
482 }
3228cc1d 483 if (pretty->options.print_loglevel_field) {
cf76ce92 484 static const char *log_level_names[] = {
50842bdc
PP
485 [ BT_EVENT_CLASS_LOG_LEVEL_EMERGENCY ] = "TRACE_EMERG",
486 [ BT_EVENT_CLASS_LOG_LEVEL_ALERT ] = "TRACE_ALERT",
487 [ BT_EVENT_CLASS_LOG_LEVEL_CRITICAL ] = "TRACE_CRIT",
488 [ BT_EVENT_CLASS_LOG_LEVEL_ERROR ] = "TRACE_ERR",
489 [ BT_EVENT_CLASS_LOG_LEVEL_WARNING ] = "TRACE_WARNING",
490 [ BT_EVENT_CLASS_LOG_LEVEL_NOTICE ] = "TRACE_NOTICE",
491 [ BT_EVENT_CLASS_LOG_LEVEL_INFO ] = "TRACE_INFO",
492 [ BT_EVENT_CLASS_LOG_LEVEL_DEBUG_SYSTEM ] = "TRACE_DEBUG_SYSTEM",
493 [ BT_EVENT_CLASS_LOG_LEVEL_DEBUG_PROGRAM ] = "TRACE_DEBUG_PROGRAM",
494 [ BT_EVENT_CLASS_LOG_LEVEL_DEBUG_PROCESS ] = "TRACE_DEBUG_PROCESS",
495 [ BT_EVENT_CLASS_LOG_LEVEL_DEBUG_MODULE ] = "TRACE_DEBUG_MODULE",
496 [ BT_EVENT_CLASS_LOG_LEVEL_DEBUG_UNIT ] = "TRACE_DEBUG_UNIT",
497 [ BT_EVENT_CLASS_LOG_LEVEL_DEBUG_FUNCTION ] = "TRACE_DEBUG_FUNCTION",
498 [ BT_EVENT_CLASS_LOG_LEVEL_DEBUG_LINE ] = "TRACE_DEBUG_LINE",
499 [ BT_EVENT_CLASS_LOG_LEVEL_DEBUG ] = "TRACE_DEBUG",
cf76ce92 500 };
50842bdc 501 enum bt_event_class_log_level log_level;
cf76ce92
PP
502 const char *log_level_str = NULL;
503
50842bdc
PP
504 log_level = bt_event_class_get_log_level(event_class);
505 assert(log_level != BT_EVENT_CLASS_LOG_LEVEL_UNKNOWN);
506 if (log_level != BT_EVENT_CLASS_LOG_LEVEL_UNSPECIFIED) {
cf76ce92
PP
507 log_level_str = log_level_names[log_level];
508 }
c3c30b08 509
cf76ce92 510 if (log_level_str) {
3228cc1d 511 if (!pretty->start_line) {
5280f742 512 g_string_append(pretty->string, ", ");
c3c30b08 513 }
c3c30b08 514 if (print_names) {
3228cc1d 515 print_name_equal(pretty, "loglevel");
60535549 516 } else if (dom_print) {
5280f742 517 g_string_append(pretty->string, ":");
c3c30b08 518 }
cf76ce92
PP
519
520 g_string_append(pretty->string, log_level_str);
521 g_string_append_printf(
522 pretty->string, " (%d)", (int) log_level);
60535549 523 dom_print = 1;
c3c30b08
MD
524 }
525 }
3228cc1d 526 if (pretty->options.print_emf_field) {
cf76ce92 527 const char *uri_str;
c3c30b08 528
50842bdc 529 uri_str = bt_event_class_get_emf_uri(event_class);
c3c30b08 530 if (uri_str) {
3228cc1d 531 if (!pretty->start_line) {
5280f742 532 g_string_append(pretty->string, ", ");
c3c30b08 533 }
c3c30b08 534 if (print_names) {
3228cc1d 535 print_name_equal(pretty, "model.emf.uri");
60535549 536 } else if (dom_print) {
5280f742 537 g_string_append(pretty->string, ":");
c3c30b08 538 }
c3c30b08 539
cf76ce92 540 g_string_append(pretty->string, uri_str);
60535549 541 dom_print = 1;
c3c30b08
MD
542 }
543 }
60535549 544 if (dom_print && !print_names) {
5280f742 545 g_string_append(pretty->string, " ");
60535549 546 }
3228cc1d 547 if (!pretty->start_line) {
5280f742 548 g_string_append(pretty->string, ", ");
c3c30b08 549 }
3228cc1d 550 pretty->start_line = true;
6a18b281 551 if (print_names) {
3228cc1d 552 print_name_equal(pretty, "name");
ad96d936 553 }
3228cc1d 554 if (pretty->use_colors) {
5280f742 555 g_string_append(pretty->string, COLOR_EVENT_NAME);
6a18b281 556 }
50842bdc 557 g_string_append(pretty->string, bt_event_class_get_name(event_class));
3228cc1d 558 if (pretty->use_colors) {
5280f742 559 g_string_append(pretty->string, COLOR_RST);
ad96d936 560 }
60535549 561 if (!print_names) {
5280f742 562 g_string_append(pretty->string, ": ");
60535549 563 } else {
5280f742 564 g_string_append(pretty->string, ", ");
60535549 565 }
af9a82eb 566end:
c3c30b08
MD
567 bt_put(trace_class);
568 bt_put(stream_class);
6a18b281
MD
569 bt_put(event_class);
570 return ret;
571}
572
573static
3228cc1d 574enum bt_component_status print_integer(struct pretty_component *pretty,
50842bdc 575 struct bt_field *field)
6a18b281
MD
576{
577 enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
50842bdc
PP
578 struct bt_field_type *field_type = NULL;
579 enum bt_integer_base base;
580 enum bt_string_encoding encoding;
6a18b281
MD
581 int signedness;
582 union {
583 uint64_t u;
584 int64_t s;
585 } v;
ad96d936 586 bool rst_color = false;
6a18b281 587
50842bdc 588 field_type = bt_field_get_type(field);
6a18b281
MD
589 if (!field_type) {
590 ret = BT_COMPONENT_STATUS_ERROR;
591 goto end;
592 }
593 signedness = bt_ctf_field_type_integer_get_signed(field_type);
594 if (signedness < 0) {
595 ret = BT_COMPONENT_STATUS_ERROR;
596 goto end;
597 }
598 if (!signedness) {
50842bdc 599 if (bt_field_unsigned_integer_get_value(field, &v.u) < 0) {
6a18b281
MD
600 ret = BT_COMPONENT_STATUS_ERROR;
601 goto end;
602 }
603 } else {
50842bdc 604 if (bt_field_signed_integer_get_value(field, &v.s) < 0) {
6a18b281
MD
605 ret = BT_COMPONENT_STATUS_ERROR;
606 goto end;
607 }
608 }
609
50842bdc 610 encoding = bt_field_type_integer_get_encoding(field_type);
6a18b281 611 switch (encoding) {
50842bdc
PP
612 case BT_STRING_ENCODING_UTF8:
613 case BT_STRING_ENCODING_ASCII:
5280f742 614 g_string_append_c(pretty->tmp_string, (int) v.u);
6a18b281 615 goto end;
50842bdc
PP
616 case BT_STRING_ENCODING_NONE:
617 case BT_STRING_ENCODING_UNKNOWN:
6a18b281
MD
618 break;
619 default:
620 ret = BT_COMPONENT_STATUS_ERROR;
621 goto end;
622 }
623
3228cc1d 624 if (pretty->use_colors) {
5280f742 625 g_string_append(pretty->string, COLOR_NUMBER_VALUE);
ad96d936
PP
626 rst_color = true;
627 }
628
50842bdc 629 base = bt_field_type_integer_get_base(field_type);
6a18b281 630 switch (base) {
50842bdc 631 case BT_INTEGER_BASE_BINARY:
6a18b281
MD
632 {
633 int bitnr, len;
634
50842bdc 635 len = bt_field_type_integer_get_size(field_type);
6a18b281
MD
636 if (len < 0) {
637 ret = BT_COMPONENT_STATUS_ERROR;
638 goto end;
639 }
5280f742 640 g_string_append(pretty->string, "0b");
6a18b281
MD
641 v.u = _bt_piecewise_lshift(v.u, 64 - len);
642 for (bitnr = 0; bitnr < len; bitnr++) {
5280f742 643 g_string_append_printf(pretty->string, "%u", (v.u & (1ULL << 63)) ? 1 : 0);
6a18b281
MD
644 v.u = _bt_piecewise_lshift(v.u, 1);
645 }
646 break;
647 }
50842bdc 648 case BT_INTEGER_BASE_OCTAL:
6a18b281
MD
649 {
650 if (signedness) {
651 int len;
652
50842bdc 653 len = bt_field_type_integer_get_size(field_type);
6a18b281
MD
654 if (len < 0) {
655 ret = BT_COMPONENT_STATUS_ERROR;
656 goto end;
657 }
658 if (len < 64) {
659 size_t rounded_len;
660
661 assert(len != 0);
662 /* Round length to the nearest 3-bit */
663 rounded_len = (((len - 1) / 3) + 1) * 3;
664 v.u &= ((uint64_t) 1 << rounded_len) - 1;
665 }
666 }
667
5280f742 668 g_string_append_printf(pretty->string, "0%" PRIo64, v.u);
6a18b281
MD
669 break;
670 }
50842bdc
PP
671 case BT_INTEGER_BASE_DECIMAL:
672 case BT_INTEGER_BASE_UNSPECIFIED:
6a18b281 673 if (!signedness) {
5280f742 674 g_string_append_printf(pretty->string, "%" PRIu64, v.u);
6a18b281 675 } else {
5280f742 676 g_string_append_printf(pretty->string, "%" PRId64, v.s);
6a18b281
MD
677 }
678 break;
50842bdc 679 case BT_INTEGER_BASE_HEXADECIMAL:
6a18b281
MD
680 {
681 int len;
682
50842bdc 683 len = bt_field_type_integer_get_size(field_type);
6a18b281
MD
684 if (len < 0) {
685 ret = BT_COMPONENT_STATUS_ERROR;
686 goto end;
687 }
688 if (len < 64) {
689 /* Round length to the nearest nibble */
690 uint8_t rounded_len = ((len + 3) & ~0x3);
691
692 v.u &= ((uint64_t) 1 << rounded_len) - 1;
693 }
694
5280f742 695 g_string_append_printf(pretty->string, "0x%" PRIX64, v.u);
6a18b281
MD
696 break;
697 }
698 default:
699 ret = BT_COMPONENT_STATUS_ERROR;
700 goto end;
701 }
702end:
ad96d936 703 if (rst_color) {
5280f742 704 g_string_append(pretty->string, COLOR_RST);
ad96d936 705 }
6a18b281
MD
706 bt_put(field_type);
707 return ret;
708}
709
93a4161c 710static
3228cc1d 711void print_escape_string(struct pretty_component *pretty, const char *str)
93a4161c
JD
712{
713 int i;
714
5280f742
PP
715 g_string_append_c(pretty->string, '"');
716
93a4161c
JD
717 for (i = 0; i < strlen(str); i++) {
718 /* Escape sequences not recognized by iscntrl(). */
719 switch (str[i]) {
720 case '\\':
5280f742 721 g_string_append(pretty->string, "\\\\");
93a4161c
JD
722 continue;
723 case '\'':
5280f742 724 g_string_append(pretty->string, "\\\'");
93a4161c
JD
725 continue;
726 case '\"':
5280f742 727 g_string_append(pretty->string, "\\\"");
93a4161c
JD
728 continue;
729 case '\?':
5280f742 730 g_string_append(pretty->string, "\\\?");
93a4161c
JD
731 continue;
732 }
733
734 /* Standard characters. */
735 if (!iscntrl(str[i])) {
5280f742 736 g_string_append_c(pretty->string, str[i]);
93a4161c
JD
737 continue;
738 }
739
740 switch (str[i]) {
741 case '\0':
5280f742 742 g_string_append(pretty->string, "\\0");
93a4161c
JD
743 break;
744 case '\a':
5280f742 745 g_string_append(pretty->string, "\\a");
93a4161c
JD
746 break;
747 case '\b':
5280f742 748 g_string_append(pretty->string, "\\b");
93a4161c
JD
749 break;
750 case '\e':
5280f742 751 g_string_append(pretty->string, "\\e");
93a4161c
JD
752 break;
753 case '\f':
5280f742 754 g_string_append(pretty->string, "\\f");
93a4161c
JD
755 break;
756 case '\n':
5280f742 757 g_string_append(pretty->string, "\\n");
93a4161c
JD
758 break;
759 case '\r':
5280f742 760 g_string_append(pretty->string, "\\r");
93a4161c
JD
761 break;
762 case '\t':
5280f742 763 g_string_append(pretty->string, "\\t");
93a4161c
JD
764 break;
765 case '\v':
5280f742 766 g_string_append(pretty->string, "\\v");
93a4161c
JD
767 break;
768 default:
769 /* Unhandled control-sequence, print as hex. */
5280f742 770 g_string_append_printf(pretty->string, "\\x%02x", str[i]);
93a4161c
JD
771 break;
772 }
773 }
5280f742
PP
774
775 g_string_append_c(pretty->string, '"');
93a4161c
JD
776}
777
6a18b281 778static
3228cc1d 779enum bt_component_status print_enum(struct pretty_component *pretty,
50842bdc 780 struct bt_field *field)
6a18b281
MD
781{
782 enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
50842bdc
PP
783 struct bt_field *container_field = NULL;
784 struct bt_field_type *enumeration_field_type = NULL;
785 struct bt_field_type *container_field_type = NULL;
786 struct bt_field_type_enumeration_mapping_iterator *iter = NULL;
96e8f959
MD
787 int nr_mappings = 0;
788 int is_signed;
789
50842bdc 790 enumeration_field_type = bt_field_get_type(field);
96e8f959
MD
791 if (!enumeration_field_type) {
792 ret = BT_COMPONENT_STATUS_ERROR;
793 goto end;
794 }
50842bdc 795 container_field = bt_field_enumeration_get_container(field);
6a18b281
MD
796 if (!container_field) {
797 ret = BT_COMPONENT_STATUS_ERROR;
798 goto end;
799 }
50842bdc 800 container_field_type = bt_field_get_type(container_field);
96e8f959
MD
801 if (!container_field_type) {
802 ret = BT_COMPONENT_STATUS_ERROR;
803 goto end;
804 }
805 is_signed = bt_ctf_field_type_integer_get_signed(container_field_type);
806 if (is_signed < 0) {
807 ret = BT_COMPONENT_STATUS_ERROR;
808 goto end;
809 }
810 if (is_signed) {
811 int64_t value;
812
50842bdc 813 if (bt_field_signed_integer_get_value(container_field,
96e8f959
MD
814 &value)) {
815 ret = BT_COMPONENT_STATUS_ERROR;
816 goto end;
817 }
50842bdc 818 iter = bt_field_type_enumeration_find_mappings_by_signed_value(
96e8f959 819 enumeration_field_type, value);
6a18b281 820 } else {
96e8f959
MD
821 uint64_t value;
822
50842bdc 823 if (bt_field_unsigned_integer_get_value(container_field,
96e8f959
MD
824 &value)) {
825 ret = BT_COMPONENT_STATUS_ERROR;
826 goto end;
827 }
50842bdc 828 iter = bt_field_type_enumeration_find_mappings_by_unsigned_value(
96e8f959
MD
829 enumeration_field_type, value);
830 }
83ef3205 831 g_string_append(pretty->string, "( ");
50842bdc 832 ret = bt_field_type_enumeration_mapping_iterator_next(iter);
74fb0452 833 if (ret) {
83ef3205
MD
834 if (pretty->use_colors) {
835 g_string_append(pretty->string, COLOR_UNKNOWN);
836 }
837 g_string_append(pretty->string, "<unknown>");
838 if (pretty->use_colors) {
839 g_string_append(pretty->string, COLOR_RST);
840 }
841 goto skip_loop;
96e8f959 842 }
96e8f959
MD
843 for (;;) {
844 const char *mapping_name;
845
50842bdc 846 if (bt_field_type_enumeration_mapping_iterator_get_signed(
96e8f959
MD
847 iter, &mapping_name, NULL, NULL) < 0) {
848 ret = BT_COMPONENT_STATUS_ERROR;
849 goto end;
850 }
851 if (nr_mappings++)
5280f742 852 g_string_append(pretty->string, ", ");
3228cc1d 853 if (pretty->use_colors) {
5280f742 854 g_string_append(pretty->string, COLOR_ENUM_MAPPING_NAME);
ad96d936 855 }
3228cc1d
PP
856 print_escape_string(pretty, mapping_name);
857 if (pretty->use_colors) {
5280f742 858 g_string_append(pretty->string, COLOR_RST);
ad96d936 859 }
50842bdc 860 if (bt_field_type_enumeration_mapping_iterator_next(iter) < 0) {
96e8f959
MD
861 break;
862 }
863 }
83ef3205 864skip_loop:
5280f742 865 g_string_append(pretty->string, " : container = ");
3228cc1d 866 ret = print_integer(pretty, container_field);
6a18b281
MD
867 if (ret != BT_COMPONENT_STATUS_OK) {
868 goto end;
869 }
5280f742 870 g_string_append(pretty->string, " )");
6a18b281 871end:
96e8f959
MD
872 bt_put(iter);
873 bt_put(container_field_type);
6a18b281 874 bt_put(container_field);
96e8f959 875 bt_put(enumeration_field_type);
6a18b281
MD
876 return ret;
877}
878
2b4c4a7c 879static
3228cc1d 880int filter_field_name(struct pretty_component *pretty, const char *field_name,
2b4c4a7c
JD
881 GQuark *filter_fields, int filter_array_len)
882{
883 int i;
884 GQuark field_quark = g_quark_try_string(field_name);
885
3228cc1d 886 if (!field_quark || pretty->options.verbose) {
2b4c4a7c
JD
887 return 1;
888 }
889
890 for (i = 0; i < filter_array_len; i++) {
891 if (field_quark == filter_fields[i]) {
892 return 0;
893 }
894 }
895 return 1;
896}
897
6a18b281 898static
3228cc1d 899enum bt_component_status print_struct_field(struct pretty_component *pretty,
50842bdc
PP
900 struct bt_field *_struct,
901 struct bt_field_type *struct_type,
2b4c4a7c
JD
902 int i, bool print_names, int *nr_printed_fields,
903 GQuark *filter_fields, int filter_array_len)
6a18b281
MD
904{
905 enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
906 const char *field_name;
50842bdc
PP
907 struct bt_field *field = NULL;
908 struct bt_field_type *field_type = NULL;;
6a18b281 909
50842bdc 910 field = bt_field_structure_get_field_by_index(_struct, i);
6a18b281
MD
911 if (!field) {
912 ret = BT_COMPONENT_STATUS_ERROR;
913 goto end;
914 }
50842bdc 915 if (bt_field_type_structure_get_field_by_index(struct_type,
6a18b281
MD
916 &field_name, &field_type, i) < 0) {
917 ret = BT_COMPONENT_STATUS_ERROR;
918 goto end;
919 }
920
3228cc1d 921 if (filter_fields && !filter_field_name(pretty, field_name,
2b4c4a7c
JD
922 filter_fields, filter_array_len)) {
923 ret = BT_COMPONENT_STATUS_OK;
924 goto end;
925 }
926
927 if (*nr_printed_fields > 0) {
5280f742 928 g_string_append(pretty->string, ", ");
6a18b281 929 } else {
5280f742 930 g_string_append(pretty->string, " ");
6a18b281
MD
931 }
932 if (print_names) {
6acddae3 933 print_field_name_equal(pretty, field_name);
6a18b281 934 }
3228cc1d 935 ret = print_field(pretty, field, print_names, NULL, 0);
2b4c4a7c 936 *nr_printed_fields += 1;
6a18b281
MD
937end:
938 bt_put(field_type);
939 bt_put(field);
940 return ret;
941}
942
943static
3228cc1d 944enum bt_component_status print_struct(struct pretty_component *pretty,
50842bdc 945 struct bt_field *_struct, bool print_names,
2b4c4a7c 946 GQuark *filter_fields, int filter_array_len)
6a18b281
MD
947{
948 enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
50842bdc 949 struct bt_field_type *struct_type = NULL;
2b4c4a7c 950 int nr_fields, i, nr_printed_fields;
6a18b281 951
50842bdc 952 struct_type = bt_field_get_type(_struct);
6a18b281
MD
953 if (!struct_type) {
954 ret = BT_COMPONENT_STATUS_ERROR;
955 goto end;
956 }
50842bdc 957 nr_fields = bt_field_type_structure_get_field_count(struct_type);
6a18b281
MD
958 if (nr_fields < 0) {
959 ret = BT_COMPONENT_STATUS_ERROR;
960 goto end;
961 }
5280f742 962 g_string_append(pretty->string, "{");
3228cc1d 963 pretty->depth++;
2b4c4a7c 964 nr_printed_fields = 0;
6a18b281 965 for (i = 0; i < nr_fields; i++) {
3228cc1d 966 ret = print_struct_field(pretty, _struct, struct_type, i,
2b4c4a7c
JD
967 print_names, &nr_printed_fields, filter_fields,
968 filter_array_len);
6a18b281
MD
969 if (ret != BT_COMPONENT_STATUS_OK) {
970 goto end;
971 }
972 }
3228cc1d 973 pretty->depth--;
5280f742 974 g_string_append(pretty->string, " }");
6a18b281
MD
975end:
976 bt_put(struct_type);
977 return ret;
978}
979
980static
3228cc1d 981enum bt_component_status print_array_field(struct pretty_component *pretty,
50842bdc 982 struct bt_field *array, uint64_t i,
6a18b281
MD
983 bool is_string, bool print_names)
984{
985 enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
50842bdc 986 struct bt_field *field = NULL;
6a18b281
MD
987
988 if (!is_string) {
989 if (i != 0) {
5280f742 990 g_string_append(pretty->string, ", ");
6a18b281 991 } else {
5280f742 992 g_string_append(pretty->string, " ");
6a18b281 993 }
60535549 994 if (print_names) {
5280f742 995 g_string_append_printf(pretty->string, "[%" PRIu64 "] = ", i);
60535549 996 }
6a18b281 997 }
50842bdc 998 field = bt_field_array_get_field(array, i);
6a18b281
MD
999 if (!field) {
1000 ret = BT_COMPONENT_STATUS_ERROR;
1001 goto end;
1002 }
3228cc1d 1003 ret = print_field(pretty, field, print_names, NULL, 0);
6a18b281
MD
1004end:
1005 bt_put(field);
1006 return ret;
1007}
1008
1009static
3228cc1d 1010enum bt_component_status print_array(struct pretty_component *pretty,
50842bdc 1011 struct bt_field *array, bool print_names)
6a18b281
MD
1012{
1013 enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
50842bdc
PP
1014 struct bt_field_type *array_type = NULL, *field_type = NULL;
1015 enum bt_field_type_id type_id;
6a18b281
MD
1016 int64_t len;
1017 uint64_t i;
1018 bool is_string = false;
1019
50842bdc 1020 array_type = bt_field_get_type(array);
6a18b281
MD
1021 if (!array_type) {
1022 ret = BT_COMPONENT_STATUS_ERROR;
1023 goto end;
1024 }
50842bdc 1025 field_type = bt_field_type_array_get_element_type(array_type);
6a18b281
MD
1026 if (!field_type) {
1027 ret = BT_COMPONENT_STATUS_ERROR;
1028 goto end;
1029 }
50842bdc 1030 len = bt_field_type_array_get_length(array_type);
6a18b281
MD
1031 if (len < 0) {
1032 ret = BT_COMPONENT_STATUS_ERROR;
1033 goto end;
1034 }
50842bdc
PP
1035 type_id = bt_field_type_get_type_id(field_type);
1036 if (type_id == BT_FIELD_TYPE_ID_INTEGER) {
1037 enum bt_string_encoding encoding;
6a18b281 1038
50842bdc
PP
1039 encoding = bt_field_type_integer_get_encoding(field_type);
1040 if (encoding == BT_STRING_ENCODING_UTF8
1041 || encoding == BT_STRING_ENCODING_ASCII) {
6a18b281
MD
1042 int integer_len, integer_alignment;
1043
50842bdc 1044 integer_len = bt_field_type_integer_get_size(field_type);
6a18b281
MD
1045 if (integer_len < 0) {
1046 return BT_COMPONENT_STATUS_ERROR;
1047 }
50842bdc 1048 integer_alignment = bt_field_type_get_alignment(field_type);
6a18b281
MD
1049 if (integer_alignment < 0) {
1050 return BT_COMPONENT_STATUS_ERROR;
1051 }
1052 if (integer_len == CHAR_BIT
1053 && integer_alignment == CHAR_BIT) {
1054 is_string = true;
1055 }
1056 }
1057 }
1058
1059 if (is_string) {
5280f742 1060 g_string_assign(pretty->tmp_string, "");
6a18b281 1061 } else {
5280f742 1062 g_string_append(pretty->string, "[");
6a18b281
MD
1063 }
1064
3228cc1d 1065 pretty->depth++;
6a18b281 1066 for (i = 0; i < len; i++) {
3228cc1d 1067 ret = print_array_field(pretty, array, i, is_string, print_names);
6a18b281
MD
1068 if (ret != BT_COMPONENT_STATUS_OK) {
1069 goto end;
1070 }
1071 }
3228cc1d 1072 pretty->depth--;
6a18b281
MD
1073
1074 if (is_string) {
3228cc1d 1075 if (pretty->use_colors) {
5280f742 1076 g_string_append(pretty->string, COLOR_STRING_VALUE);
ad96d936 1077 }
5280f742 1078 print_escape_string(pretty, pretty->tmp_string->str);
3228cc1d 1079 if (pretty->use_colors) {
5280f742 1080 g_string_append(pretty->string, COLOR_RST);
ad96d936 1081 }
6a18b281 1082 } else {
5280f742 1083 g_string_append(pretty->string, " ]");
6a18b281
MD
1084 }
1085end:
1086 bt_put(field_type);
1087 bt_put(array_type);
1088 return ret;
1089}
1090
1091static
3228cc1d 1092enum bt_component_status print_sequence_field(struct pretty_component *pretty,
50842bdc 1093 struct bt_field *seq, uint64_t i,
6a18b281
MD
1094 bool is_string, bool print_names)
1095{
1096 enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
50842bdc 1097 struct bt_field *field = NULL;
6a18b281
MD
1098
1099 if (!is_string) {
1100 if (i != 0) {
5280f742 1101 g_string_append(pretty->string, ", ");
6a18b281 1102 } else {
5280f742 1103 g_string_append(pretty->string, " ");
6a18b281 1104 }
60535549 1105 if (print_names) {
5280f742 1106 g_string_append_printf(pretty->string, "[%" PRIu64 "] = ", i);
60535549 1107 }
6a18b281 1108 }
50842bdc 1109 field = bt_field_sequence_get_field(seq, i);
6a18b281
MD
1110 if (!field) {
1111 ret = BT_COMPONENT_STATUS_ERROR;
1112 goto end;
1113 }
3228cc1d 1114 ret = print_field(pretty, field, print_names, NULL, 0);
6a18b281
MD
1115end:
1116 bt_put(field);
1117 return ret;
1118}
1119
1120static
3228cc1d 1121enum bt_component_status print_sequence(struct pretty_component *pretty,
50842bdc 1122 struct bt_field *seq, bool print_names)
6a18b281
MD
1123{
1124 enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
50842bdc
PP
1125 struct bt_field_type *seq_type = NULL, *field_type = NULL;
1126 struct bt_field *length_field = NULL;
1127 enum bt_field_type_id type_id;
6a18b281
MD
1128 uint64_t len;
1129 uint64_t i;
1130 bool is_string = false;
1131
50842bdc 1132 seq_type = bt_field_get_type(seq);
6a18b281
MD
1133 if (!seq_type) {
1134 ret = BT_COMPONENT_STATUS_ERROR;
1135 goto end;
1136 }
50842bdc 1137 length_field = bt_field_sequence_get_length(seq);
6a18b281
MD
1138 if (!length_field) {
1139 ret = BT_COMPONENT_STATUS_ERROR;
1140 goto end;
1141 }
50842bdc 1142 if (bt_field_unsigned_integer_get_value(length_field, &len) < 0) {
6a18b281
MD
1143 ret = BT_COMPONENT_STATUS_ERROR;
1144 goto end;
1145 }
50842bdc 1146 field_type = bt_field_type_sequence_get_element_type(seq_type);
6a18b281
MD
1147 if (!field_type) {
1148 ret = BT_COMPONENT_STATUS_ERROR;
1149 goto end;
1150 }
50842bdc
PP
1151 type_id = bt_field_type_get_type_id(field_type);
1152 if (type_id == BT_FIELD_TYPE_ID_INTEGER) {
1153 enum bt_string_encoding encoding;
6a18b281 1154
50842bdc
PP
1155 encoding = bt_field_type_integer_get_encoding(field_type);
1156 if (encoding == BT_STRING_ENCODING_UTF8
1157 || encoding == BT_STRING_ENCODING_ASCII) {
6a18b281
MD
1158 int integer_len, integer_alignment;
1159
50842bdc 1160 integer_len = bt_field_type_integer_get_size(field_type);
6a18b281
MD
1161 if (integer_len < 0) {
1162 ret = BT_COMPONENT_STATUS_ERROR;
1163 goto end;
1164 }
50842bdc 1165 integer_alignment = bt_field_type_get_alignment(field_type);
6a18b281
MD
1166 if (integer_alignment < 0) {
1167 ret = BT_COMPONENT_STATUS_ERROR;
1168 goto end;
1169 }
1170 if (integer_len == CHAR_BIT
1171 && integer_alignment == CHAR_BIT) {
1172 is_string = true;
1173 }
1174 }
1175 }
1176
1177 if (is_string) {
5280f742 1178 g_string_assign(pretty->tmp_string, "");
6a18b281 1179 } else {
5280f742 1180 g_string_append(pretty->string, "[");
6a18b281
MD
1181 }
1182
3228cc1d 1183 pretty->depth++;
6a18b281 1184 for (i = 0; i < len; i++) {
3228cc1d 1185 ret = print_sequence_field(pretty, seq, i,
6a18b281
MD
1186 is_string, print_names);
1187 if (ret != BT_COMPONENT_STATUS_OK) {
1188 goto end;
1189 }
1190 }
3228cc1d 1191 pretty->depth--;
6a18b281
MD
1192
1193 if (is_string) {
3228cc1d 1194 if (pretty->use_colors) {
5280f742 1195 g_string_append(pretty->string, COLOR_STRING_VALUE);
ad96d936 1196 }
5280f742 1197 print_escape_string(pretty, pretty->tmp_string->str);
3228cc1d 1198 if (pretty->use_colors) {
5280f742 1199 g_string_append(pretty->string, COLOR_RST);
ad96d936 1200 }
6a18b281 1201 } else {
5280f742 1202 g_string_append(pretty->string, " ]");
6a18b281
MD
1203 }
1204end:
1205 bt_put(length_field);
1206 bt_put(field_type);
1207 bt_put(seq_type);
1208 return ret;
1209}
1210
1211static
3228cc1d 1212enum bt_component_status print_variant(struct pretty_component *pretty,
50842bdc 1213 struct bt_field *variant, bool print_names)
6a18b281
MD
1214{
1215 enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
50842bdc 1216 struct bt_field *field = NULL;
6a18b281 1217
50842bdc 1218 field = bt_field_variant_get_current_field(variant);
6a18b281
MD
1219 if (!field) {
1220 ret = BT_COMPONENT_STATUS_ERROR;
1221 goto end;
1222 }
5280f742 1223 g_string_append(pretty->string, "{ ");
3228cc1d 1224 pretty->depth++;
6a18b281 1225 if (print_names) {
e0f15669 1226 int iter_ret;
50842bdc 1227 struct bt_field *tag_field = NULL;
6a18b281 1228 const char *tag_choice;
50842bdc 1229 struct bt_field_type_enumeration_mapping_iterator *iter;
6a18b281 1230
50842bdc 1231 tag_field = bt_field_variant_get_tag(variant);
6a18b281
MD
1232 if (!tag_field) {
1233 ret = BT_COMPONENT_STATUS_ERROR;
1234 goto end;
1235 }
e0f15669 1236
50842bdc
PP
1237 iter = bt_field_enumeration_get_mappings(tag_field);
1238 iter_ret = bt_field_type_enumeration_mapping_iterator_next(
74fb0452
JG
1239 iter);
1240 if (!iter || ret) {
e0f15669
JG
1241 bt_put(tag_field);
1242 ret = BT_COMPONENT_STATUS_ERROR;
1243 goto end;
1244 }
1245
1246 iter_ret =
50842bdc 1247 bt_field_type_enumeration_mapping_iterator_get_signed(
8803be2a 1248 iter, &tag_choice, NULL, NULL);
e0f15669
JG
1249 if (iter_ret) {
1250 bt_put(iter);
6a18b281
MD
1251 bt_put(tag_field);
1252 ret = BT_COMPONENT_STATUS_ERROR;
1253 goto end;
1254 }
6acddae3 1255 print_field_name_equal(pretty, tag_choice);
6a18b281 1256 bt_put(tag_field);
e0f15669 1257 bt_put(iter);
6a18b281 1258 }
3228cc1d 1259 ret = print_field(pretty, field, print_names, NULL, 0);
6a18b281
MD
1260 if (ret != BT_COMPONENT_STATUS_OK) {
1261 goto end;
1262 }
3228cc1d 1263 pretty->depth--;
5280f742 1264 g_string_append(pretty->string, " }");
6a18b281
MD
1265end:
1266 bt_put(field);
1267 return ret;
1268}
1269
1270static
3228cc1d 1271enum bt_component_status print_field(struct pretty_component *pretty,
50842bdc 1272 struct bt_field *field, bool print_names,
2b4c4a7c 1273 GQuark *filter_fields, int filter_array_len)
6a18b281 1274{
50842bdc 1275 enum bt_field_type_id type_id;
6a18b281 1276
50842bdc 1277 type_id = bt_field_get_type_id(field);
6a18b281
MD
1278 switch (type_id) {
1279 case CTF_TYPE_INTEGER:
3228cc1d 1280 return print_integer(pretty, field);
6a18b281
MD
1281 case CTF_TYPE_FLOAT:
1282 {
1283 double v;
1284
50842bdc 1285 if (bt_field_floating_point_get_value(field, &v)) {
6a18b281
MD
1286 return BT_COMPONENT_STATUS_ERROR;
1287 }
3228cc1d 1288 if (pretty->use_colors) {
5280f742 1289 g_string_append(pretty->string, COLOR_NUMBER_VALUE);
ad96d936 1290 }
5280f742 1291 g_string_append_printf(pretty->string, "%g", v);
3228cc1d 1292 if (pretty->use_colors) {
5280f742 1293 g_string_append(pretty->string, COLOR_RST);
ad96d936 1294 }
6a18b281
MD
1295 return BT_COMPONENT_STATUS_OK;
1296 }
1297 case CTF_TYPE_ENUM:
3228cc1d 1298 return print_enum(pretty, field);
6a18b281 1299 case CTF_TYPE_STRING:
95a518bf
JG
1300 {
1301 const char *str;
1302
50842bdc 1303 str = bt_field_string_get_value(field);
95a518bf
JG
1304 if (!str) {
1305 return BT_COMPONENT_STATUS_ERROR;
1306 }
1307
3228cc1d 1308 if (pretty->use_colors) {
5280f742 1309 g_string_append(pretty->string, COLOR_STRING_VALUE);
ad96d936 1310 }
95a518bf 1311 print_escape_string(pretty, str);
3228cc1d 1312 if (pretty->use_colors) {
5280f742 1313 g_string_append(pretty->string, COLOR_RST);
ad96d936 1314 }
6a18b281 1315 return BT_COMPONENT_STATUS_OK;
95a518bf 1316 }
6a18b281 1317 case CTF_TYPE_STRUCT:
3228cc1d 1318 return print_struct(pretty, field, print_names, filter_fields,
2b4c4a7c 1319 filter_array_len);
6a18b281 1320 case CTF_TYPE_VARIANT:
3228cc1d 1321 return print_variant(pretty, field, print_names);
6a18b281 1322 case CTF_TYPE_ARRAY:
3228cc1d 1323 return print_array(pretty, field, print_names);
6a18b281 1324 case CTF_TYPE_SEQUENCE:
3228cc1d 1325 return print_sequence(pretty, field, print_names);
6a18b281 1326 default:
5280f742 1327 // TODO: log instead
3228cc1d 1328 fprintf(pretty->err, "[error] Unknown type id: %d\n", (int) type_id);
6a18b281
MD
1329 return BT_COMPONENT_STATUS_ERROR;
1330 }
1331}
1332
1333static
3228cc1d 1334enum bt_component_status print_stream_packet_context(struct pretty_component *pretty,
50842bdc 1335 struct bt_event *event)
6a18b281
MD
1336{
1337 enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
50842bdc
PP
1338 struct bt_packet *packet = NULL;
1339 struct bt_field *main_field = NULL;
6a18b281 1340
50842bdc 1341 packet = bt_event_get_packet(event);
6a18b281
MD
1342 if (!packet) {
1343 ret = BT_COMPONENT_STATUS_ERROR;
1344 goto end;
1345 }
50842bdc 1346 main_field = bt_packet_get_context(packet);
6a18b281 1347 if (!main_field) {
6a18b281
MD
1348 goto end;
1349 }
3228cc1d 1350 if (!pretty->start_line) {
5280f742 1351 g_string_append(pretty->string, ", ");
6e1bc0df 1352 }
3228cc1d
PP
1353 pretty->start_line = false;
1354 if (pretty->options.print_scope_field_names) {
1355 print_name_equal(pretty, "stream.packet.context");
6a18b281 1356 }
3228cc1d
PP
1357 ret = print_field(pretty, main_field,
1358 pretty->options.print_context_field_names,
2b4c4a7c
JD
1359 stream_packet_context_quarks,
1360 STREAM_PACKET_CONTEXT_QUARKS_LEN);
6a18b281
MD
1361end:
1362 bt_put(main_field);
1363 bt_put(packet);
1364 return ret;
1365}
1366
1367static
3228cc1d 1368enum bt_component_status print_event_header_raw(struct pretty_component *pretty,
50842bdc 1369 struct bt_event *event)
6a18b281
MD
1370{
1371 enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
50842bdc 1372 struct bt_field *main_field = NULL;
6a18b281 1373
50842bdc 1374 main_field = bt_event_get_header(event);
6a18b281 1375 if (!main_field) {
6a18b281
MD
1376 goto end;
1377 }
3228cc1d 1378 if (!pretty->start_line) {
5280f742 1379 g_string_append(pretty->string, ", ");
6e1bc0df 1380 }
3228cc1d
PP
1381 pretty->start_line = false;
1382 if (pretty->options.print_scope_field_names) {
1383 print_name_equal(pretty, "stream.event.header");
6a18b281 1384 }
3228cc1d
PP
1385 ret = print_field(pretty, main_field,
1386 pretty->options.print_header_field_names, NULL, 0);
6a18b281
MD
1387end:
1388 bt_put(main_field);
1389 return ret;
1390}
1391
1392static
3228cc1d 1393enum bt_component_status print_stream_event_context(struct pretty_component *pretty,
50842bdc 1394 struct bt_event *event)
6a18b281
MD
1395{
1396 enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
50842bdc 1397 struct bt_field *main_field = NULL;
6a18b281 1398
50842bdc 1399 main_field = bt_event_get_stream_event_context(event);
6a18b281 1400 if (!main_field) {
6a18b281
MD
1401 goto end;
1402 }
3228cc1d 1403 if (!pretty->start_line) {
5280f742 1404 g_string_append(pretty->string, ", ");
6e1bc0df 1405 }
3228cc1d
PP
1406 pretty->start_line = false;
1407 if (pretty->options.print_scope_field_names) {
1408 print_name_equal(pretty, "stream.event.context");
6a18b281 1409 }
3228cc1d
PP
1410 ret = print_field(pretty, main_field,
1411 pretty->options.print_context_field_names, NULL, 0);
6a18b281
MD
1412end:
1413 bt_put(main_field);
1414 return ret;
1415}
1416
1417static
3228cc1d 1418enum bt_component_status print_event_context(struct pretty_component *pretty,
50842bdc 1419 struct bt_event *event)
6a18b281
MD
1420{
1421 enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
50842bdc 1422 struct bt_field *main_field = NULL;
6a18b281 1423
50842bdc 1424 main_field = bt_event_get_event_context(event);
6a18b281 1425 if (!main_field) {
6a18b281
MD
1426 goto end;
1427 }
3228cc1d 1428 if (!pretty->start_line) {
5280f742 1429 g_string_append(pretty->string, ", ");
6e1bc0df 1430 }
3228cc1d
PP
1431 pretty->start_line = false;
1432 if (pretty->options.print_scope_field_names) {
1433 print_name_equal(pretty, "event.context");
6a18b281 1434 }
3228cc1d
PP
1435 ret = print_field(pretty, main_field,
1436 pretty->options.print_context_field_names, NULL, 0);
6a18b281
MD
1437end:
1438 bt_put(main_field);
1439 return ret;
1440}
1441
1442static
3228cc1d 1443enum bt_component_status print_event_payload(struct pretty_component *pretty,
50842bdc 1444 struct bt_event *event)
6a18b281
MD
1445{
1446 enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
50842bdc 1447 struct bt_field *main_field = NULL;
6a18b281 1448
50842bdc 1449 main_field = bt_event_get_event_payload(event);
6a18b281 1450 if (!main_field) {
6a18b281
MD
1451 goto end;
1452 }
3228cc1d 1453 if (!pretty->start_line) {
5280f742 1454 g_string_append(pretty->string, ", ");
6e1bc0df 1455 }
3228cc1d
PP
1456 pretty->start_line = false;
1457 if (pretty->options.print_scope_field_names) {
1458 print_name_equal(pretty, "event.fields");
6a18b281 1459 }
3228cc1d
PP
1460 ret = print_field(pretty, main_field,
1461 pretty->options.print_payload_field_names, NULL, 0);
6a18b281
MD
1462end:
1463 bt_put(main_field);
af9a82eb
JG
1464 return ret;
1465}
1466
08899d39
PP
1467static
1468int flush_buf(struct pretty_component *pretty)
1469{
1470 int ret = 0;
1471
1472 if (pretty->string->len == 0) {
1473 goto end;
1474 }
1475
1476 if (fwrite(pretty->string->str, pretty->string->len, 1, pretty->out) != 1) {
1477 ret = -1;
1478 }
1479
1480end:
1481 return ret;
1482}
1483
af9a82eb 1484BT_HIDDEN
3228cc1d 1485enum bt_component_status pretty_print_event(struct pretty_component *pretty,
d9f65f09 1486 struct bt_notification *event_notif)
af9a82eb
JG
1487{
1488 enum bt_component_status ret;
50842bdc 1489 struct bt_event *event =
d9f65f09
PP
1490 bt_notification_event_get_event(event_notif);
1491 struct bt_clock_class_priority_map *cc_prio_map =
1492 bt_notification_event_get_clock_class_priority_map(event_notif);
af9a82eb 1493
d9f65f09
PP
1494 assert(event);
1495 assert(cc_prio_map);
3228cc1d 1496 pretty->start_line = true;
5280f742 1497 g_string_assign(pretty->string, "");
d9f65f09 1498 ret = print_event_header(pretty, event, cc_prio_map);
af9a82eb
JG
1499 if (ret != BT_COMPONENT_STATUS_OK) {
1500 goto end;
1501 }
6a18b281 1502
3228cc1d 1503 ret = print_stream_packet_context(pretty, event);
6a18b281
MD
1504 if (ret != BT_COMPONENT_STATUS_OK) {
1505 goto end;
1506 }
6a18b281 1507
3228cc1d
PP
1508 if (pretty->options.verbose) {
1509 ret = print_event_header_raw(pretty, event);
60535549
JD
1510 if (ret != BT_COMPONENT_STATUS_OK) {
1511 goto end;
1512 }
6a18b281 1513 }
6a18b281 1514
3228cc1d 1515 ret = print_stream_event_context(pretty, event);
6a18b281
MD
1516 if (ret != BT_COMPONENT_STATUS_OK) {
1517 goto end;
1518 }
6a18b281 1519
3228cc1d 1520 ret = print_event_context(pretty, event);
6a18b281
MD
1521 if (ret != BT_COMPONENT_STATUS_OK) {
1522 goto end;
1523 }
6a18b281 1524
3228cc1d 1525 ret = print_event_payload(pretty, event);
6a18b281
MD
1526 if (ret != BT_COMPONENT_STATUS_OK) {
1527 goto end;
1528 }
af9a82eb 1529
5280f742 1530 g_string_append_c(pretty->string, '\n');
08899d39 1531 if (flush_buf(pretty)) {
5280f742
PP
1532 ret = BT_COMPONENT_STATUS_ERROR;
1533 goto end;
1534 }
1535
af9a82eb 1536end:
d9f65f09
PP
1537 bt_put(event);
1538 bt_put(cc_prio_map);
af9a82eb
JG
1539 return ret;
1540}
08899d39
PP
1541
1542BT_HIDDEN
1543enum bt_component_status pretty_print_discarded_elements(
1544 struct pretty_component *pretty,
1545 struct bt_notification *notif)
1546{
1547 enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
50842bdc
PP
1548 struct bt_stream *stream = NULL;
1549 struct bt_stream_class *stream_class = NULL;
1550 struct bt_trace *trace = NULL;
08899d39
PP
1551 const char *stream_name;
1552 const char *trace_name;
1553 const unsigned char *trace_uuid;
1554 int64_t stream_class_id;
1555 int64_t stream_id;
1556 bool is_discarded_events;
89bd87b6 1557 int64_t count;
50842bdc 1558 struct bt_clock_value *clock_value = NULL;
08899d39
PP
1559
1560 /* Stream name */
1561 switch (bt_notification_get_type(notif)) {
1562 case BT_NOTIFICATION_TYPE_DISCARDED_EVENTS:
1563 stream = bt_notification_discarded_events_get_stream(notif);
89bd87b6 1564 count = bt_notification_discarded_events_get_count(notif);
08899d39
PP
1565 is_discarded_events = true;
1566 break;
1567 case BT_NOTIFICATION_TYPE_DISCARDED_PACKETS:
1568 stream = bt_notification_discarded_packets_get_stream(notif);
89bd87b6 1569 count = bt_notification_discarded_packets_get_count(notif);
08899d39
PP
1570 is_discarded_events = false;
1571 break;
1572 default:
1573 abort();
1574 }
1575
1576 assert(stream);
50842bdc 1577 stream_name = bt_stream_get_name(stream);
08899d39
PP
1578
1579 /* Stream class ID */
50842bdc 1580 stream_class = bt_stream_get_class(stream);
08899d39 1581 assert(stream_class);
50842bdc 1582 stream_class_id = bt_stream_class_get_id(stream_class);
08899d39
PP
1583
1584 /* Stream ID */
50842bdc 1585 stream_id = bt_stream_get_id(stream);
08899d39
PP
1586
1587 /* Trace path */
50842bdc 1588 trace = bt_stream_class_get_trace(stream_class);
08899d39 1589 assert(trace);
50842bdc 1590 trace_name = bt_trace_get_name(trace);
08899d39
PP
1591 if (!trace_name) {
1592 trace_name = "(unknown)";
1593 }
1594
1595 /* Trace UUID */
50842bdc 1596 trace_uuid = bt_trace_get_uuid(trace);
08899d39
PP
1597
1598 /*
1599 * Print to standard error stream to remain backward compatible
1600 * with Babeltrace 1.
1601 */
1602 fprintf(stderr,
89bd87b6 1603 "%s%sWARNING%s%s: Tracer discarded %" PRId64 " %s%s between [",
08899d39
PP
1604 bt_common_color_fg_yellow(),
1605 bt_common_color_bold(),
1606 bt_common_color_reset(),
1607 bt_common_color_fg_yellow(),
89bd87b6
PP
1608 count, is_discarded_events ? "event" : "packet",
1609 count == 1 ? "" : "s");
08899d39 1610 g_string_assign(pretty->string, "");
db14aa44 1611 clock_value = is_discarded_events ?
08899d39 1612 bt_notification_discarded_events_get_begin_clock_value(notif) :
db14aa44
PP
1613 bt_notification_discarded_packets_get_begin_clock_value(notif);
1614 print_timestamp_wall(pretty, clock_value);
1615 BT_PUT(clock_value);
08899d39
PP
1616 fprintf(stderr, "%s] and [", pretty->string->str);
1617 g_string_assign(pretty->string, "");
db14aa44 1618 clock_value = is_discarded_events ?
08899d39 1619 bt_notification_discarded_events_get_end_clock_value(notif) :
db14aa44
PP
1620 bt_notification_discarded_packets_get_end_clock_value(notif);
1621 print_timestamp_wall(pretty, clock_value);
1622 BT_PUT(clock_value);
08899d39
PP
1623 fprintf(stderr, "%s] in trace \"%s\" ",
1624 pretty->string->str, trace_name);
1625
1626 if (trace_uuid) {
1627 fprintf(stderr,
1628 "(UUID: %02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x) ",
1629 trace_uuid[0],
1630 trace_uuid[1],
1631 trace_uuid[2],
1632 trace_uuid[3],
1633 trace_uuid[4],
1634 trace_uuid[5],
1635 trace_uuid[6],
1636 trace_uuid[7],
1637 trace_uuid[8],
1638 trace_uuid[9],
1639 trace_uuid[10],
1640 trace_uuid[11],
1641 trace_uuid[12],
1642 trace_uuid[13],
1643 trace_uuid[14],
1644 trace_uuid[15]);
1645 } else {
1646 fprintf(stderr, "(no UUID) ");
1647 }
1648
1649 fprintf(stderr, "within stream \"%s\" (stream class ID: %" PRId64 ", ",
1650 stream_name, stream_class_id);
1651
1652 if (stream_id >= 0) {
1653 fprintf(stderr, "stream ID: %" PRId64, stream_id);
1654 } else {
1655 fprintf(stderr, "no stream ID");
1656 }
1657
1658 fprintf(stderr, ").%s\n", bt_common_color_reset());
1659 bt_put(stream);
1660 bt_put(stream_class);
1661 bt_put(trace);
db14aa44 1662 bt_put(clock_value);
08899d39
PP
1663 return ret;
1664}
This page took 0.122466 seconds and 4 git commands to generate.