session: add explicit reset api
[vpp.git] / src / vnet / tcp / tcp.c
1 /*
2  * Copyright (c) 2016-2019 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15
16 /**
17  * @file
18  * @brief TCP host stack utilities
19  */
20
21 #include <vnet/tcp/tcp.h>
22 #include <vnet/session/session.h>
23 #include <vnet/fib/fib.h>
24 #include <vnet/dpo/load_balance.h>
25 #include <vnet/dpo/receive_dpo.h>
26 #include <vnet/ip/ip6_neighbor.h>
27 #include <math.h>
28 #include <vnet/ethernet/arp.h>
29
30 tcp_main_t tcp_main;
31
32 typedef struct
33 {
34   fib_protocol_t nh_proto;
35   vnet_link_t link_type;
36   ip46_address_t ip;
37   u32 sw_if_index;
38   u8 is_add;
39 } tcp_add_del_adj_args_t;
40
41 static void
42 tcp_add_del_adj_cb (tcp_add_del_adj_args_t * args)
43 {
44   u32 ai;
45   if (args->is_add)
46     {
47       adj_nbr_add_or_lock (args->nh_proto, args->link_type, &args->ip,
48                            args->sw_if_index);
49     }
50   else
51     {
52       ai = adj_nbr_find (FIB_PROTOCOL_IP6, VNET_LINK_IP6, &args->ip,
53                          args->sw_if_index);
54       if (ai != ADJ_INDEX_INVALID)
55         adj_unlock (ai);
56     }
57 }
58
59 static void
60 tcp_add_del_adjacency (tcp_connection_t * tc, u8 is_add)
61 {
62   tcp_add_del_adj_args_t args = {
63     .nh_proto = FIB_PROTOCOL_IP6,
64     .link_type = VNET_LINK_IP6,
65     .ip = tc->c_rmt_ip,
66     .sw_if_index = tc->sw_if_index,
67     .is_add = is_add
68   };
69   vlib_rpc_call_main_thread (tcp_add_del_adj_cb, (u8 *) & args,
70                              sizeof (args));
71 }
72
73 static void
74 tcp_cc_init (tcp_connection_t * tc)
75 {
76   tc->cc_algo->init (tc);
77 }
78
79 static void
80 tcp_cc_cleanup (tcp_connection_t * tc)
81 {
82   if (tc->cc_algo->cleanup)
83     tc->cc_algo->cleanup (tc);
84 }
85
86 void
87 tcp_cc_algo_register (tcp_cc_algorithm_type_e type,
88                       const tcp_cc_algorithm_t * vft)
89 {
90   tcp_main_t *tm = vnet_get_tcp_main ();
91   vec_validate (tm->cc_algos, type);
92
93   tm->cc_algos[type] = *vft;
94   hash_set_mem (tm->cc_algo_by_name, vft->name, type);
95 }
96
97 tcp_cc_algorithm_t *
98 tcp_cc_algo_get (tcp_cc_algorithm_type_e type)
99 {
100   tcp_main_t *tm = vnet_get_tcp_main ();
101   return &tm->cc_algos[type];
102 }
103
104 tcp_cc_algorithm_type_e
105 tcp_cc_algo_new_type (const tcp_cc_algorithm_t * vft)
106 {
107   tcp_main_t *tm = vnet_get_tcp_main ();
108   tcp_cc_algo_register (++tm->cc_last_type, vft);
109   return tm->cc_last_type;
110 }
111
112 static u32
113 tcp_connection_bind (u32 session_index, transport_endpoint_t * lcl)
114 {
115   tcp_main_t *tm = &tcp_main;
116   tcp_connection_t *listener;
117   void *iface_ip;
118
119   pool_get (tm->listener_pool, listener);
120   clib_memset (listener, 0, sizeof (*listener));
121
122   listener->c_c_index = listener - tm->listener_pool;
123   listener->c_lcl_port = lcl->port;
124
125   /* If we are provided a sw_if_index, bind using one of its ips */
126   if (ip_is_zero (&lcl->ip, 1) && lcl->sw_if_index != ENDPOINT_INVALID_INDEX)
127     {
128       if ((iface_ip = ip_interface_get_first_ip (lcl->sw_if_index,
129                                                  lcl->is_ip4)))
130         ip_set (&lcl->ip, iface_ip, lcl->is_ip4);
131     }
132   ip_copy (&listener->c_lcl_ip, &lcl->ip, lcl->is_ip4);
133   listener->c_is_ip4 = lcl->is_ip4;
134   listener->c_proto = TRANSPORT_PROTO_TCP;
135   listener->c_s_index = session_index;
136   listener->c_fib_index = lcl->fib_index;
137   listener->state = TCP_STATE_LISTEN;
138   listener->cc_algo = tcp_cc_algo_get (tcp_cfg.cc_algo);
139
140   tcp_connection_timers_init (listener);
141
142   TCP_EVT_DBG (TCP_EVT_BIND, listener);
143
144   return listener->c_c_index;
145 }
146
147 static u32
148 tcp_session_bind (u32 session_index, transport_endpoint_t * tep)
149 {
150   return tcp_connection_bind (session_index, tep);
151 }
152
153 static void
154 tcp_connection_unbind (u32 listener_index)
155 {
156   tcp_main_t *tm = vnet_get_tcp_main ();
157   tcp_connection_t *tc;
158
159   tc = pool_elt_at_index (tm->listener_pool, listener_index);
160
161   TCP_EVT_DBG (TCP_EVT_UNBIND, tc);
162
163   /* Poison the entry */
164   if (CLIB_DEBUG > 0)
165     clib_memset (tc, 0xFA, sizeof (*tc));
166
167   pool_put_index (tm->listener_pool, listener_index);
168 }
169
170 static u32
171 tcp_session_unbind (u32 listener_index)
172 {
173   tcp_connection_unbind (listener_index);
174   return 0;
175 }
176
177 static transport_connection_t *
178 tcp_session_get_listener (u32 listener_index)
179 {
180   tcp_main_t *tm = vnet_get_tcp_main ();
181   tcp_connection_t *tc;
182   tc = pool_elt_at_index (tm->listener_pool, listener_index);
183   return &tc->connection;
184 }
185
186 /**
187  * Cleanup half-open connection
188  *
189  */
190 static void
191 tcp_half_open_connection_del (tcp_connection_t * tc)
192 {
193   tcp_main_t *tm = vnet_get_tcp_main ();
194   clib_spinlock_lock_if_init (&tm->half_open_lock);
195   pool_put_index (tm->half_open_connections, tc->c_c_index);
196   if (CLIB_DEBUG)
197     clib_memset (tc, 0xFA, sizeof (*tc));
198   clib_spinlock_unlock_if_init (&tm->half_open_lock);
199 }
200
201 /**
202  * Try to cleanup half-open connection
203  *
204  * If called from a thread that doesn't own tc, the call won't have any
205  * effect.
206  *
207  * @param tc - connection to be cleaned up
208  * @return non-zero if cleanup failed.
209  */
210 int
211 tcp_half_open_connection_cleanup (tcp_connection_t * tc)
212 {
213   /* Make sure this is the owning thread */
214   if (tc->c_thread_index != vlib_get_thread_index ())
215     return 1;
216   tcp_timer_reset (tc, TCP_TIMER_RETRANSMIT_SYN);
217   tcp_half_open_connection_del (tc);
218   return 0;
219 }
220
221 static tcp_connection_t *
222 tcp_half_open_connection_new (void)
223 {
224   tcp_main_t *tm = vnet_get_tcp_main ();
225   tcp_connection_t *tc = 0;
226   ASSERT (vlib_get_thread_index () == 0);
227   pool_get (tm->half_open_connections, tc);
228   clib_memset (tc, 0, sizeof (*tc));
229   tc->c_c_index = tc - tm->half_open_connections;
230   return tc;
231 }
232
233 /**
234  * Cleans up connection state.
235  *
236  * No notifications.
237  */
238 void
239 tcp_connection_cleanup (tcp_connection_t * tc)
240 {
241   tcp_main_t *tm = &tcp_main;
242
243   TCP_EVT_DBG (TCP_EVT_DELETE, tc);
244
245   /* Cleanup local endpoint if this was an active connect */
246   transport_endpoint_cleanup (TRANSPORT_PROTO_TCP, &tc->c_lcl_ip,
247                               tc->c_lcl_port);
248
249   /* Check if connection is not yet fully established */
250   if (tc->state == TCP_STATE_SYN_SENT)
251     {
252       /* Try to remove the half-open connection. If this is not the owning
253        * thread, tc won't be removed. Retransmit or establish timers will
254        * eventually expire and call again cleanup on the right thread. */
255       if (tcp_half_open_connection_cleanup (tc))
256         tc->flags |= TCP_CONN_HALF_OPEN_DONE;
257     }
258   else
259     {
260       int thread_index = tc->c_thread_index;
261
262       /* Make sure all timers are cleared */
263       tcp_connection_timers_reset (tc);
264
265       if (!tc->c_is_ip4 && ip6_address_is_link_local_unicast (&tc->c_rmt_ip6))
266         tcp_add_del_adjacency (tc, 0);
267
268       tcp_cc_cleanup (tc);
269       vec_free (tc->snd_sacks);
270       vec_free (tc->snd_sacks_fl);
271
272       if (tc->flags & TCP_CONN_RATE_SAMPLE)
273         tcp_bt_cleanup (tc);
274
275       /* Poison the entry */
276       if (CLIB_DEBUG > 0)
277         clib_memset (tc, 0xFA, sizeof (*tc));
278       pool_put (tm->connections[thread_index], tc);
279     }
280 }
281
282 /**
283  * Connection removal.
284  *
285  * This should be called only once connection enters CLOSED state. Note
286  * that it notifies the session of the removal event, so if the goal is to
287  * just remove the connection, call tcp_connection_cleanup instead.
288  */
289 void
290 tcp_connection_del (tcp_connection_t * tc)
291 {
292   session_transport_delete_notify (&tc->connection);
293   tcp_connection_cleanup (tc);
294 }
295
296 tcp_connection_t *
297 tcp_connection_alloc (u8 thread_index)
298 {
299   tcp_main_t *tm = vnet_get_tcp_main ();
300   tcp_connection_t *tc;
301
302   pool_get (tm->connections[thread_index], tc);
303   clib_memset (tc, 0, sizeof (*tc));
304   tc->c_c_index = tc - tm->connections[thread_index];
305   tc->c_thread_index = thread_index;
306   return tc;
307 }
308
309 tcp_connection_t *
310 tcp_connection_alloc_w_base (u8 thread_index, tcp_connection_t * base)
311 {
312   tcp_main_t *tm = vnet_get_tcp_main ();
313   tcp_connection_t *tc;
314
315   pool_get (tm->connections[thread_index], tc);
316   clib_memcpy_fast (tc, base, sizeof (*tc));
317   tc->c_c_index = tc - tm->connections[thread_index];
318   tc->c_thread_index = thread_index;
319   return tc;
320 }
321
322 void
323 tcp_connection_free (tcp_connection_t * tc)
324 {
325   tcp_main_t *tm = &tcp_main;
326   if (CLIB_DEBUG)
327     {
328       u8 thread_index = tc->c_thread_index;
329       clib_memset (tc, 0xFA, sizeof (*tc));
330       pool_put (tm->connections[thread_index], tc);
331       return;
332     }
333   pool_put (tm->connections[tc->c_thread_index], tc);
334 }
335
336 /** Notify session that connection has been reset.
337  *
338  * Switch state to closed and wait for session to call cleanup.
339  */
340 void
341 tcp_connection_reset (tcp_connection_t * tc)
342 {
343   TCP_EVT_DBG (TCP_EVT_RST_RCVD, tc);
344   switch (tc->state)
345     {
346     case TCP_STATE_SYN_RCVD:
347       /* Cleanup everything. App wasn't notified yet */
348       session_transport_delete_notify (&tc->connection);
349       tcp_connection_cleanup (tc);
350       break;
351     case TCP_STATE_SYN_SENT:
352       session_stream_connect_notify (&tc->connection, 1 /* fail */ );
353       tcp_connection_cleanup (tc);
354       break;
355     case TCP_STATE_ESTABLISHED:
356       tcp_connection_timers_reset (tc);
357       /* Set the cleanup timer, in case the session layer/app don't
358        * cleanly close the connection */
359       tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.closewait_time);
360       session_transport_reset_notify (&tc->connection);
361       tcp_connection_set_state (tc, TCP_STATE_CLOSED);
362       session_transport_closed_notify (&tc->connection);
363       break;
364     case TCP_STATE_CLOSE_WAIT:
365     case TCP_STATE_FIN_WAIT_1:
366     case TCP_STATE_FIN_WAIT_2:
367     case TCP_STATE_CLOSING:
368     case TCP_STATE_LAST_ACK:
369       tcp_connection_timers_reset (tc);
370       tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.closewait_time);
371       /* Make sure we mark the session as closed. In some states we may
372        * be still trying to send data */
373       tcp_connection_set_state (tc, TCP_STATE_CLOSED);
374       session_transport_closed_notify (&tc->connection);
375       break;
376     case TCP_STATE_CLOSED:
377     case TCP_STATE_TIME_WAIT:
378       break;
379     default:
380       TCP_DBG ("reset state: %u", tc->state);
381     }
382 }
383
384 /**
385  * Begin connection closing procedure.
386  *
387  * If at the end the connection is not in CLOSED state, it is not removed.
388  * Instead, we rely on on TCP to advance through state machine to either
389  * 1) LAST_ACK (passive close) whereby when the last ACK is received
390  * tcp_connection_del is called. This notifies session of the delete and
391  * calls cleanup.
392  * 2) TIME_WAIT (active close) whereby after 2MSL the 2MSL timer triggers
393  * and cleanup is called.
394  *
395  * N.B. Half-close connections are not supported
396  */
397 void
398 tcp_connection_close (tcp_connection_t * tc)
399 {
400   TCP_EVT_DBG (TCP_EVT_CLOSE, tc);
401
402   /* Send/Program FIN if needed and switch state */
403   switch (tc->state)
404     {
405     case TCP_STATE_SYN_SENT:
406       /* Try to cleanup. If not on the right thread, mark as half-open done.
407        * Connection will be cleaned up when establish timer pops */
408       tcp_connection_cleanup (tc);
409       break;
410     case TCP_STATE_SYN_RCVD:
411       tcp_connection_timers_reset (tc);
412       tcp_send_fin (tc);
413       tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
414       tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.finwait1_time);
415       break;
416     case TCP_STATE_ESTABLISHED:
417       /* If closing with unread data, reset the connection */
418       if (transport_max_rx_dequeue (&tc->connection))
419         {
420           tcp_send_reset (tc);
421           tcp_connection_timers_reset (tc);
422           tcp_connection_set_state (tc, TCP_STATE_CLOSED);
423           tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.closewait_time);
424           session_transport_closed_notify (&tc->connection);
425           break;
426         }
427       if (!transport_max_tx_dequeue (&tc->connection))
428         tcp_send_fin (tc);
429       else
430         tc->flags |= TCP_CONN_FINPNDG;
431       tcp_connection_set_state (tc, TCP_STATE_FIN_WAIT_1);
432       /* Set a timer in case the peer stops responding. Otherwise the
433        * connection will be stuck here forever. */
434       ASSERT (tc->timers[TCP_TIMER_WAITCLOSE] == TCP_TIMER_HANDLE_INVALID);
435       tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.finwait1_time);
436       break;
437     case TCP_STATE_CLOSE_WAIT:
438       if (!transport_max_tx_dequeue (&tc->connection))
439         {
440           tcp_send_fin (tc);
441           tcp_connection_timers_reset (tc);
442           tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
443           tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.lastack_time);
444         }
445       else
446         tc->flags |= TCP_CONN_FINPNDG;
447       break;
448     case TCP_STATE_FIN_WAIT_1:
449       tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.finwait1_time);
450       break;
451     case TCP_STATE_CLOSED:
452       tcp_connection_timers_reset (tc);
453       /* Delete connection but instead of doing it now wait until next
454        * dispatch cycle to give the session layer a chance to clear
455        * unhandled events */
456       tcp_timer_update (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
457       break;
458     default:
459       TCP_DBG ("state: %u", tc->state);
460     }
461 }
462
463 static void
464 tcp_session_close (u32 conn_index, u32 thread_index)
465 {
466   tcp_connection_t *tc;
467   tc = tcp_connection_get (conn_index, thread_index);
468   tcp_connection_close (tc);
469 }
470
471 static void
472 tcp_session_cleanup (u32 conn_index, u32 thread_index)
473 {
474   tcp_connection_t *tc;
475   tc = tcp_connection_get (conn_index, thread_index);
476   tcp_connection_set_state (tc, TCP_STATE_CLOSED);
477   tcp_connection_cleanup (tc);
478 }
479
480 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_DBG (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_dbg_evt_str[] = {
780 #define _(sym, str) str,
781   foreach_tcp_dbg_evt
782 #undef _
783 };
784
785 const char *tcp_fsm_states[] = {
786 #define _(sym, str) str,
787   foreach_tcp_fsm_state
788 #undef _
789 };
790
791 u8 *
792 format_tcp_state (u8 * s, va_list * args)
793 {
794   u32 state = va_arg (*args, u32);
795
796   if (state < TCP_N_STATES)
797     s = format (s, "%s", tcp_fsm_states[state]);
798   else
799     s = format (s, "UNKNOWN (%d (0x%x))", state, state);
800   return s;
801 }
802
803 const char *tcp_connection_flags_str[] = {
804 #define _(sym, str) str,
805   foreach_tcp_connection_flag
806 #undef _
807 };
808
809 static u8 *
810 format_tcp_connection_flags (u8 * s, va_list * args)
811 {
812   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
813   int i, last = -1;
814
815   for (i = 0; i < TCP_CONN_N_FLAG_BITS; i++)
816     if (tc->flags & (1 << i))
817       last = i;
818   for (i = 0; i < last; i++)
819     {
820       if (tc->flags & (1 << i))
821         s = format (s, "%s, ", tcp_connection_flags_str[i]);
822     }
823   if (last >= 0)
824     s = format (s, "%s", tcp_connection_flags_str[last]);
825   return s;
826 }
827
828 const char *tcp_conn_timers[] = {
829 #define _(sym, str) str,
830   foreach_tcp_timer
831 #undef _
832 };
833
834 static u8 *
835 format_tcp_timers (u8 * s, va_list * args)
836 {
837   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
838   int i, last = -1;
839
840   for (i = 0; i < TCP_N_TIMERS; i++)
841     if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
842       last = i;
843
844   for (i = 0; i < last; i++)
845     {
846       if (tc->timers[i] != TCP_TIMER_HANDLE_INVALID)
847         s = format (s, "%s,", tcp_conn_timers[i]);
848     }
849
850   if (last >= 0)
851     s = format (s, "%s", tcp_conn_timers[i]);
852
853   return s;
854 }
855
856 static u8 *
857 format_tcp_congestion_status (u8 * s, va_list * args)
858 {
859   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
860   if (tcp_in_recovery (tc))
861     s = format (s, "recovery");
862   else if (tcp_in_fastrecovery (tc))
863     s = format (s, "fastrecovery");
864   else
865     s = format (s, "none");
866   return s;
867 }
868
869 static i32
870 tcp_rcv_wnd_available (tcp_connection_t * tc)
871 {
872   return (i32) tc->rcv_wnd - (tc->rcv_nxt - tc->rcv_las);
873 }
874
875 static u8 *
876 format_tcp_congestion (u8 * s, va_list * args)
877 {
878   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
879   u32 indent = format_get_indent (s);
880
881   s = format (s, "%U ", format_tcp_congestion_status, tc);
882   s = format (s, "algo %s cwnd %u ssthresh %u bytes_acked %u\n",
883               tc->cc_algo->name, tc->cwnd, tc->ssthresh, tc->bytes_acked);
884   s = format (s, "%Ucc space %u prev_cwnd %u prev_ssthresh %u rtx_bytes %u\n",
885               format_white_space, indent, tcp_available_cc_snd_space (tc),
886               tc->prev_cwnd, tc->prev_ssthresh, tc->snd_rxt_bytes);
887   s = format (s, "%Usnd_congestion %u dupack %u limited_transmit %u\n",
888               format_white_space, indent, tc->snd_congestion - tc->iss,
889               tc->rcv_dupacks, tc->limited_transmit - tc->iss);
890   return s;
891 }
892
893 static u8 *
894 format_tcp_stats (u8 * s, va_list * args)
895 {
896   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
897   u32 indent = format_get_indent (s);
898   s = format (s, "in segs %lu dsegs %lu bytes %lu dupacks %u\n",
899               tc->segs_in, tc->data_segs_in, tc->bytes_in, tc->dupacks_in);
900   s = format (s, "%Uout segs %lu dsegs %lu bytes %lu dupacks %u\n",
901               format_white_space, indent, tc->segs_out,
902               tc->data_segs_out, tc->bytes_out, tc->dupacks_out);
903   s = format (s, "%Ufr %u tr %u rxt segs %lu bytes %lu duration %.3f\n",
904               format_white_space, indent, tc->fr_occurences,
905               tc->tr_occurences, tc->segs_retrans, tc->bytes_retrans,
906               tcp_time_now_us (tc->c_thread_index) - tc->start_ts);
907   s = format (s, "%Uerr wnd data below %u above %u ack below %u above %u",
908               format_white_space, indent, tc->errors.below_data_wnd,
909               tc->errors.above_data_wnd, tc->errors.below_ack_wnd,
910               tc->errors.above_ack_wnd);
911   return s;
912 }
913
914 static u8 *
915 format_tcp_vars (u8 * s, va_list * args)
916 {
917   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
918   s = format (s, " index: %u flags: %U timers: %U\n", tc->c_c_index,
919               format_tcp_connection_flags, tc, format_tcp_timers, tc);
920   s = format (s, " snd_una %u snd_nxt %u snd_una_max %u",
921               tc->snd_una - tc->iss, tc->snd_nxt - tc->iss,
922               tc->snd_una_max - tc->iss);
923   s = format (s, " rcv_nxt %u rcv_las %u\n",
924               tc->rcv_nxt - tc->irs, tc->rcv_las - tc->irs);
925   s = format (s, " snd_wnd %u rcv_wnd %u rcv_wscale %u ",
926               tc->snd_wnd, tc->rcv_wnd, tc->rcv_wscale);
927   s = format (s, "snd_wl1 %u snd_wl2 %u\n", tc->snd_wl1 - tc->irs,
928               tc->snd_wl2 - tc->iss);
929   s = format (s, " flight size %u out space %u rcv_wnd_av %u",
930               tcp_flight_size (tc), tcp_available_output_snd_space (tc),
931               tcp_rcv_wnd_available (tc));
932   s = format (s, " tsval_recent %u\n", tc->tsval_recent);
933   s = format (s, " tsecr %u tsecr_last_ack %u tsval_recent_age %u",
934               tc->rcv_opts.tsecr, tc->tsecr_last_ack,
935               tcp_time_now () - tc->tsval_recent_age);
936   s = format (s, " snd_mss %u\n", tc->snd_mss);
937   s = format (s, " rto %u rto_boff %u srtt %u us %.3f rttvar %u rtt_ts %.4f",
938               tc->rto, tc->rto_boff, tc->srtt, tc->mrtt_us * 1000, tc->rttvar,
939               tc->rtt_ts);
940   s = format (s, " rtt_seq %u\n", tc->rtt_seq - tc->iss);
941   s = format (s, " cong:   %U", format_tcp_congestion, tc);
942
943   if (tc->state >= TCP_STATE_ESTABLISHED)
944     {
945       s = format (s, " sboard: %U\n", format_tcp_scoreboard, &tc->sack_sb,
946                   tc);
947       s = format (s, " stats: %U\n", format_tcp_stats, tc);
948     }
949   if (vec_len (tc->snd_sacks))
950     s = format (s, " sacks tx: %U\n", format_tcp_sacks, tc);
951
952   return s;
953 }
954
955 static u8 *
956 format_tcp_connection_id (u8 * s, va_list * args)
957 {
958   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
959   if (!tc)
960     return s;
961   if (tc->c_is_ip4)
962     {
963       s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
964                   tc->c_s_index, "T", format_ip4_address, &tc->c_lcl_ip4,
965                   clib_net_to_host_u16 (tc->c_lcl_port), format_ip4_address,
966                   &tc->c_rmt_ip4, clib_net_to_host_u16 (tc->c_rmt_port));
967     }
968   else
969     {
970       s = format (s, "[%d:%d][%s] %U:%d->%U:%d", tc->c_thread_index,
971                   tc->c_s_index, "T", format_ip6_address, &tc->c_lcl_ip6,
972                   clib_net_to_host_u16 (tc->c_lcl_port), format_ip6_address,
973                   &tc->c_rmt_ip6, clib_net_to_host_u16 (tc->c_rmt_port));
974     }
975
976   return s;
977 }
978
979 u8 *
980 format_tcp_connection (u8 * s, va_list * args)
981 {
982   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
983   u32 verbose = va_arg (*args, u32);
984
985   if (!tc)
986     return s;
987   s = format (s, "%-50U", format_tcp_connection_id, tc);
988   if (verbose)
989     {
990       s = format (s, "%-15U", format_tcp_state, tc->state);
991       if (verbose > 1)
992         s = format (s, "\n%U", format_tcp_vars, tc);
993     }
994
995   return s;
996 }
997
998 static u8 *
999 format_tcp_session (u8 * s, va_list * args)
1000 {
1001   u32 tci = va_arg (*args, u32);
1002   u32 thread_index = va_arg (*args, u32);
1003   u32 verbose = va_arg (*args, u32);
1004   tcp_connection_t *tc;
1005
1006   tc = tcp_connection_get (tci, thread_index);
1007   if (tc)
1008     s = format (s, "%U", format_tcp_connection, tc, verbose);
1009   else
1010     s = format (s, "empty\n");
1011   return s;
1012 }
1013
1014 static u8 *
1015 format_tcp_listener_session (u8 * s, va_list * args)
1016 {
1017   u32 tci = va_arg (*args, u32);
1018   u32 __clib_unused thread_index = va_arg (*args, u32);
1019   u32 verbose = va_arg (*args, u32);
1020   tcp_connection_t *tc = tcp_listener_get (tci);
1021   s = format (s, "%-50U", format_tcp_connection_id, tc);
1022   if (verbose)
1023     s = format (s, "%-15U", format_tcp_state, tc->state);
1024   return s;
1025 }
1026
1027 static u8 *
1028 format_tcp_half_open_session (u8 * s, va_list * args)
1029 {
1030   u32 tci = va_arg (*args, u32);
1031   u32 __clib_unused thread_index = va_arg (*args, u32);
1032   tcp_connection_t *tc = tcp_half_open_connection_get (tci);
1033   return format (s, "%U", format_tcp_connection_id, tc);
1034 }
1035
1036 u8 *
1037 format_tcp_sacks (u8 * s, va_list * args)
1038 {
1039   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1040   sack_block_t *sacks = tc->snd_sacks;
1041   sack_block_t *block;
1042   int i, len = 0;
1043
1044   len = vec_len (sacks);
1045   for (i = 0; i < len - 1; i++)
1046     {
1047       block = &sacks[i];
1048       s = format (s, " start %u end %u\n", block->start - tc->irs,
1049                   block->end - tc->irs);
1050     }
1051   if (len)
1052     {
1053       block = &sacks[len - 1];
1054       s = format (s, " start %u end %u", block->start - tc->irs,
1055                   block->end - tc->irs);
1056     }
1057   return s;
1058 }
1059
1060 u8 *
1061 format_tcp_rcv_sacks (u8 * s, va_list * args)
1062 {
1063   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1064   sack_block_t *sacks = tc->rcv_opts.sacks;
1065   sack_block_t *block;
1066   int i, len = 0;
1067
1068   len = vec_len (sacks);
1069   for (i = 0; i < len - 1; i++)
1070     {
1071       block = &sacks[i];
1072       s = format (s, " start %u end %u\n", block->start - tc->iss,
1073                   block->end - tc->iss);
1074     }
1075   if (len)
1076     {
1077       block = &sacks[len - 1];
1078       s = format (s, " start %u end %u", block->start - tc->iss,
1079                   block->end - tc->iss);
1080     }
1081   return s;
1082 }
1083
1084 static u8 *
1085 format_tcp_sack_hole (u8 * s, va_list * args)
1086 {
1087   sack_scoreboard_hole_t *hole = va_arg (*args, sack_scoreboard_hole_t *);
1088   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1089   if (tc)
1090     s = format (s, "  [%u, %u]", hole->start - tc->iss, hole->end - tc->iss);
1091   else
1092     s = format (s, "  [%u, %u]", hole->start, hole->end);
1093   return s;
1094 }
1095
1096 u8 *
1097 format_tcp_scoreboard (u8 * s, va_list * args)
1098 {
1099   sack_scoreboard_t *sb = va_arg (*args, sack_scoreboard_t *);
1100   tcp_connection_t *tc = va_arg (*args, tcp_connection_t *);
1101   sack_scoreboard_hole_t *hole;
1102   u32 indent = format_get_indent (s);
1103
1104   s = format (s, "sacked_bytes %u last_sacked_bytes %u lost_bytes %u\n",
1105               sb->sacked_bytes, sb->last_sacked_bytes, sb->lost_bytes);
1106   s = format (s, "%Ulast_bytes_delivered %u high_sacked %u snd_una_adv %u\n",
1107               format_white_space, indent, sb->last_bytes_delivered,
1108               sb->high_sacked - tc->iss, sb->snd_una_adv);
1109   s = format (s, "%Ucur_rxt_hole %u high_rxt %u rescue_rxt %u",
1110               format_white_space, indent, sb->cur_rxt_hole,
1111               sb->high_rxt - tc->iss, sb->rescue_rxt - tc->iss);
1112
1113   hole = scoreboard_first_hole (sb);
1114   if (hole)
1115     s = format (s, "\n%Uhead %u tail %u %u holes:\n%U", format_white_space,
1116                 indent, sb->head, sb->tail, pool_elts (sb->holes),
1117                 format_white_space, indent);
1118
1119   while (hole)
1120     {
1121       s = format (s, "%U", format_tcp_sack_hole, hole, tc);
1122       hole = scoreboard_next_hole (sb, hole);
1123     }
1124
1125   return s;
1126 }
1127
1128 static transport_connection_t *
1129 tcp_session_get_transport (u32 conn_index, u32 thread_index)
1130 {
1131   tcp_connection_t *tc = tcp_connection_get (conn_index, thread_index);
1132   return &tc->connection;
1133 }
1134
1135 static transport_connection_t *
1136 tcp_half_open_session_get_transport (u32 conn_index)
1137 {
1138   tcp_connection_t *tc = tcp_half_open_connection_get (conn_index);
1139   return &tc->connection;
1140 }
1141
1142 /**
1143  * Compute maximum segment size for session layer.
1144  *
1145  * Since the result needs to be the actual data length, it first computes
1146  * the tcp options to be used in the next burst and subtracts their
1147  * length from the connection's snd_mss.
1148  */
1149 static u16
1150 tcp_session_send_mss (transport_connection_t * trans_conn)
1151 {
1152   tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1153
1154   /* Ensure snd_mss does accurately reflect the amount of data we can push
1155    * in a segment. This also makes sure that options are updated according to
1156    * the current state of the connection. */
1157   tcp_update_burst_snd_vars (tc);
1158
1159   return tc->snd_mss;
1160 }
1161
1162 always_inline u32
1163 tcp_round_snd_space (tcp_connection_t * tc, u32 snd_space)
1164 {
1165   if (PREDICT_FALSE (tc->snd_wnd < tc->snd_mss))
1166     {
1167       return tc->snd_wnd <= snd_space ? tc->snd_wnd : 0;
1168     }
1169
1170   /* If not snd_wnd constrained and we can't write at least a segment,
1171    * don't try at all */
1172   if (PREDICT_FALSE (snd_space < tc->snd_mss))
1173     return snd_space < tc->cwnd ? 0 : snd_space;
1174
1175   /* round down to mss multiple */
1176   return snd_space - (snd_space % tc->snd_mss);
1177 }
1178
1179 /**
1180  * Compute tx window session is allowed to fill.
1181  *
1182  * Takes into account available send space, snd_mss and the congestion
1183  * state of the connection. If possible, the value returned is a multiple
1184  * of snd_mss.
1185  *
1186  * @param tc tcp connection
1187  * @return number of bytes session is allowed to write
1188  */
1189 static inline u32
1190 tcp_snd_space_inline (tcp_connection_t * tc)
1191 {
1192   int snd_space, snt_limited;
1193
1194   if (PREDICT_FALSE (tcp_in_fastrecovery (tc)
1195                      || tc->state == TCP_STATE_CLOSED))
1196     return 0;
1197
1198   snd_space = tcp_available_output_snd_space (tc);
1199
1200   /* If we haven't gotten dupacks or if we did and have gotten sacked
1201    * bytes then we can still send as per Limited Transmit (RFC3042) */
1202   if (PREDICT_FALSE (tc->rcv_dupacks != 0
1203                      && (tcp_opts_sack_permitted (tc)
1204                          && tc->sack_sb.last_sacked_bytes == 0)))
1205     {
1206       if (tc->rcv_dupacks == 1 && tc->limited_transmit != tc->snd_nxt)
1207         tc->limited_transmit = tc->snd_nxt;
1208       ASSERT (seq_leq (tc->limited_transmit, tc->snd_nxt));
1209
1210       snt_limited = tc->snd_nxt - tc->limited_transmit;
1211       snd_space = clib_max (2 * tc->snd_mss - snt_limited, 0);
1212     }
1213   return tcp_round_snd_space (tc, snd_space);
1214 }
1215
1216 u32
1217 tcp_snd_space (tcp_connection_t * tc)
1218 {
1219   return tcp_snd_space_inline (tc);
1220 }
1221
1222 static u32
1223 tcp_session_send_space (transport_connection_t * trans_conn)
1224 {
1225   tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1226   return clib_min (tcp_snd_space_inline (tc),
1227                    tc->snd_wnd - (tc->snd_nxt - tc->snd_una));
1228 }
1229
1230 static u32
1231 tcp_session_tx_fifo_offset (transport_connection_t * trans_conn)
1232 {
1233   tcp_connection_t *tc = (tcp_connection_t *) trans_conn;
1234
1235   ASSERT (seq_geq (tc->snd_nxt, tc->snd_una));
1236
1237   /* This still works if fast retransmit is on */
1238   return (tc->snd_nxt - tc->snd_una);
1239 }
1240
1241 static void
1242 tcp_update_time (f64 now, u8 thread_index)
1243 {
1244   tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
1245
1246   tcp_set_time_now (wrk);
1247   tw_timer_expire_timers_16t_2w_512sl (&wrk->timer_wheel, now);
1248   tcp_flush_frames_to_output (wrk);
1249 }
1250
1251 static void
1252 tcp_session_flush_data (transport_connection_t * tconn)
1253 {
1254   tcp_connection_t *tc = (tcp_connection_t *) tconn;
1255   if (tc->flags & TCP_CONN_PSH_PENDING)
1256     return;
1257   tc->flags |= TCP_CONN_PSH_PENDING;
1258   tc->psh_seq = tc->snd_una + transport_max_tx_dequeue (tconn) - 1;
1259 }
1260
1261 /* *INDENT-OFF* */
1262 const static transport_proto_vft_t tcp_proto = {
1263   .enable = vnet_tcp_enable_disable,
1264   .start_listen = tcp_session_bind,
1265   .stop_listen = tcp_session_unbind,
1266   .push_header = tcp_session_push_header,
1267   .get_connection = tcp_session_get_transport,
1268   .get_listener = tcp_session_get_listener,
1269   .get_half_open = tcp_half_open_session_get_transport,
1270   .connect = tcp_session_open,
1271   .close = tcp_session_close,
1272   .cleanup = tcp_session_cleanup,
1273   .reset = tcp_session_reset,
1274   .send_mss = tcp_session_send_mss,
1275   .send_space = tcp_session_send_space,
1276   .update_time = tcp_update_time,
1277   .tx_fifo_offset = tcp_session_tx_fifo_offset,
1278   .flush_data = tcp_session_flush_data,
1279   .custom_tx = tcp_session_custom_tx,
1280   .format_connection = format_tcp_session,
1281   .format_listener = format_tcp_listener_session,
1282   .format_half_open = format_tcp_half_open_session,
1283   .transport_options = {
1284     .tx_type = TRANSPORT_TX_PEEK,
1285     .service_type = TRANSPORT_SERVICE_VC,
1286   },
1287 };
1288 /* *INDENT-ON* */
1289
1290 void
1291 tcp_connection_tx_pacer_update (tcp_connection_t * tc)
1292 {
1293   if (!transport_connection_is_tx_paced (&tc->connection))
1294     return;
1295
1296   transport_connection_tx_pacer_update (&tc->connection,
1297                                         tcp_cc_get_pacing_rate (tc));
1298 }
1299
1300 void
1301 tcp_connection_tx_pacer_reset (tcp_connection_t * tc, u32 window,
1302                                u32 start_bucket)
1303 {
1304   tcp_worker_ctx_t *wrk = tcp_get_worker (tc->c_thread_index);
1305   u32 byte_rate = window / ((f64) TCP_TICK * tc->srtt);
1306   u64 last_time = wrk->vm->clib_time.last_cpu_time;
1307   transport_connection_tx_pacer_reset (&tc->connection, byte_rate,
1308                                        start_bucket, last_time);
1309 }
1310
1311 static void
1312 tcp_timer_waitclose_handler (u32 conn_index)
1313 {
1314   u32 thread_index = vlib_get_thread_index ();
1315   tcp_connection_t *tc;
1316
1317   tc = tcp_connection_get (conn_index, thread_index);
1318   if (!tc)
1319     return;
1320
1321   tc->timers[TCP_TIMER_WAITCLOSE] = TCP_TIMER_HANDLE_INVALID;
1322
1323   switch (tc->state)
1324     {
1325     case TCP_STATE_CLOSE_WAIT:
1326       tcp_connection_timers_reset (tc);
1327       session_transport_closed_notify (&tc->connection);
1328
1329       if (!(tc->flags & TCP_CONN_FINPNDG))
1330         {
1331           tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1332           tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
1333           break;
1334         }
1335
1336       /* Session didn't come back with a close. Send FIN either way
1337        * and switch to LAST_ACK. */
1338       tcp_cong_recovery_off (tc);
1339       /* Make sure we don't try to send unsent data */
1340       tc->snd_nxt = tc->snd_una;
1341       tcp_send_fin (tc);
1342       tcp_connection_set_state (tc, TCP_STATE_LAST_ACK);
1343
1344       /* Make sure we don't wait in LAST ACK forever */
1345       tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.lastack_time);
1346
1347       /* Don't delete the connection yet */
1348       break;
1349     case TCP_STATE_FIN_WAIT_1:
1350       tcp_connection_timers_reset (tc);
1351       session_transport_closed_notify (&tc->connection);
1352       if (tc->flags & TCP_CONN_FINPNDG)
1353         {
1354           /* If FIN pending, we haven't sent everything, but we did try.
1355            * Notify session layer that transport is closed. */
1356           tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1357           tcp_send_reset (tc);
1358           tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
1359         }
1360       else
1361         {
1362           /* We've sent the fin but no progress. Close the connection and
1363            * to make sure everything is flushed, setup a cleanup timer */
1364           tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1365           tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
1366         }
1367       break;
1368     case TCP_STATE_LAST_ACK:
1369     case TCP_STATE_CLOSING:
1370       tcp_connection_timers_reset (tc);
1371       tcp_connection_set_state (tc, TCP_STATE_CLOSED);
1372       tcp_timer_set (tc, TCP_TIMER_WAITCLOSE, tcp_cfg.cleanup_time);
1373       session_transport_closed_notify (&tc->connection);
1374       break;
1375     default:
1376       tcp_connection_del (tc);
1377       break;
1378     }
1379 }
1380
1381 /* *INDENT-OFF* */
1382 static timer_expiration_handler *timer_expiration_handlers[TCP_N_TIMERS] =
1383 {
1384     tcp_timer_retransmit_handler,
1385     tcp_timer_delack_handler,
1386     tcp_timer_persist_handler,
1387     tcp_timer_waitclose_handler,
1388     tcp_timer_retransmit_syn_handler,
1389 };
1390 /* *INDENT-ON* */
1391
1392 static void
1393 tcp_expired_timers_dispatch (u32 * expired_timers)
1394 {
1395   int i;
1396   u32 connection_index, timer_id;
1397
1398   for (i = 0; i < vec_len (expired_timers); i++)
1399     {
1400       /* Get session index and timer id */
1401       connection_index = expired_timers[i] & 0x0FFFFFFF;
1402       timer_id = expired_timers[i] >> 28;
1403
1404       TCP_EVT_DBG (TCP_EVT_TIMER_POP, connection_index, timer_id);
1405
1406       /* Handle expiration */
1407       (*timer_expiration_handlers[timer_id]) (connection_index);
1408     }
1409 }
1410
1411 static void
1412 tcp_initialize_timer_wheels (tcp_main_t * tm)
1413 {
1414   tw_timer_wheel_16t_2w_512sl_t *tw;
1415   /* *INDENT-OFF* */
1416   foreach_vlib_main (({
1417     tw = &tm->wrk_ctx[ii].timer_wheel;
1418     tw_timer_wheel_init_16t_2w_512sl (tw, tcp_expired_timers_dispatch,
1419                                       TCP_TIMER_TICK, ~0);
1420     tw->last_run_time = vlib_time_now (this_vlib_main);
1421   }));
1422   /* *INDENT-ON* */
1423 }
1424
1425 static void
1426 tcp_initialize_iss_seed (tcp_main_t * tm)
1427 {
1428   u32 default_seed = random_default_seed ();
1429   u64 time_now = clib_cpu_time_now ();
1430
1431   tm->iss_seed.first = (u64) random_u32 (&default_seed) << 32;
1432   tm->iss_seed.second = random_u64 (&time_now);
1433 }
1434
1435 static clib_error_t *
1436 tcp_main_enable (vlib_main_t * vm)
1437 {
1438   vlib_thread_main_t *vtm = vlib_get_thread_main ();
1439   u32 num_threads, n_workers, prealloc_conn_per_wrk;
1440   tcp_connection_t *tc __attribute__ ((unused));
1441   tcp_main_t *tm = vnet_get_tcp_main ();
1442   clib_error_t *error = 0;
1443   int thread;
1444
1445   if ((error = vlib_call_init_function (vm, ip_main_init)))
1446     return error;
1447   if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
1448     return error;
1449   if ((error = vlib_call_init_function (vm, ip6_lookup_init)))
1450     return error;
1451
1452   /*
1453    * Registrations
1454    */
1455
1456   ip4_register_protocol (IP_PROTOCOL_TCP, tcp4_input_node.index);
1457   ip6_register_protocol (IP_PROTOCOL_TCP, tcp6_input_node.index);
1458
1459   /*
1460    * Initialize data structures
1461    */
1462
1463   num_threads = 1 /* main thread */  + vtm->n_threads;
1464   vec_validate (tm->connections, num_threads - 1);
1465   vec_validate (tm->wrk_ctx, num_threads - 1);
1466   n_workers = num_threads == 1 ? 1 : vtm->n_threads;
1467   prealloc_conn_per_wrk = tcp_cfg.preallocated_connections / n_workers;
1468
1469   for (thread = 0; thread < num_threads; thread++)
1470     {
1471       vec_validate (tm->wrk_ctx[thread].pending_deq_acked, 255);
1472       vec_validate (tm->wrk_ctx[thread].pending_disconnects, 255);
1473       vec_reset_length (tm->wrk_ctx[thread].pending_deq_acked);
1474       vec_reset_length (tm->wrk_ctx[thread].pending_disconnects);
1475       tm->wrk_ctx[thread].vm = vlib_mains[thread];
1476
1477       /*
1478        * Preallocate connections. Assume that thread 0 won't
1479        * use preallocated threads when running multi-core
1480        */
1481       if ((thread > 0 || num_threads == 1) && prealloc_conn_per_wrk)
1482         pool_init_fixed (tm->connections[thread], prealloc_conn_per_wrk);
1483     }
1484
1485   /*
1486    * Use a preallocated half-open connection pool?
1487    */
1488   if (tcp_cfg.preallocated_half_open_connections)
1489     pool_init_fixed (tm->half_open_connections,
1490                      tcp_cfg.preallocated_half_open_connections);
1491
1492   /* Initialize clocks per tick for TCP timestamp. Used to compute
1493    * monotonically increasing timestamps. */
1494   tm->tstamp_ticks_per_clock = vm->clib_time.seconds_per_clock
1495     / TCP_TSTAMP_RESOLUTION;
1496
1497   if (num_threads > 1)
1498     {
1499       clib_spinlock_init (&tm->half_open_lock);
1500     }
1501
1502   tcp_initialize_timer_wheels (tm);
1503   tcp_initialize_iss_seed (tm);
1504
1505   tm->bytes_per_buffer = vlib_buffer_get_default_data_size (vm);
1506   tm->cc_last_type = TCP_CC_LAST;
1507   return error;
1508 }
1509
1510 clib_error_t *
1511 vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en)
1512 {
1513   if (is_en)
1514     {
1515       if (tcp_main.is_enabled)
1516         return 0;
1517
1518       return tcp_main_enable (vm);
1519     }
1520   else
1521     {
1522       tcp_main.is_enabled = 0;
1523     }
1524
1525   return 0;
1526 }
1527
1528 void
1529 tcp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add)
1530 {
1531   tcp_main_t *tm = &tcp_main;
1532   if (is_ip4)
1533     tm->punt_unknown4 = is_add;
1534   else
1535     tm->punt_unknown6 = is_add;
1536 }
1537
1538 /**
1539  * Initialize default values for tcp parameters
1540  */
1541 static void
1542 tcp_configuration_init (void)
1543 {
1544   /* Initial wnd for SYN. Fifos are not allocated at that point so use some
1545    * predefined value. For SYN-ACK we still want the scale to be computed in
1546    * the same way */
1547   tcp_cfg.max_rx_fifo = 32 << 20;
1548   tcp_cfg.min_rx_fifo = 4 << 10;
1549
1550   tcp_cfg.default_mtu = 1460;
1551   tcp_cfg.initial_cwnd_multiplier = 0;
1552   tcp_cfg.enable_tx_pacing = 1;
1553   tcp_cfg.cc_algo = TCP_CC_NEWRENO;
1554
1555   /* Time constants defined as timer tick (100ms) multiples */
1556   tcp_cfg.delack_time = 1;      /* 0.1s */
1557   tcp_cfg.closewait_time = 20;  /* 2s */
1558   tcp_cfg.timewait_time = 100;  /* 10s */
1559   tcp_cfg.finwait1_time = 600;  /* 60s */
1560   tcp_cfg.lastack_time = 300;   /* 30s */
1561   tcp_cfg.finwait2_time = 300;  /* 30s */
1562   tcp_cfg.closing_time = 300;   /* 30s */
1563   tcp_cfg.cleanup_time = 1;     /* 0.1s */
1564 }
1565
1566 static clib_error_t *
1567 tcp_init (vlib_main_t * vm)
1568 {
1569   tcp_main_t *tm = vnet_get_tcp_main ();
1570   ip_main_t *im = &ip_main;
1571   ip_protocol_info_t *pi;
1572
1573   /* Session layer, and by implication tcp, are disabled by default */
1574   tm->is_enabled = 0;
1575
1576   /* Register with IP for header parsing */
1577   pi = ip_get_protocol_info (im, IP_PROTOCOL_TCP);
1578   if (pi == 0)
1579     return clib_error_return (0, "TCP protocol info AWOL");
1580   pi->format_header = format_tcp_header;
1581   pi->unformat_pg_edit = unformat_pg_tcp_header;
1582
1583   /* Register as transport with session layer */
1584   transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1585                                FIB_PROTOCOL_IP4, tcp4_output_node.index);
1586   transport_register_protocol (TRANSPORT_PROTO_TCP, &tcp_proto,
1587                                FIB_PROTOCOL_IP6, tcp6_output_node.index);
1588
1589   tcp_api_reference ();
1590   tcp_configuration_init ();
1591
1592   tm->cc_algo_by_name = hash_create_string (0, sizeof (uword));
1593
1594   return 0;
1595 }
1596
1597 VLIB_INIT_FUNCTION (tcp_init);
1598
1599 uword
1600 unformat_tcp_cc_algo (unformat_input_t * input, va_list * va)
1601 {
1602   tcp_cc_algorithm_type_e *result = va_arg (*va, tcp_cc_algorithm_type_e *);
1603   tcp_main_t *tm = &tcp_main;
1604   char *cc_algo_name;
1605   u8 found = 0;
1606   uword *p;
1607
1608   if (unformat (input, "%s", &cc_algo_name)
1609       && ((p = hash_get_mem (tm->cc_algo_by_name, cc_algo_name))))
1610     {
1611       *result = *p;
1612       found = 1;
1613     }
1614
1615   vec_free (cc_algo_name);
1616   return found;
1617 }
1618
1619 uword
1620 unformat_tcp_cc_algo_cfg (unformat_input_t * input, va_list * va)
1621 {
1622   tcp_main_t *tm = vnet_get_tcp_main ();
1623   tcp_cc_algorithm_t *cc_alg;
1624   unformat_input_t sub_input;
1625   int found = 0;
1626
1627   vec_foreach (cc_alg, tm->cc_algos)
1628   {
1629     if (!unformat (input, cc_alg->name))
1630       continue;
1631
1632     if (cc_alg->unformat_cfg
1633         && unformat (input, "%U", unformat_vlib_cli_sub_input, &sub_input))
1634       {
1635         if (cc_alg->unformat_cfg (&sub_input))
1636           found = 1;
1637       }
1638   }
1639   return found;
1640 }
1641
1642 static clib_error_t *
1643 tcp_config_fn (vlib_main_t * vm, unformat_input_t * input)
1644 {
1645   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1646     {
1647       if (unformat (input, "preallocated-connections %d",
1648                     &tcp_cfg.preallocated_connections))
1649         ;
1650       else if (unformat (input, "preallocated-half-open-connections %d",
1651                          &tcp_cfg.preallocated_half_open_connections))
1652         ;
1653       else if (unformat (input, "buffer-fail-fraction %f",
1654                          &tcp_cfg.buffer_fail_fraction))
1655         ;
1656       else if (unformat (input, "max-rx-fifo %U", unformat_memory_size,
1657                          &tcp_cfg.max_rx_fifo))
1658         ;
1659       else if (unformat (input, "min-rx-fifo %U", unformat_memory_size,
1660                          &tcp_cfg.min_rx_fifo))
1661         ;
1662       else if (unformat (input, "mtu %d", &tcp_cfg.default_mtu))
1663         ;
1664       else if (unformat (input, "initial-cwnd-multiplier %d",
1665                          &tcp_cfg.initial_cwnd_multiplier))
1666         ;
1667       else if (unformat (input, "no-tx-pacing"))
1668         tcp_cfg.enable_tx_pacing = 0;
1669       else if (unformat (input, "cc-algo %U", unformat_tcp_cc_algo,
1670                          &tcp_cfg.cc_algo))
1671         ;
1672       else if (unformat (input, "%U", unformat_tcp_cc_algo_cfg))
1673         ;
1674       else if (unformat (input, "closewait-time %d", &tcp_cfg.closewait_time))
1675         tcp_cfg.closewait_time /= TCP_TIMER_TICK;
1676       else if (unformat (input, "timewait-time %d", &tcp_cfg.timewait_time))
1677         tcp_cfg.timewait_time /= TCP_TIMER_TICK;
1678       else if (unformat (input, "finwait1-time %d", &tcp_cfg.finwait1_time))
1679         tcp_cfg.finwait1_time /= TCP_TIMER_TICK;
1680       else if (unformat (input, "finwait2-time %d", &tcp_cfg.finwait2_time))
1681         tcp_cfg.finwait2_time /= TCP_TIMER_TICK;
1682       else if (unformat (input, "lastack-time %d", &tcp_cfg.lastack_time))
1683         tcp_cfg.lastack_time /= TCP_TIMER_TICK;
1684       else if (unformat (input, "closing-time %d", &tcp_cfg.closing_time))
1685         tcp_cfg.closing_time /= TCP_TIMER_TICK;
1686       else if (unformat (input, "cleanup-time %d", &tcp_cfg.cleanup_time))
1687         tcp_cfg.cleanup_time /= TCP_TIMER_TICK;
1688       else
1689         return clib_error_return (0, "unknown input `%U'",
1690                                   format_unformat_error, input);
1691     }
1692   return 0;
1693 }
1694
1695 VLIB_CONFIG_FUNCTION (tcp_config_fn, "tcp");
1696
1697
1698 /**
1699  * \brief Configure an ipv4 source address range
1700  * @param vm vlib_main_t pointer
1701  * @param start first ipv4 address in the source address range
1702  * @param end last ipv4 address in the source address range
1703  * @param table_id VRF / table ID, 0 for the default FIB
1704  * @return 0 if all OK, else an error indication from api_errno.h
1705  */
1706
1707 int
1708 tcp_configure_v4_source_address_range (vlib_main_t * vm,
1709                                        ip4_address_t * start,
1710                                        ip4_address_t * end, u32 table_id)
1711 {
1712   vnet_main_t *vnm = vnet_get_main ();
1713   u32 start_host_byte_order, end_host_byte_order;
1714   fib_prefix_t prefix;
1715   fib_node_index_t fei;
1716   u32 fib_index = 0;
1717   u32 sw_if_index;
1718   int rv;
1719
1720   clib_memset (&prefix, 0, sizeof (prefix));
1721
1722   fib_index = fib_table_find (FIB_PROTOCOL_IP4, table_id);
1723
1724   if (fib_index == ~0)
1725     return VNET_API_ERROR_NO_SUCH_FIB;
1726
1727   start_host_byte_order = clib_net_to_host_u32 (start->as_u32);
1728   end_host_byte_order = clib_net_to_host_u32 (end->as_u32);
1729
1730   /* sanity check for reversed args or some such */
1731   if ((end_host_byte_order - start_host_byte_order) > (10 << 10))
1732     return VNET_API_ERROR_INVALID_ARGUMENT;
1733
1734   /* Lookup the last address, to identify the interface involved */
1735   prefix.fp_len = 32;
1736   prefix.fp_proto = FIB_PROTOCOL_IP4;
1737   memcpy (&prefix.fp_addr.ip4, end, sizeof (ip4_address_t));
1738
1739   fei = fib_table_lookup (fib_index, &prefix);
1740
1741   /* Couldn't find route to destination. Bail out. */
1742   if (fei == FIB_NODE_INDEX_INVALID)
1743     return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1744
1745   sw_if_index = fib_entry_get_resolving_interface (fei);
1746
1747   /* Configure proxy arp across the range */
1748   rv = vnet_proxy_arp_add_del (start, end, fib_index, 0 /* is_del */ );
1749
1750   if (rv)
1751     return rv;
1752
1753   rv = vnet_proxy_arp_enable_disable (vnm, sw_if_index, 1);
1754
1755   if (rv)
1756     return rv;
1757
1758   do
1759     {
1760       dpo_id_t dpo = DPO_INVALID;
1761
1762       vec_add1 (tcp_cfg.ip4_src_addrs, start[0]);
1763
1764       /* Add local adjacencies for the range */
1765
1766       receive_dpo_add_or_lock (DPO_PROTO_IP4, ~0 /* sw_if_index */ ,
1767                                NULL, &dpo);
1768       prefix.fp_len = 32;
1769       prefix.fp_proto = FIB_PROTOCOL_IP4;
1770       prefix.fp_addr.ip4.as_u32 = start->as_u32;
1771
1772       fib_table_entry_special_dpo_update (fib_index,
1773                                           &prefix,
1774                                           FIB_SOURCE_API,
1775                                           FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1776       dpo_reset (&dpo);
1777
1778       start_host_byte_order++;
1779       start->as_u32 = clib_host_to_net_u32 (start_host_byte_order);
1780     }
1781   while (start_host_byte_order <= end_host_byte_order);
1782
1783   return 0;
1784 }
1785
1786 /**
1787  * \brief Configure an ipv6 source address range
1788  * @param vm vlib_main_t pointer
1789  * @param start first ipv6 address in the source address range
1790  * @param end last ipv6 address in the source address range
1791  * @param table_id VRF / table ID, 0 for the default FIB
1792  * @return 0 if all OK, else an error indication from api_errno.h
1793  */
1794
1795 int
1796 tcp_configure_v6_source_address_range (vlib_main_t * vm,
1797                                        ip6_address_t * start,
1798                                        ip6_address_t * end, u32 table_id)
1799 {
1800   fib_prefix_t prefix;
1801   u32 fib_index = 0;
1802   fib_node_index_t fei;
1803   u32 sw_if_index;
1804
1805   clib_memset (&prefix, 0, sizeof (prefix));
1806
1807   fib_index = fib_table_find (FIB_PROTOCOL_IP6, table_id);
1808
1809   if (fib_index == ~0)
1810     return VNET_API_ERROR_NO_SUCH_FIB;
1811
1812   while (1)
1813     {
1814       int i;
1815       ip6_address_t tmp;
1816       dpo_id_t dpo = DPO_INVALID;
1817
1818       /* Remember this address */
1819       vec_add1 (tcp_cfg.ip6_src_addrs, start[0]);
1820
1821       /* Lookup the prefix, to identify the interface involved */
1822       prefix.fp_len = 128;
1823       prefix.fp_proto = FIB_PROTOCOL_IP6;
1824       memcpy (&prefix.fp_addr.ip6, start, sizeof (ip6_address_t));
1825
1826       fei = fib_table_lookup (fib_index, &prefix);
1827
1828       /* Couldn't find route to destination. Bail out. */
1829       if (fei == FIB_NODE_INDEX_INVALID)
1830         return VNET_API_ERROR_NEXT_HOP_NOT_IN_FIB;
1831
1832       sw_if_index = fib_entry_get_resolving_interface (fei);
1833
1834       if (sw_if_index == (u32) ~ 0)
1835         return VNET_API_ERROR_NO_MATCHING_INTERFACE;
1836
1837       /* Add a proxy neighbor discovery entry for this address */
1838       ip6_neighbor_proxy_add_del (sw_if_index, start, 0 /* is_del */ );
1839
1840       /* Add a receive adjacency for this address */
1841       receive_dpo_add_or_lock (DPO_PROTO_IP6, ~0 /* sw_if_index */ ,
1842                                NULL, &dpo);
1843
1844       fib_table_entry_special_dpo_update (fib_index,
1845                                           &prefix,
1846                                           FIB_SOURCE_API,
1847                                           FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
1848       dpo_reset (&dpo);
1849
1850       /* Done with the entire range? */
1851       if (!memcmp (start, end, sizeof (start[0])))
1852         break;
1853
1854       /* Increment the address. DGMS. */
1855       tmp = start[0];
1856       for (i = 15; i >= 0; i--)
1857         {
1858           tmp.as_u8[i] += 1;
1859           if (tmp.as_u8[i] != 0)
1860             break;
1861         }
1862       start[0] = tmp;
1863     }
1864   return 0;
1865 }
1866
1867 static clib_error_t *
1868 tcp_src_address (vlib_main_t * vm,
1869                  unformat_input_t * input, vlib_cli_command_t * cmd_arg)
1870 {
1871   ip4_address_t v4start, v4end;
1872   ip6_address_t v6start, v6end;
1873   u32 table_id = 0;
1874   int v4set = 0;
1875   int v6set = 0;
1876   int rv;
1877
1878   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1879     {
1880       if (unformat (input, "%U - %U", unformat_ip4_address, &v4start,
1881                     unformat_ip4_address, &v4end))
1882         v4set = 1;
1883       else if (unformat (input, "%U", unformat_ip4_address, &v4start))
1884         {
1885           memcpy (&v4end, &v4start, sizeof (v4start));
1886           v4set = 1;
1887         }
1888       else if (unformat (input, "%U - %U", unformat_ip6_address, &v6start,
1889                          unformat_ip6_address, &v6end))
1890         v6set = 1;
1891       else if (unformat (input, "%U", unformat_ip6_address, &v6start))
1892         {
1893           memcpy (&v6end, &v6start, sizeof (v6start));
1894           v6set = 1;
1895         }
1896       else if (unformat (input, "fib-table %d", &table_id))
1897         ;
1898       else
1899         break;
1900     }
1901
1902   if (!v4set && !v6set)
1903     return clib_error_return (0, "at least one v4 or v6 address required");
1904
1905   if (v4set)
1906     {
1907       rv = tcp_configure_v4_source_address_range (vm, &v4start, &v4end,
1908                                                   table_id);
1909       switch (rv)
1910         {
1911         case 0:
1912           break;
1913
1914         case VNET_API_ERROR_NO_SUCH_FIB:
1915           return clib_error_return (0, "Invalid table-id %d", table_id);
1916
1917         case VNET_API_ERROR_INVALID_ARGUMENT:
1918           return clib_error_return (0, "Invalid address range %U - %U",
1919                                     format_ip4_address, &v4start,
1920                                     format_ip4_address, &v4end);
1921         default:
1922           return clib_error_return (0, "error %d", rv);
1923           break;
1924         }
1925     }
1926   if (v6set)
1927     {
1928       rv = tcp_configure_v6_source_address_range (vm, &v6start, &v6end,
1929                                                   table_id);
1930       switch (rv)
1931         {
1932         case 0:
1933           break;
1934
1935         case VNET_API_ERROR_NO_SUCH_FIB:
1936           return clib_error_return (0, "Invalid table-id %d", table_id);
1937
1938         default:
1939           return clib_error_return (0, "error %d", rv);
1940           break;
1941         }
1942     }
1943   return 0;
1944 }
1945
1946 /* *INDENT-OFF* */
1947 VLIB_CLI_COMMAND (tcp_src_address_command, static) =
1948 {
1949   .path = "tcp src-address",
1950   .short_help = "tcp src-address <ip-addr> [- <ip-addr>] add src address range",
1951   .function = tcp_src_address,
1952 };
1953 /* *INDENT-ON* */
1954
1955 static u8 *
1956 tcp_scoreboard_dump_trace (u8 * s, sack_scoreboard_t * sb)
1957 {
1958 #if TCP_SCOREBOARD_TRACE
1959
1960   scoreboard_trace_elt_t *block;
1961   int i = 0;
1962
1963   if (!sb->trace)
1964     return s;
1965
1966   s = format (s, "scoreboard trace:");
1967   vec_foreach (block, sb->trace)
1968   {
1969     s = format (s, "{%u, %u, %u, %u, %u}, ", block->start, block->end,
1970                 block->ack, block->snd_una_max, block->group);
1971     if ((++i % 3) == 0)
1972       s = format (s, "\n");
1973   }
1974   return s;
1975 #else
1976   return 0;
1977 #endif
1978 }
1979
1980 static clib_error_t *
1981 tcp_show_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
1982                               vlib_cli_command_t * cmd_arg)
1983 {
1984   transport_connection_t *tconn = 0;
1985   tcp_connection_t *tc;
1986   u8 *s = 0;
1987   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1988     {
1989       if (unformat (input, "%U", unformat_transport_connection, &tconn,
1990                     TRANSPORT_PROTO_TCP))
1991         ;
1992       else
1993         return clib_error_return (0, "unknown input `%U'",
1994                                   format_unformat_error, input);
1995     }
1996
1997   if (!TCP_SCOREBOARD_TRACE)
1998     {
1999       vlib_cli_output (vm, "scoreboard tracing not enabled");
2000       return 0;
2001     }
2002
2003   tc = tcp_get_connection_from_transport (tconn);
2004   s = tcp_scoreboard_dump_trace (s, &tc->sack_sb);
2005   vlib_cli_output (vm, "%v", s);
2006   return 0;
2007 }
2008
2009 /* *INDENT-OFF* */
2010 VLIB_CLI_COMMAND (tcp_show_scoreboard_trace_command, static) =
2011 {
2012   .path = "show tcp scoreboard trace",
2013   .short_help = "show tcp scoreboard trace <connection>",
2014   .function = tcp_show_scoreboard_trace_fn,
2015 };
2016 /* *INDENT-ON* */
2017
2018 u8 *
2019 tcp_scoreboard_replay (u8 * s, tcp_connection_t * tc, u8 verbose)
2020 {
2021   int i, trace_len;
2022   scoreboard_trace_elt_t *trace;
2023   u32 next_ack, left, group, has_new_ack = 0;
2024   tcp_connection_t _dummy_tc, *dummy_tc = &_dummy_tc;
2025   sack_block_t *block;
2026
2027   if (!TCP_SCOREBOARD_TRACE)
2028     {
2029       s = format (s, "scoreboard tracing not enabled");
2030       return s;
2031     }
2032
2033   if (!tc)
2034     return s;
2035
2036   clib_memset (dummy_tc, 0, sizeof (*dummy_tc));
2037   tcp_connection_timers_init (dummy_tc);
2038   scoreboard_init (&dummy_tc->sack_sb);
2039   dummy_tc->rcv_opts.flags |= TCP_OPTS_FLAG_SACK;
2040
2041 #if TCP_SCOREBOARD_TRACE
2042   trace = tc->sack_sb.trace;
2043   trace_len = vec_len (tc->sack_sb.trace);
2044 #endif
2045
2046   for (i = 0; i < trace_len; i++)
2047     {
2048       if (trace[i].ack != 0)
2049         {
2050           dummy_tc->snd_una = trace[i].ack - 1448;
2051           dummy_tc->snd_una_max = trace[i].ack;
2052         }
2053     }
2054
2055   left = 0;
2056   while (left < trace_len)
2057     {
2058       group = trace[left].group;
2059       vec_reset_length (dummy_tc->rcv_opts.sacks);
2060       has_new_ack = 0;
2061       while (trace[left].group == group)
2062         {
2063           if (trace[left].ack != 0)
2064             {
2065               if (verbose)
2066                 s = format (s, "Adding ack %u, snd_una_max %u, segs: ",
2067                             trace[left].ack, trace[left].snd_una_max);
2068               dummy_tc->snd_una_max = trace[left].snd_una_max;
2069               next_ack = trace[left].ack;
2070               has_new_ack = 1;
2071             }
2072           else
2073             {
2074               if (verbose)
2075                 s = format (s, "[%u, %u], ", trace[left].start,
2076                             trace[left].end);
2077               vec_add2 (dummy_tc->rcv_opts.sacks, block, 1);
2078               block->start = trace[left].start;
2079               block->end = trace[left].end;
2080             }
2081           left++;
2082         }
2083
2084       /* Push segments */
2085       tcp_rcv_sacks (dummy_tc, next_ack);
2086       if (has_new_ack)
2087         dummy_tc->snd_una = next_ack + dummy_tc->sack_sb.snd_una_adv;
2088
2089       if (verbose)
2090         s = format (s, "result: %U", format_tcp_scoreboard,
2091                     &dummy_tc->sack_sb);
2092
2093     }
2094   s = format (s, "result: %U", format_tcp_scoreboard, &dummy_tc->sack_sb);
2095
2096   return s;
2097 }
2098
2099 static clib_error_t *
2100 tcp_scoreboard_trace_fn (vlib_main_t * vm, unformat_input_t * input,
2101                          vlib_cli_command_t * cmd_arg)
2102 {
2103   transport_connection_t *tconn = 0;
2104   tcp_connection_t *tc = 0;
2105   u8 *str = 0;
2106   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2107     {
2108       if (unformat (input, "%U", unformat_transport_connection, &tconn,
2109                     TRANSPORT_PROTO_TCP))
2110         ;
2111       else
2112         return clib_error_return (0, "unknown input `%U'",
2113                                   format_unformat_error, input);
2114     }
2115
2116   if (!TCP_SCOREBOARD_TRACE)
2117     {
2118       vlib_cli_output (vm, "scoreboard tracing not enabled");
2119       return 0;
2120     }
2121
2122   tc = tcp_get_connection_from_transport (tconn);
2123   if (!tc)
2124     {
2125       vlib_cli_output (vm, "connection not found");
2126       return 0;
2127     }
2128   str = tcp_scoreboard_replay (str, tc, 1);
2129   vlib_cli_output (vm, "%v", str);
2130   return 0;
2131 }
2132
2133 /* *INDENT-OFF* */
2134 VLIB_CLI_COMMAND (tcp_replay_scoreboard_command, static) =
2135 {
2136   .path = "tcp replay scoreboard",
2137   .short_help = "tcp replay scoreboard <connection>",
2138   .function = tcp_scoreboard_trace_fn,
2139 };
2140 /* *INDENT-ON* */
2141
2142 static clib_error_t *
2143 show_tcp_punt_fn (vlib_main_t * vm, unformat_input_t * input,
2144                   vlib_cli_command_t * cmd_arg)
2145 {
2146   tcp_main_t *tm = vnet_get_tcp_main ();
2147   if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2148     return clib_error_return (0, "unknown input `%U'", format_unformat_error,
2149                               input);
2150   vlib_cli_output (vm, "IPv4 TCP punt: %s",
2151                    tm->punt_unknown4 ? "enabled" : "disabled");
2152   vlib_cli_output (vm, "IPv6 TCP punt: %s",
2153                    tm->punt_unknown6 ? "enabled" : "disabled");
2154   return 0;
2155 }
2156 /* *INDENT-OFF* */
2157 VLIB_CLI_COMMAND (show_tcp_punt_command, static) =
2158 {
2159   .path = "show tcp punt",
2160   .short_help = "show tcp punt",
2161   .function = show_tcp_punt_fn,
2162 };
2163 /* *INDENT-ON* */
2164
2165 /*
2166  * fd.io coding-style-patch-verification: ON
2167  *
2168  * Local Variables:
2169  * eval: (c-set-style "gnu")
2170  * End:
2171  */