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_t *sm;
150 u64 handle, *handles = 0;
153 vnet_unbind_args_t _a, *a = &_a;
156 * The app event queue allocated in first segment is cleared with
157 * the segment manager. No need to explicitly free it.
160 clib_warning ("[%d] Delete app (%d)", getpid (), app->index);
162 if (application_is_proxy (app))
163 application_remove_proxy (app);
170 hash_foreach (handle, index, app->listeners_table,
172 vec_add1 (handles, handle);
173 sm = segment_manager_get (index);
174 sm->app_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
178 for (i = 0; i < vec_len (handles); i++)
180 a->app_index = app->index;
181 a->handle = handles[i];
182 /* seg manager is removed when unbind completes */
187 * Connects segment manager cleanup
190 if (app->connects_seg_manager != APP_INVALID_SEGMENT_MANAGER_INDEX)
192 sm = segment_manager_get (app->connects_seg_manager);
193 sm->app_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
194 segment_manager_init_del (sm);
197 /* If first segment manager is used by a listener */
198 if (app->first_segment_manager != APP_INVALID_SEGMENT_MANAGER_INDEX
199 && app->first_segment_manager != app->connects_seg_manager)
201 sm = segment_manager_get (app->first_segment_manager);
202 /* .. and has no fifos, e.g. it might be used for redirected sessions,
204 if (!segment_manager_has_fifos (sm))
206 sm->app_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
207 segment_manager_del (sm);
211 application_table_del (app);
212 pool_put (app_pool, app);
216 application_verify_cb_fns (session_cb_vft_t * cb_fns)
218 if (cb_fns->session_accept_callback == 0)
219 clib_warning ("No accept callback function provided");
220 if (cb_fns->session_connected_callback == 0)
221 clib_warning ("No session connected callback function provided");
222 if (cb_fns->session_disconnect_callback == 0)
223 clib_warning ("No session disconnect callback function provided");
224 if (cb_fns->session_reset_callback == 0)
225 clib_warning ("No session reset callback function provided");
229 application_init (application_t * app, u32 api_client_index, u64 * options,
230 session_cb_vft_t * cb_fns)
232 segment_manager_t *sm;
233 segment_manager_properties_t *props;
234 u32 app_evt_queue_size, first_seg_size;
235 u32 default_rx_fifo_size = 16 << 10, default_tx_fifo_size = 16 << 10;
238 app_evt_queue_size = options[APP_EVT_QUEUE_SIZE] > 0 ?
239 options[APP_EVT_QUEUE_SIZE] : default_app_evt_queue_size;
242 * Setup segment manager
244 sm = segment_manager_new ();
245 sm->app_index = app->index;
246 props = &app->sm_properties;
247 props->add_segment_size = options[SESSION_OPTIONS_ADD_SEGMENT_SIZE];
248 props->rx_fifo_size = options[SESSION_OPTIONS_RX_FIFO_SIZE];
249 props->rx_fifo_size =
250 props->rx_fifo_size ? props->rx_fifo_size : default_rx_fifo_size;
251 props->tx_fifo_size = options[SESSION_OPTIONS_TX_FIFO_SIZE];
252 props->tx_fifo_size =
253 props->tx_fifo_size ? props->tx_fifo_size : default_tx_fifo_size;
254 props->add_segment = props->add_segment_size != 0;
255 props->preallocated_fifo_pairs = options[APP_OPTIONS_PREALLOC_FIFO_PAIRS];
256 props->use_private_segment = options[APP_OPTIONS_FLAGS]
257 & APP_OPTIONS_FLAGS_IS_BUILTIN;
258 props->private_segment_count = options[APP_OPTIONS_PRIVATE_SEGMENT_COUNT];
259 props->private_segment_size = options[APP_OPTIONS_PRIVATE_SEGMENT_SIZE];
261 first_seg_size = options[SESSION_OPTIONS_SEGMENT_SIZE];
262 if ((rv = segment_manager_init (sm, props, first_seg_size)))
264 sm->first_is_protected = 1;
269 app->first_segment_manager = segment_manager_index (sm);
270 app->api_client_index = api_client_index;
271 app->flags = options[APP_OPTIONS_FLAGS];
272 app->cb_fns = *cb_fns;
273 app->ns_index = options[APP_OPTIONS_NAMESPACE];
274 app->listeners_table = hash_create (0, sizeof (u64));
275 app->proxied_transports = options[APP_OPTIONS_PROXY_TRANSPORT];
277 /* If no scope enabled, default to global */
278 if (!application_has_global_scope (app)
279 && !application_has_local_scope (app))
280 app->flags |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
282 /* Allocate app event queue in the first shared-memory segment */
283 app->event_queue = segment_manager_alloc_queue (sm, app_evt_queue_size);
285 /* Check that the obvious things are properly set up */
286 application_verify_cb_fns (cb_fns);
288 /* Add app to lookup by api_client_index table */
289 application_table_add (app);
295 application_get (u32 index)
297 if (index == APP_INVALID_INDEX)
299 return pool_elt_at_index (app_pool, index);
303 application_get_if_valid (u32 index)
305 if (pool_is_free_index (app_pool, index))
308 return pool_elt_at_index (app_pool, index);
312 application_get_index (application_t * app)
314 return app - app_pool;
317 static segment_manager_t *
318 application_alloc_segment_manager (application_t * app)
320 segment_manager_t *sm = 0;
322 /* If the first segment manager is not in use, don't allocate a new one */
323 if (app->first_segment_manager != APP_INVALID_SEGMENT_MANAGER_INDEX
324 && app->first_segment_manager_in_use == 0)
326 sm = segment_manager_get (app->first_segment_manager);
327 app->first_segment_manager_in_use = 1;
331 sm = segment_manager_new ();
332 sm->properties = &app->sm_properties;
338 * Start listening local transport endpoint for requested transport.
340 * Creates a 'dummy' stream session with state LISTENING to be used in session
341 * lookups, prior to establishing connection. Requests transport to build
342 * it's own specific listening connection.
345 application_start_listen (application_t * srv, session_endpoint_t * sep,
348 segment_manager_t *sm;
353 sst = session_type_from_proto_and_ip (sep->transport_proto, sep->is_ip4);
354 s = listen_session_new (sst);
355 s->app_index = srv->index;
357 if (stream_session_listen (s, sep))
360 /* Allocate segment manager. All sessions derived out of a listen session
361 * have fifos allocated by the same segment manager. */
362 sm = application_alloc_segment_manager (srv);
366 /* Add to app's listener table. Useful to find all child listeners
367 * when app goes down, although, just for unbinding this is not needed */
368 handle = listen_session_get_handle (s);
369 hash_set (srv->listeners_table, handle, segment_manager_index (sm));
375 listen_session_del (s);
380 * Stop listening on session associated to handle
383 application_stop_listen (application_t * srv, u64 handle)
385 stream_session_t *listener;
387 segment_manager_t *sm;
389 if (srv && hash_get (srv->listeners_table, handle) == 0)
391 clib_warning ("app doesn't own handle %llu!", handle);
395 listener = listen_session_get_from_handle (handle);
396 stream_session_stop_listen (listener);
398 indexp = hash_get (srv->listeners_table, handle);
401 sm = segment_manager_get (*indexp);
402 if (srv->first_segment_manager == *indexp)
404 /* Delete sessions but don't remove segment manager */
405 srv->first_segment_manager_in_use = 0;
406 segment_manager_del_sessions (sm);
410 segment_manager_init_del (sm);
412 hash_unset (srv->listeners_table, handle);
413 listen_session_del (listener);
419 application_open_session (application_t * app, session_endpoint_t * sep,
422 segment_manager_t *sm;
425 /* Make sure we have a segment manager for connects */
426 if (app->connects_seg_manager == APP_INVALID_SEGMENT_MANAGER_INDEX)
428 sm = application_alloc_segment_manager (app);
431 app->connects_seg_manager = segment_manager_index (sm);
434 if ((rv = session_open (app->index, sep, api_context)))
441 application_get_connect_segment_manager (application_t * app)
443 ASSERT (app->connects_seg_manager != (u32) ~ 0);
444 return segment_manager_get (app->connects_seg_manager);
448 application_get_listen_segment_manager (application_t * app,
449 stream_session_t * s)
452 smp = hash_get (app->listeners_table, listen_session_get_handle (s));
454 return segment_manager_get (*smp);
458 application_is_proxy (application_t * app)
460 return (app->flags & APP_OPTIONS_FLAGS_IS_PROXY);
464 application_is_builtin (application_t * app)
466 return (app->flags & APP_OPTIONS_FLAGS_IS_BUILTIN);
470 application_is_builtin_proxy (application_t * app)
472 return (application_is_proxy (app) && application_is_builtin (app));
476 application_add_segment_notify (u32 app_index, u32 fifo_segment_index)
478 application_t *app = application_get (app_index);
482 /* Send an API message to the external app, to map new segment */
483 ASSERT (app->cb_fns.add_segment_callback);
485 segment_manager_get_segment_info (fifo_segment_index, &seg_name, &seg_size);
486 return app->cb_fns.add_segment_callback (app->api_client_index, seg_name,
491 application_has_local_scope (application_t * app)
493 return app->flags & APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
497 application_has_global_scope (application_t * app)
499 return app->flags & APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
503 application_n_listeners (application_t * app)
505 return hash_elts (app->listeners_table);
509 application_first_listener (application_t * app, u8 fib_proto,
512 stream_session_t *listener;
517 sst = session_type_from_proto_and_ip (transport_proto,
518 fib_proto == FIB_PROTOCOL_IP4);
521 hash_foreach (handle, sm_index, app->listeners_table, ({
522 listener = listen_session_get_from_handle (handle);
523 if (listener->session_type == sst)
531 static clib_error_t *
532 application_start_stop_proxy_fib_proto (application_t * app, u8 fib_proto,
533 u8 transport_proto, u8 is_start)
535 session_rule_add_del_args_t args;
536 fib_prefix_t lcl_pref, rmt_pref;
537 app_namespace_t *app_ns = app_namespace_get (app->ns_index);
538 u8 is_ip4 = (fib_proto == FIB_PROTOCOL_IP4);
539 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
540 transport_connection_t *tc;
547 sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
548 sep.sw_if_index = app_ns->sw_if_index;
549 sep.transport_proto = transport_proto;
550 application_start_listen (app, &sep, &handle);
551 s = listen_session_get_from_handle (handle);
555 s = application_first_listener (app, fib_proto, transport_proto);
557 tc = listen_session_get_transport (s);
559 if (!ip_is_zero (&tc->lcl_ip, 1))
561 memset (&args, 0, sizeof (args));
562 memset (&lcl_pref, 0, sizeof (lcl_pref));
563 ip_copy (&lcl_pref.fp_addr, &tc->lcl_ip, is_ip4);
564 lcl_pref.fp_len = is_ip4 ? 32 : 128;
565 lcl_pref.fp_proto = fib_proto;
566 memset (&rmt_pref, 0, sizeof (rmt_pref));
568 rmt_pref.fp_proto = fib_proto;
570 args.table_args.lcl = lcl_pref;
571 args.table_args.rmt = rmt_pref;
572 args.table_args.lcl_port = 0;
573 args.table_args.rmt_port = 0;
574 args.table_args.action_index = app->index;
575 args.table_args.is_add = is_start;
576 args.transport_proto = transport_proto;
577 args.appns_index = app->ns_index;
578 args.scope = SESSION_RULE_SCOPE_GLOBAL;
579 return vnet_session_rule_add_del (&args);
585 application_start_stop_proxy (application_t * app, u8 transport_proto,
588 session_rule_add_del_args_t args;
590 if (application_has_local_scope (app))
592 memset (&args, 0, sizeof (args));
593 args.table_args.lcl.fp_proto = FIB_PROTOCOL_IP4;
594 args.table_args.rmt.fp_proto = FIB_PROTOCOL_IP4;
595 args.table_args.lcl_port = 0;
596 args.table_args.rmt_port = 0;
597 args.table_args.action_index = app->index;
598 args.table_args.is_add = is_start;
599 args.transport_proto = transport_proto;
600 args.appns_index = app->ns_index;
601 args.scope = SESSION_RULE_SCOPE_LOCAL;
602 vnet_session_rule_add_del (&args);
604 args.table_args.lcl.fp_proto = FIB_PROTOCOL_IP6;
605 args.table_args.rmt.fp_proto = FIB_PROTOCOL_IP6;
606 vnet_session_rule_add_del (&args);
609 if (application_has_global_scope (app))
611 application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP4,
612 transport_proto, is_start);
613 application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP6,
614 transport_proto, is_start);
619 application_setup_proxy (application_t * app)
621 u16 transports = app->proxied_transports;
622 ASSERT (application_is_proxy (app));
623 if (application_is_builtin (app))
625 if (transports & (1 << TRANSPORT_PROTO_TCP))
626 application_start_stop_proxy (app, TRANSPORT_PROTO_TCP, 1);
627 if (transports & (1 << TRANSPORT_PROTO_UDP))
628 application_start_stop_proxy (app, TRANSPORT_PROTO_UDP, 1);
632 application_remove_proxy (application_t * app)
634 u16 transports = app->proxied_transports;
635 ASSERT (application_is_proxy (app));
636 if (transports & (1 << TRANSPORT_PROTO_TCP))
637 application_start_stop_proxy (app, TRANSPORT_PROTO_TCP, 0);
638 if (transports & (1 << TRANSPORT_PROTO_UDP))
639 application_start_stop_proxy (app, TRANSPORT_PROTO_UDP, 0);
643 format_application_listener (u8 * s, va_list * args)
645 application_t *app = va_arg (*args, application_t *);
646 u64 handle = va_arg (*args, u64);
647 u32 index = va_arg (*args, u32);
648 int verbose = va_arg (*args, int);
649 stream_session_t *listener;
655 s = format (s, "%-40s%-20s%-15s%-15s%-10s", "Connection", "App",
656 "API Client", "ListenerID", "SegManager");
658 s = format (s, "%-40s%-20s", "Connection", "App");
663 app_name = app_get_name_from_reg_index (app);
664 listener = listen_session_get_from_handle (handle);
665 str = format (0, "%U", format_stream_session, listener, verbose);
669 s = format (s, "%-40s%-20s%-15u%-15u%-10u", str, app_name,
670 app->api_client_index, handle, index);
673 s = format (s, "%-40s%-20s", str, app_name);
680 application_format_connects (application_t * app, int verbose)
682 vlib_main_t *vm = vlib_get_main ();
683 segment_manager_t *sm;
684 u8 *app_name, *s = 0;
691 vlib_cli_output (vm, "%-40s%-20s%-15s%-10s", "Connection", "App",
692 "API Client", "SegManager");
694 vlib_cli_output (vm, "%-40s%-20s", "Connection", "App");
699 if (app->connects_seg_manager == (u32) ~ 0)
702 app_name = app_get_name_from_reg_index (app);
704 /* Across all fifo segments */
705 sm = segment_manager_get (app->connects_seg_manager);
706 for (j = 0; j < vec_len (sm->segment_indices); j++)
708 svm_fifo_segment_private_t *fifo_segment;
712 fifo_segment = svm_fifo_segment_get_segment (sm->segment_indices[j]);
713 fifo = svm_fifo_segment_get_fifo_list (fifo_segment);
716 u32 session_index, thread_index;
717 stream_session_t *session;
719 session_index = fifo->master_session_index;
720 thread_index = fifo->master_thread_index;
722 session = session_get (session_index, thread_index);
723 str = format (0, "%U", format_stream_session, session, verbose);
726 s = format (s, "%-40s%-20s%-15u%-10u", str, app_name,
727 app->api_client_index, app->connects_seg_manager);
729 s = format (s, "%-40s%-20s", str, app_name);
731 vlib_cli_output (vm, "%v", s);
732 vec_reset_length (s);
744 format_application (u8 * s, va_list * args)
746 application_t *app = va_arg (*args, application_t *);
747 CLIB_UNUSED (int verbose) = va_arg (*args, int);
748 const u8 *app_ns_name;
754 s = format (s, "%-10s%-20s%-15s%-15s%-15s%-15s%-15s", "Index", "Name",
755 "Namespace", "API Client", "Add seg size", "Rx fifo size",
759 format (s, "%-10s%-20s%-15s%-20s", "Index", "Name", "Namespace",
764 app_name = app_get_name_from_reg_index (app);
765 app_ns_name = app_namespace_id_from_index (app->ns_index);
768 format (s, "%-10d%-20s%-15s%-15d%-15d%-15d%-15d", app->index, app_name,
769 app_ns_name, app->api_client_index,
770 app->sm_properties.add_segment_size,
771 app->sm_properties.rx_fifo_size,
772 app->sm_properties.tx_fifo_size);
774 s = format (s, "%-10d%-20s%-15s%-20d", app->index, app_name, app_ns_name,
775 app->api_client_index);
779 static clib_error_t *
780 show_app_command_fn (vlib_main_t * vm, unformat_input_t * input,
781 vlib_cli_command_t * cmd)
788 session_cli_return_if_not_enabled ();
790 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
792 if (unformat (input, "server"))
794 else if (unformat (input, "client"))
796 else if (unformat (input, "verbose"))
806 if (pool_elts (app_pool))
808 vlib_cli_output (vm, "%U", format_application_listener,
809 0 /* header */ , 0, 0,
812 pool_foreach (app, app_pool,
814 /* App's listener sessions */
815 if (hash_elts (app->listeners_table) == 0)
817 hash_foreach (handle, index, app->listeners_table,
819 vlib_cli_output (vm, "%U", format_application_listener, app,
820 handle, index, verbose);
826 vlib_cli_output (vm, "No active server bindings");
831 if (pool_elts (app_pool))
833 application_format_connects (0, verbose);
836 pool_foreach (app, app_pool,
838 if (app->connects_seg_manager == (u32)~0)
840 application_format_connects (app, verbose);
845 vlib_cli_output (vm, "No active client bindings");
848 /* Print app related info */
849 if (!do_server && !do_client)
851 vlib_cli_output (vm, "%U", format_application, 0, verbose);
853 pool_foreach (app, app_pool, ({
854 vlib_cli_output (vm, "%U", format_application, app, verbose);
863 VLIB_CLI_COMMAND (show_app_command, static) =
866 .short_help = "show app [server|client] [verbose]",
867 .function = show_app_command_fn,
872 * fd.io coding-style-patch-verification: ON
875 * eval: (c-set-style "gnu")