2 * Copyright (c) 2017-2019 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/application_local.h>
20 #include <vnet/session/session.h>
22 static app_main_t app_main;
24 #define app_interface_check_thread_and_barrier(_fn, _arg) \
25 if (PREDICT_FALSE (!vlib_thread_is_main_w_barrier ())) \
27 vlib_rpc_call_main_thread (_fn, (u8 *) _arg, sizeof(*_arg)); \
31 static app_listener_t *
32 app_listener_alloc (application_t * app)
34 app_listener_t *app_listener;
35 pool_get (app->listeners, app_listener);
36 clib_memset (app_listener, 0, sizeof (*app_listener));
37 app_listener->al_index = app_listener - app->listeners;
38 app_listener->app_index = app->app_index;
39 app_listener->session_index = SESSION_INVALID_INDEX;
40 app_listener->local_index = SESSION_INVALID_INDEX;
45 app_listener_get (application_t * app, u32 app_listener_index)
47 return pool_elt_at_index (app->listeners, app_listener_index);
51 app_listener_free (application_t * app, app_listener_t * app_listener)
53 clib_bitmap_free (app_listener->workers);
54 pool_put (app->listeners, app_listener);
56 clib_memset (app_listener, 0xfa, sizeof (*app_listener));
60 app_listener_id (app_listener_t * al)
62 ASSERT (al->app_index < 1 << 16 && al->al_index < 1 << 16);
63 return (al->app_index << 16 | al->al_index);
67 app_listener_handle (app_listener_t * al)
69 return ((u64) SESSION_LISTENER_PREFIX << 32 | (u64) app_listener_id (al));
73 app_listener_id_parse (u32 listener_id, u32 * app_index,
74 u32 * app_listener_index)
76 *app_index = listener_id >> 16;
77 *app_listener_index = listener_id & 0xFFFF;
81 app_listener_handle_parse (session_handle_t handle, u32 * app_index,
82 u32 * app_listener_index)
84 app_listener_id_parse (handle & 0xFFFFFFFF, app_index, app_listener_index);
87 static app_listener_t *
88 app_listener_get_w_id (u32 listener_id)
90 u32 app_index, app_listener_index;
93 app_listener_id_parse (listener_id, &app_index, &app_listener_index);
94 app = application_get_if_valid (app_index);
97 return app_listener_get (app, app_listener_index);
101 app_listener_get_w_session (session_t * ls)
105 app = application_get_if_valid (ls->app_index);
108 return app_listener_get (app, ls->al_index);
112 app_listener_get_w_handle (session_handle_t handle)
115 if (handle >> 32 != SESSION_LISTENER_PREFIX)
118 return app_listener_get_w_id (handle & 0xFFFFFFFF);
122 app_listener_lookup (application_t * app, session_endpoint_cfg_t * sep_ext)
124 u32 table_index, fib_proto;
125 session_endpoint_t *sep;
126 session_handle_t handle;
130 sep = (session_endpoint_t *) sep_ext;
131 if (application_has_local_scope (app) && session_endpoint_is_local (sep))
133 table_index = application_local_session_table (app);
134 handle = session_lookup_endpoint_listener (table_index, sep, 1);
135 if (handle != SESSION_INVALID_HANDLE)
137 ll = application_get_local_listener_w_handle (handle);
138 return app_listener_get_w_session ((session_t *) ll);
142 fib_proto = session_endpoint_fib_proto (sep);
143 table_index = application_session_table (app, fib_proto);
144 handle = session_lookup_endpoint_listener (table_index, sep, 1);
145 if (handle != SESSION_INVALID_HANDLE)
147 ls = listen_session_get_from_handle (handle);
148 return app_listener_get_w_session ((session_t *) ls);
155 app_listener_alloc_and_init (application_t * app,
156 session_endpoint_cfg_t * sep,
157 app_listener_t ** listener)
159 app_listener_t *app_listener;
160 local_session_t *ll = 0;
167 app_listener = app_listener_alloc (app);
168 al_index = app_listener->al_index;
169 st = session_type_from_proto_and_ip (sep->transport_proto, sep->is_ip4);
172 * Add session endpoint to local session table. Only binds to "inaddr_any"
173 * (i.e., zero address) are added to local scope table.
175 if (application_has_local_scope (app)
176 && session_endpoint_is_local ((session_endpoint_t *) sep))
180 ll = application_local_listen_session_alloc (app);
181 ll->port = sep->port;
182 /* Store the original session type for the unbind */
183 ll->listener_session_type = st;
184 table_index = application_local_session_table (app);
185 lh = application_local_session_handle (ll);
186 session_lookup_add_session_endpoint (table_index,
187 (session_endpoint_t *) sep, lh);
188 app_listener->local_index = ll->session_index;
189 ll->al_index = app_listener->al_index;
192 if (application_has_global_scope (app))
195 * Start listening on local endpoint for requested transport and scope.
196 * Creates a stream session with state LISTENING to be used in session
197 * lookups, prior to establishing connection. Requests transport to
198 * build it's own specific listening connection.
200 ls = listen_session_alloc (0, st);
201 ls->app_index = app->app_index;
202 ls->app_wrk_index = sep->app_wrk_index;
204 /* Listen pool can be reallocated if the transport is
206 lh = session_handle (ls);
208 if ((rv = session_listen (ls, sep)))
210 ls = session_get_from_handle (lh);
214 ls = session_get_from_handle (lh);
215 app_listener = app_listener_get (app, al_index);
216 app_listener->session_index = ls->session_index;
217 ls->al_index = al_index;
222 app_listener_free (app, app_listener);
226 *listener = app_listener;
231 app_listener_cleanup (app_listener_t * al)
233 application_t *app = application_get (al->app_index);
235 if (al->session_index != SESSION_INVALID_INDEX)
237 session_t *ls = session_get (al->session_index, 0);
238 session_stop_listen (ls);
239 listen_session_free (ls);
241 if (al->local_index != SESSION_INVALID_INDEX)
243 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
247 table_index = application_local_session_table (app);
248 ll = application_get_local_listen_session (app, al->local_index);
249 application_local_listener_session_endpoint (ll, &sep);
250 session_lookup_del_session_endpoint (table_index, &sep);
251 application_local_listen_session_free (app, ll);
253 app_listener_free (app, al);
257 app_listener_select_worker (app_listener_t * al)
262 app = application_get (al->app_index);
263 wrk_index = clib_bitmap_next_set (al->workers, al->accept_rotor + 1);
265 wrk_index = clib_bitmap_first_set (al->workers);
267 ASSERT (wrk_index != ~0);
268 al->accept_rotor = wrk_index;
269 return application_get_worker (app, wrk_index);
273 app_listener_get_session (app_listener_t * al)
275 if (al->session_index == SESSION_INVALID_INDEX)
278 return listen_session_get (al->session_index);
281 static app_worker_map_t *
282 app_worker_map_alloc (application_t * app)
284 app_worker_map_t *map;
285 pool_get (app->worker_maps, map);
286 clib_memset (map, 0, sizeof (*map));
291 app_worker_map_index (application_t * app, app_worker_map_t * map)
293 return (map - app->worker_maps);
297 app_worker_map_free (application_t * app, app_worker_map_t * map)
299 pool_put (app->worker_maps, map);
302 static app_worker_map_t *
303 app_worker_map_get (application_t * app, u32 map_index)
305 if (pool_is_free_index (app->worker_maps, map_index))
307 return pool_elt_at_index (app->worker_maps, map_index);
311 app_get_name (application_t * app)
317 application_session_table (application_t * app, u8 fib_proto)
319 app_namespace_t *app_ns;
320 app_ns = app_namespace_get (app->ns_index);
321 if (!application_has_global_scope (app))
322 return APP_INVALID_INDEX;
323 if (fib_proto == FIB_PROTOCOL_IP4)
324 return session_lookup_get_index_for_fib (fib_proto,
325 app_ns->ip4_fib_index);
327 return session_lookup_get_index_for_fib (fib_proto,
328 app_ns->ip6_fib_index);
332 application_local_session_table (application_t * app)
334 app_namespace_t *app_ns;
335 if (!application_has_local_scope (app))
336 return APP_INVALID_INDEX;
337 app_ns = app_namespace_get (app->ns_index);
338 return app_ns->local_table_index;
342 * Returns app name for app-index
345 application_name_from_index (u32 app_index)
347 application_t *app = application_get (app_index);
350 return app_get_name (app);
354 application_api_table_add (u32 app_index, u32 api_client_index)
356 if (api_client_index != APP_INVALID_INDEX)
357 hash_set (app_main.app_by_api_client_index, api_client_index, app_index);
361 application_api_table_del (u32 api_client_index)
363 hash_unset (app_main.app_by_api_client_index, api_client_index);
367 application_name_table_add (application_t * app)
369 hash_set_mem (app_main.app_by_name, app->name, app->app_index);
373 application_name_table_del (application_t * app)
375 hash_unset_mem (app_main.app_by_name, app->name);
379 application_lookup (u32 api_client_index)
382 p = hash_get (app_main.app_by_api_client_index, api_client_index);
384 return application_get_if_valid (p[0]);
390 application_lookup_name (const u8 * name)
393 p = hash_get_mem (app_main.app_by_name, name);
395 return application_get (p[0]);
400 static application_t *
401 application_alloc (void)
404 pool_get (app_main.app_pool, app);
405 clib_memset (app, 0, sizeof (*app));
406 app->app_index = app - app_main.app_pool;
411 application_get (u32 app_index)
413 if (app_index == APP_INVALID_INDEX)
415 return pool_elt_at_index (app_main.app_pool, app_index);
419 application_get_if_valid (u32 app_index)
421 if (pool_is_free_index (app_main.app_pool, app_index))
424 return pool_elt_at_index (app_main.app_pool, app_index);
428 application_verify_cb_fns (session_cb_vft_t * cb_fns)
430 if (cb_fns->session_accept_callback == 0)
431 clib_warning ("No accept callback function provided");
432 if (cb_fns->session_connected_callback == 0)
433 clib_warning ("No session connected callback function provided");
434 if (cb_fns->session_disconnect_callback == 0)
435 clib_warning ("No session disconnect callback function provided");
436 if (cb_fns->session_reset_callback == 0)
437 clib_warning ("No session reset callback function provided");
441 * Check app config for given segment type
443 * Returns 1 on success and 0 otherwise
446 application_verify_cfg (ssvm_segment_type_t st)
449 if (st == SSVM_SEGMENT_MEMFD)
451 is_valid = (session_manager_get_evt_q_segment () != 0);
453 clib_warning ("memfd seg: vpp's event qs IN binary api svm region");
456 else if (st == SSVM_SEGMENT_SHM)
458 is_valid = (session_manager_get_evt_q_segment () == 0);
460 clib_warning ("shm seg: vpp's event qs NOT IN binary api svm region");
468 application_alloc_and_init (app_init_args_t * a)
470 ssvm_segment_type_t seg_type = SSVM_SEGMENT_MEMFD;
471 segment_manager_properties_t *props;
472 vl_api_registration_t *reg;
476 app = application_alloc ();
477 options = a->options;
479 * Make sure we support the requested configuration
481 if (!(options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_IS_BUILTIN))
483 reg = vl_api_client_index_to_registration (a->api_client_index);
485 return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
486 if (vl_api_registration_file_index (reg) == VL_API_INVALID_FI)
487 seg_type = SSVM_SEGMENT_SHM;
491 if (options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
493 clib_warning ("mq eventfds can only be used if socket transport is "
495 return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
497 seg_type = SSVM_SEGMENT_PRIVATE;
500 if (!application_verify_cfg (seg_type))
501 return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
503 /* Check that the obvious things are properly set up */
504 application_verify_cb_fns (a->session_cb_vft);
506 app->flags = options[APP_OPTIONS_FLAGS];
507 app->cb_fns = *a->session_cb_vft;
508 app->ns_index = options[APP_OPTIONS_NAMESPACE];
509 app->proxied_transports = options[APP_OPTIONS_PROXY_TRANSPORT];
510 app->name = vec_dup (a->name);
512 /* If no scope enabled, default to global */
513 if (!application_has_global_scope (app)
514 && !application_has_local_scope (app))
515 app->flags |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
517 props = application_segment_manager_properties (app);
518 segment_manager_properties_init (props);
519 props->segment_size = options[APP_OPTIONS_ADD_SEGMENT_SIZE];
520 props->prealloc_fifos = options[APP_OPTIONS_PREALLOC_FIFO_PAIRS];
521 if (options[APP_OPTIONS_ADD_SEGMENT_SIZE])
523 props->add_segment_size = options[APP_OPTIONS_ADD_SEGMENT_SIZE];
524 props->add_segment = 1;
526 if (options[APP_OPTIONS_RX_FIFO_SIZE])
527 props->rx_fifo_size = options[APP_OPTIONS_RX_FIFO_SIZE];
528 if (options[APP_OPTIONS_TX_FIFO_SIZE])
529 props->tx_fifo_size = options[APP_OPTIONS_TX_FIFO_SIZE];
530 if (options[APP_OPTIONS_EVT_QUEUE_SIZE])
531 props->evt_q_size = options[APP_OPTIONS_EVT_QUEUE_SIZE];
532 if (options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
533 props->use_mq_eventfd = 1;
534 if (options[APP_OPTIONS_TLS_ENGINE])
535 app->tls_engine = options[APP_OPTIONS_TLS_ENGINE];
536 props->segment_type = seg_type;
538 /* Add app to lookup by api_client_index table */
539 if (!application_is_builtin (app))
540 application_api_table_add (app->app_index, a->api_client_index);
542 application_name_table_add (app);
544 a->app_index = app->app_index;
546 APP_DBG ("New app name: %v api index: %u index %u", app->name,
547 app->api_client_index, app->app_index);
553 application_free (application_t * app)
555 app_worker_map_t *wrk_map;
556 app_worker_t *app_wrk;
559 session_endpoint_t sep;
562 * The app event queue allocated in first segment is cleared with
563 * the segment manager. No need to explicitly free it.
565 APP_DBG ("Delete app name %v api index: %d index: %d", app->name,
566 app->api_client_index, app->app_index);
568 if (application_is_proxy (app))
569 application_remove_proxy (app);
576 pool_flush (wrk_map, app->worker_maps, ({
577 app_wrk = app_worker_get (wrk_map->wrk_index);
578 app_worker_free (app_wrk);
581 pool_free (app->worker_maps);
584 * Free local listeners. Global table unbinds stop local listeners
585 * as well, but if we have only local binds, these won't be cleaned up.
586 * Don't bother with local accepted sessions, we clean them when
587 * cleaning up the worker.
589 table_index = application_local_session_table (app);
591 pool_foreach (ll, app->local_listen_sessions, ({
592 application_local_listener_session_endpoint (ll, &sep);
593 session_lookup_del_session_endpoint (table_index, &sep);
596 pool_free (app->local_listen_sessions);
599 * Cleanup remaining state
601 if (application_is_builtin (app))
602 application_name_table_del (app);
603 vec_free (app->name);
604 vec_free (app->tls_cert);
605 vec_free (app->tls_key);
606 pool_put (app_main.app_pool, app);
610 application_detach_process (application_t * app, u32 api_client_index)
612 vnet_app_worker_add_del_args_t _args = { 0 }, *args = &_args;
613 app_worker_map_t *wrk_map;
614 u32 *wrks = 0, *wrk_index;
615 app_worker_t *app_wrk;
617 if (api_client_index == ~0)
619 application_free (app);
623 APP_DBG ("Detaching for app %v index %u api client index %u", app->name,
624 app->app_index, app->api_client_index);
627 pool_foreach (wrk_map, app->worker_maps, ({
628 app_wrk = app_worker_get (wrk_map->wrk_index);
629 if (app_wrk->api_client_index == api_client_index)
630 vec_add1 (wrks, app_wrk->wrk_index);
636 clib_warning ("no workers for app %u api_index %u", app->app_index,
641 args->app_index = app->app_index;
642 args->api_client_index = api_client_index;
643 vec_foreach (wrk_index, wrks)
645 app_wrk = app_worker_get (wrk_index[0]);
646 args->wrk_map_index = app_wrk->wrk_map_index;
648 vnet_app_worker_add_del (args);
654 application_get_worker (application_t * app, u32 wrk_map_index)
656 app_worker_map_t *map;
657 map = app_worker_map_get (app, wrk_map_index);
660 return app_worker_get (map->wrk_index);
664 application_get_default_worker (application_t * app)
666 return application_get_worker (app, 0);
670 application_n_workers (application_t * app)
672 return pool_elts (app->worker_maps);
676 application_listener_select_worker (session_t * ls)
680 al = app_listener_get_w_session (ls);
681 return app_listener_select_worker (al);
685 application_alloc_worker_and_init (application_t * app, app_worker_t ** wrk)
687 app_worker_map_t *wrk_map;
688 app_worker_t *app_wrk;
689 segment_manager_t *sm;
692 app_wrk = app_worker_alloc (app);
693 wrk_map = app_worker_map_alloc (app);
694 wrk_map->wrk_index = app_wrk->wrk_index;
695 app_wrk->wrk_map_index = app_worker_map_index (app, wrk_map);
698 * Setup first segment manager
700 sm = segment_manager_new ();
701 sm->app_wrk_index = app_wrk->wrk_index;
703 if ((rv = segment_manager_init (sm, app->sm_properties.segment_size,
704 app->sm_properties.prealloc_fifos)))
706 app_worker_free (app_wrk);
709 sm->first_is_protected = 1;
714 app_wrk->first_segment_manager = segment_manager_index (sm);
715 app_wrk->listeners_table = hash_create (0, sizeof (u64));
716 app_wrk->event_queue = segment_manager_event_queue (sm);
717 app_wrk->app_is_builtin = application_is_builtin (app);
720 * Segment manager for local sessions
722 sm = segment_manager_new ();
723 sm->app_wrk_index = app_wrk->wrk_index;
724 app_wrk->local_segment_manager = segment_manager_index (sm);
725 app_wrk->local_connects = hash_create (0, sizeof (u64));
733 vnet_app_worker_add_del (vnet_app_worker_add_del_args_t * a)
735 svm_fifo_segment_private_t *fs;
736 app_worker_map_t *wrk_map;
737 app_worker_t *app_wrk;
738 segment_manager_t *sm;
742 app = application_get (a->app_index);
744 return VNET_API_ERROR_INVALID_VALUE;
748 if ((rv = application_alloc_worker_and_init (app, &app_wrk)))
751 /* Map worker api index to the app */
752 app_wrk->api_client_index = a->api_client_index;
753 application_api_table_add (app->app_index, a->api_client_index);
755 sm = segment_manager_get (app_wrk->first_segment_manager);
756 fs = segment_manager_get_segment_w_lock (sm, 0);
757 a->segment = &fs->ssvm;
758 a->segment_handle = segment_manager_segment_handle (sm, fs);
759 segment_manager_segment_reader_unlock (sm);
760 a->evt_q = app_wrk->event_queue;
761 a->wrk_map_index = app_wrk->wrk_map_index;
765 wrk_map = app_worker_map_get (app, a->wrk_map_index);
767 return VNET_API_ERROR_INVALID_VALUE;
769 app_wrk = app_worker_get (wrk_map->wrk_index);
771 return VNET_API_ERROR_INVALID_VALUE;
773 application_api_table_del (app_wrk->api_client_index);
774 app_worker_free (app_wrk);
775 app_worker_map_free (app, wrk_map);
776 if (application_n_workers (app) == 0)
777 application_free (app);
783 app_validate_namespace (u8 * namespace_id, u64 secret, u32 * app_ns_index)
785 app_namespace_t *app_ns;
786 if (vec_len (namespace_id) == 0)
788 /* Use default namespace */
793 *app_ns_index = app_namespace_index_from_id (namespace_id);
794 if (*app_ns_index == APP_NAMESPACE_INVALID_INDEX)
795 return VNET_API_ERROR_APP_INVALID_NS;
796 app_ns = app_namespace_get (*app_ns_index);
798 return VNET_API_ERROR_APP_INVALID_NS;
799 if (app_ns->ns_secret != secret)
800 return VNET_API_ERROR_APP_WRONG_NS_SECRET;
805 app_name_from_api_index (u32 api_client_index)
807 vl_api_registration_t *regp;
808 regp = vl_api_client_index_to_registration (api_client_index);
810 return format (0, "%s%c", regp->name, 0);
812 clib_warning ("api client index %u does not have an api registration!",
814 return format (0, "unknown%c", 0);
818 * Attach application to vpp
820 * Allocates a vpp app, i.e., a structure that keeps back pointers
821 * to external app and a segment manager for shared memory fifo based
822 * communication with the external app.
825 vnet_application_attach (vnet_app_attach_args_t * a)
827 svm_fifo_segment_private_t *fs;
828 application_t *app = 0;
829 app_worker_t *app_wrk;
830 segment_manager_t *sm;
831 u32 app_ns_index = 0;
836 if (a->api_client_index != APP_INVALID_INDEX)
837 app = application_lookup (a->api_client_index);
839 app = application_lookup_name (a->name);
841 return VNET_API_ERROR_INVALID_VALUE;
844 return VNET_API_ERROR_APP_ALREADY_ATTACHED;
846 if (a->api_client_index != APP_INVALID_INDEX)
848 app_name = app_name_from_api_index (a->api_client_index);
852 secret = a->options[APP_OPTIONS_NAMESPACE_SECRET];
853 if ((rv = app_validate_namespace (a->namespace_id, secret, &app_ns_index)))
855 a->options[APP_OPTIONS_NAMESPACE] = app_ns_index;
857 if ((rv = application_alloc_and_init ((app_init_args_t *) a)))
860 app = application_get (a->app_index);
861 if ((rv = application_alloc_worker_and_init (app, &app_wrk)))
864 a->app_evt_q = app_wrk->event_queue;
865 app_wrk->api_client_index = a->api_client_index;
866 sm = segment_manager_get (app_wrk->first_segment_manager);
867 fs = segment_manager_get_segment_w_lock (sm, 0);
869 if (application_is_proxy (app))
870 application_setup_proxy (app);
872 ASSERT (vec_len (fs->ssvm.name) <= 128);
873 a->segment = &fs->ssvm;
874 a->segment_handle = segment_manager_segment_handle (sm, fs);
876 segment_manager_segment_reader_unlock (sm);
882 * Detach application from vpp
885 vnet_application_detach (vnet_app_detach_args_t * a)
889 app = application_get_if_valid (a->app_index);
892 clib_warning ("app not attached");
893 return VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
896 app_interface_check_thread_and_barrier (vnet_application_detach, a);
897 application_detach_process (app, a->api_client_index);
903 session_endpoint_in_ns (session_endpoint_t * sep)
905 u8 is_lep = session_endpoint_is_local (sep);
906 if (!is_lep && sep->sw_if_index != ENDPOINT_INVALID_INDEX
907 && !ip_interface_has_address (sep->sw_if_index, &sep->ip, sep->is_ip4))
909 clib_warning ("sw_if_index %u not configured with ip %U",
910 sep->sw_if_index, format_ip46_address, &sep->ip,
914 return (is_lep || ip_is_local (sep->fib_index, &sep->ip, sep->is_ip4));
918 session_endpoint_update_for_app (session_endpoint_cfg_t * sep,
919 application_t * app, u8 is_connect)
921 app_namespace_t *app_ns;
922 u32 ns_index, fib_index;
924 ns_index = app->ns_index;
926 /* App is a transport proto, so fetch the calling app's ns */
927 if (app->flags & APP_OPTIONS_FLAGS_IS_TRANSPORT_APP)
928 ns_index = sep->ns_index;
930 app_ns = app_namespace_get (ns_index);
934 /* Ask transport and network to bind to/connect using local interface
935 * that "supports" app's namespace. This will fix our local connection
939 /* If in default namespace and user requested a fib index use it */
940 if (ns_index == 0 && sep->fib_index != ENDPOINT_INVALID_INDEX)
941 fib_index = sep->fib_index;
943 fib_index = sep->is_ip4 ? app_ns->ip4_fib_index : app_ns->ip6_fib_index;
944 sep->peer.fib_index = fib_index;
945 sep->fib_index = fib_index;
949 sep->sw_if_index = app_ns->sw_if_index;
953 if (app_ns->sw_if_index != APP_NAMESPACE_INVALID_INDEX
954 && sep->peer.sw_if_index != ENDPOINT_INVALID_INDEX
955 && sep->peer.sw_if_index != app_ns->sw_if_index)
956 clib_warning ("Local sw_if_index different from app ns sw_if_index");
958 sep->peer.sw_if_index = app_ns->sw_if_index;
963 vnet_listen (vnet_listen_args_t * a)
965 app_listener_t *app_listener;
966 app_worker_t *app_wrk;
970 app = application_get_if_valid (a->app_index);
972 return VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
974 app_wrk = application_get_worker (app, a->wrk_map_index);
976 return VNET_API_ERROR_INVALID_VALUE;
978 a->sep_ext.app_wrk_index = app_wrk->wrk_index;
980 session_endpoint_update_for_app (&a->sep_ext, app, 0 /* is_connect */ );
981 if (!session_endpoint_in_ns (&a->sep))
982 return VNET_API_ERROR_INVALID_VALUE_2;
985 * Check if we already have an app listener
987 app_listener = app_listener_lookup (app, &a->sep_ext);
990 if (app_listener->app_index != app->app_index)
991 return VNET_API_ERROR_ADDRESS_IN_USE;
992 if (app_worker_start_listen (app_wrk, app_listener))
994 a->handle = app_listener_handle (app_listener);
999 * Create new app listener
1001 if ((rv = app_listener_alloc_and_init (app, &a->sep_ext, &app_listener)))
1004 if ((rv = app_worker_start_listen (app_wrk, app_listener)))
1006 app_listener_cleanup (app_listener);
1010 a->handle = app_listener_handle (app_listener);
1015 vnet_connect (vnet_connect_args_t * a)
1017 app_worker_t *server_wrk, *client_wrk;
1018 application_t *client;
1019 local_session_t *ll;
1026 if (session_endpoint_is_zero (&a->sep))
1027 return VNET_API_ERROR_INVALID_VALUE;
1029 client = application_get (a->app_index);
1030 session_endpoint_update_for_app (&a->sep_ext, client, 1 /* is_connect */ );
1031 client_wrk = application_get_worker (client, a->wrk_map_index);
1034 * First check the local scope for locally attached destinations.
1035 * If we have local scope, we pass *all* connects through it since we may
1036 * have special policy rules even for non-local destinations, think proxy.
1038 if (application_has_local_scope (client))
1040 table_index = application_local_session_table (client);
1041 lh = session_lookup_local_endpoint (table_index, &a->sep);
1042 if (lh == SESSION_DROP_HANDLE)
1043 return VNET_API_ERROR_APP_CONNECT_FILTERED;
1045 if (lh == SESSION_INVALID_HANDLE)
1048 ll = application_get_local_listener_w_handle (lh);
1049 al = app_listener_get_w_session ((session_t *) ll);
1052 * Break loop if rule in local table points to connecting app. This
1053 * can happen if client is a generic proxy. Route connect through
1054 * global table instead.
1056 if (al->app_index == a->app_index)
1059 server_wrk = app_listener_select_worker (al);
1060 return app_worker_local_session_connect (client_wrk, server_wrk, ll,
1065 * If nothing found, check the global scope for locally attached
1066 * destinations. Make sure first that we're allowed to.
1070 if (session_endpoint_is_local (&a->sep))
1071 return VNET_API_ERROR_SESSION_CONNECT;
1073 if (!application_has_global_scope (client))
1074 return VNET_API_ERROR_APP_CONNECT_SCOPE;
1076 fib_proto = session_endpoint_fib_proto (&a->sep);
1077 table_index = application_session_table (client, fib_proto);
1078 ls = session_lookup_listener (table_index, &a->sep);
1081 al = app_listener_get_w_session (ls);
1082 server_wrk = app_listener_select_worker (al);
1083 ll = (local_session_t *) ls;
1084 return app_worker_local_session_connect (client_wrk, server_wrk, ll,
1089 * Not connecting to a local server, propagate to transport
1091 if (app_worker_connect_session (client_wrk, &a->sep, a->api_context))
1092 return VNET_API_ERROR_SESSION_CONNECT;
1097 vnet_unlisten (vnet_unlisten_args_t * a)
1099 app_worker_t *app_wrk;
1103 if (!(app = application_get_if_valid (a->app_index)))
1104 return VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
1106 al = app_listener_get_w_handle (a->handle);
1107 if (al->app_index != app->app_index)
1109 clib_warning ("app doesn't own handle %llu!", a->handle);
1113 app_wrk = application_get_worker (app, a->wrk_map_index);
1116 clib_warning ("no app %u worker %u", app->app_index, a->wrk_map_index);
1120 return app_worker_stop_listen (app_wrk, al);
1124 vnet_disconnect_session (vnet_disconnect_args_t * a)
1126 if (session_handle_is_local (a->handle))
1128 app_worker_t *client_wrk, *server_wrk;
1129 local_session_t *ls;
1132 /* Disconnect reply came to worker 1 not main thread */
1133 app_interface_check_thread_and_barrier (vnet_disconnect_session, a);
1135 if (!(ls = app_worker_get_local_session_from_handle (a->handle)))
1138 client_wrk = app_worker_get_if_valid (ls->client_wrk_index);
1139 server_wrk = app_worker_get (ls->app_wrk_index);
1141 if (server_wrk->app_index == a->app_index)
1142 wrk_index = server_wrk->wrk_index;
1143 else if (client_wrk && client_wrk->app_index == a->app_index)
1144 wrk_index = client_wrk->wrk_index;
1146 if (wrk_index == ~0)
1148 clib_warning ("app %u does not own session 0x%lx", a->app_index,
1149 application_local_session_handle (ls));
1150 return VNET_API_ERROR_INVALID_VALUE;
1153 return app_worker_local_session_disconnect (wrk_index, ls);
1157 app_worker_t *app_wrk;
1160 s = session_get_from_handle_if_valid (a->handle);
1162 return VNET_API_ERROR_INVALID_VALUE;
1163 app_wrk = app_worker_get (s->app_wrk_index);
1164 if (app_wrk->app_index != a->app_index)
1165 return VNET_API_ERROR_INVALID_VALUE;
1167 /* We're peeking into another's thread pool. Make sure */
1168 ASSERT (s->session_index == session_index_from_handle (a->handle));
1176 application_change_listener_owner (session_t * s, app_worker_t * app_wrk)
1178 app_worker_t *old_wrk = app_worker_get (s->app_wrk_index);
1179 app_listener_t *app_listener;
1185 hash_unset (old_wrk->listeners_table, listen_session_get_handle (s));
1186 if (session_transport_service_type (s) == TRANSPORT_SERVICE_CL
1188 segment_manager_dealloc_fifos (s->rx_fifo->segment_index, s->rx_fifo,
1191 app = application_get (old_wrk->app_index);
1195 app_listener = app_listener_get (app, s->al_index);
1197 /* Only remove from lb for now */
1198 app_listener->workers = clib_bitmap_set (app_listener->workers,
1199 old_wrk->wrk_map_index, 0);
1201 if (app_worker_start_listen (app_wrk, app_listener))
1204 s->app_wrk_index = app_wrk->wrk_index;
1210 application_is_proxy (application_t * app)
1212 return (app->flags & APP_OPTIONS_FLAGS_IS_PROXY);
1216 application_is_builtin (application_t * app)
1218 return (app->flags & APP_OPTIONS_FLAGS_IS_BUILTIN);
1222 application_is_builtin_proxy (application_t * app)
1224 return (application_is_proxy (app) && application_is_builtin (app));
1228 application_has_local_scope (application_t * app)
1230 return app->flags & APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
1234 application_has_global_scope (application_t * app)
1236 return app->flags & APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
1240 application_use_mq_for_ctrl (application_t * app)
1242 return app->flags & APP_OPTIONS_FLAGS_USE_MQ_FOR_CTRL_MSGS;
1245 static clib_error_t *
1246 application_start_stop_proxy_fib_proto (application_t * app, u8 fib_proto,
1247 u8 transport_proto, u8 is_start)
1249 app_namespace_t *app_ns = app_namespace_get (app->ns_index);
1250 u8 is_ip4 = (fib_proto == FIB_PROTOCOL_IP4);
1251 session_endpoint_cfg_t sep = SESSION_ENDPOINT_CFG_NULL;
1252 transport_connection_t *tc;
1253 app_worker_t *app_wrk;
1258 /* TODO decide if we want proxy to be enabled for all workers */
1259 app_wrk = application_get_default_worker (app);
1262 s = app_worker_first_listener (app_wrk, fib_proto, transport_proto);
1265 sep.is_ip4 = is_ip4;
1266 sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
1267 sep.sw_if_index = app_ns->sw_if_index;
1268 sep.transport_proto = transport_proto;
1269 sep.app_wrk_index = app_wrk->wrk_index; /* only default */
1271 /* force global scope listener */
1273 app->flags &= ~APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
1274 app_listener_alloc_and_init (app, &sep, &al);
1277 app_worker_start_listen (app_wrk, al);
1278 s = listen_session_get (al->session_index);
1279 s->enqueue_epoch = SESSION_PROXY_LISTENER_INDEX;
1284 s = app_worker_proxy_listener (app_wrk, fib_proto, transport_proto);
1288 tc = listen_session_get_transport (s);
1290 if (!ip_is_zero (&tc->lcl_ip, 1))
1293 sep.is_ip4 = is_ip4;
1294 sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
1295 sep.transport_proto = transport_proto;
1297 sti = session_lookup_get_index_for_fib (fib_proto, sep.fib_index);
1299 session_lookup_add_session_endpoint (sti,
1300 (session_endpoint_t *) & sep,
1303 session_lookup_del_session_endpoint (sti,
1304 (session_endpoint_t *) & sep);
1311 application_start_stop_proxy_local_scope (application_t * app,
1312 u8 transport_proto, u8 is_start)
1314 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
1315 app_namespace_t *app_ns;
1316 app_ns = app_namespace_get (app->ns_index);
1318 sep.transport_proto = transport_proto;
1323 session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
1326 session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
1331 session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
1333 session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
1338 application_start_stop_proxy (application_t * app,
1339 transport_proto_t transport_proto, u8 is_start)
1341 if (application_has_local_scope (app))
1342 application_start_stop_proxy_local_scope (app, transport_proto, is_start);
1344 if (application_has_global_scope (app))
1346 application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP4,
1347 transport_proto, is_start);
1348 application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP6,
1349 transport_proto, is_start);
1354 application_setup_proxy (application_t * app)
1356 u16 transports = app->proxied_transports;
1357 transport_proto_t tp;
1359 ASSERT (application_is_proxy (app));
1362 transport_proto_foreach (tp, ({
1363 if (transports & (1 << tp))
1364 application_start_stop_proxy (app, tp, 1);
1370 application_remove_proxy (application_t * app)
1372 u16 transports = app->proxied_transports;
1373 transport_proto_t tp;
1375 ASSERT (application_is_proxy (app));
1378 transport_proto_foreach (tp, ({
1379 if (transports & (1 << tp))
1380 application_start_stop_proxy (app, tp, 0);
1385 segment_manager_properties_t *
1386 application_segment_manager_properties (application_t * app)
1388 return &app->sm_properties;
1391 segment_manager_properties_t *
1392 application_get_segment_manager_properties (u32 app_index)
1394 application_t *app = application_get (app_index);
1395 return &app->sm_properties;
1399 vnet_app_add_tls_cert (vnet_app_add_tls_cert_args_t * a)
1402 app = application_get (a->app_index);
1404 return clib_error_return_code (0, VNET_API_ERROR_APPLICATION_NOT_ATTACHED,
1405 0, "app %u doesn't exist", a->app_index);
1406 app->tls_cert = vec_dup (a->cert);
1411 vnet_app_add_tls_key (vnet_app_add_tls_key_args_t * a)
1414 app = application_get (a->app_index);
1416 return clib_error_return_code (0, VNET_API_ERROR_APPLICATION_NOT_ATTACHED,
1417 0, "app %u doesn't exist", a->app_index);
1418 app->tls_key = vec_dup (a->key);
1423 application_format_listeners (application_t * app, int verbose)
1425 vlib_main_t *vm = vlib_get_main ();
1426 app_worker_map_t *wrk_map;
1427 app_worker_t *app_wrk;
1433 vlib_cli_output (vm, "%U", format_app_worker_listener, 0 /* header */ ,
1439 pool_foreach (wrk_map, app->worker_maps, ({
1440 app_wrk = app_worker_get (wrk_map->wrk_index);
1441 if (hash_elts (app_wrk->listeners_table) == 0)
1443 hash_foreach (handle, sm_index, app_wrk->listeners_table, ({
1444 vlib_cli_output (vm, "%U", format_app_worker_listener, app_wrk,
1445 handle, sm_index, verbose);
1452 application_format_connects (application_t * app, int verbose)
1454 app_worker_map_t *wrk_map;
1455 app_worker_t *app_wrk;
1459 app_worker_format_connects (0, verbose);
1464 pool_foreach (wrk_map, app->worker_maps, ({
1465 app_wrk = app_worker_get (wrk_map->wrk_index);
1466 app_worker_format_connects (app_wrk, verbose);
1472 application_format_local_sessions (application_t * app, int verbose)
1474 vlib_main_t *vm = vlib_get_main ();
1475 app_worker_map_t *wrk_map;
1476 app_worker_t *app_wrk;
1477 transport_proto_t tp;
1478 local_session_t *ls;
1483 app_worker_format_local_sessions (0, verbose);
1488 * Format local listeners
1492 pool_foreach (ls, app->local_listen_sessions, ({
1493 tp = session_type_transport_proto (ls->listener_session_type);
1494 conn = format (0, "[L][%U] *:%u", format_transport_proto_short, tp,
1496 vlib_cli_output (vm, "%-40v%-15u%-20s", conn, ls->app_wrk_index, "*");
1497 vec_reset_length (conn);
1502 * Format local accepted/connected sessions
1505 pool_foreach (wrk_map, app->worker_maps, ({
1506 app_wrk = app_worker_get (wrk_map->wrk_index);
1507 app_worker_format_local_sessions (app_wrk, verbose);
1513 application_format_local_connects (application_t * app, int verbose)
1515 app_worker_map_t *wrk_map;
1516 app_worker_t *app_wrk;
1520 app_worker_format_local_connects (0, verbose);
1525 pool_foreach (wrk_map, app->worker_maps, ({
1526 app_wrk = app_worker_get (wrk_map->wrk_index);
1527 app_worker_format_local_connects (app_wrk, verbose);
1533 format_application (u8 * s, va_list * args)
1535 application_t *app = va_arg (*args, application_t *);
1536 CLIB_UNUSED (int verbose) = va_arg (*args, int);
1537 segment_manager_properties_t *props;
1538 const u8 *app_ns_name, *app_name;
1539 app_worker_map_t *wrk_map;
1540 app_worker_t *app_wrk;
1545 s = format (s, "%-10s%-20s%-40s", "Index", "Name", "Namespace");
1549 app_name = app_get_name (app);
1550 app_ns_name = app_namespace_id_from_index (app->ns_index);
1551 props = application_segment_manager_properties (app);
1554 s = format (s, "%-10u%-20s%-40s", app->app_index, app_name,
1559 s = format (s, "app-name %s app-index %u ns-index %u seg-size %U\n",
1560 app_name, app->app_index, app->ns_index,
1561 format_memory_size, props->add_segment_size);
1562 s = format (s, "rx-fifo-size %U tx-fifo-size %U workers:\n",
1563 format_memory_size, props->rx_fifo_size,
1564 format_memory_size, props->tx_fifo_size);
1567 pool_foreach (wrk_map, app->worker_maps, ({
1568 app_wrk = app_worker_get (wrk_map->wrk_index);
1569 s = format (s, "%U", format_app_worker, app_wrk);
1577 application_format_all_listeners (vlib_main_t * vm, int do_local, int verbose)
1581 if (!pool_elts (app_main.app_pool))
1583 vlib_cli_output (vm, "No active server bindings");
1589 application_format_local_sessions (0, verbose);
1591 pool_foreach (app, app_main.app_pool, ({
1592 application_format_local_sessions (app, verbose);
1598 application_format_listeners (0, verbose);
1601 pool_foreach (app, app_main.app_pool, ({
1602 application_format_listeners (app, verbose);
1609 application_format_all_clients (vlib_main_t * vm, int do_local, int verbose)
1613 if (!pool_elts (app_main.app_pool))
1615 vlib_cli_output (vm, "No active apps");
1621 application_format_local_connects (0, verbose);
1624 pool_foreach (app, app_main.app_pool, ({
1625 application_format_local_connects (app, verbose);
1631 application_format_connects (0, verbose);
1634 pool_foreach (app, app_main.app_pool, ({
1635 application_format_connects (app, verbose);
1641 static clib_error_t *
1642 show_app_command_fn (vlib_main_t * vm, unformat_input_t * input,
1643 vlib_cli_command_t * cmd)
1645 int do_server = 0, do_client = 0, do_local = 0;
1650 session_cli_return_if_not_enabled ();
1652 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1654 if (unformat (input, "server"))
1656 else if (unformat (input, "client"))
1658 else if (unformat (input, "local"))
1660 else if (unformat (input, "%u", &app_index))
1662 else if (unformat (input, "verbose"))
1665 return clib_error_return (0, "unknown input `%U'",
1666 format_unformat_error, input);
1671 application_format_all_listeners (vm, do_local, verbose);
1677 application_format_all_clients (vm, do_local, verbose);
1681 if (app_index != ~0)
1683 app = application_get_if_valid (app_index);
1685 return clib_error_return (0, "No app with index %u", app_index);
1687 vlib_cli_output (vm, "%U", format_application, app, /* verbose */ 1);
1691 /* Print app related info */
1692 if (!do_server && !do_client)
1694 vlib_cli_output (vm, "%U", format_application, 0, 0);
1696 pool_foreach (app, app_main.app_pool, ({
1697 vlib_cli_output (vm, "%U", format_application, app, 0);
1706 VLIB_CLI_COMMAND (show_app_command, static) =
1709 .short_help = "show app [server|client] [verbose]",
1710 .function = show_app_command_fn,
1715 * fd.io coding-style-patch-verification: ON
1718 * eval: (c-set-style "gnu")