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);
55 pool_put (app->listeners, app_listener);
57 clib_memset (app_listener, 0xfa, sizeof (*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 = application_session_table (app, fib_proto);
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;
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;
156 local_st = session_type_from_proto_and_ip (TRANSPORT_PROTO_NONE,
158 ls = listen_session_alloc (0, local_st);
159 ls->app_index = app->app_index;
160 ls->app_wrk_index = sep->app_wrk_index;
161 lh = session_handle (ls);
163 if ((rv = session_listen (ls, sep)))
165 ls = session_get_from_handle (lh);
170 ls = session_get_from_handle (lh);
171 app_listener = app_listener_get (app, al_index);
172 app_listener->local_index = ls->session_index;
173 app_listener->ls_handle = lh;
174 ls->al_index = al_index;
176 table_index = application_local_session_table (app);
177 session_lookup_add_session_endpoint (table_index,
178 (session_endpoint_t *) sep, lh);
181 if (application_has_global_scope (app))
184 * Start listening on local endpoint for requested transport and scope.
185 * Creates a stream session with state LISTENING to be used in session
186 * lookups, prior to establishing connection. Requests transport to
187 * build it's own specific listening connection.
189 ls = listen_session_alloc (0, st);
190 ls->app_index = app->app_index;
191 ls->app_wrk_index = sep->app_wrk_index;
193 /* Listen pool can be reallocated if the transport is
195 lh = listen_session_get_handle (ls);
197 if ((rv = session_listen (ls, sep)))
199 ls = listen_session_get_from_handle (lh);
203 ls = listen_session_get_from_handle (lh);
204 app_listener = app_listener_get (app, al_index);
205 app_listener->session_index = ls->session_index;
206 app_listener->ls_handle = lh;
207 ls->al_index = al_index;
209 /* Add to the global lookup table after transport was initialized.
210 * Lookup table needs to be populated only now because sessions
211 * with cut-through transport are are added to app local tables that
212 * are not related to network fibs, i.e., cannot be added as
214 tc = session_get_transport (ls);
215 session_lookup_add_connection (tc, lh);
220 app_listener_free (app, app_listener);
224 *listener = app_listener;
229 app_listener_cleanup (app_listener_t * al)
231 application_t *app = application_get (al->app_index);
234 if (al->session_index != SESSION_INVALID_INDEX)
236 ls = session_get (al->session_index, 0);
237 session_stop_listen (ls);
238 listen_session_free (ls);
240 if (al->local_index != SESSION_INVALID_INDEX)
242 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
245 table_index = application_local_session_table (app);
246 ls = listen_session_get (al->local_index);
247 ct_session_endpoint (ls, &sep);
248 session_lookup_del_session_endpoint (table_index, &sep);
249 session_stop_listen (ls);
250 listen_session_free (ls);
252 app_listener_free (app, al);
255 static app_worker_t *
256 app_listener_select_worker (application_t * app, app_listener_t * al)
260 app = application_get (al->app_index);
261 wrk_index = clib_bitmap_next_set (al->workers, al->accept_rotor + 1);
263 wrk_index = clib_bitmap_first_set (al->workers);
265 ASSERT (wrk_index != ~0);
266 al->accept_rotor = wrk_index;
267 return application_get_worker (app, wrk_index);
271 app_listener_get_session (app_listener_t * al)
273 if (al->session_index == SESSION_INVALID_INDEX)
276 return listen_session_get (al->session_index);
280 app_listener_get_local_session (app_listener_t * al)
282 if (al->local_index == SESSION_INVALID_INDEX)
284 return listen_session_get (al->local_index);
287 static app_worker_map_t *
288 app_worker_map_alloc (application_t * app)
290 app_worker_map_t *map;
291 pool_get (app->worker_maps, map);
292 clib_memset (map, 0, sizeof (*map));
297 app_worker_map_index (application_t * app, app_worker_map_t * map)
299 return (map - app->worker_maps);
303 app_worker_map_free (application_t * app, app_worker_map_t * map)
305 pool_put (app->worker_maps, map);
308 static app_worker_map_t *
309 app_worker_map_get (application_t * app, u32 map_index)
311 if (pool_is_free_index (app->worker_maps, map_index))
313 return pool_elt_at_index (app->worker_maps, map_index);
317 app_get_name (application_t * app)
323 application_session_table (application_t * app, u8 fib_proto)
325 app_namespace_t *app_ns;
326 app_ns = app_namespace_get (app->ns_index);
327 if (!application_has_global_scope (app))
328 return APP_INVALID_INDEX;
329 if (fib_proto == FIB_PROTOCOL_IP4)
330 return session_lookup_get_index_for_fib (fib_proto,
331 app_ns->ip4_fib_index);
333 return session_lookup_get_index_for_fib (fib_proto,
334 app_ns->ip6_fib_index);
338 application_local_session_table (application_t * app)
340 app_namespace_t *app_ns;
341 if (!application_has_local_scope (app))
342 return APP_INVALID_INDEX;
343 app_ns = app_namespace_get (app->ns_index);
344 return app_ns->local_table_index;
348 * Returns app name for app-index
351 application_name_from_index (u32 app_index)
353 application_t *app = application_get (app_index);
356 return app_get_name (app);
360 application_api_table_add (u32 app_index, u32 api_client_index)
362 if (api_client_index != APP_INVALID_INDEX)
363 hash_set (app_main.app_by_api_client_index, api_client_index, app_index);
367 application_api_table_del (u32 api_client_index)
369 hash_unset (app_main.app_by_api_client_index, api_client_index);
373 application_name_table_add (application_t * app)
375 hash_set_mem (app_main.app_by_name, app->name, app->app_index);
379 application_name_table_del (application_t * app)
381 hash_unset_mem (app_main.app_by_name, app->name);
385 application_lookup (u32 api_client_index)
388 p = hash_get (app_main.app_by_api_client_index, api_client_index);
390 return application_get_if_valid (p[0]);
396 application_lookup_name (const u8 * name)
399 p = hash_get_mem (app_main.app_by_name, name);
401 return application_get (p[0]);
406 static application_t *
407 application_alloc (void)
410 pool_get (app_main.app_pool, app);
411 clib_memset (app, 0, sizeof (*app));
412 app->app_index = app - app_main.app_pool;
417 application_get (u32 app_index)
419 if (app_index == APP_INVALID_INDEX)
421 return pool_elt_at_index (app_main.app_pool, app_index);
425 application_get_if_valid (u32 app_index)
427 if (pool_is_free_index (app_main.app_pool, app_index))
430 return pool_elt_at_index (app_main.app_pool, app_index);
434 application_verify_cb_fns (session_cb_vft_t * cb_fns)
436 if (cb_fns->session_accept_callback == 0)
437 clib_warning ("No accept callback function provided");
438 if (cb_fns->session_connected_callback == 0)
439 clib_warning ("No session connected callback function provided");
440 if (cb_fns->session_disconnect_callback == 0)
441 clib_warning ("No session disconnect callback function provided");
442 if (cb_fns->session_reset_callback == 0)
443 clib_warning ("No session reset callback function provided");
447 * Check app config for given segment type
449 * Returns 1 on success and 0 otherwise
452 application_verify_cfg (ssvm_segment_type_t st)
455 if (st == SSVM_SEGMENT_MEMFD)
457 is_valid = (session_main_get_evt_q_segment () != 0);
459 clib_warning ("memfd seg: vpp's event qs IN binary api svm region");
462 else if (st == SSVM_SEGMENT_SHM)
464 is_valid = (session_main_get_evt_q_segment () == 0);
466 clib_warning ("shm seg: vpp's event qs NOT IN binary api svm region");
474 application_alloc_and_init (app_init_args_t * a)
476 ssvm_segment_type_t seg_type = SSVM_SEGMENT_MEMFD;
477 segment_manager_props_t *props;
478 vl_api_registration_t *reg;
482 app = application_alloc ();
483 options = a->options;
485 * Make sure we support the requested configuration
487 if (!(options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_IS_BUILTIN))
489 reg = vl_api_client_index_to_registration (a->api_client_index);
491 return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
492 if (vl_api_registration_file_index (reg) == VL_API_INVALID_FI)
493 seg_type = SSVM_SEGMENT_SHM;
497 seg_type = SSVM_SEGMENT_PRIVATE;
500 if ((options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
501 && seg_type != SSVM_SEGMENT_MEMFD)
503 clib_warning ("mq eventfds can only be used if socket transport is "
504 "used for binary api");
505 return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
508 if (!application_verify_cfg (seg_type))
509 return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
511 /* Check that the obvious things are properly set up */
512 application_verify_cb_fns (a->session_cb_vft);
514 app->flags = options[APP_OPTIONS_FLAGS];
515 app->cb_fns = *a->session_cb_vft;
516 app->ns_index = options[APP_OPTIONS_NAMESPACE];
517 app->proxied_transports = options[APP_OPTIONS_PROXY_TRANSPORT];
518 app->name = vec_dup (a->name);
520 /* If no scope enabled, default to global */
521 if (!application_has_global_scope (app)
522 && !application_has_local_scope (app))
523 app->flags |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
525 props = application_segment_manager_properties (app);
526 segment_manager_props_init (props);
527 props->segment_size = options[APP_OPTIONS_SEGMENT_SIZE];
528 props->prealloc_fifos = options[APP_OPTIONS_PREALLOC_FIFO_PAIRS];
529 if (options[APP_OPTIONS_ADD_SEGMENT_SIZE])
531 props->add_segment_size = options[APP_OPTIONS_ADD_SEGMENT_SIZE];
532 props->add_segment = 1;
534 if (options[APP_OPTIONS_RX_FIFO_SIZE])
535 props->rx_fifo_size = options[APP_OPTIONS_RX_FIFO_SIZE];
536 if (options[APP_OPTIONS_TX_FIFO_SIZE])
537 props->tx_fifo_size = options[APP_OPTIONS_TX_FIFO_SIZE];
538 if (options[APP_OPTIONS_EVT_QUEUE_SIZE])
539 props->evt_q_size = options[APP_OPTIONS_EVT_QUEUE_SIZE];
540 if (options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
541 props->use_mq_eventfd = 1;
542 if (options[APP_OPTIONS_TLS_ENGINE])
543 app->tls_engine = options[APP_OPTIONS_TLS_ENGINE];
544 props->segment_type = seg_type;
546 /* Add app to lookup by api_client_index table */
547 if (!application_is_builtin (app))
548 application_api_table_add (app->app_index, a->api_client_index);
550 application_name_table_add (app);
552 a->app_index = app->app_index;
554 APP_DBG ("New app name: %v api index: %u index %u", app->name,
555 a->api_client_index, app->app_index);
561 application_free (application_t * app)
563 app_worker_map_t *wrk_map;
564 app_worker_t *app_wrk;
567 * The app event queue allocated in first segment is cleared with
568 * the segment manager. No need to explicitly free it.
570 APP_DBG ("Delete app name %v index: %d", app->name, app->app_index);
572 if (application_is_proxy (app))
573 application_remove_proxy (app);
580 pool_flush (wrk_map, app->worker_maps, ({
581 app_wrk = app_worker_get (wrk_map->wrk_index);
582 app_worker_free (app_wrk);
585 pool_free (app->worker_maps);
588 * Cleanup remaining state
590 if (application_is_builtin (app))
591 application_name_table_del (app);
592 vec_free (app->name);
593 vec_free (app->tls_cert);
594 vec_free (app->tls_key);
595 pool_put (app_main.app_pool, app);
599 application_detach_process (application_t * app, u32 api_client_index)
601 vnet_app_worker_add_del_args_t _args = { 0 }, *args = &_args;
602 app_worker_map_t *wrk_map;
603 u32 *wrks = 0, *wrk_index;
604 app_worker_t *app_wrk;
606 if (api_client_index == ~0)
608 application_free (app);
612 APP_DBG ("Detaching for app %v index %u api client index %u", app->name,
613 app->app_index, api_client_index);
616 pool_foreach (wrk_map, app->worker_maps, ({
617 app_wrk = app_worker_get (wrk_map->wrk_index);
618 if (app_wrk->api_client_index == api_client_index)
619 vec_add1 (wrks, app_wrk->wrk_index);
625 clib_warning ("no workers for app %u api_index %u", app->app_index,
630 args->app_index = app->app_index;
631 args->api_client_index = api_client_index;
632 vec_foreach (wrk_index, wrks)
634 app_wrk = app_worker_get (wrk_index[0]);
635 args->wrk_map_index = app_wrk->wrk_map_index;
637 vnet_app_worker_add_del (args);
643 application_get_worker (application_t * app, u32 wrk_map_index)
645 app_worker_map_t *map;
646 map = app_worker_map_get (app, wrk_map_index);
649 return app_worker_get (map->wrk_index);
653 application_get_default_worker (application_t * app)
655 return application_get_worker (app, 0);
659 application_n_workers (application_t * app)
661 return pool_elts (app->worker_maps);
665 application_listener_select_worker (session_t * ls)
670 app = application_get (ls->app_index);
671 al = app_listener_get (app, ls->al_index);
672 return app_listener_select_worker (app, al);
676 application_alloc_worker_and_init (application_t * app, app_worker_t ** wrk)
678 app_worker_map_t *wrk_map;
679 app_worker_t *app_wrk;
680 segment_manager_t *sm;
683 app_wrk = app_worker_alloc (app);
684 wrk_map = app_worker_map_alloc (app);
685 wrk_map->wrk_index = app_wrk->wrk_index;
686 app_wrk->wrk_map_index = app_worker_map_index (app, wrk_map);
689 * Setup first segment manager
691 sm = segment_manager_alloc ();
692 sm->app_wrk_index = app_wrk->wrk_index;
694 if ((rv = segment_manager_init (sm, app->sm_properties.segment_size,
695 app->sm_properties.prealloc_fifos)))
697 app_worker_free (app_wrk);
700 sm->first_is_protected = 1;
705 app_wrk->first_segment_manager = segment_manager_index (sm);
706 app_wrk->listeners_table = hash_create (0, sizeof (u64));
707 app_wrk->event_queue = segment_manager_event_queue (sm);
708 app_wrk->app_is_builtin = application_is_builtin (app);
716 vnet_app_worker_add_del (vnet_app_worker_add_del_args_t * a)
719 app_worker_map_t *wrk_map;
720 app_worker_t *app_wrk;
721 segment_manager_t *sm;
725 app = application_get (a->app_index);
727 return VNET_API_ERROR_INVALID_VALUE;
731 if ((rv = application_alloc_worker_and_init (app, &app_wrk)))
734 /* Map worker api index to the app */
735 app_wrk->api_client_index = a->api_client_index;
736 application_api_table_add (app->app_index, a->api_client_index);
738 sm = segment_manager_get (app_wrk->first_segment_manager);
739 fs = segment_manager_get_segment_w_lock (sm, 0);
740 a->segment = &fs->ssvm;
741 a->segment_handle = segment_manager_segment_handle (sm, fs);
742 segment_manager_segment_reader_unlock (sm);
743 a->evt_q = app_wrk->event_queue;
744 a->wrk_map_index = app_wrk->wrk_map_index;
748 wrk_map = app_worker_map_get (app, a->wrk_map_index);
750 return VNET_API_ERROR_INVALID_VALUE;
752 app_wrk = app_worker_get (wrk_map->wrk_index);
754 return VNET_API_ERROR_INVALID_VALUE;
756 application_api_table_del (app_wrk->api_client_index);
757 app_worker_free (app_wrk);
758 app_worker_map_free (app, wrk_map);
759 if (application_n_workers (app) == 0)
760 application_free (app);
766 app_validate_namespace (u8 * namespace_id, u64 secret, u32 * app_ns_index)
768 app_namespace_t *app_ns;
769 if (vec_len (namespace_id) == 0)
771 /* Use default namespace */
776 *app_ns_index = app_namespace_index_from_id (namespace_id);
777 if (*app_ns_index == APP_NAMESPACE_INVALID_INDEX)
778 return VNET_API_ERROR_APP_INVALID_NS;
779 app_ns = app_namespace_get (*app_ns_index);
781 return VNET_API_ERROR_APP_INVALID_NS;
782 if (app_ns->ns_secret != secret)
783 return VNET_API_ERROR_APP_WRONG_NS_SECRET;
788 app_name_from_api_index (u32 api_client_index)
790 vl_api_registration_t *regp;
791 regp = vl_api_client_index_to_registration (api_client_index);
793 return format (0, "%s", regp->name);
795 clib_warning ("api client index %u does not have an api registration!",
797 return format (0, "unknown");
801 * Attach application to vpp
803 * Allocates a vpp app, i.e., a structure that keeps back pointers
804 * to external app and a segment manager for shared memory fifo based
805 * communication with the external app.
808 vnet_application_attach (vnet_app_attach_args_t * a)
811 application_t *app = 0;
812 app_worker_t *app_wrk;
813 segment_manager_t *sm;
814 u32 app_ns_index = 0;
819 if (a->api_client_index != APP_INVALID_INDEX)
820 app = application_lookup (a->api_client_index);
822 app = application_lookup_name (a->name);
824 return VNET_API_ERROR_INVALID_VALUE;
827 return VNET_API_ERROR_APP_ALREADY_ATTACHED;
829 if (a->api_client_index != APP_INVALID_INDEX)
831 app_name = app_name_from_api_index (a->api_client_index);
835 secret = a->options[APP_OPTIONS_NAMESPACE_SECRET];
836 if ((rv = app_validate_namespace (a->namespace_id, secret, &app_ns_index)))
838 a->options[APP_OPTIONS_NAMESPACE] = app_ns_index;
840 if ((rv = application_alloc_and_init ((app_init_args_t *) a)))
843 app = application_get (a->app_index);
844 if ((rv = application_alloc_worker_and_init (app, &app_wrk)))
847 a->app_evt_q = app_wrk->event_queue;
848 app_wrk->api_client_index = a->api_client_index;
849 sm = segment_manager_get (app_wrk->first_segment_manager);
850 fs = segment_manager_get_segment_w_lock (sm, 0);
852 if (application_is_proxy (app))
853 application_setup_proxy (app);
855 ASSERT (vec_len (fs->ssvm.name) <= 128);
856 a->segment = &fs->ssvm;
857 a->segment_handle = segment_manager_segment_handle (sm, fs);
859 segment_manager_segment_reader_unlock (sm);
865 * Detach application from vpp
868 vnet_application_detach (vnet_app_detach_args_t * a)
872 app = application_get_if_valid (a->app_index);
875 clib_warning ("app not attached");
876 return VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
879 app_interface_check_thread_and_barrier (vnet_application_detach, a);
880 application_detach_process (app, a->api_client_index);
886 session_endpoint_in_ns (session_endpoint_t * sep)
888 u8 is_lep = session_endpoint_is_local (sep);
889 if (!is_lep && sep->sw_if_index != ENDPOINT_INVALID_INDEX
890 && !ip_interface_has_address (sep->sw_if_index, &sep->ip, sep->is_ip4))
892 clib_warning ("sw_if_index %u not configured with ip %U",
893 sep->sw_if_index, format_ip46_address, &sep->ip,
897 return (is_lep || ip_is_local (sep->fib_index, &sep->ip, sep->is_ip4));
901 session_endpoint_update_for_app (session_endpoint_cfg_t * sep,
902 application_t * app, u8 is_connect)
904 app_namespace_t *app_ns;
905 u32 ns_index, fib_index;
907 ns_index = app->ns_index;
909 /* App is a transport proto, so fetch the calling app's ns */
910 if (app->flags & APP_OPTIONS_FLAGS_IS_TRANSPORT_APP)
911 ns_index = sep->ns_index;
913 app_ns = app_namespace_get (ns_index);
917 /* Ask transport and network to bind to/connect using local interface
918 * that "supports" app's namespace. This will fix our local connection
922 /* If in default namespace and user requested a fib index use it */
923 if (ns_index == 0 && sep->fib_index != ENDPOINT_INVALID_INDEX)
924 fib_index = sep->fib_index;
926 fib_index = sep->is_ip4 ? app_ns->ip4_fib_index : app_ns->ip6_fib_index;
927 sep->peer.fib_index = fib_index;
928 sep->fib_index = fib_index;
932 sep->sw_if_index = app_ns->sw_if_index;
936 if (app_ns->sw_if_index != APP_NAMESPACE_INVALID_INDEX
937 && sep->peer.sw_if_index != ENDPOINT_INVALID_INDEX
938 && sep->peer.sw_if_index != app_ns->sw_if_index)
939 clib_warning ("Local sw_if_index different from app ns sw_if_index");
941 sep->peer.sw_if_index = app_ns->sw_if_index;
946 vnet_listen (vnet_listen_args_t * a)
948 app_listener_t *app_listener;
949 app_worker_t *app_wrk;
953 app = application_get_if_valid (a->app_index);
955 return VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
957 app_wrk = application_get_worker (app, a->wrk_map_index);
959 return VNET_API_ERROR_INVALID_VALUE;
961 a->sep_ext.app_wrk_index = app_wrk->wrk_index;
963 session_endpoint_update_for_app (&a->sep_ext, app, 0 /* is_connect */ );
964 if (!session_endpoint_in_ns (&a->sep))
965 return VNET_API_ERROR_INVALID_VALUE_2;
968 * Check if we already have an app listener
970 app_listener = app_listener_lookup (app, &a->sep_ext);
973 if (app_listener->app_index != app->app_index)
974 return VNET_API_ERROR_ADDRESS_IN_USE;
975 if (app_worker_start_listen (app_wrk, app_listener))
977 a->handle = app_listener_handle (app_listener);
982 * Create new app listener
984 if ((rv = app_listener_alloc_and_init (app, &a->sep_ext, &app_listener)))
987 if ((rv = app_worker_start_listen (app_wrk, app_listener)))
989 app_listener_cleanup (app_listener);
993 a->handle = app_listener_handle (app_listener);
998 vnet_connect (vnet_connect_args_t * a)
1000 app_worker_t *client_wrk;
1001 application_t *client;
1003 if (session_endpoint_is_zero (&a->sep))
1004 return VNET_API_ERROR_INVALID_VALUE;
1006 client = application_get (a->app_index);
1007 session_endpoint_update_for_app (&a->sep_ext, client, 1 /* is_connect */ );
1008 client_wrk = application_get_worker (client, a->wrk_map_index);
1011 * First check the local scope for locally attached destinations.
1012 * If we have local scope, we pass *all* connects through it since we may
1013 * have special policy rules even for non-local destinations, think proxy.
1015 if (application_has_local_scope (client))
1019 a->sep_ext.original_tp = a->sep_ext.transport_proto;
1020 a->sep_ext.transport_proto = TRANSPORT_PROTO_NONE;
1021 rv = app_worker_connect_session (client_wrk, &a->sep, a->api_context);
1026 * Not connecting to a local server, propagate to transport
1028 if (app_worker_connect_session (client_wrk, &a->sep, a->api_context))
1029 return VNET_API_ERROR_SESSION_CONNECT;
1034 vnet_unlisten (vnet_unlisten_args_t * a)
1036 app_worker_t *app_wrk;
1040 if (!(app = application_get_if_valid (a->app_index)))
1041 return VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
1043 if (!(al = app_listener_get_w_handle (a->handle)))
1046 if (al->app_index != app->app_index)
1048 clib_warning ("app doesn't own handle %llu!", a->handle);
1052 app_wrk = application_get_worker (app, a->wrk_map_index);
1055 clib_warning ("no app %u worker %u", app->app_index, a->wrk_map_index);
1059 return app_worker_stop_listen (app_wrk, al);
1063 vnet_disconnect_session (vnet_disconnect_args_t * a)
1065 app_worker_t *app_wrk;
1068 s = session_get_from_handle_if_valid (a->handle);
1070 return VNET_API_ERROR_INVALID_VALUE;
1071 app_wrk = app_worker_get (s->app_wrk_index);
1072 if (app_wrk->app_index != a->app_index)
1073 return VNET_API_ERROR_INVALID_VALUE;
1075 /* We're peeking into another's thread pool. Make sure */
1076 ASSERT (s->session_index == session_index_from_handle (a->handle));
1083 application_change_listener_owner (session_t * s, app_worker_t * app_wrk)
1085 app_worker_t *old_wrk = app_worker_get (s->app_wrk_index);
1086 app_listener_t *app_listener;
1092 hash_unset (old_wrk->listeners_table, listen_session_get_handle (s));
1093 if (session_transport_service_type (s) == TRANSPORT_SERVICE_CL
1095 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1097 app = application_get (old_wrk->app_index);
1101 app_listener = app_listener_get (app, s->al_index);
1103 /* Only remove from lb for now */
1104 app_listener->workers = clib_bitmap_set (app_listener->workers,
1105 old_wrk->wrk_map_index, 0);
1107 if (app_worker_start_listen (app_wrk, app_listener))
1110 s->app_wrk_index = app_wrk->wrk_index;
1116 application_is_proxy (application_t * app)
1118 return (app->flags & APP_OPTIONS_FLAGS_IS_PROXY);
1122 application_is_builtin (application_t * app)
1124 return (app->flags & APP_OPTIONS_FLAGS_IS_BUILTIN);
1128 application_is_builtin_proxy (application_t * app)
1130 return (application_is_proxy (app) && application_is_builtin (app));
1134 application_has_local_scope (application_t * app)
1136 return app->flags & APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
1140 application_has_global_scope (application_t * app)
1142 return app->flags & APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
1145 static clib_error_t *
1146 application_start_stop_proxy_fib_proto (application_t * app, u8 fib_proto,
1147 u8 transport_proto, u8 is_start)
1149 app_namespace_t *app_ns = app_namespace_get (app->ns_index);
1150 u8 is_ip4 = (fib_proto == FIB_PROTOCOL_IP4);
1151 session_endpoint_cfg_t sep = SESSION_ENDPOINT_CFG_NULL;
1152 transport_connection_t *tc;
1153 app_worker_t *app_wrk;
1158 /* TODO decide if we want proxy to be enabled for all workers */
1159 app_wrk = application_get_default_worker (app);
1162 s = app_worker_first_listener (app_wrk, fib_proto, transport_proto);
1165 sep.is_ip4 = is_ip4;
1166 sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
1167 sep.sw_if_index = app_ns->sw_if_index;
1168 sep.transport_proto = transport_proto;
1169 sep.app_wrk_index = app_wrk->wrk_index; /* only default */
1171 /* force global scope listener */
1173 app->flags &= ~APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
1174 app_listener_alloc_and_init (app, &sep, &al);
1177 app_worker_start_listen (app_wrk, al);
1178 s = listen_session_get (al->session_index);
1179 s->flags |= SESSION_F_PROXY;
1184 s = app_worker_proxy_listener (app_wrk, fib_proto, transport_proto);
1188 tc = listen_session_get_transport (s);
1190 if (!ip_is_zero (&tc->lcl_ip, 1))
1193 sep.is_ip4 = is_ip4;
1194 sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
1195 sep.transport_proto = transport_proto;
1197 sti = session_lookup_get_index_for_fib (fib_proto, sep.fib_index);
1199 session_lookup_add_session_endpoint (sti,
1200 (session_endpoint_t *) & sep,
1203 session_lookup_del_session_endpoint (sti,
1204 (session_endpoint_t *) & sep);
1211 application_start_stop_proxy_local_scope (application_t * app,
1212 u8 transport_proto, u8 is_start)
1214 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
1215 app_namespace_t *app_ns;
1216 app_ns = app_namespace_get (app->ns_index);
1218 sep.transport_proto = transport_proto;
1223 session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
1226 session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
1231 session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
1233 session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
1238 application_start_stop_proxy (application_t * app,
1239 transport_proto_t transport_proto, u8 is_start)
1241 if (application_has_local_scope (app))
1242 application_start_stop_proxy_local_scope (app, transport_proto, is_start);
1244 if (application_has_global_scope (app))
1246 application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP4,
1247 transport_proto, is_start);
1248 application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP6,
1249 transport_proto, is_start);
1254 application_setup_proxy (application_t * app)
1256 u16 transports = app->proxied_transports;
1257 transport_proto_t tp;
1259 ASSERT (application_is_proxy (app));
1262 transport_proto_foreach (tp, ({
1263 if (transports & (1 << tp))
1264 application_start_stop_proxy (app, tp, 1);
1270 application_remove_proxy (application_t * app)
1272 u16 transports = app->proxied_transports;
1273 transport_proto_t tp;
1275 ASSERT (application_is_proxy (app));
1278 transport_proto_foreach (tp, ({
1279 if (transports & (1 << tp))
1280 application_start_stop_proxy (app, tp, 0);
1285 segment_manager_props_t *
1286 application_segment_manager_properties (application_t * app)
1288 return &app->sm_properties;
1291 segment_manager_props_t *
1292 application_get_segment_manager_properties (u32 app_index)
1294 application_t *app = application_get (app_index);
1295 return &app->sm_properties;
1299 vnet_app_add_tls_cert (vnet_app_add_tls_cert_args_t * a)
1302 app = application_get (a->app_index);
1304 return clib_error_return_code (0, VNET_API_ERROR_APPLICATION_NOT_ATTACHED,
1305 0, "app %u doesn't exist", a->app_index);
1306 app->tls_cert = vec_dup (a->cert);
1311 vnet_app_add_tls_key (vnet_app_add_tls_key_args_t * a)
1314 app = application_get (a->app_index);
1316 return clib_error_return_code (0, VNET_API_ERROR_APPLICATION_NOT_ATTACHED,
1317 0, "app %u doesn't exist", a->app_index);
1318 app->tls_key = vec_dup (a->key);
1323 application_format_listeners (application_t * app, int verbose)
1325 vlib_main_t *vm = vlib_get_main ();
1326 app_worker_map_t *wrk_map;
1327 app_worker_t *app_wrk;
1333 vlib_cli_output (vm, "%U", format_app_worker_listener, 0 /* header */ ,
1339 pool_foreach (wrk_map, app->worker_maps, ({
1340 app_wrk = app_worker_get (wrk_map->wrk_index);
1341 if (hash_elts (app_wrk->listeners_table) == 0)
1343 hash_foreach (handle, sm_index, app_wrk->listeners_table, ({
1344 vlib_cli_output (vm, "%U", format_app_worker_listener, app_wrk,
1345 handle, sm_index, verbose);
1352 application_format_connects (application_t * app, int verbose)
1354 app_worker_map_t *wrk_map;
1355 app_worker_t *app_wrk;
1359 app_worker_format_connects (0, verbose);
1364 pool_foreach (wrk_map, app->worker_maps, ({
1365 app_wrk = app_worker_get (wrk_map->wrk_index);
1366 app_worker_format_connects (app_wrk, verbose);
1372 format_application (u8 * s, va_list * args)
1374 application_t *app = va_arg (*args, application_t *);
1375 CLIB_UNUSED (int verbose) = va_arg (*args, int);
1376 segment_manager_props_t *props;
1377 const u8 *app_ns_name, *app_name;
1378 app_worker_map_t *wrk_map;
1379 app_worker_t *app_wrk;
1384 s = format (s, "%-10s%-20s%-40s", "Index", "Name", "Namespace");
1388 app_name = app_get_name (app);
1389 app_ns_name = app_namespace_id_from_index (app->ns_index);
1390 props = application_segment_manager_properties (app);
1393 s = format (s, "%-10u%-20v%-40s", app->app_index, app_name,
1398 s = format (s, "app-name %v app-index %u ns-index %u seg-size %U\n",
1399 app_name, app->app_index, app->ns_index,
1400 format_memory_size, props->add_segment_size);
1401 s = format (s, "rx-fifo-size %U tx-fifo-size %U workers:\n",
1402 format_memory_size, props->rx_fifo_size,
1403 format_memory_size, props->tx_fifo_size);
1406 pool_foreach (wrk_map, app->worker_maps, ({
1407 app_wrk = app_worker_get (wrk_map->wrk_index);
1408 s = format (s, "%U", format_app_worker, app_wrk);
1416 application_format_all_listeners (vlib_main_t * vm, int verbose)
1420 if (!pool_elts (app_main.app_pool))
1422 vlib_cli_output (vm, "No active server bindings");
1426 application_format_listeners (0, verbose);
1429 pool_foreach (app, app_main.app_pool, ({
1430 application_format_listeners (app, verbose);
1436 application_format_all_clients (vlib_main_t * vm, int verbose)
1440 if (!pool_elts (app_main.app_pool))
1442 vlib_cli_output (vm, "No active apps");
1446 application_format_connects (0, verbose);
1449 pool_foreach (app, app_main.app_pool, ({
1450 application_format_connects (app, verbose);
1455 static clib_error_t *
1456 show_app_command_fn (vlib_main_t * vm, unformat_input_t * input,
1457 vlib_cli_command_t * cmd)
1459 int do_server = 0, do_client = 0;
1464 session_cli_return_if_not_enabled ();
1466 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1468 if (unformat (input, "server"))
1470 else if (unformat (input, "client"))
1472 else if (unformat (input, "%u", &app_index))
1474 else if (unformat (input, "verbose"))
1477 return clib_error_return (0, "unknown input `%U'",
1478 format_unformat_error, input);
1483 application_format_all_listeners (vm, verbose);
1489 application_format_all_clients (vm, verbose);
1493 if (app_index != ~0)
1495 app = application_get_if_valid (app_index);
1497 return clib_error_return (0, "No app with index %u", app_index);
1499 vlib_cli_output (vm, "%U", format_application, app, /* verbose */ 1);
1503 /* Print app related info */
1504 if (!do_server && !do_client)
1506 vlib_cli_output (vm, "%U", format_application, 0, 0);
1508 pool_foreach (app, app_main.app_pool, ({
1509 vlib_cli_output (vm, "%U", format_application, app, 0);
1518 VLIB_CLI_COMMAND (show_app_command, static) =
1521 .short_help = "show app [server|client] [verbose]",
1522 .function = show_app_command_fn,
1527 * fd.io coding-style-patch-verification: ON
1530 * eval: (c-set-style "gnu")