sink.text.pretty: print discarded events/packets warning

Add back the discarded element message when a packet beginning's packet
object has non-zero discarded event or packet counts.

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>

diff --git a/plugins/text/pretty/pretty.c b/plugins/text/pretty/pretty.c
index 1def0826b12e8a07b060c37c7ef65c8a4c1846ea..154fa255796b4cffd9d64cb16eae992264078342 100644 (file)
--- a/plugins/text/pretty/pretty.c
+++ b/plugins/text/pretty/pretty.c
@@ -134,6 +134,9 @@ enum bt_component_status handle_notification(struct pretty_component *pretty,
        BT_ASSERT(pretty);
 
        switch (bt_notification_get_type(notification)) {
+       case BT_NOTIFICATION_TYPE_PACKET_BEGIN:
+               ret = pretty_print_packet(pretty, notification);
+               break;
        case BT_NOTIFICATION_TYPE_EVENT:
                ret = pretty_print_event(pretty, notification);
                break;

diff --git a/plugins/text/pretty/pretty.h b/plugins/text/pretty/pretty.h
index 76e4217e68f16592c08c915479d31e2d72ec3849..d2753bf4c152987b503cd42cb35d2b3ae8e3fd03 100644 (file)
--- a/plugins/text/pretty/pretty.h
+++ b/plugins/text/pretty/pretty.h
@@ -127,4 +127,8 @@ BT_HIDDEN
 enum bt_component_status pretty_print_event(struct pretty_component *pretty,
                struct bt_notification *event_notif);
 
+BT_HIDDEN
+enum bt_component_status pretty_print_packet(struct pretty_component *pretty,
+               struct bt_notification *packet_beginning_notif);
+
 #endif /* BABELTRACE_PLUGIN_TEXT_PRETTY_PRETTY_H */

diff --git a/plugins/text/pretty/print.c b/plugins/text/pretty/print.c
index 656d1971d327b2c4222f10c51a09fbf74c9676df..34967e66d6fad84c2215b2f2f01cb3a21420ac45 100644 (file)
--- a/plugins/text/pretty/print.c
+++ b/plugins/text/pretty/print.c
@@ -1450,7 +1450,7 @@ end:
 }
 
 static
-int flush_buf(struct pretty_component *pretty)
+int flush_buf(FILE *stream, struct pretty_component *pretty)
 {
        int ret = 0;
 
@@ -1458,7 +1458,7 @@ int flush_buf(struct pretty_component *pretty)
                goto end;
        }
 
-       if (fwrite(pretty->string->str, pretty->string->len, 1, pretty->out) != 1) {
+       if (fwrite(pretty->string->str, pretty->string->len, 1, stream) != 1) {
                ret = -1;
        }
 
@@ -1510,7 +1510,7 @@ enum bt_component_status pretty_print_event(struct pretty_component *pretty,
        }
 
        g_string_append_c(pretty->string, '\n');
-       if (flush_buf(pretty)) {
+       if (flush_buf(pretty->out, pretty)) {
                ret = BT_COMPONENT_STATUS_ERROR;
                goto end;
        }
@@ -1518,3 +1518,154 @@ enum bt_component_status pretty_print_event(struct pretty_component *pretty,
 end:
        return ret;
 }
+
+static
+enum bt_component_status print_discarded_elements_msg(
+               struct pretty_component *pretty, struct bt_packet *packet,
+               uint64_t count, const char *elem_type)
+{
+       enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
+       struct bt_stream *stream = NULL;
+       struct bt_stream_class *stream_class = NULL;
+       struct bt_trace *trace = NULL;
+       const char *stream_name;
+       const char *trace_name;
+       const unsigned char *trace_uuid;
+       int64_t stream_class_id;
+       int64_t stream_id;
+       struct bt_clock_value *begin_clock_value = NULL;
+       struct bt_clock_value *end_clock_value = NULL;
+
+       /* Stream name */
+       BT_ASSERT(packet);
+       stream = bt_packet_borrow_stream(packet);
+       BT_ASSERT(stream);
+       stream_name = bt_stream_get_name(stream);
+
+       /* Stream class ID */
+       stream_class = bt_stream_borrow_class(stream);
+       BT_ASSERT(stream_class);
+       stream_class_id = bt_stream_class_get_id(stream_class);
+
+       /* Stream ID */
+       stream_id = bt_stream_get_id(stream);
+
+       /* Trace name */
+       trace = bt_stream_class_borrow_trace(stream_class);
+       BT_ASSERT(trace);
+       trace_name = bt_trace_get_name(trace);
+       if (!trace_name) {
+               trace_name = "(unknown)";
+       }
+
+       /* Trace UUID */
+       trace_uuid = bt_trace_get_uuid(trace);
+
+       /* Beginning and end times */
+       (void) bt_packet_borrow_previous_packet_default_end_clock_value(
+               packet, &begin_clock_value);
+       (void) bt_packet_borrow_default_end_clock_value(packet,
+               &end_clock_value);
+
+       /* Format message */
+       g_string_assign(pretty->string, "");
+       g_string_append_printf(pretty->string,
+               "%s%sWARNING%s%s: Tracer discarded %" PRId64 " %s%s ",
+               bt_common_color_fg_yellow(),
+               bt_common_color_bold(),
+               bt_common_color_reset(),
+               bt_common_color_fg_yellow(),
+               count, elem_type, count == 1 ? "" : "s");
+
+       if (begin_clock_value && end_clock_value) {
+               g_string_append(pretty->string, "between [");
+               print_timestamp_wall(pretty, begin_clock_value);
+               g_string_append(pretty->string, "] and [");
+               print_timestamp_wall(pretty, end_clock_value);
+               g_string_append(pretty->string, "]");
+       } else {
+               g_string_append(pretty->string, "(unknown time range)");
+       }
+
+       g_string_append_printf(pretty->string, " in trace \"%s\" ", trace_name);
+
+       if (trace_uuid) {
+               g_string_append_printf(pretty->string,
+                       "(UUID: %02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x) ",
+                       trace_uuid[0],
+                       trace_uuid[1],
+                       trace_uuid[2],
+                       trace_uuid[3],
+                       trace_uuid[4],
+                       trace_uuid[5],
+                       trace_uuid[6],
+                       trace_uuid[7],
+                       trace_uuid[8],
+                       trace_uuid[9],
+                       trace_uuid[10],
+                       trace_uuid[11],
+                       trace_uuid[12],
+                       trace_uuid[13],
+                       trace_uuid[14],
+                       trace_uuid[15]);
+       } else {
+               g_string_append(pretty->string, "(no UUID) ");
+       }
+
+       g_string_append_printf(pretty->string,
+               "within stream \"%s\" (stream class ID: %" PRId64 ", ",
+               stream_name, stream_class_id);
+
+       if (stream_id >= 0) {
+               g_string_append_printf(pretty->string,
+                       "stream ID: %" PRId64, stream_id);
+       } else {
+               g_string_append(pretty->string, "no stream ID");
+       }
+
+       g_string_append_printf(pretty->string, ").%s\n",
+               bt_common_color_reset());
+
+       /*
+        * Print to standard error stream to remain backward compatible
+        * with Babeltrace 1.
+        */
+       if (flush_buf(stderr, pretty)) {
+               ret = BT_COMPONENT_STATUS_ERROR;
+       }
+
+       return ret;
+}
+
+BT_HIDDEN
+enum bt_component_status pretty_print_packet(struct pretty_component *pretty,
+               struct bt_notification *packet_beginning_notif)
+{
+       struct bt_packet *packet = bt_notification_packet_begin_borrow_packet(
+               packet_beginning_notif);
+       uint64_t count;
+       enum bt_component_status status = BT_COMPONENT_STATUS_OK;
+
+       if (bt_packet_get_discarded_event_count(packet, &count) ==
+                       BT_PACKET_PROPERTY_AVAILABILITY_AVAILABLE &&
+                       count > 0) {
+               status = print_discarded_elements_msg(pretty, packet,
+                       count, "event");
+               if (status != BT_COMPONENT_STATUS_OK) {
+                       goto end;
+               }
+       }
+
+       if (bt_packet_get_discarded_packet_count(packet, &count) ==
+                       BT_PACKET_PROPERTY_AVAILABILITY_AVAILABLE &&
+                       count > 0) {
+               status = print_discarded_elements_msg(pretty, packet,
+                       count, "packet");
+               if (status != BT_COMPONENT_STATUS_OK) {
+                       goto end;
+               }
+       }
+
+end:
+       return status;
+}