#include <vnet/session/application.h>
#include <vnet/session/application_interface.h>
+#include <vnet/session/application_namespace.h>
#include <vnet/session/session.h>
/**
*/
static u32 default_app_evt_queue_size = 128;
+static u8 *
+app_get_name_from_reg_index (application_t * app)
+{
+ u8 *app_name;
+
+ 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);
+
+ 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;
+}
+
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)
return 0;
}
+/**
+ * Returns app name
+ *
+ * Since the name is not stored per app, we generate it on the fly. It is
+ * the caller's responsibility to free the vector
+ */
+u8 *
+application_name_from_index (u32 app_index)
+{
+ application_t *app = application_get (app_index);
+ if (!app)
+ return 0;
+ return app_get_name_from_reg_index (app);
+}
+
static void
application_table_add (application_t * app)
{
void
application_del (application_t * app)
{
+ 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
if (CLIB_DEBUG > 1)
clib_warning ("[%d] Delete app (%d)", getpid (), app->index);
+ if (application_is_proxy (app))
+ application_remove_proxy (app);
+
/*
* Listener cleanup
*/
segment_manager_init_del (sm);
}
-
/* If first segment manager is used by a listener */
if (app->first_segment_manager != APP_INVALID_SEGMENT_MANAGER_INDEX
&& app->first_segment_manager != app->connects_seg_manager)
segment_manager_del (sm);
}
}
-
application_table_del (app);
pool_put (app_pool, app);
}
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;
+ u32 app_evt_queue_size, first_seg_size, prealloc_fifo_pairs;
+ ssvm_segment_type_t seg_type = SSVM_SEGMENT_MEMFD;
segment_manager_properties_t *props;
- u32 app_evt_queue_size, first_seg_size;
- u32 default_rx_fifo_size = 16 << 10, default_tx_fifo_size = 16 << 10;
+ 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
+ */
- /* Setup segment manager */
+ if (!(options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_IS_BUILTIN))
+ {
+ 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) == VL_API_INVALID_FI)
+ seg_type = SSVM_SEGMENT_SHM;
+ }
+ else
+ {
+ seg_type = SSVM_SEGMENT_PRIVATE;
+ }
+
+ if (!application_verify_cfg (seg_type))
+ 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->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];
-
- first_seg_size = options[SESSION_OPTIONS_SEGMENT_SIZE];
- if ((rv = segment_manager_init (sm, props, first_seg_size)))
+ props = application_segment_manager_properties (app);
+ segment_manager_properties_init (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->segment_type = seg_type;
+
+ 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];
+ prealloc_fifo_pairs = options[APP_OPTIONS_PREALLOC_FIFO_PAIRS];
+
+ if ((rv = segment_manager_init (sm, first_seg_size, app_evt_queue_size,
+ prealloc_fifo_pairs)))
return rv;
sm->first_is_protected = 1;
+ /*
+ * Setup application
+ */
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;
+ app->ns_index = options[APP_OPTIONS_NAMESPACE];
+ app->listeners_table = hash_create (0, sizeof (u64));
+ app->proxied_transports = options[APP_OPTIONS_PROXY_TRANSPORT];
+ app->event_queue = segment_manager_event_queue (sm);
- /* Allocate app event queue in the first shared-memory segment */
- app->event_queue = segment_manager_alloc_queue (sm, app_evt_queue_size);
+ /* 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;
/* Check that the obvious things are properly set up */
application_verify_cb_fns (cb_fns);
application_t *
application_get (u32 index)
{
+ if (index == APP_INVALID_INDEX)
+ return 0;
return pool_elt_at_index (app_pool, index);
}
}
sm = segment_manager_new ();
- sm->properties = &app->sm_properties;
+ sm->app_index = app->index;
return sm;
}
* it's own specific listening connection.
*/
int
-application_start_listen (application_t * srv, session_type_t session_type,
- transport_endpoint_t * tep, u64 * res)
+application_start_listen (application_t * srv, session_endpoint_t * sep,
+ u64 * res)
{
segment_manager_t *sm;
stream_session_t *s;
u64 handle;
+ session_type_t sst;
- s = listen_session_new (session_type);
+ sst = session_type_from_proto_and_ip (sep->transport_proto, sep->is_ip4);
+ s = listen_session_new (sst);
s->app_index = srv->index;
- if (stream_session_listen (s, tep))
+ if (stream_session_listen (s, sep))
goto err;
/* Allocate segment manager. All sessions derived out of a listen session
}
int
-application_open_session (application_t * app, session_type_t sst,
- transport_endpoint_t * tep, u32 api_context)
+application_open_session (application_t * app, session_endpoint_t * sep,
+ u32 api_context)
{
segment_manager_t *sm;
- transport_connection_t *tc = 0;
int rv;
/* Make sure we have a segment manager for connects */
- if (app->connects_seg_manager == (u32) ~ 0)
+ if (app->connects_seg_manager == APP_INVALID_SEGMENT_MANAGER_INDEX)
{
sm = application_alloc_segment_manager (app);
if (sm == 0)
app->connects_seg_manager = segment_manager_index (sm);
}
- if ((rv = stream_session_open (app->index, sst, tep, &tc)))
+ if ((rv = session_open (app->index, sep, api_context)))
return rv;
- /* Store api_context for when the reply comes. Not the nicest thing
- * but better than allocating a separate half-open pool. */
- tc->s_index = api_context;
-
return 0;
}
return segment_manager_get (*smp);
}
-static u8 *
-app_get_name_from_reg_index (application_t * app)
+int
+application_is_proxy (application_t * app)
{
- u8 *app_name;
-
- 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);
+ return (app->flags & APP_OPTIONS_FLAGS_IS_PROXY);
+}
- return app_name;
+int
+application_is_builtin (application_t * app)
+{
+ return (app->flags & APP_OPTIONS_FLAGS_IS_BUILTIN);
}
int
-application_is_proxy (application_t * app)
+application_is_builtin_proxy (application_t * app)
{
- return !(app->flags & APP_OPTIONS_FLAGS_IS_PROXY);
+ return (application_is_proxy (app) && application_is_builtin (app));
}
+/**
+ * Send an API message to the external app, to map new segment
+ */
int
-application_add_segment_notify (u32 app_index, u32 fifo_segment_index)
+application_add_segment_notify (u32 app_index, ssvm_private_t * fs)
{
application_t *app = application_get (app_index);
- u32 seg_size = 0;
- u8 *seg_name;
+ return app->cb_fns.add_segment_callback (app->api_client_index, fs);
+}
+
+u8
+application_has_local_scope (application_t * app)
+{
+ return app->flags & APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
+}
- /* Send an API message to the external app, to map new segment */
- ASSERT (app->cb_fns.add_segment_callback);
+u8
+application_has_global_scope (application_t * app)
+{
+ return app->flags & APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
+}
- 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);
+u32
+application_n_listeners (application_t * app)
+{
+ return hash_elts (app->listeners_table);
+}
+
+stream_session_t *
+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, ({
+ 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));
+
+ /* *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* */
+}
+
+segment_manager_properties_t *
+application_segment_manager_properties (application_t * app)
+{
+ return &app->sm_properties;
+}
+
+segment_manager_properties_t *
+application_get_segment_manager_properties (u32 app_index)
+{
+ application_t *app = application_get (app_index);
+ return &app->sm_properties;
}
u8 *
void
application_format_connects (application_t * app, int verbose)
{
+ svm_fifo_segment_private_t *fifo_segment;
vlib_main_t *vm = vlib_get_main ();
segment_manager_t *sm;
u8 *app_name, *s = 0;
- int j;
/* Header */
if (app == 0)
/* Across all fifo segments */
sm = segment_manager_get (app->connects_seg_manager);
- for (j = 0; j < vec_len (sm->segment_indices); j++)
- {
- svm_fifo_segment_private_t *fifo_segment;
- svm_fifo_t *fifo;
- u8 *str;
- fifo_segment = svm_fifo_segment_get_segment (sm->segment_indices[j]);
- fifo = svm_fifo_segment_get_fifo_list (fifo_segment);
- while (fifo)
+ /* *INDENT-OFF* */
+ segment_manager_foreach_segment_w_lock (fifo_segment, sm, ({
+ svm_fifo_t *fifo;
+ u8 *str;
+
+ fifo = svm_fifo_segment_get_fifo_list (fifo_segment);
+ while (fifo)
{
u32 session_index, thread_index;
stream_session_t *session;
session_index = fifo->master_session_index;
thread_index = fifo->master_thread_index;
- session = stream_session_get (session_index, thread_index);
+ session = session_get (session_index, thread_index);
str = format (0, "%U", format_stream_session, session, verbose);
if (verbose)
fifo = fifo->next;
}
- vec_free (s);
- }
+ vec_free (s);
+ }));
+ /* *INDENT-ON* */
vec_free (app_name);
}
{
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;
if (app == 0)
{
if (verbose)
- s = format (s, "%-10s%-20s%-15s%-15s%-15s%-15s", "Index", "Name",
- "API Client", "Add seg size", "Rx fifo size",
+ s = format (s, "%-10s%-20s%-15s%-15s%-15s%-15s%-15s", "Index", "Name",
+ "API Client", "Namespace", "Add seg size", "Rx fifo size",
"Tx fifo size");
else
- s = format (s, "%-10s%-20s%-20s", "Index", "Name", "API Client");
+ s =
+ 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 = application_segment_manager_properties (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);
+ s =
+ 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%-20d", app->index, app_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;
}
int do_client = 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)
{
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,
- ({
+ 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,
- ({
+ 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");
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);
- }
- ));
+ /* *INDENT-OFF* */
+ pool_foreach (app, app_pool, ({
+ vlib_cli_output (vm, "%U", format_application, app, verbose);
+ }));
+ /* *INDENT-ON* */
}
return 0;