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