session: api to add new transport types
[vpp.git] / src / vnet / session / transport.c
index 22a356e..d9a54ff 100644 (file)
@@ -42,46 +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
-#define TRANSPORT_PACER_MAX_BURST      (32 * 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_NONE:
-      s = format (s, "NONE");
-      break;
-    case TRANSPORT_PROTO_TLS:
-      s = format (s, "TLS");
-      break;
-    case TRANSPORT_PROTO_UDPC:
-      s = format (s, "UDPC");
-      break;
-    case TRANSPORT_PROTO_QUIC:
-      s = format (s, "QUIC");
-      break;
-    default:
-      s = format (s, "UNKNOWN");
-      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;
 }
 
@@ -89,33 +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_NONE:
-      s = format (s, "N");
-      break;
-    case TRANSPORT_PROTO_TLS:
-      s = format (s, "J");
-      break;
-    case TRANSPORT_PROTO_UDPC:
-      s = format (s, "U");
-      break;
-    case TRANSPORT_PROTO_QUIC:
-      s = format (s, "Q");
-      break;
-    default:
-      s = format (s, "?");
-      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;
 }
 
@@ -141,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;
 }
@@ -175,37 +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, "udpc"))
-    *proto = TRANSPORT_PROTO_UDPC;
-  else if (unformat (input, "UDPC"))
-    *proto = TRANSPORT_PROTO_UDPC;
-  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, "quic"))
-    *proto = TRANSPORT_PROTO_QUIC;
-  else if (unformat (input, "QUIC"))
-    *proto = TRANSPORT_PROTO_QUIC;
-  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
@@ -253,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,
@@ -275,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
  *
@@ -324,6 +315,15 @@ 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)
@@ -597,29 +597,49 @@ 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 tokens/period %.3f last_update %x",
-             pacer->bucket, 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 = norm_time_now;
-      pacer->bucket += inc;
+      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 = time_now;
+      pacer->bucket = clib_min (pacer->bucket + inc, pacer->bytes_per_sec);
     }
 
   return clib_min (pacer->bucket, TRANSPORT_PACER_MAX_BURST);
@@ -633,72 +653,68 @@ spacer_update_bucket (spacer_t * pacer, u32 bytes)
 }
 
 static inline void
-spacer_set_pace_rate (spacer_t * pacer, u64 rate_bytes_per_sec)
+spacer_set_pace_rate (spacer_t * pacer, u64 rate_bytes_per_sec,
+                     clib_us_time_t rtt)
 {
   ASSERT (rate_bytes_per_sec != 0);
-  pacer->tokens_per_period = rate_bytes_per_sec / transport_pacer_period;
+  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)
 {
-  return pacer->tokens_per_period * transport_pacer_period;
+  return pacer->bytes_per_sec;
+}
+
+static inline void
+spacer_reset (spacer_t * pacer, clib_us_time_t time_now, u64 bucket)
+{
+  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_set_pace_rate (&tc->pacer, rate_bytes_per_sec, rtt);
+  spacer_reset (&tc->pacer, transport_us_time_now (tc->thread_index),
+               start_bucket);
+}
+
+void
+transport_connection_tx_pacer_reset_bucket (transport_connection_t * tc,
+                                           u32 bucket)
 {
-  spacer_t *pacer = &tc->pacer;
-  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;
+  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)
 {
-  spacer_set_pace_rate (&tc->pacer, bytes_per_sec);
+  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);
-}
-
-u32
-transport_connection_snd_space (transport_connection_t * tc, u64 time_now,
-                               u16 mss)
-{
-  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_max_burst (&tc->pacer,
+                          transport_us_time_now (tc->thread_index));
 }
 
 u64
@@ -722,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)