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 /* As per RFC5961 send challenge ack instead of reset */
394 tcp_program_ack (wrk, tc0);
395 *error0 = TCP_ERROR_SPURIOUS_SYN;
399 /* If segment in window, save timestamp */
400 tcp_update_timestamp (tc0, vnet_buffer (b0)->tcp.seq_number,
401 vnet_buffer (b0)->tcp.seq_end);
409 tcp_rcv_ack_no_cc (tcp_connection_t * tc, vlib_buffer_t * b, u32 * error)
411 /* SND.UNA =< SEG.ACK =< SND.NXT */
412 if (!(seq_leq (tc->snd_una, vnet_buffer (b)->tcp.ack_number)
413 && seq_leq (vnet_buffer (b)->tcp.ack_number, tc->snd_nxt)))
415 if (seq_leq (vnet_buffer (b)->tcp.ack_number, tc->snd_una_max)
416 && seq_gt (vnet_buffer (b)->tcp.ack_number, tc->snd_una))
418 tc->snd_nxt = vnet_buffer (b)->tcp.ack_number;
421 *error = TCP_ERROR_ACK_INVALID;
426 tc->bytes_acked = vnet_buffer (b)->tcp.ack_number - tc->snd_una;
427 tc->snd_una = vnet_buffer (b)->tcp.ack_number;
428 *error = TCP_ERROR_ACK_OK;
433 * Compute smoothed RTT as per VJ's '88 SIGCOMM and RFC6298
435 * Note that although the original article, srtt and rttvar are scaled
436 * to minimize round-off errors, here we don't. Instead, we rely on
437 * better precision time measurements.
439 * TODO support us rtt resolution
442 tcp_estimate_rtt (tcp_connection_t * tc, u32 mrtt)
448 err = mrtt - tc->srtt;
450 /* XXX Drop in RTT results in RTTVAR increase and bigger RTO.
451 * The increase should be bound */
452 tc->srtt = clib_max ((int) tc->srtt + (err >> 3), 1);
453 diff = (clib_abs (err) - (int) tc->rttvar) >> 2;
454 tc->rttvar = clib_max ((int) tc->rttvar + diff, 1);
458 /* First measurement. */
460 tc->rttvar = mrtt >> 1;
464 #ifndef CLIB_MARCH_VARIANT
466 tcp_update_rto (tcp_connection_t * tc)
468 tc->rto = clib_min (tc->srtt + (tc->rttvar << 2), TCP_RTO_MAX);
469 tc->rto = clib_max (tc->rto, TCP_RTO_MIN);
471 #endif /* CLIB_MARCH_VARIANT */
474 * Update RTT estimate and RTO timer
476 * Measure RTT: We have two sources of RTT measurements: TSOPT and ACK
477 * timing. Middle boxes are known to fiddle with TCP options so we
478 * should give higher priority to ACK timing.
480 * This should be called only if previously sent bytes have been acked.
482 * return 1 if valid rtt 0 otherwise
485 tcp_update_rtt (tcp_connection_t * tc, u32 ack)
489 /* Karn's rule, part 1. Don't use retransmitted segments to estimate
490 * RTT because they're ambiguous. */
491 if (tcp_in_cong_recovery (tc) || tc->sack_sb.sacked_bytes)
493 if (tcp_in_recovery (tc))
498 if (tc->rtt_ts && seq_geq (ack, tc->rtt_seq))
500 f64 sample = tcp_time_now_us (tc->c_thread_index) - tc->rtt_ts;
501 tc->mrtt_us = tc->mrtt_us + (sample - tc->mrtt_us) * 0.125;
502 mrtt = clib_max ((u32) (sample * THZ), 1);
503 /* Allow measuring of a new RTT */
506 /* As per RFC7323 TSecr can be used for RTTM only if the segment advances
507 * snd_una, i.e., the left side of the send window:
508 * seq_lt (tc->snd_una, ack). This is a condition for calling update_rtt */
509 else if (tcp_opts_tstamp (&tc->rcv_opts) && tc->rcv_opts.tsecr)
511 u32 now = tcp_time_now_w_thread (tc->c_thread_index);
512 mrtt = clib_max (now - tc->rcv_opts.tsecr, 1);
515 /* Ignore dubious measurements */
516 if (mrtt == 0 || mrtt > TCP_RTT_MAX)
519 tcp_estimate_rtt (tc, mrtt);
523 /* If we got here something must've been ACKed so make sure boff is 0,
524 * even if mrtt is not valid since we update the rto lower */
532 tcp_estimate_initial_rtt (tcp_connection_t * tc)
534 u8 thread_index = vlib_num_workers ()? 1 : 0;
539 tc->mrtt_us = tcp_time_now_us (thread_index) - tc->rtt_ts;
540 tc->mrtt_us = clib_max (tc->mrtt_us, 0.0001);
541 mrtt = clib_max ((u32) (tc->mrtt_us * THZ), 1);
546 mrtt = tcp_time_now_w_thread (thread_index) - tc->rcv_opts.tsecr;
547 mrtt = clib_max (mrtt, 1);
548 /* Due to retransmits we don't know the initial mrtt */
549 if (tc->rto_boff && mrtt > 1 * THZ)
551 tc->mrtt_us = (f64) mrtt *TCP_TICK;
554 if (mrtt > 0 && mrtt < TCP_RTT_MAX)
555 tcp_estimate_rtt (tc, mrtt);
560 * Dequeue bytes for connections that have received acks in last burst
563 tcp_handle_postponed_dequeues (tcp_worker_ctx_t * wrk)
565 u32 thread_index = wrk->vm->thread_index;
566 u32 *pending_deq_acked;
567 tcp_connection_t *tc;
570 if (!vec_len (wrk->pending_deq_acked))
573 pending_deq_acked = wrk->pending_deq_acked;
574 for (i = 0; i < vec_len (pending_deq_acked); i++)
576 tc = tcp_connection_get (pending_deq_acked[i], thread_index);
577 tc->flags &= ~TCP_CONN_DEQ_PENDING;
579 if (PREDICT_FALSE (!tc->burst_acked))
582 /* Dequeue the newly ACKed bytes */
583 session_tx_fifo_dequeue_drop (&tc->connection, tc->burst_acked);
585 tcp_validate_txf_size (tc, tc->snd_una_max - tc->snd_una);
587 if (PREDICT_FALSE (tc->flags & TCP_CONN_PSH_PENDING))
589 if (seq_leq (tc->psh_seq, tc->snd_una))
590 tc->flags &= ~TCP_CONN_PSH_PENDING;
593 /* If everything has been acked, stop retransmit timer
594 * otherwise update. */
595 tcp_retransmit_timer_update (tc);
597 /* If not congested, update pacer based on our new
599 if (!tcp_in_fastrecovery (tc))
600 tcp_connection_tx_pacer_update (tc);
602 _vec_len (wrk->pending_deq_acked) = 0;
606 tcp_program_dequeue (tcp_worker_ctx_t * wrk, tcp_connection_t * tc)
608 if (!(tc->flags & TCP_CONN_DEQ_PENDING))
610 vec_add1 (wrk->pending_deq_acked, tc->c_c_index);
611 tc->flags |= TCP_CONN_DEQ_PENDING;
613 tc->burst_acked += tc->bytes_acked + tc->sack_sb.snd_una_adv;
617 * Check if duplicate ack as per RFC5681 Sec. 2
620 tcp_ack_is_dupack (tcp_connection_t * tc, vlib_buffer_t * b, u32 prev_snd_wnd,
623 return ((vnet_buffer (b)->tcp.ack_number == prev_snd_una)
624 && seq_gt (tc->snd_nxt, tc->snd_una)
625 && (vnet_buffer (b)->tcp.seq_end == vnet_buffer (b)->tcp.seq_number)
626 && (prev_snd_wnd == tc->snd_wnd));
630 * Checks if ack is a congestion control event.
633 tcp_ack_is_cc_event (tcp_connection_t * tc, vlib_buffer_t * b,
634 u32 prev_snd_wnd, u32 prev_snd_una, u8 * is_dack)
636 /* Check if ack is duplicate. Per RFC 6675, ACKs that SACK new data are
637 * defined to be 'duplicate' */
638 *is_dack = tc->sack_sb.last_sacked_bytes
639 || tcp_ack_is_dupack (tc, b, prev_snd_wnd, prev_snd_una);
641 return ((*is_dack || tcp_in_cong_recovery (tc)) && !tcp_is_lost_fin (tc));
644 #ifndef CLIB_MARCH_VARIANT
646 scoreboard_hole_index (sack_scoreboard_t * sb, sack_scoreboard_hole_t * hole)
648 ASSERT (!pool_is_free_index (sb->holes, hole - sb->holes));
649 return hole - sb->holes;
653 scoreboard_hole_bytes (sack_scoreboard_hole_t * hole)
655 return hole->end - hole->start;
658 sack_scoreboard_hole_t *
659 scoreboard_get_hole (sack_scoreboard_t * sb, u32 index)
661 if (index != TCP_INVALID_SACK_HOLE_INDEX)
662 return pool_elt_at_index (sb->holes, index);
666 sack_scoreboard_hole_t *
667 scoreboard_next_hole (sack_scoreboard_t * sb, sack_scoreboard_hole_t * hole)
669 if (hole->next != TCP_INVALID_SACK_HOLE_INDEX)
670 return pool_elt_at_index (sb->holes, hole->next);
674 sack_scoreboard_hole_t *
675 scoreboard_prev_hole (sack_scoreboard_t * sb, sack_scoreboard_hole_t * hole)
677 if (hole->prev != TCP_INVALID_SACK_HOLE_INDEX)
678 return pool_elt_at_index (sb->holes, hole->prev);
682 sack_scoreboard_hole_t *
683 scoreboard_first_hole (sack_scoreboard_t * sb)
685 if (sb->head != TCP_INVALID_SACK_HOLE_INDEX)
686 return pool_elt_at_index (sb->holes, sb->head);
690 sack_scoreboard_hole_t *
691 scoreboard_last_hole (sack_scoreboard_t * sb)
693 if (sb->tail != TCP_INVALID_SACK_HOLE_INDEX)
694 return pool_elt_at_index (sb->holes, sb->tail);
699 scoreboard_remove_hole (sack_scoreboard_t * sb, sack_scoreboard_hole_t * hole)
701 sack_scoreboard_hole_t *next, *prev;
703 if (hole->next != TCP_INVALID_SACK_HOLE_INDEX)
705 next = pool_elt_at_index (sb->holes, hole->next);
706 next->prev = hole->prev;
710 sb->tail = hole->prev;
713 if (hole->prev != TCP_INVALID_SACK_HOLE_INDEX)
715 prev = pool_elt_at_index (sb->holes, hole->prev);
716 prev->next = hole->next;
720 sb->head = hole->next;
723 if (scoreboard_hole_index (sb, hole) == sb->cur_rxt_hole)
724 sb->cur_rxt_hole = TCP_INVALID_SACK_HOLE_INDEX;
726 /* Poison the entry */
728 clib_memset (hole, 0xfe, sizeof (*hole));
730 pool_put (sb->holes, hole);
733 static sack_scoreboard_hole_t *
734 scoreboard_insert_hole (sack_scoreboard_t * sb, u32 prev_index,
737 sack_scoreboard_hole_t *hole, *next, *prev;
740 pool_get (sb->holes, hole);
741 clib_memset (hole, 0, sizeof (*hole));
745 hole_index = scoreboard_hole_index (sb, hole);
747 prev = scoreboard_get_hole (sb, prev_index);
750 hole->prev = prev_index;
751 hole->next = prev->next;
753 if ((next = scoreboard_next_hole (sb, hole)))
754 next->prev = hole_index;
756 sb->tail = hole_index;
758 prev->next = hole_index;
762 sb->head = hole_index;
763 hole->prev = TCP_INVALID_SACK_HOLE_INDEX;
764 hole->next = TCP_INVALID_SACK_HOLE_INDEX;
769 #endif /* CLIB_MARCH_VARIANT */
771 #ifndef CLIB_MARCH_VARIANT
773 scoreboard_update_bytes (tcp_connection_t * tc, sack_scoreboard_t * sb)
775 sack_scoreboard_hole_t *left, *right;
776 u32 bytes = 0, blks = 0;
779 sb->sacked_bytes = 0;
780 left = scoreboard_last_hole (sb);
784 if (seq_gt (sb->high_sacked, left->end))
786 bytes = sb->high_sacked - left->end;
790 while ((right = left)
791 && bytes < (TCP_DUPACK_THRESHOLD - 1) * tc->snd_mss
792 && blks < TCP_DUPACK_THRESHOLD
793 /* left not updated if above conditions fail */
794 && (left = scoreboard_prev_hole (sb, right)))
796 bytes += right->start - left->end;
800 /* left is first lost */
805 sb->lost_bytes += scoreboard_hole_bytes (right);
807 left = scoreboard_prev_hole (sb, right);
809 bytes += right->start - left->end;
811 while ((right = left));
814 sb->sacked_bytes = bytes;
818 * Figure out the next hole to retransmit
820 * Follows logic proposed in RFC6675 Sec. 4, NextSeg()
822 sack_scoreboard_hole_t *
823 scoreboard_next_rxt_hole (sack_scoreboard_t * sb,
824 sack_scoreboard_hole_t * start,
825 u8 have_unsent, u8 * can_rescue, u8 * snd_limited)
827 sack_scoreboard_hole_t *hole = 0;
829 hole = start ? start : scoreboard_first_hole (sb);
830 while (hole && seq_leq (hole->end, sb->high_rxt) && hole->is_lost)
831 hole = scoreboard_next_hole (sb, hole);
833 /* Nothing, return */
836 sb->cur_rxt_hole = TCP_INVALID_SACK_HOLE_INDEX;
840 /* Rule (1): if higher than rxt, less than high_sacked and lost */
841 if (hole->is_lost && seq_lt (hole->start, sb->high_sacked))
843 sb->cur_rxt_hole = scoreboard_hole_index (sb, hole);
847 /* Rule (2): available unsent data */
850 sb->cur_rxt_hole = TCP_INVALID_SACK_HOLE_INDEX;
853 /* Rule (3): if hole not lost */
854 else if (seq_lt (hole->start, sb->high_sacked))
857 sb->cur_rxt_hole = scoreboard_hole_index (sb, hole);
859 /* Rule (4): if hole beyond high_sacked */
862 ASSERT (seq_geq (hole->start, sb->high_sacked));
865 /* HighRxt MUST NOT be updated */
870 if (hole && seq_lt (sb->high_rxt, hole->start))
871 sb->high_rxt = hole->start;
875 #endif /* CLIB_MARCH_VARIANT */
878 scoreboard_init_high_rxt (sack_scoreboard_t * sb, u32 snd_una)
880 sack_scoreboard_hole_t *hole;
881 hole = scoreboard_first_hole (sb);
884 snd_una = seq_gt (snd_una, hole->start) ? snd_una : hole->start;
885 sb->cur_rxt_hole = sb->head;
887 sb->high_rxt = snd_una;
888 sb->rescue_rxt = snd_una - 1;
891 #ifndef CLIB_MARCH_VARIANT
893 scoreboard_init (sack_scoreboard_t * sb)
895 sb->head = TCP_INVALID_SACK_HOLE_INDEX;
896 sb->tail = TCP_INVALID_SACK_HOLE_INDEX;
897 sb->cur_rxt_hole = TCP_INVALID_SACK_HOLE_INDEX;
901 scoreboard_clear (sack_scoreboard_t * sb)
903 sack_scoreboard_hole_t *hole;
904 while ((hole = scoreboard_first_hole (sb)))
906 scoreboard_remove_hole (sb, hole);
908 ASSERT (sb->head == sb->tail && sb->head == TCP_INVALID_SACK_HOLE_INDEX);
909 ASSERT (pool_elts (sb->holes) == 0);
910 sb->sacked_bytes = 0;
911 sb->last_sacked_bytes = 0;
912 sb->last_bytes_delivered = 0;
917 sb->cur_rxt_hole = TCP_INVALID_SACK_HOLE_INDEX;
919 #endif /* CLIB_MARCH_VARIANT */
922 * Test that scoreboard is sane after recovery
924 * Returns 1 if scoreboard is empty or if first hole beyond
928 tcp_scoreboard_is_sane_post_recovery (tcp_connection_t * tc)
930 sack_scoreboard_hole_t *hole;
931 hole = scoreboard_first_hole (&tc->sack_sb);
932 return (!hole || (seq_geq (hole->start, tc->snd_una)
933 && seq_lt (hole->end, tc->snd_nxt)));
936 #ifndef CLIB_MARCH_VARIANT
938 tcp_rcv_sacks (tcp_connection_t * tc, u32 ack)
940 sack_scoreboard_t *sb = &tc->sack_sb;
941 sack_block_t *blk, tmp;
942 sack_scoreboard_hole_t *hole, *next_hole, *last_hole;
943 u32 blk_index = 0, old_sacked_bytes, hole_index;
946 sb->last_sacked_bytes = 0;
947 sb->last_bytes_delivered = 0;
950 if (!tcp_opts_sack (&tc->rcv_opts)
951 && sb->head == TCP_INVALID_SACK_HOLE_INDEX)
954 old_sacked_bytes = sb->sacked_bytes;
956 /* Remove invalid blocks */
957 blk = tc->rcv_opts.sacks;
958 while (blk < vec_end (tc->rcv_opts.sacks))
960 if (seq_lt (blk->start, blk->end)
961 && seq_gt (blk->start, tc->snd_una)
962 && seq_gt (blk->start, ack)
963 && seq_lt (blk->start, tc->snd_nxt)
964 && seq_leq (blk->end, tc->snd_nxt))
969 vec_del1 (tc->rcv_opts.sacks, blk - tc->rcv_opts.sacks);
972 /* Add block for cumulative ack */
973 if (seq_gt (ack, tc->snd_una))
975 tmp.start = tc->snd_una;
977 vec_add1 (tc->rcv_opts.sacks, tmp);
980 if (vec_len (tc->rcv_opts.sacks) == 0)
983 tcp_scoreboard_trace_add (tc, ack);
985 /* Make sure blocks are ordered */
986 for (i = 0; i < vec_len (tc->rcv_opts.sacks); i++)
987 for (j = i + 1; j < vec_len (tc->rcv_opts.sacks); j++)
988 if (seq_lt (tc->rcv_opts.sacks[j].start, tc->rcv_opts.sacks[i].start))
990 tmp = tc->rcv_opts.sacks[i];
991 tc->rcv_opts.sacks[i] = tc->rcv_opts.sacks[j];
992 tc->rcv_opts.sacks[j] = tmp;
995 if (sb->head == TCP_INVALID_SACK_HOLE_INDEX)
997 /* If no holes, insert the first that covers all outstanding bytes */
998 last_hole = scoreboard_insert_hole (sb, TCP_INVALID_SACK_HOLE_INDEX,
999 tc->snd_una, tc->snd_nxt);
1000 sb->tail = scoreboard_hole_index (sb, last_hole);
1001 tmp = tc->rcv_opts.sacks[vec_len (tc->rcv_opts.sacks) - 1];
1002 sb->high_sacked = tmp.end;
1006 /* If we have holes but snd_una_max is beyond the last hole, update
1008 tmp = tc->rcv_opts.sacks[vec_len (tc->rcv_opts.sacks) - 1];
1009 last_hole = scoreboard_last_hole (sb);
1010 if (seq_gt (tc->snd_nxt, last_hole->end))
1012 if (seq_geq (last_hole->start, sb->high_sacked))
1014 last_hole->end = tc->snd_nxt;
1016 /* New hole after high sacked block */
1017 else if (seq_lt (sb->high_sacked, tc->snd_nxt))
1019 scoreboard_insert_hole (sb, sb->tail, sb->high_sacked,
1023 /* Keep track of max byte sacked for when the last hole
1025 if (seq_gt (tmp.end, sb->high_sacked))
1026 sb->high_sacked = tmp.end;
1029 /* Walk the holes with the SACK blocks */
1030 hole = pool_elt_at_index (sb->holes, sb->head);
1031 while (hole && blk_index < vec_len (tc->rcv_opts.sacks))
1033 blk = &tc->rcv_opts.sacks[blk_index];
1034 if (seq_leq (blk->start, hole->start))
1036 /* Block covers hole. Remove hole */
1037 if (seq_geq (blk->end, hole->end))
1039 next_hole = scoreboard_next_hole (sb, hole);
1041 /* Byte accounting: snd_una needs to be advanced */
1042 if (blk->end == ack)
1046 if (seq_lt (ack, next_hole->start))
1047 sb->snd_una_adv = next_hole->start - ack;
1048 sb->last_bytes_delivered +=
1049 next_hole->start - hole->end;
1053 ASSERT (seq_geq (sb->high_sacked, ack));
1054 sb->snd_una_adv = sb->high_sacked - ack;
1055 sb->last_bytes_delivered += sb->high_sacked - hole->end;
1059 scoreboard_remove_hole (sb, hole);
1062 /* Partial 'head' overlap */
1065 if (seq_gt (blk->end, hole->start))
1067 hole->start = blk->end;
1074 /* Hole must be split */
1075 if (seq_lt (blk->end, hole->end))
1077 hole_index = scoreboard_hole_index (sb, hole);
1078 next_hole = scoreboard_insert_hole (sb, hole_index, blk->end,
1081 /* Pool might've moved */
1082 hole = scoreboard_get_hole (sb, hole_index);
1083 hole->end = blk->start;
1085 ASSERT (hole->next == scoreboard_hole_index (sb, next_hole));
1087 else if (seq_lt (blk->start, hole->end))
1089 hole->end = blk->start;
1091 hole = scoreboard_next_hole (sb, hole);
1095 if (pool_elts (sb->holes) == 1)
1097 hole = scoreboard_first_hole (sb);
1098 if (hole->start == ack + sb->snd_una_adv && hole->end == tc->snd_nxt)
1099 scoreboard_remove_hole (sb, hole);
1102 scoreboard_update_bytes (tc, sb);
1103 sb->last_sacked_bytes = sb->sacked_bytes
1104 - (old_sacked_bytes - sb->last_bytes_delivered);
1105 ASSERT (sb->last_sacked_bytes <= sb->sacked_bytes || tcp_in_recovery (tc));
1106 ASSERT (sb->sacked_bytes == 0 || tcp_in_recovery (tc)
1107 || sb->sacked_bytes < tc->snd_nxt - seq_max (tc->snd_una, ack));
1108 ASSERT (sb->last_sacked_bytes + sb->lost_bytes <= tc->snd_nxt
1109 - seq_max (tc->snd_una, ack) || tcp_in_recovery (tc));
1110 ASSERT (sb->head == TCP_INVALID_SACK_HOLE_INDEX || tcp_in_recovery (tc)
1111 || sb->holes[sb->head].start == ack + sb->snd_una_adv);
1112 TCP_EVT_DBG (TCP_EVT_CC_SCOREBOARD, tc);
1114 #endif /* CLIB_MARCH_VARIANT */
1117 * Try to update snd_wnd based on feedback received from peer.
1119 * If successful, and new window is 'effectively' 0, activate persist
1123 tcp_update_snd_wnd (tcp_connection_t * tc, u32 seq, u32 ack, u32 snd_wnd)
1125 /* If (SND.WL1 < SEG.SEQ or (SND.WL1 = SEG.SEQ and SND.WL2 =< SEG.ACK)), set
1126 * SND.WND <- SEG.WND, set SND.WL1 <- SEG.SEQ, and set SND.WL2 <- SEG.ACK */
1127 if (seq_lt (tc->snd_wl1, seq)
1128 || (tc->snd_wl1 == seq && seq_leq (tc->snd_wl2, ack)))
1130 tc->snd_wnd = snd_wnd;
1133 TCP_EVT_DBG (TCP_EVT_SND_WND, tc);
1135 if (PREDICT_FALSE (tc->snd_wnd < tc->snd_mss))
1137 /* Set persist timer if not set and we just got 0 wnd */
1138 if (!tcp_timer_is_active (tc, TCP_TIMER_PERSIST)
1139 && !tcp_timer_is_active (tc, TCP_TIMER_RETRANSMIT))
1140 tcp_persist_timer_set (tc);
1144 tcp_persist_timer_reset (tc);
1145 if (PREDICT_FALSE (!tcp_in_recovery (tc) && tc->rto_boff > 0))
1148 tcp_update_rto (tc);
1154 #ifndef CLIB_MARCH_VARIANT
1156 * Init loss recovery/fast recovery.
1158 * Triggered by dup acks as opposed to timer timeout. Note that cwnd is
1159 * updated in @ref tcp_cc_handle_event after fast retransmit
1162 tcp_cc_init_congestion (tcp_connection_t * tc)
1164 tcp_fastrecovery_on (tc);
1165 tc->snd_congestion = tc->snd_nxt;
1166 tc->cwnd_acc_bytes = 0;
1167 tc->snd_rxt_bytes = 0;
1168 tc->prev_ssthresh = tc->ssthresh;
1169 tc->prev_cwnd = tc->cwnd;
1170 tc->cc_algo->congestion (tc);
1171 TCP_EVT_DBG (TCP_EVT_CC_EVT, tc, 4);
1173 #endif /* CLIB_MARCH_VARIANT */
1176 tcp_cc_recovery_exit (tcp_connection_t * tc)
1179 tcp_update_rto (tc);
1182 tcp_recovery_off (tc);
1183 TCP_EVT_DBG (TCP_EVT_CC_EVT, tc, 3);
1186 #ifndef CLIB_MARCH_VARIANT
1188 tcp_cc_fastrecovery_exit (tcp_connection_t * tc)
1190 tc->cc_algo->recovered (tc);
1191 tc->snd_rxt_bytes = 0;
1192 tc->rcv_dupacks = 0;
1193 tc->snd_rxt_bytes = 0;
1196 tcp_fastrecovery_off (tc);
1197 tcp_fastrecovery_first_off (tc);
1199 TCP_EVT_DBG (TCP_EVT_CC_EVT, tc, 3);
1201 #endif /* CLIB_MARCH_VARIANT */
1204 tcp_cc_congestion_undo (tcp_connection_t * tc)
1206 tc->cwnd = tc->prev_cwnd;
1207 tc->ssthresh = tc->prev_ssthresh;
1208 tc->rcv_dupacks = 0;
1209 if (tcp_in_recovery (tc))
1211 tcp_cc_recovery_exit (tc);
1212 tc->snd_nxt = seq_max (tc->snd_nxt, tc->snd_congestion);
1214 else if (tcp_in_fastrecovery (tc))
1216 tcp_cc_fastrecovery_exit (tc);
1218 ASSERT (tc->rto_boff == 0);
1219 TCP_EVT_DBG (TCP_EVT_CC_EVT, tc, 5);
1223 tcp_cc_is_spurious_timeout_rxt (tcp_connection_t * tc)
1225 return (tcp_in_recovery (tc) && tc->rto_boff == 1
1227 && tcp_opts_tstamp (&tc->rcv_opts)
1228 && timestamp_lt (tc->rcv_opts.tsecr, tc->snd_rxt_ts));
1232 tcp_cc_is_spurious_fast_rxt (tcp_connection_t * tc)
1234 return (tcp_in_fastrecovery (tc)
1235 && tc->cwnd > tc->ssthresh + 3 * tc->snd_mss);
1239 tcp_cc_is_spurious_retransmit (tcp_connection_t * tc)
1241 return (tcp_cc_is_spurious_timeout_rxt (tc)
1242 || tcp_cc_is_spurious_fast_rxt (tc));
1246 tcp_cc_recover (tcp_connection_t * tc)
1248 ASSERT (tcp_in_cong_recovery (tc));
1249 if (tcp_cc_is_spurious_retransmit (tc))
1251 tcp_cc_congestion_undo (tc);
1255 if (tcp_in_recovery (tc))
1256 tcp_cc_recovery_exit (tc);
1257 else if (tcp_in_fastrecovery (tc))
1258 tcp_cc_fastrecovery_exit (tc);
1260 ASSERT (tc->rto_boff == 0);
1261 ASSERT (!tcp_in_cong_recovery (tc));
1262 ASSERT (tcp_scoreboard_is_sane_post_recovery (tc));
1267 tcp_cc_update (tcp_connection_t * tc, tcp_rate_sample_t * rs)
1269 ASSERT (!tcp_in_cong_recovery (tc) || tcp_is_lost_fin (tc));
1271 /* Congestion avoidance */
1272 tcp_cc_rcv_ack (tc, rs);
1274 /* If a cumulative ack, make sure dupacks is 0 */
1275 tc->rcv_dupacks = 0;
1277 /* When dupacks hits the threshold we only enter fast retransmit if
1278 * cumulative ack covers more than snd_congestion. Should snd_una
1279 * wrap this test may fail under otherwise valid circumstances.
1280 * Therefore, proactively update snd_congestion when wrap detected. */
1282 (seq_leq (tc->snd_congestion, tc->snd_una - tc->bytes_acked)
1283 && seq_gt (tc->snd_congestion, tc->snd_una)))
1284 tc->snd_congestion = tc->snd_una - 1;
1288 tcp_should_fastrecover_sack (tcp_connection_t * tc)
1290 return (TCP_DUPACK_THRESHOLD - 1) * tc->snd_mss < tc->sack_sb.sacked_bytes;
1294 tcp_should_fastrecover (tcp_connection_t * tc)
1296 return (tc->rcv_dupacks == TCP_DUPACK_THRESHOLD
1297 || tcp_should_fastrecover_sack (tc));
1300 #ifndef CLIB_MARCH_VARIANT
1302 tcp_program_fastretransmit (tcp_worker_ctx_t * wrk, tcp_connection_t * tc)
1304 if (!(tc->flags & TCP_CONN_FRXT_PENDING))
1306 vec_add1 (wrk->pending_fast_rxt, tc->c_c_index);
1307 tc->flags |= TCP_CONN_FRXT_PENDING;
1312 tcp_do_fastretransmits (tcp_worker_ctx_t * wrk)
1314 u32 *ongoing_fast_rxt, burst_bytes, sent_bytes, thread_index;
1315 u32 max_burst_size, burst_size, n_segs = 0, n_segs_now;
1316 tcp_connection_t *tc;
1320 if (vec_len (wrk->pending_fast_rxt) == 0
1321 && vec_len (wrk->postponed_fast_rxt) == 0)
1324 thread_index = wrk->vm->thread_index;
1325 last_cpu_time = wrk->vm->clib_time.last_cpu_time;
1326 ongoing_fast_rxt = wrk->ongoing_fast_rxt;
1327 vec_append (ongoing_fast_rxt, wrk->postponed_fast_rxt);
1328 vec_append (ongoing_fast_rxt, wrk->pending_fast_rxt);
1330 _vec_len (wrk->postponed_fast_rxt) = 0;
1331 _vec_len (wrk->pending_fast_rxt) = 0;
1333 max_burst_size = VLIB_FRAME_SIZE / vec_len (ongoing_fast_rxt);
1334 max_burst_size = clib_max (max_burst_size, 1);
1336 for (i = 0; i < vec_len (ongoing_fast_rxt); i++)
1338 tc = tcp_connection_get (ongoing_fast_rxt[i], thread_index);
1341 if (!tcp_in_fastrecovery (tc))
1343 tc->flags &= ~TCP_CONN_FRXT_PENDING;
1347 if (n_segs >= VLIB_FRAME_SIZE)
1349 vec_add1 (wrk->postponed_fast_rxt, ongoing_fast_rxt[i]);
1353 tc->flags &= ~TCP_CONN_FRXT_PENDING;
1354 burst_size = clib_min (max_burst_size, VLIB_FRAME_SIZE - n_segs);
1355 burst_bytes = transport_connection_tx_pacer_burst (&tc->connection,
1357 burst_size = clib_min (burst_size, burst_bytes / tc->snd_mss);
1360 tcp_program_fastretransmit (wrk, tc);
1364 n_segs_now = tcp_fast_retransmit (wrk, tc, burst_size);
1365 sent_bytes = clib_min (n_segs_now * tc->snd_mss, burst_bytes);
1366 transport_connection_tx_pacer_update_bytes (&tc->connection,
1368 n_segs += n_segs_now;
1370 _vec_len (ongoing_fast_rxt) = 0;
1371 wrk->ongoing_fast_rxt = ongoing_fast_rxt;
1373 #endif /* CLIB_MARCH_VARIANT */
1376 * One function to rule them all ... and in the darkness bind them
1379 tcp_cc_handle_event (tcp_connection_t * tc, tcp_rate_sample_t * rs,
1384 if (tcp_in_fastrecovery (tc) && tcp_opts_sack_permitted (&tc->rcv_opts))
1386 if (tc->bytes_acked)
1388 tcp_program_fastretransmit (tcp_get_worker (tc->c_thread_index), tc);
1392 * Duplicate ACK. Check if we should enter fast recovery, or if already in
1393 * it account for the bytes that left the network.
1395 else if (is_dack && !tcp_in_recovery (tc))
1397 TCP_EVT_DBG (TCP_EVT_DUPACK_RCVD, tc, 1);
1398 ASSERT (tc->snd_una != tc->snd_nxt || tc->sack_sb.last_sacked_bytes);
1402 /* Pure duplicate ack. If some data got acked, it's handled lower */
1403 if (tc->rcv_dupacks > TCP_DUPACK_THRESHOLD && !tc->bytes_acked)
1405 ASSERT (tcp_in_fastrecovery (tc));
1406 tcp_cc_rcv_cong_ack (tc, TCP_CC_DUPACK, rs);
1409 else if (tcp_should_fastrecover (tc))
1413 ASSERT (!tcp_in_fastrecovery (tc));
1415 /* Heuristic to catch potential late dupacks
1416 * after fast retransmit exits */
1417 if (is_dack && tc->snd_una == tc->snd_congestion
1418 && timestamp_leq (tc->rcv_opts.tsecr, tc->tsecr_last_ack))
1420 tc->rcv_dupacks = 0;
1424 tcp_cc_init_congestion (tc);
1425 tcp_cc_rcv_cong_ack (tc, TCP_CC_DUPACK, rs);
1427 if (tcp_opts_sack_permitted (&tc->rcv_opts))
1429 tc->cwnd = tc->ssthresh;
1430 scoreboard_init_high_rxt (&tc->sack_sb, tc->snd_una);
1434 /* Post retransmit update cwnd to ssthresh and account for the
1435 * three segments that have left the network and should've been
1436 * buffered at the receiver XXX */
1437 tc->cwnd = tc->ssthresh + 3 * tc->snd_mss;
1440 /* Constrain rate until we get a partial ack */
1441 pacer_wnd = clib_max (0.1 * tc->cwnd, 2 * tc->snd_mss);
1442 tcp_connection_tx_pacer_reset (tc, pacer_wnd,
1443 0 /* start bucket */ );
1444 tcp_program_fastretransmit (tcp_get_worker (tc->c_thread_index),
1448 else if (!tc->bytes_acked
1449 || (tc->bytes_acked && !tcp_in_cong_recovery (tc)))
1451 tcp_cc_rcv_cong_ack (tc, TCP_CC_DUPACK, rs);
1457 /* Don't allow entry in fast recovery if still in recovery, for now */
1458 else if (0 && is_dack && tcp_in_recovery (tc))
1460 /* If of of the two conditions lower hold, reset dupacks because
1461 * we're probably after timeout (RFC6582 heuristics).
1462 * If Cumulative ack does not cover more than congestion threshold,
1464 * 1) The following doesn't hold: The congestion window is greater
1465 * than SMSS bytes and the difference between highest_ack
1466 * and prev_highest_ack is at most 4*SMSS bytes
1467 * 2) Echoed timestamp in the last non-dup ack does not equal the
1470 if (seq_leq (tc->snd_una, tc->snd_congestion)
1471 && ((!(tc->cwnd > tc->snd_mss
1472 && tc->bytes_acked <= 4 * tc->snd_mss))
1473 || (tc->rcv_opts.tsecr != tc->tsecr_last_ack)))
1475 tc->rcv_dupacks = 0;
1480 if (!tc->bytes_acked)
1484 TCP_EVT_DBG (TCP_EVT_CC_PACK, tc);
1487 * Legitimate ACK. 1) See if we can exit recovery
1490 /* Update the pacing rate. For the first partial ack we move from
1491 * the artificially constrained rate to the one after congestion */
1492 tcp_connection_tx_pacer_update (tc);
1494 if (seq_geq (tc->snd_una, tc->snd_congestion))
1496 tcp_retransmit_timer_update (tc);
1498 /* If spurious return, we've already updated everything */
1499 if (tcp_cc_recover (tc))
1501 tc->tsecr_last_ack = tc->rcv_opts.tsecr;
1505 /* Treat as congestion avoidance ack */
1506 tcp_cc_rcv_ack (tc, rs);
1511 * Legitimate ACK. 2) If PARTIAL ACK try to retransmit
1514 /* XXX limit this only to first partial ack? */
1515 tcp_retransmit_timer_update (tc);
1517 /* RFC6675: If the incoming ACK is a cumulative acknowledgment,
1518 * reset dupacks to 0. Also needed if in congestion recovery */
1519 tc->rcv_dupacks = 0;
1521 /* Post RTO timeout don't try anything fancy */
1522 if (tcp_in_recovery (tc))
1524 tcp_cc_rcv_ack (tc, rs);
1525 transport_add_tx_event (&tc->connection);
1529 /* Remove retransmitted bytes that have been delivered */
1530 if (tcp_opts_sack_permitted (&tc->rcv_opts))
1532 ASSERT (tc->bytes_acked + tc->sack_sb.snd_una_adv
1533 >= tc->sack_sb.last_bytes_delivered
1534 || (tc->flags & TCP_CONN_FINSNT));
1536 /* If we have sacks and we haven't gotten an ack beyond high_rxt,
1537 * remove sacked bytes delivered */
1538 if (seq_lt (tc->snd_una, tc->sack_sb.high_rxt))
1540 rxt_delivered = tc->bytes_acked + tc->sack_sb.snd_una_adv
1541 - tc->sack_sb.last_bytes_delivered;
1542 ASSERT (tc->snd_rxt_bytes >= rxt_delivered);
1543 tc->snd_rxt_bytes -= rxt_delivered;
1547 /* Apparently all retransmitted holes have been acked */
1548 tc->snd_rxt_bytes = 0;
1549 tc->sack_sb.high_rxt = tc->snd_una;
1554 tcp_fastrecovery_first_on (tc);
1555 if (tc->snd_rxt_bytes > tc->bytes_acked)
1556 tc->snd_rxt_bytes -= tc->bytes_acked;
1558 tc->snd_rxt_bytes = 0;
1561 tcp_cc_rcv_cong_ack (tc, TCP_CC_PARTIALACK, rs);
1564 * Since this was a partial ack, try to retransmit some more data
1566 tcp_program_fastretransmit (tcp_get_worker (tc->c_thread_index), tc);
1570 * Process incoming ACK
1573 tcp_rcv_ack (tcp_worker_ctx_t * wrk, tcp_connection_t * tc, vlib_buffer_t * b,
1574 tcp_header_t * th, u32 * error)
1576 u32 prev_snd_wnd, prev_snd_una;
1577 tcp_rate_sample_t rs = { 0 };
1580 TCP_EVT_DBG (TCP_EVT_CC_STAT, tc);
1582 /* If the ACK acks something not yet sent (SEG.ACK > SND.NXT) */
1583 if (PREDICT_FALSE (seq_gt (vnet_buffer (b)->tcp.ack_number, tc->snd_nxt)))
1585 /* We've probably entered recovery and the peer still has some
1586 * of the data we've sent. Update snd_nxt and accept the ack */
1587 if (seq_leq (vnet_buffer (b)->tcp.ack_number, tc->snd_una_max)
1588 && seq_gt (vnet_buffer (b)->tcp.ack_number, tc->snd_una))
1590 tc->snd_nxt = vnet_buffer (b)->tcp.ack_number;
1594 *error = TCP_ERROR_ACK_FUTURE;
1595 TCP_EVT_DBG (TCP_EVT_ACK_RCV_ERR, tc, 0,
1596 vnet_buffer (b)->tcp.ack_number);
1600 /* If old ACK, probably it's an old dupack */
1601 if (PREDICT_FALSE (seq_lt (vnet_buffer (b)->tcp.ack_number, tc->snd_una)))
1603 *error = TCP_ERROR_ACK_OLD;
1604 TCP_EVT_DBG (TCP_EVT_ACK_RCV_ERR, tc, 1,
1605 vnet_buffer (b)->tcp.ack_number);
1606 if (tcp_in_fastrecovery (tc) && tc->rcv_dupacks == TCP_DUPACK_THRESHOLD)
1607 tcp_cc_handle_event (tc, 0, 1);
1608 /* Don't drop yet */
1615 * Looks okay, process feedback
1617 if (tcp_opts_sack_permitted (&tc->rcv_opts))
1618 tcp_rcv_sacks (tc, vnet_buffer (b)->tcp.ack_number);
1620 prev_snd_wnd = tc->snd_wnd;
1621 prev_snd_una = tc->snd_una;
1622 tcp_update_snd_wnd (tc, vnet_buffer (b)->tcp.seq_number,
1623 vnet_buffer (b)->tcp.ack_number,
1624 clib_net_to_host_u16 (th->window) << tc->snd_wscale);
1625 tc->bytes_acked = vnet_buffer (b)->tcp.ack_number - tc->snd_una;
1626 tc->snd_una = vnet_buffer (b)->tcp.ack_number + tc->sack_sb.snd_una_adv;
1627 tcp_validate_txf_size (tc, tc->bytes_acked);
1629 if (tc->bytes_acked)
1631 tcp_program_dequeue (wrk, tc);
1632 tcp_update_rtt (tc, vnet_buffer (b)->tcp.ack_number);
1635 if (tc->flags & TCP_CONN_RATE_SAMPLE)
1636 tcp_bt_sample_delivery_rate (tc, &rs);
1638 TCP_EVT_DBG (TCP_EVT_ACK_RCVD, tc);
1641 * Check if we have congestion event
1644 if (tcp_ack_is_cc_event (tc, b, prev_snd_wnd, prev_snd_una, &is_dack))
1646 tcp_cc_handle_event (tc, &rs, is_dack);
1647 if (!tcp_in_cong_recovery (tc))
1649 *error = TCP_ERROR_ACK_OK;
1652 *error = TCP_ERROR_ACK_DUP;
1653 if (vnet_buffer (b)->tcp.data_len || tcp_is_fin (th))
1659 * Update congestion control (slow start/congestion avoidance)
1661 tcp_cc_update (tc, &rs);
1662 *error = TCP_ERROR_ACK_OK;
1667 tcp_program_disconnect (tcp_worker_ctx_t * wrk, tcp_connection_t * tc)
1669 if (!tcp_disconnect_pending (tc))
1671 vec_add1 (wrk->pending_disconnects, tc->c_c_index);
1672 tcp_disconnect_pending_on (tc);
1677 tcp_handle_disconnects (tcp_worker_ctx_t * wrk)
1679 u32 thread_index, *pending_disconnects;
1680 tcp_connection_t *tc;
1683 if (!vec_len (wrk->pending_disconnects))
1686 thread_index = wrk->vm->thread_index;
1687 pending_disconnects = wrk->pending_disconnects;
1688 for (i = 0; i < vec_len (pending_disconnects); i++)
1690 tc = tcp_connection_get (pending_disconnects[i], thread_index);
1691 tcp_disconnect_pending_off (tc);
1692 session_transport_closing_notify (&tc->connection);
1694 _vec_len (wrk->pending_disconnects) = 0;
1698 tcp_rcv_fin (tcp_worker_ctx_t * wrk, tcp_connection_t * tc, vlib_buffer_t * b,
1701 /* Account for the FIN and send ack */
1703 tcp_program_ack (wrk, tc);
1704 /* Enter CLOSE-WAIT and notify session. To avoid lingering
1705 * in CLOSE-WAIT, set timer (reuse WAITCLOSE). */
1706 tcp_connection_set_state (tc, TCP_STATE_CLOSE_WAIT);
1707 tcp_program_disconnect (wrk, tc);
1708 tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_CLOSEWAIT_TIME);
1709 TCP_EVT_DBG (TCP_EVT_FIN_RCVD, tc);
1710 *error = TCP_ERROR_FIN_RCVD;
1713 #ifndef CLIB_MARCH_VARIANT
1715 tcp_sack_vector_is_sane (sack_block_t * sacks)
1718 for (i = 1; i < vec_len (sacks); i++)
1720 if (sacks[i - 1].end == sacks[i].start)
1727 * Build SACK list as per RFC2018.
1729 * Makes sure the first block contains the segment that generated the current
1730 * ACK and the following ones are the ones most recently reported in SACK
1733 * @param tc TCP connection for which the SACK list is updated
1734 * @param start Start sequence number of the newest SACK block
1735 * @param end End sequence of the newest SACK block
1738 tcp_update_sack_list (tcp_connection_t * tc, u32 start, u32 end)
1740 sack_block_t *new_list = tc->snd_sacks_fl, *block = 0;
1743 /* If the first segment is ooo add it to the list. Last write might've moved
1744 * rcv_nxt over the first segment. */
1745 if (seq_lt (tc->rcv_nxt, start))
1747 vec_add2 (new_list, block, 1);
1748 block->start = start;
1752 /* Find the blocks still worth keeping. */
1753 for (i = 0; i < vec_len (tc->snd_sacks); i++)
1755 /* Discard if rcv_nxt advanced beyond current block */
1756 if (seq_leq (tc->snd_sacks[i].start, tc->rcv_nxt))
1759 /* Merge or drop if segment overlapped by the new segment */
1760 if (block && (seq_geq (tc->snd_sacks[i].end, new_list[0].start)
1761 && seq_leq (tc->snd_sacks[i].start, new_list[0].end)))
1763 if (seq_lt (tc->snd_sacks[i].start, new_list[0].start))
1764 new_list[0].start = tc->snd_sacks[i].start;
1765 if (seq_lt (new_list[0].end, tc->snd_sacks[i].end))
1766 new_list[0].end = tc->snd_sacks[i].end;
1770 /* Save to new SACK list if we have space. */
1771 if (vec_len (new_list) < TCP_MAX_SACK_BLOCKS)
1772 vec_add1 (new_list, tc->snd_sacks[i]);
1775 ASSERT (vec_len (new_list) <= TCP_MAX_SACK_BLOCKS);
1777 /* Replace old vector with new one */
1778 vec_reset_length (tc->snd_sacks);
1779 tc->snd_sacks_fl = tc->snd_sacks;
1780 tc->snd_sacks = new_list;
1782 /* Segments should not 'touch' */
1783 ASSERT (tcp_sack_vector_is_sane (tc->snd_sacks));
1787 tcp_sack_list_bytes (tcp_connection_t * tc)
1790 for (i = 0; i < vec_len (tc->snd_sacks); i++)
1791 bytes += tc->snd_sacks[i].end - tc->snd_sacks[i].start;
1794 #endif /* CLIB_MARCH_VARIANT */
1796 /** Enqueue data for delivery to application */
1798 tcp_session_enqueue_data (tcp_connection_t * tc, vlib_buffer_t * b,
1801 int written, error = TCP_ERROR_ENQUEUED;
1803 ASSERT (seq_geq (vnet_buffer (b)->tcp.seq_number, tc->rcv_nxt));
1805 written = session_enqueue_stream_connection (&tc->connection, b, 0,
1806 1 /* queue event */ , 1);
1808 TCP_EVT_DBG (TCP_EVT_INPUT, tc, 0, data_len, written);
1810 /* Update rcv_nxt */
1811 if (PREDICT_TRUE (written == data_len))
1813 tc->rcv_nxt += written;
1815 /* If more data written than expected, account for out-of-order bytes. */
1816 else if (written > data_len)
1818 tc->rcv_nxt += written;
1819 TCP_EVT_DBG (TCP_EVT_CC_INPUT, tc, data_len, written);
1821 else if (written > 0)
1823 /* We've written something but FIFO is probably full now */
1824 tc->rcv_nxt += written;
1825 error = TCP_ERROR_PARTIALLY_ENQUEUED;
1829 return TCP_ERROR_FIFO_FULL;
1832 /* Update SACK list if need be */
1833 if (tcp_opts_sack_permitted (&tc->rcv_opts))
1835 /* Remove SACK blocks that have been delivered */
1836 tcp_update_sack_list (tc, tc->rcv_nxt, tc->rcv_nxt);
1842 /** Enqueue out-of-order data */
1844 tcp_session_enqueue_ooo (tcp_connection_t * tc, vlib_buffer_t * b,
1850 ASSERT (seq_gt (vnet_buffer (b)->tcp.seq_number, tc->rcv_nxt));
1853 /* Enqueue out-of-order data with relative offset */
1854 rv = session_enqueue_stream_connection (&tc->connection, b,
1855 vnet_buffer (b)->tcp.seq_number -
1856 tc->rcv_nxt, 0 /* queue event */ ,
1859 /* Nothing written */
1862 TCP_EVT_DBG (TCP_EVT_INPUT, tc, 1, data_len, 0);
1863 return TCP_ERROR_FIFO_FULL;
1866 TCP_EVT_DBG (TCP_EVT_INPUT, tc, 1, data_len, data_len);
1868 /* Update SACK list if in use */
1869 if (tcp_opts_sack_permitted (&tc->rcv_opts))
1871 ooo_segment_t *newest;
1874 s0 = session_get (tc->c_s_index, tc->c_thread_index);
1876 /* Get the newest segment from the fifo */
1877 newest = svm_fifo_newest_ooo_segment (s0->rx_fifo);
1880 offset = ooo_segment_offset_prod (s0->rx_fifo, newest);
1881 ASSERT (offset <= vnet_buffer (b)->tcp.seq_number - tc->rcv_nxt);
1882 start = tc->rcv_nxt + offset;
1883 end = start + ooo_segment_length (s0->rx_fifo, newest);
1884 tcp_update_sack_list (tc, start, end);
1885 svm_fifo_newest_ooo_segment_reset (s0->rx_fifo);
1886 TCP_EVT_DBG (TCP_EVT_CC_SACKS, tc);
1890 return TCP_ERROR_ENQUEUED_OOO;
1894 * Check if ACK could be delayed. If ack can be delayed, it should return
1895 * true for a full frame. If we're always acking return 0.
1898 tcp_can_delack (tcp_connection_t * tc)
1900 /* Send ack if ... */
1902 /* just sent a rcv wnd 0
1903 || (tc->flags & TCP_CONN_SENT_RCV_WND0) != 0 */
1904 /* constrained to send ack */
1905 || (tc->flags & TCP_CONN_SNDACK) != 0
1906 /* we're almost out of tx wnd */
1907 || tcp_available_cc_snd_space (tc) < 4 * tc->snd_mss)
1914 tcp_buffer_discard_bytes (vlib_buffer_t * b, u32 n_bytes_to_drop)
1916 u32 discard, first = b->current_length;
1917 vlib_main_t *vm = vlib_get_main ();
1919 /* Handle multi-buffer segments */
1920 if (n_bytes_to_drop > b->current_length)
1922 if (!(b->flags & VLIB_BUFFER_NEXT_PRESENT))
1926 discard = clib_min (n_bytes_to_drop, b->current_length);
1927 vlib_buffer_advance (b, discard);
1928 b = vlib_get_buffer (vm, b->next_buffer);
1929 n_bytes_to_drop -= discard;
1931 while (n_bytes_to_drop);
1932 if (n_bytes_to_drop > first)
1933 b->total_length_not_including_first_buffer -= n_bytes_to_drop - first;
1936 vlib_buffer_advance (b, n_bytes_to_drop);
1937 vnet_buffer (b)->tcp.data_len -= n_bytes_to_drop;
1942 * Receive buffer for connection and handle acks
1944 * It handles both in order or out-of-order data.
1947 tcp_segment_rcv (tcp_worker_ctx_t * wrk, tcp_connection_t * tc,
1950 u32 error, n_bytes_to_drop, n_data_bytes;
1952 vlib_buffer_advance (b, vnet_buffer (b)->tcp.data_offset);
1953 n_data_bytes = vnet_buffer (b)->tcp.data_len;
1954 ASSERT (n_data_bytes);
1956 /* Handle out-of-order data */
1957 if (PREDICT_FALSE (vnet_buffer (b)->tcp.seq_number != tc->rcv_nxt))
1959 /* Old sequence numbers allowed through because they overlapped
1961 if (seq_lt (vnet_buffer (b)->tcp.seq_number, tc->rcv_nxt))
1963 /* Completely in the past (possible retransmit). Ack
1964 * retransmissions since we may not have any data to send */
1965 if (seq_leq (vnet_buffer (b)->tcp.seq_end, tc->rcv_nxt))
1967 tcp_program_ack (wrk, tc);
1968 error = TCP_ERROR_SEGMENT_OLD;
1972 /* Chop off the bytes in the past and see if what is left
1973 * can be enqueued in order */
1974 n_bytes_to_drop = tc->rcv_nxt - vnet_buffer (b)->tcp.seq_number;
1975 n_data_bytes -= n_bytes_to_drop;
1976 vnet_buffer (b)->tcp.seq_number = tc->rcv_nxt;
1977 if (tcp_buffer_discard_bytes (b, n_bytes_to_drop))
1979 error = TCP_ERROR_SEGMENT_OLD;
1985 /* RFC2581: Enqueue and send DUPACK for fast retransmit */
1986 error = tcp_session_enqueue_ooo (tc, b, n_data_bytes);
1987 tcp_program_dupack (wrk, tc);
1988 TCP_EVT_DBG (TCP_EVT_DUPACK_SENT, tc, vnet_buffer (b)->tcp);
1994 /* In order data, enqueue. Fifo figures out by itself if any out-of-order
1995 * segments can be enqueued after fifo tail offset changes. */
1996 error = tcp_session_enqueue_data (tc, b, n_data_bytes);
1997 if (tcp_can_delack (tc))
1999 if (!tcp_timer_is_active (tc, TCP_TIMER_DELACK))
2000 tcp_timer_set (tc, TCP_TIMER_DELACK, TCP_DELACK_TIME);
2004 tcp_program_ack (wrk, tc);
2012 tcp_header_t tcp_header;
2013 tcp_connection_t tcp_connection;
2017 format_tcp_rx_trace (u8 * s, va_list * args)
2019 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
2020 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
2021 tcp_rx_trace_t *t = va_arg (*args, tcp_rx_trace_t *);
2022 u32 indent = format_get_indent (s);
2024 s = format (s, "%U\n%U%U",
2025 format_tcp_header, &t->tcp_header, 128,
2026 format_white_space, indent,
2027 format_tcp_connection, &t->tcp_connection, 1);
2033 format_tcp_rx_trace_short (u8 * s, va_list * args)
2035 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
2036 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
2037 tcp_rx_trace_t *t = va_arg (*args, tcp_rx_trace_t *);
2039 s = format (s, "%d -> %d (%U)",
2040 clib_net_to_host_u16 (t->tcp_header.dst_port),
2041 clib_net_to_host_u16 (t->tcp_header.src_port), format_tcp_state,
2042 t->tcp_connection.state);
2048 tcp_set_rx_trace_data (tcp_rx_trace_t * t0, tcp_connection_t * tc0,
2049 tcp_header_t * th0, vlib_buffer_t * b0, u8 is_ip4)
2053 clib_memcpy_fast (&t0->tcp_connection, tc0,
2054 sizeof (t0->tcp_connection));
2058 th0 = tcp_buffer_hdr (b0);
2060 clib_memcpy_fast (&t0->tcp_header, th0, sizeof (t0->tcp_header));
2064 tcp_established_trace_frame (vlib_main_t * vm, vlib_node_runtime_t * node,
2065 vlib_frame_t * frame, u8 is_ip4)
2069 n_left = frame->n_vectors;
2070 from = vlib_frame_vector_args (frame);
2074 tcp_connection_t *tc0;
2081 b0 = vlib_get_buffer (vm, bi0);
2083 if (b0->flags & VLIB_BUFFER_IS_TRACED)
2085 t0 = vlib_add_trace (vm, node, b0, sizeof (*t0));
2086 tc0 = tcp_connection_get (vnet_buffer (b0)->tcp.connection_index,
2088 th0 = tcp_buffer_hdr (b0);
2089 tcp_set_rx_trace_data (t0, tc0, th0, b0, is_ip4);
2098 tcp_node_inc_counter_i (vlib_main_t * vm, u32 tcp4_node, u32 tcp6_node,
2099 u8 is_ip4, u32 evt, u32 val)
2102 vlib_node_increment_counter (vm, tcp4_node, evt, val);
2104 vlib_node_increment_counter (vm, tcp6_node, evt, val);
2107 #define tcp_maybe_inc_counter(node_id, err, count) \
2109 if (next0 != tcp_next_drop (is_ip4)) \
2110 tcp_node_inc_counter_i (vm, tcp4_##node_id##_node.index, \
2111 tcp6_##node_id##_node.index, is_ip4, err, \
2114 #define tcp_inc_counter(node_id, err, count) \
2115 tcp_node_inc_counter_i (vm, tcp4_##node_id##_node.index, \
2116 tcp6_##node_id##_node.index, is_ip4, \
2118 #define tcp_maybe_inc_err_counter(cnts, err) \
2120 cnts[err] += (next0 != tcp_next_drop (is_ip4)); \
2122 #define tcp_inc_err_counter(cnts, err, val) \
2126 #define tcp_store_err_counters(node_id, cnts) \
2129 for (i = 0; i < TCP_N_ERROR; i++) \
2131 tcp_inc_counter(node_id, i, cnts[i]); \
2136 tcp46_established_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
2137 vlib_frame_t * frame, int is_ip4)
2139 u32 thread_index = vm->thread_index, errors = 0;
2140 tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
2141 u32 n_left_from, *from, *first_buffer;
2142 u16 err_counters[TCP_N_ERROR] = { 0 };
2144 if (node->flags & VLIB_NODE_FLAG_TRACE)
2145 tcp_established_trace_frame (vm, node, frame, is_ip4);
2147 first_buffer = from = vlib_frame_vector_args (frame);
2148 n_left_from = frame->n_vectors;
2150 while (n_left_from > 0)
2152 u32 bi0, error0 = TCP_ERROR_ACK_OK;
2155 tcp_connection_t *tc0;
2157 if (n_left_from > 1)
2160 pb = vlib_get_buffer (vm, from[1]);
2161 vlib_prefetch_buffer_header (pb, LOAD);
2162 CLIB_PREFETCH (pb->data, 2 * CLIB_CACHE_LINE_BYTES, LOAD);
2169 b0 = vlib_get_buffer (vm, bi0);
2170 tc0 = tcp_connection_get (vnet_buffer (b0)->tcp.connection_index,
2173 if (PREDICT_FALSE (tc0 == 0))
2175 error0 = TCP_ERROR_INVALID_CONNECTION;
2179 th0 = tcp_buffer_hdr (b0);
2181 /* TODO header prediction fast path */
2183 /* 1-4: check SEQ, RST, SYN */
2184 if (PREDICT_FALSE (tcp_segment_validate (wrk, tc0, b0, th0, &error0)))
2186 TCP_EVT_DBG (TCP_EVT_SEG_INVALID, tc0, vnet_buffer (b0)->tcp);
2190 /* 5: check the ACK field */
2191 if (PREDICT_FALSE (tcp_rcv_ack (wrk, tc0, b0, th0, &error0)))
2194 /* 6: check the URG bit TODO */
2196 /* 7: process the segment text */
2197 if (vnet_buffer (b0)->tcp.data_len)
2198 error0 = tcp_segment_rcv (wrk, tc0, b0);
2200 /* 8: check the FIN bit */
2201 if (PREDICT_FALSE (tcp_is_fin (th0)))
2202 tcp_rcv_fin (wrk, tc0, b0, &error0);
2205 tcp_inc_err_counter (err_counters, error0, 1);
2208 errors = session_main_flush_enqueue_events (TRANSPORT_PROTO_TCP,
2210 err_counters[TCP_ERROR_MSG_QUEUE_FULL] = errors;
2211 tcp_store_err_counters (established, err_counters);
2212 tcp_handle_postponed_dequeues (wrk);
2213 tcp_handle_disconnects (wrk);
2214 vlib_buffer_free (vm, first_buffer, frame->n_vectors);
2216 return frame->n_vectors;
2219 VLIB_NODE_FN (tcp4_established_node) (vlib_main_t * vm,
2220 vlib_node_runtime_t * node,
2221 vlib_frame_t * from_frame)
2223 return tcp46_established_inline (vm, node, from_frame, 1 /* is_ip4 */ );
2226 VLIB_NODE_FN (tcp6_established_node) (vlib_main_t * vm,
2227 vlib_node_runtime_t * node,
2228 vlib_frame_t * from_frame)
2230 return tcp46_established_inline (vm, node, from_frame, 0 /* is_ip4 */ );
2234 VLIB_REGISTER_NODE (tcp4_established_node) =
2236 .name = "tcp4-established",
2237 /* Takes a vector of packets. */
2238 .vector_size = sizeof (u32),
2239 .n_errors = TCP_N_ERROR,
2240 .error_strings = tcp_error_strings,
2241 .n_next_nodes = TCP_ESTABLISHED_N_NEXT,
2244 #define _(s,n) [TCP_ESTABLISHED_NEXT_##s] = n,
2245 foreach_tcp_state_next
2248 .format_trace = format_tcp_rx_trace_short,
2253 VLIB_REGISTER_NODE (tcp6_established_node) =
2255 .name = "tcp6-established",
2256 /* Takes a vector of packets. */
2257 .vector_size = sizeof (u32),
2258 .n_errors = TCP_N_ERROR,
2259 .error_strings = tcp_error_strings,
2260 .n_next_nodes = TCP_ESTABLISHED_N_NEXT,
2263 #define _(s,n) [TCP_ESTABLISHED_NEXT_##s] = n,
2264 foreach_tcp_state_next
2267 .format_trace = format_tcp_rx_trace_short,
2273 tcp_lookup_is_valid (tcp_connection_t * tc, tcp_header_t * hdr)
2275 transport_connection_t *tmp = 0;
2282 if (tc->c_lcl_port == 0 && tc->state == TCP_STATE_LISTEN)
2285 u8 is_valid = (tc->c_lcl_port == hdr->dst_port
2286 && (tc->state == TCP_STATE_LISTEN
2287 || tc->c_rmt_port == hdr->src_port));
2291 handle = session_lookup_half_open_handle (&tc->connection);
2292 tmp = session_lookup_half_open_connection (handle & 0xFFFFFFFF,
2293 tc->c_proto, tc->c_is_ip4);
2297 if (tmp->lcl_port == hdr->dst_port
2298 && tmp->rmt_port == hdr->src_port)
2300 TCP_DBG ("half-open is valid!");
2308 * Lookup transport connection
2310 static tcp_connection_t *
2311 tcp_lookup_connection (u32 fib_index, vlib_buffer_t * b, u8 thread_index,
2315 transport_connection_t *tconn;
2316 tcp_connection_t *tc;
2321 ip4 = vlib_buffer_get_current (b);
2322 tcp = ip4_next_header (ip4);
2323 tconn = session_lookup_connection_wt4 (fib_index,
2328 TRANSPORT_PROTO_TCP,
2329 thread_index, &is_filtered);
2330 tc = tcp_get_connection_from_transport (tconn);
2331 ASSERT (tcp_lookup_is_valid (tc, tcp));
2336 ip6 = vlib_buffer_get_current (b);
2337 tcp = ip6_next_header (ip6);
2338 tconn = session_lookup_connection_wt6 (fib_index,
2343 TRANSPORT_PROTO_TCP,
2344 thread_index, &is_filtered);
2345 tc = tcp_get_connection_from_transport (tconn);
2346 ASSERT (tcp_lookup_is_valid (tc, tcp));
2352 tcp46_syn_sent_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
2353 vlib_frame_t * from_frame, int is_ip4)
2355 tcp_main_t *tm = vnet_get_tcp_main ();
2356 u32 n_left_from, *from, *first_buffer, errors = 0;
2357 u32 my_thread_index = vm->thread_index;
2358 tcp_worker_ctx_t *wrk = tcp_get_worker (my_thread_index);
2360 from = first_buffer = vlib_frame_vector_args (from_frame);
2361 n_left_from = from_frame->n_vectors;
2363 while (n_left_from > 0)
2365 u32 bi0, ack0, seq0, error0 = TCP_ERROR_NONE;
2366 tcp_connection_t *tc0, *new_tc0;
2367 tcp_header_t *tcp0 = 0;
2375 b0 = vlib_get_buffer (vm, bi0);
2377 tcp_half_open_connection_get (vnet_buffer (b0)->tcp.connection_index);
2378 if (PREDICT_FALSE (tc0 == 0))
2380 error0 = TCP_ERROR_INVALID_CONNECTION;
2384 /* Half-open completed recently but the connection was't removed
2385 * yet by the owning thread */
2386 if (PREDICT_FALSE (tc0->flags & TCP_CONN_HALF_OPEN_DONE))
2388 /* Make sure the connection actually exists */
2389 ASSERT (tcp_lookup_connection (tc0->c_fib_index, b0,
2390 my_thread_index, is_ip4));
2391 error0 = TCP_ERROR_SPURIOUS_SYN_ACK;
2395 ack0 = vnet_buffer (b0)->tcp.ack_number;
2396 seq0 = vnet_buffer (b0)->tcp.seq_number;
2397 tcp0 = tcp_buffer_hdr (b0);
2399 /* Crude check to see if the connection handle does not match
2400 * the packet. Probably connection just switched to established */
2401 if (PREDICT_FALSE (tcp0->dst_port != tc0->c_lcl_port
2402 || tcp0->src_port != tc0->c_rmt_port))
2404 error0 = TCP_ERROR_INVALID_CONNECTION;
2408 if (PREDICT_FALSE (!tcp_ack (tcp0) && !tcp_rst (tcp0)
2409 && !tcp_syn (tcp0)))
2411 error0 = TCP_ERROR_SEGMENT_INVALID;
2415 /* SYNs consume sequence numbers */
2416 vnet_buffer (b0)->tcp.seq_end += tcp_is_syn (tcp0);
2419 * 1. check the ACK bit
2423 * If the ACK bit is set
2424 * If SEG.ACK =< ISS, or SEG.ACK > SND.NXT, send a reset (unless
2425 * the RST bit is set, if so drop the segment and return)
2426 * <SEQ=SEG.ACK><CTL=RST>
2427 * and discard the segment. Return.
2428 * If SND.UNA =< SEG.ACK =< SND.NXT then the ACK is acceptable.
2432 if (seq_leq (ack0, tc0->iss) || seq_gt (ack0, tc0->snd_nxt))
2434 if (!tcp_rst (tcp0))
2435 tcp_send_reset_w_pkt (tc0, b0, my_thread_index, is_ip4);
2436 error0 = TCP_ERROR_RCV_WND;
2440 /* Make sure ACK is valid */
2441 if (seq_gt (tc0->snd_una, ack0))
2443 error0 = TCP_ERROR_ACK_INVALID;
2449 * 2. check the RST bit
2454 /* If ACK is acceptable, signal client that peer is not
2455 * willing to accept connection and drop connection*/
2457 tcp_connection_reset (tc0);
2458 error0 = TCP_ERROR_RST_RCVD;
2463 * 3. check the security and precedence (skipped)
2467 * 4. check the SYN bit
2470 /* No SYN flag. Drop. */
2471 if (!tcp_syn (tcp0))
2473 error0 = TCP_ERROR_SEGMENT_INVALID;
2478 if (tcp_options_parse (tcp0, &tc0->rcv_opts, 1))
2480 error0 = TCP_ERROR_OPTIONS;
2484 /* Valid SYN or SYN-ACK. Move connection from half-open pool to
2485 * current thread pool. */
2486 pool_get (tm->connections[my_thread_index], new_tc0);
2487 clib_memcpy_fast (new_tc0, tc0, sizeof (*new_tc0));
2488 new_tc0->c_c_index = new_tc0 - tm->connections[my_thread_index];
2489 new_tc0->c_thread_index = my_thread_index;
2490 new_tc0->rcv_nxt = vnet_buffer (b0)->tcp.seq_end;
2491 new_tc0->irs = seq0;
2492 new_tc0->timers[TCP_TIMER_ESTABLISH_AO] = TCP_TIMER_HANDLE_INVALID;
2493 new_tc0->timers[TCP_TIMER_RETRANSMIT_SYN] = TCP_TIMER_HANDLE_INVALID;
2494 new_tc0->sw_if_index = vnet_buffer (b0)->sw_if_index[VLIB_RX];
2496 /* If this is not the owning thread, wait for syn retransmit to
2497 * expire and cleanup then */
2498 if (tcp_half_open_connection_cleanup (tc0))
2499 tc0->flags |= TCP_CONN_HALF_OPEN_DONE;
2501 if (tcp_opts_tstamp (&new_tc0->rcv_opts))
2503 new_tc0->tsval_recent = new_tc0->rcv_opts.tsval;
2504 new_tc0->tsval_recent_age = tcp_time_now ();
2507 if (tcp_opts_wscale (&new_tc0->rcv_opts))
2508 new_tc0->snd_wscale = new_tc0->rcv_opts.wscale;
2510 new_tc0->rcv_wscale = 0;
2512 new_tc0->snd_wnd = clib_net_to_host_u16 (tcp0->window)
2513 << new_tc0->snd_wscale;
2514 new_tc0->snd_wl1 = seq0;
2515 new_tc0->snd_wl2 = ack0;
2517 tcp_connection_init_vars (new_tc0);
2519 /* SYN-ACK: See if we can switch to ESTABLISHED state */
2520 if (PREDICT_TRUE (tcp_ack (tcp0)))
2522 /* Our SYN is ACKed: we have iss < ack = snd_una */
2524 /* TODO Dequeue acknowledged segments if we support Fast Open */
2525 new_tc0->snd_una = ack0;
2526 new_tc0->state = TCP_STATE_ESTABLISHED;
2528 /* Make sure las is initialized for the wnd computation */
2529 new_tc0->rcv_las = new_tc0->rcv_nxt;
2531 /* Notify app that we have connection. If session layer can't
2532 * allocate session send reset */
2533 if (session_stream_connect_notify (&new_tc0->connection, 0))
2535 tcp_send_reset_w_pkt (new_tc0, b0, my_thread_index, is_ip4);
2536 tcp_connection_cleanup (new_tc0);
2537 error0 = TCP_ERROR_CREATE_SESSION_FAIL;
2541 new_tc0->tx_fifo_size =
2542 transport_tx_fifo_size (&new_tc0->connection);
2543 /* Update rtt with the syn-ack sample */
2544 tcp_estimate_initial_rtt (new_tc0);
2545 TCP_EVT_DBG (TCP_EVT_SYNACK_RCVD, new_tc0);
2546 error0 = TCP_ERROR_SYN_ACKS_RCVD;
2548 /* SYN: Simultaneous open. Change state to SYN-RCVD and send SYN-ACK */
2551 new_tc0->state = TCP_STATE_SYN_RCVD;
2553 /* Notify app that we have connection */
2554 if (session_stream_connect_notify (&new_tc0->connection, 0))
2556 tcp_connection_cleanup (new_tc0);
2557 tcp_send_reset_w_pkt (tc0, b0, my_thread_index, is_ip4);
2558 TCP_EVT_DBG (TCP_EVT_RST_SENT, tc0);
2559 error0 = TCP_ERROR_CREATE_SESSION_FAIL;
2563 new_tc0->tx_fifo_size =
2564 transport_tx_fifo_size (&new_tc0->connection);
2565 new_tc0->rtt_ts = 0;
2566 tcp_init_snd_vars (new_tc0);
2567 tcp_send_synack (new_tc0);
2568 error0 = TCP_ERROR_SYNS_RCVD;
2572 /* Read data, if any */
2573 if (PREDICT_FALSE (vnet_buffer (b0)->tcp.data_len))
2575 clib_warning ("rcvd data in syn-sent");
2576 error0 = tcp_segment_rcv (wrk, new_tc0, b0);
2577 if (error0 == TCP_ERROR_ACK_OK)
2578 error0 = TCP_ERROR_SYN_ACKS_RCVD;
2582 tcp_program_ack (wrk, new_tc0);
2587 tcp_inc_counter (syn_sent, error0, 1);
2588 if (PREDICT_FALSE ((b0->flags & VLIB_BUFFER_IS_TRACED) && tcp0 != 0))
2590 t0 = vlib_add_trace (vm, node, b0, sizeof (*t0));
2591 clib_memcpy_fast (&t0->tcp_header, tcp0, sizeof (t0->tcp_header));
2592 clib_memcpy_fast (&t0->tcp_connection, tc0,
2593 sizeof (t0->tcp_connection));
2597 errors = session_main_flush_enqueue_events (TRANSPORT_PROTO_TCP,
2599 tcp_inc_counter (syn_sent, TCP_ERROR_MSG_QUEUE_FULL, errors);
2600 vlib_buffer_free (vm, first_buffer, from_frame->n_vectors);
2602 return from_frame->n_vectors;
2605 VLIB_NODE_FN (tcp4_syn_sent_node) (vlib_main_t * vm,
2606 vlib_node_runtime_t * node,
2607 vlib_frame_t * from_frame)
2609 return tcp46_syn_sent_inline (vm, node, from_frame, 1 /* is_ip4 */ );
2612 VLIB_NODE_FN (tcp6_syn_sent_node) (vlib_main_t * vm,
2613 vlib_node_runtime_t * node,
2614 vlib_frame_t * from_frame)
2616 return tcp46_syn_sent_inline (vm, node, from_frame, 0 /* is_ip4 */ );
2620 VLIB_REGISTER_NODE (tcp4_syn_sent_node) =
2622 .name = "tcp4-syn-sent",
2623 /* Takes a vector of packets. */
2624 .vector_size = sizeof (u32),
2625 .n_errors = TCP_N_ERROR,
2626 .error_strings = tcp_error_strings,
2627 .n_next_nodes = TCP_SYN_SENT_N_NEXT,
2630 #define _(s,n) [TCP_SYN_SENT_NEXT_##s] = n,
2631 foreach_tcp_state_next
2634 .format_trace = format_tcp_rx_trace_short,
2639 VLIB_REGISTER_NODE (tcp6_syn_sent_node) =
2641 .name = "tcp6-syn-sent",
2642 /* Takes a vector of packets. */
2643 .vector_size = sizeof (u32),
2644 .n_errors = TCP_N_ERROR,
2645 .error_strings = tcp_error_strings,
2646 .n_next_nodes = TCP_SYN_SENT_N_NEXT,
2649 #define _(s,n) [TCP_SYN_SENT_NEXT_##s] = n,
2650 foreach_tcp_state_next
2653 .format_trace = format_tcp_rx_trace_short,
2658 * Handles reception for all states except LISTEN, SYN-SENT and ESTABLISHED
2659 * as per RFC793 p. 64
2662 tcp46_rcv_process_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
2663 vlib_frame_t * from_frame, int is_ip4)
2665 u32 thread_index = vm->thread_index, errors = 0, *first_buffer;
2666 tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
2667 u32 n_left_from, *from, max_dequeue;
2669 from = first_buffer = vlib_frame_vector_args (from_frame);
2670 n_left_from = from_frame->n_vectors;
2672 while (n_left_from > 0)
2674 u32 bi0, error0 = TCP_ERROR_NONE;
2675 tcp_header_t *tcp0 = 0;
2676 tcp_connection_t *tc0;
2684 b0 = vlib_get_buffer (vm, bi0);
2685 tc0 = tcp_connection_get (vnet_buffer (b0)->tcp.connection_index,
2687 if (PREDICT_FALSE (tc0 == 0))
2689 error0 = TCP_ERROR_INVALID_CONNECTION;
2693 tcp0 = tcp_buffer_hdr (b0);
2694 is_fin0 = tcp_is_fin (tcp0);
2698 tcp_connection_t *tmp;
2699 tmp = tcp_lookup_connection (tc0->c_fib_index, b0, thread_index,
2701 if (tmp->state != tc0->state)
2703 if (tc0->state != TCP_STATE_CLOSED)
2704 clib_warning ("state changed");
2710 * Special treatment for CLOSED
2712 if (PREDICT_FALSE (tc0->state == TCP_STATE_CLOSED))
2714 error0 = TCP_ERROR_CONNECTION_CLOSED;
2719 * For all other states (except LISTEN)
2722 /* 1-4: check SEQ, RST, SYN */
2723 if (PREDICT_FALSE (tcp_segment_validate (wrk, tc0, b0, tcp0, &error0)))
2726 /* 5: check the ACK field */
2729 case TCP_STATE_SYN_RCVD:
2731 /* Make sure the segment is exactly right */
2732 if (tc0->rcv_nxt != vnet_buffer (b0)->tcp.seq_number || is_fin0)
2734 tcp_connection_reset (tc0);
2735 error0 = TCP_ERROR_SEGMENT_INVALID;
2740 * If the segment acknowledgment is not acceptable, form a
2742 * <SEQ=SEG.ACK><CTL=RST>
2745 if (tcp_rcv_ack_no_cc (tc0, b0, &error0))
2747 tcp_connection_reset (tc0);
2751 /* Update rtt and rto */
2752 tcp_estimate_initial_rtt (tc0);
2754 /* Switch state to ESTABLISHED */
2755 tc0->state = TCP_STATE_ESTABLISHED;
2756 TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc0);
2758 /* Initialize session variables */
2759 tc0->snd_una = vnet_buffer (b0)->tcp.ack_number;
2760 tc0->snd_wnd = clib_net_to_host_u16 (tcp0->window)
2761 << tc0->rcv_opts.wscale;
2762 tc0->snd_wl1 = vnet_buffer (b0)->tcp.seq_number;
2763 tc0->snd_wl2 = vnet_buffer (b0)->tcp.ack_number;
2765 /* Reset SYN-ACK retransmit and SYN_RCV establish timers */
2766 tcp_retransmit_timer_reset (tc0);
2767 tcp_timer_reset (tc0, TCP_TIMER_ESTABLISH);
2768 if (session_stream_accept_notify (&tc0->connection))
2770 error0 = TCP_ERROR_MSG_QUEUE_FULL;
2771 tcp_connection_reset (tc0);
2774 error0 = TCP_ERROR_ACK_OK;
2776 case TCP_STATE_ESTABLISHED:
2777 /* We can get packets in established state here because they
2778 * were enqueued before state change */
2779 if (tcp_rcv_ack (wrk, tc0, b0, tcp0, &error0))
2783 case TCP_STATE_FIN_WAIT_1:
2784 /* In addition to the processing for the ESTABLISHED state, if
2785 * our FIN is now acknowledged then enter FIN-WAIT-2 and
2786 * continue processing in that state. */
2787 if (tcp_rcv_ack (wrk, tc0, b0, tcp0, &error0))
2790 /* Still have to send the FIN */
2791 if (tc0->flags & TCP_CONN_FINPNDG)
2793 /* TX fifo finally drained */
2794 max_dequeue = transport_max_tx_dequeue (&tc0->connection);
2795 if (max_dequeue <= tc0->burst_acked)
2797 /* If a fin was received and data was acked extend wait */
2798 else if ((tc0->flags & TCP_CONN_FINRCVD) && tc0->bytes_acked)
2799 tcp_timer_update (tc0, TCP_TIMER_WAITCLOSE,
2800 TCP_CLOSEWAIT_TIME);
2802 /* If FIN is ACKed */
2803 else if (tc0->snd_una == tc0->snd_nxt)
2805 /* Stop all retransmit timers because we have nothing more
2807 tcp_connection_timers_reset (tc0);
2809 /* We already have a FIN but didn't transition to CLOSING
2810 * because of outstanding tx data. Close the connection. */
2811 if (tc0->flags & TCP_CONN_FINRCVD)
2813 tcp_connection_set_state (tc0, TCP_STATE_CLOSED);
2814 tcp_timer_set (tc0, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
2818 tcp_connection_set_state (tc0, TCP_STATE_FIN_WAIT_2);
2819 /* Enable waitclose because we're willing to wait for peer's
2820 * FIN but not indefinitely. */
2821 tcp_timer_set (tc0, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
2823 /* Don't try to deq the FIN acked */
2824 if (tc0->burst_acked > 1)
2825 session_tx_fifo_dequeue_drop (&tc0->connection,
2826 tc0->burst_acked - 1);
2827 tc0->burst_acked = 0;
2830 case TCP_STATE_FIN_WAIT_2:
2831 /* In addition to the processing for the ESTABLISHED state, if
2832 * the retransmission queue is empty, the user's CLOSE can be
2833 * acknowledged ("ok") but do not delete the TCB. */
2834 if (tcp_rcv_ack_no_cc (tc0, b0, &error0))
2836 tc0->burst_acked = 0;
2838 case TCP_STATE_CLOSE_WAIT:
2839 /* Do the same processing as for the ESTABLISHED state. */
2840 if (tcp_rcv_ack (wrk, tc0, b0, tcp0, &error0))
2843 if (!(tc0->flags & TCP_CONN_FINPNDG))
2846 /* Still have outstanding tx data */
2847 if (transport_max_tx_dequeue (&tc0->connection))
2851 tcp_connection_timers_reset (tc0);
2852 tcp_connection_set_state (tc0, TCP_STATE_LAST_ACK);
2853 tcp_timer_set (tc0, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
2855 case TCP_STATE_CLOSING:
2856 /* In addition to the processing for the ESTABLISHED state, if
2857 * the ACK acknowledges our FIN then enter the TIME-WAIT state,
2858 * otherwise ignore the segment. */
2859 if (tcp_rcv_ack_no_cc (tc0, b0, &error0))
2862 if (tc0->snd_una != tc0->snd_nxt)
2865 tcp_connection_timers_reset (tc0);
2866 tcp_connection_set_state (tc0, TCP_STATE_TIME_WAIT);
2867 tcp_timer_set (tc0, TCP_TIMER_WAITCLOSE, TCP_TIMEWAIT_TIME);
2871 case TCP_STATE_LAST_ACK:
2872 /* The only thing that [should] arrive in this state is an
2873 * acknowledgment of our FIN. If our FIN is now acknowledged,
2874 * delete the TCB, enter the CLOSED state, and return. */
2876 if (tcp_rcv_ack_no_cc (tc0, b0, &error0))
2879 /* Apparently our ACK for the peer's FIN was lost */
2880 if (is_fin0 && tc0->snd_una != tc0->snd_nxt)
2886 tcp_connection_set_state (tc0, TCP_STATE_CLOSED);
2888 /* Don't free the connection from the data path since
2889 * we can't ensure that we have no packets already enqueued
2890 * to output. Rely instead on the waitclose timer */
2891 tcp_connection_timers_reset (tc0);
2892 tcp_timer_set (tc0, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
2897 case TCP_STATE_TIME_WAIT:
2898 /* The only thing that can arrive in this state is a
2899 * retransmission of the remote FIN. Acknowledge it, and restart
2900 * the 2 MSL timeout. */
2902 if (tcp_rcv_ack_no_cc (tc0, b0, &error0))
2908 tcp_program_ack (wrk, tc0);
2909 tcp_timer_update (tc0, TCP_TIMER_WAITCLOSE, TCP_TIMEWAIT_TIME);
2917 /* 6: check the URG bit TODO */
2919 /* 7: process the segment text */
2922 case TCP_STATE_ESTABLISHED:
2923 case TCP_STATE_FIN_WAIT_1:
2924 case TCP_STATE_FIN_WAIT_2:
2925 if (vnet_buffer (b0)->tcp.data_len)
2926 error0 = tcp_segment_rcv (wrk, tc0, b0);
2928 case TCP_STATE_CLOSE_WAIT:
2929 case TCP_STATE_CLOSING:
2930 case TCP_STATE_LAST_ACK:
2931 case TCP_STATE_TIME_WAIT:
2932 /* This should not occur, since a FIN has been received from the
2933 * remote side. Ignore the segment text. */
2937 /* 8: check the FIN bit */
2941 TCP_EVT_DBG (TCP_EVT_FIN_RCVD, tc0);
2945 case TCP_STATE_ESTABLISHED:
2946 /* Account for the FIN and send ack */
2948 tcp_program_ack (wrk, tc0);
2949 tcp_connection_set_state (tc0, TCP_STATE_CLOSE_WAIT);
2950 tcp_program_disconnect (wrk, tc0);
2951 tcp_timer_update (tc0, TCP_TIMER_WAITCLOSE, TCP_CLOSEWAIT_TIME);
2953 case TCP_STATE_SYN_RCVD:
2954 /* Send FIN-ACK, enter LAST-ACK and because the app was not
2955 * notified yet, set a cleanup timer instead of relying on
2956 * disconnect notify and the implicit close call. */
2957 tcp_connection_timers_reset (tc0);
2960 tcp_connection_set_state (tc0, TCP_STATE_LAST_ACK);
2961 tcp_timer_set (tc0, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
2963 case TCP_STATE_CLOSE_WAIT:
2964 case TCP_STATE_CLOSING:
2965 case TCP_STATE_LAST_ACK:
2968 case TCP_STATE_FIN_WAIT_1:
2971 if (tc0->flags & TCP_CONN_FINPNDG)
2973 /* If data is outstanding, stay in FIN_WAIT_1 and try to finish
2974 * sending it. Since we already received a fin, do not wait
2976 tc0->flags |= TCP_CONN_FINRCVD;
2977 tcp_timer_update (tc0, TCP_TIMER_WAITCLOSE, TCP_CLOSEWAIT_TIME);
2981 tcp_connection_set_state (tc0, TCP_STATE_CLOSING);
2982 tcp_program_ack (wrk, tc0);
2983 /* Wait for ACK for our FIN but not forever */
2984 tcp_timer_update (tc0, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
2987 case TCP_STATE_FIN_WAIT_2:
2988 /* Got FIN, send ACK! Be more aggressive with resource cleanup */
2990 tcp_connection_set_state (tc0, TCP_STATE_TIME_WAIT);
2991 tcp_connection_timers_reset (tc0);
2992 tcp_timer_set (tc0, TCP_TIMER_WAITCLOSE, TCP_TIMEWAIT_TIME);
2993 tcp_program_ack (wrk, tc0);
2995 case TCP_STATE_TIME_WAIT:
2996 /* Remain in the TIME-WAIT state. Restart the time-wait
2999 tcp_timer_update (tc0, TCP_TIMER_WAITCLOSE, TCP_TIMEWAIT_TIME);
3002 error0 = TCP_ERROR_FIN_RCVD;
3006 tcp_inc_counter (rcv_process, error0, 1);
3007 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
3009 tcp_rx_trace_t *t0 = vlib_add_trace (vm, node, b0, sizeof (*t0));
3010 tcp_set_rx_trace_data (t0, tc0, tcp0, b0, is_ip4);
3014 errors = session_main_flush_enqueue_events (TRANSPORT_PROTO_TCP,
3016 tcp_inc_counter (rcv_process, TCP_ERROR_MSG_QUEUE_FULL, errors);
3017 tcp_handle_postponed_dequeues (wrk);
3018 tcp_handle_disconnects (wrk);
3019 vlib_buffer_free (vm, first_buffer, from_frame->n_vectors);
3021 return from_frame->n_vectors;
3024 VLIB_NODE_FN (tcp4_rcv_process_node) (vlib_main_t * vm,
3025 vlib_node_runtime_t * node,
3026 vlib_frame_t * from_frame)
3028 return tcp46_rcv_process_inline (vm, node, from_frame, 1 /* is_ip4 */ );
3031 VLIB_NODE_FN (tcp6_rcv_process_node) (vlib_main_t * vm,
3032 vlib_node_runtime_t * node,
3033 vlib_frame_t * from_frame)
3035 return tcp46_rcv_process_inline (vm, node, from_frame, 0 /* is_ip4 */ );
3039 VLIB_REGISTER_NODE (tcp4_rcv_process_node) =
3041 .name = "tcp4-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 VLIB_REGISTER_NODE (tcp6_rcv_process_node) =
3060 .name = "tcp6-rcv-process",
3061 /* Takes a vector of packets. */
3062 .vector_size = sizeof (u32),
3063 .n_errors = TCP_N_ERROR,
3064 .error_strings = tcp_error_strings,
3065 .n_next_nodes = TCP_RCV_PROCESS_N_NEXT,
3068 #define _(s,n) [TCP_RCV_PROCESS_NEXT_##s] = n,
3069 foreach_tcp_state_next
3072 .format_trace = format_tcp_rx_trace_short,
3077 * LISTEN state processing as per RFC 793 p. 65
3080 tcp46_listen_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
3081 vlib_frame_t * from_frame, int is_ip4)
3083 u32 n_left_from, *from, n_syns = 0, *first_buffer;
3084 u32 my_thread_index = vm->thread_index;
3086 from = first_buffer = vlib_frame_vector_args (from_frame);
3087 n_left_from = from_frame->n_vectors;
3089 while (n_left_from > 0)
3094 tcp_header_t *th0 = 0;
3095 tcp_connection_t *lc0;
3098 tcp_connection_t *child0;
3099 u32 error0 = TCP_ERROR_NONE;
3105 b0 = vlib_get_buffer (vm, bi0);
3106 lc0 = tcp_listener_get (vnet_buffer (b0)->tcp.connection_index);
3110 ip40 = vlib_buffer_get_current (b0);
3111 th0 = ip4_next_header (ip40);
3115 ip60 = vlib_buffer_get_current (b0);
3116 th0 = ip6_next_header (ip60);
3119 /* Create child session. For syn-flood protection use filter */
3121 /* 1. first check for an RST: handled in dispatch */
3122 /* if (tcp_rst (th0))
3126 /* 2. second check for an ACK: handled in dispatch */
3127 /* if (tcp_ack (th0))
3129 tcp_send_reset (b0, is_ip4);
3134 /* 3. check for a SYN (did that already) */
3136 /* Make sure connection wasn't just created */
3137 child0 = tcp_lookup_connection (lc0->c_fib_index, b0, my_thread_index,
3139 if (PREDICT_FALSE (child0->state != TCP_STATE_LISTEN))
3141 error0 = TCP_ERROR_CREATE_EXISTS;
3145 /* Create child session and send SYN-ACK */
3146 child0 = tcp_connection_alloc (my_thread_index);
3147 child0->c_lcl_port = th0->dst_port;
3148 child0->c_rmt_port = th0->src_port;
3149 child0->c_is_ip4 = is_ip4;
3150 child0->state = TCP_STATE_SYN_RCVD;
3151 child0->c_fib_index = lc0->c_fib_index;
3155 child0->c_lcl_ip4.as_u32 = ip40->dst_address.as_u32;
3156 child0->c_rmt_ip4.as_u32 = ip40->src_address.as_u32;
3160 clib_memcpy_fast (&child0->c_lcl_ip6, &ip60->dst_address,
3161 sizeof (ip6_address_t));
3162 clib_memcpy_fast (&child0->c_rmt_ip6, &ip60->src_address,
3163 sizeof (ip6_address_t));
3166 if (tcp_options_parse (th0, &child0->rcv_opts, 1))
3168 error0 = TCP_ERROR_OPTIONS;
3169 tcp_connection_free (child0);
3173 child0->irs = vnet_buffer (b0)->tcp.seq_number;
3174 child0->rcv_nxt = vnet_buffer (b0)->tcp.seq_number + 1;
3175 child0->rcv_las = child0->rcv_nxt;
3176 child0->sw_if_index = vnet_buffer (b0)->sw_if_index[VLIB_RX];
3178 /* RFC1323: TSval timestamps sent on {SYN} and {SYN,ACK}
3179 * segments are used to initialize PAWS. */
3180 if (tcp_opts_tstamp (&child0->rcv_opts))
3182 child0->tsval_recent = child0->rcv_opts.tsval;
3183 child0->tsval_recent_age = tcp_time_now ();
3186 if (tcp_opts_wscale (&child0->rcv_opts))
3187 child0->snd_wscale = child0->rcv_opts.wscale;
3189 child0->snd_wnd = clib_net_to_host_u16 (th0->window)
3190 << child0->snd_wscale;
3191 child0->snd_wl1 = vnet_buffer (b0)->tcp.seq_number;
3192 child0->snd_wl2 = vnet_buffer (b0)->tcp.ack_number;
3194 tcp_connection_init_vars (child0);
3195 child0->rto = TCP_RTO_MIN;
3197 if (session_stream_accept (&child0->connection, lc0->c_s_index,
3198 lc0->c_thread_index, 0 /* notify */ ))
3200 tcp_connection_cleanup (child0);
3201 error0 = TCP_ERROR_CREATE_SESSION_FAIL;
3205 TCP_EVT_DBG (TCP_EVT_SYN_RCVD, child0, 1);
3206 child0->tx_fifo_size = transport_tx_fifo_size (&child0->connection);
3207 tcp_send_synack (child0);
3208 tcp_timer_set (child0, TCP_TIMER_ESTABLISH, TCP_SYN_RCVD_TIME);
3212 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
3214 t0 = vlib_add_trace (vm, node, b0, sizeof (*t0));
3215 clib_memcpy_fast (&t0->tcp_header, th0, sizeof (t0->tcp_header));
3216 clib_memcpy_fast (&t0->tcp_connection, lc0,
3217 sizeof (t0->tcp_connection));
3220 n_syns += (error0 == TCP_ERROR_NONE);
3223 tcp_inc_counter (listen, TCP_ERROR_SYNS_RCVD, n_syns);
3224 vlib_buffer_free (vm, first_buffer, from_frame->n_vectors);
3226 return from_frame->n_vectors;
3229 VLIB_NODE_FN (tcp4_listen_node) (vlib_main_t * vm, vlib_node_runtime_t * node,
3230 vlib_frame_t * from_frame)
3232 return tcp46_listen_inline (vm, node, from_frame, 1 /* is_ip4 */ );
3235 VLIB_NODE_FN (tcp6_listen_node) (vlib_main_t * vm, vlib_node_runtime_t * node,
3236 vlib_frame_t * from_frame)
3238 return tcp46_listen_inline (vm, node, from_frame, 0 /* is_ip4 */ );
3242 VLIB_REGISTER_NODE (tcp4_listen_node) =
3244 .name = "tcp4-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,
3261 VLIB_REGISTER_NODE (tcp6_listen_node) =
3263 .name = "tcp6-listen",
3264 /* Takes a vector of packets. */
3265 .vector_size = sizeof (u32),
3266 .n_errors = TCP_N_ERROR,
3267 .error_strings = tcp_error_strings,
3268 .n_next_nodes = TCP_LISTEN_N_NEXT,
3271 #define _(s,n) [TCP_LISTEN_NEXT_##s] = n,
3272 foreach_tcp_state_next
3275 .format_trace = format_tcp_rx_trace_short,
3279 typedef enum _tcp_input_next
3281 TCP_INPUT_NEXT_DROP,
3282 TCP_INPUT_NEXT_LISTEN,
3283 TCP_INPUT_NEXT_RCV_PROCESS,
3284 TCP_INPUT_NEXT_SYN_SENT,
3285 TCP_INPUT_NEXT_ESTABLISHED,
3286 TCP_INPUT_NEXT_RESET,
3287 TCP_INPUT_NEXT_PUNT,
3291 #define foreach_tcp4_input_next \
3292 _ (DROP, "ip4-drop") \
3293 _ (LISTEN, "tcp4-listen") \
3294 _ (RCV_PROCESS, "tcp4-rcv-process") \
3295 _ (SYN_SENT, "tcp4-syn-sent") \
3296 _ (ESTABLISHED, "tcp4-established") \
3297 _ (RESET, "tcp4-reset") \
3298 _ (PUNT, "ip4-punt")
3300 #define foreach_tcp6_input_next \
3301 _ (DROP, "ip6-drop") \
3302 _ (LISTEN, "tcp6-listen") \
3303 _ (RCV_PROCESS, "tcp6-rcv-process") \
3304 _ (SYN_SENT, "tcp6-syn-sent") \
3305 _ (ESTABLISHED, "tcp6-established") \
3306 _ (RESET, "tcp6-reset") \
3307 _ (PUNT, "ip6-punt")
3309 #define filter_flags (TCP_FLAG_SYN|TCP_FLAG_ACK|TCP_FLAG_RST|TCP_FLAG_FIN)
3312 tcp_input_trace_frame (vlib_main_t * vm, vlib_node_runtime_t * node,
3313 vlib_buffer_t ** bs, u32 n_bufs, u8 is_ip4)
3315 tcp_connection_t *tc;
3320 for (i = 0; i < n_bufs; i++)
3322 if (bs[i]->flags & VLIB_BUFFER_IS_TRACED)
3324 t = vlib_add_trace (vm, node, bs[i], sizeof (*t));
3325 tc = tcp_connection_get (vnet_buffer (bs[i])->tcp.connection_index,
3327 tcp = vlib_buffer_get_current (bs[i]);
3328 tcp_set_rx_trace_data (t, tc, tcp, bs[i], is_ip4);
3334 tcp_input_set_error_next (tcp_main_t * tm, u16 * next, u32 * error, u8 is_ip4)
3336 if (*error == TCP_ERROR_FILTERED || *error == TCP_ERROR_WRONG_THREAD)
3338 *next = TCP_INPUT_NEXT_DROP;
3340 else if ((is_ip4 && tm->punt_unknown4) || (!is_ip4 && tm->punt_unknown6))
3342 *next = TCP_INPUT_NEXT_PUNT;
3343 *error = TCP_ERROR_PUNT;
3347 *next = TCP_INPUT_NEXT_RESET;
3348 *error = TCP_ERROR_NO_LISTENER;
3352 static inline tcp_connection_t *
3353 tcp_input_lookup_buffer (vlib_buffer_t * b, u8 thread_index, u32 * error,
3356 u32 fib_index = vnet_buffer (b)->ip.fib_index;
3357 int n_advance_bytes, n_data_bytes;
3358 transport_connection_t *tc;
3364 ip4_header_t *ip4 = vlib_buffer_get_current (b);
3365 int ip_hdr_bytes = ip4_header_bytes (ip4);
3366 if (PREDICT_FALSE (b->current_length < ip_hdr_bytes + sizeof (*tcp)))
3368 *error = TCP_ERROR_LENGTH;
3371 tcp = ip4_next_header (ip4);
3372 vnet_buffer (b)->tcp.hdr_offset = (u8 *) tcp - (u8 *) ip4;
3373 n_advance_bytes = (ip_hdr_bytes + tcp_header_bytes (tcp));
3374 n_data_bytes = clib_net_to_host_u16 (ip4->length) - n_advance_bytes;
3376 /* Length check. Checksum computed by ipx_local no need to compute again */
3377 if (PREDICT_FALSE (n_data_bytes < 0))
3379 *error = TCP_ERROR_LENGTH;
3383 tc = session_lookup_connection_wt4 (fib_index, &ip4->dst_address,
3384 &ip4->src_address, tcp->dst_port,
3385 tcp->src_port, TRANSPORT_PROTO_TCP,
3386 thread_index, &result);
3390 ip6_header_t *ip6 = vlib_buffer_get_current (b);
3391 if (PREDICT_FALSE (b->current_length < sizeof (*ip6) + sizeof (*tcp)))
3393 *error = TCP_ERROR_LENGTH;
3396 tcp = ip6_next_header (ip6);
3397 vnet_buffer (b)->tcp.hdr_offset = (u8 *) tcp - (u8 *) ip6;
3398 n_advance_bytes = tcp_header_bytes (tcp);
3399 n_data_bytes = clib_net_to_host_u16 (ip6->payload_length)
3401 n_advance_bytes += sizeof (ip6[0]);
3403 if (PREDICT_FALSE (n_data_bytes < 0))
3405 *error = TCP_ERROR_LENGTH;
3409 (ip6_address_is_link_local_unicast (&ip6->dst_address)))
3411 ip4_main_t *im = &ip4_main;
3412 fib_index = vec_elt (im->fib_index_by_sw_if_index,
3413 vnet_buffer (b)->sw_if_index[VLIB_RX]);
3416 tc = session_lookup_connection_wt6 (fib_index, &ip6->dst_address,
3417 &ip6->src_address, tcp->dst_port,
3418 tcp->src_port, TRANSPORT_PROTO_TCP,
3419 thread_index, &result);
3422 vnet_buffer (b)->tcp.seq_number = clib_net_to_host_u32 (tcp->seq_number);
3423 vnet_buffer (b)->tcp.ack_number = clib_net_to_host_u32 (tcp->ack_number);
3424 vnet_buffer (b)->tcp.data_offset = n_advance_bytes;
3425 vnet_buffer (b)->tcp.data_len = n_data_bytes;
3426 vnet_buffer (b)->tcp.seq_end = vnet_buffer (b)->tcp.seq_number
3428 vnet_buffer (b)->tcp.flags = 0;
3430 *error = result ? TCP_ERROR_NONE + result : *error;
3432 return tcp_get_connection_from_transport (tc);
3436 tcp_input_dispatch_buffer (tcp_main_t * tm, tcp_connection_t * tc,
3437 vlib_buffer_t * b, u16 * next, u32 * error)
3442 tcp = tcp_buffer_hdr (b);
3443 flags = tcp->flags & filter_flags;
3444 *next = tm->dispatch_table[tc->state][flags].next;
3445 *error = tm->dispatch_table[tc->state][flags].error;
3447 if (PREDICT_FALSE (*error == TCP_ERROR_DISPATCH
3448 || *next == TCP_INPUT_NEXT_RESET))
3450 /* Overload tcp flags to store state */
3451 tcp_state_t state = tc->state;
3452 vnet_buffer (b)->tcp.flags = tc->state;
3454 if (*error == TCP_ERROR_DISPATCH)
3455 clib_warning ("tcp conn %u disp error state %U flags %U",
3456 tc->c_c_index, format_tcp_state, state,
3457 format_tcp_flags, (int) flags);
3462 tcp46_input_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
3463 vlib_frame_t * frame, int is_ip4)
3465 u32 n_left_from, *from, thread_index = vm->thread_index;
3466 tcp_main_t *tm = vnet_get_tcp_main ();
3467 vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b;
3468 u16 nexts[VLIB_FRAME_SIZE], *next;
3470 tcp_set_time_now (tcp_get_worker (thread_index));
3472 from = vlib_frame_vector_args (frame);
3473 n_left_from = frame->n_vectors;
3474 vlib_get_buffers (vm, from, bufs, n_left_from);
3479 while (n_left_from >= 4)
3481 u32 error0 = TCP_ERROR_NO_LISTENER, error1 = TCP_ERROR_NO_LISTENER;
3482 tcp_connection_t *tc0, *tc1;
3485 vlib_prefetch_buffer_header (b[2], STORE);
3486 CLIB_PREFETCH (b[2]->data, 2 * CLIB_CACHE_LINE_BYTES, LOAD);
3488 vlib_prefetch_buffer_header (b[3], STORE);
3489 CLIB_PREFETCH (b[3]->data, 2 * CLIB_CACHE_LINE_BYTES, LOAD);
3492 next[0] = next[1] = TCP_INPUT_NEXT_DROP;
3494 tc0 = tcp_input_lookup_buffer (b[0], thread_index, &error0, is_ip4);
3495 tc1 = tcp_input_lookup_buffer (b[1], thread_index, &error1, is_ip4);
3497 if (PREDICT_TRUE (!tc0 + !tc1 == 0))
3499 ASSERT (tcp_lookup_is_valid (tc0, tcp_buffer_hdr (b[0])));
3500 ASSERT (tcp_lookup_is_valid (tc1, tcp_buffer_hdr (b[1])));
3502 vnet_buffer (b[0])->tcp.connection_index = tc0->c_c_index;
3503 vnet_buffer (b[1])->tcp.connection_index = tc1->c_c_index;
3505 tcp_input_dispatch_buffer (tm, tc0, b[0], &next[0], &error0);
3506 tcp_input_dispatch_buffer (tm, tc1, b[1], &next[1], &error1);
3510 if (PREDICT_TRUE (tc0 != 0))
3512 ASSERT (tcp_lookup_is_valid (tc0, tcp_buffer_hdr (b[0])));
3513 vnet_buffer (b[0])->tcp.connection_index = tc0->c_c_index;
3514 tcp_input_dispatch_buffer (tm, tc0, b[0], &next[0], &error0);
3517 tcp_input_set_error_next (tm, &next[0], &error0, is_ip4);
3519 if (PREDICT_TRUE (tc1 != 0))
3521 ASSERT (tcp_lookup_is_valid (tc1, tcp_buffer_hdr (b[1])));
3522 vnet_buffer (b[1])->tcp.connection_index = tc1->c_c_index;
3523 tcp_input_dispatch_buffer (tm, tc1, b[1], &next[1], &error1);
3526 tcp_input_set_error_next (tm, &next[1], &error1, is_ip4);
3533 while (n_left_from > 0)
3535 tcp_connection_t *tc0;
3536 u32 error0 = TCP_ERROR_NO_LISTENER;
3538 if (n_left_from > 1)
3540 vlib_prefetch_buffer_header (b[1], STORE);
3541 CLIB_PREFETCH (b[1]->data, 2 * CLIB_CACHE_LINE_BYTES, LOAD);
3544 next[0] = TCP_INPUT_NEXT_DROP;
3545 tc0 = tcp_input_lookup_buffer (b[0], thread_index, &error0, is_ip4);
3546 if (PREDICT_TRUE (tc0 != 0))
3548 ASSERT (tcp_lookup_is_valid (tc0, tcp_buffer_hdr (b[0])));
3549 vnet_buffer (b[0])->tcp.connection_index = tc0->c_c_index;
3550 tcp_input_dispatch_buffer (tm, tc0, b[0], &next[0], &error0);
3553 tcp_input_set_error_next (tm, &next[0], &error0, is_ip4);
3560 if (PREDICT_FALSE (node->flags & VLIB_NODE_FLAG_TRACE))
3561 tcp_input_trace_frame (vm, node, bufs, frame->n_vectors, is_ip4);
3563 vlib_buffer_enqueue_to_next (vm, node, from, nexts, frame->n_vectors);
3564 return frame->n_vectors;
3567 VLIB_NODE_FN (tcp4_input_node) (vlib_main_t * vm, vlib_node_runtime_t * node,
3568 vlib_frame_t * from_frame)
3570 return tcp46_input_inline (vm, node, from_frame, 1 /* is_ip4 */ );
3573 VLIB_NODE_FN (tcp6_input_node) (vlib_main_t * vm, vlib_node_runtime_t * node,
3574 vlib_frame_t * from_frame)
3576 return tcp46_input_inline (vm, node, from_frame, 0 /* is_ip4 */ );
3580 VLIB_REGISTER_NODE (tcp4_input_node) =
3582 .name = "tcp4-input",
3583 /* Takes a vector of packets. */
3584 .vector_size = sizeof (u32),
3585 .n_errors = TCP_N_ERROR,
3586 .error_strings = tcp_error_strings,
3587 .n_next_nodes = TCP_INPUT_N_NEXT,
3590 #define _(s,n) [TCP_INPUT_NEXT_##s] = n,
3591 foreach_tcp4_input_next
3594 .format_buffer = format_tcp_header,
3595 .format_trace = format_tcp_rx_trace,
3600 VLIB_REGISTER_NODE (tcp6_input_node) =
3602 .name = "tcp6-input",
3603 /* Takes a vector of packets. */
3604 .vector_size = sizeof (u32),
3605 .n_errors = TCP_N_ERROR,
3606 .error_strings = tcp_error_strings,
3607 .n_next_nodes = TCP_INPUT_N_NEXT,
3610 #define _(s,n) [TCP_INPUT_NEXT_##s] = n,
3611 foreach_tcp6_input_next
3614 .format_buffer = format_tcp_header,
3615 .format_trace = format_tcp_rx_trace,
3619 #ifndef CLIB_MARCH_VARIANT
3621 tcp_dispatch_table_init (tcp_main_t * tm)
3624 for (i = 0; i < ARRAY_LEN (tm->dispatch_table); i++)
3625 for (j = 0; j < ARRAY_LEN (tm->dispatch_table[i]); j++)
3627 tm->dispatch_table[i][j].next = TCP_INPUT_NEXT_DROP;
3628 tm->dispatch_table[i][j].error = TCP_ERROR_DISPATCH;
3631 #define _(t,f,n,e) \
3633 tm->dispatch_table[TCP_STATE_##t][f].next = (n); \
3634 tm->dispatch_table[TCP_STATE_##t][f].error = (e); \
3637 /* RFC 793: In LISTEN if RST drop and if ACK return RST */
3638 _(LISTEN, 0, TCP_INPUT_NEXT_DROP, TCP_ERROR_SEGMENT_INVALID);
3639 _(LISTEN, TCP_FLAG_ACK, TCP_INPUT_NEXT_RESET, TCP_ERROR_ACK_INVALID);
3640 _(LISTEN, TCP_FLAG_RST, TCP_INPUT_NEXT_DROP, TCP_ERROR_INVALID_CONNECTION);
3641 _(LISTEN, TCP_FLAG_SYN, TCP_INPUT_NEXT_LISTEN, TCP_ERROR_NONE);
3642 _(LISTEN, TCP_FLAG_SYN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RESET,
3643 TCP_ERROR_ACK_INVALID);
3644 _(LISTEN, TCP_FLAG_SYN | TCP_FLAG_RST, TCP_INPUT_NEXT_DROP,
3645 TCP_ERROR_SEGMENT_INVALID);
3646 _(LISTEN, TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_DROP,
3647 TCP_ERROR_SEGMENT_INVALID);
3648 _(LISTEN, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_DROP,
3649 TCP_ERROR_INVALID_CONNECTION);
3650 _(LISTEN, TCP_FLAG_FIN, TCP_INPUT_NEXT_RESET, TCP_ERROR_SEGMENT_INVALID);
3651 _(LISTEN, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RESET,
3652 TCP_ERROR_SEGMENT_INVALID);
3653 _(LISTEN, TCP_FLAG_FIN | TCP_FLAG_RST, TCP_INPUT_NEXT_DROP,
3654 TCP_ERROR_SEGMENT_INVALID);
3655 _(LISTEN, TCP_FLAG_FIN | TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_DROP,
3657 _(LISTEN, TCP_FLAG_FIN | TCP_FLAG_SYN, TCP_INPUT_NEXT_DROP,
3658 TCP_ERROR_SEGMENT_INVALID);
3659 _(LISTEN, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_ACK, TCP_INPUT_NEXT_DROP,
3660 TCP_ERROR_SEGMENT_INVALID);
3661 _(LISTEN, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_RST, TCP_INPUT_NEXT_DROP,
3662 TCP_ERROR_SEGMENT_INVALID);
3663 _(LISTEN, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK,
3664 TCP_INPUT_NEXT_DROP, TCP_ERROR_SEGMENT_INVALID);
3665 /* ACK for for a SYN-ACK -> tcp-rcv-process. */
3666 _(SYN_RCVD, TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3667 _(SYN_RCVD, TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3668 _(SYN_RCVD, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3670 _(SYN_RCVD, TCP_FLAG_SYN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3671 _(SYN_RCVD, TCP_FLAG_SYN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3673 _(SYN_RCVD, TCP_FLAG_SYN | TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS,
3675 _(SYN_RCVD, TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK,
3676 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3677 _(SYN_RCVD, TCP_FLAG_FIN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3678 _(SYN_RCVD, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3680 _(SYN_RCVD, TCP_FLAG_FIN | TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS,
3682 _(SYN_RCVD, TCP_FLAG_FIN | TCP_FLAG_RST | TCP_FLAG_ACK,
3683 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3684 _(SYN_RCVD, TCP_FLAG_FIN | TCP_FLAG_SYN, TCP_INPUT_NEXT_RCV_PROCESS,
3686 _(SYN_RCVD, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_RST,
3687 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3688 _(SYN_RCVD, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_ACK,
3689 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3690 _(SYN_RCVD, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK,
3691 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3692 _(SYN_RCVD, 0, TCP_INPUT_NEXT_DROP, TCP_ERROR_SEGMENT_INVALID);
3693 /* SYN-ACK for a SYN */
3694 _(SYN_SENT, TCP_FLAG_SYN | TCP_FLAG_ACK, TCP_INPUT_NEXT_SYN_SENT,
3696 _(SYN_SENT, TCP_FLAG_ACK, TCP_INPUT_NEXT_SYN_SENT, TCP_ERROR_NONE);
3697 _(SYN_SENT, TCP_FLAG_RST, TCP_INPUT_NEXT_SYN_SENT, TCP_ERROR_NONE);
3698 _(SYN_SENT, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_SYN_SENT,
3700 _(SYN_SENT, TCP_FLAG_FIN, TCP_INPUT_NEXT_SYN_SENT, TCP_ERROR_NONE);
3701 _(SYN_SENT, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_SYN_SENT,
3703 /* ACK for for established connection -> tcp-established. */
3704 _(ESTABLISHED, TCP_FLAG_ACK, TCP_INPUT_NEXT_ESTABLISHED, TCP_ERROR_NONE);
3705 /* FIN for for established connection -> tcp-established. */
3706 _(ESTABLISHED, TCP_FLAG_FIN, TCP_INPUT_NEXT_ESTABLISHED, TCP_ERROR_NONE);
3707 _(ESTABLISHED, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_ESTABLISHED,
3709 _(ESTABLISHED, TCP_FLAG_FIN | TCP_FLAG_RST, TCP_INPUT_NEXT_ESTABLISHED,
3711 _(ESTABLISHED, TCP_FLAG_FIN | TCP_FLAG_RST | TCP_FLAG_ACK,
3712 TCP_INPUT_NEXT_ESTABLISHED, TCP_ERROR_NONE);
3713 _(ESTABLISHED, TCP_FLAG_FIN | TCP_FLAG_SYN, TCP_INPUT_NEXT_ESTABLISHED,
3715 _(ESTABLISHED, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_ACK,
3716 TCP_INPUT_NEXT_ESTABLISHED, TCP_ERROR_NONE);
3717 _(ESTABLISHED, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_RST,
3718 TCP_INPUT_NEXT_ESTABLISHED, TCP_ERROR_NONE);
3719 _(ESTABLISHED, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK,
3720 TCP_INPUT_NEXT_ESTABLISHED, TCP_ERROR_NONE);
3721 _(ESTABLISHED, TCP_FLAG_RST, TCP_INPUT_NEXT_ESTABLISHED, TCP_ERROR_NONE);
3722 _(ESTABLISHED, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_ESTABLISHED,
3724 _(ESTABLISHED, TCP_FLAG_SYN, TCP_INPUT_NEXT_ESTABLISHED, TCP_ERROR_NONE);
3725 _(ESTABLISHED, TCP_FLAG_SYN | TCP_FLAG_ACK, TCP_INPUT_NEXT_ESTABLISHED,
3727 _(ESTABLISHED, TCP_FLAG_SYN | TCP_FLAG_RST, TCP_INPUT_NEXT_ESTABLISHED,
3729 _(ESTABLISHED, TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK,
3730 TCP_INPUT_NEXT_ESTABLISHED, TCP_ERROR_NONE);
3731 _(ESTABLISHED, 0, TCP_INPUT_NEXT_DROP, TCP_ERROR_SEGMENT_INVALID);
3732 /* ACK or FIN-ACK to our FIN */
3733 _(FIN_WAIT_1, TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3734 _(FIN_WAIT_1, TCP_FLAG_ACK | TCP_FLAG_FIN, TCP_INPUT_NEXT_RCV_PROCESS,
3736 /* FIN in reply to our FIN from the other side */
3737 _(FIN_WAIT_1, 0, TCP_INPUT_NEXT_DROP, TCP_ERROR_SEGMENT_INVALID);
3738 _(FIN_WAIT_1, TCP_FLAG_FIN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3739 _(FIN_WAIT_1, TCP_FLAG_FIN | TCP_FLAG_SYN, TCP_INPUT_NEXT_RCV_PROCESS,
3741 _(FIN_WAIT_1, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_ACK,
3742 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3743 _(FIN_WAIT_1, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_RST,
3744 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3745 _(FIN_WAIT_1, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK,
3746 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3747 _(FIN_WAIT_1, TCP_FLAG_FIN | TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS,
3749 _(FIN_WAIT_1, TCP_FLAG_FIN | TCP_FLAG_RST | TCP_FLAG_ACK,
3750 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3751 _(FIN_WAIT_1, TCP_FLAG_SYN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3752 _(FIN_WAIT_1, TCP_FLAG_SYN | TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS,
3754 _(FIN_WAIT_1, TCP_FLAG_SYN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3756 _(FIN_WAIT_1, TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK,
3757 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3758 _(FIN_WAIT_1, TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3759 _(FIN_WAIT_1, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3761 _(CLOSING, 0, TCP_INPUT_NEXT_DROP, TCP_ERROR_SEGMENT_INVALID);
3762 _(CLOSING, TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3763 _(CLOSING, TCP_FLAG_SYN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3764 _(CLOSING, TCP_FLAG_SYN | TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS,
3766 _(CLOSING, TCP_FLAG_SYN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3768 _(CLOSING, TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK,
3769 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3770 _(CLOSING, TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3771 _(CLOSING, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3773 _(CLOSING, TCP_FLAG_FIN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3774 _(CLOSING, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3776 _(CLOSING, TCP_FLAG_FIN | TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS,
3778 _(CLOSING, TCP_FLAG_FIN | TCP_FLAG_RST | TCP_FLAG_ACK,
3779 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3780 _(CLOSING, TCP_FLAG_FIN | TCP_FLAG_SYN, TCP_INPUT_NEXT_RCV_PROCESS,
3782 _(CLOSING, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_ACK,
3783 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3784 _(CLOSING, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK,
3785 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3786 /* FIN confirming that the peer (app) has closed */
3787 _(FIN_WAIT_2, TCP_FLAG_FIN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3788 _(FIN_WAIT_2, TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3789 _(FIN_WAIT_2, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3791 _(FIN_WAIT_2, TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3792 _(FIN_WAIT_2, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3794 _(CLOSE_WAIT, TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3795 _(CLOSE_WAIT, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3797 _(CLOSE_WAIT, TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3798 _(CLOSE_WAIT, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3800 _(LAST_ACK, 0, TCP_INPUT_NEXT_DROP, TCP_ERROR_SEGMENT_INVALID);
3801 _(LAST_ACK, TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3802 _(LAST_ACK, TCP_FLAG_FIN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3803 _(LAST_ACK, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3805 _(LAST_ACK, TCP_FLAG_FIN | TCP_FLAG_SYN, TCP_INPUT_NEXT_RCV_PROCESS,
3807 _(LAST_ACK, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_ACK,
3808 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3809 _(LAST_ACK, TCP_FLAG_FIN | TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS,
3811 _(LAST_ACK, TCP_FLAG_FIN | TCP_FLAG_RST | TCP_FLAG_ACK,
3812 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3813 _(LAST_ACK, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_RST,
3814 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3815 _(LAST_ACK, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK,
3816 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3817 _(LAST_ACK, TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3818 _(LAST_ACK, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3820 _(LAST_ACK, TCP_FLAG_SYN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3821 _(LAST_ACK, TCP_FLAG_SYN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3823 _(LAST_ACK, TCP_FLAG_SYN | TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS,
3825 _(LAST_ACK, TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK,
3826 TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3827 _(TIME_WAIT, TCP_FLAG_SYN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3828 _(TIME_WAIT, TCP_FLAG_FIN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3829 _(TIME_WAIT, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3831 _(TIME_WAIT, TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3832 _(TIME_WAIT, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3834 _(TIME_WAIT, TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3835 /* RFC793 CLOSED: An incoming segment containing a RST is discarded. An
3836 * incoming segment not containing a RST causes a RST to be sent in
3838 _(CLOSED, TCP_FLAG_RST, TCP_INPUT_NEXT_DROP, TCP_ERROR_CONNECTION_CLOSED);
3839 _(CLOSED, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_DROP,
3840 TCP_ERROR_CONNECTION_CLOSED);
3841 _(CLOSED, TCP_FLAG_ACK, TCP_INPUT_NEXT_RESET, TCP_ERROR_NONE);
3842 _(CLOSED, TCP_FLAG_SYN, TCP_INPUT_NEXT_RESET, TCP_ERROR_NONE);
3843 _(CLOSED, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RESET,
3848 static clib_error_t *
3849 tcp_input_init (vlib_main_t * vm)
3851 clib_error_t *error = 0;
3852 tcp_main_t *tm = vnet_get_tcp_main ();
3854 if ((error = vlib_call_init_function (vm, tcp_init)))
3857 /* Initialize dispatch table. */
3858 tcp_dispatch_table_init (tm);
3863 VLIB_INIT_FUNCTION (tcp_input_init);
3865 #endif /* CLIB_MARCH_VARIANT */
3868 * fd.io coding-style-patch-verification: ON
3871 * eval: (c-set-style "gnu")