Clean up event log merge code

Fix a decade-old ridiculous qsort function bug. Managed to subtract
floating-point numbers as if they were integers, leading to
manufactured time-paradoxes. That completely confuses g2, leading to
the summary disappearance of entire tracks' worth of data at high zoom
levels.

Add a manual alignment tweak parameter to elog_merge, users can
dial-out time paradoxes caused by NTP-grade clock synchronization.
The event-logger has a precision of O(100ns), whereas NTP
synchronization is O(1ms).

Change-Id: I69dedabaa314f69f9df74ec9ee66e21e6c87f703
Signed-off-by: Dave Barach <dave@barachs.net>

1 files changed, 157 insertions, 49 deletions

diff --git a/src/vppinfra/elog.h b/src/vppinfra/elog.h
index 9756fb83a8d..359868dd0f0 100644
--- a/src/vppinfra/elog.h
+++ b/src/vppinfra/elog.h
@@ -35,7 +35,16 @@
   WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
 
-/* High speed event logging with much thanks to Dave Barach. */
+/* High speed event logger */
+
+/** \file
+    The fine-grained event logger allows lightweight, thread-safe
+    event logging at minimum cost. In typical operation, logging
+    a single event costs around 80ns on x86_64. It's appropriate
+    for at-least per-frame event-logging in vector packet processing.
+
+    See https://wiki.fd.io/view/VPP/elog for more information.
+*/
 
 #ifndef included_clib_elog_h
 #define included_clib_elog_h
@@ -50,38 +59,38 @@ typedef struct
 {
   union
   {
-    /* Absolute time stamp in CPU clock cycles. */
+    /** Absolute time stamp in CPU clock cycles. */
     u64 time_cycles;
 
-    /* Absolute time as floating point number in seconds. */
+    /** Absolute time as floating point number in seconds. */
     f64 time;
   };
 
-  /* Event type index. */
+  /** Event type index. */
   u16 type;
 
-  /* Track for this event.  Tracks allow events to be sorted and
+  /** Track for this event.  Tracks allow events to be sorted and
      displayed by track.  Think of 2 dimensional display with time and
      track being the x and y axes. */
   u16 track;
 
-  /* 20-bytes of data follows and pads to 32 bytes. */
+  /** 20-bytes of data follows, pads to 32 bytes. */
   u8 data[20];
 } elog_event_t;
 
 typedef struct
 {
-  /* Type index plus one assigned to this type.
+  /** Type index plus one assigned to this type.
      This is used to mark type as seen. */
   u32 type_index_plus_one;
 
-  /* String table as a vector constructed when type is registered. */
+  /** String table as a vector constructed when type is registered. */
   char **enum_strings_vector;
 
-  /* Format string. (example: "my-event (%d,%d)"). */
+  /** Format string. (example: "my-event (%d,%d)"). */
   char *format;
 
-  /* Specifies how arguments to format are parsed from event data.
+  /** Specifies how arguments to format are parsed from event data.
      String of characters '0' '1' or '2' '3' to specify log2 size of data
      (e.g. for u8, u16, u32 or u64),
      's' means a null-terminated C string
@@ -90,97 +99,110 @@ typedef struct
      'f' is a double. */
   char *format_args;
 
-  /* Function name generating event. */
+  /** Function name generating event. */
   char *function;
 
-  /* Number of elements in string enum table. */
+  /** Number of elements in string enum table. */
   u32 n_enum_strings;
 
-  /* String table for enum/number to string formatting. */
+  /** String table for enum/number to string formatting. */
   char *enum_strings[];
 } elog_event_type_t;
 
 typedef struct
 {
-  /* Track name vector. */
+  /** Track name vector. */
   char *name;
 
-  /* Set to one when track has been added to
+  /** Set to one when track has been added to
      main structure. */
   u32 track_index_plus_one;
 } elog_track_t;
 
 typedef struct
 {
-  /* CPU cycle counter. */
+  /** CPU cycle counter. */
   u64 cpu;
 
-  /* OS timer in nano secs since epoch Jan 1 1970. */
+  /** OS timer in nano secs since epoch 3/30/2017, see elog_time_now() */
   u64 os_nsec;
 } elog_time_stamp_t;
 
 typedef struct
 {
-  /* Total number of events in buffer. */
+  /** Total number of events in buffer. */
   u32 n_total_events;
 
-  /* When count reaches limit logging is disabled.  This is
+  /** When count reaches limit logging is disabled.  This is
      used for event triggers. */
   u32 n_total_events_disable_limit;
 
-  /* Dummy event to use when logger is disabled. */
+  /** Dummy event to use when logger is disabled. */
   elog_event_t dummy_event;
 
-  /* Power of 2 number of elements in ring. */
+  /** Power of 2 number of elements in ring. */
   uword event_ring_size;
 
-  /* Vector of events (circular buffer).  Power of 2 size.
-     Used when events are being collected. */
+  /** Vector of events (circular buffer).  Power of 2 size.
+      Used when events are being collected. */
   elog_event_t *event_ring;
 
-  /* Vector of event types. */
+  /** Vector of event types. */
   elog_event_type_t *event_types;
 
-  /* Hash table mapping type format to type index. */
+  /** Hash table mapping type format to type index. */
   uword *event_type_by_format;
 
-  /* Events may refer to strings in string table. */
+  /** Events may refer to strings in string table. */
   char *string_table;
 
-  /* Vector of tracks. */
+  /** Vector of tracks. */
   elog_track_t *tracks;
 
-  /* Default track. */
+  /** Default track. */
   elog_track_t default_track;
 
-  /* Place holder for CPU clock frequency. */
+  /** Place holder for CPU clock frequency. */
   clib_time_t cpu_timer;
 
+  /** Timestamps */
   elog_time_stamp_t init_time, serialize_time;
 
-  /* SMP lock, non-zero means locking required */
+  /** SMP lock, non-zero means locking required */
   uword *lock;
 
-  /* Use serialize_time and init_time to give estimate for
-     cpu clock frequency. */
+  /** Use serialize_time and init_time to give estimate for
+      cpu clock frequency. */
   f64 nsec_per_cpu_clock;
 
-  /* Vector of events converted to generic form after collection. */
+  /** Vector of events converted to generic form after collection. */
   elog_event_t *events;
 } elog_main_t;
 
+/** @brief Return number of events in the event-log buffer
+    @param em elog_main_t *
+    @return number of events in the buffer
+*/
+
 always_inline uword
 elog_n_events_in_buffer (elog_main_t * em)
 {
   return clib_min (em->n_total_events, em->event_ring_size);
 }
 
+/** @brief Return number of events which can fit in the event buffer
+    @param em elog_main_t *
+    @return number of events which can fit in the buffer
+*/
 always_inline uword
 elog_buffer_capacity (elog_main_t * em)
 {
   return em->event_ring_size;
 }
 
+/** @brief Reset the event buffer
+    @param em elog_main_t *
+*/
 always_inline void
 elog_reset_buffer (elog_main_t * em)
 {
@@ -188,6 +210,9 @@ elog_reset_buffer (elog_main_t * em)
   em->n_total_events_disable_limit = ~0;
 }
 
+/** @brief Enable or disable event logging
+    @param em elog_main_t *
+*/
 always_inline void
 elog_enable_disable (elog_main_t * em, int is_enabled)
 {
@@ -195,18 +220,27 @@ elog_enable_disable (elog_main_t * em, int is_enabled)
   em->n_total_events_disable_limit = is_enabled ? ~0 : 0;
 }
 
-/* Disable logging after specified number of ievents have been logged.
+/** @brief disable logging after specified number of ievents have been logged.
+
    This is used as a "debug trigger" when a certain event has occurred.
    Events will be logged both before and after the "event" but the
-   event will not be lost as long as N < RING_SIZE. */
+   event will not be lost as long as N < RING_SIZE.
+
+   @param em elog_main_t *
+   @param n uword number of events before disabling event logging
+*/
 always_inline void
 elog_disable_after_events (elog_main_t * em, uword n)
 {
   em->n_total_events_disable_limit = em->n_total_events + n;
 }
 
-/* Signal a trigger.  We do this when we encounter an event that we want to save
-   context around (before and after). */
+/* @brief mid-buffer logic-analyzer trigger
+
+   Currently, only midpoint triggering is supported, but it's pretty obvious
+   how to generalize the scheme.
+   @param em elog_main_t *
+*/
 always_inline void
 elog_disable_trigger (elog_main_t * em)
 {
@@ -214,18 +248,44 @@ elog_disable_trigger (elog_main_t * em)
     em->n_total_events + vec_len (em->event_ring) / 2;
 }
 
-/* External function to register types/tracks. */
+/** @brief register an event type
+    @param em elog_main_t *
+    @param t elog_event_type_t * event to register
+    @return type index
+    @warning Typically not called directly
+*/
+
 word elog_event_type_register (elog_main_t * em, elog_event_type_t * t);
+
+/** @brief register an event track
+    @param em elog_main_t *
+    @param t elog_track_t * track to register
+    @return track index
+    @note this function is often called directly
+*/
 word elog_track_register (elog_main_t * em, elog_track_t * t);
 
+/** @brief event logging enabled predicate
+    @param em elog_main_t *
+    @return 1 if enabled, 0 if not enabled
+*/
 always_inline uword
 elog_is_enabled (elog_main_t * em)
 {
   return em->n_total_events < em->n_total_events_disable_limit;
 }
 
-/* Add an event to the log.  Returns a pointer to the
-   data for caller to write into. */
+/** @brief Allocate an event to be filled in by the caller
+
+    Not normally called directly; this function underlies the
+    ELOG_DATA and ELOG_TRACK_DATA macros
+
+    @param em elog_main_t *
+    @param type elog_event_type_t * type
+    @param track elog_track_t * track
+    @param cpu_time u64 current cpu tick value
+    @returns event to be filled in
+*/
 always_inline void *
 elog_event_data_inline (elog_main_t * em,
 			elog_event_type_t * type,
@@ -274,7 +334,17 @@ void *elog_event_data (elog_main_t * em,
 		       elog_event_type_t * type,
 		       elog_track_t * track, u64 cpu_time);
 
-/* Non-inline version. */
+/** @brief Allocate an event to be filled in by the caller, non-inline
+
+    Not normally called directly; this function underlies the
+    ELOG_DATA and ELOG_TRACK_DATA macros
+
+    @param em elog_main_t *
+    @param type elog_event_type_t * type
+    @param track elog_track_t * track
+    @param cpu_time u64 current cpu tick value
+    @returns event to be filled in
+*/
 always_inline void *
 elog_event_data_not_inline (elog_main_t * em,
 			    elog_event_type_t * type,
@@ -286,7 +356,11 @@ elog_event_data_not_inline (elog_main_t * em,
   return elog_event_data (em, type, track, cpu_time);
 }
 
-/* Most common forms: log a single 32 bit datum, w / w-out track */
+/** @brief Log a single-datum event
+    @param em elog_main_t *
+    @param type elog_event_type_t * type
+    @param data u32 single datum to capture
+*/
 always_inline void
 elog (elog_main_t * em, elog_event_type_t * type, u32 data)
 {
@@ -297,7 +371,11 @@ elog (elog_main_t * em, elog_event_type_t * type, u32 data)
   d[0] = data;
 }
 
-/* Inline version of above. */
+/** @brief Log a single-datum event, inline version
+    @param em elog_main_t *
+    @param type elog_event_type_t * type
+    @param data u32 single datum to capture
+*/
 always_inline void
 elog_inline (elog_main_t * em, elog_event_type_t * type, u32 data)
 {
@@ -308,6 +386,12 @@ elog_inline (elog_main_t * em, elog_event_type_t * type, u32 data)
   d[0] = data;
 }
 
+/** @brief Log a single-datum event to a specific track, non-inline version
+    @param em elog_main_t *
+    @param type elog_event_type_t * type
+    @param type elog_event_track_t * track
+    @param data u32 single datum to capture
+*/
 always_inline void
 elog_track (elog_main_t * em, elog_event_type_t * type, elog_track_t * track,
 	    u32 data)
@@ -319,6 +403,12 @@ elog_track (elog_main_t * em, elog_event_type_t * type, elog_track_t * track,
   d[0] = data;
 }
 
+/** @brief Log a single-datum event to a specific track
+    @param em elog_main_t *
+    @param type elog_event_type_t * type
+    @param type elog_event_track_t * track
+    @param data u32 single datum to capture
+*/
 always_inline void
 elog_track_inline (elog_main_t * em, elog_event_type_t * type,
 		   elog_track_t * track, u32 data)
@@ -392,19 +482,37 @@ elog_data_inline (elog_main_t * em, elog_event_type_t * type,
 #define ELOG_DATA(em,f) elog_data ((em), &__ELOG_TYPE_VAR (f), &(em)->default_track)
 #define ELOG_DATA_INLINE(em,f) elog_data_inline ((em), &__ELOG_TYPE_VAR (f), &(em)->default_track)
 
+/** @brief add a string to the event-log string table
+
+    Often combined with hashing and the T4 elog format specifier to
+    display complex strings in offline tooling
+
+    @param em elog_main_t *
+    @param format char *
+    @param VARARGS
+    @return u32 index to add to event log
+*/
 u32 elog_string (elog_main_t * em, char *format, ...);
+
 void elog_time_now (elog_time_stamp_t * et);
 
-/* Convert ievents to events and return them as a vector.
-   Sets em->events to resulting vector. */
+/** @brief convert event ring events to events, and return them as a vector.
+    @param em elog_main_t *
+    @return event vector with timestamps in f64 seconds
+    @note sets em->events to resulting vector.
+*/
 elog_event_t *elog_get_events (elog_main_t * em);
 
-/* Convert ievents to events and return them as a vector with no side effects. */
+/** @brief convert event ring events to events, and return them as a vector.
+    @param em elog_main_t *
+    @return event vector with timestamps in f64 seconds
+    @note no side effects
+*/
 elog_event_t *elog_peek_events (elog_main_t * em);
 
 /* Merge two logs, add supplied track tags. */
 void elog_merge (elog_main_t * dst, u8 * dst_tag,
-		 elog_main_t * src, u8 * src_tag);
+		 elog_main_t * src, u8 * src_tag, f64 align_tweak);
 
 /* 2 arguments elog_main_t and elog_event_t to format event or track name. */
 u8 *format_elog_event (u8 * s, va_list * va);
@@ -418,7 +526,7 @@ void elog_alloc (elog_main_t * em, u32 n_events);
 
 #ifdef CLIB_UNIX
 always_inline clib_error_t *
-elog_write_file (elog_main_t * em, char *unix_file)
+elog_write_file (elog_main_t * em, char *unix_file, int flush_ring)
 {
   serialize_main_t m;
   clib_error_t *error;
@@ -426,7 +534,7 @@ elog_write_file (elog_main_t * em, char *unix_file)
   error = serialize_open_unix_file (&m, unix_file);
   if (error)
     return error;
-  error = serialize (&m, serialize_elog_main, em);
+  error = serialize (&m, serialize_elog_main, em, flush_ring);
   if (!error)
     serialize_close (&m);
   return error;