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 application_table_del (app);
213 pool_put (app_pool, app);
217 application_verify_cb_fns (session_cb_vft_t * cb_fns)
219 if (cb_fns->session_accept_callback == 0)
220 clib_warning ("No accept callback function provided");
221 if (cb_fns->session_connected_callback == 0)
222 clib_warning ("No session connected callback function provided");
223 if (cb_fns->session_disconnect_callback == 0)
224 clib_warning ("No session disconnect callback function provided");
225 if (cb_fns->session_reset_callback == 0)
226 clib_warning ("No session reset callback function provided");
230 * Check app config for given segment type
232 * Returns 1 on success and 0 otherwise
235 application_verify_cfg (ssvm_segment_type_t st)
238 if (st == SSVM_SEGMENT_MEMFD)
240 is_valid = (session_manager_get_evt_q_segment () != 0);
242 clib_warning ("memfd seg: vpp's event qs IN binary api svm region");
245 else if (st == SSVM_SEGMENT_SHM)
247 is_valid = (session_manager_get_evt_q_segment () == 0);
249 clib_warning ("shm seg: vpp's event qs NOT IN binary api svm region");
257 application_init (application_t * app, u32 api_client_index, u64 * options,
258 session_cb_vft_t * cb_fns)
260 ssvm_segment_type_t seg_type = SSVM_SEGMENT_MEMFD;
261 u32 first_seg_size, prealloc_fifo_pairs;
262 segment_manager_properties_t *props;
263 vl_api_registration_t *reg;
264 segment_manager_t *sm;
268 * Make sure we support the requested configuration
271 if (!(options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_IS_BUILTIN))
273 reg = vl_api_client_index_to_registration (api_client_index);
275 return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
276 if (vl_api_registration_file_index (reg) == VL_API_INVALID_FI)
277 seg_type = SSVM_SEGMENT_SHM;
281 seg_type = SSVM_SEGMENT_PRIVATE;
284 if (!application_verify_cfg (seg_type))
285 return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
288 * Setup segment manager
290 sm = segment_manager_new ();
291 sm->app_index = app->index;
292 props = application_segment_manager_properties (app);
293 segment_manager_properties_init (props);
294 if (options[APP_OPTIONS_ADD_SEGMENT_SIZE])
296 props->add_segment_size = options[APP_OPTIONS_ADD_SEGMENT_SIZE];
297 props->add_segment = 1;
299 if (options[APP_OPTIONS_RX_FIFO_SIZE])
300 props->rx_fifo_size = options[APP_OPTIONS_RX_FIFO_SIZE];
301 if (options[APP_OPTIONS_TX_FIFO_SIZE])
302 props->tx_fifo_size = options[APP_OPTIONS_TX_FIFO_SIZE];
303 if (options[APP_OPTIONS_EVT_QUEUE_SIZE])
304 props->evt_q_size = options[APP_OPTIONS_EVT_QUEUE_SIZE];
305 props->segment_type = seg_type;
307 first_seg_size = options[APP_OPTIONS_SEGMENT_SIZE];
308 prealloc_fifo_pairs = options[APP_OPTIONS_PREALLOC_FIFO_PAIRS];
310 if ((rv = segment_manager_init (sm, first_seg_size, prealloc_fifo_pairs)))
312 sm->first_is_protected = 1;
317 app->first_segment_manager = segment_manager_index (sm);
318 app->api_client_index = api_client_index;
319 app->flags = options[APP_OPTIONS_FLAGS];
320 app->cb_fns = *cb_fns;
321 app->ns_index = options[APP_OPTIONS_NAMESPACE];
322 app->listeners_table = hash_create (0, sizeof (u64));
323 app->local_connects = hash_create (0, sizeof (u64));
324 app->proxied_transports = options[APP_OPTIONS_PROXY_TRANSPORT];
325 app->event_queue = segment_manager_event_queue (sm);
327 /* If no scope enabled, default to global */
328 if (!application_has_global_scope (app)
329 && !application_has_local_scope (app))
330 app->flags |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
332 /* Check that the obvious things are properly set up */
333 application_verify_cb_fns (cb_fns);
335 /* Add app to lookup by api_client_index table */
336 application_table_add (app);
339 * Segment manager for local sessions
341 sm = segment_manager_new ();
342 sm->app_index = app->index;
343 app->local_segment_manager = segment_manager_index (sm);
349 application_get (u32 index)
351 if (index == APP_INVALID_INDEX)
353 return pool_elt_at_index (app_pool, index);
357 application_get_if_valid (u32 index)
359 if (pool_is_free_index (app_pool, index))
362 return pool_elt_at_index (app_pool, index);
366 application_get_index (application_t * app)
368 return app - app_pool;
371 static segment_manager_t *
372 application_alloc_segment_manager (application_t * app)
374 segment_manager_t *sm = 0;
376 /* If the first segment manager is not in use, don't allocate a new one */
377 if (app->first_segment_manager != APP_INVALID_SEGMENT_MANAGER_INDEX
378 && app->first_segment_manager_in_use == 0)
380 sm = segment_manager_get (app->first_segment_manager);
381 app->first_segment_manager_in_use = 1;
385 sm = segment_manager_new ();
386 sm->app_index = app->index;
392 * Start listening local transport endpoint for requested transport.
394 * Creates a 'dummy' stream session with state LISTENING to be used in session
395 * lookups, prior to establishing connection. Requests transport to build
396 * it's own specific listening connection.
399 application_start_listen (application_t * srv, session_endpoint_t * sep,
400 session_handle_t * res)
402 segment_manager_t *sm;
404 session_handle_t handle;
407 sst = session_type_from_proto_and_ip (sep->transport_proto, sep->is_ip4);
408 s = listen_session_new (sst);
409 s->app_index = srv->index;
411 if (stream_session_listen (s, sep))
414 /* Allocate segment manager. All sessions derived out of a listen session
415 * have fifos allocated by the same segment manager. */
416 sm = application_alloc_segment_manager (srv);
420 /* Add to app's listener table. Useful to find all child listeners
421 * when app goes down, although, just for unbinding this is not needed */
422 handle = listen_session_get_handle (s);
423 hash_set (srv->listeners_table, handle, segment_manager_index (sm));
429 listen_session_del (s);
434 * Stop listening on session associated to handle
437 application_stop_listen (application_t * srv, session_handle_t handle)
439 stream_session_t *listener;
441 segment_manager_t *sm;
443 if (srv && hash_get (srv->listeners_table, handle) == 0)
445 clib_warning ("app doesn't own handle %llu!", handle);
449 listener = listen_session_get_from_handle (handle);
450 stream_session_stop_listen (listener);
452 indexp = hash_get (srv->listeners_table, handle);
455 sm = segment_manager_get (*indexp);
456 if (srv->first_segment_manager == *indexp)
458 /* Delete sessions but don't remove segment manager */
459 srv->first_segment_manager_in_use = 0;
460 segment_manager_del_sessions (sm);
464 segment_manager_init_del (sm);
466 hash_unset (srv->listeners_table, handle);
467 listen_session_del (listener);
473 application_open_session (application_t * app, session_endpoint_t * sep,
476 segment_manager_t *sm;
479 /* Make sure we have a segment manager for connects */
480 if (app->connects_seg_manager == APP_INVALID_SEGMENT_MANAGER_INDEX)
482 sm = application_alloc_segment_manager (app);
485 app->connects_seg_manager = segment_manager_index (sm);
488 if ((rv = session_open (app->index, sep, api_context)))
495 application_get_connect_segment_manager (application_t * app)
497 ASSERT (app->connects_seg_manager != (u32) ~ 0);
498 return segment_manager_get (app->connects_seg_manager);
502 application_get_listen_segment_manager (application_t * app,
503 stream_session_t * s)
506 smp = hash_get (app->listeners_table, listen_session_get_handle (s));
508 return segment_manager_get (*smp);
512 application_get_local_segment_manager (application_t * app)
514 return segment_manager_get (app->local_segment_manager);
518 application_get_local_segment_manager_w_session (application_t * app,
519 local_session_t * ls)
521 stream_session_t *listener;
522 if (application_local_session_listener_has_transport (ls))
524 listener = listen_session_get (ls->listener_session_type,
526 return application_get_listen_segment_manager (app, listener);
528 return segment_manager_get (app->local_segment_manager);
532 application_is_proxy (application_t * app)
534 return (app->flags & APP_OPTIONS_FLAGS_IS_PROXY);
538 application_is_builtin (application_t * app)
540 return (app->flags & APP_OPTIONS_FLAGS_IS_BUILTIN);
544 application_is_builtin_proxy (application_t * app)
546 return (application_is_proxy (app) && application_is_builtin (app));
550 * Send an API message to the external app, to map new segment
553 application_add_segment_notify (u32 app_index, ssvm_private_t * fs)
555 application_t *app = application_get (app_index);
556 return app->cb_fns.add_segment_callback (app->api_client_index, fs);
560 application_has_local_scope (application_t * app)
562 return app->flags & APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
566 application_has_global_scope (application_t * app)
568 return app->flags & APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
572 application_n_listeners (application_t * app)
574 return hash_elts (app->listeners_table);
578 application_first_listener (application_t * app, u8 fib_proto,
581 stream_session_t *listener;
586 sst = session_type_from_proto_and_ip (transport_proto,
587 fib_proto == FIB_PROTOCOL_IP4);
590 hash_foreach (handle, sm_index, app->listeners_table, ({
591 listener = listen_session_get_from_handle (handle);
592 if (listener->session_type == sst
593 && listener->listener_index != SESSION_PROXY_LISTENER_INDEX)
602 application_proxy_listener (application_t * app, u8 fib_proto,
605 stream_session_t *listener;
610 sst = session_type_from_proto_and_ip (transport_proto,
611 fib_proto == FIB_PROTOCOL_IP4);
614 hash_foreach (handle, sm_index, app->listeners_table, ({
615 listener = listen_session_get_from_handle (handle);
616 if (listener->session_type == sst
617 && listener->listener_index == SESSION_PROXY_LISTENER_INDEX)
625 static clib_error_t *
626 application_start_stop_proxy_fib_proto (application_t * app, u8 fib_proto,
627 u8 transport_proto, u8 is_start)
629 app_namespace_t *app_ns = app_namespace_get (app->ns_index);
630 u8 is_ip4 = (fib_proto == FIB_PROTOCOL_IP4);
631 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
632 transport_connection_t *tc;
638 s = application_first_listener (app, fib_proto, transport_proto);
642 sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
643 sep.sw_if_index = app_ns->sw_if_index;
644 sep.transport_proto = transport_proto;
645 application_start_listen (app, &sep, &handle);
646 s = listen_session_get_from_handle (handle);
647 s->listener_index = SESSION_PROXY_LISTENER_INDEX;
652 s = application_proxy_listener (app, fib_proto, transport_proto);
656 tc = listen_session_get_transport (s);
658 if (!ip_is_zero (&tc->lcl_ip, 1))
662 sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
663 sep.transport_proto = transport_proto;
665 sti = session_lookup_get_index_for_fib (fib_proto, sep.fib_index);
667 session_lookup_add_session_endpoint (sti, &sep, s->session_index);
669 session_lookup_del_session_endpoint (sti, &sep);
676 application_start_stop_proxy_local_scope (application_t * app,
677 u8 transport_proto, u8 is_start)
679 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
680 app_namespace_t *app_ns;
681 app_ns = app_namespace_get (app->ns_index);
683 sep.transport_proto = transport_proto;
688 session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
691 session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
696 session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
698 session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
703 application_start_stop_proxy (application_t * app,
704 transport_proto_t transport_proto, u8 is_start)
706 if (application_has_local_scope (app))
707 application_start_stop_proxy_local_scope (app, transport_proto, is_start);
709 if (application_has_global_scope (app))
711 application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP4,
712 transport_proto, is_start);
713 application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP6,
714 transport_proto, is_start);
719 application_setup_proxy (application_t * app)
721 u16 transports = app->proxied_transports;
722 transport_proto_t tp;
724 ASSERT (application_is_proxy (app));
727 transport_proto_foreach (tp, ({
728 if (transports & (1 << tp))
729 application_start_stop_proxy (app, tp, 1);
735 application_remove_proxy (application_t * app)
737 u16 transports = app->proxied_transports;
738 transport_proto_t tp;
740 ASSERT (application_is_proxy (app));
743 transport_proto_foreach (tp, ({
744 if (transports & (1 << tp))
745 application_start_stop_proxy (app, tp, 0);
750 segment_manager_properties_t *
751 application_segment_manager_properties (application_t * app)
753 return &app->sm_properties;
756 segment_manager_properties_t *
757 application_get_segment_manager_properties (u32 app_index)
759 application_t *app = application_get (app_index);
760 return &app->sm_properties;
764 application_alloc_local_session (application_t * app)
767 pool_get (app->local_sessions, s);
768 memset (s, 0, sizeof (*s));
769 s->app_index = app->index;
770 s->session_index = s - app->local_sessions;
771 s->session_type = session_type_from_proto_and_ip (TRANSPORT_PROTO_NONE, 0);
776 application_free_local_session (application_t * app, local_session_t * s)
778 pool_put (app->local_sessions, s);
780 memset (s, 0xfc, sizeof (*s));
784 application_get_local_session (application_t * app, u32 session_index)
786 return pool_elt_at_index (app->local_sessions, session_index);
790 application_get_local_session_from_handle (session_handle_t handle)
792 application_t *server;
793 u32 session_index, server_index;
794 local_session_parse_handle (handle, &server_index, &session_index);
795 server = application_get (server_index);
796 return application_get_local_session (server, session_index);
800 application_local_listener_session_endpoint (local_session_t * ll,
801 session_endpoint_t * sep)
803 sep->transport_proto =
804 session_type_transport_proto (ll->listener_session_type);
805 sep->port = ll->port;
806 sep->is_ip4 = ll->listener_session_type & 1;
810 application_start_local_listen (application_t * server,
811 session_endpoint_t * sep,
812 session_handle_t * handle)
818 table_index = application_local_session_table (server);
820 /* An exact sep match, as opposed to session_lookup_local_listener */
821 lh = session_lookup_endpoint_listener (table_index, sep, 1);
822 if (lh != SESSION_INVALID_HANDLE)
823 return VNET_API_ERROR_ADDRESS_IN_USE;
825 pool_get (server->local_listen_sessions, ll);
826 memset (ll, 0, sizeof (*ll));
827 ll->session_type = session_type_from_proto_and_ip (TRANSPORT_PROTO_NONE, 0);
828 ll->app_index = server->index;
829 ll->session_index = ll - server->local_listen_sessions;
830 ll->port = sep->port;
831 /* Store the original session type for the unbind */
832 ll->listener_session_type =
833 session_type_from_proto_and_ip (sep->transport_proto, sep->is_ip4);
835 *handle = application_local_session_handle (ll);
836 session_lookup_add_session_endpoint (table_index, sep, *handle);
842 * Clean up local session table. If we have a listener session use it to
843 * find the port and proto. If not, the handle must be a local table handle
847 application_stop_local_listen (application_t * server, session_handle_t lh)
849 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
850 u32 table_index, ll_index, server_index;
851 stream_session_t *sl = 0;
852 local_session_t *ll, *ls;
854 table_index = application_local_session_table (server);
856 /* We have both local and global table binds. Figure from global what
857 * the sep we should be cleaning up is.
859 if (!session_handle_is_local (lh))
861 sl = listen_session_get_from_handle (lh);
862 if (!sl || listen_session_get_local_session_endpoint (sl, &sep))
864 clib_warning ("broken listener");
867 lh = session_lookup_endpoint_listener (table_index, &sep, 0);
868 if (lh == SESSION_INVALID_HANDLE)
872 local_session_parse_handle (lh, &server_index, &ll_index);
873 ASSERT (server->index == server_index);
874 if (!(ll = application_get_local_listen_session (server, ll_index)))
876 clib_warning ("no local listener");
879 application_local_listener_session_endpoint (ll, &sep);
880 session_lookup_del_session_endpoint (table_index, &sep);
883 pool_foreach (ls, server->local_sessions, ({
884 if (ls->listener_index == ll->session_index)
885 application_local_session_disconnect (server->index, ls);
888 pool_put_index (server->local_listen_sessions, ll->session_index);
894 application_local_session_connect (u32 table_index, application_t * client,
895 application_t * server,
896 local_session_t * ll, u32 opaque)
898 u32 seg_size, evt_q_sz, evt_q_elts, margin = 16 << 10;
899 segment_manager_properties_t *props, *cprops;
900 int rv, has_transport, seg_index;
901 svm_fifo_segment_private_t *seg;
902 segment_manager_t *sm;
904 svm_queue_t *sq, *cq;
906 ls = application_alloc_local_session (server);
908 props = application_segment_manager_properties (server);
909 cprops = application_segment_manager_properties (client);
910 evt_q_elts = props->evt_q_size + cprops->evt_q_size;
911 evt_q_sz = evt_q_elts * sizeof (session_fifo_event_t);
912 seg_size = props->rx_fifo_size + props->tx_fifo_size + evt_q_sz + margin;
914 has_transport = session_has_transport ((stream_session_t *) ll);
917 /* Local sessions don't have backing transport */
919 sm = application_get_local_segment_manager (server);
923 stream_session_t *sl = (stream_session_t *) ll;
924 transport_connection_t *tc;
925 tc = listen_session_get_transport (sl);
926 ls->port = tc->lcl_port;
927 sm = application_get_listen_segment_manager (server, sl);
930 seg_index = segment_manager_add_segment (sm, seg_size);
933 clib_warning ("failed to add new cut-through segment");
936 seg = segment_manager_get_segment_w_lock (sm, seg_index);
937 sq = segment_manager_alloc_queue (seg, props->evt_q_size);
938 cq = segment_manager_alloc_queue (seg, cprops->evt_q_size);
939 ls->server_evt_q = pointer_to_uword (sq);
940 ls->client_evt_q = pointer_to_uword (cq);
941 rv = segment_manager_try_alloc_fifos (seg, props->rx_fifo_size,
944 &ls->server_tx_fifo);
947 clib_warning ("failed to add fifos in cut-through segment");
948 segment_manager_segment_reader_unlock (sm);
951 ls->server_rx_fifo->master_session_index = ls->session_index;
952 ls->server_tx_fifo->master_session_index = ls->session_index;
953 ls->server_rx_fifo->master_thread_index = ~0;
954 ls->server_tx_fifo->master_thread_index = ~0;
955 ls->svm_segment_index = seg_index;
956 ls->listener_index = ll->session_index;
957 ls->client_index = client->index;
958 ls->client_opaque = opaque;
959 ls->listener_session_type = ll->session_type;
961 if ((rv = server->cb_fns.add_segment_callback (server->api_client_index,
964 clib_warning ("failed to notify server of new segment");
965 segment_manager_segment_reader_unlock (sm);
968 segment_manager_segment_reader_unlock (sm);
969 if ((rv = server->cb_fns.session_accept_callback ((stream_session_t *) ls)))
971 clib_warning ("failed to send accept cut-through notify to server");
974 if (server->flags & APP_OPTIONS_FLAGS_IS_BUILTIN)
975 application_local_session_connect_notify (ls);
981 segment_manager_del_segment (sm, seg);
986 application_client_local_connect_key (local_session_t * ls)
988 return ((uword) ls->app_index << 32 | (uword) ls->session_index);
992 application_client_local_connect_key_parse (uword key, u32 * app_index,
995 *app_index = key >> 32;
996 *session_index = key & 0xFFFFFFFF;
1000 application_local_session_connect_notify (local_session_t * ls)
1002 svm_fifo_segment_private_t *seg;
1003 application_t *client, *server;
1004 segment_manager_t *sm;
1005 int rv, is_fail = 0;
1008 client = application_get (ls->client_index);
1009 server = application_get (ls->app_index);
1010 sm = application_get_local_segment_manager_w_session (server, ls);
1011 seg = segment_manager_get_segment_w_lock (sm, ls->svm_segment_index);
1012 if ((rv = client->cb_fns.add_segment_callback (client->api_client_index,
1015 clib_warning ("failed to notify client %u of new segment",
1017 segment_manager_segment_reader_unlock (sm);
1018 application_local_session_disconnect (ls->client_index, ls);
1023 segment_manager_segment_reader_unlock (sm);
1026 client->cb_fns.session_connected_callback (client->index, ls->client_opaque,
1027 (stream_session_t *) ls,
1030 client_key = application_client_local_connect_key (ls);
1031 hash_set (client->local_connects, client_key, client_key);
1036 application_local_session_disconnect (u32 app_index, local_session_t * ls)
1038 svm_fifo_segment_private_t *seg;
1039 application_t *client, *server;
1040 segment_manager_t *sm;
1043 client = application_get_if_valid (ls->client_index);
1044 server = application_get (ls->app_index);
1046 if (ls->session_state == SESSION_STATE_CLOSED)
1049 client_key = application_client_local_connect_key (ls);
1050 sm = application_get_local_segment_manager_w_session (server, ls);
1051 seg = segment_manager_get_segment (sm, ls->svm_segment_index);
1055 hash_unset (client->local_connects, client_key);
1056 client->cb_fns.del_segment_callback (client->api_client_index,
1060 server->cb_fns.del_segment_callback (server->api_client_index,
1062 segment_manager_del_segment (sm, seg);
1063 application_free_local_session (server, ls);
1067 if (app_index == ls->client_index)
1069 send_local_session_disconnect_callback (ls->app_index, ls);
1077 else if (ls->session_state < SESSION_STATE_READY)
1079 client->cb_fns.session_connected_callback (client->index,
1081 (stream_session_t *) ls,
1083 ls->session_state = SESSION_STATE_CLOSED;
1088 send_local_session_disconnect_callback (ls->client_index, ls);
1092 ls->session_state = SESSION_STATE_CLOSED;
1098 application_local_sessions_del (application_t * app)
1100 u32 index, server_index, session_index, table_index;
1101 segment_manager_t *sm;
1102 u64 handle, *handles = 0;
1103 local_session_t *ls, *ll;
1104 application_t *server;
1105 session_endpoint_t sep;
1109 * Local listens. Don't bother with local sessions, we clean them lower
1111 table_index = application_local_session_table (app);
1113 pool_foreach (ll, app->local_listen_sessions, ({
1114 application_local_listener_session_endpoint (ll, &sep);
1115 session_lookup_del_session_endpoint (table_index, &sep);
1122 if (app->local_sessions)
1125 pool_foreach (ls, app->local_sessions, ({
1126 application_local_session_disconnect (app->index, ls);
1134 vec_reset_length (handles);
1136 hash_foreach (handle, index, app->local_connects, ({
1137 vec_add1 (handles, handle);
1141 for (i = 0; i < vec_len (handles); i++)
1143 application_client_local_connect_key_parse (handles[i], &server_index,
1145 server = application_get_if_valid (server_index);
1148 ls = application_get_local_session (server, session_index);
1149 application_local_session_disconnect (app->index, ls);
1153 sm = segment_manager_get (app->local_segment_manager);
1154 sm->app_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
1155 segment_manager_del (sm);
1159 format_application_listener (u8 * s, va_list * args)
1161 application_t *app = va_arg (*args, application_t *);
1162 u64 handle = va_arg (*args, u64);
1163 u32 sm_index = va_arg (*args, u32);
1164 int verbose = va_arg (*args, int);
1165 stream_session_t *listener;
1171 s = format (s, "%-40s%-20s%-15s%-15s%-10s", "Connection", "App",
1172 "API Client", "ListenerID", "SegManager");
1174 s = format (s, "%-40s%-20s", "Connection", "App");
1179 app_name = app_get_name_from_reg_index (app);
1180 listener = listen_session_get_from_handle (handle);
1181 str = format (0, "%U", format_stream_session, listener, verbose);
1185 s = format (s, "%-40s%-20s%-15u%-15u%-10u", str, app_name,
1186 app->api_client_index, handle, sm_index);
1189 s = format (s, "%-40s%-20s", str, app_name);
1191 vec_free (app_name);
1196 application_format_connects (application_t * app, int verbose)
1198 svm_fifo_segment_private_t *fifo_segment;
1199 vlib_main_t *vm = vlib_get_main ();
1200 segment_manager_t *sm;
1201 u8 *app_name, *s = 0;
1207 vlib_cli_output (vm, "%-40s%-20s%-15s%-10s", "Connection", "App",
1208 "API Client", "SegManager");
1210 vlib_cli_output (vm, "%-40s%-20s", "Connection", "App");
1215 if (app->connects_seg_manager == (u32) ~ 0)
1218 app_name = app_get_name_from_reg_index (app);
1220 /* Across all fifo segments */
1221 sm = segment_manager_get (app->connects_seg_manager);
1224 segment_manager_foreach_segment_w_lock (fifo_segment, sm, ({
1228 fifo = svm_fifo_segment_get_fifo_list (fifo_segment);
1231 u32 session_index, thread_index;
1232 stream_session_t *session;
1234 session_index = fifo->master_session_index;
1235 thread_index = fifo->master_thread_index;
1237 session = session_get (session_index, thread_index);
1238 str = format (0, "%U", format_stream_session, session, verbose);
1241 s = format (s, "%-40s%-20s%-15u%-10u", str, app_name,
1242 app->api_client_index, app->connects_seg_manager);
1244 s = format (s, "%-40s%-20s", str, app_name);
1246 vlib_cli_output (vm, "%v", s);
1247 vec_reset_length (s);
1256 vec_free (app_name);
1260 application_format_local_sessions (application_t * app, int verbose)
1262 vlib_main_t *vm = vlib_get_main ();
1263 local_session_t *ls;
1264 transport_proto_t tp;
1270 vlib_cli_output (vm, "%-40s%-15s%-20s", "Connection", "ServerApp",
1276 pool_foreach (ls, app->local_listen_sessions, ({
1277 tp = session_type_transport_proto(ls->listener_session_type);
1278 conn = format (0, "[L][%U] *:%u", format_transport_proto_short, tp,
1280 vlib_cli_output (vm, "%-40v%-15u%-20s", conn, ls->app_index, "*");
1281 vec_reset_length (conn);
1283 pool_foreach (ls, app->local_sessions, ({
1284 tp = session_type_transport_proto(ls->listener_session_type);
1285 conn = format (0, "[L][%U] *:%u", format_transport_proto_short, tp,
1287 vlib_cli_output (vm, "%-40v%-15u%-20u", conn, ls->app_index,
1289 vec_reset_length (conn);
1297 application_format_local_connects (application_t * app, int verbose)
1299 vlib_main_t *vm = vlib_get_main ();
1300 u32 app_index, session_index;
1301 application_t *server;
1302 local_session_t *ls;
1310 vlib_cli_output (vm, "%-40s%-15s%-20s%-10s", "Connection", "App",
1311 "Peer App", "SegManager");
1313 vlib_cli_output (vm, "%-40s%-15s%-20s", "Connection", "App",
1319 hash_foreach (client_key, value, app->local_connects, ({
1320 application_client_local_connect_key_parse (client_key, &app_index,
1322 server = application_get (app_index);
1323 ls = application_get_local_session (server, session_index);
1324 vlib_cli_output (vm, "%-40s%-15s%-20s", "TODO", ls->app_index, ls->client_index);
1330 format_application (u8 * s, va_list * args)
1332 application_t *app = va_arg (*args, application_t *);
1333 CLIB_UNUSED (int verbose) = va_arg (*args, int);
1334 segment_manager_properties_t *props;
1335 const u8 *app_ns_name;
1341 s = format (s, "%-10s%-20s%-15s%-15s%-15s%-15s%-15s", "Index", "Name",
1342 "API Client", "Namespace", "Add seg size", "Rx fifo size",
1346 format (s, "%-10s%-20s%-15s%-40s", "Index", "Name", "API Client",
1351 app_name = app_get_name_from_reg_index (app);
1352 app_ns_name = app_namespace_id_from_index (app->ns_index);
1353 props = application_segment_manager_properties (app);
1356 format (s, "%-10d%-20s%-15d%-15d%-15d%-15d%-15d", app->index, app_name,
1357 app->api_client_index, app->ns_index,
1358 props->add_segment_size,
1359 props->rx_fifo_size, props->tx_fifo_size);
1361 s = format (s, "%-10d%-20s%-15d%-40s", app->index, app_name,
1362 app->api_client_index, app_ns_name);
1368 application_format_all_listeners (vlib_main_t * vm, int do_local, int verbose)
1374 if (!pool_elts (app_pool))
1376 vlib_cli_output (vm, "No active server bindings");
1382 application_format_local_sessions (0, verbose);
1384 pool_foreach (app, app_pool, ({
1385 if (!pool_elts (app->local_sessions)
1386 && !pool_elts(app->local_connects))
1388 application_format_local_sessions (app, verbose);
1394 vlib_cli_output (vm, "%U", format_application_listener, 0 /* header */ ,
1398 pool_foreach (app, app_pool, ({
1399 if (hash_elts (app->listeners_table) == 0)
1401 hash_foreach (handle, sm_index, app->listeners_table, ({
1402 vlib_cli_output (vm, "%U", format_application_listener, app,
1403 handle, sm_index, verbose);
1411 application_format_all_clients (vlib_main_t * vm, int do_local, int verbose)
1415 if (!pool_elts (app_pool))
1417 vlib_cli_output (vm, "No active apps");
1423 application_format_local_connects (0, verbose);
1426 pool_foreach (app, app_pool, ({
1427 if (app->local_connects)
1428 application_format_local_connects (app, verbose);
1434 application_format_connects (0, verbose);
1437 pool_foreach (app, app_pool, ({
1438 if (app->connects_seg_manager == (u32)~0)
1440 application_format_connects (app, verbose);
1446 static clib_error_t *
1447 show_app_command_fn (vlib_main_t * vm, unformat_input_t * input,
1448 vlib_cli_command_t * cmd)
1450 int do_server = 0, do_client = 0, do_local = 0;
1454 session_cli_return_if_not_enabled ();
1456 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1458 if (unformat (input, "server"))
1460 else if (unformat (input, "client"))
1462 else if (unformat (input, "local"))
1464 else if (unformat (input, "verbose"))
1471 application_format_all_listeners (vm, do_local, verbose);
1474 application_format_all_clients (vm, do_local, verbose);
1476 /* Print app related info */
1477 if (!do_server && !do_client)
1479 vlib_cli_output (vm, "%U", format_application, 0, verbose);
1481 pool_foreach (app, app_pool, ({
1482 vlib_cli_output (vm, "%U", format_application, app, verbose);
1491 VLIB_CLI_COMMAND (show_app_command, static) =
1494 .short_help = "show app [server|client] [verbose]",
1495 .function = show_app_command_fn,
1500 * fd.io coding-style-patch-verification: ON
1503 * eval: (c-set-style "gnu")