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_worker_map_t *
24 app_worker_map_alloc (application_t * app)
26 app_worker_map_t *map;
27 pool_get (app->worker_maps, map);
28 memset (map, 0, sizeof (*map));
33 app_worker_map_index (application_t * app, app_worker_map_t * map)
35 return (map - app->worker_maps);
39 app_worker_map_free (application_t * app, app_worker_map_t * map)
41 pool_put (app->worker_maps, map);
44 static app_worker_map_t *
45 app_worker_map_get (application_t * app, u32 map_index)
47 return pool_elt_at_index (app->worker_maps, map_index);
51 app_get_name_from_reg_index (application_t * app)
55 vl_api_registration_t *regp;
56 regp = vl_api_client_index_to_registration (app->api_client_index);
58 app_name = format (0, "builtin-%d%c", app->app_index, 0);
60 app_name = format (0, "%s%c", regp->name, 0);
66 app_get_name (application_t * app)
69 return app_get_name_from_reg_index (app);
74 application_session_table (application_t * app, u8 fib_proto)
76 app_namespace_t *app_ns;
77 app_ns = app_namespace_get (app->ns_index);
78 if (!application_has_global_scope (app))
79 return APP_INVALID_INDEX;
80 if (fib_proto == FIB_PROTOCOL_IP4)
81 return session_lookup_get_index_for_fib (fib_proto,
82 app_ns->ip4_fib_index);
84 return session_lookup_get_index_for_fib (fib_proto,
85 app_ns->ip6_fib_index);
89 application_local_session_table (application_t * app)
91 app_namespace_t *app_ns;
92 if (!application_has_local_scope (app))
93 return APP_INVALID_INDEX;
94 app_ns = app_namespace_get (app->ns_index);
95 return app_ns->local_table_index;
99 application_api_queue_is_full (application_t * app)
103 /* builtin servers are always OK */
104 if (app->api_client_index == ~0)
107 q = vl_api_client_index_to_input_queue (app->api_client_index);
111 if (q->cursize == q->maxsize)
119 * Since the name is not stored per app, we generate it on the fly. It is
120 * the caller's responsibility to free the vector
123 application_name_from_index (u32 app_index)
125 application_t *app = application_get (app_index);
128 return app_get_name_from_reg_index (app);
132 application_table_add (application_t * app)
134 if (app->api_client_index != APP_INVALID_INDEX)
135 hash_set (app_main.app_by_api_client_index, app->api_client_index,
138 hash_set_mem (app_main.app_by_name, app->name, app->app_index);
142 application_table_del (application_t * app)
144 if (app->api_client_index != APP_INVALID_INDEX)
145 hash_unset (app_main.app_by_api_client_index, app->api_client_index);
147 hash_unset_mem (app_main.app_by_name, app->name);
151 application_lookup (u32 api_client_index)
154 p = hash_get (app_main.app_by_api_client_index, api_client_index);
156 return application_get (p[0]);
162 application_lookup_name (const u8 * name)
165 p = hash_get_mem (app_main.app_by_name, name);
167 return application_get (p[0]);
173 application_alloc (void)
176 pool_get (app_main.app_pool, app);
177 memset (app, 0, sizeof (*app));
178 app->app_index = app - app_main.app_pool;
183 application_get (u32 app_index)
185 if (app_index == APP_INVALID_INDEX)
187 return pool_elt_at_index (app_main.app_pool, app_index);
191 application_get_if_valid (u32 app_index)
193 if (pool_is_free_index (app_main.app_pool, app_index))
196 return pool_elt_at_index (app_main.app_pool, app_index);
200 application_index (application_t * app)
202 return app - app_main.app_pool;
206 application_verify_cb_fns (session_cb_vft_t * cb_fns)
208 if (cb_fns->session_accept_callback == 0)
209 clib_warning ("No accept callback function provided");
210 if (cb_fns->session_connected_callback == 0)
211 clib_warning ("No session connected callback function provided");
212 if (cb_fns->session_disconnect_callback == 0)
213 clib_warning ("No session disconnect callback function provided");
214 if (cb_fns->session_reset_callback == 0)
215 clib_warning ("No session reset callback function provided");
219 * Check app config for given segment type
221 * Returns 1 on success and 0 otherwise
224 application_verify_cfg (ssvm_segment_type_t st)
227 if (st == SSVM_SEGMENT_MEMFD)
229 is_valid = (session_manager_get_evt_q_segment () != 0);
231 clib_warning ("memfd seg: vpp's event qs IN binary api svm region");
234 else if (st == SSVM_SEGMENT_SHM)
236 is_valid = (session_manager_get_evt_q_segment () == 0);
238 clib_warning ("shm seg: vpp's event qs NOT IN binary api svm region");
246 application_alloc_and_init (app_init_args_t * a)
248 ssvm_segment_type_t seg_type = SSVM_SEGMENT_MEMFD;
249 segment_manager_properties_t *props;
250 vl_api_registration_t *reg;
254 app = application_alloc ();
255 options = a->options;
257 * Make sure we support the requested configuration
259 if (!(options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_IS_BUILTIN))
261 reg = vl_api_client_index_to_registration (a->api_client_index);
263 return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
264 if (vl_api_registration_file_index (reg) == VL_API_INVALID_FI)
265 seg_type = SSVM_SEGMENT_SHM;
269 if (options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
271 clib_warning ("mq eventfds can only be used if socket transport is "
273 return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
275 seg_type = SSVM_SEGMENT_PRIVATE;
278 if (!application_verify_cfg (seg_type))
279 return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
281 /* Check that the obvious things are properly set up */
282 application_verify_cb_fns (a->session_cb_vft);
284 app->api_client_index = a->api_client_index;
285 app->flags = options[APP_OPTIONS_FLAGS];
286 app->cb_fns = *a->session_cb_vft;
287 app->ns_index = options[APP_OPTIONS_NAMESPACE];
288 app->proxied_transports = options[APP_OPTIONS_PROXY_TRANSPORT];
289 app->name = vec_dup (a->name);
291 /* If no scope enabled, default to global */
292 if (!application_has_global_scope (app)
293 && !application_has_local_scope (app))
294 app->flags |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
296 props = application_segment_manager_properties (app);
297 segment_manager_properties_init (props);
298 props->segment_size = options[APP_OPTIONS_ADD_SEGMENT_SIZE];
299 props->prealloc_fifos = options[APP_OPTIONS_PREALLOC_FIFO_PAIRS];
300 if (options[APP_OPTIONS_ADD_SEGMENT_SIZE])
302 props->add_segment_size = options[APP_OPTIONS_ADD_SEGMENT_SIZE];
303 props->add_segment = 1;
305 if (options[APP_OPTIONS_RX_FIFO_SIZE])
306 props->rx_fifo_size = options[APP_OPTIONS_RX_FIFO_SIZE];
307 if (options[APP_OPTIONS_TX_FIFO_SIZE])
308 props->tx_fifo_size = options[APP_OPTIONS_TX_FIFO_SIZE];
309 if (options[APP_OPTIONS_EVT_QUEUE_SIZE])
310 props->evt_q_size = options[APP_OPTIONS_EVT_QUEUE_SIZE];
311 if (options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
312 props->use_mq_eventfd = 1;
313 if (options[APP_OPTIONS_TLS_ENGINE])
314 app->tls_engine = options[APP_OPTIONS_TLS_ENGINE];
315 props->segment_type = seg_type;
317 /* Add app to lookup by api_client_index table */
318 application_table_add (app);
319 a->app_index = application_index (app);
321 APP_DBG ("New app name: %v api index: %u index %u", app->name,
322 app->api_client_index, app->app_index);
328 application_free (application_t * app)
330 app_worker_map_t *wrk_map;
331 app_worker_t *app_wrk;
334 * The app event queue allocated in first segment is cleared with
335 * the segment manager. No need to explicitly free it.
337 APP_DBG ("Delete app name %v api index: %d index: %d", app->name,
338 app->api_client_index, app->app_index);
340 if (application_is_proxy (app))
341 application_remove_proxy (app);
344 pool_flush (wrk_map, app->worker_maps, ({
345 app_wrk = app_worker_get (wrk_map->wrk_index);
346 app_worker_free (app_wrk);
349 pool_free (app->worker_maps);
351 application_table_del (app);
352 vec_free (app->name);
353 vec_free (app->tls_cert);
354 vec_free (app->tls_key);
355 pool_put (app_main.app_pool, app);
359 application_get_worker (application_t * app, u32 wrk_map_index)
361 app_worker_map_t *map;
362 map = app_worker_map_get (app, wrk_map_index);
365 return app_worker_get (map->wrk_index);
369 application_get_default_worker (application_t * app)
371 return application_get_worker (app, 0);
375 app_worker_alloc (application_t * app)
377 app_worker_t *app_wrk;
378 pool_get (app_main.workers, app_wrk);
379 memset (app_wrk, 0, sizeof (*app_wrk));
380 app_wrk->wrk_index = app_wrk - app_main.workers;
381 app_wrk->app_index = app->app_index;
382 app_wrk->wrk_map_index = ~0;
383 app_wrk->connects_seg_manager = APP_INVALID_SEGMENT_MANAGER_INDEX;
384 app_wrk->first_segment_manager = APP_INVALID_SEGMENT_MANAGER_INDEX;
385 app_wrk->local_segment_manager = APP_INVALID_SEGMENT_MANAGER_INDEX;
386 APP_DBG ("New app %v worker %u", app_get_name (app), app_wrk->wrk_index);
391 app_worker_get (u32 wrk_index)
393 return pool_elt_at_index (app_main.workers, wrk_index);
397 app_worker_get_if_valid (u32 wrk_index)
399 if (pool_is_free_index (app_main.workers, wrk_index))
401 return pool_elt_at_index (app_main.workers, wrk_index);
405 app_worker_free (app_worker_t * app_wrk)
407 application_t *app = application_get (app_wrk->app_index);
408 vnet_unbind_args_t _a, *a = &_a;
409 u64 handle, *handles = 0;
410 segment_manager_t *sm;
419 hash_foreach (handle, sm_index, app_wrk->listeners_table,
421 vec_add1 (handles, handle);
422 sm = segment_manager_get (sm_index);
423 sm->app_wrk_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
427 for (i = 0; i < vec_len (handles); i++)
429 a->app_index = app->app_index;
430 a->app_wrk_index = app_wrk->wrk_map_index;
431 a->handle = handles[i];
432 /* seg manager is removed when unbind completes */
437 * Connects segment manager cleanup
440 if (app_wrk->connects_seg_manager != APP_INVALID_SEGMENT_MANAGER_INDEX)
442 sm = segment_manager_get (app_wrk->connects_seg_manager);
443 sm->app_wrk_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
444 segment_manager_init_del (sm);
447 /* If first segment manager is used by a listener */
448 if (app_wrk->first_segment_manager != APP_INVALID_SEGMENT_MANAGER_INDEX
449 && app_wrk->first_segment_manager != app_wrk->connects_seg_manager)
451 sm = segment_manager_get (app_wrk->first_segment_manager);
452 /* .. and has no fifos, e.g. it might be used for redirected sessions,
454 if (!segment_manager_has_fifos (sm))
456 sm->app_wrk_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
457 segment_manager_del (sm);
464 application_local_sessions_free (app_wrk);
466 pool_put (app_main.workers, app_wrk);
468 memset (app_wrk, 0xfe, sizeof (*app_wrk));
472 app_worker_alloc_and_init (application_t * app, app_worker_t ** wrk)
474 app_worker_map_t *wrk_map;
475 app_worker_t *app_wrk;
476 segment_manager_t *sm;
479 app_wrk = app_worker_alloc (app);
480 wrk_map = app_worker_map_alloc (app);
481 wrk_map->wrk_index = app_wrk->wrk_index;
482 app_wrk->wrk_map_index = app_worker_map_index (app, wrk_map);
485 * Setup first segment manager
487 sm = segment_manager_new ();
488 sm->app_wrk_index = app_wrk->wrk_index;
490 if ((rv = segment_manager_init (sm, app->sm_properties.segment_size,
491 app->sm_properties.prealloc_fifos)))
493 app_worker_free (app_wrk);
496 sm->first_is_protected = 1;
501 app_wrk->first_segment_manager = segment_manager_index (sm);
502 app_wrk->listeners_table = hash_create (0, sizeof (u64));
503 app_wrk->event_queue = segment_manager_event_queue (sm);
504 app_wrk->app_is_builtin = application_is_builtin (app);
507 * Segment manager for local sessions
509 sm = segment_manager_new ();
510 sm->app_wrk_index = app_wrk->wrk_index;
511 app_wrk->local_segment_manager = segment_manager_index (sm);
512 app_wrk->local_connects = hash_create (0, sizeof (u64));
519 static segment_manager_t *
520 application_alloc_segment_manager (app_worker_t * app_wrk)
522 segment_manager_t *sm = 0;
524 /* If the first segment manager is not in use, don't allocate a new one */
525 if (app_wrk->first_segment_manager != APP_INVALID_SEGMENT_MANAGER_INDEX
526 && app_wrk->first_segment_manager_in_use == 0)
528 sm = segment_manager_get (app_wrk->first_segment_manager);
529 app_wrk->first_segment_manager_in_use = 1;
533 sm = segment_manager_new ();
534 sm->app_wrk_index = app_wrk->wrk_index;
540 * Start listening local transport endpoint for requested transport.
542 * Creates a 'dummy' stream session with state LISTENING to be used in session
543 * lookups, prior to establishing connection. Requests transport to build
544 * it's own specific listening connection.
547 app_worker_start_listen (app_worker_t * app_wrk, session_endpoint_t * sep,
548 session_handle_t * res)
550 segment_manager_t *sm;
552 session_handle_t handle;
555 sst = session_type_from_proto_and_ip (sep->transport_proto, sep->is_ip4);
556 s = listen_session_new (0, sst);
557 s->app_wrk_index = app_wrk->wrk_index;
559 /* Allocate segment manager. All sessions derived out of a listen session
560 * have fifos allocated by the same segment manager. */
561 if (!(sm = application_alloc_segment_manager (app_wrk)))
564 /* Add to app's listener table. Useful to find all child listeners
565 * when app goes down, although, just for unbinding this is not needed */
566 handle = listen_session_get_handle (s);
567 hash_set (app_wrk->listeners_table, handle, segment_manager_index (sm));
569 if (stream_session_listen (s, sep))
571 segment_manager_del (sm);
572 hash_unset (app_wrk->listeners_table, handle);
580 listen_session_del (s);
585 * Stop listening on session associated to handle
587 * @param handle listener handle
588 * @param app_index index of the app owning the handle. This is used
589 * only for validating ownership
592 app_worker_stop_listen (session_handle_t handle, u32 app_index)
594 stream_session_t *listener;
595 segment_manager_t *sm;
596 app_worker_t *app_wrk;
599 listener = listen_session_get_from_handle (handle);
600 app_wrk = app_worker_get (listener->app_wrk_index);
601 if (PREDICT_FALSE (!app_wrk || app_wrk->app_index != app_index))
603 clib_warning ("app doesn't own handle %llu!", handle);
606 if (PREDICT_FALSE (hash_get (app_wrk->listeners_table, handle) == 0))
608 clib_warning ("listener handle was removed %llu!", handle);
612 stream_session_stop_listen (listener);
614 indexp = hash_get (app_wrk->listeners_table, handle);
617 sm = segment_manager_get (*indexp);
618 if (app_wrk->first_segment_manager == *indexp)
620 /* Delete sessions but don't remove segment manager */
621 app_wrk->first_segment_manager_in_use = 0;
622 segment_manager_del_sessions (sm);
626 segment_manager_init_del (sm);
628 hash_unset (app_wrk->listeners_table, handle);
629 listen_session_del (listener);
635 app_worker_open_session (app_worker_t * app, session_endpoint_t * sep,
640 /* Make sure we have a segment manager for connects */
641 app_worker_alloc_connects_segment_manager (app);
643 if ((rv = session_open (app->wrk_index, sep, api_context)))
650 app_worker_alloc_connects_segment_manager (app_worker_t * app_wrk)
652 segment_manager_t *sm;
654 if (app_wrk->connects_seg_manager == APP_INVALID_SEGMENT_MANAGER_INDEX)
656 sm = application_alloc_segment_manager (app_wrk);
659 app_wrk->connects_seg_manager = segment_manager_index (sm);
665 app_worker_get_connect_segment_manager (app_worker_t * app)
667 ASSERT (app->connects_seg_manager != (u32) ~ 0);
668 return segment_manager_get (app->connects_seg_manager);
672 app_worker_get_listen_segment_manager (app_worker_t * app,
673 stream_session_t * s)
676 smp = hash_get (app->listeners_table, listen_session_get_handle (s));
678 return segment_manager_get (*smp);
682 vnet_app_worker_add_del (vnet_app_worker_add_del_args_t * a)
684 svm_fifo_segment_private_t *fs;
685 app_worker_map_t *wrk_map;
686 app_worker_t *app_wrk;
687 segment_manager_t *sm;
691 app = application_get (a->app_index);
693 return clib_error_return_code (0, VNET_API_ERROR_INVALID_VALUE, 0,
694 "App %u does not exist", a->app_index);
698 if ((rv = app_worker_alloc_and_init (app, &app_wrk)))
699 return clib_error_return_code (0, rv, 0, "app wrk init: %d", rv);
700 sm = segment_manager_get (app_wrk->first_segment_manager);
701 fs = segment_manager_get_segment_w_lock (sm, 0);
702 a->segment = &fs->ssvm;
703 segment_manager_segment_reader_unlock (sm);
704 a->evt_q = app_wrk->event_queue;
708 wrk_map = app_worker_map_get (app, a->wrk_index);
710 return clib_error_return_code (0, VNET_API_ERROR_INVALID_VALUE, 0,
711 "App %u does not have worker %u",
712 app->app_index, a->wrk_index);
713 app_wrk = app_worker_get (wrk_map->wrk_index);
714 app_worker_map_free (app, wrk_map);
716 return clib_error_return_code (0, VNET_API_ERROR_INVALID_VALUE, 0,
717 "No worker %u", a->wrk_index);
718 app_worker_free (app_wrk);
724 application_get_local_segment_manager (app_worker_t * app)
726 return segment_manager_get (app->local_segment_manager);
730 application_get_local_segment_manager_w_session (app_worker_t * app,
731 local_session_t * ls)
733 stream_session_t *listener;
734 if (application_local_session_listener_has_transport (ls))
736 listener = listen_session_get (ls->listener_index);
737 return app_worker_get_listen_segment_manager (app, listener);
739 return segment_manager_get (app->local_segment_manager);
743 application_is_proxy (application_t * app)
745 return (app->flags & APP_OPTIONS_FLAGS_IS_PROXY);
749 application_is_builtin (application_t * app)
751 return (app->flags & APP_OPTIONS_FLAGS_IS_BUILTIN);
755 application_is_builtin_proxy (application_t * app)
757 return (application_is_proxy (app) && application_is_builtin (app));
761 application_has_local_scope (application_t * app)
763 return app->flags & APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
767 application_has_global_scope (application_t * app)
769 return app->flags & APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
773 application_use_mq_for_ctrl (application_t * app)
775 return app->flags & APP_OPTIONS_FLAGS_USE_MQ_FOR_CTRL_MSGS;
779 * Send an API message to the external app, to map new segment
782 app_worker_add_segment_notify (u32 app_wrk_index, ssvm_private_t * fs)
784 app_worker_t *app_wrk = app_worker_get (app_wrk_index);
785 application_t *app = application_get (app_wrk->app_index);
786 return app->cb_fns.add_segment_callback (app->api_client_index, fs);
790 application_n_listeners (app_worker_t * app)
792 return hash_elts (app->listeners_table);
796 app_worker_first_listener (app_worker_t * app, u8 fib_proto,
799 stream_session_t *listener;
804 sst = session_type_from_proto_and_ip (transport_proto,
805 fib_proto == FIB_PROTOCOL_IP4);
808 hash_foreach (handle, sm_index, app->listeners_table, ({
809 listener = listen_session_get_from_handle (handle);
810 if (listener->session_type == sst
811 && listener->listener_index != SESSION_PROXY_LISTENER_INDEX)
820 app_worker_application_is_builtin (app_worker_t * app_wrk)
822 return app_wrk->app_is_builtin;
826 application_proxy_listener (app_worker_t * app, u8 fib_proto,
829 stream_session_t *listener;
834 sst = session_type_from_proto_and_ip (transport_proto,
835 fib_proto == FIB_PROTOCOL_IP4);
838 hash_foreach (handle, sm_index, app->listeners_table, ({
839 listener = listen_session_get_from_handle (handle);
840 if (listener->session_type == sst
841 && listener->listener_index == SESSION_PROXY_LISTENER_INDEX)
849 static clib_error_t *
850 application_start_stop_proxy_fib_proto (application_t * app, u8 fib_proto,
851 u8 transport_proto, u8 is_start)
853 app_namespace_t *app_ns = app_namespace_get (app->ns_index);
854 u8 is_ip4 = (fib_proto == FIB_PROTOCOL_IP4);
855 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
856 transport_connection_t *tc;
857 app_worker_t *app_wrk;
861 /* TODO decide if we want proxy to be enabled for all workers */
862 app_wrk = application_get_default_worker (app);
865 s = app_worker_first_listener (app_wrk, fib_proto, transport_proto);
869 sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
870 sep.sw_if_index = app_ns->sw_if_index;
871 sep.transport_proto = transport_proto;
872 app_worker_start_listen (app_wrk, &sep, &handle);
873 s = listen_session_get_from_handle (handle);
874 s->listener_index = SESSION_PROXY_LISTENER_INDEX;
879 s = application_proxy_listener (app_wrk, fib_proto, transport_proto);
883 tc = listen_session_get_transport (s);
885 if (!ip_is_zero (&tc->lcl_ip, 1))
889 sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
890 sep.transport_proto = transport_proto;
892 sti = session_lookup_get_index_for_fib (fib_proto, sep.fib_index);
894 session_lookup_add_session_endpoint (sti, &sep, s->session_index);
896 session_lookup_del_session_endpoint (sti, &sep);
903 application_start_stop_proxy_local_scope (application_t * app,
904 u8 transport_proto, u8 is_start)
906 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
907 app_namespace_t *app_ns;
908 app_ns = app_namespace_get (app->ns_index);
910 sep.transport_proto = transport_proto;
915 session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
918 session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
923 session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
925 session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
930 application_start_stop_proxy (application_t * app,
931 transport_proto_t transport_proto, u8 is_start)
933 if (application_has_local_scope (app))
934 application_start_stop_proxy_local_scope (app, transport_proto, is_start);
936 if (application_has_global_scope (app))
938 application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP4,
939 transport_proto, is_start);
940 application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP6,
941 transport_proto, is_start);
946 application_setup_proxy (application_t * app)
948 u16 transports = app->proxied_transports;
949 transport_proto_t tp;
951 ASSERT (application_is_proxy (app));
954 transport_proto_foreach (tp, ({
955 if (transports & (1 << tp))
956 application_start_stop_proxy (app, tp, 1);
962 application_remove_proxy (application_t * app)
964 u16 transports = app->proxied_transports;
965 transport_proto_t tp;
967 ASSERT (application_is_proxy (app));
970 transport_proto_foreach (tp, ({
971 if (transports & (1 << tp))
972 application_start_stop_proxy (app, tp, 0);
977 segment_manager_properties_t *
978 application_segment_manager_properties (application_t * app)
980 return &app->sm_properties;
983 segment_manager_properties_t *
984 application_get_segment_manager_properties (u32 app_index)
986 application_t *app = application_get (app_index);
987 return &app->sm_properties;
991 app_enqueue_evt (svm_msg_q_t * mq, svm_msg_q_msg_t * msg, u8 lock)
993 if (PREDICT_FALSE (svm_msg_q_is_full (mq)))
995 clib_warning ("evt q full");
996 svm_msg_q_free_msg (mq, msg);
998 svm_msg_q_unlock (mq);
1004 svm_msg_q_add_and_unlock (mq, msg);
1008 /* Even when not locking the ring, we must wait for queue mutex */
1009 if (svm_msg_q_add (mq, msg, SVM_Q_WAIT))
1011 clib_warning ("msg q add returned");
1018 app_send_io_evt_rx (app_worker_t * app_wrk, stream_session_t * s, u8 lock)
1020 session_event_t *evt;
1021 svm_msg_q_msg_t msg;
1024 if (PREDICT_FALSE (s->session_state != SESSION_STATE_READY
1025 && s->session_state != SESSION_STATE_LISTENING))
1027 /* Session is closed so app will never clean up. Flush rx fifo */
1028 if (s->session_state == SESSION_STATE_CLOSED)
1029 svm_fifo_dequeue_drop_all (s->server_rx_fifo);
1033 if (app_worker_application_is_builtin (app_wrk))
1035 application_t *app = application_get (app_wrk->app_index);
1036 return app->cb_fns.builtin_app_rx_callback (s);
1039 if (svm_fifo_has_event (s->server_rx_fifo)
1040 || svm_fifo_is_empty (s->server_rx_fifo))
1043 mq = app_wrk->event_queue;
1045 svm_msg_q_lock (mq);
1047 if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
1049 clib_warning ("evt q rings full");
1051 svm_msg_q_unlock (mq);
1055 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
1056 ASSERT (!svm_msg_q_msg_is_invalid (&msg));
1058 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
1059 evt->fifo = s->server_rx_fifo;
1060 evt->event_type = FIFO_EVENT_APP_RX;
1062 if (app_enqueue_evt (mq, &msg, lock))
1064 (void) svm_fifo_set_event (s->server_rx_fifo);
1069 app_send_io_evt_tx (app_worker_t * app_wrk, stream_session_t * s, u8 lock)
1072 session_event_t *evt;
1073 svm_msg_q_msg_t msg;
1075 if (app_worker_application_is_builtin (app_wrk))
1078 mq = app_wrk->event_queue;
1080 svm_msg_q_lock (mq);
1082 if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
1084 clib_warning ("evt q rings full");
1086 svm_msg_q_unlock (mq);
1090 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
1091 ASSERT (!svm_msg_q_msg_is_invalid (&msg));
1093 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
1094 evt->event_type = FIFO_EVENT_APP_TX;
1095 evt->fifo = s->server_tx_fifo;
1097 return app_enqueue_evt (mq, &msg, lock);
1101 typedef int (app_send_evt_handler_fn) (app_worker_t *app,
1102 stream_session_t *s,
1104 static app_send_evt_handler_fn * const app_send_evt_handler_fns[3] = {
1112 * Send event to application
1114 * Logic from queue perspective is non-blocking. That is, if there's
1115 * not enough space to enqueue a message, we return. However, if the lock
1116 * flag is set, we do wait for queue mutex.
1119 application_send_event (app_worker_t * app, stream_session_t * s, u8 evt_type)
1121 ASSERT (app && evt_type <= FIFO_EVENT_APP_TX);
1122 return app_send_evt_handler_fns[evt_type] (app, s, 0 /* lock */ );
1126 application_lock_and_send_event (app_worker_t * app, stream_session_t * s,
1129 return app_send_evt_handler_fns[evt_type] (app, s, 1 /* lock */ );
1133 application_alloc_local_session (app_worker_t * app)
1136 pool_get (app->local_sessions, s);
1137 memset (s, 0, sizeof (*s));
1138 s->app_wrk_index = app->app_index;
1139 s->session_index = s - app->local_sessions;
1140 s->session_type = session_type_from_proto_and_ip (TRANSPORT_PROTO_NONE, 0);
1145 application_free_local_session (app_worker_t * app, local_session_t * s)
1147 pool_put (app->local_sessions, s);
1149 memset (s, 0xfc, sizeof (*s));
1153 application_get_local_session (app_worker_t * app_wrk, u32 session_index)
1155 if (pool_is_free_index (app_wrk->local_sessions, session_index))
1157 return pool_elt_at_index (app_wrk->local_sessions, session_index);
1161 application_get_local_session_from_handle (session_handle_t handle)
1163 app_worker_t *server_wrk;
1164 u32 session_index, server_wrk_index;
1165 local_session_parse_handle (handle, &server_wrk_index, &session_index);
1166 server_wrk = app_worker_get_if_valid (server_wrk_index);
1169 return application_get_local_session (server_wrk, session_index);
1173 application_get_local_listen_session_from_handle (session_handle_t lh)
1175 u32 ll_index, server_wrk_index;
1176 app_worker_t *server_wrk;
1178 local_session_parse_handle (lh, &server_wrk_index, &ll_index);
1179 server_wrk = app_worker_get (server_wrk_index);
1180 return application_get_local_listen_session (server_wrk, ll_index);
1184 application_local_listener_session_endpoint (local_session_t * ll,
1185 session_endpoint_t * sep)
1187 sep->transport_proto =
1188 session_type_transport_proto (ll->listener_session_type);
1189 sep->port = ll->port;
1190 sep->is_ip4 = ll->listener_session_type & 1;
1194 application_start_local_listen (app_worker_t * app_wrk,
1195 session_endpoint_t * sep,
1196 session_handle_t * handle)
1198 session_handle_t lh;
1199 local_session_t *ll;
1203 app = application_get (app_wrk->app_index);
1204 table_index = application_local_session_table (app);
1206 /* An exact sep match, as opposed to session_lookup_local_listener */
1207 lh = session_lookup_endpoint_listener (table_index, sep, 1);
1208 if (lh != SESSION_INVALID_HANDLE)
1209 return VNET_API_ERROR_ADDRESS_IN_USE;
1211 pool_get (app_wrk->local_listen_sessions, ll);
1212 memset (ll, 0, sizeof (*ll));
1213 ll->session_type = session_type_from_proto_and_ip (TRANSPORT_PROTO_NONE, 0);
1214 ll->app_wrk_index = app_wrk->app_index;
1215 ll->session_index = ll - app_wrk->local_listen_sessions;
1216 ll->port = sep->port;
1217 /* Store the original session type for the unbind */
1218 ll->listener_session_type =
1219 session_type_from_proto_and_ip (sep->transport_proto, sep->is_ip4);
1220 ll->transport_listener_index = ~0;
1222 *handle = application_local_session_handle (ll);
1223 session_lookup_add_session_endpoint (table_index, sep, *handle);
1229 * Clean up local session table. If we have a listener session use it to
1230 * find the port and proto. If not, the handle must be a local table handle
1234 application_stop_local_listen (session_handle_t lh, u32 app_index)
1236 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
1237 u32 table_index, ll_index, server_wrk_index;
1238 app_worker_t *server_wrk;
1239 stream_session_t *sl = 0;
1240 local_session_t *ll, *ls;
1241 application_t *server;
1243 server = application_get (app_index);
1244 table_index = application_local_session_table (server);
1246 /* We have both local and global table binds. Figure from global what
1247 * the sep we should be cleaning up is.
1249 if (!session_handle_is_local (lh))
1251 sl = listen_session_get_from_handle (lh);
1252 if (!sl || listen_session_get_local_session_endpoint (sl, &sep))
1254 clib_warning ("broken listener");
1257 lh = session_lookup_endpoint_listener (table_index, &sep, 0);
1258 if (lh == SESSION_INVALID_HANDLE)
1262 local_session_parse_handle (lh, &server_wrk_index, &ll_index);
1263 server_wrk = app_worker_get (server_wrk_index);
1264 if (PREDICT_FALSE (server_wrk->app_index != app_index))
1266 clib_warning ("app %u does not own local handle 0x%lx", app_index, lh);
1268 ll = application_get_local_listen_session (server_wrk, ll_index);
1269 if (PREDICT_FALSE (!ll))
1271 clib_warning ("no local listener");
1274 application_local_listener_session_endpoint (ll, &sep);
1275 session_lookup_del_session_endpoint (table_index, &sep);
1278 pool_foreach (ls, server_wrk->local_sessions, ({
1279 if (ls->listener_index == ll->session_index)
1280 application_local_session_disconnect (server_wrk->app_index, ls);
1283 pool_put_index (server_wrk->local_listen_sessions, ll->session_index);
1289 application_local_session_fix_eventds (svm_msg_q_t * sq, svm_msg_q_t * cq)
1294 * segment manager initializes only the producer eventds, since vpp is
1295 * typically the producer. But for local sessions, we also pass to the
1296 * apps the mqs they listen on for events from peer apps, so they are also
1299 fd = svm_msg_q_get_producer_eventfd (sq);
1300 svm_msg_q_set_consumer_eventfd (sq, fd);
1301 fd = svm_msg_q_get_producer_eventfd (cq);
1302 svm_msg_q_set_consumer_eventfd (cq, fd);
1306 application_local_session_connect (app_worker_t * client_wrk,
1307 app_worker_t * server_wrk,
1308 local_session_t * ll, u32 opaque)
1310 u32 seg_size, evt_q_sz, evt_q_elts, margin = 16 << 10;
1311 segment_manager_properties_t *props, *cprops;
1312 u32 round_rx_fifo_sz, round_tx_fifo_sz;
1313 int rv, has_transport, seg_index;
1314 svm_fifo_segment_private_t *seg;
1315 application_t *server, *client;
1316 segment_manager_t *sm;
1317 local_session_t *ls;
1318 svm_msg_q_t *sq, *cq;
1320 ls = application_alloc_local_session (server_wrk);
1322 server = application_get (server_wrk->app_index);
1323 client = application_get (client_wrk->app_index);
1325 props = application_segment_manager_properties (server);
1326 cprops = application_segment_manager_properties (client);
1327 evt_q_elts = props->evt_q_size + cprops->evt_q_size;
1328 evt_q_sz = segment_manager_evt_q_expected_size (evt_q_elts);
1329 round_rx_fifo_sz = 1 << max_log2 (props->rx_fifo_size);
1330 round_tx_fifo_sz = 1 << max_log2 (props->tx_fifo_size);
1331 seg_size = round_rx_fifo_sz + round_tx_fifo_sz + evt_q_sz + margin;
1333 has_transport = session_has_transport ((stream_session_t *) ll);
1336 /* Local sessions don't have backing transport */
1337 ls->port = ll->port;
1338 sm = application_get_local_segment_manager (server_wrk);
1342 stream_session_t *sl = (stream_session_t *) ll;
1343 transport_connection_t *tc;
1344 tc = listen_session_get_transport (sl);
1345 ls->port = tc->lcl_port;
1346 sm = app_worker_get_listen_segment_manager (server_wrk, sl);
1349 seg_index = segment_manager_add_segment (sm, seg_size);
1352 clib_warning ("failed to add new cut-through segment");
1355 seg = segment_manager_get_segment_w_lock (sm, seg_index);
1356 sq = segment_manager_alloc_queue (seg, props);
1357 cq = segment_manager_alloc_queue (seg, cprops);
1359 if (props->use_mq_eventfd)
1360 application_local_session_fix_eventds (sq, cq);
1362 ls->server_evt_q = pointer_to_uword (sq);
1363 ls->client_evt_q = pointer_to_uword (cq);
1364 rv = segment_manager_try_alloc_fifos (seg, props->rx_fifo_size,
1365 props->tx_fifo_size,
1366 &ls->server_rx_fifo,
1367 &ls->server_tx_fifo);
1370 clib_warning ("failed to add fifos in cut-through segment");
1371 segment_manager_segment_reader_unlock (sm);
1374 ls->server_rx_fifo->master_session_index = ls->session_index;
1375 ls->server_tx_fifo->master_session_index = ls->session_index;
1376 ls->server_rx_fifo->master_thread_index = ~0;
1377 ls->server_tx_fifo->master_thread_index = ~0;
1378 ls->svm_segment_index = seg_index;
1379 ls->listener_index = ll->session_index;
1380 ls->client_wrk_index = client_wrk->wrk_index;
1381 ls->client_opaque = opaque;
1382 ls->listener_session_type = ll->session_type;
1384 if ((rv = server->cb_fns.add_segment_callback (server->api_client_index,
1387 clib_warning ("failed to notify server of new segment");
1388 segment_manager_segment_reader_unlock (sm);
1391 segment_manager_segment_reader_unlock (sm);
1392 if ((rv = server->cb_fns.session_accept_callback ((stream_session_t *) ls)))
1394 clib_warning ("failed to send accept cut-through notify to server");
1397 if (server->flags & APP_OPTIONS_FLAGS_IS_BUILTIN)
1398 application_local_session_connect_notify (ls);
1404 segment_manager_del_segment (sm, seg);
1409 application_client_local_connect_key (local_session_t * ls)
1411 return ((uword) ls->app_wrk_index << 32 | (uword) ls->session_index);
1415 application_client_local_connect_key_parse (uword key, u32 * app_wrk_index,
1416 u32 * session_index)
1418 *app_wrk_index = key >> 32;
1419 *session_index = key & 0xFFFFFFFF;
1423 application_local_session_connect_notify (local_session_t * ls)
1425 svm_fifo_segment_private_t *seg;
1426 app_worker_t *client_wrk, *server_wrk;
1427 segment_manager_t *sm;
1428 application_t *client;
1429 int rv, is_fail = 0;
1432 client_wrk = app_worker_get (ls->client_wrk_index);
1433 server_wrk = app_worker_get (ls->app_wrk_index);
1434 client = application_get (client_wrk->app_index);
1436 sm = application_get_local_segment_manager_w_session (server_wrk, ls);
1437 seg = segment_manager_get_segment_w_lock (sm, ls->svm_segment_index);
1438 if ((rv = client->cb_fns.add_segment_callback (client->api_client_index,
1441 clib_warning ("failed to notify client %u of new segment",
1442 ls->client_wrk_index);
1443 segment_manager_segment_reader_unlock (sm);
1444 application_local_session_disconnect (ls->client_wrk_index, ls);
1449 segment_manager_segment_reader_unlock (sm);
1452 client->cb_fns.session_connected_callback (client_wrk->wrk_index,
1454 (stream_session_t *) ls,
1457 client_key = application_client_local_connect_key (ls);
1458 hash_set (client_wrk->local_connects, client_key, client_key);
1463 application_local_session_cleanup (app_worker_t * client_wrk,
1464 app_worker_t * server_wrk,
1465 local_session_t * ls)
1467 svm_fifo_segment_private_t *seg;
1468 segment_manager_t *sm;
1472 has_transport = session_has_transport ((stream_session_t *) ls);
1473 client_key = application_client_local_connect_key (ls);
1475 sm = application_get_local_segment_manager_w_session (server_wrk, ls);
1477 sm = app_worker_get_listen_segment_manager (server_wrk,
1478 (stream_session_t *) ls);
1480 seg = segment_manager_get_segment (sm, ls->svm_segment_index);
1482 hash_unset (client_wrk->local_connects, client_key);
1486 application_t *server = application_get (server_wrk->app_index);
1487 server->cb_fns.del_segment_callback (server->api_client_index,
1491 application_t *client = application_get (client_wrk->app_index);
1492 client->cb_fns.del_segment_callback (client->api_client_index,
1495 segment_manager_del_segment (sm, seg);
1498 application_free_local_session (server_wrk, ls);
1504 application_local_session_disconnect (u32 app_wrk_index, local_session_t * ls)
1506 app_worker_t *client_wrk, *server_wrk;
1508 client_wrk = app_worker_get_if_valid (ls->client_wrk_index);
1509 server_wrk = app_worker_get (ls->app_wrk_index);
1512 if (ls->session_state == SESSION_STATE_CLOSED)
1513 return application_local_session_cleanup (client_wrk, server_wrk, ls);
1515 if (app_wrk_index == ls->client_wrk_index)
1517 mq_send_local_session_disconnected_cb (ls->app_wrk_index, ls);
1523 return application_local_session_cleanup (client_wrk, server_wrk,
1526 else if (ls->session_state < SESSION_STATE_READY)
1528 application_t *client = application_get (client_wrk->app_index);
1529 client->cb_fns.session_connected_callback (client_wrk->wrk_index,
1531 (stream_session_t *) ls,
1533 ls->session_state = SESSION_STATE_CLOSED;
1534 return application_local_session_cleanup (client_wrk, server_wrk,
1539 mq_send_local_session_disconnected_cb (client_wrk->wrk_index, ls);
1543 ls->session_state = SESSION_STATE_CLOSED;
1549 application_local_session_disconnect_w_index (u32 app_wrk_index, u32 ls_index)
1551 app_worker_t *app_wrk;
1552 local_session_t *ls;
1553 app_wrk = app_worker_get (app_wrk_index);
1554 ls = application_get_local_session (app_wrk, ls_index);
1555 return application_local_session_disconnect (app_wrk_index, ls);
1559 application_local_sessions_free (app_worker_t * app_wrk)
1561 u32 index, server_wrk_index, session_index, table_index;
1562 segment_manager_t *sm;
1563 u64 handle, *handles = 0;
1564 local_session_t *ls, *ll;
1565 app_worker_t *server_wrk;
1566 session_endpoint_t sep;
1571 * Local listens. Don't bother with local sessions, we clean them lower
1573 app = application_get (app_wrk->app_index);
1574 table_index = application_local_session_table (app);
1576 pool_foreach (ll, app_wrk->local_listen_sessions, ({
1577 application_local_listener_session_endpoint (ll, &sep);
1578 session_lookup_del_session_endpoint (table_index, &sep);
1585 if (app_wrk->local_sessions)
1588 pool_foreach (ls, app_wrk->local_sessions, ({
1589 application_local_session_disconnect (app_wrk->wrk_index, ls);
1597 vec_reset_length (handles);
1599 hash_foreach (handle, index, app_wrk->local_connects, ({
1600 vec_add1 (handles, handle);
1604 for (i = 0; i < vec_len (handles); i++)
1606 application_client_local_connect_key_parse (handles[i],
1609 server_wrk = app_worker_get_if_valid (server_wrk_index);
1612 ls = application_get_local_session (server_wrk, session_index);
1613 application_local_session_disconnect (app_wrk->wrk_index, ls);
1617 sm = segment_manager_get (app_wrk->local_segment_manager);
1618 sm->app_wrk_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
1619 segment_manager_del (sm);
1623 vnet_app_add_tls_cert (vnet_app_add_tls_cert_args_t * a)
1626 app = application_get (a->app_index);
1628 return clib_error_return_code (0, VNET_API_ERROR_APPLICATION_NOT_ATTACHED,
1629 0, "app %u doesn't exist", a->app_index);
1630 app->tls_cert = vec_dup (a->cert);
1635 vnet_app_add_tls_key (vnet_app_add_tls_key_args_t * a)
1638 app = application_get (a->app_index);
1640 return clib_error_return_code (0, VNET_API_ERROR_APPLICATION_NOT_ATTACHED,
1641 0, "app %u doesn't exist", a->app_index);
1642 app->tls_key = vec_dup (a->key);
1647 format_app_worker_listener (u8 * s, va_list * args)
1649 app_worker_t *app_wrk = va_arg (*args, app_worker_t *);
1650 u64 handle = va_arg (*args, u64);
1651 u32 sm_index = va_arg (*args, u32);
1652 int verbose = va_arg (*args, int);
1653 stream_session_t *listener;
1660 s = format (s, "%-40s%-25s%-15s%-15s%-10s", "Connection", "App",
1661 "API Client", "ListenerID", "SegManager");
1663 s = format (s, "%-40s%-25s", "Connection", "App");
1668 app = application_get (app_wrk->app_index);
1669 app_name = app_get_name_from_reg_index (app);
1670 listener = listen_session_get_from_handle (handle);
1671 str = format (0, "%U", format_stream_session, listener, verbose);
1675 s = format (s, "%-40s%-25s%-15u%-15u%-10u", str, app_name,
1676 app->api_client_index, handle, sm_index);
1679 s = format (s, "%-40s%-25s", str, app_name);
1681 vec_free (app_name);
1686 application_format_listeners (application_t * app, int verbose)
1688 vlib_main_t *vm = vlib_get_main ();
1689 app_worker_map_t *wrk_map;
1690 app_worker_t *app_wrk;
1696 vlib_cli_output (vm, "%U", format_app_worker_listener, 0 /* header */ ,
1702 pool_foreach (wrk_map, app->worker_maps, ({
1703 app_wrk = app_worker_get (wrk_map->wrk_index);
1704 if (hash_elts (app_wrk->listeners_table) == 0)
1706 hash_foreach (handle, sm_index, app_wrk->listeners_table, ({
1707 vlib_cli_output (vm, "%U", format_app_worker_listener, app_wrk,
1708 handle, sm_index, verbose);
1715 app_worker_format_connects (app_worker_t * app_wrk, int verbose)
1717 svm_fifo_segment_private_t *fifo_segment;
1718 vlib_main_t *vm = vlib_get_main ();
1719 segment_manager_t *sm;
1720 u8 *app_name, *s = 0;
1727 vlib_cli_output (vm, "%-40s%-20s%-15s%-10s", "Connection", "App",
1728 "API Client", "SegManager");
1730 vlib_cli_output (vm, "%-40s%-20s", "Connection", "App");
1734 app = application_get (app_wrk->app_index);
1735 if (app_wrk->connects_seg_manager == (u32) ~ 0)
1738 app_name = app_get_name_from_reg_index (app);
1740 /* Across all fifo segments */
1741 sm = segment_manager_get (app_wrk->connects_seg_manager);
1744 segment_manager_foreach_segment_w_lock (fifo_segment, sm, ({
1748 fifo = svm_fifo_segment_get_fifo_list (fifo_segment);
1751 u32 session_index, thread_index;
1752 stream_session_t *session;
1754 session_index = fifo->master_session_index;
1755 thread_index = fifo->master_thread_index;
1757 session = session_get (session_index, thread_index);
1758 str = format (0, "%U", format_stream_session, session, verbose);
1761 s = format (s, "%-40s%-20s%-15u%-10u", str, app_name,
1762 app->api_client_index, app_wrk->connects_seg_manager);
1764 s = format (s, "%-40s%-20s", str, app_name);
1766 vlib_cli_output (vm, "%v", s);
1767 vec_reset_length (s);
1776 vec_free (app_name);
1780 application_format_connects (application_t * app, int verbose)
1782 app_worker_map_t *wrk_map;
1783 app_worker_t *app_wrk;
1787 app_worker_format_connects (0, verbose);
1792 pool_foreach (wrk_map, app->worker_maps, ({
1793 app_wrk = app_worker_get (wrk_map->wrk_index);
1794 app_worker_format_connects (app_wrk, verbose);
1800 app_worker_format_local_sessions (app_worker_t * app_wrk, int verbose)
1802 vlib_main_t *vm = vlib_get_main ();
1803 local_session_t *ls;
1804 transport_proto_t tp;
1810 vlib_cli_output (vm, "%-40s%-15s%-20s", "Connection", "ServerApp",
1815 if (!pool_elts (app_wrk->local_sessions)
1816 && !pool_elts (app_wrk->local_connects))
1820 pool_foreach (ls, app_wrk->local_listen_sessions, ({
1821 tp = session_type_transport_proto(ls->listener_session_type);
1822 conn = format (0, "[L][%U] *:%u", format_transport_proto_short, tp,
1824 vlib_cli_output (vm, "%-40v%-15u%-20s", conn, ls->app_wrk_index, "*");
1825 vec_reset_length (conn);
1827 pool_foreach (ls, app_wrk->local_sessions, ({
1828 tp = session_type_transport_proto(ls->listener_session_type);
1829 conn = format (0, "[L][%U] *:%u", format_transport_proto_short, tp,
1831 vlib_cli_output (vm, "%-40v%-15u%-20u", conn, ls->app_wrk_index,
1832 ls->client_wrk_index);
1833 vec_reset_length (conn);
1841 application_format_local_sessions (application_t * app, int verbose)
1843 app_worker_map_t *wrk_map;
1844 app_worker_t *app_wrk;
1848 app_worker_format_local_sessions (0, verbose);
1853 pool_foreach (wrk_map, app->worker_maps, ({
1854 app_wrk = app_worker_get (wrk_map->wrk_index);
1855 app_worker_format_local_sessions (app_wrk, verbose);
1861 app_worker_format_local_connects (app_worker_t * app, int verbose)
1863 vlib_main_t *vm = vlib_get_main ();
1864 u32 app_wrk_index, session_index;
1865 app_worker_t *server_wrk;
1866 local_session_t *ls;
1874 vlib_cli_output (vm, "%-40s%-15s%-20s%-10s", "Connection", "App",
1875 "Peer App", "SegManager");
1877 vlib_cli_output (vm, "%-40s%-15s%-20s", "Connection", "App",
1882 if (!app->local_connects)
1886 hash_foreach (client_key, value, app->local_connects, ({
1887 application_client_local_connect_key_parse (client_key, &app_wrk_index,
1889 server_wrk = app_worker_get (app_wrk_index);
1890 ls = application_get_local_session (server_wrk, session_index);
1891 vlib_cli_output (vm, "%-40s%-15s%-20s", "TODO", ls->app_wrk_index,
1892 ls->client_wrk_index);
1898 application_format_local_connects (application_t * app, int verbose)
1900 app_worker_map_t *wrk_map;
1901 app_worker_t *app_wrk;
1905 app_worker_format_local_connects (0, verbose);
1910 pool_foreach (wrk_map, app->worker_maps, ({
1911 app_wrk = app_worker_get (wrk_map->wrk_index);
1912 app_worker_format_local_connects (app_wrk, verbose);
1918 format_application (u8 * s, va_list * args)
1920 application_t *app = va_arg (*args, application_t *);
1921 CLIB_UNUSED (int verbose) = va_arg (*args, int);
1922 segment_manager_properties_t *props;
1923 const u8 *app_ns_name;
1929 s = format (s, "%-10s%-20s%-15s%-15s%-15s%-15s%-15s", "Index", "Name",
1930 "API Client", "Namespace", "Add seg size", "Rx-f size",
1933 s = format (s, "%-10s%-20s%-15s%-40s", "Index", "Name", "API Client",
1938 app_name = app_get_name (app);
1939 app_ns_name = app_namespace_id_from_index (app->ns_index);
1940 props = application_segment_manager_properties (app);
1942 s = format (s, "%-10u%-20s%-15d%-15u%-15U%-15U%-15U", app->app_index,
1943 app_name, app->api_client_index, app->ns_index,
1944 format_memory_size, props->add_segment_size,
1945 format_memory_size, props->rx_fifo_size, format_memory_size,
1946 props->tx_fifo_size);
1948 s = format (s, "%-10u%-20s%-15d%-40s", app->app_index, app_name,
1949 app->api_client_index, app_ns_name);
1954 application_format_all_listeners (vlib_main_t * vm, int do_local, int verbose)
1958 if (!pool_elts (app_main.app_pool))
1960 vlib_cli_output (vm, "No active server bindings");
1966 application_format_local_sessions (0, verbose);
1968 pool_foreach (app, app_main.app_pool, ({
1969 application_format_local_sessions (app, verbose);
1975 application_format_listeners (0, verbose);
1978 pool_foreach (app, app_main.app_pool, ({
1979 application_format_listeners (app, verbose);
1986 application_format_all_clients (vlib_main_t * vm, int do_local, int verbose)
1990 if (!pool_elts (app_main.app_pool))
1992 vlib_cli_output (vm, "No active apps");
1998 application_format_local_connects (0, verbose);
2001 pool_foreach (app, app_main.app_pool, ({
2002 application_format_local_connects (app, verbose);
2008 application_format_connects (0, verbose);
2011 pool_foreach (app, app_main.app_pool, ({
2012 application_format_connects (app, verbose);
2018 static clib_error_t *
2019 show_app_command_fn (vlib_main_t * vm, unformat_input_t * input,
2020 vlib_cli_command_t * cmd)
2022 int do_server = 0, do_client = 0, do_local = 0;
2026 session_cli_return_if_not_enabled ();
2028 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2030 if (unformat (input, "server"))
2032 else if (unformat (input, "client"))
2034 else if (unformat (input, "local"))
2036 else if (unformat (input, "verbose"))
2043 application_format_all_listeners (vm, do_local, verbose);
2046 application_format_all_clients (vm, do_local, verbose);
2048 /* Print app related info */
2049 if (!do_server && !do_client)
2051 vlib_cli_output (vm, "%U", format_application, 0, verbose);
2053 pool_foreach (app, app_main.app_pool, ({
2054 vlib_cli_output (vm, "%U", format_application, app, verbose);
2063 VLIB_CLI_COMMAND (show_app_command, static) =
2066 .short_help = "show app [server|client] [verbose]",
2067 .function = show_app_command_fn,
2072 * fd.io coding-style-patch-verification: ON
2075 * eval: (c-set-style "gnu")