src/vnet/session/session_debug.h

   1 /*
   2  * Copyright (c) 2017 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15 #ifndef SRC_VNET_SESSION_SESSION_DEBUG_H_
  16 #define SRC_VNET_SESSION_SESSION_DEBUG_H_
  17
  18 #include <vnet/session/transport.h>
  19 #include <vlib/vlib.h>
  20
  21 #define foreach_session_dbg_evt         \
  22   _(ENQ, "enqueue")                     \
  23   _(DEQ, "dequeue")                     \
  24   _(DEQ_NODE, "dequeue")                \
  25   _(POLL_GAP_TRACK, "poll gap track")   \
  26
  27 typedef enum _session_evt_dbg
  28 {
  29 #define _(sym, str) SESSION_EVT_##sym,
  30   foreach_session_dbg_evt
  31 #undef _
  32 } session_evt_dbg_e;
  33
  34 #define SESSION_DEBUG (0 && TRANSPORT_DEBUG)
  35 #define SESSION_DEQ_NODE_EVTS (0)
  36 #define SESSION_EVT_POLL_DBG (0)
  37
  38 #if SESSION_DEBUG
  39
  40 #define SESSION_DBG(_fmt, _args...) clib_warning (_fmt, ##_args)
  41
  42 #define DEC_SESSION_ETD(_s, _e, _size)                                  \
  43   struct                                                                \
  44   {                                                                     \
  45     u32 data[_size];                                                    \
  46   } * ed;                                                               \
  47   transport_connection_t *_tc = session_get_transport (_s);             \
  48   ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main,                    \
  49                         _e, _tc->elog_track)
  50
  51 #define DEC_SESSION_ED(_e, _size)                                       \
  52   struct                                                                \
  53   {                                                                     \
  54     u32 data[_size];                                                    \
  55   } * ed;                                                               \
  56   ed = ELOG_DATA (&vlib_global_main.elog_main, _e)
  57
  58 #define SESSION_EVT_DEQ_HANDLER(_s, _body)                              \
  59 {                                                                       \
  60   ELOG_TYPE_DECLARE (_e) =                                              \
  61   {                                                                     \
  62     .format = "deq: id %d len %d rd %d wnd %d",                         \
  63     .format_args = "i4i4i4i4",                                          \
  64   };                                                                    \
  65   DEC_SESSION_ETD(_s, _e, 4);                                           \
  66   do { _body; } while (0);                                              \
  67 }
  68
  69 #define SESSION_EVT_ENQ_HANDLER(_s, _body)                              \
  70 {                                                                       \
  71   ELOG_TYPE_DECLARE (_e) =                                              \
  72   {                                                                     \
  73     .format = "enq: id %d length %d",                                   \
  74     .format_args = "i4i4",                                              \
  75   };                                                                    \
  76   DEC_SESSION_ETD(_s, _e, 2);                                           \
  77   do { _body; } while (0);                                              \
  78 }
  79
  80 #if SESSION_DEQ_NODE_EVTS && SESSION_DEBUG > 1
  81 #define SESSION_EVT_DEQ_NODE_HANDLER(_node_evt)                         \
  82 {                                                                       \
  83   ELOG_TYPE_DECLARE (_e) =                                              \
  84   {                                                                     \
  85     .format = "deq-node: %s",                                           \
  86     .format_args = "t4",                                                \
  87     .n_enum_strings = 2,                                                \
  88     .enum_strings = {                                                   \
  89       "start",                                                          \
  90       "end",                                                            \
  91     },                                                                  \
  92   };                                                                    \
  93   DEC_SESSION_ED(_e, 1);                                                \
  94   ed->data[0] = _node_evt;                                              \
  95 }
  96 #else
  97 #define SESSION_EVT_DEQ_NODE_HANDLER(_node_evt)
  98 #endif /* SESSION_DEQ_NODE_EVTS */
  99
 100 #if SESSION_EVT_POLL_DBG && SESSION_DEBUG > 1
 101 #define SESSION_EVT_POLL_GAP(_smm, _ti)                                 \
 102 {                                                                       \
 103   ELOG_TYPE_DECLARE (_e) =                                              \
 104   {                                                                     \
 105     .format = "nixon-gap: %d us",                                       \
 106     .format_args = "i4",                                                \
 107   };                                                                    \
 108   DEC_SESSION_ED(_e, 1);                                                \
 109   ed->data[0] = (u32) ((now -                                           \
 110       _smm->last_event_poll_by_thread[_ti])*1000000.0);                 \
 111 }
 112 #define SESSION_EVT_POLL_GAP_TRACK_HANDLER(_smm, _ti)                   \
 113 {                                                                       \
 114   if (PREDICT_TRUE (smm->last_event_poll_by_thread[_ti] != 0.0))        \
 115     if (now > smm->last_event_poll_by_thread[_ti] + 500e-6)             \
 116       SESSION_EVT_POLL_GAP(smm, _ti);                                   \
 117   _smm->last_event_poll_by_thread[_ti] = now;                           \
 118 }
 119
 120 #else
 121 #define SESSION_EVT_POLL_GAP(_smm, _my_thread_index)
 122 #define SESSION_EVT_POLL_GAP_TRACK_HANDLER(_smm, _my_thread_index)
 123 #endif /* SESSION_EVT_POLL_DBG */
 124
 125 #define CONCAT_HELPER(_a, _b) _a##_b
 126 #define CC(_a, _b) CONCAT_HELPER(_a, _b)
 127 #define SESSION_EVT_DBG(_evt, _args...) CC(_evt, _HANDLER)(_args)
 128
 129 #else
 130 #define SESSION_EVT_DBG(_evt, _args...)
 131 #define SESSION_DBG(_fmt, _args...)
 132 #endif /* SESSION_DEBUG */
 133
 134 #endif /* SRC_VNET_SESSION_SESSION_DEBUG_H_ */
 135 /*
 136  * fd.io coding-style-patch-verification: ON
 137  *
 138  * Local Variables:
 139  * eval: (c-set-style "gnu")
 140  * End:
 141  */