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/tcp/tcp_packet.h>
18 #include <vnet/tcp/tcp.h>
19 #include <vnet/session/session.h>
22 static char *tcp_error_strings[] = {
23 #define tcp_error(n,s) s,
24 #include <vnet/tcp/tcp_error.def>
28 /* All TCP nodes have the same outgoing arcs */
29 #define foreach_tcp_state_next \
30 _ (DROP4, "ip4-drop") \
31 _ (DROP6, "ip6-drop") \
32 _ (TCP4_OUTPUT, "tcp4-output") \
33 _ (TCP6_OUTPUT, "tcp6-output")
35 typedef enum _tcp_established_next
37 #define _(s,n) TCP_ESTABLISHED_NEXT_##s,
38 foreach_tcp_state_next
40 TCP_ESTABLISHED_N_NEXT,
41 } tcp_established_next_t;
43 typedef enum _tcp_rcv_process_next
45 #define _(s,n) TCP_RCV_PROCESS_NEXT_##s,
46 foreach_tcp_state_next
48 TCP_RCV_PROCESS_N_NEXT,
49 } tcp_rcv_process_next_t;
51 typedef enum _tcp_syn_sent_next
53 #define _(s,n) TCP_SYN_SENT_NEXT_##s,
54 foreach_tcp_state_next
57 } tcp_syn_sent_next_t;
59 typedef enum _tcp_listen_next
61 #define _(s,n) TCP_LISTEN_NEXT_##s,
62 foreach_tcp_state_next
67 /* Generic, state independent indices */
68 typedef enum _tcp_state_next
70 #define _(s,n) TCP_NEXT_##s,
71 foreach_tcp_state_next
76 #define tcp_next_output(is_ip4) (is_ip4 ? TCP_NEXT_TCP4_OUTPUT \
77 : TCP_NEXT_TCP6_OUTPUT)
79 #define tcp_next_drop(is_ip4) (is_ip4 ? TCP_NEXT_DROP4 \
83 * Validate segment sequence number. As per RFC793:
85 * Segment Receive Test
87 * ------- ------- -------------------------------------------
88 * 0 0 SEG.SEQ = RCV.NXT
89 * 0 >0 RCV.NXT =< SEG.SEQ < RCV.NXT+RCV.WND
91 * >0 >0 RCV.NXT =< SEG.SEQ < RCV.NXT+RCV.WND
92 * or RCV.NXT =< SEG.SEQ+SEG.LEN-1 < RCV.NXT+RCV.WND
94 * This ultimately consists in checking if segment falls within the window.
95 * The one important difference compared to RFC793 is that we use rcv_las,
96 * or the rcv_nxt at last ack sent instead of rcv_nxt since that's the
97 * peer's reference when computing our receive window.
100 * seq_leq (end_seq, tc->rcv_las + tc->rcv_wnd) && seq_geq (seq, tc->rcv_las)
101 * however, is too strict when we have retransmits. Instead we just check that
102 * the seq is not beyond the right edge and that the end of the segment is not
103 * less than the left edge.
105 * N.B. rcv_nxt and rcv_wnd are both updated in this node if acks are sent, so
106 * use rcv_nxt in the right edge window test instead of rcv_las.
110 tcp_segment_in_rcv_wnd (tcp_connection_t * tc, u32 seq, u32 end_seq)
112 return (seq_geq (end_seq, tc->rcv_las)
113 && seq_leq (seq, tc->rcv_nxt + tc->rcv_wnd));
117 * Parse TCP header options.
119 * @param th TCP header
120 * @param to TCP options data structure to be populated
121 * @param is_syn set if packet is syn
122 * @return -1 if parsing failed
125 tcp_options_parse (tcp_header_t * th, tcp_options_t * to, u8 is_syn)
128 u8 opt_len, opts_len, kind;
132 opts_len = (tcp_doff (th) << 2) - sizeof (tcp_header_t);
133 data = (const u8 *) (th + 1);
135 /* Zero out all flags but those set in SYN */
136 to->flags &= (TCP_OPTS_FLAG_SACK_PERMITTED | TCP_OPTS_FLAG_WSCALE
137 | TCP_OPTS_FLAG_TSTAMP | TCP_OPTION_MSS);
139 for (; opts_len > 0; opts_len -= opt_len, data += opt_len)
143 /* Get options length */
144 if (kind == TCP_OPTION_EOL)
146 else if (kind == TCP_OPTION_NOOP)
158 /* weird option length */
159 if (opt_len < 2 || opt_len > opts_len)
169 if ((opt_len == TCP_OPTION_LEN_MSS) && tcp_syn (th))
171 to->flags |= TCP_OPTS_FLAG_MSS;
172 to->mss = clib_net_to_host_u16 (*(u16 *) (data + 2));
175 case TCP_OPTION_WINDOW_SCALE:
178 if ((opt_len == TCP_OPTION_LEN_WINDOW_SCALE) && tcp_syn (th))
180 to->flags |= TCP_OPTS_FLAG_WSCALE;
181 to->wscale = data[2];
182 if (to->wscale > TCP_MAX_WND_SCALE)
183 to->wscale = TCP_MAX_WND_SCALE;
186 case TCP_OPTION_TIMESTAMP:
188 to->flags |= TCP_OPTS_FLAG_TSTAMP;
189 if ((to->flags & TCP_OPTS_FLAG_TSTAMP)
190 && opt_len == TCP_OPTION_LEN_TIMESTAMP)
192 to->tsval = clib_net_to_host_u32 (*(u32 *) (data + 2));
193 to->tsecr = clib_net_to_host_u32 (*(u32 *) (data + 6));
196 case TCP_OPTION_SACK_PERMITTED:
199 if (opt_len == TCP_OPTION_LEN_SACK_PERMITTED && tcp_syn (th))
200 to->flags |= TCP_OPTS_FLAG_SACK_PERMITTED;
202 case TCP_OPTION_SACK_BLOCK:
203 /* If SACK permitted was not advertised or a SYN, break */
204 if ((to->flags & TCP_OPTS_FLAG_SACK_PERMITTED) == 0 || tcp_syn (th))
207 /* If too short or not correctly formatted, break */
208 if (opt_len < 10 || ((opt_len - 2) % TCP_OPTION_LEN_SACK_BLOCK))
211 to->flags |= TCP_OPTS_FLAG_SACK;
212 to->n_sack_blocks = (opt_len - 2) / TCP_OPTION_LEN_SACK_BLOCK;
213 vec_reset_length (to->sacks);
214 for (j = 0; j < to->n_sack_blocks; j++)
216 b.start = clib_net_to_host_u32 (*(u32 *) (data + 2 + 8 * j));
217 b.end = clib_net_to_host_u32 (*(u32 *) (data + 6 + 8 * j));
218 vec_add1 (to->sacks, b);
222 /* Nothing to see here */
230 * RFC1323: Check against wrapped sequence numbers (PAWS). If we have
231 * timestamp to echo and it's less than tsval_recent, drop segment
232 * but still send an ACK in order to retain TCP's mechanism for detecting
233 * and recovering from half-open connections
235 * Or at least that's what the theory says. It seems that this might not work
236 * very well with packet reordering and fast retransmit. XXX
239 tcp_segment_check_paws (tcp_connection_t * tc)
241 return tcp_opts_tstamp (&tc->rcv_opts)
242 && timestamp_lt (tc->rcv_opts.tsval, tc->tsval_recent);
246 * Update tsval recent
249 tcp_update_timestamp (tcp_connection_t * tc, u32 seq, u32 seq_end)
252 * RFC1323: If Last.ACK.sent falls within the range of sequence numbers
253 * of an incoming segment:
254 * SEG.SEQ <= Last.ACK.sent < SEG.SEQ + SEG.LEN
255 * then the TSval from the segment is copied to TS.Recent;
256 * otherwise, the TSval is ignored.
258 if (tcp_opts_tstamp (&tc->rcv_opts) && seq_leq (seq, tc->rcv_las)
259 && seq_leq (tc->rcv_las, seq_end))
261 ASSERT (timestamp_leq (tc->tsval_recent, tc->rcv_opts.tsval));
262 tc->tsval_recent = tc->rcv_opts.tsval;
263 tc->tsval_recent_age = tcp_time_now_w_thread (tc->c_thread_index);
268 * Validate incoming segment as per RFC793 p. 69 and RFC1323 p. 19
270 * It first verifies if segment has a wrapped sequence number (PAWS) and then
271 * does the processing associated to the first four steps (ignoring security
272 * and precedence): sequence number, rst bit and syn bit checks.
274 * @return 0 if segments passes validation.
277 tcp_segment_validate (tcp_worker_ctx_t * wrk, tcp_connection_t * tc0,
278 vlib_buffer_t * b0, tcp_header_t * th0, u32 * error0)
280 /* We could get a burst of RSTs interleaved with acks */
281 if (PREDICT_FALSE (tc0->state == TCP_STATE_CLOSED))
283 tcp_send_reset (tc0);
284 *error0 = TCP_ERROR_CONNECTION_CLOSED;
288 if (PREDICT_FALSE (!tcp_ack (th0) && !tcp_rst (th0) && !tcp_syn (th0)))
290 *error0 = TCP_ERROR_SEGMENT_INVALID;
294 if (PREDICT_FALSE (tcp_options_parse (th0, &tc0->rcv_opts, 0)))
296 *error0 = TCP_ERROR_OPTIONS;
300 if (PREDICT_FALSE (tcp_segment_check_paws (tc0)))
302 *error0 = TCP_ERROR_PAWS;
303 TCP_EVT_DBG (TCP_EVT_PAWS_FAIL, tc0, vnet_buffer (b0)->tcp.seq_number,
304 vnet_buffer (b0)->tcp.seq_end);
306 /* If it just so happens that a segment updates tsval_recent for a
307 * segment over 24 days old, invalidate tsval_recent. */
308 if (timestamp_lt (tc0->tsval_recent_age + TCP_PAWS_IDLE,
309 tcp_time_now_w_thread (tc0->c_thread_index)))
311 tc0->tsval_recent = tc0->rcv_opts.tsval;
312 clib_warning ("paws failed: 24-day old segment");
314 /* Drop after ack if not rst. Resets can fail paws check as per
315 * RFC 7323 sec. 5.2: When an <RST> segment is received, it MUST NOT
316 * be subjected to the PAWS check by verifying an acceptable value in
318 else if (!tcp_rst (th0))
320 tcp_program_ack (wrk, tc0);
321 TCP_EVT_DBG (TCP_EVT_DUPACK_SENT, tc0, vnet_buffer (b0)->tcp);
326 /* 1st: check sequence number */
327 if (!tcp_segment_in_rcv_wnd (tc0, vnet_buffer (b0)->tcp.seq_number,
328 vnet_buffer (b0)->tcp.seq_end))
330 /* SYN/SYN-ACK retransmit */
332 && vnet_buffer (b0)->tcp.seq_number == tc0->rcv_nxt - 1)
334 tcp_options_parse (th0, &tc0->rcv_opts, 1);
335 if (tc0->state == TCP_STATE_SYN_RCVD)
337 tcp_send_synack (tc0);
338 TCP_EVT_DBG (TCP_EVT_SYN_RCVD, tc0, 0);
339 *error0 = TCP_ERROR_SYNS_RCVD;
343 tcp_program_ack (wrk, tc0);
344 TCP_EVT_DBG (TCP_EVT_SYNACK_RCVD, tc0);
345 *error0 = TCP_ERROR_SYN_ACKS_RCVD;
350 /* If our window is 0 and the packet is in sequence, let it pass
351 * through for ack processing. It should be dropped later. */
352 if (tc0->rcv_wnd < tc0->snd_mss
353 && tc0->rcv_nxt == vnet_buffer (b0)->tcp.seq_number)
356 /* If we entered recovery and peer did so as well, there's a chance that
357 * dup acks won't be acceptable on either end because seq_end may be less
358 * than rcv_las. This can happen if acks are lost in both directions. */
359 if (tcp_in_recovery (tc0)
360 && seq_geq (vnet_buffer (b0)->tcp.seq_number,
361 tc0->rcv_las - tc0->rcv_wnd)
362 && seq_leq (vnet_buffer (b0)->tcp.seq_end,
363 tc0->rcv_nxt + tc0->rcv_wnd))
366 *error0 = TCP_ERROR_RCV_WND;
368 /* If not RST, send dup ack */
371 tcp_program_dupack (wrk, tc0);
372 TCP_EVT_DBG (TCP_EVT_DUPACK_SENT, tc0, vnet_buffer (b0)->tcp);
380 /* 2nd: check the RST bit */
381 if (PREDICT_FALSE (tcp_rst (th0)))
383 tcp_connection_reset (tc0);
384 *error0 = TCP_ERROR_RST_RCVD;
388 /* 3rd: check security and precedence (skip) */
390 /* 4th: check the SYN bit (in window) */
391 if (PREDICT_FALSE (tcp_syn (th0)))
393 *error0 = TCP_ERROR_SPURIOUS_SYN;
394 tcp_send_reset (tc0);
398 /* If segment in window, save timestamp */
399 tcp_update_timestamp (tc0, vnet_buffer (b0)->tcp.seq_number,
400 vnet_buffer (b0)->tcp.seq_end);
408 tcp_rcv_ack_is_acceptable (tcp_connection_t * tc0, vlib_buffer_t * tb0)
410 /* SND.UNA =< SEG.ACK =< SND.NXT */
411 return (seq_leq (tc0->snd_una, vnet_buffer (tb0)->tcp.ack_number)
412 && seq_leq (vnet_buffer (tb0)->tcp.ack_number, tc0->snd_una_max));
416 * Compute smoothed RTT as per VJ's '88 SIGCOMM and RFC6298
418 * Note that although the original article, srtt and rttvar are scaled
419 * to minimize round-off errors, here we don't. Instead, we rely on
420 * better precision time measurements.
422 * TODO support us rtt resolution
425 tcp_estimate_rtt (tcp_connection_t * tc, u32 mrtt)
431 err = mrtt - tc->srtt;
433 /* XXX Drop in RTT results in RTTVAR increase and bigger RTO.
434 * The increase should be bound */
435 tc->srtt = clib_max ((int) tc->srtt + (err >> 3), 1);
436 diff = (clib_abs (err) - (int) tc->rttvar) >> 2;
437 tc->rttvar = clib_max ((int) tc->rttvar + diff, 1);
441 /* First measurement. */
443 tc->rttvar = mrtt >> 1;
447 #ifndef CLIB_MARCH_VARIANT
449 tcp_update_rto (tcp_connection_t * tc)
451 tc->rto = clib_min (tc->srtt + (tc->rttvar << 2), TCP_RTO_MAX);
452 tc->rto = clib_max (tc->rto, TCP_RTO_MIN);
454 #endif /* CLIB_MARCH_VARIANT */
457 * Update RTT estimate and RTO timer
459 * Measure RTT: We have two sources of RTT measurements: TSOPT and ACK
460 * timing. Middle boxes are known to fiddle with TCP options so we
461 * should give higher priority to ACK timing.
463 * This should be called only if previously sent bytes have been acked.
465 * return 1 if valid rtt 0 otherwise
468 tcp_update_rtt (tcp_connection_t * tc, u32 ack)
472 /* Karn's rule, part 1. Don't use retransmitted segments to estimate
473 * RTT because they're ambiguous. */
474 if (tcp_in_cong_recovery (tc) || tc->sack_sb.sacked_bytes)
476 if (tcp_in_recovery (tc))
481 if (tc->rtt_ts && seq_geq (ack, tc->rtt_seq))
483 f64 sample = tcp_time_now_us (tc->c_thread_index) - tc->rtt_ts;
484 tc->mrtt_us = tc->mrtt_us + (sample - tc->mrtt_us) * 0.125;
485 mrtt = clib_max ((u32) (sample * THZ), 1);
486 /* Allow measuring of a new RTT */
489 /* As per RFC7323 TSecr can be used for RTTM only if the segment advances
490 * snd_una, i.e., the left side of the send window:
491 * seq_lt (tc->snd_una, ack). This is a condition for calling update_rtt */
492 else if (tcp_opts_tstamp (&tc->rcv_opts) && tc->rcv_opts.tsecr)
494 u32 now = tcp_time_now_w_thread (tc->c_thread_index);
495 mrtt = clib_max (now - tc->rcv_opts.tsecr, 1);
498 /* Ignore dubious measurements */
499 if (mrtt == 0 || mrtt > TCP_RTT_MAX)
502 tcp_estimate_rtt (tc, mrtt);
506 /* If we got here something must've been ACKed so make sure boff is 0,
507 * even if mrtt is not valid since we update the rto lower */
515 tcp_estimate_initial_rtt (tcp_connection_t * tc)
517 u8 thread_index = vlib_num_workers ()? 1 : 0;
522 tc->mrtt_us = tcp_time_now_us (thread_index) - tc->rtt_ts;
523 tc->mrtt_us = clib_max (tc->mrtt_us, 0.0001);
524 mrtt = clib_max ((u32) (tc->mrtt_us * THZ), 1);
529 mrtt = tcp_time_now_w_thread (thread_index) - tc->rcv_opts.tsecr;
530 mrtt = clib_max (mrtt, 1);
531 /* Due to retransmits we don't know the initial mrtt */
532 if (tc->rto_boff && mrtt > 1 * THZ)
534 tc->mrtt_us = (f64) mrtt *TCP_TICK;
537 if (mrtt > 0 && mrtt < TCP_RTT_MAX)
538 tcp_estimate_rtt (tc, mrtt);
543 * Dequeue bytes for connections that have received acks in last burst
546 tcp_handle_postponed_dequeues (tcp_worker_ctx_t * wrk)
548 u32 thread_index = wrk->vm->thread_index;
549 u32 *pending_deq_acked;
550 tcp_connection_t *tc;
553 if (!vec_len (wrk->pending_deq_acked))
556 pending_deq_acked = wrk->pending_deq_acked;
557 for (i = 0; i < vec_len (pending_deq_acked); i++)
559 tc = tcp_connection_get (pending_deq_acked[i], thread_index);
560 tc->flags &= ~TCP_CONN_DEQ_PENDING;
562 if (PREDICT_FALSE (!tc->burst_acked))
565 /* Dequeue the newly ACKed bytes */
566 session_tx_fifo_dequeue_drop (&tc->connection, tc->burst_acked);
568 tcp_validate_txf_size (tc, tc->snd_una_max - tc->snd_una);
570 if (PREDICT_FALSE (tc->flags & TCP_CONN_PSH_PENDING))
572 if (seq_leq (tc->psh_seq, tc->snd_una))
573 tc->flags &= ~TCP_CONN_PSH_PENDING;
576 /* If everything has been acked, stop retransmit timer
577 * otherwise update. */
578 tcp_retransmit_timer_update (tc);
580 /* If not congested, update pacer based on our new
582 if (!tcp_in_fastrecovery (tc))
583 tcp_connection_tx_pacer_update (tc);
585 _vec_len (wrk->pending_deq_acked) = 0;
589 tcp_program_dequeue (tcp_worker_ctx_t * wrk, tcp_connection_t * tc)
591 if (!(tc->flags & TCP_CONN_DEQ_PENDING))
593 vec_add1 (wrk->pending_deq_acked, tc->c_c_index);
594 tc->flags |= TCP_CONN_DEQ_PENDING;
596 tc->burst_acked += tc->bytes_acked + tc->sack_sb.snd_una_adv;
600 * Check if duplicate ack as per RFC5681 Sec. 2
603 tcp_ack_is_dupack (tcp_connection_t * tc, vlib_buffer_t * b, u32 prev_snd_wnd,
606 return ((vnet_buffer (b)->tcp.ack_number == prev_snd_una)
607 && seq_gt (tc->snd_nxt, tc->snd_una)
608 && (vnet_buffer (b)->tcp.seq_end == vnet_buffer (b)->tcp.seq_number)
609 && (prev_snd_wnd == tc->snd_wnd));
613 * Checks if ack is a congestion control event.
616 tcp_ack_is_cc_event (tcp_connection_t * tc, vlib_buffer_t * b,
617 u32 prev_snd_wnd, u32 prev_snd_una, u8 * is_dack)
619 /* Check if ack is duplicate. Per RFC 6675, ACKs that SACK new data are
620 * defined to be 'duplicate' */
621 *is_dack = tc->sack_sb.last_sacked_bytes
622 || tcp_ack_is_dupack (tc, b, prev_snd_wnd, prev_snd_una);
624 return ((*is_dack || tcp_in_cong_recovery (tc)) && !tcp_is_lost_fin (tc));
627 #ifndef CLIB_MARCH_VARIANT
629 scoreboard_hole_index (sack_scoreboard_t * sb, sack_scoreboard_hole_t * hole)
631 ASSERT (!pool_is_free_index (sb->holes, hole - sb->holes));
632 return hole - sb->holes;
636 scoreboard_hole_bytes (sack_scoreboard_hole_t * hole)
638 return hole->end - hole->start;
641 sack_scoreboard_hole_t *
642 scoreboard_get_hole (sack_scoreboard_t * sb, u32 index)
644 if (index != TCP_INVALID_SACK_HOLE_INDEX)
645 return pool_elt_at_index (sb->holes, index);
649 sack_scoreboard_hole_t *
650 scoreboard_next_hole (sack_scoreboard_t * sb, sack_scoreboard_hole_t * hole)
652 if (hole->next != TCP_INVALID_SACK_HOLE_INDEX)
653 return pool_elt_at_index (sb->holes, hole->next);
657 sack_scoreboard_hole_t *
658 scoreboard_prev_hole (sack_scoreboard_t * sb, sack_scoreboard_hole_t * hole)
660 if (hole->prev != TCP_INVALID_SACK_HOLE_INDEX)
661 return pool_elt_at_index (sb->holes, hole->prev);
665 sack_scoreboard_hole_t *
666 scoreboard_first_hole (sack_scoreboard_t * sb)
668 if (sb->head != TCP_INVALID_SACK_HOLE_INDEX)
669 return pool_elt_at_index (sb->holes, sb->head);
673 sack_scoreboard_hole_t *
674 scoreboard_last_hole (sack_scoreboard_t * sb)
676 if (sb->tail != TCP_INVALID_SACK_HOLE_INDEX)
677 return pool_elt_at_index (sb->holes, sb->tail);
682 scoreboard_remove_hole (sack_scoreboard_t * sb, sack_scoreboard_hole_t * hole)
684 sack_scoreboard_hole_t *next, *prev;
686 if (hole->next != TCP_INVALID_SACK_HOLE_INDEX)
688 next = pool_elt_at_index (sb->holes, hole->next);
689 next->prev = hole->prev;
693 sb->tail = hole->prev;
696 if (hole->prev != TCP_INVALID_SACK_HOLE_INDEX)
698 prev = pool_elt_at_index (sb->holes, hole->prev);
699 prev->next = hole->next;
703 sb->head = hole->next;
706 if (scoreboard_hole_index (sb, hole) == sb->cur_rxt_hole)
707 sb->cur_rxt_hole = TCP_INVALID_SACK_HOLE_INDEX;
709 /* Poison the entry */
711 clib_memset (hole, 0xfe, sizeof (*hole));
713 pool_put (sb->holes, hole);
716 static sack_scoreboard_hole_t *
717 scoreboard_insert_hole (sack_scoreboard_t * sb, u32 prev_index,
720 sack_scoreboard_hole_t *hole, *next, *prev;
723 pool_get (sb->holes, hole);
724 clib_memset (hole, 0, sizeof (*hole));
728 hole_index = scoreboard_hole_index (sb, hole);
730 prev = scoreboard_get_hole (sb, prev_index);
733 hole->prev = prev_index;
734 hole->next = prev->next;
736 if ((next = scoreboard_next_hole (sb, hole)))
737 next->prev = hole_index;
739 sb->tail = hole_index;
741 prev->next = hole_index;
745 sb->head = hole_index;
746 hole->prev = TCP_INVALID_SACK_HOLE_INDEX;
747 hole->next = TCP_INVALID_SACK_HOLE_INDEX;
752 #endif /* CLIB_MARCH_VARIANT */
754 #ifndef CLIB_MARCH_VARIANT
756 scoreboard_update_bytes (tcp_connection_t * tc, sack_scoreboard_t * sb)
758 sack_scoreboard_hole_t *left, *right;
759 u32 bytes = 0, blks = 0;
762 sb->sacked_bytes = 0;
763 left = scoreboard_last_hole (sb);
767 if (seq_gt (sb->high_sacked, left->end))
769 bytes = sb->high_sacked - left->end;
773 while ((right = left)
774 && bytes < (TCP_DUPACK_THRESHOLD - 1) * tc->snd_mss
775 && blks < TCP_DUPACK_THRESHOLD
776 /* left not updated if above conditions fail */
777 && (left = scoreboard_prev_hole (sb, right)))
779 bytes += right->start - left->end;
783 /* left is first lost */
788 sb->lost_bytes += scoreboard_hole_bytes (right);
790 left = scoreboard_prev_hole (sb, right);
792 bytes += right->start - left->end;
794 while ((right = left));
797 sb->sacked_bytes = bytes;
801 * Figure out the next hole to retransmit
803 * Follows logic proposed in RFC6675 Sec. 4, NextSeg()
805 sack_scoreboard_hole_t *
806 scoreboard_next_rxt_hole (sack_scoreboard_t * sb,
807 sack_scoreboard_hole_t * start,
808 u8 have_unsent, u8 * can_rescue, u8 * snd_limited)
810 sack_scoreboard_hole_t *hole = 0;
812 hole = start ? start : scoreboard_first_hole (sb);
813 while (hole && seq_leq (hole->end, sb->high_rxt) && hole->is_lost)
814 hole = scoreboard_next_hole (sb, hole);
816 /* Nothing, return */
819 sb->cur_rxt_hole = TCP_INVALID_SACK_HOLE_INDEX;
823 /* Rule (1): if higher than rxt, less than high_sacked and lost */
824 if (hole->is_lost && seq_lt (hole->start, sb->high_sacked))
826 sb->cur_rxt_hole = scoreboard_hole_index (sb, hole);
830 /* Rule (2): available unsent data */
833 sb->cur_rxt_hole = TCP_INVALID_SACK_HOLE_INDEX;
836 /* Rule (3): if hole not lost */
837 else if (seq_lt (hole->start, sb->high_sacked))
840 sb->cur_rxt_hole = scoreboard_hole_index (sb, hole);
842 /* Rule (4): if hole beyond high_sacked */
845 ASSERT (seq_geq (hole->start, sb->high_sacked));
848 /* HighRxt MUST NOT be updated */
853 if (hole && seq_lt (sb->high_rxt, hole->start))
854 sb->high_rxt = hole->start;
858 #endif /* CLIB_MARCH_VARIANT */
861 scoreboard_init_high_rxt (sack_scoreboard_t * sb, u32 snd_una)
863 sack_scoreboard_hole_t *hole;
864 hole = scoreboard_first_hole (sb);
867 snd_una = seq_gt (snd_una, hole->start) ? snd_una : hole->start;
868 sb->cur_rxt_hole = sb->head;
870 sb->high_rxt = snd_una;
871 sb->rescue_rxt = snd_una - 1;
874 #ifndef CLIB_MARCH_VARIANT
876 scoreboard_init (sack_scoreboard_t * sb)
878 sb->head = TCP_INVALID_SACK_HOLE_INDEX;
879 sb->tail = TCP_INVALID_SACK_HOLE_INDEX;
880 sb->cur_rxt_hole = TCP_INVALID_SACK_HOLE_INDEX;
884 scoreboard_clear (sack_scoreboard_t * sb)
886 sack_scoreboard_hole_t *hole;
887 while ((hole = scoreboard_first_hole (sb)))
889 scoreboard_remove_hole (sb, hole);
891 ASSERT (sb->head == sb->tail && sb->head == TCP_INVALID_SACK_HOLE_INDEX);
892 ASSERT (pool_elts (sb->holes) == 0);
893 sb->sacked_bytes = 0;
894 sb->last_sacked_bytes = 0;
895 sb->last_bytes_delivered = 0;
900 sb->cur_rxt_hole = TCP_INVALID_SACK_HOLE_INDEX;
902 #endif /* CLIB_MARCH_VARIANT */
905 * Test that scoreboard is sane after recovery
907 * Returns 1 if scoreboard is empty or if first hole beyond
911 tcp_scoreboard_is_sane_post_recovery (tcp_connection_t * tc)
913 sack_scoreboard_hole_t *hole;
914 hole = scoreboard_first_hole (&tc->sack_sb);
915 return (!hole || (seq_geq (hole->start, tc->snd_una)
916 && seq_lt (hole->end, tc->snd_nxt)));
919 #ifndef CLIB_MARCH_VARIANT
921 tcp_rcv_sacks (tcp_connection_t * tc, u32 ack)
923 sack_scoreboard_t *sb = &tc->sack_sb;
924 sack_block_t *blk, tmp;
925 sack_scoreboard_hole_t *hole, *next_hole, *last_hole;
926 u32 blk_index = 0, old_sacked_bytes, hole_index;
929 sb->last_sacked_bytes = 0;
930 sb->last_bytes_delivered = 0;
933 if (!tcp_opts_sack (&tc->rcv_opts)
934 && sb->head == TCP_INVALID_SACK_HOLE_INDEX)
937 old_sacked_bytes = sb->sacked_bytes;
939 /* Remove invalid blocks */
940 blk = tc->rcv_opts.sacks;
941 while (blk < vec_end (tc->rcv_opts.sacks))
943 if (seq_lt (blk->start, blk->end)
944 && seq_gt (blk->start, tc->snd_una)
945 && seq_gt (blk->start, ack)
946 && seq_lt (blk->start, tc->snd_nxt)
947 && seq_leq (blk->end, tc->snd_nxt))
952 vec_del1 (tc->rcv_opts.sacks, blk - tc->rcv_opts.sacks);
955 /* Add block for cumulative ack */
956 if (seq_gt (ack, tc->snd_una))
958 tmp.start = tc->snd_una;
960 vec_add1 (tc->rcv_opts.sacks, tmp);
963 if (vec_len (tc->rcv_opts.sacks) == 0)
966 tcp_scoreboard_trace_add (tc, ack);
968 /* Make sure blocks are ordered */
969 for (i = 0; i < vec_len (tc->rcv_opts.sacks); i++)
970 for (j = i + 1; j < vec_len (tc->rcv_opts.sacks); j++)
971 if (seq_lt (tc->rcv_opts.sacks[j].start, tc->rcv_opts.sacks[i].start))
973 tmp = tc->rcv_opts.sacks[i];
974 tc->rcv_opts.sacks[i] = tc->rcv_opts.sacks[j];
975 tc->rcv_opts.sacks[j] = tmp;
978 if (sb->head == TCP_INVALID_SACK_HOLE_INDEX)
980 /* If no holes, insert the first that covers all outstanding bytes */
981 last_hole = scoreboard_insert_hole (sb, TCP_INVALID_SACK_HOLE_INDEX,
982 tc->snd_una, tc->snd_nxt);
983 sb->tail = scoreboard_hole_index (sb, last_hole);
984 tmp = tc->rcv_opts.sacks[vec_len (tc->rcv_opts.sacks) - 1];
985 sb->high_sacked = tmp.end;
989 /* If we have holes but snd_una_max is beyond the last hole, update
991 tmp = tc->rcv_opts.sacks[vec_len (tc->rcv_opts.sacks) - 1];
992 last_hole = scoreboard_last_hole (sb);
993 if (seq_gt (tc->snd_nxt, last_hole->end))
995 if (seq_geq (last_hole->start, sb->high_sacked))
997 last_hole->end = tc->snd_nxt;
999 /* New hole after high sacked block */
1000 else if (seq_lt (sb->high_sacked, tc->snd_nxt))
1002 scoreboard_insert_hole (sb, sb->tail, sb->high_sacked,
1006 /* Keep track of max byte sacked for when the last hole
1008 if (seq_gt (tmp.end, sb->high_sacked))
1009 sb->high_sacked = tmp.end;
1012 /* Walk the holes with the SACK blocks */
1013 hole = pool_elt_at_index (sb->holes, sb->head);
1014 while (hole && blk_index < vec_len (tc->rcv_opts.sacks))
1016 blk = &tc->rcv_opts.sacks[blk_index];
1017 if (seq_leq (blk->start, hole->start))
1019 /* Block covers hole. Remove hole */
1020 if (seq_geq (blk->end, hole->end))
1022 next_hole = scoreboard_next_hole (sb, hole);
1024 /* Byte accounting: snd_una needs to be advanced */
1025 if (blk->end == ack)
1029 if (seq_lt (ack, next_hole->start))
1030 sb->snd_una_adv = next_hole->start - ack;
1031 sb->last_bytes_delivered +=
1032 next_hole->start - hole->end;
1036 ASSERT (seq_geq (sb->high_sacked, ack));
1037 sb->snd_una_adv = sb->high_sacked - ack;
1038 sb->last_bytes_delivered += sb->high_sacked - hole->end;
1042 scoreboard_remove_hole (sb, hole);
1045 /* Partial 'head' overlap */
1048 if (seq_gt (blk->end, hole->start))
1050 hole->start = blk->end;
1057 /* Hole must be split */
1058 if (seq_lt (blk->end, hole->end))
1060 hole_index = scoreboard_hole_index (sb, hole);
1061 next_hole = scoreboard_insert_hole (sb, hole_index, blk->end,
1064 /* Pool might've moved */
1065 hole = scoreboard_get_hole (sb, hole_index);
1066 hole->end = blk->start;
1068 ASSERT (hole->next == scoreboard_hole_index (sb, next_hole));
1070 else if (seq_lt (blk->start, hole->end))
1072 hole->end = blk->start;
1074 hole = scoreboard_next_hole (sb, hole);
1078 if (pool_elts (sb->holes) == 1)
1080 hole = scoreboard_first_hole (sb);
1081 if (hole->start == ack + sb->snd_una_adv && hole->end == tc->snd_nxt)
1082 scoreboard_remove_hole (sb, hole);
1085 scoreboard_update_bytes (tc, sb);
1086 sb->last_sacked_bytes = sb->sacked_bytes
1087 - (old_sacked_bytes - sb->last_bytes_delivered);
1088 ASSERT (sb->last_sacked_bytes <= sb->sacked_bytes || tcp_in_recovery (tc));
1089 ASSERT (sb->sacked_bytes == 0 || tcp_in_recovery (tc)
1090 || sb->sacked_bytes < tc->snd_nxt - seq_max (tc->snd_una, ack));
1091 ASSERT (sb->last_sacked_bytes + sb->lost_bytes <= tc->snd_nxt
1092 - seq_max (tc->snd_una, ack) || tcp_in_recovery (tc));
1093 ASSERT (sb->head == TCP_INVALID_SACK_HOLE_INDEX || tcp_in_recovery (tc)
1094 || sb->holes[sb->head].start == ack + sb->snd_una_adv);
1095 TCP_EVT_DBG (TCP_EVT_CC_SCOREBOARD, tc);
1097 #endif /* CLIB_MARCH_VARIANT */
1100 * Try to update snd_wnd based on feedback received from peer.
1102 * If successful, and new window is 'effectively' 0, activate persist
1106 tcp_update_snd_wnd (tcp_connection_t * tc, u32 seq, u32 ack, u32 snd_wnd)
1108 /* If (SND.WL1 < SEG.SEQ or (SND.WL1 = SEG.SEQ and SND.WL2 =< SEG.ACK)), set
1109 * SND.WND <- SEG.WND, set SND.WL1 <- SEG.SEQ, and set SND.WL2 <- SEG.ACK */
1110 if (seq_lt (tc->snd_wl1, seq)
1111 || (tc->snd_wl1 == seq && seq_leq (tc->snd_wl2, ack)))
1113 tc->snd_wnd = snd_wnd;
1116 TCP_EVT_DBG (TCP_EVT_SND_WND, tc);
1118 if (PREDICT_FALSE (tc->snd_wnd < tc->snd_mss))
1120 /* Set persist timer if not set and we just got 0 wnd */
1121 if (!tcp_timer_is_active (tc, TCP_TIMER_PERSIST)
1122 && !tcp_timer_is_active (tc, TCP_TIMER_RETRANSMIT))
1123 tcp_persist_timer_set (tc);
1127 tcp_persist_timer_reset (tc);
1128 if (PREDICT_FALSE (!tcp_in_recovery (tc) && tc->rto_boff > 0))
1131 tcp_update_rto (tc);
1137 #ifndef CLIB_MARCH_VARIANT
1139 * Init loss recovery/fast recovery.
1141 * Triggered by dup acks as opposed to timer timeout. Note that cwnd is
1142 * updated in @ref tcp_cc_handle_event after fast retransmit
1145 tcp_cc_init_congestion (tcp_connection_t * tc)
1147 tcp_fastrecovery_on (tc);
1148 tc->snd_congestion = tc->snd_nxt;
1149 tc->cwnd_acc_bytes = 0;
1150 tc->snd_rxt_bytes = 0;
1151 tc->prev_ssthresh = tc->ssthresh;
1152 tc->prev_cwnd = tc->cwnd;
1153 tc->cc_algo->congestion (tc);
1154 TCP_EVT_DBG (TCP_EVT_CC_EVT, tc, 4);
1156 #endif /* CLIB_MARCH_VARIANT */
1159 tcp_cc_recovery_exit (tcp_connection_t * tc)
1162 tcp_update_rto (tc);
1165 tcp_recovery_off (tc);
1166 TCP_EVT_DBG (TCP_EVT_CC_EVT, tc, 3);
1169 #ifndef CLIB_MARCH_VARIANT
1171 tcp_cc_fastrecovery_exit (tcp_connection_t * tc)
1173 tc->cc_algo->recovered (tc);
1174 tc->snd_rxt_bytes = 0;
1175 tc->rcv_dupacks = 0;
1176 tc->snd_rxt_bytes = 0;
1179 tcp_fastrecovery_off (tc);
1180 tcp_fastrecovery_first_off (tc);
1182 TCP_EVT_DBG (TCP_EVT_CC_EVT, tc, 3);
1184 #endif /* CLIB_MARCH_VARIANT */
1187 tcp_cc_congestion_undo (tcp_connection_t * tc)
1189 tc->cwnd = tc->prev_cwnd;
1190 tc->ssthresh = tc->prev_ssthresh;
1191 tc->rcv_dupacks = 0;
1192 if (tcp_in_recovery (tc))
1194 tcp_cc_recovery_exit (tc);
1195 tc->snd_nxt = seq_max (tc->snd_nxt, tc->snd_congestion);
1197 else if (tcp_in_fastrecovery (tc))
1199 tcp_cc_fastrecovery_exit (tc);
1201 ASSERT (tc->rto_boff == 0);
1202 TCP_EVT_DBG (TCP_EVT_CC_EVT, tc, 5);
1206 tcp_cc_is_spurious_timeout_rxt (tcp_connection_t * tc)
1208 return (tcp_in_recovery (tc) && tc->rto_boff == 1
1210 && tcp_opts_tstamp (&tc->rcv_opts)
1211 && timestamp_lt (tc->rcv_opts.tsecr, tc->snd_rxt_ts));
1215 tcp_cc_is_spurious_fast_rxt (tcp_connection_t * tc)
1217 return (tcp_in_fastrecovery (tc)
1218 && tc->cwnd > tc->ssthresh + 3 * tc->snd_mss);
1222 tcp_cc_is_spurious_retransmit (tcp_connection_t * tc)
1224 return (tcp_cc_is_spurious_timeout_rxt (tc)
1225 || tcp_cc_is_spurious_fast_rxt (tc));
1229 tcp_cc_recover (tcp_connection_t * tc)
1231 ASSERT (tcp_in_cong_recovery (tc));
1232 if (tcp_cc_is_spurious_retransmit (tc))
1234 tcp_cc_congestion_undo (tc);
1238 if (tcp_in_recovery (tc))
1239 tcp_cc_recovery_exit (tc);
1240 else if (tcp_in_fastrecovery (tc))
1241 tcp_cc_fastrecovery_exit (tc);
1243 ASSERT (tc->rto_boff == 0);
1244 ASSERT (!tcp_in_cong_recovery (tc));
1245 ASSERT (tcp_scoreboard_is_sane_post_recovery (tc));
1250 tcp_cc_update (tcp_connection_t * tc, vlib_buffer_t * b)
1252 ASSERT (!tcp_in_cong_recovery (tc) || tcp_is_lost_fin (tc));
1254 /* Congestion avoidance */
1255 tcp_cc_rcv_ack (tc);
1257 /* If a cumulative ack, make sure dupacks is 0 */
1258 tc->rcv_dupacks = 0;
1260 /* When dupacks hits the threshold we only enter fast retransmit if
1261 * cumulative ack covers more than snd_congestion. Should snd_una
1262 * wrap this test may fail under otherwise valid circumstances.
1263 * Therefore, proactively update snd_congestion when wrap detected. */
1265 (seq_leq (tc->snd_congestion, tc->snd_una - tc->bytes_acked)
1266 && seq_gt (tc->snd_congestion, tc->snd_una)))
1267 tc->snd_congestion = tc->snd_una - 1;
1271 tcp_should_fastrecover_sack (tcp_connection_t * tc)
1273 return (TCP_DUPACK_THRESHOLD - 1) * tc->snd_mss < tc->sack_sb.sacked_bytes;
1277 tcp_should_fastrecover (tcp_connection_t * tc)
1279 return (tc->rcv_dupacks == TCP_DUPACK_THRESHOLD
1280 || tcp_should_fastrecover_sack (tc));
1283 #ifndef CLIB_MARCH_VARIANT
1285 tcp_program_fastretransmit (tcp_worker_ctx_t * wrk, tcp_connection_t * tc)
1287 if (!(tc->flags & TCP_CONN_FRXT_PENDING))
1289 vec_add1 (wrk->pending_fast_rxt, tc->c_c_index);
1290 tc->flags |= TCP_CONN_FRXT_PENDING;
1295 tcp_do_fastretransmits (tcp_worker_ctx_t * wrk)
1297 u32 *ongoing_fast_rxt, burst_bytes, sent_bytes, thread_index;
1298 u32 max_burst_size, burst_size, n_segs = 0, n_segs_now;
1299 tcp_connection_t *tc;
1303 if (vec_len (wrk->pending_fast_rxt) == 0
1304 && vec_len (wrk->postponed_fast_rxt) == 0)
1307 thread_index = wrk->vm->thread_index;
1308 last_cpu_time = wrk->vm->clib_time.last_cpu_time;
1309 ongoing_fast_rxt = wrk->ongoing_fast_rxt;
1310 vec_append (ongoing_fast_rxt, wrk->postponed_fast_rxt);
1311 vec_append (ongoing_fast_rxt, wrk->pending_fast_rxt);
1313 _vec_len (wrk->postponed_fast_rxt) = 0;
1314 _vec_len (wrk->pending_fast_rxt) = 0;
1316 max_burst_size = VLIB_FRAME_SIZE / vec_len (ongoing_fast_rxt);
1317 max_burst_size = clib_max (max_burst_size, 1);
1319 for (i = 0; i < vec_len (ongoing_fast_rxt); i++)
1321 tc = tcp_connection_get (ongoing_fast_rxt[i], thread_index);
1322 if (!tcp_in_fastrecovery (tc))
1324 tc->flags &= ~TCP_CONN_FRXT_PENDING;
1328 if (n_segs >= VLIB_FRAME_SIZE)
1330 vec_add1 (wrk->postponed_fast_rxt, ongoing_fast_rxt[i]);
1334 tc->flags &= ~TCP_CONN_FRXT_PENDING;
1335 burst_size = clib_min (max_burst_size, VLIB_FRAME_SIZE - n_segs);
1336 burst_bytes = transport_connection_tx_pacer_burst (&tc->connection,
1338 burst_size = clib_min (burst_size, burst_bytes / tc->snd_mss);
1341 tcp_program_fastretransmit (wrk, tc);
1345 n_segs_now = tcp_fast_retransmit (wrk, tc, burst_size);
1346 sent_bytes = clib_min (n_segs_now * tc->snd_mss, burst_bytes);
1347 transport_connection_tx_pacer_update_bytes (&tc->connection,
1349 n_segs += n_segs_now;
1351 _vec_len (ongoing_fast_rxt) = 0;
1352 wrk->ongoing_fast_rxt = ongoing_fast_rxt;
1354 #endif /* CLIB_MARCH_VARIANT */
1357 * One function to rule them all ... and in the darkness bind them
1360 tcp_cc_handle_event (tcp_connection_t * tc, u32 is_dack)
1364 if (tcp_in_fastrecovery (tc) && tcp_opts_sack_permitted (&tc->rcv_opts))
1366 if (tc->bytes_acked)
1368 tcp_program_fastretransmit (tcp_get_worker (tc->c_thread_index), tc);
1372 * Duplicate ACK. Check if we should enter fast recovery, or if already in
1373 * it account for the bytes that left the network.
1375 else if (is_dack && !tcp_in_recovery (tc))
1377 TCP_EVT_DBG (TCP_EVT_DUPACK_RCVD, tc, 1);
1378 ASSERT (tc->snd_una != tc->snd_nxt || tc->sack_sb.last_sacked_bytes);
1382 /* Pure duplicate ack. If some data got acked, it's handled lower */
1383 if (tc->rcv_dupacks > TCP_DUPACK_THRESHOLD && !tc->bytes_acked)
1385 ASSERT (tcp_in_fastrecovery (tc));
1386 tc->cc_algo->rcv_cong_ack (tc, TCP_CC_DUPACK);
1389 else if (tcp_should_fastrecover (tc))
1393 ASSERT (!tcp_in_fastrecovery (tc));
1395 /* Heuristic to catch potential late dupacks
1396 * after fast retransmit exits */
1397 if (is_dack && tc->snd_una == tc->snd_congestion
1398 && timestamp_leq (tc->rcv_opts.tsecr, tc->tsecr_last_ack))
1400 tc->rcv_dupacks = 0;
1404 tcp_cc_init_congestion (tc);
1405 tc->cc_algo->rcv_cong_ack (tc, TCP_CC_DUPACK);
1407 if (tcp_opts_sack_permitted (&tc->rcv_opts))
1409 tc->cwnd = tc->ssthresh;
1410 scoreboard_init_high_rxt (&tc->sack_sb, tc->snd_una);
1414 /* Post retransmit update cwnd to ssthresh and account for the
1415 * three segments that have left the network and should've been
1416 * buffered at the receiver XXX */
1417 tc->cwnd = tc->ssthresh + 3 * tc->snd_mss;
1420 /* Constrain rate until we get a partial ack */
1421 pacer_wnd = clib_max (0.1 * tc->cwnd, 2 * tc->snd_mss);
1422 tcp_connection_tx_pacer_reset (tc, pacer_wnd,
1423 0 /* start bucket */ );
1424 tcp_program_fastretransmit (tcp_get_worker (tc->c_thread_index),
1428 else if (!tc->bytes_acked
1429 || (tc->bytes_acked && !tcp_in_cong_recovery (tc)))
1431 tc->cc_algo->rcv_cong_ack (tc, TCP_CC_DUPACK);
1437 /* Don't allow entry in fast recovery if still in recovery, for now */
1438 else if (0 && is_dack && tcp_in_recovery (tc))
1440 /* If of of the two conditions lower hold, reset dupacks because
1441 * we're probably after timeout (RFC6582 heuristics).
1442 * If Cumulative ack does not cover more than congestion threshold,
1444 * 1) The following doesn't hold: The congestion window is greater
1445 * than SMSS bytes and the difference between highest_ack
1446 * and prev_highest_ack is at most 4*SMSS bytes
1447 * 2) Echoed timestamp in the last non-dup ack does not equal the
1450 if (seq_leq (tc->snd_una, tc->snd_congestion)
1451 && ((!(tc->cwnd > tc->snd_mss
1452 && tc->bytes_acked <= 4 * tc->snd_mss))
1453 || (tc->rcv_opts.tsecr != tc->tsecr_last_ack)))
1455 tc->rcv_dupacks = 0;
1460 if (!tc->bytes_acked)
1464 TCP_EVT_DBG (TCP_EVT_CC_PACK, tc);
1467 * Legitimate ACK. 1) See if we can exit recovery
1470 /* Update the pacing rate. For the first partial ack we move from
1471 * the artificially constrained rate to the one after congestion */
1472 tcp_connection_tx_pacer_update (tc);
1474 if (seq_geq (tc->snd_una, tc->snd_congestion))
1476 tcp_retransmit_timer_update (tc);
1478 /* If spurious return, we've already updated everything */
1479 if (tcp_cc_recover (tc))
1481 tc->tsecr_last_ack = tc->rcv_opts.tsecr;
1485 /* Treat as congestion avoidance ack */
1486 tcp_cc_rcv_ack (tc);
1491 * Legitimate ACK. 2) If PARTIAL ACK try to retransmit
1494 /* XXX limit this only to first partial ack? */
1495 tcp_retransmit_timer_update (tc);
1497 /* RFC6675: If the incoming ACK is a cumulative acknowledgment,
1498 * reset dupacks to 0. Also needed if in congestion recovery */
1499 tc->rcv_dupacks = 0;
1501 /* Post RTO timeout don't try anything fancy */
1502 if (tcp_in_recovery (tc))
1504 tcp_cc_rcv_ack (tc);
1505 transport_add_tx_event (&tc->connection);
1509 /* Remove retransmitted bytes that have been delivered */
1510 if (tcp_opts_sack_permitted (&tc->rcv_opts))
1512 ASSERT (tc->bytes_acked + tc->sack_sb.snd_una_adv
1513 >= tc->sack_sb.last_bytes_delivered
1514 || (tc->flags & TCP_CONN_FINSNT));
1516 /* If we have sacks and we haven't gotten an ack beyond high_rxt,
1517 * remove sacked bytes delivered */
1518 if (seq_lt (tc->snd_una, tc->sack_sb.high_rxt))
1520 rxt_delivered = tc->bytes_acked + tc->sack_sb.snd_una_adv
1521 - tc->sack_sb.last_bytes_delivered;
1522 ASSERT (tc->snd_rxt_bytes >= rxt_delivered);
1523 tc->snd_rxt_bytes -= rxt_delivered;
1527 /* Apparently all retransmitted holes have been acked */
1528 tc->snd_rxt_bytes = 0;
1529 tc->sack_sb.high_rxt = tc->snd_una;
1534 tcp_fastrecovery_first_on (tc);
1535 /* Reuse last bytes delivered to track total bytes acked */
1536 tc->sack_sb.last_bytes_delivered += tc->bytes_acked;
1537 if (tc->snd_rxt_bytes > tc->bytes_acked)
1538 tc->snd_rxt_bytes -= tc->bytes_acked;
1540 tc->snd_rxt_bytes = 0;
1543 tc->cc_algo->rcv_cong_ack (tc, TCP_CC_PARTIALACK);
1546 * Since this was a partial ack, try to retransmit some more data
1548 tcp_program_fastretransmit (tcp_get_worker (tc->c_thread_index), tc);
1552 * Process incoming ACK
1555 tcp_rcv_ack (tcp_worker_ctx_t * wrk, tcp_connection_t * tc, vlib_buffer_t * b,
1556 tcp_header_t * th, u32 * error)
1558 u32 prev_snd_wnd, prev_snd_una;
1561 TCP_EVT_DBG (TCP_EVT_CC_STAT, tc);
1563 /* If the ACK acks something not yet sent (SEG.ACK > SND.NXT) */
1564 if (PREDICT_FALSE (seq_gt (vnet_buffer (b)->tcp.ack_number, tc->snd_nxt)))
1566 /* We've probably entered recovery and the peer still has some
1567 * of the data we've sent. Update snd_nxt and accept the ack */
1568 if (seq_leq (vnet_buffer (b)->tcp.ack_number, tc->snd_una_max))
1570 tc->snd_nxt = vnet_buffer (b)->tcp.ack_number;
1574 *error = TCP_ERROR_ACK_FUTURE;
1575 TCP_EVT_DBG (TCP_EVT_ACK_RCV_ERR, tc, 0,
1576 vnet_buffer (b)->tcp.ack_number);
1580 /* If old ACK, probably it's an old dupack */
1581 if (PREDICT_FALSE (seq_lt (vnet_buffer (b)->tcp.ack_number, tc->snd_una)))
1583 *error = TCP_ERROR_ACK_OLD;
1584 TCP_EVT_DBG (TCP_EVT_ACK_RCV_ERR, tc, 1,
1585 vnet_buffer (b)->tcp.ack_number);
1586 if (tcp_in_fastrecovery (tc) && tc->rcv_dupacks == TCP_DUPACK_THRESHOLD)
1587 tcp_cc_handle_event (tc, 1);
1588 /* Don't drop yet */
1595 * Looks okay, process feedback
1597 if (tcp_opts_sack_permitted (&tc->rcv_opts))
1598 tcp_rcv_sacks (tc, vnet_buffer (b)->tcp.ack_number);
1600 prev_snd_wnd = tc->snd_wnd;
1601 prev_snd_una = tc->snd_una;
1602 tcp_update_snd_wnd (tc, vnet_buffer (b)->tcp.seq_number,
1603 vnet_buffer (b)->tcp.ack_number,
1604 clib_net_to_host_u16 (th->window) << tc->snd_wscale);
1605 tc->bytes_acked = vnet_buffer (b)->tcp.ack_number - tc->snd_una;
1606 tc->snd_una = vnet_buffer (b)->tcp.ack_number + tc->sack_sb.snd_una_adv;
1607 tcp_validate_txf_size (tc, tc->bytes_acked);
1609 if (tc->bytes_acked)
1611 tcp_program_dequeue (wrk, tc);
1612 tcp_update_rtt (tc, vnet_buffer (b)->tcp.ack_number);
1615 TCP_EVT_DBG (TCP_EVT_ACK_RCVD, tc);
1618 * Check if we have congestion event
1621 if (tcp_ack_is_cc_event (tc, b, prev_snd_wnd, prev_snd_una, &is_dack))
1623 tcp_cc_handle_event (tc, is_dack);
1624 if (!tcp_in_cong_recovery (tc))
1626 *error = TCP_ERROR_ACK_OK;
1629 *error = TCP_ERROR_ACK_DUP;
1630 if (vnet_buffer (b)->tcp.data_len || tcp_is_fin (th))
1636 * Update congestion control (slow start/congestion avoidance)
1638 tcp_cc_update (tc, b);
1639 *error = TCP_ERROR_ACK_OK;
1644 tcp_program_disconnect (tcp_worker_ctx_t * wrk, tcp_connection_t * tc)
1646 if (!tcp_disconnect_pending (tc))
1648 vec_add1 (wrk->pending_disconnects, tc->c_c_index);
1649 tcp_disconnect_pending_on (tc);
1654 tcp_handle_disconnects (tcp_worker_ctx_t * wrk)
1656 u32 thread_index, *pending_disconnects;
1657 tcp_connection_t *tc;
1660 if (!vec_len (wrk->pending_disconnects))
1663 thread_index = wrk->vm->thread_index;
1664 pending_disconnects = wrk->pending_disconnects;
1665 for (i = 0; i < vec_len (pending_disconnects); i++)
1667 tc = tcp_connection_get (pending_disconnects[i], thread_index);
1668 tcp_disconnect_pending_off (tc);
1669 session_transport_closing_notify (&tc->connection);
1671 _vec_len (wrk->pending_disconnects) = 0;
1675 tcp_rcv_fin (tcp_worker_ctx_t * wrk, tcp_connection_t * tc, vlib_buffer_t * b,
1678 /* Account for the FIN and send ack */
1680 tcp_program_ack (wrk, tc);
1681 /* Enter CLOSE-WAIT and notify session. To avoid lingering
1682 * in CLOSE-WAIT, set timer (reuse WAITCLOSE). */
1683 tcp_connection_set_state (tc, TCP_STATE_CLOSE_WAIT);
1684 tcp_program_disconnect (wrk, tc);
1685 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_CLOSEWAIT_TIME);
1686 TCP_EVT_DBG (TCP_EVT_FIN_RCVD, tc);
1687 *error = TCP_ERROR_FIN_RCVD;
1690 #ifndef CLIB_MARCH_VARIANT
1692 tcp_sack_vector_is_sane (sack_block_t * sacks)
1695 for (i = 1; i < vec_len (sacks); i++)
1697 if (sacks[i - 1].end == sacks[i].start)
1704 * Build SACK list as per RFC2018.
1706 * Makes sure the first block contains the segment that generated the current
1707 * ACK and the following ones are the ones most recently reported in SACK
1710 * @param tc TCP connection for which the SACK list is updated
1711 * @param start Start sequence number of the newest SACK block
1712 * @param end End sequence of the newest SACK block
1715 tcp_update_sack_list (tcp_connection_t * tc, u32 start, u32 end)
1717 sack_block_t *new_list = tc->snd_sacks_fl, *block = 0;
1720 /* If the first segment is ooo add it to the list. Last write might've moved
1721 * rcv_nxt over the first segment. */
1722 if (seq_lt (tc->rcv_nxt, start))
1724 vec_add2 (new_list, block, 1);
1725 block->start = start;
1729 /* Find the blocks still worth keeping. */
1730 for (i = 0; i < vec_len (tc->snd_sacks); i++)
1732 /* Discard if rcv_nxt advanced beyond current block */
1733 if (seq_leq (tc->snd_sacks[i].start, tc->rcv_nxt))
1736 /* Merge or drop if segment overlapped by the new segment */
1737 if (block && (seq_geq (tc->snd_sacks[i].end, new_list[0].start)
1738 && seq_leq (tc->snd_sacks[i].start, new_list[0].end)))
1740 if (seq_lt (tc->snd_sacks[i].start, new_list[0].start))
1741 new_list[0].start = tc->snd_sacks[i].start;
1742 if (seq_lt (new_list[0].end, tc->snd_sacks[i].end))
1743 new_list[0].end = tc->snd_sacks[i].end;
1747 /* Save to new SACK list if we have space. */
1748 if (vec_len (new_list) < TCP_MAX_SACK_BLOCKS)
1749 vec_add1 (new_list, tc->snd_sacks[i]);
1752 ASSERT (vec_len (new_list) <= TCP_MAX_SACK_BLOCKS);
1754 /* Replace old vector with new one */
1755 vec_reset_length (tc->snd_sacks);
1756 tc->snd_sacks_fl = tc->snd_sacks;
1757 tc->snd_sacks = new_list;
1759 /* Segments should not 'touch' */
1760 ASSERT (tcp_sack_vector_is_sane (tc->snd_sacks));
1764 tcp_sack_list_bytes (tcp_connection_t * tc)
1767 for (i = 0; i < vec_len (tc->snd_sacks); i++)
1768 bytes += tc->snd_sacks[i].end - tc->snd_sacks[i].start;
1771 #endif /* CLIB_MARCH_VARIANT */
1773 /** Enqueue data for delivery to application */
1775 tcp_session_enqueue_data (tcp_connection_t * tc, vlib_buffer_t * b,
1778 int written, error = TCP_ERROR_ENQUEUED;
1780 ASSERT (seq_geq (vnet_buffer (b)->tcp.seq_number, tc->rcv_nxt));
1782 written = session_enqueue_stream_connection (&tc->connection, b, 0,
1783 1 /* queue event */ , 1);
1785 TCP_EVT_DBG (TCP_EVT_INPUT, tc, 0, data_len, written);
1787 /* Update rcv_nxt */
1788 if (PREDICT_TRUE (written == data_len))
1790 tc->rcv_nxt += written;
1792 /* If more data written than expected, account for out-of-order bytes. */
1793 else if (written > data_len)
1795 tc->rcv_nxt += written;
1796 TCP_EVT_DBG (TCP_EVT_CC_INPUT, tc, data_len, written);
1798 else if (written > 0)
1800 /* We've written something but FIFO is probably full now */
1801 tc->rcv_nxt += written;
1802 error = TCP_ERROR_PARTIALLY_ENQUEUED;
1806 return TCP_ERROR_FIFO_FULL;
1809 /* Update SACK list if need be */
1810 if (tcp_opts_sack_permitted (&tc->rcv_opts))
1812 /* Remove SACK blocks that have been delivered */
1813 tcp_update_sack_list (tc, tc->rcv_nxt, tc->rcv_nxt);
1819 /** Enqueue out-of-order data */
1821 tcp_session_enqueue_ooo (tcp_connection_t * tc, vlib_buffer_t * b,
1827 ASSERT (seq_gt (vnet_buffer (b)->tcp.seq_number, tc->rcv_nxt));
1830 /* Enqueue out-of-order data with relative offset */
1831 rv = session_enqueue_stream_connection (&tc->connection, b,
1832 vnet_buffer (b)->tcp.seq_number -
1833 tc->rcv_nxt, 0 /* queue event */ ,
1836 /* Nothing written */
1839 TCP_EVT_DBG (TCP_EVT_INPUT, tc, 1, data_len, 0);
1840 return TCP_ERROR_FIFO_FULL;
1843 TCP_EVT_DBG (TCP_EVT_INPUT, tc, 1, data_len, data_len);
1845 /* Update SACK list if in use */
1846 if (tcp_opts_sack_permitted (&tc->rcv_opts))
1848 ooo_segment_t *newest;
1851 s0 = session_get (tc->c_s_index, tc->c_thread_index);
1853 /* Get the newest segment from the fifo */
1854 newest = svm_fifo_newest_ooo_segment (s0->rx_fifo);
1857 offset = ooo_segment_offset (s0->rx_fifo, newest);
1858 ASSERT (offset <= vnet_buffer (b)->tcp.seq_number - tc->rcv_nxt);
1859 start = tc->rcv_nxt + offset;
1860 end = start + ooo_segment_length (s0->rx_fifo, newest);
1861 tcp_update_sack_list (tc, start, end);
1862 svm_fifo_newest_ooo_segment_reset (s0->rx_fifo);
1863 TCP_EVT_DBG (TCP_EVT_CC_SACKS, tc);
1867 return TCP_ERROR_ENQUEUED_OOO;
1871 * Check if ACK could be delayed. If ack can be delayed, it should return
1872 * true for a full frame. If we're always acking return 0.
1875 tcp_can_delack (tcp_connection_t * tc)
1877 /* Send ack if ... */
1879 /* just sent a rcv wnd 0 */
1880 || (tc->flags & TCP_CONN_SENT_RCV_WND0) != 0
1881 /* constrained to send ack */
1882 || (tc->flags & TCP_CONN_SNDACK) != 0
1883 /* we're almost out of tx wnd */
1884 || tcp_available_cc_snd_space (tc) < 4 * tc->snd_mss)
1891 tcp_buffer_discard_bytes (vlib_buffer_t * b, u32 n_bytes_to_drop)
1893 u32 discard, first = b->current_length;
1894 vlib_main_t *vm = vlib_get_main ();
1896 /* Handle multi-buffer segments */
1897 if (n_bytes_to_drop > b->current_length)
1899 if (!(b->flags & VLIB_BUFFER_NEXT_PRESENT))
1903 discard = clib_min (n_bytes_to_drop, b->current_length);
1904 vlib_buffer_advance (b, discard);
1905 b = vlib_get_buffer (vm, b->next_buffer);
1906 n_bytes_to_drop -= discard;
1908 while (n_bytes_to_drop);
1909 if (n_bytes_to_drop > first)
1910 b->total_length_not_including_first_buffer -= n_bytes_to_drop - first;
1913 vlib_buffer_advance (b, n_bytes_to_drop);
1914 vnet_buffer (b)->tcp.data_len -= n_bytes_to_drop;
1919 * Receive buffer for connection and handle acks
1921 * It handles both in order or out-of-order data.
1924 tcp_segment_rcv (tcp_worker_ctx_t * wrk, tcp_connection_t * tc,
1927 u32 error, n_bytes_to_drop, n_data_bytes;
1929 vlib_buffer_advance (b, vnet_buffer (b)->tcp.data_offset);
1930 n_data_bytes = vnet_buffer (b)->tcp.data_len;
1931 ASSERT (n_data_bytes);
1933 /* Handle out-of-order data */
1934 if (PREDICT_FALSE (vnet_buffer (b)->tcp.seq_number != tc->rcv_nxt))
1936 /* Old sequence numbers allowed through because they overlapped
1938 if (seq_lt (vnet_buffer (b)->tcp.seq_number, tc->rcv_nxt))
1940 /* Completely in the past (possible retransmit). Ack
1941 * retransmissions since we may not have any data to send */
1942 if (seq_leq (vnet_buffer (b)->tcp.seq_end, tc->rcv_nxt))
1944 tcp_program_ack (wrk, tc);
1945 error = TCP_ERROR_SEGMENT_OLD;
1949 /* Chop off the bytes in the past and see if what is left
1950 * can be enqueued in order */
1951 n_bytes_to_drop = tc->rcv_nxt - vnet_buffer (b)->tcp.seq_number;
1952 n_data_bytes -= n_bytes_to_drop;
1953 vnet_buffer (b)->tcp.seq_number = tc->rcv_nxt;
1954 if (tcp_buffer_discard_bytes (b, n_bytes_to_drop))
1956 error = TCP_ERROR_SEGMENT_OLD;
1962 /* RFC2581: Enqueue and send DUPACK for fast retransmit */
1963 error = tcp_session_enqueue_ooo (tc, b, n_data_bytes);
1964 tcp_program_dupack (wrk, tc);
1965 TCP_EVT_DBG (TCP_EVT_DUPACK_SENT, tc, vnet_buffer (b)->tcp);
1971 /* In order data, enqueue. Fifo figures out by itself if any out-of-order
1972 * segments can be enqueued after fifo tail offset changes. */
1973 error = tcp_session_enqueue_data (tc, b, n_data_bytes);
1974 if (tcp_can_delack (tc))
1976 if (!tcp_timer_is_active (tc, TCP_TIMER_DELACK))
1977 tcp_timer_set (tc, TCP_TIMER_DELACK, TCP_DELACK_TIME);
1981 tcp_program_ack (wrk, tc);
1989 tcp_header_t tcp_header;
1990 tcp_connection_t tcp_connection;
1994 format_tcp_rx_trace (u8 * s, va_list * args)
1996 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
1997 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
1998 tcp_rx_trace_t *t = va_arg (*args, tcp_rx_trace_t *);
1999 u32 indent = format_get_indent (s);
2001 s = format (s, "%U\n%U%U",
2002 format_tcp_header, &t->tcp_header, 128,
2003 format_white_space, indent,
2004 format_tcp_connection, &t->tcp_connection, 1);
2010 format_tcp_rx_trace_short (u8 * s, va_list * args)
2012 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
2013 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
2014 tcp_rx_trace_t *t = va_arg (*args, tcp_rx_trace_t *);
2016 s = format (s, "%d -> %d (%U)",
2017 clib_net_to_host_u16 (t->tcp_header.dst_port),
2018 clib_net_to_host_u16 (t->tcp_header.src_port), format_tcp_state,
2019 t->tcp_connection.state);
2025 tcp_set_rx_trace_data (tcp_rx_trace_t * t0, tcp_connection_t * tc0,
2026 tcp_header_t * th0, vlib_buffer_t * b0, u8 is_ip4)
2030 clib_memcpy_fast (&t0->tcp_connection, tc0,
2031 sizeof (t0->tcp_connection));
2035 th0 = tcp_buffer_hdr (b0);
2037 clib_memcpy_fast (&t0->tcp_header, th0, sizeof (t0->tcp_header));
2041 tcp_established_trace_frame (vlib_main_t * vm, vlib_node_runtime_t * node,
2042 vlib_frame_t * frame, u8 is_ip4)
2046 n_left = frame->n_vectors;
2047 from = vlib_frame_vector_args (frame);
2051 tcp_connection_t *tc0;
2058 b0 = vlib_get_buffer (vm, bi0);
2060 if (b0->flags & VLIB_BUFFER_IS_TRACED)
2062 t0 = vlib_add_trace (vm, node, b0, sizeof (*t0));
2063 tc0 = tcp_connection_get (vnet_buffer (b0)->tcp.connection_index,
2065 th0 = tcp_buffer_hdr (b0);
2066 tcp_set_rx_trace_data (t0, tc0, th0, b0, is_ip4);
2075 tcp_node_inc_counter_i (vlib_main_t * vm, u32 tcp4_node, u32 tcp6_node,
2076 u8 is_ip4, u32 evt, u32 val)
2079 vlib_node_increment_counter (vm, tcp4_node, evt, val);
2081 vlib_node_increment_counter (vm, tcp6_node, evt, val);
2084 #define tcp_maybe_inc_counter(node_id, err, count) \
2086 if (next0 != tcp_next_drop (is_ip4)) \
2087 tcp_node_inc_counter_i (vm, tcp4_##node_id##_node.index, \
2088 tcp6_##node_id##_node.index, is_ip4, err, \
2091 #define tcp_inc_counter(node_id, err, count) \
2092 tcp_node_inc_counter_i (vm, tcp4_##node_id##_node.index, \
2093 tcp6_##node_id##_node.index, is_ip4, \
2095 #define tcp_maybe_inc_err_counter(cnts, err) \
2097 cnts[err] += (next0 != tcp_next_drop (is_ip4)); \
2099 #define tcp_inc_err_counter(cnts, err, val) \
2103 #define tcp_store_err_counters(node_id, cnts) \
2106 for (i = 0; i < TCP_N_ERROR; i++) \
2108 tcp_inc_counter(node_id, i, cnts[i]); \
2113 tcp46_established_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
2114 vlib_frame_t * frame, int is_ip4)
2116 u32 thread_index = vm->thread_index, errors = 0;
2117 tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
2118 u32 n_left_from, *from, *first_buffer;
2119 u16 err_counters[TCP_N_ERROR] = { 0 };
2121 if (node->flags & VLIB_NODE_FLAG_TRACE)
2122 tcp_established_trace_frame (vm, node, frame, is_ip4);
2124 first_buffer = from = vlib_frame_vector_args (frame);
2125 n_left_from = frame->n_vectors;
2127 while (n_left_from > 0)
2129 u32 bi0, error0 = TCP_ERROR_ACK_OK;
2132 tcp_connection_t *tc0;
2134 if (n_left_from > 1)
2137 pb = vlib_get_buffer (vm, from[1]);
2138 vlib_prefetch_buffer_header (pb, LOAD);
2139 CLIB_PREFETCH (pb->data, 2 * CLIB_CACHE_LINE_BYTES, LOAD);
2146 b0 = vlib_get_buffer (vm, bi0);
2147 tc0 = tcp_connection_get (vnet_buffer (b0)->tcp.connection_index,
2150 if (PREDICT_FALSE (tc0 == 0))
2152 error0 = TCP_ERROR_INVALID_CONNECTION;
2156 th0 = tcp_buffer_hdr (b0);
2158 /* TODO header prediction fast path */
2160 /* 1-4: check SEQ, RST, SYN */
2161 if (PREDICT_FALSE (tcp_segment_validate (wrk, tc0, b0, th0, &error0)))
2163 TCP_EVT_DBG (TCP_EVT_SEG_INVALID, tc0, vnet_buffer (b0)->tcp);
2167 /* 5: check the ACK field */
2168 if (PREDICT_FALSE (tcp_rcv_ack (wrk, tc0, b0, th0, &error0)))
2171 /* 6: check the URG bit TODO */
2173 /* 7: process the segment text */
2174 if (vnet_buffer (b0)->tcp.data_len)
2175 error0 = tcp_segment_rcv (wrk, tc0, b0);
2177 /* 8: check the FIN bit */
2178 if (PREDICT_FALSE (tcp_is_fin (th0)))
2179 tcp_rcv_fin (wrk, tc0, b0, &error0);
2182 tcp_inc_err_counter (err_counters, error0, 1);
2185 errors = session_main_flush_enqueue_events (TRANSPORT_PROTO_TCP,
2187 err_counters[TCP_ERROR_MSG_QUEUE_FULL] = errors;
2188 tcp_store_err_counters (established, err_counters);
2189 tcp_handle_postponed_dequeues (wrk);
2190 tcp_handle_disconnects (wrk);
2191 vlib_buffer_free (vm, first_buffer, frame->n_vectors);
2193 return frame->n_vectors;
2196 VLIB_NODE_FN (tcp4_established_node) (vlib_main_t * vm,
2197 vlib_node_runtime_t * node,
2198 vlib_frame_t * from_frame)
2200 return tcp46_established_inline (vm, node, from_frame, 1 /* is_ip4 */ );
2203 VLIB_NODE_FN (tcp6_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, 0 /* is_ip4 */ );
2211 VLIB_REGISTER_NODE (tcp4_established_node) =
2213 .name = "tcp4-established",
2214 /* Takes a vector of packets. */
2215 .vector_size = sizeof (u32),
2216 .n_errors = TCP_N_ERROR,
2217 .error_strings = tcp_error_strings,
2218 .n_next_nodes = TCP_ESTABLISHED_N_NEXT,
2221 #define _(s,n) [TCP_ESTABLISHED_NEXT_##s] = n,
2222 foreach_tcp_state_next
2225 .format_trace = format_tcp_rx_trace_short,
2230 VLIB_REGISTER_NODE (tcp6_established_node) =
2232 .name = "tcp6-established",
2233 /* Takes a vector of packets. */
2234 .vector_size = sizeof (u32),
2235 .n_errors = TCP_N_ERROR,
2236 .error_strings = tcp_error_strings,
2237 .n_next_nodes = TCP_ESTABLISHED_N_NEXT,
2240 #define _(s,n) [TCP_ESTABLISHED_NEXT_##s] = n,
2241 foreach_tcp_state_next
2244 .format_trace = format_tcp_rx_trace_short,
2250 tcp_lookup_is_valid (tcp_connection_t * tc, tcp_header_t * hdr)
2252 transport_connection_t *tmp = 0;
2259 if (tc->c_lcl_port == 0 && tc->state == TCP_STATE_LISTEN)
2262 u8 is_valid = (tc->c_lcl_port == hdr->dst_port
2263 && (tc->state == TCP_STATE_LISTEN
2264 || tc->c_rmt_port == hdr->src_port));
2268 handle = session_lookup_half_open_handle (&tc->connection);
2269 tmp = session_lookup_half_open_connection (handle & 0xFFFFFFFF,
2270 tc->c_proto, tc->c_is_ip4);
2274 if (tmp->lcl_port == hdr->dst_port
2275 && tmp->rmt_port == hdr->src_port)
2277 TCP_DBG ("half-open is valid!");
2285 * Lookup transport connection
2287 static tcp_connection_t *
2288 tcp_lookup_connection (u32 fib_index, vlib_buffer_t * b, u8 thread_index,
2292 transport_connection_t *tconn;
2293 tcp_connection_t *tc;
2298 ip4 = vlib_buffer_get_current (b);
2299 tcp = ip4_next_header (ip4);
2300 tconn = session_lookup_connection_wt4 (fib_index,
2305 TRANSPORT_PROTO_TCP,
2306 thread_index, &is_filtered);
2307 tc = tcp_get_connection_from_transport (tconn);
2308 ASSERT (tcp_lookup_is_valid (tc, tcp));
2313 ip6 = vlib_buffer_get_current (b);
2314 tcp = ip6_next_header (ip6);
2315 tconn = session_lookup_connection_wt6 (fib_index,
2320 TRANSPORT_PROTO_TCP,
2321 thread_index, &is_filtered);
2322 tc = tcp_get_connection_from_transport (tconn);
2323 ASSERT (tcp_lookup_is_valid (tc, tcp));
2329 tcp46_syn_sent_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
2330 vlib_frame_t * from_frame, int is_ip4)
2332 tcp_main_t *tm = vnet_get_tcp_main ();
2333 u32 n_left_from, *from, *first_buffer, errors = 0;
2334 u32 my_thread_index = vm->thread_index;
2335 tcp_worker_ctx_t *wrk = tcp_get_worker (my_thread_index);
2337 from = first_buffer = vlib_frame_vector_args (from_frame);
2338 n_left_from = from_frame->n_vectors;
2340 while (n_left_from > 0)
2342 u32 bi0, ack0, seq0, error0 = TCP_ERROR_NONE;
2343 tcp_connection_t *tc0, *new_tc0;
2344 tcp_header_t *tcp0 = 0;
2352 b0 = vlib_get_buffer (vm, bi0);
2354 tcp_half_open_connection_get (vnet_buffer (b0)->tcp.connection_index);
2355 if (PREDICT_FALSE (tc0 == 0))
2357 error0 = TCP_ERROR_INVALID_CONNECTION;
2361 /* Half-open completed recently but the connection was't removed
2362 * yet by the owning thread */
2363 if (PREDICT_FALSE (tc0->flags & TCP_CONN_HALF_OPEN_DONE))
2365 /* Make sure the connection actually exists */
2366 ASSERT (tcp_lookup_connection (tc0->c_fib_index, b0,
2367 my_thread_index, is_ip4));
2368 error0 = TCP_ERROR_SPURIOUS_SYN_ACK;
2372 ack0 = vnet_buffer (b0)->tcp.ack_number;
2373 seq0 = vnet_buffer (b0)->tcp.seq_number;
2374 tcp0 = tcp_buffer_hdr (b0);
2376 /* Crude check to see if the connection handle does not match
2377 * the packet. Probably connection just switched to established */
2378 if (PREDICT_FALSE (tcp0->dst_port != tc0->c_lcl_port
2379 || tcp0->src_port != tc0->c_rmt_port))
2381 error0 = TCP_ERROR_INVALID_CONNECTION;
2385 if (PREDICT_FALSE (!tcp_ack (tcp0) && !tcp_rst (tcp0)
2386 && !tcp_syn (tcp0)))
2388 error0 = TCP_ERROR_SEGMENT_INVALID;
2392 /* SYNs consume sequence numbers */
2393 vnet_buffer (b0)->tcp.seq_end += tcp_is_syn (tcp0);
2396 * 1. check the ACK bit
2400 * If the ACK bit is set
2401 * If SEG.ACK =< ISS, or SEG.ACK > SND.NXT, send a reset (unless
2402 * the RST bit is set, if so drop the segment and return)
2403 * <SEQ=SEG.ACK><CTL=RST>
2404 * and discard the segment. Return.
2405 * If SND.UNA =< SEG.ACK =< SND.NXT then the ACK is acceptable.
2409 if (seq_leq (ack0, tc0->iss) || seq_gt (ack0, tc0->snd_nxt))
2411 if (!tcp_rst (tcp0))
2412 tcp_send_reset_w_pkt (tc0, b0, my_thread_index, is_ip4);
2413 error0 = TCP_ERROR_RCV_WND;
2417 /* Make sure ACK is valid */
2418 if (seq_gt (tc0->snd_una, ack0))
2420 error0 = TCP_ERROR_ACK_INVALID;
2426 * 2. check the RST bit
2431 /* If ACK is acceptable, signal client that peer is not
2432 * willing to accept connection and drop connection*/
2434 tcp_connection_reset (tc0);
2435 error0 = TCP_ERROR_RST_RCVD;
2440 * 3. check the security and precedence (skipped)
2444 * 4. check the SYN bit
2447 /* No SYN flag. Drop. */
2448 if (!tcp_syn (tcp0))
2450 error0 = TCP_ERROR_SEGMENT_INVALID;
2455 if (tcp_options_parse (tcp0, &tc0->rcv_opts, 1))
2457 error0 = TCP_ERROR_OPTIONS;
2461 /* Valid SYN or SYN-ACK. Move connection from half-open pool to
2462 * current thread pool. */
2463 pool_get (tm->connections[my_thread_index], new_tc0);
2464 clib_memcpy_fast (new_tc0, tc0, sizeof (*new_tc0));
2465 new_tc0->c_c_index = new_tc0 - tm->connections[my_thread_index];
2466 new_tc0->c_thread_index = my_thread_index;
2467 new_tc0->rcv_nxt = vnet_buffer (b0)->tcp.seq_end;
2468 new_tc0->irs = seq0;
2469 new_tc0->timers[TCP_TIMER_ESTABLISH_AO] = TCP_TIMER_HANDLE_INVALID;
2470 new_tc0->timers[TCP_TIMER_RETRANSMIT_SYN] = TCP_TIMER_HANDLE_INVALID;
2471 new_tc0->sw_if_index = vnet_buffer (b0)->sw_if_index[VLIB_RX];
2473 /* If this is not the owning thread, wait for syn retransmit to
2474 * expire and cleanup then */
2475 if (tcp_half_open_connection_cleanup (tc0))
2476 tc0->flags |= TCP_CONN_HALF_OPEN_DONE;
2478 if (tcp_opts_tstamp (&new_tc0->rcv_opts))
2480 new_tc0->tsval_recent = new_tc0->rcv_opts.tsval;
2481 new_tc0->tsval_recent_age = tcp_time_now ();
2484 if (tcp_opts_wscale (&new_tc0->rcv_opts))
2485 new_tc0->snd_wscale = new_tc0->rcv_opts.wscale;
2487 new_tc0->rcv_wscale = 0;
2489 new_tc0->snd_wnd = clib_net_to_host_u16 (tcp0->window)
2490 << new_tc0->snd_wscale;
2491 new_tc0->snd_wl1 = seq0;
2492 new_tc0->snd_wl2 = ack0;
2494 tcp_connection_init_vars (new_tc0);
2496 /* SYN-ACK: See if we can switch to ESTABLISHED state */
2497 if (PREDICT_TRUE (tcp_ack (tcp0)))
2499 /* Our SYN is ACKed: we have iss < ack = snd_una */
2501 /* TODO Dequeue acknowledged segments if we support Fast Open */
2502 new_tc0->snd_una = ack0;
2503 new_tc0->state = TCP_STATE_ESTABLISHED;
2505 /* Make sure las is initialized for the wnd computation */
2506 new_tc0->rcv_las = new_tc0->rcv_nxt;
2508 /* Notify app that we have connection. If session layer can't
2509 * allocate session send reset */
2510 if (session_stream_connect_notify (&new_tc0->connection, 0))
2512 clib_warning ("connect notify fail");
2513 tcp_send_reset_w_pkt (new_tc0, b0, my_thread_index, is_ip4);
2514 tcp_connection_cleanup (new_tc0);
2518 new_tc0->tx_fifo_size =
2519 transport_tx_fifo_size (&new_tc0->connection);
2520 /* Update rtt with the syn-ack sample */
2521 tcp_estimate_initial_rtt (new_tc0);
2522 TCP_EVT_DBG (TCP_EVT_SYNACK_RCVD, new_tc0);
2523 error0 = TCP_ERROR_SYN_ACKS_RCVD;
2525 /* SYN: Simultaneous open. Change state to SYN-RCVD and send SYN-ACK */
2528 new_tc0->state = TCP_STATE_SYN_RCVD;
2530 /* Notify app that we have connection */
2531 if (session_stream_connect_notify (&new_tc0->connection, 0))
2533 tcp_connection_cleanup (new_tc0);
2534 tcp_send_reset_w_pkt (tc0, b0, my_thread_index, is_ip4);
2535 TCP_EVT_DBG (TCP_EVT_RST_SENT, tc0);
2539 new_tc0->tx_fifo_size =
2540 transport_tx_fifo_size (&new_tc0->connection);
2541 new_tc0->rtt_ts = 0;
2542 tcp_init_snd_vars (new_tc0);
2543 tcp_send_synack (new_tc0);
2544 error0 = TCP_ERROR_SYNS_RCVD;
2548 /* Read data, if any */
2549 if (PREDICT_FALSE (vnet_buffer (b0)->tcp.data_len))
2551 clib_warning ("rcvd data in syn-sent");
2552 error0 = tcp_segment_rcv (wrk, new_tc0, b0);
2553 if (error0 == TCP_ERROR_ACK_OK)
2554 error0 = TCP_ERROR_SYN_ACKS_RCVD;
2558 tcp_program_ack (wrk, new_tc0);
2563 tcp_inc_counter (syn_sent, error0, 1);
2564 if (PREDICT_FALSE ((b0->flags & VLIB_BUFFER_IS_TRACED) && tcp0 != 0))
2566 t0 = vlib_add_trace (vm, node, b0, sizeof (*t0));
2567 clib_memcpy_fast (&t0->tcp_header, tcp0, sizeof (t0->tcp_header));
2568 clib_memcpy_fast (&t0->tcp_connection, tc0,
2569 sizeof (t0->tcp_connection));
2573 errors = session_main_flush_enqueue_events (TRANSPORT_PROTO_TCP,
2575 tcp_inc_counter (syn_sent, TCP_ERROR_MSG_QUEUE_FULL, errors);
2576 vlib_buffer_free (vm, first_buffer, from_frame->n_vectors);
2578 return from_frame->n_vectors;
2581 VLIB_NODE_FN (tcp4_syn_sent_node) (vlib_main_t * vm,
2582 vlib_node_runtime_t * node,
2583 vlib_frame_t * from_frame)
2585 return tcp46_syn_sent_inline (vm, node, from_frame, 1 /* is_ip4 */ );
2588 VLIB_NODE_FN (tcp6_syn_sent_node) (vlib_main_t * vm,
2589 vlib_node_runtime_t * node,
2590 vlib_frame_t * from_frame)
2592 return tcp46_syn_sent_inline (vm, node, from_frame, 0 /* is_ip4 */ );
2596 VLIB_REGISTER_NODE (tcp4_syn_sent_node) =
2598 .name = "tcp4-syn-sent",
2599 /* Takes a vector of packets. */
2600 .vector_size = sizeof (u32),
2601 .n_errors = TCP_N_ERROR,
2602 .error_strings = tcp_error_strings,
2603 .n_next_nodes = TCP_SYN_SENT_N_NEXT,
2606 #define _(s,n) [TCP_SYN_SENT_NEXT_##s] = n,
2607 foreach_tcp_state_next
2610 .format_trace = format_tcp_rx_trace_short,
2615 VLIB_REGISTER_NODE (tcp6_syn_sent_node) =
2617 .name = "tcp6-syn-sent",
2618 /* Takes a vector of packets. */
2619 .vector_size = sizeof (u32),
2620 .n_errors = TCP_N_ERROR,
2621 .error_strings = tcp_error_strings,
2622 .n_next_nodes = TCP_SYN_SENT_N_NEXT,
2625 #define _(s,n) [TCP_SYN_SENT_NEXT_##s] = n,
2626 foreach_tcp_state_next
2629 .format_trace = format_tcp_rx_trace_short,
2634 * Handles reception for all states except LISTEN, SYN-SENT and ESTABLISHED
2635 * as per RFC793 p. 64
2638 tcp46_rcv_process_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
2639 vlib_frame_t * from_frame, int is_ip4)
2641 u32 thread_index = vm->thread_index, errors = 0, *first_buffer;
2642 tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
2643 u32 n_left_from, *from, max_dequeue;
2645 from = first_buffer = vlib_frame_vector_args (from_frame);
2646 n_left_from = from_frame->n_vectors;
2648 while (n_left_from > 0)
2650 u32 bi0, error0 = TCP_ERROR_NONE;
2651 tcp_header_t *tcp0 = 0;
2652 tcp_connection_t *tc0;
2660 b0 = vlib_get_buffer (vm, bi0);
2661 tc0 = tcp_connection_get (vnet_buffer (b0)->tcp.connection_index,
2663 if (PREDICT_FALSE (tc0 == 0))
2665 error0 = TCP_ERROR_INVALID_CONNECTION;
2669 tcp0 = tcp_buffer_hdr (b0);
2670 is_fin0 = tcp_is_fin (tcp0);
2674 tcp_connection_t *tmp;
2675 tmp = tcp_lookup_connection (tc0->c_fib_index, b0, thread_index,
2677 if (tmp->state != tc0->state)
2679 if (tc0->state != TCP_STATE_CLOSED)
2680 clib_warning ("state changed");
2686 * Special treatment for CLOSED
2688 if (PREDICT_FALSE (tc0->state == TCP_STATE_CLOSED))
2690 error0 = TCP_ERROR_CONNECTION_CLOSED;
2695 * For all other states (except LISTEN)
2698 /* 1-4: check SEQ, RST, SYN */
2699 if (PREDICT_FALSE (tcp_segment_validate (wrk, tc0, b0, tcp0, &error0)))
2702 /* 5: check the ACK field */
2705 case TCP_STATE_SYN_RCVD:
2707 * If the segment acknowledgment is not acceptable, form a
2709 * <SEQ=SEG.ACK><CTL=RST>
2712 if (!tcp_rcv_ack_is_acceptable (tc0, b0))
2714 tcp_connection_reset (tc0);
2715 error0 = TCP_ERROR_ACK_INVALID;
2719 /* Make sure the ack is exactly right */
2720 if (tc0->rcv_nxt != vnet_buffer (b0)->tcp.seq_number || is_fin0)
2722 tcp_connection_reset (tc0);
2723 error0 = TCP_ERROR_SEGMENT_INVALID;
2727 /* Update rtt and rto */
2728 tcp_estimate_initial_rtt (tc0);
2730 /* Switch state to ESTABLISHED */
2731 tc0->state = TCP_STATE_ESTABLISHED;
2732 TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc0);
2734 /* Initialize session variables */
2735 tc0->snd_una = vnet_buffer (b0)->tcp.ack_number;
2736 tc0->snd_wnd = clib_net_to_host_u16 (tcp0->window)
2737 << tc0->rcv_opts.wscale;
2738 tc0->snd_wl1 = vnet_buffer (b0)->tcp.seq_number;
2739 tc0->snd_wl2 = vnet_buffer (b0)->tcp.ack_number;
2741 /* Reset SYN-ACK retransmit and SYN_RCV establish timers */
2742 tcp_retransmit_timer_reset (tc0);
2743 tcp_timer_reset (tc0, TCP_TIMER_ESTABLISH);
2744 if (session_stream_accept_notify (&tc0->connection))
2746 error0 = TCP_ERROR_MSG_QUEUE_FULL;
2747 tcp_connection_reset (tc0);
2750 error0 = TCP_ERROR_ACK_OK;
2752 case TCP_STATE_ESTABLISHED:
2753 /* We can get packets in established state here because they
2754 * were enqueued before state change */
2755 if (tcp_rcv_ack (wrk, tc0, b0, tcp0, &error0))
2759 case TCP_STATE_FIN_WAIT_1:
2760 /* In addition to the processing for the ESTABLISHED state, if
2761 * our FIN is now acknowledged then enter FIN-WAIT-2 and
2762 * continue processing in that state. */
2763 if (tcp_rcv_ack (wrk, tc0, b0, tcp0, &error0))
2766 /* Still have to send the FIN */
2767 if (tc0->flags & TCP_CONN_FINPNDG)
2769 /* TX fifo finally drained */
2770 max_dequeue = transport_max_tx_dequeue (&tc0->connection);
2771 if (max_dequeue <= tc0->burst_acked)
2774 /* If FIN is ACKed */
2775 else if (tc0->snd_una == tc0->snd_nxt)
2777 tcp_connection_set_state (tc0, TCP_STATE_FIN_WAIT_2);
2779 /* Stop all retransmit timers because we have nothing more
2780 * to send. Enable waitclose though because we're willing to
2781 * wait for peer's FIN but not indefinitely. */
2782 tcp_connection_timers_reset (tc0);
2783 tcp_timer_set (tc0, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
2785 /* Don't try to deq the FIN acked */
2786 if (tc0->burst_acked > 1)
2787 session_tx_fifo_dequeue_drop (&tc0->connection,
2788 tc0->burst_acked - 1);
2789 tc0->burst_acked = 0;
2792 case TCP_STATE_FIN_WAIT_2:
2793 /* In addition to the processing for the ESTABLISHED state, if
2794 * the retransmission queue is empty, the user's CLOSE can be
2795 * acknowledged ("ok") but do not delete the TCB. */
2796 if (tcp_rcv_ack (wrk, tc0, b0, tcp0, &error0))
2798 tc0->burst_acked = 0;
2800 case TCP_STATE_CLOSE_WAIT:
2801 /* Do the same processing as for the ESTABLISHED state. */
2802 if (tcp_rcv_ack (wrk, tc0, b0, tcp0, &error0))
2805 if (tc0->flags & TCP_CONN_FINPNDG)
2807 /* TX fifo finally drained */
2808 if (!transport_max_tx_dequeue (&tc0->connection))
2811 tcp_connection_timers_reset (tc0);
2812 tcp_connection_set_state (tc0, TCP_STATE_LAST_ACK);
2813 tcp_timer_set (tc0, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
2817 case TCP_STATE_CLOSING:
2818 /* In addition to the processing for the ESTABLISHED state, if
2819 * the ACK acknowledges our FIN then enter the TIME-WAIT state,
2820 * otherwise ignore the segment. */
2821 if (!tcp_rcv_ack_is_acceptable (tc0, b0))
2823 error0 = TCP_ERROR_ACK_INVALID;
2827 error0 = TCP_ERROR_ACK_OK;
2828 tc0->snd_una = vnet_buffer (b0)->tcp.ack_number;
2829 /* Ack moved snd_una beyond snd_nxt so reprogram fin */
2830 if (seq_gt (tc0->snd_una, tc0->snd_nxt))
2832 tc0->snd_nxt = tc0->snd_una;
2833 tc0->flags &= ~TCP_CONN_FINSNT;
2837 tcp_connection_timers_reset (tc0);
2838 tcp_connection_set_state (tc0, TCP_STATE_TIME_WAIT);
2839 tcp_timer_set (tc0, TCP_TIMER_WAITCLOSE, TCP_TIMEWAIT_TIME);
2843 case TCP_STATE_LAST_ACK:
2844 /* The only thing that [should] arrive in this state is an
2845 * acknowledgment of our FIN. If our FIN is now acknowledged,
2846 * delete the TCB, enter the CLOSED state, and return. */
2848 if (!tcp_rcv_ack_is_acceptable (tc0, b0))
2850 error0 = TCP_ERROR_ACK_INVALID;
2853 error0 = TCP_ERROR_ACK_OK;
2854 tc0->snd_una = vnet_buffer (b0)->tcp.ack_number;
2855 /* Apparently our ACK for the peer's FIN was lost */
2856 if (is_fin0 && tc0->snd_una != tc0->snd_nxt)
2862 tcp_connection_set_state (tc0, TCP_STATE_CLOSED);
2864 /* Don't free the connection from the data path since
2865 * we can't ensure that we have no packets already enqueued
2866 * to output. Rely instead on the waitclose timer */
2867 tcp_connection_timers_reset (tc0);
2868 tcp_timer_set (tc0, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
2873 case TCP_STATE_TIME_WAIT:
2874 /* The only thing that can arrive in this state is a
2875 * retransmission of the remote FIN. Acknowledge it, and restart
2876 * the 2 MSL timeout. */
2878 if (tcp_rcv_ack (wrk, tc0, b0, tcp0, &error0))
2884 tcp_program_ack (wrk, tc0);
2885 tcp_timer_update (tc0, TCP_TIMER_WAITCLOSE, TCP_TIMEWAIT_TIME);
2893 /* 6: check the URG bit TODO */
2895 /* 7: process the segment text */
2898 case TCP_STATE_ESTABLISHED:
2899 case TCP_STATE_FIN_WAIT_1:
2900 case TCP_STATE_FIN_WAIT_2:
2901 if (vnet_buffer (b0)->tcp.data_len)
2902 error0 = tcp_segment_rcv (wrk, tc0, b0);
2904 case TCP_STATE_CLOSE_WAIT:
2905 case TCP_STATE_CLOSING:
2906 case TCP_STATE_LAST_ACK:
2907 case TCP_STATE_TIME_WAIT:
2908 /* This should not occur, since a FIN has been received from the
2909 * remote side. Ignore the segment text. */
2913 /* 8: check the FIN bit */
2917 TCP_EVT_DBG (TCP_EVT_FIN_RCVD, tc0);
2921 case TCP_STATE_ESTABLISHED:
2922 /* Account for the FIN and send ack */
2924 tcp_program_ack (wrk, tc0);
2925 tcp_connection_set_state (tc0, TCP_STATE_CLOSE_WAIT);
2926 tcp_program_disconnect (wrk, tc0);
2927 tcp_timer_update (tc0, TCP_TIMER_WAITCLOSE, TCP_CLOSEWAIT_TIME);
2929 case TCP_STATE_SYN_RCVD:
2930 /* Send FIN-ACK, enter LAST-ACK and because the app was not
2931 * notified yet, set a cleanup timer instead of relying on
2932 * disconnect notify and the implicit close call. */
2933 tcp_connection_timers_reset (tc0);
2936 tcp_connection_set_state (tc0, TCP_STATE_LAST_ACK);
2937 tcp_timer_set (tc0, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
2939 case TCP_STATE_CLOSE_WAIT:
2940 case TCP_STATE_CLOSING:
2941 case TCP_STATE_LAST_ACK:
2944 case TCP_STATE_FIN_WAIT_1:
2946 tcp_connection_set_state (tc0, TCP_STATE_CLOSING);
2947 if (tc0->flags & TCP_CONN_FINPNDG)
2949 /* Drop all outstanding tx data. */
2950 session_tx_fifo_dequeue_drop (&tc0->connection,
2951 transport_max_tx_dequeue
2952 (&tc0->connection));
2953 /* Make it look as if we've recovered, if needed */
2954 if (tcp_in_cong_recovery (tc0))
2956 scoreboard_clear (&tc0->sack_sb);
2957 tcp_fastrecovery_off (tc0);
2958 tcp_recovery_off (tc0);
2959 tcp_connection_timers_reset (tc0);
2960 tc0->snd_nxt = tc0->snd_una;
2965 tcp_program_ack (wrk, tc0);
2966 /* Wait for ACK for our FIN but not forever */
2967 tcp_timer_update (tc0, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
2969 case TCP_STATE_FIN_WAIT_2:
2970 /* Got FIN, send ACK! Be more aggressive with resource cleanup */
2972 tcp_connection_set_state (tc0, TCP_STATE_TIME_WAIT);
2973 tcp_connection_timers_reset (tc0);
2974 tcp_timer_set (tc0, TCP_TIMER_WAITCLOSE, TCP_TIMEWAIT_TIME);
2975 tcp_program_ack (wrk, tc0);
2977 case TCP_STATE_TIME_WAIT:
2978 /* Remain in the TIME-WAIT state. Restart the time-wait
2981 tcp_timer_update (tc0, TCP_TIMER_WAITCLOSE, TCP_TIMEWAIT_TIME);
2984 error0 = TCP_ERROR_FIN_RCVD;
2988 tcp_inc_counter (rcv_process, error0, 1);
2989 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
2991 tcp_rx_trace_t *t0 = vlib_add_trace (vm, node, b0, sizeof (*t0));
2992 tcp_set_rx_trace_data (t0, tc0, tcp0, b0, is_ip4);
2996 errors = session_main_flush_enqueue_events (TRANSPORT_PROTO_TCP,
2998 tcp_inc_counter (rcv_process, TCP_ERROR_MSG_QUEUE_FULL, errors);
2999 tcp_handle_postponed_dequeues (wrk);
3000 vlib_buffer_free (vm, first_buffer, from_frame->n_vectors);
3002 return from_frame->n_vectors;
3005 VLIB_NODE_FN (tcp4_rcv_process_node) (vlib_main_t * vm,
3006 vlib_node_runtime_t * node,
3007 vlib_frame_t * from_frame)
3009 return tcp46_rcv_process_inline (vm, node, from_frame, 1 /* is_ip4 */ );
3012 VLIB_NODE_FN (tcp6_rcv_process_node) (vlib_main_t * vm,
3013 vlib_node_runtime_t * node,
3014 vlib_frame_t * from_frame)
3016 return tcp46_rcv_process_inline (vm, node, from_frame, 0 /* is_ip4 */ );
3020 VLIB_REGISTER_NODE (tcp4_rcv_process_node) =
3022 .name = "tcp4-rcv-process",
3023 /* Takes a vector of packets. */
3024 .vector_size = sizeof (u32),
3025 .n_errors = TCP_N_ERROR,
3026 .error_strings = tcp_error_strings,
3027 .n_next_nodes = TCP_RCV_PROCESS_N_NEXT,
3030 #define _(s,n) [TCP_RCV_PROCESS_NEXT_##s] = n,
3031 foreach_tcp_state_next
3034 .format_trace = format_tcp_rx_trace_short,
3039 VLIB_REGISTER_NODE (tcp6_rcv_process_node) =
3041 .name = "tcp6-rcv-process",
3042 /* Takes a vector of packets. */
3043 .vector_size = sizeof (u32),
3044 .n_errors = TCP_N_ERROR,
3045 .error_strings = tcp_error_strings,
3046 .n_next_nodes = TCP_RCV_PROCESS_N_NEXT,
3049 #define _(s,n) [TCP_RCV_PROCESS_NEXT_##s] = n,
3050 foreach_tcp_state_next
3053 .format_trace = format_tcp_rx_trace_short,
3058 * LISTEN state processing as per RFC 793 p. 65
3061 tcp46_listen_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
3062 vlib_frame_t * from_frame, int is_ip4)
3064 u32 n_left_from, *from, n_syns = 0, *first_buffer;
3065 u32 my_thread_index = vm->thread_index;
3067 from = first_buffer = vlib_frame_vector_args (from_frame);
3068 n_left_from = from_frame->n_vectors;
3070 while (n_left_from > 0)
3075 tcp_header_t *th0 = 0;
3076 tcp_connection_t *lc0;
3079 tcp_connection_t *child0;
3080 u32 error0 = TCP_ERROR_NONE;
3086 b0 = vlib_get_buffer (vm, bi0);
3087 lc0 = tcp_listener_get (vnet_buffer (b0)->tcp.connection_index);
3091 ip40 = vlib_buffer_get_current (b0);
3092 th0 = ip4_next_header (ip40);
3096 ip60 = vlib_buffer_get_current (b0);
3097 th0 = ip6_next_header (ip60);
3100 /* Create child session. For syn-flood protection use filter */
3102 /* 1. first check for an RST: handled in dispatch */
3103 /* if (tcp_rst (th0))
3107 /* 2. second check for an ACK: handled in dispatch */
3108 /* if (tcp_ack (th0))
3110 tcp_send_reset (b0, is_ip4);
3115 /* 3. check for a SYN (did that already) */
3117 /* Make sure connection wasn't just created */
3118 child0 = tcp_lookup_connection (lc0->c_fib_index, b0, my_thread_index,
3120 if (PREDICT_FALSE (child0->state != TCP_STATE_LISTEN))
3122 error0 = TCP_ERROR_CREATE_EXISTS;
3126 /* Create child session and send SYN-ACK */
3127 child0 = tcp_connection_alloc (my_thread_index);
3128 child0->c_lcl_port = th0->dst_port;
3129 child0->c_rmt_port = th0->src_port;
3130 child0->c_is_ip4 = is_ip4;
3131 child0->state = TCP_STATE_SYN_RCVD;
3132 child0->c_fib_index = lc0->c_fib_index;
3136 child0->c_lcl_ip4.as_u32 = ip40->dst_address.as_u32;
3137 child0->c_rmt_ip4.as_u32 = ip40->src_address.as_u32;
3141 clib_memcpy_fast (&child0->c_lcl_ip6, &ip60->dst_address,
3142 sizeof (ip6_address_t));
3143 clib_memcpy_fast (&child0->c_rmt_ip6, &ip60->src_address,
3144 sizeof (ip6_address_t));
3147 if (tcp_options_parse (th0, &child0->rcv_opts, 1))
3149 error0 = TCP_ERROR_OPTIONS;
3150 tcp_connection_free (child0);
3154 child0->irs = vnet_buffer (b0)->tcp.seq_number;
3155 child0->rcv_nxt = vnet_buffer (b0)->tcp.seq_number + 1;
3156 child0->rcv_las = child0->rcv_nxt;
3157 child0->sw_if_index = vnet_buffer (b0)->sw_if_index[VLIB_RX];
3159 /* RFC1323: TSval timestamps sent on {SYN} and {SYN,ACK}
3160 * segments are used to initialize PAWS. */
3161 if (tcp_opts_tstamp (&child0->rcv_opts))
3163 child0->tsval_recent = child0->rcv_opts.tsval;
3164 child0->tsval_recent_age = tcp_time_now ();
3167 if (tcp_opts_wscale (&child0->rcv_opts))
3168 child0->snd_wscale = child0->rcv_opts.wscale;
3170 child0->snd_wnd = clib_net_to_host_u16 (th0->window)
3171 << child0->snd_wscale;
3172 child0->snd_wl1 = vnet_buffer (b0)->tcp.seq_number;
3173 child0->snd_wl2 = vnet_buffer (b0)->tcp.ack_number;
3175 tcp_connection_init_vars (child0);
3176 child0->rto = TCP_RTO_MIN;
3177 TCP_EVT_DBG (TCP_EVT_SYN_RCVD, child0, 1);
3179 if (session_stream_accept (&child0->connection, lc0->c_s_index,
3182 tcp_connection_cleanup (child0);
3183 error0 = TCP_ERROR_CREATE_SESSION_FAIL;
3187 child0->tx_fifo_size = transport_tx_fifo_size (&child0->connection);
3188 tcp_send_synack (child0);
3189 tcp_timer_set (child0, TCP_TIMER_ESTABLISH, TCP_SYN_RCVD_TIME);
3193 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
3195 t0 = vlib_add_trace (vm, node, b0, sizeof (*t0));
3196 clib_memcpy_fast (&t0->tcp_header, th0, sizeof (t0->tcp_header));
3197 clib_memcpy_fast (&t0->tcp_connection, lc0,
3198 sizeof (t0->tcp_connection));
3201 n_syns += (error0 == TCP_ERROR_NONE);
3204 tcp_inc_counter (listen, TCP_ERROR_SYNS_RCVD, n_syns);
3205 vlib_buffer_free (vm, first_buffer, from_frame->n_vectors);
3207 return from_frame->n_vectors;
3210 VLIB_NODE_FN (tcp4_listen_node) (vlib_main_t * vm, vlib_node_runtime_t * node,
3211 vlib_frame_t * from_frame)
3213 return tcp46_listen_inline (vm, node, from_frame, 1 /* is_ip4 */ );
3216 VLIB_NODE_FN (tcp6_listen_node) (vlib_main_t * vm, vlib_node_runtime_t * node,
3217 vlib_frame_t * from_frame)
3219 return tcp46_listen_inline (vm, node, from_frame, 0 /* is_ip4 */ );
3223 VLIB_REGISTER_NODE (tcp4_listen_node) =
3225 .name = "tcp4-listen",
3226 /* Takes a vector of packets. */
3227 .vector_size = sizeof (u32),
3228 .n_errors = TCP_N_ERROR,
3229 .error_strings = tcp_error_strings,
3230 .n_next_nodes = TCP_LISTEN_N_NEXT,
3233 #define _(s,n) [TCP_LISTEN_NEXT_##s] = n,
3234 foreach_tcp_state_next
3237 .format_trace = format_tcp_rx_trace_short,
3242 VLIB_REGISTER_NODE (tcp6_listen_node) =
3244 .name = "tcp6-listen",
3245 /* Takes a vector of packets. */
3246 .vector_size = sizeof (u32),
3247 .n_errors = TCP_N_ERROR,
3248 .error_strings = tcp_error_strings,
3249 .n_next_nodes = TCP_LISTEN_N_NEXT,
3252 #define _(s,n) [TCP_LISTEN_NEXT_##s] = n,
3253 foreach_tcp_state_next
3256 .format_trace = format_tcp_rx_trace_short,
3260 typedef enum _tcp_input_next
3262 TCP_INPUT_NEXT_DROP,
3263 TCP_INPUT_NEXT_LISTEN,
3264 TCP_INPUT_NEXT_RCV_PROCESS,
3265 TCP_INPUT_NEXT_SYN_SENT,
3266 TCP_INPUT_NEXT_ESTABLISHED,
3267 TCP_INPUT_NEXT_RESET,
3268 TCP_INPUT_NEXT_PUNT,
3272 #define foreach_tcp4_input_next \
3273 _ (DROP, "ip4-drop") \
3274 _ (LISTEN, "tcp4-listen") \
3275 _ (RCV_PROCESS, "tcp4-rcv-process") \
3276 _ (SYN_SENT, "tcp4-syn-sent") \
3277 _ (ESTABLISHED, "tcp4-established") \
3278 _ (RESET, "tcp4-reset") \
3279 _ (PUNT, "ip4-punt")
3281 #define foreach_tcp6_input_next \
3282 _ (DROP, "ip6-drop") \
3283 _ (LISTEN, "tcp6-listen") \
3284 _ (RCV_PROCESS, "tcp6-rcv-process") \
3285 _ (SYN_SENT, "tcp6-syn-sent") \
3286 _ (ESTABLISHED, "tcp6-established") \
3287 _ (RESET, "tcp6-reset") \
3288 _ (PUNT, "ip6-punt")
3290 #define filter_flags (TCP_FLAG_SYN|TCP_FLAG_ACK|TCP_FLAG_RST|TCP_FLAG_FIN)
3293 tcp_input_trace_frame (vlib_main_t * vm, vlib_node_runtime_t * node,
3294 vlib_buffer_t ** bs, u32 n_bufs, u8 is_ip4)
3296 tcp_connection_t *tc;
3301 for (i = 0; i < n_bufs; i++)
3303 if (bs[i]->flags & VLIB_BUFFER_IS_TRACED)
3305 t = vlib_add_trace (vm, node, bs[i], sizeof (*t));
3306 tc = tcp_connection_get (vnet_buffer (bs[i])->tcp.connection_index,
3308 tcp = vlib_buffer_get_current (bs[i]);
3309 tcp_set_rx_trace_data (t, tc, tcp, bs[i], is_ip4);
3315 tcp_input_set_error_next (tcp_main_t * tm, u16 * next, u32 * error, u8 is_ip4)
3317 if (*error == TCP_ERROR_FILTERED || *error == TCP_ERROR_WRONG_THREAD)
3319 *next = TCP_INPUT_NEXT_DROP;
3321 else if ((is_ip4 && tm->punt_unknown4) || (!is_ip4 && tm->punt_unknown6))
3323 *next = TCP_INPUT_NEXT_PUNT;
3324 *error = TCP_ERROR_PUNT;
3328 *next = TCP_INPUT_NEXT_RESET;
3329 *error = TCP_ERROR_NO_LISTENER;
3333 static inline tcp_connection_t *
3334 tcp_input_lookup_buffer (vlib_buffer_t * b, u8 thread_index, u32 * error,
3337 u32 fib_index = vnet_buffer (b)->ip.fib_index;
3338 int n_advance_bytes, n_data_bytes;
3339 transport_connection_t *tc;
3345 ip4_header_t *ip4 = vlib_buffer_get_current (b);
3346 int ip_hdr_bytes = ip4_header_bytes (ip4);
3347 if (PREDICT_FALSE (b->current_length < ip_hdr_bytes + sizeof (*tcp)))
3349 *error = TCP_ERROR_LENGTH;
3352 tcp = ip4_next_header (ip4);
3353 vnet_buffer (b)->tcp.hdr_offset = (u8 *) tcp - (u8 *) ip4;
3354 n_advance_bytes = (ip_hdr_bytes + tcp_header_bytes (tcp));
3355 n_data_bytes = clib_net_to_host_u16 (ip4->length) - n_advance_bytes;
3357 /* Length check. Checksum computed by ipx_local no need to compute again */
3358 if (PREDICT_FALSE (n_data_bytes < 0))
3360 *error = TCP_ERROR_LENGTH;
3364 tc = session_lookup_connection_wt4 (fib_index, &ip4->dst_address,
3365 &ip4->src_address, tcp->dst_port,
3366 tcp->src_port, TRANSPORT_PROTO_TCP,
3367 thread_index, &result);
3371 ip6_header_t *ip6 = vlib_buffer_get_current (b);
3372 if (PREDICT_FALSE (b->current_length < sizeof (*ip6) + sizeof (*tcp)))
3374 *error = TCP_ERROR_LENGTH;
3377 tcp = ip6_next_header (ip6);
3378 vnet_buffer (b)->tcp.hdr_offset = (u8 *) tcp - (u8 *) ip6;
3379 n_advance_bytes = tcp_header_bytes (tcp);
3380 n_data_bytes = clib_net_to_host_u16 (ip6->payload_length)
3382 n_advance_bytes += sizeof (ip6[0]);
3384 if (PREDICT_FALSE (n_data_bytes < 0))
3386 *error = TCP_ERROR_LENGTH;
3390 (ip6_address_is_link_local_unicast (&ip6->dst_address)))
3392 ip4_main_t *im = &ip4_main;
3393 fib_index = vec_elt (im->fib_index_by_sw_if_index,
3394 vnet_buffer (b)->sw_if_index[VLIB_RX]);
3397 tc = session_lookup_connection_wt6 (fib_index, &ip6->dst_address,
3398 &ip6->src_address, tcp->dst_port,
3399 tcp->src_port, TRANSPORT_PROTO_TCP,
3400 thread_index, &result);
3403 vnet_buffer (b)->tcp.seq_number = clib_net_to_host_u32 (tcp->seq_number);
3404 vnet_buffer (b)->tcp.ack_number = clib_net_to_host_u32 (tcp->ack_number);
3405 vnet_buffer (b)->tcp.data_offset = n_advance_bytes;
3406 vnet_buffer (b)->tcp.data_len = n_data_bytes;
3407 vnet_buffer (b)->tcp.seq_end = vnet_buffer (b)->tcp.seq_number
3409 vnet_buffer (b)->tcp.flags = 0;
3411 *error = result ? TCP_ERROR_NONE + result : *error;
3413 return tcp_get_connection_from_transport (tc);
3417 tcp_input_dispatch_buffer (tcp_main_t * tm, tcp_connection_t * tc,
3418 vlib_buffer_t * b, u16 * next, u32 * error)
3423 tcp = tcp_buffer_hdr (b);
3424 flags = tcp->flags & filter_flags;
3425 *next = tm->dispatch_table[tc->state][flags].next;
3426 *error = tm->dispatch_table[tc->state][flags].error;
3428 if (PREDICT_FALSE (*error == TCP_ERROR_DISPATCH
3429 || *next == TCP_INPUT_NEXT_RESET))
3431 /* Overload tcp flags to store state */
3432 tcp_state_t state = tc->state;
3433 vnet_buffer (b)->tcp.flags = tc->state;
3435 if (*error == TCP_ERROR_DISPATCH)
3436 clib_warning ("tcp conn %u disp error state %U flags %U",
3437 tc->c_c_index, format_tcp_state, state,
3438 format_tcp_flags, (int) flags);
3443 tcp46_input_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
3444 vlib_frame_t * frame, int is_ip4)
3446 u32 n_left_from, *from, thread_index = vm->thread_index;
3447 tcp_main_t *tm = vnet_get_tcp_main ();
3448 vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b;
3449 u16 nexts[VLIB_FRAME_SIZE], *next;
3451 tcp_set_time_now (tcp_get_worker (thread_index));
3453 from = vlib_frame_vector_args (frame);
3454 n_left_from = frame->n_vectors;
3455 vlib_get_buffers (vm, from, bufs, n_left_from);
3460 while (n_left_from >= 4)
3462 u32 error0 = TCP_ERROR_NO_LISTENER, error1 = TCP_ERROR_NO_LISTENER;
3463 tcp_connection_t *tc0, *tc1;
3466 vlib_prefetch_buffer_header (b[2], STORE);
3467 CLIB_PREFETCH (b[2]->data, 2 * CLIB_CACHE_LINE_BYTES, LOAD);
3469 vlib_prefetch_buffer_header (b[3], STORE);
3470 CLIB_PREFETCH (b[3]->data, 2 * CLIB_CACHE_LINE_BYTES, LOAD);
3473 next[0] = next[1] = TCP_INPUT_NEXT_DROP;
3475 tc0 = tcp_input_lookup_buffer (b[0], thread_index, &error0, is_ip4);
3476 tc1 = tcp_input_lookup_buffer (b[1], thread_index, &error1, is_ip4);
3478 if (PREDICT_TRUE (!tc0 + !tc1 == 0))
3480 ASSERT (tcp_lookup_is_valid (tc0, tcp_buffer_hdr (b[0])));
3481 ASSERT (tcp_lookup_is_valid (tc1, tcp_buffer_hdr (b[1])));
3483 vnet_buffer (b[0])->tcp.connection_index = tc0->c_c_index;
3484 vnet_buffer (b[1])->tcp.connection_index = tc1->c_c_index;
3486 tcp_input_dispatch_buffer (tm, tc0, b[0], &next[0], &error0);
3487 tcp_input_dispatch_buffer (tm, tc1, b[1], &next[1], &error1);
3491 if (PREDICT_TRUE (tc0 != 0))
3493 ASSERT (tcp_lookup_is_valid (tc0, tcp_buffer_hdr (b[0])));
3494 vnet_buffer (b[0])->tcp.connection_index = tc0->c_c_index;
3495 tcp_input_dispatch_buffer (tm, tc0, b[0], &next[0], &error0);
3498 tcp_input_set_error_next (tm, &next[0], &error0, is_ip4);
3500 if (PREDICT_TRUE (tc1 != 0))
3502 ASSERT (tcp_lookup_is_valid (tc1, tcp_buffer_hdr (b[1])));
3503 vnet_buffer (b[1])->tcp.connection_index = tc1->c_c_index;
3504 tcp_input_dispatch_buffer (tm, tc1, b[1], &next[1], &error1);
3507 tcp_input_set_error_next (tm, &next[1], &error1, is_ip4);
3514 while (n_left_from > 0)
3516 tcp_connection_t *tc0;
3517 u32 error0 = TCP_ERROR_NO_LISTENER;
3519 if (n_left_from > 1)
3521 vlib_prefetch_buffer_header (b[1], STORE);
3522 CLIB_PREFETCH (b[1]->data, 2 * CLIB_CACHE_LINE_BYTES, LOAD);
3525 next[0] = TCP_INPUT_NEXT_DROP;
3526 tc0 = tcp_input_lookup_buffer (b[0], thread_index, &error0, is_ip4);
3527 if (PREDICT_TRUE (tc0 != 0))
3529 ASSERT (tcp_lookup_is_valid (tc0, tcp_buffer_hdr (b[0])));
3530 vnet_buffer (b[0])->tcp.connection_index = tc0->c_c_index;
3531 tcp_input_dispatch_buffer (tm, tc0, b[0], &next[0], &error0);
3534 tcp_input_set_error_next (tm, &next[0], &error0, is_ip4);
3541 if (PREDICT_FALSE (node->flags & VLIB_NODE_FLAG_TRACE))
3542 tcp_input_trace_frame (vm, node, bufs, frame->n_vectors, is_ip4);
3544 vlib_buffer_enqueue_to_next (vm, node, from, nexts, frame->n_vectors);
3545 return frame->n_vectors;
3548 VLIB_NODE_FN (tcp4_input_node) (vlib_main_t * vm, vlib_node_runtime_t * node,
3549 vlib_frame_t * from_frame)
3551 return tcp46_input_inline (vm, node, from_frame, 1 /* is_ip4 */ );
3554 VLIB_NODE_FN (tcp6_input_node) (vlib_main_t * vm, vlib_node_runtime_t * node,
3555 vlib_frame_t * from_frame)
3557 return tcp46_input_inline (vm, node, from_frame, 0 /* is_ip4 */ );
3561 VLIB_REGISTER_NODE (tcp4_input_node) =
3563 .name = "tcp4-input",
3564 /* Takes a vector of packets. */
3565 .vector_size = sizeof (u32),
3566 .n_errors = TCP_N_ERROR,
3567 .error_strings = tcp_error_strings,
3568 .n_next_nodes = TCP_INPUT_N_NEXT,
3571 #define _(s,n) [TCP_INPUT_NEXT_##s] = n,
3572 foreach_tcp4_input_next
3575 .format_buffer = format_tcp_header,
3576 .format_trace = format_tcp_rx_trace,
3581 VLIB_REGISTER_NODE (tcp6_input_node) =
3583 .name = "tcp6-input",
3584 /* Takes a vector of packets. */
3585 .vector_size = sizeof (u32),
3586 .n_errors = TCP_N_ERROR,
3587 .error_strings = tcp_error_strings,
3588 .n_next_nodes = TCP_INPUT_N_NEXT,
3591 #define _(s,n) [TCP_INPUT_NEXT_##s] = n,
3592 foreach_tcp6_input_next
3595 .format_buffer = format_tcp_header,
3596 .format_trace = format_tcp_rx_trace,
3600 #ifndef CLIB_MARCH_VARIANT
3602 tcp_dispatch_table_init (tcp_main_t * tm)
3605 for (i = 0; i < ARRAY_LEN (tm->dispatch_table); i++)
3606 for (j = 0; j < ARRAY_LEN (tm->dispatch_table[i]); j++)
3608 tm->dispatch_table[i][j].next = TCP_INPUT_NEXT_DROP;
3609 tm->dispatch_table[i][j].error = TCP_ERROR_DISPATCH;
3612 #define _(t,f,n,e) \
3614 tm->dispatch_table[TCP_STATE_##t][f].next = (n); \
3615 tm->dispatch_table[TCP_STATE_##t][f].error = (e); \
3618 /* RFC 793: In LISTEN if RST drop and if ACK return RST */
3619 _(LISTEN, 0, TCP_INPUT_NEXT_DROP, TCP_ERROR_SEGMENT_INVALID);
3620 _(LISTEN, TCP_FLAG_ACK, TCP_INPUT_NEXT_RESET, TCP_ERROR_ACK_INVALID);
3621 _(LISTEN, TCP_FLAG_RST, TCP_INPUT_NEXT_DROP, TCP_ERROR_INVALID_CONNECTION);
3622 _(LISTEN, TCP_FLAG_SYN, TCP_INPUT_NEXT_LISTEN, TCP_ERROR_NONE);
3623 _(LISTEN, TCP_FLAG_SYN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RESET,
3624 TCP_ERROR_ACK_INVALID);
3625 _(LISTEN, TCP_FLAG_SYN | TCP_FLAG_RST, TCP_INPUT_NEXT_DROP,
3626 TCP_ERROR_SEGMENT_INVALID);
3627 _(LISTEN, TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_DROP,
3628 TCP_ERROR_SEGMENT_INVALID);
3629 _(LISTEN, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_DROP,
3630 TCP_ERROR_INVALID_CONNECTION);
3631 _(LISTEN, TCP_FLAG_FIN, TCP_INPUT_NEXT_RESET, TCP_ERROR_SEGMENT_INVALID);
3632 _(LISTEN, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RESET,
3633 TCP_ERROR_SEGMENT_INVALID);
3634 _(LISTEN, TCP_FLAG_FIN | TCP_FLAG_RST, TCP_INPUT_NEXT_DROP,
3635 TCP_ERROR_SEGMENT_INVALID);
3636 _(LISTEN, TCP_FLAG_FIN | TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_DROP,
3638 _(LISTEN, TCP_FLAG_FIN | TCP_FLAG_SYN, TCP_INPUT_NEXT_DROP,
3639 TCP_ERROR_SEGMENT_INVALID);
3640 _(LISTEN, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_ACK, TCP_INPUT_NEXT_DROP,
3641 TCP_ERROR_SEGMENT_INVALID);
3642 _(LISTEN, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_RST, TCP_INPUT_NEXT_DROP,
3643 TCP_ERROR_SEGMENT_INVALID);
3644 _(LISTEN, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK,
3645 TCP_INPUT_NEXT_DROP, TCP_ERROR_SEGMENT_INVALID);
3646 /* ACK for for a SYN-ACK -> tcp-rcv-process. */
3647 _(SYN_RCVD, TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3648 _(SYN_RCVD, TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3649 _(SYN_RCVD, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3651 _(SYN_RCVD, TCP_FLAG_SYN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3652 _(SYN_RCVD, TCP_FLAG_SYN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3654 _(SYN_RCVD, TCP_FLAG_SYN | TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS,
3656 _(SYN_RCVD, TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK,
3657 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3658 _(SYN_RCVD, TCP_FLAG_FIN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3659 _(SYN_RCVD, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3661 _(SYN_RCVD, TCP_FLAG_FIN | TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS,
3663 _(SYN_RCVD, TCP_FLAG_FIN | TCP_FLAG_RST | TCP_FLAG_ACK,
3664 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3665 _(SYN_RCVD, TCP_FLAG_FIN | TCP_FLAG_SYN, TCP_INPUT_NEXT_RCV_PROCESS,
3667 _(SYN_RCVD, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_RST,
3668 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3669 _(SYN_RCVD, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_ACK,
3670 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3671 _(SYN_RCVD, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK,
3672 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3673 _(SYN_RCVD, 0, TCP_INPUT_NEXT_DROP, TCP_ERROR_SEGMENT_INVALID);
3674 /* SYN-ACK for a SYN */
3675 _(SYN_SENT, TCP_FLAG_SYN | TCP_FLAG_ACK, TCP_INPUT_NEXT_SYN_SENT,
3677 _(SYN_SENT, TCP_FLAG_ACK, TCP_INPUT_NEXT_SYN_SENT, TCP_ERROR_NONE);
3678 _(SYN_SENT, TCP_FLAG_RST, TCP_INPUT_NEXT_SYN_SENT, TCP_ERROR_NONE);
3679 _(SYN_SENT, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_SYN_SENT,
3681 _(SYN_SENT, TCP_FLAG_FIN, TCP_INPUT_NEXT_SYN_SENT, TCP_ERROR_NONE);
3682 _(SYN_SENT, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_SYN_SENT,
3684 /* ACK for for established connection -> tcp-established. */
3685 _(ESTABLISHED, TCP_FLAG_ACK, TCP_INPUT_NEXT_ESTABLISHED, TCP_ERROR_NONE);
3686 /* FIN for for established connection -> tcp-established. */
3687 _(ESTABLISHED, TCP_FLAG_FIN, TCP_INPUT_NEXT_ESTABLISHED, TCP_ERROR_NONE);
3688 _(ESTABLISHED, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_ESTABLISHED,
3690 _(ESTABLISHED, TCP_FLAG_FIN | TCP_FLAG_RST, TCP_INPUT_NEXT_ESTABLISHED,
3692 _(ESTABLISHED, TCP_FLAG_FIN | TCP_FLAG_RST | TCP_FLAG_ACK,
3693 TCP_INPUT_NEXT_ESTABLISHED, TCP_ERROR_NONE);
3694 _(ESTABLISHED, TCP_FLAG_FIN | TCP_FLAG_SYN, TCP_INPUT_NEXT_ESTABLISHED,
3696 _(ESTABLISHED, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_ACK,
3697 TCP_INPUT_NEXT_ESTABLISHED, TCP_ERROR_NONE);
3698 _(ESTABLISHED, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_RST,
3699 TCP_INPUT_NEXT_ESTABLISHED, TCP_ERROR_NONE);
3700 _(ESTABLISHED, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK,
3701 TCP_INPUT_NEXT_ESTABLISHED, TCP_ERROR_NONE);
3702 _(ESTABLISHED, TCP_FLAG_RST, TCP_INPUT_NEXT_ESTABLISHED, TCP_ERROR_NONE);
3703 _(ESTABLISHED, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_ESTABLISHED,
3705 _(ESTABLISHED, TCP_FLAG_SYN, TCP_INPUT_NEXT_ESTABLISHED, TCP_ERROR_NONE);
3706 _(ESTABLISHED, TCP_FLAG_SYN | TCP_FLAG_ACK, TCP_INPUT_NEXT_ESTABLISHED,
3708 _(ESTABLISHED, TCP_FLAG_SYN | TCP_FLAG_RST, TCP_INPUT_NEXT_ESTABLISHED,
3710 _(ESTABLISHED, TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK,
3711 TCP_INPUT_NEXT_ESTABLISHED, TCP_ERROR_NONE);
3712 _(ESTABLISHED, 0, TCP_INPUT_NEXT_DROP, TCP_ERROR_SEGMENT_INVALID);
3713 /* ACK or FIN-ACK to our FIN */
3714 _(FIN_WAIT_1, TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3715 _(FIN_WAIT_1, TCP_FLAG_ACK | TCP_FLAG_FIN, TCP_INPUT_NEXT_RCV_PROCESS,
3717 /* FIN in reply to our FIN from the other side */
3718 _(FIN_WAIT_1, 0, TCP_INPUT_NEXT_DROP, TCP_ERROR_SEGMENT_INVALID);
3719 _(FIN_WAIT_1, TCP_FLAG_FIN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3720 _(FIN_WAIT_1, TCP_FLAG_FIN | TCP_FLAG_SYN, TCP_INPUT_NEXT_RCV_PROCESS,
3722 _(FIN_WAIT_1, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_ACK,
3723 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3724 _(FIN_WAIT_1, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_RST,
3725 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3726 _(FIN_WAIT_1, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK,
3727 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3728 _(FIN_WAIT_1, TCP_FLAG_FIN | TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS,
3730 _(FIN_WAIT_1, TCP_FLAG_FIN | TCP_FLAG_RST | TCP_FLAG_ACK,
3731 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3732 _(FIN_WAIT_1, TCP_FLAG_SYN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3733 _(FIN_WAIT_1, TCP_FLAG_SYN | TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS,
3735 _(FIN_WAIT_1, TCP_FLAG_SYN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3737 _(FIN_WAIT_1, TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK,
3738 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3739 _(FIN_WAIT_1, TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3740 _(FIN_WAIT_1, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3742 _(CLOSING, 0, TCP_INPUT_NEXT_DROP, TCP_ERROR_SEGMENT_INVALID);
3743 _(CLOSING, TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3744 _(CLOSING, TCP_FLAG_SYN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3745 _(CLOSING, TCP_FLAG_SYN | TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS,
3747 _(CLOSING, TCP_FLAG_SYN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3749 _(CLOSING, TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK,
3750 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3751 _(CLOSING, TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3752 _(CLOSING, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3754 _(CLOSING, TCP_FLAG_FIN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3755 _(CLOSING, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3757 _(CLOSING, TCP_FLAG_FIN | TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS,
3759 _(CLOSING, TCP_FLAG_FIN | TCP_FLAG_RST | TCP_FLAG_ACK,
3760 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3761 _(CLOSING, TCP_FLAG_FIN | TCP_FLAG_SYN, TCP_INPUT_NEXT_RCV_PROCESS,
3763 _(CLOSING, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_ACK,
3764 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3765 _(CLOSING, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK,
3766 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3767 /* FIN confirming that the peer (app) has closed */
3768 _(FIN_WAIT_2, TCP_FLAG_FIN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3769 _(FIN_WAIT_2, TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3770 _(FIN_WAIT_2, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3772 _(FIN_WAIT_2, TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3773 _(FIN_WAIT_2, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3775 _(CLOSE_WAIT, TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3776 _(CLOSE_WAIT, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3778 _(CLOSE_WAIT, TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3779 _(CLOSE_WAIT, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3781 _(LAST_ACK, 0, TCP_INPUT_NEXT_DROP, TCP_ERROR_SEGMENT_INVALID);
3782 _(LAST_ACK, TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3783 _(LAST_ACK, TCP_FLAG_FIN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3784 _(LAST_ACK, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3786 _(LAST_ACK, TCP_FLAG_FIN | TCP_FLAG_SYN, TCP_INPUT_NEXT_RCV_PROCESS,
3788 _(LAST_ACK, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_ACK,
3789 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3790 _(LAST_ACK, TCP_FLAG_FIN | TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS,
3792 _(LAST_ACK, TCP_FLAG_FIN | TCP_FLAG_RST | TCP_FLAG_ACK,
3793 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3794 _(LAST_ACK, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_RST,
3795 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3796 _(LAST_ACK, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK,
3797 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3798 _(LAST_ACK, TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3799 _(LAST_ACK, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3801 _(LAST_ACK, TCP_FLAG_SYN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3802 _(LAST_ACK, TCP_FLAG_SYN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3804 _(LAST_ACK, TCP_FLAG_SYN | TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS,
3806 _(LAST_ACK, TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK,
3807 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3808 _(TIME_WAIT, TCP_FLAG_SYN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3809 _(TIME_WAIT, TCP_FLAG_FIN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3810 _(TIME_WAIT, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3812 _(TIME_WAIT, TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3813 _(TIME_WAIT, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3815 _(TIME_WAIT, TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3816 /* RFC793 CLOSED: An incoming segment containing a RST is discarded. An
3817 * incoming segment not containing a RST causes a RST to be sent in
3819 _(CLOSED, TCP_FLAG_RST, TCP_INPUT_NEXT_DROP, TCP_ERROR_CONNECTION_CLOSED);
3820 _(CLOSED, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_DROP,
3821 TCP_ERROR_CONNECTION_CLOSED);
3822 _(CLOSED, TCP_FLAG_ACK, TCP_INPUT_NEXT_RESET, TCP_ERROR_NONE);
3823 _(CLOSED, TCP_FLAG_SYN, TCP_INPUT_NEXT_RESET, TCP_ERROR_NONE);
3824 _(CLOSED, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RESET,
3829 static clib_error_t *
3830 tcp_input_init (vlib_main_t * vm)
3832 clib_error_t *error = 0;
3833 tcp_main_t *tm = vnet_get_tcp_main ();
3835 if ((error = vlib_call_init_function (vm, tcp_init)))
3838 /* Initialize dispatch table. */
3839 tcp_dispatch_table_init (tm);
3844 VLIB_INIT_FUNCTION (tcp_input_init);
3846 #endif /* CLIB_MARCH_VARIANT */
3849 * fd.io coding-style-patch-verification: ON
3852 * eval: (c-set-style "gnu")