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