2 * Copyright (c) 2018 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (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.
16 #ifndef SRC_VCL_VCL_DEBUG_H_
17 #define SRC_VCL_VCL_DEBUG_H_
19 #include <vppinfra/elog.h>
24 #define VDBG(_lvl, _fmt, _args...) \
25 if (VCL_DBG_ON && vcm->debug > _lvl) \
26 clib_warning ("vcl<%d:%d>: " _fmt, \
27 vcm->workers[__vcl_worker_index].current_pid, \
28 __vcl_worker_index, ##_args)
30 #define VWRN(_fmt, _args...) \
31 clib_warning ("vcl<%d:%d>: " _fmt, \
32 vcm->workers[__vcl_worker_index].current_pid, \
33 __vcl_worker_index, ##_args)
35 #define VERR(_fmt, _args...) \
36 clib_warning ("vcl<%d:%d>: ERROR " _fmt, \
37 vcm->workers[__vcl_worker_index].current_pid, \
38 __vcl_worker_index, ##_args)
40 #define foreach_vcl_dbg_evt \
41 _(INIT, "vcl init track") \
42 _(TIMEOUT, "vcl timeout") \
43 _(DETACH, "vcl detach") \
44 _(SESSION_INIT, "init session track") \
45 _(SESSION_TIMEOUT, "session timeout") \
46 _(CREATE, "session create") \
47 _(CLOSE, "session close") \
48 _(BIND, "session bind") \
49 _(UNBIND, "session unbind") \
50 _(ACCEPT, "session accept") \
51 _(EPOLL_CREATE, "epoll session create") \
52 _(EPOLL_CTLADD, "epoll ctl add") \
53 _(EPOLL_CTLDEL, "epoll ctl del") \
55 typedef enum vcl_dbg_evt_
57 #define _(sym, str) VCL_EVT_##sym,
64 #define VCL_DECLARE_ETD(_s, _e, _size) \
65 struct { u32 data[_size]; } * ed; \
66 ed = ELOG_TRACK_DATA (&vcm->elog_main, _e, _s->elog_track) \
68 #define VCL_EVT_INIT_HANDLER(_vcm, ...) \
70 _vcm->elog_track.name = (char *) format (0, "P:%d:C:%d%c", getpid (), \
71 _vcm->my_client_index, 0); \
72 elog_track_register (&_vcm->elog_main, &_vcm->elog_track); \
73 ELOG_TYPE_DECLARE (e) = \
75 .format = "connect_vpp:rv:%d", \
76 .format_args = "i4", \
78 struct { u32 data; } *ed; \
79 ed = ELOG_TRACK_DATA (&_vcm->elog_main, e, _vcm->elog_track); \
80 ed->data = (u32) rv; \
83 #define VCL_EVT_SESSION_INIT_HANDLER(_s, _s_index, ...) \
85 _s->elog_track.name = (char *) format (0, "CI:%d:S:%d%c", \
86 vcm->my_client_index, \
88 elog_track_register (&vcm->elog_main, &_s->elog_track); \
91 #define VCL_EVT_BIND_HANDLER(_s, ...) \
93 if (_s->lcl_addr.is_ip4) \
95 ELOG_TYPE_DECLARE (_e) = \
97 .format = "bind local:%s:%d.%d.%d.%d:%d ", \
98 .format_args = "t1i1i1i1i1i2", \
99 .n_enum_strings = 2, \
100 .enum_strings = {"TCP", "UDP",}, \
102 CLIB_PACKED (struct { \
107 ed = ELOG_TRACK_DATA (&vcm->elog_main, _e, _s->elog_track); \
108 ed->proto = _s->proto; \
109 ed->addr[0] = _s->lcl_addr.ip46.ip4.as_u8[0]; \
110 ed->addr[1] = _s->lcl_addr.ip46.ip4.as_u8[1]; \
111 ed->addr[2] = _s->lcl_addr.ip46.ip4.as_u8[2]; \
112 ed->addr[3] = _s->lcl_addr.ip46.ip4.as_u8[3]; \
113 ed->port = clib_net_to_host_u16 (_s->lcl_port); \
121 #define VCL_EVT_ACCEPT_HANDLER(_s, _ls, _s_idx, ...) \
123 VCL_EVT_SESSION_INIT_HANDLER (_s, _s_idx); \
124 ELOG_TYPE_DECLARE (_e) = \
126 .format = "accept: listen_handle:%x from_handle:%x", \
127 .format_args = "i8i8", \
129 struct { u64 handle[2]; } *ed; \
130 ed = ELOG_TRACK_DATA (&vcm->elog_main, _e, _s->elog_track); \
131 ed->handle[0] = _ls->vpp_handle; \
132 ed->handle[1] = _s->vpp_handle; \
133 if (_s->peer_addr.is_ip4) \
135 ELOG_TYPE_DECLARE (_e) = \
137 .format = "accept:S:%x addr:%d.%d.%d.%d:%d", \
138 .format_args = "i8i1i1i1i1i2", \
140 CLIB_PACKED (struct { \
145 ed = ELOG_TRACK_DATA (&vcm->elog_main, _e, _s->elog_track); \
146 ed->s_idx = _s_idx; \
147 ed->addr[0] = _s->peer_addr.ip46.ip4.as_u8[0]; \
148 ed->addr[1] = _s->peer_addr.ip46.ip4.as_u8[1]; \
149 ed->addr[2] = _s->peer_addr.ip46.ip4.as_u8[2]; \
150 ed->addr[3] = _s->peer_addr.ip46.ip4.as_u8[3]; \
151 ed->port = clib_net_to_host_u16 (_s->peer_port); \
159 #define VCL_EVT_CREATE_HANDLER(_s, _proto, _state, _is_nb, _s_idx, ...) \
161 VCL_EVT_SESSION_INIT_HANDLER (_s, _s_idx); \
162 ELOG_TYPE_DECLARE (_e) = \
164 .format = "create:proto:%d state:%d is_nonblk:%d idx: %d", \
165 .format_args = "i4i4i4i4", \
167 VCL_DECLARE_ETD (_s, _e, 4); \
168 ed->data[0] = _proto; \
169 ed->data[1] = _state; \
170 ed->data[2] = _is_nb; \
171 ed->data[3] = _s_idx; \
174 #define VCL_EVT_CLOSE_HANDLER(_s, _rv, ...) \
176 ELOG_TYPE_DECLARE (_e) = \
178 .format = "session_close:rv:%d", \
179 .format_args = "i4", \
181 VCL_DECLARE_ETD (_s, _e, 1); \
185 #define VCL_EVT_SESSION_TIMEOUT_HANDLER(_s, _state, ...) \
187 ELOG_TYPE_DECLARE (_e) = \
189 .format = "ERR: timeout state:%d", \
190 .format_args = "i4", \
192 VCL_DECLARE_ETD (_s, _e, 1); \
193 ed->data[0] = _state; \
196 #define VCL_EVT_TIMEOUT_HANDLER(_vcm, _state, ...) \
198 ELOG_TYPE_DECLARE (_e) = \
200 .format = "ERR: timeout state:%d", \
201 .format_args = "i4", \
203 struct { u32 data; } * ed; \
204 ed = ELOG_TRACK_DATA (&_vcm->elog_main, _e, _vcm->elog_track); \
205 ed->data[0] = _state; \
208 #define VCL_EVT_DETACH_HANDLER(_vcm, ...) \
210 ELOG_TYPE_DECLARE (_e) = \
212 .format = "app_detach:C:%d", \
213 .format_args = "i4", \
215 struct { u32 data; } * ed; \
216 ed = ELOG_TRACK_DATA (&_vcm->elog_main, _e, _vcm->elog_track); \
217 ed->data = _vcm->my_client_index; \
220 #define VCL_EVT_UNBIND_HANDLER(_s, ...) \
222 ELOG_TYPE_DECLARE (_e) = \
224 .format = "unbind: handle:%x", \
225 .format_args = "i8", \
227 struct { u64 data; } * ed; \
228 ed = ELOG_TRACK_DATA (&vcm->elog_main, _e, _s->elog_track); \
229 ed->data = _s->vpp_handle; \
232 #define VCL_EVT_EPOLL_CREATE_HANDLER(_s, _s_idx, ...) \
234 VCL_EVT_SESSION_INIT_HANDLER (_s, _s_idx); \
235 ELOG_TYPE_DECLARE (_e) = \
237 .format = "create epoll vep_idx: %d", \
238 .format_args = "i4", \
240 VCL_DECLARE_ETD (_s, _e, 1); \
241 ed->data[0] = _s_idx; \
244 #define VCL_EVT_EPOLL_CTLADD_HANDLER(_s, _evts, _evt_data, ...) \
246 ELOG_TYPE_DECLARE (_e) = \
248 .format = "epoll_ctladd: events:%x data:%x", \
249 .format_args = "i4", \
255 ed = ELOG_TRACK_DATA (&vcm->elog_main, _e, _s->elog_track); \
256 ed->events = _evts; \
257 ed->event_data = _evt_data; \
260 #define VCL_EVT_EPOLL_CTLDEL_HANDLER(_s, _vep_idx, ...) \
262 ELOG_TYPE_DECLARE (_e) = \
264 .format = "epoll_ctldel: vep:%d", \
265 .format_args = "i4", \
267 VCL_DECLARE_ETD (_s, _e, 1); \
268 ed->data[0] = _vep_idx; \
271 #define vcl_elog_init(_vcm) \
273 _vcm->elog_main.lock = clib_mem_alloc_aligned (CLIB_CACHE_LINE_BYTES, \
274 CLIB_CACHE_LINE_BYTES);\
275 _vcm->elog_main.lock[0] = 0; \
276 _vcm->elog_main.event_ring_size = _vcm->cfg.event_ring_size; \
277 elog_init (&_vcm->elog_main, _vcm->elog_main.event_ring_size); \
278 elog_enable_disable (&_vcm->elog_main, 1); \
281 #define vcl_elog_stop(_vcm) \
283 clib_error_t *error = 0; \
284 char *chroot_file = (char *) format (0, "%s/%d-%d-vcl-elog%c", \
285 _vcm->cfg.event_log_path, \
286 _vcm->my_client_index, \
288 error = elog_write_file (&_vcm->elog_main, chroot_file, \
289 1 /* flush ring */ ); \
291 clib_error_report (error); \
292 clib_warning ("[%d] Event Log:'%s' ", getpid (), chroot_file); \
293 vec_free (chroot_file); \
296 #define CONCAT_HELPER(_a, _b) _a##_b
297 #define CC(_a, _b) CONCAT_HELPER(_a, _b)
298 #define vcl_evt(_evt, _args...) CC(_evt, _HANDLER)(_args)
300 #define vcl_evt(_evt, _args...)
301 #define vcl_elog_init(_vcm)
302 #define vcl_elog_stop(_vcm)
305 #endif /* SRC_VCL_VCL_DEBUG_H_ */
308 * fd.io coding-style-patch-verification: ON
311 * eval: (c-set-style "gnu")