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;
41 app_listener->ls_handle = SESSION_INVALID_HANDLE;
46 app_listener_get (application_t * app, u32 app_listener_index)
48 return pool_elt_at_index (app->listeners, app_listener_index);
52 app_listener_free (application_t * app, app_listener_t * app_listener)
54 clib_bitmap_free (app_listener->workers);
56 clib_memset (app_listener, 0xfa, sizeof (*app_listener));
57 pool_put (app->listeners, app_listener);
61 app_listener_handle (app_listener_t * al)
67 app_listener_get_w_session (session_t * ls)
71 app = application_get_if_valid (ls->app_index);
74 return app_listener_get (app, ls->al_index);
78 app_listen_session_handle (session_t * ls)
81 al = app_listener_get_w_session (ls);
83 return listen_session_get_handle (ls);
88 app_listener_get_w_handle (session_handle_t handle)
91 ls = session_get_from_handle_if_valid (handle);
94 return app_listener_get_w_session (ls);
98 app_listener_lookup (application_t * app, session_endpoint_cfg_t * sep_ext)
100 u32 table_index, fib_proto;
101 session_endpoint_t *sep;
102 session_handle_t handle;
105 sep = (session_endpoint_t *) sep_ext;
106 if (application_has_local_scope (app) && session_endpoint_is_local (sep))
108 table_index = application_local_session_table (app);
109 handle = session_lookup_endpoint_listener (table_index, sep, 1);
110 if (handle != SESSION_INVALID_HANDLE)
112 ls = listen_session_get_from_handle (handle);
113 return app_listener_get_w_session (ls);
117 fib_proto = session_endpoint_fib_proto (sep);
118 table_index = session_lookup_get_index_for_fib (fib_proto, sep->fib_index);
119 handle = session_lookup_endpoint_listener (table_index, sep, 1);
120 if (handle != SESSION_INVALID_HANDLE)
122 ls = listen_session_get_from_handle (handle);
123 return app_listener_get_w_session ((session_t *) ls);
130 app_listener_alloc_and_init (application_t * app,
131 session_endpoint_cfg_t * sep,
132 app_listener_t ** listener)
134 app_listener_t *app_listener;
135 transport_connection_t *tc;
136 u32 al_index, table_index;
142 app_listener = app_listener_alloc (app);
143 al_index = app_listener->al_index;
144 st = session_type_from_proto_and_ip (sep->transport_proto, sep->is_ip4);
147 * Add session endpoint to local session table. Only binds to "inaddr_any"
148 * (i.e., zero address) are added to local scope table.
150 if (application_has_local_scope (app)
151 && session_endpoint_is_local ((session_endpoint_t *) sep))
153 session_type_t local_st;
155 local_st = session_type_from_proto_and_ip (TRANSPORT_PROTO_NONE,
157 ls = listen_session_alloc (0, local_st);
158 ls->app_index = app->app_index;
159 ls->app_wrk_index = sep->app_wrk_index;
160 lh = session_handle (ls);
162 if ((rv = session_listen (ls, sep)))
164 ls = session_get_from_handle (lh);
169 ls = session_get_from_handle (lh);
170 app_listener = app_listener_get (app, al_index);
171 app_listener->local_index = ls->session_index;
172 app_listener->ls_handle = lh;
173 ls->al_index = al_index;
175 table_index = application_local_session_table (app);
176 session_lookup_add_session_endpoint (table_index,
177 (session_endpoint_t *) sep, lh);
180 if (application_has_global_scope (app))
183 * Start listening on local endpoint for requested transport and scope.
184 * Creates a stream session with state LISTENING to be used in session
185 * lookups, prior to establishing connection. Requests transport to
186 * build it's own specific listening connection.
188 ls = listen_session_alloc (0, st);
189 ls->app_index = app->app_index;
190 ls->app_wrk_index = sep->app_wrk_index;
192 /* Listen pool can be reallocated if the transport is
194 lh = listen_session_get_handle (ls);
196 if ((rv = session_listen (ls, sep)))
198 ls = listen_session_get_from_handle (lh);
202 ls = listen_session_get_from_handle (lh);
203 app_listener = app_listener_get (app, al_index);
204 app_listener->session_index = ls->session_index;
205 app_listener->ls_handle = lh;
206 ls->al_index = al_index;
208 /* Add to the global lookup table after transport was initialized.
209 * Lookup table needs to be populated only now because sessions
210 * with cut-through transport are are added to app local tables that
211 * are not related to network fibs, i.e., cannot be added as
213 tc = session_get_transport (ls);
214 if (!(tc->flags & TRANSPORT_CONNECTION_F_NO_LOOKUP))
216 fib_protocol_t fib_proto;
217 fib_proto = session_endpoint_fib_proto ((session_endpoint_t *) sep);
218 table_index = session_lookup_get_index_for_fib (fib_proto,
220 ASSERT (table_index != SESSION_TABLE_INVALID_INDEX);
221 session_lookup_add_session_endpoint (table_index,
222 (session_endpoint_t *) sep,
229 app_listener_free (app, app_listener);
233 *listener = app_listener;
238 app_listener_cleanup (app_listener_t * al)
240 application_t *app = application_get (al->app_index);
243 if (al->session_index != SESSION_INVALID_INDEX)
245 ls = session_get (al->session_index, 0);
246 session_stop_listen (ls);
247 listen_session_free (ls);
249 if (al->local_index != SESSION_INVALID_INDEX)
251 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
254 table_index = application_local_session_table (app);
255 ls = listen_session_get (al->local_index);
256 ct_session_endpoint (ls, &sep);
257 session_lookup_del_session_endpoint (table_index, &sep);
258 session_stop_listen (ls);
259 listen_session_free (ls);
261 app_listener_free (app, al);
264 static app_worker_t *
265 app_listener_select_worker (application_t * app, app_listener_t * al)
269 app = application_get (al->app_index);
270 wrk_index = clib_bitmap_next_set (al->workers, al->accept_rotor + 1);
272 wrk_index = clib_bitmap_first_set (al->workers);
274 ASSERT (wrk_index != ~0);
275 al->accept_rotor = wrk_index;
276 return application_get_worker (app, wrk_index);
280 app_listener_get_session (app_listener_t * al)
282 if (al->session_index == SESSION_INVALID_INDEX)
285 return listen_session_get (al->session_index);
289 app_listener_get_local_session (app_listener_t * al)
291 if (al->local_index == SESSION_INVALID_INDEX)
293 return listen_session_get (al->local_index);
296 static app_worker_map_t *
297 app_worker_map_alloc (application_t * app)
299 app_worker_map_t *map;
300 pool_get (app->worker_maps, map);
301 clib_memset (map, 0, sizeof (*map));
306 app_worker_map_index (application_t * app, app_worker_map_t * map)
308 return (map - app->worker_maps);
312 app_worker_map_free (application_t * app, app_worker_map_t * map)
314 pool_put (app->worker_maps, map);
317 static app_worker_map_t *
318 app_worker_map_get (application_t * app, u32 map_index)
320 if (pool_is_free_index (app->worker_maps, map_index))
322 return pool_elt_at_index (app->worker_maps, map_index);
326 app_get_name (application_t * app)
332 application_session_table (application_t * app, u8 fib_proto)
334 app_namespace_t *app_ns;
335 app_ns = app_namespace_get (app->ns_index);
336 if (!application_has_global_scope (app))
337 return APP_INVALID_INDEX;
338 if (fib_proto == FIB_PROTOCOL_IP4)
339 return session_lookup_get_index_for_fib (fib_proto,
340 app_ns->ip4_fib_index);
342 return session_lookup_get_index_for_fib (fib_proto,
343 app_ns->ip6_fib_index);
347 application_local_session_table (application_t * app)
349 app_namespace_t *app_ns;
350 if (!application_has_local_scope (app))
351 return APP_INVALID_INDEX;
352 app_ns = app_namespace_get (app->ns_index);
353 return app_ns->local_table_index;
357 * Returns app name for app-index
360 application_name_from_index (u32 app_index)
362 application_t *app = application_get (app_index);
365 return app_get_name (app);
369 application_api_table_add (u32 app_index, u32 api_client_index)
371 if (api_client_index != APP_INVALID_INDEX)
372 hash_set (app_main.app_by_api_client_index, api_client_index, app_index);
376 application_api_table_del (u32 api_client_index)
378 hash_unset (app_main.app_by_api_client_index, api_client_index);
382 application_name_table_add (application_t * app)
384 hash_set_mem (app_main.app_by_name, app->name, app->app_index);
388 application_name_table_del (application_t * app)
390 hash_unset_mem (app_main.app_by_name, app->name);
394 application_lookup (u32 api_client_index)
397 p = hash_get (app_main.app_by_api_client_index, api_client_index);
399 return application_get_if_valid (p[0]);
405 application_lookup_name (const u8 * name)
408 p = hash_get_mem (app_main.app_by_name, name);
410 return application_get (p[0]);
415 static application_t *
416 application_alloc (void)
419 pool_get (app_main.app_pool, app);
420 clib_memset (app, 0, sizeof (*app));
421 app->app_index = app - app_main.app_pool;
426 application_get (u32 app_index)
428 if (app_index == APP_INVALID_INDEX)
430 return pool_elt_at_index (app_main.app_pool, app_index);
434 application_get_if_valid (u32 app_index)
436 if (pool_is_free_index (app_main.app_pool, app_index))
439 return pool_elt_at_index (app_main.app_pool, app_index);
443 application_verify_cb_fns (session_cb_vft_t * cb_fns)
445 if (cb_fns->session_accept_callback == 0)
446 clib_warning ("No accept callback function provided");
447 if (cb_fns->session_connected_callback == 0)
448 clib_warning ("No session connected callback function provided");
449 if (cb_fns->session_disconnect_callback == 0)
450 clib_warning ("No session disconnect callback function provided");
451 if (cb_fns->session_reset_callback == 0)
452 clib_warning ("No session reset callback function provided");
456 * Check app config for given segment type
458 * Returns 1 on success and 0 otherwise
461 application_verify_cfg (ssvm_segment_type_t st)
464 if (st == SSVM_SEGMENT_MEMFD)
466 is_valid = (session_main_get_evt_q_segment () != 0);
468 clib_warning ("memfd seg: vpp's event qs IN binary api svm region");
471 else if (st == SSVM_SEGMENT_SHM)
473 is_valid = (session_main_get_evt_q_segment () == 0);
475 clib_warning ("shm seg: vpp's event qs NOT IN binary api svm region");
483 application_alloc_and_init (app_init_args_t * a)
485 ssvm_segment_type_t seg_type = SSVM_SEGMENT_MEMFD;
486 segment_manager_props_t *props;
487 vl_api_registration_t *reg;
491 app = application_alloc ();
492 options = a->options;
494 * Make sure we support the requested configuration
496 if (!(options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_IS_BUILTIN))
498 reg = vl_api_client_index_to_registration (a->api_client_index);
500 return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
501 if (vl_api_registration_file_index (reg) == VL_API_INVALID_FI)
502 seg_type = SSVM_SEGMENT_SHM;
506 seg_type = SSVM_SEGMENT_PRIVATE;
509 if ((options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
510 && seg_type != SSVM_SEGMENT_MEMFD)
512 clib_warning ("mq eventfds can only be used if socket transport is "
513 "used for binary api");
514 return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
517 if (!application_verify_cfg (seg_type))
518 return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
520 /* Check that the obvious things are properly set up */
521 application_verify_cb_fns (a->session_cb_vft);
523 app->flags = options[APP_OPTIONS_FLAGS];
524 app->cb_fns = *a->session_cb_vft;
525 app->ns_index = options[APP_OPTIONS_NAMESPACE];
526 app->proxied_transports = options[APP_OPTIONS_PROXY_TRANSPORT];
527 app->name = vec_dup (a->name);
529 /* If no scope enabled, default to global */
530 if (!application_has_global_scope (app)
531 && !application_has_local_scope (app))
532 app->flags |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
534 props = application_segment_manager_properties (app);
535 segment_manager_props_init (props);
536 props->segment_size = options[APP_OPTIONS_SEGMENT_SIZE];
537 props->prealloc_fifos = options[APP_OPTIONS_PREALLOC_FIFO_PAIRS];
538 if (options[APP_OPTIONS_ADD_SEGMENT_SIZE])
540 props->add_segment_size = options[APP_OPTIONS_ADD_SEGMENT_SIZE];
541 props->add_segment = 1;
543 if (options[APP_OPTIONS_RX_FIFO_SIZE])
544 props->rx_fifo_size = options[APP_OPTIONS_RX_FIFO_SIZE];
545 if (options[APP_OPTIONS_TX_FIFO_SIZE])
546 props->tx_fifo_size = options[APP_OPTIONS_TX_FIFO_SIZE];
547 if (options[APP_OPTIONS_EVT_QUEUE_SIZE])
548 props->evt_q_size = options[APP_OPTIONS_EVT_QUEUE_SIZE];
549 if (options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
550 props->use_mq_eventfd = 1;
551 if (options[APP_OPTIONS_TLS_ENGINE])
552 app->tls_engine = options[APP_OPTIONS_TLS_ENGINE];
553 if (options[APP_OPTIONS_MAX_FIFO_SIZE])
554 props->max_fifo_size = options[APP_OPTIONS_MAX_FIFO_SIZE];
555 if (options[APP_OPTIONS_HIGH_WATERMARK])
556 props->high_watermark = options[APP_OPTIONS_HIGH_WATERMARK];
557 if (options[APP_OPTIONS_LOW_WATERMARK])
558 props->low_watermark = options[APP_OPTIONS_LOW_WATERMARK];
559 if (options[APP_OPTIONS_PCT_FIRST_ALLOC])
560 props->pct_first_alloc = options[APP_OPTIONS_PCT_FIRST_ALLOC];
561 props->segment_type = seg_type;
563 /* Add app to lookup by api_client_index table */
564 if (!application_is_builtin (app))
565 application_api_table_add (app->app_index, a->api_client_index);
567 application_name_table_add (app);
569 a->app_index = app->app_index;
571 APP_DBG ("New app name: %v api index: %u index %u", app->name,
572 a->api_client_index, app->app_index);
578 application_free (application_t * app)
580 app_worker_map_t *wrk_map;
581 app_worker_t *app_wrk;
584 * The app event queue allocated in first segment is cleared with
585 * the segment manager. No need to explicitly free it.
587 APP_DBG ("Delete app name %v index: %d", app->name, app->app_index);
589 if (application_is_proxy (app))
590 application_remove_proxy (app);
597 pool_flush (wrk_map, app->worker_maps, ({
598 app_wrk = app_worker_get (wrk_map->wrk_index);
599 app_worker_free (app_wrk);
602 pool_free (app->worker_maps);
605 * Cleanup remaining state
607 if (application_is_builtin (app))
608 application_name_table_del (app);
609 vec_free (app->name);
610 pool_put (app_main.app_pool, app);
614 application_detach_process (application_t * app, u32 api_client_index)
616 vnet_app_worker_add_del_args_t _args = { 0 }, *args = &_args;
617 app_worker_map_t *wrk_map;
618 u32 *wrks = 0, *wrk_index;
619 app_worker_t *app_wrk;
621 if (api_client_index == ~0)
623 application_free (app);
627 APP_DBG ("Detaching for app %v index %u api client index %u", app->name,
628 app->app_index, api_client_index);
631 pool_foreach (wrk_map, app->worker_maps, ({
632 app_wrk = app_worker_get (wrk_map->wrk_index);
633 if (app_wrk->api_client_index == api_client_index)
634 vec_add1 (wrks, app_wrk->wrk_index);
640 clib_warning ("no workers for app %u api_index %u", app->app_index,
645 args->app_index = app->app_index;
646 args->api_client_index = api_client_index;
647 vec_foreach (wrk_index, wrks)
649 app_wrk = app_worker_get (wrk_index[0]);
650 args->wrk_map_index = app_wrk->wrk_map_index;
652 vnet_app_worker_add_del (args);
658 application_get_worker (application_t * app, u32 wrk_map_index)
660 app_worker_map_t *map;
661 map = app_worker_map_get (app, wrk_map_index);
664 return app_worker_get (map->wrk_index);
668 application_get_default_worker (application_t * app)
670 return application_get_worker (app, 0);
674 application_n_workers (application_t * app)
676 return pool_elts (app->worker_maps);
680 application_listener_select_worker (session_t * ls)
685 app = application_get (ls->app_index);
686 al = app_listener_get (app, ls->al_index);
687 return app_listener_select_worker (app, al);
691 application_alloc_worker_and_init (application_t * app, app_worker_t ** wrk)
693 app_worker_map_t *wrk_map;
694 app_worker_t *app_wrk;
695 segment_manager_t *sm;
698 app_wrk = app_worker_alloc (app);
699 wrk_map = app_worker_map_alloc (app);
700 wrk_map->wrk_index = app_wrk->wrk_index;
701 app_wrk->wrk_map_index = app_worker_map_index (app, wrk_map);
704 * Setup first segment manager
706 sm = segment_manager_alloc ();
707 sm->app_wrk_index = app_wrk->wrk_index;
709 if ((rv = segment_manager_init (sm)))
711 app_worker_free (app_wrk);
714 sm->first_is_protected = 1;
719 app_wrk->first_segment_manager = segment_manager_index (sm);
720 app_wrk->listeners_table = hash_create (0, sizeof (u64));
721 app_wrk->event_queue = segment_manager_event_queue (sm);
722 app_wrk->app_is_builtin = application_is_builtin (app);
730 vnet_app_worker_add_del (vnet_app_worker_add_del_args_t * a)
733 app_worker_map_t *wrk_map;
734 app_worker_t *app_wrk;
735 segment_manager_t *sm;
739 app = application_get (a->app_index);
741 return VNET_API_ERROR_INVALID_VALUE;
745 if ((rv = application_alloc_worker_and_init (app, &app_wrk)))
748 /* Map worker api index to the app */
749 app_wrk->api_client_index = a->api_client_index;
750 application_api_table_add (app->app_index, a->api_client_index);
752 sm = segment_manager_get (app_wrk->first_segment_manager);
753 fs = segment_manager_get_segment_w_lock (sm, 0);
754 a->segment = &fs->ssvm;
755 a->segment_handle = segment_manager_segment_handle (sm, fs);
756 segment_manager_segment_reader_unlock (sm);
757 a->evt_q = app_wrk->event_queue;
758 a->wrk_map_index = app_wrk->wrk_map_index;
762 wrk_map = app_worker_map_get (app, a->wrk_map_index);
764 return VNET_API_ERROR_INVALID_VALUE;
766 app_wrk = app_worker_get (wrk_map->wrk_index);
768 return VNET_API_ERROR_INVALID_VALUE;
770 application_api_table_del (app_wrk->api_client_index);
771 app_worker_free (app_wrk);
772 app_worker_map_free (app, wrk_map);
773 if (application_n_workers (app) == 0)
774 application_free (app);
780 app_validate_namespace (u8 * namespace_id, u64 secret, u32 * app_ns_index)
782 app_namespace_t *app_ns;
783 if (vec_len (namespace_id) == 0)
785 /* Use default namespace */
790 *app_ns_index = app_namespace_index_from_id (namespace_id);
791 if (*app_ns_index == APP_NAMESPACE_INVALID_INDEX)
792 return VNET_API_ERROR_APP_INVALID_NS;
793 app_ns = app_namespace_get (*app_ns_index);
795 return VNET_API_ERROR_APP_INVALID_NS;
796 if (app_ns->ns_secret != secret)
797 return VNET_API_ERROR_APP_WRONG_NS_SECRET;
802 app_name_from_api_index (u32 api_client_index)
804 vl_api_registration_t *regp;
805 regp = vl_api_client_index_to_registration (api_client_index);
807 return format (0, "%s", regp->name);
809 clib_warning ("api client index %u does not have an api registration!",
811 return format (0, "unknown");
815 * Attach application to vpp
817 * Allocates a vpp app, i.e., a structure that keeps back pointers
818 * to external app and a segment manager for shared memory fifo based
819 * communication with the external app.
822 vnet_application_attach (vnet_app_attach_args_t * a)
825 application_t *app = 0;
826 app_worker_t *app_wrk;
827 segment_manager_t *sm;
828 u32 app_ns_index = 0;
833 if (a->api_client_index != APP_INVALID_INDEX)
834 app = application_lookup (a->api_client_index);
836 app = application_lookup_name (a->name);
838 return VNET_API_ERROR_INVALID_VALUE;
841 return VNET_API_ERROR_APP_ALREADY_ATTACHED;
843 if (a->api_client_index != APP_INVALID_INDEX)
845 app_name = app_name_from_api_index (a->api_client_index);
849 secret = a->options[APP_OPTIONS_NAMESPACE_SECRET];
850 if ((rv = app_validate_namespace (a->namespace_id, secret, &app_ns_index)))
852 a->options[APP_OPTIONS_NAMESPACE] = app_ns_index;
854 if ((rv = application_alloc_and_init ((app_init_args_t *) a)))
857 app = application_get (a->app_index);
858 if ((rv = application_alloc_worker_and_init (app, &app_wrk)))
861 a->app_evt_q = app_wrk->event_queue;
862 app_wrk->api_client_index = a->api_client_index;
863 sm = segment_manager_get (app_wrk->first_segment_manager);
864 fs = segment_manager_get_segment_w_lock (sm, 0);
866 if (application_is_proxy (app))
867 application_setup_proxy (app);
869 ASSERT (vec_len (fs->ssvm.name) <= 128);
870 a->segment = &fs->ssvm;
871 a->segment_handle = segment_manager_segment_handle (sm, fs);
873 segment_manager_segment_reader_unlock (sm);
879 * Detach application from vpp
882 vnet_application_detach (vnet_app_detach_args_t * a)
886 app = application_get_if_valid (a->app_index);
889 clib_warning ("app not attached");
890 return VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
893 app_interface_check_thread_and_barrier (vnet_application_detach, a);
894 application_detach_process (app, a->api_client_index);
900 session_endpoint_in_ns (session_endpoint_t * sep)
902 u8 is_lep = session_endpoint_is_local (sep);
903 if (!is_lep && sep->sw_if_index != ENDPOINT_INVALID_INDEX
904 && !ip_interface_has_address (sep->sw_if_index, &sep->ip, sep->is_ip4))
906 clib_warning ("sw_if_index %u not configured with ip %U",
907 sep->sw_if_index, format_ip46_address, &sep->ip,
911 return (is_lep || ip_is_local (sep->fib_index, &sep->ip, sep->is_ip4));
915 session_endpoint_update_for_app (session_endpoint_cfg_t * sep,
916 application_t * app, u8 is_connect)
918 app_namespace_t *app_ns;
919 u32 ns_index, fib_index;
921 ns_index = app->ns_index;
923 /* App is a transport proto, so fetch the calling app's ns */
924 if (app->flags & APP_OPTIONS_FLAGS_IS_TRANSPORT_APP)
925 ns_index = sep->ns_index;
927 app_ns = app_namespace_get (ns_index);
931 /* Ask transport and network to bind to/connect using local interface
932 * that "supports" app's namespace. This will fix our local connection
936 /* If in default namespace and user requested a fib index use it */
937 if (ns_index == 0 && sep->fib_index != ENDPOINT_INVALID_INDEX)
938 fib_index = sep->fib_index;
940 fib_index = sep->is_ip4 ? app_ns->ip4_fib_index : app_ns->ip6_fib_index;
941 sep->peer.fib_index = fib_index;
942 sep->fib_index = fib_index;
946 sep->sw_if_index = app_ns->sw_if_index;
950 if (app_ns->sw_if_index != APP_NAMESPACE_INVALID_INDEX
951 && sep->peer.sw_if_index != ENDPOINT_INVALID_INDEX
952 && sep->peer.sw_if_index != app_ns->sw_if_index)
953 clib_warning ("Local sw_if_index different from app ns sw_if_index");
955 sep->peer.sw_if_index = app_ns->sw_if_index;
960 vnet_listen (vnet_listen_args_t * a)
962 app_listener_t *app_listener;
963 app_worker_t *app_wrk;
967 ASSERT (vlib_thread_is_main_w_barrier ());
969 app = application_get_if_valid (a->app_index);
971 return VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
973 app_wrk = application_get_worker (app, a->wrk_map_index);
975 return VNET_API_ERROR_INVALID_VALUE;
977 a->sep_ext.app_wrk_index = app_wrk->wrk_index;
979 session_endpoint_update_for_app (&a->sep_ext, app, 0 /* is_connect */ );
980 if (!session_endpoint_in_ns (&a->sep))
981 return VNET_API_ERROR_INVALID_VALUE_2;
984 * Check if we already have an app listener
986 app_listener = app_listener_lookup (app, &a->sep_ext);
989 if (app_listener->app_index != app->app_index)
990 return VNET_API_ERROR_ADDRESS_IN_USE;
991 if (app_worker_start_listen (app_wrk, app_listener))
993 a->handle = app_listener_handle (app_listener);
998 * Create new app listener
1000 if ((rv = app_listener_alloc_and_init (app, &a->sep_ext, &app_listener)))
1003 if ((rv = app_worker_start_listen (app_wrk, app_listener)))
1005 app_listener_cleanup (app_listener);
1009 a->handle = app_listener_handle (app_listener);
1014 vnet_connect (vnet_connect_args_t * a)
1016 app_worker_t *client_wrk;
1017 application_t *client;
1019 ASSERT (vlib_thread_is_main_w_barrier ());
1021 if (session_endpoint_is_zero (&a->sep))
1022 return VNET_API_ERROR_INVALID_VALUE;
1024 client = application_get (a->app_index);
1025 session_endpoint_update_for_app (&a->sep_ext, client, 1 /* is_connect */ );
1026 client_wrk = application_get_worker (client, a->wrk_map_index);
1029 * First check the local scope for locally attached destinations.
1030 * If we have local scope, we pass *all* connects through it since we may
1031 * have special policy rules even for non-local destinations, think proxy.
1033 if (application_has_local_scope (client))
1037 a->sep_ext.original_tp = a->sep_ext.transport_proto;
1038 a->sep_ext.transport_proto = TRANSPORT_PROTO_NONE;
1039 rv = app_worker_connect_session (client_wrk, &a->sep, a->api_context);
1044 * Not connecting to a local server, propagate to transport
1046 if (app_worker_connect_session (client_wrk, &a->sep, a->api_context))
1047 return VNET_API_ERROR_SESSION_CONNECT;
1052 vnet_unlisten (vnet_unlisten_args_t * a)
1054 app_worker_t *app_wrk;
1058 ASSERT (vlib_thread_is_main_w_barrier ());
1060 if (!(app = application_get_if_valid (a->app_index)))
1061 return VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
1063 if (!(al = app_listener_get_w_handle (a->handle)))
1066 if (al->app_index != app->app_index)
1068 clib_warning ("app doesn't own handle %llu!", a->handle);
1072 app_wrk = application_get_worker (app, a->wrk_map_index);
1075 clib_warning ("no app %u worker %u", app->app_index, a->wrk_map_index);
1079 return app_worker_stop_listen (app_wrk, al);
1083 vnet_disconnect_session (vnet_disconnect_args_t * a)
1085 app_worker_t *app_wrk;
1088 s = session_get_from_handle_if_valid (a->handle);
1090 return VNET_API_ERROR_INVALID_VALUE;
1091 app_wrk = app_worker_get (s->app_wrk_index);
1092 if (app_wrk->app_index != a->app_index)
1093 return VNET_API_ERROR_INVALID_VALUE;
1095 /* We're peeking into another's thread pool. Make sure */
1096 ASSERT (s->session_index == session_index_from_handle (a->handle));
1103 application_change_listener_owner (session_t * s, app_worker_t * app_wrk)
1105 app_worker_t *old_wrk = app_worker_get (s->app_wrk_index);
1106 app_listener_t *app_listener;
1112 hash_unset (old_wrk->listeners_table, listen_session_get_handle (s));
1113 if (session_transport_service_type (s) == TRANSPORT_SERVICE_CL
1115 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1117 app = application_get (old_wrk->app_index);
1121 app_listener = app_listener_get (app, s->al_index);
1123 /* Only remove from lb for now */
1124 app_listener->workers = clib_bitmap_set (app_listener->workers,
1125 old_wrk->wrk_map_index, 0);
1127 if (app_worker_start_listen (app_wrk, app_listener))
1130 s->app_wrk_index = app_wrk->wrk_index;
1136 application_is_proxy (application_t * app)
1138 return (app->flags & APP_OPTIONS_FLAGS_IS_PROXY);
1142 application_is_builtin (application_t * app)
1144 return (app->flags & APP_OPTIONS_FLAGS_IS_BUILTIN);
1148 application_is_builtin_proxy (application_t * app)
1150 return (application_is_proxy (app) && application_is_builtin (app));
1154 application_has_local_scope (application_t * app)
1156 return app->flags & APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
1160 application_has_global_scope (application_t * app)
1162 return app->flags & APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
1165 static clib_error_t *
1166 application_start_stop_proxy_fib_proto (application_t * app, u8 fib_proto,
1167 u8 transport_proto, u8 is_start)
1169 app_namespace_t *app_ns = app_namespace_get (app->ns_index);
1170 u8 is_ip4 = (fib_proto == FIB_PROTOCOL_IP4);
1171 session_endpoint_cfg_t sep = SESSION_ENDPOINT_CFG_NULL;
1172 transport_connection_t *tc;
1173 app_worker_t *app_wrk;
1178 /* TODO decide if we want proxy to be enabled for all workers */
1179 app_wrk = application_get_default_worker (app);
1182 s = app_worker_first_listener (app_wrk, fib_proto, transport_proto);
1185 sep.is_ip4 = is_ip4;
1186 sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
1187 sep.sw_if_index = app_ns->sw_if_index;
1188 sep.transport_proto = transport_proto;
1189 sep.app_wrk_index = app_wrk->wrk_index; /* only default */
1191 /* force global scope listener */
1193 app->flags &= ~APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
1194 app_listener_alloc_and_init (app, &sep, &al);
1197 app_worker_start_listen (app_wrk, al);
1198 s = listen_session_get (al->session_index);
1199 s->flags |= SESSION_F_PROXY;
1204 s = app_worker_proxy_listener (app_wrk, fib_proto, transport_proto);
1208 tc = listen_session_get_transport (s);
1210 if (!ip_is_zero (&tc->lcl_ip, 1))
1213 sep.is_ip4 = is_ip4;
1214 sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
1215 sep.transport_proto = transport_proto;
1217 sti = session_lookup_get_index_for_fib (fib_proto, sep.fib_index);
1219 session_lookup_add_session_endpoint (sti,
1220 (session_endpoint_t *) & sep,
1223 session_lookup_del_session_endpoint (sti,
1224 (session_endpoint_t *) & sep);
1231 application_start_stop_proxy_local_scope (application_t * app,
1232 u8 transport_proto, u8 is_start)
1234 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
1235 app_namespace_t *app_ns;
1236 app_ns = app_namespace_get (app->ns_index);
1238 sep.transport_proto = transport_proto;
1243 session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
1246 session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
1251 session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
1253 session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
1258 application_start_stop_proxy (application_t * app,
1259 transport_proto_t transport_proto, u8 is_start)
1261 if (application_has_local_scope (app))
1262 application_start_stop_proxy_local_scope (app, transport_proto, is_start);
1264 if (application_has_global_scope (app))
1266 application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP4,
1267 transport_proto, is_start);
1268 application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP6,
1269 transport_proto, is_start);
1274 application_setup_proxy (application_t * app)
1276 u16 transports = app->proxied_transports;
1277 transport_proto_t tp;
1279 ASSERT (application_is_proxy (app));
1282 transport_proto_foreach (tp, ({
1283 if (transports & (1 << tp))
1284 application_start_stop_proxy (app, tp, 1);
1290 application_remove_proxy (application_t * app)
1292 u16 transports = app->proxied_transports;
1293 transport_proto_t tp;
1295 ASSERT (application_is_proxy (app));
1298 transport_proto_foreach (tp, ({
1299 if (transports & (1 << tp))
1300 application_start_stop_proxy (app, tp, 0);
1305 segment_manager_props_t *
1306 application_segment_manager_properties (application_t * app)
1308 return &app->sm_properties;
1311 segment_manager_props_t *
1312 application_get_segment_manager_properties (u32 app_index)
1314 application_t *app = application_get (app_index);
1315 return &app->sm_properties;
1319 vnet_app_add_tls_cert (vnet_app_add_tls_cert_args_t * a)
1321 /* Deprected, will be remove after 20.01 */
1322 app_cert_key_pair_t *ckpair;
1323 ckpair = app_cert_key_pair_get_default ();
1324 ckpair->cert = vec_dup (a->cert);
1329 vnet_app_add_tls_key (vnet_app_add_tls_key_args_t * a)
1331 /* Deprected, will be remove after 20.01 */
1332 app_cert_key_pair_t *ckpair;
1333 ckpair = app_cert_key_pair_get_default ();
1334 ckpair->key = vec_dup (a->key);
1339 application_format_listeners (application_t * app, int verbose)
1341 vlib_main_t *vm = vlib_get_main ();
1342 app_worker_map_t *wrk_map;
1343 app_worker_t *app_wrk;
1349 vlib_cli_output (vm, "%U", format_app_worker_listener, 0 /* header */ ,
1355 pool_foreach (wrk_map, app->worker_maps, ({
1356 app_wrk = app_worker_get (wrk_map->wrk_index);
1357 if (hash_elts (app_wrk->listeners_table) == 0)
1359 hash_foreach (handle, sm_index, app_wrk->listeners_table, ({
1360 vlib_cli_output (vm, "%U", format_app_worker_listener, app_wrk,
1361 handle, sm_index, verbose);
1368 application_format_connects (application_t * app, int verbose)
1370 app_worker_map_t *wrk_map;
1371 app_worker_t *app_wrk;
1375 app_worker_format_connects (0, verbose);
1380 pool_foreach (wrk_map, app->worker_maps, ({
1381 app_wrk = app_worker_get (wrk_map->wrk_index);
1382 app_worker_format_connects (app_wrk, verbose);
1388 format_cert_key_pair (u8 * s, va_list * args)
1390 app_cert_key_pair_t *ckpair = va_arg (*args, app_cert_key_pair_t *);
1391 int key_len = 0, cert_len = 0;
1392 cert_len = vec_len (ckpair->cert);
1393 key_len = vec_len (ckpair->key);
1394 if (ckpair->cert_key_index == 0)
1395 s = format (s, "DEFAULT (cert:%d, key:%d)", cert_len, key_len);
1397 s = format (s, "%d (cert:%d, key:%d)", ckpair->cert_key_index,
1403 format_crypto_engine (u8 * s, va_list * args)
1405 u32 engine = va_arg (*args, u32);
1408 case CRYPTO_ENGINE_NONE:
1409 return format (s, "none");
1410 case CRYPTO_ENGINE_MBEDTLS:
1411 return format (s, "mbedtls");
1412 case CRYPTO_ENGINE_OPENSSL:
1413 return format (s, "openssl");
1414 case CRYPTO_ENGINE_PICOTLS:
1415 return format (s, "picotls");
1416 case CRYPTO_ENGINE_VPP:
1417 return format (s, "vpp");
1419 return format (s, "unknown engine");
1425 unformat_crypto_engine (unformat_input_t * input, va_list * args)
1427 u8 *a = va_arg (*args, u8 *);
1428 if (unformat (input, "mbedtls"))
1429 *a = CRYPTO_ENGINE_MBEDTLS;
1430 else if (unformat (input, "openssl"))
1431 *a = CRYPTO_ENGINE_OPENSSL;
1432 else if (unformat (input, "picotls"))
1433 *a = CRYPTO_ENGINE_PICOTLS;
1434 else if (unformat (input, "vpp"))
1435 *a = CRYPTO_ENGINE_VPP;
1442 format_crypto_context (u8 * s, va_list * args)
1444 crypto_context_t *crctx = va_arg (*args, crypto_context_t *);
1445 s = format (s, "[0x%x][sub%d,ckpair%x]", crctx->ctx_index,
1446 crctx->n_subscribers, crctx->ckpair_index);
1447 s = format (s, "[%U]", format_crypto_engine, crctx->crypto_engine);
1452 format_application (u8 * s, va_list * args)
1454 application_t *app = va_arg (*args, application_t *);
1455 CLIB_UNUSED (int verbose) = va_arg (*args, int);
1456 segment_manager_props_t *props;
1457 const u8 *app_ns_name, *app_name;
1458 app_worker_map_t *wrk_map;
1459 app_worker_t *app_wrk;
1464 s = format (s, "%-10s%-20s%-40s", "Index", "Name", "Namespace");
1468 app_name = app_get_name (app);
1469 app_ns_name = app_namespace_id_from_index (app->ns_index);
1470 props = application_segment_manager_properties (app);
1473 s = format (s, "%-10u%-20v%-40s", app->app_index, app_name,
1478 s = format (s, "app-name %v app-index %u ns-index %u seg-size %U\n",
1479 app_name, app->app_index, app->ns_index,
1480 format_memory_size, props->add_segment_size);
1481 s = format (s, "rx-fifo-size %U tx-fifo-size %U workers:\n",
1482 format_memory_size, props->rx_fifo_size,
1483 format_memory_size, props->tx_fifo_size);
1486 pool_foreach (wrk_map, app->worker_maps, ({
1487 app_wrk = app_worker_get (wrk_map->wrk_index);
1488 s = format (s, "%U", format_app_worker, app_wrk);
1496 application_format_all_listeners (vlib_main_t * vm, int verbose)
1500 if (!pool_elts (app_main.app_pool))
1502 vlib_cli_output (vm, "No active server bindings");
1506 application_format_listeners (0, verbose);
1509 pool_foreach (app, app_main.app_pool, ({
1510 application_format_listeners (app, verbose);
1516 application_format_all_clients (vlib_main_t * vm, int verbose)
1520 if (!pool_elts (app_main.app_pool))
1522 vlib_cli_output (vm, "No active apps");
1526 application_format_connects (0, verbose);
1529 pool_foreach (app, app_main.app_pool, ({
1530 application_format_connects (app, verbose);
1535 static clib_error_t *
1536 show_certificate_command_fn (vlib_main_t * vm, unformat_input_t * input,
1537 vlib_cli_command_t * cmd)
1539 app_cert_key_pair_t *ckpair;
1540 session_cli_return_if_not_enabled ();
1543 pool_foreach (ckpair, app_main.cert_key_pair_store, ({
1544 vlib_cli_output (vm, "%U", format_cert_key_pair, ckpair);
1551 appliction_format_app_mq (vlib_main_t * vm, application_t * app)
1553 app_worker_map_t *map;
1556 pool_foreach (map, app->worker_maps, ({
1557 wrk = app_worker_get (map->wrk_index);
1558 vlib_cli_output (vm, "[A%d][%d]%U", app->app_index,
1559 map->wrk_index, format_svm_msg_q,
1565 static clib_error_t *
1566 appliction_format_all_app_mq (vlib_main_t * vm)
1571 n_threads = vec_len (vlib_mains);
1573 for (i = 0; i < n_threads; i++)
1575 vlib_cli_output (vm, "[Ctrl%d]%U", i, format_svm_msg_q,
1576 session_main_get_vpp_event_queue (i));
1580 pool_foreach (app, app_main.app_pool, ({
1581 appliction_format_app_mq (vm, app);
1587 static clib_error_t *
1588 show_app_command_fn (vlib_main_t * vm, unformat_input_t * input,
1589 vlib_cli_command_t * cmd)
1591 int do_server = 0, do_client = 0, do_mq = 0;
1596 session_cli_return_if_not_enabled ();
1598 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1600 if (unformat (input, "server"))
1602 else if (unformat (input, "client"))
1604 else if (unformat (input, "mq"))
1606 else if (unformat (input, "%u", &app_index))
1608 else if (unformat (input, "verbose"))
1611 return clib_error_return (0, "unknown input `%U'",
1612 format_unformat_error, input);
1615 if (do_mq && app_index != ~0)
1617 app = application_get_if_valid (app_index);
1619 return clib_error_return (0, "No app with index %u", app_index);
1621 appliction_format_app_mq (vm, app);
1627 appliction_format_all_app_mq (vm);
1633 application_format_all_listeners (vm, verbose);
1639 application_format_all_clients (vm, verbose);
1643 if (app_index != ~0)
1645 app = application_get_if_valid (app_index);
1647 return clib_error_return (0, "No app with index %u", app_index);
1649 vlib_cli_output (vm, "%U", format_application, app, /* verbose */ 1);
1653 /* Print app related info */
1654 if (!do_server && !do_client)
1656 vlib_cli_output (vm, "%U", format_application, 0, 0);
1658 pool_foreach (app, app_main.app_pool, ({
1659 vlib_cli_output (vm, "%U", format_application, app, 0);
1667 /* Certificate store */
1669 static app_cert_key_pair_t *
1670 app_cert_key_pair_alloc ()
1672 app_cert_key_pair_t *ckpair;
1673 pool_get (app_main.cert_key_pair_store, ckpair);
1674 clib_memset (ckpair, 0, sizeof (*ckpair));
1675 ckpair->cert_key_index = ckpair - app_main.cert_key_pair_store;
1679 app_cert_key_pair_t *
1680 app_cert_key_pair_get_if_valid (u32 index)
1682 if (pool_is_free_index (app_main.cert_key_pair_store, index))
1684 return app_cert_key_pair_get (index);
1687 app_cert_key_pair_t *
1688 app_cert_key_pair_get (u32 index)
1690 return pool_elt_at_index (app_main.cert_key_pair_store, index);
1693 app_cert_key_pair_t *
1694 app_cert_key_pair_get_default ()
1696 /* To maintain legacy bapi */
1697 return app_cert_key_pair_get (0);
1701 vnet_app_add_cert_key_pair (vnet_app_add_cert_key_pair_args_t * a)
1703 app_cert_key_pair_t *ckpair = app_cert_key_pair_alloc ();
1704 ckpair->cert = vec_dup (a->cert);
1705 ckpair->key = vec_dup (a->key);
1706 a->index = ckpair->cert_key_index;
1711 vnet_app_add_cert_key_interest (u32 index, u32 app_index)
1713 app_cert_key_pair_t *ckpair;
1714 if (!(ckpair = app_cert_key_pair_get_if_valid (index)))
1716 if (vec_search (ckpair->app_interests, app_index) != ~0)
1717 vec_add1 (ckpair->app_interests, app_index);
1722 vnet_app_del_cert_key_pair (u32 index)
1724 app_cert_key_pair_t *ckpair;
1728 if (!(ckpair = app_cert_key_pair_get_if_valid (index)))
1729 return (VNET_API_ERROR_INVALID_VALUE);
1731 vec_foreach (app_index, ckpair->app_interests)
1733 if ((app = application_get_if_valid (*app_index))
1734 && app->cb_fns.app_cert_key_pair_delete_callback)
1735 app->cb_fns.app_cert_key_pair_delete_callback (ckpair);
1738 vec_free (ckpair->cert);
1739 vec_free (ckpair->key);
1740 pool_put (app_main.cert_key_pair_store, ckpair);
1745 application_init (vlib_main_t * vm)
1747 /* Add a certificate with index 0 to support legacy apis */
1748 (void) app_cert_key_pair_alloc ();
1749 app_main.last_crypto_engine = CRYPTO_ENGINE_LAST;
1754 VLIB_INIT_FUNCTION (application_init);
1756 VLIB_CLI_COMMAND (show_app_command, static) =
1759 .short_help = "show app [app_id] [server|client] [mq] [verbose]",
1760 .function = show_app_command_fn,
1763 VLIB_CLI_COMMAND (show_certificate_command, static) =
1765 .path = "show app certificate",
1766 .short_help = "list app certs and keys present in store",
1767 .function = show_certificate_command_fn,
1771 crypto_engine_type_t
1772 app_crypto_engine_type_add (void)
1774 return (++app_main.last_crypto_engine);
1778 app_crypto_engine_n_types (void)
1780 return (app_main.last_crypto_engine + 1);
1784 * fd.io coding-style-patch-verification: ON
1787 * eval: (c-set-style "gnu")