tcp: protect against forced cleanups
[vpp.git] / src / vnet / tcp / tcp.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 /**
17  * @file
18  * @brief TCP host stack utilities
19  */
20
21 #include <vnet/tcp/tcp.h>
22 #include <vnet/session/session.h>
23 #include <vnet/fib/fib.h>
24 #include <vnet/dpo/load_balance.h>
25 #include <vnet/dpo/receive_dpo.h>
26 #include <vnet/ip-neighbor/ip_neighbor.h>
27 #include <math.h>
28
29 tcp_main_t tcp_main;
30
31 typedef struct
32 {
33   fib_protocol_t nh_proto;
34   vnet_link_t link_type;
35   ip46_address_t ip;
36   u32 sw_if_index;
37   u8 is_add;
38 } tcp_add_del_adj_args_t;
39
40 static void
41 tcp_add_del_adj_cb (tcp_add_del_adj_args_t * args)
42 {
43   u32 ai;
44   if (args->is_add)
45     {
46       adj_nbr_add_or_lock (args->nh_proto, args->link_type, &args->ip,
47                            args->sw_if_index);
48     }
49   else
50     {
51       ai = adj_nbr_find (FIB_PROTOCOL_IP6, VNET_LINK_IP6, &args->ip,
52                          args->sw_if_index);
53       if (ai != ADJ_INDEX_INVALID)
54         adj_unlock (ai);
55     }
56 }
57
58 static void
59 tcp_add_del_adjacency (tcp_connection_t * tc, u8 is_add)
60 {
61   tcp_add_del_adj_args_t args = {
62     .nh_proto = FIB_PROTOCOL_IP6,
63     .link_type = VNET_LINK_IP6,
64     .ip = tc->c_rmt_ip,
65     .sw_if_index = tc->sw_if_index,
66     .is_add = is_add
67   };
68   vlib_rpc_call_main_thread (tcp_add_del_adj_cb, (u8 *) & args,
69                              sizeof (args));
70 }
71
72 static void
73 tcp_cc_init (tcp_connection_t * tc)
74 {
75   tc->cc_algo->init (tc);
76 }
77
78 static void
79 tcp_cc_cleanup (tcp_connection_t * tc)
80 {
81   if (tc->cc_algo->cleanup)
82     tc->cc_algo->cleanup (tc);
83 }
84
85 void
86 tcp_cc_algo_register (tcp_cc_algorithm_type_e type,
87                       const tcp_cc_algorithm_t * vft)
88 {
89   tcp_main_t *tm = vnet_get_tcp_main ();
90   vec_validate (tm->cc_algos, type);
91
92   tm->cc_algos[type] = *vft;
93   hash_set_mem (tm->cc_algo_by_name, vft->name, type);
94 }
95
96 tcp_cc_algorithm_t *
97 tcp_cc_algo_get (tcp_cc_algorithm_type_e type)
98 {
99   tcp_main_t *tm = vnet_get_tcp_main ();
100   return &tm->cc_algos[type];
101 }
102
103 tcp_cc_algorithm_type_e
104 tcp_cc_algo_new_type (const tcp_cc_algorithm_t * vft)
105 {
106   tcp_main_t *tm = vnet_get_tcp_main ();
107   tcp_cc_algo_register (++tm->cc_last_type, vft);
108   return tm->cc_last_type;
109 }
110
111 static u32
112 tcp_connection_bind (u32 session_index, transport_endpoint_t * lcl)
113 {
114   tcp_main_t *tm = &tcp_main;
115   tcp_connection_t *listener;
116   void *iface_ip;
117
118   pool_get (tm->listener_pool, listener);
119   clib_memset (listener, 0, sizeof (*listener));
120
121   listener->c_c_index = listener - tm->listener_pool;
122   listener->c_lcl_port = lcl->port;
123
124   /* If we are provided a sw_if_index, bind using one of its ips */
125   if (ip_is_zero (&lcl->ip, 1) && lcl->sw_if_index != ENDPOINT_INVALID_INDEX)
126     {
127       if ((iface_ip = ip_interface_get_first_ip (lcl->sw_if_index,
128                                                  lcl->is_ip4)))
129         ip_set (&lcl->ip, iface_ip, lcl->is_ip4);
130     }
131   ip_copy (&listener->c_lcl_ip, &lcl->ip, lcl->is_ip4);
132   listener->c_is_ip4 = lcl->is_ip4;
133   listener->c_proto = TRANSPORT_PROTO_TCP;
134   listener->c_s_index = session_index;
135   listener->c_fib_index = lcl->fib_index;
136   listener->state = TCP_STATE_LISTEN;
137   listener->cc_algo = tcp_cc_algo_get (tcp_cfg.cc_algo);
138
139   tcp_connection_timers_init (listener);
140
141   TCP_EVT (TCP_EVT_BIND, listener);
142
143   return listener->c_c_index;
144 }
145
146 static u32
147 tcp_session_bind (u32 session_index, transport_endpoint_t * tep)
148 {
149   return tcp_connection_bind (session_index, tep);
150 }
151
152 static void
153 tcp_connection_unbind (u32 listener_index)
154 {
155   tcp_main_t *tm = vnet_get_tcp_main ();
156   tcp_connection_t *tc;
157
158   tc = pool_elt_at_index (tm->listener_pool, listener_index);
159
160   TCP_EVT (TCP_EVT_UNBIND, tc);
161
162   /* Poison the entry */
163   if (CLIB_DEBUG > 0)
164     clib_memset (tc, 0xFA, sizeof (*tc));
165
166   pool_put_index (tm->listener_pool, listener_index);
167 }
168
169 static u32
170 tcp_session_unbind (u32 listener_index)
171 {
172   tcp_connection_unbind (listener_index);
173   return 0;
174 }
175
176 static transport_connection_t *
177 tcp_session_get_listener (u32 listener_index)
178 {
179   tcp_main_t *tm = vnet_get_tcp_main ();
180   tcp_connection_t *tc;
181   tc = pool_elt_at_index (tm->listener_pool, listener_index);
182   return &tc->connection;
183 }
184
185 /**
186  * Cleanup half-open connection
187  *
188  */
189 static void
190 tcp_half_open_connection_del (tcp_connection_t * tc)
191 {
192   tcp_main_t *tm = vnet_get_tcp_main ();
193   clib_spinlock_lock_if_init (&tm->half_open_lock);
194   if (CLIB_DEBUG)
195     clib_memset (tc, 0xFA, sizeof (*tc));
196   pool_put (tm->half_open_connections, tc);
197   clib_spinlock_unlock_if_init (&tm->half_open_lock);
198 }
199
200 /**
201  * Try to cleanup half-open connection
202  *
203  * If called from a thread that doesn't own tc, the call won't have any
204  * effect.
205  *
206  * @param tc - connection to be cleaned up
207  * @return non-zero if cleanup failed.
208  */
209 int
210 tcp_half_open_connection_cleanup (tcp_connection_t * tc)
211 {
212   /* Make sure this is the owning thread */
213   if (tc->c_thread_index != vlib_get_thread_index ())
214     return 1;
215   tcp_timer_reset (tc, TCP_TIMER_RETRANSMIT_SYN);
216   tcp_half_open_connection_del (tc);
217   return 0;
218 }
219
220 static tcp_connection_t *
221 tcp_half_open_connection_new (void)
222 {
223   tcp_main_t *tm = vnet_get_tcp_main ();
224   tcp_connection_t *tc = 0;
225   ASSERT (vlib_get_thread_index () == 0);
226   pool_get (tm->half_open_connections, tc);
227   clib_memset (tc, 0, sizeof (*tc));
228   tc->c_c_index = tc - tm->half_open_connections;
229   return tc;
230 }
231
232 /**
233  * Cleans up connection state.
234  *
235  * No notifications.
236  */
237 void
238 tcp_connection_cleanup (tcp_connection_t * tc)
239 {
240   TCP_EVT (TCP_EVT_DELETE, tc);
241
242   /* Cleanup local endpoint if this was an active connect */
243   if (!(tc->cfg_flags & TCP_CFG_F_NO_ENDPOINT))
244     transport_endpoint_cleanup (TRANSPORT_PROTO_TCP, &tc->c_lcl_ip,
245                                 tc->c_lcl_port);
246
247   /* Check if connection is not yet fully established */
248   if (tc->state == TCP_STATE_SYN_SENT)
249     {
250       /* Try to remove the half-open connection. If this is not the owning
251        * thread, tc won't be removed. Retransmit or establish timers will
252        * eventually expire and call again cleanup on the right thread. */
253       if (tcp_half_open_connection_cleanup (tc))
254         tc->flags |= TCP_CONN_HALF_OPEN_DONE;
255     }
256   else
257     {
258       /* Make sure all timers are cleared */
259       tcp_connection_timers_reset (tc);
260
261       if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
262         tcp_add_del_adjacency (tc, 0);
263
264       tcp_cc_cleanup (tc);
265       vec_free (tc->snd_sacks);
266       vec_free (tc->snd_sacks_fl);
267       vec_free (tc->rcv_opts.sacks);
268       pool_free (tc->sack_sb.holes);
269
270       if (tc->cfg_flags & TCP_CFG_F_RATE_SAMPLE)
271         tcp_bt_cleanup (tc);
272
273       tcp_connection_free (tc);
274     }
275 }
276
277 /**
278  * Connection removal.
279  *
280  * This should be called only once connection enters CLOSED state. Note
281  * that it notifies the session of the removal event, so if the goal is to
282  * just remove the connection, call tcp_connection_cleanup instead.
283  */
284 void
285 tcp_connection_del (tcp_connection_t * tc)
286 {
287   session_transport_delete_notify (&tc->connection);
288   tcp_connection_cleanup (tc);
289 }
290
291 tcp_connection_t *
292 tcp_connection_alloc (u8 thread_index)
293 {
294   tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
295   tcp_connection_t *tc;
296
297   pool_get (wrk->connections, tc);
298   clib_memset (tc, 0, sizeof (*tc));
299   tc->c_c_index = tc - wrk->connections;
300   tc->c_thread_index = thread_index;
301   return tc;
302 }
303
304 tcp_connection_t *
305 tcp_connection_alloc_w_base (u8 thread_index, tcp_connection_t * base)
306 {
307   tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
308   tcp_connection_t *tc;
309
310   pool_get (wrk->connections, tc);
311   clib_memcpy_fast (tc, base, sizeof (*tc));
312   tc->c_c_index = tc - wrk->connections;
313   tc->c_thread_index = thread_index;
314   return tc;
315 }
316
317 void
318 tcp_connection_free (tcp_connection_t * tc)
319 {
320   tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
321   if (CLIB_DEBUG)
322     {
323       clib_memset (tc, 0xFA, sizeof (*tc));
324       pool_put (wrk->connections, tc);
325       return;
326     }
327   pool_put (wrk->connections, tc);
328 }
329
330 void
331 tcp_program_cleanup (tcp_worker_ctx_t * wrk, tcp_connection_t * tc)
332 {
333   tcp_cleanup_req_t *req;
334   clib_time_type_t now;
335
336   now = transport_time_now (tc->c_thread_index);
337   clib_fifo_add2 (wrk->pending_cleanups, req);
338   req->connection_index = tc->c_c_index;
339   req->free_time = now + tcp_cfg.cleanup_time;
340 }
341
342 /**
343  * Begin connection closing procedure.
344  *
345  * If at the end the connection is not in CLOSED state, it is not removed.
346  * Instead, we rely on on TCP to advance through state machine to either
347  * 1) LAST_ACK (passive close) whereby when the last ACK is received
348  * tcp_connection_del is called. This notifies session of the delete and
349  * calls cleanup.
350  * 2) TIME_WAIT (active close) whereby after 2MSL the 2MSL timer triggers
351  * and cleanup is called.
352  *
353  * N.B. Half-close connections are not supported
354  */
355 void
356 tcp_connection_close (tcp_connection_t * tc)
357 {
358   TCP_EVT (TCP_EVT_CLOSE, tc);
359
360   /* Send/Program FIN if needed and switch state */
361   switch (tc->state)
362     {
363     case TCP_STATE_SYN_SENT:
364       /* Try to cleanup. If not on the right thread, mark as half-open done.
365        * Connection will be cleaned up when establish timer pops */
366       tcp_connection_cleanup (tc);
367       break;
368     case TCP_STATE_SYN_RCVD:
369       tcp_connection_timers_reset (tc);
370       tcp_send_fin (tc);
371       tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
372       tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.finwait1_time);
373       break;
374     case TCP_STATE_ESTABLISHED:
375       /* If closing with unread data, reset the connection */
376       if (transport_max_rx_dequeue (&tc->connection))
377         {
378           tcp_send_reset (tc);
379           tcp_connection_timers_reset (tc);
380           tcp_connection_set_state (tc, TCP_STATE_CLOSED);
381           session_transport_closed_notify (&tc->connection);
382           tcp_program_cleanup (tcp_get_worker (tc->c_thread_index), tc);
383           tcp_worker_stats_inc (tc->c_thread_index, rst_unread, 1);
384           break;
385         }
386       if (!transport_max_tx_dequeue (&tc->connection))
387         tcp_send_fin (tc);
388       else
389         tc->flags |= TCP_CONN_FINPNDG;
390       tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
391       /* Set a timer in case the peer stops responding. Otherwise the
392        * connection will be stuck here forever. */
393       ASSERT (tc->timers[TCP_TIMER_WAITCLOSE] == TCP_TIMER_HANDLE_INVALID);
394       tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.finwait1_time);
395       break;
396     case TCP_STATE_CLOSE_WAIT:
397       if (!transport_max_tx_dequeue (&tc->connection))
398         {
399           tcp_send_fin (tc);
400           tcp_connection_timers_reset (tc);
401           tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
402           tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.lastack_time);
403         }
404       else
405         tc->flags |= TCP_CONN_FINPNDG;
406       break;
407     case TCP_STATE_FIN_WAIT_1:
408       tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.finwait1_time);
409       break;
410     case TCP_STATE_CLOSED:
411       /* Cleanup should've been programmed already */
412       break;
413     default:
414       TCP_DBG ("state: %u", tc->state);
415     }
416 }
417
418 static void
419 tcp_session_close (u32 conn_index, u32 thread_index)
420 {
421   tcp_connection_t *tc;
422   tc = tcp_connection_get (conn_index, thread_index);
423   tcp_connection_close (tc);
424 }
425
426 static void
427 tcp_session_cleanup (u32 conn_index, u32 thread_index)
428 {
429   tcp_connection_t *tc;
430   tc = tcp_connection_get (conn_index, thread_index);
431   if (!tc)
432     return;
433   tcp_connection_set_state (tc, TCP_STATE_CLOSED);
434   tcp_connection_cleanup (tc);
435 }
436
437 static void
438 tcp_session_reset (u32 conn_index, u32 thread_index)
439 {
440   tcp_connection_t *tc;
441   tc = tcp_connection_get (conn_index, thread_index);
442   tcp_send_reset (tc);
443   tcp_connection_timers_reset (tc);
444   tcp_cong_recovery_off (tc);
445   tcp_connection_set_state (tc, TCP_STATE_CLOSED);
446   session_transport_closed_notify (&tc->connection);
447   tcp_program_cleanup (tcp_get_worker (thread_index), tc);
448 }
449
450 /**
451  * Initialize all connection timers as invalid
452  */
453 void
454 tcp_connection_timers_init (tcp_connection_t * tc)
455 {
456   int i;
457
458   /* Set all to invalid */
459   for (i = 0; i < TCP_N_TIMERS; i++)
460     {
461       tc->timers[i] = TCP_TIMER_HANDLE_INVALID;
462     }
463
464   tc->rto = TCP_RTO_INIT;
465 }
466
467 /**
468  * Stop all connection timers
469  */
470 void
471 tcp_connection_timers_reset (tcp_connection_t * tc)
472 {
473   int i;
474   for (i = 0; i < TCP_N_TIMERS; i++)
475     {
476       tcp_timer_reset (tc, i);
477     }
478 }
479
480 #if 0
481 typedef struct ip4_tcp_hdr
482 {
483   ip4_header_t ip;
484   tcp_header_t tcp;
485 } ip4_tcp_hdr_t;
486
487 typedef struct ip6_tcp_hdr
488 {
489   ip6_header_t ip;
490   tcp_header_t tcp;
491 } ip6_tcp_hdr_t;
492
493 static void
494 tcp_connection_select_lb_bucket (tcp_connection_t * tc, const dpo_id_t * dpo,
495                                  dpo_id_t * result)
496 {
497   const dpo_id_t *choice;
498   load_balance_t *lb;
499   int hash;
500
501   lb = load_balance_get (dpo->dpoi_index);
502   if (tc->c_is_ip4)
503     {
504       ip4_tcp_hdr_t hdr;
505       clib_memset (&hdr, 0, sizeof (hdr));
506       hdr.ip.protocol = IP_PROTOCOL_TCP;
507       hdr.ip.address_pair.src.as_u32 = tc->c_lcl_ip.ip4.as_u32;
508       hdr.ip.address_pair.dst.as_u32 = tc->c_rmt_ip.ip4.as_u32;
509       hdr.tcp.src_port = tc->c_lcl_port;
510       hdr.tcp.dst_port = tc->c_rmt_port;
511       hash = ip4_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
512     }
513   else
514     {
515       ip6_tcp_hdr_t hdr;
516       clib_memset (&hdr, 0, sizeof (hdr));
517       hdr.ip.protocol = IP_PROTOCOL_TCP;
518       clib_memcpy_fast (&hdr.ip.src_address, &tc->c_lcl_ip.ip6,
519                         sizeof (ip6_address_t));
520       clib_memcpy_fast (&hdr.ip.dst_address, &tc->c_rmt_ip.ip6,
521                         sizeof (ip6_address_t));
522       hdr.tcp.src_port = tc->c_lcl_port;
523       hdr.tcp.dst_port = tc->c_rmt_port;
524       hash = ip6_compute_flow_hash (&hdr.ip, lb->lb_hash_config);
525     }
526   choice = load_balance_get_bucket_i (lb, hash & lb->lb_n_buckets_minus_1);
527   dpo_copy (result, choice);
528 }
529
530 fib_node_index_t
531 tcp_lookup_rmt_in_fib (tcp_connection_t * tc)
532 {
533   fib_prefix_t prefix;
534   u32 fib_index;
535
536   clib_memcpy_fast (&prefix.fp_addr, &tc->c_rmt_ip, sizeof (prefix.fp_addr));
537   prefix.fp_proto = tc->c_is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
538   prefix.fp_len = tc->c_is_ip4 ? 32 : 128;
539   fib_index = fib_table_find (prefix.fp_proto, tc->c_fib_index);
540   return fib_table_lookup (fib_index, &prefix);
541 }
542
543 static int
544 tcp_connection_stack_on_fib_entry (tcp_connection_t * tc)
545 {
546   dpo_id_t choice = DPO_INVALID;
547   u32 output_node_index;
548   fib_entry_t *fe;
549
550   fe = fib_entry_get (tc->c_rmt_fei);
551   if (fe->fe_lb.dpoi_type != DPO_LOAD_BALANCE)
552     return -1;
553
554   tcp_connection_select_lb_bucket (tc, &fe->fe_lb, &choice);
555
556   output_node_index =
557     tc->c_is_ip4 ? tcp4_output_node.index : tcp6_output_node.index;
558   dpo_stack_from_node (output_node_index, &tc->c_rmt_dpo, &choice);
559   return 0;
560 }
561
562 /** Stack tcp connection on peer's fib entry.
563  *
564  * This ultimately populates the dpo the connection will use to send packets.
565  */
566 static void
567 tcp_connection_fib_attach (tcp_connection_t * tc)
568 {
569   tc->c_rmt_fei = tcp_lookup_rmt_in_fib (tc);
570
571   ASSERT (tc->c_rmt_fei != FIB_NODE_INDEX_INVALID);
572
573   tcp_connection_stack_on_fib_entry (tc);
574 }
575 #endif /* 0 */
576
577 /**
578  * Generate random iss as per rfc6528
579  */
580 static u32
581 tcp_generate_random_iss (tcp_connection_t * tc)
582 {
583   tcp_main_t *tm = &tcp_main;
584   u64 tmp;
585
586   if (tc->c_is_ip4)
587     tmp = (u64) tc->c_lcl_ip.ip4.as_u32 << 32 | (u64) tc->c_rmt_ip.ip4.as_u32;
588   else
589     tmp = tc->c_lcl_ip.ip6.as_u64[0] ^ tc->c_lcl_ip.ip6.as_u64[1]
590       ^ tc->c_rmt_ip.ip6.as_u64[0] ^ tc->c_rmt_ip.ip6.as_u64[1];
591
592   tmp ^= tm->iss_seed.first | ((u64) tc->c_lcl_port << 16 | tc->c_rmt_port);
593   tmp ^= tm->iss_seed.second;
594   tmp = clib_xxhash (tmp) + clib_cpu_time_now ();
595   return ((tmp >> 32) ^ (tmp & 0xffffffff));
596 }
597
598 /**
599  * Initialize max segment size we're able to process.
600  *
601  * The value is constrained by the output interface's MTU and by the size
602  * of the IP and TCP headers (see RFC6691). It is also what we advertise
603  * to our peer.
604  */
605 static void
606 tcp_init_rcv_mss (tcp_connection_t * tc)
607 {
608   u8 ip_hdr_len;
609
610   /* Already provided at connection init time */
611   if (tc->mss)
612     return;
613
614   ip_hdr_len = tc->c_is_ip4 ? sizeof (ip4_header_t) : sizeof (ip6_header_t);
615   tc->mss = tcp_cfg.default_mtu - sizeof (tcp_header_t) - ip_hdr_len;
616 }
617
618 static void
619 tcp_init_mss (tcp_connection_t * tc)
620 {
621   u16 default_min_mss = 536;
622
623   tcp_init_rcv_mss (tc);
624
625   /* TODO consider PMTU discovery */
626   tc->snd_mss = clib_min (tc->rcv_opts.mss, tc->mss);
627
628   if (tc->snd_mss < 45)
629     {
630       /* Assume that at least the min default mss works */
631       tc->snd_mss = default_min_mss;
632       tc->rcv_opts.mss = default_min_mss;
633     }
634
635   /* We should have enough space for 40 bytes of options */
636   ASSERT (tc->snd_mss > 45);
637
638   /* If we use timestamp option, account for it */
639   if (tcp_opts_tstamp (&tc->rcv_opts))
640     tc->snd_mss -= TCP_OPTION_LEN_TIMESTAMP;
641 }
642
643 /**
644  * Initialize connection send variables.
645  */
646 void
647 tcp_init_snd_vars (tcp_connection_t * tc)
648 {
649   /*
650    * We use the time to randomize iss and for setting up the initial
651    * timestamp. Make sure it's updated otherwise syn and ack in the
652    * handshake may make it look as if time has flown in the opposite
653    * direction for us.
654    */
655   tcp_set_time_now (tcp_get_worker (vlib_get_thread_index ()));
656
657   tcp_init_rcv_mss (tc);
658   tc->iss = tcp_generate_random_iss (tc);
659   tc->snd_una = tc->iss;
660   tc->snd_nxt = tc->iss + 1;
661   tc->snd_una_max = tc->snd_nxt;
662   tc->srtt = 100;               /* 100 ms */
663
664   if (!tcp_cfg.csum_offload)
665     tc->cfg_flags |= TCP_CFG_F_NO_CSUM_OFFLOAD;
666 }
667
668 void
669 tcp_enable_pacing (tcp_connection_t * tc)
670 {
671   u32 byte_rate;
672   byte_rate = tc->cwnd / (tc->srtt * TCP_TICK);
673   transport_connection_tx_pacer_init (&tc->connection, byte_rate, tc->cwnd);
674   tc->mrtt_us = (u32) ~ 0;
675 }
676
677 /** Initialize tcp connection variables
678  *
679  * Should be called after having received a msg from the peer, i.e., a SYN or
680  * a SYNACK, such that connection options have already been exchanged. */
681 void
682 tcp_connection_init_vars (tcp_connection_t * tc)
683 {
684   tcp_connection_timers_init (tc);
685   tcp_init_mss (tc);
686   scoreboard_init (&tc->sack_sb);
687   if (tc->state == TCP_STATE_SYN_RCVD)
688     tcp_init_snd_vars (tc);
689
690   tcp_cc_init (tc);
691
692   if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
693     tcp_add_del_adjacency (tc, 1);
694
695   /*  tcp_connection_fib_attach (tc); */
696
697   if (transport_connection_is_tx_paced (&tc->connection)
698       || tcp_cfg.enable_tx_pacing)
699     tcp_enable_pacing (tc);
700
701   if (tc->cfg_flags & TCP_CFG_F_RATE_SAMPLE)
702     tcp_bt_init (tc);
703
704   if (!tcp_cfg.allow_tso)
705     tc->cfg_flags |= TCP_CFG_F_NO_TSO;
706
707   tc->start_ts = tcp_time_now_us (tc->c_thread_index);
708 }
709
710 static int
711 tcp_alloc_custom_local_endpoint (tcp_main_t * tm, ip46_address_t * lcl_addr,
712                                  u16 * lcl_port, u8 is_ip4)
713 {
714   int index, port;
715   if (is_ip4)
716     {
717       index = tm->last_v4_addr_rotor++;
718       if (tm->last_v4_addr_rotor >= vec_len (tcp_cfg.ip4_src_addrs))
719         tm->last_v4_addr_rotor = 0;
720       lcl_addr->ip4.as_u32 = tcp_cfg.ip4_src_addrs[index].as_u32;
721     }
722   else
723     {
724       index = tm->last_v6_addr_rotor++;
725       if (tm->last_v6_addr_rotor >= vec_len (tcp_cfg.ip6_src_addrs))
726         tm->last_v6_addr_rotor = 0;
727       clib_memcpy_fast (&lcl_addr->ip6, &tcp_cfg.ip6_src_addrs[index],
728                         sizeof (ip6_address_t));
729     }
730   port = transport_alloc_local_port (TRANSPORT_PROTO_TCP, lcl_addr);
731   if (port < 1)
732     {
733       clib_warning ("Failed to allocate src port");
734       return -1;
735     }
736   *lcl_port = port;
737   return 0;
738 }
739
740 static int
741 tcp_session_open (transport_endpoint_cfg_t * rmt)
742 {
743   tcp_main_t *tm = vnet_get_tcp_main ();
744   tcp_connection_t *tc;
745   ip46_address_t lcl_addr;
746   u16 lcl_port;
747   int rv;
748
749   /*
750    * Allocate local endpoint
751    */
752   if ((rmt->is_ip4 && vec_len (tcp_cfg.ip4_src_addrs))
753       || (!rmt->is_ip4 && vec_len (tcp_cfg.ip6_src_addrs)))
754     rv = tcp_alloc_custom_local_endpoint (tm, &lcl_addr, &lcl_port,
755                                           rmt->is_ip4);
756   else
757     rv = transport_alloc_local_endpoint (TRANSPORT_PROTO_TCP,
758                                          rmt, &lcl_addr, &lcl_port);
759
760   if (rv)
761     return -1;
762
763   /*
764    * Create connection and send SYN
765    */
766   clib_spinlock_lock_if_init (&tm->half_open_lock);
767   tc = tcp_half_open_connection_new ();
768   ip_copy (&tc->c_rmt_ip, &rmt->ip, rmt->is_ip4);
769   ip_copy (&tc->c_lcl_ip, &lcl_addr, rmt->is_ip4);
770   tc->c_rmt_port = rmt->port;
771   tc->c_lcl_port = clib_host_to_net_u16 (lcl_port);
772   tc->c_is_ip4 = rmt->is_ip4;
773   tc->c_proto = TRANSPORT_PROTO_TCP;
774   tc->c_fib_index = rmt->fib_index;
775   tc->cc_algo = tcp_cc_algo_get (tcp_cfg.cc_algo);
776   /* The other connection vars will be initialized after SYN ACK */
777   tcp_connection_timers_init (tc);
778   tc->mss = rmt->mss;
779
780   TCP_EVT (TCP_EVT_OPEN, tc);
781   tc->state = TCP_STATE_SYN_SENT;
782   tcp_init_snd_vars (tc);
783   tcp_send_syn (tc);
784   clib_spinlock_unlock_if_init (&tm->half_open_lock);
785
786   return tc->c_c_index;
787 }
788
789 const char *tcp_fsm_states[] = {
790 #define _(sym, str) str,
791   foreach_tcp_fsm_state
792 #undef _
793 };
794
795 u8 *
796 format_tcp_state (u8 * s, va_list * args)
797 {
798   u32 state = va_arg (*args, u32);
799
800   if (state < TCP_N_STATES)
801     s = format (s, "%s", tcp_fsm_states[state]);
802   else
803     s = format (s, "UNKNOWN (%d (0x%x))", state, state);
804   return s;
805 }
806
807 const char *tcp_cfg_flags_str[] = {
808 #define _(sym, str) str,
809   foreach_tcp_cfg_flag
810 #undef _
811 };
812
813 static u8 *
814 format_tcp_cfg_flags (u8 * s, va_list * args)
815 {
816   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
817   int i, last = -1;
818
819   for (i = 0; i < TCP_CFG_N_FLAG_BITS; i++)
820     if (tc->cfg_flags & (1 << i))
821       last = i;
822   for (i = 0; i < last; i++)
823     {
824       if (tc->cfg_flags & (1 << i))
825         s = format (s, "%s, ", tcp_cfg_flags_str[i]);
826     }
827   if (last >= 0)
828     s = format (s, "%s", tcp_cfg_flags_str[last]);
829   return s;
830 }
831
832 const char *tcp_connection_flags_str[] = {
833 #define _(sym, str) str,
834   foreach_tcp_connection_flag
835 #undef _
836 };
837
838 static u8 *
839 format_tcp_connection_flags (u8 * s, va_list * args)
840 {
841   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
842   int i, last = -1;
843
844   for (i = 0; i < TCP_CONN_N_FLAG_BITS; i++)
845     if (tc->flags & (1 << i))
846       last = i;
847   for (i = 0; i < last; i++)
848     {
849       if (tc->flags & (1 << i))
850         s = format (s, "%s, ", tcp_connection_flags_str[i]);
851     }
852   if (last >= 0)
853     s = format (s, "%s", tcp_connection_flags_str[last]);
854   return s;
855 }
856
857 const char *tcp_conn_timers[] = {
858 #define _(sym, str) str,
859   foreach_tcp_timer
860 #undef _
861 };
862
863 static u8 *
864 format_tcp_timers (u8 * s, va_list * args)
865 {
866   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
867   int i, last = -1;
868
869   for (i = 0; i < TCP_N_TIMERS; i++)
870     if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
871       last = i;
872
873   for (i = 0; i < last; i++)
874     {
875       if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
876         s = format (s, "%s,", tcp_conn_timers[i]);
877     }
878
879   if (last >= 0)
880     s = format (s, "%s", tcp_conn_timers[i]);
881
882   return s;
883 }
884
885 static u8 *
886 format_tcp_congestion_status (u8 * s, va_list * args)
887 {
888   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
889   if (tcp_in_recovery (tc))
890     s = format (s, "recovery");
891   else if (tcp_in_fastrecovery (tc))
892     s = format (s, "fastrecovery");
893   else
894     s = format (s, "none");
895   return s;
896 }
897
898 static i32
899 tcp_rcv_wnd_available (tcp_connection_t * tc)
900 {
901   return (i32) tc->rcv_wnd - (tc->rcv_nxt - tc->rcv_las);
902 }
903
904 static u8 *
905 format_tcp_congestion (u8 * s, va_list * args)
906 {
907   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
908   u32 indent = format_get_indent (s), prr_space = 0;
909
910   s = format (s, "%U ", format_tcp_congestion_status, tc);
911   s = format (s, "algo %s cwnd %u ssthresh %u bytes_acked %u\n",
912               tc->cc_algo->name, tc->cwnd, tc->ssthresh, tc->bytes_acked);
913   s = format (s, "%Ucc space %u prev_cwnd %u prev_ssthresh %u\n",
914               format_white_space, indent, tcp_available_cc_snd_space (tc),
915               tc->prev_cwnd, tc->prev_ssthresh);
916   s = format (s, "%Usnd_cong %u dupack %u limited_tx %u\n",
917               format_white_space, indent, tc->snd_congestion - tc->iss,
918               tc->rcv_dupacks, tc->limited_transmit - tc->iss);
919   s = format (s, "%Urxt_bytes %u rxt_delivered %u rxt_head %u rxt_ts %u\n",
920               format_white_space, indent, tc->snd_rxt_bytes,
921               tc->rxt_delivered, tc->rxt_head - tc->iss,
922               tcp_time_now_w_thread (tc->c_thread_index) - tc->snd_rxt_ts);
923   if (tcp_in_fastrecovery (tc))
924     prr_space = tcp_fastrecovery_prr_snd_space (tc);
925   s = format (s, "%Uprr_start %u prr_delivered %u prr space %u\n",
926               format_white_space, indent, tc->prr_start - tc->iss,
927               tc->prr_delivered, prr_space);
928   return s;
929 }
930
931 static u8 *
932 format_tcp_stats (u8 * s, va_list * args)
933 {
934   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
935   u32 indent = format_get_indent (s);
936   s = format (s, "in segs %lu dsegs %lu bytes %lu dupacks %u\n",
937               tc->segs_in, tc->data_segs_in, tc->bytes_in, tc->dupacks_in);
938   s = format (s, "%Uout segs %lu dsegs %lu bytes %lu dupacks %u\n",
939               format_white_space, indent, tc->segs_out,
940               tc->data_segs_out, tc->bytes_out, tc->dupacks_out);
941   s = format (s, "%Ufr %u tr %u rxt segs %lu bytes %lu duration %.3f\n",
942               format_white_space, indent, tc->fr_occurences,
943               tc->tr_occurences, tc->segs_retrans, tc->bytes_retrans,
944               tcp_time_now_us (tc->c_thread_index) - tc->start_ts);
945   s = format (s, "%Uerr wnd data below %u above %u ack below %u above %u",
946               format_white_space, indent, tc->errors.below_data_wnd,
947               tc->errors.above_data_wnd, tc->errors.below_ack_wnd,
948               tc->errors.above_ack_wnd);
949   return s;
950 }
951
952 static u8 *
953 format_tcp_vars (u8 * s, va_list * args)
954 {
955   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
956   s = format (s, " index: %u cfg: %U flags: %U timers: %U\n", tc->c_c_index,
957               format_tcp_cfg_flags, tc, format_tcp_connection_flags, tc,
958               format_tcp_timers, tc);
959   s = format (s, " snd_una %u snd_nxt %u snd_una_max %u",
960               tc->snd_una - tc->iss, tc->snd_nxt - tc->iss,
961               tc->snd_una_max - tc->iss);
962   s = format (s, " rcv_nxt %u rcv_las %u\n",
963               tc->rcv_nxt - tc->irs, tc->rcv_las - tc->irs);
964   s = format (s, " snd_wnd %u rcv_wnd %u rcv_wscale %u ",
965               tc->snd_wnd, tc->rcv_wnd, tc->rcv_wscale);
966   s = format (s, "snd_wl1 %u snd_wl2 %u\n", tc->snd_wl1 - tc->irs,
967               tc->snd_wl2 - tc->iss);
968   s = format (s, " flight size %u out space %u rcv_wnd_av %u",
969               tcp_flight_size (tc), tcp_available_output_snd_space (tc),
970               tcp_rcv_wnd_available (tc));
971   s = format (s, " tsval_recent %u\n", tc->tsval_recent);
972   s = format (s, " tsecr %u tsecr_last_ack %u tsval_recent_age %u",
973               tc->rcv_opts.tsecr, tc->tsecr_last_ack,
974               tcp_time_now () - tc->tsval_recent_age);
975   s = format (s, " snd_mss %u\n", tc->snd_mss);
976   s = format (s, " rto %u rto_boff %u srtt %u us %.3f rttvar %u rtt_ts %.4f",
977               tc->rto, tc->rto_boff, tc->srtt, tc->mrtt_us * 1000, tc->rttvar,
978               tc->rtt_ts);
979   s = format (s, " rtt_seq %u\n", tc->rtt_seq - tc->iss);
980   s = format (s, " next_node %u opaque 0x%x fib_index %u\n",
981               tc->next_node_index, tc->next_node_opaque, tc->c_fib_index);
982   s = format (s, " cong:   %U", format_tcp_congestion, tc);
983
984   if (tc->state >= TCP_STATE_ESTABLISHED)
985     {
986       s = format (s, " sboard: %U\n", format_tcp_scoreboard, &tc->sack_sb,
987                   tc);
988       s = format (s, " stats: %U\n", format_tcp_stats, tc);
989     }
990   if (vec_len (tc->snd_sacks))
991     s = format (s, " sacks tx: %U\n", format_tcp_sacks, tc);
992
993   return s;
994 }
995
996 u8 *
997 format_tcp_connection_id (u8 * s, va_list * args)
998 {
999   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1000   if (!tc)
1001     return s;
1002   if (tc->c_is_ip4)
1003     {
1004       s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
1005                   tc->c_s_index, "T", format_ip4_address, &tc->c_lcl_ip4,
1006                   clib_net_to_host_u16 (tc->c_lcl_port), format_ip4_address,
1007                   &tc->c_rmt_ip4, clib_net_to_host_u16 (tc->c_rmt_port));
1008     }
1009   else
1010     {
1011       s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
1012                   tc->c_s_index, "T", format_ip6_address, &tc->c_lcl_ip6,
1013                   clib_net_to_host_u16 (tc->c_lcl_port), format_ip6_address,
1014                   &tc->c_rmt_ip6, clib_net_to_host_u16 (tc->c_rmt_port));
1015     }
1016
1017   return s;
1018 }
1019
1020 u8 *
1021 format_tcp_connection (u8 * s, va_list * args)
1022 {
1023   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1024   u32 verbose = va_arg (*args, u32);
1025
1026   if (!tc)
1027     return s;
1028   s = format (s, "%-50U", format_tcp_connection_id, tc);
1029   if (verbose)
1030     {
1031       s = format (s, "%-15U", format_tcp_state, tc->state);
1032       if (verbose > 1)
1033         s = format (s, "\n%U", format_tcp_vars, tc);
1034     }
1035
1036   return s;
1037 }
1038
1039 static u8 *
1040 format_tcp_session (u8 * s, va_list * args)
1041 {
1042   u32 tci = va_arg (*args, u32);
1043   u32 thread_index = va_arg (*args, u32);
1044   u32 verbose = va_arg (*args, u32);
1045   tcp_connection_t *tc;
1046
1047   tc = tcp_connection_get (tci, thread_index);
1048   if (tc)
1049     s = format (s, "%U", format_tcp_connection, tc, verbose);
1050   else
1051     s = format (s, "empty\n");
1052   return s;
1053 }
1054
1055 static u8 *
1056 format_tcp_listener_session (u8 * s, va_list * args)
1057 {
1058   u32 tci = va_arg (*args, u32);
1059   u32 __clib_unused thread_index = va_arg (*args, u32);
1060   u32 verbose = va_arg (*args, u32);
1061   tcp_connection_t *tc = tcp_listener_get (tci);
1062   s = format (s, "%-50U", format_tcp_connection_id, tc);
1063   if (verbose)
1064     s = format (s, "%-15U", format_tcp_state, tc->state);
1065   return s;
1066 }
1067
1068 static u8 *
1069 format_tcp_half_open_session (u8 * s, va_list * args)
1070 {
1071   u32 tci = va_arg (*args, u32);
1072   u32 __clib_unused thread_index = va_arg (*args, u32);
1073   tcp_connection_t *tc = tcp_half_open_connection_get (tci);
1074   return format (s, "%U", format_tcp_connection_id, tc);
1075 }
1076
1077 u8 *
1078 format_tcp_sacks (u8 * s, va_list * args)
1079 {
1080   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1081   sack_block_t *sacks = tc->snd_sacks;
1082   sack_block_t *block;
1083   int i, len = 0;
1084
1085   len = vec_len (sacks);
1086   for (i = 0; i < len - 1; i++)
1087     {
1088       block = &sacks[i];
1089       s = format (s, " start %u end %u\n", block->start - tc->irs,
1090                   block->end - tc->irs);
1091     }
1092   if (len)
1093     {
1094       block = &sacks[len - 1];
1095       s = format (s, " start %u end %u", block->start - tc->irs,
1096                   block->end - tc->irs);
1097     }
1098   return s;
1099 }
1100
1101 u8 *
1102 format_tcp_rcv_sacks (u8 * s, va_list * args)
1103 {
1104   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1105   sack_block_t *sacks = tc->rcv_opts.sacks;
1106   sack_block_t *block;
1107   int i, len = 0;
1108
1109   len = vec_len (sacks);
1110   for (i = 0; i < len - 1; i++)
1111     {
1112       block = &sacks[i];
1113       s = format (s, " start %u end %u\n", block->start - tc->iss,
1114                   block->end - tc->iss);
1115     }
1116   if (len)
1117     {
1118       block = &sacks[len - 1];
1119       s = format (s, " start %u end %u", block->start - tc->iss,
1120                   block->end - tc->iss);
1121     }
1122   return s;
1123 }
1124
1125 static u8 *
1126 format_tcp_sack_hole (u8 * s, va_list * args)
1127 {
1128   sack_scoreboard_hole_t *hole = va_arg (*args, sack_scoreboard_hole_t *);
1129   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1130   if (tc)
1131     s = format (s, "  [%u, %u]", hole->start - tc->iss, hole->end - tc->iss);
1132   else
1133     s = format (s, "  [%u, %u]", hole->start, hole->end);
1134   return s;
1135 }
1136
1137 u8 *
1138 format_tcp_scoreboard (u8 * s, va_list * args)
1139 {
1140   sack_scoreboard_t *sb = va_arg (*args, sack_scoreboard_t *);
1141   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1142   sack_scoreboard_hole_t *hole;
1143   u32 indent = format_get_indent (s);
1144
1145   s = format (s, "sacked %u last_sacked %u lost %u last_lost %u"
1146               " rxt_sacked %u\n",
1147               sb->sacked_bytes, sb->last_sacked_bytes, sb->lost_bytes,
1148               sb->last_lost_bytes, sb->rxt_sacked);
1149   s = format (s, "%Ulast_delivered %u high_sacked %u is_reneging %u\n",
1150               format_white_space, indent, sb->last_bytes_delivered,
1151               sb->high_sacked - tc->iss, sb->is_reneging);
1152   s = format (s, "%Ucur_rxt_hole %u high_rxt %u rescue_rxt %u",
1153               format_white_space, indent, sb->cur_rxt_hole,
1154               sb->high_rxt - tc->iss, sb->rescue_rxt - tc->iss);
1155
1156   hole = scoreboard_first_hole (sb);
1157   if (hole)
1158     s = format (s, "\n%Uhead %u tail %u %u holes:\n%U", format_white_space,
1159                 indent, sb->head, sb->tail, pool_elts (sb->holes),
1160                 format_white_space, indent);
1161
1162   while (hole)
1163     {
1164       s = format (s, "%U", format_tcp_sack_hole, hole, tc);
1165       hole = scoreboard_next_hole (sb, hole);
1166     }
1167
1168   return s;
1169 }
1170
1171 static transport_connection_t *
1172 tcp_session_get_transport (u32 conn_index, u32 thread_index)
1173 {
1174   tcp_connection_t *tc = tcp_connection_get (conn_index, thread_index);
1175   if (PREDICT_FALSE (!tc))
1176     return 0;
1177   return &tc->connection;
1178 }
1179
1180 static transport_connection_t *
1181 tcp_half_open_session_get_transport (u32 conn_index)
1182 {
1183   tcp_connection_t *tc = tcp_half_open_connection_get (conn_index);
1184   return &tc->connection;
1185 }
1186
1187 static u16
1188 tcp_session_cal_goal_size (tcp_connection_t * tc)
1189 {
1190   u16 goal_size = tc->snd_mss;
1191
1192   goal_size = TCP_MAX_GSO_SZ - tc->snd_mss % TCP_MAX_GSO_SZ;
1193   goal_size = clib_min (goal_size, tc->snd_wnd / 2);
1194
1195   return goal_size > tc->snd_mss ? goal_size : tc->snd_mss;
1196 }
1197
1198 /**
1199  * Compute maximum segment size for session layer.
1200  *
1201  * Since the result needs to be the actual data length, it first computes
1202  * the tcp options to be used in the next burst and subtracts their
1203  * length from the connection's snd_mss.
1204  */
1205 static u16
1206 tcp_session_send_mss (transport_connection_t * trans_conn)
1207 {
1208   tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1209
1210   /* Ensure snd_mss does accurately reflect the amount of data we can push
1211    * in a segment. This also makes sure that options are updated according to
1212    * the current state of the connection. */
1213   tcp_update_burst_snd_vars (tc);
1214
1215   if (PREDICT_FALSE (tc->cfg_flags & TCP_CFG_F_TSO))
1216     return tcp_session_cal_goal_size (tc);
1217
1218   return tc->snd_mss;
1219 }
1220
1221 always_inline u32
1222 tcp_round_snd_space (tcp_connection_t * tc, u32 snd_space)
1223 {
1224   if (PREDICT_FALSE (tc->snd_wnd < tc->snd_mss))
1225     {
1226       return tc->snd_wnd <= snd_space ? tc->snd_wnd : 0;
1227     }
1228
1229   /* If not snd_wnd constrained and we can't write at least a segment,
1230    * don't try at all */
1231   if (PREDICT_FALSE (snd_space < tc->snd_mss))
1232     return snd_space < tc->cwnd ? 0 : snd_space;
1233
1234   /* round down to mss multiple */
1235   return snd_space - (snd_space % tc->snd_mss);
1236 }
1237
1238 /**
1239  * Compute tx window session is allowed to fill.
1240  *
1241  * Takes into account available send space, snd_mss and the congestion
1242  * state of the connection. If possible, the value returned is a multiple
1243  * of snd_mss.
1244  *
1245  * @param tc tcp connection
1246  * @return number of bytes session is allowed to write
1247  */
1248 static inline u32
1249 tcp_snd_space_inline (tcp_connection_t * tc)
1250 {
1251   int snd_space;
1252
1253   if (PREDICT_FALSE (tcp_in_fastrecovery (tc)
1254                      || tc->state == TCP_STATE_CLOSED))
1255     return 0;
1256
1257   snd_space = tcp_available_output_snd_space (tc);
1258
1259   /* If we got dupacks or sacked bytes but we're not yet in recovery, try
1260    * to force the peer to send enough dupacks to start retransmitting as
1261    * per Limited Transmit (RFC3042)
1262    */
1263   if (PREDICT_FALSE (tc->rcv_dupacks != 0 || tc->sack_sb.sacked_bytes))
1264     {
1265       if (tc->limited_transmit != tc->snd_nxt
1266           && (seq_lt (tc->limited_transmit, tc->snd_nxt - 2 * tc->snd_mss)
1267               || seq_gt (tc->limited_transmit, tc->snd_nxt)))
1268         tc->limited_transmit = tc->snd_nxt;
1269
1270       ASSERT (seq_leq (tc->limited_transmit, tc->snd_nxt));
1271
1272       int snt_limited = tc->snd_nxt - tc->limited_transmit;
1273       snd_space = clib_max ((int) 2 * tc->snd_mss - snt_limited, 0);
1274     }
1275   return tcp_round_snd_space (tc, snd_space);
1276 }
1277
1278 u32
1279 tcp_snd_space (tcp_connection_t * tc)
1280 {
1281   return tcp_snd_space_inline (tc);
1282 }
1283
1284 static u32
1285 tcp_session_send_space (transport_connection_t * trans_conn)
1286 {
1287   tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1288   return clib_min (tcp_snd_space_inline (tc),
1289                    tc->snd_wnd - (tc->snd_nxt - tc->snd_una));
1290 }
1291
1292 static u32
1293 tcp_session_tx_fifo_offset (transport_connection_t * trans_conn)
1294 {
1295   tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1296
1297   ASSERT (seq_geq (tc->snd_nxt, tc->snd_una));
1298
1299   /* This still works if fast retransmit is on */
1300   return (tc->snd_nxt - tc->snd_una);
1301 }
1302
1303 static void
1304 tcp_timer_waitclose_handler (tcp_connection_t * tc)
1305 {
1306   tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
1307
1308   switch (tc->state)
1309     {
1310     case TCP_STATE_CLOSE_WAIT:
1311       tcp_connection_timers_reset (tc);
1312       /* App never returned with a close */
1313       if (!(tc->flags & TCP_CONN_FINPNDG))
1314         {
1315           tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1316           session_transport_closed_notify (&tc->connection);
1317           tcp_program_cleanup (wrk, tc);
1318           tcp_workerp_stats_inc (wrk, to_closewait, 1);
1319           break;
1320         }
1321
1322       /* Send FIN either way and switch to LAST_ACK. */
1323       tcp_cong_recovery_off (tc);
1324       /* Make sure we don't try to send unsent data */
1325       tc->snd_nxt = tc->snd_una;
1326       tcp_send_fin (tc);
1327       tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
1328       session_transport_closed_notify (&tc->connection);
1329
1330       /* Make sure we don't wait in LAST ACK forever */
1331       tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.lastack_time);
1332       tcp_workerp_stats_inc (wrk, to_closewait2, 1);
1333
1334       /* Don't delete the connection yet */
1335       break;
1336     case TCP_STATE_FIN_WAIT_1:
1337       tcp_connection_timers_reset (tc);
1338       if (tc->flags & TCP_CONN_FINPNDG)
1339         {
1340           /* If FIN pending, we haven't sent everything, but we did try.
1341            * Notify session layer that transport is closed. */
1342           tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1343           tcp_send_reset (tc);
1344           tcp_program_cleanup (wrk, tc);
1345         }
1346       else
1347         {
1348           /* We've sent the fin but no progress. Close the connection and
1349            * to make sure everything is flushed, setup a cleanup timer */
1350           tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1351           tcp_program_cleanup (wrk, tc);
1352         }
1353       session_transport_closed_notify (&tc->connection);
1354       tcp_workerp_stats_inc (wrk, to_finwait1, 1);
1355       break;
1356     case TCP_STATE_LAST_ACK:
1357       tcp_connection_timers_reset (tc);
1358       tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1359       session_transport_closed_notify (&tc->connection);
1360       tcp_program_cleanup (wrk, tc);
1361       tcp_workerp_stats_inc (wrk, to_lastack, 1);
1362       break;
1363     case TCP_STATE_CLOSING:
1364       tcp_connection_timers_reset (tc);
1365       tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1366       session_transport_closed_notify (&tc->connection);
1367       tcp_program_cleanup (wrk, tc);
1368       tcp_workerp_stats_inc (wrk, to_closing, 1);
1369       break;
1370     case TCP_STATE_FIN_WAIT_2:
1371       tcp_send_reset (tc);
1372       tcp_connection_timers_reset (tc);
1373       tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1374       session_transport_closed_notify (&tc->connection);
1375       tcp_program_cleanup (wrk, tc);
1376       tcp_workerp_stats_inc (wrk, to_finwait2, 1);
1377       break;
1378     case TCP_STATE_TIME_WAIT:
1379       tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1380       tcp_program_cleanup (wrk, tc);
1381       break;
1382     default:
1383       clib_warning ("waitclose in state: %U", format_tcp_state, tc->state);
1384       break;
1385     }
1386 }
1387
1388 /* *INDENT-OFF* */
1389 static timer_expiration_handler *timer_expiration_handlers[TCP_N_TIMERS] =
1390 {
1391     tcp_timer_retransmit_handler,
1392     tcp_timer_delack_handler,
1393     tcp_timer_persist_handler,
1394     tcp_timer_waitclose_handler,
1395     tcp_timer_retransmit_syn_handler,
1396 };
1397 /* *INDENT-ON* */
1398
1399 static void
1400 tcp_dispatch_pending_timers (tcp_worker_ctx_t * wrk)
1401 {
1402   u32 n_timers, connection_index, timer_id, thread_index, timer_handle;
1403   tcp_connection_t *tc;
1404   int i;
1405
1406   if (!(n_timers = clib_fifo_elts (wrk->pending_timers)))
1407     return;
1408
1409   thread_index = wrk->vm->thread_index;
1410   for (i = 0; i < clib_min (n_timers, wrk->max_timers_per_loop); i++)
1411     {
1412       clib_fifo_sub1 (wrk->pending_timers, timer_handle);
1413       connection_index = timer_handle & 0x0FFFFFFF;
1414       timer_id = timer_handle >> 28;
1415
1416       if (PREDICT_TRUE (timer_id != TCP_TIMER_RETRANSMIT_SYN))
1417         tc = tcp_connection_get (connection_index, thread_index);
1418       else
1419         tc = tcp_half_open_connection_get (connection_index);
1420
1421       if (PREDICT_FALSE (!tc))
1422         continue;
1423
1424       /* Skip timer if it was rearmed while pending dispatch */
1425       if (PREDICT_FALSE (tc->timers[timer_id] != TCP_TIMER_HANDLE_INVALID))
1426         continue;
1427
1428       (*timer_expiration_handlers[timer_id]) (tc);
1429     }
1430
1431   if (thread_index == 0 && clib_fifo_elts (wrk->pending_timers))
1432     vlib_process_signal_event_mt (wrk->vm, session_queue_process_node.index,
1433                                   SESSION_Q_PROCESS_FLUSH_FRAMES, 0);
1434 }
1435
1436 /**
1437  * Flush ip lookup tx frames populated by timer pops
1438  */
1439 static void
1440 tcp_flush_frames_to_output (tcp_worker_ctx_t * wrk)
1441 {
1442   if (wrk->ip_lookup_tx_frames[0])
1443     {
1444       vlib_put_frame_to_node (wrk->vm, ip4_lookup_node.index,
1445                               wrk->ip_lookup_tx_frames[0]);
1446       wrk->ip_lookup_tx_frames[0] = 0;
1447     }
1448   if (wrk->ip_lookup_tx_frames[1])
1449     {
1450       vlib_put_frame_to_node (wrk->vm, ip6_lookup_node.index,
1451                               wrk->ip_lookup_tx_frames[1]);
1452       wrk->ip_lookup_tx_frames[1] = 0;
1453     }
1454 }
1455
1456 static void
1457 tcp_handle_cleanups (tcp_worker_ctx_t * wrk, clib_time_type_t now)
1458 {
1459   u32 thread_index = wrk->vm->thread_index;
1460   tcp_cleanup_req_t *req;
1461   tcp_connection_t *tc;
1462
1463   while (clib_fifo_elts (wrk->pending_cleanups))
1464     {
1465       req = clib_fifo_head (wrk->pending_cleanups);
1466       if (req->free_time > now)
1467         break;
1468       clib_fifo_sub2 (wrk->pending_cleanups, req);
1469       tc = tcp_connection_get (req->connection_index, thread_index);
1470       if (PREDICT_FALSE (!tc))
1471         continue;
1472       session_transport_delete_notify (&tc->connection);
1473       tcp_connection_cleanup (tc);
1474     }
1475 }
1476
1477 static void
1478 tcp_update_time (f64 now, u8 thread_index)
1479 {
1480   tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
1481
1482   tcp_set_time_now (wrk);
1483   tcp_handle_cleanups (wrk, now);
1484   tw_timer_expire_timers_16t_2w_512sl (&wrk->timer_wheel, now);
1485   tcp_dispatch_pending_timers (wrk);
1486   tcp_flush_frames_to_output (wrk);
1487 }
1488
1489 static void
1490 tcp_session_flush_data (transport_connection_t * tconn)
1491 {
1492   tcp_connection_t *tc = (tcp_connection_t *) tconn;
1493   if (tc->flags & TCP_CONN_PSH_PENDING)
1494     return;
1495   tc->flags |= TCP_CONN_PSH_PENDING;
1496   tc->psh_seq = tc->snd_una + transport_max_tx_dequeue (tconn) - 1;
1497 }
1498
1499 /* *INDENT-OFF* */
1500 const static transport_proto_vft_t tcp_proto = {
1501   .enable = vnet_tcp_enable_disable,
1502   .start_listen = tcp_session_bind,
1503   .stop_listen = tcp_session_unbind,
1504   .push_header = tcp_session_push_header,
1505   .get_connection = tcp_session_get_transport,
1506   .get_listener = tcp_session_get_listener,
1507   .get_half_open = tcp_half_open_session_get_transport,
1508   .connect = tcp_session_open,
1509   .close = tcp_session_close,
1510   .cleanup = tcp_session_cleanup,
1511   .reset = tcp_session_reset,
1512   .send_mss = tcp_session_send_mss,
1513   .send_space = tcp_session_send_space,
1514   .update_time = tcp_update_time,
1515   .tx_fifo_offset = tcp_session_tx_fifo_offset,
1516   .flush_data = tcp_session_flush_data,
1517   .custom_tx = tcp_session_custom_tx,
1518   .format_connection = format_tcp_session,
1519   .format_listener = format_tcp_listener_session,
1520   .format_half_open = format_tcp_half_open_session,
1521   .transport_options = {
1522     .tx_type = TRANSPORT_TX_PEEK,
1523     .service_type = TRANSPORT_SERVICE_VC,
1524   },
1525 };
1526 /* *INDENT-ON* */
1527
1528 void
1529 tcp_connection_tx_pacer_update (tcp_connection_t * tc)
1530 {
1531   if (!transport_connection_is_tx_paced (&tc->connection))
1532     return;
1533
1534   f64 srtt = clib_min ((f64) tc->srtt * TCP_TICK, tc->mrtt_us);
1535
1536   transport_connection_tx_pacer_update (&tc->connection,
1537                                         tcp_cc_get_pacing_rate (tc),
1538                                         srtt * CLIB_US_TIME_FREQ);
1539 }
1540
1541 void
1542 tcp_connection_tx_pacer_reset (tcp_connection_t * tc, u32 window,
1543                                u32 start_bucket)
1544 {
1545   f64 srtt = clib_min ((f64) tc->srtt * TCP_TICK, tc->mrtt_us);
1546   transport_connection_tx_pacer_reset (&tc->connection,
1547                                        tcp_cc_get_pacing_rate (tc),
1548                                        start_bucket,
1549                                        srtt * CLIB_US_TIME_FREQ);
1550 }
1551
1552 static void
1553 tcp_expired_timers_dispatch (u32 * expired_timers)
1554 {
1555   u32 thread_index = vlib_get_thread_index (), n_left, max_per_loop;
1556   u32 connection_index, timer_id, n_expired, max_loops;
1557   tcp_worker_ctx_t *wrk;
1558   tcp_connection_t *tc;
1559   int i;
1560
1561   wrk = tcp_get_worker (thread_index);
1562   n_expired = vec_len (expired_timers);
1563   tcp_workerp_stats_inc (wrk, timer_expirations, n_expired);
1564   n_left = clib_fifo_elts (wrk->pending_timers);
1565
1566   /*
1567    * Invalidate all timer handles before dispatching. This avoids dangling
1568    * index references to timer wheel pool entries that have been freed.
1569    */
1570   for (i = 0; i < n_expired; i++)
1571     {
1572       connection_index = expired_timers[i] & 0x0FFFFFFF;
1573       timer_id = expired_timers[i] >> 28;
1574
1575       if (timer_id != TCP_TIMER_RETRANSMIT_SYN)
1576         tc = tcp_connection_get (connection_index, thread_index);
1577       else
1578         tc = tcp_half_open_connection_get (connection_index);
1579
1580       TCP_EVT (TCP_EVT_TIMER_POP, connection_index, timer_id);
1581
1582       tc->timers[timer_id] = TCP_TIMER_HANDLE_INVALID;
1583     }
1584
1585   clib_fifo_add (wrk->pending_timers, expired_timers, n_expired);
1586
1587   max_loops = clib_max (1, 0.5 * TCP_TIMER_TICK * wrk->vm->loops_per_second);
1588   max_per_loop = clib_max ((n_left + n_expired) / max_loops, 10);
1589   max_per_loop = clib_min (max_per_loop, VLIB_FRAME_SIZE);
1590   wrk->max_timers_per_loop = clib_max (n_left ? wrk->max_timers_per_loop : 0,
1591                                        max_per_loop);
1592
1593   if (thread_index == 0)
1594     vlib_process_signal_event_mt (wrk->vm, session_queue_process_node.index,
1595                                   SESSION_Q_PROCESS_FLUSH_FRAMES, 0);
1596 }
1597
1598 static void
1599 tcp_initialize_timer_wheels (tcp_main_t * tm)
1600 {
1601   tw_timer_wheel_16t_2w_512sl_t *tw;
1602   /* *INDENT-OFF* */
1603   foreach_vlib_main (({
1604     tw = &tm->wrk_ctx[ii].timer_wheel;
1605     tw_timer_wheel_init_16t_2w_512sl (tw, tcp_expired_timers_dispatch,
1606                                       TCP_TIMER_TICK, ~0);
1607     tw->last_run_time = vlib_time_now (this_vlib_main);
1608   }));
1609   /* *INDENT-ON* */
1610 }
1611
1612 static void
1613 tcp_initialize_iss_seed (tcp_main_t * tm)
1614 {
1615   u32 default_seed = random_default_seed ();
1616   u64 time_now = clib_cpu_time_now ();
1617
1618   tm->iss_seed.first = (u64) random_u32 (&default_seed) << 32;
1619   tm->iss_seed.second = random_u64 (&time_now);
1620 }
1621
1622 static clib_error_t *
1623 tcp_main_enable (vlib_main_t * vm)
1624 {
1625   vlib_thread_main_t *vtm = vlib_get_thread_main ();
1626   u32 num_threads, n_workers, prealloc_conn_per_wrk;
1627   tcp_connection_t *tc __attribute__ ((unused));
1628   tcp_main_t *tm = vnet_get_tcp_main ();
1629   tcp_worker_ctx_t *wrk;
1630   clib_error_t *error = 0;
1631   int thread;
1632
1633   if ((error = vlib_call_init_function (vm, ip_main_init)))
1634     return error;
1635   if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
1636     return error;
1637   if ((error = vlib_call_init_function (vm, ip6_lookup_init)))
1638     return error;
1639
1640   /*
1641    * Registrations
1642    */
1643
1644   ip4_register_protocol (IP_PROTOCOL_TCP, tcp4_input_node.index);
1645   ip6_register_protocol (IP_PROTOCOL_TCP, tcp6_input_node.index);
1646
1647   /*
1648    * Initialize data structures
1649    */
1650
1651   num_threads = 1 /* main thread */  + vtm->n_threads;
1652   vec_validate (tm->wrk_ctx, num_threads - 1);
1653   n_workers = num_threads == 1 ? 1 : vtm->n_threads;
1654   prealloc_conn_per_wrk = tcp_cfg.preallocated_connections / n_workers;
1655
1656   for (thread = 0; thread < num_threads; thread++)
1657     {
1658       wrk = &tm->wrk_ctx[thread];
1659
1660       vec_validate (wrk->pending_deq_acked, 255);
1661       vec_validate (wrk->pending_disconnects, 255);
1662       vec_validate (wrk->pending_resets, 255);
1663       vec_reset_length (wrk->pending_deq_acked);
1664       vec_reset_length (wrk->pending_disconnects);
1665       vec_reset_length (wrk->pending_resets);
1666       wrk->vm = vlib_mains[thread];
1667       wrk->max_timers_per_loop = 10;
1668
1669       /*
1670        * Preallocate connections. Assume that thread 0 won't
1671        * use preallocated threads when running multi-core
1672        */
1673       if ((thread > 0 || num_threads == 1) && prealloc_conn_per_wrk)
1674         pool_init_fixed (wrk->connections, prealloc_conn_per_wrk);
1675     }
1676
1677   /*
1678    * Use a preallocated half-open connection pool?
1679    */
1680   if (tcp_cfg.preallocated_half_open_connections)
1681     pool_init_fixed (tm->half_open_connections,
1682                      tcp_cfg.preallocated_half_open_connections);
1683
1684   /* Initialize clocks per tick for TCP timestamp. Used to compute
1685    * monotonically increasing timestamps. */
1686   tm->tstamp_ticks_per_clock = vm->clib_time.seconds_per_clock
1687     / TCP_TSTAMP_RESOLUTION;
1688
1689   if (num_threads > 1)
1690     {
1691       clib_spinlock_init (&tm->half_open_lock);
1692     }
1693
1694   tcp_initialize_timer_wheels (tm);
1695   tcp_initialize_iss_seed (tm);
1696
1697   tm->bytes_per_buffer = vlib_buffer_get_default_data_size (vm);
1698   tm->cc_last_type = TCP_CC_LAST;
1699   return error;
1700 }
1701
1702 clib_error_t *
1703 vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en)
1704 {
1705   if (is_en)
1706     {
1707       if (tcp_main.is_enabled)
1708         return 0;
1709
1710       return tcp_main_enable (vm);
1711     }
1712   else
1713     {
1714       tcp_main.is_enabled = 0;
1715     }
1716
1717   return 0;
1718 }
1719
1720 void
1721 tcp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add)
1722 {
1723   tcp_main_t *tm = &tcp_main;
1724   if (is_ip4)
1725     tm->punt_unknown4 = is_add;
1726   else
1727     tm->punt_unknown6 = is_add;
1728 }
1729
1730 /**
1731  * Initialize default values for tcp parameters
1732  */
1733 static void
1734 tcp_configuration_init (void)
1735 {
1736   /* Initial wnd for SYN. Fifos are not allocated at that point so use some
1737    * predefined value. For SYN-ACK we still want the scale to be computed in
1738    * the same way */
1739   tcp_cfg.max_rx_fifo = 32 << 20;
1740   tcp_cfg.min_rx_fifo = 4 << 10;
1741
1742   tcp_cfg.default_mtu = 1500;
1743   tcp_cfg.initial_cwnd_multiplier = 0;
1744   tcp_cfg.enable_tx_pacing = 1;
1745   tcp_cfg.allow_tso = 0;
1746   tcp_cfg.csum_offload = 1;
1747   tcp_cfg.cc_algo = TCP_CC_NEWRENO;
1748   tcp_cfg.rwnd_min_update_ack = 1;
1749
1750   /* Time constants defined as timer tick (100ms) multiples */
1751   tcp_cfg.delack_time = 1;      /* 0.1s */
1752   tcp_cfg.closewait_time = 20;  /* 2s */
1753   tcp_cfg.timewait_time = 100;  /* 10s */
1754   tcp_cfg.finwait1_time = 600;  /* 60s */
1755   tcp_cfg.lastack_time = 300;   /* 30s */
1756   tcp_cfg.finwait2_time = 300;  /* 30s */
1757   tcp_cfg.closing_time = 300;   /* 30s */
1758   tcp_cfg.cleanup_time = 0.1;   /* 100ms */
1759 }
1760
1761 static clib_error_t *
1762 tcp_init (vlib_main_t * vm)
1763 {
1764   tcp_main_t *tm = vnet_get_tcp_main ();
1765   ip_main_t *im = &ip_main;
1766   ip_protocol_info_t *pi;
1767
1768   /* Session layer, and by implication tcp, are disabled by default */
1769   tm->is_enabled = 0;
1770
1771   /* Register with IP for header parsing */
1772   pi = ip_get_protocol_info (im, IP_PROTOCOL_TCP);
1773   if (pi == 0)
1774     return clib_error_return (0, "TCP protocol info AWOL");
1775   pi->format_header = format_tcp_header;
1776   pi->unformat_pg_edit = unformat_pg_tcp_header;
1777
1778   /* Register as transport with session layer */
1779   transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1780                                FIB_PROTOCOL_IP4, tcp4_output_node.index);
1781   transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1782                                FIB_PROTOCOL_IP6, tcp6_output_node.index);
1783
1784   tcp_api_reference ();
1785   tcp_configuration_init ();
1786
1787   tm->cc_algo_by_name = hash_create_string (0, sizeof (uword));
1788
1789   return 0;
1790 }
1791
1792 VLIB_INIT_FUNCTION (tcp_init);
1793
1794 uword
1795 unformat_tcp_cc_algo (unformat_input_t * input, va_list * va)
1796 {
1797   tcp_cc_algorithm_type_e *result = va_arg (*va, tcp_cc_algorithm_type_e *);
1798   tcp_main_t *tm = &tcp_main;
1799   char *cc_algo_name;
1800   u8 found = 0;
1801   uword *p;
1802
1803   if (unformat (input, "%s", &cc_algo_name)
1804       && ((p = hash_get_mem (tm->cc_algo_by_name, cc_algo_name))))
1805     {
1806       *result = *p;
1807       found = 1;
1808     }
1809
1810   vec_free (cc_algo_name);
1811   return found;
1812 }
1813
1814 uword
1815 unformat_tcp_cc_algo_cfg (unformat_input_t * input, va_list * va)
1816 {
1817   tcp_main_t *tm = vnet_get_tcp_main ();
1818   tcp_cc_algorithm_t *cc_alg;
1819   unformat_input_t sub_input;
1820   int found = 0;
1821
1822   vec_foreach (cc_alg, tm->cc_algos)
1823   {
1824     if (!unformat (input, cc_alg->name))
1825       continue;
1826
1827     if (cc_alg->unformat_cfg
1828         && unformat (input, "%U", unformat_vlib_cli_sub_input, &sub_input))
1829       {
1830         if (cc_alg->unformat_cfg (&sub_input))
1831           found = 1;
1832       }
1833   }
1834   return found;
1835 }
1836
1837 static clib_error_t *
1838 tcp_config_fn (vlib_main_t * vm, unformat_input_t * input)
1839 {
1840   u32 cwnd_multiplier, tmp_time;
1841   uword memory_size;
1842
1843   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1844     {
1845       if (unformat (input, "preallocated-connections %d",
1846                     &tcp_cfg.preallocated_connections))
1847         ;
1848       else if (unformat (input, "preallocated-half-open-connections %d",
1849                          &tcp_cfg.preallocated_half_open_connections))
1850         ;
1851       else if (unformat (input, "buffer-fail-fraction %f",
1852                          &tcp_cfg.buffer_fail_fraction))
1853         ;
1854       else if (unformat (input, "max-rx-fifo %U", unformat_memory_size,
1855                          &memory_size))
1856         {
1857           if (memory_size >= 0x100000000)
1858             {
1859               return clib_error_return
1860                 (0, "max-rx-fifo %llu (0x%llx) too large", memory_size,
1861                  memory_size);
1862             }
1863           tcp_cfg.max_rx_fifo = memory_size;
1864         }
1865       else if (unformat (input, "min-rx-fifo %U", unformat_memory_size,
1866                          &memory_size))
1867         {
1868           if (memory_size >= 0x100000000)
1869             {
1870               return clib_error_return
1871                 (0, "min-rx-fifo %llu (0x%llx) too large", memory_size,
1872                  memory_size);
1873             }
1874           tcp_cfg.min_rx_fifo = memory_size;
1875         }
1876       else if (unformat (input, "mtu %u", &tcp_cfg.default_mtu))
1877         ;
1878       else if (unformat (input, "rwnd-min-update-ack %d",
1879                          &tcp_cfg.rwnd_min_update_ack))
1880         ;
1881       else if (unformat (input, "initial-cwnd-multiplier %u",
1882                          &cwnd_multiplier))
1883         tcp_cfg.initial_cwnd_multiplier = cwnd_multiplier;
1884       else if (unformat (input, "no-tx-pacing"))
1885         tcp_cfg.enable_tx_pacing = 0;
1886       else if (unformat (input, "tso"))
1887         tcp_cfg.allow_tso = 1;
1888       else if (unformat (input, "no-csum-offload"))
1889         tcp_cfg.csum_offload = 0;
1890       else if (unformat (input, "cc-algo %U", unformat_tcp_cc_algo,
1891                          &tcp_cfg.cc_algo))
1892         ;
1893       else if (unformat (input, "%U", unformat_tcp_cc_algo_cfg))
1894         ;
1895       else if (unformat (input, "closewait-time %u", &tmp_time))
1896         tcp_cfg.closewait_time = tmp_time / TCP_TIMER_TICK;
1897       else if (unformat (input, "timewait-time %u", &tmp_time))
1898         tcp_cfg.timewait_time = tmp_time / TCP_TIMER_TICK;
1899       else if (unformat (input, "finwait1-time %u", &tmp_time))
1900         tcp_cfg.finwait1_time = tmp_time / TCP_TIMER_TICK;
1901       else if (unformat (input, "finwait2-time %u", &tmp_time))
1902         tcp_cfg.finwait2_time = tmp_time / TCP_TIMER_TICK;
1903       else if (unformat (input, "lastack-time %u", &tmp_time))
1904         tcp_cfg.lastack_time = tmp_time / TCP_TIMER_TICK;
1905       else if (unformat (input, "closing-time %u", &tmp_time))
1906         tcp_cfg.closing_time = tmp_time / TCP_TIMER_TICK;
1907       else if (unformat (input, "cleanup-time %u", &tmp_time))
1908         tcp_cfg.cleanup_time = tmp_time / 1000.0;
1909       else
1910         return clib_error_return (0, "unknown input `%U'",
1911                                   format_unformat_error, input);
1912     }
1913   return 0;
1914 }
1915
1916 VLIB_CONFIG_FUNCTION (tcp_config_fn, "tcp");
1917
1918
1919 /**
1920  * \brief Configure an ipv4 source address range
1921  * @param vm vlib_main_t pointer
1922  * @param start first ipv4 address in the source address range
1923  * @param end last ipv4 address in the source address range
1924  * @param table_id VRF / table ID, 0 for the default FIB
1925  * @return 0 if all OK, else an error indication from api_errno.h
1926  */
1927
1928 int
1929 tcp_configure_v4_source_address_range (vlib_main_t * vm,
1930                                        ip4_address_t * start,
1931                                        ip4_address_t * end, u32 table_id)
1932 {
1933   u32 start_host_byte_order, end_host_byte_order;
1934   fib_prefix_t prefix;
1935   fib_node_index_t fei;
1936   u32 fib_index = 0;
1937   u32 sw_if_index;
1938   int rv;
1939
1940   clib_memset (&prefix, 0, sizeof (prefix));
1941
1942   fib_index = fib_table_find (FIB_PROTOCOL_IP4, table_id);
1943
1944   if (fib_index == ~0)
1945     return VNET_API_ERROR_NO_SUCH_FIB;
1946
1947   start_host_byte_order = clib_net_to_host_u32 (start->as_u32);
1948   end_host_byte_order = clib_net_to_host_u32 (end->as_u32);
1949
1950   /* sanity check for reversed args or some such */
1951   if ((end_host_byte_order - start_host_byte_order) > (10 << 10))
1952     return VNET_API_ERROR_INVALID_ARGUMENT;
1953
1954   /* Lookup the last address, to identify the interface involved */
1955   prefix.fp_len = 32;
1956   prefix.fp_proto = FIB_PROTOCOL_IP4;
1957   memcpy (&prefix.fp_addr.ip4, end, sizeof (ip4_address_t));
1958
1959   fei = fib_table_lookup (fib_index, &prefix);
1960
1961   /* Couldn't find route to destination. Bail out. */
1962   if (fei == FIB_NODE_INDEX_INVALID)
1963     return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1964
1965   sw_if_index = fib_entry_get_resolving_interface (fei);
1966
1967   /* Configure proxy arp across the range */
1968   rv = ip4_neighbor_proxy_add (fib_index, start, end);
1969
1970   if (rv)
1971     return rv;
1972
1973   rv = ip4_neighbor_proxy_enable (sw_if_index);
1974
1975   if (rv)
1976     return rv;
1977
1978   do
1979     {
1980       dpo_id_t dpo = DPO_INVALID;
1981
1982       vec_add1 (tcp_cfg.ip4_src_addrs, start[0]);
1983
1984       /* Add local adjacencies for the range */
1985
1986       receive_dpo_add_or_lock (DPO_PROTO_IP4, ~0 /* sw_if_index */ ,
1987                                NULL, &dpo);
1988       prefix.fp_len = 32;
1989       prefix.fp_proto = FIB_PROTOCOL_IP4;
1990       prefix.fp_addr.ip4.as_u32 = start->as_u32;
1991
1992       fib_table_entry_special_dpo_update (fib_index,
1993                                           &prefix,
1994                                           FIB_SOURCE_API,
1995                                           FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1996       dpo_reset (&dpo);
1997
1998       start_host_byte_order++;
1999       start->as_u32 = clib_host_to_net_u32 (start_host_byte_order);
2000     }
2001   while (start_host_byte_order <= end_host_byte_order);
2002
2003   return 0;
2004 }
2005
2006 /**
2007  * \brief Configure an ipv6 source address range
2008  * @param vm vlib_main_t pointer
2009  * @param start first ipv6 address in the source address range
2010  * @param end last ipv6 address in the source address range
2011  * @param table_id VRF / table ID, 0 for the default FIB
2012  * @return 0 if all OK, else an error indication from api_errno.h
2013  */
2014
2015 int
2016 tcp_configure_v6_source_address_range (vlib_main_t * vm,
2017                                        ip6_address_t * start,
2018                                        ip6_address_t * end, u32 table_id)
2019 {
2020   fib_prefix_t prefix;
2021   u32 fib_index = 0;
2022   fib_node_index_t fei;
2023   u32 sw_if_index;
2024
2025   clib_memset (&prefix, 0, sizeof (prefix));
2026
2027   fib_index = fib_table_find (FIB_PROTOCOL_IP6, table_id);
2028
2029   if (fib_index == ~0)
2030     return VNET_API_ERROR_NO_SUCH_FIB;
2031
2032   while (1)
2033     {
2034       int i;
2035       ip6_address_t tmp;
2036       dpo_id_t dpo = DPO_INVALID;
2037
2038       /* Remember this address */
2039       vec_add1 (tcp_cfg.ip6_src_addrs, start[0]);
2040
2041       /* Lookup the prefix, to identify the interface involved */
2042       prefix.fp_len = 128;
2043       prefix.fp_proto = FIB_PROTOCOL_IP6;
2044       memcpy (&prefix.fp_addr.ip6, start, sizeof (ip6_address_t));
2045
2046       fei = fib_table_lookup (fib_index, &prefix);
2047
2048       /* Couldn't find route to destination. Bail out. */
2049       if (fei == FIB_NODE_INDEX_INVALID)
2050         return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
2051
2052       sw_if_index = fib_entry_get_resolving_interface (fei);
2053
2054       if (sw_if_index == (u32) ~ 0)
2055         return VNET_API_ERROR_NO_MATCHING_INTERFACE;
2056
2057       /* Add a proxy neighbor discovery entry for this address */
2058       ip6_neighbor_proxy_add (sw_if_index, start);
2059
2060       /* Add a receive adjacency for this address */
2061       receive_dpo_add_or_lock (DPO_PROTO_IP6, ~0 /* sw_if_index */ ,
2062                                NULL, &dpo);
2063
2064       fib_table_entry_special_dpo_update (fib_index,
2065                                           &prefix,
2066                                           FIB_SOURCE_API,
2067                                           FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
2068       dpo_reset (&dpo);
2069
2070       /* Done with the entire range? */
2071       if (!memcmp (start, end, sizeof (start[0])))
2072         break;
2073
2074       /* Increment the address. DGMS. */
2075       tmp = start[0];
2076       for (i = 15; i >= 0; i--)
2077         {
2078           tmp.as_u8[i] += 1;
2079           if (tmp.as_u8[i] != 0)
2080             break;
2081         }
2082       start[0] = tmp;
2083     }
2084   return 0;
2085 }
2086
2087 static clib_error_t *
2088 tcp_src_address_fn (vlib_main_t * vm,
2089                     unformat_input_t * input, vlib_cli_command_t * cmd_arg)
2090 {
2091   ip4_address_t v4start, v4end;
2092   ip6_address_t v6start, v6end;
2093   u32 table_id = 0;
2094   int v4set = 0;
2095   int v6set = 0;
2096   int rv;
2097
2098   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2099     {
2100       if (unformat (input, "%U - %U", unformat_ip4_address, &v4start,
2101                     unformat_ip4_address, &v4end))
2102         v4set = 1;
2103       else if (unformat (input, "%U", unformat_ip4_address, &v4start))
2104         {
2105           memcpy (&v4end, &v4start, sizeof (v4start));
2106           v4set = 1;
2107         }
2108       else if (unformat (input, "%U - %U", unformat_ip6_address, &v6start,
2109                          unformat_ip6_address, &v6end))
2110         v6set = 1;
2111       else if (unformat (input, "%U", unformat_ip6_address, &v6start))
2112         {
2113           memcpy (&v6end, &v6start, sizeof (v6start));
2114           v6set = 1;
2115         }
2116       else if (unformat (input, "fib-table %d", &table_id))
2117         ;
2118       else
2119         break;
2120     }
2121
2122   if (!v4set && !v6set)
2123     return clib_error_return (0, "at least one v4 or v6 address required");
2124
2125   if (v4set)
2126     {
2127       rv = tcp_configure_v4_source_address_range (vm, &v4start, &v4end,
2128                                                   table_id);
2129       switch (rv)
2130         {
2131         case 0:
2132           break;
2133
2134         case VNET_API_ERROR_NO_SUCH_FIB:
2135           return clib_error_return (0, "Invalid table-id %d", table_id);
2136
2137         case VNET_API_ERROR_INVALID_ARGUMENT:
2138           return clib_error_return (0, "Invalid address range %U - %U",
2139                                     format_ip4_address, &v4start,
2140                                     format_ip4_address, &v4end);
2141         default:
2142           return clib_error_return (0, "error %d", rv);
2143           break;
2144         }
2145     }
2146   if (v6set)
2147     {
2148       rv = tcp_configure_v6_source_address_range (vm, &v6start, &v6end,
2149                                                   table_id);
2150       switch (rv)
2151         {
2152         case 0:
2153           break;
2154
2155         case VNET_API_ERROR_NO_SUCH_FIB:
2156           return clib_error_return (0, "Invalid table-id %d", table_id);
2157
2158         default:
2159           return clib_error_return (0, "error %d", rv);
2160           break;
2161         }
2162     }
2163   return 0;
2164 }
2165
2166 /* *INDENT-OFF* */
2167 VLIB_CLI_COMMAND (tcp_src_address_command, static) =
2168 {
2169   .path = "tcp src-address",
2170   .short_help = "tcp src-address <ip-addr> [- <ip-addr>] add src address range",
2171   .function = tcp_src_address_fn,
2172 };
2173 /* *INDENT-ON* */
2174
2175 static u8 *
2176 tcp_scoreboard_dump_trace (u8 * s, sack_scoreboard_t * sb)
2177 {
2178 #if TCP_SCOREBOARD_TRACE
2179
2180   scoreboard_trace_elt_t *block;
2181   int i = 0;
2182
2183   if (!sb->trace)
2184     return s;
2185
2186   s = format (s, "scoreboard trace:");
2187   vec_foreach (block, sb->trace)
2188   {
2189     s = format (s, "{%u, %u, %u, %u, %u}, ", block->start, block->end,
2190                 block->ack, block->snd_una_max, block->group);
2191     if ((++i % 3) == 0)
2192       s = format (s, "\n");
2193   }
2194   return s;
2195 #else
2196   return 0;
2197 #endif
2198 }
2199
2200 static clib_error_t *
2201 tcp_show_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
2202                               vlib_cli_command_t * cmd_arg)
2203 {
2204   transport_connection_t *tconn = 0;
2205   tcp_connection_t *tc;
2206   u8 *s = 0;
2207   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2208     {
2209       if (unformat (input, "%U", unformat_transport_connection, &tconn,
2210                     TRANSPORT_PROTO_TCP))
2211         ;
2212       else
2213         return clib_error_return (0, "unknown input `%U'",
2214                                   format_unformat_error, input);
2215     }
2216
2217   if (!TCP_SCOREBOARD_TRACE)
2218     {
2219       vlib_cli_output (vm, "scoreboard tracing not enabled");
2220       return 0;
2221     }
2222
2223   tc = tcp_get_connection_from_transport (tconn);
2224   s = tcp_scoreboard_dump_trace (s, &tc->sack_sb);
2225   vlib_cli_output (vm, "%v", s);
2226   return 0;
2227 }
2228
2229 /* *INDENT-OFF* */
2230 VLIB_CLI_COMMAND (tcp_show_scoreboard_trace_command, static) =
2231 {
2232   .path = "show tcp scoreboard trace",
2233   .short_help = "show tcp scoreboard trace <connection>",
2234   .function = tcp_show_scoreboard_trace_fn,
2235 };
2236 /* *INDENT-ON* */
2237
2238 u8 *
2239 tcp_scoreboard_replay (u8 * s, tcp_connection_t * tc, u8 verbose)
2240 {
2241   int i, trace_len;
2242   scoreboard_trace_elt_t *trace;
2243   u32 next_ack, left, group, has_new_ack = 0;
2244   tcp_connection_t _dummy_tc, *dummy_tc = &_dummy_tc;
2245   sack_block_t *block;
2246
2247   if (!TCP_SCOREBOARD_TRACE)
2248     {
2249       s = format (s, "scoreboard tracing not enabled");
2250       return s;
2251     }
2252
2253   if (!tc)
2254     return s;
2255
2256   clib_memset (dummy_tc, 0, sizeof (*dummy_tc));
2257   tcp_connection_timers_init (dummy_tc);
2258   scoreboard_init (&dummy_tc->sack_sb);
2259   dummy_tc->rcv_opts.flags |= TCP_OPTS_FLAG_SACK;
2260
2261 #if TCP_SCOREBOARD_TRACE
2262   trace = tc->sack_sb.trace;
2263   trace_len = vec_len (tc->sack_sb.trace);
2264 #endif
2265
2266   for (i = 0; i < trace_len; i++)
2267     {
2268       if (trace[i].ack != 0)
2269         {
2270           dummy_tc->snd_una = trace[i].ack - 1448;
2271           dummy_tc->snd_una_max = trace[i].ack;
2272         }
2273     }
2274
2275   left = 0;
2276   while (left < trace_len)
2277     {
2278       group = trace[left].group;
2279       vec_reset_length (dummy_tc->rcv_opts.sacks);
2280       has_new_ack = 0;
2281       while (trace[left].group == group)
2282         {
2283           if (trace[left].ack != 0)
2284             {
2285               if (verbose)
2286                 s = format (s, "Adding ack %u, snd_una_max %u, segs: ",
2287                             trace[left].ack, trace[left].snd_una_max);
2288               dummy_tc->snd_una_max = trace[left].snd_una_max;
2289               next_ack = trace[left].ack;
2290               has_new_ack = 1;
2291             }
2292           else
2293             {
2294               if (verbose)
2295                 s = format (s, "[%u, %u], ", trace[left].start,
2296                             trace[left].end);
2297               vec_add2 (dummy_tc->rcv_opts.sacks, block, 1);
2298               block->start = trace[left].start;
2299               block->end = trace[left].end;
2300             }
2301           left++;
2302         }
2303
2304       /* Push segments */
2305       tcp_rcv_sacks (dummy_tc, next_ack);
2306       if (has_new_ack)
2307         dummy_tc->snd_una = next_ack;
2308
2309       if (verbose)
2310         s = format (s, "result: %U", format_tcp_scoreboard,
2311                     &dummy_tc->sack_sb);
2312
2313     }
2314   s = format (s, "result: %U", format_tcp_scoreboard, &dummy_tc->sack_sb);
2315
2316   return s;
2317 }
2318
2319 static clib_error_t *
2320 tcp_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
2321                          vlib_cli_command_t * cmd_arg)
2322 {
2323   transport_connection_t *tconn = 0;
2324   tcp_connection_t *tc = 0;
2325   u8 *str = 0;
2326   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2327     {
2328       if (unformat (input, "%U", unformat_transport_connection, &tconn,
2329                     TRANSPORT_PROTO_TCP))
2330         ;
2331       else
2332         return clib_error_return (0, "unknown input `%U'",
2333                                   format_unformat_error, input);
2334     }
2335
2336   if (!TCP_SCOREBOARD_TRACE)
2337     {
2338       vlib_cli_output (vm, "scoreboard tracing not enabled");
2339       return 0;
2340     }
2341
2342   tc = tcp_get_connection_from_transport (tconn);
2343   if (!tc)
2344     {
2345       vlib_cli_output (vm, "connection not found");
2346       return 0;
2347     }
2348   str = tcp_scoreboard_replay (str, tc, 1);
2349   vlib_cli_output (vm, "%v", str);
2350   return 0;
2351 }
2352
2353 /* *INDENT-OFF* */
2354 VLIB_CLI_COMMAND (tcp_replay_scoreboard_command, static) =
2355 {
2356   .path = "tcp replay scoreboard",
2357   .short_help = "tcp replay scoreboard <connection>",
2358   .function = tcp_scoreboard_trace_fn,
2359 };
2360 /* *INDENT-ON* */
2361
2362 static clib_error_t *
2363 show_tcp_punt_fn (vlib_main_t * vm, unformat_input_t * input,
2364                   vlib_cli_command_t * cmd_arg)
2365 {
2366   tcp_main_t *tm = vnet_get_tcp_main ();
2367   if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2368     return clib_error_return (0, "unknown input `%U'", format_unformat_error,
2369                               input);
2370   vlib_cli_output (vm, "IPv4 TCP punt: %s",
2371                    tm->punt_unknown4 ? "enabled" : "disabled");
2372   vlib_cli_output (vm, "IPv6 TCP punt: %s",
2373                    tm->punt_unknown6 ? "enabled" : "disabled");
2374   return 0;
2375 }
2376 /* *INDENT-OFF* */
2377 VLIB_CLI_COMMAND (show_tcp_punt_command, static) =
2378 {
2379   .path = "show tcp punt",
2380   .short_help = "show tcp punt",
2381   .function = show_tcp_punt_fn,
2382 };
2383 /* *INDENT-ON* */
2384
2385 static clib_error_t *
2386 show_tcp_stats_fn (vlib_main_t * vm, unformat_input_t * input,
2387                    vlib_cli_command_t * cmd)
2388 {
2389   tcp_main_t *tm = vnet_get_tcp_main ();
2390   tcp_worker_ctx_t *wrk;
2391   u32 thread;
2392
2393   if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2394     return clib_error_return (0, "unknown input `%U'", format_unformat_error,
2395                               input);
2396   for (thread = 0; thread < vec_len (tm->wrk_ctx); thread++)
2397     {
2398       wrk = tcp_get_worker (thread);
2399       vlib_cli_output (vm, "Thread %u:\n", thread);
2400
2401       if (clib_fifo_elts (wrk->pending_timers))
2402         vlib_cli_output (vm, " %lu pending timers",
2403                          clib_fifo_elts (wrk->pending_timers));
2404
2405 #define _(name,type,str)                                        \
2406   if (wrk->stats.name)                                          \
2407     vlib_cli_output (vm, " %lu %s", wrk->stats.name, str);
2408       foreach_tcp_wrk_stat
2409 #undef _
2410     }
2411
2412   return 0;
2413 }
2414
2415 /* *INDENT-OFF* */
2416 VLIB_CLI_COMMAND (show_tcp_stats_command, static) =
2417 {
2418   .path = "show tcp stats",
2419   .short_help = "show tcp stats",
2420   .function = show_tcp_stats_fn,
2421 };
2422 /* *INDENT-ON* */
2423
2424 static clib_error_t *
2425 clear_tcp_stats_fn (vlib_main_t * vm, unformat_input_t * input,
2426                     vlib_cli_command_t * cmd)
2427 {
2428   tcp_main_t *tm = vnet_get_tcp_main ();
2429   tcp_worker_ctx_t *wrk;
2430   u32 thread;
2431
2432   if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2433     return clib_error_return (0, "unknown input `%U'", format_unformat_error,
2434                               input);
2435
2436   for (thread = 0; thread < vec_len (tm->wrk_ctx); thread++)
2437     {
2438       wrk = tcp_get_worker (thread);
2439       clib_memset (&wrk->stats, 0, sizeof (wrk->stats));
2440     }
2441
2442   return 0;
2443 }
2444
2445 /* *INDENT-OFF* */
2446 VLIB_CLI_COMMAND (clear_tcp_stats_command, static) =
2447 {
2448   .path = "clear tcp stats",
2449   .short_help = "clear tcp stats",
2450   .function = clear_tcp_stats_fn,
2451 };
2452 /* *INDENT-ON* */
2453
2454 /*
2455  * fd.io coding-style-patch-verification: ON
2456  *
2457  * Local Variables:
2458  * eval: (c-set-style "gnu")
2459  * End:
2460  */