session: add support for memfd segments
[vpp.git] / src / vnet / session / application.c
index df68ce0..13ccdd7 100644 (file)
@@ -76,7 +76,7 @@ application_local_session_table (application_t * app)
 int
 application_api_queue_is_full (application_t * app)
 {
-  unix_shared_memory_queue_t *q;
+  svm_queue_t *q;
 
   /* builtin servers are always OK */
   if (app->api_client_index == ~0)
@@ -146,11 +146,12 @@ application_new ()
 void
 application_del (application_t * app)
 {
+  segment_manager_properties_t *props;
+  vnet_unbind_args_t _a, *a = &_a;
   segment_manager_t *sm;
-  u64 handle;
-  u32 index, *handles = 0;
+  u64 handle, *handles = 0;
+  u32 index;
   int i;
-  vnet_unbind_args_t _a, *a = &_a;
 
   /*
    * The app event queue allocated in first segment is cleared with
@@ -159,6 +160,9 @@ application_del (application_t * app)
   if (CLIB_DEBUG > 1)
     clib_warning ("[%d] Delete app (%d)", getpid (), app->index);
 
+  if (application_is_proxy (app))
+    application_remove_proxy (app);
+
   /*
    *  Listener cleanup
    */
@@ -204,7 +208,8 @@ application_del (application_t * app)
          segment_manager_del (sm);
        }
     }
-
+  props = segment_manager_properties_get (app->sm_properties);
+  segment_manager_properties_free (props);
   application_table_del (app);
   pool_put (app_pool, app);
 }
@@ -222,41 +227,85 @@ application_verify_cb_fns (session_cb_vft_t * cb_fns)
     clib_warning ("No session reset callback function provided");
 }
 
+/**
+ * Check app config for given segment type
+ *
+ * Returns 1 on success and 0 otherwise
+ */
+static u8
+application_verify_cfg (ssvm_segment_type_t st)
+{
+  u8 is_valid;
+  if (st == SSVM_SEGMENT_MEMFD)
+    {
+      is_valid = (session_manager_get_evt_q_segment () != 0);
+      if (!is_valid)
+       clib_warning ("memfd seg: vpp's event qs IN binary api svm region");
+      return is_valid;
+    }
+  else if (st == SSVM_SEGMENT_SHM)
+    {
+      is_valid = (session_manager_get_evt_q_segment () == 0);
+      if (!is_valid)
+       clib_warning ("shm seg: vpp's event qs NOT IN binary api svm region");
+      return is_valid;
+    }
+  else
+    return 1;
+}
+
 int
 application_init (application_t * app, u32 api_client_index, u64 * options,
                  session_cb_vft_t * cb_fns)
 {
-  segment_manager_t *sm;
-  segment_manager_properties_t *props;
+  ssvm_segment_type_t st = SSVM_SEGMENT_MEMFD;
   u32 app_evt_queue_size, first_seg_size;
-  u32 default_rx_fifo_size = 16 << 10, default_tx_fifo_size = 16 << 10;
+  segment_manager_properties_t *props;
+  vl_api_registration_t *reg;
+  segment_manager_t *sm;
   int rv;
 
-  app_evt_queue_size = options[APP_EVT_QUEUE_SIZE] > 0 ?
-    options[APP_EVT_QUEUE_SIZE] : default_app_evt_queue_size;
+  /*
+   * Make sure we support the requested configuration
+   */
+  reg = vl_api_client_index_to_registration (api_client_index);
+  if (!reg)
+    return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
+
+  if (vl_api_registration_file_index (reg) == ~0)
+    st = SSVM_SEGMENT_SHM;
+
+  if (!application_verify_cfg (st))
+    return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
 
   /*
    * Setup segment manager
    */
   sm = segment_manager_new ();
   sm->app_index = app->index;
-  props = &app->sm_properties;
-  props->add_segment_size = options[SESSION_OPTIONS_ADD_SEGMENT_SIZE];
-  props->rx_fifo_size = options[SESSION_OPTIONS_RX_FIFO_SIZE];
-  props->rx_fifo_size =
-    props->rx_fifo_size ? props->rx_fifo_size : default_rx_fifo_size;
-  props->tx_fifo_size = options[SESSION_OPTIONS_TX_FIFO_SIZE];
-  props->tx_fifo_size =
-    props->tx_fifo_size ? props->tx_fifo_size : default_tx_fifo_size;
-  props->add_segment = props->add_segment_size != 0;
+  props = segment_manager_properties_alloc ();
+  app->sm_properties = segment_manager_properties_index (props);
+  if (options[APP_OPTIONS_ADD_SEGMENT_SIZE])
+    {
+      props->add_segment_size = options[APP_OPTIONS_ADD_SEGMENT_SIZE];
+      props->add_segment = 1;
+    }
+  if (options[APP_OPTIONS_RX_FIFO_SIZE])
+    props->rx_fifo_size = options[APP_OPTIONS_RX_FIFO_SIZE];
+  if (options[APP_OPTIONS_TX_FIFO_SIZE])
+    props->tx_fifo_size = options[APP_OPTIONS_TX_FIFO_SIZE];
   props->preallocated_fifo_pairs = options[APP_OPTIONS_PREALLOC_FIFO_PAIRS];
-  props->use_private_segment = options[APP_OPTIONS_FLAGS]
-    & APP_OPTIONS_FLAGS_BUILTIN_APP;
   props->private_segment_count = options[APP_OPTIONS_PRIVATE_SEGMENT_COUNT];
-  props->private_segment_size = options[APP_OPTIONS_PRIVATE_SEGMENT_SIZE];
+  if (options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_IS_BUILTIN)
+    props->segment_type = SSVM_N_SEGMENT_TYPES;
+  else
+    props->segment_type = st;
 
-  first_seg_size = options[SESSION_OPTIONS_SEGMENT_SIZE];
-  if ((rv = segment_manager_init (sm, props, first_seg_size)))
+  app_evt_queue_size = options[APP_OPTIONS_EVT_QUEUE_SIZE] > 0 ?
+    options[APP_OPTIONS_EVT_QUEUE_SIZE] : default_app_evt_queue_size;
+  first_seg_size = options[APP_OPTIONS_SEGMENT_SIZE];
+  if ((rv = segment_manager_init (sm, app->sm_properties, first_seg_size,
+                                 app_evt_queue_size)))
     return rv;
   sm->first_is_protected = 1;
 
@@ -268,6 +317,8 @@ application_init (application_t * app, u32 api_client_index, u64 * options,
   app->flags = options[APP_OPTIONS_FLAGS];
   app->cb_fns = *cb_fns;
   app->ns_index = options[APP_OPTIONS_NAMESPACE];
+  app->listeners_table = hash_create (0, sizeof (u64));
+  app->proxied_transports = options[APP_OPTIONS_PROXY_TRANSPORT];
 
   /* If no scope enabled, default to global */
   if (!application_has_global_scope (app)
@@ -324,7 +375,7 @@ application_alloc_segment_manager (application_t * app)
     }
 
   sm = segment_manager_new ();
-  sm->properties = &app->sm_properties;
+  sm->properties_index = app->sm_properties;
 
   return sm;
 }
@@ -452,22 +503,32 @@ application_get_listen_segment_manager (application_t * app,
 int
 application_is_proxy (application_t * app)
 {
-  return !(app->flags & APP_OPTIONS_FLAGS_IS_PROXY);
+  return (app->flags & APP_OPTIONS_FLAGS_IS_PROXY);
+}
+
+int
+application_is_builtin (application_t * app)
+{
+  return (app->flags & APP_OPTIONS_FLAGS_IS_BUILTIN);
+}
+
+int
+application_is_builtin_proxy (application_t * app)
+{
+  return (application_is_proxy (app) && application_is_builtin (app));
 }
 
 int
 application_add_segment_notify (u32 app_index, u32 fifo_segment_index)
 {
   application_t *app = application_get (app_index);
-  u32 seg_size = 0;
-  u8 *seg_name;
+  svm_fifo_segment_private_t *fs;
 
   /* Send an API message to the external app, to map new segment */
   ASSERT (app->cb_fns.add_segment_callback);
 
-  segment_manager_get_segment_info (fifo_segment_index, &seg_name, &seg_size);
-  return app->cb_fns.add_segment_callback (app->api_client_index, seg_name,
-                                          seg_size);
+  fs = segment_manager_get_segment (fifo_segment_index);
+  return app->cb_fns.add_segment_callback (app->api_client_index, &fs->ssvm);
 }
 
 u8
@@ -489,20 +550,180 @@ application_n_listeners (application_t * app)
 }
 
 stream_session_t *
-application_first_listener (application_t * app)
+application_first_listener (application_t * app, u8 fib_proto,
+                           u8 transport_proto)
+{
+  stream_session_t *listener;
+  u64 handle;
+  u32 sm_index;
+  u8 sst;
+
+  sst = session_type_from_proto_and_ip (transport_proto,
+                                       fib_proto == FIB_PROTOCOL_IP4);
+
+  /* *INDENT-OFF* */
+   hash_foreach (handle, sm_index, app->listeners_table, ({
+     listener = listen_session_get_from_handle (handle);
+     if (listener->session_type == sst
+        && listener->listener_index != SESSION_PROXY_LISTENER_INDEX)
+       return listener;
+   }));
+  /* *INDENT-ON* */
+
+  return 0;
+}
+
+stream_session_t *
+application_proxy_listener (application_t * app, u8 fib_proto,
+                           u8 transport_proto)
 {
+  stream_session_t *listener;
   u64 handle;
   u32 sm_index;
+  u8 sst;
+
+  sst = session_type_from_proto_and_ip (transport_proto,
+                                       fib_proto == FIB_PROTOCOL_IP4);
 
   /* *INDENT-OFF* */
    hash_foreach (handle, sm_index, app->listeners_table, ({
-     return listen_session_get_from_handle (handle);
+     listener = listen_session_get_from_handle (handle);
+     if (listener->session_type == sst
+        && listener->listener_index == SESSION_PROXY_LISTENER_INDEX)
+       return listener;
    }));
   /* *INDENT-ON* */
 
   return 0;
 }
 
+static clib_error_t *
+application_start_stop_proxy_fib_proto (application_t * app, u8 fib_proto,
+                                       u8 transport_proto, u8 is_start)
+{
+  app_namespace_t *app_ns = app_namespace_get (app->ns_index);
+  u8 is_ip4 = (fib_proto == FIB_PROTOCOL_IP4);
+  session_endpoint_t sep = SESSION_ENDPOINT_NULL;
+  transport_connection_t *tc;
+  stream_session_t *s;
+  u64 handle;
+
+  if (is_start)
+    {
+      s = application_first_listener (app, fib_proto, transport_proto);
+      if (!s)
+       {
+         sep.is_ip4 = is_ip4;
+         sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
+         sep.sw_if_index = app_ns->sw_if_index;
+         sep.transport_proto = transport_proto;
+         application_start_listen (app, &sep, &handle);
+         s = listen_session_get_from_handle (handle);
+         s->listener_index = SESSION_PROXY_LISTENER_INDEX;
+       }
+    }
+  else
+    {
+      s = application_proxy_listener (app, fib_proto, transport_proto);
+      ASSERT (s);
+    }
+
+  tc = listen_session_get_transport (s);
+
+  if (!ip_is_zero (&tc->lcl_ip, 1))
+    {
+      u32 sti;
+      sep.is_ip4 = is_ip4;
+      sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
+      sep.transport_proto = transport_proto;
+      sep.port = 0;
+      sti = session_lookup_get_index_for_fib (fib_proto, sep.fib_index);
+      if (is_start)
+       session_lookup_add_session_endpoint (sti, &sep, s->session_index);
+      else
+       session_lookup_del_session_endpoint (sti, &sep);
+    }
+
+  return 0;
+}
+
+static void
+application_start_stop_proxy_local_scope (application_t * app,
+                                         u8 transport_proto, u8 is_start)
+{
+  session_endpoint_t sep = SESSION_ENDPOINT_NULL;
+  app_namespace_t *app_ns;
+  app_ns = app_namespace_get (app->ns_index);
+  sep.is_ip4 = 1;
+  sep.transport_proto = transport_proto;
+  sep.port = 0;
+
+  if (is_start)
+    {
+      session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
+                                          app->index);
+      sep.is_ip4 = 0;
+      session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
+                                          app->index);
+    }
+  else
+    {
+      session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
+      sep.is_ip4 = 0;
+      session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
+    }
+}
+
+void
+application_start_stop_proxy (application_t * app,
+                             transport_proto_t transport_proto, u8 is_start)
+{
+  if (application_has_local_scope (app))
+    application_start_stop_proxy_local_scope (app, transport_proto, is_start);
+
+  if (application_has_global_scope (app))
+    {
+      application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP4,
+                                             transport_proto, is_start);
+      application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP6,
+                                             transport_proto, is_start);
+    }
+}
+
+void
+application_setup_proxy (application_t * app)
+{
+  u16 transports = app->proxied_transports;
+  transport_proto_t tp;
+
+  ASSERT (application_is_proxy (app));
+  if (application_is_builtin (app))
+    return;
+
+  /* *INDENT-OFF* */
+  transport_proto_foreach (tp, ({
+    if (transports & (1 << tp))
+      application_start_stop_proxy (app, tp, 1);
+  }));
+  /* *INDENT-ON* */
+}
+
+void
+application_remove_proxy (application_t * app)
+{
+  u16 transports = app->proxied_transports;
+  transport_proto_t tp;
+
+  ASSERT (application_is_proxy (app));
+
+  /* *INDENT-OFF* */
+  transport_proto_foreach (tp, ({
+    if (transports & (1 << tp))
+      application_start_stop_proxy (app, tp, 0);
+  }));
+  /* *INDENT-ON* */
+}
+
 u8 *
 format_application_listener (u8 * s, va_list * args)
 {
@@ -609,6 +830,7 @@ format_application (u8 * s, va_list * args)
 {
   application_t *app = va_arg (*args, application_t *);
   CLIB_UNUSED (int verbose) = va_arg (*args, int);
+  segment_manager_properties_t *props;
   const u8 *app_ns_name;
   u8 *app_name;
 
@@ -616,27 +838,27 @@ format_application (u8 * s, va_list * args)
     {
       if (verbose)
        s = format (s, "%-10s%-20s%-15s%-15s%-15s%-15s%-15s", "Index", "Name",
-                   "Namespace", "API Client", "Add seg size", "Rx fifo size",
+                   "API Client", "Namespace", "Add seg size", "Rx fifo size",
                    "Tx fifo size");
       else
        s =
-         format (s, "%-10s%-20s%-15s%-20s", "Index", "Name", "Namespace",
-                 "API Client");
+         format (s, "%-10s%-20s%-15s%-40s", "Index", "Name", "API Client",
+                 "Namespace");
       return s;
     }
 
   app_name = app_get_name_from_reg_index (app);
   app_ns_name = app_namespace_id_from_index (app->ns_index);
+  props = segment_manager_properties_get (app->sm_properties);
   if (verbose)
     s =
-      format (s, "%-10d%-20s%-15s%-15d%-15d%-15d%-15d", app->index, app_name,
-             app_ns_name, app->api_client_index,
-             app->sm_properties.add_segment_size,
-             app->sm_properties.rx_fifo_size,
-             app->sm_properties.tx_fifo_size);
+      format (s, "%-10d%-20s%-15d%-15d%-15d%-15d%-15d", app->index, app_name,
+             app->api_client_index, app->ns_index,
+             props->add_segment_size,
+             props->rx_fifo_size, props->tx_fifo_size);
   else
-    s = format (s, "%-10d%-20s%-15s%-20d", app->index, app_name, app_ns_name,
-               app->api_client_index);
+    s = format (s, "%-10d%-20s%-15d%-40s", app->index, app_name,
+               app->api_client_index, app_ns_name);
   return s;
 }