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