2 * Copyright (c) 2017 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 #include <vnet/session/application.h>
17 #include <vnet/session/application_interface.h>
18 #include <vnet/session/application_namespace.h>
19 #include <vnet/session/session.h>
22 * Pool from which we allocate all applications
24 static application_t *app_pool;
27 * Hash table of apps by api client index
29 static uword *app_by_api_client_index;
32 * Default application event queue size
34 static u32 default_app_evt_queue_size = 128;
37 app_get_name_from_reg_index (application_t * app)
41 vl_api_registration_t *regp;
42 regp = vl_api_client_index_to_registration (app->api_client_index);
44 app_name = format (0, "builtin-%d%c", app->index, 0);
46 app_name = format (0, "%s%c", regp->name, 0);
52 application_session_table (application_t * app, u8 fib_proto)
54 app_namespace_t *app_ns;
55 app_ns = app_namespace_get (app->ns_index);
56 if (!application_has_global_scope (app))
57 return APP_INVALID_INDEX;
58 if (fib_proto == FIB_PROTOCOL_IP4)
59 return session_lookup_get_index_for_fib (fib_proto,
60 app_ns->ip4_fib_index);
62 return session_lookup_get_index_for_fib (fib_proto,
63 app_ns->ip6_fib_index);
67 application_local_session_table (application_t * app)
69 app_namespace_t *app_ns;
70 if (!application_has_local_scope (app))
71 return APP_INVALID_INDEX;
72 app_ns = app_namespace_get (app->ns_index);
73 return app_ns->local_table_index;
77 application_api_queue_is_full (application_t * app)
81 /* builtin servers are always OK */
82 if (app->api_client_index == ~0)
85 q = vl_api_client_index_to_input_queue (app->api_client_index);
89 if (q->cursize == q->maxsize)
97 * Since the name is not stored per app, we generate it on the fly. It is
98 * the caller's responsibility to free the vector
101 application_name_from_index (u32 app_index)
103 application_t *app = application_get (app_index);
106 return app_get_name_from_reg_index (app);
110 application_table_add (application_t * app)
112 hash_set (app_by_api_client_index, app->api_client_index, app->index);
116 application_table_del (application_t * app)
118 hash_unset (app_by_api_client_index, app->api_client_index);
122 application_lookup (u32 api_client_index)
125 p = hash_get (app_by_api_client_index, api_client_index);
127 return application_get (p[0]);
136 pool_get (app_pool, app);
137 memset (app, 0, sizeof (*app));
138 app->index = application_get_index (app);
139 app->connects_seg_manager = APP_INVALID_SEGMENT_MANAGER_INDEX;
140 app->first_segment_manager = APP_INVALID_SEGMENT_MANAGER_INDEX;
142 clib_warning ("[%d] New app (%d)", getpid (), app->index);
147 application_del (application_t * app)
149 segment_manager_properties_t *props;
150 vnet_unbind_args_t _a, *a = &_a;
151 segment_manager_t *sm;
152 u64 handle, *handles = 0;
157 * The app event queue allocated in first segment is cleared with
158 * the segment manager. No need to explicitly free it.
161 clib_warning ("[%d] Delete app (%d)", getpid (), app->index);
163 if (application_is_proxy (app))
164 application_remove_proxy (app);
171 hash_foreach (handle, index, app->listeners_table,
173 vec_add1 (handles, handle);
174 sm = segment_manager_get (index);
175 sm->app_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
179 for (i = 0; i < vec_len (handles); i++)
181 a->app_index = app->index;
182 a->handle = handles[i];
183 /* seg manager is removed when unbind completes */
188 * Connects segment manager cleanup
191 if (app->connects_seg_manager != APP_INVALID_SEGMENT_MANAGER_INDEX)
193 sm = segment_manager_get (app->connects_seg_manager);
194 sm->app_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
195 segment_manager_init_del (sm);
198 /* If first segment manager is used by a listener */
199 if (app->first_segment_manager != APP_INVALID_SEGMENT_MANAGER_INDEX
200 && app->first_segment_manager != app->connects_seg_manager)
202 sm = segment_manager_get (app->first_segment_manager);
203 /* .. and has no fifos, e.g. it might be used for redirected sessions,
205 if (!segment_manager_has_fifos (sm))
207 sm->app_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
208 segment_manager_del (sm);
211 props = segment_manager_properties_get (app->sm_properties);
212 segment_manager_properties_free (props);
213 application_table_del (app);
214 pool_put (app_pool, app);
218 application_verify_cb_fns (session_cb_vft_t * cb_fns)
220 if (cb_fns->session_accept_callback == 0)
221 clib_warning ("No accept callback function provided");
222 if (cb_fns->session_connected_callback == 0)
223 clib_warning ("No session connected callback function provided");
224 if (cb_fns->session_disconnect_callback == 0)
225 clib_warning ("No session disconnect callback function provided");
226 if (cb_fns->session_reset_callback == 0)
227 clib_warning ("No session reset callback function provided");
231 * Check app config for given segment type
233 * Returns 1 on success and 0 otherwise
236 application_verify_cfg (ssvm_segment_type_t st)
239 if (st == SSVM_SEGMENT_MEMFD)
241 is_valid = (session_manager_get_evt_q_segment () != 0);
243 clib_warning ("memfd seg: vpp's event qs IN binary api svm region");
246 else if (st == SSVM_SEGMENT_SHM)
248 is_valid = (session_manager_get_evt_q_segment () == 0);
250 clib_warning ("shm seg: vpp's event qs NOT IN binary api svm region");
258 application_init (application_t * app, u32 api_client_index, u64 * options,
259 session_cb_vft_t * cb_fns)
261 ssvm_segment_type_t st = SSVM_SEGMENT_MEMFD;
262 u32 app_evt_queue_size, first_seg_size;
263 segment_manager_properties_t *props;
264 vl_api_registration_t *reg;
265 segment_manager_t *sm;
269 * Make sure we support the requested configuration
271 reg = vl_api_client_index_to_registration (api_client_index);
273 return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
275 if (options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_IS_BUILTIN)
276 st = SSVM_N_SEGMENT_TYPES;
277 else if (vl_api_registration_file_index (reg) == VL_API_INVALID_FI)
278 st = SSVM_SEGMENT_SHM;
280 if (!application_verify_cfg (st))
281 return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
284 * Setup segment manager
286 sm = segment_manager_new ();
287 sm->app_index = app->index;
288 props = segment_manager_properties_alloc ();
289 app->sm_properties = segment_manager_properties_index (props);
290 if (options[APP_OPTIONS_ADD_SEGMENT_SIZE])
292 props->add_segment_size = options[APP_OPTIONS_ADD_SEGMENT_SIZE];
293 props->add_segment = 1;
295 if (options[APP_OPTIONS_RX_FIFO_SIZE])
296 props->rx_fifo_size = options[APP_OPTIONS_RX_FIFO_SIZE];
297 if (options[APP_OPTIONS_TX_FIFO_SIZE])
298 props->tx_fifo_size = options[APP_OPTIONS_TX_FIFO_SIZE];
299 props->preallocated_fifo_pairs = options[APP_OPTIONS_PREALLOC_FIFO_PAIRS];
300 props->private_segment_count = options[APP_OPTIONS_PRIVATE_SEGMENT_COUNT];
301 if (options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_IS_BUILTIN)
302 props->segment_type = SSVM_N_SEGMENT_TYPES;
304 props->segment_type = st;
306 app_evt_queue_size = options[APP_OPTIONS_EVT_QUEUE_SIZE] > 0 ?
307 options[APP_OPTIONS_EVT_QUEUE_SIZE] : default_app_evt_queue_size;
308 first_seg_size = options[APP_OPTIONS_SEGMENT_SIZE];
309 if ((rv = segment_manager_init (sm, app->sm_properties, first_seg_size,
310 app_evt_queue_size)))
312 sm->first_is_protected = 1;
317 app->first_segment_manager = segment_manager_index (sm);
318 app->api_client_index = api_client_index;
319 app->flags = options[APP_OPTIONS_FLAGS];
320 app->cb_fns = *cb_fns;
321 app->ns_index = options[APP_OPTIONS_NAMESPACE];
322 app->listeners_table = hash_create (0, sizeof (u64));
323 app->proxied_transports = options[APP_OPTIONS_PROXY_TRANSPORT];
325 /* If no scope enabled, default to global */
326 if (!application_has_global_scope (app)
327 && !application_has_local_scope (app))
328 app->flags |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
330 /* Allocate app event queue in the first shared-memory segment */
331 app->event_queue = segment_manager_alloc_queue (sm, app_evt_queue_size);
333 /* Check that the obvious things are properly set up */
334 application_verify_cb_fns (cb_fns);
336 /* Add app to lookup by api_client_index table */
337 application_table_add (app);
343 application_get (u32 index)
345 if (index == APP_INVALID_INDEX)
347 return pool_elt_at_index (app_pool, index);
351 application_get_if_valid (u32 index)
353 if (pool_is_free_index (app_pool, index))
356 return pool_elt_at_index (app_pool, index);
360 application_get_index (application_t * app)
362 return app - app_pool;
365 static segment_manager_t *
366 application_alloc_segment_manager (application_t * app)
368 segment_manager_t *sm = 0;
370 /* If the first segment manager is not in use, don't allocate a new one */
371 if (app->first_segment_manager != APP_INVALID_SEGMENT_MANAGER_INDEX
372 && app->first_segment_manager_in_use == 0)
374 sm = segment_manager_get (app->first_segment_manager);
375 app->first_segment_manager_in_use = 1;
379 sm = segment_manager_new ();
380 sm->properties_index = app->sm_properties;
386 * Start listening local transport endpoint for requested transport.
388 * Creates a 'dummy' stream session with state LISTENING to be used in session
389 * lookups, prior to establishing connection. Requests transport to build
390 * it's own specific listening connection.
393 application_start_listen (application_t * srv, session_endpoint_t * sep,
396 segment_manager_t *sm;
401 sst = session_type_from_proto_and_ip (sep->transport_proto, sep->is_ip4);
402 s = listen_session_new (sst);
403 s->app_index = srv->index;
405 if (stream_session_listen (s, sep))
408 /* Allocate segment manager. All sessions derived out of a listen session
409 * have fifos allocated by the same segment manager. */
410 sm = application_alloc_segment_manager (srv);
414 /* Add to app's listener table. Useful to find all child listeners
415 * when app goes down, although, just for unbinding this is not needed */
416 handle = listen_session_get_handle (s);
417 hash_set (srv->listeners_table, handle, segment_manager_index (sm));
423 listen_session_del (s);
428 * Stop listening on session associated to handle
431 application_stop_listen (application_t * srv, u64 handle)
433 stream_session_t *listener;
435 segment_manager_t *sm;
437 if (srv && hash_get (srv->listeners_table, handle) == 0)
439 clib_warning ("app doesn't own handle %llu!", handle);
443 listener = listen_session_get_from_handle (handle);
444 stream_session_stop_listen (listener);
446 indexp = hash_get (srv->listeners_table, handle);
449 sm = segment_manager_get (*indexp);
450 if (srv->first_segment_manager == *indexp)
452 /* Delete sessions but don't remove segment manager */
453 srv->first_segment_manager_in_use = 0;
454 segment_manager_del_sessions (sm);
458 segment_manager_init_del (sm);
460 hash_unset (srv->listeners_table, handle);
461 listen_session_del (listener);
467 application_open_session (application_t * app, session_endpoint_t * sep,
470 segment_manager_t *sm;
473 /* Make sure we have a segment manager for connects */
474 if (app->connects_seg_manager == APP_INVALID_SEGMENT_MANAGER_INDEX)
476 sm = application_alloc_segment_manager (app);
479 app->connects_seg_manager = segment_manager_index (sm);
482 if ((rv = session_open (app->index, sep, api_context)))
489 application_get_connect_segment_manager (application_t * app)
491 ASSERT (app->connects_seg_manager != (u32) ~ 0);
492 return segment_manager_get (app->connects_seg_manager);
496 application_get_listen_segment_manager (application_t * app,
497 stream_session_t * s)
500 smp = hash_get (app->listeners_table, listen_session_get_handle (s));
502 return segment_manager_get (*smp);
506 application_is_proxy (application_t * app)
508 return (app->flags & APP_OPTIONS_FLAGS_IS_PROXY);
512 application_is_builtin (application_t * app)
514 return (app->flags & APP_OPTIONS_FLAGS_IS_BUILTIN);
518 application_is_builtin_proxy (application_t * app)
520 return (application_is_proxy (app) && application_is_builtin (app));
524 application_add_segment_notify (u32 app_index, u32 fifo_segment_index)
526 application_t *app = application_get (app_index);
527 svm_fifo_segment_private_t *fs;
529 /* Send an API message to the external app, to map new segment */
530 ASSERT (app->cb_fns.add_segment_callback);
532 fs = segment_manager_get_segment (fifo_segment_index);
533 return app->cb_fns.add_segment_callback (app->api_client_index, &fs->ssvm);
537 application_has_local_scope (application_t * app)
539 return app->flags & APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
543 application_has_global_scope (application_t * app)
545 return app->flags & APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
549 application_n_listeners (application_t * app)
551 return hash_elts (app->listeners_table);
555 application_first_listener (application_t * app, u8 fib_proto,
558 stream_session_t *listener;
563 sst = session_type_from_proto_and_ip (transport_proto,
564 fib_proto == FIB_PROTOCOL_IP4);
567 hash_foreach (handle, sm_index, app->listeners_table, ({
568 listener = listen_session_get_from_handle (handle);
569 if (listener->session_type == sst
570 && listener->listener_index != SESSION_PROXY_LISTENER_INDEX)
579 application_proxy_listener (application_t * app, u8 fib_proto,
582 stream_session_t *listener;
587 sst = session_type_from_proto_and_ip (transport_proto,
588 fib_proto == FIB_PROTOCOL_IP4);
591 hash_foreach (handle, sm_index, app->listeners_table, ({
592 listener = listen_session_get_from_handle (handle);
593 if (listener->session_type == sst
594 && listener->listener_index == SESSION_PROXY_LISTENER_INDEX)
602 static clib_error_t *
603 application_start_stop_proxy_fib_proto (application_t * app, u8 fib_proto,
604 u8 transport_proto, u8 is_start)
606 app_namespace_t *app_ns = app_namespace_get (app->ns_index);
607 u8 is_ip4 = (fib_proto == FIB_PROTOCOL_IP4);
608 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
609 transport_connection_t *tc;
615 s = application_first_listener (app, fib_proto, transport_proto);
619 sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
620 sep.sw_if_index = app_ns->sw_if_index;
621 sep.transport_proto = transport_proto;
622 application_start_listen (app, &sep, &handle);
623 s = listen_session_get_from_handle (handle);
624 s->listener_index = SESSION_PROXY_LISTENER_INDEX;
629 s = application_proxy_listener (app, fib_proto, transport_proto);
633 tc = listen_session_get_transport (s);
635 if (!ip_is_zero (&tc->lcl_ip, 1))
639 sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
640 sep.transport_proto = transport_proto;
642 sti = session_lookup_get_index_for_fib (fib_proto, sep.fib_index);
644 session_lookup_add_session_endpoint (sti, &sep, s->session_index);
646 session_lookup_del_session_endpoint (sti, &sep);
653 application_start_stop_proxy_local_scope (application_t * app,
654 u8 transport_proto, u8 is_start)
656 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
657 app_namespace_t *app_ns;
658 app_ns = app_namespace_get (app->ns_index);
660 sep.transport_proto = transport_proto;
665 session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
668 session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
673 session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
675 session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
680 application_start_stop_proxy (application_t * app,
681 transport_proto_t transport_proto, u8 is_start)
683 if (application_has_local_scope (app))
684 application_start_stop_proxy_local_scope (app, transport_proto, is_start);
686 if (application_has_global_scope (app))
688 application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP4,
689 transport_proto, is_start);
690 application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP6,
691 transport_proto, is_start);
696 application_setup_proxy (application_t * app)
698 u16 transports = app->proxied_transports;
699 transport_proto_t tp;
701 ASSERT (application_is_proxy (app));
702 if (application_is_builtin (app))
706 transport_proto_foreach (tp, ({
707 if (transports & (1 << tp))
708 application_start_stop_proxy (app, tp, 1);
714 application_remove_proxy (application_t * app)
716 u16 transports = app->proxied_transports;
717 transport_proto_t tp;
719 ASSERT (application_is_proxy (app));
722 transport_proto_foreach (tp, ({
723 if (transports & (1 << tp))
724 application_start_stop_proxy (app, tp, 0);
730 format_application_listener (u8 * s, va_list * args)
732 application_t *app = va_arg (*args, application_t *);
733 u64 handle = va_arg (*args, u64);
734 u32 index = va_arg (*args, u32);
735 int verbose = va_arg (*args, int);
736 stream_session_t *listener;
742 s = format (s, "%-40s%-20s%-15s%-15s%-10s", "Connection", "App",
743 "API Client", "ListenerID", "SegManager");
745 s = format (s, "%-40s%-20s", "Connection", "App");
750 app_name = app_get_name_from_reg_index (app);
751 listener = listen_session_get_from_handle (handle);
752 str = format (0, "%U", format_stream_session, listener, verbose);
756 s = format (s, "%-40s%-20s%-15u%-15u%-10u", str, app_name,
757 app->api_client_index, handle, index);
760 s = format (s, "%-40s%-20s", str, app_name);
767 application_format_connects (application_t * app, int verbose)
769 vlib_main_t *vm = vlib_get_main ();
770 segment_manager_t *sm;
771 u8 *app_name, *s = 0;
778 vlib_cli_output (vm, "%-40s%-20s%-15s%-10s", "Connection", "App",
779 "API Client", "SegManager");
781 vlib_cli_output (vm, "%-40s%-20s", "Connection", "App");
786 if (app->connects_seg_manager == (u32) ~ 0)
789 app_name = app_get_name_from_reg_index (app);
791 /* Across all fifo segments */
792 sm = segment_manager_get (app->connects_seg_manager);
793 for (j = 0; j < vec_len (sm->segment_indices); j++)
795 svm_fifo_segment_private_t *fifo_segment;
799 fifo_segment = svm_fifo_segment_get_segment (sm->segment_indices[j]);
800 fifo = svm_fifo_segment_get_fifo_list (fifo_segment);
803 u32 session_index, thread_index;
804 stream_session_t *session;
806 session_index = fifo->master_session_index;
807 thread_index = fifo->master_thread_index;
809 session = session_get (session_index, thread_index);
810 str = format (0, "%U", format_stream_session, session, verbose);
813 s = format (s, "%-40s%-20s%-15u%-10u", str, app_name,
814 app->api_client_index, app->connects_seg_manager);
816 s = format (s, "%-40s%-20s", str, app_name);
818 vlib_cli_output (vm, "%v", s);
819 vec_reset_length (s);
831 format_application (u8 * s, va_list * args)
833 application_t *app = va_arg (*args, application_t *);
834 CLIB_UNUSED (int verbose) = va_arg (*args, int);
835 segment_manager_properties_t *props;
836 const u8 *app_ns_name;
842 s = format (s, "%-10s%-20s%-15s%-15s%-15s%-15s%-15s", "Index", "Name",
843 "API Client", "Namespace", "Add seg size", "Rx fifo size",
847 format (s, "%-10s%-20s%-15s%-40s", "Index", "Name", "API Client",
852 app_name = app_get_name_from_reg_index (app);
853 app_ns_name = app_namespace_id_from_index (app->ns_index);
854 props = segment_manager_properties_get (app->sm_properties);
857 format (s, "%-10d%-20s%-15d%-15d%-15d%-15d%-15d", app->index, app_name,
858 app->api_client_index, app->ns_index,
859 props->add_segment_size,
860 props->rx_fifo_size, props->tx_fifo_size);
862 s = format (s, "%-10d%-20s%-15d%-40s", app->index, app_name,
863 app->api_client_index, app_ns_name);
867 static clib_error_t *
868 show_app_command_fn (vlib_main_t * vm, unformat_input_t * input,
869 vlib_cli_command_t * cmd)
876 session_cli_return_if_not_enabled ();
878 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
880 if (unformat (input, "server"))
882 else if (unformat (input, "client"))
884 else if (unformat (input, "verbose"))
894 if (pool_elts (app_pool))
896 vlib_cli_output (vm, "%U", format_application_listener,
897 0 /* header */ , 0, 0,
900 pool_foreach (app, app_pool,
902 /* App's listener sessions */
903 if (hash_elts (app->listeners_table) == 0)
905 hash_foreach (handle, index, app->listeners_table,
907 vlib_cli_output (vm, "%U", format_application_listener, app,
908 handle, index, verbose);
914 vlib_cli_output (vm, "No active server bindings");
919 if (pool_elts (app_pool))
921 application_format_connects (0, verbose);
924 pool_foreach (app, app_pool,
926 if (app->connects_seg_manager == (u32)~0)
928 application_format_connects (app, verbose);
933 vlib_cli_output (vm, "No active client bindings");
936 /* Print app related info */
937 if (!do_server && !do_client)
939 vlib_cli_output (vm, "%U", format_application, 0, verbose);
941 pool_foreach (app, app_pool, ({
942 vlib_cli_output (vm, "%U", format_application, app, verbose);
951 VLIB_CLI_COMMAND (show_app_command, static) =
954 .short_help = "show app [server|client] [verbose]",
955 .function = show_app_command_fn,
960 * fd.io coding-style-patch-verification: ON
963 * eval: (c-set-style "gnu")