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