2 * Copyright (c) 2017-2019 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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
15 #ifndef SRC_VNET_SESSION_SESSION_DEBUG_H_
16 #define SRC_VNET_SESSION_SESSION_DEBUG_H_
18 #include <vnet/session/transport.h>
19 #include <vlib/vlib.h>
21 #define foreach_session_dbg_evt \
24 _(DEQ_NODE, "dequeue") \
25 _(POLL_GAP_TRACK, "poll gap track") \
26 _(POLL_DISPATCH_TIME, "dispatch time")\
27 _(DISPATCH_START, "dispatch start") \
28 _(DISPATCH_END, "dispatch end") \
29 _(FREE, "session free") \
31 typedef enum _session_evt_dbg
33 #define _(sym, str) SESSION_EVT_##sym,
34 foreach_session_dbg_evt
38 #define SESSION_DEBUG 0 * (TRANSPORT_DEBUG > 0)
39 #define SESSION_DEQ_EVTS (0)
40 #define SESSION_EVT_POLL_DBG (0)
41 #define SESSION_SM (0)
45 #define SESSION_DBG(_fmt, _args...) clib_warning (_fmt, ##_args)
47 #define DEC_SESSION_ETD(_s, _e, _size) \
52 transport_connection_t *_tc = session_get_transport (_s); \
53 ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, \
56 #define DEC_SESSION_ED(_e, _size) \
61 ed = ELOG_DATA (&vlib_global_main.elog_main, _e)
64 #define SESSION_EVT_FREE_HANDLER(_s) \
66 ELOG_TYPE_DECLARE (_e) = \
68 .format = "free: idx %u", \
69 .format_args = "i4", \
71 DEC_SESSION_ETD(_s, _e, 1); \
72 ed->data[0] = _s->session_index; \
75 #define SESSION_EVT_FREE_HANDLER(_s)
79 #define SESSION_EVT_DEQ_HANDLER(_s, _now, _max, _has_evt, _ts) \
81 ELOG_TYPE_DECLARE (_e) = \
83 .format = "deq: now %u max %d evt %u ts %d", \
84 .format_args = "i4i4i4i4", \
86 DEC_SESSION_ETD(_s, _e, 4); \
89 ed->data[2] = _has_evt; \
90 ed->data[3] = _ts * 1000000.0; \
93 #define SESSION_EVT_ENQ_HANDLER(_s, _len) \
95 ELOG_TYPE_DECLARE (_e) = \
97 .format = "enq: length %d", \
98 .format_args = "i4", \
100 DEC_SESSION_ETD(_s, _e, 1); \
101 ed->data[0] = _len; \
104 #define SESSION_EVT_DEQ_NODE_HANDLER(_node_evt) \
106 ELOG_TYPE_DECLARE (_e) = \
108 .format = "deq-node: %s", \
109 .format_args = "t4", \
110 .n_enum_strings = 2, \
116 DEC_SESSION_ED(_e, 1); \
117 ed->data[0] = _node_evt; \
120 #define SESSION_EVT_DEQ_HANDLER(_s, _body)
121 #define SESSION_EVT_ENQ_HANDLER(_s, _body)
122 #define SESSION_EVT_DEQ_NODE_HANDLER(_node_evt)
123 #endif /* SESSION_DEQ_NODE_EVTS */
125 #if SESSION_EVT_POLL_DBG && SESSION_DEBUG > 1
126 #define SESSION_EVT_POLL_GAP(_wrk) \
128 ELOG_TYPE_DECLARE (_e) = \
130 .format = "nixon-gap: %d us", \
131 .format_args = "i4", \
133 DEC_SESSION_ED(_e, 1); \
134 ed->data[0] = (u32) ((now - _wrk->last_event_poll)*1000000.0); \
136 #define SESSION_EVT_POLL_GAP_TRACK_HANDLER(_wrk) \
138 if (PREDICT_TRUE (smm->last_event_poll != 0.0)) \
139 if (now > smm->last_event_poll + 500e-6) \
140 SESSION_EVT_POLL_GAP(smm, _ti); \
141 _wrk->last_event_poll = now; \
144 #define SESSION_EVT_POLL_DISPATCH_TIME_HANDLER(_wrk) \
146 f64 diff = vlib_time_now (vlib_get_main ()) - _wrk->last_event_poll; \
149 ELOG_TYPE_DECLARE (_e) = \
151 .format = "dispatch time: %d us", \
152 .format_args = "i4", \
154 DEC_SESSION_ED(_e, 1); \
155 ed->data[0] = diff *1000000.0; \
160 #define SESSION_EVT_POLL_GAP(_wrk)
161 #define SESSION_EVT_POLL_GAP_TRACK_HANDLER(_wrk)
162 #define SESSION_EVT_POLL_DISPATCH_TIME_HANDLER(_wrk)
163 #endif /* SESSION_EVT_POLL_DBG */
165 #define SESSION_EVT_DISPATCH_START_HANDLER(_wrk) \
167 if (SESSION_DEQ_EVTS > 1) \
168 SESSION_EVT_DEQ_NODE_HANDLER (0); \
169 SESSION_EVT_POLL_GAP_TRACK_HANDLER (wrk); \
172 #define SESSION_EVT_DISPATCH_END_HANDLER(_wrk, _ntx) \
174 if (SESSION_DEQ_EVTS > 1 || _ntx) \
175 SESSION_EVT_DEQ_NODE_HANDLER (1); \
176 SESSION_EVT_POLL_DISPATCH_TIME_HANDLER(_wrk); \
179 #define CONCAT_HELPER(_a, _b) _a##_b
180 #define CC(_a, _b) CONCAT_HELPER(_a, _b)
181 #define SESSION_EVT(_evt, _args...) CC(_evt, _HANDLER)(_args)
184 #define SESSION_EVT(_evt, _args...)
185 #define SESSION_DBG(_fmt, _args...)
186 #endif /* SESSION_DEBUG */
188 #endif /* SRC_VNET_SESSION_SESSION_DEBUG_H_ */
190 * fd.io coding-style-patch-verification: ON
193 * eval: (c-set-style "gnu")