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 _(PAWS_FAIL, "failed paws check") \
54 _(ACK_RCV_ERR, "invalid ack") \
55 _(RCV_WND_SHRUNK, "shrunk rcv_wnd") \
59 #define _(sym, str) TCP_DBG_##sym,
64 typedef enum _tcp_dbg_evt
66 #define _(sym, str) TCP_EVT_##sym,
73 #define TRANSPORT_DEBUG (1)
75 #define TCP_DBG(_tc, _evt, _args...) \
78 _tmp = format(_tmp, "%U", format_tcp_connection_verbose, _tc); \
79 clib_warning("%s", _tmp); \
83 #define DECLARE_ETD(_tc, _e, _size) \
88 ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, \
89 _e, _tc->c_elog_track)
91 #define TCP_EVT_INIT_HANDLER(_tc, _fmt, ...) \
93 _tc->c_elog_track.name = \
94 (char *) format (0, _fmt, _tc->c_c_index, 0); \
95 elog_track_register (&vlib_global_main.elog_main, &_tc->c_elog_track);\
98 #define TCP_EVT_DEALLOC_HANDLER(_tc, ...) \
100 vec_free (_tc->c_elog_track.name); \
103 #define TCP_EVT_OPEN_HANDLER(_tc, ...) \
105 TCP_EVT_INIT_HANDLER(_tc, "s%d%c"); \
106 ELOG_TYPE_DECLARE (_e) = \
108 .format = "open: index %d", \
109 .format_args = "i4", \
111 DECLARE_ETD(_tc, _e, 1); \
112 ed->data[0] = _tc->c_c_index; \
115 #define TCP_EVT_CLOSE_HANDLER(_tc, ...) \
117 ELOG_TYPE_DECLARE (_e) = \
119 .format = "close: %d", \
120 .format_args = "i4", \
122 DECLARE_ETD(_tc, _e, 1); \
123 ed->data[0] = _tc->c_c_index; \
126 #define TCP_EVT_BIND_HANDLER(_tc, ...) \
128 TCP_EVT_INIT_HANDLER(_tc, "l%d%c"); \
129 ELOG_TYPE_DECLARE (_e) = \
131 .format = "bind: listener %d", \
133 DECLARE_ETD(_tc, _e, 1); \
134 ed->data[0] = _tc->c_c_index; \
137 #define TCP_EVT_UNBIND_HANDLER(_tc, ...) \
139 TCP_EVT_DEALLOC_HANDLER(_tc); \
140 ELOG_TYPE_DECLARE (_e) = \
142 .format = "unbind: listener %d", \
144 DECLARE_ETD(_tc, _e, 1); \
145 ed->data[0] = _tc->c_c_index; \
146 TCP_EVT_DEALLOC_HANDLER(_tc); \
149 #define TCP_EVT_DELETE_HANDLER(_tc, ...) \
151 ELOG_TYPE_DECLARE (_e) = \
153 .format = "delete: %d", \
154 .format_args = "i4", \
156 DECLARE_ETD(_tc, _e, 1); \
157 ed->data[0] = _tc->c_c_index; \
158 TCP_EVT_DEALLOC_HANDLER(_tc); \
161 #define TCP_EVT_ACK_SENT_HANDLER(_tc, ...) \
163 ELOG_TYPE_DECLARE (_e) = \
165 .format = "ack_tx: acked %u rcv_nxt %u rcv_wnd %u snd_nxt %u snd_wnd %u",\
166 .format_args = "i4i4i4i4i4", \
168 DECLARE_ETD(_tc, _e, 5); \
169 ed->data[0] = _tc->rcv_nxt - _tc->rcv_las; \
170 ed->data[1] = _tc->rcv_nxt - _tc->irs; \
171 ed->data[2] = _tc->rcv_wnd; \
172 ed->data[3] = _tc->snd_nxt - _tc->iss; \
173 ed->data[4] = _tc->snd_wnd; \
176 #define TCP_EVT_DUPACK_SENT_HANDLER(_tc, ...) \
178 ELOG_TYPE_DECLARE (_e) = \
180 .format = "dack_tx: rcv_nxt %u rcv_wnd %u snd_nxt %u av_wnd %u snd_wnd %u",\
181 .format_args = "i4i4i4i4i4", \
183 DECLARE_ETD(_tc, _e, 5); \
184 ed->data[0] = _tc->rcv_nxt - _tc->irs; \
185 ed->data[1] = _tc->rcv_wnd; \
186 ed->data[2] = _tc->snd_nxt - _tc->iss; \
187 ed->data[3] = tcp_available_wnd(_tc); \
188 ed->data[4] = _tc->snd_wnd; \
191 #define TCP_EVT_SYN_SENT_HANDLER(_tc, ...) \
193 ELOG_TYPE_DECLARE (_e) = \
195 .format = "SYNtx: iss %u", \
196 .format_args = "i4", \
198 DECLARE_ETD(_tc, _e, 1); \
199 ed->data[0] = _tc->iss; \
202 #define TCP_EVT_SYN_RTX_HANDLER(_tc, ...) \
204 ELOG_TYPE_DECLARE (_e) = \
206 .format = "SYNrtx: iss %u", \
207 .format_args = "i4", \
209 DECLARE_ETD(_tc, _e, 1); \
210 ed->data[0] = _tc->iss; \
213 #define TCP_EVT_FIN_SENT_HANDLER(_tc, ...) \
215 ELOG_TYPE_DECLARE (_e) = \
217 .format = "FINtx: snd_nxt %d rcv_nxt %d", \
218 .format_args = "i4i4", \
220 DECLARE_ETD(_tc, _e, 2); \
221 ed->data[0] = _tc->snd_nxt - _tc->iss; \
222 ed->data[1] = _tc->rcv_nxt - _tc->irs; \
225 #define TCP_EVT_RST_SENT_HANDLER(_tc, ...) \
227 ELOG_TYPE_DECLARE (_e) = \
229 .format = "RSTtx: snd_nxt %d rcv_nxt %d", \
230 .format_args = "i4i4", \
232 DECLARE_ETD(_tc, _e, 2); \
233 ed->data[0] = _tc->snd_nxt - _tc->iss; \
234 ed->data[1] = _tc->rcv_nxt - _tc->irs; \
237 #define TCP_EVT_SYN_RCVD_HANDLER(_tc, ...) \
239 TCP_EVT_INIT_HANDLER(_tc, "s%d%c"); \
240 ELOG_TYPE_DECLARE (_e) = \
242 .format = "SYNrx: irs %u", \
243 .format_args = "i4", \
245 DECLARE_ETD(_tc, _e, 1); \
246 ed->data[0] = _tc->irs; \
249 #define TCP_EVT_FIN_RCVD_HANDLER(_tc, ...) \
251 ELOG_TYPE_DECLARE (_e) = \
253 .format = "FINrx: snd_nxt %d rcv_nxt %d", \
254 .format_args = "i4i4", \
256 DECLARE_ETD(_tc, _e, 2); \
257 ed->data[0] = _tc->snd_nxt - _tc->iss; \
258 ed->data[1] = _tc->rcv_nxt - _tc->irs; \
261 #define TCP_EVT_RST_RCVD_HANDLER(_tc, ...) \
263 ELOG_TYPE_DECLARE (_e) = \
265 .format = "RSTrx: snd_nxt %d rcv_nxt %d", \
266 .format_args = "i4i4", \
268 DECLARE_ETD(_tc, _e, 2); \
269 ed->data[0] = _tc->snd_nxt - _tc->iss; \
270 ed->data[1] = _tc->rcv_nxt - _tc->irs; \
273 #define TCP_EVT_ACK_RCVD_HANDLER(_tc, ...) \
275 ELOG_TYPE_DECLARE (_e) = \
277 .format = "acked: %u snd_una %u snd_wnd %u cwnd %u inflight %u", \
278 .format_args = "i4i4i4i4i4", \
280 DECLARE_ETD(_tc, _e, 5); \
281 ed->data[0] = _tc->bytes_acked; \
282 ed->data[1] = _tc->snd_una - _tc->iss; \
283 ed->data[2] = _tc->snd_wnd; \
284 ed->data[3] = _tc->cwnd; \
285 ed->data[4] = tcp_flight_size(_tc); \
288 #define TCP_EVT_DUPACK_RCVD_HANDLER(_tc, ...) \
290 ELOG_TYPE_DECLARE (_e) = \
292 .format = "dack_rx: snd_una %u cwnd %u snd_wnd %u flight %u rcv_wnd %u",\
293 .format_args = "i4i4i4i4i4", \
295 DECLARE_ETD(_tc, _e, 5); \
296 ed->data[0] = _tc->snd_una - _tc->iss; \
297 ed->data[1] = _tc->cwnd; \
298 ed->data[2] = _tc->snd_wnd; \
299 ed->data[3] = tcp_flight_size(_tc); \
300 ed->data[4] = _tc->rcv_wnd; \
303 #define TCP_EVT_PKTIZE_HANDLER(_tc, ...) \
305 ELOG_TYPE_DECLARE (_e) = \
307 .format = "pktize: una %u snd_nxt %u space %u flight %u rcv_wnd %u",\
308 .format_args = "i4i4i4i4i4", \
310 DECLARE_ETD(_tc, _e, 5); \
311 ed->data[0] = _tc->snd_una - _tc->iss; \
312 ed->data[1] = _tc->snd_nxt - _tc->iss; \
313 ed->data[2] = tcp_available_snd_space (_tc); \
314 ed->data[3] = tcp_flight_size (_tc); \
315 ed->data[4] = _tc->rcv_wnd; \
318 #define TCP_EVT_INPUT_HANDLER(_tc, _type, _len, _written, ...) \
320 ELOG_TYPE_DECLARE (_e) = \
322 .format = "in: %s len %u written %d rcv_nxt %u rcv_wnd(o) %d", \
323 .format_args = "t4i4i4i4i4", \
324 .n_enum_strings = 2, \
330 DECLARE_ETD(_tc, _e, 5); \
331 ed->data[0] = _type; \
332 ed->data[1] = _len; \
333 ed->data[2] = _written; \
334 ed->data[3] = (_tc->rcv_nxt - _tc->irs) + _written; \
335 ed->data[4] = _tc->rcv_wnd - (_tc->rcv_nxt - _tc->rcv_las); \
338 #define TCP_EVT_TIMER_POP_HANDLER(_tc_index, _timer_id, ...) \
340 tcp_connection_t *_tc; \
341 if (_timer_id == TCP_TIMER_RETRANSMIT_SYN \
342 || _timer_id == TCP_TIMER_ESTABLISH) \
344 _tc = tcp_half_open_connection_get (_tc_index); \
348 u32 _thread_index = vlib_get_thread_index (); \
349 _tc = tcp_connection_get (_tc_index, _thread_index); \
351 ELOG_TYPE_DECLARE (_e) = \
353 .format = "TimerPop: %s (%d)", \
354 .format_args = "t4i4", \
355 .n_enum_strings = 7, \
366 DECLARE_ETD(_tc, _e, 2); \
367 ed->data[0] = _timer_id; \
368 ed->data[1] = _timer_id; \
371 #define TCP_EVT_SEG_INVALID_HANDLER(_tc, _seq, _end, ...) \
373 ELOG_TYPE_DECLARE (_e) = \
375 .format = "seg-inv: seq %u end %u rcv_las %u rcv_nxt %u rcv_wnd %u",\
376 .format_args = "i4i4i4i4i4", \
378 DECLARE_ETD(_tc, _e, 5); \
379 ed->data[0] = _seq - _tc->irs; \
380 ed->data[1] = _end - _tc->irs; \
381 ed->data[2] = _tc->rcv_las - _tc->irs; \
382 ed->data[3] = _tc->rcv_nxt - _tc->irs; \
383 ed->data[4] = _tc->rcv_wnd; \
386 #define TCP_EVT_PAWS_FAIL_HANDLER(_tc, _seq, _end, ...) \
388 ELOG_TYPE_DECLARE (_e) = \
390 .format = "paws fail: seq %u end %u tsval %u tsval_recent %u", \
391 .format_args = "i4i4i4i4", \
393 DECLARE_ETD(_tc, _e, 4); \
394 ed->data[0] = _seq - _tc->irs; \
395 ed->data[1] = _end - _tc->irs; \
396 ed->data[2] = _tc->opt.tsval; \
397 ed->data[3] = _tc->tsval_recent; \
400 #define TCP_EVT_ACK_RCV_ERR_HANDLER(_tc, _type, _ack, ...) \
402 ELOG_TYPE_DECLARE (_e) = \
404 .format = "ack-err: %s ack %u snd_una %u snd_nxt %u una_max %u", \
405 .format_args = "t4i4i4i4i4", \
406 .n_enum_strings = 3, \
413 DECLARE_ETD(_tc, _e, 5); \
414 ed->data[0] = _type; \
415 ed->data[1] = _ack - _tc->iss; \
416 ed->data[2] = _tc->snd_una - _tc->iss; \
417 ed->data[3] = _tc->snd_nxt - _tc->iss; \
418 ed->data[4] = _tc->snd_una_max - _tc->iss; \
426 #define TCP_EVT_CC_RTX_HANDLER(_tc, offset, n_bytes, ...) \
428 ELOG_TYPE_DECLARE (_e) = \
430 .format = "rtx: snd_nxt %u offset %u snd %u rtx %u", \
431 .format_args = "i4i4i4i4", \
433 DECLARE_ETD(_tc, _e, 4); \
434 ed->data[0] = _tc->snd_nxt - _tc->iss; \
435 ed->data[1] = offset; \
436 ed->data[2] = n_bytes; \
437 ed->data[3] = _tc->rtx_bytes; \
440 #define TCP_EVT_CC_EVT_HANDLER(_tc, _sub_evt, ...) \
442 ELOG_TYPE_DECLARE (_e) = \
444 .format = "cc: %s wnd %u snd_cong %u rtx_bytes %u", \
445 .format_args = "t4i4i4i4", \
446 .n_enum_strings = 5, \
455 DECLARE_ETD(_tc, _e, 4); \
456 ed->data[0] = _sub_evt; \
457 ed->data[1] = tcp_available_snd_space (_tc); \
458 ed->data[2] = _tc->snd_congestion - _tc->iss; \
459 ed->data[3] = _tc->rtx_bytes; \
462 #define TCP_EVT_CC_PACK_HANDLER(_tc, ...) \
464 ELOG_TYPE_DECLARE (_e) = \
466 .format = "pack: snd_una %u snd_una_max %u", \
467 .format_args = "i4i4", \
469 DECLARE_ETD(_tc, _e, 2); \
470 ed->data[0] = _tc->snd_una - _tc->iss; \
471 ed->data[1] = _tc->snd_una_max - _tc->iss; \
475 #define TCP_EVT_CC_RTX_HANDLER(_tc, offset, n_bytes, ...)
476 #define TCP_EVT_CC_EVT_HANDLER(_tc, _sub_evt, _snd_space, ...)
477 #define TCP_EVT_CC_PACK_HANDLER(_tc, ...)
480 #define TCP_EVT_RCV_WND_SHRUNK_HANDLER(_tc, _obs, _av, ...) \
484 ELOG_TYPE_DECLARE (_e) = \
486 .format = "huh?: rcv_wnd %u obsd %u av %u rcv_nxt %u rcv_las %u", \
487 .format_args = "i4i4i4i4i4", \
489 DECLARE_ETD(_tc, _e, 5); \
490 ed->data[0] = _tc->rcv_wnd; \
491 ed->data[1] = _obs; \
493 ed->data[3] = _tc->rcv_nxt - _tc->irs; \
494 ed->data[4] = _tc->rcv_las - _tc->irs; \
499 #define TCP_EVT_SND_WND_HANDLER(_tc, ...) \
501 ELOG_TYPE_DECLARE (_e) = \
503 .format = "snd_wnd update: %u ", \
504 .format_args = "i4", \
506 DECLARE_ETD(_tc, _e, 1); \
507 ed->data[0] = _tc->snd_wnd; \
510 #define TCP_EVT_OUTPUT_HANDLER(_tc, flags, n_bytes,...) \
512 ELOG_TYPE_DECLARE (_e) = \
514 .format = "out: flags %x, bytes %u", \
515 .format_args = "i4i4", \
517 DECLARE_ETD(_tc, _e, 2); \
518 ed->data[0] = flags; \
519 ed->data[1] = n_bytes; \
522 #define TCP_EVT_SND_WND_HANDLER(_tc, ...)
523 #define TCP_EVT_OUTPUT_HANDLER(_tc, flags, n_bytes,...)
526 #define CONCAT_HELPER(_a, _b) _a##_b
527 #define CC(_a, _b) CONCAT_HELPER(_a, _b)
528 #define TCP_EVT_DBG(_evt, _args...) CC(_evt, _HANDLER)(_args)
531 #define TCP_EVT_DBG(_evt, _args...)
535 #endif /* SRC_VNET_TCP_TCP_DEBUG_H_ */
537 * fd.io coding-style-patch-verification: ON
540 * eval: (c-set-style "gnu")