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 /* Allocate segment manager. All sessions derived out of a listen session
449 * have fifos allocated by the same segment manager. */
450 if (!(sm = application_alloc_segment_manager (srv)))
453 /* Add to app's listener table. Useful to find all child listeners
454 * when app goes down, although, just for unbinding this is not needed */
455 handle = listen_session_get_handle (s);
456 hash_set (srv->listeners_table, handle, segment_manager_index (sm));
458 if (stream_session_listen (s, sep))
460 segment_manager_del (sm);
461 hash_unset (srv->listeners_table, handle);
469 listen_session_del (s);
474 * Stop listening on session associated to handle
477 application_stop_listen (application_t * srv, session_handle_t handle)
479 stream_session_t *listener;
481 segment_manager_t *sm;
483 if (srv && hash_get (srv->listeners_table, handle) == 0)
485 clib_warning ("app doesn't own handle %llu!", handle);
489 listener = listen_session_get_from_handle (handle);
490 stream_session_stop_listen (listener);
492 indexp = hash_get (srv->listeners_table, handle);
495 sm = segment_manager_get (*indexp);
496 if (srv->first_segment_manager == *indexp)
498 /* Delete sessions but don't remove segment manager */
499 srv->first_segment_manager_in_use = 0;
500 segment_manager_del_sessions (sm);
504 segment_manager_init_del (sm);
506 hash_unset (srv->listeners_table, handle);
507 listen_session_del (listener);
513 application_open_session (application_t * app, session_endpoint_t * sep,
518 /* Make sure we have a segment manager for connects */
519 application_alloc_connects_segment_manager (app);
521 if ((rv = session_open (app->index, sep, api_context)))
528 application_alloc_connects_segment_manager (application_t * app)
530 segment_manager_t *sm;
532 if (app->connects_seg_manager == APP_INVALID_SEGMENT_MANAGER_INDEX)
534 sm = application_alloc_segment_manager (app);
537 app->connects_seg_manager = segment_manager_index (sm);
543 application_get_connect_segment_manager (application_t * app)
545 ASSERT (app->connects_seg_manager != (u32) ~ 0);
546 return segment_manager_get (app->connects_seg_manager);
550 application_get_listen_segment_manager (application_t * app,
551 stream_session_t * s)
554 smp = hash_get (app->listeners_table, listen_session_get_handle (s));
556 return segment_manager_get (*smp);
560 application_get_local_segment_manager (application_t * app)
562 return segment_manager_get (app->local_segment_manager);
566 application_get_local_segment_manager_w_session (application_t * app,
567 local_session_t * ls)
569 stream_session_t *listener;
570 if (application_local_session_listener_has_transport (ls))
572 listener = listen_session_get (ls->listener_index);
573 return application_get_listen_segment_manager (app, listener);
575 return segment_manager_get (app->local_segment_manager);
579 application_is_proxy (application_t * app)
581 return (app->flags & APP_OPTIONS_FLAGS_IS_PROXY);
585 application_is_builtin (application_t * app)
587 return (app->flags & APP_OPTIONS_FLAGS_IS_BUILTIN);
591 application_is_builtin_proxy (application_t * app)
593 return (application_is_proxy (app) && application_is_builtin (app));
597 * Send an API message to the external app, to map new segment
600 application_add_segment_notify (u32 app_index, ssvm_private_t * fs)
602 application_t *app = application_get (app_index);
603 return app->cb_fns.add_segment_callback (app->api_client_index, fs);
607 application_has_local_scope (application_t * app)
609 return app->flags & APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
613 application_has_global_scope (application_t * app)
615 return app->flags & APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
619 application_n_listeners (application_t * app)
621 return hash_elts (app->listeners_table);
625 application_first_listener (application_t * app, u8 fib_proto,
628 stream_session_t *listener;
633 sst = session_type_from_proto_and_ip (transport_proto,
634 fib_proto == FIB_PROTOCOL_IP4);
637 hash_foreach (handle, sm_index, app->listeners_table, ({
638 listener = listen_session_get_from_handle (handle);
639 if (listener->session_type == sst
640 && listener->listener_index != SESSION_PROXY_LISTENER_INDEX)
649 application_proxy_listener (application_t * app, u8 fib_proto,
652 stream_session_t *listener;
657 sst = session_type_from_proto_and_ip (transport_proto,
658 fib_proto == FIB_PROTOCOL_IP4);
661 hash_foreach (handle, sm_index, app->listeners_table, ({
662 listener = listen_session_get_from_handle (handle);
663 if (listener->session_type == sst
664 && listener->listener_index == SESSION_PROXY_LISTENER_INDEX)
672 static clib_error_t *
673 application_start_stop_proxy_fib_proto (application_t * app, u8 fib_proto,
674 u8 transport_proto, u8 is_start)
676 app_namespace_t *app_ns = app_namespace_get (app->ns_index);
677 u8 is_ip4 = (fib_proto == FIB_PROTOCOL_IP4);
678 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
679 transport_connection_t *tc;
685 s = application_first_listener (app, fib_proto, transport_proto);
689 sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
690 sep.sw_if_index = app_ns->sw_if_index;
691 sep.transport_proto = transport_proto;
692 application_start_listen (app, &sep, &handle);
693 s = listen_session_get_from_handle (handle);
694 s->listener_index = SESSION_PROXY_LISTENER_INDEX;
699 s = application_proxy_listener (app, fib_proto, transport_proto);
703 tc = listen_session_get_transport (s);
705 if (!ip_is_zero (&tc->lcl_ip, 1))
709 sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
710 sep.transport_proto = transport_proto;
712 sti = session_lookup_get_index_for_fib (fib_proto, sep.fib_index);
714 session_lookup_add_session_endpoint (sti, &sep, s->session_index);
716 session_lookup_del_session_endpoint (sti, &sep);
723 application_start_stop_proxy_local_scope (application_t * app,
724 u8 transport_proto, u8 is_start)
726 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
727 app_namespace_t *app_ns;
728 app_ns = app_namespace_get (app->ns_index);
730 sep.transport_proto = transport_proto;
735 session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
738 session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
743 session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
745 session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
750 application_start_stop_proxy (application_t * app,
751 transport_proto_t transport_proto, u8 is_start)
753 if (application_has_local_scope (app))
754 application_start_stop_proxy_local_scope (app, transport_proto, is_start);
756 if (application_has_global_scope (app))
758 application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP4,
759 transport_proto, is_start);
760 application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP6,
761 transport_proto, is_start);
766 application_setup_proxy (application_t * app)
768 u16 transports = app->proxied_transports;
769 transport_proto_t tp;
771 ASSERT (application_is_proxy (app));
774 transport_proto_foreach (tp, ({
775 if (transports & (1 << tp))
776 application_start_stop_proxy (app, tp, 1);
782 application_remove_proxy (application_t * app)
784 u16 transports = app->proxied_transports;
785 transport_proto_t tp;
787 ASSERT (application_is_proxy (app));
790 transport_proto_foreach (tp, ({
791 if (transports & (1 << tp))
792 application_start_stop_proxy (app, tp, 0);
797 segment_manager_properties_t *
798 application_segment_manager_properties (application_t * app)
800 return &app->sm_properties;
803 segment_manager_properties_t *
804 application_get_segment_manager_properties (u32 app_index)
806 application_t *app = application_get (app_index);
807 return &app->sm_properties;
811 app_enqueue_evt (svm_msg_q_t * mq, svm_msg_q_msg_t * msg, u8 lock)
813 if (PREDICT_FALSE (svm_msg_q_is_full (mq)))
815 clib_warning ("evt q full");
816 svm_msg_q_free_msg (mq, msg);
818 svm_msg_q_unlock (mq);
824 svm_msg_q_add_and_unlock (mq, msg);
828 /* Even when not locking the ring, we must wait for queue mutex */
829 if (svm_msg_q_add (mq, msg, SVM_Q_WAIT))
831 clib_warning ("msg q add returned");
838 app_send_io_evt_rx (application_t * app, stream_session_t * s, u8 lock)
840 session_event_t *evt;
844 if (PREDICT_FALSE (s->session_state == SESSION_STATE_CLOSED))
846 /* Session is closed so app will never clean up. Flush rx fifo */
847 svm_fifo_dequeue_drop_all (s->server_rx_fifo);
851 /* Built-in app? Hand event to the callback... */
852 if (app->cb_fns.builtin_app_rx_callback)
853 return app->cb_fns.builtin_app_rx_callback (s);
855 /* If no need for event, return */
856 if (!svm_fifo_set_event (s->server_rx_fifo))
859 mq = app->event_queue;
863 if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
865 clib_warning ("evt q rings full");
867 svm_msg_q_unlock (mq);
871 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
872 ASSERT (!svm_msg_q_msg_is_invalid (&msg));
874 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
875 evt->fifo = s->server_rx_fifo;
876 evt->event_type = FIFO_EVENT_APP_RX;
878 return app_enqueue_evt (mq, &msg, lock);
882 app_send_io_evt_tx (application_t * app, stream_session_t * s, u8 lock)
885 session_event_t *evt;
888 if (application_is_builtin (app))
891 mq = app->event_queue;
895 if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
897 clib_warning ("evt q rings full");
899 svm_msg_q_unlock (mq);
903 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
904 ASSERT (!svm_msg_q_msg_is_invalid (&msg));
906 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
907 evt->event_type = FIFO_EVENT_APP_TX;
908 evt->fifo = s->server_tx_fifo;
910 return app_enqueue_evt (mq, &msg, lock);
914 typedef int (app_send_evt_handler_fn) (application_t *app,
917 static app_send_evt_handler_fn * const app_send_evt_handler_fns[2] = {
924 * Send event to application
926 * Logic from queue perspective is non-blocking. That is, if there's
927 * not enough space to enqueue a message, we return. However, if the lock
928 * flag is set, we do wait for queue mutex.
931 application_send_event (application_t * app, stream_session_t * s,
934 ASSERT (app && evt_type <= FIFO_EVENT_APP_TX);
935 return app_send_evt_handler_fns[evt_type] (app, s, 0 /* lock */ );
939 application_lock_and_send_event (application_t * app, stream_session_t * s,
942 return app_send_evt_handler_fns[evt_type] (app, s, 1 /* lock */ );
946 application_alloc_local_session (application_t * app)
949 pool_get (app->local_sessions, s);
950 memset (s, 0, sizeof (*s));
951 s->app_index = app->index;
952 s->session_index = s - app->local_sessions;
953 s->session_type = session_type_from_proto_and_ip (TRANSPORT_PROTO_NONE, 0);
958 application_free_local_session (application_t * app, local_session_t * s)
960 pool_put (app->local_sessions, s);
962 memset (s, 0xfc, sizeof (*s));
966 application_get_local_session (application_t * app, u32 session_index)
968 return pool_elt_at_index (app->local_sessions, session_index);
972 application_get_local_session_from_handle (session_handle_t handle)
974 application_t *server;
975 u32 session_index, server_index;
976 local_session_parse_handle (handle, &server_index, &session_index);
977 server = application_get (server_index);
978 return application_get_local_session (server, session_index);
982 application_local_listener_session_endpoint (local_session_t * ll,
983 session_endpoint_t * sep)
985 sep->transport_proto =
986 session_type_transport_proto (ll->listener_session_type);
987 sep->port = ll->port;
988 sep->is_ip4 = ll->listener_session_type & 1;
992 application_start_local_listen (application_t * server,
993 session_endpoint_t * sep,
994 session_handle_t * handle)
1000 table_index = application_local_session_table (server);
1002 /* An exact sep match, as opposed to session_lookup_local_listener */
1003 lh = session_lookup_endpoint_listener (table_index, sep, 1);
1004 if (lh != SESSION_INVALID_HANDLE)
1005 return VNET_API_ERROR_ADDRESS_IN_USE;
1007 pool_get (server->local_listen_sessions, ll);
1008 memset (ll, 0, sizeof (*ll));
1009 ll->session_type = session_type_from_proto_and_ip (TRANSPORT_PROTO_NONE, 0);
1010 ll->app_index = server->index;
1011 ll->session_index = ll - server->local_listen_sessions;
1012 ll->port = sep->port;
1013 /* Store the original session type for the unbind */
1014 ll->listener_session_type =
1015 session_type_from_proto_and_ip (sep->transport_proto, sep->is_ip4);
1016 ll->transport_listener_index = ~0;
1018 *handle = application_local_session_handle (ll);
1019 session_lookup_add_session_endpoint (table_index, sep, *handle);
1025 * Clean up local session table. If we have a listener session use it to
1026 * find the port and proto. If not, the handle must be a local table handle
1030 application_stop_local_listen (application_t * server, session_handle_t lh)
1032 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
1033 u32 table_index, ll_index, server_index;
1034 stream_session_t *sl = 0;
1035 local_session_t *ll, *ls;
1037 table_index = application_local_session_table (server);
1039 /* We have both local and global table binds. Figure from global what
1040 * the sep we should be cleaning up is.
1042 if (!session_handle_is_local (lh))
1044 sl = listen_session_get_from_handle (lh);
1045 if (!sl || listen_session_get_local_session_endpoint (sl, &sep))
1047 clib_warning ("broken listener");
1050 lh = session_lookup_endpoint_listener (table_index, &sep, 0);
1051 if (lh == SESSION_INVALID_HANDLE)
1055 local_session_parse_handle (lh, &server_index, &ll_index);
1056 ASSERT (server->index == server_index);
1057 if (!(ll = application_get_local_listen_session (server, ll_index)))
1059 clib_warning ("no local listener");
1062 application_local_listener_session_endpoint (ll, &sep);
1063 session_lookup_del_session_endpoint (table_index, &sep);
1066 pool_foreach (ls, server->local_sessions, ({
1067 if (ls->listener_index == ll->session_index)
1068 application_local_session_disconnect (server->index, ls);
1071 pool_put_index (server->local_listen_sessions, ll->session_index);
1077 application_local_session_connect (u32 table_index, application_t * client,
1078 application_t * server,
1079 local_session_t * ll, u32 opaque)
1081 u32 seg_size, evt_q_sz, evt_q_elts, margin = 16 << 10;
1082 segment_manager_properties_t *props, *cprops;
1083 int rv, has_transport, seg_index;
1084 svm_fifo_segment_private_t *seg;
1085 segment_manager_t *sm;
1086 local_session_t *ls;
1087 svm_msg_q_t *sq, *cq;
1089 ls = application_alloc_local_session (server);
1091 props = application_segment_manager_properties (server);
1092 cprops = application_segment_manager_properties (client);
1093 evt_q_elts = props->evt_q_size + cprops->evt_q_size;
1094 evt_q_sz = segment_manager_evt_q_expected_size (evt_q_elts);
1095 seg_size = props->rx_fifo_size + props->tx_fifo_size + evt_q_sz + margin;
1097 has_transport = session_has_transport ((stream_session_t *) ll);
1100 /* Local sessions don't have backing transport */
1101 ls->port = ll->port;
1102 sm = application_get_local_segment_manager (server);
1106 stream_session_t *sl = (stream_session_t *) ll;
1107 transport_connection_t *tc;
1108 tc = listen_session_get_transport (sl);
1109 ls->port = tc->lcl_port;
1110 sm = application_get_listen_segment_manager (server, sl);
1113 seg_index = segment_manager_add_segment (sm, seg_size);
1116 clib_warning ("failed to add new cut-through segment");
1119 seg = segment_manager_get_segment_w_lock (sm, seg_index);
1120 sq = segment_manager_alloc_queue (seg, props->evt_q_size);
1121 cq = segment_manager_alloc_queue (seg, cprops->evt_q_size);
1122 ls->server_evt_q = pointer_to_uword (sq);
1123 ls->client_evt_q = pointer_to_uword (cq);
1124 rv = segment_manager_try_alloc_fifos (seg, props->rx_fifo_size,
1125 props->tx_fifo_size,
1126 &ls->server_rx_fifo,
1127 &ls->server_tx_fifo);
1130 clib_warning ("failed to add fifos in cut-through segment");
1131 segment_manager_segment_reader_unlock (sm);
1134 ls->server_rx_fifo->master_session_index = ls->session_index;
1135 ls->server_tx_fifo->master_session_index = ls->session_index;
1136 ls->server_rx_fifo->master_thread_index = ~0;
1137 ls->server_tx_fifo->master_thread_index = ~0;
1138 ls->svm_segment_index = seg_index;
1139 ls->listener_index = ll->session_index;
1140 ls->client_index = client->index;
1141 ls->client_opaque = opaque;
1142 ls->listener_session_type = ll->session_type;
1144 if ((rv = server->cb_fns.add_segment_callback (server->api_client_index,
1147 clib_warning ("failed to notify server of new segment");
1148 segment_manager_segment_reader_unlock (sm);
1151 segment_manager_segment_reader_unlock (sm);
1152 if ((rv = server->cb_fns.session_accept_callback ((stream_session_t *) ls)))
1154 clib_warning ("failed to send accept cut-through notify to server");
1157 if (server->flags & APP_OPTIONS_FLAGS_IS_BUILTIN)
1158 application_local_session_connect_notify (ls);
1164 segment_manager_del_segment (sm, seg);
1169 application_client_local_connect_key (local_session_t * ls)
1171 return ((uword) ls->app_index << 32 | (uword) ls->session_index);
1175 application_client_local_connect_key_parse (uword key, u32 * app_index,
1176 u32 * session_index)
1178 *app_index = key >> 32;
1179 *session_index = key & 0xFFFFFFFF;
1183 application_local_session_connect_notify (local_session_t * ls)
1185 svm_fifo_segment_private_t *seg;
1186 application_t *client, *server;
1187 segment_manager_t *sm;
1188 int rv, is_fail = 0;
1191 client = application_get (ls->client_index);
1192 server = application_get (ls->app_index);
1193 sm = application_get_local_segment_manager_w_session (server, ls);
1194 seg = segment_manager_get_segment_w_lock (sm, ls->svm_segment_index);
1195 if ((rv = client->cb_fns.add_segment_callback (client->api_client_index,
1198 clib_warning ("failed to notify client %u of new segment",
1200 segment_manager_segment_reader_unlock (sm);
1201 application_local_session_disconnect (ls->client_index, ls);
1206 segment_manager_segment_reader_unlock (sm);
1209 client->cb_fns.session_connected_callback (client->index, ls->client_opaque,
1210 (stream_session_t *) ls,
1213 client_key = application_client_local_connect_key (ls);
1214 hash_set (client->local_connects, client_key, client_key);
1219 application_local_session_cleanup (application_t * client,
1220 application_t * server,
1221 local_session_t * ls)
1223 svm_fifo_segment_private_t *seg;
1224 segment_manager_t *sm;
1228 has_transport = session_has_transport ((stream_session_t *) ls);
1229 client_key = application_client_local_connect_key (ls);
1231 sm = application_get_local_segment_manager_w_session (server, ls);
1233 sm = application_get_listen_segment_manager (server,
1234 (stream_session_t *) ls);
1236 seg = segment_manager_get_segment (sm, ls->svm_segment_index);
1238 hash_unset (client->local_connects, client_key);
1242 server->cb_fns.del_segment_callback (server->api_client_index,
1245 client->cb_fns.del_segment_callback (client->api_client_index,
1247 segment_manager_del_segment (sm, seg);
1250 application_free_local_session (server, ls);
1256 application_local_session_disconnect (u32 app_index, local_session_t * ls)
1258 application_t *client, *server;
1260 client = application_get_if_valid (ls->client_index);
1261 server = application_get (ls->app_index);
1263 if (ls->session_state == SESSION_STATE_CLOSED)
1264 return application_local_session_cleanup (client, server, ls);
1266 if (app_index == ls->client_index)
1268 send_local_session_disconnect_callback (ls->app_index, ls);
1274 return application_local_session_cleanup (client, server, ls);
1276 else if (ls->session_state < SESSION_STATE_READY)
1278 client->cb_fns.session_connected_callback (client->index,
1280 (stream_session_t *) ls,
1282 ls->session_state = SESSION_STATE_CLOSED;
1283 return application_local_session_cleanup (client, server, ls);
1287 send_local_session_disconnect_callback (client->index, ls);
1291 ls->session_state = SESSION_STATE_CLOSED;
1297 application_local_session_disconnect_w_index (u32 app_index, u32 ls_index)
1300 local_session_t *ls;
1301 app = application_get (app_index);
1302 ls = application_get_local_session (app, ls_index);
1303 return application_local_session_disconnect (app_index, ls);
1307 application_local_sessions_del (application_t * app)
1309 u32 index, server_index, session_index, table_index;
1310 segment_manager_t *sm;
1311 u64 handle, *handles = 0;
1312 local_session_t *ls, *ll;
1313 application_t *server;
1314 session_endpoint_t sep;
1318 * Local listens. Don't bother with local sessions, we clean them lower
1320 table_index = application_local_session_table (app);
1322 pool_foreach (ll, app->local_listen_sessions, ({
1323 application_local_listener_session_endpoint (ll, &sep);
1324 session_lookup_del_session_endpoint (table_index, &sep);
1331 if (app->local_sessions)
1334 pool_foreach (ls, app->local_sessions, ({
1335 application_local_session_disconnect (app->index, ls);
1343 vec_reset_length (handles);
1345 hash_foreach (handle, index, app->local_connects, ({
1346 vec_add1 (handles, handle);
1350 for (i = 0; i < vec_len (handles); i++)
1352 application_client_local_connect_key_parse (handles[i], &server_index,
1354 server = application_get_if_valid (server_index);
1357 ls = application_get_local_session (server, session_index);
1358 application_local_session_disconnect (app->index, ls);
1362 sm = segment_manager_get (app->local_segment_manager);
1363 sm->app_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
1364 segment_manager_del (sm);
1368 vnet_app_add_tls_cert (vnet_app_add_tls_cert_args_t * a)
1371 app = application_get (a->app_index);
1373 return clib_error_return_code (0, VNET_API_ERROR_APPLICATION_NOT_ATTACHED,
1374 0, "app %u doesn't exist", a->app_index);
1375 app->tls_cert = vec_dup (a->cert);
1380 vnet_app_add_tls_key (vnet_app_add_tls_key_args_t * a)
1383 app = application_get (a->app_index);
1385 return clib_error_return_code (0, VNET_API_ERROR_APPLICATION_NOT_ATTACHED,
1386 0, "app %u doesn't exist", a->app_index);
1387 app->tls_key = vec_dup (a->key);
1392 format_application_listener (u8 * s, va_list * args)
1394 application_t *app = va_arg (*args, application_t *);
1395 u64 handle = va_arg (*args, u64);
1396 u32 sm_index = va_arg (*args, u32);
1397 int verbose = va_arg (*args, int);
1398 stream_session_t *listener;
1404 s = format (s, "%-40s%-20s%-15s%-15s%-10s", "Connection", "App",
1405 "API Client", "ListenerID", "SegManager");
1407 s = format (s, "%-40s%-20s", "Connection", "App");
1412 app_name = app_get_name_from_reg_index (app);
1413 listener = listen_session_get_from_handle (handle);
1414 str = format (0, "%U", format_stream_session, listener, verbose);
1418 s = format (s, "%-40s%-20s%-15u%-15u%-10u", str, app_name,
1419 app->api_client_index, handle, sm_index);
1422 s = format (s, "%-40s%-20s", str, app_name);
1424 vec_free (app_name);
1429 application_format_connects (application_t * app, int verbose)
1431 svm_fifo_segment_private_t *fifo_segment;
1432 vlib_main_t *vm = vlib_get_main ();
1433 segment_manager_t *sm;
1434 u8 *app_name, *s = 0;
1440 vlib_cli_output (vm, "%-40s%-20s%-15s%-10s", "Connection", "App",
1441 "API Client", "SegManager");
1443 vlib_cli_output (vm, "%-40s%-20s", "Connection", "App");
1448 if (app->connects_seg_manager == (u32) ~ 0)
1451 app_name = app_get_name_from_reg_index (app);
1453 /* Across all fifo segments */
1454 sm = segment_manager_get (app->connects_seg_manager);
1457 segment_manager_foreach_segment_w_lock (fifo_segment, sm, ({
1461 fifo = svm_fifo_segment_get_fifo_list (fifo_segment);
1464 u32 session_index, thread_index;
1465 stream_session_t *session;
1467 session_index = fifo->master_session_index;
1468 thread_index = fifo->master_thread_index;
1470 session = session_get (session_index, thread_index);
1471 str = format (0, "%U", format_stream_session, session, verbose);
1474 s = format (s, "%-40s%-20s%-15u%-10u", str, app_name,
1475 app->api_client_index, app->connects_seg_manager);
1477 s = format (s, "%-40s%-20s", str, app_name);
1479 vlib_cli_output (vm, "%v", s);
1480 vec_reset_length (s);
1489 vec_free (app_name);
1493 application_format_local_sessions (application_t * app, int verbose)
1495 vlib_main_t *vm = vlib_get_main ();
1496 local_session_t *ls;
1497 transport_proto_t tp;
1503 vlib_cli_output (vm, "%-40s%-15s%-20s", "Connection", "ServerApp",
1509 pool_foreach (ls, app->local_listen_sessions, ({
1510 tp = session_type_transport_proto(ls->listener_session_type);
1511 conn = format (0, "[L][%U] *:%u", format_transport_proto_short, tp,
1513 vlib_cli_output (vm, "%-40v%-15u%-20s", conn, ls->app_index, "*");
1514 vec_reset_length (conn);
1516 pool_foreach (ls, app->local_sessions, ({
1517 tp = session_type_transport_proto(ls->listener_session_type);
1518 conn = format (0, "[L][%U] *:%u", format_transport_proto_short, tp,
1520 vlib_cli_output (vm, "%-40v%-15u%-20u", conn, ls->app_index,
1522 vec_reset_length (conn);
1530 application_format_local_connects (application_t * app, int verbose)
1532 vlib_main_t *vm = vlib_get_main ();
1533 u32 app_index, session_index;
1534 application_t *server;
1535 local_session_t *ls;
1543 vlib_cli_output (vm, "%-40s%-15s%-20s%-10s", "Connection", "App",
1544 "Peer App", "SegManager");
1546 vlib_cli_output (vm, "%-40s%-15s%-20s", "Connection", "App",
1552 hash_foreach (client_key, value, app->local_connects, ({
1553 application_client_local_connect_key_parse (client_key, &app_index,
1555 server = application_get (app_index);
1556 ls = application_get_local_session (server, session_index);
1557 vlib_cli_output (vm, "%-40s%-15s%-20s", "TODO", ls->app_index, ls->client_index);
1563 format_application (u8 * s, va_list * args)
1565 application_t *app = va_arg (*args, application_t *);
1566 CLIB_UNUSED (int verbose) = va_arg (*args, int);
1567 segment_manager_properties_t *props;
1568 const u8 *app_ns_name;
1574 s = format (s, "%-10s%-20s%-15s%-15s%-15s%-15s%-15s", "Index", "Name",
1575 "API Client", "Namespace", "Add seg size", "Rx-f size",
1578 s = format (s, "%-10s%-20s%-15s%-40s", "Index", "Name", "API Client",
1583 app_name = app_get_name (app);
1584 app_ns_name = app_namespace_id_from_index (app->ns_index);
1585 props = application_segment_manager_properties (app);
1587 s = format (s, "%-10u%-20s%-15d%-15u%-15U%-15U%-15U", app->index,
1588 app_name, app->api_client_index, app->ns_index,
1589 format_memory_size, props->add_segment_size,
1590 format_memory_size, props->rx_fifo_size, format_memory_size,
1591 props->tx_fifo_size);
1593 s = format (s, "%-10u%-20s%-15d%-40s", app->index, app_name,
1594 app->api_client_index, app_ns_name);
1600 application_format_all_listeners (vlib_main_t * vm, int do_local, int verbose)
1606 if (!pool_elts (app_pool))
1608 vlib_cli_output (vm, "No active server bindings");
1614 application_format_local_sessions (0, verbose);
1616 pool_foreach (app, app_pool, ({
1617 if (!pool_elts (app->local_sessions)
1618 && !pool_elts(app->local_connects))
1620 application_format_local_sessions (app, verbose);
1626 vlib_cli_output (vm, "%U", format_application_listener, 0 /* header */ ,
1630 pool_foreach (app, app_pool, ({
1631 if (hash_elts (app->listeners_table) == 0)
1633 hash_foreach (handle, sm_index, app->listeners_table, ({
1634 vlib_cli_output (vm, "%U", format_application_listener, app,
1635 handle, sm_index, verbose);
1643 application_format_all_clients (vlib_main_t * vm, int do_local, int verbose)
1647 if (!pool_elts (app_pool))
1649 vlib_cli_output (vm, "No active apps");
1655 application_format_local_connects (0, verbose);
1658 pool_foreach (app, app_pool, ({
1659 if (app->local_connects)
1660 application_format_local_connects (app, verbose);
1666 application_format_connects (0, verbose);
1669 pool_foreach (app, app_pool, ({
1670 if (app->connects_seg_manager == (u32)~0)
1672 application_format_connects (app, verbose);
1678 static clib_error_t *
1679 show_app_command_fn (vlib_main_t * vm, unformat_input_t * input,
1680 vlib_cli_command_t * cmd)
1682 int do_server = 0, do_client = 0, do_local = 0;
1686 session_cli_return_if_not_enabled ();
1688 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1690 if (unformat (input, "server"))
1692 else if (unformat (input, "client"))
1694 else if (unformat (input, "local"))
1696 else if (unformat (input, "verbose"))
1703 application_format_all_listeners (vm, do_local, verbose);
1706 application_format_all_clients (vm, do_local, verbose);
1708 /* Print app related info */
1709 if (!do_server && !do_client)
1711 vlib_cli_output (vm, "%U", format_application, 0, verbose);
1713 pool_foreach (app, app_pool, ({
1714 vlib_cli_output (vm, "%U", format_application, app, verbose);
1723 VLIB_CLI_COMMAND (show_app_command, static) =
1726 .short_help = "show app [server|client] [verbose]",
1727 .function = show_app_command_fn,
1732 * fd.io coding-style-patch-verification: ON
1735 * eval: (c-set-style "gnu")