+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;
+}
+
+static int
+application_alloc_and_init (app_init_args_t * a)
+{
+ ssvm_segment_type_t seg_type = SSVM_SEGMENT_MEMFD;
+ segment_manager_properties_t *props;
+ vl_api_registration_t *reg;
+ application_t *app;
+ u64 *options;
+
+ app = application_alloc ();
+ options = a->options;
+ /*
+ * Make sure we support the requested configuration
+ */
+ if (!(options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_IS_BUILTIN))
+ {
+ reg = vl_api_client_index_to_registration (a->api_client_index);
+ if (!reg)
+ return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
+ if (vl_api_registration_file_index (reg) == VL_API_INVALID_FI)
+ seg_type = SSVM_SEGMENT_SHM;
+ }
+ else
+ {
+ if (options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
+ {
+ clib_warning ("mq eventfds can only be used if socket transport is "
+ "used for api");
+ return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
+ }
+ seg_type = SSVM_SEGMENT_PRIVATE;
+ }
+
+ if (!application_verify_cfg (seg_type))
+ return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
+
+ /* Check that the obvious things are properly set up */
+ application_verify_cb_fns (a->session_cb_vft);
+
+ app->flags = options[APP_OPTIONS_FLAGS];
+ app->cb_fns = *a->session_cb_vft;
+ app->ns_index = options[APP_OPTIONS_NAMESPACE];
+ app->proxied_transports = options[APP_OPTIONS_PROXY_TRANSPORT];
+ app->name = vec_dup (a->name);
+
+ /* If no scope enabled, default to global */
+ if (!application_has_global_scope (app)
+ && !application_has_local_scope (app))
+ app->flags |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
+
+ props = application_segment_manager_properties (app);
+ segment_manager_properties_init (props);
+ props->segment_size = options[APP_OPTIONS_ADD_SEGMENT_SIZE];
+ props->prealloc_fifos = options[APP_OPTIONS_PREALLOC_FIFO_PAIRS];
+ 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];
+ if (options[APP_OPTIONS_EVT_QUEUE_SIZE])
+ props->evt_q_size = options[APP_OPTIONS_EVT_QUEUE_SIZE];
+ if (options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
+ props->use_mq_eventfd = 1;
+ if (options[APP_OPTIONS_TLS_ENGINE])
+ app->tls_engine = options[APP_OPTIONS_TLS_ENGINE];
+ props->segment_type = seg_type;
+
+ /* Add app to lookup by api_client_index table */
+ if (!application_is_builtin (app))
+ application_api_table_add (app->app_index, a->api_client_index);
+ else
+ application_name_table_add (app);
+
+ a->app_index = app->app_index;
+
+ APP_DBG ("New app name: %v api index: %u index %u", app->name,
+ app->api_client_index, app->app_index);
+
+ return 0;
+}
+
+static void
+application_free (application_t * app)
+{
+ app_worker_map_t *wrk_map;
+ app_worker_t *app_wrk;
+ u32 table_index;
+ local_session_t *ll;
+ session_endpoint_t sep;
+
+ /*
+ * The app event queue allocated in first segment is cleared with
+ * the segment manager. No need to explicitly free it.
+ */
+ APP_DBG ("Delete app name %v api index: %d index: %d", app->name,
+ app->api_client_index, app->app_index);
+
+ if (application_is_proxy (app))
+ application_remove_proxy (app);
+
+ /*
+ * Free workers
+ */
+
+ /* *INDENT-OFF* */
+ pool_flush (wrk_map, app->worker_maps, ({
+ app_wrk = app_worker_get (wrk_map->wrk_index);
+ app_worker_free (app_wrk);
+ }));
+ /* *INDENT-ON* */
+ pool_free (app->worker_maps);
+
+ /*
+ * Free local listeners. Global table unbinds stop local listeners
+ * as well, but if we have only local binds, these won't be cleaned up.
+ * Don't bother with local accepted sessions, we clean them when
+ * cleaning up the worker.
+ */
+ table_index = application_local_session_table (app);
+ /* *INDENT-OFF* */
+ pool_foreach (ll, app->local_listen_sessions, ({
+ application_local_listener_session_endpoint (ll, &sep);
+ session_lookup_del_session_endpoint (table_index, &sep);
+ }));
+ /* *INDENT-ON* */
+ pool_free (app->local_listen_sessions);
+
+ /*
+ * Cleanup remaining state
+ */
+ if (application_is_builtin (app))
+ application_name_table_del (app);
+ vec_free (app->name);
+ vec_free (app->tls_cert);
+ vec_free (app->tls_key);
+ pool_put (app_main.app_pool, app);
+}
+
+static void
+application_detach_process (application_t * app, u32 api_client_index)
+{
+ vnet_app_worker_add_del_args_t _args = { 0 }, *args = &_args;
+ app_worker_map_t *wrk_map;
+ u32 *wrks = 0, *wrk_index;
+ app_worker_t *app_wrk;
+
+ if (api_client_index == ~0)
+ {
+ application_free (app);
+ return;
+ }
+
+ APP_DBG ("Detaching for app %v index %u api client index %u", app->name,
+ app->app_index, app->api_client_index);
+
+ /* *INDENT-OFF* */
+ pool_foreach (wrk_map, app->worker_maps, ({
+ app_wrk = app_worker_get (wrk_map->wrk_index);
+ if (app_wrk->api_client_index == api_client_index)
+ vec_add1 (wrks, app_wrk->wrk_index);
+ }));
+ /* *INDENT-ON* */
+
+ if (!vec_len (wrks))
+ {
+ clib_warning ("no workers for app %u api_index %u", app->app_index,
+ api_client_index);
+ return;
+ }
+
+ args->app_index = app->app_index;
+ args->api_client_index = api_client_index;
+ vec_foreach (wrk_index, wrks)
+ {
+ app_wrk = app_worker_get (wrk_index[0]);
+ args->wrk_map_index = app_wrk->wrk_map_index;
+ args->is_add = 0;
+ vnet_app_worker_add_del (args);
+ }
+ vec_free (wrks);
+}
+
+app_worker_t *
+application_get_worker (application_t * app, u32 wrk_map_index)
+{
+ app_worker_map_t *map;
+ map = app_worker_map_get (app, wrk_map_index);
+ if (!map)
+ return 0;
+ return app_worker_get (map->wrk_index);
+}
+
+app_worker_t *
+application_get_default_worker (application_t * app)
+{
+ return application_get_worker (app, 0);
+}
+
+u32
+application_n_workers (application_t * app)
+{
+ return pool_elts (app->worker_maps);
+}
+
+app_worker_t *
+application_listener_select_worker (session_t * ls)
+{
+ app_listener_t *al;
+
+ al = app_listener_get_w_session (ls);
+ return app_listener_select_worker (al);
+}
+
+int
+application_alloc_worker_and_init (application_t * app, app_worker_t ** wrk)
+{
+ app_worker_map_t *wrk_map;
+ app_worker_t *app_wrk;
+ segment_manager_t *sm;
+ int rv;
+
+ app_wrk = app_worker_alloc (app);
+ wrk_map = app_worker_map_alloc (app);
+ wrk_map->wrk_index = app_wrk->wrk_index;
+ app_wrk->wrk_map_index = app_worker_map_index (app, wrk_map);
+
+ /*
+ * Setup first segment manager
+ */
+ sm = segment_manager_new ();
+ sm->app_wrk_index = app_wrk->wrk_index;
+
+ if ((rv = segment_manager_init (sm, app->sm_properties.segment_size,
+ app->sm_properties.prealloc_fifos)))
+ {
+ app_worker_free (app_wrk);
+ return rv;
+ }
+ sm->first_is_protected = 1;
+
+ /*
+ * Setup app worker
+ */
+ app_wrk->first_segment_manager = segment_manager_index (sm);
+ app_wrk->listeners_table = hash_create (0, sizeof (u64));
+ app_wrk->event_queue = segment_manager_event_queue (sm);
+ app_wrk->app_is_builtin = application_is_builtin (app);
+
+ /*
+ * Segment manager for local sessions
+ */
+ sm = segment_manager_new ();
+ sm->app_wrk_index = app_wrk->wrk_index;
+ app_wrk->local_segment_manager = segment_manager_index (sm);
+ app_wrk->local_connects = hash_create (0, sizeof (u64));
+
+ *wrk = app_wrk;
+
+ return 0;
+}
+
+int
+vnet_app_worker_add_del (vnet_app_worker_add_del_args_t * a)
+{
+ svm_fifo_segment_private_t *fs;
+ app_worker_map_t *wrk_map;
+ app_worker_t *app_wrk;
+ segment_manager_t *sm;
+ application_t *app;
+ int rv;
+
+ app = application_get (a->app_index);
+ if (!app)
+ return VNET_API_ERROR_INVALID_VALUE;
+
+ if (a->is_add)
+ {
+ if ((rv = application_alloc_worker_and_init (app, &app_wrk)))
+ return rv;
+
+ /* Map worker api index to the app */
+ app_wrk->api_client_index = a->api_client_index;
+ application_api_table_add (app->app_index, a->api_client_index);
+
+ sm = segment_manager_get (app_wrk->first_segment_manager);
+ fs = segment_manager_get_segment_w_lock (sm, 0);
+ a->segment = &fs->ssvm;
+ a->segment_handle = segment_manager_segment_handle (sm, fs);
+ segment_manager_segment_reader_unlock (sm);
+ a->evt_q = app_wrk->event_queue;
+ a->wrk_map_index = app_wrk->wrk_map_index;
+ }
+ else
+ {
+ wrk_map = app_worker_map_get (app, a->wrk_map_index);
+ if (!wrk_map)
+ return VNET_API_ERROR_INVALID_VALUE;
+
+ app_wrk = app_worker_get (wrk_map->wrk_index);
+ if (!app_wrk)
+ return VNET_API_ERROR_INVALID_VALUE;
+
+ application_api_table_del (app_wrk->api_client_index);
+ app_worker_free (app_wrk);
+ app_worker_map_free (app, wrk_map);
+ if (application_n_workers (app) == 0)
+ application_free (app);
+ }
+ return 0;
+}
+
+static int
+app_validate_namespace (u8 * namespace_id, u64 secret, u32 * app_ns_index)
+{
+ app_namespace_t *app_ns;
+ if (vec_len (namespace_id) == 0)
+ {
+ /* Use default namespace */
+ *app_ns_index = 0;
+ return 0;
+ }
+
+ *app_ns_index = app_namespace_index_from_id (namespace_id);
+ if (*app_ns_index == APP_NAMESPACE_INVALID_INDEX)
+ return VNET_API_ERROR_APP_INVALID_NS;
+ app_ns = app_namespace_get (*app_ns_index);
+ if (!app_ns)
+ return VNET_API_ERROR_APP_INVALID_NS;
+ if (app_ns->ns_secret != secret)
+ return VNET_API_ERROR_APP_WRONG_NS_SECRET;
+ return 0;
+}
+
+static u8 *
+app_name_from_api_index (u32 api_client_index)
+{
+ vl_api_registration_t *regp;
+ regp = vl_api_client_index_to_registration (api_client_index);
+ if (regp)
+ return format (0, "%s%c", regp->name, 0);
+
+ clib_warning ("api client index %u does not have an api registration!",
+ api_client_index);
+ return format (0, "unknown%c", 0);
+}
+
+/**
+ * Attach application to vpp
+ *
+ * Allocates a vpp app, i.e., a structure that keeps back pointers
+ * to external app and a segment manager for shared memory fifo based
+ * communication with the external app.
+ */
+int
+vnet_application_attach (vnet_app_attach_args_t * a)
+{
+ svm_fifo_segment_private_t *fs;
+ application_t *app = 0;
+ app_worker_t *app_wrk;
+ segment_manager_t *sm;
+ u32 app_ns_index = 0;
+ u8 *app_name = 0;
+ u64 secret;
+ int rv;
+
+ if (a->api_client_index != APP_INVALID_INDEX)
+ app = application_lookup (a->api_client_index);
+ else if (a->name)
+ app = application_lookup_name (a->name);
+ else
+ return VNET_API_ERROR_INVALID_VALUE;
+
+ if (app)
+ return VNET_API_ERROR_APP_ALREADY_ATTACHED;
+
+ if (a->api_client_index != APP_INVALID_INDEX)
+ {
+ app_name = app_name_from_api_index (a->api_client_index);
+ a->name = app_name;
+ }
+
+ secret = a->options[APP_OPTIONS_NAMESPACE_SECRET];
+ if ((rv = app_validate_namespace (a->namespace_id, secret, &app_ns_index)))
+ return rv;
+ a->options[APP_OPTIONS_NAMESPACE] = app_ns_index;
+
+ if ((rv = application_alloc_and_init ((app_init_args_t *) a)))
+ return rv;
+
+ app = application_get (a->app_index);
+ if ((rv = application_alloc_worker_and_init (app, &app_wrk)))
+ return rv;
+
+ a->app_evt_q = app_wrk->event_queue;
+ app_wrk->api_client_index = a->api_client_index;
+ sm = segment_manager_get (app_wrk->first_segment_manager);
+ fs = segment_manager_get_segment_w_lock (sm, 0);
+
+ if (application_is_proxy (app))
+ application_setup_proxy (app);
+
+ ASSERT (vec_len (fs->ssvm.name) <= 128);
+ a->segment = &fs->ssvm;
+ a->segment_handle = segment_manager_segment_handle (sm, fs);
+
+ segment_manager_segment_reader_unlock (sm);
+ vec_free (app_name);
+ return 0;
+}
+
+/**
+ * Detach application from vpp
+ */
+int
+vnet_application_detach (vnet_app_detach_args_t * a)
+{
+ application_t *app;
+
+ app = application_get_if_valid (a->app_index);
+ if (!app)
+ {
+ clib_warning ("app not attached");
+ return VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
+ }
+
+ app_interface_check_thread_and_barrier (vnet_application_detach, a);
+ application_detach_process (app, a->api_client_index);
+ return 0;
+}
+
+
+static u8
+session_endpoint_in_ns (session_endpoint_t * sep)
+{
+ u8 is_lep = session_endpoint_is_local (sep);
+ if (!is_lep && sep->sw_if_index != ENDPOINT_INVALID_INDEX
+ && !ip_interface_has_address (sep->sw_if_index, &sep->ip, sep->is_ip4))
+ {
+ clib_warning ("sw_if_index %u not configured with ip %U",
+ sep->sw_if_index, format_ip46_address, &sep->ip,
+ sep->is_ip4);
+ return 0;
+ }
+ return (is_lep || ip_is_local (sep->fib_index, &sep->ip, sep->is_ip4));
+}
+
+static void
+session_endpoint_update_for_app (session_endpoint_cfg_t * sep,
+ application_t * app, u8 is_connect)
+{
+ app_namespace_t *app_ns;
+ u32 ns_index, fib_index;
+
+ ns_index = app->ns_index;
+
+ /* App is a transport proto, so fetch the calling app's ns */
+ if (app->flags & APP_OPTIONS_FLAGS_IS_TRANSPORT_APP)
+ ns_index = sep->ns_index;
+
+ app_ns = app_namespace_get (ns_index);
+ if (!app_ns)
+ return;
+
+ /* Ask transport and network to bind to/connect using local interface
+ * that "supports" app's namespace. This will fix our local connection
+ * endpoint.
+ */
+
+ /* If in default namespace and user requested a fib index use it */
+ if (ns_index == 0 && sep->fib_index != ENDPOINT_INVALID_INDEX)
+ fib_index = sep->fib_index;
+ else
+ fib_index = sep->is_ip4 ? app_ns->ip4_fib_index : app_ns->ip6_fib_index;
+ sep->peer.fib_index = fib_index;
+ sep->fib_index = fib_index;
+
+ if (!is_connect)
+ {
+ sep->sw_if_index = app_ns->sw_if_index;
+ }
+ else
+ {
+ if (app_ns->sw_if_index != APP_NAMESPACE_INVALID_INDEX
+ && sep->peer.sw_if_index != ENDPOINT_INVALID_INDEX
+ && sep->peer.sw_if_index != app_ns->sw_if_index)
+ clib_warning ("Local sw_if_index different from app ns sw_if_index");
+
+ sep->peer.sw_if_index = app_ns->sw_if_index;
+ }
+}
+
+int
+vnet_listen (vnet_listen_args_t * a)
+{
+ app_listener_t *app_listener;
+ app_worker_t *app_wrk;
+ application_t *app;
+ int rv;
+
+ app = application_get_if_valid (a->app_index);
+ if (!app)
+ return VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
+
+ app_wrk = application_get_worker (app, a->wrk_map_index);
+ if (!app_wrk)
+ return VNET_API_ERROR_INVALID_VALUE;
+
+ a->sep_ext.app_wrk_index = app_wrk->wrk_index;
+
+ session_endpoint_update_for_app (&a->sep_ext, app, 0 /* is_connect */ );
+ if (!session_endpoint_in_ns (&a->sep))
+ return VNET_API_ERROR_INVALID_VALUE_2;
+
+ /*
+ * Check if we already have an app listener
+ */
+ app_listener = app_listener_lookup (app, &a->sep_ext);
+ if (app_listener)
+ {
+ if (app_listener->app_index != app->app_index)
+ return VNET_API_ERROR_ADDRESS_IN_USE;
+ if (app_worker_start_listen (app_wrk, app_listener))
+ return -1;
+ a->handle = app_listener_handle (app_listener);
+ return 0;
+ }
+
+ /*
+ * Create new app listener
+ */
+ if ((rv = app_listener_alloc_and_init (app, &a->sep_ext, &app_listener)))
+ return rv;
+
+ if ((rv = app_worker_start_listen (app_wrk, app_listener)))
+ {
+ app_listener_cleanup (app_listener);
+ return rv;
+ }
+
+ a->handle = app_listener_handle (app_listener);
+ return 0;
+}
+
+int
+vnet_connect (vnet_connect_args_t * a)
+{
+ app_worker_t *server_wrk, *client_wrk;
+ application_t *client;
+ local_session_t *ll;
+ app_listener_t *al;
+ u32 table_index;
+ session_t *ls;
+ u8 fib_proto;
+ u64 lh;
+
+ if (session_endpoint_is_zero (&a->sep))
+ return VNET_API_ERROR_INVALID_VALUE;
+
+ client = application_get (a->app_index);
+ session_endpoint_update_for_app (&a->sep_ext, client, 1 /* is_connect */ );
+ client_wrk = application_get_worker (client, a->wrk_map_index);
+
+ /*
+ * First check the local scope for locally attached destinations.
+ * If we have local scope, we pass *all* connects through it since we may
+ * have special policy rules even for non-local destinations, think proxy.
+ */
+ if (application_has_local_scope (client))
+ {
+ table_index = application_local_session_table (client);
+ lh = session_lookup_local_endpoint (table_index, &a->sep);
+ if (lh == SESSION_DROP_HANDLE)
+ return VNET_API_ERROR_APP_CONNECT_FILTERED;
+
+ if (lh == SESSION_INVALID_HANDLE)
+ goto global_scope;
+
+ ll = application_get_local_listener_w_handle (lh);
+ al = app_listener_get_w_session ((session_t *) ll);
+
+ /*
+ * Break loop if rule in local table points to connecting app. This
+ * can happen if client is a generic proxy. Route connect through
+ * global table instead.
+ */
+ if (al->app_index == a->app_index)
+ goto global_scope;
+
+ server_wrk = app_listener_select_worker (al);
+ return app_worker_local_session_connect (client_wrk, server_wrk, ll,
+ a->api_context);
+ }
+
+ /*
+ * If nothing found, check the global scope for locally attached
+ * destinations. Make sure first that we're allowed to.
+ */
+
+global_scope:
+ if (session_endpoint_is_local (&a->sep))
+ return VNET_API_ERROR_SESSION_CONNECT;
+
+ if (!application_has_global_scope (client))
+ return VNET_API_ERROR_APP_CONNECT_SCOPE;
+
+ fib_proto = session_endpoint_fib_proto (&a->sep);
+ table_index = application_session_table (client, fib_proto);
+ ls = session_lookup_listener (table_index, &a->sep);
+ if (ls)
+ {
+ al = app_listener_get_w_session (ls);
+ server_wrk = app_listener_select_worker (al);
+ ll = (local_session_t *) ls;
+ return app_worker_local_session_connect (client_wrk, server_wrk, ll,
+ a->api_context);
+ }
+
+ /*
+ * Not connecting to a local server, propagate to transport
+ */
+ if (app_worker_connect_session (client_wrk, &a->sep, a->api_context))
+ return VNET_API_ERROR_SESSION_CONNECT;
+ return 0;
+}
+
+int
+vnet_unlisten (vnet_unlisten_args_t * a)
+{
+ app_worker_t *app_wrk;
+ app_listener_t *al;
+ application_t *app;
+
+ if (!(app = application_get_if_valid (a->app_index)))
+ return VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
+
+ al = app_listener_get_w_handle (a->handle);
+ if (al->app_index != app->app_index)
+ {
+ clib_warning ("app doesn't own handle %llu!", a->handle);
+ return -1;
+ }
+
+ app_wrk = application_get_worker (app, a->wrk_map_index);
+ if (!app_wrk)
+ {
+ clib_warning ("no app %u worker %u", app->app_index, a->wrk_map_index);
+ return -1;
+ }
+
+ return app_worker_stop_listen (app_wrk, al);
+}
+
+int
+vnet_disconnect_session (vnet_disconnect_args_t * a)
+{
+ if (session_handle_is_local (a->handle))
+ {
+ app_worker_t *client_wrk, *server_wrk;
+ local_session_t *ls;
+ u32 wrk_index = ~0;