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