/*
- * 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:
#include <vnet/session/application.h>
#include <vnet/session/application_interface.h>
+#include <vnet/session/application_namespace.h>
#include <vnet/session/session.h>
+static app_main_t app_main;
+
+#define app_interface_check_thread_and_barrier(_fn, _arg) \
+ if (PREDICT_FALSE (!vlib_thread_is_main_w_barrier ())) \
+ { \
+ vlib_rpc_call_main_thread (_fn, (u8 *) _arg, sizeof(*_arg)); \
+ return 0; \
+ }
+
+static void
+application_local_listener_session_endpoint (local_session_t * ll,
+ session_endpoint_t * sep)
+{
+ sep->transport_proto =
+ session_type_transport_proto (ll->listener_session_type);
+ sep->port = ll->port;
+ sep->is_ip4 = ll->listener_session_type & 1;
+}
+
+static app_listener_t *
+app_listener_alloc (application_t * app)
+{
+ app_listener_t *app_listener;
+ pool_get (app->listeners, app_listener);
+ clib_memset (app_listener, 0, sizeof (*app_listener));
+ app_listener->al_index = app_listener - app->listeners;
+ app_listener->app_index = app->app_index;
+ app_listener->session_index = SESSION_INVALID_INDEX;
+ app_listener->local_index = SESSION_INVALID_INDEX;
+ return app_listener;
+}
+
+app_listener_t *
+app_listener_get (application_t * app, u32 app_listener_index)
+{
+ return pool_elt_at_index (app->listeners, app_listener_index);
+}
+
+static void
+app_listener_free (application_t * app, app_listener_t * app_listener)
+{
+ clib_bitmap_free (app_listener->workers);
+ pool_put (app->listeners, app_listener);
+ if (CLIB_DEBUG)
+ clib_memset (app_listener, 0xfa, sizeof (*app_listener));
+}
+
+local_session_t *
+application_local_listen_session_alloc (application_t * app)
+{
+ local_session_t *ll;
+ pool_get_zero (app->local_listen_sessions, ll);
+ ll->session_index = ll - app->local_listen_sessions;
+ ll->session_type = session_type_from_proto_and_ip (TRANSPORT_PROTO_NONE, 0);
+ ll->app_index = app->app_index;
+ return ll;
+}
+
+void
+application_local_listen_session_free (application_t * app,
+ local_session_t * ll)
+{
+ pool_put (app->local_listen_sessions, ll);
+ if (CLIB_DEBUG)
+ clib_memset (ll, 0xfb, sizeof (*ll));
+}
+
+static u32
+app_listener_id (app_listener_t * al)
+{
+ ASSERT (al->app_index < 1 << 16 && al->al_index < 1 << 16);
+ return (al->app_index << 16 | al->al_index);
+}
+
+session_handle_t
+app_listener_handle (app_listener_t * al)
+{
+ return ((u64) SESSION_LISTENER_PREFIX << 32 | (u64) app_listener_id (al));
+}
+
+static void
+app_listener_id_parse (u32 listener_id, u32 * app_index,
+ u32 * app_listener_index)
+{
+ *app_index = listener_id >> 16;
+ *app_listener_index = listener_id & 0xFFFF;
+}
+
+void
+app_listener_handle_parse (session_handle_t handle, u32 * app_index,
+ u32 * app_listener_index)
+{
+ app_listener_id_parse (handle & 0xFFFFFFFF, app_index, app_listener_index);
+}
+
+static app_listener_t *
+app_listener_get_w_id (u32 listener_id)
+{
+ u32 app_index, app_listener_index;
+ application_t *app;
+
+ app_listener_id_parse (listener_id, &app_index, &app_listener_index);
+ app = application_get_if_valid (app_index);
+ if (!app)
+ return 0;
+ return app_listener_get (app, app_listener_index);
+}
+
+app_listener_t *
+app_listener_get_w_session (session_t * ls)
+{
+ application_t *app;
+
+ app = application_get_if_valid (ls->app_index);
+ if (!app)
+ return 0;
+ return app_listener_get (app, ls->al_index);
+}
+
+app_listener_t *
+app_listener_get_w_handle (session_handle_t handle)
+{
+
+ if (handle >> 32 != SESSION_LISTENER_PREFIX)
+ return 0;
+
+ return app_listener_get_w_id (handle & 0xFFFFFFFF);
+}
+
+app_listener_t *
+app_listener_lookup (application_t * app, session_endpoint_cfg_t * sep_ext)
+{
+ u32 table_index, fib_proto;
+ session_endpoint_t *sep;
+ session_handle_t handle;
+ local_session_t *ll;
+ session_t *ls;
+
+ sep = (session_endpoint_t *) sep_ext;
+ if (application_has_local_scope (app) && session_endpoint_is_local (sep))
+ {
+ table_index = application_local_session_table (app);
+ handle = session_lookup_endpoint_listener (table_index, sep, 1);
+ if (handle != SESSION_INVALID_HANDLE)
+ {
+ ll = application_get_local_listener_w_handle (handle);
+ return app_listener_get_w_session ((session_t *) ll);
+ }
+ }
+
+ fib_proto = session_endpoint_fib_proto (sep);
+ table_index = application_session_table (app, fib_proto);
+ handle = session_lookup_endpoint_listener (table_index, sep, 1);
+ if (handle != SESSION_INVALID_HANDLE)
+ {
+ ls = listen_session_get_from_handle (handle);
+ return app_listener_get_w_session ((session_t *) ls);
+ }
+
+ return 0;
+}
+
+int
+app_listener_alloc_and_init (application_t * app,
+ session_endpoint_cfg_t * sep,
+ app_listener_t ** listener)
+{
+ app_listener_t *app_listener;
+ local_session_t *ll = 0;
+ session_handle_t lh;
+ session_type_t st;
+ session_t *ls = 0;
+ int rv;
+
+ app_listener = app_listener_alloc (app);
+ st = session_type_from_proto_and_ip (sep->transport_proto, sep->is_ip4);
+
+ /*
+ * Add session endpoint to local session table. Only binds to "inaddr_any"
+ * (i.e., zero address) are added to local scope table.
+ */
+ if (application_has_local_scope (app)
+ && session_endpoint_is_local ((session_endpoint_t *) sep))
+ {
+ u32 table_index;
+
+ ll = application_local_listen_session_alloc (app);
+ ll->port = sep->port;
+ /* Store the original session type for the unbind */
+ ll->listener_session_type = st;
+ table_index = application_local_session_table (app);
+ lh = application_local_session_handle (ll);
+ session_lookup_add_session_endpoint (table_index,
+ (session_endpoint_t *) sep, lh);
+ app_listener->local_index = ll->session_index;
+ ll->al_index = app_listener->al_index;
+ }
+
+ if (application_has_global_scope (app))
+ {
+ /*
+ * Start listening on local endpoint for requested transport and scope.
+ * Creates a stream session with state LISTENING to be used in session
+ * lookups, prior to establishing connection. Requests transport to
+ * build it's own specific listening connection.
+ */
+ ls = listen_session_new (0, st);
+ ls->app_index = app->app_index;
+ ls->app_wrk_index = sep->app_wrk_index;
+
+ /* Listen pool can be reallocated if the transport is
+ * recursive (tls) */
+ lh = session_handle (ls);
+
+ if ((rv = session_listen (ls, sep)))
+ {
+ ls = session_get_from_handle (lh);
+ session_free (ls);
+ return rv;
+ }
+ app_listener->session_index = ls->session_index;
+ ls->al_index = app_listener->al_index;
+ }
+
+ if (!ll && !ls)
+ {
+ app_listener_free (app, app_listener);
+ return -1;
+ }
+
+ *listener = app_listener;
+ return 0;
+}
+
+void
+app_listener_cleanup (app_listener_t * al)
+{
+ application_t *app = application_get (al->app_index);
+
+ if (al->session_index != SESSION_INVALID_INDEX)
+ {
+ session_t *ls = session_get (al->session_index, 0);
+ session_stop_listen (ls);
+ listen_session_del (ls);
+ }
+ if (al->local_index != SESSION_INVALID_INDEX)
+ {
+ session_endpoint_t sep = SESSION_ENDPOINT_NULL;
+ local_session_t *ll;
+ u32 table_index;
+
+ table_index = application_local_session_table (app);
+ ll = application_get_local_listen_session (app, al->local_index);
+ application_local_listener_session_endpoint (ll, &sep);
+ session_lookup_del_session_endpoint (table_index, &sep);
+ application_local_listen_session_free (app, ll);
+ }
+ app_listener_free (app, al);
+}
+
+app_worker_t *
+app_listener_select_worker (app_listener_t * al)
+{
+ application_t *app;
+ u32 wrk_index;
+
+ app = application_get (al->app_index);
+ wrk_index = clib_bitmap_next_set (al->workers, al->accept_rotor + 1);
+ if (wrk_index == ~0)
+ wrk_index = clib_bitmap_first_set (al->workers);
+
+ ASSERT (wrk_index != ~0);
+ al->accept_rotor = wrk_index;
+ return application_get_worker (app, wrk_index);
+}
+
+session_t *
+app_listener_get_session (app_listener_t * al)
+{
+ if (al->session_index == SESSION_INVALID_INDEX)
+ return 0;
+
+ return listen_session_get (al->session_index);
+}
+
+static app_worker_map_t *
+app_worker_map_alloc (application_t * app)
+{
+ app_worker_map_t *map;
+ pool_get (app->worker_maps, map);
+ clib_memset (map, 0, sizeof (*map));
+ return map;
+}
+
+static u32
+app_worker_map_index (application_t * app, app_worker_map_t * map)
+{
+ return (map - app->worker_maps);
+}
+
+static void
+app_worker_map_free (application_t * app, app_worker_map_t * map)
+{
+ pool_put (app->worker_maps, map);
+}
+
+static app_worker_map_t *
+app_worker_map_get (application_t * app, u32 map_index)
+{
+ if (pool_is_free_index (app->worker_maps, map_index))
+ return 0;
+ return pool_elt_at_index (app->worker_maps, map_index);
+}
+
+static const u8 *
+app_get_name (application_t * app)
+{
+ return app->name;
+}
+
+u32
+application_session_table (application_t * app, u8 fib_proto)
+{
+ app_namespace_t *app_ns;
+ app_ns = app_namespace_get (app->ns_index);
+ if (!application_has_global_scope (app))
+ return APP_INVALID_INDEX;
+ if (fib_proto == FIB_PROTOCOL_IP4)
+ return session_lookup_get_index_for_fib (fib_proto,
+ app_ns->ip4_fib_index);
+ else
+ return session_lookup_get_index_for_fib (fib_proto,
+ app_ns->ip6_fib_index);
+}
+
+u32
+application_local_session_table (application_t * app)
+{
+ app_namespace_t *app_ns;
+ if (!application_has_local_scope (app))
+ return APP_INVALID_INDEX;
+ app_ns = app_namespace_get (app->ns_index);
+ return app_ns->local_table_index;
+}
+
+/**
+ * Returns app name for app-index
+ */
+const u8 *
+application_name_from_index (u32 app_index)
+{
+ application_t *app = application_get (app_index);
+ if (!app)
+ return 0;
+ return app_get_name (app);
+}
+
+static void
+application_api_table_add (u32 app_index, u32 api_client_index)
+{
+ if (api_client_index != APP_INVALID_INDEX)
+ hash_set (app_main.app_by_api_client_index, api_client_index, app_index);
+}
+
+static void
+application_api_table_del (u32 api_client_index)
+{
+ hash_unset (app_main.app_by_api_client_index, api_client_index);
+}
+
+static void
+application_name_table_add (application_t * app)
+{
+ hash_set_mem (app_main.app_by_name, app->name, app->app_index);
+}
+
+static void
+application_name_table_del (application_t * app)
+{
+ hash_unset_mem (app_main.app_by_name, app->name);
+}
+
+application_t *
+application_lookup (u32 api_client_index)
+{
+ uword *p;
+ p = hash_get (app_main.app_by_api_client_index, api_client_index);
+ if (p)
+ return application_get_if_valid (p[0]);
+
+ return 0;
+}
+
+application_t *
+application_lookup_name (const u8 * name)
+{
+ uword *p;
+ p = hash_get_mem (app_main.app_by_name, name);
+ if (p)
+ return application_get (p[0]);
+
+ return 0;
+}
+
+static application_t *
+application_alloc (void)
+{
+ application_t *app;
+ pool_get (app_main.app_pool, app);
+ clib_memset (app, 0, sizeof (*app));
+ app->app_index = app - app_main.app_pool;
+ return app;
+}
+
+application_t *
+application_get (u32 app_index)
+{
+ if (app_index == APP_INVALID_INDEX)
+ return 0;
+ return pool_elt_at_index (app_main.app_pool, app_index);
+}
+
+application_t *
+application_get_if_valid (u32 app_index)
+{
+ if (pool_is_free_index (app_main.app_pool, app_index))
+ return 0;
+
+ return pool_elt_at_index (app_main.app_pool, app_index);
+}
+
+static void
+application_verify_cb_fns (session_cb_vft_t * cb_fns)
+{
+ if (cb_fns->session_accept_callback == 0)
+ clib_warning ("No accept callback function provided");
+ if (cb_fns->session_connected_callback == 0)
+ clib_warning ("No session connected callback function provided");
+ if (cb_fns->session_disconnect_callback == 0)
+ clib_warning ("No session disconnect callback function provided");
+ if (cb_fns->session_reset_callback == 0)
+ 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;
+}
+
+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);
+}
+
/**
- * Pool from which we allocate all applications
+ * 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.
*/
-static application_t *app_pool;
+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;
+}
/**
- * Hash table of apps by api client index
+ * Detach application from vpp
*/
-static uword *app_by_api_client_index;
+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)
+ {
+ app_worker_t *owner_wrk;
+ application_t *owner_app;
+
+ owner_wrk = app_worker_get (sep->app_wrk_index);
+ owner_app = application_get (owner_wrk->app_index);
+ ns_index = owner_app->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;
+ }
-/**
- * Default application event queue size
- */
-static u32 default_app_evt_queue_size = 128;
+ 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
-application_api_queue_is_full (application_t * app)
+vnet_disconnect_session (vnet_disconnect_args_t * a)
{
- unix_shared_memory_queue_t *q;
+ if (session_handle_is_local (a->handle))
+ {
+ local_session_t *ls;
- /* builtin servers are always OK */
- if (app->api_client_index == ~0)
- return 0;
+ /* Disconnect reply came to worker 1 not main thread */
+ app_interface_check_thread_and_barrier (vnet_disconnect_session, a);
- q = vl_api_client_index_to_input_queue (app->api_client_index);
- if (!q)
- return 1;
+ if (!(ls = app_worker_get_local_session_from_handle (a->handle)))
+ return 0;
- if (q->cursize == q->maxsize)
- return 1;
+ return app_worker_local_session_disconnect (a->app_index, ls);
+ }
+ else
+ {
+ app_worker_t *app_wrk;
+ session_t *s;
+
+ s = session_get_from_handle_if_valid (a->handle);
+ if (!s)
+ return VNET_API_ERROR_INVALID_VALUE;
+ app_wrk = app_worker_get (s->app_wrk_index);
+ if (app_wrk->app_index != a->app_index)
+ return VNET_API_ERROR_INVALID_VALUE;
+
+ /* We're peeking into another's thread pool. Make sure */
+ ASSERT (s->session_index == session_index_from_handle (a->handle));
+
+ session_close (s);
+ }
return 0;
}
-static void
-application_table_add (application_t * app)
+int
+application_change_listener_owner (session_t * s, app_worker_t * app_wrk)
{
- hash_set (app_by_api_client_index, app->api_client_index, app->index);
+ app_worker_t *old_wrk = app_worker_get (s->app_wrk_index);
+ app_listener_t *app_listener;
+ application_t *app;
+
+ if (!old_wrk)
+ return -1;
+
+ hash_unset (old_wrk->listeners_table, listen_session_get_handle (s));
+ if (session_transport_service_type (s) == TRANSPORT_SERVICE_CL
+ && s->rx_fifo)
+ segment_manager_dealloc_fifos (s->rx_fifo->segment_index, s->rx_fifo,
+ s->tx_fifo);
+
+ app = application_get (old_wrk->app_index);
+ if (!app)
+ return -1;
+
+ app_listener = app_listener_get (app, s->al_index);
+
+ /* Only remove from lb for now */
+ app_listener->workers = clib_bitmap_set (app_listener->workers,
+ old_wrk->wrk_map_index, 0);
+
+ if (app_worker_start_listen (app_wrk, app_listener))
+ return -1;
+
+ s->app_wrk_index = app_wrk->wrk_index;
+
+ return 0;
}
-static void
-application_table_del (application_t * app)
+int
+application_is_proxy (application_t * app)
{
- hash_unset (app_by_api_client_index, app->api_client_index);
+ return (app->flags & APP_OPTIONS_FLAGS_IS_PROXY);
}
-application_t *
-application_lookup (u32 api_client_index)
+int
+application_is_builtin (application_t * app)
{
- uword *p;
- p = hash_get (app_by_api_client_index, api_client_index);
- if (p)
- return application_get (p[0]);
+ return (app->flags & APP_OPTIONS_FLAGS_IS_BUILTIN);
+}
- return 0;
+int
+application_is_builtin_proxy (application_t * app)
+{
+ return (application_is_proxy (app) && application_is_builtin (app));
}
-application_t *
-application_new ()
+u8
+application_has_local_scope (application_t * app)
{
- application_t *app;
- pool_get (app_pool, app);
- memset (app, 0, sizeof (*app));
- app->index = application_get_index (app);
- app->connects_seg_manager = ~0;
- return app;
+ return app->flags & APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
}
-void
-application_del (application_t * app)
+u8
+application_has_global_scope (application_t * app)
{
- segment_manager_t *sm;
- u64 handle;
- u32 index, *handles = 0;
- int i;
- vnet_unbind_args_t _a, *a = &_a;
+ return app->flags & APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
+}
- /*
- * The app event queue allocated in first segment is cleared with
- * the segment manager. No need to explicitly free it.
- */
+u8
+application_use_mq_for_ctrl (application_t * app)
+{
+ return app->flags & APP_OPTIONS_FLAGS_USE_MQ_FOR_CTRL_MSGS;
+}
- /*
- * Cleanup segment managers
- */
- if (app->connects_seg_manager != (u32) ~ 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_cfg_t sep = SESSION_ENDPOINT_CFG_NULL;
+ transport_connection_t *tc;
+ app_worker_t *app_wrk;
+ app_listener_t *al;
+ session_t *s;
+ u32 flags;
+
+ /* TODO decide if we want proxy to be enabled for all workers */
+ app_wrk = application_get_default_worker (app);
+ if (is_start)
+ {
+ s = app_worker_first_listener (app_wrk, 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;
+ sep.app_wrk_index = app_wrk->wrk_index; /* only default */
+
+ /* force global scope listener */
+ flags = app->flags;
+ app->flags &= ~APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
+ app_listener_alloc_and_init (app, &sep, &al);
+ app->flags = flags;
+
+ app_worker_start_listen (app_wrk, al);
+ s = listen_session_get (al->session_index);
+ s->enqueue_epoch = SESSION_PROXY_LISTENER_INDEX;
+ }
+ }
+ else
{
- sm = segment_manager_get (app->connects_seg_manager);
- segment_manager_del (sm);
+ s = app_worker_proxy_listener (app_wrk, fib_proto, transport_proto);
+ ASSERT (s);
}
- /* *INDENT-OFF* */
- hash_foreach (handle, index, app->listeners_table,
- ({
- vec_add1 (handles, handle);
- }));
- /* *INDENT-ON* */
+ tc = listen_session_get_transport (s);
- /* Actual listener cleanup */
- for (i = 0; i < vec_len (handles); i++)
+ if (!ip_is_zero (&tc->lcl_ip, 1))
{
- a->app_index = app->api_client_index;
- a->handle = handles[i];
- /* seg manager is removed when unbind completes */
- vnet_unbind (a);
+ 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,
+ (session_endpoint_t *) & sep,
+ s->session_index);
+ else
+ session_lookup_del_session_endpoint (sti,
+ (session_endpoint_t *) & sep);
}
- application_table_del (app);
- pool_put (app_pool, app);
+ return 0;
}
static void
-application_verify_cb_fns (session_cb_vft_t * cb_fns)
+application_start_stop_proxy_local_scope (application_t * app,
+ u8 transport_proto, u8 is_start)
{
- if (cb_fns->session_accept_callback == 0)
- clib_warning ("No accept callback function provided");
- if (cb_fns->session_connected_callback == 0)
- clib_warning ("No session connected callback function provided");
- if (cb_fns->session_disconnect_callback == 0)
- clib_warning ("No session disconnect callback function provided");
- if (cb_fns->session_reset_callback == 0)
- clib_warning ("No session reset callback function provided");
+ 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->app_index);
+ sep.is_ip4 = 0;
+ session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
+ app->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);
+ }
}
-int
-application_init (application_t * app, u32 api_client_index, u64 * options,
- session_cb_vft_t * cb_fns)
+void
+application_start_stop_proxy (application_t * app,
+ transport_proto_t transport_proto, u8 is_start)
{
- segment_manager_t *sm;
- segment_manager_properties_t *props;
- u32 app_evt_queue_size, first_seg_size;
- int rv;
+ if (application_has_local_scope (app))
+ application_start_stop_proxy_local_scope (app, transport_proto, is_start);
- app_evt_queue_size = options[APP_EVT_QUEUE_SIZE] > 0 ?
- options[APP_EVT_QUEUE_SIZE] : default_app_evt_queue_size;
+ 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);
+ }
+}
- /* 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->tx_fifo_size = options[SESSION_OPTIONS_TX_FIFO_SIZE];
- props->add_segment = props->add_segment_size != 0;
- props->use_private_segment = options[APP_OPTIONS_FLAGS]
- & APP_OPTIONS_FLAGS_BUILTIN_APP;
-
- first_seg_size = options[SESSION_OPTIONS_SEGMENT_SIZE];
- if ((rv = segment_manager_init (sm, props, first_seg_size)))
- return rv;
+void
+application_setup_proxy (application_t * app)
+{
+ u16 transports = app->proxied_transports;
+ transport_proto_t tp;
- app->first_segment_manager = segment_manager_index (sm);
- app->api_client_index = api_client_index;
- app->flags = options[APP_OPTIONS_FLAGS];
- app->cb_fns = *cb_fns;
+ ASSERT (application_is_proxy (app));
- /* Allocate app event queue in the first shared-memory segment */
- app->event_queue = segment_manager_alloc_queue (sm, app_evt_queue_size);
+ /* *INDENT-OFF* */
+ transport_proto_foreach (tp, ({
+ if (transports & (1 << tp))
+ application_start_stop_proxy (app, tp, 1);
+ }));
+ /* *INDENT-ON* */
+}
- /* Check that the obvious things are properly set up */
- application_verify_cb_fns (cb_fns);
+void
+application_remove_proxy (application_t * app)
+{
+ u16 transports = app->proxied_transports;
+ transport_proto_t tp;
- /* Add app to lookup by api_client_index table */
- application_table_add (app);
+ ASSERT (application_is_proxy (app));
- return 0;
+ /* *INDENT-OFF* */
+ transport_proto_foreach (tp, ({
+ if (transports & (1 << tp))
+ application_start_stop_proxy (app, tp, 0);
+ }));
+ /* *INDENT-ON* */
}
-application_t *
-application_get (u32 index)
+segment_manager_properties_t *
+application_segment_manager_properties (application_t * app)
{
- return pool_elt_at_index (app_pool, index);
+ return &app->sm_properties;
}
-application_t *
-application_get_if_valid (u32 index)
+segment_manager_properties_t *
+application_get_segment_manager_properties (u32 app_index)
{
- if (pool_is_free_index (app_pool, index))
- return 0;
-
- return pool_elt_at_index (app_pool, index);
+ application_t *app = application_get (app_index);
+ return &app->sm_properties;
}
-u32
-application_get_index (application_t * app)
+clib_error_t *
+vnet_app_add_tls_cert (vnet_app_add_tls_cert_args_t * a)
{
- return app - app_pool;
+ application_t *app;
+ app = application_get (a->app_index);
+ if (!app)
+ return clib_error_return_code (0, VNET_API_ERROR_APPLICATION_NOT_ATTACHED,
+ 0, "app %u doesn't exist", a->app_index);
+ app->tls_cert = vec_dup (a->cert);
+ return 0;
}
-static segment_manager_t *
-application_alloc_segment_manager (application_t * app)
+clib_error_t *
+vnet_app_add_tls_key (vnet_app_add_tls_key_args_t * a)
{
- segment_manager_t *sm = 0;
-
- if (app->first_segment_manager != (u32) ~ 0)
- {
- sm = segment_manager_get (app->first_segment_manager);
- app->first_segment_manager = ~0;
- return sm;
- }
-
- sm = segment_manager_new ();
- if (segment_manager_init (sm, &app->sm_properties, 0))
- return 0;
- return sm;
+ application_t *app;
+ app = application_get (a->app_index);
+ if (!app)
+ return clib_error_return_code (0, VNET_API_ERROR_APPLICATION_NOT_ATTACHED,
+ 0, "app %u doesn't exist", a->app_index);
+ app->tls_key = vec_dup (a->key);
+ return 0;
}
-/**
- * Start listening local transport endpoint for requested transport.
- *
- * Creates a 'dummy' stream session with state LISTENING to be used in session
- * lookups, prior to establishing connection. Requests transport to build
- * it's own specific listening connection.
- */
-int
-application_start_listen (application_t * srv, session_type_t session_type,
- transport_endpoint_t * tep, u64 * res)
+static void
+application_format_listeners (application_t * app, int verbose)
{
- segment_manager_t *sm;
- stream_session_t *s;
+ vlib_main_t *vm = vlib_get_main ();
+ app_worker_map_t *wrk_map;
+ app_worker_t *app_wrk;
+ u32 sm_index;
u64 handle;
- s = listen_session_new (session_type);
- s->app_index = srv->index;
-
- if (stream_session_listen (s, tep))
- goto err;
-
- /* Allocate segment manager. All sessions derived out of a listen session
- * have fifos allocated by the same segment manager. */
- sm = application_alloc_segment_manager (srv);
- if (sm == 0)
- goto err;
-
- /* Add to app's listener table. Useful to find all child listeners
- * when app goes down, although, just for unbinding this is not needed */
- handle = listen_session_get_handle (s);
- hash_set (srv->listeners_table, handle, segment_manager_index (sm));
-
- *res = handle;
- return 0;
+ if (!app)
+ {
+ vlib_cli_output (vm, "%U", format_app_worker_listener, 0 /* header */ ,
+ 0, 0, verbose);
+ return;
+ }
-err:
- listen_session_del (s);
- return -1;
+ /* *INDENT-OFF* */
+ pool_foreach (wrk_map, app->worker_maps, ({
+ app_wrk = app_worker_get (wrk_map->wrk_index);
+ if (hash_elts (app_wrk->listeners_table) == 0)
+ continue;
+ hash_foreach (handle, sm_index, app_wrk->listeners_table, ({
+ vlib_cli_output (vm, "%U", format_app_worker_listener, app_wrk,
+ handle, sm_index, verbose);
+ }));
+ }));
+ /* *INDENT-ON* */
}
-/**
- * Stop listening on session associated to handle
- */
-int
-application_stop_listen (application_t * srv, u64 handle)
+static void
+application_format_connects (application_t * app, int verbose)
{
- stream_session_t *listener;
- uword *indexp;
- segment_manager_t *sm;
+ app_worker_map_t *wrk_map;
+ app_worker_t *app_wrk;
- if (srv && hash_get (srv->listeners_table, handle) == 0)
+ if (!app)
{
- clib_warning ("app doesn't own handle %llu!", handle);
- return -1;
+ app_worker_format_connects (0, verbose);
+ return;
}
- listener = listen_session_get_from_handle (handle);
- stream_session_stop_listen (listener);
-
- indexp = hash_get (srv->listeners_table, handle);
- ASSERT (indexp);
-
- sm = segment_manager_get (*indexp);
- segment_manager_del (sm);
- hash_unset (srv->listeners_table, handle);
- listen_session_del (listener);
-
- return 0;
+ /* *INDENT-OFF* */
+ pool_foreach (wrk_map, app->worker_maps, ({
+ app_wrk = app_worker_get (wrk_map->wrk_index);
+ app_worker_format_connects (app_wrk, verbose);
+ }));
+ /* *INDENT-ON* */
}
-int
-application_open_session (application_t * app, session_type_t sst,
- transport_endpoint_t * tep, u32 api_context)
+static void
+application_format_local_sessions (application_t * app, int verbose)
{
- segment_manager_t *sm;
- transport_connection_t *tc = 0;
- int rv;
+ vlib_main_t *vm = vlib_get_main ();
+ app_worker_map_t *wrk_map;
+ app_worker_t *app_wrk;
+ transport_proto_t tp;
+ local_session_t *ls;
+ u8 *conn = 0;
- /* Make sure we have a segment manager for connects */
- if (app->connects_seg_manager == (u32) ~ 0)
+ if (!app)
{
- sm = application_alloc_segment_manager (app);
- if (sm == 0)
- return -1;
- app->connects_seg_manager = segment_manager_index (sm);
+ app_worker_format_local_sessions (0, verbose);
+ return;
}
- if ((rv = stream_session_open (app->index, sst, tep, &tc)))
- return rv;
-
- /* Store api_context for when the reply comes. Not the nicest thing
- * but better allocating a separate half-open pool. */
- tc->s_index = api_context;
-
- return 0;
-}
+ /*
+ * Format local listeners
+ */
-segment_manager_t *
-application_get_connect_segment_manager (application_t * app)
-{
- ASSERT (app->connects_seg_manager != (u32) ~ 0);
- return segment_manager_get (app->connects_seg_manager);
-}
+ /* *INDENT-OFF* */
+ pool_foreach (ls, app->local_listen_sessions, ({
+ tp = session_type_transport_proto (ls->listener_session_type);
+ conn = format (0, "[L][%U] *:%u", format_transport_proto_short, tp,
+ ls->port);
+ vlib_cli_output (vm, "%-40v%-15u%-20s", conn, ls->app_wrk_index, "*");
+ vec_reset_length (conn);
+ }));
+ /* *INDENT-ON* */
-segment_manager_t *
-application_get_listen_segment_manager (application_t * app,
- stream_session_t * s)
-{
- uword *smp;
- smp = hash_get (app->listeners_table, listen_session_get_handle (s));
- ASSERT (smp != 0);
- return segment_manager_get (*smp);
+ /*
+ * Format local accepted/connected sessions
+ */
+ /* *INDENT-OFF* */
+ pool_foreach (wrk_map, app->worker_maps, ({
+ app_wrk = app_worker_get (wrk_map->wrk_index);
+ app_worker_format_local_sessions (app_wrk, verbose);
+ }));
+ /* *INDENT-ON* */
}
-static u8 *
-app_get_name_from_reg_index (application_t * app)
+static void
+application_format_local_connects (application_t * app, int verbose)
{
- u8 *app_name;
+ app_worker_map_t *wrk_map;
+ app_worker_t *app_wrk;
- vl_api_registration_t *regp;
- regp = vl_api_client_index_to_registration (app->api_client_index);
- if (!regp)
- app_name = format (0, "builtin-%d%c", app->index, 0);
- else
- app_name = format (0, "%s%c", regp->name, 0);
+ if (!app)
+ {
+ app_worker_format_local_connects (0, verbose);
+ return;
+ }
- return app_name;
+ /* *INDENT-OFF* */
+ pool_foreach (wrk_map, app->worker_maps, ({
+ app_wrk = app_worker_get (wrk_map->wrk_index);
+ app_worker_format_local_connects (app_wrk, verbose);
+ }));
+ /* *INDENT-ON* */
}
u8 *
-format_application_listener (u8 * s, va_list * args)
+format_application (u8 * s, va_list * args)
{
application_t *app = va_arg (*args, application_t *);
- u64 handle = va_arg (*args, u64);
- u32 index = va_arg (*args, u32);
- int verbose = va_arg (*args, int);
- stream_session_t *listener;
- u8 *app_name, *str;
+ CLIB_UNUSED (int verbose) = va_arg (*args, int);
+ segment_manager_properties_t *props;
+ const u8 *app_ns_name, *app_name;
+ app_worker_map_t *wrk_map;
+ app_worker_t *app_wrk;
if (app == 0)
{
- if (verbose)
- s = format (s, "%-40s%-20s%-15s%-15s%-10s", "Connection", "App",
- "API Client", "ListenerID", "SegManager");
- else
- s = format (s, "%-40s%-20s", "Connection", "App");
-
+ if (!verbose)
+ s = format (s, "%-10s%-20s%-40s", "Index", "Name", "Namespace");
return s;
}
- app_name = app_get_name_from_reg_index (app);
- listener = listen_session_get_from_handle (handle);
- str = format (0, "%U", format_stream_session, listener, verbose);
-
- if (verbose)
+ app_name = app_get_name (app);
+ app_ns_name = app_namespace_id_from_index (app->ns_index);
+ props = application_segment_manager_properties (app);
+ if (!verbose)
{
- s = format (s, "%-40s%-20s%-15u%-15u%-10u", str, app_name,
- app->api_client_index, handle, index);
+ s = format (s, "%-10u%-20s%-40s", app->app_index, app_name,
+ app_ns_name);
+ return s;
}
- else
- s = format (s, "%-40s%-20s", str, app_name);
- vec_free (app_name);
+ s = format (s, "app-name %s app-index %u ns-index %u seg-size %U\n",
+ app_name, app->app_index, app->ns_index,
+ format_memory_size, props->add_segment_size);
+ s = format (s, "rx-fifo-size %U tx-fifo-size %U workers:\n",
+ format_memory_size, props->rx_fifo_size,
+ format_memory_size, props->tx_fifo_size);
+
+ /* *INDENT-OFF* */
+ pool_foreach (wrk_map, app->worker_maps, ({
+ app_wrk = app_worker_get (wrk_map->wrk_index);
+ s = format (s, "%U", format_app_worker, app_wrk);
+ }));
+ /* *INDENT-ON* */
+
return s;
}
void
-application_format_connects (application_t * app, int verbose)
+application_format_all_listeners (vlib_main_t * vm, int do_local, int verbose)
{
- vlib_main_t *vm = vlib_get_main ();
- segment_manager_t *sm;
- u8 *app_name, *s = 0;
- int i, j;
+ application_t *app;
- /* Header */
- if (app == 0)
+ if (!pool_elts (app_main.app_pool))
{
- if (verbose)
- vlib_cli_output (vm, "%-40s%-20s%-15s%-10s", "Connection", "App",
- "API Client", "SegManager");
- else
- vlib_cli_output (vm, "%-40s%-20s", "Connection", "App");
+ vlib_cli_output (vm, "No active server bindings");
return;
}
- /* make sure */
- if (app->connects_seg_manager == (u32) ~ 0)
- return;
-
- app_name = app_get_name_from_reg_index (app);
-
- /* Across all fifo segments */
- sm = segment_manager_get (app->connects_seg_manager);
- for (j = 0; j < vec_len (sm->segment_indices); j++)
+ if (do_local)
{
- svm_fifo_segment_private_t *fifo_segment;
- svm_fifo_t **fifos;
- u8 *str;
-
- fifo_segment = svm_fifo_get_segment (sm->segment_indices[j]);
- fifos = svm_fifo_segment_get_fifos (fifo_segment);
- for (i = 0; i < vec_len (fifos); i++)
- {
- svm_fifo_t *fifo;
- u32 session_index, thread_index;
- stream_session_t *session;
-
- /* There are 2 fifos/session. Avoid printing twice. */
- if (i % 2)
- continue;
-
- fifo = fifos[i];
- session_index = fifo->master_session_index;
- thread_index = fifo->master_thread_index;
-
- session = stream_session_get (session_index, thread_index);
- str = format (0, "%U", format_stream_session, session, verbose);
-
- if (verbose)
- s = format (s, "%-40s%-20s%-15u%-10u", str, app_name,
- app->api_client_index, app->connects_seg_manager);
- else
- s = format (s, "%-40s%-20s", str, app_name);
-
- vlib_cli_output (vm, "%v", s);
-
- vec_reset_length (s);
- vec_free (str);
- }
- vec_free (s);
+ application_format_local_sessions (0, verbose);
+ /* *INDENT-OFF* */
+ pool_foreach (app, app_main.app_pool, ({
+ application_format_local_sessions (app, verbose);
+ }));
+ /* *INDENT-ON* */
}
+ else
+ {
+ application_format_listeners (0, verbose);
- vec_free (app_name);
+ /* *INDENT-OFF* */
+ pool_foreach (app, app_main.app_pool, ({
+ application_format_listeners (app, verbose);
+ }));
+ /* *INDENT-ON* */
+ }
}
-u8 *
-format_application (u8 * s, va_list * args)
+void
+application_format_all_clients (vlib_main_t * vm, int do_local, int verbose)
{
- application_t *app = va_arg (*args, application_t *);
- CLIB_UNUSED (int verbose) = va_arg (*args, int);
- u8 *app_name;
+ application_t *app;
- if (app == 0)
+ if (!pool_elts (app_main.app_pool))
{
- if (verbose)
- s = format (s, "%-10s%-20s%-15s%-15s%-15s%-15s", "Index", "Name",
- "API Client", "Add seg size", "Rx fifo size",
- "Tx fifo size");
- else
- s = format (s, "%-10s%-20s%-20s", "Index", "Name", "API Client");
- return s;
+ vlib_cli_output (vm, "No active apps");
+ return;
}
- app_name = app_get_name_from_reg_index (app);
- if (verbose)
- s = format (s, "%-10d%-20s%-15d%-15d%-15d%-15d", app->index, app_name,
- app->api_client_index, app->sm_properties.add_segment_size,
- app->sm_properties.rx_fifo_size,
- app->sm_properties.tx_fifo_size);
+ if (do_local)
+ {
+ application_format_local_connects (0, verbose);
+
+ /* *INDENT-OFF* */
+ pool_foreach (app, app_main.app_pool, ({
+ application_format_local_connects (app, verbose);
+ }));
+ /* *INDENT-ON* */
+ }
else
- s = format (s, "%-10d%-20s%-20d", app->index, app_name,
- app->api_client_index);
- return s;
+ {
+ application_format_connects (0, verbose);
+
+ /* *INDENT-OFF* */
+ pool_foreach (app, app_main.app_pool, ({
+ application_format_connects (app, verbose);
+ }));
+ /* *INDENT-ON* */
+ }
}
static clib_error_t *
show_app_command_fn (vlib_main_t * vm, unformat_input_t * input,
vlib_cli_command_t * cmd)
{
+ int do_server = 0, do_client = 0, do_local = 0;
application_t *app;
- int do_server = 0;
- int do_client = 0;
+ u32 app_index = ~0;
int verbose = 0;
- if (!session_manager_is_enabled ())
- {
- clib_error_return (0, "session layer is not enabled");
- }
+ session_cli_return_if_not_enabled ();
while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
{
do_server = 1;
else if (unformat (input, "client"))
do_client = 1;
+ else if (unformat (input, "local"))
+ do_local = 1;
+ else if (unformat (input, "%u", &app_index))
+ ;
else if (unformat (input, "verbose"))
verbose = 1;
else
- break;
+ return clib_error_return (0, "unknown input `%U'",
+ format_unformat_error, input);
}
if (do_server)
{
- u64 handle;
- u32 index;
- if (pool_elts (app_pool))
- {
- vlib_cli_output (vm, "%U", format_application_listener,
- 0 /* header */ , 0, 0,
- verbose);
- /* *INDENT-OFF* */
- pool_foreach (app, app_pool,
- ({
- /* App's listener sessions */
- if (hash_elts (app->listeners_table) == 0)
- continue;
- hash_foreach (handle, index, app->listeners_table,
- ({
- vlib_cli_output (vm, "%U", format_application_listener, app,
- handle, index, verbose);
- }));
- }));
- /* *INDENT-ON* */
- }
- else
- vlib_cli_output (vm, "No active server bindings");
+ application_format_all_listeners (vm, do_local, verbose);
+ return 0;
}
if (do_client)
{
- if (pool_elts (app_pool))
- {
- application_format_connects (0, verbose);
-
- /* *INDENT-OFF* */
- pool_foreach (app, app_pool,
- ({
- if (app->connects_seg_manager == (u32)~0)
- continue;
- application_format_connects (app, verbose);
- }));
- /* *INDENT-ON* */
- }
- else
- vlib_cli_output (vm, "No active client bindings");
+ application_format_all_clients (vm, do_local, verbose);
+ return 0;
+ }
+
+ if (app_index != ~0)
+ {
+ app = application_get_if_valid (app_index);
+ if (!app)
+ return clib_error_return (0, "No app with index %u", app_index);
+
+ vlib_cli_output (vm, "%U", format_application, app, /* verbose */ 1);
+ return 0;
}
/* Print app related info */
if (!do_server && !do_client)
{
- vlib_cli_output (vm, "%U", format_application, 0, verbose);
- pool_foreach (app, app_pool, (
- {
- vlib_cli_output (vm, "%U",
- format_application, app,
- verbose);
- }
- ));
+ vlib_cli_output (vm, "%U", format_application, 0, 0);
+ /* *INDENT-OFF* */
+ pool_foreach (app, app_main.app_pool, ({
+ vlib_cli_output (vm, "%U", format_application, app, 0);
+ }));
+ /* *INDENT-ON* */
}
return 0;