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:
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_VNET_TCP_TCP_DEBUG_H_
17 #define SRC_VNET_TCP_TCP_DEBUG_H_
19 #include <vlib/vlib.h>
22 #define TCP_DEBUG_CC (1)
23 #define TCP_DEBUG_VERBOSE (0)
25 #define foreach_tcp_dbg_evt \
33 _(SYN_SENT, "SYN sent") \
34 _(SYN_RTX, "SYN retransmit") \
35 _(FIN_SENT, "FIN sent") \
36 _(ACK_SENT, "ACK sent") \
37 _(DUPACK_SENT, "DUPACK sent") \
38 _(RST_SENT, "RST sent") \
39 _(SYN_RCVD, "SYN rcvd") \
40 _(ACK_RCVD, "ACK rcvd") \
41 _(DUPACK_RCVD, "DUPACK rcvd") \
42 _(FIN_RCVD, "FIN rcvd") \
43 _(RST_RCVD, "RST rcvd") \
44 _(PKTIZE, "packetize") \
46 _(SND_WND, "snd_wnd update") \
48 _(TIMER_POP, "timer pop") \
49 _(CC_RTX, "retransmit") \
50 _(CC_EVT, "cc event") \
51 _(CC_PACK, "cc partial ack") \
52 _(SEG_INVALID, "invalid segment") \
53 _(ACK_RCV_ERR, "invalid ack") \
54 _(RCV_WND_SHRUNK, "shrunk rcv_wnd") \
58 #define _(sym, str) TCP_DBG_##sym,
63 typedef enum _tcp_dbg_evt
65 #define _(sym, str) TCP_EVT_##sym,
72 #define TRANSPORT_DEBUG (1)
74 #define TCP_DBG(_tc, _evt, _args...) \
77 _tmp = format(_tmp, "%U", format_tcp_connection_verbose, _tc); \
78 clib_warning("%s", _tmp); \
82 #define DECLARE_ETD(_tc, _e, _size) \
87 ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, \
88 _e, _tc->c_elog_track)
90 #define TCP_EVT_INIT_HANDLER(_tc, _fmt, ...) \
92 _tc->c_elog_track.name = \
93 (char *) format (0, _fmt, _tc->c_c_index, 0); \
94 elog_track_register (&vlib_global_main.elog_main, &_tc->c_elog_track);\
97 #define TCP_EVT_DEALLOC_HANDLER(_tc, ...) \
99 vec_free (_tc->c_elog_track.name); \
102 #define TCP_EVT_OPEN_HANDLER(_tc, ...) \
104 TCP_EVT_INIT_HANDLER(_tc, "s%d%c"); \
105 ELOG_TYPE_DECLARE (_e) = \
107 .format = "open: index %d", \
108 .format_args = "i4", \
110 DECLARE_ETD(_tc, _e, 1); \
111 ed->data[0] = _tc->c_c_index; \
114 #define TCP_EVT_CLOSE_HANDLER(_tc, ...) \
116 ELOG_TYPE_DECLARE (_e) = \
118 .format = "close: %d", \
119 .format_args = "i4", \
121 DECLARE_ETD(_tc, _e, 1); \
122 ed->data[0] = _tc->c_c_index; \
125 #define TCP_EVT_BIND_HANDLER(_tc, ...) \
127 TCP_EVT_INIT_HANDLER(_tc, "l%d%c"); \
128 ELOG_TYPE_DECLARE (_e) = \
130 .format = "bind: listener %d", \
132 DECLARE_ETD(_tc, _e, 1); \
133 ed->data[0] = _tc->c_c_index; \
136 #define TCP_EVT_UNBIND_HANDLER(_tc, ...) \
138 TCP_EVT_DEALLOC_HANDLER(_tc); \
139 ELOG_TYPE_DECLARE (_e) = \
141 .format = "unbind: listener %d", \
143 DECLARE_ETD(_tc, _e, 1); \
144 ed->data[0] = _tc->c_c_index; \
145 TCP_EVT_DEALLOC_HANDLER(_tc); \
148 #define TCP_EVT_DELETE_HANDLER(_tc, ...) \
150 ELOG_TYPE_DECLARE (_e) = \
152 .format = "delete: %d", \
153 .format_args = "i4", \
155 DECLARE_ETD(_tc, _e, 1); \
156 ed->data[0] = _tc->c_c_index; \
157 TCP_EVT_DEALLOC_HANDLER(_tc); \
160 #define TCP_EVT_ACK_SENT_HANDLER(_tc, ...) \
162 ELOG_TYPE_DECLARE (_e) = \
164 .format = "ack_tx: acked %u rcv_nxt %u rcv_wnd %u snd_nxt %u snd_wnd %u",\
165 .format_args = "i4i4i4i4i4", \
167 DECLARE_ETD(_tc, _e, 5); \
168 ed->data[0] = _tc->rcv_nxt - _tc->rcv_las; \
169 ed->data[1] = _tc->rcv_nxt - _tc->irs; \
170 ed->data[2] = _tc->rcv_wnd; \
171 ed->data[3] = _tc->snd_nxt - _tc->iss; \
172 ed->data[4] = _tc->snd_wnd; \
175 #define TCP_EVT_DUPACK_SENT_HANDLER(_tc, ...) \
177 ELOG_TYPE_DECLARE (_e) = \
179 .format = "dack_tx: rcv_nxt %u rcv_wnd %u snd_nxt %u av_wnd %u snd_wnd %u",\
180 .format_args = "i4i4i4i4i4", \
182 DECLARE_ETD(_tc, _e, 5); \
183 ed->data[0] = _tc->rcv_nxt - _tc->irs; \
184 ed->data[1] = _tc->rcv_wnd; \
185 ed->data[2] = _tc->snd_nxt - _tc->iss; \
186 ed->data[3] = tcp_available_wnd(_tc); \
187 ed->data[4] = _tc->snd_wnd; \
190 #define TCP_EVT_SYN_SENT_HANDLER(_tc, ...) \
192 ELOG_TYPE_DECLARE (_e) = \
194 .format = "SYNtx: iss %u", \
195 .format_args = "i4", \
197 DECLARE_ETD(_tc, _e, 1); \
198 ed->data[0] = _tc->iss; \
201 #define TCP_EVT_SYN_RTX_HANDLER(_tc, ...) \
203 ELOG_TYPE_DECLARE (_e) = \
205 .format = "SYNrtx: iss %u", \
206 .format_args = "i4", \
208 DECLARE_ETD(_tc, _e, 1); \
209 ed->data[0] = _tc->iss; \
212 #define TCP_EVT_FIN_SENT_HANDLER(_tc, ...) \
214 ELOG_TYPE_DECLARE (_e) = \
216 .format = "FINtx: snd_nxt %d rcv_nxt %d", \
217 .format_args = "i4i4", \
219 DECLARE_ETD(_tc, _e, 2); \
220 ed->data[0] = _tc->snd_nxt - _tc->iss; \
221 ed->data[1] = _tc->rcv_nxt - _tc->irs; \
224 #define TCP_EVT_RST_SENT_HANDLER(_tc, ...) \
226 ELOG_TYPE_DECLARE (_e) = \
228 .format = "RSTtx: snd_nxt %d rcv_nxt %d", \
229 .format_args = "i4i4", \
231 DECLARE_ETD(_tc, _e, 2); \
232 ed->data[0] = _tc->snd_nxt - _tc->iss; \
233 ed->data[1] = _tc->rcv_nxt - _tc->irs; \
236 #define TCP_EVT_SYN_RCVD_HANDLER(_tc, ...) \
238 TCP_EVT_INIT_HANDLER(_tc, "s%d%c"); \
239 ELOG_TYPE_DECLARE (_e) = \
241 .format = "SYNrx: irs %u", \
242 .format_args = "i4", \
244 DECLARE_ETD(_tc, _e, 1); \
245 ed->data[0] = _tc->irs; \
248 #define TCP_EVT_FIN_RCVD_HANDLER(_tc, ...) \
250 ELOG_TYPE_DECLARE (_e) = \
252 .format = "FINrx: snd_nxt %d rcv_nxt %d", \
253 .format_args = "i4i4", \
255 DECLARE_ETD(_tc, _e, 2); \
256 ed->data[0] = _tc->snd_nxt - _tc->iss; \
257 ed->data[1] = _tc->rcv_nxt - _tc->irs; \
260 #define TCP_EVT_RST_RCVD_HANDLER(_tc, ...) \
262 ELOG_TYPE_DECLARE (_e) = \
264 .format = "RSTrx: snd_nxt %d rcv_nxt %d", \
265 .format_args = "i4i4", \
267 DECLARE_ETD(_tc, _e, 2); \
268 ed->data[0] = _tc->snd_nxt - _tc->iss; \
269 ed->data[1] = _tc->rcv_nxt - _tc->irs; \
272 #define TCP_EVT_ACK_RCVD_HANDLER(_tc, ...) \
274 ELOG_TYPE_DECLARE (_e) = \
276 .format = "acked: %u snd_una %u snd_wnd %u cwnd %u inflight %u", \
277 .format_args = "i4i4i4i4i4", \
279 DECLARE_ETD(_tc, _e, 5); \
280 ed->data[0] = _tc->bytes_acked; \
281 ed->data[1] = _tc->snd_una - _tc->iss; \
282 ed->data[2] = _tc->snd_wnd; \
283 ed->data[3] = _tc->cwnd; \
284 ed->data[4] = tcp_flight_size(_tc); \
287 #define TCP_EVT_DUPACK_RCVD_HANDLER(_tc, ...) \
289 ELOG_TYPE_DECLARE (_e) = \
291 .format = "dack_rx: snd_una %u cwnd %u snd_wnd %u flight %u rcv_wnd %u",\
292 .format_args = "i4i4i4i4i4", \
294 DECLARE_ETD(_tc, _e, 5); \
295 ed->data[0] = _tc->snd_una - _tc->iss; \
296 ed->data[1] = _tc->cwnd; \
297 ed->data[2] = _tc->snd_wnd; \
298 ed->data[3] = tcp_flight_size(_tc); \
299 ed->data[4] = _tc->rcv_wnd; \
302 #define TCP_EVT_PKTIZE_HANDLER(_tc, ...) \
304 ELOG_TYPE_DECLARE (_e) = \
306 .format = "pktize: una %u snd_nxt %u space %u flight %u rcv_wnd %u",\
307 .format_args = "i4i4i4i4i4", \
309 DECLARE_ETD(_tc, _e, 5); \
310 ed->data[0] = _tc->snd_una - _tc->iss; \
311 ed->data[1] = _tc->snd_nxt - _tc->iss; \
312 ed->data[2] = tcp_available_snd_space (_tc); \
313 ed->data[3] = tcp_flight_size (_tc); \
314 ed->data[4] = _tc->rcv_wnd; \
317 #define TCP_EVT_INPUT_HANDLER(_tc, _type, _len, _written, ...) \
319 ELOG_TYPE_DECLARE (_e) = \
321 .format = "in: %s len %u written %d rcv_nxt %u rcv_wnd(o) %d", \
322 .format_args = "t4i4i4i4i4", \
323 .n_enum_strings = 2, \
329 DECLARE_ETD(_tc, _e, 5); \
330 ed->data[0] = _type; \
331 ed->data[1] = _len; \
332 ed->data[2] = _written; \
333 ed->data[3] = (_tc->rcv_nxt - _tc->irs) + _written; \
334 ed->data[4] = _tc->rcv_wnd - (_tc->rcv_nxt - _tc->rcv_las); \
337 #define TCP_EVT_TIMER_POP_HANDLER(_tc_index, _timer_id, ...) \
339 tcp_connection_t *_tc; \
340 if (_timer_id == TCP_TIMER_RETRANSMIT_SYN) \
342 _tc = tcp_half_open_connection_get (_tc_index); \
346 u32 _thread_index = vlib_get_thread_index (); \
347 _tc = tcp_connection_get (_tc_index, _thread_index); \
349 ELOG_TYPE_DECLARE (_e) = \
351 .format = "TimerPop: %s (%d)", \
352 .format_args = "t4i4", \
353 .n_enum_strings = 7, \
364 DECLARE_ETD(_tc, _e, 2); \
365 ed->data[0] = _timer_id; \
366 ed->data[1] = _timer_id; \
369 #define TCP_EVT_SEG_INVALID_HANDLER(_tc, _seq, _end, ...) \
371 ELOG_TYPE_DECLARE (_e) = \
373 .format = "seg-inv: seq %u end %u rcv_las %u rcv_nxt %u rcv_wnd %u",\
374 .format_args = "i4i4i4i4i4", \
376 DECLARE_ETD(_tc, _e, 5); \
377 ed->data[0] = _seq - _tc->irs; \
378 ed->data[1] = _end - _tc->irs; \
379 ed->data[2] = _tc->rcv_las - _tc->irs; \
380 ed->data[3] = _tc->rcv_nxt - _tc->irs; \
381 ed->data[4] = _tc->rcv_wnd; \
384 #define TCP_EVT_ACK_RCV_ERR_HANDLER(_tc, _type, _ack, ...) \
386 ELOG_TYPE_DECLARE (_e) = \
388 .format = "ack-err: %s ack %u snd_una %u snd_nxt %u una_max %u", \
389 .format_args = "t4i4i4i4i4", \
390 .n_enum_strings = 3, \
397 DECLARE_ETD(_tc, _e, 5); \
398 ed->data[0] = _type; \
399 ed->data[1] = _ack - _tc->iss; \
400 ed->data[2] = _tc->snd_una - _tc->iss; \
401 ed->data[3] = _tc->snd_nxt - _tc->iss; \
402 ed->data[4] = _tc->snd_una_max - _tc->iss; \
410 #define TCP_EVT_CC_RTX_HANDLER(_tc, offset, n_bytes, ...) \
412 ELOG_TYPE_DECLARE (_e) = \
414 .format = "rtx: snd_nxt %u offset %u snd %u rtx %u", \
415 .format_args = "i4i4i4i4", \
417 DECLARE_ETD(_tc, _e, 4); \
418 ed->data[0] = _tc->snd_nxt - _tc->iss; \
419 ed->data[1] = offset; \
420 ed->data[2] = n_bytes; \
421 ed->data[3] = _tc->rtx_bytes; \
424 #define TCP_EVT_CC_EVT_HANDLER(_tc, _sub_evt, ...) \
426 ELOG_TYPE_DECLARE (_e) = \
428 .format = "cc: %s wnd %u snd_cong %u rtx_bytes %u", \
429 .format_args = "t4i4i4i4", \
430 .n_enum_strings = 5, \
439 DECLARE_ETD(_tc, _e, 4); \
440 ed->data[0] = _sub_evt; \
441 ed->data[1] = tcp_available_snd_space (_tc); \
442 ed->data[2] = _tc->snd_congestion - _tc->iss; \
443 ed->data[3] = _tc->rtx_bytes; \
446 #define TCP_EVT_CC_PACK_HANDLER(_tc, ...) \
448 ELOG_TYPE_DECLARE (_e) = \
450 .format = "pack: snd_una %u snd_una_max %u", \
451 .format_args = "i4i4", \
453 DECLARE_ETD(_tc, _e, 2); \
454 ed->data[0] = _tc->snd_una - _tc->iss; \
455 ed->data[1] = _tc->snd_una_max - _tc->iss; \
459 #define TCP_EVT_CC_RTX_HANDLER(_tc, offset, n_bytes, ...)
460 #define TCP_EVT_CC_EVT_HANDLER(_tc, _sub_evt, _snd_space, ...)
461 #define TCP_EVT_CC_PACK_HANDLER(_tc, ...)
464 #define TCP_EVT_RCV_WND_SHRUNK_HANDLER(_tc, _obs, _av, ...) \
468 ELOG_TYPE_DECLARE (_e) = \
470 .format = "huh?: rcv_wnd %u obsd %u av %u rcv_nxt %u rcv_las %u", \
471 .format_args = "i4i4i4i4i4", \
473 DECLARE_ETD(_tc, _e, 5); \
474 ed->data[0] = _tc->rcv_wnd; \
475 ed->data[1] = _obs; \
477 ed->data[3] = _tc->rcv_nxt - _tc->irs; \
478 ed->data[4] = _tc->rcv_las - _tc->irs; \
483 #define TCP_EVT_SND_WND_HANDLER(_tc, ...) \
485 ELOG_TYPE_DECLARE (_e) = \
487 .format = "snd_wnd update: %u ", \
488 .format_args = "i4", \
490 DECLARE_ETD(_tc, _e, 1); \
491 ed->data[0] = _tc->snd_wnd; \
494 #define TCP_EVT_OUTPUT_HANDLER(_tc, flags, n_bytes,...) \
496 ELOG_TYPE_DECLARE (_e) = \
498 .format = "out: flags %x, bytes %u", \
499 .format_args = "i4i4", \
501 DECLARE_ETD(_tc, _e, 2); \
502 ed->data[0] = flags; \
503 ed->data[1] = n_bytes; \
506 #define TCP_EVT_SND_WND_HANDLER(_tc, ...)
507 #define TCP_EVT_OUTPUT_HANDLER(_tc, flags, n_bytes,...)
510 #define CONCAT_HELPER(_a, _b) _a##_b
511 #define CC(_a, _b) CONCAT_HELPER(_a, _b)
512 #define TCP_EVT_DBG(_evt, _args...) CC(_evt, _HANDLER)(_args)
515 #define TCP_EVT_DBG(_evt, _args...)
519 #endif /* SRC_VNET_TCP_TCP_DEBUG_H_ */
521 * fd.io coding-style-patch-verification: ON
524 * eval: (c-set-style "gnu")