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_EVT_QUEUE_SIZE] > 0 ?
241 options[APP_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[SESSION_OPTIONS_ADD_SEGMENT_SIZE];
251 props->rx_fifo_size = options[SESSION_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[SESSION_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];
262 props->private_segment_size = options[APP_OPTIONS_PRIVATE_SEGMENT_SIZE];
264 first_seg_size = options[SESSION_OPTIONS_SEGMENT_SIZE];
265 if ((rv = segment_manager_init (sm, app->sm_properties, first_seg_size)))
267 sm->first_is_protected = 1;
272 app->first_segment_manager = segment_manager_index (sm);
273 app->api_client_index = api_client_index;
274 app->flags = options[APP_OPTIONS_FLAGS];
275 app->cb_fns = *cb_fns;
276 app->ns_index = options[APP_OPTIONS_NAMESPACE];
277 app->listeners_table = hash_create (0, sizeof (u64));
278 app->proxied_transports = options[APP_OPTIONS_PROXY_TRANSPORT];
280 /* If no scope enabled, default to global */
281 if (!application_has_global_scope (app)
282 && !application_has_local_scope (app))
283 app->flags |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
285 /* Allocate app event queue in the first shared-memory segment */
286 app->event_queue = segment_manager_alloc_queue (sm, app_evt_queue_size);
288 /* Check that the obvious things are properly set up */
289 application_verify_cb_fns (cb_fns);
291 /* Add app to lookup by api_client_index table */
292 application_table_add (app);
298 application_get (u32 index)
300 if (index == APP_INVALID_INDEX)
302 return pool_elt_at_index (app_pool, index);
306 application_get_if_valid (u32 index)
308 if (pool_is_free_index (app_pool, index))
311 return pool_elt_at_index (app_pool, index);
315 application_get_index (application_t * app)
317 return app - app_pool;
320 static segment_manager_t *
321 application_alloc_segment_manager (application_t * app)
323 segment_manager_t *sm = 0;
325 /* If the first segment manager is not in use, don't allocate a new one */
326 if (app->first_segment_manager != APP_INVALID_SEGMENT_MANAGER_INDEX
327 && app->first_segment_manager_in_use == 0)
329 sm = segment_manager_get (app->first_segment_manager);
330 app->first_segment_manager_in_use = 1;
334 sm = segment_manager_new ();
335 sm->properties_index = app->sm_properties;
341 * Start listening local transport endpoint for requested transport.
343 * Creates a 'dummy' stream session with state LISTENING to be used in session
344 * lookups, prior to establishing connection. Requests transport to build
345 * it's own specific listening connection.
348 application_start_listen (application_t * srv, session_endpoint_t * sep,
351 segment_manager_t *sm;
356 sst = session_type_from_proto_and_ip (sep->transport_proto, sep->is_ip4);
357 s = listen_session_new (sst);
358 s->app_index = srv->index;
360 if (stream_session_listen (s, sep))
363 /* Allocate segment manager. All sessions derived out of a listen session
364 * have fifos allocated by the same segment manager. */
365 sm = application_alloc_segment_manager (srv);
369 /* Add to app's listener table. Useful to find all child listeners
370 * when app goes down, although, just for unbinding this is not needed */
371 handle = listen_session_get_handle (s);
372 hash_set (srv->listeners_table, handle, segment_manager_index (sm));
378 listen_session_del (s);
383 * Stop listening on session associated to handle
386 application_stop_listen (application_t * srv, u64 handle)
388 stream_session_t *listener;
390 segment_manager_t *sm;
392 if (srv && hash_get (srv->listeners_table, handle) == 0)
394 clib_warning ("app doesn't own handle %llu!", handle);
398 listener = listen_session_get_from_handle (handle);
399 stream_session_stop_listen (listener);
401 indexp = hash_get (srv->listeners_table, handle);
404 sm = segment_manager_get (*indexp);
405 if (srv->first_segment_manager == *indexp)
407 /* Delete sessions but don't remove segment manager */
408 srv->first_segment_manager_in_use = 0;
409 segment_manager_del_sessions (sm);
413 segment_manager_init_del (sm);
415 hash_unset (srv->listeners_table, handle);
416 listen_session_del (listener);
422 application_open_session (application_t * app, session_endpoint_t * sep,
425 segment_manager_t *sm;
428 /* Make sure we have a segment manager for connects */
429 if (app->connects_seg_manager == APP_INVALID_SEGMENT_MANAGER_INDEX)
431 sm = application_alloc_segment_manager (app);
434 app->connects_seg_manager = segment_manager_index (sm);
437 if ((rv = session_open (app->index, sep, api_context)))
444 application_get_connect_segment_manager (application_t * app)
446 ASSERT (app->connects_seg_manager != (u32) ~ 0);
447 return segment_manager_get (app->connects_seg_manager);
451 application_get_listen_segment_manager (application_t * app,
452 stream_session_t * s)
455 smp = hash_get (app->listeners_table, listen_session_get_handle (s));
457 return segment_manager_get (*smp);
461 application_is_proxy (application_t * app)
463 return (app->flags & APP_OPTIONS_FLAGS_IS_PROXY);
467 application_is_builtin (application_t * app)
469 return (app->flags & APP_OPTIONS_FLAGS_IS_BUILTIN);
473 application_is_builtin_proxy (application_t * app)
475 return (application_is_proxy (app) && application_is_builtin (app));
479 application_add_segment_notify (u32 app_index, u32 fifo_segment_index)
481 application_t *app = application_get (app_index);
485 /* Send an API message to the external app, to map new segment */
486 ASSERT (app->cb_fns.add_segment_callback);
488 segment_manager_get_segment_info (fifo_segment_index, &seg_name, &seg_size);
489 return app->cb_fns.add_segment_callback (app->api_client_index, seg_name,
494 application_has_local_scope (application_t * app)
496 return app->flags & APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
500 application_has_global_scope (application_t * app)
502 return app->flags & APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
506 application_n_listeners (application_t * app)
508 return hash_elts (app->listeners_table);
512 application_first_listener (application_t * app, u8 fib_proto,
515 stream_session_t *listener;
520 sst = session_type_from_proto_and_ip (transport_proto,
521 fib_proto == FIB_PROTOCOL_IP4);
524 hash_foreach (handle, sm_index, app->listeners_table, ({
525 listener = listen_session_get_from_handle (handle);
526 if (listener->session_type == sst
527 && listener->listener_index != SESSION_PROXY_LISTENER_INDEX)
535 static clib_error_t *
536 application_start_stop_proxy_fib_proto (application_t * app, u8 fib_proto,
537 u8 transport_proto, u8 is_start)
539 app_namespace_t *app_ns = app_namespace_get (app->ns_index);
540 u8 is_ip4 = (fib_proto == FIB_PROTOCOL_IP4);
541 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
542 transport_connection_t *tc;
549 sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
550 sep.sw_if_index = app_ns->sw_if_index;
551 sep.transport_proto = transport_proto;
552 application_start_listen (app, &sep, &handle);
553 s = listen_session_get_from_handle (handle);
554 s->listener_index = SESSION_PROXY_LISTENER_INDEX;
558 s = application_first_listener (app, fib_proto, transport_proto);
560 tc = listen_session_get_transport (s);
562 if (!ip_is_zero (&tc->lcl_ip, 1))
566 sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
567 sep.transport_proto = transport_proto;
569 sti = session_lookup_get_index_for_fib (fib_proto, sep.fib_index);
570 session_lookup_add_session_endpoint (sti, &sep, s->session_index);
576 application_start_stop_proxy (application_t * app, u8 transport_proto,
579 if (application_has_local_scope (app))
581 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
582 app_namespace_t *app_ns;
583 app_ns = app_namespace_get (app->ns_index);
585 sep.transport_proto = transport_proto;
587 session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
591 session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
595 if (application_has_global_scope (app))
597 application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP4,
598 transport_proto, is_start);
599 application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP6,
600 transport_proto, is_start);
605 application_setup_proxy (application_t * app)
607 u16 transports = app->proxied_transports;
608 ASSERT (application_is_proxy (app));
609 if (application_is_builtin (app))
611 if (transports & (1 << TRANSPORT_PROTO_TCP))
612 application_start_stop_proxy (app, TRANSPORT_PROTO_TCP, 1);
613 if (transports & (1 << TRANSPORT_PROTO_UDP))
614 application_start_stop_proxy (app, TRANSPORT_PROTO_UDP, 1);
618 application_remove_proxy (application_t * app)
620 u16 transports = app->proxied_transports;
621 ASSERT (application_is_proxy (app));
622 if (transports & (1 << TRANSPORT_PROTO_TCP))
623 application_start_stop_proxy (app, TRANSPORT_PROTO_TCP, 0);
624 if (transports & (1 << TRANSPORT_PROTO_UDP))
625 application_start_stop_proxy (app, TRANSPORT_PROTO_UDP, 0);
629 format_application_listener (u8 * s, va_list * args)
631 application_t *app = va_arg (*args, application_t *);
632 u64 handle = va_arg (*args, u64);
633 u32 index = va_arg (*args, u32);
634 int verbose = va_arg (*args, int);
635 stream_session_t *listener;
641 s = format (s, "%-40s%-20s%-15s%-15s%-10s", "Connection", "App",
642 "API Client", "ListenerID", "SegManager");
644 s = format (s, "%-40s%-20s", "Connection", "App");
649 app_name = app_get_name_from_reg_index (app);
650 listener = listen_session_get_from_handle (handle);
651 str = format (0, "%U", format_stream_session, listener, verbose);
655 s = format (s, "%-40s%-20s%-15u%-15u%-10u", str, app_name,
656 app->api_client_index, handle, index);
659 s = format (s, "%-40s%-20s", str, app_name);
666 application_format_connects (application_t * app, int verbose)
668 vlib_main_t *vm = vlib_get_main ();
669 segment_manager_t *sm;
670 u8 *app_name, *s = 0;
677 vlib_cli_output (vm, "%-40s%-20s%-15s%-10s", "Connection", "App",
678 "API Client", "SegManager");
680 vlib_cli_output (vm, "%-40s%-20s", "Connection", "App");
685 if (app->connects_seg_manager == (u32) ~ 0)
688 app_name = app_get_name_from_reg_index (app);
690 /* Across all fifo segments */
691 sm = segment_manager_get (app->connects_seg_manager);
692 for (j = 0; j < vec_len (sm->segment_indices); j++)
694 svm_fifo_segment_private_t *fifo_segment;
698 fifo_segment = svm_fifo_segment_get_segment (sm->segment_indices[j]);
699 fifo = svm_fifo_segment_get_fifo_list (fifo_segment);
702 u32 session_index, thread_index;
703 stream_session_t *session;
705 session_index = fifo->master_session_index;
706 thread_index = fifo->master_thread_index;
708 session = session_get (session_index, thread_index);
709 str = format (0, "%U", format_stream_session, session, verbose);
712 s = format (s, "%-40s%-20s%-15u%-10u", str, app_name,
713 app->api_client_index, app->connects_seg_manager);
715 s = format (s, "%-40s%-20s", str, app_name);
717 vlib_cli_output (vm, "%v", s);
718 vec_reset_length (s);
730 format_application (u8 * s, va_list * args)
732 application_t *app = va_arg (*args, application_t *);
733 CLIB_UNUSED (int verbose) = va_arg (*args, int);
734 segment_manager_properties_t *props;
735 const u8 *app_ns_name;
741 s = format (s, "%-10s%-20s%-15s%-15s%-15s%-15s%-15s", "Index", "Name",
742 "API Client", "Namespace", "Add seg size", "Rx fifo size",
746 format (s, "%-10s%-20s%-15s%-40s", "Index", "Name", "API Client",
751 app_name = app_get_name_from_reg_index (app);
752 app_ns_name = app_namespace_id_from_index (app->ns_index);
753 props = segment_manager_properties_get (app->sm_properties);
756 format (s, "%-10d%-20s%-15d%-15d%-15d%-15d%-15d", app->index, app_name,
757 app->api_client_index, app->ns_index,
758 props->add_segment_size,
759 props->rx_fifo_size, props->tx_fifo_size);
761 s = format (s, "%-10d%-20s%-15d%-40s", app->index, app_name,
762 app->api_client_index, app_ns_name);
766 static clib_error_t *
767 show_app_command_fn (vlib_main_t * vm, unformat_input_t * input,
768 vlib_cli_command_t * cmd)
775 session_cli_return_if_not_enabled ();
777 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
779 if (unformat (input, "server"))
781 else if (unformat (input, "client"))
783 else if (unformat (input, "verbose"))
793 if (pool_elts (app_pool))
795 vlib_cli_output (vm, "%U", format_application_listener,
796 0 /* header */ , 0, 0,
799 pool_foreach (app, app_pool,
801 /* App's listener sessions */
802 if (hash_elts (app->listeners_table) == 0)
804 hash_foreach (handle, index, app->listeners_table,
806 vlib_cli_output (vm, "%U", format_application_listener, app,
807 handle, index, verbose);
813 vlib_cli_output (vm, "No active server bindings");
818 if (pool_elts (app_pool))
820 application_format_connects (0, verbose);
823 pool_foreach (app, app_pool,
825 if (app->connects_seg_manager == (u32)~0)
827 application_format_connects (app, verbose);
832 vlib_cli_output (vm, "No active client bindings");
835 /* Print app related info */
836 if (!do_server && !do_client)
838 vlib_cli_output (vm, "%U", format_application, 0, verbose);
840 pool_foreach (app, app_pool, ({
841 vlib_cli_output (vm, "%U", format_application, app, verbose);
850 VLIB_CLI_COMMAND (show_app_command, static) =
853 .short_help = "show app [server|client] [verbose]",
854 .function = show_app_command_fn,
859 * fd.io coding-style-patch-verification: ON
862 * eval: (c-set-style "gnu")