2 * Copyright (c) 2016-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 #include <vppinfra/sparse_vec.h>
17 #include <vnet/fib/ip4_fib.h>
18 #include <vnet/fib/ip6_fib.h>
19 #include <vnet/tcp/tcp_packet.h>
20 #include <vnet/tcp/tcp.h>
21 #include <vnet/session/session.h>
24 static char *tcp_error_strings[] = {
25 #define tcp_error(n,s) s,
26 #include <vnet/tcp/tcp_error.def>
30 /* All TCP nodes have the same outgoing arcs */
31 #define foreach_tcp_state_next \
32 _ (DROP4, "ip4-drop") \
33 _ (DROP6, "ip6-drop") \
34 _ (TCP4_OUTPUT, "tcp4-output") \
35 _ (TCP6_OUTPUT, "tcp6-output")
37 typedef enum _tcp_established_next
39 #define _(s,n) TCP_ESTABLISHED_NEXT_##s,
40 foreach_tcp_state_next
42 TCP_ESTABLISHED_N_NEXT,
43 } tcp_established_next_t;
45 typedef enum _tcp_rcv_process_next
47 #define _(s,n) TCP_RCV_PROCESS_NEXT_##s,
48 foreach_tcp_state_next
50 TCP_RCV_PROCESS_N_NEXT,
51 } tcp_rcv_process_next_t;
53 typedef enum _tcp_syn_sent_next
55 #define _(s,n) TCP_SYN_SENT_NEXT_##s,
56 foreach_tcp_state_next
59 } tcp_syn_sent_next_t;
61 typedef enum _tcp_listen_next
63 #define _(s,n) TCP_LISTEN_NEXT_##s,
64 foreach_tcp_state_next
69 /* Generic, state independent indices */
70 typedef enum _tcp_state_next
72 #define _(s,n) TCP_NEXT_##s,
73 foreach_tcp_state_next
78 #define tcp_next_output(is_ip4) (is_ip4 ? TCP_NEXT_TCP4_OUTPUT \
79 : TCP_NEXT_TCP6_OUTPUT)
81 #define tcp_next_drop(is_ip4) (is_ip4 ? TCP_NEXT_DROP4 \
85 * Validate segment sequence number. As per RFC793:
87 * Segment Receive Test
89 * ------- ------- -------------------------------------------
90 * 0 0 SEG.SEQ = RCV.NXT
91 * 0 >0 RCV.NXT =< SEG.SEQ < RCV.NXT+RCV.WND
93 * >0 >0 RCV.NXT =< SEG.SEQ < RCV.NXT+RCV.WND
94 * or RCV.NXT =< SEG.SEQ+SEG.LEN-1 < RCV.NXT+RCV.WND
96 * This ultimately consists in checking if segment falls within the window.
97 * The one important difference compared to RFC793 is that we use rcv_las,
98 * or the rcv_nxt at last ack sent instead of rcv_nxt since that's the
99 * peer's reference when computing our receive window.
102 * seq_leq (end_seq, tc->rcv_las + tc->rcv_wnd) && seq_geq (seq, tc->rcv_las)
103 * however, is too strict when we have retransmits. Instead we just check that
104 * the seq is not beyond the right edge and that the end of the segment is not
105 * less than the left edge.
107 * N.B. rcv_nxt and rcv_wnd are both updated in this node if acks are sent, so
108 * use rcv_nxt in the right edge window test instead of rcv_las.
112 tcp_segment_in_rcv_wnd (tcp_connection_t * tc, u32 seq, u32 end_seq)
114 return (seq_geq (end_seq, tc->rcv_las)
115 && seq_leq (seq, tc->rcv_nxt + tc->rcv_wnd));
119 * Parse TCP header options.
121 * @param th TCP header
122 * @param to TCP options data structure to be populated
123 * @param is_syn set if packet is syn
124 * @return -1 if parsing failed
127 tcp_options_parse (tcp_header_t * th, tcp_options_t * to, u8 is_syn)
130 u8 opt_len, opts_len, kind;
134 opts_len = (tcp_doff (th) << 2) - sizeof (tcp_header_t);
135 data = (const u8 *) (th + 1);
137 /* Zero out all flags but those set in SYN */
138 to->flags &= (TCP_OPTS_FLAG_SACK_PERMITTED | TCP_OPTS_FLAG_WSCALE
139 | TCP_OPTS_FLAG_TSTAMP | TCP_OPTION_MSS);
141 for (; opts_len > 0; opts_len -= opt_len, data += opt_len)
145 /* Get options length */
146 if (kind == TCP_OPTION_EOL)
148 else if (kind == TCP_OPTION_NOOP)
160 /* weird option length */
161 if (opt_len < 2 || opt_len > opts_len)
171 if ((opt_len == TCP_OPTION_LEN_MSS) && tcp_syn (th))
173 to->flags |= TCP_OPTS_FLAG_MSS;
174 to->mss = clib_net_to_host_u16 (*(u16 *) (data + 2));
177 case TCP_OPTION_WINDOW_SCALE:
180 if ((opt_len == TCP_OPTION_LEN_WINDOW_SCALE) && tcp_syn (th))
182 to->flags |= TCP_OPTS_FLAG_WSCALE;
183 to->wscale = data[2];
184 if (to->wscale > TCP_MAX_WND_SCALE)
185 to->wscale = TCP_MAX_WND_SCALE;
188 case TCP_OPTION_TIMESTAMP:
190 to->flags |= TCP_OPTS_FLAG_TSTAMP;
191 if ((to->flags & TCP_OPTS_FLAG_TSTAMP)
192 && opt_len == TCP_OPTION_LEN_TIMESTAMP)
194 to->tsval = clib_net_to_host_u32 (*(u32 *) (data + 2));
195 to->tsecr = clib_net_to_host_u32 (*(u32 *) (data + 6));
198 case TCP_OPTION_SACK_PERMITTED:
201 if (opt_len == TCP_OPTION_LEN_SACK_PERMITTED && tcp_syn (th))
202 to->flags |= TCP_OPTS_FLAG_SACK_PERMITTED;
204 case TCP_OPTION_SACK_BLOCK:
205 /* If SACK permitted was not advertised or a SYN, break */
206 if ((to->flags & TCP_OPTS_FLAG_SACK_PERMITTED) == 0 || tcp_syn (th))
209 /* If too short or not correctly formatted, break */
210 if (opt_len < 10 || ((opt_len - 2) % TCP_OPTION_LEN_SACK_BLOCK))
213 to->flags |= TCP_OPTS_FLAG_SACK;
214 to->n_sack_blocks = (opt_len - 2) / TCP_OPTION_LEN_SACK_BLOCK;
215 vec_reset_length (to->sacks);
216 for (j = 0; j < to->n_sack_blocks; j++)
218 b.start = clib_net_to_host_u32 (*(u32 *) (data + 2 + 8 * j));
219 b.end = clib_net_to_host_u32 (*(u32 *) (data + 6 + 8 * j));
220 vec_add1 (to->sacks, b);
224 /* Nothing to see here */
232 * RFC1323: Check against wrapped sequence numbers (PAWS). If we have
233 * timestamp to echo and it's less than tsval_recent, drop segment
234 * but still send an ACK in order to retain TCP's mechanism for detecting
235 * and recovering from half-open connections
237 * Or at least that's what the theory says. It seems that this might not work
238 * very well with packet reordering and fast retransmit. XXX
241 tcp_segment_check_paws (tcp_connection_t * tc)
243 return tcp_opts_tstamp (&tc->rcv_opts)
244 && timestamp_lt (tc->rcv_opts.tsval, tc->tsval_recent);
248 * Update tsval recent
251 tcp_update_timestamp (tcp_connection_t * tc, u32 seq, u32 seq_end)
254 * RFC1323: If Last.ACK.sent falls within the range of sequence numbers
255 * of an incoming segment:
256 * SEG.SEQ <= Last.ACK.sent < SEG.SEQ + SEG.LEN
257 * then the TSval from the segment is copied to TS.Recent;
258 * otherwise, the TSval is ignored.
260 if (tcp_opts_tstamp (&tc->rcv_opts) && seq_leq (seq, tc->rcv_las)
261 && seq_leq (tc->rcv_las, seq_end))
263 ASSERT (timestamp_leq (tc->tsval_recent, tc->rcv_opts.tsval));
264 tc->tsval_recent = tc->rcv_opts.tsval;
265 tc->tsval_recent_age = tcp_time_now_w_thread (tc->c_thread_index);
270 * Validate incoming segment as per RFC793 p. 69 and RFC1323 p. 19
272 * It first verifies if segment has a wrapped sequence number (PAWS) and then
273 * does the processing associated to the first four steps (ignoring security
274 * and precedence): sequence number, rst bit and syn bit checks.
276 * @return 0 if segments passes validation.
279 tcp_segment_validate (tcp_worker_ctx_t * wrk, tcp_connection_t * tc0,
280 vlib_buffer_t * b0, tcp_header_t * th0, u32 * error0)
282 /* We could get a burst of RSTs interleaved with acks */
283 if (PREDICT_FALSE (tc0->state == TCP_STATE_CLOSED))
285 tcp_send_reset (tc0);
286 *error0 = TCP_ERROR_CONNECTION_CLOSED;
290 if (PREDICT_FALSE (!tcp_ack (th0) && !tcp_rst (th0) && !tcp_syn (th0)))
292 *error0 = TCP_ERROR_SEGMENT_INVALID;
296 if (PREDICT_FALSE (tcp_options_parse (th0, &tc0->rcv_opts, 0)))
298 *error0 = TCP_ERROR_OPTIONS;
302 if (PREDICT_FALSE (tcp_segment_check_paws (tc0)))
304 *error0 = TCP_ERROR_PAWS;
305 TCP_EVT (TCP_EVT_PAWS_FAIL, tc0, vnet_buffer (b0)->tcp.seq_number,
306 vnet_buffer (b0)->tcp.seq_end);
308 /* If it just so happens that a segment updates tsval_recent for a
309 * segment over 24 days old, invalidate tsval_recent. */
310 if (timestamp_lt (tc0->tsval_recent_age + TCP_PAWS_IDLE,
311 tcp_time_now_w_thread (tc0->c_thread_index)))
313 tc0->tsval_recent = tc0->rcv_opts.tsval;
314 clib_warning ("paws failed: 24-day old segment");
316 /* Drop after ack if not rst. Resets can fail paws check as per
317 * RFC 7323 sec. 5.2: When an <RST> segment is received, it MUST NOT
318 * be subjected to the PAWS check by verifying an acceptable value in
320 else if (!tcp_rst (th0))
322 tcp_program_ack (tc0);
323 TCP_EVT (TCP_EVT_DUPACK_SENT, tc0, vnet_buffer (b0)->tcp);
328 /* 1st: check sequence number */
329 if (!tcp_segment_in_rcv_wnd (tc0, vnet_buffer (b0)->tcp.seq_number,
330 vnet_buffer (b0)->tcp.seq_end))
332 /* SYN/SYN-ACK retransmit */
334 && vnet_buffer (b0)->tcp.seq_number == tc0->rcv_nxt - 1)
336 tcp_options_parse (th0, &tc0->rcv_opts, 1);
337 if (tc0->state == TCP_STATE_SYN_RCVD)
339 tcp_send_synack (tc0);
340 TCP_EVT (TCP_EVT_SYN_RCVD, tc0, 0);
341 *error0 = TCP_ERROR_SYNS_RCVD;
345 tcp_program_ack (tc0);
346 TCP_EVT (TCP_EVT_SYNACK_RCVD, tc0);
347 *error0 = TCP_ERROR_SYN_ACKS_RCVD;
352 /* If our window is 0 and the packet is in sequence, let it pass
353 * through for ack processing. It should be dropped later. */
354 if (tc0->rcv_wnd < tc0->snd_mss
355 && tc0->rcv_nxt == vnet_buffer (b0)->tcp.seq_number)
358 /* If we entered recovery and peer did so as well, there's a chance that
359 * dup acks won't be acceptable on either end because seq_end may be less
360 * than rcv_las. This can happen if acks are lost in both directions. */
361 if (tcp_in_recovery (tc0)
362 && seq_geq (vnet_buffer (b0)->tcp.seq_number,
363 tc0->rcv_las - tc0->rcv_wnd)
364 && seq_leq (vnet_buffer (b0)->tcp.seq_end,
365 tc0->rcv_nxt + tc0->rcv_wnd))
368 *error0 = TCP_ERROR_RCV_WND;
370 /* If we advertised a zero rcv_wnd and the segment is in the past or the
371 * next one that we expect, it is probably a window probe */
372 if ((tc0->flags & TCP_CONN_ZERO_RWND_SENT)
373 && seq_lt (vnet_buffer (b0)->tcp.seq_end,
374 tc0->rcv_las + tc0->rcv_opts.mss))
375 *error0 = TCP_ERROR_ZERO_RWND;
377 tc0->errors.below_data_wnd += seq_lt (vnet_buffer (b0)->tcp.seq_end,
380 /* If not RST, send dup ack */
383 tcp_program_dupack (tc0);
384 TCP_EVT (TCP_EVT_DUPACK_SENT, tc0, vnet_buffer (b0)->tcp);
392 /* 2nd: check the RST bit */
393 if (PREDICT_FALSE (tcp_rst (th0)))
395 tcp_connection_reset (tc0);
396 *error0 = TCP_ERROR_RST_RCVD;
400 /* 3rd: check security and precedence (skip) */
402 /* 4th: check the SYN bit (in window) */
403 if (PREDICT_FALSE (tcp_syn (th0)))
405 /* As per RFC5961 send challenge ack instead of reset */
406 tcp_program_ack (tc0);
407 *error0 = TCP_ERROR_SPURIOUS_SYN;
411 /* If segment in window, save timestamp */
412 tcp_update_timestamp (tc0, vnet_buffer (b0)->tcp.seq_number,
413 vnet_buffer (b0)->tcp.seq_end);
421 tcp_rcv_ack_no_cc (tcp_connection_t * tc, vlib_buffer_t * b, u32 * error)
423 /* SND.UNA =< SEG.ACK =< SND.NXT */
424 if (!(seq_leq (tc->snd_una, vnet_buffer (b)->tcp.ack_number)
425 && seq_leq (vnet_buffer (b)->tcp.ack_number, tc->snd_nxt)))
427 if (seq_leq (vnet_buffer (b)->tcp.ack_number, tc->snd_una_max)
428 && seq_gt (vnet_buffer (b)->tcp.ack_number, tc->snd_una))
430 tc->snd_nxt = vnet_buffer (b)->tcp.ack_number;
433 *error = TCP_ERROR_ACK_INVALID;
438 tc->bytes_acked = vnet_buffer (b)->tcp.ack_number - tc->snd_una;
439 tc->snd_una = vnet_buffer (b)->tcp.ack_number;
440 *error = TCP_ERROR_ACK_OK;
445 * Compute smoothed RTT as per VJ's '88 SIGCOMM and RFC6298
447 * Note that although the original article, srtt and rttvar are scaled
448 * to minimize round-off errors, here we don't. Instead, we rely on
449 * better precision time measurements.
451 * TODO support us rtt resolution
454 tcp_estimate_rtt (tcp_connection_t * tc, u32 mrtt)
460 err = mrtt - tc->srtt;
462 /* XXX Drop in RTT results in RTTVAR increase and bigger RTO.
463 * The increase should be bound */
464 tc->srtt = clib_max ((int) tc->srtt + (err >> 3), 1);
465 diff = (clib_abs (err) - (int) tc->rttvar) >> 2;
466 tc->rttvar = clib_max ((int) tc->rttvar + diff, 1);
470 /* First measurement. */
472 tc->rttvar = mrtt >> 1;
476 #ifndef CLIB_MARCH_VARIANT
478 tcp_update_rto (tcp_connection_t * tc)
480 tc->rto = clib_min (tc->srtt + (tc->rttvar << 2), TCP_RTO_MAX);
481 tc->rto = clib_max (tc->rto, TCP_RTO_MIN);
483 #endif /* CLIB_MARCH_VARIANT */
486 * Update RTT estimate and RTO timer
488 * Measure RTT: We have two sources of RTT measurements: TSOPT and ACK
489 * timing. Middle boxes are known to fiddle with TCP options so we
490 * should give higher priority to ACK timing.
492 * This should be called only if previously sent bytes have been acked.
494 * return 1 if valid rtt 0 otherwise
497 tcp_update_rtt (tcp_connection_t * tc, tcp_rate_sample_t * rs, u32 ack)
501 /* Karn's rule, part 1. Don't use retransmitted segments to estimate
502 * RTT because they're ambiguous. */
503 if (tcp_in_cong_recovery (tc))
505 /* Accept rtt estimates for samples that have not been retransmitted */
506 if ((tc->flags & TCP_CONN_RATE_SAMPLE) && !(rs->flags & TCP_BTS_IS_RXT))
508 mrtt = rs->rtt_time * THZ;
514 if (tc->rtt_ts && seq_geq (ack, tc->rtt_seq))
516 f64 sample = tcp_time_now_us (tc->c_thread_index) - tc->rtt_ts;
517 tc->mrtt_us = tc->mrtt_us + (sample - tc->mrtt_us) * 0.125;
518 mrtt = clib_max ((u32) (sample * THZ), 1);
519 /* Allow measuring of a new RTT */
522 /* As per RFC7323 TSecr can be used for RTTM only if the segment advances
523 * snd_una, i.e., the left side of the send window:
524 * seq_lt (tc->snd_una, ack). This is a condition for calling update_rtt */
525 else if (tcp_opts_tstamp (&tc->rcv_opts) && tc->rcv_opts.tsecr)
527 u32 now = tcp_tstamp (tc);
528 mrtt = clib_max (now - tc->rcv_opts.tsecr, 1);
533 /* Ignore dubious measurements */
534 if (mrtt == 0 || mrtt > TCP_RTT_MAX)
537 tcp_estimate_rtt (tc, mrtt);
541 /* If we got here something must've been ACKed so make sure boff is 0,
542 * even if mrtt is not valid since we update the rto lower */
550 tcp_estimate_initial_rtt (tcp_connection_t * tc)
552 u8 thread_index = vlib_num_workers ()? 1 : 0;
557 tc->mrtt_us = tcp_time_now_us (thread_index) - tc->rtt_ts;
558 tc->mrtt_us = clib_max (tc->mrtt_us, 0.0001);
559 mrtt = clib_max ((u32) (tc->mrtt_us * THZ), 1);
564 mrtt = tcp_time_now_w_thread (thread_index) - tc->rcv_opts.tsecr;
565 mrtt = clib_max (mrtt, 1);
566 /* Due to retransmits we don't know the initial mrtt */
567 if (tc->rto_boff && mrtt > 1 * THZ)
569 tc->mrtt_us = (f64) mrtt *TCP_TICK;
572 if (mrtt > 0 && mrtt < TCP_RTT_MAX)
573 tcp_estimate_rtt (tc, mrtt);
578 * Dequeue bytes for connections that have received acks in last burst
581 tcp_handle_postponed_dequeues (tcp_worker_ctx_t * wrk)
583 u32 thread_index = wrk->vm->thread_index;
584 u32 *pending_deq_acked;
585 tcp_connection_t *tc;
588 if (!vec_len (wrk->pending_deq_acked))
591 pending_deq_acked = wrk->pending_deq_acked;
592 for (i = 0; i < vec_len (pending_deq_acked); i++)
594 tc = tcp_connection_get (pending_deq_acked[i], thread_index);
595 tc->flags &= ~TCP_CONN_DEQ_PENDING;
597 if (PREDICT_FALSE (!tc->burst_acked))
600 /* Dequeue the newly ACKed bytes */
601 session_tx_fifo_dequeue_drop (&tc->connection, tc->burst_acked);
603 tcp_validate_txf_size (tc, tc->snd_una_max - tc->snd_una);
605 if (PREDICT_FALSE (tc->flags & TCP_CONN_PSH_PENDING))
607 if (seq_leq (tc->psh_seq, tc->snd_una))
608 tc->flags &= ~TCP_CONN_PSH_PENDING;
611 /* If everything has been acked, stop retransmit timer
612 * otherwise update. */
613 tcp_retransmit_timer_update (tc);
615 /* Update pacer based on our new cwnd estimate */
616 tcp_connection_tx_pacer_update (tc);
618 _vec_len (wrk->pending_deq_acked) = 0;
622 tcp_program_dequeue (tcp_worker_ctx_t * wrk, tcp_connection_t * tc)
624 if (!(tc->flags & TCP_CONN_DEQ_PENDING))
626 vec_add1 (wrk->pending_deq_acked, tc->c_c_index);
627 tc->flags |= TCP_CONN_DEQ_PENDING;
629 tc->burst_acked += tc->bytes_acked;
633 * Check if duplicate ack as per RFC5681 Sec. 2
636 tcp_ack_is_dupack (tcp_connection_t * tc, vlib_buffer_t * b, u32 prev_snd_wnd,
639 return ((vnet_buffer (b)->tcp.ack_number == prev_snd_una)
640 && seq_gt (tc->snd_nxt, tc->snd_una)
641 && (vnet_buffer (b)->tcp.seq_end == vnet_buffer (b)->tcp.seq_number)
642 && (prev_snd_wnd == tc->snd_wnd));
646 * Checks if ack is a congestion control event.
649 tcp_ack_is_cc_event (tcp_connection_t * tc, vlib_buffer_t * b,
650 u32 prev_snd_wnd, u32 prev_snd_una, u8 * is_dack)
652 /* Check if ack is duplicate. Per RFC 6675, ACKs that SACK new data are
653 * defined to be 'duplicate' */
654 *is_dack = tc->sack_sb.last_sacked_bytes
655 || tcp_ack_is_dupack (tc, b, prev_snd_wnd, prev_snd_una);
657 return ((*is_dack || tcp_in_cong_recovery (tc)) && !tcp_is_lost_fin (tc));
660 #ifndef CLIB_MARCH_VARIANT
662 scoreboard_hole_index (sack_scoreboard_t * sb, sack_scoreboard_hole_t * hole)
664 ASSERT (!pool_is_free_index (sb->holes, hole - sb->holes));
665 return hole - sb->holes;
669 scoreboard_hole_bytes (sack_scoreboard_hole_t * hole)
671 return hole->end - hole->start;
674 sack_scoreboard_hole_t *
675 scoreboard_get_hole (sack_scoreboard_t * sb, u32 index)
677 if (index != TCP_INVALID_SACK_HOLE_INDEX)
678 return pool_elt_at_index (sb->holes, index);
682 sack_scoreboard_hole_t *
683 scoreboard_next_hole (sack_scoreboard_t * sb, sack_scoreboard_hole_t * hole)
685 if (hole->next != TCP_INVALID_SACK_HOLE_INDEX)
686 return pool_elt_at_index (sb->holes, hole->next);
690 sack_scoreboard_hole_t *
691 scoreboard_prev_hole (sack_scoreboard_t * sb, sack_scoreboard_hole_t * hole)
693 if (hole->prev != TCP_INVALID_SACK_HOLE_INDEX)
694 return pool_elt_at_index (sb->holes, hole->prev);
698 sack_scoreboard_hole_t *
699 scoreboard_first_hole (sack_scoreboard_t * sb)
701 if (sb->head != TCP_INVALID_SACK_HOLE_INDEX)
702 return pool_elt_at_index (sb->holes, sb->head);
706 sack_scoreboard_hole_t *
707 scoreboard_last_hole (sack_scoreboard_t * sb)
709 if (sb->tail != TCP_INVALID_SACK_HOLE_INDEX)
710 return pool_elt_at_index (sb->holes, sb->tail);
715 scoreboard_remove_hole (sack_scoreboard_t * sb, sack_scoreboard_hole_t * hole)
717 sack_scoreboard_hole_t *next, *prev;
719 if (hole->next != TCP_INVALID_SACK_HOLE_INDEX)
721 next = pool_elt_at_index (sb->holes, hole->next);
722 next->prev = hole->prev;
726 sb->tail = hole->prev;
729 if (hole->prev != TCP_INVALID_SACK_HOLE_INDEX)
731 prev = pool_elt_at_index (sb->holes, hole->prev);
732 prev->next = hole->next;
736 sb->head = hole->next;
739 if (scoreboard_hole_index (sb, hole) == sb->cur_rxt_hole)
740 sb->cur_rxt_hole = TCP_INVALID_SACK_HOLE_INDEX;
742 /* Poison the entry */
744 clib_memset (hole, 0xfe, sizeof (*hole));
746 pool_put (sb->holes, hole);
749 static sack_scoreboard_hole_t *
750 scoreboard_insert_hole (sack_scoreboard_t * sb, u32 prev_index,
753 sack_scoreboard_hole_t *hole, *next, *prev;
756 pool_get (sb->holes, hole);
757 clib_memset (hole, 0, sizeof (*hole));
761 hole_index = scoreboard_hole_index (sb, hole);
763 prev = scoreboard_get_hole (sb, prev_index);
766 hole->prev = prev_index;
767 hole->next = prev->next;
769 if ((next = scoreboard_next_hole (sb, hole)))
770 next->prev = hole_index;
772 sb->tail = hole_index;
774 prev->next = hole_index;
778 sb->head = hole_index;
779 hole->prev = TCP_INVALID_SACK_HOLE_INDEX;
780 hole->next = TCP_INVALID_SACK_HOLE_INDEX;
787 scoreboard_update_sacked_rxt (sack_scoreboard_t * sb, u32 start, u32 end,
790 if (!has_rxt || seq_geq (start, sb->high_rxt))
794 seq_lt (end, sb->high_rxt) ? (end - start) : (sb->high_rxt - start);
798 scoreboard_update_bytes (sack_scoreboard_t * sb, u32 ack, u32 snd_mss)
800 sack_scoreboard_hole_t *left, *right;
801 u32 sacked = 0, blks = 0, old_sacked;
803 old_sacked = sb->sacked_bytes;
805 sb->last_lost_bytes = 0;
807 sb->sacked_bytes = 0;
809 right = scoreboard_last_hole (sb);
812 sb->sacked_bytes = sb->high_sacked - ack;
816 if (seq_gt (sb->high_sacked, right->end))
818 sacked = sb->high_sacked - right->end;
822 while (sacked < (TCP_DUPACK_THRESHOLD - 1) * snd_mss
823 && blks < TCP_DUPACK_THRESHOLD)
826 sb->lost_bytes += scoreboard_hole_bytes (right);
828 left = scoreboard_prev_hole (sb, right);
831 ASSERT (right->start == ack || sb->is_reneging);
832 sacked += right->start - ack;
837 sacked += right->start - left->end;
842 /* right is first lost */
845 sb->lost_bytes += scoreboard_hole_bytes (right);
846 sb->last_lost_bytes += right->is_lost ? 0 : (right->end - right->start);
848 left = scoreboard_prev_hole (sb, right);
851 ASSERT (right->start == ack || sb->is_reneging);
852 sacked += right->start - ack;
855 sacked += right->start - left->end;
859 sb->sacked_bytes = sacked;
860 sb->last_sacked_bytes = sacked - (old_sacked - sb->last_bytes_delivered);
864 * Figure out the next hole to retransmit
866 * Follows logic proposed in RFC6675 Sec. 4, NextSeg()
868 sack_scoreboard_hole_t *
869 scoreboard_next_rxt_hole (sack_scoreboard_t * sb,
870 sack_scoreboard_hole_t * start,
871 u8 have_unsent, u8 * can_rescue, u8 * snd_limited)
873 sack_scoreboard_hole_t *hole = 0;
875 hole = start ? start : scoreboard_first_hole (sb);
876 while (hole && seq_leq (hole->end, sb->high_rxt) && hole->is_lost)
877 hole = scoreboard_next_hole (sb, hole);
879 /* Nothing, return */
882 sb->cur_rxt_hole = TCP_INVALID_SACK_HOLE_INDEX;
886 /* Rule (1): if higher than rxt, less than high_sacked and lost */
887 if (hole->is_lost && seq_lt (hole->start, sb->high_sacked))
889 sb->cur_rxt_hole = scoreboard_hole_index (sb, hole);
893 /* Rule (2): available unsent data */
896 sb->cur_rxt_hole = TCP_INVALID_SACK_HOLE_INDEX;
899 /* Rule (3): if hole not lost */
900 else if (seq_lt (hole->start, sb->high_sacked))
903 sb->cur_rxt_hole = scoreboard_hole_index (sb, hole);
905 /* Rule (4): if hole beyond high_sacked */
908 ASSERT (seq_geq (hole->start, sb->high_sacked));
911 /* HighRxt MUST NOT be updated */
916 if (hole && seq_lt (sb->high_rxt, hole->start))
917 sb->high_rxt = hole->start;
923 scoreboard_init_high_rxt (sack_scoreboard_t * sb, u32 snd_una)
925 sack_scoreboard_hole_t *hole;
926 hole = scoreboard_first_hole (sb);
929 snd_una = seq_gt (snd_una, hole->start) ? snd_una : hole->start;
930 sb->cur_rxt_hole = sb->head;
932 sb->high_rxt = snd_una;
933 sb->rescue_rxt = snd_una - 1;
937 scoreboard_init (sack_scoreboard_t * sb)
939 sb->head = TCP_INVALID_SACK_HOLE_INDEX;
940 sb->tail = TCP_INVALID_SACK_HOLE_INDEX;
941 sb->cur_rxt_hole = TCP_INVALID_SACK_HOLE_INDEX;
945 scoreboard_clear (sack_scoreboard_t * sb)
947 sack_scoreboard_hole_t *hole;
948 while ((hole = scoreboard_first_hole (sb)))
950 scoreboard_remove_hole (sb, hole);
952 ASSERT (sb->head == sb->tail && sb->head == TCP_INVALID_SACK_HOLE_INDEX);
953 ASSERT (pool_elts (sb->holes) == 0);
954 sb->sacked_bytes = 0;
955 sb->last_sacked_bytes = 0;
956 sb->last_bytes_delivered = 0;
960 sb->last_lost_bytes = 0;
961 sb->cur_rxt_hole = TCP_INVALID_SACK_HOLE_INDEX;
966 scoreboard_clear_reneging (sack_scoreboard_t * sb, u32 start, u32 end)
968 sack_scoreboard_hole_t *last_hole;
970 clib_warning ("sack reneging");
972 scoreboard_clear (sb);
973 last_hole = scoreboard_insert_hole (sb, TCP_INVALID_SACK_HOLE_INDEX,
975 last_hole->is_lost = 1;
976 sb->tail = scoreboard_hole_index (sb, last_hole);
977 sb->high_sacked = start;
978 scoreboard_init_high_rxt (sb, start);
981 #endif /* CLIB_MARCH_VARIANT */
984 * Test that scoreboard is sane after recovery
986 * Returns 1 if scoreboard is empty or if first hole beyond
990 tcp_scoreboard_is_sane_post_recovery (tcp_connection_t * tc)
992 sack_scoreboard_hole_t *hole;
993 hole = scoreboard_first_hole (&tc->sack_sb);
994 return (!hole || (seq_geq (hole->start, tc->snd_una)
995 && seq_lt (hole->end, tc->snd_nxt)));
998 #ifndef CLIB_MARCH_VARIANT
1001 tcp_rcv_sacks (tcp_connection_t * tc, u32 ack)
1003 sack_scoreboard_hole_t *hole, *next_hole;
1004 sack_scoreboard_t *sb = &tc->sack_sb;
1005 sack_block_t *blk, *rcv_sacks;
1006 u32 blk_index = 0, i, j;
1009 sb->last_sacked_bytes = 0;
1010 sb->last_bytes_delivered = 0;
1013 if (!tcp_opts_sack (&tc->rcv_opts)
1014 && sb->head == TCP_INVALID_SACK_HOLE_INDEX)
1017 has_rxt = tcp_in_cong_recovery (tc);
1019 /* Remove invalid blocks */
1020 blk = tc->rcv_opts.sacks;
1021 while (blk < vec_end (tc->rcv_opts.sacks))
1023 if (seq_lt (blk->start, blk->end)
1024 && seq_gt (blk->start, tc->snd_una)
1025 && seq_gt (blk->start, ack)
1026 && seq_lt (blk->start, tc->snd_nxt)
1027 && seq_leq (blk->end, tc->snd_nxt))
1032 vec_del1 (tc->rcv_opts.sacks, blk - tc->rcv_opts.sacks);
1035 /* Add block for cumulative ack */
1036 if (seq_gt (ack, tc->snd_una))
1038 vec_add2 (tc->rcv_opts.sacks, blk, 1);
1039 blk->start = tc->snd_una;
1043 if (vec_len (tc->rcv_opts.sacks) == 0)
1046 tcp_scoreboard_trace_add (tc, ack);
1048 /* Make sure blocks are ordered */
1049 rcv_sacks = tc->rcv_opts.sacks;
1050 for (i = 0; i < vec_len (rcv_sacks); i++)
1051 for (j = i + 1; j < vec_len (rcv_sacks); j++)
1052 if (seq_lt (rcv_sacks[j].start, rcv_sacks[i].start))
1054 sack_block_t tmp = rcv_sacks[i];
1055 rcv_sacks[i] = rcv_sacks[j];
1059 if (sb->head == TCP_INVALID_SACK_HOLE_INDEX)
1061 /* Handle reneging as a special case */
1062 if (PREDICT_FALSE (sb->is_reneging))
1064 /* No holes, only sacked bytes */
1065 if (seq_leq (tc->snd_nxt, sb->high_sacked))
1067 /* No progress made so return */
1068 if (seq_leq (ack, tc->snd_una))
1071 /* Update sacked bytes delivered and return */
1072 sb->last_bytes_delivered = ack - tc->snd_una;
1073 sb->sacked_bytes -= sb->last_bytes_delivered;
1074 sb->is_reneging = seq_lt (ack, sb->high_sacked);
1078 /* New hole above high sacked. Add it and process normally */
1079 hole = scoreboard_insert_hole (sb, TCP_INVALID_SACK_HOLE_INDEX,
1080 sb->high_sacked, tc->snd_nxt);
1081 sb->tail = scoreboard_hole_index (sb, hole);
1083 /* Not reneging and no holes. Insert the first that covers all
1084 * outstanding bytes */
1087 hole = scoreboard_insert_hole (sb, TCP_INVALID_SACK_HOLE_INDEX,
1088 tc->snd_una, tc->snd_nxt);
1089 sb->tail = scoreboard_hole_index (sb, hole);
1091 sb->high_sacked = rcv_sacks[vec_len (rcv_sacks) - 1].end;
1095 /* If we have holes but snd_nxt is beyond the last hole, update
1096 * last hole end or add new hole after high sacked */
1097 hole = scoreboard_last_hole (sb);
1098 if (seq_gt (tc->snd_nxt, hole->end))
1100 if (seq_geq (hole->start, sb->high_sacked))
1102 hole->end = tc->snd_nxt;
1104 /* New hole after high sacked block */
1105 else if (seq_lt (sb->high_sacked, tc->snd_nxt))
1107 scoreboard_insert_hole (sb, sb->tail, sb->high_sacked,
1112 /* Keep track of max byte sacked for when the last hole
1114 sb->high_sacked = seq_max (rcv_sacks[vec_len (rcv_sacks) - 1].end,
1118 /* Walk the holes with the SACK blocks */
1119 hole = pool_elt_at_index (sb->holes, sb->head);
1121 if (PREDICT_FALSE (sb->is_reneging))
1122 sb->last_bytes_delivered += hole->start - tc->snd_una;
1124 while (hole && blk_index < vec_len (rcv_sacks))
1126 blk = &rcv_sacks[blk_index];
1127 if (seq_leq (blk->start, hole->start))
1129 /* Block covers hole. Remove hole */
1130 if (seq_geq (blk->end, hole->end))
1132 next_hole = scoreboard_next_hole (sb, hole);
1134 /* If covered by ack, compute delivered bytes */
1135 if (blk->end == ack)
1137 u32 sacked = next_hole ? next_hole->start : sb->high_sacked;
1138 if (PREDICT_FALSE (seq_lt (ack, sacked)))
1140 sb->last_bytes_delivered += ack - hole->end;
1141 sb->is_reneging = 1;
1145 sb->last_bytes_delivered += sacked - hole->end;
1146 sb->is_reneging = 0;
1149 scoreboard_update_sacked_rxt (sb, hole->start, hole->end,
1151 scoreboard_remove_hole (sb, hole);
1154 /* Partial 'head' overlap */
1157 if (seq_gt (blk->end, hole->start))
1159 scoreboard_update_sacked_rxt (sb, hole->start, blk->end,
1161 hole->start = blk->end;
1168 /* Hole must be split */
1169 if (seq_lt (blk->end, hole->end))
1171 u32 hole_index = scoreboard_hole_index (sb, hole);
1172 next_hole = scoreboard_insert_hole (sb, hole_index, blk->end,
1174 /* Pool might've moved */
1175 hole = scoreboard_get_hole (sb, hole_index);
1176 hole->end = blk->start;
1178 scoreboard_update_sacked_rxt (sb, blk->start, blk->end,
1182 ASSERT (hole->next == scoreboard_hole_index (sb, next_hole));
1184 else if (seq_lt (blk->start, hole->end))
1186 scoreboard_update_sacked_rxt (sb, blk->start, hole->end,
1188 hole->end = blk->start;
1190 hole = scoreboard_next_hole (sb, hole);
1194 scoreboard_update_bytes (sb, ack, tc->snd_mss);
1196 ASSERT (sb->last_sacked_bytes <= sb->sacked_bytes || tcp_in_recovery (tc));
1197 ASSERT (sb->sacked_bytes == 0 || tcp_in_recovery (tc)
1198 || sb->sacked_bytes <= tc->snd_nxt - seq_max (tc->snd_una, ack));
1199 ASSERT (sb->last_sacked_bytes + sb->lost_bytes <= tc->snd_nxt
1200 - seq_max (tc->snd_una, ack) || tcp_in_recovery (tc));
1201 ASSERT (sb->head == TCP_INVALID_SACK_HOLE_INDEX || tcp_in_recovery (tc)
1202 || sb->is_reneging || sb->holes[sb->head].start == ack);
1203 ASSERT (sb->last_lost_bytes <= sb->lost_bytes);
1204 ASSERT ((ack - tc->snd_una) + sb->last_sacked_bytes
1205 - sb->last_bytes_delivered >= sb->rxt_sacked);
1207 TCP_EVT (TCP_EVT_CC_SCOREBOARD, tc);
1209 #endif /* CLIB_MARCH_VARIANT */
1212 * Try to update snd_wnd based on feedback received from peer.
1214 * If successful, and new window is 'effectively' 0, activate persist
1218 tcp_update_snd_wnd (tcp_connection_t * tc, u32 seq, u32 ack, u32 snd_wnd)
1220 /* If (SND.WL1 < SEG.SEQ or (SND.WL1 = SEG.SEQ and SND.WL2 =< SEG.ACK)), set
1221 * SND.WND <- SEG.WND, set SND.WL1 <- SEG.SEQ, and set SND.WL2 <- SEG.ACK */
1222 if (seq_lt (tc->snd_wl1, seq)
1223 || (tc->snd_wl1 == seq && seq_leq (tc->snd_wl2, ack)))
1225 tc->snd_wnd = snd_wnd;
1228 TCP_EVT (TCP_EVT_SND_WND, tc);
1230 if (PREDICT_FALSE (tc->snd_wnd < tc->snd_mss))
1232 /* Set persist timer if not set and we just got 0 wnd */
1233 if (!tcp_timer_is_active (tc, TCP_TIMER_PERSIST)
1234 && !tcp_timer_is_active (tc, TCP_TIMER_RETRANSMIT))
1235 tcp_persist_timer_set (tc);
1239 tcp_persist_timer_reset (tc);
1240 if (PREDICT_FALSE (!tcp_in_recovery (tc) && tc->rto_boff > 0))
1243 tcp_update_rto (tc);
1250 * Init loss recovery/fast recovery.
1252 * Triggered by dup acks as opposed to timer timeout. Note that cwnd is
1253 * updated in @ref tcp_cc_handle_event after fast retransmit
1256 tcp_cc_init_congestion (tcp_connection_t * tc)
1258 tcp_fastrecovery_on (tc);
1259 tc->snd_congestion = tc->snd_nxt;
1260 tc->cwnd_acc_bytes = 0;
1261 tc->snd_rxt_bytes = 0;
1262 tc->rxt_delivered = 0;
1263 tc->prr_delivered = 0;
1264 tc->prev_ssthresh = tc->ssthresh;
1265 tc->prev_cwnd = tc->cwnd;
1267 tcp_cc_congestion (tc);
1269 /* Post retransmit update cwnd to ssthresh and account for the
1270 * three segments that have left the network and should've been
1271 * buffered at the receiver XXX */
1272 if (!tcp_opts_sack_permitted (&tc->rcv_opts))
1273 tc->cwnd += 3 * tc->snd_mss;
1275 tc->fr_occurences += 1;
1276 TCP_EVT (TCP_EVT_CC_EVT, tc, 4);
1280 tcp_cc_congestion_undo (tcp_connection_t * tc)
1282 tc->cwnd = tc->prev_cwnd;
1283 tc->ssthresh = tc->prev_ssthresh;
1284 tcp_cc_undo_recovery (tc);
1285 ASSERT (tc->rto_boff == 0);
1286 TCP_EVT (TCP_EVT_CC_EVT, tc, 5);
1290 tcp_cc_is_spurious_timeout_rxt (tcp_connection_t * tc)
1292 return (tcp_in_recovery (tc) && tc->rto_boff == 1
1294 && tcp_opts_tstamp (&tc->rcv_opts)
1295 && timestamp_lt (tc->rcv_opts.tsecr, tc->snd_rxt_ts));
1299 tcp_cc_is_spurious_retransmit (tcp_connection_t * tc)
1301 return (tcp_cc_is_spurious_timeout_rxt (tc));
1305 tcp_should_fastrecover_sack (tcp_connection_t * tc)
1307 return (tc->sack_sb.lost_bytes
1308 || ((TCP_DUPACK_THRESHOLD - 1) * tc->snd_mss
1309 < tc->sack_sb.sacked_bytes));
1313 tcp_should_fastrecover (tcp_connection_t * tc)
1315 return ((tc->rcv_dupacks == TCP_DUPACK_THRESHOLD)
1316 || tcp_should_fastrecover_sack (tc));
1320 tcp_cc_recover (tcp_connection_t * tc)
1322 sack_scoreboard_hole_t *hole;
1325 ASSERT (tcp_in_cong_recovery (tc));
1327 if (tcp_cc_is_spurious_retransmit (tc))
1329 tcp_cc_congestion_undo (tc);
1333 tc->prr_delivered = 0;
1334 tc->rxt_delivered = 0;
1335 tc->snd_rxt_bytes = 0;
1338 tc->flags &= ~TCP_CONN_RXT_PENDING;
1340 /* Previous recovery left us congested. Continue sending as part
1341 * of the current recovery event with an updated snd_congestion */
1342 if (tc->sack_sb.sacked_bytes)
1344 tc->snd_congestion = tc->snd_nxt;
1345 if (tcp_opts_sack_permitted (&tc->rcv_opts))
1346 scoreboard_init_high_rxt (&tc->sack_sb, tc->snd_una);
1347 tcp_program_retransmit (tc);
1351 hole = scoreboard_first_hole (&tc->sack_sb);
1352 if (hole && hole->start == tc->snd_una && hole->end == tc->snd_nxt)
1353 scoreboard_clear (&tc->sack_sb);
1355 if (!tcp_in_recovery (tc) && !is_spurious)
1356 tcp_cc_recovered (tc);
1358 tcp_fastrecovery_off (tc);
1359 tcp_fastrecovery_first_off (tc);
1360 tcp_recovery_off (tc);
1361 TCP_EVT (TCP_EVT_CC_EVT, tc, 3);
1363 ASSERT (tc->rto_boff == 0);
1364 ASSERT (!tcp_in_cong_recovery (tc));
1365 ASSERT (tcp_scoreboard_is_sane_post_recovery (tc));
1370 tcp_cc_update (tcp_connection_t * tc, tcp_rate_sample_t * rs)
1372 ASSERT (!tcp_in_cong_recovery (tc) || tcp_is_lost_fin (tc));
1374 /* Congestion avoidance */
1375 tcp_cc_rcv_ack (tc, rs);
1377 /* If a cumulative ack, make sure dupacks is 0 */
1378 tc->rcv_dupacks = 0;
1380 /* When dupacks hits the threshold we only enter fast retransmit if
1381 * cumulative ack covers more than snd_congestion. Should snd_una
1382 * wrap this test may fail under otherwise valid circumstances.
1383 * Therefore, proactively update snd_congestion when wrap detected. */
1385 (seq_leq (tc->snd_congestion, tc->snd_una - tc->bytes_acked)
1386 && seq_gt (tc->snd_congestion, tc->snd_una)))
1387 tc->snd_congestion = tc->snd_una - 1;
1391 tcp_update_delivered (tcp_connection_t * tc, u8 is_dack, u8 has_sack)
1395 ASSERT (tc->bytes_acked >= tc->sack_sb.last_bytes_delivered
1396 || (tc->flags & TCP_CONN_FINSNT));
1398 tc->rxt_delivered += tc->sack_sb.rxt_sacked;
1399 tc->prr_delivered += tc->bytes_acked + tc->sack_sb.last_sacked_bytes
1400 - tc->sack_sb.last_bytes_delivered;
1404 tcp_fastrecovery_first_on (tc);
1405 tc->rxt_delivered = clib_max (tc->rxt_delivered + tc->bytes_acked,
1408 tc->prr_delivered += is_dack;
1410 tc->prr_delivered += tc->bytes_acked - tc->snd_mss * tc->rcv_dupacks;
1415 * One function to rule them all ... and in the darkness bind them
1418 tcp_cc_handle_event (tcp_connection_t * tc, tcp_rate_sample_t * rs,
1421 u8 has_sack = tcp_opts_sack_permitted (&tc->rcv_opts);
1424 * Already in fast recovery. Return if no data acked, partial acks
1425 * and accounting for segments that have left the network are done
1428 if (tcp_in_cong_recovery (tc))
1431 tc->rcv_dupacks += is_dack;
1433 if (!tc->bytes_acked)
1435 tcp_update_delivered (tc, is_dack, has_sack);
1436 tcp_program_retransmit (tc);
1438 tcp_cc_rcv_cong_ack (tc, TCP_CC_DUPACK, rs);
1443 * Duplicate ACK. Check if we should enter fast recovery
1447 TCP_EVT (TCP_EVT_DUPACK_RCVD, tc, 1);
1448 ASSERT (tc->snd_una != tc->snd_nxt || tc->sack_sb.last_sacked_bytes);
1450 /* Heuristic to catch potential late dupacks */
1451 if (!tc->sack_sb.sacked_bytes && tc->snd_una == tc->snd_congestion
1452 && timestamp_leq (tc->rcv_opts.tsecr, tc->tsecr_last_ack))
1457 if (tcp_should_fastrecover (tc))
1459 ASSERT (!tcp_in_fastrecovery (tc));
1461 tcp_cc_init_congestion (tc);
1464 scoreboard_init_high_rxt (&tc->sack_sb, tc->snd_una);
1466 tcp_connection_tx_pacer_reset (tc, tc->cwnd, 0 /* start bucket */ );
1467 tcp_program_retransmit (tc);
1472 tcp_cc_rcv_cong_ack (tc, TCP_CC_DUPACK, rs);
1476 /* Don't allow entry in fast recovery if still in recovery, for now */
1477 else if (0 && is_dack && tcp_in_recovery (tc))
1479 /* If of of the two conditions lower hold, reset dupacks because
1480 * we're probably after timeout (RFC6582 heuristics).
1481 * If Cumulative ack does not cover more than congestion threshold,
1483 * 1) The following doesn't hold: The congestion window is greater
1484 * than SMSS bytes and the difference between highest_ack
1485 * and prev_highest_ack is at most 4*SMSS bytes
1486 * 2) Echoed timestamp in the last non-dup ack does not equal the
1489 if (seq_leq (tc->snd_una, tc->snd_congestion)
1490 && ((!(tc->cwnd > tc->snd_mss
1491 && tc->bytes_acked <= 4 * tc->snd_mss))
1492 || (tc->rcv_opts.tsecr != tc->tsecr_last_ack)))
1494 tc->rcv_dupacks = 0;
1499 ASSERT (tc->bytes_acked);
1500 TCP_EVT (TCP_EVT_CC_PACK, tc);
1503 * Legitimate ACK. 1) See if we can exit recovery
1506 /* RFC6675: If the incoming ACK is a cumulative acknowledgment,
1507 * reset dupacks to 0. Also needed if in congestion recovery */
1508 tc->rcv_dupacks = 0;
1510 if (seq_geq (tc->snd_una, tc->snd_congestion))
1512 /* If spurious return, we've already updated everything */
1513 if (tcp_cc_recover (tc))
1515 tc->tsecr_last_ack = tc->rcv_opts.tsecr;
1519 /* Treat as congestion avoidance ack */
1520 tcp_cc_rcv_ack (tc, rs);
1525 * Legitimate ACK. 2) If PARTIAL ACK try to retransmit
1528 /* Remove retransmitted bytes that have been delivered */
1529 tcp_update_delivered (tc, is_dack, has_sack);
1531 if (tcp_in_recovery (tc))
1532 tcp_cc_rcv_ack (tc, rs);
1534 tcp_cc_rcv_cong_ack (tc, TCP_CC_PARTIALACK, rs);
1537 * Since this was a partial ack, try to retransmit some more data
1539 tcp_program_retransmit (tc);
1543 * Process incoming ACK
1546 tcp_rcv_ack (tcp_worker_ctx_t * wrk, tcp_connection_t * tc, vlib_buffer_t * b,
1547 tcp_header_t * th, u32 * error)
1549 u32 prev_snd_wnd, prev_snd_una;
1550 tcp_rate_sample_t rs = { 0 };
1553 TCP_EVT (TCP_EVT_CC_STAT, tc);
1555 /* If the ACK acks something not yet sent (SEG.ACK > SND.NXT) */
1556 if (PREDICT_FALSE (seq_gt (vnet_buffer (b)->tcp.ack_number, tc->snd_nxt)))
1558 /* We've probably entered recovery and the peer still has some
1559 * of the data we've sent. Update snd_nxt and accept the ack */
1560 if (seq_leq (vnet_buffer (b)->tcp.ack_number, tc->snd_una_max)
1561 && seq_gt (vnet_buffer (b)->tcp.ack_number, tc->snd_una))
1563 tc->snd_nxt = vnet_buffer (b)->tcp.ack_number;
1567 tc->errors.above_ack_wnd += 1;
1568 *error = TCP_ERROR_ACK_FUTURE;
1569 TCP_EVT (TCP_EVT_ACK_RCV_ERR, tc, 0, vnet_buffer (b)->tcp.ack_number);
1573 /* If old ACK, probably it's an old dupack */
1574 if (PREDICT_FALSE (seq_lt (vnet_buffer (b)->tcp.ack_number, tc->snd_una)))
1576 tc->errors.below_ack_wnd += 1;
1577 *error = TCP_ERROR_ACK_OLD;
1578 TCP_EVT (TCP_EVT_ACK_RCV_ERR, tc, 1, vnet_buffer (b)->tcp.ack_number);
1579 if (tcp_in_fastrecovery (tc) && tc->rcv_dupacks == TCP_DUPACK_THRESHOLD)
1580 tcp_cc_handle_event (tc, 0, 1);
1581 /* Don't drop yet */
1588 * Looks okay, process feedback
1591 if (tcp_opts_sack_permitted (&tc->rcv_opts))
1592 tcp_rcv_sacks (tc, vnet_buffer (b)->tcp.ack_number);
1594 prev_snd_wnd = tc->snd_wnd;
1595 prev_snd_una = tc->snd_una;
1596 tcp_update_snd_wnd (tc, vnet_buffer (b)->tcp.seq_number,
1597 vnet_buffer (b)->tcp.ack_number,
1598 clib_net_to_host_u16 (th->window) << tc->snd_wscale);
1599 tc->bytes_acked = vnet_buffer (b)->tcp.ack_number - tc->snd_una;
1600 tc->snd_una = vnet_buffer (b)->tcp.ack_number;
1601 tcp_validate_txf_size (tc, tc->bytes_acked);
1603 if (tc->flags & TCP_CONN_RATE_SAMPLE)
1604 tcp_bt_sample_delivery_rate (tc, &rs);
1606 if (tc->bytes_acked)
1608 tcp_program_dequeue (wrk, tc);
1609 tcp_update_rtt (tc, &rs, vnet_buffer (b)->tcp.ack_number);
1612 TCP_EVT (TCP_EVT_ACK_RCVD, tc);
1615 * Check if we have congestion event
1618 if (tcp_ack_is_cc_event (tc, b, prev_snd_wnd, prev_snd_una, &is_dack))
1620 tcp_cc_handle_event (tc, &rs, is_dack);
1621 tc->dupacks_in += is_dack;
1622 if (!tcp_in_cong_recovery (tc))
1624 *error = TCP_ERROR_ACK_OK;
1627 *error = TCP_ERROR_ACK_DUP;
1628 if (vnet_buffer (b)->tcp.data_len || tcp_is_fin (th))
1634 * Update congestion control (slow start/congestion avoidance)
1636 tcp_cc_update (tc, &rs);
1637 *error = TCP_ERROR_ACK_OK;
1642 tcp_program_disconnect (tcp_worker_ctx_t * wrk, tcp_connection_t * tc)
1644 if (!tcp_disconnect_pending (tc))
1646 vec_add1 (wrk->pending_disconnects, tc->c_c_index);
1647 tcp_disconnect_pending_on (tc);
1652 tcp_handle_disconnects (tcp_worker_ctx_t * wrk)
1654 u32 thread_index, *pending_disconnects;
1655 tcp_connection_t *tc;
1658 if (!vec_len (wrk->pending_disconnects))
1661 thread_index = wrk->vm->thread_index;
1662 pending_disconnects = wrk->pending_disconnects;
1663 for (i = 0; i < vec_len (pending_disconnects); i++)
1665 tc = tcp_connection_get (pending_disconnects[i], thread_index);
1666 tcp_disconnect_pending_off (tc);
1667 session_transport_closing_notify (&tc->connection);
1669 _vec_len (wrk->pending_disconnects) = 0;
1673 tcp_rcv_fin (tcp_worker_ctx_t * wrk, tcp_connection_t * tc, vlib_buffer_t * b,
1676 /* Reject out-of-order fins */
1677 if (vnet_buffer (b)->tcp.seq_end != tc->rcv_nxt)
1680 /* Account for the FIN and send ack */
1682 tcp_program_ack (tc);
1683 /* Enter CLOSE-WAIT and notify session. To avoid lingering
1684 * in CLOSE-WAIT, set timer (reuse WAITCLOSE). */
1685 tcp_connection_set_state (tc, TCP_STATE_CLOSE_WAIT);
1686 tcp_program_disconnect (wrk, tc);
1687 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.closewait_time);
1688 TCP_EVT (TCP_EVT_FIN_RCVD, tc);
1689 *error = TCP_ERROR_FIN_RCVD;
1692 #ifndef CLIB_MARCH_VARIANT
1694 tcp_sack_vector_is_sane (sack_block_t * sacks)
1697 for (i = 1; i < vec_len (sacks); i++)
1699 if (sacks[i - 1].end == sacks[i].start)
1706 * Build SACK list as per RFC2018.
1708 * Makes sure the first block contains the segment that generated the current
1709 * ACK and the following ones are the ones most recently reported in SACK
1712 * @param tc TCP connection for which the SACK list is updated
1713 * @param start Start sequence number of the newest SACK block
1714 * @param end End sequence of the newest SACK block
1717 tcp_update_sack_list (tcp_connection_t * tc, u32 start, u32 end)
1719 sack_block_t *new_list = tc->snd_sacks_fl, *block = 0;
1722 /* If the first segment is ooo add it to the list. Last write might've moved
1723 * rcv_nxt over the first segment. */
1724 if (seq_lt (tc->rcv_nxt, start))
1726 vec_add2 (new_list, block, 1);
1727 block->start = start;
1731 /* Find the blocks still worth keeping. */
1732 for (i = 0; i < vec_len (tc->snd_sacks); i++)
1734 /* Discard if rcv_nxt advanced beyond current block */
1735 if (seq_leq (tc->snd_sacks[i].start, tc->rcv_nxt))
1738 /* Merge or drop if segment overlapped by the new segment */
1739 if (block && (seq_geq (tc->snd_sacks[i].end, new_list[0].start)
1740 && seq_leq (tc->snd_sacks[i].start, new_list[0].end)))
1742 if (seq_lt (tc->snd_sacks[i].start, new_list[0].start))
1743 new_list[0].start = tc->snd_sacks[i].start;
1744 if (seq_lt (new_list[0].end, tc->snd_sacks[i].end))
1745 new_list[0].end = tc->snd_sacks[i].end;
1749 /* Save to new SACK list if we have space. */
1750 if (vec_len (new_list) < TCP_MAX_SACK_BLOCKS)
1751 vec_add1 (new_list, tc->snd_sacks[i]);
1754 ASSERT (vec_len (new_list) <= TCP_MAX_SACK_BLOCKS);
1756 /* Replace old vector with new one */
1757 vec_reset_length (tc->snd_sacks);
1758 tc->snd_sacks_fl = tc->snd_sacks;
1759 tc->snd_sacks = new_list;
1761 /* Segments should not 'touch' */
1762 ASSERT (tcp_sack_vector_is_sane (tc->snd_sacks));
1766 tcp_sack_list_bytes (tcp_connection_t * tc)
1769 for (i = 0; i < vec_len (tc->snd_sacks); i++)
1770 bytes += tc->snd_sacks[i].end - tc->snd_sacks[i].start;
1773 #endif /* CLIB_MARCH_VARIANT */
1775 /** Enqueue data for delivery to application */
1777 tcp_session_enqueue_data (tcp_connection_t * tc, vlib_buffer_t * b,
1780 int written, error = TCP_ERROR_ENQUEUED;
1782 ASSERT (seq_geq (vnet_buffer (b)->tcp.seq_number, tc->rcv_nxt));
1784 written = session_enqueue_stream_connection (&tc->connection, b, 0,
1785 1 /* queue event */ , 1);
1786 tc->bytes_in += written;
1788 TCP_EVT (TCP_EVT_INPUT, tc, 0, data_len, written);
1790 /* Update rcv_nxt */
1791 if (PREDICT_TRUE (written == data_len))
1793 tc->rcv_nxt += written;
1795 /* If more data written than expected, account for out-of-order bytes. */
1796 else if (written > data_len)
1798 tc->rcv_nxt += written;
1799 TCP_EVT (TCP_EVT_CC_INPUT, tc, data_len, written);
1801 else if (written > 0)
1803 /* We've written something but FIFO is probably full now */
1804 tc->rcv_nxt += written;
1805 error = TCP_ERROR_PARTIALLY_ENQUEUED;
1809 return TCP_ERROR_FIFO_FULL;
1812 /* Update SACK list if need be */
1813 if (tcp_opts_sack_permitted (&tc->rcv_opts))
1815 /* Remove SACK blocks that have been delivered */
1816 tcp_update_sack_list (tc, tc->rcv_nxt, tc->rcv_nxt);
1822 /** Enqueue out-of-order data */
1824 tcp_session_enqueue_ooo (tcp_connection_t * tc, vlib_buffer_t * b,
1830 ASSERT (seq_gt (vnet_buffer (b)->tcp.seq_number, tc->rcv_nxt));
1833 /* Enqueue out-of-order data with relative offset */
1834 rv = session_enqueue_stream_connection (&tc->connection, b,
1835 vnet_buffer (b)->tcp.seq_number -
1836 tc->rcv_nxt, 0 /* queue event */ ,
1839 /* Nothing written */
1842 TCP_EVT (TCP_EVT_INPUT, tc, 1, data_len, 0);
1843 return TCP_ERROR_FIFO_FULL;
1846 TCP_EVT (TCP_EVT_INPUT, tc, 1, data_len, data_len);
1847 tc->bytes_in += data_len;
1849 /* Update SACK list if in use */
1850 if (tcp_opts_sack_permitted (&tc->rcv_opts))
1852 ooo_segment_t *newest;
1855 s0 = session_get (tc->c_s_index, tc->c_thread_index);
1857 /* Get the newest segment from the fifo */
1858 newest = svm_fifo_newest_ooo_segment (s0->rx_fifo);
1861 offset = ooo_segment_offset_prod (s0->rx_fifo, newest);
1862 ASSERT (offset <= vnet_buffer (b)->tcp.seq_number - tc->rcv_nxt);
1863 start = tc->rcv_nxt + offset;
1864 end = start + ooo_segment_length (s0->rx_fifo, newest);
1865 tcp_update_sack_list (tc, start, end);
1866 svm_fifo_newest_ooo_segment_reset (s0->rx_fifo);
1867 TCP_EVT (TCP_EVT_CC_SACKS, tc);
1871 return TCP_ERROR_ENQUEUED_OOO;
1875 * Check if ACK could be delayed. If ack can be delayed, it should return
1876 * true for a full frame. If we're always acking return 0.
1879 tcp_can_delack (tcp_connection_t * tc)
1881 /* Send ack if ... */
1883 /* just sent a rcv wnd 0
1884 || (tc->flags & TCP_CONN_SENT_RCV_WND0) != 0 */
1885 /* constrained to send ack */
1886 || (tc->flags & TCP_CONN_SNDACK) != 0
1887 /* we're almost out of tx wnd */
1888 || tcp_available_cc_snd_space (tc) < 4 * tc->snd_mss)
1895 tcp_buffer_discard_bytes (vlib_buffer_t * b, u32 n_bytes_to_drop)
1897 u32 discard, first = b->current_length;
1898 vlib_main_t *vm = vlib_get_main ();
1900 /* Handle multi-buffer segments */
1901 if (n_bytes_to_drop > b->current_length)
1903 if (!(b->flags & VLIB_BUFFER_NEXT_PRESENT))
1907 discard = clib_min (n_bytes_to_drop, b->current_length);
1908 vlib_buffer_advance (b, discard);
1909 b = vlib_get_buffer (vm, b->next_buffer);
1910 n_bytes_to_drop -= discard;
1912 while (n_bytes_to_drop);
1913 if (n_bytes_to_drop > first)
1914 b->total_length_not_including_first_buffer -= n_bytes_to_drop - first;
1917 vlib_buffer_advance (b, n_bytes_to_drop);
1918 vnet_buffer (b)->tcp.data_len -= n_bytes_to_drop;
1923 * Receive buffer for connection and handle acks
1925 * It handles both in order or out-of-order data.
1928 tcp_segment_rcv (tcp_worker_ctx_t * wrk, tcp_connection_t * tc,
1931 u32 error, n_bytes_to_drop, n_data_bytes;
1933 vlib_buffer_advance (b, vnet_buffer (b)->tcp.data_offset);
1934 n_data_bytes = vnet_buffer (b)->tcp.data_len;
1935 ASSERT (n_data_bytes);
1936 tc->data_segs_in += 1;
1938 /* Handle out-of-order data */
1939 if (PREDICT_FALSE (vnet_buffer (b)->tcp.seq_number != tc->rcv_nxt))
1941 /* Old sequence numbers allowed through because they overlapped
1943 if (seq_lt (vnet_buffer (b)->tcp.seq_number, tc->rcv_nxt))
1945 /* Completely in the past (possible retransmit). Ack
1946 * retransmissions since we may not have any data to send */
1947 if (seq_leq (vnet_buffer (b)->tcp.seq_end, tc->rcv_nxt))
1949 tcp_program_ack (tc);
1950 error = TCP_ERROR_SEGMENT_OLD;
1954 /* Chop off the bytes in the past and see if what is left
1955 * can be enqueued in order */
1956 n_bytes_to_drop = tc->rcv_nxt - vnet_buffer (b)->tcp.seq_number;
1957 n_data_bytes -= n_bytes_to_drop;
1958 vnet_buffer (b)->tcp.seq_number = tc->rcv_nxt;
1959 if (tcp_buffer_discard_bytes (b, n_bytes_to_drop))
1961 error = TCP_ERROR_SEGMENT_OLD;
1967 /* RFC2581: Enqueue and send DUPACK for fast retransmit */
1968 error = tcp_session_enqueue_ooo (tc, b, n_data_bytes);
1969 tcp_program_dupack (tc);
1970 TCP_EVT (TCP_EVT_DUPACK_SENT, tc, vnet_buffer (b)->tcp);
1971 tc->errors.above_data_wnd += seq_gt (vnet_buffer (b)->tcp.seq_end,
1972 tc->rcv_las + tc->rcv_wnd);
1978 /* In order data, enqueue. Fifo figures out by itself if any out-of-order
1979 * segments can be enqueued after fifo tail offset changes. */
1980 error = tcp_session_enqueue_data (tc, b, n_data_bytes);
1981 if (tcp_can_delack (tc))
1983 if (!tcp_timer_is_active (tc, TCP_TIMER_DELACK))
1984 tcp_timer_set (tc, TCP_TIMER_DELACK, tcp_cfg.delack_time);
1988 tcp_program_ack (tc);
1996 tcp_header_t tcp_header;
1997 tcp_connection_t tcp_connection;
2001 format_tcp_rx_trace (u8 * s, va_list * args)
2003 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
2004 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
2005 tcp_rx_trace_t *t = va_arg (*args, tcp_rx_trace_t *);
2006 u32 indent = format_get_indent (s);
2008 s = format (s, "%U\n%U%U",
2009 format_tcp_header, &t->tcp_header, 128,
2010 format_white_space, indent,
2011 format_tcp_connection, &t->tcp_connection, 1);
2017 format_tcp_rx_trace_short (u8 * s, va_list * args)
2019 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
2020 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
2021 tcp_rx_trace_t *t = va_arg (*args, tcp_rx_trace_t *);
2023 s = format (s, "%d -> %d (%U)",
2024 clib_net_to_host_u16 (t->tcp_header.dst_port),
2025 clib_net_to_host_u16 (t->tcp_header.src_port), format_tcp_state,
2026 t->tcp_connection.state);
2032 tcp_set_rx_trace_data (tcp_rx_trace_t * t0, tcp_connection_t * tc0,
2033 tcp_header_t * th0, vlib_buffer_t * b0, u8 is_ip4)
2037 clib_memcpy_fast (&t0->tcp_connection, tc0,
2038 sizeof (t0->tcp_connection));
2042 th0 = tcp_buffer_hdr (b0);
2044 clib_memcpy_fast (&t0->tcp_header, th0, sizeof (t0->tcp_header));
2048 tcp_established_trace_frame (vlib_main_t * vm, vlib_node_runtime_t * node,
2049 vlib_frame_t * frame, u8 is_ip4)
2053 n_left = frame->n_vectors;
2054 from = vlib_frame_vector_args (frame);
2058 tcp_connection_t *tc0;
2065 b0 = vlib_get_buffer (vm, bi0);
2067 if (b0->flags & VLIB_BUFFER_IS_TRACED)
2069 t0 = vlib_add_trace (vm, node, b0, sizeof (*t0));
2070 tc0 = tcp_connection_get (vnet_buffer (b0)->tcp.connection_index,
2072 th0 = tcp_buffer_hdr (b0);
2073 tcp_set_rx_trace_data (t0, tc0, th0, b0, is_ip4);
2082 tcp_node_inc_counter_i (vlib_main_t * vm, u32 tcp4_node, u32 tcp6_node,
2083 u8 is_ip4, u32 evt, u32 val)
2086 vlib_node_increment_counter (vm, tcp4_node, evt, val);
2088 vlib_node_increment_counter (vm, tcp6_node, evt, val);
2091 #define tcp_maybe_inc_counter(node_id, err, count) \
2093 if (next0 != tcp_next_drop (is_ip4)) \
2094 tcp_node_inc_counter_i (vm, tcp4_##node_id##_node.index, \
2095 tcp6_##node_id##_node.index, is_ip4, err, \
2098 #define tcp_inc_counter(node_id, err, count) \
2099 tcp_node_inc_counter_i (vm, tcp4_##node_id##_node.index, \
2100 tcp6_##node_id##_node.index, is_ip4, \
2102 #define tcp_maybe_inc_err_counter(cnts, err) \
2104 cnts[err] += (next0 != tcp_next_drop (is_ip4)); \
2106 #define tcp_inc_err_counter(cnts, err, val) \
2110 #define tcp_store_err_counters(node_id, cnts) \
2113 for (i = 0; i < TCP_N_ERROR; i++) \
2115 tcp_inc_counter(node_id, i, cnts[i]); \
2120 tcp46_established_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
2121 vlib_frame_t * frame, int is_ip4)
2123 u32 thread_index = vm->thread_index, errors = 0;
2124 tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
2125 u32 n_left_from, *from, *first_buffer;
2126 u16 err_counters[TCP_N_ERROR] = { 0 };
2128 if (node->flags & VLIB_NODE_FLAG_TRACE)
2129 tcp_established_trace_frame (vm, node, frame, is_ip4);
2131 first_buffer = from = vlib_frame_vector_args (frame);
2132 n_left_from = frame->n_vectors;
2134 while (n_left_from > 0)
2136 u32 bi0, error0 = TCP_ERROR_ACK_OK;
2139 tcp_connection_t *tc0;
2141 if (n_left_from > 1)
2144 pb = vlib_get_buffer (vm, from[1]);
2145 vlib_prefetch_buffer_header (pb, LOAD);
2146 CLIB_PREFETCH (pb->data, 2 * CLIB_CACHE_LINE_BYTES, LOAD);
2153 b0 = vlib_get_buffer (vm, bi0);
2154 tc0 = tcp_connection_get (vnet_buffer (b0)->tcp.connection_index,
2157 if (PREDICT_FALSE (tc0 == 0))
2159 error0 = TCP_ERROR_INVALID_CONNECTION;
2163 th0 = tcp_buffer_hdr (b0);
2165 /* TODO header prediction fast path */
2167 /* 1-4: check SEQ, RST, SYN */
2168 if (PREDICT_FALSE (tcp_segment_validate (wrk, tc0, b0, th0, &error0)))
2170 TCP_EVT (TCP_EVT_SEG_INVALID, tc0, vnet_buffer (b0)->tcp);
2174 /* 5: check the ACK field */
2175 if (PREDICT_FALSE (tcp_rcv_ack (wrk, tc0, b0, th0, &error0)))
2178 /* 6: check the URG bit TODO */
2180 /* 7: process the segment text */
2181 if (vnet_buffer (b0)->tcp.data_len)
2182 error0 = tcp_segment_rcv (wrk, tc0, b0);
2184 /* 8: check the FIN bit */
2185 if (PREDICT_FALSE (tcp_is_fin (th0)))
2186 tcp_rcv_fin (wrk, tc0, b0, &error0);
2189 tcp_inc_err_counter (err_counters, error0, 1);
2192 errors = session_main_flush_enqueue_events (TRANSPORT_PROTO_TCP,
2194 err_counters[TCP_ERROR_MSG_QUEUE_FULL] = errors;
2195 tcp_store_err_counters (established, err_counters);
2196 tcp_handle_postponed_dequeues (wrk);
2197 tcp_handle_disconnects (wrk);
2198 vlib_buffer_free (vm, first_buffer, frame->n_vectors);
2200 return frame->n_vectors;
2203 VLIB_NODE_FN (tcp4_established_node) (vlib_main_t * vm,
2204 vlib_node_runtime_t * node,
2205 vlib_frame_t * from_frame)
2207 return tcp46_established_inline (vm, node, from_frame, 1 /* is_ip4 */ );
2210 VLIB_NODE_FN (tcp6_established_node) (vlib_main_t * vm,
2211 vlib_node_runtime_t * node,
2212 vlib_frame_t * from_frame)
2214 return tcp46_established_inline (vm, node, from_frame, 0 /* is_ip4 */ );
2218 VLIB_REGISTER_NODE (tcp4_established_node) =
2220 .name = "tcp4-established",
2221 /* Takes a vector of packets. */
2222 .vector_size = sizeof (u32),
2223 .n_errors = TCP_N_ERROR,
2224 .error_strings = tcp_error_strings,
2225 .n_next_nodes = TCP_ESTABLISHED_N_NEXT,
2228 #define _(s,n) [TCP_ESTABLISHED_NEXT_##s] = n,
2229 foreach_tcp_state_next
2232 .format_trace = format_tcp_rx_trace_short,
2237 VLIB_REGISTER_NODE (tcp6_established_node) =
2239 .name = "tcp6-established",
2240 /* Takes a vector of packets. */
2241 .vector_size = sizeof (u32),
2242 .n_errors = TCP_N_ERROR,
2243 .error_strings = tcp_error_strings,
2244 .n_next_nodes = TCP_ESTABLISHED_N_NEXT,
2247 #define _(s,n) [TCP_ESTABLISHED_NEXT_##s] = n,
2248 foreach_tcp_state_next
2251 .format_trace = format_tcp_rx_trace_short,
2257 tcp_lookup_is_valid (tcp_connection_t * tc, tcp_header_t * hdr)
2259 transport_connection_t *tmp = 0;
2266 if (tc->c_lcl_port == 0 && tc->state == TCP_STATE_LISTEN)
2269 u8 is_valid = (tc->c_lcl_port == hdr->dst_port
2270 && (tc->state == TCP_STATE_LISTEN
2271 || tc->c_rmt_port == hdr->src_port));
2275 handle = session_lookup_half_open_handle (&tc->connection);
2276 tmp = session_lookup_half_open_connection (handle & 0xFFFFFFFF,
2277 tc->c_proto, tc->c_is_ip4);
2281 if (tmp->lcl_port == hdr->dst_port
2282 && tmp->rmt_port == hdr->src_port)
2284 TCP_DBG ("half-open is valid!");
2292 * Lookup transport connection
2294 static tcp_connection_t *
2295 tcp_lookup_connection (u32 fib_index, vlib_buffer_t * b, u8 thread_index,
2299 transport_connection_t *tconn;
2300 tcp_connection_t *tc;
2305 ip4 = vlib_buffer_get_current (b);
2306 tcp = ip4_next_header (ip4);
2307 tconn = session_lookup_connection_wt4 (fib_index,
2312 TRANSPORT_PROTO_TCP,
2313 thread_index, &is_filtered);
2314 tc = tcp_get_connection_from_transport (tconn);
2315 ASSERT (tcp_lookup_is_valid (tc, tcp));
2320 ip6 = vlib_buffer_get_current (b);
2321 tcp = ip6_next_header (ip6);
2322 tconn = session_lookup_connection_wt6 (fib_index,
2327 TRANSPORT_PROTO_TCP,
2328 thread_index, &is_filtered);
2329 tc = tcp_get_connection_from_transport (tconn);
2330 ASSERT (tcp_lookup_is_valid (tc, tcp));
2336 tcp_check_tx_offload (tcp_connection_t * tc, int is_ipv4)
2338 vnet_main_t *vnm = vnet_get_main ();
2339 const dpo_id_t *dpo;
2340 const load_balance_t *lb;
2341 vnet_hw_interface_t *hw_if;
2342 u32 sw_if_idx, lb_idx;
2346 ip4_address_t *dst_addr = &(tc->c_rmt_ip.ip4);
2347 lb_idx = ip4_fib_forwarding_lookup (tc->c_fib_index, dst_addr);
2351 ip6_address_t *dst_addr = &(tc->c_rmt_ip.ip6);
2352 lb_idx = ip6_fib_table_fwding_lookup (tc->c_fib_index, dst_addr);
2355 lb = load_balance_get (lb_idx);
2356 dpo = load_balance_get_bucket_i (lb, 0);
2358 sw_if_idx = dpo->dpoi_index;
2359 hw_if = vnet_get_sup_hw_interface (vnm, sw_if_idx);
2362 ((hw_if->flags & VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO) == 0) ? 0 : 1;
2367 tcp46_syn_sent_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
2368 vlib_frame_t * from_frame, int is_ip4)
2370 u32 n_left_from, *from, *first_buffer, errors = 0;
2371 u32 my_thread_index = vm->thread_index;
2372 tcp_worker_ctx_t *wrk = tcp_get_worker (my_thread_index);
2374 from = first_buffer = vlib_frame_vector_args (from_frame);
2375 n_left_from = from_frame->n_vectors;
2377 while (n_left_from > 0)
2379 u32 bi0, ack0, seq0, error0 = TCP_ERROR_NONE;
2380 tcp_connection_t *tc0, *new_tc0;
2381 tcp_header_t *tcp0 = 0;
2389 b0 = vlib_get_buffer (vm, bi0);
2391 tcp_half_open_connection_get (vnet_buffer (b0)->tcp.connection_index);
2392 if (PREDICT_FALSE (tc0 == 0))
2394 error0 = TCP_ERROR_INVALID_CONNECTION;
2398 /* Half-open completed recently but the connection was't removed
2399 * yet by the owning thread */
2400 if (PREDICT_FALSE (tc0->flags & TCP_CONN_HALF_OPEN_DONE))
2402 /* Make sure the connection actually exists */
2403 ASSERT (tcp_lookup_connection (tc0->c_fib_index, b0,
2404 my_thread_index, is_ip4));
2405 error0 = TCP_ERROR_SPURIOUS_SYN_ACK;
2409 ack0 = vnet_buffer (b0)->tcp.ack_number;
2410 seq0 = vnet_buffer (b0)->tcp.seq_number;
2411 tcp0 = tcp_buffer_hdr (b0);
2413 /* Crude check to see if the connection handle does not match
2414 * the packet. Probably connection just switched to established */
2415 if (PREDICT_FALSE (tcp0->dst_port != tc0->c_lcl_port
2416 || tcp0->src_port != tc0->c_rmt_port))
2418 error0 = TCP_ERROR_INVALID_CONNECTION;
2422 if (PREDICT_FALSE (!tcp_ack (tcp0) && !tcp_rst (tcp0)
2423 && !tcp_syn (tcp0)))
2425 error0 = TCP_ERROR_SEGMENT_INVALID;
2429 /* SYNs consume sequence numbers */
2430 vnet_buffer (b0)->tcp.seq_end += tcp_is_syn (tcp0);
2433 * 1. check the ACK bit
2437 * If the ACK bit is set
2438 * If SEG.ACK =< ISS, or SEG.ACK > SND.NXT, send a reset (unless
2439 * the RST bit is set, if so drop the segment and return)
2440 * <SEQ=SEG.ACK><CTL=RST>
2441 * and discard the segment. Return.
2442 * If SND.UNA =< SEG.ACK =< SND.NXT then the ACK is acceptable.
2446 if (seq_leq (ack0, tc0->iss) || seq_gt (ack0, tc0->snd_nxt))
2448 if (!tcp_rst (tcp0))
2449 tcp_send_reset_w_pkt (tc0, b0, my_thread_index, is_ip4);
2450 error0 = TCP_ERROR_RCV_WND;
2454 /* Make sure ACK is valid */
2455 if (seq_gt (tc0->snd_una, ack0))
2457 error0 = TCP_ERROR_ACK_INVALID;
2463 * 2. check the RST bit
2468 /* If ACK is acceptable, signal client that peer is not
2469 * willing to accept connection and drop connection*/
2471 tcp_connection_reset (tc0);
2472 error0 = TCP_ERROR_RST_RCVD;
2477 * 3. check the security and precedence (skipped)
2481 * 4. check the SYN bit
2484 /* No SYN flag. Drop. */
2485 if (!tcp_syn (tcp0))
2487 error0 = TCP_ERROR_SEGMENT_INVALID;
2492 if (tcp_options_parse (tcp0, &tc0->rcv_opts, 1))
2494 error0 = TCP_ERROR_OPTIONS;
2498 /* Valid SYN or SYN-ACK. Move connection from half-open pool to
2499 * current thread pool. */
2500 new_tc0 = tcp_connection_alloc_w_base (my_thread_index, tc0);
2501 new_tc0->rcv_nxt = vnet_buffer (b0)->tcp.seq_end;
2502 new_tc0->irs = seq0;
2503 new_tc0->timers[TCP_TIMER_RETRANSMIT_SYN] = TCP_TIMER_HANDLE_INVALID;
2504 new_tc0->sw_if_index = vnet_buffer (b0)->sw_if_index[VLIB_RX];
2506 /* If this is not the owning thread, wait for syn retransmit to
2507 * expire and cleanup then */
2508 if (tcp_half_open_connection_cleanup (tc0))
2509 tc0->flags |= TCP_CONN_HALF_OPEN_DONE;
2511 if (tcp_opts_tstamp (&new_tc0->rcv_opts))
2513 new_tc0->tsval_recent = new_tc0->rcv_opts.tsval;
2514 new_tc0->tsval_recent_age = tcp_time_now ();
2517 if (tcp_opts_wscale (&new_tc0->rcv_opts))
2518 new_tc0->snd_wscale = new_tc0->rcv_opts.wscale;
2520 new_tc0->rcv_wscale = 0;
2522 new_tc0->snd_wnd = clib_net_to_host_u16 (tcp0->window)
2523 << new_tc0->snd_wscale;
2524 new_tc0->snd_wl1 = seq0;
2525 new_tc0->snd_wl2 = ack0;
2527 tcp_connection_init_vars (new_tc0);
2529 /* SYN-ACK: See if we can switch to ESTABLISHED state */
2530 if (PREDICT_TRUE (tcp_ack (tcp0)))
2532 /* Our SYN is ACKed: we have iss < ack = snd_una */
2534 /* TODO Dequeue acknowledged segments if we support Fast Open */
2535 new_tc0->snd_una = ack0;
2536 new_tc0->state = TCP_STATE_ESTABLISHED;
2538 /* Make sure las is initialized for the wnd computation */
2539 new_tc0->rcv_las = new_tc0->rcv_nxt;
2541 /* Notify app that we have connection. If session layer can't
2542 * allocate session send reset */
2543 if (session_stream_connect_notify (&new_tc0->connection, 0))
2545 tcp_send_reset_w_pkt (new_tc0, b0, my_thread_index, is_ip4);
2546 tcp_connection_cleanup (new_tc0);
2547 error0 = TCP_ERROR_CREATE_SESSION_FAIL;
2551 new_tc0->tx_fifo_size =
2552 transport_tx_fifo_size (&new_tc0->connection);
2553 /* Update rtt with the syn-ack sample */
2554 tcp_estimate_initial_rtt (new_tc0);
2555 TCP_EVT (TCP_EVT_SYNACK_RCVD, new_tc0);
2556 error0 = TCP_ERROR_SYN_ACKS_RCVD;
2558 /* SYN: Simultaneous open. Change state to SYN-RCVD and send SYN-ACK */
2561 new_tc0->state = TCP_STATE_SYN_RCVD;
2563 /* Notify app that we have connection */
2564 if (session_stream_connect_notify (&new_tc0->connection, 0))
2566 tcp_connection_cleanup (new_tc0);
2567 tcp_send_reset_w_pkt (tc0, b0, my_thread_index, is_ip4);
2568 TCP_EVT (TCP_EVT_RST_SENT, tc0);
2569 error0 = TCP_ERROR_CREATE_SESSION_FAIL;
2573 new_tc0->tx_fifo_size =
2574 transport_tx_fifo_size (&new_tc0->connection);
2575 new_tc0->rtt_ts = 0;
2576 tcp_init_snd_vars (new_tc0);
2577 tcp_send_synack (new_tc0);
2578 error0 = TCP_ERROR_SYNS_RCVD;
2582 tcp_check_tx_offload (new_tc0, is_ip4);
2584 /* Read data, if any */
2585 if (PREDICT_FALSE (vnet_buffer (b0)->tcp.data_len))
2587 clib_warning ("rcvd data in syn-sent");
2588 error0 = tcp_segment_rcv (wrk, new_tc0, b0);
2589 if (error0 == TCP_ERROR_ACK_OK)
2590 error0 = TCP_ERROR_SYN_ACKS_RCVD;
2594 tcp_program_ack (new_tc0);
2599 tcp_inc_counter (syn_sent, error0, 1);
2600 if (PREDICT_FALSE ((b0->flags & VLIB_BUFFER_IS_TRACED) && tcp0 != 0))
2602 t0 = vlib_add_trace (vm, node, b0, sizeof (*t0));
2603 clib_memcpy_fast (&t0->tcp_header, tcp0, sizeof (t0->tcp_header));
2604 clib_memcpy_fast (&t0->tcp_connection, tc0,
2605 sizeof (t0->tcp_connection));
2609 errors = session_main_flush_enqueue_events (TRANSPORT_PROTO_TCP,
2611 tcp_inc_counter (syn_sent, TCP_ERROR_MSG_QUEUE_FULL, errors);
2612 vlib_buffer_free (vm, first_buffer, from_frame->n_vectors);
2614 return from_frame->n_vectors;
2617 VLIB_NODE_FN (tcp4_syn_sent_node) (vlib_main_t * vm,
2618 vlib_node_runtime_t * node,
2619 vlib_frame_t * from_frame)
2621 return tcp46_syn_sent_inline (vm, node, from_frame, 1 /* is_ip4 */ );
2624 VLIB_NODE_FN (tcp6_syn_sent_node) (vlib_main_t * vm,
2625 vlib_node_runtime_t * node,
2626 vlib_frame_t * from_frame)
2628 return tcp46_syn_sent_inline (vm, node, from_frame, 0 /* is_ip4 */ );
2632 VLIB_REGISTER_NODE (tcp4_syn_sent_node) =
2634 .name = "tcp4-syn-sent",
2635 /* Takes a vector of packets. */
2636 .vector_size = sizeof (u32),
2637 .n_errors = TCP_N_ERROR,
2638 .error_strings = tcp_error_strings,
2639 .n_next_nodes = TCP_SYN_SENT_N_NEXT,
2642 #define _(s,n) [TCP_SYN_SENT_NEXT_##s] = n,
2643 foreach_tcp_state_next
2646 .format_trace = format_tcp_rx_trace_short,
2651 VLIB_REGISTER_NODE (tcp6_syn_sent_node) =
2653 .name = "tcp6-syn-sent",
2654 /* Takes a vector of packets. */
2655 .vector_size = sizeof (u32),
2656 .n_errors = TCP_N_ERROR,
2657 .error_strings = tcp_error_strings,
2658 .n_next_nodes = TCP_SYN_SENT_N_NEXT,
2661 #define _(s,n) [TCP_SYN_SENT_NEXT_##s] = n,
2662 foreach_tcp_state_next
2665 .format_trace = format_tcp_rx_trace_short,
2670 * Handles reception for all states except LISTEN, SYN-SENT and ESTABLISHED
2671 * as per RFC793 p. 64
2674 tcp46_rcv_process_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
2675 vlib_frame_t * from_frame, int is_ip4)
2677 u32 thread_index = vm->thread_index, errors = 0, *first_buffer;
2678 tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
2679 u32 n_left_from, *from, max_dequeue;
2681 from = first_buffer = vlib_frame_vector_args (from_frame);
2682 n_left_from = from_frame->n_vectors;
2684 while (n_left_from > 0)
2686 u32 bi0, error0 = TCP_ERROR_NONE;
2687 tcp_header_t *tcp0 = 0;
2688 tcp_connection_t *tc0;
2696 b0 = vlib_get_buffer (vm, bi0);
2697 tc0 = tcp_connection_get (vnet_buffer (b0)->tcp.connection_index,
2699 if (PREDICT_FALSE (tc0 == 0))
2701 error0 = TCP_ERROR_INVALID_CONNECTION;
2705 tcp0 = tcp_buffer_hdr (b0);
2706 is_fin0 = tcp_is_fin (tcp0);
2710 tcp_connection_t *tmp;
2711 tmp = tcp_lookup_connection (tc0->c_fib_index, b0, thread_index,
2713 if (tmp->state != tc0->state)
2715 if (tc0->state != TCP_STATE_CLOSED)
2716 clib_warning ("state changed");
2722 * Special treatment for CLOSED
2724 if (PREDICT_FALSE (tc0->state == TCP_STATE_CLOSED))
2726 error0 = TCP_ERROR_CONNECTION_CLOSED;
2731 * For all other states (except LISTEN)
2734 /* 1-4: check SEQ, RST, SYN */
2735 if (PREDICT_FALSE (tcp_segment_validate (wrk, tc0, b0, tcp0, &error0)))
2738 /* 5: check the ACK field */
2741 case TCP_STATE_SYN_RCVD:
2743 /* Make sure the segment is exactly right */
2744 if (tc0->rcv_nxt != vnet_buffer (b0)->tcp.seq_number || is_fin0)
2746 tcp_connection_reset (tc0);
2747 error0 = TCP_ERROR_SEGMENT_INVALID;
2752 * If the segment acknowledgment is not acceptable, form a
2754 * <SEQ=SEG.ACK><CTL=RST>
2757 if (tcp_rcv_ack_no_cc (tc0, b0, &error0))
2759 tcp_connection_reset (tc0);
2763 /* Update rtt and rto */
2764 tcp_estimate_initial_rtt (tc0);
2765 tcp_connection_tx_pacer_update (tc0);
2767 /* Switch state to ESTABLISHED */
2768 tc0->state = TCP_STATE_ESTABLISHED;
2769 TCP_EVT (TCP_EVT_STATE_CHANGE, tc0);
2771 tcp_check_tx_offload (tc0, is_ip4);
2773 /* Initialize session variables */
2774 tc0->snd_una = vnet_buffer (b0)->tcp.ack_number;
2775 tc0->snd_wnd = clib_net_to_host_u16 (tcp0->window)
2776 << tc0->rcv_opts.wscale;
2777 tc0->snd_wl1 = vnet_buffer (b0)->tcp.seq_number;
2778 tc0->snd_wl2 = vnet_buffer (b0)->tcp.ack_number;
2780 /* Reset SYN-ACK retransmit and SYN_RCV establish timers */
2781 tcp_retransmit_timer_reset (tc0);
2782 if (session_stream_accept_notify (&tc0->connection))
2784 error0 = TCP_ERROR_MSG_QUEUE_FULL;
2785 tcp_connection_reset (tc0);
2788 error0 = TCP_ERROR_ACK_OK;
2790 case TCP_STATE_ESTABLISHED:
2791 /* We can get packets in established state here because they
2792 * were enqueued before state change */
2793 if (tcp_rcv_ack (wrk, tc0, b0, tcp0, &error0))
2797 case TCP_STATE_FIN_WAIT_1:
2798 /* In addition to the processing for the ESTABLISHED state, if
2799 * our FIN is now acknowledged then enter FIN-WAIT-2 and
2800 * continue processing in that state. */
2801 if (tcp_rcv_ack (wrk, tc0, b0, tcp0, &error0))
2804 /* Still have to send the FIN */
2805 if (tc0->flags & TCP_CONN_FINPNDG)
2807 /* TX fifo finally drained */
2808 max_dequeue = transport_max_tx_dequeue (&tc0->connection);
2809 if (max_dequeue <= tc0->burst_acked)
2811 /* If a fin was received and data was acked extend wait */
2812 else if ((tc0->flags & TCP_CONN_FINRCVD) && tc0->bytes_acked)
2813 tcp_timer_update (tc0, TCP_TIMER_WAITCLOSE,
2814 tcp_cfg.closewait_time);
2816 /* If FIN is ACKed */
2817 else if (tc0->snd_una == tc0->snd_nxt)
2819 /* Stop all retransmit timers because we have nothing more
2821 tcp_connection_timers_reset (tc0);
2823 /* We already have a FIN but didn't transition to CLOSING
2824 * because of outstanding tx data. Close the connection. */
2825 if (tc0->flags & TCP_CONN_FINRCVD)
2827 tcp_connection_set_state (tc0, TCP_STATE_CLOSED);
2828 tcp_timer_set (tc0, TCP_TIMER_WAITCLOSE,
2829 tcp_cfg.cleanup_time);
2830 session_transport_closed_notify (&tc0->connection);
2834 tcp_connection_set_state (tc0, TCP_STATE_FIN_WAIT_2);
2835 /* Enable waitclose because we're willing to wait for peer's
2836 * FIN but not indefinitely. */
2837 tcp_timer_set (tc0, TCP_TIMER_WAITCLOSE, tcp_cfg.finwait2_time);
2839 /* Don't try to deq the FIN acked */
2840 if (tc0->burst_acked > 1)
2841 session_tx_fifo_dequeue_drop (&tc0->connection,
2842 tc0->burst_acked - 1);
2843 tc0->burst_acked = 0;
2846 case TCP_STATE_FIN_WAIT_2:
2847 /* In addition to the processing for the ESTABLISHED state, if
2848 * the retransmission queue is empty, the user's CLOSE can be
2849 * acknowledged ("ok") but do not delete the TCB. */
2850 if (tcp_rcv_ack_no_cc (tc0, b0, &error0))
2852 tc0->burst_acked = 0;
2854 case TCP_STATE_CLOSE_WAIT:
2855 /* Do the same processing as for the ESTABLISHED state. */
2856 if (tcp_rcv_ack (wrk, tc0, b0, tcp0, &error0))
2859 if (!(tc0->flags & TCP_CONN_FINPNDG))
2862 /* Still have outstanding tx data */
2863 max_dequeue = transport_max_tx_dequeue (&tc0->connection);
2864 if (max_dequeue > tc0->burst_acked)
2868 tcp_connection_timers_reset (tc0);
2869 tcp_connection_set_state (tc0, TCP_STATE_LAST_ACK);
2870 tcp_timer_set (tc0, TCP_TIMER_WAITCLOSE, tcp_cfg.lastack_time);
2872 case TCP_STATE_CLOSING:
2873 /* In addition to the processing for the ESTABLISHED state, if
2874 * the ACK acknowledges our FIN then enter the TIME-WAIT state,
2875 * otherwise ignore the segment. */
2876 if (tcp_rcv_ack_no_cc (tc0, b0, &error0))
2879 if (tc0->snd_una != tc0->snd_nxt)
2882 tcp_connection_timers_reset (tc0);
2883 tcp_connection_set_state (tc0, TCP_STATE_TIME_WAIT);
2884 tcp_timer_set (tc0, TCP_TIMER_WAITCLOSE, tcp_cfg.timewait_time);
2885 session_transport_closed_notify (&tc0->connection);
2889 case TCP_STATE_LAST_ACK:
2890 /* The only thing that [should] arrive in this state is an
2891 * acknowledgment of our FIN. If our FIN is now acknowledged,
2892 * delete the TCB, enter the CLOSED state, and return. */
2894 if (tcp_rcv_ack_no_cc (tc0, b0, &error0))
2897 /* Apparently our ACK for the peer's FIN was lost */
2898 if (is_fin0 && tc0->snd_una != tc0->snd_nxt)
2904 tcp_connection_set_state (tc0, TCP_STATE_CLOSED);
2905 session_transport_closed_notify (&tc0->connection);
2907 /* Don't free the connection from the data path since
2908 * we can't ensure that we have no packets already enqueued
2909 * to output. Rely instead on the waitclose timer */
2910 tcp_connection_timers_reset (tc0);
2911 tcp_timer_set (tc0, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
2916 case TCP_STATE_TIME_WAIT:
2917 /* The only thing that can arrive in this state is a
2918 * retransmission of the remote FIN. Acknowledge it, and restart
2919 * the 2 MSL timeout. */
2921 if (tcp_rcv_ack_no_cc (tc0, b0, &error0))
2927 tcp_program_ack (tc0);
2928 tcp_timer_update (tc0, TCP_TIMER_WAITCLOSE, tcp_cfg.timewait_time);
2936 /* 6: check the URG bit TODO */
2938 /* 7: process the segment text */
2941 case TCP_STATE_ESTABLISHED:
2942 case TCP_STATE_FIN_WAIT_1:
2943 case TCP_STATE_FIN_WAIT_2:
2944 if (vnet_buffer (b0)->tcp.data_len)
2945 error0 = tcp_segment_rcv (wrk, tc0, b0);
2947 case TCP_STATE_CLOSE_WAIT:
2948 case TCP_STATE_CLOSING:
2949 case TCP_STATE_LAST_ACK:
2950 case TCP_STATE_TIME_WAIT:
2951 /* This should not occur, since a FIN has been received from the
2952 * remote side. Ignore the segment text. */
2956 /* 8: check the FIN bit */
2960 TCP_EVT (TCP_EVT_FIN_RCVD, tc0);
2964 case TCP_STATE_ESTABLISHED:
2965 /* Account for the FIN and send ack */
2967 tcp_program_ack (tc0);
2968 tcp_connection_set_state (tc0, TCP_STATE_CLOSE_WAIT);
2969 tcp_program_disconnect (wrk, tc0);
2970 tcp_timer_update (tc0, TCP_TIMER_WAITCLOSE, tcp_cfg.closewait_time);
2972 case TCP_STATE_SYN_RCVD:
2973 /* Send FIN-ACK, enter LAST-ACK and because the app was not
2974 * notified yet, set a cleanup timer instead of relying on
2975 * disconnect notify and the implicit close call. */
2976 tcp_connection_timers_reset (tc0);
2979 tcp_connection_set_state (tc0, TCP_STATE_LAST_ACK);
2980 tcp_timer_set (tc0, TCP_TIMER_WAITCLOSE, tcp_cfg.lastack_time);
2982 case TCP_STATE_CLOSE_WAIT:
2983 case TCP_STATE_CLOSING:
2984 case TCP_STATE_LAST_ACK:
2987 case TCP_STATE_FIN_WAIT_1:
2990 if (tc0->flags & TCP_CONN_FINPNDG)
2992 /* If data is outstanding, stay in FIN_WAIT_1 and try to finish
2993 * sending it. Since we already received a fin, do not wait
2995 tc0->flags |= TCP_CONN_FINRCVD;
2996 tcp_timer_update (tc0, TCP_TIMER_WAITCLOSE,
2997 tcp_cfg.closewait_time);
3001 tcp_connection_set_state (tc0, TCP_STATE_CLOSING);
3002 tcp_program_ack (tc0);
3003 /* Wait for ACK for our FIN but not forever */
3004 tcp_timer_update (tc0, TCP_TIMER_WAITCLOSE,
3005 tcp_cfg.closing_time);
3008 case TCP_STATE_FIN_WAIT_2:
3009 /* Got FIN, send ACK! Be more aggressive with resource cleanup */
3011 tcp_connection_set_state (tc0, TCP_STATE_TIME_WAIT);
3012 tcp_connection_timers_reset (tc0);
3013 tcp_timer_set (tc0, TCP_TIMER_WAITCLOSE, tcp_cfg.timewait_time);
3014 tcp_program_ack (tc0);
3015 session_transport_closed_notify (&tc0->connection);
3017 case TCP_STATE_TIME_WAIT:
3018 /* Remain in the TIME-WAIT state. Restart the time-wait
3021 tcp_timer_update (tc0, TCP_TIMER_WAITCLOSE, tcp_cfg.timewait_time);
3024 error0 = TCP_ERROR_FIN_RCVD;
3028 tcp_inc_counter (rcv_process, error0, 1);
3029 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
3031 tcp_rx_trace_t *t0 = vlib_add_trace (vm, node, b0, sizeof (*t0));
3032 tcp_set_rx_trace_data (t0, tc0, tcp0, b0, is_ip4);
3036 errors = session_main_flush_enqueue_events (TRANSPORT_PROTO_TCP,
3038 tcp_inc_counter (rcv_process, TCP_ERROR_MSG_QUEUE_FULL, errors);
3039 tcp_handle_postponed_dequeues (wrk);
3040 tcp_handle_disconnects (wrk);
3041 vlib_buffer_free (vm, first_buffer, from_frame->n_vectors);
3043 return from_frame->n_vectors;
3046 VLIB_NODE_FN (tcp4_rcv_process_node) (vlib_main_t * vm,
3047 vlib_node_runtime_t * node,
3048 vlib_frame_t * from_frame)
3050 return tcp46_rcv_process_inline (vm, node, from_frame, 1 /* is_ip4 */ );
3053 VLIB_NODE_FN (tcp6_rcv_process_node) (vlib_main_t * vm,
3054 vlib_node_runtime_t * node,
3055 vlib_frame_t * from_frame)
3057 return tcp46_rcv_process_inline (vm, node, from_frame, 0 /* is_ip4 */ );
3061 VLIB_REGISTER_NODE (tcp4_rcv_process_node) =
3063 .name = "tcp4-rcv-process",
3064 /* Takes a vector of packets. */
3065 .vector_size = sizeof (u32),
3066 .n_errors = TCP_N_ERROR,
3067 .error_strings = tcp_error_strings,
3068 .n_next_nodes = TCP_RCV_PROCESS_N_NEXT,
3071 #define _(s,n) [TCP_RCV_PROCESS_NEXT_##s] = n,
3072 foreach_tcp_state_next
3075 .format_trace = format_tcp_rx_trace_short,
3080 VLIB_REGISTER_NODE (tcp6_rcv_process_node) =
3082 .name = "tcp6-rcv-process",
3083 /* Takes a vector of packets. */
3084 .vector_size = sizeof (u32),
3085 .n_errors = TCP_N_ERROR,
3086 .error_strings = tcp_error_strings,
3087 .n_next_nodes = TCP_RCV_PROCESS_N_NEXT,
3090 #define _(s,n) [TCP_RCV_PROCESS_NEXT_##s] = n,
3091 foreach_tcp_state_next
3094 .format_trace = format_tcp_rx_trace_short,
3099 * LISTEN state processing as per RFC 793 p. 65
3102 tcp46_listen_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
3103 vlib_frame_t * from_frame, int is_ip4)
3105 u32 n_left_from, *from, n_syns = 0, *first_buffer;
3106 u32 my_thread_index = vm->thread_index;
3108 from = first_buffer = vlib_frame_vector_args (from_frame);
3109 n_left_from = from_frame->n_vectors;
3111 while (n_left_from > 0)
3116 tcp_header_t *th0 = 0;
3117 tcp_connection_t *lc0;
3120 tcp_connection_t *child0;
3121 u32 error0 = TCP_ERROR_NONE;
3127 b0 = vlib_get_buffer (vm, bi0);
3128 lc0 = tcp_listener_get (vnet_buffer (b0)->tcp.connection_index);
3132 ip40 = vlib_buffer_get_current (b0);
3133 th0 = ip4_next_header (ip40);
3137 ip60 = vlib_buffer_get_current (b0);
3138 th0 = ip6_next_header (ip60);
3141 /* Create child session. For syn-flood protection use filter */
3143 /* 1. first check for an RST: handled in dispatch */
3144 /* if (tcp_rst (th0))
3148 /* 2. second check for an ACK: handled in dispatch */
3149 /* if (tcp_ack (th0))
3151 tcp_send_reset (b0, is_ip4);
3156 /* 3. check for a SYN (did that already) */
3158 /* Make sure connection wasn't just created */
3159 child0 = tcp_lookup_connection (lc0->c_fib_index, b0, my_thread_index,
3161 if (PREDICT_FALSE (child0->state != TCP_STATE_LISTEN))
3163 error0 = TCP_ERROR_CREATE_EXISTS;
3167 /* Create child session and send SYN-ACK */
3168 child0 = tcp_connection_alloc (my_thread_index);
3169 child0->c_lcl_port = th0->dst_port;
3170 child0->c_rmt_port = th0->src_port;
3171 child0->c_is_ip4 = is_ip4;
3172 child0->state = TCP_STATE_SYN_RCVD;
3173 child0->c_fib_index = lc0->c_fib_index;
3174 child0->cc_algo = lc0->cc_algo;
3178 child0->c_lcl_ip4.as_u32 = ip40->dst_address.as_u32;
3179 child0->c_rmt_ip4.as_u32 = ip40->src_address.as_u32;
3183 clib_memcpy_fast (&child0->c_lcl_ip6, &ip60->dst_address,
3184 sizeof (ip6_address_t));
3185 clib_memcpy_fast (&child0->c_rmt_ip6, &ip60->src_address,
3186 sizeof (ip6_address_t));
3189 if (tcp_options_parse (th0, &child0->rcv_opts, 1))
3191 error0 = TCP_ERROR_OPTIONS;
3192 tcp_connection_free (child0);
3196 child0->irs = vnet_buffer (b0)->tcp.seq_number;
3197 child0->rcv_nxt = vnet_buffer (b0)->tcp.seq_number + 1;
3198 child0->rcv_las = child0->rcv_nxt;
3199 child0->sw_if_index = vnet_buffer (b0)->sw_if_index[VLIB_RX];
3201 /* RFC1323: TSval timestamps sent on {SYN} and {SYN,ACK}
3202 * segments are used to initialize PAWS. */
3203 if (tcp_opts_tstamp (&child0->rcv_opts))
3205 child0->tsval_recent = child0->rcv_opts.tsval;
3206 child0->tsval_recent_age = tcp_time_now ();
3209 if (tcp_opts_wscale (&child0->rcv_opts))
3210 child0->snd_wscale = child0->rcv_opts.wscale;
3212 child0->snd_wnd = clib_net_to_host_u16 (th0->window)
3213 << child0->snd_wscale;
3214 child0->snd_wl1 = vnet_buffer (b0)->tcp.seq_number;
3215 child0->snd_wl2 = vnet_buffer (b0)->tcp.ack_number;
3217 tcp_connection_init_vars (child0);
3218 child0->rto = TCP_RTO_MIN;
3220 if (session_stream_accept (&child0->connection, lc0->c_s_index,
3221 lc0->c_thread_index, 0 /* notify */ ))
3223 tcp_connection_cleanup (child0);
3224 error0 = TCP_ERROR_CREATE_SESSION_FAIL;
3228 TCP_EVT (TCP_EVT_SYN_RCVD, child0, 1);
3229 child0->tx_fifo_size = transport_tx_fifo_size (&child0->connection);
3230 tcp_send_synack (child0);
3234 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
3236 t0 = vlib_add_trace (vm, node, b0, sizeof (*t0));
3237 clib_memcpy_fast (&t0->tcp_header, th0, sizeof (t0->tcp_header));
3238 clib_memcpy_fast (&t0->tcp_connection, lc0,
3239 sizeof (t0->tcp_connection));
3242 n_syns += (error0 == TCP_ERROR_NONE);
3245 tcp_inc_counter (listen, TCP_ERROR_SYNS_RCVD, n_syns);
3246 vlib_buffer_free (vm, first_buffer, from_frame->n_vectors);
3248 return from_frame->n_vectors;
3251 VLIB_NODE_FN (tcp4_listen_node) (vlib_main_t * vm, vlib_node_runtime_t * node,
3252 vlib_frame_t * from_frame)
3254 return tcp46_listen_inline (vm, node, from_frame, 1 /* is_ip4 */ );
3257 VLIB_NODE_FN (tcp6_listen_node) (vlib_main_t * vm, vlib_node_runtime_t * node,
3258 vlib_frame_t * from_frame)
3260 return tcp46_listen_inline (vm, node, from_frame, 0 /* is_ip4 */ );
3264 VLIB_REGISTER_NODE (tcp4_listen_node) =
3266 .name = "tcp4-listen",
3267 /* Takes a vector of packets. */
3268 .vector_size = sizeof (u32),
3269 .n_errors = TCP_N_ERROR,
3270 .error_strings = tcp_error_strings,
3271 .n_next_nodes = TCP_LISTEN_N_NEXT,
3274 #define _(s,n) [TCP_LISTEN_NEXT_##s] = n,
3275 foreach_tcp_state_next
3278 .format_trace = format_tcp_rx_trace_short,
3283 VLIB_REGISTER_NODE (tcp6_listen_node) =
3285 .name = "tcp6-listen",
3286 /* Takes a vector of packets. */
3287 .vector_size = sizeof (u32),
3288 .n_errors = TCP_N_ERROR,
3289 .error_strings = tcp_error_strings,
3290 .n_next_nodes = TCP_LISTEN_N_NEXT,
3293 #define _(s,n) [TCP_LISTEN_NEXT_##s] = n,
3294 foreach_tcp_state_next
3297 .format_trace = format_tcp_rx_trace_short,
3301 typedef enum _tcp_input_next
3303 TCP_INPUT_NEXT_DROP,
3304 TCP_INPUT_NEXT_LISTEN,
3305 TCP_INPUT_NEXT_RCV_PROCESS,
3306 TCP_INPUT_NEXT_SYN_SENT,
3307 TCP_INPUT_NEXT_ESTABLISHED,
3308 TCP_INPUT_NEXT_RESET,
3309 TCP_INPUT_NEXT_PUNT,
3313 #define foreach_tcp4_input_next \
3314 _ (DROP, "ip4-drop") \
3315 _ (LISTEN, "tcp4-listen") \
3316 _ (RCV_PROCESS, "tcp4-rcv-process") \
3317 _ (SYN_SENT, "tcp4-syn-sent") \
3318 _ (ESTABLISHED, "tcp4-established") \
3319 _ (RESET, "tcp4-reset") \
3320 _ (PUNT, "ip4-punt")
3322 #define foreach_tcp6_input_next \
3323 _ (DROP, "ip6-drop") \
3324 _ (LISTEN, "tcp6-listen") \
3325 _ (RCV_PROCESS, "tcp6-rcv-process") \
3326 _ (SYN_SENT, "tcp6-syn-sent") \
3327 _ (ESTABLISHED, "tcp6-established") \
3328 _ (RESET, "tcp6-reset") \
3329 _ (PUNT, "ip6-punt")
3331 #define filter_flags (TCP_FLAG_SYN|TCP_FLAG_ACK|TCP_FLAG_RST|TCP_FLAG_FIN)
3334 tcp_input_trace_frame (vlib_main_t * vm, vlib_node_runtime_t * node,
3335 vlib_buffer_t ** bs, u32 n_bufs, u8 is_ip4)
3337 tcp_connection_t *tc;
3342 for (i = 0; i < n_bufs; i++)
3344 if (bs[i]->flags & VLIB_BUFFER_IS_TRACED)
3346 t = vlib_add_trace (vm, node, bs[i], sizeof (*t));
3347 tc = tcp_connection_get (vnet_buffer (bs[i])->tcp.connection_index,
3349 tcp = vlib_buffer_get_current (bs[i]);
3350 tcp_set_rx_trace_data (t, tc, tcp, bs[i], is_ip4);
3356 tcp_input_set_error_next (tcp_main_t * tm, u16 * next, u32 * error, u8 is_ip4)
3358 if (*error == TCP_ERROR_FILTERED || *error == TCP_ERROR_WRONG_THREAD)
3360 *next = TCP_INPUT_NEXT_DROP;
3362 else if ((is_ip4 && tm->punt_unknown4) || (!is_ip4 && tm->punt_unknown6))
3364 *next = TCP_INPUT_NEXT_PUNT;
3365 *error = TCP_ERROR_PUNT;
3369 *next = TCP_INPUT_NEXT_RESET;
3370 *error = TCP_ERROR_NO_LISTENER;
3374 always_inline tcp_connection_t *
3375 tcp_input_lookup_buffer (vlib_buffer_t * b, u8 thread_index, u32 * error,
3376 u8 is_ip4, u8 is_nolookup)
3378 u32 fib_index = vnet_buffer (b)->ip.fib_index;
3379 int n_advance_bytes, n_data_bytes;
3380 transport_connection_t *tc;
3386 ip4_header_t *ip4 = vlib_buffer_get_current (b);
3387 int ip_hdr_bytes = ip4_header_bytes (ip4);
3388 if (PREDICT_FALSE (b->current_length < ip_hdr_bytes + sizeof (*tcp)))
3390 *error = TCP_ERROR_LENGTH;
3393 tcp = ip4_next_header (ip4);
3394 vnet_buffer (b)->tcp.hdr_offset = (u8 *) tcp - (u8 *) ip4;
3395 n_advance_bytes = (ip_hdr_bytes + tcp_header_bytes (tcp));
3396 n_data_bytes = clib_net_to_host_u16 (ip4->length) - n_advance_bytes;
3398 /* Length check. Checksum computed by ipx_local no need to compute again */
3399 if (PREDICT_FALSE (n_data_bytes < 0))
3401 *error = TCP_ERROR_LENGTH;
3406 tc = session_lookup_connection_wt4 (fib_index, &ip4->dst_address,
3407 &ip4->src_address, tcp->dst_port,
3409 TRANSPORT_PROTO_TCP, thread_index,
3414 ip6_header_t *ip6 = vlib_buffer_get_current (b);
3415 if (PREDICT_FALSE (b->current_length < sizeof (*ip6) + sizeof (*tcp)))
3417 *error = TCP_ERROR_LENGTH;
3420 tcp = ip6_next_header (ip6);
3421 vnet_buffer (b)->tcp.hdr_offset = (u8 *) tcp - (u8 *) ip6;
3422 n_advance_bytes = tcp_header_bytes (tcp);
3423 n_data_bytes = clib_net_to_host_u16 (ip6->payload_length)
3425 n_advance_bytes += sizeof (ip6[0]);
3427 if (PREDICT_FALSE (n_data_bytes < 0))
3429 *error = TCP_ERROR_LENGTH;
3436 (ip6_address_is_link_local_unicast (&ip6->dst_address)))
3438 ip4_main_t *im = &ip4_main;
3439 fib_index = vec_elt (im->fib_index_by_sw_if_index,
3440 vnet_buffer (b)->sw_if_index[VLIB_RX]);
3443 tc = session_lookup_connection_wt6 (fib_index, &ip6->dst_address,
3445 tcp->dst_port, tcp->src_port,
3446 TRANSPORT_PROTO_TCP,
3447 thread_index, &result);
3453 (transport_connection_t *) tcp_connection_get (vnet_buffer (b)->
3454 tcp.connection_index,
3457 vnet_buffer (b)->tcp.seq_number = clib_net_to_host_u32 (tcp->seq_number);
3458 vnet_buffer (b)->tcp.ack_number = clib_net_to_host_u32 (tcp->ack_number);
3459 vnet_buffer (b)->tcp.data_offset = n_advance_bytes;
3460 vnet_buffer (b)->tcp.data_len = n_data_bytes;
3461 vnet_buffer (b)->tcp.seq_end = vnet_buffer (b)->tcp.seq_number
3463 vnet_buffer (b)->tcp.flags = 0;
3465 *error = result ? TCP_ERROR_NONE + result : *error;
3467 return tcp_get_connection_from_transport (tc);
3471 tcp_input_dispatch_buffer (tcp_main_t * tm, tcp_connection_t * tc,
3472 vlib_buffer_t * b, u16 * next, u32 * error)
3477 tcp = tcp_buffer_hdr (b);
3478 flags = tcp->flags & filter_flags;
3479 *next = tm->dispatch_table[tc->state][flags].next;
3480 *error = tm->dispatch_table[tc->state][flags].error;
3483 if (PREDICT_FALSE (*error == TCP_ERROR_DISPATCH
3484 || *next == TCP_INPUT_NEXT_RESET))
3486 /* Overload tcp flags to store state */
3487 tcp_state_t state = tc->state;
3488 vnet_buffer (b)->tcp.flags = tc->state;
3490 if (*error == TCP_ERROR_DISPATCH)
3491 clib_warning ("tcp conn %u disp error state %U flags %U",
3492 tc->c_c_index, format_tcp_state, state,
3493 format_tcp_flags, (int) flags);
3498 tcp46_input_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
3499 vlib_frame_t * frame, int is_ip4, u8 is_nolookup)
3501 u32 n_left_from, *from, thread_index = vm->thread_index;
3502 tcp_main_t *tm = vnet_get_tcp_main ();
3503 vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b;
3504 u16 nexts[VLIB_FRAME_SIZE], *next;
3506 tcp_set_time_now (tcp_get_worker (thread_index));
3508 from = vlib_frame_vector_args (frame);
3509 n_left_from = frame->n_vectors;
3510 vlib_get_buffers (vm, from, bufs, n_left_from);
3515 while (n_left_from >= 4)
3517 u32 error0 = TCP_ERROR_NO_LISTENER, error1 = TCP_ERROR_NO_LISTENER;
3518 tcp_connection_t *tc0, *tc1;
3521 vlib_prefetch_buffer_header (b[2], STORE);
3522 CLIB_PREFETCH (b[2]->data, 2 * CLIB_CACHE_LINE_BYTES, LOAD);
3524 vlib_prefetch_buffer_header (b[3], STORE);
3525 CLIB_PREFETCH (b[3]->data, 2 * CLIB_CACHE_LINE_BYTES, LOAD);
3528 next[0] = next[1] = TCP_INPUT_NEXT_DROP;
3530 tc0 = tcp_input_lookup_buffer (b[0], thread_index, &error0, is_ip4,
3532 tc1 = tcp_input_lookup_buffer (b[1], thread_index, &error1, is_ip4,
3535 if (PREDICT_TRUE (!tc0 + !tc1 == 0))
3537 ASSERT (tcp_lookup_is_valid (tc0, tcp_buffer_hdr (b[0])));
3538 ASSERT (tcp_lookup_is_valid (tc1, tcp_buffer_hdr (b[1])));
3540 vnet_buffer (b[0])->tcp.connection_index = tc0->c_c_index;
3541 vnet_buffer (b[1])->tcp.connection_index = tc1->c_c_index;
3543 tcp_input_dispatch_buffer (tm, tc0, b[0], &next[0], &error0);
3544 tcp_input_dispatch_buffer (tm, tc1, b[1], &next[1], &error1);
3548 if (PREDICT_TRUE (tc0 != 0))
3550 ASSERT (tcp_lookup_is_valid (tc0, tcp_buffer_hdr (b[0])));
3551 vnet_buffer (b[0])->tcp.connection_index = tc0->c_c_index;
3552 tcp_input_dispatch_buffer (tm, tc0, b[0], &next[0], &error0);
3555 tcp_input_set_error_next (tm, &next[0], &error0, is_ip4);
3557 if (PREDICT_TRUE (tc1 != 0))
3559 ASSERT (tcp_lookup_is_valid (tc1, tcp_buffer_hdr (b[1])));
3560 vnet_buffer (b[1])->tcp.connection_index = tc1->c_c_index;
3561 tcp_input_dispatch_buffer (tm, tc1, b[1], &next[1], &error1);
3564 tcp_input_set_error_next (tm, &next[1], &error1, is_ip4);
3571 while (n_left_from > 0)
3573 tcp_connection_t *tc0;
3574 u32 error0 = TCP_ERROR_NO_LISTENER;
3576 if (n_left_from > 1)
3578 vlib_prefetch_buffer_header (b[1], STORE);
3579 CLIB_PREFETCH (b[1]->data, 2 * CLIB_CACHE_LINE_BYTES, LOAD);
3582 next[0] = TCP_INPUT_NEXT_DROP;
3583 tc0 = tcp_input_lookup_buffer (b[0], thread_index, &error0, is_ip4,
3585 if (PREDICT_TRUE (tc0 != 0))
3587 ASSERT (tcp_lookup_is_valid (tc0, tcp_buffer_hdr (b[0])));
3588 vnet_buffer (b[0])->tcp.connection_index = tc0->c_c_index;
3589 tcp_input_dispatch_buffer (tm, tc0, b[0], &next[0], &error0);
3592 tcp_input_set_error_next (tm, &next[0], &error0, is_ip4);
3599 if (PREDICT_FALSE (node->flags & VLIB_NODE_FLAG_TRACE))
3600 tcp_input_trace_frame (vm, node, bufs, frame->n_vectors, is_ip4);
3602 vlib_buffer_enqueue_to_next (vm, node, from, nexts, frame->n_vectors);
3603 return frame->n_vectors;
3606 VLIB_NODE_FN (tcp4_input_nolookup_node) (vlib_main_t * vm,
3607 vlib_node_runtime_t * node,
3608 vlib_frame_t * from_frame)
3610 return tcp46_input_inline (vm, node, from_frame, 1 /* is_ip4 */ ,
3611 1 /* is_nolookup */ );
3614 VLIB_NODE_FN (tcp6_input_nolookup_node) (vlib_main_t * vm,
3615 vlib_node_runtime_t * node,
3616 vlib_frame_t * from_frame)
3618 return tcp46_input_inline (vm, node, from_frame, 0 /* is_ip4 */ ,
3619 1 /* is_nolookup */ );
3623 VLIB_REGISTER_NODE (tcp4_input_nolookup_node) =
3625 .name = "tcp4-input-nolookup",
3626 /* Takes a vector of packets. */
3627 .vector_size = sizeof (u32),
3628 .n_errors = TCP_N_ERROR,
3629 .error_strings = tcp_error_strings,
3630 .n_next_nodes = TCP_INPUT_N_NEXT,
3633 #define _(s,n) [TCP_INPUT_NEXT_##s] = n,
3634 foreach_tcp4_input_next
3637 .format_buffer = format_tcp_header,
3638 .format_trace = format_tcp_rx_trace,
3643 VLIB_REGISTER_NODE (tcp6_input_nolookup_node) =
3645 .name = "tcp6-input-nolookup",
3646 /* Takes a vector of packets. */
3647 .vector_size = sizeof (u32),
3648 .n_errors = TCP_N_ERROR,
3649 .error_strings = tcp_error_strings,
3650 .n_next_nodes = TCP_INPUT_N_NEXT,
3653 #define _(s,n) [TCP_INPUT_NEXT_##s] = n,
3654 foreach_tcp6_input_next
3657 .format_buffer = format_tcp_header,
3658 .format_trace = format_tcp_rx_trace,
3662 VLIB_NODE_FN (tcp4_input_node) (vlib_main_t * vm, vlib_node_runtime_t * node,
3663 vlib_frame_t * from_frame)
3665 return tcp46_input_inline (vm, node, from_frame, 1 /* is_ip4 */ ,
3666 0 /* is_nolookup */ );
3669 VLIB_NODE_FN (tcp6_input_node) (vlib_main_t * vm, vlib_node_runtime_t * node,
3670 vlib_frame_t * from_frame)
3672 return tcp46_input_inline (vm, node, from_frame, 0 /* is_ip4 */ ,
3673 0 /* is_nolookup */ );
3677 VLIB_REGISTER_NODE (tcp4_input_node) =
3679 .name = "tcp4-input",
3680 /* Takes a vector of packets. */
3681 .vector_size = sizeof (u32),
3682 .n_errors = TCP_N_ERROR,
3683 .error_strings = tcp_error_strings,
3684 .n_next_nodes = TCP_INPUT_N_NEXT,
3687 #define _(s,n) [TCP_INPUT_NEXT_##s] = n,
3688 foreach_tcp4_input_next
3691 .format_buffer = format_tcp_header,
3692 .format_trace = format_tcp_rx_trace,
3697 VLIB_REGISTER_NODE (tcp6_input_node) =
3699 .name = "tcp6-input",
3700 /* Takes a vector of packets. */
3701 .vector_size = sizeof (u32),
3702 .n_errors = TCP_N_ERROR,
3703 .error_strings = tcp_error_strings,
3704 .n_next_nodes = TCP_INPUT_N_NEXT,
3707 #define _(s,n) [TCP_INPUT_NEXT_##s] = n,
3708 foreach_tcp6_input_next
3711 .format_buffer = format_tcp_header,
3712 .format_trace = format_tcp_rx_trace,
3716 #ifndef CLIB_MARCH_VARIANT
3718 tcp_dispatch_table_init (tcp_main_t * tm)
3721 for (i = 0; i < ARRAY_LEN (tm->dispatch_table); i++)
3722 for (j = 0; j < ARRAY_LEN (tm->dispatch_table[i]); j++)
3724 tm->dispatch_table[i][j].next = TCP_INPUT_NEXT_DROP;
3725 tm->dispatch_table[i][j].error = TCP_ERROR_DISPATCH;
3728 #define _(t,f,n,e) \
3730 tm->dispatch_table[TCP_STATE_##t][f].next = (n); \
3731 tm->dispatch_table[TCP_STATE_##t][f].error = (e); \
3734 /* RFC 793: In LISTEN if RST drop and if ACK return RST */
3735 _(LISTEN, 0, TCP_INPUT_NEXT_DROP, TCP_ERROR_SEGMENT_INVALID);
3736 _(LISTEN, TCP_FLAG_ACK, TCP_INPUT_NEXT_RESET, TCP_ERROR_ACK_INVALID);
3737 _(LISTEN, TCP_FLAG_RST, TCP_INPUT_NEXT_DROP, TCP_ERROR_INVALID_CONNECTION);
3738 _(LISTEN, TCP_FLAG_SYN, TCP_INPUT_NEXT_LISTEN, TCP_ERROR_NONE);
3739 _(LISTEN, TCP_FLAG_SYN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RESET,
3740 TCP_ERROR_ACK_INVALID);
3741 _(LISTEN, TCP_FLAG_SYN | TCP_FLAG_RST, TCP_INPUT_NEXT_DROP,
3742 TCP_ERROR_SEGMENT_INVALID);
3743 _(LISTEN, TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_DROP,
3744 TCP_ERROR_SEGMENT_INVALID);
3745 _(LISTEN, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_DROP,
3746 TCP_ERROR_INVALID_CONNECTION);
3747 _(LISTEN, TCP_FLAG_FIN, TCP_INPUT_NEXT_RESET, TCP_ERROR_SEGMENT_INVALID);
3748 _(LISTEN, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RESET,
3749 TCP_ERROR_SEGMENT_INVALID);
3750 _(LISTEN, TCP_FLAG_FIN | TCP_FLAG_RST, TCP_INPUT_NEXT_DROP,
3751 TCP_ERROR_SEGMENT_INVALID);
3752 _(LISTEN, TCP_FLAG_FIN | TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_DROP,
3754 _(LISTEN, TCP_FLAG_FIN | TCP_FLAG_SYN, TCP_INPUT_NEXT_DROP,
3755 TCP_ERROR_SEGMENT_INVALID);
3756 _(LISTEN, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_ACK, TCP_INPUT_NEXT_DROP,
3757 TCP_ERROR_SEGMENT_INVALID);
3758 _(LISTEN, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_RST, TCP_INPUT_NEXT_DROP,
3759 TCP_ERROR_SEGMENT_INVALID);
3760 _(LISTEN, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK,
3761 TCP_INPUT_NEXT_DROP, TCP_ERROR_SEGMENT_INVALID);
3762 /* ACK for for a SYN-ACK -> tcp-rcv-process. */
3763 _(SYN_RCVD, TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3764 _(SYN_RCVD, TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3765 _(SYN_RCVD, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3767 _(SYN_RCVD, TCP_FLAG_SYN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3768 _(SYN_RCVD, TCP_FLAG_SYN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3770 _(SYN_RCVD, TCP_FLAG_SYN | TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS,
3772 _(SYN_RCVD, TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK,
3773 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3774 _(SYN_RCVD, TCP_FLAG_FIN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3775 _(SYN_RCVD, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3777 _(SYN_RCVD, TCP_FLAG_FIN | TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS,
3779 _(SYN_RCVD, TCP_FLAG_FIN | TCP_FLAG_RST | TCP_FLAG_ACK,
3780 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3781 _(SYN_RCVD, TCP_FLAG_FIN | TCP_FLAG_SYN, TCP_INPUT_NEXT_RCV_PROCESS,
3783 _(SYN_RCVD, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_RST,
3784 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3785 _(SYN_RCVD, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_ACK,
3786 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3787 _(SYN_RCVD, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK,
3788 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3789 _(SYN_RCVD, 0, TCP_INPUT_NEXT_DROP, TCP_ERROR_SEGMENT_INVALID);
3790 /* SYN-ACK for a SYN */
3791 _(SYN_SENT, TCP_FLAG_SYN | TCP_FLAG_ACK, TCP_INPUT_NEXT_SYN_SENT,
3793 _(SYN_SENT, TCP_FLAG_ACK, TCP_INPUT_NEXT_SYN_SENT, TCP_ERROR_NONE);
3794 _(SYN_SENT, TCP_FLAG_RST, TCP_INPUT_NEXT_SYN_SENT, TCP_ERROR_NONE);
3795 _(SYN_SENT, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_SYN_SENT,
3797 _(SYN_SENT, TCP_FLAG_FIN, TCP_INPUT_NEXT_SYN_SENT, TCP_ERROR_NONE);
3798 _(SYN_SENT, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_SYN_SENT,
3800 /* ACK for for established connection -> tcp-established. */
3801 _(ESTABLISHED, TCP_FLAG_ACK, TCP_INPUT_NEXT_ESTABLISHED, TCP_ERROR_NONE);
3802 /* FIN for for established connection -> tcp-established. */
3803 _(ESTABLISHED, TCP_FLAG_FIN, TCP_INPUT_NEXT_ESTABLISHED, TCP_ERROR_NONE);
3804 _(ESTABLISHED, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_ESTABLISHED,
3806 _(ESTABLISHED, TCP_FLAG_FIN | TCP_FLAG_RST, TCP_INPUT_NEXT_ESTABLISHED,
3808 _(ESTABLISHED, TCP_FLAG_FIN | TCP_FLAG_RST | TCP_FLAG_ACK,
3809 TCP_INPUT_NEXT_ESTABLISHED, TCP_ERROR_NONE);
3810 _(ESTABLISHED, TCP_FLAG_FIN | TCP_FLAG_SYN, TCP_INPUT_NEXT_ESTABLISHED,
3812 _(ESTABLISHED, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_ACK,
3813 TCP_INPUT_NEXT_ESTABLISHED, TCP_ERROR_NONE);
3814 _(ESTABLISHED, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_RST,
3815 TCP_INPUT_NEXT_ESTABLISHED, TCP_ERROR_NONE);
3816 _(ESTABLISHED, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK,
3817 TCP_INPUT_NEXT_ESTABLISHED, TCP_ERROR_NONE);
3818 _(ESTABLISHED, TCP_FLAG_RST, TCP_INPUT_NEXT_ESTABLISHED, TCP_ERROR_NONE);
3819 _(ESTABLISHED, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_ESTABLISHED,
3821 _(ESTABLISHED, TCP_FLAG_SYN, TCP_INPUT_NEXT_ESTABLISHED, TCP_ERROR_NONE);
3822 _(ESTABLISHED, TCP_FLAG_SYN | TCP_FLAG_ACK, TCP_INPUT_NEXT_ESTABLISHED,
3824 _(ESTABLISHED, TCP_FLAG_SYN | TCP_FLAG_RST, TCP_INPUT_NEXT_ESTABLISHED,
3826 _(ESTABLISHED, TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK,
3827 TCP_INPUT_NEXT_ESTABLISHED, TCP_ERROR_NONE);
3828 _(ESTABLISHED, 0, TCP_INPUT_NEXT_DROP, TCP_ERROR_SEGMENT_INVALID);
3829 /* ACK or FIN-ACK to our FIN */
3830 _(FIN_WAIT_1, TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3831 _(FIN_WAIT_1, TCP_FLAG_ACK | TCP_FLAG_FIN, TCP_INPUT_NEXT_RCV_PROCESS,
3833 /* FIN in reply to our FIN from the other side */
3834 _(FIN_WAIT_1, 0, TCP_INPUT_NEXT_DROP, TCP_ERROR_SEGMENT_INVALID);
3835 _(FIN_WAIT_1, TCP_FLAG_FIN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3836 _(FIN_WAIT_1, TCP_FLAG_FIN | TCP_FLAG_SYN, TCP_INPUT_NEXT_RCV_PROCESS,
3838 _(FIN_WAIT_1, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_ACK,
3839 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3840 _(FIN_WAIT_1, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_RST,
3841 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3842 _(FIN_WAIT_1, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK,
3843 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3844 _(FIN_WAIT_1, TCP_FLAG_FIN | TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS,
3846 _(FIN_WAIT_1, TCP_FLAG_FIN | TCP_FLAG_RST | TCP_FLAG_ACK,
3847 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3848 _(FIN_WAIT_1, TCP_FLAG_SYN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3849 _(FIN_WAIT_1, TCP_FLAG_SYN | TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS,
3851 _(FIN_WAIT_1, TCP_FLAG_SYN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3853 _(FIN_WAIT_1, TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK,
3854 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3855 _(FIN_WAIT_1, TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3856 _(FIN_WAIT_1, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3858 _(CLOSING, 0, TCP_INPUT_NEXT_DROP, TCP_ERROR_SEGMENT_INVALID);
3859 _(CLOSING, TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3860 _(CLOSING, TCP_FLAG_SYN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3861 _(CLOSING, TCP_FLAG_SYN | TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS,
3863 _(CLOSING, TCP_FLAG_SYN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3865 _(CLOSING, TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK,
3866 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3867 _(CLOSING, TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3868 _(CLOSING, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3870 _(CLOSING, TCP_FLAG_FIN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3871 _(CLOSING, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3873 _(CLOSING, TCP_FLAG_FIN | TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS,
3875 _(CLOSING, TCP_FLAG_FIN | TCP_FLAG_RST | TCP_FLAG_ACK,
3876 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3877 _(CLOSING, TCP_FLAG_FIN | TCP_FLAG_SYN, TCP_INPUT_NEXT_RCV_PROCESS,
3879 _(CLOSING, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_ACK,
3880 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3881 _(CLOSING, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_RST,
3882 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3883 _(CLOSING, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK,
3884 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3885 /* FIN confirming that the peer (app) has closed */
3886 _(FIN_WAIT_2, TCP_FLAG_FIN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3887 _(FIN_WAIT_2, TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3888 _(FIN_WAIT_2, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3890 _(FIN_WAIT_2, TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3891 _(FIN_WAIT_2, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3893 _(CLOSE_WAIT, TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3894 _(CLOSE_WAIT, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3896 _(CLOSE_WAIT, TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3897 _(CLOSE_WAIT, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3899 _(LAST_ACK, 0, TCP_INPUT_NEXT_DROP, TCP_ERROR_SEGMENT_INVALID);
3900 _(LAST_ACK, TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3901 _(LAST_ACK, TCP_FLAG_FIN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3902 _(LAST_ACK, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3904 _(LAST_ACK, TCP_FLAG_FIN | TCP_FLAG_SYN, TCP_INPUT_NEXT_RCV_PROCESS,
3906 _(LAST_ACK, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_ACK,
3907 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3908 _(LAST_ACK, TCP_FLAG_FIN | TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS,
3910 _(LAST_ACK, TCP_FLAG_FIN | TCP_FLAG_RST | TCP_FLAG_ACK,
3911 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3912 _(LAST_ACK, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_RST,
3913 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3914 _(LAST_ACK, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK,
3915 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3916 _(LAST_ACK, TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3917 _(LAST_ACK, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3919 _(LAST_ACK, TCP_FLAG_SYN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3920 _(LAST_ACK, TCP_FLAG_SYN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3922 _(LAST_ACK, TCP_FLAG_SYN | TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS,
3924 _(LAST_ACK, TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK,
3925 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3926 _(TIME_WAIT, TCP_FLAG_SYN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3927 _(TIME_WAIT, TCP_FLAG_FIN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3928 _(TIME_WAIT, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3930 _(TIME_WAIT, TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3931 _(TIME_WAIT, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3933 _(TIME_WAIT, TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3934 /* RFC793 CLOSED: An incoming segment containing a RST is discarded. An
3935 * incoming segment not containing a RST causes a RST to be sent in
3937 _(CLOSED, TCP_FLAG_RST, TCP_INPUT_NEXT_DROP, TCP_ERROR_CONNECTION_CLOSED);
3938 _(CLOSED, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_DROP,
3939 TCP_ERROR_CONNECTION_CLOSED);
3940 _(CLOSED, TCP_FLAG_ACK, TCP_INPUT_NEXT_RESET, TCP_ERROR_NONE);
3941 _(CLOSED, TCP_FLAG_SYN, TCP_INPUT_NEXT_RESET, TCP_ERROR_NONE);
3942 _(CLOSED, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RESET,
3947 static clib_error_t *
3948 tcp_input_init (vlib_main_t * vm)
3950 clib_error_t *error = 0;
3951 tcp_main_t *tm = vnet_get_tcp_main ();
3953 if ((error = vlib_call_init_function (vm, tcp_init)))
3956 /* Initialize dispatch table. */
3957 tcp_dispatch_table_init (tm);
3962 VLIB_INIT_FUNCTION (tcp_input_init);
3964 #endif /* CLIB_MARCH_VARIANT */
3967 * fd.io coding-style-patch-verification: ON
3970 * eval: (c-set-style "gnu")