session: add support for application namespacing
Applications are now provided the option to select the namespace they
are to be attached to and the scope of their attachement. Application
namespaces are meant to:
1) constrain the scope of communication through the network by
association with source interfaces and/or fib tables that provide the
source ips to be used and limit the scope of routing
2) provide a namespace local scope to session layer communication, as
opposed to the global scope provided by 1). That is, sessions can be
established without assistance from transport and network layers.
Albeit, zero/local-host ip addresses must still be provided in session
establishment messages due to existing application idiosyncrasies. This
mode of communication uses shared-memory fifos (cut-through sessions)
exclusively.
If applications request no namespace, they are assigned to the default
one, which at its turn uses the default fib. Applications can request
access to both local and global scopes for a namespace. If no scope is
specified, session layer defaults to the global one.
When a sw_if_index is provided for a namespace, zero-ip (INADDR_ANY)
binds are converted to binds to the requested interface.
Change-Id: Ia0f660bbf7eec7f89673f75b4821fc7c3d58e3d1
Signed-off-by: Florin Coras <fcoras@cisco.com>
diff --git a/src/vnet/session/session_test.c b/src/vnet/session/session_test.c
new file mode 100644
index 0000000..b46b33d
--- /dev/null
+++ b/src/vnet/session/session_test.c
@@ -0,0 +1,473 @@
+/*
+ * Copyright (c) 2017 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:
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include <vnet/session/application_namespace.h>
+#include <vnet/session/application_interface.h>
+#include <vnet/session/application.h>
+#include <vnet/session/session.h>
+
+#define SESSION_TEST_I(_cond, _comment, _args...) \
+({ \
+ int _evald = (_cond); \
+ if (!(_evald)) { \
+ fformat(stderr, "FAIL:%d: " _comment "\n", \
+ __LINE__, ##_args); \
+ } else { \
+ fformat(stderr, "PASS:%d: " _comment "\n", \
+ __LINE__, ##_args); \
+ } \
+ _evald; \
+})
+
+#define SESSION_TEST(_cond, _comment, _args...) \
+{ \
+ if (!SESSION_TEST_I(_cond, _comment, ##_args)) { \
+ return 1; \
+ } \
+}
+
+void
+dummy_session_reset_callback (stream_session_t * s)
+{
+ clib_warning ("called...");
+}
+
+int
+dummy_session_connected_callback (u32 app_index, u32 api_context,
+ stream_session_t * s, u8 is_fail)
+{
+ clib_warning ("called...");
+ return -1;
+}
+
+int
+dummy_add_segment_callback (u32 client_index, const u8 * seg_name,
+ u32 seg_size)
+{
+ clib_warning ("called...");
+ return -1;
+}
+
+int
+dummy_redirect_connect_callback (u32 client_index, void *mp)
+{
+ return VNET_API_ERROR_SESSION_REDIRECT;
+}
+
+void
+dummy_session_disconnect_callback (stream_session_t * s)
+{
+ clib_warning ("called...");
+}
+
+int
+dummy_session_accept_callback (stream_session_t * s)
+{
+ clib_warning ("called...");
+ return -1;
+}
+
+int
+dummy_server_rx_callback (stream_session_t * s)
+{
+ clib_warning ("called...");
+ return -1;
+}
+
+/* *INDENT-OFF* */
+static session_cb_vft_t dummy_session_cbs = {
+ .session_reset_callback = dummy_session_reset_callback,
+ .session_connected_callback = dummy_session_connected_callback,
+ .session_accept_callback = dummy_session_accept_callback,
+ .session_disconnect_callback = dummy_session_disconnect_callback,
+ .builtin_server_rx_callback = dummy_server_rx_callback,
+ .redirect_connect_callback = dummy_redirect_connect_callback,
+};
+/* *INDENT-ON* */
+
+static int
+session_test_namespace (vlib_main_t * vm, unformat_input_t * input)
+{
+ u64 options[SESSION_OPTIONS_N_OPTIONS], dummy_secret = 1234;
+ u32 server_index, server_st_index, server_local_st_index;
+ u32 dummy_port = 1234, local_listener, client_index;
+ u32 dummy_api_context = 4321, dummy_client_api_index = 1234;
+ u32 dummy_server_api_index = ~0, sw_if_index = 0;
+ session_endpoint_t server_sep = SESSION_ENDPOINT_NULL;
+ session_endpoint_t client_sep = SESSION_ENDPOINT_NULL;
+ session_endpoint_t intf_sep = SESSION_ENDPOINT_NULL;
+ clib_error_t *error = 0;
+ u8 *ns_id = format (0, "appns1"), intf_mac[6];
+ app_namespace_t *app_ns;
+ u8 segment_name[128];
+ application_t *server;
+ stream_session_t *s;
+ int code;
+
+ server_sep.is_ip4 = 1;
+ server_sep.port = dummy_port;
+ client_sep.is_ip4 = 1;
+ client_sep.port = dummy_port;
+ memset (options, 0, sizeof (options));
+ memset (intf_mac, 0, sizeof (intf_mac));
+
+ options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_BUILTIN_APP;
+ options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_ACCEPT_REDIRECT;
+ vnet_app_attach_args_t attach_args = {
+ .api_client_index = ~0,
+ .options = options,
+ .namespace_id = 0,
+ .session_cb_vft = &dummy_session_cbs,
+ .segment_name = segment_name,
+ };
+
+ vnet_bind_args_t bind_args = {
+ .sep = server_sep,
+ .app_index = 0,
+ };
+
+ vnet_connect_args_t connect_args = {
+ .sep = client_sep,
+ .app_index = 0,
+ .api_context = 0,
+ };
+
+ vnet_unbind_args_t unbind_args = {
+ .handle = bind_args.handle,
+ .app_index = 0,
+ };
+
+ vnet_app_detach_args_t detach_args = {
+ .app_index = 0,
+ };
+
+ ip4_address_t intf_addr = {
+ .as_u32 = clib_host_to_net_u32 (0x06000105),
+ };
+
+ intf_sep.ip.ip4 = intf_addr;
+ intf_sep.is_ip4 = 1;
+ intf_sep.port = dummy_port;
+
+ /*
+ * Insert namespace and lookup
+ */
+
+ vnet_app_namespace_add_del_args_t ns_args = {
+ .ns_id = ns_id,
+ .secret = dummy_secret,
+ .sw_if_index = APP_NAMESPACE_INVALID_INDEX,
+ .is_add = 1
+ };
+ error = vnet_app_namespace_add_del (&ns_args);
+ SESSION_TEST ((error == 0), "app ns insertion should succeed: %d",
+ clib_error_get_code (error));
+
+ app_ns = app_namespace_get_from_id (ns_id);
+ SESSION_TEST ((app_ns != 0), "should find ns %v status", ns_id);
+ SESSION_TEST ((app_ns->ns_secret == dummy_secret), "secret should be %d",
+ dummy_secret);
+ SESSION_TEST ((app_ns->sw_if_index == APP_NAMESPACE_INVALID_INDEX),
+ "sw_if_index should be invalid");
+
+ /*
+ * Try application attach with wrong secret
+ */
+
+ options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
+ options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
+ options[APP_OPTIONS_NAMESPACE_SECRET] = dummy_secret - 1;
+ attach_args.namespace_id = ns_id;
+ attach_args.api_client_index = dummy_server_api_index;
+
+ error = vnet_application_attach (&attach_args);
+ SESSION_TEST ((error != 0), "app attachment should fail");
+ code = clib_error_get_code (error);
+ SESSION_TEST ((code == VNET_API_ERROR_APP_WRONG_NS_SECRET),
+ "code should be wrong ns secret: %d", code);
+
+ /*
+ * Attach server with global default scope
+ */
+ options[APP_OPTIONS_FLAGS] &= ~APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
+ options[APP_OPTIONS_FLAGS] &= ~APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
+ options[APP_OPTIONS_NAMESPACE_SECRET] = 0;
+ attach_args.namespace_id = 0;
+ attach_args.api_client_index = dummy_server_api_index;
+ error = vnet_application_attach (&attach_args);
+ SESSION_TEST ((error == 0), "server attachment should work");
+ server_index = attach_args.app_index;
+ server = application_get (server_index);
+ SESSION_TEST ((server->ns_index == 0),
+ "server should be in the default ns");
+
+ bind_args.app_index = server_index;
+ error = vnet_bind (&bind_args);
+ SESSION_TEST ((error == 0), "server bind should work");
+
+ server_st_index = application_session_table (server, FIB_PROTOCOL_IP4);
+ s = session_lookup_listener (server_st_index, &server_sep);
+ SESSION_TEST ((s != 0), "listener should exist in global table");
+ SESSION_TEST ((s->app_index == server_index), "app_index should be that of "
+ "the server");
+ server_local_st_index = application_local_session_table (server);
+ SESSION_TEST ((server_local_st_index == APP_INVALID_INDEX),
+ "server shouldn't have access to local table");
+
+ unbind_args.app_index = server_index;
+ error = vnet_unbind (&unbind_args);
+ SESSION_TEST ((error == 0), "unbind should work");
+
+ s = session_lookup_listener (server_st_index, &server_sep);
+ SESSION_TEST ((s == 0), "listener should not exist in global table");
+
+ detach_args.app_index = server_index;
+ vnet_application_detach (&detach_args);
+
+ /*
+ * Attach server with local and global scope
+ */
+ options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
+ options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
+ options[APP_OPTIONS_NAMESPACE_SECRET] = dummy_secret;
+ attach_args.namespace_id = ns_id;
+ attach_args.api_client_index = dummy_server_api_index;
+ error = vnet_application_attach (&attach_args);
+ SESSION_TEST ((error == 0), "server attachment should work");
+ server_index = attach_args.app_index;
+ server = application_get (server_index);
+ SESSION_TEST ((server->ns_index == app_namespace_index (app_ns)),
+ "server should be in the right ns");
+
+ bind_args.app_index = server_index;
+ error = vnet_bind (&bind_args);
+ SESSION_TEST ((error == 0), "bind should work");
+ server_st_index = application_session_table (server, FIB_PROTOCOL_IP4);
+ s = session_lookup_listener (server_st_index, &server_sep);
+ SESSION_TEST ((s != 0), "listener should exist in global table");
+ SESSION_TEST ((s->app_index == server_index), "app_index should be that of "
+ "the server");
+ server_local_st_index = application_local_session_table (server);
+ local_listener = session_lookup_session_endpoint (server_local_st_index,
+ &server_sep);
+ SESSION_TEST ((local_listener != SESSION_INVALID_INDEX),
+ "listener should exist in local table");
+
+ /*
+ * Try client connect with 1) local scope 2) global scope
+ */
+ options[APP_OPTIONS_FLAGS] &= ~APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
+ attach_args.api_client_index = dummy_client_api_index;
+ error = vnet_application_attach (&attach_args);
+ SESSION_TEST ((error == 0), "client attachment should work");
+ client_index = attach_args.app_index;
+ connect_args.api_context = dummy_api_context;
+ connect_args.app_index = client_index;
+ error = vnet_connect (&connect_args);
+ SESSION_TEST ((error != 0), "client connect should return error code");
+ code = clib_error_get_code (error);
+ SESSION_TEST ((code == VNET_API_ERROR_INVALID_VALUE),
+ "error code should be invalid value (zero ip)");
+ connect_args.sep.ip.ip4.as_u8[0] = 127;
+ error = vnet_connect (&connect_args);
+ SESSION_TEST ((error != 0), "client connect should return error code");
+ code = clib_error_get_code (error);
+ SESSION_TEST ((code == VNET_API_ERROR_SESSION_REDIRECT),
+ "error code should be redirect");
+ detach_args.app_index = client_index;
+ vnet_application_detach (&detach_args);
+
+ options[APP_OPTIONS_FLAGS] &= ~APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
+ options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
+ attach_args.api_client_index = dummy_client_api_index;
+ error = vnet_application_attach (&attach_args);
+ SESSION_TEST ((error == 0), "client attachment should work");
+ error = vnet_connect (&connect_args);
+ SESSION_TEST ((error != 0), "client connect should return error code");
+ code = clib_error_get_code (error);
+ SESSION_TEST ((code == VNET_API_ERROR_SESSION_CONNECT),
+ "error code should be connect (nothing in local scope)");
+ detach_args.app_index = client_index;
+ vnet_application_detach (&detach_args);
+
+ /*
+ * Unbind and detach server and then re-attach with local scope only
+ */
+ unbind_args.handle = bind_args.handle;
+ unbind_args.app_index = server_index;
+ error = vnet_unbind (&unbind_args);
+ SESSION_TEST ((error == 0), "unbind should work");
+
+ s = session_lookup_listener (server_st_index, &server_sep);
+ SESSION_TEST ((s == 0), "listener should not exist in global table");
+ local_listener = session_lookup_session_endpoint (server_local_st_index,
+ &server_sep);
+ SESSION_TEST ((s == 0), "listener should not exist in local table");
+
+ detach_args.app_index = server_index;
+ vnet_application_detach (&detach_args);
+
+ options[APP_OPTIONS_FLAGS] &= ~APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
+ options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
+ attach_args.api_client_index = dummy_server_api_index;
+ error = vnet_application_attach (&attach_args);
+ SESSION_TEST ((error == 0), "app attachment should work");
+ server_index = attach_args.app_index;
+ server = application_get (server_index);
+ SESSION_TEST ((server->ns_index == app_namespace_index (app_ns)),
+ "app should be in the right ns");
+
+ bind_args.app_index = server_index;
+ error = vnet_bind (&bind_args);
+ SESSION_TEST ((error == 0), "bind should work");
+
+ server_st_index = application_session_table (server, FIB_PROTOCOL_IP4);
+ s = session_lookup_listener (server_st_index, &server_sep);
+ SESSION_TEST ((s == 0), "listener should not exist in global table");
+ server_local_st_index = application_local_session_table (server);
+ local_listener = session_lookup_session_endpoint (server_local_st_index,
+ &server_sep);
+ SESSION_TEST ((local_listener != SESSION_INVALID_INDEX),
+ "listener should exist in local table");
+
+ unbind_args.handle = bind_args.handle;
+ error = vnet_unbind (&unbind_args);
+ SESSION_TEST ((error == 0), "unbind should work");
+
+ local_listener = session_lookup_session_endpoint (server_local_st_index,
+ &server_sep);
+ SESSION_TEST ((local_listener == SESSION_INVALID_INDEX),
+ "listener should not exist in local table");
+
+ /*
+ * Client attach + connect in default ns with local scope
+ */
+ options[APP_OPTIONS_FLAGS] &= ~APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
+ options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
+ attach_args.namespace_id = 0;
+ attach_args.api_client_index = dummy_client_api_index;
+ vnet_application_attach (&attach_args);
+ error = vnet_connect (&connect_args);
+ SESSION_TEST ((error != 0), "client connect should return error code");
+ code = clib_error_get_code (error);
+ SESSION_TEST ((code == VNET_API_ERROR_SESSION_CONNECT),
+ "error code should be connect (not in same ns)");
+ detach_args.app_index = client_index;
+ vnet_application_detach (&detach_args);
+
+ /*
+ * Detach server
+ */
+ detach_args.app_index = server_index;
+ vnet_application_detach (&detach_args);
+
+ /*
+ * Create loopback interface
+ */
+ if (vnet_create_loopback_interface (&sw_if_index, intf_mac, 0, 0))
+ {
+ clib_warning ("couldn't create loopback. stopping the test!");
+ return 0;
+ }
+ vnet_sw_interface_set_flags (vnet_get_main (), sw_if_index,
+ VNET_SW_INTERFACE_FLAG_ADMIN_UP);
+ ip4_add_del_interface_address (vlib_get_main (), sw_if_index, &intf_addr,
+ 24, 0);
+
+ /*
+ * Update namespace
+ */
+ ns_args.sw_if_index = sw_if_index;
+ error = vnet_app_namespace_add_del (&ns_args);
+ SESSION_TEST ((error == 0), "app ns insertion should succeed: %d",
+ clib_error_get_code (error));
+
+ /*
+ * Attach server with local and global scope
+ */
+ options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
+ options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
+ options[APP_OPTIONS_NAMESPACE_SECRET] = dummy_secret;
+ attach_args.namespace_id = ns_id;
+ attach_args.api_client_index = dummy_server_api_index;
+ error = vnet_application_attach (&attach_args);
+ SESSION_TEST ((error == 0), "server attachment should work");
+ server_index = attach_args.app_index;
+
+ bind_args.app_index = server_index;
+ error = vnet_bind (&bind_args);
+ server_st_index = application_session_table (server, FIB_PROTOCOL_IP4);
+ s = session_lookup_listener (server_st_index, &server_sep);
+ SESSION_TEST ((s == 0), "zero listener should not exist in global table");
+
+ s = session_lookup_listener (server_st_index, &intf_sep);
+ SESSION_TEST ((s != 0), "intf listener should exist in global table");
+ SESSION_TEST ((s->app_index == server_index), "app_index should be that of "
+ "the server");
+ server_local_st_index = application_local_session_table (server);
+ local_listener = session_lookup_session_endpoint (server_local_st_index,
+ &server_sep);
+ SESSION_TEST ((local_listener != SESSION_INVALID_INDEX),
+ "zero listener should exist in local table");
+ detach_args.app_index = server_index;
+ vnet_application_detach (&detach_args);
+
+ /*
+ * Cleanup
+ */
+ vec_free (ns_id);
+ vnet_delete_loopback_interface (sw_if_index);
+ return 0;
+}
+
+static clib_error_t *
+session_test (vlib_main_t * vm,
+ unformat_input_t * input, vlib_cli_command_t * cmd_arg)
+{
+ int res = 0;
+
+ vnet_session_enable_disable (vm, 1);
+
+ while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
+ {
+ if (unformat (input, "namespace"))
+ {
+ res = session_test_namespace (vm, input);
+ }
+ else
+ break;
+ }
+
+ if (res)
+ return clib_error_return (0, "Session unit test failed");
+ return 0;
+}
+
+/* *INDENT-OFF* */
+VLIB_CLI_COMMAND (tcp_test_command, static) =
+{
+ .path = "test session",
+ .short_help = "internal session unit tests",
+ .function = session_test,
+};
+/* *INDENT-ON* */
+
+/*
+ * fd.io coding-style-patch-verification: ON
+ *
+ * Local Variables:
+ * eval: (c-set-style "gnu")
+ * End:
+ */