session: api to add new transport types
[vpp.git] / src / vnet / session / transport.c
index 06c541a..d9a54ff 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017 Cisco and/or its affiliates.
+ * Copyright (c) 2017-2019 Cisco and/or its affiliates.
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at:
@@ -13,7 +13,7 @@
  * limitations under the License.
  */
 
-#include <vnet/session/transport_interface.h>
+#include <vnet/session/transport.h>
 #include <vnet/session/session.h>
 #include <vnet/fib/fib.h>
 
@@ -42,33 +42,16 @@ static transport_endpoint_t *local_endpoints;
  */
 static clib_spinlock_t local_endpoints_lock;
 
-/*
- * Period used by transport pacers. Initialized by session layer
- */
-static double transport_pacer_period;
-
-#define TRANSPORT_PACER_MIN_MSS        1460
-#define TRANSPORT_PACER_MIN_BURST      TRANSPORT_PACER_MIN_MSS
-
 u8 *
 format_transport_proto (u8 * s, va_list * args)
 {
   u32 transport_proto = va_arg (*args, u32);
-  switch (transport_proto)
-    {
-    case TRANSPORT_PROTO_TCP:
-      s = format (s, "TCP");
-      break;
-    case TRANSPORT_PROTO_UDP:
-      s = format (s, "UDP");
-      break;
-    case TRANSPORT_PROTO_SCTP:
-      s = format (s, "SCTP");
-      break;
-    case TRANSPORT_PROTO_UDPC:
-      s = format (s, "UDPC");
-      break;
-    }
+
+  if (tp_vfts[transport_proto].transport_options.name)
+    s = format (s, "%s", tp_vfts[transport_proto].transport_options.name);
+  else
+    s = format (s, "n/a");
+
   return s;
 }
 
@@ -76,21 +59,14 @@ u8 *
 format_transport_proto_short (u8 * s, va_list * args)
 {
   u32 transport_proto = va_arg (*args, u32);
-  switch (transport_proto)
-    {
-    case TRANSPORT_PROTO_TCP:
-      s = format (s, "T");
-      break;
-    case TRANSPORT_PROTO_UDP:
-      s = format (s, "U");
-      break;
-    case TRANSPORT_PROTO_SCTP:
-      s = format (s, "S");
-      break;
-    case TRANSPORT_PROTO_UDPC:
-      s = format (s, "U");
-      break;
-    }
+  char *short_name;
+
+  short_name = tp_vfts[transport_proto].transport_options.short_name;
+  if (short_name)
+    s = format (s, "%s", short_name);
+  else
+    s = format (s, "NA");
+
   return s;
 }
 
@@ -116,7 +92,9 @@ format_transport_connection (u8 * s, va_list * args)
     {
       indent = format_get_indent (s) + 1;
       s = format (s, "%Upacer: %U\n", format_white_space, indent,
-                 format_transport_pacer, &tc->pacer);
+                 format_transport_pacer, &tc->pacer, tc->thread_index);
+      s = format (s, "%Utransport: flags 0x%x\n", format_white_space, indent,
+                 tc->flags);
     }
   return s;
 }
@@ -125,14 +103,13 @@ u8 *
 format_transport_listen_connection (u8 * s, va_list * args)
 {
   u32 transport_proto = va_arg (*args, u32);
-  u32 listen_index = va_arg (*args, u32);
   transport_proto_vft_t *tp_vft;
 
   tp_vft = transport_protocol_get_vft (transport_proto);
   if (!tp_vft)
     return s;
 
-  s = format (s, "%U", tp_vft->format_listener, listen_index);
+  s = (tp_vft->format_listener) (s, args);
   return s;
 }
 
@@ -151,33 +128,66 @@ format_transport_half_open_connection (u8 * s, va_list * args)
   return s;
 }
 
+static u8
+unformat_transport_str_match (unformat_input_t * input, const char *str)
+{
+  int i;
+
+  if (strlen (str) > vec_len (input->buffer) - input->index)
+    return 0;
+
+  for (i = 0; i < strlen (str); i++)
+    {
+      if (input->buffer[i + input->index] != str[i])
+       return 0;
+    }
+  return 1;
+}
+
 uword
 unformat_transport_proto (unformat_input_t * input, va_list * args)
 {
   u32 *proto = va_arg (*args, u32 *);
-  if (unformat (input, "tcp"))
-    *proto = TRANSPORT_PROTO_TCP;
-  else if (unformat (input, "TCP"))
-    *proto = TRANSPORT_PROTO_TCP;
-  else if (unformat (input, "udp"))
-    *proto = TRANSPORT_PROTO_UDP;
-  else if (unformat (input, "UDP"))
-    *proto = TRANSPORT_PROTO_UDP;
-  else if (unformat (input, "sctp"))
-    *proto = TRANSPORT_PROTO_SCTP;
-  else if (unformat (input, "SCTP"))
-    *proto = TRANSPORT_PROTO_SCTP;
-  else if (unformat (input, "tls"))
-    *proto = TRANSPORT_PROTO_TLS;
-  else if (unformat (input, "TLS"))
-    *proto = TRANSPORT_PROTO_TLS;
-  else if (unformat (input, "udpc"))
-    *proto = TRANSPORT_PROTO_UDPC;
-  else if (unformat (input, "UDPC"))
-    *proto = TRANSPORT_PROTO_UDPC;
-  else
-    return 0;
-  return 1;
+  transport_proto_vft_t *tp_vft;
+  u8 longest_match = 0, match;
+  char *str, *str_match = 0;
+  transport_proto_t tp;
+
+  for (tp = 0; tp < vec_len (tp_vfts); tp++)
+    {
+      tp_vft = &tp_vfts[tp];
+      str = tp_vft->transport_options.name;
+      if (!str)
+       continue;
+      if (unformat_transport_str_match (input, str))
+       {
+         match = strlen (str);
+         if (match > longest_match)
+           {
+             *proto = tp;
+             longest_match = match;
+             str_match = str;
+           }
+       }
+    }
+  if (longest_match)
+    {
+      unformat (input, str_match);
+      return 1;
+    }
+
+  return 0;
+}
+
+u8 *
+format_transport_protos (u8 * s, va_list * args)
+{
+  transport_proto_vft_t *tp_vft;
+
+  vec_foreach (tp_vft, tp_vfts)
+    s = format (s, "%s\n", tp_vft->transport_options.name);
+
+  return s;
 }
 
 u32
@@ -225,15 +235,6 @@ transport_endpoint_table_del (transport_endpoint_table_t * ht, u8 proto,
   clib_bihash_add_del_24_8 (ht, &kv, 0);
 }
 
-/**
- * Register transport virtual function table.
- *
- * @param transport_proto - transport protocol type (i.e., TCP, UDP ..)
- * @param vft - virtual function table for transport proto
- * @param fib_proto - network layer protocol
- * @param output_node - output node index that session layer will hand off
- *                     buffers to, for requested fib proto
- */
 void
 transport_register_protocol (transport_proto_t transport_proto,
                             const transport_proto_vft_t * vft,
@@ -247,6 +248,24 @@ transport_register_protocol (transport_proto_t transport_proto,
   session_register_transport (transport_proto, vft, is_ip4, output_node);
 }
 
+transport_proto_t
+transport_register_new_protocol (const transport_proto_vft_t * vft,
+                                fib_protocol_t fib_proto, u32 output_node)
+{
+  transport_proto_t transport_proto;
+  u8 is_ip4;
+
+  transport_proto = session_add_transport_proto ();
+  is_ip4 = fib_proto == FIB_PROTOCOL_IP4;
+
+  vec_validate (tp_vfts, transport_proto);
+  tp_vfts[transport_proto] = *vft;
+
+  session_register_transport (transport_proto, vft, is_ip4, output_node);
+
+  return transport_proto;
+}
+
 /**
  * Get transport virtual function table
  *
@@ -260,22 +279,116 @@ transport_protocol_get_vft (transport_proto_t transport_proto)
   return &tp_vfts[transport_proto];
 }
 
+u8
+transport_half_open_has_fifos (transport_proto_t tp)
+{
+  return tp_vfts[tp].transport_options.half_open_has_fifos;
+}
+
 transport_service_type_t
 transport_protocol_service_type (transport_proto_t tp)
 {
-  return tp_vfts[tp].service_type;
+  return tp_vfts[tp].transport_options.service_type;
 }
 
 transport_tx_fn_type_t
 transport_protocol_tx_fn_type (transport_proto_t tp)
 {
-  return tp_vfts[tp].tx_type;
+  return tp_vfts[tp].transport_options.tx_type;
+}
+
+void
+transport_cleanup (transport_proto_t tp, u32 conn_index, u8 thread_index)
+{
+  tp_vfts[tp].cleanup (conn_index, thread_index);
+}
+
+int
+transport_connect (transport_proto_t tp, transport_endpoint_cfg_t * tep)
+{
+  return tp_vfts[tp].connect (tep);
+}
+
+void
+transport_close (transport_proto_t tp, u32 conn_index, u8 thread_index)
+{
+  tp_vfts[tp].close (conn_index, thread_index);
+}
+
+void
+transport_reset (transport_proto_t tp, u32 conn_index, u8 thread_index)
+{
+  if (tp_vfts[tp].reset)
+    tp_vfts[tp].reset (conn_index, thread_index);
+  else
+    tp_vfts[tp].close (conn_index, thread_index);
+}
+
+u32
+transport_start_listen (transport_proto_t tp, u32 session_index,
+                       transport_endpoint_t * tep)
+{
+  return tp_vfts[tp].start_listen (session_index, tep);
+}
+
+u32
+transport_stop_listen (transport_proto_t tp, u32 conn_index)
+{
+  return tp_vfts[tp].stop_listen (conn_index);
 }
 
 u8
 transport_protocol_is_cl (transport_proto_t tp)
 {
-  return (tp_vfts[tp].service_type == TRANSPORT_SERVICE_CL);
+  return (tp_vfts[tp].transport_options.service_type == TRANSPORT_SERVICE_CL);
+}
+
+always_inline void
+default_get_transport_endpoint (transport_connection_t * tc,
+                               transport_endpoint_t * tep, u8 is_lcl)
+{
+  if (is_lcl)
+    {
+      tep->port = tc->lcl_port;
+      tep->is_ip4 = tc->is_ip4;
+      clib_memcpy_fast (&tep->ip, &tc->lcl_ip, sizeof (tc->lcl_ip));
+    }
+  else
+    {
+      tep->port = tc->rmt_port;
+      tep->is_ip4 = tc->is_ip4;
+      clib_memcpy_fast (&tep->ip, &tc->rmt_ip, sizeof (tc->rmt_ip));
+    }
+}
+
+void
+transport_get_endpoint (transport_proto_t tp, u32 conn_index,
+                       u32 thread_index, transport_endpoint_t * tep,
+                       u8 is_lcl)
+{
+  if (tp_vfts[tp].get_transport_endpoint)
+    tp_vfts[tp].get_transport_endpoint (conn_index, thread_index, tep,
+                                       is_lcl);
+  else
+    {
+      transport_connection_t *tc;
+      tc = transport_get_connection (tp, conn_index, thread_index);
+      default_get_transport_endpoint (tc, tep, is_lcl);
+    }
+}
+
+void
+transport_get_listener_endpoint (transport_proto_t tp, u32 conn_index,
+                                transport_endpoint_t * tep, u8 is_lcl)
+{
+  if (tp_vfts[tp].get_transport_listener_endpoint)
+    tp_vfts[tp].get_transport_listener_endpoint (conn_index, tep, is_lcl);
+  else
+    {
+      transport_connection_t *tc;
+      tc = transport_get_listener (tp, conn_index);
+      default_get_transport_endpoint (tc, tep, is_lcl);
+    }
 }
 
 #define PORT_MASK ((1 << 16)- 1)
@@ -319,7 +432,7 @@ transport_endpoint_mark_used (u8 proto, ip46_address_t * ip, u16 port)
   transport_endpoint_t *tep;
   clib_spinlock_lock_if_init (&local_endpoints_lock);
   tep = transport_endpoint_new ();
-  clib_memcpy (&tep->ip, ip, sizeof (*ip));
+  clib_memcpy_fast (&tep->ip, ip, sizeof (*ip));
   tep->port = port;
   transport_endpoint_table_add (&local_endpoints_table, proto, tep,
                                tep - local_endpoints);
@@ -388,7 +501,7 @@ transport_get_interface_ip (u32 sw_if_index, u8 is_ip4, ip46_address_t * addr)
        return clib_error_return (0, "no routable ip6 addresses on %U",
                                  format_vnet_sw_if_index_name,
                                  vnet_get_main (), sw_if_index);
-      clib_memcpy (&addr->ip6, ip6, sizeof (*ip6));
+      clib_memcpy_fast (&addr->ip6, ip6, sizeof (*ip6));
     }
   return 0;
 }
@@ -404,7 +517,7 @@ transport_find_local_ip_for_remote (u32 sw_if_index,
   if (sw_if_index == ENDPOINT_INVALID_INDEX)
     {
       /* Find a FIB path to the destination */
-      clib_memcpy (&prefix.fp_addr, &rmt->ip, sizeof (rmt->ip));
+      clib_memcpy_fast (&prefix.fp_addr, &rmt->ip, sizeof (rmt->ip));
       prefix.fp_proto = rmt->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
       prefix.fp_len = rmt->is_ip4 ? 32 : 128;
 
@@ -444,12 +557,16 @@ transport_alloc_local_endpoint (u8 proto, transport_endpoint_cfg_t * rmt_cfg,
       error = transport_find_local_ip_for_remote (rmt_cfg->peer.sw_if_index,
                                                  rmt, lcl_addr);
       if (error)
-       return -1;
+       {
+         clib_error_report (error);
+         return -1;
+       }
     }
   else
     {
       /* Assume session layer vetted this address */
-      clib_memcpy (lcl_addr, &rmt_cfg->peer.ip, sizeof (rmt_cfg->peer.ip));
+      clib_memcpy_fast (lcl_addr, &rmt_cfg->peer.ip,
+                       sizeof (rmt_cfg->peer.ip));
     }
 
   /*
@@ -480,33 +597,52 @@ transport_alloc_local_endpoint (u8 proto, transport_endpoint_cfg_t * rmt_cfg,
   return 0;
 }
 
-#define SPACER_CPU_TICKS_PER_PERIOD_SHIFT 10
-#define SPACER_CPU_TICKS_PER_PERIOD (1 << SPACER_CPU_TICKS_PER_PERIOD_SHIFT)
+u8 *
+format_clib_us_time (u8 * s, va_list * args)
+{
+  clib_us_time_t t = va_arg (*args, clib_us_time_t);
+  if (t < 1e3)
+    s = format (s, "%u us", t);
+  else
+    s = format (s, "%.3f s", (f64) t * CLIB_US_TIME_PERIOD);
+  return s;
+}
 
 u8 *
 format_transport_pacer (u8 * s, va_list * args)
 {
   spacer_t *pacer = va_arg (*args, spacer_t *);
-
-  s = format (s, "bucket %u max_burst %u tokens/period %.3f last_update %x",
-             pacer->bucket, pacer->max_burst_size, pacer->tokens_per_period,
-             pacer->last_update);
+  u32 thread_index = va_arg (*args, int);
+  clib_us_time_t now, diff;
+
+  now = transport_us_time_now (thread_index);
+  diff = now - pacer->last_update;
+  s = format (s, "rate %lu bucket %lu t/p %.3f last_update %U idle %u",
+             pacer->bytes_per_sec, pacer->bucket, pacer->tokens_per_period,
+             format_clib_us_time, diff, pacer->idle_timeout_us);
   return s;
 }
 
 static inline u32
-spacer_max_burst (spacer_t * pacer, u64 norm_time_now)
+spacer_max_burst (spacer_t * pacer, clib_us_time_t time_now)
 {
-  u64 n_periods = norm_time_now - pacer->last_update;
+  u64 n_periods = (time_now - pacer->last_update);
   u64 inc;
 
-  if (n_periods > 0 && (inc = n_periods * pacer->tokens_per_period) > 10)
+  if (PREDICT_FALSE (n_periods > pacer->idle_timeout_us))
+    {
+      pacer->last_update = time_now;
+      pacer->bucket = TRANSPORT_PACER_MIN_BURST;
+      return TRANSPORT_PACER_MIN_BURST;
+    }
+
+  if ((inc = (f32) n_periods * pacer->tokens_per_period) > 10)
     {
-      pacer->last_update = norm_time_now;
-      pacer->bucket += inc;
+      pacer->last_update = time_now;
+      pacer->bucket = clib_min (pacer->bucket + inc, pacer->bytes_per_sec);
     }
 
-  return clib_min (pacer->bucket, pacer->max_burst_size);
+  return clib_min (pacer->bucket, TRANSPORT_PACER_MAX_BURST);
 }
 
 static inline void
@@ -517,88 +653,79 @@ spacer_update_bucket (spacer_t * pacer, u32 bytes)
 }
 
 static inline void
-spacer_update_max_burst_size (spacer_t * pacer, u32 max_burst_bytes)
+spacer_set_pace_rate (spacer_t * pacer, u64 rate_bytes_per_sec,
+                     clib_us_time_t rtt)
+{
+  ASSERT (rate_bytes_per_sec != 0);
+  pacer->bytes_per_sec = rate_bytes_per_sec;
+  pacer->tokens_per_period = rate_bytes_per_sec * CLIB_US_TIME_PERIOD;
+  pacer->idle_timeout_us = clib_max (rtt * TRANSPORT_PACER_IDLE_FACTOR,
+                                    TRANSPORT_PACER_MIN_IDLE);
+}
+
+static inline u64
+spacer_pace_rate (spacer_t * pacer)
 {
-  pacer->max_burst_size = clib_max (max_burst_bytes,
-                                   TRANSPORT_PACER_MIN_BURST);
+  return pacer->bytes_per_sec;
 }
 
 static inline void
-spacer_set_pace_rate (spacer_t * pacer, u64 rate_bytes_per_sec)
+spacer_reset (spacer_t * pacer, clib_us_time_t time_now, u64 bucket)
 {
-  ASSERT (rate_bytes_per_sec != 0);
-  pacer->tokens_per_period = rate_bytes_per_sec / transport_pacer_period;
+  pacer->last_update = time_now;
+  pacer->bucket = bucket;
 }
 
 void
 transport_connection_tx_pacer_reset (transport_connection_t * tc,
-                                    u32 rate_bytes_per_sec,
-                                    u32 start_bucket, u64 time_now)
+                                    u64 rate_bytes_per_sec, u32 start_bucket,
+                                    clib_us_time_t rtt)
 {
-  spacer_t *pacer = &tc->pacer;
-  f64 dispatch_period;
-  u32 burst_size;
+  spacer_set_pace_rate (&tc->pacer, rate_bytes_per_sec, rtt);
+  spacer_reset (&tc->pacer, transport_us_time_now (tc->thread_index),
+               start_bucket);
+}
 
-  dispatch_period = transport_dispatch_period (tc->thread_index);
-  burst_size = rate_bytes_per_sec * dispatch_period;
-  spacer_update_max_burst_size (&tc->pacer, burst_size);
-  spacer_set_pace_rate (&tc->pacer, rate_bytes_per_sec);
-  pacer->last_update = time_now >> SPACER_CPU_TICKS_PER_PERIOD_SHIFT;
-  pacer->bucket = start_bucket;
+void
+transport_connection_tx_pacer_reset_bucket (transport_connection_t * tc,
+                                           u32 bucket)
+{
+  spacer_reset (&tc->pacer, transport_us_time_now (tc->thread_index), bucket);
 }
 
 void
 transport_connection_tx_pacer_init (transport_connection_t * tc,
-                                   u32 rate_bytes_per_sec,
+                                   u64 rate_bytes_per_sec,
                                    u32 initial_bucket)
 {
-  vlib_main_t *vm = vlib_get_main ();
   tc->flags |= TRANSPORT_CONNECTION_F_IS_TX_PACED;
   transport_connection_tx_pacer_reset (tc, rate_bytes_per_sec,
-                                      initial_bucket,
-                                      vm->clib_time.last_cpu_time);
+                                      initial_bucket, 1e6);
 }
 
 void
 transport_connection_tx_pacer_update (transport_connection_t * tc,
-                                     u64 bytes_per_sec)
+                                     u64 bytes_per_sec, clib_us_time_t rtt)
 {
-  f64 dispatch_period = transport_dispatch_period (tc->thread_index);
-  u32 burst_size = 1.1 * bytes_per_sec * dispatch_period;
-  spacer_set_pace_rate (&tc->pacer, bytes_per_sec);
-  spacer_update_max_burst_size (&tc->pacer, burst_size);
+  spacer_set_pace_rate (&tc->pacer, bytes_per_sec, rtt);
 }
 
 u32
-transport_connection_tx_pacer_burst (transport_connection_t * tc,
-                                    u64 time_now)
+transport_connection_tx_pacer_burst (transport_connection_t * tc)
 {
-  time_now >>= SPACER_CPU_TICKS_PER_PERIOD_SHIFT;
-  return spacer_max_burst (&tc->pacer, time_now);
+  return spacer_max_burst (&tc->pacer,
+                          transport_us_time_now (tc->thread_index));
 }
 
-u32
-transport_connection_snd_space (transport_connection_t * tc, u64 time_now,
-                               u16 mss)
+u64
+transport_connection_tx_pacer_rate (transport_connection_t * tc)
 {
-  u32 snd_space, max_paced_burst;
-
-  snd_space = tp_vfts[tc->proto].send_space (tc);
-  if (transport_connection_is_tx_paced (tc))
-    {
-      time_now >>= SPACER_CPU_TICKS_PER_PERIOD_SHIFT;
-      max_paced_burst = spacer_max_burst (&tc->pacer, time_now);
-      max_paced_burst = (max_paced_burst < mss) ? 0 : max_paced_burst;
-      snd_space = clib_min (snd_space, max_paced_burst);
-      snd_space = snd_space - snd_space % mss;
-    }
-  return snd_space;
+  return spacer_pace_rate (&tc->pacer);
 }
 
 void
-transport_connection_update_tx_stats (transport_connection_t * tc, u32 bytes)
+transport_connection_update_tx_bytes (transport_connection_t * tc, u32 bytes)
 {
-  tc->stats.tx_bytes += bytes;
   if (transport_connection_is_tx_paced (tc))
     spacer_update_bucket (&tc->pacer, bytes);
 }
@@ -611,14 +738,24 @@ transport_connection_tx_pacer_update_bytes (transport_connection_t * tc,
 }
 
 void
-transport_init_tx_pacers_period (void)
+transport_connection_reschedule (transport_connection_t * tc)
 {
-  f64 cpu_freq = os_cpu_clock_frequency ();
-  transport_pacer_period = cpu_freq / SPACER_CPU_TICKS_PER_PERIOD;
+  tc->flags &= ~TRANSPORT_CONNECTION_F_DESCHED;
+  transport_connection_tx_pacer_reset_bucket (tc, TRANSPORT_PACER_MIN_BURST);
+  if (transport_max_tx_dequeue (tc))
+    sesssion_reschedule_tx (tc);
+  else
+    {
+      session_t *s = session_get (tc->s_index, tc->thread_index);
+      svm_fifo_unset_event (s->tx_fifo);
+      if (svm_fifo_max_dequeue_cons (s->tx_fifo))
+       if (svm_fifo_set_event (s->tx_fifo))
+         sesssion_reschedule_tx (tc);
+    }
 }
 
 void
-transport_update_time (f64 time_now, u8 thread_index)
+transport_update_time (clib_time_type_t time_now, u8 thread_index)
 {
   transport_proto_vft_t *vft;
   vec_foreach (vft, tp_vfts)
@@ -643,7 +780,7 @@ void
 transport_init (void)
 {
   vlib_thread_main_t *vtm = vlib_get_thread_main ();
-  session_manager_main_t *smm = vnet_get_session_manager_main ();
+  session_main_t *smm = vnet_get_session_main ();
   u32 num_threads;
 
   if (smm->local_endpoints_table_buckets == 0)