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 * Hash table of builtin apps by name
34 static uword *app_by_name;
37 app_get_name_from_reg_index (application_t * app)
41 vl_api_registration_t *regp;
42 regp = vl_api_client_index_to_registration (app->api_client_index);
44 app_name = format (0, "builtin-%d%c", app->index, 0);
46 app_name = format (0, "%s%c", regp->name, 0);
52 app_get_name (application_t * app)
55 return app_get_name_from_reg_index (app);
60 application_session_table (application_t * app, u8 fib_proto)
62 app_namespace_t *app_ns;
63 app_ns = app_namespace_get (app->ns_index);
64 if (!application_has_global_scope (app))
65 return APP_INVALID_INDEX;
66 if (fib_proto == FIB_PROTOCOL_IP4)
67 return session_lookup_get_index_for_fib (fib_proto,
68 app_ns->ip4_fib_index);
70 return session_lookup_get_index_for_fib (fib_proto,
71 app_ns->ip6_fib_index);
75 application_local_session_table (application_t * app)
77 app_namespace_t *app_ns;
78 if (!application_has_local_scope (app))
79 return APP_INVALID_INDEX;
80 app_ns = app_namespace_get (app->ns_index);
81 return app_ns->local_table_index;
85 application_api_queue_is_full (application_t * app)
89 /* builtin servers are always OK */
90 if (app->api_client_index == ~0)
93 q = vl_api_client_index_to_input_queue (app->api_client_index);
97 if (q->cursize == q->maxsize)
105 * Since the name is not stored per app, we generate it on the fly. It is
106 * the caller's responsibility to free the vector
109 application_name_from_index (u32 app_index)
111 application_t *app = application_get (app_index);
114 return app_get_name_from_reg_index (app);
118 application_table_add (application_t * app)
120 if (app->api_client_index != APP_INVALID_INDEX)
121 hash_set (app_by_api_client_index, app->api_client_index, app->index);
123 hash_set_mem (app_by_name, app->name, app->index);
127 application_table_del (application_t * app)
129 if (app->api_client_index != APP_INVALID_INDEX)
130 hash_unset (app_by_api_client_index, app->api_client_index);
132 hash_unset_mem (app_by_name, app->name);
136 application_lookup (u32 api_client_index)
139 p = hash_get (app_by_api_client_index, api_client_index);
141 return application_get (p[0]);
147 application_lookup_name (const u8 * name)
150 p = hash_get_mem (app_by_name, name);
152 return application_get (p[0]);
161 pool_get (app_pool, app);
162 memset (app, 0, sizeof (*app));
163 app->index = application_get_index (app);
164 app->connects_seg_manager = APP_INVALID_SEGMENT_MANAGER_INDEX;
165 app->first_segment_manager = APP_INVALID_SEGMENT_MANAGER_INDEX;
166 app->local_segment_manager = APP_INVALID_SEGMENT_MANAGER_INDEX;
168 clib_warning ("[%d] New app (%d)", getpid (), app->index);
173 application_del (application_t * app)
175 vnet_unbind_args_t _a, *a = &_a;
176 u64 handle, *handles = 0;
177 segment_manager_t *sm;
182 * The app event queue allocated in first segment is cleared with
183 * the segment manager. No need to explicitly free it.
186 clib_warning ("[%d] Delete app (%d)", getpid (), app->index);
188 if (application_is_proxy (app))
189 application_remove_proxy (app);
196 hash_foreach (handle, index, app->listeners_table,
198 vec_add1 (handles, handle);
199 sm = segment_manager_get (index);
200 sm->app_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
204 for (i = 0; i < vec_len (handles); i++)
206 a->app_index = app->index;
207 a->handle = handles[i];
208 /* seg manager is removed when unbind completes */
213 * Connects segment manager cleanup
216 if (app->connects_seg_manager != APP_INVALID_SEGMENT_MANAGER_INDEX)
218 sm = segment_manager_get (app->connects_seg_manager);
219 sm->app_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
220 segment_manager_init_del (sm);
223 /* If first segment manager is used by a listener */
224 if (app->first_segment_manager != APP_INVALID_SEGMENT_MANAGER_INDEX
225 && app->first_segment_manager != app->connects_seg_manager)
227 sm = segment_manager_get (app->first_segment_manager);
228 /* .. and has no fifos, e.g. it might be used for redirected sessions,
230 if (!segment_manager_has_fifos (sm))
232 sm->app_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
233 segment_manager_del (sm);
238 * Local connections cleanup
240 application_local_sessions_del (app);
242 vec_free (app->tls_cert);
243 vec_free (app->tls_key);
245 application_table_del (app);
246 vec_free (app->name);
247 pool_put (app_pool, app);
251 application_verify_cb_fns (session_cb_vft_t * cb_fns)
253 if (cb_fns->session_accept_callback == 0)
254 clib_warning ("No accept callback function provided");
255 if (cb_fns->session_connected_callback == 0)
256 clib_warning ("No session connected callback function provided");
257 if (cb_fns->session_disconnect_callback == 0)
258 clib_warning ("No session disconnect callback function provided");
259 if (cb_fns->session_reset_callback == 0)
260 clib_warning ("No session reset callback function provided");
264 * Check app config for given segment type
266 * Returns 1 on success and 0 otherwise
269 application_verify_cfg (ssvm_segment_type_t st)
272 if (st == SSVM_SEGMENT_MEMFD)
274 is_valid = (session_manager_get_evt_q_segment () != 0);
276 clib_warning ("memfd seg: vpp's event qs IN binary api svm region");
279 else if (st == SSVM_SEGMENT_SHM)
281 is_valid = (session_manager_get_evt_q_segment () == 0);
283 clib_warning ("shm seg: vpp's event qs NOT IN binary api svm region");
291 application_init (application_t * app, u32 api_client_index, u8 * app_name,
292 u64 * options, session_cb_vft_t * cb_fns)
294 ssvm_segment_type_t seg_type = SSVM_SEGMENT_MEMFD;
295 u32 first_seg_size, prealloc_fifo_pairs;
296 segment_manager_properties_t *props;
297 vl_api_registration_t *reg;
298 segment_manager_t *sm;
302 * Make sure we support the requested configuration
305 if (!(options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_IS_BUILTIN))
307 reg = vl_api_client_index_to_registration (api_client_index);
309 return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
310 if (vl_api_registration_file_index (reg) == VL_API_INVALID_FI)
311 seg_type = SSVM_SEGMENT_SHM;
315 seg_type = SSVM_SEGMENT_PRIVATE;
318 if (!application_verify_cfg (seg_type))
319 return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
322 * Setup segment manager
324 sm = segment_manager_new ();
325 sm->app_index = app->index;
326 props = application_segment_manager_properties (app);
327 segment_manager_properties_init (props);
328 if (options[APP_OPTIONS_ADD_SEGMENT_SIZE])
330 props->add_segment_size = options[APP_OPTIONS_ADD_SEGMENT_SIZE];
331 props->add_segment = 1;
333 if (options[APP_OPTIONS_RX_FIFO_SIZE])
334 props->rx_fifo_size = options[APP_OPTIONS_RX_FIFO_SIZE];
335 if (options[APP_OPTIONS_TX_FIFO_SIZE])
336 props->tx_fifo_size = options[APP_OPTIONS_TX_FIFO_SIZE];
337 if (options[APP_OPTIONS_EVT_QUEUE_SIZE])
338 props->evt_q_size = options[APP_OPTIONS_EVT_QUEUE_SIZE];
339 if (options[APP_OPTIONS_TLS_ENGINE])
340 app->tls_engine = options[APP_OPTIONS_TLS_ENGINE];
341 props->segment_type = seg_type;
343 first_seg_size = options[APP_OPTIONS_SEGMENT_SIZE];
344 prealloc_fifo_pairs = options[APP_OPTIONS_PREALLOC_FIFO_PAIRS];
346 if ((rv = segment_manager_init (sm, first_seg_size, prealloc_fifo_pairs)))
348 sm->first_is_protected = 1;
353 app->first_segment_manager = segment_manager_index (sm);
354 app->api_client_index = api_client_index;
355 app->flags = options[APP_OPTIONS_FLAGS];
356 app->cb_fns = *cb_fns;
357 app->ns_index = options[APP_OPTIONS_NAMESPACE];
358 app->listeners_table = hash_create (0, sizeof (u64));
359 app->local_connects = hash_create (0, sizeof (u64));
360 app->proxied_transports = options[APP_OPTIONS_PROXY_TRANSPORT];
361 app->event_queue = segment_manager_event_queue (sm);
362 app->name = vec_dup (app_name);
364 /* If no scope enabled, default to global */
365 if (!application_has_global_scope (app)
366 && !application_has_local_scope (app))
367 app->flags |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
369 /* Check that the obvious things are properly set up */
370 application_verify_cb_fns (cb_fns);
372 /* Add app to lookup by api_client_index table */
373 application_table_add (app);
376 * Segment manager for local sessions
378 sm = segment_manager_new ();
379 sm->app_index = app->index;
380 app->local_segment_manager = segment_manager_index (sm);
386 application_get (u32 index)
388 if (index == APP_INVALID_INDEX)
390 return pool_elt_at_index (app_pool, index);
394 application_get_if_valid (u32 index)
396 if (pool_is_free_index (app_pool, index))
399 return pool_elt_at_index (app_pool, index);
403 application_get_index (application_t * app)
405 return app - app_pool;
408 static segment_manager_t *
409 application_alloc_segment_manager (application_t * app)
411 segment_manager_t *sm = 0;
413 /* If the first segment manager is not in use, don't allocate a new one */
414 if (app->first_segment_manager != APP_INVALID_SEGMENT_MANAGER_INDEX
415 && app->first_segment_manager_in_use == 0)
417 sm = segment_manager_get (app->first_segment_manager);
418 app->first_segment_manager_in_use = 1;
422 sm = segment_manager_new ();
423 sm->app_index = app->index;
429 * Start listening local transport endpoint for requested transport.
431 * Creates a 'dummy' stream session with state LISTENING to be used in session
432 * lookups, prior to establishing connection. Requests transport to build
433 * it's own specific listening connection.
436 application_start_listen (application_t * srv, session_endpoint_t * sep,
437 session_handle_t * res)
439 segment_manager_t *sm;
441 session_handle_t handle;
444 sst = session_type_from_proto_and_ip (sep->transport_proto, sep->is_ip4);
445 s = listen_session_new (0, sst);
446 s->app_index = srv->index;
448 if (stream_session_listen (s, sep))
451 /* Allocate segment manager. All sessions derived out of a listen session
452 * have fifos allocated by the same segment manager. */
453 sm = application_alloc_segment_manager (srv);
457 /* Add to app's listener table. Useful to find all child listeners
458 * when app goes down, although, just for unbinding this is not needed */
459 handle = listen_session_get_handle (s);
460 hash_set (srv->listeners_table, handle, segment_manager_index (sm));
466 listen_session_del (s);
471 * Stop listening on session associated to handle
474 application_stop_listen (application_t * srv, session_handle_t handle)
476 stream_session_t *listener;
478 segment_manager_t *sm;
480 if (srv && hash_get (srv->listeners_table, handle) == 0)
482 clib_warning ("app doesn't own handle %llu!", handle);
486 listener = listen_session_get_from_handle (handle);
487 stream_session_stop_listen (listener);
489 indexp = hash_get (srv->listeners_table, handle);
492 sm = segment_manager_get (*indexp);
493 if (srv->first_segment_manager == *indexp)
495 /* Delete sessions but don't remove segment manager */
496 srv->first_segment_manager_in_use = 0;
497 segment_manager_del_sessions (sm);
501 segment_manager_init_del (sm);
503 hash_unset (srv->listeners_table, handle);
504 listen_session_del (listener);
510 application_open_session (application_t * app, session_endpoint_t * sep,
515 /* Make sure we have a segment manager for connects */
516 application_alloc_connects_segment_manager (app);
518 if ((rv = session_open (app->index, sep, api_context)))
525 application_alloc_connects_segment_manager (application_t * app)
527 segment_manager_t *sm;
529 if (app->connects_seg_manager == APP_INVALID_SEGMENT_MANAGER_INDEX)
531 sm = application_alloc_segment_manager (app);
534 app->connects_seg_manager = segment_manager_index (sm);
540 application_get_connect_segment_manager (application_t * app)
542 ASSERT (app->connects_seg_manager != (u32) ~ 0);
543 return segment_manager_get (app->connects_seg_manager);
547 application_get_listen_segment_manager (application_t * app,
548 stream_session_t * s)
551 smp = hash_get (app->listeners_table, listen_session_get_handle (s));
553 return segment_manager_get (*smp);
557 application_get_local_segment_manager (application_t * app)
559 return segment_manager_get (app->local_segment_manager);
563 application_get_local_segment_manager_w_session (application_t * app,
564 local_session_t * ls)
566 stream_session_t *listener;
567 if (application_local_session_listener_has_transport (ls))
569 listener = listen_session_get (ls->listener_index);
570 return application_get_listen_segment_manager (app, listener);
572 return segment_manager_get (app->local_segment_manager);
576 application_is_proxy (application_t * app)
578 return (app->flags & APP_OPTIONS_FLAGS_IS_PROXY);
582 application_is_builtin (application_t * app)
584 return (app->flags & APP_OPTIONS_FLAGS_IS_BUILTIN);
588 application_is_builtin_proxy (application_t * app)
590 return (application_is_proxy (app) && application_is_builtin (app));
594 * Send an API message to the external app, to map new segment
597 application_add_segment_notify (u32 app_index, ssvm_private_t * fs)
599 application_t *app = application_get (app_index);
600 return app->cb_fns.add_segment_callback (app->api_client_index, fs);
604 application_has_local_scope (application_t * app)
606 return app->flags & APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
610 application_has_global_scope (application_t * app)
612 return app->flags & APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
616 application_n_listeners (application_t * app)
618 return hash_elts (app->listeners_table);
622 application_first_listener (application_t * app, u8 fib_proto,
625 stream_session_t *listener;
630 sst = session_type_from_proto_and_ip (transport_proto,
631 fib_proto == FIB_PROTOCOL_IP4);
634 hash_foreach (handle, sm_index, app->listeners_table, ({
635 listener = listen_session_get_from_handle (handle);
636 if (listener->session_type == sst
637 && listener->listener_index != SESSION_PROXY_LISTENER_INDEX)
646 application_proxy_listener (application_t * app, u8 fib_proto,
649 stream_session_t *listener;
654 sst = session_type_from_proto_and_ip (transport_proto,
655 fib_proto == FIB_PROTOCOL_IP4);
658 hash_foreach (handle, sm_index, app->listeners_table, ({
659 listener = listen_session_get_from_handle (handle);
660 if (listener->session_type == sst
661 && listener->listener_index == SESSION_PROXY_LISTENER_INDEX)
669 static clib_error_t *
670 application_start_stop_proxy_fib_proto (application_t * app, u8 fib_proto,
671 u8 transport_proto, u8 is_start)
673 app_namespace_t *app_ns = app_namespace_get (app->ns_index);
674 u8 is_ip4 = (fib_proto == FIB_PROTOCOL_IP4);
675 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
676 transport_connection_t *tc;
682 s = application_first_listener (app, fib_proto, transport_proto);
686 sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
687 sep.sw_if_index = app_ns->sw_if_index;
688 sep.transport_proto = transport_proto;
689 application_start_listen (app, &sep, &handle);
690 s = listen_session_get_from_handle (handle);
691 s->listener_index = SESSION_PROXY_LISTENER_INDEX;
696 s = application_proxy_listener (app, fib_proto, transport_proto);
700 tc = listen_session_get_transport (s);
702 if (!ip_is_zero (&tc->lcl_ip, 1))
706 sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
707 sep.transport_proto = transport_proto;
709 sti = session_lookup_get_index_for_fib (fib_proto, sep.fib_index);
711 session_lookup_add_session_endpoint (sti, &sep, s->session_index);
713 session_lookup_del_session_endpoint (sti, &sep);
720 application_start_stop_proxy_local_scope (application_t * app,
721 u8 transport_proto, u8 is_start)
723 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
724 app_namespace_t *app_ns;
725 app_ns = app_namespace_get (app->ns_index);
727 sep.transport_proto = transport_proto;
732 session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
735 session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
740 session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
742 session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
747 application_start_stop_proxy (application_t * app,
748 transport_proto_t transport_proto, u8 is_start)
750 if (application_has_local_scope (app))
751 application_start_stop_proxy_local_scope (app, transport_proto, is_start);
753 if (application_has_global_scope (app))
755 application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP4,
756 transport_proto, is_start);
757 application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP6,
758 transport_proto, is_start);
763 application_setup_proxy (application_t * app)
765 u16 transports = app->proxied_transports;
766 transport_proto_t tp;
768 ASSERT (application_is_proxy (app));
771 transport_proto_foreach (tp, ({
772 if (transports & (1 << tp))
773 application_start_stop_proxy (app, tp, 1);
779 application_remove_proxy (application_t * app)
781 u16 transports = app->proxied_transports;
782 transport_proto_t tp;
784 ASSERT (application_is_proxy (app));
787 transport_proto_foreach (tp, ({
788 if (transports & (1 << tp))
789 application_start_stop_proxy (app, tp, 0);
794 segment_manager_properties_t *
795 application_segment_manager_properties (application_t * app)
797 return &app->sm_properties;
800 segment_manager_properties_t *
801 application_get_segment_manager_properties (u32 app_index)
803 application_t *app = application_get (app_index);
804 return &app->sm_properties;
808 application_alloc_local_session (application_t * app)
811 pool_get (app->local_sessions, s);
812 memset (s, 0, sizeof (*s));
813 s->app_index = app->index;
814 s->session_index = s - app->local_sessions;
815 s->session_type = session_type_from_proto_and_ip (TRANSPORT_PROTO_NONE, 0);
820 application_free_local_session (application_t * app, local_session_t * s)
822 pool_put (app->local_sessions, s);
824 memset (s, 0xfc, sizeof (*s));
828 application_get_local_session (application_t * app, u32 session_index)
830 return pool_elt_at_index (app->local_sessions, session_index);
834 application_get_local_session_from_handle (session_handle_t handle)
836 application_t *server;
837 u32 session_index, server_index;
838 local_session_parse_handle (handle, &server_index, &session_index);
839 server = application_get (server_index);
840 return application_get_local_session (server, session_index);
844 application_local_listener_session_endpoint (local_session_t * ll,
845 session_endpoint_t * sep)
847 sep->transport_proto =
848 session_type_transport_proto (ll->listener_session_type);
849 sep->port = ll->port;
850 sep->is_ip4 = ll->listener_session_type & 1;
854 application_start_local_listen (application_t * server,
855 session_endpoint_t * sep,
856 session_handle_t * handle)
862 table_index = application_local_session_table (server);
864 /* An exact sep match, as opposed to session_lookup_local_listener */
865 lh = session_lookup_endpoint_listener (table_index, sep, 1);
866 if (lh != SESSION_INVALID_HANDLE)
867 return VNET_API_ERROR_ADDRESS_IN_USE;
869 pool_get (server->local_listen_sessions, ll);
870 memset (ll, 0, sizeof (*ll));
871 ll->session_type = session_type_from_proto_and_ip (TRANSPORT_PROTO_NONE, 0);
872 ll->app_index = server->index;
873 ll->session_index = ll - server->local_listen_sessions;
874 ll->port = sep->port;
875 /* Store the original session type for the unbind */
876 ll->listener_session_type =
877 session_type_from_proto_and_ip (sep->transport_proto, sep->is_ip4);
878 ll->transport_listener_index = ~0;
880 *handle = application_local_session_handle (ll);
881 session_lookup_add_session_endpoint (table_index, sep, *handle);
887 * Clean up local session table. If we have a listener session use it to
888 * find the port and proto. If not, the handle must be a local table handle
892 application_stop_local_listen (application_t * server, session_handle_t lh)
894 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
895 u32 table_index, ll_index, server_index;
896 stream_session_t *sl = 0;
897 local_session_t *ll, *ls;
899 table_index = application_local_session_table (server);
901 /* We have both local and global table binds. Figure from global what
902 * the sep we should be cleaning up is.
904 if (!session_handle_is_local (lh))
906 sl = listen_session_get_from_handle (lh);
907 if (!sl || listen_session_get_local_session_endpoint (sl, &sep))
909 clib_warning ("broken listener");
912 lh = session_lookup_endpoint_listener (table_index, &sep, 0);
913 if (lh == SESSION_INVALID_HANDLE)
917 local_session_parse_handle (lh, &server_index, &ll_index);
918 ASSERT (server->index == server_index);
919 if (!(ll = application_get_local_listen_session (server, ll_index)))
921 clib_warning ("no local listener");
924 application_local_listener_session_endpoint (ll, &sep);
925 session_lookup_del_session_endpoint (table_index, &sep);
928 pool_foreach (ls, server->local_sessions, ({
929 if (ls->listener_index == ll->session_index)
930 application_local_session_disconnect (server->index, ls);
933 pool_put_index (server->local_listen_sessions, ll->session_index);
939 application_local_session_connect (u32 table_index, application_t * client,
940 application_t * server,
941 local_session_t * ll, u32 opaque)
943 u32 seg_size, evt_q_sz, evt_q_elts, margin = 16 << 10;
944 segment_manager_properties_t *props, *cprops;
945 int rv, has_transport, seg_index;
946 svm_fifo_segment_private_t *seg;
947 segment_manager_t *sm;
949 svm_queue_t *sq, *cq;
951 ls = application_alloc_local_session (server);
953 props = application_segment_manager_properties (server);
954 cprops = application_segment_manager_properties (client);
955 evt_q_elts = props->evt_q_size + cprops->evt_q_size;
956 evt_q_sz = evt_q_elts * sizeof (session_fifo_event_t);
957 seg_size = props->rx_fifo_size + props->tx_fifo_size + evt_q_sz + margin;
959 has_transport = session_has_transport ((stream_session_t *) ll);
962 /* Local sessions don't have backing transport */
964 sm = application_get_local_segment_manager (server);
968 stream_session_t *sl = (stream_session_t *) ll;
969 transport_connection_t *tc;
970 tc = listen_session_get_transport (sl);
971 ls->port = tc->lcl_port;
972 sm = application_get_listen_segment_manager (server, sl);
975 seg_index = segment_manager_add_segment (sm, seg_size);
978 clib_warning ("failed to add new cut-through segment");
981 seg = segment_manager_get_segment_w_lock (sm, seg_index);
982 sq = segment_manager_alloc_queue (seg, props->evt_q_size);
983 cq = segment_manager_alloc_queue (seg, cprops->evt_q_size);
984 ls->server_evt_q = pointer_to_uword (sq);
985 ls->client_evt_q = pointer_to_uword (cq);
986 rv = segment_manager_try_alloc_fifos (seg, props->rx_fifo_size,
989 &ls->server_tx_fifo);
992 clib_warning ("failed to add fifos in cut-through segment");
993 segment_manager_segment_reader_unlock (sm);
996 ls->server_rx_fifo->master_session_index = ls->session_index;
997 ls->server_tx_fifo->master_session_index = ls->session_index;
998 ls->server_rx_fifo->master_thread_index = ~0;
999 ls->server_tx_fifo->master_thread_index = ~0;
1000 ls->svm_segment_index = seg_index;
1001 ls->listener_index = ll->session_index;
1002 ls->client_index = client->index;
1003 ls->client_opaque = opaque;
1004 ls->listener_session_type = ll->session_type;
1006 if ((rv = server->cb_fns.add_segment_callback (server->api_client_index,
1009 clib_warning ("failed to notify server of new segment");
1010 segment_manager_segment_reader_unlock (sm);
1013 segment_manager_segment_reader_unlock (sm);
1014 if ((rv = server->cb_fns.session_accept_callback ((stream_session_t *) ls)))
1016 clib_warning ("failed to send accept cut-through notify to server");
1019 if (server->flags & APP_OPTIONS_FLAGS_IS_BUILTIN)
1020 application_local_session_connect_notify (ls);
1026 segment_manager_del_segment (sm, seg);
1031 application_client_local_connect_key (local_session_t * ls)
1033 return ((uword) ls->app_index << 32 | (uword) ls->session_index);
1037 application_client_local_connect_key_parse (uword key, u32 * app_index,
1038 u32 * session_index)
1040 *app_index = key >> 32;
1041 *session_index = key & 0xFFFFFFFF;
1045 application_local_session_connect_notify (local_session_t * ls)
1047 svm_fifo_segment_private_t *seg;
1048 application_t *client, *server;
1049 segment_manager_t *sm;
1050 int rv, is_fail = 0;
1053 client = application_get (ls->client_index);
1054 server = application_get (ls->app_index);
1055 sm = application_get_local_segment_manager_w_session (server, ls);
1056 seg = segment_manager_get_segment_w_lock (sm, ls->svm_segment_index);
1057 if ((rv = client->cb_fns.add_segment_callback (client->api_client_index,
1060 clib_warning ("failed to notify client %u of new segment",
1062 segment_manager_segment_reader_unlock (sm);
1063 application_local_session_disconnect (ls->client_index, ls);
1068 segment_manager_segment_reader_unlock (sm);
1071 client->cb_fns.session_connected_callback (client->index, ls->client_opaque,
1072 (stream_session_t *) ls,
1075 client_key = application_client_local_connect_key (ls);
1076 hash_set (client->local_connects, client_key, client_key);
1081 application_local_session_cleanup (application_t * client,
1082 application_t * server,
1083 local_session_t * ls)
1085 svm_fifo_segment_private_t *seg;
1086 segment_manager_t *sm;
1090 has_transport = session_has_transport ((stream_session_t *) ls);
1091 client_key = application_client_local_connect_key (ls);
1093 sm = application_get_local_segment_manager_w_session (server, ls);
1095 sm = application_get_listen_segment_manager (server,
1096 (stream_session_t *) ls);
1098 seg = segment_manager_get_segment (sm, ls->svm_segment_index);
1100 hash_unset (client->local_connects, client_key);
1104 server->cb_fns.del_segment_callback (server->api_client_index,
1107 client->cb_fns.del_segment_callback (client->api_client_index,
1109 segment_manager_del_segment (sm, seg);
1112 application_free_local_session (server, ls);
1118 application_local_session_disconnect (u32 app_index, local_session_t * ls)
1120 application_t *client, *server;
1122 client = application_get_if_valid (ls->client_index);
1123 server = application_get (ls->app_index);
1125 if (ls->session_state == SESSION_STATE_CLOSED)
1126 return application_local_session_cleanup (client, server, ls);
1128 if (app_index == ls->client_index)
1130 send_local_session_disconnect_callback (ls->app_index, ls);
1136 return application_local_session_cleanup (client, server, ls);
1138 else if (ls->session_state < SESSION_STATE_READY)
1140 client->cb_fns.session_connected_callback (client->index,
1142 (stream_session_t *) ls,
1144 ls->session_state = SESSION_STATE_CLOSED;
1145 return application_local_session_cleanup (client, server, ls);
1149 send_local_session_disconnect_callback (client->index, ls);
1153 ls->session_state = SESSION_STATE_CLOSED;
1159 application_local_session_disconnect_w_index (u32 app_index, u32 ls_index)
1162 local_session_t *ls;
1163 app = application_get (app_index);
1164 ls = application_get_local_session (app, ls_index);
1165 return application_local_session_disconnect (app_index, ls);
1169 application_local_sessions_del (application_t * app)
1171 u32 index, server_index, session_index, table_index;
1172 segment_manager_t *sm;
1173 u64 handle, *handles = 0;
1174 local_session_t *ls, *ll;
1175 application_t *server;
1176 session_endpoint_t sep;
1180 * Local listens. Don't bother with local sessions, we clean them lower
1182 table_index = application_local_session_table (app);
1184 pool_foreach (ll, app->local_listen_sessions, ({
1185 application_local_listener_session_endpoint (ll, &sep);
1186 session_lookup_del_session_endpoint (table_index, &sep);
1193 if (app->local_sessions)
1196 pool_foreach (ls, app->local_sessions, ({
1197 application_local_session_disconnect (app->index, ls);
1205 vec_reset_length (handles);
1207 hash_foreach (handle, index, app->local_connects, ({
1208 vec_add1 (handles, handle);
1212 for (i = 0; i < vec_len (handles); i++)
1214 application_client_local_connect_key_parse (handles[i], &server_index,
1216 server = application_get_if_valid (server_index);
1219 ls = application_get_local_session (server, session_index);
1220 application_local_session_disconnect (app->index, ls);
1224 sm = segment_manager_get (app->local_segment_manager);
1225 sm->app_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
1226 segment_manager_del (sm);
1230 vnet_app_add_tls_cert (vnet_app_add_tls_cert_args_t * a)
1233 app = application_get (a->app_index);
1235 return clib_error_return_code (0, VNET_API_ERROR_APPLICATION_NOT_ATTACHED,
1236 0, "app %u doesn't exist", a->app_index);
1237 app->tls_cert = vec_dup (a->cert);
1242 vnet_app_add_tls_key (vnet_app_add_tls_key_args_t * a)
1245 app = application_get (a->app_index);
1247 return clib_error_return_code (0, VNET_API_ERROR_APPLICATION_NOT_ATTACHED,
1248 0, "app %u doesn't exist", a->app_index);
1249 app->tls_key = vec_dup (a->key);
1254 format_application_listener (u8 * s, va_list * args)
1256 application_t *app = va_arg (*args, application_t *);
1257 u64 handle = va_arg (*args, u64);
1258 u32 sm_index = va_arg (*args, u32);
1259 int verbose = va_arg (*args, int);
1260 stream_session_t *listener;
1266 s = format (s, "%-40s%-20s%-15s%-15s%-10s", "Connection", "App",
1267 "API Client", "ListenerID", "SegManager");
1269 s = format (s, "%-40s%-20s", "Connection", "App");
1274 app_name = app_get_name_from_reg_index (app);
1275 listener = listen_session_get_from_handle (handle);
1276 str = format (0, "%U", format_stream_session, listener, verbose);
1280 s = format (s, "%-40s%-20s%-15u%-15u%-10u", str, app_name,
1281 app->api_client_index, handle, sm_index);
1284 s = format (s, "%-40s%-20s", str, app_name);
1286 vec_free (app_name);
1291 application_format_connects (application_t * app, int verbose)
1293 svm_fifo_segment_private_t *fifo_segment;
1294 vlib_main_t *vm = vlib_get_main ();
1295 segment_manager_t *sm;
1296 u8 *app_name, *s = 0;
1302 vlib_cli_output (vm, "%-40s%-20s%-15s%-10s", "Connection", "App",
1303 "API Client", "SegManager");
1305 vlib_cli_output (vm, "%-40s%-20s", "Connection", "App");
1310 if (app->connects_seg_manager == (u32) ~ 0)
1313 app_name = app_get_name_from_reg_index (app);
1315 /* Across all fifo segments */
1316 sm = segment_manager_get (app->connects_seg_manager);
1319 segment_manager_foreach_segment_w_lock (fifo_segment, sm, ({
1323 fifo = svm_fifo_segment_get_fifo_list (fifo_segment);
1326 u32 session_index, thread_index;
1327 stream_session_t *session;
1329 session_index = fifo->master_session_index;
1330 thread_index = fifo->master_thread_index;
1332 session = session_get (session_index, thread_index);
1333 str = format (0, "%U", format_stream_session, session, verbose);
1336 s = format (s, "%-40s%-20s%-15u%-10u", str, app_name,
1337 app->api_client_index, app->connects_seg_manager);
1339 s = format (s, "%-40s%-20s", str, app_name);
1341 vlib_cli_output (vm, "%v", s);
1342 vec_reset_length (s);
1351 vec_free (app_name);
1355 application_format_local_sessions (application_t * app, int verbose)
1357 vlib_main_t *vm = vlib_get_main ();
1358 local_session_t *ls;
1359 transport_proto_t tp;
1365 vlib_cli_output (vm, "%-40s%-15s%-20s", "Connection", "ServerApp",
1371 pool_foreach (ls, app->local_listen_sessions, ({
1372 tp = session_type_transport_proto(ls->listener_session_type);
1373 conn = format (0, "[L][%U] *:%u", format_transport_proto_short, tp,
1375 vlib_cli_output (vm, "%-40v%-15u%-20s", conn, ls->app_index, "*");
1376 vec_reset_length (conn);
1378 pool_foreach (ls, app->local_sessions, ({
1379 tp = session_type_transport_proto(ls->listener_session_type);
1380 conn = format (0, "[L][%U] *:%u", format_transport_proto_short, tp,
1382 vlib_cli_output (vm, "%-40v%-15u%-20u", conn, ls->app_index,
1384 vec_reset_length (conn);
1392 application_format_local_connects (application_t * app, int verbose)
1394 vlib_main_t *vm = vlib_get_main ();
1395 u32 app_index, session_index;
1396 application_t *server;
1397 local_session_t *ls;
1405 vlib_cli_output (vm, "%-40s%-15s%-20s%-10s", "Connection", "App",
1406 "Peer App", "SegManager");
1408 vlib_cli_output (vm, "%-40s%-15s%-20s", "Connection", "App",
1414 hash_foreach (client_key, value, app->local_connects, ({
1415 application_client_local_connect_key_parse (client_key, &app_index,
1417 server = application_get (app_index);
1418 ls = application_get_local_session (server, session_index);
1419 vlib_cli_output (vm, "%-40s%-15s%-20s", "TODO", ls->app_index, ls->client_index);
1425 format_application (u8 * s, va_list * args)
1427 application_t *app = va_arg (*args, application_t *);
1428 CLIB_UNUSED (int verbose) = va_arg (*args, int);
1429 segment_manager_properties_t *props;
1430 const u8 *app_ns_name;
1436 s = format (s, "%-10s%-20s%-15s%-15s%-15s%-15s%-15s", "Index", "Name",
1437 "API Client", "Namespace", "Add seg size", "Rx fifo size",
1440 s = format (s, "%-10s%-20s%-15s%-40s", "Index", "Name", "API Client",
1445 app_name = app_get_name (app);
1446 app_ns_name = app_namespace_id_from_index (app->ns_index);
1447 props = application_segment_manager_properties (app);
1449 s = format (s, "%-10d%-20s%-15d%-15d%-15d%-15d%-15d", app->index,
1450 app_name, app->api_client_index, app->ns_index,
1451 props->add_segment_size, props->rx_fifo_size,
1452 props->tx_fifo_size);
1454 s = format (s, "%-10d%-20s%-15d%-40s", app->index, app_name,
1455 app->api_client_index, app_ns_name);
1461 application_format_all_listeners (vlib_main_t * vm, int do_local, int verbose)
1467 if (!pool_elts (app_pool))
1469 vlib_cli_output (vm, "No active server bindings");
1475 application_format_local_sessions (0, verbose);
1477 pool_foreach (app, app_pool, ({
1478 if (!pool_elts (app->local_sessions)
1479 && !pool_elts(app->local_connects))
1481 application_format_local_sessions (app, verbose);
1487 vlib_cli_output (vm, "%U", format_application_listener, 0 /* header */ ,
1491 pool_foreach (app, app_pool, ({
1492 if (hash_elts (app->listeners_table) == 0)
1494 hash_foreach (handle, sm_index, app->listeners_table, ({
1495 vlib_cli_output (vm, "%U", format_application_listener, app,
1496 handle, sm_index, verbose);
1504 application_format_all_clients (vlib_main_t * vm, int do_local, int verbose)
1508 if (!pool_elts (app_pool))
1510 vlib_cli_output (vm, "No active apps");
1516 application_format_local_connects (0, verbose);
1519 pool_foreach (app, app_pool, ({
1520 if (app->local_connects)
1521 application_format_local_connects (app, verbose);
1527 application_format_connects (0, verbose);
1530 pool_foreach (app, app_pool, ({
1531 if (app->connects_seg_manager == (u32)~0)
1533 application_format_connects (app, verbose);
1539 static clib_error_t *
1540 show_app_command_fn (vlib_main_t * vm, unformat_input_t * input,
1541 vlib_cli_command_t * cmd)
1543 int do_server = 0, do_client = 0, do_local = 0;
1547 session_cli_return_if_not_enabled ();
1549 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1551 if (unformat (input, "server"))
1553 else if (unformat (input, "client"))
1555 else if (unformat (input, "local"))
1557 else if (unformat (input, "verbose"))
1564 application_format_all_listeners (vm, do_local, verbose);
1567 application_format_all_clients (vm, do_local, verbose);
1569 /* Print app related info */
1570 if (!do_server && !do_client)
1572 vlib_cli_output (vm, "%U", format_application, 0, verbose);
1574 pool_foreach (app, app_pool, ({
1575 vlib_cli_output (vm, "%U", format_application, app, verbose);
1584 VLIB_CLI_COMMAND (show_app_command, static) =
1587 .short_help = "show app [server|client] [verbose]",
1588 .function = show_app_command_fn,
1593 * fd.io coding-style-patch-verification: ON
1596 * eval: (c-set-style "gnu")