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.
16 #ifndef SRC_VNET_TCP_TCP_DEBUG_H_
17 #define SRC_VNET_TCP_TCP_DEBUG_H_
19 #include <vlib/vlib.h>
20 #include <vpp/vnet/config.h>
23 * Build debugging infra unconditionally. Debug components controlled via
24 * debug configuration. Comes with some overhead so it's not recommended for
25 * production/performance scenarios. Takes priority over TCP_DEBUG_ENABLE.
27 #ifdef VPP_TCP_DEBUG_ALWAYS
28 #define TCP_DEBUG_ALWAYS (1)
30 #define TCP_DEBUG_ALWAYS (0)
33 * Build debugging infra only if enabled. Debug components controlled via
36 #define TCP_DEBUG_ENABLE (0)
38 #define TCP_DEBUG_SM (0)
39 #define TCP_DEBUG_CC (0)
40 #define TCP_DEBUG_CS (0)
41 #define TCP_DEBUG_LC (0 || TCP_DEBUG_SM || TCP_DEBUG_CC || TCP_DEBUG_CS)
43 #define TCP_DEBUG (TCP_DEBUG_ALWAYS || TCP_DEBUG_ENABLE)
44 #define TCP_DEBUG_BUF_ALLOC (0)
47 #define TRANSPORT_DEBUG (1)
50 #define TCP_CONCAT_HELPER(_a, _b) _a##_b
51 #define TCP_CC(_a, _b) TCP_CONCAT_HELPER(_a, _b)
53 #define tcp_evt_lvl(_evt) TCP_CC(_evt, _LVL)
54 #define tcp_evt_grp(_evt) TCP_CC(_evt, _GRP)
55 #define tcp_evt_handler(_evt, _args...) TCP_CC(_evt, _HANDLER) (_args)
56 #define tcp_evt_grp_dbg_lvl(_evt) tcp_dbg_main.grp_dbg_lvl[tcp_evt_grp (_evt)]
58 #define foreach_tcp_evt_grp \
60 _(SM, "state machine") \
61 _(CC, "congestion control") \
64 typedef enum tcp_evt_grp_
66 #define _(sym, str) TCP_EVT_GRP_ ## sym,
72 typedef struct tcp_dbg_main_
74 u8 grp_dbg_lvl[TCP_EVT_N_GRP];
75 u32 *free_track_indices;
78 extern tcp_dbg_main_t tcp_dbg_main;
80 #define foreach_tcp_dbg_evt \
81 _(INIT, LC, 1, "init") \
82 _(DEALLOC, LC, 1, "dealloc") \
83 _(OPEN, LC, 1, "open") \
84 _(CLOSE, LC, 1, "close") \
85 _(BIND, LC, 1, "bind") \
86 _(UNBIND, LC, 1, "unbind") \
87 _(DELETE, LC, 1, "delete") \
88 _(SYN_RCVD, LC, 1, "SYN rcvd") \
89 _(STATE_CHANGE, LC, 1, "state change") \
90 _(SYN_SENT, SM, 1, "SYN sent") \
91 _(SYN_RXT, SM, 1, "SYN retransmit") \
92 _(SYNACK_SENT, SM, 1, "SYNACK sent") \
93 _(SYNACK_RCVD, SM, 1, "SYNACK rcvd") \
94 _(FIN_SENT, SM, 1, "FIN sent") \
95 _(FIN_RCVD, SM, 1, "FIN rcvd") \
96 _(RST_SENT, SM, 1, "RST sent") \
97 _(RST_RCVD, SM, 1, "RST rcvd") \
98 _(TIMER_POP, SM, 1, "timer pop") \
99 _(SEG_INVALID, SM, 2, "invalid segment") \
100 _(PAWS_FAIL, SM, 2, "failed paws check") \
101 _(ACK_RCV_ERR, SM, 2, "invalid ack") \
102 _(RCV_WND_SHRUNK, SM, 2, "shrunk rcv_wnd") \
103 _(ACK_SENT, SM, 3, "ACK sent") \
104 _(ACK_RCVD, SM, 3, "ACK rcvd") \
105 _(PKTIZE, SM, 3, "packetize") \
106 _(INPUT, SM, 3, "in") \
107 _(OUTPUT, SM, 4, "output") \
108 _(SND_WND, SM, 4, "snd_wnd update") \
109 _(CC_EVT, CC, 1, "cc event") \
110 _(CC_RTX, CC, 2, "retransmit") \
111 _(CC_PACK, CC, 2, "cc partial ack") \
112 _(DUPACK_SENT, CC, 2, "DUPACK sent") \
113 _(DUPACK_RCVD, CC, 2, "DUPACK rcvd") \
114 _(CC_SCOREBOARD, CC, 2, "scoreboard stats") \
115 _(CC_SACKS, CC, 2, "snd sacks stats") \
116 _(CC_INPUT, CC, 2, "ooo data delivered") \
117 _(CC_STAT, CS, 1, "cc stats") \
118 _(CC_RTO_STAT, CS, 1, "cc rto stats") \
120 typedef enum tcp_evt_types_
122 #define _(sym, grp, lvl, str) TCP_EVT_##sym,
127 typedef enum tcp_evt_lvl_
129 #define _(sym, grp, lvl, str) TCP_EVT_## sym ## _LVL = lvl,
134 typedef enum tcp_evt_to_grp_
136 #define _(sym, grp, lvl, str) TCP_EVT_ ## sym ## _GRP = TCP_EVT_GRP_ ## grp,
141 #if TCP_DEBUG_ALWAYS > 0
142 #define TCP_EVT(_evt, _args...) \
143 if (PREDICT_FALSE (tcp_evt_grp_dbg_lvl (_evt) >= tcp_evt_lvl (_evt))) \
144 tcp_evt_handler (_evt, _args)
145 #define TCP_DBG(_fmt, _args...) clib_warning (_fmt, ##_args)
146 #elif TCP_DEBUG_ENABLE > 0
147 #define TCP_EVT(_evt, _args...) tcp_evt_handler(_evt, _args)
148 #define TCP_DBG(_fmt, _args...) clib_warning (_fmt, ##_args)
150 #define TCP_EVT(_evt, _args...)
151 #define TCP_DBG(_fmt, _args...)
154 void tcp_evt_track_register (elog_track_t * et);
155 void tcp_debug_init (void);
157 #define TCP_DECLARE_ETD(_tc, _e, _size) \
162 ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, _e, \
166 * Event handlers definitions
169 #if TCP_DEBUG_LC || TCP_DEBUG_ALWAYS
172 * Infra and evt track setup
175 #define TCP_DBG_IP_TAG_LCL(_tc) \
179 ELOG_TYPE_DECLARE (_e) = \
181 .format = "lcl: %d.%d.%d.%d:%d", \
182 .format_args = "i4i4i4i4i4", \
184 TCP_DECLARE_ETD(_tc, _e, 5); \
185 ed->data[0] = _tc->c_lcl_ip.ip4.as_u8[0]; \
186 ed->data[1] = _tc->c_lcl_ip.ip4.as_u8[1]; \
187 ed->data[2] = _tc->c_lcl_ip.ip4.as_u8[2]; \
188 ed->data[3] = _tc->c_lcl_ip.ip4.as_u8[3]; \
189 ed->data[4] = clib_net_to_host_u16(_tc->c_lcl_port); \
193 #define TCP_DBG_IP_TAG_RMT(_tc) \
197 ELOG_TYPE_DECLARE (_e) = \
199 .format = "rmt: %d.%d.%d.%d:%d", \
200 .format_args = "i4i4i4i4i4", \
202 TCP_DECLARE_ETD(_tc, _e, 5); \
203 ed->data[0] = _tc->c_rmt_ip.ip4.as_u8[0]; \
204 ed->data[1] = _tc->c_rmt_ip.ip4.as_u8[1]; \
205 ed->data[2] = _tc->c_rmt_ip.ip4.as_u8[2]; \
206 ed->data[3] = _tc->c_rmt_ip.ip4.as_u8[3]; \
207 ed->data[4] = clib_net_to_host_u16(_tc->c_rmt_port); \
211 #define TCP_EVT_INIT_HANDLER(_tc, _is_l, ...) \
213 char *_fmt = _is_l ? "l[%d].%d:%d%c" : "[%d].%d:%d->.%d:%d%c"; \
216 _tc->c_elog_track.name = \
217 (char *) format (0, _fmt, _tc->c_thread_index, \
218 _tc->c_lcl_ip.ip4.as_u8[3], \
219 clib_net_to_host_u16(_tc->c_lcl_port), \
220 _tc->c_rmt_ip.ip4.as_u8[3], \
221 clib_net_to_host_u16(_tc->c_rmt_port), 0); \
224 _tc->c_elog_track.name = \
225 (char *) format (0, _fmt, _tc->c_thread_index, \
226 _tc->c_lcl_ip.ip6.as_u8[15], \
227 clib_net_to_host_u16(_tc->c_lcl_port), \
228 _tc->c_rmt_ip.ip6.as_u8[15], \
229 clib_net_to_host_u16(_tc->c_rmt_port), 0); \
230 tcp_evt_track_register (&_tc->c_elog_track); \
231 TCP_DBG_IP_TAG_LCL(_tc); \
232 TCP_DBG_IP_TAG_RMT(_tc); \
235 #define TCP_EVT_DEALLOC_HANDLER(_tc, ...) \
237 vec_free (_tc->c_elog_track.name); \
238 vec_add1 (tcp_dbg_main.free_track_indices, \
239 _tc->c_elog_track.track_index_plus_one - 1); \
242 #define TCP_EVT_OPEN_HANDLER(_tc, ...) \
244 TCP_EVT_INIT_HANDLER(_tc, 0); \
245 ELOG_TYPE_DECLARE (_e) = \
247 .format = "open: index %d", \
248 .format_args = "i4", \
250 TCP_DECLARE_ETD(_tc, _e, 1); \
251 ed->data[0] = _tc->c_c_index; \
254 #define TCP_EVT_CLOSE_HANDLER(_tc, ...) \
256 ELOG_TYPE_DECLARE (_e) = \
258 .format = "close: cidx %d", \
259 .format_args = "i4", \
261 TCP_DECLARE_ETD(_tc, _e, 1); \
262 ed->data[0] = _tc->c_c_index; \
265 #define TCP_EVT_BIND_HANDLER(_tc, ...) \
267 TCP_EVT_INIT_HANDLER(_tc, 1); \
268 ELOG_TYPE_DECLARE (_e) = \
270 .format = "bind: listener %d", \
272 TCP_DECLARE_ETD(_tc, _e, 1); \
273 ed->data[0] = _tc->c_c_index; \
276 #define TCP_EVT_SYN_RCVD_HANDLER(_tc,_init, ...) \
279 TCP_EVT_INIT_HANDLER(_tc, 0); \
280 ELOG_TYPE_DECLARE (_e) = \
282 .format = "syn-rx: cidx %u sidx %u irs %u", \
283 .format_args = "i4i4i4", \
285 TCP_DECLARE_ETD(_tc, _e, 3); \
286 ed->data[0] = _tc->c_c_index; \
287 ed->data[1] = _tc->c_s_index; \
288 ed->data[2] = _tc->irs; \
289 TCP_EVT_STATE_CHANGE_HANDLER(_tc); \
292 #define TCP_EVT_UNBIND_HANDLER(_tc, ...) \
294 TCP_EVT_DEALLOC_HANDLER(_tc); \
295 ELOG_TYPE_DECLARE (_e) = \
297 .format = "unbind: listener %d", \
299 TCP_DECLARE_ETD(_tc, _e, 1); \
300 ed->data[0] = _tc->c_c_index; \
301 TCP_EVT_DEALLOC_HANDLER(_tc); \
304 #define TCP_EVT_DELETE_HANDLER(_tc, ...) \
306 ELOG_TYPE_DECLARE (_e) = \
308 .format = "delete: cidx %d sidx %d", \
309 .format_args = "i4i4", \
311 TCP_DECLARE_ETD(_tc, _e, 2); \
312 ed->data[0] = _tc->c_c_index; \
313 ed->data[1] = _tc->c_s_index; \
314 TCP_EVT_DEALLOC_HANDLER(_tc); \
322 #if TCP_DEBUG_SM > 0 || TCP_DEBUG_ALWAYS
324 #define TCP_EVT_STATE_CHANGE_HANDLER(_tc, ...) \
326 ELOG_TYPE_DECLARE (_e) = \
328 .format = "state: %s", \
329 .format_args = "t4", \
330 .n_enum_strings = 11, \
345 TCP_DECLARE_ETD(_tc, _e, 1); \
346 ed->data[0] = _tc->state; \
349 #define TCP_EVT_SYN_SENT_HANDLER(_tc, ...) \
351 ELOG_TYPE_DECLARE (_e) = \
353 .format = "syn-tx: iss %u snd_una %u snd_nxt %u", \
354 .format_args = "i4i4i4", \
356 TCP_DECLARE_ETD(_tc, _e, 3); \
357 ed->data[0] = _tc->iss; \
358 ed->data[1] = _tc->snd_una - _tc->iss; \
359 ed->data[2] = _tc->snd_nxt - _tc->iss; \
360 TCP_EVT_STATE_CHANGE_HANDLER(_tc); \
363 #define TCP_EVT_SYNACK_SENT_HANDLER(_tc, ...) \
365 ELOG_TYPE_DECLARE (_e) = \
367 .format = "synack-tx: iss %u irs %u snd_una %u snd_nxt %u rcv_nxt %u",\
368 .format_args = "i4i4i4i4i4", \
370 TCP_DECLARE_ETD(_tc, _e, 5); \
371 ed->data[0] = _tc->iss; \
372 ed->data[1] = _tc->irs; \
373 ed->data[2] = _tc->snd_una - _tc->iss; \
374 ed->data[3] = _tc->snd_nxt - _tc->iss; \
375 ed->data[4] = _tc->rcv_nxt - _tc->irs; \
378 #define TCP_EVT_SYNACK_RCVD_HANDLER(_tc, ...) \
380 ELOG_TYPE_DECLARE (_e) = \
382 .format = "synack-rx: iss %u irs %u snd_una %u snd_nxt %u rcv_nxt %u",\
383 .format_args = "i4i4i4i4i4", \
385 TCP_DECLARE_ETD(_tc, _e, 5); \
386 ed->data[0] = _tc->iss; \
387 ed->data[1] = _tc->irs; \
388 ed->data[2] = _tc->snd_una - _tc->iss; \
389 ed->data[3] = _tc->snd_nxt - _tc->iss; \
390 ed->data[4] = _tc->rcv_nxt - _tc->irs; \
391 TCP_EVT_STATE_CHANGE_HANDLER(_tc); \
394 #define TCP_EVT_FIN_SENT_HANDLER(_tc, ...) \
396 ELOG_TYPE_DECLARE (_e) = \
398 .format = "fin-tx: snd_nxt %d rcv_nxt %d", \
399 .format_args = "i4i4", \
401 TCP_DECLARE_ETD(_tc, _e, 2); \
402 ed->data[0] = _tc->snd_nxt - _tc->iss; \
403 ed->data[1] = _tc->rcv_nxt - _tc->irs; \
406 #define TCP_EVT_RST_SENT_HANDLER(_tc, ...) \
410 ELOG_TYPE_DECLARE (_e) = \
412 .format = "rst-tx: snd_nxt %d rcv_nxt %d", \
413 .format_args = "i4i4", \
415 TCP_DECLARE_ETD(_tc, _e, 2); \
416 ed->data[0] = _tc->snd_nxt - _tc->iss; \
417 ed->data[1] = _tc->rcv_nxt - _tc->irs; \
418 TCP_EVT_STATE_CHANGE_HANDLER(_tc); \
422 #define TCP_EVT_FIN_RCVD_HANDLER(_tc, ...) \
424 ELOG_TYPE_DECLARE (_e) = \
426 .format = "fin-rx: snd_nxt %d rcv_nxt %d", \
427 .format_args = "i4i4", \
429 TCP_DECLARE_ETD(_tc, _e, 2); \
430 ed->data[0] = _tc->snd_nxt - _tc->iss; \
431 ed->data[1] = _tc->rcv_nxt - _tc->irs; \
434 #define TCP_EVT_RST_RCVD_HANDLER(_tc, ...) \
436 ELOG_TYPE_DECLARE (_e) = \
438 .format = "rst-rx: snd_nxt %d rcv_nxt %d", \
439 .format_args = "i4i4", \
441 TCP_DECLARE_ETD(_tc, _e, 2); \
442 ed->data[0] = _tc->snd_nxt - _tc->iss; \
443 ed->data[1] = _tc->rcv_nxt - _tc->irs; \
446 #define TCP_EVT_SYN_RXT_HANDLER(_tc, _type, ...) \
448 ELOG_TYPE_DECLARE (_e) = \
450 .format = "%s-rxt: iss %u irs %u snd_nxt %u rcv_nxt %u", \
451 .format_args = "t4i4i4i4i4", \
452 .n_enum_strings = 2, \
458 TCP_DECLARE_ETD(_tc, _e, 5); \
459 ed->data[0] = _type; \
460 ed->data[1] = _tc->iss; \
461 ed->data[2] = _tc->irs; \
462 ed->data[3] = _tc->snd_nxt - _tc->iss; \
463 ed->data[4] = _tc->rcv_nxt - _tc->irs; \
466 #define TCP_EVT_TIMER_POP_HANDLER(_tc_index, _timer_id, ...) \
468 tcp_connection_t *_tc; \
469 if (_timer_id == TCP_TIMER_RETRANSMIT_SYN) \
471 _tc = tcp_half_open_connection_get (_tc_index); \
475 u32 _thread_index = vlib_get_thread_index (); \
476 _tc = tcp_connection_get (_tc_index, _thread_index); \
478 ELOG_TYPE_DECLARE (_e) = \
480 .format = "timer-pop: %s cidx %u sidx %u", \
481 .format_args = "t4i4i4", \
482 .n_enum_strings = 8, \
496 TCP_DECLARE_ETD(_tc, _e, 3); \
497 ed->data[0] = _timer_id; \
498 ed->data[1] = _tc->c_c_index; \
499 ed->data[2] = _tc->c_s_index; \
503 clib_warning ("pop %d for unexisting connection %d", _timer_id, \
509 #define TCP_EVT_SYN_SENT_HANDLER(_tc, ...)
510 #define TCP_EVT_SYNACK_SENT_HANDLER(_tc, ...)
511 #define TCP_EVT_SYNACK_RCVD_HANDLER(_tc, ...)
512 #define TCP_EVT_SYN_RXT_HANDLER(_tc, ...)
513 #define TCP_EVT_FIN_SENT_HANDLER(_tc, ...)
514 #define TCP_EVT_RST_SENT_HANDLER(_tc, ...)
515 #define TCP_EVT_FIN_RCVD_HANDLER(_tc, ...)
516 #define TCP_EVT_RST_RCVD_HANDLER(_tc, ...)
517 #define TCP_EVT_STATE_CHANGE_HANDLER(_tc, ...)
518 #define TCP_EVT_TIMER_POP_HANDLER(_tc_index, _timer_id, ...)
521 #if TCP_DEBUG_SM > 1 || TCP_DEBUG_ALWAYS
522 #define TCP_EVT_SEG_INVALID_HANDLER(_tc, _btcp, ...) \
524 ELOG_TYPE_DECLARE (_e) = \
526 .format = "seg-inv: seq %u end %u rcv_las %u rcv_nxt %u rcv_wnd %u",\
527 .format_args = "i4i4i4i4i4", \
529 TCP_DECLARE_ETD(_tc, _e, 5); \
530 ed->data[0] = _btcp.seq_number - _tc->irs; \
531 ed->data[1] = _btcp.seq_end - _tc->irs; \
532 ed->data[2] = _tc->rcv_las - _tc->irs; \
533 ed->data[3] = _tc->rcv_nxt - _tc->irs; \
534 ed->data[4] = _tc->rcv_wnd; \
537 #define TCP_EVT_PAWS_FAIL_HANDLER(_tc, _seq, _end, ...) \
539 ELOG_TYPE_DECLARE (_e) = \
541 .format = "paws-err: seq %u end %u tsval %u tsval_recent %u", \
542 .format_args = "i4i4i4i4", \
544 TCP_DECLARE_ETD(_tc, _e, 4); \
545 ed->data[0] = _seq - _tc->irs; \
546 ed->data[1] = _end - _tc->irs; \
547 ed->data[2] = _tc->rcv_opts.tsval; \
548 ed->data[3] = _tc->tsval_recent; \
551 #define TCP_EVT_ACK_RCV_ERR_HANDLER(_tc, _type, _ack, ...) \
553 ELOG_TYPE_DECLARE (_e) = \
555 .format = "ack-err: %s ack %u snd_una %u snd_nxt %u", \
556 .format_args = "t4i4i4i4", \
557 .n_enum_strings = 3, \
564 TCP_DECLARE_ETD(_tc, _e, 4); \
565 ed->data[0] = _type; \
566 ed->data[1] = _ack - _tc->iss; \
567 ed->data[2] = _tc->snd_una - _tc->iss; \
568 ed->data[3] = _tc->snd_nxt - _tc->iss; \
571 #define TCP_EVT_RCV_WND_SHRUNK_HANDLER(_tc, _obs, _av, ...) \
575 ELOG_TYPE_DECLARE (_e) = \
577 .format = "huh?: rcv_wnd %u obsd %u av %u rcv_nxt %u rcv_las %u", \
578 .format_args = "i4i4i4i4i4", \
580 TCP_DECLARE_ETD(_tc, _e, 5); \
581 ed->data[0] = _tc->rcv_wnd; \
582 ed->data[1] = _obs; \
584 ed->data[3] = _tc->rcv_nxt - _tc->irs; \
585 ed->data[4] = _tc->rcv_las - _tc->irs; \
589 #define TCP_EVT_SEG_INVALID_HANDLER(_tc, _btcp, ...)
590 #define TCP_EVT_PAWS_FAIL_HANDLER(_tc, _seq, _end, ...)
591 #define TCP_EVT_ACK_RCV_ERR_HANDLER(_tc, _type, _ack, ...)
592 #define TCP_EVT_RCV_WND_SHRUNK_HANDLER(_tc, _obs, _av, ...)
595 #if TCP_DEBUG_SM > 2 || TCP_DEBUG_ALWAYS
597 #define TCP_EVT_ACK_SENT_HANDLER(_tc, ...) \
599 ELOG_TYPE_DECLARE (_e) = \
601 .format = "ack-tx: acked %u rcv_nxt %u rcv_wnd %u snd_nxt %u snd_wnd %u",\
602 .format_args = "i4i4i4i4i4", \
604 TCP_DECLARE_ETD(_tc, _e, 5); \
605 ed->data[0] = _tc->rcv_nxt - _tc->rcv_las; \
606 ed->data[1] = _tc->rcv_nxt - _tc->irs; \
607 ed->data[2] = _tc->rcv_wnd; \
608 ed->data[3] = _tc->snd_nxt - _tc->iss; \
609 ed->data[4] = _tc->snd_wnd; \
612 #define TCP_EVT_ACK_RCVD_HANDLER(_tc, ...) \
614 ELOG_TYPE_DECLARE (_e) = \
616 .format = "ack-rx: %u snd_una %u snd_wnd %u cwnd %u inflight %u", \
617 .format_args = "i4i4i4i4i4", \
619 TCP_DECLARE_ETD(_tc, _e, 5); \
620 ed->data[0] = _tc->bytes_acked; \
621 ed->data[1] = _tc->snd_una - _tc->iss; \
622 ed->data[2] = _tc->snd_wnd; \
623 ed->data[3] = _tc->cwnd; \
624 ed->data[4] = tcp_flight_size(_tc); \
627 #define TCP_EVT_PKTIZE_HANDLER(_tc, ...) \
629 ELOG_TYPE_DECLARE (_e) = \
631 .format = "tx: una %u snd_nxt %u space %u flight %u rcv_wnd %u",\
632 .format_args = "i4i4i4i4i4", \
634 TCP_DECLARE_ETD(_tc, _e, 5); \
635 ed->data[0] = _tc->snd_una - _tc->iss; \
636 ed->data[1] = _tc->snd_nxt - _tc->iss; \
637 ed->data[2] = tcp_available_output_snd_space (_tc); \
638 ed->data[3] = tcp_flight_size (_tc); \
639 ed->data[4] = _tc->rcv_wnd; \
642 #define TCP_EVT_INPUT_HANDLER(_tc, _type, _len, _written, ...) \
644 ELOG_TYPE_DECLARE (_e) = \
646 .format = "in: %s len %u written %d rcv_nxt %u rcv_wnd(o) %d", \
647 .format_args = "t4i4i4i4i4", \
648 .n_enum_strings = 2, \
654 TCP_DECLARE_ETD(_tc, _e, 5); \
655 ed->data[0] = _type; \
656 ed->data[1] = _len; \
657 ed->data[2] = _written; \
658 ed->data[3] = (_tc->rcv_nxt - _tc->irs) + _written; \
659 ed->data[4] = _tc->rcv_wnd - (_tc->rcv_nxt - _tc->rcv_las); \
663 #define TCP_EVT_ACK_SENT_HANDLER(_tc, ...)
664 #define TCP_EVT_ACK_RCVD_HANDLER(_tc, ...)
665 #define TCP_EVT_PKTIZE_HANDLER(_tc, ...)
666 #define TCP_EVT_INPUT_HANDLER(_tc, _type, _len, _written, ...)
670 * State machine verbose
672 #if TCP_DEBUG_SM > 3 || TCP_DEBUG_ALWAYS
673 #define TCP_EVT_SND_WND_HANDLER(_tc, ...) \
675 ELOG_TYPE_DECLARE (_e) = \
677 .format = "snd-wnd update: %u ", \
678 .format_args = "i4", \
680 TCP_DECLARE_ETD(_tc, _e, 1); \
681 ed->data[0] = _tc->snd_wnd; \
684 #define TCP_EVT_OUTPUT_HANDLER(_tc, flags, n_bytes,...) \
686 ELOG_TYPE_DECLARE (_e) = \
688 .format = "out: flags %x, bytes %u", \
689 .format_args = "i4i4", \
691 TCP_DECLARE_ETD(_tc, _e, 2); \
692 ed->data[0] = flags; \
693 ed->data[1] = n_bytes; \
696 #define TCP_EVT_SND_WND_HANDLER(_tc, ...)
697 #define TCP_EVT_OUTPUT_HANDLER(_tc, flags, n_bytes,...)
704 #if TCP_DEBUG_CC || TCP_DEBUG_ALWAYS
706 #define TCP_EVT_CC_EVT_PRINT(_tc, _sub_evt) \
708 ELOG_TYPE_DECLARE (_e) = \
710 .format = "cc: %s snd_space %u snd_una %u out %u flight %u", \
711 .format_args = "t4i4i4i4i4", \
712 .n_enum_strings = 7, \
723 TCP_DECLARE_ETD(_tc, _e, 5); \
724 ed->data[0] = _sub_evt; \
725 ed->data[1] = tcp_available_cc_snd_space (_tc); \
726 ed->data[2] = _tc->snd_una - _tc->iss; \
727 ed->data[3] = tcp_bytes_out(_tc); \
728 ed->data[4] = tcp_flight_size (_tc); \
731 #define TCP_EVT_CC_EVT_HANDLER(_tc, _sub_evt, ...) \
733 if (_tc->snd_una != _tc->iss) \
734 TCP_EVT_CC_STAT_PRINT (_tc); \
735 if ((_sub_evt <= 1 && TCP_DEBUG_CC > 1) \
736 || (_sub_evt > 1 && TCP_DEBUG_CC > 0)) \
737 TCP_EVT_CC_EVT_PRINT (_tc, _sub_evt); \
740 #define TCP_EVT_CC_EVT_HANDLER(_tc, _sub_evt, ...) \
744 #if TCP_DEBUG_CC > 1 || TCP_DEBUG_ALWAYS
745 #define TCP_EVT_CC_RTX_HANDLER(_tc, offset, n_bytes, ...) \
747 ELOG_TYPE_DECLARE (_e) = \
749 .format = "rxt: snd_nxt %u offset %u snd %u rxt %u", \
750 .format_args = "i4i4i4i4", \
752 TCP_DECLARE_ETD(_tc, _e, 4); \
753 ed->data[0] = _tc->snd_nxt - _tc->iss; \
754 ed->data[1] = offset; \
755 ed->data[2] = n_bytes; \
756 ed->data[3] = _tc->snd_rxt_bytes; \
759 #define TCP_EVT_DUPACK_SENT_HANDLER(_tc, _btcp, ...) \
761 ELOG_TYPE_DECLARE (_e) = \
763 .format = "dack-tx: rcv_nxt %u seq %u rcv_wnd %u snd_nxt %u av_wnd %u",\
764 .format_args = "i4i4i4i4i4", \
766 TCP_DECLARE_ETD(_tc, _e, 5); \
767 ed->data[0] = _tc->rcv_nxt - _tc->irs; \
768 ed->data[1] = _btcp.seq_number - _tc->irs; \
769 ed->data[2] = _tc->rcv_wnd; \
770 ed->data[3] = _tc->snd_nxt - _tc->iss; \
771 ed->data[4] = tcp_available_snd_wnd(_tc); \
774 #define TCP_EVT_DUPACK_RCVD_HANDLER(_tc, ...) \
776 ELOG_TYPE_DECLARE (_e) = \
778 .format = "dack-rx: snd_una %u cwnd %u snd_wnd %u flight %u rcv_wnd %u",\
779 .format_args = "i4i4i4i4i4", \
781 TCP_DECLARE_ETD(_tc, _e, 5); \
782 ed->data[0] = _tc->snd_una - _tc->iss; \
783 ed->data[1] = _tc->cwnd; \
784 ed->data[2] = _tc->snd_wnd; \
785 ed->data[3] = tcp_flight_size(_tc); \
786 ed->data[4] = _tc->rcv_wnd; \
789 #define TCP_EVT_CC_PACK_HANDLER(_tc, ...) \
791 ELOG_TYPE_DECLARE (_e) = \
793 .format = "pack: snd_una %u snd_nxt %u", \
794 .format_args = "i4i4", \
796 TCP_DECLARE_ETD(_tc, _e, 2); \
797 ed->data[0] = _tc->snd_una - _tc->iss; \
798 ed->data[1] = _tc->snd_nxt - _tc->iss; \
800 #define TCP_EVT_CC_SCOREBOARD_HANDLER(_tc, ...) \
802 if (TCP_DEBUG_CC > 1 && _tc->sack_sb.last_sacked_bytes) \
804 ELOG_TYPE_DECLARE (_e) = \
806 .format = "sb1: holes %u lost %u sacked %u high %u highrxt %u", \
807 .format_args = "i4i4i4i4i4", \
809 TCP_DECLARE_ETD(_tc, _e, 5); \
810 ed->data[0] = pool_elts(_tc->sack_sb.holes); \
811 ed->data[1] = _tc->sack_sb.lost_bytes; \
812 ed->data[2] = _tc->sack_sb.sacked_bytes; \
813 ed->data[3] = _tc->sack_sb.high_sacked - _tc->iss; \
814 ed->data[4] = _tc->sack_sb.high_rxt - _tc->iss; \
816 if (TCP_DEBUG_CC > 1 && _tc->sack_sb.last_sacked_bytes) \
818 sack_scoreboard_hole_t *hole; \
819 hole = scoreboard_first_hole (&_tc->sack_sb); \
820 ELOG_TYPE_DECLARE (_e) = \
822 .format = "sb2: first start: %u end %u last start %u end %u", \
823 .format_args = "i4i4i4i4", \
825 TCP_DECLARE_ETD(_tc, _e, 4); \
826 ed->data[0] = hole ? hole->start - _tc->iss : 0; \
827 ed->data[1] = hole ? hole->end - _tc->iss : 0; \
828 hole = scoreboard_last_hole (&_tc->sack_sb); \
829 ed->data[2] = hole ? hole->start - _tc->iss : 0; \
830 ed->data[3] = hole ? hole->end - _tc->iss : 0; \
833 #define TCP_EVT_CC_SACKS_HANDLER(_tc, ...) \
835 if (TCP_DEBUG_CC > 1) \
837 ELOG_TYPE_DECLARE (_e) = \
839 .format = "sacks: blocks %u bytes %u", \
840 .format_args = "i4i4", \
842 TCP_DECLARE_ETD(_tc, _e, 2); \
843 ed->data[0] = vec_len (_tc->snd_sacks); \
844 ed->data[1] = tcp_sack_list_bytes (_tc); \
847 #define TCP_EVT_CC_INPUT_HANDLER(_tc, _len, _written, ...) \
849 ELOG_TYPE_DECLARE (_e) = \
851 .format = "cc input: len %u written %d rcv_nxt %u rcv_wnd(o) %d", \
852 .format_args = "i4i4i4i4", \
854 TCP_DECLARE_ETD(_tc, _e, 4); \
855 ed->data[0] = _len; \
856 ed->data[1] = _written; \
857 ed->data[2] = _tc->rcv_nxt - _tc->irs; \
858 ed->data[3] = _tc->rcv_wnd - (_tc->rcv_nxt - _tc->rcv_las); \
861 #define TCP_EVT_CC_RTX_HANDLER(_tc, offset, n_bytes, ...)
862 #define TCP_EVT_DUPACK_SENT_HANDLER(_tc, _btcp, ...)
863 #define TCP_EVT_DUPACK_RCVD_HANDLER(_tc, ...)
864 #define TCP_EVT_CC_PACK_HANDLER(_tc, ...)
865 #define TCP_EVT_CC_SCOREBOARD_HANDLER(_tc, ...)
866 #define TCP_EVT_CC_SACKS_HANDLER(_tc, ...)
867 #define TCP_EVT_CC_INPUT_HANDLER(_tc, _len, _written, ...)
871 * Congestion control stats
873 #if TCP_DEBUG_CS || TCP_DEBUG_ALWAYS
875 #define STATS_INTERVAL 0.001
877 #define tcp_cc_time_to_print_stats(_tc) \
878 _tc->c_cc_stat_tstamp + STATS_INTERVAL < \
879 tcp_time_now_us (_tc->c_thread_index) || \
880 tcp_in_fastrecovery (_tc)
882 #define TCP_EVT_CC_RTO_STAT_PRINT(_tc) \
884 ELOG_TYPE_DECLARE (_e) = \
886 .format = "rcv_stat: rto %u srtt %u mrtt-us %u rttvar %u", \
887 .format_args = "i4i4i4i4", \
889 TCP_DECLARE_ETD(_tc, _e, 4); \
890 ed->data[0] = _tc->rto; \
891 ed->data[1] = _tc->srtt; \
892 ed->data[2] = (u32) (_tc->mrtt_us * 1e6); \
893 ed->data[3] = _tc->rttvar; \
896 #define TCP_EVT_CC_RTO_STAT_HANDLER(_tc, ...) \
898 if (tcp_cc_time_to_print_stats (_tc)) \
900 TCP_EVT_CC_RTO_STAT_PRINT (_tc); \
901 _tc->c_cc_stat_tstamp = tcp_time_now_us (_tc->c_thread_index); \
905 #define TCP_EVT_CC_SND_STAT_PRINT(_tc) \
907 ELOG_TYPE_DECLARE (_e) = \
909 .format = "snd_stat: cc_space %u sacked %u lost %u out %u rxt %u", \
910 .format_args = "i4i4i4i4i4", \
912 TCP_DECLARE_ETD(_tc, _e, 5); \
913 ed->data[0] = tcp_available_cc_snd_space (_tc); \
914 ed->data[1] = _tc->sack_sb.sacked_bytes; \
915 ed->data[2] = _tc->sack_sb.lost_bytes; \
916 ed->data[3] = tcp_bytes_out (_tc); \
917 ed->data[3] = _tc->snd_rxt_bytes; \
920 #define TCP_EVT_CC_SND_STAT_HANDLER(_tc, ...) \
922 if (tcp_cc_time_to_print_stats (_tc)) \
924 TCP_EVT_CC_SND_STAT_PRINT (_tc); \
925 _tc->c_cc_stat_tstamp = tcp_time_now_us (_tc->c_thread_index); \
929 #define TCP_EVT_CC_STAT_PRINT(_tc) \
931 ELOG_TYPE_DECLARE (_e) = \
933 .format = "cc_stat: cwnd %u flight %u space %u ssthresh %u snd_wnd %u",\
934 .format_args = "i4i4i4i4i4", \
936 TCP_DECLARE_ETD(_tc, _e, 5); \
937 ed->data[0] = _tc->cwnd; \
938 ed->data[1] = tcp_flight_size (_tc); \
939 ed->data[2] = tcp_snd_space (_tc); \
940 ed->data[3] = _tc->ssthresh; \
941 ed->data[4] = _tc->snd_wnd; \
942 TCP_EVT_CC_RTO_STAT_PRINT (_tc); \
943 TCP_EVT_CC_SND_STAT_PRINT (_tc); \
946 #define TCP_EVT_CC_STAT_HANDLER(_tc, ...) \
948 if (tcp_cc_time_to_print_stats (_tc)) \
950 TCP_EVT_CC_STAT_PRINT (_tc); \
951 _tc->c_cc_stat_tstamp = tcp_time_now_us (_tc->c_thread_index); \
955 #define TCP_EVT_CC_STAT_HANDLER(_tc, ...)
956 #define TCP_EVT_CC_STAT_PRINT(_tc)
962 #if TCP_DEBUG_BUF_ALLOC
964 #define TCP_DBG_BUFFER_ALLOC_MAYBE_FAIL(thread_index) \
966 static u32 *buffer_fail_counters; \
967 if (PREDICT_FALSE (buffer_fail_counters == 0)) \
970 vlib_thread_main_t *vtm = vlib_get_thread_main (); \
971 num_threads = 1 /* main thread */ + vtm->n_threads; \
972 vec_validate (buffer_fail_counters, num_threads - 1); \
974 if (PREDICT_FALSE (tcp_cfg.buffer_fail_fraction != 0.0)) \
976 if (PREDICT_TRUE (buffer_fail_counters[thread_index] > 0)) \
978 if ((1.0 / (f32) (buffer_fail_counters[thread_index])) \
979 < tcp_cfg.buffer_fail_fraction) \
981 buffer_fail_counters[thread_index] = 0.0000001; \
985 buffer_fail_counters[thread_index] ++; \
989 #define TCP_DBG_BUFFER_ALLOC_MAYBE_FAIL(thread_index)
992 #endif /* SRC_VNET_TCP_TCP_DEBUG_H_ */
994 * fd.io coding-style-patch-verification: ON
997 * eval: (c-set-style "gnu")