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