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>
22 * Pool from which we allocate all applications
24 static application_t *app_pool;
27 * Hash table of apps by api client index
29 static uword *app_by_api_client_index;
32 app_get_name_from_reg_index (application_t * app)
36 vl_api_registration_t *regp;
37 regp = vl_api_client_index_to_registration (app->api_client_index);
39 app_name = format (0, "builtin-%d%c", app->index, 0);
41 app_name = format (0, "%s%c", regp->name, 0);
47 application_session_table (application_t * app, u8 fib_proto)
49 app_namespace_t *app_ns;
50 app_ns = app_namespace_get (app->ns_index);
51 if (!application_has_global_scope (app))
52 return APP_INVALID_INDEX;
53 if (fib_proto == FIB_PROTOCOL_IP4)
54 return session_lookup_get_index_for_fib (fib_proto,
55 app_ns->ip4_fib_index);
57 return session_lookup_get_index_for_fib (fib_proto,
58 app_ns->ip6_fib_index);
62 application_local_session_table (application_t * app)
64 app_namespace_t *app_ns;
65 if (!application_has_local_scope (app))
66 return APP_INVALID_INDEX;
67 app_ns = app_namespace_get (app->ns_index);
68 return app_ns->local_table_index;
72 application_api_queue_is_full (application_t * app)
76 /* builtin servers are always OK */
77 if (app->api_client_index == ~0)
80 q = vl_api_client_index_to_input_queue (app->api_client_index);
84 if (q->cursize == q->maxsize)
92 * Since the name is not stored per app, we generate it on the fly. It is
93 * the caller's responsibility to free the vector
96 application_name_from_index (u32 app_index)
98 application_t *app = application_get (app_index);
101 return app_get_name_from_reg_index (app);
105 application_table_add (application_t * app)
107 hash_set (app_by_api_client_index, app->api_client_index, app->index);
111 application_table_del (application_t * app)
113 hash_unset (app_by_api_client_index, app->api_client_index);
117 application_lookup (u32 api_client_index)
120 p = hash_get (app_by_api_client_index, api_client_index);
122 return application_get (p[0]);
131 pool_get (app_pool, app);
132 memset (app, 0, sizeof (*app));
133 app->index = application_get_index (app);
134 app->connects_seg_manager = APP_INVALID_SEGMENT_MANAGER_INDEX;
135 app->first_segment_manager = APP_INVALID_SEGMENT_MANAGER_INDEX;
136 app->local_segment_manager = APP_INVALID_SEGMENT_MANAGER_INDEX;
138 clib_warning ("[%d] New app (%d)", getpid (), app->index);
143 application_del (application_t * app)
145 vnet_unbind_args_t _a, *a = &_a;
146 u64 handle, *handles = 0;
147 segment_manager_t *sm;
152 * The app event queue allocated in first segment is cleared with
153 * the segment manager. No need to explicitly free it.
156 clib_warning ("[%d] Delete app (%d)", getpid (), app->index);
158 if (application_is_proxy (app))
159 application_remove_proxy (app);
166 hash_foreach (handle, index, app->listeners_table,
168 vec_add1 (handles, handle);
169 sm = segment_manager_get (index);
170 sm->app_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
174 for (i = 0; i < vec_len (handles); i++)
176 a->app_index = app->index;
177 a->handle = handles[i];
178 /* seg manager is removed when unbind completes */
183 * Connects segment manager cleanup
186 if (app->connects_seg_manager != APP_INVALID_SEGMENT_MANAGER_INDEX)
188 sm = segment_manager_get (app->connects_seg_manager);
189 sm->app_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
190 segment_manager_init_del (sm);
193 /* If first segment manager is used by a listener */
194 if (app->first_segment_manager != APP_INVALID_SEGMENT_MANAGER_INDEX
195 && app->first_segment_manager != app->connects_seg_manager)
197 sm = segment_manager_get (app->first_segment_manager);
198 /* .. and has no fifos, e.g. it might be used for redirected sessions,
200 if (!segment_manager_has_fifos (sm))
202 sm->app_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
203 segment_manager_del (sm);
208 * Local connections cleanup
210 application_local_sessions_del (app);
212 vec_free (app->tls_cert);
213 vec_free (app->tls_key);
215 application_table_del (app);
216 pool_put (app_pool, app);
220 application_verify_cb_fns (session_cb_vft_t * cb_fns)
222 if (cb_fns->session_accept_callback == 0)
223 clib_warning ("No accept callback function provided");
224 if (cb_fns->session_connected_callback == 0)
225 clib_warning ("No session connected callback function provided");
226 if (cb_fns->session_disconnect_callback == 0)
227 clib_warning ("No session disconnect callback function provided");
228 if (cb_fns->session_reset_callback == 0)
229 clib_warning ("No session reset callback function provided");
233 * Check app config for given segment type
235 * Returns 1 on success and 0 otherwise
238 application_verify_cfg (ssvm_segment_type_t st)
241 if (st == SSVM_SEGMENT_MEMFD)
243 is_valid = (session_manager_get_evt_q_segment () != 0);
245 clib_warning ("memfd seg: vpp's event qs IN binary api svm region");
248 else if (st == SSVM_SEGMENT_SHM)
250 is_valid = (session_manager_get_evt_q_segment () == 0);
252 clib_warning ("shm seg: vpp's event qs NOT IN binary api svm region");
260 application_init (application_t * app, u32 api_client_index, u64 * options,
261 session_cb_vft_t * cb_fns)
263 ssvm_segment_type_t seg_type = SSVM_SEGMENT_MEMFD;
264 u32 first_seg_size, prealloc_fifo_pairs;
265 segment_manager_properties_t *props;
266 vl_api_registration_t *reg;
267 segment_manager_t *sm;
271 * Make sure we support the requested configuration
274 if (!(options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_IS_BUILTIN))
276 reg = vl_api_client_index_to_registration (api_client_index);
278 return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
279 if (vl_api_registration_file_index (reg) == VL_API_INVALID_FI)
280 seg_type = SSVM_SEGMENT_SHM;
284 seg_type = SSVM_SEGMENT_PRIVATE;
287 if (!application_verify_cfg (seg_type))
288 return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
291 * Setup segment manager
293 sm = segment_manager_new ();
294 sm->app_index = app->index;
295 props = application_segment_manager_properties (app);
296 segment_manager_properties_init (props);
297 if (options[APP_OPTIONS_ADD_SEGMENT_SIZE])
299 props->add_segment_size = options[APP_OPTIONS_ADD_SEGMENT_SIZE];
300 props->add_segment = 1;
302 if (options[APP_OPTIONS_RX_FIFO_SIZE])
303 props->rx_fifo_size = options[APP_OPTIONS_RX_FIFO_SIZE];
304 if (options[APP_OPTIONS_TX_FIFO_SIZE])
305 props->tx_fifo_size = options[APP_OPTIONS_TX_FIFO_SIZE];
306 if (options[APP_OPTIONS_EVT_QUEUE_SIZE])
307 props->evt_q_size = options[APP_OPTIONS_EVT_QUEUE_SIZE];
308 props->segment_type = seg_type;
310 first_seg_size = options[APP_OPTIONS_SEGMENT_SIZE];
311 prealloc_fifo_pairs = options[APP_OPTIONS_PREALLOC_FIFO_PAIRS];
313 if ((rv = segment_manager_init (sm, first_seg_size, prealloc_fifo_pairs)))
315 sm->first_is_protected = 1;
320 app->first_segment_manager = segment_manager_index (sm);
321 app->api_client_index = api_client_index;
322 app->flags = options[APP_OPTIONS_FLAGS];
323 app->cb_fns = *cb_fns;
324 app->ns_index = options[APP_OPTIONS_NAMESPACE];
325 app->listeners_table = hash_create (0, sizeof (u64));
326 app->local_connects = hash_create (0, sizeof (u64));
327 app->proxied_transports = options[APP_OPTIONS_PROXY_TRANSPORT];
328 app->event_queue = segment_manager_event_queue (sm);
330 /* If no scope enabled, default to global */
331 if (!application_has_global_scope (app)
332 && !application_has_local_scope (app))
333 app->flags |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
335 /* Check that the obvious things are properly set up */
336 application_verify_cb_fns (cb_fns);
338 /* Add app to lookup by api_client_index table */
339 application_table_add (app);
342 * Segment manager for local sessions
344 sm = segment_manager_new ();
345 sm->app_index = app->index;
346 app->local_segment_manager = segment_manager_index (sm);
352 application_get (u32 index)
354 if (index == APP_INVALID_INDEX)
356 return pool_elt_at_index (app_pool, index);
360 application_get_if_valid (u32 index)
362 if (pool_is_free_index (app_pool, index))
365 return pool_elt_at_index (app_pool, index);
369 application_get_index (application_t * app)
371 return app - app_pool;
374 static segment_manager_t *
375 application_alloc_segment_manager (application_t * app)
377 segment_manager_t *sm = 0;
379 /* If the first segment manager is not in use, don't allocate a new one */
380 if (app->first_segment_manager != APP_INVALID_SEGMENT_MANAGER_INDEX
381 && app->first_segment_manager_in_use == 0)
383 sm = segment_manager_get (app->first_segment_manager);
384 app->first_segment_manager_in_use = 1;
388 sm = segment_manager_new ();
389 sm->app_index = app->index;
395 * Start listening local transport endpoint for requested transport.
397 * Creates a 'dummy' stream session with state LISTENING to be used in session
398 * lookups, prior to establishing connection. Requests transport to build
399 * it's own specific listening connection.
402 application_start_listen (application_t * srv, session_endpoint_t * sep,
403 session_handle_t * res)
405 segment_manager_t *sm;
407 session_handle_t handle;
410 sst = session_type_from_proto_and_ip (sep->transport_proto, sep->is_ip4);
411 s = listen_session_new (sst);
412 s->app_index = srv->index;
414 if (stream_session_listen (s, sep))
417 /* Allocate segment manager. All sessions derived out of a listen session
418 * have fifos allocated by the same segment manager. */
419 sm = application_alloc_segment_manager (srv);
423 /* Add to app's listener table. Useful to find all child listeners
424 * when app goes down, although, just for unbinding this is not needed */
425 handle = listen_session_get_handle (s);
426 hash_set (srv->listeners_table, handle, segment_manager_index (sm));
432 listen_session_del (s);
437 * Stop listening on session associated to handle
440 application_stop_listen (application_t * srv, session_handle_t handle)
442 stream_session_t *listener;
444 segment_manager_t *sm;
446 if (srv && hash_get (srv->listeners_table, handle) == 0)
448 clib_warning ("app doesn't own handle %llu!", handle);
452 listener = listen_session_get_from_handle (handle);
453 stream_session_stop_listen (listener);
455 indexp = hash_get (srv->listeners_table, handle);
458 sm = segment_manager_get (*indexp);
459 if (srv->first_segment_manager == *indexp)
461 /* Delete sessions but don't remove segment manager */
462 srv->first_segment_manager_in_use = 0;
463 segment_manager_del_sessions (sm);
467 segment_manager_init_del (sm);
469 hash_unset (srv->listeners_table, handle);
470 listen_session_del (listener);
476 application_open_session (application_t * app, session_endpoint_t * sep,
481 /* Make sure we have a segment manager for connects */
482 application_alloc_connects_segment_manager (app);
484 if ((rv = session_open (app->index, sep, api_context)))
491 application_alloc_connects_segment_manager (application_t * app)
493 segment_manager_t *sm;
495 if (app->connects_seg_manager == APP_INVALID_SEGMENT_MANAGER_INDEX)
497 sm = application_alloc_segment_manager (app);
500 app->connects_seg_manager = segment_manager_index (sm);
506 application_get_connect_segment_manager (application_t * app)
508 ASSERT (app->connects_seg_manager != (u32) ~ 0);
509 return segment_manager_get (app->connects_seg_manager);
513 application_get_listen_segment_manager (application_t * app,
514 stream_session_t * s)
517 smp = hash_get (app->listeners_table, listen_session_get_handle (s));
519 return segment_manager_get (*smp);
523 application_get_local_segment_manager (application_t * app)
525 return segment_manager_get (app->local_segment_manager);
529 application_get_local_segment_manager_w_session (application_t * app,
530 local_session_t * ls)
532 stream_session_t *listener;
533 if (application_local_session_listener_has_transport (ls))
535 listener = listen_session_get (ls->listener_session_type,
537 return application_get_listen_segment_manager (app, listener);
539 return segment_manager_get (app->local_segment_manager);
543 application_is_proxy (application_t * app)
545 return (app->flags & APP_OPTIONS_FLAGS_IS_PROXY);
549 application_is_builtin (application_t * app)
551 return (app->flags & APP_OPTIONS_FLAGS_IS_BUILTIN);
555 application_is_builtin_proxy (application_t * app)
557 return (application_is_proxy (app) && application_is_builtin (app));
561 * Send an API message to the external app, to map new segment
564 application_add_segment_notify (u32 app_index, ssvm_private_t * fs)
566 application_t *app = application_get (app_index);
567 return app->cb_fns.add_segment_callback (app->api_client_index, fs);
571 application_has_local_scope (application_t * app)
573 return app->flags & APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
577 application_has_global_scope (application_t * app)
579 return app->flags & APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
583 application_n_listeners (application_t * app)
585 return hash_elts (app->listeners_table);
589 application_first_listener (application_t * app, u8 fib_proto,
592 stream_session_t *listener;
597 sst = session_type_from_proto_and_ip (transport_proto,
598 fib_proto == FIB_PROTOCOL_IP4);
601 hash_foreach (handle, sm_index, app->listeners_table, ({
602 listener = listen_session_get_from_handle (handle);
603 if (listener->session_type == sst
604 && listener->listener_index != SESSION_PROXY_LISTENER_INDEX)
613 application_proxy_listener (application_t * app, u8 fib_proto,
616 stream_session_t *listener;
621 sst = session_type_from_proto_and_ip (transport_proto,
622 fib_proto == FIB_PROTOCOL_IP4);
625 hash_foreach (handle, sm_index, app->listeners_table, ({
626 listener = listen_session_get_from_handle (handle);
627 if (listener->session_type == sst
628 && listener->listener_index == SESSION_PROXY_LISTENER_INDEX)
636 static clib_error_t *
637 application_start_stop_proxy_fib_proto (application_t * app, u8 fib_proto,
638 u8 transport_proto, u8 is_start)
640 app_namespace_t *app_ns = app_namespace_get (app->ns_index);
641 u8 is_ip4 = (fib_proto == FIB_PROTOCOL_IP4);
642 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
643 transport_connection_t *tc;
649 s = application_first_listener (app, fib_proto, transport_proto);
653 sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
654 sep.sw_if_index = app_ns->sw_if_index;
655 sep.transport_proto = transport_proto;
656 application_start_listen (app, &sep, &handle);
657 s = listen_session_get_from_handle (handle);
658 s->listener_index = SESSION_PROXY_LISTENER_INDEX;
663 s = application_proxy_listener (app, fib_proto, transport_proto);
667 tc = listen_session_get_transport (s);
669 if (!ip_is_zero (&tc->lcl_ip, 1))
673 sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
674 sep.transport_proto = transport_proto;
676 sti = session_lookup_get_index_for_fib (fib_proto, sep.fib_index);
678 session_lookup_add_session_endpoint (sti, &sep, s->session_index);
680 session_lookup_del_session_endpoint (sti, &sep);
687 application_start_stop_proxy_local_scope (application_t * app,
688 u8 transport_proto, u8 is_start)
690 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
691 app_namespace_t *app_ns;
692 app_ns = app_namespace_get (app->ns_index);
694 sep.transport_proto = transport_proto;
699 session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
702 session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
707 session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
709 session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
714 application_start_stop_proxy (application_t * app,
715 transport_proto_t transport_proto, u8 is_start)
717 if (application_has_local_scope (app))
718 application_start_stop_proxy_local_scope (app, transport_proto, is_start);
720 if (application_has_global_scope (app))
722 application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP4,
723 transport_proto, is_start);
724 application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP6,
725 transport_proto, is_start);
730 application_setup_proxy (application_t * app)
732 u16 transports = app->proxied_transports;
733 transport_proto_t tp;
735 ASSERT (application_is_proxy (app));
738 transport_proto_foreach (tp, ({
739 if (transports & (1 << tp))
740 application_start_stop_proxy (app, tp, 1);
746 application_remove_proxy (application_t * app)
748 u16 transports = app->proxied_transports;
749 transport_proto_t tp;
751 ASSERT (application_is_proxy (app));
754 transport_proto_foreach (tp, ({
755 if (transports & (1 << tp))
756 application_start_stop_proxy (app, tp, 0);
761 segment_manager_properties_t *
762 application_segment_manager_properties (application_t * app)
764 return &app->sm_properties;
767 segment_manager_properties_t *
768 application_get_segment_manager_properties (u32 app_index)
770 application_t *app = application_get (app_index);
771 return &app->sm_properties;
775 application_alloc_local_session (application_t * app)
778 pool_get (app->local_sessions, s);
779 memset (s, 0, sizeof (*s));
780 s->app_index = app->index;
781 s->session_index = s - app->local_sessions;
782 s->session_type = session_type_from_proto_and_ip (TRANSPORT_PROTO_NONE, 0);
787 application_free_local_session (application_t * app, local_session_t * s)
789 pool_put (app->local_sessions, s);
791 memset (s, 0xfc, sizeof (*s));
795 application_get_local_session (application_t * app, u32 session_index)
797 return pool_elt_at_index (app->local_sessions, session_index);
801 application_get_local_session_from_handle (session_handle_t handle)
803 application_t *server;
804 u32 session_index, server_index;
805 local_session_parse_handle (handle, &server_index, &session_index);
806 server = application_get (server_index);
807 return application_get_local_session (server, session_index);
811 application_local_listener_session_endpoint (local_session_t * ll,
812 session_endpoint_t * sep)
814 sep->transport_proto =
815 session_type_transport_proto (ll->listener_session_type);
816 sep->port = ll->port;
817 sep->is_ip4 = ll->listener_session_type & 1;
821 application_start_local_listen (application_t * server,
822 session_endpoint_t * sep,
823 session_handle_t * handle)
829 table_index = application_local_session_table (server);
831 /* An exact sep match, as opposed to session_lookup_local_listener */
832 lh = session_lookup_endpoint_listener (table_index, sep, 1);
833 if (lh != SESSION_INVALID_HANDLE)
834 return VNET_API_ERROR_ADDRESS_IN_USE;
836 pool_get (server->local_listen_sessions, ll);
837 memset (ll, 0, sizeof (*ll));
838 ll->session_type = session_type_from_proto_and_ip (TRANSPORT_PROTO_NONE, 0);
839 ll->app_index = server->index;
840 ll->session_index = ll - server->local_listen_sessions;
841 ll->port = sep->port;
842 /* Store the original session type for the unbind */
843 ll->listener_session_type =
844 session_type_from_proto_and_ip (sep->transport_proto, sep->is_ip4);
845 ll->transport_listener_index = ~0;
847 *handle = application_local_session_handle (ll);
848 session_lookup_add_session_endpoint (table_index, sep, *handle);
854 * Clean up local session table. If we have a listener session use it to
855 * find the port and proto. If not, the handle must be a local table handle
859 application_stop_local_listen (application_t * server, session_handle_t lh)
861 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
862 u32 table_index, ll_index, server_index;
863 stream_session_t *sl = 0;
864 local_session_t *ll, *ls;
866 table_index = application_local_session_table (server);
868 /* We have both local and global table binds. Figure from global what
869 * the sep we should be cleaning up is.
871 if (!session_handle_is_local (lh))
873 sl = listen_session_get_from_handle (lh);
874 if (!sl || listen_session_get_local_session_endpoint (sl, &sep))
876 clib_warning ("broken listener");
879 lh = session_lookup_endpoint_listener (table_index, &sep, 0);
880 if (lh == SESSION_INVALID_HANDLE)
884 local_session_parse_handle (lh, &server_index, &ll_index);
885 ASSERT (server->index == server_index);
886 if (!(ll = application_get_local_listen_session (server, ll_index)))
888 clib_warning ("no local listener");
891 application_local_listener_session_endpoint (ll, &sep);
892 session_lookup_del_session_endpoint (table_index, &sep);
895 pool_foreach (ls, server->local_sessions, ({
896 if (ls->listener_index == ll->session_index)
897 application_local_session_disconnect (server->index, ls);
900 pool_put_index (server->local_listen_sessions, ll->session_index);
906 application_local_session_connect (u32 table_index, application_t * client,
907 application_t * server,
908 local_session_t * ll, u32 opaque)
910 u32 seg_size, evt_q_sz, evt_q_elts, margin = 16 << 10;
911 segment_manager_properties_t *props, *cprops;
912 int rv, has_transport, seg_index;
913 svm_fifo_segment_private_t *seg;
914 segment_manager_t *sm;
916 svm_queue_t *sq, *cq;
918 ls = application_alloc_local_session (server);
920 props = application_segment_manager_properties (server);
921 cprops = application_segment_manager_properties (client);
922 evt_q_elts = props->evt_q_size + cprops->evt_q_size;
923 evt_q_sz = evt_q_elts * sizeof (session_fifo_event_t);
924 seg_size = props->rx_fifo_size + props->tx_fifo_size + evt_q_sz + margin;
926 has_transport = session_has_transport ((stream_session_t *) ll);
929 /* Local sessions don't have backing transport */
931 sm = application_get_local_segment_manager (server);
935 stream_session_t *sl = (stream_session_t *) ll;
936 transport_connection_t *tc;
937 tc = listen_session_get_transport (sl);
938 ls->port = tc->lcl_port;
939 sm = application_get_listen_segment_manager (server, sl);
942 seg_index = segment_manager_add_segment (sm, seg_size);
945 clib_warning ("failed to add new cut-through segment");
948 seg = segment_manager_get_segment_w_lock (sm, seg_index);
949 sq = segment_manager_alloc_queue (seg, props->evt_q_size);
950 cq = segment_manager_alloc_queue (seg, cprops->evt_q_size);
951 ls->server_evt_q = pointer_to_uword (sq);
952 ls->client_evt_q = pointer_to_uword (cq);
953 rv = segment_manager_try_alloc_fifos (seg, props->rx_fifo_size,
956 &ls->server_tx_fifo);
959 clib_warning ("failed to add fifos in cut-through segment");
960 segment_manager_segment_reader_unlock (sm);
963 ls->server_rx_fifo->master_session_index = ls->session_index;
964 ls->server_tx_fifo->master_session_index = ls->session_index;
965 ls->server_rx_fifo->master_thread_index = ~0;
966 ls->server_tx_fifo->master_thread_index = ~0;
967 ls->svm_segment_index = seg_index;
968 ls->listener_index = ll->session_index;
969 ls->client_index = client->index;
970 ls->client_opaque = opaque;
971 ls->listener_session_type = ll->session_type;
973 if ((rv = server->cb_fns.add_segment_callback (server->api_client_index,
976 clib_warning ("failed to notify server of new segment");
977 segment_manager_segment_reader_unlock (sm);
980 segment_manager_segment_reader_unlock (sm);
981 if ((rv = server->cb_fns.session_accept_callback ((stream_session_t *) ls)))
983 clib_warning ("failed to send accept cut-through notify to server");
986 if (server->flags & APP_OPTIONS_FLAGS_IS_BUILTIN)
987 application_local_session_connect_notify (ls);
993 segment_manager_del_segment (sm, seg);
998 application_client_local_connect_key (local_session_t * ls)
1000 return ((uword) ls->app_index << 32 | (uword) ls->session_index);
1004 application_client_local_connect_key_parse (uword key, u32 * app_index,
1005 u32 * session_index)
1007 *app_index = key >> 32;
1008 *session_index = key & 0xFFFFFFFF;
1012 application_local_session_connect_notify (local_session_t * ls)
1014 svm_fifo_segment_private_t *seg;
1015 application_t *client, *server;
1016 segment_manager_t *sm;
1017 int rv, is_fail = 0;
1020 client = application_get (ls->client_index);
1021 server = application_get (ls->app_index);
1022 sm = application_get_local_segment_manager_w_session (server, ls);
1023 seg = segment_manager_get_segment_w_lock (sm, ls->svm_segment_index);
1024 if ((rv = client->cb_fns.add_segment_callback (client->api_client_index,
1027 clib_warning ("failed to notify client %u of new segment",
1029 segment_manager_segment_reader_unlock (sm);
1030 application_local_session_disconnect (ls->client_index, ls);
1035 segment_manager_segment_reader_unlock (sm);
1038 client->cb_fns.session_connected_callback (client->index, ls->client_opaque,
1039 (stream_session_t *) ls,
1042 client_key = application_client_local_connect_key (ls);
1043 hash_set (client->local_connects, client_key, client_key);
1048 application_local_session_disconnect (u32 app_index, local_session_t * ls)
1050 svm_fifo_segment_private_t *seg;
1051 application_t *client, *server;
1052 segment_manager_t *sm;
1055 client = application_get_if_valid (ls->client_index);
1056 server = application_get (ls->app_index);
1058 if (ls->session_state == SESSION_STATE_CLOSED)
1061 client_key = application_client_local_connect_key (ls);
1062 sm = application_get_local_segment_manager_w_session (server, ls);
1063 seg = segment_manager_get_segment (sm, ls->svm_segment_index);
1067 hash_unset (client->local_connects, client_key);
1068 client->cb_fns.del_segment_callback (client->api_client_index,
1072 server->cb_fns.del_segment_callback (server->api_client_index,
1074 segment_manager_del_segment (sm, seg);
1075 application_free_local_session (server, ls);
1079 if (app_index == ls->client_index)
1081 send_local_session_disconnect_callback (ls->app_index, ls);
1089 else if (ls->session_state < SESSION_STATE_READY)
1091 client->cb_fns.session_connected_callback (client->index,
1093 (stream_session_t *) ls,
1095 ls->session_state = SESSION_STATE_CLOSED;
1100 send_local_session_disconnect_callback (ls->client_index, ls);
1104 ls->session_state = SESSION_STATE_CLOSED;
1110 application_local_sessions_del (application_t * app)
1112 u32 index, server_index, session_index, table_index;
1113 segment_manager_t *sm;
1114 u64 handle, *handles = 0;
1115 local_session_t *ls, *ll;
1116 application_t *server;
1117 session_endpoint_t sep;
1121 * Local listens. Don't bother with local sessions, we clean them lower
1123 table_index = application_local_session_table (app);
1125 pool_foreach (ll, app->local_listen_sessions, ({
1126 application_local_listener_session_endpoint (ll, &sep);
1127 session_lookup_del_session_endpoint (table_index, &sep);
1134 if (app->local_sessions)
1137 pool_foreach (ls, app->local_sessions, ({
1138 application_local_session_disconnect (app->index, ls);
1146 vec_reset_length (handles);
1148 hash_foreach (handle, index, app->local_connects, ({
1149 vec_add1 (handles, handle);
1153 for (i = 0; i < vec_len (handles); i++)
1155 application_client_local_connect_key_parse (handles[i], &server_index,
1157 server = application_get_if_valid (server_index);
1160 ls = application_get_local_session (server, session_index);
1161 application_local_session_disconnect (app->index, ls);
1165 sm = segment_manager_get (app->local_segment_manager);
1166 sm->app_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
1167 segment_manager_del (sm);
1171 vnet_app_add_tls_cert (vnet_app_add_tls_cert_args_t * a)
1174 app = application_get (a->app_index);
1176 return clib_error_return_code (0, VNET_API_ERROR_APPLICATION_NOT_ATTACHED,
1177 0, "app %u doesn't exist", a->app_index);
1178 app->tls_cert = vec_dup (a->cert);
1183 vnet_app_add_tls_key (vnet_app_add_tls_key_args_t * a)
1186 app = application_get (a->app_index);
1188 return clib_error_return_code (0, VNET_API_ERROR_APPLICATION_NOT_ATTACHED,
1189 0, "app %u doesn't exist", a->app_index);
1190 app->tls_key = vec_dup (a->key);
1195 format_application_listener (u8 * s, va_list * args)
1197 application_t *app = va_arg (*args, application_t *);
1198 u64 handle = va_arg (*args, u64);
1199 u32 sm_index = va_arg (*args, u32);
1200 int verbose = va_arg (*args, int);
1201 stream_session_t *listener;
1207 s = format (s, "%-40s%-20s%-15s%-15s%-10s", "Connection", "App",
1208 "API Client", "ListenerID", "SegManager");
1210 s = format (s, "%-40s%-20s", "Connection", "App");
1215 app_name = app_get_name_from_reg_index (app);
1216 listener = listen_session_get_from_handle (handle);
1217 str = format (0, "%U", format_stream_session, listener, verbose);
1221 s = format (s, "%-40s%-20s%-15u%-15u%-10u", str, app_name,
1222 app->api_client_index, handle, sm_index);
1225 s = format (s, "%-40s%-20s", str, app_name);
1227 vec_free (app_name);
1232 application_format_connects (application_t * app, int verbose)
1234 svm_fifo_segment_private_t *fifo_segment;
1235 vlib_main_t *vm = vlib_get_main ();
1236 segment_manager_t *sm;
1237 u8 *app_name, *s = 0;
1243 vlib_cli_output (vm, "%-40s%-20s%-15s%-10s", "Connection", "App",
1244 "API Client", "SegManager");
1246 vlib_cli_output (vm, "%-40s%-20s", "Connection", "App");
1251 if (app->connects_seg_manager == (u32) ~ 0)
1254 app_name = app_get_name_from_reg_index (app);
1256 /* Across all fifo segments */
1257 sm = segment_manager_get (app->connects_seg_manager);
1260 segment_manager_foreach_segment_w_lock (fifo_segment, sm, ({
1264 fifo = svm_fifo_segment_get_fifo_list (fifo_segment);
1267 u32 session_index, thread_index;
1268 stream_session_t *session;
1270 session_index = fifo->master_session_index;
1271 thread_index = fifo->master_thread_index;
1273 session = session_get (session_index, thread_index);
1274 str = format (0, "%U", format_stream_session, session, verbose);
1277 s = format (s, "%-40s%-20s%-15u%-10u", str, app_name,
1278 app->api_client_index, app->connects_seg_manager);
1280 s = format (s, "%-40s%-20s", str, app_name);
1282 vlib_cli_output (vm, "%v", s);
1283 vec_reset_length (s);
1292 vec_free (app_name);
1296 application_format_local_sessions (application_t * app, int verbose)
1298 vlib_main_t *vm = vlib_get_main ();
1299 local_session_t *ls;
1300 transport_proto_t tp;
1306 vlib_cli_output (vm, "%-40s%-15s%-20s", "Connection", "ServerApp",
1312 pool_foreach (ls, app->local_listen_sessions, ({
1313 tp = session_type_transport_proto(ls->listener_session_type);
1314 conn = format (0, "[L][%U] *:%u", format_transport_proto_short, tp,
1316 vlib_cli_output (vm, "%-40v%-15u%-20s", conn, ls->app_index, "*");
1317 vec_reset_length (conn);
1319 pool_foreach (ls, app->local_sessions, ({
1320 tp = session_type_transport_proto(ls->listener_session_type);
1321 conn = format (0, "[L][%U] *:%u", format_transport_proto_short, tp,
1323 vlib_cli_output (vm, "%-40v%-15u%-20u", conn, ls->app_index,
1325 vec_reset_length (conn);
1333 application_format_local_connects (application_t * app, int verbose)
1335 vlib_main_t *vm = vlib_get_main ();
1336 u32 app_index, session_index;
1337 application_t *server;
1338 local_session_t *ls;
1346 vlib_cli_output (vm, "%-40s%-15s%-20s%-10s", "Connection", "App",
1347 "Peer App", "SegManager");
1349 vlib_cli_output (vm, "%-40s%-15s%-20s", "Connection", "App",
1355 hash_foreach (client_key, value, app->local_connects, ({
1356 application_client_local_connect_key_parse (client_key, &app_index,
1358 server = application_get (app_index);
1359 ls = application_get_local_session (server, session_index);
1360 vlib_cli_output (vm, "%-40s%-15s%-20s", "TODO", ls->app_index, ls->client_index);
1366 format_application (u8 * s, va_list * args)
1368 application_t *app = va_arg (*args, application_t *);
1369 CLIB_UNUSED (int verbose) = va_arg (*args, int);
1370 segment_manager_properties_t *props;
1371 const u8 *app_ns_name;
1377 s = format (s, "%-10s%-20s%-15s%-15s%-15s%-15s%-15s", "Index", "Name",
1378 "API Client", "Namespace", "Add seg size", "Rx fifo size",
1382 format (s, "%-10s%-20s%-15s%-40s", "Index", "Name", "API Client",
1387 app_name = app_get_name_from_reg_index (app);
1388 app_ns_name = app_namespace_id_from_index (app->ns_index);
1389 props = application_segment_manager_properties (app);
1392 format (s, "%-10d%-20s%-15d%-15d%-15d%-15d%-15d", app->index, app_name,
1393 app->api_client_index, app->ns_index,
1394 props->add_segment_size,
1395 props->rx_fifo_size, props->tx_fifo_size);
1397 s = format (s, "%-10d%-20s%-15d%-40s", app->index, app_name,
1398 app->api_client_index, app_ns_name);
1404 application_format_all_listeners (vlib_main_t * vm, int do_local, int verbose)
1410 if (!pool_elts (app_pool))
1412 vlib_cli_output (vm, "No active server bindings");
1418 application_format_local_sessions (0, verbose);
1420 pool_foreach (app, app_pool, ({
1421 if (!pool_elts (app->local_sessions)
1422 && !pool_elts(app->local_connects))
1424 application_format_local_sessions (app, verbose);
1430 vlib_cli_output (vm, "%U", format_application_listener, 0 /* header */ ,
1434 pool_foreach (app, app_pool, ({
1435 if (hash_elts (app->listeners_table) == 0)
1437 hash_foreach (handle, sm_index, app->listeners_table, ({
1438 vlib_cli_output (vm, "%U", format_application_listener, app,
1439 handle, sm_index, verbose);
1447 application_format_all_clients (vlib_main_t * vm, int do_local, int verbose)
1451 if (!pool_elts (app_pool))
1453 vlib_cli_output (vm, "No active apps");
1459 application_format_local_connects (0, verbose);
1462 pool_foreach (app, app_pool, ({
1463 if (app->local_connects)
1464 application_format_local_connects (app, verbose);
1470 application_format_connects (0, verbose);
1473 pool_foreach (app, app_pool, ({
1474 if (app->connects_seg_manager == (u32)~0)
1476 application_format_connects (app, verbose);
1482 static clib_error_t *
1483 show_app_command_fn (vlib_main_t * vm, unformat_input_t * input,
1484 vlib_cli_command_t * cmd)
1486 int do_server = 0, do_client = 0, do_local = 0;
1490 session_cli_return_if_not_enabled ();
1492 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1494 if (unformat (input, "server"))
1496 else if (unformat (input, "client"))
1498 else if (unformat (input, "local"))
1500 else if (unformat (input, "verbose"))
1507 application_format_all_listeners (vm, do_local, verbose);
1510 application_format_all_clients (vm, do_local, verbose);
1512 /* Print app related info */
1513 if (!do_server && !do_client)
1515 vlib_cli_output (vm, "%U", format_application, 0, verbose);
1517 pool_foreach (app, app_pool, ({
1518 vlib_cli_output (vm, "%U", format_application, app, verbose);
1527 VLIB_CLI_COMMAND (show_app_command, static) =
1530 .short_help = "show app [server|client] [verbose]",
1531 .function = show_app_command_fn,
1536 * fd.io coding-style-patch-verification: ON
1539 * eval: (c-set-style "gnu")