* Babeltrace CTF Text Output Plugin Event Printing
*
* Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
+ * Copyright 2016 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
*
* Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
*
#include <babeltrace/ctf-ir/packet.h>
#include <babeltrace/ctf-ir/stream.h>
#include <babeltrace/ctf-ir/stream-class.h>
-#include <babeltrace/ctf-ir/clock.h>
+#include <babeltrace/ctf-ir/clock-class.h>
#include <babeltrace/ctf-ir/field-types.h>
#include <babeltrace/ctf-ir/fields.h>
#include <babeltrace/ctf-ir/trace.h>
#include <babeltrace/bitfield.h>
+#include <babeltrace/common-internal.h>
#include <inttypes.h>
#include "text.h"
#define NSEC_PER_SEC 1000000000LL
+#define COLOR_NAME BT_COMMON_COLOR_BOLD
+#define COLOR_FIELD_NAME BT_COMMON_COLOR_FG_CYAN
+#define COLOR_RST BT_COMMON_COLOR_RESET
+#define COLOR_STRING_VALUE BT_COMMON_COLOR_BOLD BT_COMMON_COLOR_FG_GREEN
+#define COLOR_NUMBER_VALUE BT_COMMON_COLOR_BOLD BT_COMMON_COLOR_FG_RED
+#define COLOR_ENUM_MAPPING_NAME BT_COMMON_COLOR_BOLD BT_COMMON_COLOR_FG_CYAN
+#define COLOR_UNKNOWN BT_COMMON_COLOR_BOLD BT_COMMON_COLOR_FG_RED
+#define COLOR_EVENT_NAME BT_COMMON_COLOR_BOLD BT_COMMON_COLOR_FG_MAGENTA
+#define COLOR_TIMESTAMP BT_COMMON_COLOR_BOLD BT_COMMON_COLOR_FG_YELLOW
+
static inline
const char *rem_(const char *str)
{
static
enum bt_component_status print_field(struct text_component *text,
- struct bt_ctf_field *field, bool print_names);
+ struct bt_ctf_field *field, bool print_names,
+ GQuark *filters_fields, int filter_array_len);
+
+static
+void print_name_equal(struct text_component *text, const char *name)
+{
+ if (text->use_colors) {
+ fprintf(text->out, "%s%s%s = ", COLOR_NAME, name, COLOR_RST);
+ } else {
+ fputs(name, text->out);
+ }
+}
+
+static
+void print_field_name_equal(struct text_component *text, const char *name)
+{
+ if (text->use_colors) {
+ fprintf(text->out, "%s%s%s = ", COLOR_FIELD_NAME, name,
+ COLOR_RST);
+ } else {
+ fputs(name, text->out);
+ }
+}
static
void print_timestamp_cycles(struct text_component *text,
- struct bt_ctf_clock *clock,
+ struct bt_ctf_clock_class *clock_class,
struct bt_ctf_event *event)
{
int ret;
struct bt_ctf_clock_value *clock_value;
uint64_t cycles;
- clock_value = bt_ctf_event_get_clock_value(event, clock);
+ clock_value = bt_ctf_event_get_clock_value(event, clock_class);
if (!clock_value) {
fputs("????????????????????", text->out);
return;
return;
}
fprintf(text->out, "%020" PRIu64, cycles);
+
+ if (text->last_cycles_timestamp != -1ULL) {
+ text->delta_cycles = cycles - text->last_cycles_timestamp;
+ }
+ text->last_cycles_timestamp = cycles;
}
static
void print_timestamp_wall(struct text_component *text,
- struct bt_ctf_clock *clock,
+ struct bt_ctf_clock_class *clock_class,
struct bt_ctf_event *event)
{
int ret;
uint64_t ts_sec_abs, ts_nsec_abs;
bool is_negative;
- clock_value = bt_ctf_event_get_clock_value(event, clock);
+ clock_value = bt_ctf_event_get_clock_value(event, clock_class);
if (!clock_value) {
fputs("??:??:??.?????????", text->out);
return;
return;
}
+ if (text->last_real_timestamp != -1ULL) {
+ text->delta_real_timestamp = ts_nsec - text->last_real_timestamp;
+ }
+ text->last_real_timestamp = ts_nsec;
+
ts_sec += ts_nsec / NSEC_PER_SEC;
ts_nsec = ts_nsec % NSEC_PER_SEC;
if (ts_sec >= 0 && ts_nsec >= 0) {
ts_nsec_abs = -ts_nsec;
}
- if (/*!opt_clock_seconds*/true) {
+ if (!text->options.clock_seconds) {
struct tm tm;
time_t time_s = (time_t) ts_sec_abs;
goto seconds;
}
- if (/*!opt_clock_gmt*/true) {
+ if (!text->options.clock_gmt) {
struct tm *res;
res = localtime_r(&time_s, &tm);
goto seconds;
}
}
- if (/*opt_clock_date*/false) {
+ if (text->options.clock_date) {
char timestr[26];
size_t res;
struct bt_ctf_stream *stream = NULL;
struct bt_ctf_stream_class *stream_class = NULL;
struct bt_ctf_trace *trace = NULL;
- struct bt_ctf_clock *clock = NULL;
+ struct bt_ctf_clock_class *clock_class = NULL;
FILE *out = text->out;
- FILE *err = text->err;
- uint64_t real_timestamp;
stream = bt_ctf_event_get_stream(event);
if (!stream) {
goto end;
}
- /* FIXME - error checking */
stream_class = bt_ctf_stream_get_class(stream);
+ if (!stream_class) {
+ ret = BT_COMPONENT_STATUS_ERROR;
+ goto end;
+ }
trace = bt_ctf_stream_class_get_trace(stream_class);
- clock = bt_ctf_trace_get_clock(trace, 0);
+ if (!trace) {
+ ret = BT_COMPONENT_STATUS_ERROR;
+ goto end;
+ }
+ clock_class = bt_ctf_trace_get_clock_class(trace, 0);
+ if (!clock_class) {
+ ret = BT_COMPONENT_STATUS_ERROR;
+ goto end;
+ }
- fputs(print_names ? "timestamp = " : "[", out);
+ if (print_names) {
+ print_name_equal(text, "timestamp");
+ } else {
+ fputs("[", out);
+ }
+ if (text->use_colors) {
+ fputs(COLOR_TIMESTAMP, text->out);
+ }
if (text->options.print_timestamp_cycles) {
- print_timestamp_cycles(text, clock, event);
+ print_timestamp_cycles(text, clock_class, event);
} else {
- print_timestamp_wall(text, clock, event);
+ print_timestamp_wall(text, clock_class, event);
+ }
+ if (text->use_colors) {
+ fputs(COLOR_RST, text->out);
}
if (!print_names)
fputs("] ", out);
- *start_line = !print_names;
- if (!text->options.print_delta_field) {
- goto end;
+ if (text->options.print_delta_field) {
+ if (print_names) {
+ fputs(", ", text->out);
+ print_name_equal(text, "delta");
+ } else {
+ fputs("(", text->out);
+ }
+ if (text->options.print_timestamp_cycles) {
+ if (text->delta_cycles == -1ULL) {
+ fputs("+??????????\?\?) ", text->out); /* Not a trigraph. */
+ } else {
+ fprintf(text->out, "+%012" PRIu64, text->delta_cycles);
+ }
+ } else {
+ if (text->delta_real_timestamp != -1ULL) {
+ uint64_t delta_sec, delta_nsec, delta;
+
+ delta = text->delta_real_timestamp;
+ delta_sec = delta / NSEC_PER_SEC;
+ delta_nsec = delta % NSEC_PER_SEC;
+ fprintf(text->out, "+%" PRIu64 ".%09" PRIu64,
+ delta_sec, delta_nsec);
+ } else {
+ fputs("+?.?????????", text->out);
+ }
+ }
+ if (!print_names) {
+ fputs(") ", text->out);
+ }
}
+ *start_line = !print_names;
+
end:
bt_put(stream);
- bt_put(clock);
+ bt_put(clock_class);
bt_put(stream_class);
bt_put(trace);
return ret;
}
text->start_line = false;
if (print_names) {
- fputs("trace = ", text->out);
+ print_name_equal(text, "trace");
}
fprintf(text->out, "%s", name);
}
}
text->start_line = false;
if (print_names) {
- fputs("trace:hostname = ", text->out);
+ print_name_equal(text, "trace:hostname");
}
if (bt_value_string_get(hostname_str, &str)
== BT_VALUE_STATUS_OK) {
}
text->start_line = false;
if (print_names) {
- fputs("trace:domain = ", text->out);
+ print_name_equal(text, "trace:domain");
}
if (bt_value_string_get(domain_str, &str)
== BT_VALUE_STATUS_OK) {
}
text->start_line = false;
if (print_names) {
- fputs("trace:procname = ", text->out);
+ print_name_equal(text, "trace:procname");
}
if (bt_value_string_get(procname_str, &str)
== BT_VALUE_STATUS_OK) {
}
text->start_line = false;
if (print_names) {
- fputs("trace:vpid = ", text->out);
+ print_name_equal(text, "trace:vpid");
}
if (bt_value_integer_get(vpid_value, &value)
== BT_VALUE_STATUS_OK) {
}
text->start_line = false;
if (print_names) {
- fputs("loglevel = ", text->out);
+ print_name_equal(text, "loglevel");
}
if (loglevel_str) {
const char *str;
}
text->start_line = false;
if (print_names) {
- fputs("model.emf.uri = ", text->out);
+ print_name_equal(text, "model.emf.uri");
}
if (uri_str) {
const char *str;
bt_put(uri_str);
}
}
- if (text->options.print_callsite_field) {
- if (!text->start_line) {
- fputs(", ", text->out);
- }
- text->start_line = false;
- if (print_names) {
- fputs("callsite = ", text->out);
- }
- /* TODO */
- }
if (!text->start_line) {
fputs(", ", text->out);
}
text->start_line = false;
if (print_names) {
- fputs("name = ", text->out);
+ print_name_equal(text, "name");
+ }
+ if (text->use_colors) {
+ fputs(COLOR_EVENT_NAME, text->out);
}
fputs(bt_ctf_event_class_get_name(event_class), text->out);
+ if (text->use_colors) {
+ fputs(COLOR_RST, text->out);
+ }
end:
bt_put(trace_class);
bt_put(stream_class);
uint64_t u;
int64_t s;
} v;
+ bool rst_color = false;
field_type = bt_ctf_field_get_type(field);
if (!field_type) {
goto end;
}
+ if (text->use_colors) {
+ fputs(COLOR_NUMBER_VALUE, text->out);
+ rst_color = true;
+ }
+
base = bt_ctf_field_type_integer_get_base(field_type);
switch (base) {
case BT_CTF_INTEGER_BASE_BINARY:
goto end;
}
end:
+ if (rst_color) {
+ fputs(COLOR_RST, text->out);
+ }
bt_put(field_type);
return ret;
}
{
enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
struct bt_ctf_field *container_field = NULL;
- const char *mapping_name;
-
+ struct bt_ctf_field_type *enumeration_field_type = NULL;
+ struct bt_ctf_field_type *container_field_type = NULL;
+ struct bt_ctf_field_type_enumeration_mapping_iterator *iter = NULL;
+ int nr_mappings = 0;
+ int is_signed;
+
+ enumeration_field_type = bt_ctf_field_get_type(field);
+ if (!enumeration_field_type) {
+ ret = BT_COMPONENT_STATUS_ERROR;
+ goto end;
+ }
container_field = bt_ctf_field_enumeration_get_container(field);
if (!container_field) {
ret = BT_COMPONENT_STATUS_ERROR;
goto end;
}
- mapping_name = bt_ctf_field_enumeration_get_mapping_name(field);
- if (mapping_name) {
- fprintf(text->out, "( \"%s\"", mapping_name);
+ container_field_type = bt_ctf_field_get_type(container_field);
+ if (!container_field_type) {
+ ret = BT_COMPONENT_STATUS_ERROR;
+ goto end;
+ }
+ is_signed = bt_ctf_field_type_integer_get_signed(container_field_type);
+ if (is_signed < 0) {
+ ret = BT_COMPONENT_STATUS_ERROR;
+ goto end;
+ }
+ if (is_signed) {
+ int64_t value;
+
+ if (bt_ctf_field_signed_integer_get_value(container_field,
+ &value)) {
+ ret = BT_COMPONENT_STATUS_ERROR;
+ goto end;
+ }
+ iter = bt_ctf_field_type_enumeration_find_mappings_by_signed_value(
+ enumeration_field_type, value);
} else {
- fprintf(text->out, "( <unknown>");
+ uint64_t value;
+
+ if (bt_ctf_field_unsigned_integer_get_value(container_field,
+ &value)) {
+ ret = BT_COMPONENT_STATUS_ERROR;
+ goto end;
+ }
+ iter = bt_ctf_field_type_enumeration_find_mappings_by_unsigned_value(
+ enumeration_field_type, value);
+ }
+ if (!iter) {
+ ret = BT_COMPONENT_STATUS_ERROR;
+ goto end;
+ }
+ fprintf(text->out, "( ");
+ for (;;) {
+ const char *mapping_name;
+
+ if (bt_ctf_field_type_enumeration_mapping_iterator_get_signed(
+ iter, &mapping_name, NULL, NULL) < 0) {
+ ret = BT_COMPONENT_STATUS_ERROR;
+ goto end;
+ }
+ if (nr_mappings++)
+ fprintf(text->out, ", ");
+ if (text->use_colors) {
+ fputs(COLOR_ENUM_MAPPING_NAME, text->out);
+ }
+ // TODO: escape string
+ fprintf(text->out, "\"%s\"", mapping_name);
+ if (text->use_colors) {
+ fputs(COLOR_RST, text->out);
+ }
+ if (bt_ctf_field_type_enumeration_mapping_iterator_next(iter) < 0) {
+ break;
+ }
+ }
+ if (!nr_mappings) {
+ if (text->use_colors) {
+ fputs(COLOR_UNKNOWN, text->out);
+ }
+ fprintf(text->out, "<unknown>");
+ if (text->use_colors) {
+ fputs(COLOR_RST, text->out);
+ }
}
fprintf(text->out, " : container = ");
ret = print_integer(text, container_field);
}
fprintf(text->out, " )");
end:
+ bt_put(iter);
+ bt_put(container_field_type);
bt_put(container_field);
+ bt_put(enumeration_field_type);
return ret;
}
+static
+int filter_field_name(struct text_component *text, const char *field_name,
+ GQuark *filter_fields, int filter_array_len)
+{
+ int i;
+ GQuark field_quark = g_quark_try_string(field_name);
+
+ if (!field_quark || text->options.verbose) {
+ return 1;
+ }
+
+ for (i = 0; i < filter_array_len; i++) {
+ if (field_quark == filter_fields[i]) {
+ return 0;
+ }
+ }
+ return 1;
+}
+
static
enum bt_component_status print_struct_field(struct text_component *text,
struct bt_ctf_field *_struct,
struct bt_ctf_field_type *struct_type,
- int i, bool print_names)
+ int i, bool print_names, int *nr_printed_fields,
+ GQuark *filter_fields, int filter_array_len)
{
enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
const char *field_name;
goto end;
}
- if (i != 0) {
+ if (filter_fields && !filter_field_name(text, field_name,
+ filter_fields, filter_array_len)) {
+ ret = BT_COMPONENT_STATUS_OK;
+ goto end;
+ }
+
+ if (*nr_printed_fields > 0) {
fprintf(text->out, ", ");
} else {
fprintf(text->out, " ");
}
if (print_names) {
- fprintf(text->out, "%s = ", rem_(field_name));
+ print_field_name_equal(text, rem_(field_name));
}
- ret = print_field(text, field, print_names);
+ ret = print_field(text, field, print_names, NULL, 0);
+ *nr_printed_fields += 1;
end:
bt_put(field_type);
bt_put(field);
static
enum bt_component_status print_struct(struct text_component *text,
- struct bt_ctf_field *_struct, bool print_names)
+ struct bt_ctf_field *_struct, bool print_names,
+ GQuark *filter_fields, int filter_array_len)
{
enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
struct bt_ctf_field_type *struct_type = NULL;
- int nr_fields, i;
+ int nr_fields, i, nr_printed_fields;
struct_type = bt_ctf_field_get_type(_struct);
if (!struct_type) {
}
fprintf(text->out, "{");
text->depth++;
+ nr_printed_fields = 0;
for (i = 0; i < nr_fields; i++) {
ret = print_struct_field(text, _struct, struct_type, i,
- print_names);
+ print_names, &nr_printed_fields, filter_fields,
+ filter_array_len);
if (ret != BT_COMPONENT_STATUS_OK) {
goto end;
}
ret = BT_COMPONENT_STATUS_ERROR;
goto end;
}
- ret = print_field(text, field, print_names);
+ ret = print_field(text, field, print_names, NULL, 0);
end:
bt_put(field);
return ret;
text->depth--;
if (is_string) {
+ if (text->use_colors) {
+ fputs(COLOR_STRING_VALUE, text->out);
+ }
+ // TODO: escape string
fprintf(text->out, "\"%s\"", text->string->str);
+ if (text->use_colors) {
+ fputs(COLOR_RST, text->out);
+ }
} else {
fprintf(text->out, " ]");
}
ret = BT_COMPONENT_STATUS_ERROR;
goto end;
}
- ret = print_field(text, field, print_names);
+ ret = print_field(text, field, print_names, NULL, 0);
end:
bt_put(field);
return ret;
text->depth--;
if (is_string) {
+ if (text->use_colors) {
+ fputs(COLOR_STRING_VALUE, text->out);
+ }
+ // TODO: escape string
fprintf(text->out, "\"%s\"", text->string->str);
+ if (text->use_colors) {
+ fputs(COLOR_RST, text->out);
+ }
} else {
fprintf(text->out, " ]");
}
fprintf(text->out, "{ ");
text->depth++;
if (print_names) {
+ int iter_ret;
struct bt_ctf_field *tag_field = NULL;
const char *tag_choice;
+ struct bt_ctf_field_type_enumeration_mapping_iterator *iter;
tag_field = bt_ctf_field_variant_get_tag(variant);
if (!tag_field) {
ret = BT_COMPONENT_STATUS_ERROR;
goto end;
}
- tag_choice = bt_ctf_field_enumeration_get_mapping_name(tag_field);
- if (!tag_choice) {
+
+ iter = bt_ctf_field_enumeration_get_mappings(tag_field);
+ if (!iter) {
bt_put(tag_field);
ret = BT_COMPONENT_STATUS_ERROR;
goto end;
}
- fprintf(text->out, "%s = ", rem_(tag_choice));
+
+ iter_ret =
+ bt_ctf_field_type_enumeration_mapping_iterator_get_signed(
+ iter, &tag_choice, NULL, NULL);
+ if (iter_ret) {
+ bt_put(iter);
+ bt_put(tag_field);
+ ret = BT_COMPONENT_STATUS_ERROR;
+ goto end;
+ }
+ print_field_name_equal(text, rem_(tag_choice));
bt_put(tag_field);
+ bt_put(iter);
}
- ret = print_field(text, field, print_names);
+ ret = print_field(text, field, print_names, NULL, 0);
if (ret != BT_COMPONENT_STATUS_OK) {
goto end;
}
static
enum bt_component_status print_field(struct text_component *text,
- struct bt_ctf_field *field, bool print_names)
+ struct bt_ctf_field *field, bool print_names,
+ GQuark *filter_fields, int filter_array_len)
{
enum bt_ctf_type_id type_id;
if (bt_ctf_field_floating_point_get_value(field, &v)) {
return BT_COMPONENT_STATUS_ERROR;
}
+ if (text->use_colors) {
+ fputs(COLOR_NUMBER_VALUE, text->out);
+ }
fprintf(text->out, "%g", v);
+ if (text->use_colors) {
+ fputs(COLOR_RST, text->out);
+ }
return BT_COMPONENT_STATUS_OK;
}
case CTF_TYPE_ENUM:
return print_enum(text, field);
case CTF_TYPE_STRING:
- fprintf(text->out, "\"%s\"", bt_ctf_field_string_get_value(field));
+ if (text->use_colors) {
+ fputs(COLOR_STRING_VALUE, text->out);
+ }
+ // TODO: escape the string value
+ fprintf(text->out, "\"%s\"",
+ bt_ctf_field_string_get_value(field));
+ if (text->use_colors) {
+ fputs(COLOR_RST, text->out);
+ }
return BT_COMPONENT_STATUS_OK;
case CTF_TYPE_STRUCT:
- return print_struct(text, field, print_names);
+ return print_struct(text, field, print_names, filter_fields,
+ filter_array_len);
case CTF_TYPE_UNTAGGED_VARIANT:
case CTF_TYPE_VARIANT:
return print_variant(text, field, print_names);
}
main_field = bt_ctf_packet_get_context(packet);
if (!main_field) {
- ret = BT_COMPONENT_STATUS_ERROR;
goto end;
}
if (!text->start_line) {
}
text->start_line = false;
if (text->options.print_scope_field_names) {
- fputs("stream.packet.context = ", text->out);
+ print_name_equal(text, "stream.packet.context");
}
ret = print_field(text, main_field,
- text->options.print_context_field_names);
+ text->options.print_context_field_names,
+ stream_packet_context_quarks,
+ STREAM_PACKET_CONTEXT_QUARKS_LEN);
end:
bt_put(main_field);
bt_put(packet);
main_field = bt_ctf_event_get_header(event);
if (!main_field) {
- ret = BT_COMPONENT_STATUS_ERROR;
goto end;
}
if (!text->start_line) {
}
text->start_line = false;
if (text->options.print_scope_field_names) {
- fputs("stream.event.header = ", text->out);
+ print_name_equal(text, "stream.event.header");
}
ret = print_field(text, main_field,
- text->options.print_header_field_names);
+ text->options.print_header_field_names, NULL, 0);
end:
bt_put(main_field);
return ret;
main_field = bt_ctf_event_get_stream_event_context(event);
if (!main_field) {
- ret = BT_COMPONENT_STATUS_ERROR;
goto end;
}
if (!text->start_line) {
}
text->start_line = false;
if (text->options.print_scope_field_names) {
- fputs("stream.event.context = ", text->out);
+ print_name_equal(text, "stream.event.context");
}
ret = print_field(text, main_field,
- text->options.print_context_field_names);
+ text->options.print_context_field_names, NULL, 0);
end:
bt_put(main_field);
return ret;
main_field = bt_ctf_event_get_event_context(event);
if (!main_field) {
- ret = BT_COMPONENT_STATUS_ERROR;
goto end;
}
if (!text->start_line) {
}
text->start_line = false;
if (text->options.print_scope_field_names) {
- fputs("event.context = ", text->out);
+ print_name_equal(text, "event.context");
}
ret = print_field(text, main_field,
- text->options.print_context_field_names);
+ text->options.print_context_field_names, NULL, 0);
end:
bt_put(main_field);
return ret;
main_field = bt_ctf_event_get_payload_field(event);
if (!main_field) {
- ret = BT_COMPONENT_STATUS_ERROR;
goto end;
}
if (!text->start_line) {
}
text->start_line = false;
if (text->options.print_scope_field_names) {
- fputs("event.fields = ", text->out);
+ print_name_equal(text, "event.fields");
}
ret = print_field(text, main_field,
- text->options.print_payload_field_names);
+ text->options.print_payload_field_names, NULL, 0);
end:
bt_put(main_field);
return ret;