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