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