2 * Copyright (c) 2017 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 #include <vnet/session/application.h>
17 #include <vnet/session/application_interface.h>
18 #include <vnet/session/application_namespace.h>
19 #include <vnet/session/session.h>
21 static app_main_t app_main;
23 static app_listener_t *
24 app_listener_alloc (application_t * app)
26 app_listener_t *app_listener;
27 pool_get (app->listeners, app_listener);
28 clib_memset (app_listener, 0, sizeof (*app_listener));
29 app_listener->al_index = app_listener - app->listeners;
33 static app_listener_t *
34 app_listener_get (application_t * app, u32 app_listener_index)
36 return pool_elt_at_index (app->listeners, app_listener_index);
40 app_listener_free (application_t * app, app_listener_t * app_listener)
42 clib_bitmap_free (app_listener->workers);
43 pool_put (app->listeners, app_listener);
45 clib_memset (app_listener, 0xfa, sizeof (*app_listener));
48 static app_listener_t *
49 app_local_listener_alloc (application_t * app)
51 app_listener_t *app_listener;
52 pool_get (app->local_listeners, app_listener);
53 clib_memset (app_listener, 0, sizeof (*app_listener));
54 app_listener->al_index = app_listener - app->local_listeners;
58 static app_listener_t *
59 app_local_listener_get (application_t * app, u32 app_listener_index)
61 return pool_elt_at_index (app->local_listeners, app_listener_index);
65 app_local_listener_free (application_t * app, app_listener_t * app_listener)
67 clib_bitmap_free (app_listener->workers);
68 pool_put (app->local_listeners, app_listener);
70 clib_memset (app_listener, 0xfa, sizeof (*app_listener));
73 static app_worker_map_t *
74 app_worker_map_alloc (application_t * app)
76 app_worker_map_t *map;
77 pool_get (app->worker_maps, map);
78 clib_memset (map, 0, sizeof (*map));
83 app_worker_map_index (application_t * app, app_worker_map_t * map)
85 return (map - app->worker_maps);
89 app_worker_map_free (application_t * app, app_worker_map_t * map)
91 pool_put (app->worker_maps, map);
94 static app_worker_map_t *
95 app_worker_map_get (application_t * app, u32 map_index)
97 return pool_elt_at_index (app->worker_maps, map_index);
101 app_get_name_from_reg_index (application_t * app)
105 vl_api_registration_t *regp;
106 regp = vl_api_client_index_to_registration (app->api_client_index);
108 app_name = format (0, "builtin-%d%c", app->app_index, 0);
110 app_name = format (0, "%s%c", regp->name, 0);
116 app_get_name (application_t * app)
119 return app_get_name_from_reg_index (app);
124 application_session_table (application_t * app, u8 fib_proto)
126 app_namespace_t *app_ns;
127 app_ns = app_namespace_get (app->ns_index);
128 if (!application_has_global_scope (app))
129 return APP_INVALID_INDEX;
130 if (fib_proto == FIB_PROTOCOL_IP4)
131 return session_lookup_get_index_for_fib (fib_proto,
132 app_ns->ip4_fib_index);
134 return session_lookup_get_index_for_fib (fib_proto,
135 app_ns->ip6_fib_index);
139 application_local_session_table (application_t * app)
141 app_namespace_t *app_ns;
142 if (!application_has_local_scope (app))
143 return APP_INVALID_INDEX;
144 app_ns = app_namespace_get (app->ns_index);
145 return app_ns->local_table_index;
149 application_local_listener_session_endpoint (local_session_t * ll,
150 session_endpoint_t * sep)
152 sep->transport_proto =
153 session_type_transport_proto (ll->listener_session_type);
154 sep->port = ll->port;
155 sep->is_ip4 = ll->listener_session_type & 1;
159 application_api_queue_is_full (application_t * app)
163 /* builtin servers are always OK */
164 if (app->api_client_index == ~0)
167 q = vl_api_client_index_to_input_queue (app->api_client_index);
171 if (q->cursize == q->maxsize)
179 * Since the name is not stored per app, we generate it on the fly. It is
180 * the caller's responsibility to free the vector
183 application_name_from_index (u32 app_index)
185 application_t *app = application_get (app_index);
188 return app_get_name_from_reg_index (app);
192 application_table_add (application_t * app)
194 if (app->api_client_index != APP_INVALID_INDEX)
195 hash_set (app_main.app_by_api_client_index, app->api_client_index,
198 hash_set_mem (app_main.app_by_name, app->name, app->app_index);
202 application_table_del (application_t * app)
204 if (app->api_client_index != APP_INVALID_INDEX)
205 hash_unset (app_main.app_by_api_client_index, app->api_client_index);
207 hash_unset_mem (app_main.app_by_name, app->name);
211 application_lookup (u32 api_client_index)
214 p = hash_get (app_main.app_by_api_client_index, api_client_index);
216 return application_get (p[0]);
222 application_lookup_name (const u8 * name)
225 p = hash_get_mem (app_main.app_by_name, name);
227 return application_get (p[0]);
233 application_alloc (void)
236 pool_get (app_main.app_pool, app);
237 clib_memset (app, 0, sizeof (*app));
238 app->app_index = app - app_main.app_pool;
243 application_get (u32 app_index)
245 if (app_index == APP_INVALID_INDEX)
247 return pool_elt_at_index (app_main.app_pool, app_index);
251 application_get_if_valid (u32 app_index)
253 if (pool_is_free_index (app_main.app_pool, app_index))
256 return pool_elt_at_index (app_main.app_pool, app_index);
260 application_index (application_t * app)
262 return app - app_main.app_pool;
266 application_verify_cb_fns (session_cb_vft_t * cb_fns)
268 if (cb_fns->session_accept_callback == 0)
269 clib_warning ("No accept callback function provided");
270 if (cb_fns->session_connected_callback == 0)
271 clib_warning ("No session connected callback function provided");
272 if (cb_fns->session_disconnect_callback == 0)
273 clib_warning ("No session disconnect callback function provided");
274 if (cb_fns->session_reset_callback == 0)
275 clib_warning ("No session reset callback function provided");
279 * Check app config for given segment type
281 * Returns 1 on success and 0 otherwise
284 application_verify_cfg (ssvm_segment_type_t st)
287 if (st == SSVM_SEGMENT_MEMFD)
289 is_valid = (session_manager_get_evt_q_segment () != 0);
291 clib_warning ("memfd seg: vpp's event qs IN binary api svm region");
294 else if (st == SSVM_SEGMENT_SHM)
296 is_valid = (session_manager_get_evt_q_segment () == 0);
298 clib_warning ("shm seg: vpp's event qs NOT IN binary api svm region");
306 application_alloc_and_init (app_init_args_t * a)
308 ssvm_segment_type_t seg_type = SSVM_SEGMENT_MEMFD;
309 segment_manager_properties_t *props;
310 vl_api_registration_t *reg;
314 app = application_alloc ();
315 options = a->options;
317 * Make sure we support the requested configuration
319 if (!(options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_IS_BUILTIN))
321 reg = vl_api_client_index_to_registration (a->api_client_index);
323 return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
324 if (vl_api_registration_file_index (reg) == VL_API_INVALID_FI)
325 seg_type = SSVM_SEGMENT_SHM;
329 if (options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
331 clib_warning ("mq eventfds can only be used if socket transport is "
333 return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
335 seg_type = SSVM_SEGMENT_PRIVATE;
338 if (!application_verify_cfg (seg_type))
339 return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
341 /* Check that the obvious things are properly set up */
342 application_verify_cb_fns (a->session_cb_vft);
344 app->api_client_index = a->api_client_index;
345 app->flags = options[APP_OPTIONS_FLAGS];
346 app->cb_fns = *a->session_cb_vft;
347 app->ns_index = options[APP_OPTIONS_NAMESPACE];
348 app->proxied_transports = options[APP_OPTIONS_PROXY_TRANSPORT];
349 app->name = vec_dup (a->name);
351 /* If no scope enabled, default to global */
352 if (!application_has_global_scope (app)
353 && !application_has_local_scope (app))
354 app->flags |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
356 props = application_segment_manager_properties (app);
357 segment_manager_properties_init (props);
358 props->segment_size = options[APP_OPTIONS_ADD_SEGMENT_SIZE];
359 props->prealloc_fifos = options[APP_OPTIONS_PREALLOC_FIFO_PAIRS];
360 if (options[APP_OPTIONS_ADD_SEGMENT_SIZE])
362 props->add_segment_size = options[APP_OPTIONS_ADD_SEGMENT_SIZE];
363 props->add_segment = 1;
365 if (options[APP_OPTIONS_RX_FIFO_SIZE])
366 props->rx_fifo_size = options[APP_OPTIONS_RX_FIFO_SIZE];
367 if (options[APP_OPTIONS_TX_FIFO_SIZE])
368 props->tx_fifo_size = options[APP_OPTIONS_TX_FIFO_SIZE];
369 if (options[APP_OPTIONS_EVT_QUEUE_SIZE])
370 props->evt_q_size = options[APP_OPTIONS_EVT_QUEUE_SIZE];
371 if (options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
372 props->use_mq_eventfd = 1;
373 if (options[APP_OPTIONS_TLS_ENGINE])
374 app->tls_engine = options[APP_OPTIONS_TLS_ENGINE];
375 props->segment_type = seg_type;
377 /* Add app to lookup by api_client_index table */
378 application_table_add (app);
379 a->app_index = application_index (app);
381 APP_DBG ("New app name: %v api index: %u index %u", app->name,
382 app->api_client_index, app->app_index);
388 application_free (application_t * app)
390 app_worker_map_t *wrk_map;
391 app_worker_t *app_wrk;
394 session_endpoint_t sep;
397 * The app event queue allocated in first segment is cleared with
398 * the segment manager. No need to explicitly free it.
400 APP_DBG ("Delete app name %v api index: %d index: %d", app->name,
401 app->api_client_index, app->app_index);
403 if (application_is_proxy (app))
404 application_remove_proxy (app);
411 pool_flush (wrk_map, app->worker_maps, ({
412 app_wrk = app_worker_get (wrk_map->wrk_index);
413 app_worker_free (app_wrk);
416 pool_free (app->worker_maps);
419 * Free local listeners. Global table unbinds stop local listeners
420 * as well, but if we have only local binds, these won't be cleaned up.
421 * Don't bother with local accepted sessions, we clean them when
422 * cleaning up the worker.
424 table_index = application_local_session_table (app);
426 pool_foreach (ll, app->local_listen_sessions, ({
427 application_local_listener_session_endpoint (ll, &sep);
428 session_lookup_del_session_endpoint (table_index, &sep);
431 pool_free (app->local_listen_sessions);
434 * Cleanup remaining state
436 application_table_del (app);
437 vec_free (app->name);
438 vec_free (app->tls_cert);
439 vec_free (app->tls_key);
440 pool_put (app_main.app_pool, app);
444 application_get_worker (application_t * app, u32 wrk_map_index)
446 app_worker_map_t *map;
447 map = app_worker_map_get (app, wrk_map_index);
450 return app_worker_get (map->wrk_index);
454 application_get_default_worker (application_t * app)
456 return application_get_worker (app, 0);
460 application_listener_select_worker (stream_session_t * ls, u8 is_local)
462 app_listener_t *app_listener;
466 app = application_get (ls->app_index);
468 app_listener = app_listener_get (app, ls->listener_db_index);
470 app_listener = app_local_listener_get (app, ls->listener_db_index);
472 wrk_index = clib_bitmap_next_set (app_listener->workers,
473 app_listener->accept_rotor + 1);
475 wrk_index = clib_bitmap_first_set (app_listener->workers);
477 ASSERT (wrk_index != ~0);
478 app_listener->accept_rotor = wrk_index;
479 return application_get_worker (app, wrk_index);
483 app_worker_alloc (application_t * app)
485 app_worker_t *app_wrk;
486 pool_get (app_main.workers, app_wrk);
487 clib_memset (app_wrk, 0, sizeof (*app_wrk));
488 app_wrk->wrk_index = app_wrk - app_main.workers;
489 app_wrk->app_index = app->app_index;
490 app_wrk->wrk_map_index = ~0;
491 app_wrk->connects_seg_manager = APP_INVALID_SEGMENT_MANAGER_INDEX;
492 app_wrk->first_segment_manager = APP_INVALID_SEGMENT_MANAGER_INDEX;
493 app_wrk->local_segment_manager = APP_INVALID_SEGMENT_MANAGER_INDEX;
494 APP_DBG ("New app %v worker %u", app_get_name (app), app_wrk->wrk_index);
499 app_worker_get (u32 wrk_index)
501 return pool_elt_at_index (app_main.workers, wrk_index);
505 app_worker_get_if_valid (u32 wrk_index)
507 if (pool_is_free_index (app_main.workers, wrk_index))
509 return pool_elt_at_index (app_main.workers, wrk_index);
513 app_worker_free (app_worker_t * app_wrk)
515 application_t *app = application_get (app_wrk->app_index);
516 vnet_unbind_args_t _a, *a = &_a;
517 u64 handle, *handles = 0;
518 segment_manager_t *sm;
527 hash_foreach (handle, sm_index, app_wrk->listeners_table,
529 vec_add1 (handles, handle);
530 sm = segment_manager_get (sm_index);
531 sm->app_wrk_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
535 for (i = 0; i < vec_len (handles); i++)
537 a->app_index = app->app_index;
538 a->wrk_map_index = app_wrk->wrk_map_index;
539 a->handle = handles[i];
540 /* seg manager is removed when unbind completes */
545 * Connects segment manager cleanup
548 if (app_wrk->connects_seg_manager != APP_INVALID_SEGMENT_MANAGER_INDEX)
550 sm = segment_manager_get (app_wrk->connects_seg_manager);
551 sm->app_wrk_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
552 segment_manager_init_del (sm);
555 /* If first segment manager is used by a listener */
556 if (app_wrk->first_segment_manager != APP_INVALID_SEGMENT_MANAGER_INDEX
557 && app_wrk->first_segment_manager != app_wrk->connects_seg_manager)
559 sm = segment_manager_get (app_wrk->first_segment_manager);
560 sm->first_is_protected = 0;
561 sm->app_wrk_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
562 /* .. and has no fifos, e.g. it might be used for redirected sessions,
564 if (!segment_manager_has_fifos (sm))
565 segment_manager_del (sm);
571 app_worker_local_sessions_free (app_wrk);
573 pool_put (app_main.workers, app_wrk);
575 clib_memset (app_wrk, 0xfe, sizeof (*app_wrk));
579 app_worker_alloc_and_init (application_t * app, app_worker_t ** wrk)
581 app_worker_map_t *wrk_map;
582 app_worker_t *app_wrk;
583 segment_manager_t *sm;
586 app_wrk = app_worker_alloc (app);
587 wrk_map = app_worker_map_alloc (app);
588 wrk_map->wrk_index = app_wrk->wrk_index;
589 app_wrk->wrk_map_index = app_worker_map_index (app, wrk_map);
592 * Setup first segment manager
594 sm = segment_manager_new ();
595 sm->app_wrk_index = app_wrk->wrk_index;
597 if ((rv = segment_manager_init (sm, app->sm_properties.segment_size,
598 app->sm_properties.prealloc_fifos)))
600 app_worker_free (app_wrk);
603 sm->first_is_protected = 1;
608 app_wrk->first_segment_manager = segment_manager_index (sm);
609 app_wrk->listeners_table = hash_create (0, sizeof (u64));
610 app_wrk->event_queue = segment_manager_event_queue (sm);
611 app_wrk->app_is_builtin = application_is_builtin (app);
614 * Segment manager for local sessions
616 sm = segment_manager_new ();
617 sm->app_wrk_index = app_wrk->wrk_index;
618 app_wrk->local_segment_manager = segment_manager_index (sm);
619 app_wrk->local_connects = hash_create (0, sizeof (u64));
627 app_worker_get_app (u32 wrk_index)
629 app_worker_t *app_wrk;
630 app_wrk = app_worker_get_if_valid (wrk_index);
633 return application_get_if_valid (app_wrk->app_index);
636 static segment_manager_t *
637 app_worker_alloc_segment_manager (app_worker_t * app_wrk)
639 segment_manager_t *sm = 0;
641 /* If the first segment manager is not in use, don't allocate a new one */
642 if (app_wrk->first_segment_manager != APP_INVALID_SEGMENT_MANAGER_INDEX
643 && app_wrk->first_segment_manager_in_use == 0)
645 sm = segment_manager_get (app_wrk->first_segment_manager);
646 app_wrk->first_segment_manager_in_use = 1;
650 sm = segment_manager_new ();
651 sm->app_wrk_index = app_wrk->wrk_index;
657 app_worker_start_listen (app_worker_t * app_wrk, stream_session_t * ls)
659 segment_manager_t *sm;
661 /* Allocate segment manager. All sessions derived out of a listen session
662 * have fifos allocated by the same segment manager. */
663 if (!(sm = app_worker_alloc_segment_manager (app_wrk)))
666 /* Add to app's listener table. Useful to find all child listeners
667 * when app goes down, although, just for unbinding this is not needed */
668 hash_set (app_wrk->listeners_table, listen_session_get_handle (ls),
669 segment_manager_index (sm));
671 if (!ls->server_rx_fifo
672 && session_transport_service_type (ls) == TRANSPORT_SERVICE_CL)
674 if (session_alloc_fifos (sm, ls))
681 app_worker_stop_listen (app_worker_t * app_wrk, session_handle_t handle)
683 segment_manager_t *sm;
686 sm_indexp = hash_get (app_wrk->listeners_table, handle);
687 if (PREDICT_FALSE (!sm_indexp))
689 clib_warning ("listener handle was removed %llu!", handle);
693 sm = segment_manager_get (*sm_indexp);
694 if (app_wrk->first_segment_manager == *sm_indexp)
696 /* Delete sessions but don't remove segment manager */
697 app_wrk->first_segment_manager_in_use = 0;
698 segment_manager_del_sessions (sm);
702 segment_manager_init_del (sm);
704 hash_unset (app_wrk->listeners_table, handle);
710 * Start listening local transport endpoint for requested transport.
712 * Creates a 'dummy' stream session with state LISTENING to be used in session
713 * lookups, prior to establishing connection. Requests transport to build
714 * it's own specific listening connection.
717 application_start_listen (application_t * app,
718 session_endpoint_cfg_t * sep_ext,
719 session_handle_t * res)
721 app_listener_t *app_listener;
722 u32 table_index, fib_proto;
723 session_endpoint_t *sep;
724 app_worker_t *app_wrk;
725 stream_session_t *ls;
730 * Check if sep is already listened on
732 sep = (session_endpoint_t *) sep_ext;
733 fib_proto = session_endpoint_fib_proto (sep);
734 table_index = application_session_table (app, fib_proto);
735 lh = session_lookup_endpoint_listener (table_index, sep, 1);
736 if (lh != SESSION_INVALID_HANDLE)
738 ls = listen_session_get_from_handle (lh);
739 if (ls->app_index != app->app_index)
740 return VNET_API_ERROR_ADDRESS_IN_USE;
742 app_wrk = app_worker_get (sep_ext->app_wrk_index);
743 if (ls->app_wrk_index == app_wrk->wrk_index)
744 return VNET_API_ERROR_ADDRESS_IN_USE;
746 if (app_worker_start_listen (app_wrk, ls))
749 app_listener = app_listener_get (app, ls->listener_db_index);
750 app_listener->workers = clib_bitmap_set (app_listener->workers,
751 app_wrk->wrk_map_index, 1);
753 *res = listen_session_get_handle (ls);
758 * Allocate new listener for application
760 sst = session_type_from_proto_and_ip (sep_ext->transport_proto,
762 ls = listen_session_new (0, sst);
763 ls->app_index = app->app_index;
764 lh = listen_session_get_handle (ls);
765 if (session_listen (ls, sep_ext))
769 ls = listen_session_get_from_handle (lh);
770 app_listener = app_listener_alloc (app);
771 ls->listener_db_index = app_listener->al_index;
774 * Setup app worker as a listener
776 app_wrk = app_worker_get (sep_ext->app_wrk_index);
777 ls->app_wrk_index = app_wrk->wrk_index;
778 if (app_worker_start_listen (app_wrk, ls))
780 app_listener->workers = clib_bitmap_set (app_listener->workers,
781 app_wrk->wrk_map_index, 1);
787 listen_session_del (ls);
792 * Stop listening on session associated to handle
794 * @param handle listener handle
795 * @param app_index index of the app owning the handle.
796 * @param app_wrk_index index of the worker requesting the stop
799 application_stop_listen (u32 app_index, u32 app_wrk_index,
800 session_handle_t handle)
802 app_listener_t *app_listener;
803 stream_session_t *listener;
804 app_worker_t *app_wrk;
807 listener = listen_session_get_from_handle (handle);
808 app = application_get (app_index);
809 if (PREDICT_FALSE (!app || app->app_index != listener->app_index))
811 clib_warning ("app doesn't own handle %llu!", handle);
815 app_listener = app_listener_get (app, listener->listener_db_index);
816 if (!clib_bitmap_get (app_listener->workers, app_wrk_index))
818 clib_warning ("worker not listening on handle %lu", handle);
822 app_wrk = application_get_worker (app, app_wrk_index);
823 app_worker_stop_listen (app_wrk, handle);
824 clib_bitmap_set_no_check (app_listener->workers, app_wrk_index, 0);
826 if (clib_bitmap_is_zero (app_listener->workers))
828 session_stop_listen (listener);
829 app_listener_free (app, app_listener);
830 listen_session_del (listener);
837 app_worker_open_session (app_worker_t * app, session_endpoint_t * sep,
842 /* Make sure we have a segment manager for connects */
843 app_worker_alloc_connects_segment_manager (app);
845 if ((rv = session_open (app->wrk_index, sep, api_context)))
852 app_worker_alloc_connects_segment_manager (app_worker_t * app_wrk)
854 segment_manager_t *sm;
856 if (app_wrk->connects_seg_manager == APP_INVALID_SEGMENT_MANAGER_INDEX)
858 sm = app_worker_alloc_segment_manager (app_wrk);
861 app_wrk->connects_seg_manager = segment_manager_index (sm);
867 app_worker_get_connect_segment_manager (app_worker_t * app)
869 ASSERT (app->connects_seg_manager != (u32) ~ 0);
870 return segment_manager_get (app->connects_seg_manager);
874 app_worker_get_listen_segment_manager (app_worker_t * app,
875 stream_session_t * listener)
878 smp = hash_get (app->listeners_table, listen_session_get_handle (listener));
880 return segment_manager_get (*smp);
884 vnet_app_worker_add_del (vnet_app_worker_add_del_args_t * a)
886 svm_fifo_segment_private_t *fs;
887 app_worker_map_t *wrk_map;
888 app_worker_t *app_wrk;
889 segment_manager_t *sm;
893 app = application_get (a->app_index);
895 return clib_error_return_code (0, VNET_API_ERROR_INVALID_VALUE, 0,
896 "App %u does not exist", a->app_index);
900 if ((rv = app_worker_alloc_and_init (app, &app_wrk)))
901 return clib_error_return_code (0, rv, 0, "app wrk init: %d", rv);
902 sm = segment_manager_get (app_wrk->first_segment_manager);
903 fs = segment_manager_get_segment_w_lock (sm, 0);
904 a->segment = &fs->ssvm;
905 segment_manager_segment_reader_unlock (sm);
906 a->evt_q = app_wrk->event_queue;
907 a->wrk_index = app_wrk->wrk_map_index;
911 wrk_map = app_worker_map_get (app, a->wrk_index);
913 return clib_error_return_code (0, VNET_API_ERROR_INVALID_VALUE, 0,
914 "App %u does not have worker %u",
915 app->app_index, a->wrk_index);
916 app_wrk = app_worker_get (wrk_map->wrk_index);
917 app_worker_map_free (app, wrk_map);
919 return clib_error_return_code (0, VNET_API_ERROR_INVALID_VALUE, 0,
920 "No worker %u", a->wrk_index);
921 app_worker_free (app_wrk);
927 application_get_local_segment_manager (app_worker_t * app)
929 return segment_manager_get (app->local_segment_manager);
933 application_get_local_segment_manager_w_session (app_worker_t * app,
934 local_session_t * ls)
936 stream_session_t *listener;
937 if (application_local_session_listener_has_transport (ls))
939 listener = listen_session_get (ls->listener_index);
940 return app_worker_get_listen_segment_manager (app, listener);
942 return segment_manager_get (app->local_segment_manager);
946 application_is_proxy (application_t * app)
948 return (app->flags & APP_OPTIONS_FLAGS_IS_PROXY);
952 application_is_builtin (application_t * app)
954 return (app->flags & APP_OPTIONS_FLAGS_IS_BUILTIN);
958 application_is_builtin_proxy (application_t * app)
960 return (application_is_proxy (app) && application_is_builtin (app));
964 application_has_local_scope (application_t * app)
966 return app->flags & APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
970 application_has_global_scope (application_t * app)
972 return app->flags & APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
976 application_use_mq_for_ctrl (application_t * app)
978 return app->flags & APP_OPTIONS_FLAGS_USE_MQ_FOR_CTRL_MSGS;
982 * Send an API message to the external app, to map new segment
985 app_worker_add_segment_notify (u32 app_wrk_index, ssvm_private_t * fs)
987 app_worker_t *app_wrk = app_worker_get (app_wrk_index);
988 application_t *app = application_get (app_wrk->app_index);
989 return app->cb_fns.add_segment_callback (app->api_client_index, fs);
993 application_n_listeners (app_worker_t * app)
995 return hash_elts (app->listeners_table);
999 app_worker_first_listener (app_worker_t * app, u8 fib_proto,
1002 stream_session_t *listener;
1007 sst = session_type_from_proto_and_ip (transport_proto,
1008 fib_proto == FIB_PROTOCOL_IP4);
1011 hash_foreach (handle, sm_index, app->listeners_table, ({
1012 listener = listen_session_get_from_handle (handle);
1013 if (listener->session_type == sst
1014 && listener->enqueue_epoch != SESSION_PROXY_LISTENER_INDEX)
1023 app_worker_application_is_builtin (app_worker_t * app_wrk)
1025 return app_wrk->app_is_builtin;
1029 application_proxy_listener (app_worker_t * app, u8 fib_proto,
1032 stream_session_t *listener;
1037 sst = session_type_from_proto_and_ip (transport_proto,
1038 fib_proto == FIB_PROTOCOL_IP4);
1041 hash_foreach (handle, sm_index, app->listeners_table, ({
1042 listener = listen_session_get_from_handle (handle);
1043 if (listener->session_type == sst
1044 && listener->enqueue_epoch == SESSION_PROXY_LISTENER_INDEX)
1052 static clib_error_t *
1053 application_start_stop_proxy_fib_proto (application_t * app, u8 fib_proto,
1054 u8 transport_proto, u8 is_start)
1056 app_namespace_t *app_ns = app_namespace_get (app->ns_index);
1057 u8 is_ip4 = (fib_proto == FIB_PROTOCOL_IP4);
1058 session_endpoint_cfg_t sep = SESSION_ENDPOINT_CFG_NULL;
1059 transport_connection_t *tc;
1060 app_worker_t *app_wrk;
1061 stream_session_t *s;
1064 /* TODO decide if we want proxy to be enabled for all workers */
1065 app_wrk = application_get_default_worker (app);
1068 s = app_worker_first_listener (app_wrk, fib_proto, transport_proto);
1071 sep.is_ip4 = is_ip4;
1072 sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
1073 sep.sw_if_index = app_ns->sw_if_index;
1074 sep.transport_proto = transport_proto;
1075 sep.app_wrk_index = app_wrk->wrk_index; /* only default */
1076 application_start_listen (app, &sep, &handle);
1077 s = listen_session_get_from_handle (handle);
1078 s->enqueue_epoch = SESSION_PROXY_LISTENER_INDEX;
1083 s = application_proxy_listener (app_wrk, fib_proto, transport_proto);
1087 tc = listen_session_get_transport (s);
1089 if (!ip_is_zero (&tc->lcl_ip, 1))
1092 sep.is_ip4 = is_ip4;
1093 sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
1094 sep.transport_proto = transport_proto;
1096 sti = session_lookup_get_index_for_fib (fib_proto, sep.fib_index);
1098 session_lookup_add_session_endpoint (sti,
1099 (session_endpoint_t *) & sep,
1102 session_lookup_del_session_endpoint (sti,
1103 (session_endpoint_t *) & sep);
1110 application_start_stop_proxy_local_scope (application_t * app,
1111 u8 transport_proto, u8 is_start)
1113 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
1114 app_namespace_t *app_ns;
1115 app_ns = app_namespace_get (app->ns_index);
1117 sep.transport_proto = transport_proto;
1122 session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
1125 session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
1130 session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
1132 session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
1137 application_start_stop_proxy (application_t * app,
1138 transport_proto_t transport_proto, u8 is_start)
1140 if (application_has_local_scope (app))
1141 application_start_stop_proxy_local_scope (app, transport_proto, is_start);
1143 if (application_has_global_scope (app))
1145 application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP4,
1146 transport_proto, is_start);
1147 application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP6,
1148 transport_proto, is_start);
1153 application_setup_proxy (application_t * app)
1155 u16 transports = app->proxied_transports;
1156 transport_proto_t tp;
1158 ASSERT (application_is_proxy (app));
1161 transport_proto_foreach (tp, ({
1162 if (transports & (1 << tp))
1163 application_start_stop_proxy (app, tp, 1);
1169 application_remove_proxy (application_t * app)
1171 u16 transports = app->proxied_transports;
1172 transport_proto_t tp;
1174 ASSERT (application_is_proxy (app));
1177 transport_proto_foreach (tp, ({
1178 if (transports & (1 << tp))
1179 application_start_stop_proxy (app, tp, 0);
1184 segment_manager_properties_t *
1185 application_segment_manager_properties (application_t * app)
1187 return &app->sm_properties;
1190 segment_manager_properties_t *
1191 application_get_segment_manager_properties (u32 app_index)
1193 application_t *app = application_get (app_index);
1194 return &app->sm_properties;
1198 app_enqueue_evt (svm_msg_q_t * mq, svm_msg_q_msg_t * msg, u8 lock)
1200 if (PREDICT_FALSE (svm_msg_q_is_full (mq)))
1202 clib_warning ("evt q full");
1203 svm_msg_q_free_msg (mq, msg);
1205 svm_msg_q_unlock (mq);
1211 svm_msg_q_add_and_unlock (mq, msg);
1215 /* Even when not locking the ring, we must wait for queue mutex */
1216 if (svm_msg_q_add (mq, msg, SVM_Q_WAIT))
1218 clib_warning ("msg q add returned");
1225 app_send_io_evt_rx (app_worker_t * app_wrk, stream_session_t * s, u8 lock)
1227 session_event_t *evt;
1228 svm_msg_q_msg_t msg;
1231 if (PREDICT_FALSE (s->session_state != SESSION_STATE_READY
1232 && s->session_state != SESSION_STATE_LISTENING))
1234 /* Session is closed so app will never clean up. Flush rx fifo */
1235 if (s->session_state == SESSION_STATE_CLOSED)
1236 svm_fifo_dequeue_drop_all (s->server_rx_fifo);
1240 if (app_worker_application_is_builtin (app_wrk))
1242 application_t *app = application_get (app_wrk->app_index);
1243 return app->cb_fns.builtin_app_rx_callback (s);
1246 if (svm_fifo_has_event (s->server_rx_fifo)
1247 || svm_fifo_is_empty (s->server_rx_fifo))
1250 mq = app_wrk->event_queue;
1252 svm_msg_q_lock (mq);
1254 if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
1256 clib_warning ("evt q rings full");
1258 svm_msg_q_unlock (mq);
1262 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
1263 ASSERT (!svm_msg_q_msg_is_invalid (&msg));
1265 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
1266 evt->fifo = s->server_rx_fifo;
1267 evt->event_type = FIFO_EVENT_APP_RX;
1269 (void) svm_fifo_set_event (s->server_rx_fifo);
1271 if (app_enqueue_evt (mq, &msg, lock))
1277 app_send_io_evt_tx (app_worker_t * app_wrk, stream_session_t * s, u8 lock)
1280 session_event_t *evt;
1281 svm_msg_q_msg_t msg;
1283 if (app_worker_application_is_builtin (app_wrk))
1286 mq = app_wrk->event_queue;
1288 svm_msg_q_lock (mq);
1290 if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
1292 clib_warning ("evt q rings full");
1294 svm_msg_q_unlock (mq);
1298 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
1299 ASSERT (!svm_msg_q_msg_is_invalid (&msg));
1301 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
1302 evt->event_type = FIFO_EVENT_APP_TX;
1303 evt->fifo = s->server_tx_fifo;
1305 return app_enqueue_evt (mq, &msg, lock);
1309 typedef int (app_send_evt_handler_fn) (app_worker_t *app,
1310 stream_session_t *s,
1312 static app_send_evt_handler_fn * const app_send_evt_handler_fns[3] = {
1320 * Send event to application
1322 * Logic from queue perspective is non-blocking. If there's
1323 * not enough space to enqueue a message, we return.
1326 app_worker_send_event (app_worker_t * app, stream_session_t * s, u8 evt_type)
1328 ASSERT (app && evt_type <= FIFO_EVENT_APP_TX);
1329 return app_send_evt_handler_fns[evt_type] (app, s, 0 /* lock */ );
1333 * Send event to application
1335 * Logic from queue perspective is blocking. However, if queue is full,
1339 app_worker_lock_and_send_event (app_worker_t * app, stream_session_t * s,
1342 return app_send_evt_handler_fns[evt_type] (app, s, 1 /* lock */ );
1346 application_local_session_alloc (app_worker_t * app_wrk)
1349 pool_get (app_wrk->local_sessions, s);
1350 clib_memset (s, 0, sizeof (*s));
1351 s->app_wrk_index = app_wrk->wrk_index;
1352 s->session_index = s - app_wrk->local_sessions;
1353 s->session_type = session_type_from_proto_and_ip (TRANSPORT_PROTO_NONE, 0);
1358 application_local_session_free (app_worker_t * app, local_session_t * s)
1360 pool_put (app->local_sessions, s);
1362 clib_memset (s, 0xfc, sizeof (*s));
1366 application_get_local_session (app_worker_t * app_wrk, u32 session_index)
1368 if (pool_is_free_index (app_wrk->local_sessions, session_index))
1370 return pool_elt_at_index (app_wrk->local_sessions, session_index);
1374 application_get_local_session_from_handle (session_handle_t handle)
1376 app_worker_t *server_wrk;
1377 u32 session_index, server_wrk_index;
1378 local_session_parse_handle (handle, &server_wrk_index, &session_index);
1379 server_wrk = app_worker_get_if_valid (server_wrk_index);
1382 return application_get_local_session (server_wrk, session_index);
1386 application_local_listen_session_alloc (application_t * app)
1388 local_session_t *ll;
1389 pool_get (app->local_listen_sessions, ll);
1390 clib_memset (ll, 0, sizeof (*ll));
1395 application_local_listener_index (application_t * app, local_session_t * ll)
1397 return (ll - app->local_listen_sessions);
1401 application_local_listen_session_free (application_t * app,
1402 local_session_t * ll)
1404 pool_put (app->local_listen_sessions, ll);
1406 clib_memset (ll, 0xfb, sizeof (*ll));
1410 application_start_local_listen (application_t * app,
1411 session_endpoint_cfg_t * sep_ext,
1412 session_handle_t * handle)
1414 app_listener_t *app_listener;
1415 session_endpoint_t *sep;
1416 app_worker_t *app_wrk;
1417 session_handle_t lh;
1418 local_session_t *ll;
1421 sep = (session_endpoint_t *) sep_ext;
1422 table_index = application_local_session_table (app);
1423 app_wrk = app_worker_get (sep_ext->app_wrk_index);
1425 /* An exact sep match, as opposed to session_lookup_local_listener */
1426 lh = session_lookup_endpoint_listener (table_index, sep, 1);
1427 if (lh != SESSION_INVALID_HANDLE)
1429 ll = application_get_local_listener_w_handle (lh);
1430 if (ll->app_index != app->app_index)
1431 return VNET_API_ERROR_ADDRESS_IN_USE;
1433 if (ll->app_wrk_index == app_wrk->wrk_index)
1434 return VNET_API_ERROR_ADDRESS_IN_USE;
1436 app_listener = app_local_listener_get (app, ll->listener_db_index);
1437 app_listener->workers = clib_bitmap_set (app_listener->workers,
1438 app_wrk->wrk_map_index, 1);
1439 *handle = application_local_session_handle (ll);
1443 ll = application_local_listen_session_alloc (app);
1444 ll->session_type = session_type_from_proto_and_ip (TRANSPORT_PROTO_NONE, 0);
1445 ll->app_wrk_index = app_wrk->app_index;
1446 ll->session_index = application_local_listener_index (app, ll);
1447 ll->port = sep_ext->port;
1448 /* Store the original session type for the unbind */
1449 ll->listener_session_type =
1450 session_type_from_proto_and_ip (sep_ext->transport_proto,
1452 ll->transport_listener_index = ~0;
1453 ll->app_index = app->app_index;
1455 app_listener = app_local_listener_alloc (app);
1456 ll->listener_db_index = app_listener->al_index;
1457 app_listener->workers = clib_bitmap_set (app_listener->workers,
1458 app_wrk->wrk_map_index, 1);
1460 *handle = application_local_session_handle (ll);
1461 session_lookup_add_session_endpoint (table_index, sep, *handle);
1467 * Clean up local session table. If we have a listener session use it to
1468 * find the port and proto. If not, the handle must be a local table handle
1472 application_stop_local_listen (u32 app_index, u32 wrk_map_index,
1473 session_handle_t lh)
1475 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
1476 u32 table_index, ll_index, server_index;
1477 app_listener_t *app_listener;
1478 app_worker_t *server_wrk;
1479 stream_session_t *sl = 0;
1480 local_session_t *ll, *ls;
1481 application_t *server;
1483 server = application_get (app_index);
1484 table_index = application_local_session_table (server);
1486 /* We have both local and global table binds. Figure from global what
1487 * the sep we should be cleaning up is.
1489 if (!session_handle_is_local (lh))
1491 sl = listen_session_get_from_handle (lh);
1492 if (!sl || listen_session_get_local_session_endpoint (sl, &sep))
1494 clib_warning ("broken listener");
1497 lh = session_lookup_endpoint_listener (table_index, &sep, 0);
1498 if (lh == SESSION_INVALID_HANDLE)
1502 local_session_parse_handle (lh, &server_index, &ll_index);
1503 if (PREDICT_FALSE (server_index != app_index))
1505 clib_warning ("app %u does not own local handle 0x%lx", app_index, lh);
1509 ll = application_get_local_listen_session (server, ll_index);
1510 if (PREDICT_FALSE (!ll))
1512 clib_warning ("no local listener");
1516 app_listener = app_local_listener_get (server, ll->listener_db_index);
1517 if (!clib_bitmap_get (app_listener->workers, wrk_map_index))
1519 clib_warning ("app wrk %u not listening on handle %lu", wrk_map_index,
1524 server_wrk = application_get_worker (server, wrk_map_index);
1526 pool_foreach (ls, server_wrk->local_sessions, ({
1527 if (ls->listener_index == ll->session_index)
1528 application_local_session_disconnect (server_wrk->app_index, ls);
1532 clib_bitmap_set_no_check (app_listener->workers, wrk_map_index, 0);
1533 if (clib_bitmap_is_zero (app_listener->workers))
1535 app_local_listener_free (server, app_listener);
1536 application_local_listener_session_endpoint (ll, &sep);
1537 session_lookup_del_session_endpoint (table_index, &sep);
1538 application_local_listen_session_free (server, ll);
1545 application_local_session_fix_eventds (svm_msg_q_t * sq, svm_msg_q_t * cq)
1550 * segment manager initializes only the producer eventds, since vpp is
1551 * typically the producer. But for local sessions, we also pass to the
1552 * apps the mqs they listen on for events from peer apps, so they are also
1555 fd = svm_msg_q_get_producer_eventfd (sq);
1556 svm_msg_q_set_consumer_eventfd (sq, fd);
1557 fd = svm_msg_q_get_producer_eventfd (cq);
1558 svm_msg_q_set_consumer_eventfd (cq, fd);
1562 application_local_session_connect (app_worker_t * client_wrk,
1563 app_worker_t * server_wrk,
1564 local_session_t * ll, u32 opaque)
1566 u32 seg_size, evt_q_sz, evt_q_elts, margin = 16 << 10;
1567 segment_manager_properties_t *props, *cprops;
1568 u32 round_rx_fifo_sz, round_tx_fifo_sz;
1569 int rv, has_transport, seg_index;
1570 svm_fifo_segment_private_t *seg;
1571 application_t *server, *client;
1572 segment_manager_t *sm;
1573 local_session_t *ls;
1574 svm_msg_q_t *sq, *cq;
1576 ls = application_local_session_alloc (server_wrk);
1577 server = application_get (server_wrk->app_index);
1578 client = application_get (client_wrk->app_index);
1580 props = application_segment_manager_properties (server);
1581 cprops = application_segment_manager_properties (client);
1582 evt_q_elts = props->evt_q_size + cprops->evt_q_size;
1583 evt_q_sz = segment_manager_evt_q_expected_size (evt_q_elts);
1584 round_rx_fifo_sz = 1 << max_log2 (props->rx_fifo_size);
1585 round_tx_fifo_sz = 1 << max_log2 (props->tx_fifo_size);
1586 seg_size = round_rx_fifo_sz + round_tx_fifo_sz + evt_q_sz + margin;
1588 has_transport = session_has_transport ((stream_session_t *) ll);
1591 /* Local sessions don't have backing transport */
1592 ls->port = ll->port;
1593 sm = application_get_local_segment_manager (server_wrk);
1597 stream_session_t *sl = (stream_session_t *) ll;
1598 transport_connection_t *tc;
1599 tc = listen_session_get_transport (sl);
1600 ls->port = tc->lcl_port;
1601 sm = app_worker_get_listen_segment_manager (server_wrk, sl);
1604 seg_index = segment_manager_add_segment (sm, seg_size);
1607 clib_warning ("failed to add new cut-through segment");
1610 seg = segment_manager_get_segment_w_lock (sm, seg_index);
1611 sq = segment_manager_alloc_queue (seg, props);
1612 cq = segment_manager_alloc_queue (seg, cprops);
1614 if (props->use_mq_eventfd)
1615 application_local_session_fix_eventds (sq, cq);
1617 ls->server_evt_q = pointer_to_uword (sq);
1618 ls->client_evt_q = pointer_to_uword (cq);
1619 rv = segment_manager_try_alloc_fifos (seg, props->rx_fifo_size,
1620 props->tx_fifo_size,
1621 &ls->server_rx_fifo,
1622 &ls->server_tx_fifo);
1625 clib_warning ("failed to add fifos in cut-through segment");
1626 segment_manager_segment_reader_unlock (sm);
1629 ls->server_rx_fifo->ct_session_index = ls->session_index;
1630 ls->server_tx_fifo->ct_session_index = ls->session_index;
1631 ls->svm_segment_index = seg_index;
1632 ls->listener_index = ll->session_index;
1633 ls->client_wrk_index = client_wrk->wrk_index;
1634 ls->client_opaque = opaque;
1635 ls->listener_session_type = ll->session_type;
1636 ls->session_state = SESSION_STATE_READY;
1638 if ((rv = server->cb_fns.add_segment_callback (server->api_client_index,
1641 clib_warning ("failed to notify server of new segment");
1642 segment_manager_segment_reader_unlock (sm);
1645 segment_manager_segment_reader_unlock (sm);
1646 if ((rv = server->cb_fns.session_accept_callback ((stream_session_t *) ls)))
1648 clib_warning ("failed to send accept cut-through notify to server");
1651 if (server->flags & APP_OPTIONS_FLAGS_IS_BUILTIN)
1652 application_local_session_connect_notify (ls);
1658 segment_manager_del_segment (sm, seg);
1663 application_client_local_connect_key (local_session_t * ls)
1665 return ((uword) ls->app_wrk_index << 32 | (uword) ls->session_index);
1669 application_client_local_connect_key_parse (uword key, u32 * app_wrk_index,
1670 u32 * session_index)
1672 *app_wrk_index = key >> 32;
1673 *session_index = key & 0xFFFFFFFF;
1677 application_local_session_connect_notify (local_session_t * ls)
1679 svm_fifo_segment_private_t *seg;
1680 app_worker_t *client_wrk, *server_wrk;
1681 segment_manager_t *sm;
1682 application_t *client;
1683 int rv, is_fail = 0;
1686 client_wrk = app_worker_get (ls->client_wrk_index);
1687 server_wrk = app_worker_get (ls->app_wrk_index);
1688 client = application_get (client_wrk->app_index);
1690 sm = application_get_local_segment_manager_w_session (server_wrk, ls);
1691 seg = segment_manager_get_segment_w_lock (sm, ls->svm_segment_index);
1692 if ((rv = client->cb_fns.add_segment_callback (client->api_client_index,
1695 clib_warning ("failed to notify client %u of new segment",
1696 ls->client_wrk_index);
1697 segment_manager_segment_reader_unlock (sm);
1698 application_local_session_disconnect (ls->client_wrk_index, ls);
1703 segment_manager_segment_reader_unlock (sm);
1706 client->cb_fns.session_connected_callback (client_wrk->wrk_index,
1708 (stream_session_t *) ls,
1711 client_key = application_client_local_connect_key (ls);
1712 hash_set (client_wrk->local_connects, client_key, client_key);
1717 application_local_session_cleanup (app_worker_t * client_wrk,
1718 app_worker_t * server_wrk,
1719 local_session_t * ls)
1721 svm_fifo_segment_private_t *seg;
1722 stream_session_t *listener;
1723 segment_manager_t *sm;
1727 /* Retrieve listener transport type as it is the one that decides where
1728 * the fifos are allocated */
1729 has_transport = application_local_session_listener_has_transport (ls);
1731 sm = application_get_local_segment_manager_w_session (server_wrk, ls);
1734 listener = listen_session_get (ls->listener_index);
1735 sm = app_worker_get_listen_segment_manager (server_wrk, listener);
1738 seg = segment_manager_get_segment (sm, ls->svm_segment_index);
1741 client_key = application_client_local_connect_key (ls);
1742 hash_unset (client_wrk->local_connects, client_key);
1747 application_t *server = application_get (server_wrk->app_index);
1748 server->cb_fns.del_segment_callback (server->api_client_index,
1752 application_t *client = application_get (client_wrk->app_index);
1753 client->cb_fns.del_segment_callback (client->api_client_index,
1756 segment_manager_del_segment (sm, seg);
1759 application_local_session_free (server_wrk, ls);
1765 application_local_session_disconnect (u32 app_index, local_session_t * ls)
1767 app_worker_t *client_wrk, *server_wrk;
1768 u8 is_server = 0, is_client = 0;
1771 app = application_get_if_valid (app_index);
1775 client_wrk = app_worker_get_if_valid (ls->client_wrk_index);
1776 server_wrk = app_worker_get (ls->app_wrk_index);
1778 if (server_wrk->app_index == app_index)
1780 else if (client_wrk && client_wrk->app_index == app_index)
1783 if (!is_server && !is_client)
1785 clib_warning ("app %u is neither client nor server for session 0x%lx",
1786 app_index, application_local_session_handle (ls));
1787 return VNET_API_ERROR_INVALID_VALUE;
1790 if (ls->session_state == SESSION_STATE_CLOSED)
1791 return application_local_session_cleanup (client_wrk, server_wrk, ls);
1793 if (app_index == ls->client_wrk_index)
1795 mq_send_local_session_disconnected_cb (ls->app_wrk_index, ls);
1801 return application_local_session_cleanup (client_wrk, server_wrk,
1804 else if (ls->session_state < SESSION_STATE_READY)
1806 application_t *client = application_get (client_wrk->app_index);
1807 client->cb_fns.session_connected_callback (client_wrk->wrk_index,
1809 (stream_session_t *) ls,
1811 ls->session_state = SESSION_STATE_CLOSED;
1812 return application_local_session_cleanup (client_wrk, server_wrk,
1817 mq_send_local_session_disconnected_cb (client_wrk->wrk_index, ls);
1821 ls->session_state = SESSION_STATE_CLOSED;
1827 application_local_session_disconnect_w_index (u32 app_wrk_index, u32 ls_index)
1829 app_worker_t *app_wrk;
1830 local_session_t *ls;
1831 app_wrk = app_worker_get (app_wrk_index);
1832 ls = application_get_local_session (app_wrk, ls_index);
1833 return application_local_session_disconnect (app_wrk_index, ls);
1837 app_worker_local_sessions_free (app_worker_t * app_wrk)
1839 u32 index, server_wrk_index, session_index;
1840 u64 handle, *handles = 0;
1841 app_worker_t *server_wrk;
1842 segment_manager_t *sm;
1843 local_session_t *ls;
1849 if (app_wrk->local_sessions)
1852 pool_foreach (ls, app_wrk->local_sessions, ({
1853 application_local_session_disconnect (app_wrk->wrk_index, ls);
1861 vec_reset_length (handles);
1863 hash_foreach (handle, index, app_wrk->local_connects, ({
1864 vec_add1 (handles, handle);
1868 for (i = 0; i < vec_len (handles); i++)
1870 application_client_local_connect_key_parse (handles[i],
1873 server_wrk = app_worker_get_if_valid (server_wrk_index);
1876 ls = application_get_local_session (server_wrk, session_index);
1877 application_local_session_disconnect (app_wrk->wrk_index, ls);
1881 sm = segment_manager_get (app_wrk->local_segment_manager);
1882 sm->app_wrk_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
1883 segment_manager_del (sm);
1887 vnet_app_add_tls_cert (vnet_app_add_tls_cert_args_t * a)
1890 app = application_get (a->app_index);
1892 return clib_error_return_code (0, VNET_API_ERROR_APPLICATION_NOT_ATTACHED,
1893 0, "app %u doesn't exist", a->app_index);
1894 app->tls_cert = vec_dup (a->cert);
1899 vnet_app_add_tls_key (vnet_app_add_tls_key_args_t * a)
1902 app = application_get (a->app_index);
1904 return clib_error_return_code (0, VNET_API_ERROR_APPLICATION_NOT_ATTACHED,
1905 0, "app %u doesn't exist", a->app_index);
1906 app->tls_key = vec_dup (a->key);
1911 format_app_worker_listener (u8 * s, va_list * args)
1913 app_worker_t *app_wrk = va_arg (*args, app_worker_t *);
1914 u64 handle = va_arg (*args, u64);
1915 u32 sm_index = va_arg (*args, u32);
1916 int verbose = va_arg (*args, int);
1917 stream_session_t *listener;
1924 s = format (s, "%-40s%-25s%=10s%-15s%-15s%-10s", "Connection", "App",
1925 "Wrk", "API Client", "ListenerID", "SegManager");
1927 s = format (s, "%-40s%-25s%=10s", "Connection", "App", "Wrk");
1932 app = application_get (app_wrk->app_index);
1933 app_name = app_get_name_from_reg_index (app);
1934 listener = listen_session_get_from_handle (handle);
1935 str = format (0, "%U", format_stream_session, listener, verbose);
1940 sprintf (buf, "%u(%u)", app_wrk->wrk_map_index, app_wrk->wrk_index);
1941 s = format (s, "%-40s%-25s%=10s%-15u%-15u%-10u", str, app_name,
1942 buf, app->api_client_index, handle, sm_index);
1945 s = format (s, "%-40s%-25s%=10u", str, app_name, app_wrk->wrk_map_index);
1947 vec_free (app_name);
1952 application_format_listeners (application_t * app, int verbose)
1954 vlib_main_t *vm = vlib_get_main ();
1955 app_worker_map_t *wrk_map;
1956 app_worker_t *app_wrk;
1962 vlib_cli_output (vm, "%U", format_app_worker_listener, 0 /* header */ ,
1968 pool_foreach (wrk_map, app->worker_maps, ({
1969 app_wrk = app_worker_get (wrk_map->wrk_index);
1970 if (hash_elts (app_wrk->listeners_table) == 0)
1972 hash_foreach (handle, sm_index, app_wrk->listeners_table, ({
1973 vlib_cli_output (vm, "%U", format_app_worker_listener, app_wrk,
1974 handle, sm_index, verbose);
1981 app_worker_format_connects (app_worker_t * app_wrk, int verbose)
1983 svm_fifo_segment_private_t *fifo_segment;
1984 vlib_main_t *vm = vlib_get_main ();
1985 segment_manager_t *sm;
1986 u8 *app_name, *s = 0;
1993 vlib_cli_output (vm, "%-40s%-20s%-15s%-10s", "Connection", "App",
1994 "API Client", "SegManager");
1996 vlib_cli_output (vm, "%-40s%-20s", "Connection", "App");
2000 app = application_get (app_wrk->app_index);
2001 if (app_wrk->connects_seg_manager == (u32) ~ 0)
2004 app_name = app_get_name_from_reg_index (app);
2006 /* Across all fifo segments */
2007 sm = segment_manager_get (app_wrk->connects_seg_manager);
2010 segment_manager_foreach_segment_w_lock (fifo_segment, sm, ({
2014 fifo = svm_fifo_segment_get_fifo_list (fifo_segment);
2017 u32 session_index, thread_index;
2018 stream_session_t *session;
2020 session_index = fifo->master_session_index;
2021 thread_index = fifo->master_thread_index;
2023 session = session_get (session_index, thread_index);
2024 str = format (0, "%U", format_stream_session, session, verbose);
2027 s = format (s, "%-40s%-20s%-15u%-10u", str, app_name,
2028 app->api_client_index, app_wrk->connects_seg_manager);
2030 s = format (s, "%-40s%-20s", str, app_name);
2032 vlib_cli_output (vm, "%v", s);
2033 vec_reset_length (s);
2042 vec_free (app_name);
2046 application_format_connects (application_t * app, int verbose)
2048 app_worker_map_t *wrk_map;
2049 app_worker_t *app_wrk;
2053 app_worker_format_connects (0, verbose);
2058 pool_foreach (wrk_map, app->worker_maps, ({
2059 app_wrk = app_worker_get (wrk_map->wrk_index);
2060 app_worker_format_connects (app_wrk, verbose);
2066 app_worker_format_local_sessions (app_worker_t * app_wrk, int verbose)
2068 vlib_main_t *vm = vlib_get_main ();
2069 local_session_t *ls;
2070 transport_proto_t tp;
2076 vlib_cli_output (vm, "%-40s%-15s%-20s", "Connection", "ServerApp",
2081 if (!pool_elts (app_wrk->local_sessions)
2082 && !pool_elts (app_wrk->local_connects))
2086 pool_foreach (ls, app_wrk->local_sessions, ({
2087 tp = session_type_transport_proto(ls->listener_session_type);
2088 conn = format (0, "[L][%U] *:%u", format_transport_proto_short, tp,
2090 vlib_cli_output (vm, "%-40v%-15u%-20u", conn, ls->app_wrk_index,
2091 ls->client_wrk_index);
2092 vec_reset_length (conn);
2100 application_format_local_sessions (application_t * app, int verbose)
2102 vlib_main_t *vm = vlib_get_main ();
2103 app_worker_map_t *wrk_map;
2104 app_worker_t *app_wrk;
2105 transport_proto_t tp;
2106 local_session_t *ls;
2111 app_worker_format_local_sessions (0, verbose);
2116 * Format local listeners
2120 pool_foreach (ls, app->local_listen_sessions, ({
2121 tp = session_type_transport_proto (ls->listener_session_type);
2122 conn = format (0, "[L][%U] *:%u", format_transport_proto_short, tp,
2124 vlib_cli_output (vm, "%-40v%-15u%-20s", conn, ls->app_wrk_index, "*");
2125 vec_reset_length (conn);
2130 * Format local accepted/connected sessions
2133 pool_foreach (wrk_map, app->worker_maps, ({
2134 app_wrk = app_worker_get (wrk_map->wrk_index);
2135 app_worker_format_local_sessions (app_wrk, verbose);
2141 app_worker_format_local_connects (app_worker_t * app, int verbose)
2143 vlib_main_t *vm = vlib_get_main ();
2144 u32 app_wrk_index, session_index;
2145 app_worker_t *server_wrk;
2146 local_session_t *ls;
2154 vlib_cli_output (vm, "%-40s%-15s%-20s%-10s", "Connection", "App",
2155 "Peer App", "SegManager");
2157 vlib_cli_output (vm, "%-40s%-15s%-20s", "Connection", "App",
2162 if (!app->local_connects)
2166 hash_foreach (client_key, value, app->local_connects, ({
2167 application_client_local_connect_key_parse (client_key, &app_wrk_index,
2169 server_wrk = app_worker_get (app_wrk_index);
2170 ls = application_get_local_session (server_wrk, session_index);
2171 vlib_cli_output (vm, "%-40s%-15s%-20s", "TODO", ls->app_wrk_index,
2172 ls->client_wrk_index);
2178 application_format_local_connects (application_t * app, int verbose)
2180 app_worker_map_t *wrk_map;
2181 app_worker_t *app_wrk;
2185 app_worker_format_local_connects (0, verbose);
2190 pool_foreach (wrk_map, app->worker_maps, ({
2191 app_wrk = app_worker_get (wrk_map->wrk_index);
2192 app_worker_format_local_connects (app_wrk, verbose);
2198 format_application (u8 * s, va_list * args)
2200 application_t *app = va_arg (*args, application_t *);
2201 CLIB_UNUSED (int verbose) = va_arg (*args, int);
2202 segment_manager_properties_t *props;
2203 const u8 *app_ns_name;
2209 s = format (s, "%-10s%-20s%-15s%-15s%-15s%-15s%-15s", "Index", "Name",
2210 "API Client", "Namespace", "Add seg size", "Rx-f size",
2213 s = format (s, "%-10s%-20s%-15s%-40s", "Index", "Name", "API Client",
2218 app_name = app_get_name (app);
2219 app_ns_name = app_namespace_id_from_index (app->ns_index);
2220 props = application_segment_manager_properties (app);
2222 s = format (s, "%-10u%-20s%-15d%-15u%-15U%-15U%-15U", app->app_index,
2223 app_name, app->api_client_index, app->ns_index,
2224 format_memory_size, props->add_segment_size,
2225 format_memory_size, props->rx_fifo_size, format_memory_size,
2226 props->tx_fifo_size);
2228 s = format (s, "%-10u%-20s%-15d%-40s", app->app_index, app_name,
2229 app->api_client_index, app_ns_name);
2234 application_format_all_listeners (vlib_main_t * vm, int do_local, int verbose)
2238 if (!pool_elts (app_main.app_pool))
2240 vlib_cli_output (vm, "No active server bindings");
2246 application_format_local_sessions (0, verbose);
2248 pool_foreach (app, app_main.app_pool, ({
2249 application_format_local_sessions (app, verbose);
2255 application_format_listeners (0, verbose);
2258 pool_foreach (app, app_main.app_pool, ({
2259 application_format_listeners (app, verbose);
2266 application_format_all_clients (vlib_main_t * vm, int do_local, int verbose)
2270 if (!pool_elts (app_main.app_pool))
2272 vlib_cli_output (vm, "No active apps");
2278 application_format_local_connects (0, verbose);
2281 pool_foreach (app, app_main.app_pool, ({
2282 application_format_local_connects (app, verbose);
2288 application_format_connects (0, verbose);
2291 pool_foreach (app, app_main.app_pool, ({
2292 application_format_connects (app, verbose);
2298 static clib_error_t *
2299 show_app_command_fn (vlib_main_t * vm, unformat_input_t * input,
2300 vlib_cli_command_t * cmd)
2302 int do_server = 0, do_client = 0, do_local = 0;
2306 session_cli_return_if_not_enabled ();
2308 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2310 if (unformat (input, "server"))
2312 else if (unformat (input, "client"))
2314 else if (unformat (input, "local"))
2316 else if (unformat (input, "verbose"))
2323 application_format_all_listeners (vm, do_local, verbose);
2326 application_format_all_clients (vm, do_local, verbose);
2328 /* Print app related info */
2329 if (!do_server && !do_client)
2331 vlib_cli_output (vm, "%U", format_application, 0, verbose);
2333 pool_foreach (app, app_main.app_pool, ({
2334 vlib_cli_output (vm, "%U", format_application, app, verbose);
2343 VLIB_CLI_COMMAND (show_app_command, static) =
2346 .short_help = "show app [server|client] [verbose]",
2347 .function = show_app_command_fn,
2352 * fd.io coding-style-patch-verification: ON
2355 * eval: (c-set-style "gnu")