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)
79 unix_shared_memory_queue_t *q;
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 application_init (application_t * app, u32 api_client_index, u64 * options,
232 session_cb_vft_t * cb_fns)
234 segment_manager_t *sm;
235 segment_manager_properties_t *props;
236 u32 app_evt_queue_size, first_seg_size;
237 u32 default_rx_fifo_size = 16 << 10, default_tx_fifo_size = 16 << 10;
240 app_evt_queue_size = options[APP_OPTIONS_EVT_QUEUE_SIZE] > 0 ?
241 options[APP_OPTIONS_EVT_QUEUE_SIZE] : default_app_evt_queue_size;
244 * Setup segment manager
246 sm = segment_manager_new ();
247 sm->app_index = app->index;
248 props = segment_manager_properties_alloc ();
249 app->sm_properties = segment_manager_properties_index (props);
250 props->add_segment_size = options[APP_OPTIONS_ADD_SEGMENT_SIZE];
251 props->rx_fifo_size = options[APP_OPTIONS_RX_FIFO_SIZE];
252 props->rx_fifo_size =
253 props->rx_fifo_size ? props->rx_fifo_size : default_rx_fifo_size;
254 props->tx_fifo_size = options[APP_OPTIONS_TX_FIFO_SIZE];
255 props->tx_fifo_size =
256 props->tx_fifo_size ? props->tx_fifo_size : default_tx_fifo_size;
257 props->add_segment = props->add_segment_size != 0;
258 props->preallocated_fifo_pairs = options[APP_OPTIONS_PREALLOC_FIFO_PAIRS];
259 props->use_private_segment = options[APP_OPTIONS_FLAGS]
260 & APP_OPTIONS_FLAGS_IS_BUILTIN;
261 props->private_segment_count = options[APP_OPTIONS_PRIVATE_SEGMENT_COUNT];
263 first_seg_size = options[APP_OPTIONS_SEGMENT_SIZE];
264 if ((rv = segment_manager_init (sm, app->sm_properties, first_seg_size)))
266 sm->first_is_protected = 1;
271 app->first_segment_manager = segment_manager_index (sm);
272 app->api_client_index = api_client_index;
273 app->flags = options[APP_OPTIONS_FLAGS];
274 app->cb_fns = *cb_fns;
275 app->ns_index = options[APP_OPTIONS_NAMESPACE];
276 app->listeners_table = hash_create (0, sizeof (u64));
277 app->proxied_transports = options[APP_OPTIONS_PROXY_TRANSPORT];
279 /* If no scope enabled, default to global */
280 if (!application_has_global_scope (app)
281 && !application_has_local_scope (app))
282 app->flags |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
284 /* Allocate app event queue in the first shared-memory segment */
285 app->event_queue = segment_manager_alloc_queue (sm, app_evt_queue_size);
287 /* Check that the obvious things are properly set up */
288 application_verify_cb_fns (cb_fns);
290 /* Add app to lookup by api_client_index table */
291 application_table_add (app);
297 application_get (u32 index)
299 if (index == APP_INVALID_INDEX)
301 return pool_elt_at_index (app_pool, index);
305 application_get_if_valid (u32 index)
307 if (pool_is_free_index (app_pool, index))
310 return pool_elt_at_index (app_pool, index);
314 application_get_index (application_t * app)
316 return app - app_pool;
319 static segment_manager_t *
320 application_alloc_segment_manager (application_t * app)
322 segment_manager_t *sm = 0;
324 /* If the first segment manager is not in use, don't allocate a new one */
325 if (app->first_segment_manager != APP_INVALID_SEGMENT_MANAGER_INDEX
326 && app->first_segment_manager_in_use == 0)
328 sm = segment_manager_get (app->first_segment_manager);
329 app->first_segment_manager_in_use = 1;
333 sm = segment_manager_new ();
334 sm->properties_index = app->sm_properties;
340 * Start listening local transport endpoint for requested transport.
342 * Creates a 'dummy' stream session with state LISTENING to be used in session
343 * lookups, prior to establishing connection. Requests transport to build
344 * it's own specific listening connection.
347 application_start_listen (application_t * srv, session_endpoint_t * sep,
350 segment_manager_t *sm;
355 sst = session_type_from_proto_and_ip (sep->transport_proto, sep->is_ip4);
356 s = listen_session_new (sst);
357 s->app_index = srv->index;
359 if (stream_session_listen (s, sep))
362 /* Allocate segment manager. All sessions derived out of a listen session
363 * have fifos allocated by the same segment manager. */
364 sm = application_alloc_segment_manager (srv);
368 /* Add to app's listener table. Useful to find all child listeners
369 * when app goes down, although, just for unbinding this is not needed */
370 handle = listen_session_get_handle (s);
371 hash_set (srv->listeners_table, handle, segment_manager_index (sm));
377 listen_session_del (s);
382 * Stop listening on session associated to handle
385 application_stop_listen (application_t * srv, u64 handle)
387 stream_session_t *listener;
389 segment_manager_t *sm;
391 if (srv && hash_get (srv->listeners_table, handle) == 0)
393 clib_warning ("app doesn't own handle %llu!", handle);
397 listener = listen_session_get_from_handle (handle);
398 stream_session_stop_listen (listener);
400 indexp = hash_get (srv->listeners_table, handle);
403 sm = segment_manager_get (*indexp);
404 if (srv->first_segment_manager == *indexp)
406 /* Delete sessions but don't remove segment manager */
407 srv->first_segment_manager_in_use = 0;
408 segment_manager_del_sessions (sm);
412 segment_manager_init_del (sm);
414 hash_unset (srv->listeners_table, handle);
415 listen_session_del (listener);
421 application_open_session (application_t * app, session_endpoint_t * sep,
424 segment_manager_t *sm;
427 /* Make sure we have a segment manager for connects */
428 if (app->connects_seg_manager == APP_INVALID_SEGMENT_MANAGER_INDEX)
430 sm = application_alloc_segment_manager (app);
433 app->connects_seg_manager = segment_manager_index (sm);
436 if ((rv = session_open (app->index, sep, api_context)))
443 application_get_connect_segment_manager (application_t * app)
445 ASSERT (app->connects_seg_manager != (u32) ~ 0);
446 return segment_manager_get (app->connects_seg_manager);
450 application_get_listen_segment_manager (application_t * app,
451 stream_session_t * s)
454 smp = hash_get (app->listeners_table, listen_session_get_handle (s));
456 return segment_manager_get (*smp);
460 application_is_proxy (application_t * app)
462 return (app->flags & APP_OPTIONS_FLAGS_IS_PROXY);
466 application_is_builtin (application_t * app)
468 return (app->flags & APP_OPTIONS_FLAGS_IS_BUILTIN);
472 application_is_builtin_proxy (application_t * app)
474 return (application_is_proxy (app) && application_is_builtin (app));
478 application_add_segment_notify (u32 app_index, u32 fifo_segment_index)
480 application_t *app = application_get (app_index);
484 /* Send an API message to the external app, to map new segment */
485 ASSERT (app->cb_fns.add_segment_callback);
487 segment_manager_get_segment_info (fifo_segment_index, &seg_name, &seg_size);
488 return app->cb_fns.add_segment_callback (app->api_client_index, seg_name,
493 application_has_local_scope (application_t * app)
495 return app->flags & APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
499 application_has_global_scope (application_t * app)
501 return app->flags & APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
505 application_n_listeners (application_t * app)
507 return hash_elts (app->listeners_table);
511 application_first_listener (application_t * app, u8 fib_proto,
514 stream_session_t *listener;
519 sst = session_type_from_proto_and_ip (transport_proto,
520 fib_proto == FIB_PROTOCOL_IP4);
523 hash_foreach (handle, sm_index, app->listeners_table, ({
524 listener = listen_session_get_from_handle (handle);
525 if (listener->session_type == sst
526 && listener->listener_index != SESSION_PROXY_LISTENER_INDEX)
535 application_proxy_listener (application_t * app, u8 fib_proto,
538 stream_session_t *listener;
543 sst = session_type_from_proto_and_ip (transport_proto,
544 fib_proto == FIB_PROTOCOL_IP4);
547 hash_foreach (handle, sm_index, app->listeners_table, ({
548 listener = listen_session_get_from_handle (handle);
549 if (listener->session_type == sst
550 && listener->listener_index == SESSION_PROXY_LISTENER_INDEX)
558 static clib_error_t *
559 application_start_stop_proxy_fib_proto (application_t * app, u8 fib_proto,
560 u8 transport_proto, u8 is_start)
562 app_namespace_t *app_ns = app_namespace_get (app->ns_index);
563 u8 is_ip4 = (fib_proto == FIB_PROTOCOL_IP4);
564 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
565 transport_connection_t *tc;
571 s = application_first_listener (app, fib_proto, transport_proto);
575 sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
576 sep.sw_if_index = app_ns->sw_if_index;
577 sep.transport_proto = transport_proto;
578 application_start_listen (app, &sep, &handle);
579 s = listen_session_get_from_handle (handle);
580 s->listener_index = SESSION_PROXY_LISTENER_INDEX;
585 s = application_proxy_listener (app, fib_proto, transport_proto);
589 tc = listen_session_get_transport (s);
591 if (!ip_is_zero (&tc->lcl_ip, 1))
595 sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
596 sep.transport_proto = transport_proto;
598 sti = session_lookup_get_index_for_fib (fib_proto, sep.fib_index);
600 session_lookup_add_session_endpoint (sti, &sep, s->session_index);
602 session_lookup_del_session_endpoint (sti, &sep);
609 application_start_stop_proxy_local_scope (application_t * app,
610 u8 transport_proto, u8 is_start)
612 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
613 app_namespace_t *app_ns;
614 app_ns = app_namespace_get (app->ns_index);
616 sep.transport_proto = transport_proto;
621 session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
624 session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
629 session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
631 session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
636 application_start_stop_proxy (application_t * app,
637 transport_proto_t transport_proto, u8 is_start)
639 if (application_has_local_scope (app))
640 application_start_stop_proxy_local_scope (app, transport_proto, is_start);
642 if (application_has_global_scope (app))
644 application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP4,
645 transport_proto, is_start);
646 application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP6,
647 transport_proto, is_start);
652 application_setup_proxy (application_t * app)
654 u16 transports = app->proxied_transports;
655 transport_proto_t tp;
657 ASSERT (application_is_proxy (app));
658 if (application_is_builtin (app))
662 transport_proto_foreach (tp, ({
663 if (transports & (1 << tp))
664 application_start_stop_proxy (app, tp, 1);
670 application_remove_proxy (application_t * app)
672 u16 transports = app->proxied_transports;
673 transport_proto_t tp;
675 ASSERT (application_is_proxy (app));
678 transport_proto_foreach (tp, ({
679 if (transports & (1 << tp))
680 application_start_stop_proxy (app, tp, 0);
686 format_application_listener (u8 * s, va_list * args)
688 application_t *app = va_arg (*args, application_t *);
689 u64 handle = va_arg (*args, u64);
690 u32 index = va_arg (*args, u32);
691 int verbose = va_arg (*args, int);
692 stream_session_t *listener;
698 s = format (s, "%-40s%-20s%-15s%-15s%-10s", "Connection", "App",
699 "API Client", "ListenerID", "SegManager");
701 s = format (s, "%-40s%-20s", "Connection", "App");
706 app_name = app_get_name_from_reg_index (app);
707 listener = listen_session_get_from_handle (handle);
708 str = format (0, "%U", format_stream_session, listener, verbose);
712 s = format (s, "%-40s%-20s%-15u%-15u%-10u", str, app_name,
713 app->api_client_index, handle, index);
716 s = format (s, "%-40s%-20s", str, app_name);
723 application_format_connects (application_t * app, int verbose)
725 vlib_main_t *vm = vlib_get_main ();
726 segment_manager_t *sm;
727 u8 *app_name, *s = 0;
734 vlib_cli_output (vm, "%-40s%-20s%-15s%-10s", "Connection", "App",
735 "API Client", "SegManager");
737 vlib_cli_output (vm, "%-40s%-20s", "Connection", "App");
742 if (app->connects_seg_manager == (u32) ~ 0)
745 app_name = app_get_name_from_reg_index (app);
747 /* Across all fifo segments */
748 sm = segment_manager_get (app->connects_seg_manager);
749 for (j = 0; j < vec_len (sm->segment_indices); j++)
751 svm_fifo_segment_private_t *fifo_segment;
755 fifo_segment = svm_fifo_segment_get_segment (sm->segment_indices[j]);
756 fifo = svm_fifo_segment_get_fifo_list (fifo_segment);
759 u32 session_index, thread_index;
760 stream_session_t *session;
762 session_index = fifo->master_session_index;
763 thread_index = fifo->master_thread_index;
765 session = session_get (session_index, thread_index);
766 str = format (0, "%U", format_stream_session, session, verbose);
769 s = format (s, "%-40s%-20s%-15u%-10u", str, app_name,
770 app->api_client_index, app->connects_seg_manager);
772 s = format (s, "%-40s%-20s", str, app_name);
774 vlib_cli_output (vm, "%v", s);
775 vec_reset_length (s);
787 format_application (u8 * s, va_list * args)
789 application_t *app = va_arg (*args, application_t *);
790 CLIB_UNUSED (int verbose) = va_arg (*args, int);
791 segment_manager_properties_t *props;
792 const u8 *app_ns_name;
798 s = format (s, "%-10s%-20s%-15s%-15s%-15s%-15s%-15s", "Index", "Name",
799 "API Client", "Namespace", "Add seg size", "Rx fifo size",
803 format (s, "%-10s%-20s%-15s%-40s", "Index", "Name", "API Client",
808 app_name = app_get_name_from_reg_index (app);
809 app_ns_name = app_namespace_id_from_index (app->ns_index);
810 props = segment_manager_properties_get (app->sm_properties);
813 format (s, "%-10d%-20s%-15d%-15d%-15d%-15d%-15d", app->index, app_name,
814 app->api_client_index, app->ns_index,
815 props->add_segment_size,
816 props->rx_fifo_size, props->tx_fifo_size);
818 s = format (s, "%-10d%-20s%-15d%-40s", app->index, app_name,
819 app->api_client_index, app_ns_name);
823 static clib_error_t *
824 show_app_command_fn (vlib_main_t * vm, unformat_input_t * input,
825 vlib_cli_command_t * cmd)
832 session_cli_return_if_not_enabled ();
834 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
836 if (unformat (input, "server"))
838 else if (unformat (input, "client"))
840 else if (unformat (input, "verbose"))
850 if (pool_elts (app_pool))
852 vlib_cli_output (vm, "%U", format_application_listener,
853 0 /* header */ , 0, 0,
856 pool_foreach (app, app_pool,
858 /* App's listener sessions */
859 if (hash_elts (app->listeners_table) == 0)
861 hash_foreach (handle, index, app->listeners_table,
863 vlib_cli_output (vm, "%U", format_application_listener, app,
864 handle, index, verbose);
870 vlib_cli_output (vm, "No active server bindings");
875 if (pool_elts (app_pool))
877 application_format_connects (0, verbose);
880 pool_foreach (app, app_pool,
882 if (app->connects_seg_manager == (u32)~0)
884 application_format_connects (app, verbose);
889 vlib_cli_output (vm, "No active client bindings");
892 /* Print app related info */
893 if (!do_server && !do_client)
895 vlib_cli_output (vm, "%U", format_application, 0, verbose);
897 pool_foreach (app, app_pool, ({
898 vlib_cli_output (vm, "%U", format_application, app, verbose);
907 VLIB_CLI_COMMAND (show_app_command, static) =
910 .short_help = "show app [server|client] [verbose]",
911 .function = show_app_command_fn,
916 * fd.io coding-style-patch-verification: ON
919 * eval: (c-set-style "gnu")