session: adding debug events
[vpp.git] / src / vnet / session / session_debug.h
index 80a97cd..6140466 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017 Cisco and/or its affiliates.
+ * Copyright (c) 2017-2019 Cisco and/or its affiliates.
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at:
 #define SRC_VNET_SESSION_SESSION_DEBUG_H_
 
 #include <vnet/session/transport.h>
-#include <vnet/session/session.h>
 #include <vlib/vlib.h>
 
 #define foreach_session_dbg_evt                \
   _(ENQ, "enqueue")                    \
   _(DEQ, "dequeue")                    \
-  _(DEQ_NODE, "dequeue")
+  _(DEQ_NODE, "dequeue")               \
+  _(POLL_GAP_TRACK, "poll gap track")  \
+  _(POLL_DISPATCH_TIME, "dispatch time")\
+  _(DISPATCH_START, "dispatch start")  \
+  _(DISPATCH_END, "dispatch end")      \
+  _(FREE, "session free")              \
+  _(DSP_CNTRS, "dispatch counters")    \
+  _(IO_EVT_COUNTS, "io evt counts")    \
+  _(EVT_COUNTS, "ctrl evt counts")     \
 
 typedef enum _session_evt_dbg
 {
@@ -31,20 +38,80 @@ typedef enum _session_evt_dbg
 #undef _
 } session_evt_dbg_e;
 
-#define SESSION_DBG (0)
-#define SESSION_DEQ_NODE_EVTS (0)
+#define foreach_session_events                          \
+_(CLK_UPDATE_TIME, 1, 1, "Time Session Update Timers")         \
+_(CLK_MQ_DEQ, 1, 1, "Time MQ Dequeue")                         \
+_(CLK_CTRL_EVTS, 1, 1, "Time Ctrl Events")                     \
+_(CLK_NEW_IO_EVTS, 1, 1, "Time New IO Events")         \
+_(CLK_OLD_IO_EVTS, 1, 1, "Time Old IO Events")         \
+\
+_(CNT_MQ_EVTS, 1, 0, "# of MQ Events Processed" )           \
+_(CNT_CTRL_EVTS, 1, 0, "# of Cntrl Events Processed" )      \
+_(CNT_NEW_EVTS, 1, 0, "# of New Events Processed" )         \
+_(CNT_OLD_EVTS, 1, 0, "# of Old Events Processed" )         \
+_(CNT_IO_EVTS, 1, 0, "# of Events Processed" )         \
+_(NODE_CALL_CNT, 1, 0, "Node call count")                  \
+_(NEW_IO_EVTS, 1, 0, "New IO Events")                      \
+_(OLD_IO_EVTS, 1, 0, "Old IO Events")                      \
+\
+_(BASE_OFFSET_IO_EVTS, 0, 0, "NULL")                        \
+_(SESSION_IO_EVT_RX, 1, 0, "# of IO Event RX")                  \
+_(SESSION_IO_EVT_TX,  1, 0, "# of IO Event TX")                 \
+_(SESSION_IO_EVT_TX_FLUSH, 1, 0, "# of IO Event TX Flush")      \
+_(SESSION_IO_EVT_BUILTIN_RX, 1, 0, "# of IO Event BuiltIn RX")  \
+_(SESSION_IO_EVT_BUILTIN_TX, 1, 0, "# of IO Event BuiltIn TX")   \
 
-#if TRANSPORT_DEBUG && SESSION_DBG
+
+typedef enum
+{
+#define _(sym, disp, type, str) SESS_Q_##sym,
+  foreach_session_events
+#undef _
+  SESS_Q_MAX_EVT_TYPES
+} sess_q_node_events_types_t;
+
+typedef struct session_dbg_counter_
+{
+  union
+  {
+    f64 f64;
+    u64 u64;
+  };
+} session_dbg_counter_t;
+
+typedef struct session_dbg_evts_t
+{
+  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
+  f64 last_time;
+  u64 prev_io;
+  session_dbg_counter_t sess_dbg_evt_type[SESS_Q_MAX_EVT_TYPES];
+} session_dbg_evts_t;
+
+typedef struct session_dbg_main_
+{
+  session_dbg_evts_t *wrk;
+} session_dbg_main_t;
+
+extern session_dbg_main_t session_dbg_main;
+
+#define SESSION_DEBUG 0 * (TRANSPORT_DEBUG > 0)
+#define SESSION_DEQ_EVTS (0)
+#define SESSION_DISPATCH_DBG (0)
+#define SESSION_EVT_POLL_DBG (0)
+#define SESSION_SM (0)
+#define SESSION_CLOCKS_EVT_DBG (0)
+#define SESSION_COUNTS_EVT_DBG (0)
+
+#if SESSION_DEBUG
+
+#define SESSION_DBG(_fmt, _args...) clib_warning (_fmt, ##_args)
 
 #define DEC_SESSION_ETD(_s, _e, _size)                                 \
   struct                                                               \
   {                                                                    \
     u32 data[_size];                                                   \
   } * ed;                                                              \
-  transport_proto_vft_t *vft =                                                 \
-      session_get_transport_vft (_s->session_type);                    \
-  transport_connection_t *_tc =                                        \
-      vft->get_connection (_s->connection_index, _s->thread_index);    \
+  transport_connection_t *_tc = session_get_transport (_s);            \
   ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main,                   \
                        _e, _tc->elog_track)
 
@@ -55,56 +122,205 @@ typedef enum _session_evt_dbg
   } * ed;                                                              \
   ed = ELOG_DATA (&vlib_global_main.elog_main, _e)
 
-#define SESSION_EVT_DEQ_HANDLER(_s, _body)                             \
+#if SESSION_SM
+#define SESSION_EVT_FREE_HANDLER(_s)                                   \
 {                                                                      \
   ELOG_TYPE_DECLARE (_e) =                                             \
   {                                                                    \
-    .format = "deq: id %d len %d rd %d wnd %d",                                \
+    .format = "free: idx %u",                                          \
+    .format_args = "i4",                                               \
+  };                                                                   \
+  DEC_SESSION_ETD(_s, _e, 1);                                          \
+  ed->data[0] =        _s->session_index;                                      \
+}
+#else
+#define SESSION_EVT_FREE_HANDLER(_s)
+#endif
+
+#if SESSION_DEQ_EVTS
+#define SESSION_EVT_DEQ_HANDLER(_s, _now, _max, _has_evt, _ts)         \
+{                                                                      \
+  ELOG_TYPE_DECLARE (_e) =                                             \
+  {                                                                    \
+    .format = "deq: now %u max %d evt %u ts %d",                       \
     .format_args = "i4i4i4i4",                                         \
   };                                                                   \
   DEC_SESSION_ETD(_s, _e, 4);                                          \
-  do { _body; } while (0);                                             \
+  ed->data[0] = _now;                                                  \
+  ed->data[1] = _max;                                                  \
+  ed->data[2] = _has_evt;                                              \
+  ed->data[3] = _ts * 1000000.0;                                       \
 }
 
-#define SESSION_EVT_ENQ_HANDLER(_s, _body)                             \
+#define SESSION_EVT_ENQ_HANDLER(_s, _len)                              \
 {                                                                      \
   ELOG_TYPE_DECLARE (_e) =                                             \
   {                                                                    \
-    .format = "enq: id %d length %d",                                  \
-    .format_args = "i4i4",                                             \
+    .format = "enq: length %d",                                                \
+    .format_args = "i4",                                               \
   };                                                                   \
-  DEC_SESSION_ETD(_s, _e, 2);                                          \
-  do { _body; } while (0);                                             \
+  DEC_SESSION_ETD(_s, _e, 1);                                          \
+  ed->data[0] = _len;                                                  \
 }
+#else
+#define SESSION_EVT_DEQ_HANDLER(_s, _now, _max, _has_evt, _ts)
+#define SESSION_EVT_ENQ_HANDLER(_s, _body)
+#endif /* SESSION_DEQ_NODE_EVTS */
 
-#if SESSION_DEQ_NODE_EVTS
-#define SESSION_EVT_DEQ_NODE_HANDLER(_node_evt)                                \
+#if SESSION_DISPATCH_DBG
+#define SESSION_EVT_DEQ_NODE_HANDLER(_wrk, _node_evt, _ntx)            \
 {                                                                      \
   ELOG_TYPE_DECLARE (_e) =                                             \
   {                                                                    \
-    .format = "deq-node: %s",                                          \
-    .format_args = "t4",                                               \
+    .format = "dispatch: %s pkts %u re-entry: %u dispatch %u",         \
+    .format_args = "t4i4i4i4",                                         \
     .n_enum_strings = 2,                                               \
     .enum_strings = {                                                  \
       "start",                                                         \
       "end",                                                           \
     },                                                                 \
   };                                                                   \
-  DEC_SESSION_ED(_e, 1);                                               \
+  DEC_SESSION_ED(_e, 4);                                               \
   ed->data[0] = _node_evt;                                             \
+  ed->data[1] = _ntx;                                                  \
+  ed->data[2] = (_wrk->last_vlib_time - _wrk->last_event_poll)                 \
+               * 1000000.0;                                            \
+  ed->data[3] = (vlib_time_now (_wrk->vm) - _wrk->last_vlib_time)      \
+                * 1000000.0;                                           \
 }
 #else
-#define SESSION_EVT_DEQ_NODE_HANDLER(_node_evt)
-#endif
+#define SESSION_EVT_DEQ_NODE_HANDLER(_node_evt, _ntx)
+#endif /* SESSION_DISPATCH_DBG */
+
+#if SESSION_EVT_POLL_DBG && SESSION_DEBUG > 1
+#define SESSION_EVT_POLL_GAP(_wrk)                                     \
+{                                                                      \
+  ELOG_TYPE_DECLARE (_e) =                                             \
+  {                                                                    \
+    .format = "nixon-gap: %d us",                                      \
+    .format_args = "i4",                                               \
+  };                                                                   \
+  DEC_SESSION_ED(_e, 1);                                               \
+  ed->data[0] =        (u32) ((_wrk->last_vlib_time - _wrk->last_event_poll)   \
+                       *1000000.0);                                    \
+}
+#define SESSION_EVT_POLL_GAP_TRACK_HANDLER(_wrk)                       \
+{                                                                      \
+  if (PREDICT_TRUE (_wrk->last_event_poll != 0.0))                     \
+    if (_wrk->last_vlib_time > _wrk->last_event_poll + 500e-6)         \
+      SESSION_EVT_POLL_GAP(_wrk);                                      \
+  _wrk->last_event_poll = _wrk->last_vlib_time;                                \
+}
+
+#define SESSION_EVT_POLL_DISPATCH_TIME_HANDLER(_wrk)                   \
+{                                                                      \
+  f64 diff = vlib_time_now (vlib_get_main ()) - _wrk->last_event_poll;  \
+  if (diff > 5e-2)                                                     \
+    {                                                                  \
+      ELOG_TYPE_DECLARE (_e) =                                         \
+      {                                                                        \
+        .format = "dispatch time: %d us",                              \
+        .format_args = "i4",                                           \
+      };                                                               \
+      DEC_SESSION_ED(_e, 1);                                           \
+      ed->data[0] = diff *1000000.0;                                   \
+    }                                                                  \
+}
+
+#else
+#define SESSION_EVT_POLL_GAP(_wrk)
+#define SESSION_EVT_POLL_GAP_TRACK_HANDLER(_wrk)
+#define SESSION_EVT_POLL_DISPATCH_TIME_HANDLER(_wrk)
+#define SESSION_EVT_POLL_CLOCKS_TIME_HANDLER(_wrk)
+
+#endif /* SESSION_EVT_POLL_DBG */
+
+#if SESSION_CLOCKS_EVT_DBG
+
+#define SESSION_EVT_DSP_CNTRS_UPDATE_TIME_HANDLER(_wrk, _diff, _args...)       \
+  session_dbg_evts_t *sdm = &session_dbg_main.wrk[_wrk->vm->thread_index];     \
+  sdm->sess_dbg_evt_type[SESS_Q_CLK_UPDATE_TIME].f64 += _diff;                 \
+
+#define SESSION_EVT_DSP_CNTRS_MQ_DEQ_HANDLER(_wrk, _diff, _cnt, _args...)      \
+  session_dbg_evts_t *sdm = &session_dbg_main.wrk[_wrk->vm->thread_index];     \
+  sdm->sess_dbg_evt_type[SESS_Q_CNT_MQ_EVTS].u64 += _cnt;                              \
+  sdm->sess_dbg_evt_type[SESS_Q_CLK_MQ_DEQ].f64 += _diff;                      \
+
+#define SESSION_EVT_DSP_CNTRS_CTRL_EVTS_HANDLER(_wrk, _diff, _args...)         \
+  session_dbg_evts_t *sdm = &session_dbg_main.wrk[_wrk->vm->thread_index];     \
+  sdm->sess_dbg_evt_type[SESS_Q_CLK_CTRL_EVTS].f64 += _diff;                   \
+  sdm->prev_io = sdm->sess_dbg_evt_type[SESS_Q_CNT_IO_EVTS].u64;               \
+
+#define SESSION_EVT_DSP_CNTRS_NEW_IO_EVTS_HANDLER(_wrk, _diff, _args...)       \
+  session_dbg_evts_t *sdm = &session_dbg_main.wrk[_wrk->vm->thread_index];     \
+  sdm->sess_dbg_evt_type[SESS_Q_CLK_NEW_IO_EVTS].f64 += _diff;                         \
+  sdm->sess_dbg_evt_type[SESS_Q_CNT_NEW_EVTS].u64 +=                           \
+    sdm->sess_dbg_evt_type[SESS_Q_CNT_IO_EVTS].u64 - sdm->prev_io;             \
+  sdm->prev_io = sdm->sess_dbg_evt_type[SESS_Q_CNT_IO_EVTS].u64;               \
+
+#define SESSION_EVT_DSP_CNTRS_OLD_IO_EVTS_HANDLER(_wrk, _diff, _args...)       \
+  session_dbg_evts_t *sdm = &session_dbg_main.wrk[_wrk->vm->thread_index];     \
+  sdm->sess_dbg_evt_type[SESS_Q_CLK_OLD_IO_EVTS].f64 += _diff;                         \
+  sdm->sess_dbg_evt_type[SESS_Q_CNT_OLD_EVTS].u64 +=                           \
+    sdm->sess_dbg_evt_type[SESS_Q_CNT_IO_EVTS].u64 - sdm->prev_io;             \
+
+#define SESSION_EVT_DSP_CNTRS_HANDLER(_disp_evt, _wrk, _args...)               \
+{                                                                               \
+  f64 time_now = vlib_time_now (_wrk->vm);                                      \
+  f64 diff = time_now - session_dbg_main.wrk[_wrk->vm->thread_index].last_time; \
+  session_dbg_main.wrk[_wrk->vm->thread_index].last_time = time_now;            \
+  CC(CC(SESSION_EVT_DSP_CNTRS_,_disp_evt),_HANDLER)(wrk, diff, _args);         \
+}
+#else
+#define SESSION_EVT_CLOCKS_HANDLER(_node_evt, _wrk)
+#endif /*SESSION_CLOCKS_EVT_DBG */
+
+#if SESSION_COUNTS_EVT_DBG
+#define SESSION_EVT_COUNTS_HANDLER(_node_evt, _cnt, _wrk)       \
+{                                                              \
+  session_dbg_main.wrk[_wrk->vm->thread_index].                \
+       sess_dbg_evt_type[SESS_Q_##_node_evt].u64 += _cnt;      \
+}
+
+#define SESSION_IO_EVT_COUNTS_HANDLER(_node_evt, _cnt, _wrk)     \
+{                                                                \
+  u8 type = SESS_Q_BASE_OFFSET_IO_EVTS + _node_evt +1 ;         \
+  session_dbg_main.wrk[_wrk->vm->thread_index].                  \
+        sess_dbg_evt_type[type].u64 += _cnt ;                    \
+  session_dbg_main.wrk[_wrk->vm->thread_index].                  \
+        sess_dbg_evt_type[SESS_Q_CNT_IO_EVTS].u64 += _cnt ;     \
+}
+#else
+#define SESSION_EVT_COUNTS_HANDLER(_node_evt, _wrk)
+#define SESSION_IO_EVT_COUNTS_HANDLER(_node_evt, _cnt, _wrk)
+#endif /*SESSION_COUNTS_EVT_DBG */
+
+
+#define SESSION_EVT_DISPATCH_START_HANDLER(_wrk)                       \
+{                                                                      \
+  if (SESSION_DEQ_EVTS > 1)                                            \
+    SESSION_EVT_DEQ_NODE_HANDLER (_wrk, 0, 0);                         \
+  SESSION_EVT_POLL_GAP_TRACK_HANDLER (wrk);                            \
+  session_dbg_main.wrk[_wrk->vm->thread_index].                         \
+       sess_dbg_evt_type[SESS_Q_##NODE_CALL_CNT].u64 +=1;              \
+}
+
+#define SESSION_EVT_DISPATCH_END_HANDLER(_wrk, _ntx)                   \
+{                                                                      \
+  if (_ntx)                                                            \
+    SESSION_EVT_DEQ_NODE_HANDLER (_wrk, 1, _ntx);                      \
+  SESSION_EVT_POLL_DISPATCH_TIME_HANDLER(_wrk);                                \
+  _wrk->last_event_poll = vlib_time_now (_wrk->vm);                    \
+}
 
 #define CONCAT_HELPER(_a, _b) _a##_b
 #define CC(_a, _b) CONCAT_HELPER(_a, _b)
-
-#define SESSION_EVT_DBG(_evt, _args...) CC(_evt, _HANDLER)(_args)
+#define SESSION_EVT(_evt, _args...) CC(_evt, _HANDLER)(_args)
 
 #else
-#define SESSION_EVT_DBG(_evt, _args...)
-#endif
+#define SESSION_EVT(_evt, _args...)
+#define SESSION_DBG(_fmt, _args...)
+#endif /* SESSION_DEBUG */
 
 #endif /* SRC_VNET_SESSION_SESSION_DEBUG_H_ */
 /*