tcp: migrate old MULTIARCH macros to VLIB_NODE_FN
[vpp.git] / src / vnet / tcp / tcp_input.c
1 /*
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:
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15
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>
20 #include <math.h>
21
22 static char *tcp_error_strings[] = {
23 #define tcp_error(n,s) s,
24 #include <vnet/tcp/tcp_error.def>
25 #undef tcp_error
26 };
27
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")
34
35 typedef enum _tcp_established_next
36 {
37 #define _(s,n) TCP_ESTABLISHED_NEXT_##s,
38   foreach_tcp_state_next
39 #undef _
40     TCP_ESTABLISHED_N_NEXT,
41 } tcp_established_next_t;
42
43 typedef enum _tcp_rcv_process_next
44 {
45 #define _(s,n) TCP_RCV_PROCESS_NEXT_##s,
46   foreach_tcp_state_next
47 #undef _
48     TCP_RCV_PROCESS_N_NEXT,
49 } tcp_rcv_process_next_t;
50
51 typedef enum _tcp_syn_sent_next
52 {
53 #define _(s,n) TCP_SYN_SENT_NEXT_##s,
54   foreach_tcp_state_next
55 #undef _
56     TCP_SYN_SENT_N_NEXT,
57 } tcp_syn_sent_next_t;
58
59 typedef enum _tcp_listen_next
60 {
61 #define _(s,n) TCP_LISTEN_NEXT_##s,
62   foreach_tcp_state_next
63 #undef _
64     TCP_LISTEN_N_NEXT,
65 } tcp_listen_next_t;
66
67 /* Generic, state independent indices */
68 typedef enum _tcp_state_next
69 {
70 #define _(s,n) TCP_NEXT_##s,
71   foreach_tcp_state_next
72 #undef _
73     TCP_STATE_N_NEXT,
74 } tcp_state_next_t;
75
76 #define tcp_next_output(is_ip4) (is_ip4 ? TCP_NEXT_TCP4_OUTPUT          \
77                                         : TCP_NEXT_TCP6_OUTPUT)
78
79 #define tcp_next_drop(is_ip4) (is_ip4 ? TCP_NEXT_DROP4                  \
80                                       : TCP_NEXT_DROP6)
81
82 /**
83  * Validate segment sequence number. As per RFC793:
84  *
85  * Segment Receive Test
86  *      Length  Window
87  *      ------- -------  -------------------------------------------
88  *      0       0       SEG.SEQ = RCV.NXT
89  *      0       >0      RCV.NXT =< SEG.SEQ < RCV.NXT+RCV.WND
90  *      >0      0       not acceptable
91  *      >0      >0      RCV.NXT =< SEG.SEQ < RCV.NXT+RCV.WND
92  *                      or RCV.NXT =< SEG.SEQ+SEG.LEN-1 < RCV.NXT+RCV.WND
93  *
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.
98  *
99  * This:
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.
104  *
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.
107  *
108  */
109 always_inline u8
110 tcp_segment_in_rcv_wnd (tcp_connection_t * tc, u32 seq, u32 end_seq)
111 {
112   return (seq_geq (end_seq, tc->rcv_las)
113           && seq_leq (seq, tc->rcv_nxt + tc->rcv_wnd));
114 }
115
116 /**
117  * Parse TCP header options.
118  *
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
123  */
124 static inline int
125 tcp_options_parse (tcp_header_t * th, tcp_options_t * to, u8 is_syn)
126 {
127   const u8 *data;
128   u8 opt_len, opts_len, kind;
129   int j;
130   sack_block_t b;
131
132   opts_len = (tcp_doff (th) << 2) - sizeof (tcp_header_t);
133   data = (const u8 *) (th + 1);
134
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);
138
139   for (; opts_len > 0; opts_len -= opt_len, data += opt_len)
140     {
141       kind = data[0];
142
143       /* Get options length */
144       if (kind == TCP_OPTION_EOL)
145         break;
146       else if (kind == TCP_OPTION_NOOP)
147         {
148           opt_len = 1;
149           continue;
150         }
151       else
152         {
153           /* broken options */
154           if (opts_len < 2)
155             return -1;
156           opt_len = data[1];
157
158           /* weird option length */
159           if (opt_len < 2 || opt_len > opts_len)
160             return -1;
161         }
162
163       /* Parse options */
164       switch (kind)
165         {
166         case TCP_OPTION_MSS:
167           if (!is_syn)
168             break;
169           if ((opt_len == TCP_OPTION_LEN_MSS) && tcp_syn (th))
170             {
171               to->flags |= TCP_OPTS_FLAG_MSS;
172               to->mss = clib_net_to_host_u16 (*(u16 *) (data + 2));
173             }
174           break;
175         case TCP_OPTION_WINDOW_SCALE:
176           if (!is_syn)
177             break;
178           if ((opt_len == TCP_OPTION_LEN_WINDOW_SCALE) && tcp_syn (th))
179             {
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;
184             }
185           break;
186         case TCP_OPTION_TIMESTAMP:
187           if (is_syn)
188             to->flags |= TCP_OPTS_FLAG_TSTAMP;
189           if ((to->flags & TCP_OPTS_FLAG_TSTAMP)
190               && opt_len == TCP_OPTION_LEN_TIMESTAMP)
191             {
192               to->tsval = clib_net_to_host_u32 (*(u32 *) (data + 2));
193               to->tsecr = clib_net_to_host_u32 (*(u32 *) (data + 6));
194             }
195           break;
196         case TCP_OPTION_SACK_PERMITTED:
197           if (!is_syn)
198             break;
199           if (opt_len == TCP_OPTION_LEN_SACK_PERMITTED && tcp_syn (th))
200             to->flags |= TCP_OPTS_FLAG_SACK_PERMITTED;
201           break;
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))
205             break;
206
207           /* If too short or not correctly formatted, break */
208           if (opt_len < 10 || ((opt_len - 2) % TCP_OPTION_LEN_SACK_BLOCK))
209             break;
210
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++)
215             {
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);
219             }
220           break;
221         default:
222           /* Nothing to see here */
223           continue;
224         }
225     }
226   return 0;
227 }
228
229 /**
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
234  *
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
237  */
238 always_inline int
239 tcp_segment_check_paws (tcp_connection_t * tc)
240 {
241   return tcp_opts_tstamp (&tc->rcv_opts)
242     && timestamp_lt (tc->rcv_opts.tsval, tc->tsval_recent);
243 }
244
245 /**
246  * Update tsval recent
247  */
248 always_inline void
249 tcp_update_timestamp (tcp_connection_t * tc, u32 seq, u32 seq_end)
250 {
251   /*
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.
257    */
258   if (tcp_opts_tstamp (&tc->rcv_opts) && seq_leq (seq, tc->rcv_las)
259       && seq_leq (tc->rcv_las, seq_end))
260     {
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);
264     }
265 }
266
267 /**
268  * Validate incoming segment as per RFC793 p. 69 and RFC1323 p. 19
269  *
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.
273  *
274  * @return 0 if segments passes validation.
275  */
276 static int
277 tcp_segment_validate (tcp_worker_ctx_t * wrk, tcp_connection_t * tc0,
278                       vlib_buffer_t * b0, tcp_header_t * th0, u32 * error0)
279 {
280   /* We could get a burst of RSTs interleaved with acks */
281   if (PREDICT_FALSE (tc0->state == TCP_STATE_CLOSED))
282     {
283       tcp_send_reset (tc0);
284       *error0 = TCP_ERROR_CONNECTION_CLOSED;
285       goto error;
286     }
287
288   if (PREDICT_FALSE (!tcp_ack (th0) && !tcp_rst (th0) && !tcp_syn (th0)))
289     {
290       *error0 = TCP_ERROR_SEGMENT_INVALID;
291       goto error;
292     }
293
294   if (PREDICT_FALSE (tcp_options_parse (th0, &tc0->rcv_opts, 0)))
295     {
296       *error0 = TCP_ERROR_OPTIONS;
297       goto error;
298     }
299
300   if (PREDICT_FALSE (tcp_segment_check_paws (tc0)))
301     {
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);
305
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)))
310         {
311           tc0->tsval_recent = tc0->rcv_opts.tsval;
312           clib_warning ("paws failed: 24-day old segment");
313         }
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
317        * SEG.TSval */
318       else if (!tcp_rst (th0))
319         {
320           tcp_program_ack (wrk, tc0);
321           TCP_EVT_DBG (TCP_EVT_DUPACK_SENT, tc0, vnet_buffer (b0)->tcp);
322           goto error;
323         }
324     }
325
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))
329     {
330       /* SYN/SYN-ACK retransmit */
331       if (tcp_syn (th0)
332           && vnet_buffer (b0)->tcp.seq_number == tc0->rcv_nxt - 1)
333         {
334           tcp_options_parse (th0, &tc0->rcv_opts, 1);
335           if (tc0->state == TCP_STATE_SYN_RCVD)
336             {
337               tcp_send_synack (tc0);
338               TCP_EVT_DBG (TCP_EVT_SYN_RCVD, tc0, 0);
339               *error0 = TCP_ERROR_SYNS_RCVD;
340             }
341           else
342             {
343               tcp_program_ack (wrk, tc0);
344               TCP_EVT_DBG (TCP_EVT_SYNACK_RCVD, tc0);
345               *error0 = TCP_ERROR_SYN_ACKS_RCVD;
346             }
347           goto error;
348         }
349
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 == 0
353           && tc0->rcv_nxt == vnet_buffer (b0)->tcp.seq_number)
354         goto check_reset;
355
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))
364         goto check_reset;
365
366       *error0 = TCP_ERROR_RCV_WND;
367
368       /* If not RST, send dup ack */
369       if (!tcp_rst (th0))
370         {
371           tcp_program_dupack (wrk, tc0);
372           TCP_EVT_DBG (TCP_EVT_DUPACK_SENT, tc0, vnet_buffer (b0)->tcp);
373         }
374       goto error;
375
376     check_reset:
377       ;
378     }
379
380   /* 2nd: check the RST bit */
381   if (PREDICT_FALSE (tcp_rst (th0)))
382     {
383       tcp_connection_reset (tc0);
384       *error0 = TCP_ERROR_RST_RCVD;
385       goto error;
386     }
387
388   /* 3rd: check security and precedence (skip) */
389
390   /* 4th: check the SYN bit (in window) */
391   if (PREDICT_FALSE (tcp_syn (th0)))
392     {
393       *error0 = TCP_ERROR_SPURIOUS_SYN;
394       tcp_send_reset (tc0);
395       goto error;
396     }
397
398   /* If segment in window, save timestamp */
399   tcp_update_timestamp (tc0, vnet_buffer (b0)->tcp.seq_number,
400                         vnet_buffer (b0)->tcp.seq_end);
401   return 0;
402
403 error:
404   return -1;
405 }
406
407 always_inline int
408 tcp_rcv_ack_is_acceptable (tcp_connection_t * tc0, vlib_buffer_t * tb0)
409 {
410   /* SND.UNA =< SEG.ACK =< SND.NXT */
411   return (seq_leq (tc0->snd_una, vnet_buffer (tb0)->tcp.ack_number)
412           && seq_leq (vnet_buffer (tb0)->tcp.ack_number, tc0->snd_nxt));
413 }
414
415 /**
416  * Compute smoothed RTT as per VJ's '88 SIGCOMM and RFC6298
417  *
418  * Note that although the original article, srtt and rttvar are scaled
419  * to minimize round-off errors, here we don't. Instead, we rely on
420  * better precision time measurements.
421  *
422  * TODO support us rtt resolution
423  */
424 static void
425 tcp_estimate_rtt (tcp_connection_t * tc, u32 mrtt)
426 {
427   int err, diff;
428
429   if (tc->srtt != 0)
430     {
431       err = mrtt - tc->srtt;
432
433       /* XXX Drop in RTT results in RTTVAR increase and bigger RTO.
434        * The increase should be bound */
435       tc->srtt = clib_max ((int) tc->srtt + (err >> 3), 1);
436       diff = (clib_abs (err) - (int) tc->rttvar) >> 2;
437       tc->rttvar = clib_max ((int) tc->rttvar + diff, 1);
438     }
439   else
440     {
441       /* First measurement. */
442       tc->srtt = mrtt;
443       tc->rttvar = mrtt >> 1;
444     }
445 }
446
447 #ifndef CLIB_MARCH_VARIANT
448 void
449 tcp_update_rto (tcp_connection_t * tc)
450 {
451   tc->rto = clib_min (tc->srtt + (tc->rttvar << 2), TCP_RTO_MAX);
452   tc->rto = clib_max (tc->rto, TCP_RTO_MIN);
453 }
454 #endif /* CLIB_MARCH_VARIANT */
455
456 /**
457  * Update RTT estimate and RTO timer
458  *
459  * Measure RTT: We have two sources of RTT measurements: TSOPT and ACK
460  * timing. Middle boxes are known to fiddle with TCP options so we
461  * should give higher priority to ACK timing.
462  *
463  * This should be called only if previously sent bytes have been acked.
464  *
465  * return 1 if valid rtt 0 otherwise
466  */
467 static int
468 tcp_update_rtt (tcp_connection_t * tc, u32 ack)
469 {
470   u32 mrtt = 0;
471
472   /* Karn's rule, part 1. Don't use retransmitted segments to estimate
473    * RTT because they're ambiguous. */
474   if (tcp_in_cong_recovery (tc) || tc->sack_sb.sacked_bytes)
475     {
476       if (tcp_in_recovery (tc))
477         return 0;
478       goto done;
479     }
480
481   if (tc->rtt_ts && seq_geq (ack, tc->rtt_seq))
482     {
483       f64 sample = tcp_time_now_us (tc->c_thread_index) - tc->rtt_ts;
484       tc->mrtt_us = tc->mrtt_us + (sample - tc->mrtt_us) * 0.125;
485       mrtt = clib_max ((u32) (sample * THZ), 1);
486       /* Allow measuring of a new RTT */
487       tc->rtt_ts = 0;
488     }
489   /* As per RFC7323 TSecr can be used for RTTM only if the segment advances
490    * snd_una, i.e., the left side of the send window:
491    * seq_lt (tc->snd_una, ack). This is a condition for calling update_rtt */
492   else if (tcp_opts_tstamp (&tc->rcv_opts) && tc->rcv_opts.tsecr)
493     {
494       u32 now = tcp_time_now_w_thread (tc->c_thread_index);
495       mrtt = clib_max (now - tc->rcv_opts.tsecr, 1);
496     }
497
498   /* Ignore dubious measurements */
499   if (mrtt == 0 || mrtt > TCP_RTT_MAX)
500     goto done;
501
502   tcp_estimate_rtt (tc, mrtt);
503
504 done:
505
506   /* If we got here something must've been ACKed so make sure boff is 0,
507    * even if mrtt is not valid since we update the rto lower */
508   tc->rto_boff = 0;
509   tcp_update_rto (tc);
510
511   return 0;
512 }
513
514 static void
515 tcp_estimate_initial_rtt (tcp_connection_t * tc)
516 {
517   u8 thread_index = vlib_num_workers ()? 1 : 0;
518   int mrtt;
519
520   if (tc->rtt_ts)
521     {
522       tc->mrtt_us = tcp_time_now_us (thread_index) - tc->rtt_ts;
523       tc->mrtt_us = clib_max (tc->mrtt_us, 0.0001);
524       mrtt = clib_max ((u32) (tc->mrtt_us * THZ), 1);
525       tc->rtt_ts = 0;
526     }
527   else
528     {
529       mrtt = tcp_time_now_w_thread (thread_index) - tc->rcv_opts.tsecr;
530       mrtt = clib_max (mrtt, 1);
531       /* Due to retransmits we don't know the initial mrtt */
532       if (tc->rto_boff && mrtt > 1 * THZ)
533         mrtt = 1 * THZ;
534       tc->mrtt_us = (f64) mrtt *TCP_TICK;
535     }
536
537   if (mrtt > 0 && mrtt < TCP_RTT_MAX)
538     tcp_estimate_rtt (tc, mrtt);
539   tcp_update_rto (tc);
540 }
541
542 /**
543  * Dequeue bytes for connections that have received acks in last burst
544  */
545 static void
546 tcp_handle_postponed_dequeues (tcp_worker_ctx_t * wrk)
547 {
548   u32 thread_index = wrk->vm->thread_index;
549   u32 *pending_deq_acked;
550   tcp_connection_t *tc;
551   int i;
552
553   if (!vec_len (wrk->pending_deq_acked))
554     return;
555
556   pending_deq_acked = wrk->pending_deq_acked;
557   for (i = 0; i < vec_len (pending_deq_acked); i++)
558     {
559       tc = tcp_connection_get (pending_deq_acked[i], thread_index);
560       tc->flags &= ~TCP_CONN_DEQ_PENDING;
561
562       if (PREDICT_FALSE (!tc->burst_acked))
563         continue;
564
565       /* Dequeue the newly ACKed bytes */
566       session_tx_fifo_dequeue_drop (&tc->connection, tc->burst_acked);
567       tc->burst_acked = 0;
568       tcp_validate_txf_size (tc, tc->snd_una_max - tc->snd_una);
569
570       if (PREDICT_FALSE (tc->flags & TCP_CONN_PSH_PENDING))
571         {
572           if (seq_leq (tc->psh_seq, tc->snd_una))
573             tc->flags &= ~TCP_CONN_PSH_PENDING;
574         }
575
576       /* If everything has been acked, stop retransmit timer
577        * otherwise update. */
578       tcp_retransmit_timer_update (tc);
579
580       /* If not congested, update pacer based on our new
581        * cwnd estimate */
582       if (!tcp_in_fastrecovery (tc))
583         tcp_connection_tx_pacer_update (tc);
584     }
585   _vec_len (wrk->pending_deq_acked) = 0;
586 }
587
588 static void
589 tcp_program_dequeue (tcp_worker_ctx_t * wrk, tcp_connection_t * tc)
590 {
591   if (!(tc->flags & TCP_CONN_DEQ_PENDING))
592     {
593       vec_add1 (wrk->pending_deq_acked, tc->c_c_index);
594       tc->flags |= TCP_CONN_DEQ_PENDING;
595     }
596   tc->burst_acked += tc->bytes_acked + tc->sack_sb.snd_una_adv;
597 }
598
599 /**
600  * Check if duplicate ack as per RFC5681 Sec. 2
601  */
602 static u8
603 tcp_ack_is_dupack (tcp_connection_t * tc, vlib_buffer_t * b, u32 prev_snd_wnd,
604                    u32 prev_snd_una)
605 {
606   return ((vnet_buffer (b)->tcp.ack_number == prev_snd_una)
607           && seq_gt (tc->snd_una_max, tc->snd_una)
608           && (vnet_buffer (b)->tcp.seq_end == vnet_buffer (b)->tcp.seq_number)
609           && (prev_snd_wnd == tc->snd_wnd));
610 }
611
612 /**
613  * Checks if ack is a congestion control event.
614  */
615 static u8
616 tcp_ack_is_cc_event (tcp_connection_t * tc, vlib_buffer_t * b,
617                      u32 prev_snd_wnd, u32 prev_snd_una, u8 * is_dack)
618 {
619   /* Check if ack is duplicate. Per RFC 6675, ACKs that SACK new data are
620    * defined to be 'duplicate' */
621   *is_dack = tc->sack_sb.last_sacked_bytes
622     || tcp_ack_is_dupack (tc, b, prev_snd_wnd, prev_snd_una);
623
624   return ((*is_dack || tcp_in_cong_recovery (tc)) && !tcp_is_lost_fin (tc));
625 }
626
627 #ifndef CLIB_MARCH_VARIANT
628 static u32
629 scoreboard_hole_index (sack_scoreboard_t * sb, sack_scoreboard_hole_t * hole)
630 {
631   ASSERT (!pool_is_free_index (sb->holes, hole - sb->holes));
632   return hole - sb->holes;
633 }
634
635 static u32
636 scoreboard_hole_bytes (sack_scoreboard_hole_t * hole)
637 {
638   return hole->end - hole->start;
639 }
640
641 sack_scoreboard_hole_t *
642 scoreboard_get_hole (sack_scoreboard_t * sb, u32 index)
643 {
644   if (index != TCP_INVALID_SACK_HOLE_INDEX)
645     return pool_elt_at_index (sb->holes, index);
646   return 0;
647 }
648
649 sack_scoreboard_hole_t *
650 scoreboard_next_hole (sack_scoreboard_t * sb, sack_scoreboard_hole_t * hole)
651 {
652   if (hole->next != TCP_INVALID_SACK_HOLE_INDEX)
653     return pool_elt_at_index (sb->holes, hole->next);
654   return 0;
655 }
656
657 sack_scoreboard_hole_t *
658 scoreboard_prev_hole (sack_scoreboard_t * sb, sack_scoreboard_hole_t * hole)
659 {
660   if (hole->prev != TCP_INVALID_SACK_HOLE_INDEX)
661     return pool_elt_at_index (sb->holes, hole->prev);
662   return 0;
663 }
664
665 sack_scoreboard_hole_t *
666 scoreboard_first_hole (sack_scoreboard_t * sb)
667 {
668   if (sb->head != TCP_INVALID_SACK_HOLE_INDEX)
669     return pool_elt_at_index (sb->holes, sb->head);
670   return 0;
671 }
672
673 sack_scoreboard_hole_t *
674 scoreboard_last_hole (sack_scoreboard_t * sb)
675 {
676   if (sb->tail != TCP_INVALID_SACK_HOLE_INDEX)
677     return pool_elt_at_index (sb->holes, sb->tail);
678   return 0;
679 }
680
681 static void
682 scoreboard_remove_hole (sack_scoreboard_t * sb, sack_scoreboard_hole_t * hole)
683 {
684   sack_scoreboard_hole_t *next, *prev;
685
686   if (hole->next != TCP_INVALID_SACK_HOLE_INDEX)
687     {
688       next = pool_elt_at_index (sb->holes, hole->next);
689       next->prev = hole->prev;
690     }
691   else
692     {
693       sb->tail = hole->prev;
694     }
695
696   if (hole->prev != TCP_INVALID_SACK_HOLE_INDEX)
697     {
698       prev = pool_elt_at_index (sb->holes, hole->prev);
699       prev->next = hole->next;
700     }
701   else
702     {
703       sb->head = hole->next;
704     }
705
706   if (scoreboard_hole_index (sb, hole) == sb->cur_rxt_hole)
707     sb->cur_rxt_hole = TCP_INVALID_SACK_HOLE_INDEX;
708
709   /* Poison the entry */
710   if (CLIB_DEBUG > 0)
711     clib_memset (hole, 0xfe, sizeof (*hole));
712
713   pool_put (sb->holes, hole);
714 }
715
716 static sack_scoreboard_hole_t *
717 scoreboard_insert_hole (sack_scoreboard_t * sb, u32 prev_index,
718                         u32 start, u32 end)
719 {
720   sack_scoreboard_hole_t *hole, *next, *prev;
721   u32 hole_index;
722
723   pool_get (sb->holes, hole);
724   clib_memset (hole, 0, sizeof (*hole));
725
726   hole->start = start;
727   hole->end = end;
728   hole_index = scoreboard_hole_index (sb, hole);
729
730   prev = scoreboard_get_hole (sb, prev_index);
731   if (prev)
732     {
733       hole->prev = prev_index;
734       hole->next = prev->next;
735
736       if ((next = scoreboard_next_hole (sb, hole)))
737         next->prev = hole_index;
738       else
739         sb->tail = hole_index;
740
741       prev->next = hole_index;
742     }
743   else
744     {
745       sb->head = hole_index;
746       hole->prev = TCP_INVALID_SACK_HOLE_INDEX;
747       hole->next = TCP_INVALID_SACK_HOLE_INDEX;
748     }
749
750   return hole;
751 }
752 #endif /* CLIB_MARCH_VARIANT */
753
754 #ifndef CLIB_MARCH_VARIANT
755 static void
756 scoreboard_update_bytes (tcp_connection_t * tc, sack_scoreboard_t * sb)
757 {
758   sack_scoreboard_hole_t *left, *right;
759   u32 bytes = 0, blks = 0;
760
761   sb->lost_bytes = 0;
762   sb->sacked_bytes = 0;
763   left = scoreboard_last_hole (sb);
764   if (!left)
765     return;
766
767   if (seq_gt (sb->high_sacked, left->end))
768     {
769       bytes = sb->high_sacked - left->end;
770       blks = 1;
771     }
772
773   while ((right = left)
774          && bytes < (TCP_DUPACK_THRESHOLD - 1) * tc->snd_mss
775          && blks < TCP_DUPACK_THRESHOLD
776          /* left not updated if above conditions fail */
777          && (left = scoreboard_prev_hole (sb, right)))
778     {
779       bytes += right->start - left->end;
780       blks++;
781     }
782
783   /* left is first lost */
784   if (left)
785     {
786       do
787         {
788           sb->lost_bytes += scoreboard_hole_bytes (right);
789           left->is_lost = 1;
790           left = scoreboard_prev_hole (sb, right);
791           if (left)
792             bytes += right->start - left->end;
793         }
794       while ((right = left));
795     }
796
797   sb->sacked_bytes = bytes;
798 }
799
800 /**
801  * Figure out the next hole to retransmit
802  *
803  * Follows logic proposed in RFC6675 Sec. 4, NextSeg()
804  */
805 sack_scoreboard_hole_t *
806 scoreboard_next_rxt_hole (sack_scoreboard_t * sb,
807                           sack_scoreboard_hole_t * start,
808                           u8 have_unsent, u8 * can_rescue, u8 * snd_limited)
809 {
810   sack_scoreboard_hole_t *hole = 0;
811
812   hole = start ? start : scoreboard_first_hole (sb);
813   while (hole && seq_leq (hole->end, sb->high_rxt) && hole->is_lost)
814     hole = scoreboard_next_hole (sb, hole);
815
816   /* Nothing, return */
817   if (!hole)
818     {
819       sb->cur_rxt_hole = TCP_INVALID_SACK_HOLE_INDEX;
820       return 0;
821     }
822
823   /* Rule (1): if higher than rxt, less than high_sacked and lost */
824   if (hole->is_lost && seq_lt (hole->start, sb->high_sacked))
825     {
826       sb->cur_rxt_hole = scoreboard_hole_index (sb, hole);
827     }
828   else
829     {
830       /* Rule (2): available unsent data */
831       if (have_unsent)
832         {
833           sb->cur_rxt_hole = TCP_INVALID_SACK_HOLE_INDEX;
834           return 0;
835         }
836       /* Rule (3): if hole not lost */
837       else if (seq_lt (hole->start, sb->high_sacked))
838         {
839           *snd_limited = 0;
840           sb->cur_rxt_hole = scoreboard_hole_index (sb, hole);
841         }
842       /* Rule (4): if hole beyond high_sacked */
843       else
844         {
845           ASSERT (seq_geq (hole->start, sb->high_sacked));
846           *snd_limited = 1;
847           *can_rescue = 1;
848           /* HighRxt MUST NOT be updated */
849           return 0;
850         }
851     }
852
853   if (hole && seq_lt (sb->high_rxt, hole->start))
854     sb->high_rxt = hole->start;
855
856   return hole;
857 }
858 #endif /* CLIB_MARCH_VARIANT */
859
860 static void
861 scoreboard_init_high_rxt (sack_scoreboard_t * sb, u32 snd_una)
862 {
863   sack_scoreboard_hole_t *hole;
864   hole = scoreboard_first_hole (sb);
865   if (hole)
866     {
867       snd_una = seq_gt (snd_una, hole->start) ? snd_una : hole->start;
868       sb->cur_rxt_hole = sb->head;
869     }
870   sb->high_rxt = snd_una;
871   sb->rescue_rxt = snd_una - 1;
872 }
873
874 #ifndef  CLIB_MARCH_VARIANT
875 void
876 scoreboard_init (sack_scoreboard_t * sb)
877 {
878   sb->head = TCP_INVALID_SACK_HOLE_INDEX;
879   sb->tail = TCP_INVALID_SACK_HOLE_INDEX;
880   sb->cur_rxt_hole = TCP_INVALID_SACK_HOLE_INDEX;
881 }
882
883 void
884 scoreboard_clear (sack_scoreboard_t * sb)
885 {
886   sack_scoreboard_hole_t *hole;
887   while ((hole = scoreboard_first_hole (sb)))
888     {
889       scoreboard_remove_hole (sb, hole);
890     }
891   ASSERT (sb->head == sb->tail && sb->head == TCP_INVALID_SACK_HOLE_INDEX);
892   ASSERT (pool_elts (sb->holes) == 0);
893   sb->sacked_bytes = 0;
894   sb->last_sacked_bytes = 0;
895   sb->last_bytes_delivered = 0;
896   sb->snd_una_adv = 0;
897   sb->high_sacked = 0;
898   sb->high_rxt = 0;
899   sb->lost_bytes = 0;
900   sb->cur_rxt_hole = TCP_INVALID_SACK_HOLE_INDEX;
901 }
902 #endif /* CLIB_MARCH_VARIANT */
903
904 /**
905  * Test that scoreboard is sane after recovery
906  *
907  * Returns 1 if scoreboard is empty or if first hole beyond
908  * snd_una.
909  */
910 static u8
911 tcp_scoreboard_is_sane_post_recovery (tcp_connection_t * tc)
912 {
913   sack_scoreboard_hole_t *hole;
914   hole = scoreboard_first_hole (&tc->sack_sb);
915   return (!hole || (seq_geq (hole->start, tc->snd_una)
916                     && seq_lt (hole->end, tc->snd_una_max)));
917 }
918
919 #ifndef CLIB_MARCH_VARIANT
920 void
921 tcp_rcv_sacks (tcp_connection_t * tc, u32 ack)
922 {
923   sack_scoreboard_t *sb = &tc->sack_sb;
924   sack_block_t *blk, tmp;
925   sack_scoreboard_hole_t *hole, *next_hole, *last_hole;
926   u32 blk_index = 0, old_sacked_bytes, hole_index;
927   int i, j;
928
929   sb->last_sacked_bytes = 0;
930   sb->last_bytes_delivered = 0;
931   sb->snd_una_adv = 0;
932
933   if (!tcp_opts_sack (&tc->rcv_opts)
934       && sb->head == TCP_INVALID_SACK_HOLE_INDEX)
935     return;
936
937   old_sacked_bytes = sb->sacked_bytes;
938
939   /* Remove invalid blocks */
940   blk = tc->rcv_opts.sacks;
941   while (blk < vec_end (tc->rcv_opts.sacks))
942     {
943       if (seq_lt (blk->start, blk->end)
944           && seq_gt (blk->start, tc->snd_una)
945           && seq_gt (blk->start, ack)
946           && seq_lt (blk->start, tc->snd_una_max)
947           && seq_leq (blk->end, tc->snd_una_max))
948         {
949           blk++;
950           continue;
951         }
952       vec_del1 (tc->rcv_opts.sacks, blk - tc->rcv_opts.sacks);
953     }
954
955   /* Add block for cumulative ack */
956   if (seq_gt (ack, tc->snd_una))
957     {
958       tmp.start = tc->snd_una;
959       tmp.end = ack;
960       vec_add1 (tc->rcv_opts.sacks, tmp);
961     }
962
963   if (vec_len (tc->rcv_opts.sacks) == 0)
964     return;
965
966   tcp_scoreboard_trace_add (tc, ack);
967
968   /* Make sure blocks are ordered */
969   for (i = 0; i < vec_len (tc->rcv_opts.sacks); i++)
970     for (j = i + 1; j < vec_len (tc->rcv_opts.sacks); j++)
971       if (seq_lt (tc->rcv_opts.sacks[j].start, tc->rcv_opts.sacks[i].start))
972         {
973           tmp = tc->rcv_opts.sacks[i];
974           tc->rcv_opts.sacks[i] = tc->rcv_opts.sacks[j];
975           tc->rcv_opts.sacks[j] = tmp;
976         }
977
978   if (sb->head == TCP_INVALID_SACK_HOLE_INDEX)
979     {
980       /* If no holes, insert the first that covers all outstanding bytes */
981       last_hole = scoreboard_insert_hole (sb, TCP_INVALID_SACK_HOLE_INDEX,
982                                           tc->snd_una, tc->snd_una_max);
983       sb->tail = scoreboard_hole_index (sb, last_hole);
984       tmp = tc->rcv_opts.sacks[vec_len (tc->rcv_opts.sacks) - 1];
985       sb->high_sacked = tmp.end;
986     }
987   else
988     {
989       /* If we have holes but snd_una_max is beyond the last hole, update
990        * last hole end */
991       tmp = tc->rcv_opts.sacks[vec_len (tc->rcv_opts.sacks) - 1];
992       last_hole = scoreboard_last_hole (sb);
993       if (seq_gt (tc->snd_una_max, last_hole->end))
994         {
995           if (seq_geq (last_hole->start, sb->high_sacked))
996             {
997               last_hole->end = tc->snd_una_max;
998             }
999           /* New hole after high sacked block */
1000           else if (seq_lt (sb->high_sacked, tc->snd_una_max))
1001             {
1002               scoreboard_insert_hole (sb, sb->tail, sb->high_sacked,
1003                                       tc->snd_una_max);
1004             }
1005         }
1006       /* Keep track of max byte sacked for when the last hole
1007        * is acked */
1008       if (seq_gt (tmp.end, sb->high_sacked))
1009         sb->high_sacked = tmp.end;
1010     }
1011
1012   /* Walk the holes with the SACK blocks */
1013   hole = pool_elt_at_index (sb->holes, sb->head);
1014   while (hole && blk_index < vec_len (tc->rcv_opts.sacks))
1015     {
1016       blk = &tc->rcv_opts.sacks[blk_index];
1017       if (seq_leq (blk->start, hole->start))
1018         {
1019           /* Block covers hole. Remove hole */
1020           if (seq_geq (blk->end, hole->end))
1021             {
1022               next_hole = scoreboard_next_hole (sb, hole);
1023
1024               /* Byte accounting: snd_una needs to be advanced */
1025               if (blk->end == ack)
1026                 {
1027                   if (next_hole)
1028                     {
1029                       if (seq_lt (ack, next_hole->start))
1030                         sb->snd_una_adv = next_hole->start - ack;
1031                       sb->last_bytes_delivered +=
1032                         next_hole->start - hole->end;
1033                     }
1034                   else
1035                     {
1036                       ASSERT (seq_geq (sb->high_sacked, ack));
1037                       sb->snd_una_adv = sb->high_sacked - ack;
1038                       sb->last_bytes_delivered += sb->high_sacked - hole->end;
1039                     }
1040                 }
1041
1042               scoreboard_remove_hole (sb, hole);
1043               hole = next_hole;
1044             }
1045           /* Partial 'head' overlap */
1046           else
1047             {
1048               if (seq_gt (blk->end, hole->start))
1049                 {
1050                   hole->start = blk->end;
1051                 }
1052               blk_index++;
1053             }
1054         }
1055       else
1056         {
1057           /* Hole must be split */
1058           if (seq_lt (blk->end, hole->end))
1059             {
1060               hole_index = scoreboard_hole_index (sb, hole);
1061               next_hole = scoreboard_insert_hole (sb, hole_index, blk->end,
1062                                                   hole->end);
1063
1064               /* Pool might've moved */
1065               hole = scoreboard_get_hole (sb, hole_index);
1066               hole->end = blk->start;
1067               blk_index++;
1068               ASSERT (hole->next == scoreboard_hole_index (sb, next_hole));
1069             }
1070           else if (seq_lt (blk->start, hole->end))
1071             {
1072               hole->end = blk->start;
1073             }
1074           hole = scoreboard_next_hole (sb, hole);
1075         }
1076     }
1077
1078   if (pool_elts (sb->holes) == 1)
1079     {
1080       hole = scoreboard_first_hole (sb);
1081       if (hole->start == ack + sb->snd_una_adv
1082           && hole->end == tc->snd_una_max)
1083         scoreboard_remove_hole (sb, hole);
1084     }
1085
1086   scoreboard_update_bytes (tc, sb);
1087   sb->last_sacked_bytes = sb->sacked_bytes
1088     - (old_sacked_bytes - sb->last_bytes_delivered);
1089   ASSERT (sb->last_sacked_bytes <= sb->sacked_bytes || tcp_in_recovery (tc));
1090   ASSERT (sb->sacked_bytes == 0 || tcp_in_recovery (tc)
1091           || sb->sacked_bytes < tc->snd_una_max - seq_max (tc->snd_una, ack));
1092   ASSERT (sb->last_sacked_bytes + sb->lost_bytes <= tc->snd_una_max
1093           - seq_max (tc->snd_una, ack) || tcp_in_recovery (tc));
1094   ASSERT (sb->head == TCP_INVALID_SACK_HOLE_INDEX || tcp_in_recovery (tc)
1095           || sb->holes[sb->head].start == ack + sb->snd_una_adv);
1096   TCP_EVT_DBG (TCP_EVT_CC_SCOREBOARD, tc);
1097 }
1098 #endif /* CLIB_MARCH_VARIANT */
1099
1100 /**
1101  * Try to update snd_wnd based on feedback received from peer.
1102  *
1103  * If successful, and new window is 'effectively' 0, activate persist
1104  * timer.
1105  */
1106 static void
1107 tcp_update_snd_wnd (tcp_connection_t * tc, u32 seq, u32 ack, u32 snd_wnd)
1108 {
1109   /* If (SND.WL1 < SEG.SEQ or (SND.WL1 = SEG.SEQ and SND.WL2 =< SEG.ACK)), set
1110    * SND.WND <- SEG.WND, set SND.WL1 <- SEG.SEQ, and set SND.WL2 <- SEG.ACK */
1111   if (seq_lt (tc->snd_wl1, seq)
1112       || (tc->snd_wl1 == seq && seq_leq (tc->snd_wl2, ack)))
1113     {
1114       tc->snd_wnd = snd_wnd;
1115       tc->snd_wl1 = seq;
1116       tc->snd_wl2 = ack;
1117       TCP_EVT_DBG (TCP_EVT_SND_WND, tc);
1118
1119       if (PREDICT_FALSE (tc->snd_wnd < tc->snd_mss))
1120         {
1121           /* Set persist timer if not set and we just got 0 wnd */
1122           if (!tcp_timer_is_active (tc, TCP_TIMER_PERSIST)
1123               && !tcp_timer_is_active (tc, TCP_TIMER_RETRANSMIT))
1124             tcp_persist_timer_set (tc);
1125         }
1126       else
1127         {
1128           tcp_persist_timer_reset (tc);
1129           if (PREDICT_FALSE (!tcp_in_recovery (tc) && tc->rto_boff > 0))
1130             {
1131               tc->rto_boff = 0;
1132               tcp_update_rto (tc);
1133             }
1134         }
1135     }
1136 }
1137
1138 #ifndef CLIB_MARCH_VARIANT
1139 /**
1140  * Init loss recovery/fast recovery.
1141  *
1142  * Triggered by dup acks as opposed to timer timeout. Note that cwnd is
1143  * updated in @ref tcp_cc_handle_event after fast retransmit
1144  */
1145 void
1146 tcp_cc_init_congestion (tcp_connection_t * tc)
1147 {
1148   tcp_fastrecovery_on (tc);
1149   tc->snd_congestion = tc->snd_una_max;
1150   tc->cwnd_acc_bytes = 0;
1151   tc->snd_rxt_bytes = 0;
1152   tc->prev_ssthresh = tc->ssthresh;
1153   tc->prev_cwnd = tc->cwnd;
1154   tc->cc_algo->congestion (tc);
1155   TCP_EVT_DBG (TCP_EVT_CC_EVT, tc, 4);
1156 }
1157 #endif /* CLIB_MARCH_VARIANT */
1158
1159 static void
1160 tcp_cc_recovery_exit (tcp_connection_t * tc)
1161 {
1162   tc->rto_boff = 0;
1163   tcp_update_rto (tc);
1164   tc->snd_rxt_ts = 0;
1165   tc->snd_nxt = tc->snd_una_max;
1166   tc->rtt_ts = 0;
1167   tcp_recovery_off (tc);
1168   TCP_EVT_DBG (TCP_EVT_CC_EVT, tc, 3);
1169 }
1170
1171 #ifndef CLIB_MARCH_VARIANT
1172 void
1173 tcp_cc_fastrecovery_exit (tcp_connection_t * tc)
1174 {
1175   tc->cc_algo->recovered (tc);
1176   tc->snd_rxt_bytes = 0;
1177   tc->rcv_dupacks = 0;
1178   tc->snd_nxt = tc->snd_una_max;
1179   tc->snd_rxt_bytes = 0;
1180   tc->rtt_ts = 0;
1181
1182   tcp_fastrecovery_off (tc);
1183   tcp_fastrecovery_first_off (tc);
1184
1185   TCP_EVT_DBG (TCP_EVT_CC_EVT, tc, 3);
1186 }
1187 #endif /* CLIB_MARCH_VARIANT */
1188
1189 static void
1190 tcp_cc_congestion_undo (tcp_connection_t * tc)
1191 {
1192   tc->cwnd = tc->prev_cwnd;
1193   tc->ssthresh = tc->prev_ssthresh;
1194   tc->snd_nxt = tc->snd_una_max;
1195   tc->rcv_dupacks = 0;
1196   if (tcp_in_recovery (tc))
1197     tcp_cc_recovery_exit (tc);
1198   else if (tcp_in_fastrecovery (tc))
1199     tcp_cc_fastrecovery_exit (tc);
1200   ASSERT (tc->rto_boff == 0);
1201   TCP_EVT_DBG (TCP_EVT_CC_EVT, tc, 5);
1202 }
1203
1204 static inline u8
1205 tcp_cc_is_spurious_timeout_rxt (tcp_connection_t * tc)
1206 {
1207   return (tcp_in_recovery (tc) && tc->rto_boff == 1
1208           && tc->snd_rxt_ts
1209           && tcp_opts_tstamp (&tc->rcv_opts)
1210           && timestamp_lt (tc->rcv_opts.tsecr, tc->snd_rxt_ts));
1211 }
1212
1213 static inline u8
1214 tcp_cc_is_spurious_fast_rxt (tcp_connection_t * tc)
1215 {
1216   return (tcp_in_fastrecovery (tc)
1217           && tc->cwnd > tc->ssthresh + 3 * tc->snd_mss);
1218 }
1219
1220 static u8
1221 tcp_cc_is_spurious_retransmit (tcp_connection_t * tc)
1222 {
1223   return (tcp_cc_is_spurious_timeout_rxt (tc)
1224           || tcp_cc_is_spurious_fast_rxt (tc));
1225 }
1226
1227 static int
1228 tcp_cc_recover (tcp_connection_t * tc)
1229 {
1230   ASSERT (tcp_in_cong_recovery (tc));
1231   if (tcp_cc_is_spurious_retransmit (tc))
1232     {
1233       tcp_cc_congestion_undo (tc);
1234       return 1;
1235     }
1236
1237   if (tcp_in_recovery (tc))
1238     tcp_cc_recovery_exit (tc);
1239   else if (tcp_in_fastrecovery (tc))
1240     tcp_cc_fastrecovery_exit (tc);
1241
1242   ASSERT (tc->rto_boff == 0);
1243   ASSERT (!tcp_in_cong_recovery (tc));
1244   ASSERT (tcp_scoreboard_is_sane_post_recovery (tc));
1245   return 0;
1246 }
1247
1248 static void
1249 tcp_cc_update (tcp_connection_t * tc, vlib_buffer_t * b)
1250 {
1251   ASSERT (!tcp_in_cong_recovery (tc) || tcp_is_lost_fin (tc));
1252
1253   /* Congestion avoidance */
1254   tcp_cc_rcv_ack (tc);
1255
1256   /* If a cumulative ack, make sure dupacks is 0 */
1257   tc->rcv_dupacks = 0;
1258
1259   /* When dupacks hits the threshold we only enter fast retransmit if
1260    * cumulative ack covers more than snd_congestion. Should snd_una
1261    * wrap this test may fail under otherwise valid circumstances.
1262    * Therefore, proactively update snd_congestion when wrap detected. */
1263   if (PREDICT_FALSE
1264       (seq_leq (tc->snd_congestion, tc->snd_una - tc->bytes_acked)
1265        && seq_gt (tc->snd_congestion, tc->snd_una)))
1266     tc->snd_congestion = tc->snd_una - 1;
1267 }
1268
1269 static u8
1270 tcp_should_fastrecover_sack (tcp_connection_t * tc)
1271 {
1272   return (TCP_DUPACK_THRESHOLD - 1) * tc->snd_mss < tc->sack_sb.sacked_bytes;
1273 }
1274
1275 static u8
1276 tcp_should_fastrecover (tcp_connection_t * tc)
1277 {
1278   return (tc->rcv_dupacks == TCP_DUPACK_THRESHOLD
1279           || tcp_should_fastrecover_sack (tc));
1280 }
1281
1282 #ifndef CLIB_MARCH_VARIANT
1283 void
1284 tcp_program_fastretransmit (tcp_worker_ctx_t * wrk, tcp_connection_t * tc)
1285 {
1286   if (!(tc->flags & TCP_CONN_FRXT_PENDING))
1287     {
1288       vec_add1 (wrk->pending_fast_rxt, tc->c_c_index);
1289       tc->flags |= TCP_CONN_FRXT_PENDING;
1290     }
1291 }
1292
1293 void
1294 tcp_do_fastretransmits (tcp_worker_ctx_t * wrk)
1295 {
1296   u32 *ongoing_fast_rxt, burst_bytes, sent_bytes, thread_index;
1297   u32 max_burst_size, burst_size, n_segs = 0, n_segs_now;
1298   tcp_connection_t *tc;
1299   u64 last_cpu_time;
1300   int i;
1301
1302   if (vec_len (wrk->pending_fast_rxt) == 0
1303       && vec_len (wrk->postponed_fast_rxt) == 0)
1304     return;
1305
1306   thread_index = wrk->vm->thread_index;
1307   last_cpu_time = wrk->vm->clib_time.last_cpu_time;
1308   ongoing_fast_rxt = wrk->ongoing_fast_rxt;
1309   vec_append (ongoing_fast_rxt, wrk->postponed_fast_rxt);
1310   vec_append (ongoing_fast_rxt, wrk->pending_fast_rxt);
1311
1312   _vec_len (wrk->postponed_fast_rxt) = 0;
1313   _vec_len (wrk->pending_fast_rxt) = 0;
1314
1315   max_burst_size = VLIB_FRAME_SIZE / vec_len (ongoing_fast_rxt);
1316   max_burst_size = clib_max (max_burst_size, 1);
1317
1318   for (i = 0; i < vec_len (ongoing_fast_rxt); i++)
1319     {
1320       if (n_segs >= VLIB_FRAME_SIZE)
1321         {
1322           vec_add1 (wrk->postponed_fast_rxt, ongoing_fast_rxt[i]);
1323           continue;
1324         }
1325
1326       tc = tcp_connection_get (ongoing_fast_rxt[i], thread_index);
1327       tc->flags &= ~TCP_CONN_FRXT_PENDING;
1328
1329       if (!tcp_in_fastrecovery (tc))
1330         continue;
1331
1332       burst_size = clib_min (max_burst_size, VLIB_FRAME_SIZE - n_segs);
1333       burst_bytes = transport_connection_tx_pacer_burst (&tc->connection,
1334                                                          last_cpu_time);
1335       burst_size = clib_min (burst_size, burst_bytes / tc->snd_mss);
1336       if (!burst_size)
1337         {
1338           tcp_program_fastretransmit (wrk, tc);
1339           continue;
1340         }
1341
1342       n_segs_now = tcp_fast_retransmit (wrk, tc, burst_size);
1343       sent_bytes = clib_min (n_segs_now * tc->snd_mss, burst_bytes);
1344       transport_connection_tx_pacer_update_bytes (&tc->connection,
1345                                                   sent_bytes);
1346       n_segs += n_segs_now;
1347     }
1348   _vec_len (ongoing_fast_rxt) = 0;
1349   wrk->ongoing_fast_rxt = ongoing_fast_rxt;
1350 }
1351 #endif /* CLIB_MARCH_VARIANT */
1352
1353 /**
1354  * One function to rule them all ... and in the darkness bind them
1355  */
1356 static void
1357 tcp_cc_handle_event (tcp_connection_t * tc, u32 is_dack)
1358 {
1359   u32 rxt_delivered;
1360
1361   if (tcp_in_fastrecovery (tc) && tcp_opts_sack_permitted (&tc->rcv_opts))
1362     {
1363       if (tc->bytes_acked)
1364         goto partial_ack;
1365       tcp_program_fastretransmit (tcp_get_worker (tc->c_thread_index), tc);
1366       return;
1367     }
1368   /*
1369    * Duplicate ACK. Check if we should enter fast recovery, or if already in
1370    * it account for the bytes that left the network.
1371    */
1372   else if (is_dack && !tcp_in_recovery (tc))
1373     {
1374       TCP_EVT_DBG (TCP_EVT_DUPACK_RCVD, tc, 1);
1375       ASSERT (tc->snd_una != tc->snd_una_max
1376               || tc->sack_sb.last_sacked_bytes);
1377
1378       tc->rcv_dupacks++;
1379
1380       /* Pure duplicate ack. If some data got acked, it's handled lower */
1381       if (tc->rcv_dupacks > TCP_DUPACK_THRESHOLD && !tc->bytes_acked)
1382         {
1383           ASSERT (tcp_in_fastrecovery (tc));
1384           tc->cc_algo->rcv_cong_ack (tc, TCP_CC_DUPACK);
1385           return;
1386         }
1387       else if (tcp_should_fastrecover (tc))
1388         {
1389           u32 pacer_wnd;
1390
1391           ASSERT (!tcp_in_fastrecovery (tc));
1392
1393           /* Heuristic to catch potential late dupacks
1394            * after fast retransmit exits */
1395           if (is_dack && tc->snd_una == tc->snd_congestion
1396               && timestamp_leq (tc->rcv_opts.tsecr, tc->tsecr_last_ack))
1397             {
1398               tc->rcv_dupacks = 0;
1399               return;
1400             }
1401
1402           tcp_cc_init_congestion (tc);
1403           tc->cc_algo->rcv_cong_ack (tc, TCP_CC_DUPACK);
1404
1405           if (tcp_opts_sack_permitted (&tc->rcv_opts))
1406             {
1407               tc->cwnd = tc->ssthresh;
1408               scoreboard_init_high_rxt (&tc->sack_sb, tc->snd_una);
1409             }
1410           else
1411             {
1412               /* Post retransmit update cwnd to ssthresh and account for the
1413                * three segments that have left the network and should've been
1414                * buffered at the receiver XXX */
1415               tc->cwnd = tc->ssthresh + 3 * tc->snd_mss;
1416             }
1417
1418           /* Constrain rate until we get a partial ack */
1419           pacer_wnd = clib_max (0.1 * tc->cwnd, 2 * tc->snd_mss);
1420           tcp_connection_tx_pacer_reset (tc, pacer_wnd,
1421                                          0 /* start bucket */ );
1422           tcp_program_fastretransmit (tcp_get_worker (tc->c_thread_index),
1423                                       tc);
1424           return;
1425         }
1426       else if (!tc->bytes_acked
1427                || (tc->bytes_acked && !tcp_in_cong_recovery (tc)))
1428         {
1429           tc->cc_algo->rcv_cong_ack (tc, TCP_CC_DUPACK);
1430           return;
1431         }
1432       else
1433         goto partial_ack;
1434     }
1435   /* Don't allow entry in fast recovery if still in recovery, for now */
1436   else if (0 && is_dack && tcp_in_recovery (tc))
1437     {
1438       /* If of of the two conditions lower hold, reset dupacks because
1439        * we're probably after timeout (RFC6582 heuristics).
1440        * If Cumulative ack does not cover more than congestion threshold,
1441        * and:
1442        * 1) The following doesn't hold: The congestion window is greater
1443        *    than SMSS bytes and the difference between highest_ack
1444        *    and prev_highest_ack is at most 4*SMSS bytes
1445        * 2) Echoed timestamp in the last non-dup ack does not equal the
1446        *    stored timestamp
1447        */
1448       if (seq_leq (tc->snd_una, tc->snd_congestion)
1449           && ((!(tc->cwnd > tc->snd_mss
1450                  && tc->bytes_acked <= 4 * tc->snd_mss))
1451               || (tc->rcv_opts.tsecr != tc->tsecr_last_ack)))
1452         {
1453           tc->rcv_dupacks = 0;
1454           return;
1455         }
1456     }
1457
1458   if (!tc->bytes_acked)
1459     return;
1460
1461 partial_ack:
1462   TCP_EVT_DBG (TCP_EVT_CC_PACK, tc);
1463
1464   /*
1465    * Legitimate ACK. 1) See if we can exit recovery
1466    */
1467
1468   /* Update the pacing rate. For the first partial ack we move from
1469    * the artificially constrained rate to the one after congestion */
1470   tcp_connection_tx_pacer_update (tc);
1471
1472   if (seq_geq (tc->snd_una, tc->snd_congestion))
1473     {
1474       tcp_retransmit_timer_update (tc);
1475
1476       /* If spurious return, we've already updated everything */
1477       if (tcp_cc_recover (tc))
1478         {
1479           tc->tsecr_last_ack = tc->rcv_opts.tsecr;
1480           return;
1481         }
1482
1483       tc->snd_nxt = tc->snd_una_max;
1484
1485       /* Treat as congestion avoidance ack */
1486       tcp_cc_rcv_ack (tc);
1487       return;
1488     }
1489
1490   /*
1491    * Legitimate ACK. 2) If PARTIAL ACK try to retransmit
1492    */
1493
1494   /* XXX limit this only to first partial ack? */
1495   tcp_retransmit_timer_update (tc);
1496
1497   /* RFC6675: If the incoming ACK is a cumulative acknowledgment,
1498    * reset dupacks to 0. Also needed if in congestion recovery */
1499   tc->rcv_dupacks = 0;
1500
1501   /* Post RTO timeout don't try anything fancy */
1502   if (tcp_in_recovery (tc))
1503     {
1504       tcp_cc_rcv_ack (tc);
1505       transport_add_tx_event (&tc->connection);
1506       return;
1507     }
1508
1509   /* Remove retransmitted bytes that have been delivered */
1510   if (tcp_opts_sack_permitted (&tc->rcv_opts))
1511     {
1512       ASSERT (tc->bytes_acked + tc->sack_sb.snd_una_adv
1513               >= tc->sack_sb.last_bytes_delivered
1514               || (tc->flags & TCP_CONN_FINSNT));
1515
1516       /* If we have sacks and we haven't gotten an ack beyond high_rxt,
1517        * remove sacked bytes delivered */
1518       if (seq_lt (tc->snd_una, tc->sack_sb.high_rxt))
1519         {
1520           rxt_delivered = tc->bytes_acked + tc->sack_sb.snd_una_adv
1521             - tc->sack_sb.last_bytes_delivered;
1522           ASSERT (tc->snd_rxt_bytes >= rxt_delivered);
1523           tc->snd_rxt_bytes -= rxt_delivered;
1524         }
1525       else
1526         {
1527           /* Apparently all retransmitted holes have been acked */
1528           tc->snd_rxt_bytes = 0;
1529           tc->sack_sb.high_rxt = tc->snd_una;
1530         }
1531     }
1532   else
1533     {
1534       tcp_fastrecovery_first_on (tc);
1535       /* Reuse last bytes delivered to track total bytes acked */
1536       tc->sack_sb.last_bytes_delivered += tc->bytes_acked;
1537       if (tc->snd_rxt_bytes > tc->bytes_acked)
1538         tc->snd_rxt_bytes -= tc->bytes_acked;
1539       else
1540         tc->snd_rxt_bytes = 0;
1541     }
1542
1543   tc->cc_algo->rcv_cong_ack (tc, TCP_CC_PARTIALACK);
1544
1545   /*
1546    * Since this was a partial ack, try to retransmit some more data
1547    */
1548   tcp_program_fastretransmit (tcp_get_worker (tc->c_thread_index), tc);
1549 }
1550
1551 /**
1552  * Process incoming ACK
1553  */
1554 static int
1555 tcp_rcv_ack (tcp_worker_ctx_t * wrk, tcp_connection_t * tc, vlib_buffer_t * b,
1556              tcp_header_t * th, u32 * error)
1557 {
1558   u32 prev_snd_wnd, prev_snd_una;
1559   u8 is_dack;
1560
1561   TCP_EVT_DBG (TCP_EVT_CC_STAT, tc);
1562
1563   /* If the ACK acks something not yet sent (SEG.ACK > SND.NXT) */
1564   if (PREDICT_FALSE (seq_gt (vnet_buffer (b)->tcp.ack_number, tc->snd_nxt)))
1565     {
1566       /* When we entered cong recovery, we reset snd_nxt to snd_una. Seems
1567        * peer still has the data so accept the ack */
1568       if (tcp_in_cong_recovery (tc)
1569           && seq_leq (vnet_buffer (b)->tcp.ack_number,
1570                       tc->snd_una + tc->snd_wnd))
1571         {
1572           tc->snd_nxt = vnet_buffer (b)->tcp.ack_number;
1573           if (seq_gt (tc->snd_nxt, tc->snd_una_max))
1574             tc->snd_una_max = tc->snd_nxt;
1575           goto process_ack;
1576         }
1577
1578       /* If we have outstanding data and this is within the window, accept it,
1579        * probably retransmit has timed out. Otherwise ACK segment and then
1580        * drop it */
1581       if (seq_gt (vnet_buffer (b)->tcp.ack_number, tc->snd_una_max))
1582         {
1583           tcp_program_ack (wrk, tc);
1584           *error = TCP_ERROR_ACK_FUTURE;
1585           TCP_EVT_DBG (TCP_EVT_ACK_RCV_ERR, tc, 0,
1586                        vnet_buffer (b)->tcp.ack_number);
1587           return -1;
1588         }
1589
1590       TCP_EVT_DBG (TCP_EVT_ACK_RCV_ERR, tc, 2,
1591                    vnet_buffer (b)->tcp.ack_number);
1592
1593       tc->snd_nxt = vnet_buffer (b)->tcp.ack_number;
1594       if (seq_gt (tc->snd_nxt, tc->snd_una_max))
1595         tc->snd_una_max = tc->snd_nxt;
1596
1597       goto process_ack;
1598     }
1599
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)))
1602     {
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, 1);
1608       /* Don't drop yet */
1609       return 0;
1610     }
1611
1612   /*
1613    * Looks okay, process feedback
1614    */
1615 process_ack:
1616   if (tcp_opts_sack_permitted (&tc->rcv_opts))
1617     tcp_rcv_sacks (tc, vnet_buffer (b)->tcp.ack_number);
1618
1619   prev_snd_wnd = tc->snd_wnd;
1620   prev_snd_una = tc->snd_una;
1621   tcp_update_snd_wnd (tc, vnet_buffer (b)->tcp.seq_number,
1622                       vnet_buffer (b)->tcp.ack_number,
1623                       clib_net_to_host_u16 (th->window) << tc->snd_wscale);
1624   tc->bytes_acked = vnet_buffer (b)->tcp.ack_number - tc->snd_una;
1625   tc->snd_una = vnet_buffer (b)->tcp.ack_number + tc->sack_sb.snd_una_adv;
1626   tcp_validate_txf_size (tc, tc->bytes_acked);
1627
1628   if (tc->bytes_acked)
1629     {
1630       tcp_program_dequeue (wrk, tc);
1631       tcp_update_rtt (tc, vnet_buffer (b)->tcp.ack_number);
1632     }
1633
1634   TCP_EVT_DBG (TCP_EVT_ACK_RCVD, tc);
1635
1636   /*
1637    * Check if we have congestion event
1638    */
1639
1640   if (tcp_ack_is_cc_event (tc, b, prev_snd_wnd, prev_snd_una, &is_dack))
1641     {
1642       tcp_cc_handle_event (tc, is_dack);
1643       if (!tcp_in_cong_recovery (tc))
1644         {
1645           *error = TCP_ERROR_ACK_OK;
1646           return 0;
1647         }
1648       *error = TCP_ERROR_ACK_DUP;
1649       if (vnet_buffer (b)->tcp.data_len || tcp_is_fin (th))
1650         return 0;
1651       return -1;
1652     }
1653
1654   /*
1655    * Update congestion control (slow start/congestion avoidance)
1656    */
1657   tcp_cc_update (tc, b);
1658   *error = TCP_ERROR_ACK_OK;
1659   return 0;
1660 }
1661
1662 static void
1663 tcp_program_disconnect (tcp_worker_ctx_t * wrk, tcp_connection_t * tc)
1664 {
1665   if (!tcp_disconnect_pending (tc))
1666     {
1667       vec_add1 (wrk->pending_disconnects, tc->c_c_index);
1668       tcp_disconnect_pending_on (tc);
1669     }
1670 }
1671
1672 static void
1673 tcp_handle_disconnects (tcp_worker_ctx_t * wrk)
1674 {
1675   u32 thread_index, *pending_disconnects;
1676   tcp_connection_t *tc;
1677   int i;
1678
1679   if (!vec_len (wrk->pending_disconnects))
1680     return;
1681
1682   thread_index = wrk->vm->thread_index;
1683   pending_disconnects = wrk->pending_disconnects;
1684   for (i = 0; i < vec_len (pending_disconnects); i++)
1685     {
1686       tc = tcp_connection_get (pending_disconnects[i], thread_index);
1687       tcp_disconnect_pending_off (tc);
1688       session_transport_closing_notify (&tc->connection);
1689     }
1690   _vec_len (wrk->pending_disconnects) = 0;
1691 }
1692
1693 static void
1694 tcp_rcv_fin (tcp_worker_ctx_t * wrk, tcp_connection_t * tc, vlib_buffer_t * b,
1695              u32 * error)
1696 {
1697   /* Account for the FIN and send ack */
1698   tc->rcv_nxt += 1;
1699   tcp_program_ack (wrk, tc);
1700   /* Enter CLOSE-WAIT and notify session. To avoid lingering
1701    * in CLOSE-WAIT, set timer (reuse WAITCLOSE). */
1702   tcp_connection_set_state (tc, TCP_STATE_CLOSE_WAIT);
1703   tcp_program_disconnect (wrk, tc);
1704   tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, TCP_CLOSEWAIT_TIME);
1705   TCP_EVT_DBG (TCP_EVT_FIN_RCVD, tc);
1706   *error = TCP_ERROR_FIN_RCVD;
1707 }
1708
1709 #ifndef CLIB_MARCH_VARIANT
1710 static u8
1711 tcp_sack_vector_is_sane (sack_block_t * sacks)
1712 {
1713   int i;
1714   for (i = 1; i < vec_len (sacks); i++)
1715     {
1716       if (sacks[i - 1].end == sacks[i].start)
1717         return 0;
1718     }
1719   return 1;
1720 }
1721
1722 /**
1723  * Build SACK list as per RFC2018.
1724  *
1725  * Makes sure the first block contains the segment that generated the current
1726  * ACK and the following ones are the ones most recently reported in SACK
1727  * blocks.
1728  *
1729  * @param tc TCP connection for which the SACK list is updated
1730  * @param start Start sequence number of the newest SACK block
1731  * @param end End sequence of the newest SACK block
1732  */
1733 void
1734 tcp_update_sack_list (tcp_connection_t * tc, u32 start, u32 end)
1735 {
1736   sack_block_t *new_list = tc->snd_sacks_fl, *block = 0;
1737   int i;
1738
1739   /* If the first segment is ooo add it to the list. Last write might've moved
1740    * rcv_nxt over the first segment. */
1741   if (seq_lt (tc->rcv_nxt, start))
1742     {
1743       vec_add2 (new_list, block, 1);
1744       block->start = start;
1745       block->end = end;
1746     }
1747
1748   /* Find the blocks still worth keeping. */
1749   for (i = 0; i < vec_len (tc->snd_sacks); i++)
1750     {
1751       /* Discard if rcv_nxt advanced beyond current block */
1752       if (seq_leq (tc->snd_sacks[i].start, tc->rcv_nxt))
1753         continue;
1754
1755       /* Merge or drop if segment overlapped by the new segment */
1756       if (block && (seq_geq (tc->snd_sacks[i].end, new_list[0].start)
1757                     && seq_leq (tc->snd_sacks[i].start, new_list[0].end)))
1758         {
1759           if (seq_lt (tc->snd_sacks[i].start, new_list[0].start))
1760             new_list[0].start = tc->snd_sacks[i].start;
1761           if (seq_lt (new_list[0].end, tc->snd_sacks[i].end))
1762             new_list[0].end = tc->snd_sacks[i].end;
1763           continue;
1764         }
1765
1766       /* Save to new SACK list if we have space. */
1767       if (vec_len (new_list) < TCP_MAX_SACK_BLOCKS)
1768         {
1769           vec_add1 (new_list, tc->snd_sacks[i]);
1770         }
1771       else
1772         {
1773           clib_warning ("sack discarded");
1774         }
1775     }
1776
1777   ASSERT (vec_len (new_list) <= TCP_MAX_SACK_BLOCKS);
1778
1779   /* Replace old vector with new one */
1780   vec_reset_length (tc->snd_sacks);
1781   tc->snd_sacks_fl = tc->snd_sacks;
1782   tc->snd_sacks = new_list;
1783
1784   /* Segments should not 'touch' */
1785   ASSERT (tcp_sack_vector_is_sane (tc->snd_sacks));
1786 }
1787
1788 u32
1789 tcp_sack_list_bytes (tcp_connection_t * tc)
1790 {
1791   u32 bytes = 0, i;
1792   for (i = 0; i < vec_len (tc->snd_sacks); i++)
1793     bytes += tc->snd_sacks[i].end - tc->snd_sacks[i].start;
1794   return bytes;
1795 }
1796 #endif /* CLIB_MARCH_VARIANT */
1797
1798 /** Enqueue data for delivery to application */
1799 static int
1800 tcp_session_enqueue_data (tcp_connection_t * tc, vlib_buffer_t * b,
1801                           u16 data_len)
1802 {
1803   int written, error = TCP_ERROR_ENQUEUED;
1804
1805   ASSERT (seq_geq (vnet_buffer (b)->tcp.seq_number, tc->rcv_nxt));
1806   ASSERT (data_len);
1807   written = session_enqueue_stream_connection (&tc->connection, b, 0,
1808                                                1 /* queue event */ , 1);
1809
1810   TCP_EVT_DBG (TCP_EVT_INPUT, tc, 0, data_len, written);
1811
1812   /* Update rcv_nxt */
1813   if (PREDICT_TRUE (written == data_len))
1814     {
1815       tc->rcv_nxt += written;
1816     }
1817   /* If more data written than expected, account for out-of-order bytes. */
1818   else if (written > data_len)
1819     {
1820       tc->rcv_nxt += written;
1821       TCP_EVT_DBG (TCP_EVT_CC_INPUT, tc, data_len, written);
1822     }
1823   else if (written > 0)
1824     {
1825       /* We've written something but FIFO is probably full now */
1826       tc->rcv_nxt += written;
1827       error = TCP_ERROR_PARTIALLY_ENQUEUED;
1828     }
1829   else
1830     {
1831       return TCP_ERROR_FIFO_FULL;
1832     }
1833
1834   /* Update SACK list if need be */
1835   if (tcp_opts_sack_permitted (&tc->rcv_opts))
1836     {
1837       /* Remove SACK blocks that have been delivered */
1838       tcp_update_sack_list (tc, tc->rcv_nxt, tc->rcv_nxt);
1839     }
1840
1841   return error;
1842 }
1843
1844 /** Enqueue out-of-order data */
1845 static int
1846 tcp_session_enqueue_ooo (tcp_connection_t * tc, vlib_buffer_t * b,
1847                          u16 data_len)
1848 {
1849   session_t *s0;
1850   int rv, offset;
1851
1852   ASSERT (seq_gt (vnet_buffer (b)->tcp.seq_number, tc->rcv_nxt));
1853   ASSERT (data_len);
1854
1855   /* Enqueue out-of-order data with relative offset */
1856   rv = session_enqueue_stream_connection (&tc->connection, b,
1857                                           vnet_buffer (b)->tcp.seq_number -
1858                                           tc->rcv_nxt, 0 /* queue event */ ,
1859                                           0);
1860
1861   /* Nothing written */
1862   if (rv)
1863     {
1864       TCP_EVT_DBG (TCP_EVT_INPUT, tc, 1, data_len, 0);
1865       return TCP_ERROR_FIFO_FULL;
1866     }
1867
1868   TCP_EVT_DBG (TCP_EVT_INPUT, tc, 1, data_len, data_len);
1869
1870   /* Update SACK list if in use */
1871   if (tcp_opts_sack_permitted (&tc->rcv_opts))
1872     {
1873       ooo_segment_t *newest;
1874       u32 start, end;
1875
1876       s0 = session_get (tc->c_s_index, tc->c_thread_index);
1877
1878       /* Get the newest segment from the fifo */
1879       newest = svm_fifo_newest_ooo_segment (s0->rx_fifo);
1880       if (newest)
1881         {
1882           offset = ooo_segment_offset (s0->rx_fifo, newest);
1883           ASSERT (offset <= vnet_buffer (b)->tcp.seq_number - tc->rcv_nxt);
1884           start = tc->rcv_nxt + offset;
1885           end = start + ooo_segment_length (s0->rx_fifo, newest);
1886           tcp_update_sack_list (tc, start, end);
1887           svm_fifo_newest_ooo_segment_reset (s0->rx_fifo);
1888           TCP_EVT_DBG (TCP_EVT_CC_SACKS, tc);
1889         }
1890     }
1891
1892   return TCP_ERROR_ENQUEUED_OOO;
1893 }
1894
1895 /**
1896  * Check if ACK could be delayed. If ack can be delayed, it should return
1897  * true for a full frame. If we're always acking return 0.
1898  */
1899 always_inline int
1900 tcp_can_delack (tcp_connection_t * tc)
1901 {
1902   /* Send ack if ... */
1903   if (TCP_ALWAYS_ACK
1904       /* just sent a rcv wnd 0 */
1905       || (tc->flags & TCP_CONN_SENT_RCV_WND0) != 0
1906       /* constrained to send ack */
1907       || (tc->flags & TCP_CONN_SNDACK) != 0
1908       /* we're almost out of tx wnd */
1909       || tcp_available_cc_snd_space (tc) < 4 * tc->snd_mss)
1910     return 0;
1911
1912   return 1;
1913 }
1914
1915 static int
1916 tcp_buffer_discard_bytes (vlib_buffer_t * b, u32 n_bytes_to_drop)
1917 {
1918   u32 discard, first = b->current_length;
1919   vlib_main_t *vm = vlib_get_main ();
1920
1921   /* Handle multi-buffer segments */
1922   if (n_bytes_to_drop > b->current_length)
1923     {
1924       if (!(b->flags & VLIB_BUFFER_NEXT_PRESENT))
1925         return -1;
1926       do
1927         {
1928           discard = clib_min (n_bytes_to_drop, b->current_length);
1929           vlib_buffer_advance (b, discard);
1930           b = vlib_get_buffer (vm, b->next_buffer);
1931           n_bytes_to_drop -= discard;
1932         }
1933       while (n_bytes_to_drop);
1934       if (n_bytes_to_drop > first)
1935         b->total_length_not_including_first_buffer -= n_bytes_to_drop - first;
1936     }
1937   else
1938     vlib_buffer_advance (b, n_bytes_to_drop);
1939   vnet_buffer (b)->tcp.data_len -= n_bytes_to_drop;
1940   return 0;
1941 }
1942
1943 /**
1944  * Receive buffer for connection and handle acks
1945  *
1946  * It handles both in order or out-of-order data.
1947  */
1948 static int
1949 tcp_segment_rcv (tcp_worker_ctx_t * wrk, tcp_connection_t * tc,
1950                  vlib_buffer_t * b)
1951 {
1952   u32 error, n_bytes_to_drop, n_data_bytes;
1953
1954   vlib_buffer_advance (b, vnet_buffer (b)->tcp.data_offset);
1955   n_data_bytes = vnet_buffer (b)->tcp.data_len;
1956   ASSERT (n_data_bytes);
1957
1958   /* Handle out-of-order data */
1959   if (PREDICT_FALSE (vnet_buffer (b)->tcp.seq_number != tc->rcv_nxt))
1960     {
1961       /* Old sequence numbers allowed through because they overlapped
1962        * the rx window */
1963       if (seq_lt (vnet_buffer (b)->tcp.seq_number, tc->rcv_nxt))
1964         {
1965           /* Completely in the past (possible retransmit). Ack
1966            * retransmissions since we may not have any data to send */
1967           if (seq_leq (vnet_buffer (b)->tcp.seq_end, tc->rcv_nxt))
1968             {
1969               tcp_program_ack (wrk, tc);
1970               error = TCP_ERROR_SEGMENT_OLD;
1971               goto done;
1972             }
1973
1974           /* Chop off the bytes in the past and see if what is left
1975            * can be enqueued in order */
1976           n_bytes_to_drop = tc->rcv_nxt - vnet_buffer (b)->tcp.seq_number;
1977           n_data_bytes -= n_bytes_to_drop;
1978           vnet_buffer (b)->tcp.seq_number = tc->rcv_nxt;
1979           if (tcp_buffer_discard_bytes (b, n_bytes_to_drop))
1980             {
1981               error = TCP_ERROR_SEGMENT_OLD;
1982               goto done;
1983             }
1984           goto in_order;
1985         }
1986
1987       /* RFC2581: Enqueue and send DUPACK for fast retransmit */
1988       error = tcp_session_enqueue_ooo (tc, b, n_data_bytes);
1989       tcp_program_dupack (wrk, tc);
1990       TCP_EVT_DBG (TCP_EVT_DUPACK_SENT, tc, vnet_buffer (b)->tcp);
1991       goto done;
1992     }
1993
1994 in_order:
1995
1996   /* In order data, enqueue. Fifo figures out by itself if any out-of-order
1997    * segments can be enqueued after fifo tail offset changes. */
1998   error = tcp_session_enqueue_data (tc, b, n_data_bytes);
1999   if (tcp_can_delack (tc))
2000     {
2001       if (!tcp_timer_is_active (tc, TCP_TIMER_DELACK))
2002         tcp_timer_set (tc, TCP_TIMER_DELACK, TCP_DELACK_TIME);
2003       goto done;
2004     }
2005
2006   tcp_program_ack (wrk, tc);
2007
2008 done:
2009   return error;
2010 }
2011
2012 typedef struct
2013 {
2014   tcp_header_t tcp_header;
2015   tcp_connection_t tcp_connection;
2016 } tcp_rx_trace_t;
2017
2018 static u8 *
2019 format_tcp_rx_trace (u8 * s, va_list * args)
2020 {
2021   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
2022   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
2023   tcp_rx_trace_t *t = va_arg (*args, tcp_rx_trace_t *);
2024   u32 indent = format_get_indent (s);
2025
2026   s = format (s, "%U\n%U%U",
2027               format_tcp_header, &t->tcp_header, 128,
2028               format_white_space, indent,
2029               format_tcp_connection, &t->tcp_connection, 1);
2030
2031   return s;
2032 }
2033
2034 static u8 *
2035 format_tcp_rx_trace_short (u8 * s, va_list * args)
2036 {
2037   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
2038   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
2039   tcp_rx_trace_t *t = va_arg (*args, tcp_rx_trace_t *);
2040
2041   s = format (s, "%d -> %d (%U)",
2042               clib_net_to_host_u16 (t->tcp_header.dst_port),
2043               clib_net_to_host_u16 (t->tcp_header.src_port), format_tcp_state,
2044               t->tcp_connection.state);
2045
2046   return s;
2047 }
2048
2049 static void
2050 tcp_set_rx_trace_data (tcp_rx_trace_t * t0, tcp_connection_t * tc0,
2051                        tcp_header_t * th0, vlib_buffer_t * b0, u8 is_ip4)
2052 {
2053   if (tc0)
2054     {
2055       clib_memcpy_fast (&t0->tcp_connection, tc0,
2056                         sizeof (t0->tcp_connection));
2057     }
2058   else
2059     {
2060       th0 = tcp_buffer_hdr (b0);
2061     }
2062   clib_memcpy_fast (&t0->tcp_header, th0, sizeof (t0->tcp_header));
2063 }
2064
2065 static void
2066 tcp_established_trace_frame (vlib_main_t * vm, vlib_node_runtime_t * node,
2067                              vlib_frame_t * frame, u8 is_ip4)
2068 {
2069   u32 *from, n_left;
2070
2071   n_left = frame->n_vectors;
2072   from = vlib_frame_vector_args (frame);
2073
2074   while (n_left >= 1)
2075     {
2076       tcp_connection_t *tc0;
2077       tcp_rx_trace_t *t0;
2078       tcp_header_t *th0;
2079       vlib_buffer_t *b0;
2080       u32 bi0;
2081
2082       bi0 = from[0];
2083       b0 = vlib_get_buffer (vm, bi0);
2084
2085       if (b0->flags & VLIB_BUFFER_IS_TRACED)
2086         {
2087           t0 = vlib_add_trace (vm, node, b0, sizeof (*t0));
2088           tc0 = tcp_connection_get (vnet_buffer (b0)->tcp.connection_index,
2089                                     vm->thread_index);
2090           th0 = tcp_buffer_hdr (b0);
2091           tcp_set_rx_trace_data (t0, tc0, th0, b0, is_ip4);
2092         }
2093
2094       from += 1;
2095       n_left -= 1;
2096     }
2097 }
2098
2099 always_inline void
2100 tcp_node_inc_counter_i (vlib_main_t * vm, u32 tcp4_node, u32 tcp6_node,
2101                         u8 is_ip4, u32 evt, u32 val)
2102 {
2103   if (is_ip4)
2104     vlib_node_increment_counter (vm, tcp4_node, evt, val);
2105   else
2106     vlib_node_increment_counter (vm, tcp6_node, evt, val);
2107 }
2108
2109 #define tcp_maybe_inc_counter(node_id, err, count)                      \
2110 {                                                                       \
2111   if (next0 != tcp_next_drop (is_ip4))                                  \
2112     tcp_node_inc_counter_i (vm, tcp4_##node_id##_node.index,            \
2113                             tcp6_##node_id##_node.index, is_ip4, err,   \
2114                             1);                                         \
2115 }
2116 #define tcp_inc_counter(node_id, err, count)                            \
2117   tcp_node_inc_counter_i (vm, tcp4_##node_id##_node.index,              \
2118                            tcp6_##node_id##_node.index, is_ip4,         \
2119                            err, count)
2120 #define tcp_maybe_inc_err_counter(cnts, err)                            \
2121 {                                                                       \
2122   cnts[err] += (next0 != tcp_next_drop (is_ip4));                       \
2123 }
2124 #define tcp_inc_err_counter(cnts, err, val)                             \
2125 {                                                                       \
2126   cnts[err] += val;                                                     \
2127 }
2128 #define tcp_store_err_counters(node_id, cnts)                           \
2129 {                                                                       \
2130   int i;                                                                \
2131   for (i = 0; i < TCP_N_ERROR; i++)                                     \
2132     if (cnts[i])                                                        \
2133       tcp_inc_counter(node_id, i, cnts[i]);                             \
2134 }
2135
2136
2137 always_inline uword
2138 tcp46_established_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
2139                           vlib_frame_t * frame, int is_ip4)
2140 {
2141   u32 thread_index = vm->thread_index, errors = 0;
2142   tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
2143   u32 n_left_from, *from, *first_buffer;
2144   u16 err_counters[TCP_N_ERROR] = { 0 };
2145
2146   if (node->flags & VLIB_NODE_FLAG_TRACE)
2147     tcp_established_trace_frame (vm, node, frame, is_ip4);
2148
2149   first_buffer = from = vlib_frame_vector_args (frame);
2150   n_left_from = frame->n_vectors;
2151
2152   while (n_left_from > 0)
2153     {
2154       u32 bi0, error0 = TCP_ERROR_ACK_OK;
2155       vlib_buffer_t *b0;
2156       tcp_header_t *th0;
2157       tcp_connection_t *tc0;
2158
2159       if (n_left_from > 1)
2160         {
2161           vlib_buffer_t *pb;
2162           pb = vlib_get_buffer (vm, from[1]);
2163           vlib_prefetch_buffer_header (pb, LOAD);
2164           CLIB_PREFETCH (pb->data, 2 * CLIB_CACHE_LINE_BYTES, LOAD);
2165         }
2166
2167       bi0 = from[0];
2168       from += 1;
2169       n_left_from -= 1;
2170
2171       b0 = vlib_get_buffer (vm, bi0);
2172       tc0 = tcp_connection_get (vnet_buffer (b0)->tcp.connection_index,
2173                                 thread_index);
2174
2175       if (PREDICT_FALSE (tc0 == 0))
2176         {
2177           error0 = TCP_ERROR_INVALID_CONNECTION;
2178           goto done;
2179         }
2180
2181       th0 = tcp_buffer_hdr (b0);
2182
2183       /* TODO header prediction fast path */
2184
2185       /* 1-4: check SEQ, RST, SYN */
2186       if (PREDICT_FALSE (tcp_segment_validate (wrk, tc0, b0, th0, &error0)))
2187         {
2188           TCP_EVT_DBG (TCP_EVT_SEG_INVALID, tc0, vnet_buffer (b0)->tcp);
2189           goto done;
2190         }
2191
2192       /* 5: check the ACK field  */
2193       if (PREDICT_FALSE (tcp_rcv_ack (wrk, tc0, b0, th0, &error0)))
2194         goto done;
2195
2196       /* 6: check the URG bit TODO */
2197
2198       /* 7: process the segment text */
2199       if (vnet_buffer (b0)->tcp.data_len)
2200         error0 = tcp_segment_rcv (wrk, tc0, b0);
2201
2202       /* 8: check the FIN bit */
2203       if (PREDICT_FALSE (tcp_is_fin (th0)))
2204         tcp_rcv_fin (wrk, tc0, b0, &error0);
2205
2206     done:
2207       tcp_inc_err_counter (err_counters, error0, 1);
2208     }
2209
2210   errors = session_main_flush_enqueue_events (TRANSPORT_PROTO_TCP,
2211                                               thread_index);
2212   err_counters[TCP_ERROR_MSG_QUEUE_FULL] = errors;
2213   tcp_store_err_counters (established, err_counters);
2214   tcp_handle_postponed_dequeues (wrk);
2215   tcp_handle_disconnects (wrk);
2216   vlib_buffer_free (vm, first_buffer, frame->n_vectors);
2217
2218   return frame->n_vectors;
2219 }
2220
2221 VLIB_NODE_FN (tcp4_established_node) (vlib_main_t * vm,
2222                                       vlib_node_runtime_t * node,
2223                                       vlib_frame_t * from_frame)
2224 {
2225   return tcp46_established_inline (vm, node, from_frame, 1 /* is_ip4 */ );
2226 }
2227
2228 VLIB_NODE_FN (tcp6_established_node) (vlib_main_t * vm,
2229                                       vlib_node_runtime_t * node,
2230                                       vlib_frame_t * from_frame)
2231 {
2232   return tcp46_established_inline (vm, node, from_frame, 0 /* is_ip4 */ );
2233 }
2234
2235 /* *INDENT-OFF* */
2236 VLIB_REGISTER_NODE (tcp4_established_node) =
2237 {
2238   .name = "tcp4-established",
2239   /* Takes a vector of packets. */
2240   .vector_size = sizeof (u32),
2241   .n_errors = TCP_N_ERROR,
2242   .error_strings = tcp_error_strings,
2243   .n_next_nodes = TCP_ESTABLISHED_N_NEXT,
2244   .next_nodes =
2245   {
2246 #define _(s,n) [TCP_ESTABLISHED_NEXT_##s] = n,
2247     foreach_tcp_state_next
2248 #undef _
2249   },
2250   .format_trace = format_tcp_rx_trace_short,
2251 };
2252 /* *INDENT-ON* */
2253
2254 /* *INDENT-OFF* */
2255 VLIB_REGISTER_NODE (tcp6_established_node) =
2256 {
2257   .name = "tcp6-established",
2258   /* Takes a vector of packets. */
2259   .vector_size = sizeof (u32),
2260   .n_errors = TCP_N_ERROR,
2261   .error_strings = tcp_error_strings,
2262   .n_next_nodes = TCP_ESTABLISHED_N_NEXT,
2263   .next_nodes =
2264   {
2265 #define _(s,n) [TCP_ESTABLISHED_NEXT_##s] = n,
2266     foreach_tcp_state_next
2267 #undef _
2268   },
2269   .format_trace = format_tcp_rx_trace_short,
2270 };
2271 /* *INDENT-ON* */
2272
2273
2274 static u8
2275 tcp_lookup_is_valid (tcp_connection_t * tc, tcp_header_t * hdr)
2276 {
2277   transport_connection_t *tmp = 0;
2278   u64 handle;
2279
2280   if (!tc)
2281     return 1;
2282
2283   /* Proxy case */
2284   if (tc->c_lcl_port == 0 && tc->state == TCP_STATE_LISTEN)
2285     return 1;
2286
2287   u8 is_valid = (tc->c_lcl_port == hdr->dst_port
2288                  && (tc->state == TCP_STATE_LISTEN
2289                      || tc->c_rmt_port == hdr->src_port));
2290
2291   if (!is_valid)
2292     {
2293       handle = session_lookup_half_open_handle (&tc->connection);
2294       tmp = session_lookup_half_open_connection (handle & 0xFFFFFFFF,
2295                                                  tc->c_proto, tc->c_is_ip4);
2296
2297       if (tmp)
2298         {
2299           if (tmp->lcl_port == hdr->dst_port
2300               && tmp->rmt_port == hdr->src_port)
2301             {
2302               TCP_DBG ("half-open is valid!");
2303             }
2304         }
2305     }
2306   return is_valid;
2307 }
2308
2309 /**
2310  * Lookup transport connection
2311  */
2312 static tcp_connection_t *
2313 tcp_lookup_connection (u32 fib_index, vlib_buffer_t * b, u8 thread_index,
2314                        u8 is_ip4)
2315 {
2316   tcp_header_t *tcp;
2317   transport_connection_t *tconn;
2318   tcp_connection_t *tc;
2319   u8 is_filtered = 0;
2320   if (is_ip4)
2321     {
2322       ip4_header_t *ip4;
2323       ip4 = vlib_buffer_get_current (b);
2324       tcp = ip4_next_header (ip4);
2325       tconn = session_lookup_connection_wt4 (fib_index,
2326                                              &ip4->dst_address,
2327                                              &ip4->src_address,
2328                                              tcp->dst_port,
2329                                              tcp->src_port,
2330                                              TRANSPORT_PROTO_TCP,
2331                                              thread_index, &is_filtered);
2332       tc = tcp_get_connection_from_transport (tconn);
2333       ASSERT (tcp_lookup_is_valid (tc, tcp));
2334     }
2335   else
2336     {
2337       ip6_header_t *ip6;
2338       ip6 = vlib_buffer_get_current (b);
2339       tcp = ip6_next_header (ip6);
2340       tconn = session_lookup_connection_wt6 (fib_index,
2341                                              &ip6->dst_address,
2342                                              &ip6->src_address,
2343                                              tcp->dst_port,
2344                                              tcp->src_port,
2345                                              TRANSPORT_PROTO_TCP,
2346                                              thread_index, &is_filtered);
2347       tc = tcp_get_connection_from_transport (tconn);
2348       ASSERT (tcp_lookup_is_valid (tc, tcp));
2349     }
2350   return tc;
2351 }
2352
2353 always_inline uword
2354 tcp46_syn_sent_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
2355                        vlib_frame_t * from_frame, int is_ip4)
2356 {
2357   tcp_main_t *tm = vnet_get_tcp_main ();
2358   u32 n_left_from, *from, *first_buffer, errors = 0;
2359   u32 my_thread_index = vm->thread_index;
2360   tcp_worker_ctx_t *wrk = tcp_get_worker (my_thread_index);
2361
2362   from = first_buffer = vlib_frame_vector_args (from_frame);
2363   n_left_from = from_frame->n_vectors;
2364
2365   while (n_left_from > 0)
2366     {
2367       u32 bi0, ack0, seq0, error0 = TCP_ERROR_NONE;
2368       tcp_connection_t *tc0, *new_tc0;
2369       tcp_header_t *tcp0 = 0;
2370       tcp_rx_trace_t *t0;
2371       vlib_buffer_t *b0;
2372
2373       bi0 = from[0];
2374       from += 1;
2375       n_left_from -= 1;
2376
2377       b0 = vlib_get_buffer (vm, bi0);
2378       tc0 =
2379         tcp_half_open_connection_get (vnet_buffer (b0)->tcp.connection_index);
2380       if (PREDICT_FALSE (tc0 == 0))
2381         {
2382           error0 = TCP_ERROR_INVALID_CONNECTION;
2383           goto drop;
2384         }
2385
2386       /* Half-open completed recently but the connection was't removed
2387        * yet by the owning thread */
2388       if (PREDICT_FALSE (tc0->flags & TCP_CONN_HALF_OPEN_DONE))
2389         {
2390           /* Make sure the connection actually exists */
2391           ASSERT (tcp_lookup_connection (tc0->c_fib_index, b0,
2392                                          my_thread_index, is_ip4));
2393           error0 = TCP_ERROR_SPURIOUS_SYN_ACK;
2394           goto drop;
2395         }
2396
2397       ack0 = vnet_buffer (b0)->tcp.ack_number;
2398       seq0 = vnet_buffer (b0)->tcp.seq_number;
2399       tcp0 = tcp_buffer_hdr (b0);
2400
2401       /* Crude check to see if the connection handle does not match
2402        * the packet. Probably connection just switched to established */
2403       if (PREDICT_FALSE (tcp0->dst_port != tc0->c_lcl_port
2404                          || tcp0->src_port != tc0->c_rmt_port))
2405         {
2406           error0 = TCP_ERROR_INVALID_CONNECTION;
2407           goto drop;
2408         }
2409
2410       if (PREDICT_FALSE (!tcp_ack (tcp0) && !tcp_rst (tcp0)
2411                          && !tcp_syn (tcp0)))
2412         {
2413           error0 = TCP_ERROR_SEGMENT_INVALID;
2414           goto drop;
2415         }
2416
2417       /* SYNs consume sequence numbers */
2418       vnet_buffer (b0)->tcp.seq_end += tcp_is_syn (tcp0);
2419
2420       /*
2421        *  1. check the ACK bit
2422        */
2423
2424       /*
2425        *   If the ACK bit is set
2426        *     If SEG.ACK =< ISS, or SEG.ACK > SND.NXT, send a reset (unless
2427        *     the RST bit is set, if so drop the segment and return)
2428        *       <SEQ=SEG.ACK><CTL=RST>
2429        *     and discard the segment.  Return.
2430        *     If SND.UNA =< SEG.ACK =< SND.NXT then the ACK is acceptable.
2431        */
2432       if (tcp_ack (tcp0))
2433         {
2434           if (seq_leq (ack0, tc0->iss) || seq_gt (ack0, tc0->snd_nxt))
2435             {
2436               if (!tcp_rst (tcp0))
2437                 tcp_send_reset_w_pkt (tc0, b0, my_thread_index, is_ip4);
2438               error0 = TCP_ERROR_RCV_WND;
2439               goto drop;
2440             }
2441
2442           /* Make sure ACK is valid */
2443           if (seq_gt (tc0->snd_una, ack0))
2444             {
2445               error0 = TCP_ERROR_ACK_INVALID;
2446               goto drop;
2447             }
2448         }
2449
2450       /*
2451        * 2. check the RST bit
2452        */
2453
2454       if (tcp_rst (tcp0))
2455         {
2456           /* If ACK is acceptable, signal client that peer is not
2457            * willing to accept connection and drop connection*/
2458           if (tcp_ack (tcp0))
2459             tcp_connection_reset (tc0);
2460           error0 = TCP_ERROR_RST_RCVD;
2461           goto drop;
2462         }
2463
2464       /*
2465        * 3. check the security and precedence (skipped)
2466        */
2467
2468       /*
2469        * 4. check the SYN bit
2470        */
2471
2472       /* No SYN flag. Drop. */
2473       if (!tcp_syn (tcp0))
2474         {
2475           error0 = TCP_ERROR_SEGMENT_INVALID;
2476           goto drop;
2477         }
2478
2479       /* Parse options */
2480       if (tcp_options_parse (tcp0, &tc0->rcv_opts, 1))
2481         {
2482           error0 = TCP_ERROR_OPTIONS;
2483           goto drop;
2484         }
2485
2486       /* Valid SYN or SYN-ACK. Move connection from half-open pool to
2487        * current thread pool. */
2488       pool_get (tm->connections[my_thread_index], new_tc0);
2489       clib_memcpy_fast (new_tc0, tc0, sizeof (*new_tc0));
2490       new_tc0->c_c_index = new_tc0 - tm->connections[my_thread_index];
2491       new_tc0->c_thread_index = my_thread_index;
2492       new_tc0->rcv_nxt = vnet_buffer (b0)->tcp.seq_end;
2493       new_tc0->irs = seq0;
2494       new_tc0->timers[TCP_TIMER_ESTABLISH_AO] = TCP_TIMER_HANDLE_INVALID;
2495       new_tc0->timers[TCP_TIMER_RETRANSMIT_SYN] = TCP_TIMER_HANDLE_INVALID;
2496       new_tc0->sw_if_index = vnet_buffer (b0)->sw_if_index[VLIB_RX];
2497
2498       /* If this is not the owning thread, wait for syn retransmit to
2499        * expire and cleanup then */
2500       if (tcp_half_open_connection_cleanup (tc0))
2501         tc0->flags |= TCP_CONN_HALF_OPEN_DONE;
2502
2503       if (tcp_opts_tstamp (&new_tc0->rcv_opts))
2504         {
2505           new_tc0->tsval_recent = new_tc0->rcv_opts.tsval;
2506           new_tc0->tsval_recent_age = tcp_time_now ();
2507         }
2508
2509       if (tcp_opts_wscale (&new_tc0->rcv_opts))
2510         new_tc0->snd_wscale = new_tc0->rcv_opts.wscale;
2511       else
2512         new_tc0->rcv_wscale = 0;
2513
2514       new_tc0->snd_wnd = clib_net_to_host_u16 (tcp0->window)
2515         << new_tc0->snd_wscale;
2516       new_tc0->snd_wl1 = seq0;
2517       new_tc0->snd_wl2 = ack0;
2518
2519       tcp_connection_init_vars (new_tc0);
2520
2521       /* SYN-ACK: See if we can switch to ESTABLISHED state */
2522       if (PREDICT_TRUE (tcp_ack (tcp0)))
2523         {
2524           /* Our SYN is ACKed: we have iss < ack = snd_una */
2525
2526           /* TODO Dequeue acknowledged segments if we support Fast Open */
2527           new_tc0->snd_una = ack0;
2528           new_tc0->state = TCP_STATE_ESTABLISHED;
2529
2530           /* Make sure las is initialized for the wnd computation */
2531           new_tc0->rcv_las = new_tc0->rcv_nxt;
2532
2533           /* Notify app that we have connection. If session layer can't
2534            * allocate session send reset */
2535           if (session_stream_connect_notify (&new_tc0->connection, 0))
2536             {
2537               clib_warning ("connect notify fail");
2538               tcp_send_reset_w_pkt (new_tc0, b0, my_thread_index, is_ip4);
2539               tcp_connection_cleanup (new_tc0);
2540               goto drop;
2541             }
2542
2543           new_tc0->tx_fifo_size =
2544             transport_tx_fifo_size (&new_tc0->connection);
2545           /* Update rtt with the syn-ack sample */
2546           tcp_estimate_initial_rtt (new_tc0);
2547           TCP_EVT_DBG (TCP_EVT_SYNACK_RCVD, new_tc0);
2548           error0 = TCP_ERROR_SYN_ACKS_RCVD;
2549         }
2550       /* SYN: Simultaneous open. Change state to SYN-RCVD and send SYN-ACK */
2551       else
2552         {
2553           new_tc0->state = TCP_STATE_SYN_RCVD;
2554
2555           /* Notify app that we have connection */
2556           if (session_stream_connect_notify (&new_tc0->connection, 0))
2557             {
2558               tcp_connection_cleanup (new_tc0);
2559               tcp_send_reset_w_pkt (tc0, b0, my_thread_index, is_ip4);
2560               TCP_EVT_DBG (TCP_EVT_RST_SENT, tc0);
2561               goto drop;
2562             }
2563
2564           new_tc0->tx_fifo_size =
2565             transport_tx_fifo_size (&new_tc0->connection);
2566           new_tc0->rtt_ts = 0;
2567           tcp_init_snd_vars (new_tc0);
2568           tcp_send_synack (new_tc0);
2569           error0 = TCP_ERROR_SYNS_RCVD;
2570           goto drop;
2571         }
2572
2573       /* Read data, if any */
2574       if (PREDICT_FALSE (vnet_buffer (b0)->tcp.data_len))
2575         {
2576           clib_warning ("rcvd data in syn-sent");
2577           error0 = tcp_segment_rcv (wrk, new_tc0, b0);
2578           if (error0 == TCP_ERROR_ACK_OK)
2579             error0 = TCP_ERROR_SYN_ACKS_RCVD;
2580         }
2581       else
2582         {
2583           tcp_program_ack (wrk, new_tc0);
2584         }
2585
2586     drop:
2587
2588       tcp_inc_counter (syn_sent, error0, 1);
2589       if (PREDICT_FALSE ((b0->flags & VLIB_BUFFER_IS_TRACED) && tcp0 != 0))
2590         {
2591           t0 = vlib_add_trace (vm, node, b0, sizeof (*t0));
2592           clib_memcpy_fast (&t0->tcp_header, tcp0, sizeof (t0->tcp_header));
2593           clib_memcpy_fast (&t0->tcp_connection, tc0,
2594                             sizeof (t0->tcp_connection));
2595         }
2596     }
2597
2598   errors = session_main_flush_enqueue_events (TRANSPORT_PROTO_TCP,
2599                                               my_thread_index);
2600   tcp_inc_counter (syn_sent, TCP_ERROR_MSG_QUEUE_FULL, errors);
2601   vlib_buffer_free (vm, first_buffer, from_frame->n_vectors);
2602
2603   return from_frame->n_vectors;
2604 }
2605
2606 VLIB_NODE_FN (tcp4_syn_sent_node) (vlib_main_t * vm,
2607                                    vlib_node_runtime_t * node,
2608                                    vlib_frame_t * from_frame)
2609 {
2610   return tcp46_syn_sent_inline (vm, node, from_frame, 1 /* is_ip4 */ );
2611 }
2612
2613 VLIB_NODE_FN (tcp6_syn_sent_node) (vlib_main_t * vm,
2614                                    vlib_node_runtime_t * node,
2615                                    vlib_frame_t * from_frame)
2616 {
2617   return tcp46_syn_sent_inline (vm, node, from_frame, 0 /* is_ip4 */ );
2618 }
2619
2620 /* *INDENT-OFF* */
2621 VLIB_REGISTER_NODE (tcp4_syn_sent_node) =
2622 {
2623   .name = "tcp4-syn-sent",
2624   /* Takes a vector of packets. */
2625   .vector_size = sizeof (u32),
2626   .n_errors = TCP_N_ERROR,
2627   .error_strings = tcp_error_strings,
2628   .n_next_nodes = TCP_SYN_SENT_N_NEXT,
2629   .next_nodes =
2630   {
2631 #define _(s,n) [TCP_SYN_SENT_NEXT_##s] = n,
2632     foreach_tcp_state_next
2633 #undef _
2634   },
2635   .format_trace = format_tcp_rx_trace_short,
2636 };
2637 /* *INDENT-ON* */
2638
2639 /* *INDENT-OFF* */
2640 VLIB_REGISTER_NODE (tcp6_syn_sent_node) =
2641 {
2642   .name = "tcp6-syn-sent",
2643   /* Takes a vector of packets. */
2644   .vector_size = sizeof (u32),
2645   .n_errors = TCP_N_ERROR,
2646   .error_strings = tcp_error_strings,
2647   .n_next_nodes = TCP_SYN_SENT_N_NEXT,
2648   .next_nodes =
2649   {
2650 #define _(s,n) [TCP_SYN_SENT_NEXT_##s] = n,
2651     foreach_tcp_state_next
2652 #undef _
2653   },
2654   .format_trace = format_tcp_rx_trace_short,
2655 };
2656 /* *INDENT-ON* */
2657
2658 /**
2659  * Handles reception for all states except LISTEN, SYN-SENT and ESTABLISHED
2660  * as per RFC793 p. 64
2661  */
2662 always_inline uword
2663 tcp46_rcv_process_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
2664                           vlib_frame_t * from_frame, int is_ip4)
2665 {
2666   u32 thread_index = vm->thread_index, errors = 0, *first_buffer;
2667   tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
2668   u32 n_left_from, *from, max_dequeue;
2669
2670   from = first_buffer = vlib_frame_vector_args (from_frame);
2671   n_left_from = from_frame->n_vectors;
2672
2673   while (n_left_from > 0)
2674     {
2675       u32 bi0, error0 = TCP_ERROR_NONE;
2676       tcp_header_t *tcp0 = 0;
2677       tcp_connection_t *tc0;
2678       vlib_buffer_t *b0;
2679       u8 is_fin0;
2680
2681       bi0 = from[0];
2682       from += 1;
2683       n_left_from -= 1;
2684
2685       b0 = vlib_get_buffer (vm, bi0);
2686       tc0 = tcp_connection_get (vnet_buffer (b0)->tcp.connection_index,
2687                                 thread_index);
2688       if (PREDICT_FALSE (tc0 == 0))
2689         {
2690           error0 = TCP_ERROR_INVALID_CONNECTION;
2691           goto drop;
2692         }
2693
2694       tcp0 = tcp_buffer_hdr (b0);
2695       is_fin0 = tcp_is_fin (tcp0);
2696
2697       if (CLIB_DEBUG)
2698         {
2699           tcp_connection_t *tmp;
2700           tmp = tcp_lookup_connection (tc0->c_fib_index, b0, thread_index,
2701                                        is_ip4);
2702           if (tmp->state != tc0->state)
2703             {
2704               if (tc0->state != TCP_STATE_CLOSED)
2705                 clib_warning ("state changed");
2706               goto drop;
2707             }
2708         }
2709
2710       /*
2711        * Special treatment for CLOSED
2712        */
2713       if (PREDICT_FALSE (tc0->state == TCP_STATE_CLOSED))
2714         {
2715           error0 = TCP_ERROR_CONNECTION_CLOSED;
2716           goto drop;
2717         }
2718
2719       /*
2720        * For all other states (except LISTEN)
2721        */
2722
2723       /* 1-4: check SEQ, RST, SYN */
2724       if (PREDICT_FALSE (tcp_segment_validate (wrk, tc0, b0, tcp0, &error0)))
2725         goto drop;
2726
2727       /* 5: check the ACK field  */
2728       switch (tc0->state)
2729         {
2730         case TCP_STATE_SYN_RCVD:
2731           /*
2732            * If the segment acknowledgment is not acceptable, form a
2733            * reset segment,
2734            *  <SEQ=SEG.ACK><CTL=RST>
2735            * and send it.
2736            */
2737           if (!tcp_rcv_ack_is_acceptable (tc0, b0))
2738             {
2739               tcp_connection_reset (tc0);
2740               error0 = TCP_ERROR_ACK_INVALID;
2741               goto drop;
2742             }
2743
2744           /* Make sure the ack is exactly right */
2745           if (tc0->rcv_nxt != vnet_buffer (b0)->tcp.seq_number || is_fin0)
2746             {
2747               tcp_connection_reset (tc0);
2748               error0 = TCP_ERROR_SEGMENT_INVALID;
2749               goto drop;
2750             }
2751
2752           /* Update rtt and rto */
2753           tcp_estimate_initial_rtt (tc0);
2754
2755           /* Switch state to ESTABLISHED */
2756           tc0->state = TCP_STATE_ESTABLISHED;
2757           TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc0);
2758
2759           /* Initialize session variables */
2760           tc0->snd_una = vnet_buffer (b0)->tcp.ack_number;
2761           tc0->snd_wnd = clib_net_to_host_u16 (tcp0->window)
2762             << tc0->rcv_opts.wscale;
2763           tc0->snd_wl1 = vnet_buffer (b0)->tcp.seq_number;
2764           tc0->snd_wl2 = vnet_buffer (b0)->tcp.ack_number;
2765
2766           /* Reset SYN-ACK retransmit and SYN_RCV establish timers */
2767           tcp_retransmit_timer_reset (tc0);
2768           tcp_timer_reset (tc0, TCP_TIMER_ESTABLISH);
2769           if (session_stream_accept_notify (&tc0->connection))
2770             {
2771               error0 = TCP_ERROR_MSG_QUEUE_FULL;
2772               tcp_connection_reset (tc0);
2773               goto drop;
2774             }
2775           error0 = TCP_ERROR_ACK_OK;
2776           break;
2777         case TCP_STATE_ESTABLISHED:
2778           /* We can get packets in established state here because they
2779            * were enqueued before state change */
2780           if (tcp_rcv_ack (wrk, tc0, b0, tcp0, &error0))
2781             goto drop;
2782
2783           break;
2784         case TCP_STATE_FIN_WAIT_1:
2785           /* In addition to the processing for the ESTABLISHED state, if
2786            * our FIN is now acknowledged then enter FIN-WAIT-2 and
2787            * continue processing in that state. */
2788           if (tcp_rcv_ack (wrk, tc0, b0, tcp0, &error0))
2789             goto drop;
2790
2791           /* Still have to send the FIN */
2792           if (tc0->flags & TCP_CONN_FINPNDG)
2793             {
2794               /* TX fifo finally drained */
2795               max_dequeue = transport_max_tx_dequeue (&tc0->connection);
2796               if (max_dequeue <= tc0->burst_acked)
2797                 tcp_send_fin (tc0);
2798             }
2799           /* If FIN is ACKed */
2800           else if (tc0->snd_una == tc0->snd_una_max)
2801             {
2802               tcp_connection_set_state (tc0, TCP_STATE_FIN_WAIT_2);
2803
2804               /* Stop all retransmit timers because we have nothing more
2805                * to send. Enable waitclose though because we're willing to
2806                * wait for peer's FIN but not indefinitely. */
2807               tcp_connection_timers_reset (tc0);
2808               tcp_timer_set (tc0, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
2809
2810               /* Don't try to deq the FIN acked */
2811               if (tc0->burst_acked > 1)
2812                 session_tx_fifo_dequeue_drop (&tc0->connection,
2813                                               tc0->burst_acked - 1);
2814               tc0->burst_acked = 0;
2815             }
2816           break;
2817         case TCP_STATE_FIN_WAIT_2:
2818           /* In addition to the processing for the ESTABLISHED state, if
2819            * the retransmission queue is empty, the user's CLOSE can be
2820            * acknowledged ("ok") but do not delete the TCB. */
2821           if (tcp_rcv_ack (wrk, tc0, b0, tcp0, &error0))
2822             goto drop;
2823           tc0->burst_acked = 0;
2824           break;
2825         case TCP_STATE_CLOSE_WAIT:
2826           /* Do the same processing as for the ESTABLISHED state. */
2827           if (tcp_rcv_ack (wrk, tc0, b0, tcp0, &error0))
2828             goto drop;
2829
2830           if (tc0->flags & TCP_CONN_FINPNDG)
2831             {
2832               /* TX fifo finally drained */
2833               if (!transport_max_tx_dequeue (&tc0->connection))
2834                 {
2835                   tcp_send_fin (tc0);
2836                   tcp_connection_timers_reset (tc0);
2837                   tcp_connection_set_state (tc0, TCP_STATE_LAST_ACK);
2838                   tcp_timer_set (tc0, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
2839                 }
2840             }
2841           break;
2842         case TCP_STATE_CLOSING:
2843           /* In addition to the processing for the ESTABLISHED state, if
2844            * the ACK acknowledges our FIN then enter the TIME-WAIT state,
2845            * otherwise ignore the segment. */
2846           if (tcp_rcv_ack (wrk, tc0, b0, tcp0, &error0))
2847             goto drop;
2848
2849           tcp_connection_timers_reset (tc0);
2850           tcp_connection_set_state (tc0, TCP_STATE_TIME_WAIT);
2851           tcp_timer_set (tc0, TCP_TIMER_WAITCLOSE, TCP_TIMEWAIT_TIME);
2852           goto drop;
2853
2854           break;
2855         case TCP_STATE_LAST_ACK:
2856           /* The only thing that [should] arrive in this state is an
2857            * acknowledgment of our FIN. If our FIN is now acknowledged,
2858            * delete the TCB, enter the CLOSED state, and return. */
2859
2860           if (!tcp_rcv_ack_is_acceptable (tc0, b0))
2861             {
2862               error0 = TCP_ERROR_ACK_INVALID;
2863               goto drop;
2864             }
2865           error0 = TCP_ERROR_ACK_OK;
2866           tc0->snd_una = vnet_buffer (b0)->tcp.ack_number;
2867           /* Apparently our ACK for the peer's FIN was lost */
2868           if (is_fin0 && tc0->snd_una != tc0->snd_una_max)
2869             {
2870               tcp_send_fin (tc0);
2871               goto drop;
2872             }
2873
2874           tcp_connection_set_state (tc0, TCP_STATE_CLOSED);
2875
2876           /* Don't free the connection from the data path since
2877            * we can't ensure that we have no packets already enqueued
2878            * to output. Rely instead on the waitclose timer */
2879           tcp_connection_timers_reset (tc0);
2880           tcp_timer_set (tc0, TCP_TIMER_WAITCLOSE, TCP_CLEANUP_TIME);
2881
2882           goto drop;
2883
2884           break;
2885         case TCP_STATE_TIME_WAIT:
2886           /* The only thing that can arrive in this state is a
2887            * retransmission of the remote FIN. Acknowledge it, and restart
2888            * the 2 MSL timeout. */
2889
2890           if (tcp_rcv_ack (wrk, tc0, b0, tcp0, &error0))
2891             goto drop;
2892
2893           tcp_program_ack (wrk, tc0);
2894           tcp_timer_update (tc0, TCP_TIMER_WAITCLOSE, TCP_TIMEWAIT_TIME);
2895           goto drop;
2896
2897           break;
2898         default:
2899           ASSERT (0);
2900         }
2901
2902       /* 6: check the URG bit TODO */
2903
2904       /* 7: process the segment text */
2905       switch (tc0->state)
2906         {
2907         case TCP_STATE_ESTABLISHED:
2908         case TCP_STATE_FIN_WAIT_1:
2909         case TCP_STATE_FIN_WAIT_2:
2910           if (vnet_buffer (b0)->tcp.data_len)
2911             error0 = tcp_segment_rcv (wrk, tc0, b0);
2912           break;
2913         case TCP_STATE_CLOSE_WAIT:
2914         case TCP_STATE_CLOSING:
2915         case TCP_STATE_LAST_ACK:
2916         case TCP_STATE_TIME_WAIT:
2917           /* This should not occur, since a FIN has been received from the
2918            * remote side.  Ignore the segment text. */
2919           break;
2920         }
2921
2922       /* 8: check the FIN bit */
2923       if (!is_fin0)
2924         goto drop;
2925
2926       TCP_EVT_DBG (TCP_EVT_FIN_RCVD, tc0);
2927
2928       switch (tc0->state)
2929         {
2930         case TCP_STATE_ESTABLISHED:
2931           /* Account for the FIN and send ack */
2932           tc0->rcv_nxt += 1;
2933           tcp_program_ack (wrk, tc0);
2934           tcp_connection_set_state (tc0, TCP_STATE_CLOSE_WAIT);
2935           tcp_program_disconnect (wrk, tc0);
2936           tcp_timer_update (tc0, TCP_TIMER_WAITCLOSE, TCP_CLOSEWAIT_TIME);
2937           break;
2938         case TCP_STATE_SYN_RCVD:
2939           /* Send FIN-ACK, enter LAST-ACK and because the app was not
2940            * notified yet, set a cleanup timer instead of relying on
2941            * disconnect notify and the implicit close call. */
2942           tcp_connection_timers_reset (tc0);
2943           tc0->rcv_nxt += 1;
2944           tcp_send_fin (tc0);
2945           tcp_connection_set_state (tc0, TCP_STATE_LAST_ACK);
2946           tcp_timer_set (tc0, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
2947           break;
2948         case TCP_STATE_CLOSE_WAIT:
2949         case TCP_STATE_CLOSING:
2950         case TCP_STATE_LAST_ACK:
2951           /* move along .. */
2952           break;
2953         case TCP_STATE_FIN_WAIT_1:
2954           tc0->rcv_nxt += 1;
2955           tcp_connection_set_state (tc0, TCP_STATE_CLOSING);
2956           if (tc0->flags & TCP_CONN_FINPNDG)
2957             {
2958               /* Drop all outstanding tx data. */
2959               session_tx_fifo_dequeue_drop (&tc0->connection,
2960                                             transport_max_tx_dequeue
2961                                             (&tc0->connection));
2962               tcp_send_fin (tc0);
2963             }
2964           else
2965             tcp_program_ack (wrk, tc0);
2966           /* Wait for ACK for our FIN but not forever */
2967           tcp_timer_update (tc0, TCP_TIMER_WAITCLOSE, TCP_2MSL_TIME);
2968           break;
2969         case TCP_STATE_FIN_WAIT_2:
2970           /* Got FIN, send ACK! Be more aggressive with resource cleanup */
2971           tc0->rcv_nxt += 1;
2972           tcp_connection_set_state (tc0, TCP_STATE_TIME_WAIT);
2973           tcp_connection_timers_reset (tc0);
2974           tcp_timer_set (tc0, TCP_TIMER_WAITCLOSE, TCP_TIMEWAIT_TIME);
2975           tcp_program_ack (wrk, tc0);
2976           break;
2977         case TCP_STATE_TIME_WAIT:
2978           /* Remain in the TIME-WAIT state. Restart the time-wait
2979            * timeout.
2980            */
2981           tcp_timer_update (tc0, TCP_TIMER_WAITCLOSE, TCP_TIMEWAIT_TIME);
2982           break;
2983         }
2984       error0 = TCP_ERROR_FIN_RCVD;
2985
2986     drop:
2987
2988       tcp_inc_counter (rcv_process, error0, 1);
2989       if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
2990         {
2991           tcp_rx_trace_t *t0 = vlib_add_trace (vm, node, b0, sizeof (*t0));
2992           tcp_set_rx_trace_data (t0, tc0, tcp0, b0, is_ip4);
2993         }
2994     }
2995
2996   errors = session_main_flush_enqueue_events (TRANSPORT_PROTO_TCP,
2997                                               thread_index);
2998   tcp_inc_counter (rcv_process, TCP_ERROR_MSG_QUEUE_FULL, errors);
2999   tcp_handle_postponed_dequeues (wrk);
3000   vlib_buffer_free (vm, first_buffer, from_frame->n_vectors);
3001
3002   return from_frame->n_vectors;
3003 }
3004
3005 VLIB_NODE_FN (tcp4_rcv_process_node) (vlib_main_t * vm,
3006                                       vlib_node_runtime_t * node,
3007                                       vlib_frame_t * from_frame)
3008 {
3009   return tcp46_rcv_process_inline (vm, node, from_frame, 1 /* is_ip4 */ );
3010 }
3011
3012 VLIB_NODE_FN (tcp6_rcv_process_node) (vlib_main_t * vm,
3013                                       vlib_node_runtime_t * node,
3014                                       vlib_frame_t * from_frame)
3015 {
3016   return tcp46_rcv_process_inline (vm, node, from_frame, 0 /* is_ip4 */ );
3017 }
3018
3019 /* *INDENT-OFF* */
3020 VLIB_REGISTER_NODE (tcp4_rcv_process_node) =
3021 {
3022   .name = "tcp4-rcv-process",
3023   /* Takes a vector of packets. */
3024   .vector_size = sizeof (u32),
3025   .n_errors = TCP_N_ERROR,
3026   .error_strings = tcp_error_strings,
3027   .n_next_nodes = TCP_RCV_PROCESS_N_NEXT,
3028   .next_nodes =
3029   {
3030 #define _(s,n) [TCP_RCV_PROCESS_NEXT_##s] = n,
3031     foreach_tcp_state_next
3032 #undef _
3033   },
3034   .format_trace = format_tcp_rx_trace_short,
3035 };
3036 /* *INDENT-ON* */
3037
3038 /* *INDENT-OFF* */
3039 VLIB_REGISTER_NODE (tcp6_rcv_process_node) =
3040 {
3041   .name = "tcp6-rcv-process",
3042   /* Takes a vector of packets. */
3043   .vector_size = sizeof (u32),
3044   .n_errors = TCP_N_ERROR,
3045   .error_strings = tcp_error_strings,
3046   .n_next_nodes = TCP_RCV_PROCESS_N_NEXT,
3047   .next_nodes =
3048   {
3049 #define _(s,n) [TCP_RCV_PROCESS_NEXT_##s] = n,
3050     foreach_tcp_state_next
3051 #undef _
3052   },
3053   .format_trace = format_tcp_rx_trace_short,
3054 };
3055 /* *INDENT-ON* */
3056
3057 /**
3058  * LISTEN state processing as per RFC 793 p. 65
3059  */
3060 always_inline uword
3061 tcp46_listen_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
3062                      vlib_frame_t * from_frame, int is_ip4)
3063 {
3064   u32 n_left_from, *from, n_syns = 0, *first_buffer;
3065   u32 my_thread_index = vm->thread_index;
3066
3067   from = first_buffer = vlib_frame_vector_args (from_frame);
3068   n_left_from = from_frame->n_vectors;
3069
3070   while (n_left_from > 0)
3071     {
3072       u32 bi0;
3073       vlib_buffer_t *b0;
3074       tcp_rx_trace_t *t0;
3075       tcp_header_t *th0 = 0;
3076       tcp_connection_t *lc0;
3077       ip4_header_t *ip40;
3078       ip6_header_t *ip60;
3079       tcp_connection_t *child0;
3080       u32 error0 = TCP_ERROR_NONE;
3081
3082       bi0 = from[0];
3083       from += 1;
3084       n_left_from -= 1;
3085
3086       b0 = vlib_get_buffer (vm, bi0);
3087       lc0 = tcp_listener_get (vnet_buffer (b0)->tcp.connection_index);
3088
3089       if (is_ip4)
3090         {
3091           ip40 = vlib_buffer_get_current (b0);
3092           th0 = ip4_next_header (ip40);
3093         }
3094       else
3095         {
3096           ip60 = vlib_buffer_get_current (b0);
3097           th0 = ip6_next_header (ip60);
3098         }
3099
3100       /* Create child session. For syn-flood protection use filter */
3101
3102       /* 1. first check for an RST: handled in dispatch */
3103       /* if (tcp_rst (th0))
3104          goto drop;
3105        */
3106
3107       /* 2. second check for an ACK: handled in dispatch */
3108       /* if (tcp_ack (th0))
3109          {
3110          tcp_send_reset (b0, is_ip4);
3111          goto drop;
3112          }
3113        */
3114
3115       /* 3. check for a SYN (did that already) */
3116
3117       /* Make sure connection wasn't just created */
3118       child0 = tcp_lookup_connection (lc0->c_fib_index, b0, my_thread_index,
3119                                       is_ip4);
3120       if (PREDICT_FALSE (child0->state != TCP_STATE_LISTEN))
3121         {
3122           error0 = TCP_ERROR_CREATE_EXISTS;
3123           goto drop;
3124         }
3125
3126       /* Create child session and send SYN-ACK */
3127       child0 = tcp_connection_alloc (my_thread_index);
3128       child0->c_lcl_port = th0->dst_port;
3129       child0->c_rmt_port = th0->src_port;
3130       child0->c_is_ip4 = is_ip4;
3131       child0->state = TCP_STATE_SYN_RCVD;
3132       child0->c_fib_index = lc0->c_fib_index;
3133
3134       if (is_ip4)
3135         {
3136           child0->c_lcl_ip4.as_u32 = ip40->dst_address.as_u32;
3137           child0->c_rmt_ip4.as_u32 = ip40->src_address.as_u32;
3138         }
3139       else
3140         {
3141           clib_memcpy_fast (&child0->c_lcl_ip6, &ip60->dst_address,
3142                             sizeof (ip6_address_t));
3143           clib_memcpy_fast (&child0->c_rmt_ip6, &ip60->src_address,
3144                             sizeof (ip6_address_t));
3145         }
3146
3147       if (tcp_options_parse (th0, &child0->rcv_opts, 1))
3148         {
3149           error0 = TCP_ERROR_OPTIONS;
3150           tcp_connection_free (child0);
3151           goto drop;
3152         }
3153
3154       child0->irs = vnet_buffer (b0)->tcp.seq_number;
3155       child0->rcv_nxt = vnet_buffer (b0)->tcp.seq_number + 1;
3156       child0->rcv_las = child0->rcv_nxt;
3157       child0->sw_if_index = vnet_buffer (b0)->sw_if_index[VLIB_RX];
3158
3159       /* RFC1323: TSval timestamps sent on {SYN} and {SYN,ACK}
3160        * segments are used to initialize PAWS. */
3161       if (tcp_opts_tstamp (&child0->rcv_opts))
3162         {
3163           child0->tsval_recent = child0->rcv_opts.tsval;
3164           child0->tsval_recent_age = tcp_time_now ();
3165         }
3166
3167       if (tcp_opts_wscale (&child0->rcv_opts))
3168         child0->snd_wscale = child0->rcv_opts.wscale;
3169
3170       child0->snd_wnd = clib_net_to_host_u16 (th0->window)
3171         << child0->snd_wscale;
3172       child0->snd_wl1 = vnet_buffer (b0)->tcp.seq_number;
3173       child0->snd_wl2 = vnet_buffer (b0)->tcp.ack_number;
3174
3175       tcp_connection_init_vars (child0);
3176       child0->rto = TCP_RTO_MIN;
3177       TCP_EVT_DBG (TCP_EVT_SYN_RCVD, child0, 1);
3178
3179       if (session_stream_accept (&child0->connection, lc0->c_s_index,
3180                                  0 /* notify */ ))
3181         {
3182           tcp_connection_cleanup (child0);
3183           error0 = TCP_ERROR_CREATE_SESSION_FAIL;
3184           goto drop;
3185         }
3186
3187       child0->tx_fifo_size = transport_tx_fifo_size (&child0->connection);
3188       tcp_send_synack (child0);
3189       tcp_timer_set (child0, TCP_TIMER_ESTABLISH, TCP_SYN_RCVD_TIME);
3190
3191     drop:
3192
3193       if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
3194         {
3195           t0 = vlib_add_trace (vm, node, b0, sizeof (*t0));
3196           clib_memcpy_fast (&t0->tcp_header, th0, sizeof (t0->tcp_header));
3197           clib_memcpy_fast (&t0->tcp_connection, lc0,
3198                             sizeof (t0->tcp_connection));
3199         }
3200
3201       n_syns += (error0 == TCP_ERROR_NONE);
3202     }
3203
3204   tcp_inc_counter (listen, TCP_ERROR_SYNS_RCVD, n_syns);
3205   vlib_buffer_free (vm, first_buffer, from_frame->n_vectors);
3206
3207   return from_frame->n_vectors;
3208 }
3209
3210 VLIB_NODE_FN (tcp4_listen_node) (vlib_main_t * vm, vlib_node_runtime_t * node,
3211                                  vlib_frame_t * from_frame)
3212 {
3213   return tcp46_listen_inline (vm, node, from_frame, 1 /* is_ip4 */ );
3214 }
3215
3216 VLIB_NODE_FN (tcp6_listen_node) (vlib_main_t * vm, vlib_node_runtime_t * node,
3217                                  vlib_frame_t * from_frame)
3218 {
3219   return tcp46_listen_inline (vm, node, from_frame, 0 /* is_ip4 */ );
3220 }
3221
3222 /* *INDENT-OFF* */
3223 VLIB_REGISTER_NODE (tcp4_listen_node) =
3224 {
3225   .name = "tcp4-listen",
3226   /* Takes a vector of packets. */
3227   .vector_size = sizeof (u32),
3228   .n_errors = TCP_N_ERROR,
3229   .error_strings = tcp_error_strings,
3230   .n_next_nodes = TCP_LISTEN_N_NEXT,
3231   .next_nodes =
3232   {
3233 #define _(s,n) [TCP_LISTEN_NEXT_##s] = n,
3234     foreach_tcp_state_next
3235 #undef _
3236   },
3237   .format_trace = format_tcp_rx_trace_short,
3238 };
3239 /* *INDENT-ON* */
3240
3241 /* *INDENT-OFF* */
3242 VLIB_REGISTER_NODE (tcp6_listen_node) =
3243 {
3244   .name = "tcp6-listen",
3245   /* Takes a vector of packets. */
3246   .vector_size = sizeof (u32),
3247   .n_errors = TCP_N_ERROR,
3248   .error_strings = tcp_error_strings,
3249   .n_next_nodes = TCP_LISTEN_N_NEXT,
3250   .next_nodes =
3251   {
3252 #define _(s,n) [TCP_LISTEN_NEXT_##s] = n,
3253     foreach_tcp_state_next
3254 #undef _
3255   },
3256   .format_trace = format_tcp_rx_trace_short,
3257 };
3258 /* *INDENT-ON* */
3259
3260 typedef enum _tcp_input_next
3261 {
3262   TCP_INPUT_NEXT_DROP,
3263   TCP_INPUT_NEXT_LISTEN,
3264   TCP_INPUT_NEXT_RCV_PROCESS,
3265   TCP_INPUT_NEXT_SYN_SENT,
3266   TCP_INPUT_NEXT_ESTABLISHED,
3267   TCP_INPUT_NEXT_RESET,
3268   TCP_INPUT_NEXT_PUNT,
3269   TCP_INPUT_N_NEXT
3270 } tcp_input_next_t;
3271
3272 #define foreach_tcp4_input_next                 \
3273   _ (DROP, "ip4-drop")                          \
3274   _ (LISTEN, "tcp4-listen")                     \
3275   _ (RCV_PROCESS, "tcp4-rcv-process")           \
3276   _ (SYN_SENT, "tcp4-syn-sent")                 \
3277   _ (ESTABLISHED, "tcp4-established")           \
3278   _ (RESET, "tcp4-reset")                       \
3279   _ (PUNT, "ip4-punt")
3280
3281 #define foreach_tcp6_input_next                 \
3282   _ (DROP, "ip6-drop")                          \
3283   _ (LISTEN, "tcp6-listen")                     \
3284   _ (RCV_PROCESS, "tcp6-rcv-process")           \
3285   _ (SYN_SENT, "tcp6-syn-sent")                 \
3286   _ (ESTABLISHED, "tcp6-established")           \
3287   _ (RESET, "tcp6-reset")                       \
3288   _ (PUNT, "ip6-punt")
3289
3290 #define filter_flags (TCP_FLAG_SYN|TCP_FLAG_ACK|TCP_FLAG_RST|TCP_FLAG_FIN)
3291
3292 static void
3293 tcp_input_trace_frame (vlib_main_t * vm, vlib_node_runtime_t * node,
3294                        vlib_buffer_t ** bs, u32 n_bufs, u8 is_ip4)
3295 {
3296   tcp_connection_t *tc;
3297   tcp_header_t *tcp;
3298   tcp_rx_trace_t *t;
3299   int i;
3300
3301   for (i = 0; i < n_bufs; i++)
3302     {
3303       if (bs[i]->flags & VLIB_BUFFER_IS_TRACED)
3304         {
3305           t = vlib_add_trace (vm, node, bs[i], sizeof (*t));
3306           tc = tcp_connection_get (vnet_buffer (bs[i])->tcp.connection_index,
3307                                    vm->thread_index);
3308           tcp = vlib_buffer_get_current (bs[i]);
3309           tcp_set_rx_trace_data (t, tc, tcp, bs[i], is_ip4);
3310         }
3311     }
3312 }
3313
3314 static void
3315 tcp_input_set_error_next (tcp_main_t * tm, u16 * next, u32 * error, u8 is_ip4)
3316 {
3317   if (*error == TCP_ERROR_FILTERED || *error == TCP_ERROR_WRONG_THREAD)
3318     {
3319       *next = TCP_INPUT_NEXT_DROP;
3320     }
3321   else if ((is_ip4 && tm->punt_unknown4) || (!is_ip4 && tm->punt_unknown6))
3322     {
3323       *next = TCP_INPUT_NEXT_PUNT;
3324       *error = TCP_ERROR_PUNT;
3325     }
3326   else
3327     {
3328       *next = TCP_INPUT_NEXT_RESET;
3329       *error = TCP_ERROR_NO_LISTENER;
3330     }
3331 }
3332
3333 static inline tcp_connection_t *
3334 tcp_input_lookup_buffer (vlib_buffer_t * b, u8 thread_index, u32 * error,
3335                          u8 is_ip4)
3336 {
3337   u32 fib_index = vnet_buffer (b)->ip.fib_index;
3338   int n_advance_bytes, n_data_bytes;
3339   transport_connection_t *tc;
3340   tcp_header_t *tcp;
3341   u8 result = 0;
3342
3343   if (is_ip4)
3344     {
3345       ip4_header_t *ip4 = vlib_buffer_get_current (b);
3346       int ip_hdr_bytes = ip4_header_bytes (ip4);
3347       if (PREDICT_FALSE (b->current_length < ip_hdr_bytes + sizeof (*tcp)))
3348         {
3349           *error = TCP_ERROR_LENGTH;
3350           return 0;
3351         }
3352       tcp = ip4_next_header (ip4);
3353       vnet_buffer (b)->tcp.hdr_offset = (u8 *) tcp - (u8 *) ip4;
3354       n_advance_bytes = (ip_hdr_bytes + tcp_header_bytes (tcp));
3355       n_data_bytes = clib_net_to_host_u16 (ip4->length) - n_advance_bytes;
3356
3357       /* Length check. Checksum computed by ipx_local no need to compute again */
3358       if (PREDICT_FALSE (n_data_bytes < 0))
3359         {
3360           *error = TCP_ERROR_LENGTH;
3361           return 0;
3362         }
3363
3364       tc = session_lookup_connection_wt4 (fib_index, &ip4->dst_address,
3365                                           &ip4->src_address, tcp->dst_port,
3366                                           tcp->src_port, TRANSPORT_PROTO_TCP,
3367                                           thread_index, &result);
3368     }
3369   else
3370     {
3371       ip6_header_t *ip6 = vlib_buffer_get_current (b);
3372       if (PREDICT_FALSE (b->current_length < sizeof (*ip6) + sizeof (*tcp)))
3373         {
3374           *error = TCP_ERROR_LENGTH;
3375           return 0;
3376         }
3377       tcp = ip6_next_header (ip6);
3378       vnet_buffer (b)->tcp.hdr_offset = (u8 *) tcp - (u8 *) ip6;
3379       n_advance_bytes = tcp_header_bytes (tcp);
3380       n_data_bytes = clib_net_to_host_u16 (ip6->payload_length)
3381         - n_advance_bytes;
3382       n_advance_bytes += sizeof (ip6[0]);
3383
3384       if (PREDICT_FALSE (n_data_bytes < 0))
3385         {
3386           *error = TCP_ERROR_LENGTH;
3387           return 0;
3388         }
3389       if (PREDICT_FALSE
3390           (ip6_address_is_link_local_unicast (&ip6->dst_address)))
3391         {
3392           ip4_main_t *im = &ip4_main;
3393           fib_index = vec_elt (im->fib_index_by_sw_if_index,
3394                                vnet_buffer (b)->sw_if_index[VLIB_RX]);
3395         }
3396
3397       tc = session_lookup_connection_wt6 (fib_index, &ip6->dst_address,
3398                                           &ip6->src_address, tcp->dst_port,
3399                                           tcp->src_port, TRANSPORT_PROTO_TCP,
3400                                           thread_index, &result);
3401     }
3402
3403   vnet_buffer (b)->tcp.seq_number = clib_net_to_host_u32 (tcp->seq_number);
3404   vnet_buffer (b)->tcp.ack_number = clib_net_to_host_u32 (tcp->ack_number);
3405   vnet_buffer (b)->tcp.data_offset = n_advance_bytes;
3406   vnet_buffer (b)->tcp.data_len = n_data_bytes;
3407   vnet_buffer (b)->tcp.seq_end = vnet_buffer (b)->tcp.seq_number
3408     + n_data_bytes;
3409   vnet_buffer (b)->tcp.flags = 0;
3410
3411   *error = result ? TCP_ERROR_NONE + result : *error;
3412
3413   return tcp_get_connection_from_transport (tc);
3414 }
3415
3416 static inline void
3417 tcp_input_dispatch_buffer (tcp_main_t * tm, tcp_connection_t * tc,
3418                            vlib_buffer_t * b, u16 * next, u32 * error)
3419 {
3420   tcp_header_t *tcp;
3421   u8 flags;
3422
3423   tcp = tcp_buffer_hdr (b);
3424   flags = tcp->flags & filter_flags;
3425   *next = tm->dispatch_table[tc->state][flags].next;
3426   *error = tm->dispatch_table[tc->state][flags].error;
3427
3428   if (PREDICT_FALSE (*error == TCP_ERROR_DISPATCH
3429                      || *next == TCP_INPUT_NEXT_RESET))
3430     {
3431       /* Overload tcp flags to store state */
3432       tcp_state_t state = tc->state;
3433       vnet_buffer (b)->tcp.flags = tc->state;
3434
3435       if (*error == TCP_ERROR_DISPATCH)
3436         clib_warning ("tcp conn %u disp error state %U flags %U",
3437                       tc->c_c_index, format_tcp_state, state,
3438                       format_tcp_flags, (int) flags);
3439     }
3440 }
3441
3442 always_inline uword
3443 tcp46_input_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
3444                     vlib_frame_t * frame, int is_ip4)
3445 {
3446   u32 n_left_from, *from, thread_index = vm->thread_index;
3447   tcp_main_t *tm = vnet_get_tcp_main ();
3448   vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b;
3449   u16 nexts[VLIB_FRAME_SIZE], *next;
3450
3451   tcp_set_time_now (tcp_get_worker (thread_index));
3452
3453   from = vlib_frame_vector_args (frame);
3454   n_left_from = frame->n_vectors;
3455   vlib_get_buffers (vm, from, bufs, n_left_from);
3456
3457   b = bufs;
3458   next = nexts;
3459
3460   while (n_left_from >= 4)
3461     {
3462       u32 error0 = TCP_ERROR_NO_LISTENER, error1 = TCP_ERROR_NO_LISTENER;
3463       tcp_connection_t *tc0, *tc1;
3464
3465       {
3466         vlib_prefetch_buffer_header (b[2], STORE);
3467         CLIB_PREFETCH (b[2]->data, 2 * CLIB_CACHE_LINE_BYTES, LOAD);
3468
3469         vlib_prefetch_buffer_header (b[3], STORE);
3470         CLIB_PREFETCH (b[3]->data, 2 * CLIB_CACHE_LINE_BYTES, LOAD);
3471       }
3472
3473       next[0] = next[1] = TCP_INPUT_NEXT_DROP;
3474
3475       tc0 = tcp_input_lookup_buffer (b[0], thread_index, &error0, is_ip4);
3476       tc1 = tcp_input_lookup_buffer (b[1], thread_index, &error1, is_ip4);
3477
3478       if (PREDICT_TRUE (!tc0 + !tc1 == 0))
3479         {
3480           ASSERT (tcp_lookup_is_valid (tc0, tcp_buffer_hdr (b[0])));
3481           ASSERT (tcp_lookup_is_valid (tc1, tcp_buffer_hdr (b[1])));
3482
3483           vnet_buffer (b[0])->tcp.connection_index = tc0->c_c_index;
3484           vnet_buffer (b[1])->tcp.connection_index = tc1->c_c_index;
3485
3486           tcp_input_dispatch_buffer (tm, tc0, b[0], &next[0], &error0);
3487           tcp_input_dispatch_buffer (tm, tc1, b[1], &next[1], &error1);
3488         }
3489       else
3490         {
3491           if (PREDICT_TRUE (tc0 != 0))
3492             {
3493               ASSERT (tcp_lookup_is_valid (tc0, tcp_buffer_hdr (b[0])));
3494               vnet_buffer (b[0])->tcp.connection_index = tc0->c_c_index;
3495               tcp_input_dispatch_buffer (tm, tc0, b[0], &next[0], &error0);
3496             }
3497           else
3498             tcp_input_set_error_next (tm, &next[0], &error0, is_ip4);
3499
3500           if (PREDICT_TRUE (tc1 != 0))
3501             {
3502               ASSERT (tcp_lookup_is_valid (tc1, tcp_buffer_hdr (b[1])));
3503               vnet_buffer (b[1])->tcp.connection_index = tc1->c_c_index;
3504               tcp_input_dispatch_buffer (tm, tc1, b[1], &next[1], &error1);
3505             }
3506           else
3507             tcp_input_set_error_next (tm, &next[1], &error1, is_ip4);
3508         }
3509
3510       b += 2;
3511       next += 2;
3512       n_left_from -= 2;
3513     }
3514   while (n_left_from > 0)
3515     {
3516       tcp_connection_t *tc0;
3517       u32 error0 = TCP_ERROR_NO_LISTENER;
3518
3519       if (n_left_from > 1)
3520         {
3521           vlib_prefetch_buffer_header (b[1], STORE);
3522           CLIB_PREFETCH (b[1]->data, 2 * CLIB_CACHE_LINE_BYTES, LOAD);
3523         }
3524
3525       next[0] = TCP_INPUT_NEXT_DROP;
3526       tc0 = tcp_input_lookup_buffer (b[0], thread_index, &error0, is_ip4);
3527       if (PREDICT_TRUE (tc0 != 0))
3528         {
3529           ASSERT (tcp_lookup_is_valid (tc0, tcp_buffer_hdr (b[0])));
3530           vnet_buffer (b[0])->tcp.connection_index = tc0->c_c_index;
3531           tcp_input_dispatch_buffer (tm, tc0, b[0], &next[0], &error0);
3532         }
3533       else
3534         tcp_input_set_error_next (tm, &next[0], &error0, is_ip4);
3535
3536       b += 1;
3537       next += 1;
3538       n_left_from -= 1;
3539     }
3540
3541   if (PREDICT_FALSE (node->flags & VLIB_NODE_FLAG_TRACE))
3542     tcp_input_trace_frame (vm, node, bufs, frame->n_vectors, is_ip4);
3543
3544   vlib_buffer_enqueue_to_next (vm, node, from, nexts, frame->n_vectors);
3545   return frame->n_vectors;
3546 }
3547
3548 VLIB_NODE_FN (tcp4_input_node) (vlib_main_t * vm, vlib_node_runtime_t * node,
3549                                 vlib_frame_t * from_frame)
3550 {
3551   return tcp46_input_inline (vm, node, from_frame, 1 /* is_ip4 */ );
3552 }
3553
3554 VLIB_NODE_FN (tcp6_input_node) (vlib_main_t * vm, vlib_node_runtime_t * node,
3555                                 vlib_frame_t * from_frame)
3556 {
3557   return tcp46_input_inline (vm, node, from_frame, 0 /* is_ip4 */ );
3558 }
3559
3560 /* *INDENT-OFF* */
3561 VLIB_REGISTER_NODE (tcp4_input_node) =
3562 {
3563   .name = "tcp4-input",
3564   /* Takes a vector of packets. */
3565   .vector_size = sizeof (u32),
3566   .n_errors = TCP_N_ERROR,
3567   .error_strings = tcp_error_strings,
3568   .n_next_nodes = TCP_INPUT_N_NEXT,
3569   .next_nodes =
3570   {
3571 #define _(s,n) [TCP_INPUT_NEXT_##s] = n,
3572     foreach_tcp4_input_next
3573 #undef _
3574   },
3575   .format_buffer = format_tcp_header,
3576   .format_trace = format_tcp_rx_trace,
3577 };
3578 /* *INDENT-ON* */
3579
3580 /* *INDENT-OFF* */
3581 VLIB_REGISTER_NODE (tcp6_input_node) =
3582 {
3583   .name = "tcp6-input",
3584   /* Takes a vector of packets. */
3585   .vector_size = sizeof (u32),
3586   .n_errors = TCP_N_ERROR,
3587   .error_strings = tcp_error_strings,
3588   .n_next_nodes = TCP_INPUT_N_NEXT,
3589   .next_nodes =
3590   {
3591 #define _(s,n) [TCP_INPUT_NEXT_##s] = n,
3592     foreach_tcp6_input_next
3593 #undef _
3594   },
3595   .format_buffer = format_tcp_header,
3596   .format_trace = format_tcp_rx_trace,
3597 };
3598 /* *INDENT-ON* */
3599
3600 #ifndef CLIB_MARCH_VARIANT
3601 static void
3602 tcp_dispatch_table_init (tcp_main_t * tm)
3603 {
3604   int i, j;
3605   for (i = 0; i < ARRAY_LEN (tm->dispatch_table); i++)
3606     for (j = 0; j < ARRAY_LEN (tm->dispatch_table[i]); j++)
3607       {
3608         tm->dispatch_table[i][j].next = TCP_INPUT_NEXT_DROP;
3609         tm->dispatch_table[i][j].error = TCP_ERROR_DISPATCH;
3610       }
3611
3612 #define _(t,f,n,e)                                              \
3613 do {                                                            \
3614     tm->dispatch_table[TCP_STATE_##t][f].next = (n);            \
3615     tm->dispatch_table[TCP_STATE_##t][f].error = (e);           \
3616 } while (0)
3617
3618   /* RFC 793: In LISTEN if RST drop and if ACK return RST */
3619   _(LISTEN, 0, TCP_INPUT_NEXT_DROP, TCP_ERROR_SEGMENT_INVALID);
3620   _(LISTEN, TCP_FLAG_ACK, TCP_INPUT_NEXT_RESET, TCP_ERROR_ACK_INVALID);
3621   _(LISTEN, TCP_FLAG_RST, TCP_INPUT_NEXT_DROP, TCP_ERROR_INVALID_CONNECTION);
3622   _(LISTEN, TCP_FLAG_SYN, TCP_INPUT_NEXT_LISTEN, TCP_ERROR_NONE);
3623   _(LISTEN, TCP_FLAG_SYN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RESET,
3624     TCP_ERROR_ACK_INVALID);
3625   _(LISTEN, TCP_FLAG_SYN | TCP_FLAG_RST, TCP_INPUT_NEXT_DROP,
3626     TCP_ERROR_SEGMENT_INVALID);
3627   _(LISTEN, TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_DROP,
3628     TCP_ERROR_SEGMENT_INVALID);
3629   _(LISTEN, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_DROP,
3630     TCP_ERROR_INVALID_CONNECTION);
3631   _(LISTEN, TCP_FLAG_FIN, TCP_INPUT_NEXT_RESET, TCP_ERROR_SEGMENT_INVALID);
3632   _(LISTEN, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RESET,
3633     TCP_ERROR_SEGMENT_INVALID);
3634   _(LISTEN, TCP_FLAG_FIN | TCP_FLAG_RST, TCP_INPUT_NEXT_DROP,
3635     TCP_ERROR_SEGMENT_INVALID);
3636   _(LISTEN, TCP_FLAG_FIN | TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_DROP,
3637     TCP_ERROR_NONE);
3638   _(LISTEN, TCP_FLAG_FIN | TCP_FLAG_SYN, TCP_INPUT_NEXT_DROP,
3639     TCP_ERROR_SEGMENT_INVALID);
3640   _(LISTEN, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_ACK, TCP_INPUT_NEXT_DROP,
3641     TCP_ERROR_SEGMENT_INVALID);
3642   _(LISTEN, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_RST, TCP_INPUT_NEXT_DROP,
3643     TCP_ERROR_SEGMENT_INVALID);
3644   _(LISTEN, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK,
3645     TCP_INPUT_NEXT_DROP, TCP_ERROR_SEGMENT_INVALID);
3646   /* ACK for for a SYN-ACK -> tcp-rcv-process. */
3647   _(SYN_RCVD, TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3648   _(SYN_RCVD, TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3649   _(SYN_RCVD, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3650     TCP_ERROR_NONE);
3651   _(SYN_RCVD, TCP_FLAG_SYN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3652   _(SYN_RCVD, TCP_FLAG_SYN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3653     TCP_ERROR_NONE);
3654   _(SYN_RCVD, TCP_FLAG_SYN | TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS,
3655     TCP_ERROR_NONE);
3656   _(SYN_RCVD, TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK,
3657     TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3658   _(SYN_RCVD, TCP_FLAG_FIN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3659   _(SYN_RCVD, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3660     TCP_ERROR_NONE);
3661   _(SYN_RCVD, TCP_FLAG_FIN | TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS,
3662     TCP_ERROR_NONE);
3663   _(SYN_RCVD, TCP_FLAG_FIN | TCP_FLAG_RST | TCP_FLAG_ACK,
3664     TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3665   _(SYN_RCVD, TCP_FLAG_FIN | TCP_FLAG_SYN, TCP_INPUT_NEXT_RCV_PROCESS,
3666     TCP_ERROR_NONE);
3667   _(SYN_RCVD, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_RST,
3668     TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3669   _(SYN_RCVD, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_ACK,
3670     TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3671   _(SYN_RCVD, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK,
3672     TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3673   _(SYN_RCVD, 0, TCP_INPUT_NEXT_DROP, TCP_ERROR_SEGMENT_INVALID);
3674   /* SYN-ACK for a SYN */
3675   _(SYN_SENT, TCP_FLAG_SYN | TCP_FLAG_ACK, TCP_INPUT_NEXT_SYN_SENT,
3676     TCP_ERROR_NONE);
3677   _(SYN_SENT, TCP_FLAG_ACK, TCP_INPUT_NEXT_SYN_SENT, TCP_ERROR_NONE);
3678   _(SYN_SENT, TCP_FLAG_RST, TCP_INPUT_NEXT_SYN_SENT, TCP_ERROR_NONE);
3679   _(SYN_SENT, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_SYN_SENT,
3680     TCP_ERROR_NONE);
3681   _(SYN_SENT, TCP_FLAG_FIN, TCP_INPUT_NEXT_SYN_SENT, TCP_ERROR_NONE);
3682   _(SYN_SENT, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_SYN_SENT,
3683     TCP_ERROR_NONE);
3684   /* ACK for for established connection -> tcp-established. */
3685   _(ESTABLISHED, TCP_FLAG_ACK, TCP_INPUT_NEXT_ESTABLISHED, TCP_ERROR_NONE);
3686   /* FIN for for established connection -> tcp-established. */
3687   _(ESTABLISHED, TCP_FLAG_FIN, TCP_INPUT_NEXT_ESTABLISHED, TCP_ERROR_NONE);
3688   _(ESTABLISHED, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_ESTABLISHED,
3689     TCP_ERROR_NONE);
3690   _(ESTABLISHED, TCP_FLAG_FIN | TCP_FLAG_RST, TCP_INPUT_NEXT_ESTABLISHED,
3691     TCP_ERROR_NONE);
3692   _(ESTABLISHED, TCP_FLAG_FIN | TCP_FLAG_RST | TCP_FLAG_ACK,
3693     TCP_INPUT_NEXT_ESTABLISHED, TCP_ERROR_NONE);
3694   _(ESTABLISHED, TCP_FLAG_FIN | TCP_FLAG_SYN, TCP_INPUT_NEXT_ESTABLISHED,
3695     TCP_ERROR_NONE);
3696   _(ESTABLISHED, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_ACK,
3697     TCP_INPUT_NEXT_ESTABLISHED, TCP_ERROR_NONE);
3698   _(ESTABLISHED, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_RST,
3699     TCP_INPUT_NEXT_ESTABLISHED, TCP_ERROR_NONE);
3700   _(ESTABLISHED, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK,
3701     TCP_INPUT_NEXT_ESTABLISHED, TCP_ERROR_NONE);
3702   _(ESTABLISHED, TCP_FLAG_RST, TCP_INPUT_NEXT_ESTABLISHED, TCP_ERROR_NONE);
3703   _(ESTABLISHED, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_ESTABLISHED,
3704     TCP_ERROR_NONE);
3705   _(ESTABLISHED, TCP_FLAG_SYN, TCP_INPUT_NEXT_ESTABLISHED, TCP_ERROR_NONE);
3706   _(ESTABLISHED, TCP_FLAG_SYN | TCP_FLAG_ACK, TCP_INPUT_NEXT_ESTABLISHED,
3707     TCP_ERROR_NONE);
3708   _(ESTABLISHED, TCP_FLAG_SYN | TCP_FLAG_RST, TCP_INPUT_NEXT_ESTABLISHED,
3709     TCP_ERROR_NONE);
3710   _(ESTABLISHED, TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK,
3711     TCP_INPUT_NEXT_ESTABLISHED, TCP_ERROR_NONE);
3712   _(ESTABLISHED, 0, TCP_INPUT_NEXT_DROP, TCP_ERROR_SEGMENT_INVALID);
3713   /* ACK or FIN-ACK to our FIN */
3714   _(FIN_WAIT_1, TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3715   _(FIN_WAIT_1, TCP_FLAG_ACK | TCP_FLAG_FIN, TCP_INPUT_NEXT_RCV_PROCESS,
3716     TCP_ERROR_NONE);
3717   /* FIN in reply to our FIN from the other side */
3718   _(FIN_WAIT_1, 0, TCP_INPUT_NEXT_DROP, TCP_ERROR_SEGMENT_INVALID);
3719   _(FIN_WAIT_1, TCP_FLAG_FIN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3720   _(FIN_WAIT_1, TCP_FLAG_FIN | TCP_FLAG_SYN, TCP_INPUT_NEXT_RCV_PROCESS,
3721     TCP_ERROR_NONE);
3722   _(FIN_WAIT_1, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_ACK,
3723     TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3724   _(FIN_WAIT_1, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_RST,
3725     TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3726   _(FIN_WAIT_1, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK,
3727     TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3728   _(FIN_WAIT_1, TCP_FLAG_FIN | TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS,
3729     TCP_ERROR_NONE);
3730   _(FIN_WAIT_1, TCP_FLAG_FIN | TCP_FLAG_RST | TCP_FLAG_ACK,
3731     TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3732   _(FIN_WAIT_1, TCP_FLAG_SYN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3733   _(FIN_WAIT_1, TCP_FLAG_SYN | TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS,
3734     TCP_ERROR_NONE);
3735   _(FIN_WAIT_1, TCP_FLAG_SYN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3736     TCP_ERROR_NONE);
3737   _(FIN_WAIT_1, TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK,
3738     TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3739   _(FIN_WAIT_1, TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3740   _(FIN_WAIT_1, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3741     TCP_ERROR_NONE);
3742   _(CLOSING, 0, TCP_INPUT_NEXT_DROP, TCP_ERROR_SEGMENT_INVALID);
3743   _(CLOSING, TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3744   _(CLOSING, TCP_FLAG_SYN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3745   _(CLOSING, TCP_FLAG_SYN | TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS,
3746     TCP_ERROR_NONE);
3747   _(CLOSING, TCP_FLAG_SYN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3748     TCP_ERROR_NONE);
3749   _(CLOSING, TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK,
3750     TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3751   _(CLOSING, TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3752   _(CLOSING, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3753     TCP_ERROR_NONE);
3754   _(CLOSING, TCP_FLAG_FIN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3755   _(CLOSING, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3756     TCP_ERROR_NONE);
3757   _(CLOSING, TCP_FLAG_FIN | TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS,
3758     TCP_ERROR_NONE);
3759   _(CLOSING, TCP_FLAG_FIN | TCP_FLAG_RST | TCP_FLAG_ACK,
3760     TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3761   _(CLOSING, TCP_FLAG_FIN | TCP_FLAG_SYN, TCP_INPUT_NEXT_RCV_PROCESS,
3762     TCP_ERROR_NONE);
3763   _(CLOSING, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_ACK,
3764     TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3765   _(CLOSING, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK,
3766     TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3767   /* FIN confirming that the peer (app) has closed */
3768   _(FIN_WAIT_2, TCP_FLAG_FIN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3769   _(FIN_WAIT_2, TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3770   _(FIN_WAIT_2, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3771     TCP_ERROR_NONE);
3772   _(FIN_WAIT_2, TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3773   _(FIN_WAIT_2, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3774     TCP_ERROR_NONE);
3775   _(CLOSE_WAIT, TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3776   _(CLOSE_WAIT, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3777     TCP_ERROR_NONE);
3778   _(CLOSE_WAIT, TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3779   _(CLOSE_WAIT, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3780     TCP_ERROR_NONE);
3781   _(LAST_ACK, 0, TCP_INPUT_NEXT_DROP, TCP_ERROR_SEGMENT_INVALID);
3782   _(LAST_ACK, TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3783   _(LAST_ACK, TCP_FLAG_FIN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3784   _(LAST_ACK, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3785     TCP_ERROR_NONE);
3786   _(LAST_ACK, TCP_FLAG_FIN | TCP_FLAG_SYN, TCP_INPUT_NEXT_RCV_PROCESS,
3787     TCP_ERROR_NONE);
3788   _(LAST_ACK, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_ACK,
3789     TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3790   _(LAST_ACK, TCP_FLAG_FIN | TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS,
3791     TCP_ERROR_NONE);
3792   _(LAST_ACK, TCP_FLAG_FIN | TCP_FLAG_RST | TCP_FLAG_ACK,
3793     TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3794   _(LAST_ACK, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_RST,
3795     TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3796   _(LAST_ACK, TCP_FLAG_FIN | TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK,
3797     TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3798   _(LAST_ACK, TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3799   _(LAST_ACK, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3800     TCP_ERROR_NONE);
3801   _(LAST_ACK, TCP_FLAG_SYN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3802   _(LAST_ACK, TCP_FLAG_SYN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3803     TCP_ERROR_NONE);
3804   _(LAST_ACK, TCP_FLAG_SYN | TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS,
3805     TCP_ERROR_NONE);
3806   _(LAST_ACK, TCP_FLAG_SYN | TCP_FLAG_RST | TCP_FLAG_ACK,
3807     TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3808   _(TIME_WAIT, TCP_FLAG_SYN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3809   _(TIME_WAIT, TCP_FLAG_FIN, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3810   _(TIME_WAIT, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3811     TCP_ERROR_NONE);
3812   _(TIME_WAIT, TCP_FLAG_RST, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3813   _(TIME_WAIT, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS,
3814     TCP_ERROR_NONE);
3815   _(TIME_WAIT, TCP_FLAG_ACK, TCP_INPUT_NEXT_RCV_PROCESS, TCP_ERROR_NONE);
3816   /* RFC793 CLOSED: An incoming segment containing a RST is discarded. An
3817    * incoming segment not containing a RST causes a RST to be sent in
3818    * response.*/
3819   _(CLOSED, TCP_FLAG_RST, TCP_INPUT_NEXT_DROP, TCP_ERROR_CONNECTION_CLOSED);
3820   _(CLOSED, TCP_FLAG_RST | TCP_FLAG_ACK, TCP_INPUT_NEXT_DROP,
3821     TCP_ERROR_CONNECTION_CLOSED);
3822   _(CLOSED, TCP_FLAG_ACK, TCP_INPUT_NEXT_RESET, TCP_ERROR_NONE);
3823   _(CLOSED, TCP_FLAG_SYN, TCP_INPUT_NEXT_RESET, TCP_ERROR_NONE);
3824   _(CLOSED, TCP_FLAG_FIN | TCP_FLAG_ACK, TCP_INPUT_NEXT_RESET,
3825     TCP_ERROR_NONE);
3826 #undef _
3827 }
3828
3829 static clib_error_t *
3830 tcp_input_init (vlib_main_t * vm)
3831 {
3832   clib_error_t *error = 0;
3833   tcp_main_t *tm = vnet_get_tcp_main ();
3834
3835   if ((error = vlib_call_init_function (vm, tcp_init)))
3836     return error;
3837
3838   /* Initialize dispatch table. */
3839   tcp_dispatch_table_init (tm);
3840
3841   return error;
3842 }
3843
3844 VLIB_INIT_FUNCTION (tcp_input_init);
3845
3846 #endif /* CLIB_MARCH_VARIANT */
3847
3848 /*
3849  * fd.io coding-style-patch-verification: ON
3850  *
3851  * Local Variables:
3852  * eval: (c-set-style "gnu")
3853  * End:
3854  */