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