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 if (options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
317 clib_warning ("mq eventfds can only be used if socket transport is "
319 return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
321 seg_type = SSVM_SEGMENT_PRIVATE;
324 if (!application_verify_cfg (seg_type))
325 return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
328 * Setup segment manager
330 sm = segment_manager_new ();
331 sm->app_index = app->index;
332 props = application_segment_manager_properties (app);
333 segment_manager_properties_init (props);
334 if (options[APP_OPTIONS_ADD_SEGMENT_SIZE])
336 props->add_segment_size = options[APP_OPTIONS_ADD_SEGMENT_SIZE];
337 props->add_segment = 1;
339 if (options[APP_OPTIONS_RX_FIFO_SIZE])
340 props->rx_fifo_size = options[APP_OPTIONS_RX_FIFO_SIZE];
341 if (options[APP_OPTIONS_TX_FIFO_SIZE])
342 props->tx_fifo_size = options[APP_OPTIONS_TX_FIFO_SIZE];
343 if (options[APP_OPTIONS_EVT_QUEUE_SIZE])
344 props->evt_q_size = options[APP_OPTIONS_EVT_QUEUE_SIZE];
345 if (options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
346 props->use_mq_eventfd = 1;
347 if (options[APP_OPTIONS_TLS_ENGINE])
348 app->tls_engine = options[APP_OPTIONS_TLS_ENGINE];
349 props->segment_type = seg_type;
351 first_seg_size = options[APP_OPTIONS_SEGMENT_SIZE];
352 prealloc_fifo_pairs = options[APP_OPTIONS_PREALLOC_FIFO_PAIRS];
354 if ((rv = segment_manager_init (sm, first_seg_size, prealloc_fifo_pairs)))
356 sm->first_is_protected = 1;
361 app->first_segment_manager = segment_manager_index (sm);
362 app->api_client_index = api_client_index;
363 app->flags = options[APP_OPTIONS_FLAGS];
364 app->cb_fns = *cb_fns;
365 app->ns_index = options[APP_OPTIONS_NAMESPACE];
366 app->listeners_table = hash_create (0, sizeof (u64));
367 app->local_connects = hash_create (0, sizeof (u64));
368 app->proxied_transports = options[APP_OPTIONS_PROXY_TRANSPORT];
369 app->event_queue = segment_manager_event_queue (sm);
370 app->name = vec_dup (app_name);
372 /* If no scope enabled, default to global */
373 if (!application_has_global_scope (app)
374 && !application_has_local_scope (app))
375 app->flags |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
377 /* Check that the obvious things are properly set up */
378 application_verify_cb_fns (cb_fns);
380 /* Add app to lookup by api_client_index table */
381 application_table_add (app);
384 * Segment manager for local sessions
386 sm = segment_manager_new ();
387 sm->app_index = app->index;
388 app->local_segment_manager = segment_manager_index (sm);
394 application_get (u32 index)
396 if (index == APP_INVALID_INDEX)
398 return pool_elt_at_index (app_pool, index);
402 application_get_if_valid (u32 index)
404 if (pool_is_free_index (app_pool, index))
407 return pool_elt_at_index (app_pool, index);
411 application_get_index (application_t * app)
413 return app - app_pool;
416 static segment_manager_t *
417 application_alloc_segment_manager (application_t * app)
419 segment_manager_t *sm = 0;
421 /* If the first segment manager is not in use, don't allocate a new one */
422 if (app->first_segment_manager != APP_INVALID_SEGMENT_MANAGER_INDEX
423 && app->first_segment_manager_in_use == 0)
425 sm = segment_manager_get (app->first_segment_manager);
426 app->first_segment_manager_in_use = 1;
430 sm = segment_manager_new ();
431 sm->app_index = app->index;
437 * Start listening local transport endpoint for requested transport.
439 * Creates a 'dummy' stream session with state LISTENING to be used in session
440 * lookups, prior to establishing connection. Requests transport to build
441 * it's own specific listening connection.
444 application_start_listen (application_t * srv, session_endpoint_t * sep,
445 session_handle_t * res)
447 segment_manager_t *sm;
449 session_handle_t handle;
452 sst = session_type_from_proto_and_ip (sep->transport_proto, sep->is_ip4);
453 s = listen_session_new (0, sst);
454 s->app_index = srv->index;
456 /* Allocate segment manager. All sessions derived out of a listen session
457 * have fifos allocated by the same segment manager. */
458 if (!(sm = application_alloc_segment_manager (srv)))
461 /* Add to app's listener table. Useful to find all child listeners
462 * when app goes down, although, just for unbinding this is not needed */
463 handle = listen_session_get_handle (s);
464 hash_set (srv->listeners_table, handle, segment_manager_index (sm));
466 if (stream_session_listen (s, sep))
468 segment_manager_del (sm);
469 hash_unset (srv->listeners_table, handle);
477 listen_session_del (s);
482 * Stop listening on session associated to handle
485 application_stop_listen (application_t * srv, session_handle_t handle)
487 stream_session_t *listener;
489 segment_manager_t *sm;
491 if (srv && hash_get (srv->listeners_table, handle) == 0)
493 clib_warning ("app doesn't own handle %llu!", handle);
497 listener = listen_session_get_from_handle (handle);
498 stream_session_stop_listen (listener);
500 indexp = hash_get (srv->listeners_table, handle);
503 sm = segment_manager_get (*indexp);
504 if (srv->first_segment_manager == *indexp)
506 /* Delete sessions but don't remove segment manager */
507 srv->first_segment_manager_in_use = 0;
508 segment_manager_del_sessions (sm);
512 segment_manager_init_del (sm);
514 hash_unset (srv->listeners_table, handle);
515 listen_session_del (listener);
521 application_open_session (application_t * app, session_endpoint_t * sep,
526 /* Make sure we have a segment manager for connects */
527 application_alloc_connects_segment_manager (app);
529 if ((rv = session_open (app->index, sep, api_context)))
536 application_alloc_connects_segment_manager (application_t * app)
538 segment_manager_t *sm;
540 if (app->connects_seg_manager == APP_INVALID_SEGMENT_MANAGER_INDEX)
542 sm = application_alloc_segment_manager (app);
545 app->connects_seg_manager = segment_manager_index (sm);
551 application_get_connect_segment_manager (application_t * app)
553 ASSERT (app->connects_seg_manager != (u32) ~ 0);
554 return segment_manager_get (app->connects_seg_manager);
558 application_get_listen_segment_manager (application_t * app,
559 stream_session_t * s)
562 smp = hash_get (app->listeners_table, listen_session_get_handle (s));
564 return segment_manager_get (*smp);
568 application_get_local_segment_manager (application_t * app)
570 return segment_manager_get (app->local_segment_manager);
574 application_get_local_segment_manager_w_session (application_t * app,
575 local_session_t * ls)
577 stream_session_t *listener;
578 if (application_local_session_listener_has_transport (ls))
580 listener = listen_session_get (ls->listener_index);
581 return application_get_listen_segment_manager (app, listener);
583 return segment_manager_get (app->local_segment_manager);
587 application_is_proxy (application_t * app)
589 return (app->flags & APP_OPTIONS_FLAGS_IS_PROXY);
593 application_is_builtin (application_t * app)
595 return (app->flags & APP_OPTIONS_FLAGS_IS_BUILTIN);
599 application_is_builtin_proxy (application_t * app)
601 return (application_is_proxy (app) && application_is_builtin (app));
605 * Send an API message to the external app, to map new segment
608 application_add_segment_notify (u32 app_index, ssvm_private_t * fs)
610 application_t *app = application_get (app_index);
611 return app->cb_fns.add_segment_callback (app->api_client_index, fs);
615 application_has_local_scope (application_t * app)
617 return app->flags & APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
621 application_has_global_scope (application_t * app)
623 return app->flags & APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
627 application_n_listeners (application_t * app)
629 return hash_elts (app->listeners_table);
633 application_first_listener (application_t * app, u8 fib_proto,
636 stream_session_t *listener;
641 sst = session_type_from_proto_and_ip (transport_proto,
642 fib_proto == FIB_PROTOCOL_IP4);
645 hash_foreach (handle, sm_index, app->listeners_table, ({
646 listener = listen_session_get_from_handle (handle);
647 if (listener->session_type == sst
648 && listener->listener_index != SESSION_PROXY_LISTENER_INDEX)
657 application_proxy_listener (application_t * app, u8 fib_proto,
660 stream_session_t *listener;
665 sst = session_type_from_proto_and_ip (transport_proto,
666 fib_proto == FIB_PROTOCOL_IP4);
669 hash_foreach (handle, sm_index, app->listeners_table, ({
670 listener = listen_session_get_from_handle (handle);
671 if (listener->session_type == sst
672 && listener->listener_index == SESSION_PROXY_LISTENER_INDEX)
680 static clib_error_t *
681 application_start_stop_proxy_fib_proto (application_t * app, u8 fib_proto,
682 u8 transport_proto, u8 is_start)
684 app_namespace_t *app_ns = app_namespace_get (app->ns_index);
685 u8 is_ip4 = (fib_proto == FIB_PROTOCOL_IP4);
686 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
687 transport_connection_t *tc;
693 s = application_first_listener (app, fib_proto, transport_proto);
697 sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
698 sep.sw_if_index = app_ns->sw_if_index;
699 sep.transport_proto = transport_proto;
700 application_start_listen (app, &sep, &handle);
701 s = listen_session_get_from_handle (handle);
702 s->listener_index = SESSION_PROXY_LISTENER_INDEX;
707 s = application_proxy_listener (app, fib_proto, transport_proto);
711 tc = listen_session_get_transport (s);
713 if (!ip_is_zero (&tc->lcl_ip, 1))
717 sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
718 sep.transport_proto = transport_proto;
720 sti = session_lookup_get_index_for_fib (fib_proto, sep.fib_index);
722 session_lookup_add_session_endpoint (sti, &sep, s->session_index);
724 session_lookup_del_session_endpoint (sti, &sep);
731 application_start_stop_proxy_local_scope (application_t * app,
732 u8 transport_proto, u8 is_start)
734 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
735 app_namespace_t *app_ns;
736 app_ns = app_namespace_get (app->ns_index);
738 sep.transport_proto = transport_proto;
743 session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
746 session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
751 session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
753 session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
758 application_start_stop_proxy (application_t * app,
759 transport_proto_t transport_proto, u8 is_start)
761 if (application_has_local_scope (app))
762 application_start_stop_proxy_local_scope (app, transport_proto, is_start);
764 if (application_has_global_scope (app))
766 application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP4,
767 transport_proto, is_start);
768 application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP6,
769 transport_proto, is_start);
774 application_setup_proxy (application_t * app)
776 u16 transports = app->proxied_transports;
777 transport_proto_t tp;
779 ASSERT (application_is_proxy (app));
782 transport_proto_foreach (tp, ({
783 if (transports & (1 << tp))
784 application_start_stop_proxy (app, tp, 1);
790 application_remove_proxy (application_t * app)
792 u16 transports = app->proxied_transports;
793 transport_proto_t tp;
795 ASSERT (application_is_proxy (app));
798 transport_proto_foreach (tp, ({
799 if (transports & (1 << tp))
800 application_start_stop_proxy (app, tp, 0);
805 segment_manager_properties_t *
806 application_segment_manager_properties (application_t * app)
808 return &app->sm_properties;
811 segment_manager_properties_t *
812 application_get_segment_manager_properties (u32 app_index)
814 application_t *app = application_get (app_index);
815 return &app->sm_properties;
819 app_enqueue_evt (svm_msg_q_t * mq, svm_msg_q_msg_t * msg, u8 lock)
821 if (PREDICT_FALSE (svm_msg_q_is_full (mq)))
823 clib_warning ("evt q full");
824 svm_msg_q_free_msg (mq, msg);
826 svm_msg_q_unlock (mq);
832 svm_msg_q_add_and_unlock (mq, msg);
836 /* Even when not locking the ring, we must wait for queue mutex */
837 if (svm_msg_q_add (mq, msg, SVM_Q_WAIT))
839 clib_warning ("msg q add returned");
846 app_send_io_evt_rx (application_t * app, stream_session_t * s, u8 lock)
848 session_event_t *evt;
852 if (PREDICT_FALSE (s->session_state != SESSION_STATE_READY
853 && s->session_state != SESSION_STATE_LISTENING))
855 /* Session is closed so app will never clean up. Flush rx fifo */
856 if (s->session_state == SESSION_STATE_CLOSED)
857 svm_fifo_dequeue_drop_all (s->server_rx_fifo);
861 if (app->cb_fns.builtin_app_rx_callback)
862 return app->cb_fns.builtin_app_rx_callback (s);
864 if (svm_fifo_has_event (s->server_rx_fifo)
865 || svm_fifo_is_empty (s->server_rx_fifo))
868 mq = app->event_queue;
872 if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
874 clib_warning ("evt q rings full");
876 svm_msg_q_unlock (mq);
880 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
881 ASSERT (!svm_msg_q_msg_is_invalid (&msg));
883 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
884 evt->fifo = s->server_rx_fifo;
885 evt->event_type = FIFO_EVENT_APP_RX;
887 if (app_enqueue_evt (mq, &msg, lock))
889 (void) svm_fifo_set_event (s->server_rx_fifo);
894 app_send_io_evt_tx (application_t * app, stream_session_t * s, u8 lock)
897 session_event_t *evt;
900 if (application_is_builtin (app))
903 mq = app->event_queue;
907 if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
909 clib_warning ("evt q rings full");
911 svm_msg_q_unlock (mq);
915 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
916 ASSERT (!svm_msg_q_msg_is_invalid (&msg));
918 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
919 evt->event_type = FIFO_EVENT_APP_TX;
920 evt->fifo = s->server_tx_fifo;
922 return app_enqueue_evt (mq, &msg, lock);
926 typedef int (app_send_evt_handler_fn) (application_t *app,
929 static app_send_evt_handler_fn * const app_send_evt_handler_fns[3] = {
937 * Send event to application
939 * Logic from queue perspective is non-blocking. That is, if there's
940 * not enough space to enqueue a message, we return. However, if the lock
941 * flag is set, we do wait for queue mutex.
944 application_send_event (application_t * app, stream_session_t * s,
947 ASSERT (app && evt_type <= FIFO_EVENT_APP_TX);
948 return app_send_evt_handler_fns[evt_type] (app, s, 0 /* lock */ );
952 application_lock_and_send_event (application_t * app, stream_session_t * s,
955 return app_send_evt_handler_fns[evt_type] (app, s, 1 /* lock */ );
959 application_alloc_local_session (application_t * app)
962 pool_get (app->local_sessions, s);
963 memset (s, 0, sizeof (*s));
964 s->app_index = app->index;
965 s->session_index = s - app->local_sessions;
966 s->session_type = session_type_from_proto_and_ip (TRANSPORT_PROTO_NONE, 0);
971 application_free_local_session (application_t * app, local_session_t * s)
973 pool_put (app->local_sessions, s);
975 memset (s, 0xfc, sizeof (*s));
979 application_get_local_session (application_t * app, u32 session_index)
981 if (pool_is_free_index (app->local_sessions, session_index))
983 return pool_elt_at_index (app->local_sessions, session_index);
987 application_get_local_session_from_handle (session_handle_t handle)
989 application_t *server;
990 u32 session_index, server_index;
991 local_session_parse_handle (handle, &server_index, &session_index);
992 server = application_get (server_index);
993 return application_get_local_session (server, session_index);
997 application_local_listener_session_endpoint (local_session_t * ll,
998 session_endpoint_t * sep)
1000 sep->transport_proto =
1001 session_type_transport_proto (ll->listener_session_type);
1002 sep->port = ll->port;
1003 sep->is_ip4 = ll->listener_session_type & 1;
1007 application_start_local_listen (application_t * server,
1008 session_endpoint_t * sep,
1009 session_handle_t * handle)
1011 session_handle_t lh;
1012 local_session_t *ll;
1015 table_index = application_local_session_table (server);
1017 /* An exact sep match, as opposed to session_lookup_local_listener */
1018 lh = session_lookup_endpoint_listener (table_index, sep, 1);
1019 if (lh != SESSION_INVALID_HANDLE)
1020 return VNET_API_ERROR_ADDRESS_IN_USE;
1022 pool_get (server->local_listen_sessions, ll);
1023 memset (ll, 0, sizeof (*ll));
1024 ll->session_type = session_type_from_proto_and_ip (TRANSPORT_PROTO_NONE, 0);
1025 ll->app_index = server->index;
1026 ll->session_index = ll - server->local_listen_sessions;
1027 ll->port = sep->port;
1028 /* Store the original session type for the unbind */
1029 ll->listener_session_type =
1030 session_type_from_proto_and_ip (sep->transport_proto, sep->is_ip4);
1031 ll->transport_listener_index = ~0;
1033 *handle = application_local_session_handle (ll);
1034 session_lookup_add_session_endpoint (table_index, sep, *handle);
1040 * Clean up local session table. If we have a listener session use it to
1041 * find the port and proto. If not, the handle must be a local table handle
1045 application_stop_local_listen (application_t * server, session_handle_t lh)
1047 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
1048 u32 table_index, ll_index, server_index;
1049 stream_session_t *sl = 0;
1050 local_session_t *ll, *ls;
1052 table_index = application_local_session_table (server);
1054 /* We have both local and global table binds. Figure from global what
1055 * the sep we should be cleaning up is.
1057 if (!session_handle_is_local (lh))
1059 sl = listen_session_get_from_handle (lh);
1060 if (!sl || listen_session_get_local_session_endpoint (sl, &sep))
1062 clib_warning ("broken listener");
1065 lh = session_lookup_endpoint_listener (table_index, &sep, 0);
1066 if (lh == SESSION_INVALID_HANDLE)
1070 local_session_parse_handle (lh, &server_index, &ll_index);
1071 ASSERT (server->index == server_index);
1072 if (!(ll = application_get_local_listen_session (server, ll_index)))
1074 clib_warning ("no local listener");
1077 application_local_listener_session_endpoint (ll, &sep);
1078 session_lookup_del_session_endpoint (table_index, &sep);
1081 pool_foreach (ls, server->local_sessions, ({
1082 if (ls->listener_index == ll->session_index)
1083 application_local_session_disconnect (server->index, ls);
1086 pool_put_index (server->local_listen_sessions, ll->session_index);
1092 application_local_session_fix_eventds (svm_msg_q_t * sq, svm_msg_q_t * cq)
1097 * segment manager initializes only the producer eventds, since vpp is
1098 * typically the producer. But for local sessions, we also pass to the
1099 * apps the mqs they listen on for events from peer apps, so they are also
1102 fd = svm_msg_q_get_producer_eventfd (sq);
1103 svm_msg_q_set_consumer_eventfd (sq, fd);
1104 fd = svm_msg_q_get_producer_eventfd (cq);
1105 svm_msg_q_set_consumer_eventfd (cq, fd);
1109 application_local_session_connect (u32 table_index, application_t * client,
1110 application_t * server,
1111 local_session_t * ll, u32 opaque)
1113 u32 seg_size, evt_q_sz, evt_q_elts, margin = 16 << 10;
1114 segment_manager_properties_t *props, *cprops;
1115 u32 round_rx_fifo_sz, round_tx_fifo_sz;
1116 int rv, has_transport, seg_index;
1117 svm_fifo_segment_private_t *seg;
1118 segment_manager_t *sm;
1119 local_session_t *ls;
1120 svm_msg_q_t *sq, *cq;
1122 ls = application_alloc_local_session (server);
1124 props = application_segment_manager_properties (server);
1125 cprops = application_segment_manager_properties (client);
1126 evt_q_elts = props->evt_q_size + cprops->evt_q_size;
1127 evt_q_sz = segment_manager_evt_q_expected_size (evt_q_elts);
1128 round_rx_fifo_sz = 1 << max_log2 (props->rx_fifo_size);
1129 round_tx_fifo_sz = 1 << max_log2 (props->tx_fifo_size);
1130 seg_size = round_rx_fifo_sz + round_tx_fifo_sz + evt_q_sz + margin;
1132 has_transport = session_has_transport ((stream_session_t *) ll);
1135 /* Local sessions don't have backing transport */
1136 ls->port = ll->port;
1137 sm = application_get_local_segment_manager (server);
1141 stream_session_t *sl = (stream_session_t *) ll;
1142 transport_connection_t *tc;
1143 tc = listen_session_get_transport (sl);
1144 ls->port = tc->lcl_port;
1145 sm = application_get_listen_segment_manager (server, sl);
1148 seg_index = segment_manager_add_segment (sm, seg_size);
1151 clib_warning ("failed to add new cut-through segment");
1154 seg = segment_manager_get_segment_w_lock (sm, seg_index);
1155 sq = segment_manager_alloc_queue (seg, props);
1156 cq = segment_manager_alloc_queue (seg, cprops);
1158 if (props->use_mq_eventfd)
1159 application_local_session_fix_eventds (sq, cq);
1161 ls->server_evt_q = pointer_to_uword (sq);
1162 ls->client_evt_q = pointer_to_uword (cq);
1163 rv = segment_manager_try_alloc_fifos (seg, props->rx_fifo_size,
1164 props->tx_fifo_size,
1165 &ls->server_rx_fifo,
1166 &ls->server_tx_fifo);
1169 clib_warning ("failed to add fifos in cut-through segment");
1170 segment_manager_segment_reader_unlock (sm);
1173 ls->server_rx_fifo->master_session_index = ls->session_index;
1174 ls->server_tx_fifo->master_session_index = ls->session_index;
1175 ls->server_rx_fifo->master_thread_index = ~0;
1176 ls->server_tx_fifo->master_thread_index = ~0;
1177 ls->svm_segment_index = seg_index;
1178 ls->listener_index = ll->session_index;
1179 ls->client_index = client->index;
1180 ls->client_opaque = opaque;
1181 ls->listener_session_type = ll->session_type;
1183 if ((rv = server->cb_fns.add_segment_callback (server->api_client_index,
1186 clib_warning ("failed to notify server of new segment");
1187 segment_manager_segment_reader_unlock (sm);
1190 segment_manager_segment_reader_unlock (sm);
1191 if ((rv = server->cb_fns.session_accept_callback ((stream_session_t *) ls)))
1193 clib_warning ("failed to send accept cut-through notify to server");
1196 if (server->flags & APP_OPTIONS_FLAGS_IS_BUILTIN)
1197 application_local_session_connect_notify (ls);
1203 segment_manager_del_segment (sm, seg);
1208 application_client_local_connect_key (local_session_t * ls)
1210 return ((uword) ls->app_index << 32 | (uword) ls->session_index);
1214 application_client_local_connect_key_parse (uword key, u32 * app_index,
1215 u32 * session_index)
1217 *app_index = key >> 32;
1218 *session_index = key & 0xFFFFFFFF;
1222 application_local_session_connect_notify (local_session_t * ls)
1224 svm_fifo_segment_private_t *seg;
1225 application_t *client, *server;
1226 segment_manager_t *sm;
1227 int rv, is_fail = 0;
1230 client = application_get (ls->client_index);
1231 server = application_get (ls->app_index);
1232 sm = application_get_local_segment_manager_w_session (server, ls);
1233 seg = segment_manager_get_segment_w_lock (sm, ls->svm_segment_index);
1234 if ((rv = client->cb_fns.add_segment_callback (client->api_client_index,
1237 clib_warning ("failed to notify client %u of new segment",
1239 segment_manager_segment_reader_unlock (sm);
1240 application_local_session_disconnect (ls->client_index, ls);
1245 segment_manager_segment_reader_unlock (sm);
1248 client->cb_fns.session_connected_callback (client->index, ls->client_opaque,
1249 (stream_session_t *) ls,
1252 client_key = application_client_local_connect_key (ls);
1253 hash_set (client->local_connects, client_key, client_key);
1258 application_local_session_cleanup (application_t * client,
1259 application_t * server,
1260 local_session_t * ls)
1262 svm_fifo_segment_private_t *seg;
1263 segment_manager_t *sm;
1267 has_transport = session_has_transport ((stream_session_t *) ls);
1268 client_key = application_client_local_connect_key (ls);
1270 sm = application_get_local_segment_manager_w_session (server, ls);
1272 sm = application_get_listen_segment_manager (server,
1273 (stream_session_t *) ls);
1275 seg = segment_manager_get_segment (sm, ls->svm_segment_index);
1277 hash_unset (client->local_connects, client_key);
1281 server->cb_fns.del_segment_callback (server->api_client_index,
1284 client->cb_fns.del_segment_callback (client->api_client_index,
1286 segment_manager_del_segment (sm, seg);
1289 application_free_local_session (server, ls);
1295 application_local_session_disconnect (u32 app_index, local_session_t * ls)
1297 application_t *client, *server;
1299 client = application_get_if_valid (ls->client_index);
1300 server = application_get (ls->app_index);
1302 if (ls->session_state == SESSION_STATE_CLOSED)
1303 return application_local_session_cleanup (client, server, ls);
1305 if (app_index == ls->client_index)
1307 mq_send_local_session_disconnected_cb (ls->app_index, ls);
1313 return application_local_session_cleanup (client, server, ls);
1315 else if (ls->session_state < SESSION_STATE_READY)
1317 client->cb_fns.session_connected_callback (client->index,
1319 (stream_session_t *) ls,
1321 ls->session_state = SESSION_STATE_CLOSED;
1322 return application_local_session_cleanup (client, server, ls);
1326 mq_send_local_session_disconnected_cb (client->index, ls);
1330 ls->session_state = SESSION_STATE_CLOSED;
1336 application_local_session_disconnect_w_index (u32 app_index, u32 ls_index)
1339 local_session_t *ls;
1340 app = application_get (app_index);
1341 ls = application_get_local_session (app, ls_index);
1342 return application_local_session_disconnect (app_index, ls);
1346 application_local_sessions_del (application_t * app)
1348 u32 index, server_index, session_index, table_index;
1349 segment_manager_t *sm;
1350 u64 handle, *handles = 0;
1351 local_session_t *ls, *ll;
1352 application_t *server;
1353 session_endpoint_t sep;
1357 * Local listens. Don't bother with local sessions, we clean them lower
1359 table_index = application_local_session_table (app);
1361 pool_foreach (ll, app->local_listen_sessions, ({
1362 application_local_listener_session_endpoint (ll, &sep);
1363 session_lookup_del_session_endpoint (table_index, &sep);
1370 if (app->local_sessions)
1373 pool_foreach (ls, app->local_sessions, ({
1374 application_local_session_disconnect (app->index, ls);
1382 vec_reset_length (handles);
1384 hash_foreach (handle, index, app->local_connects, ({
1385 vec_add1 (handles, handle);
1389 for (i = 0; i < vec_len (handles); i++)
1391 application_client_local_connect_key_parse (handles[i], &server_index,
1393 server = application_get_if_valid (server_index);
1396 ls = application_get_local_session (server, session_index);
1397 application_local_session_disconnect (app->index, ls);
1401 sm = segment_manager_get (app->local_segment_manager);
1402 sm->app_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
1403 segment_manager_del (sm);
1407 vnet_app_add_tls_cert (vnet_app_add_tls_cert_args_t * a)
1410 app = application_get (a->app_index);
1412 return clib_error_return_code (0, VNET_API_ERROR_APPLICATION_NOT_ATTACHED,
1413 0, "app %u doesn't exist", a->app_index);
1414 app->tls_cert = vec_dup (a->cert);
1419 vnet_app_add_tls_key (vnet_app_add_tls_key_args_t * a)
1422 app = application_get (a->app_index);
1424 return clib_error_return_code (0, VNET_API_ERROR_APPLICATION_NOT_ATTACHED,
1425 0, "app %u doesn't exist", a->app_index);
1426 app->tls_key = vec_dup (a->key);
1431 format_application_listener (u8 * s, va_list * args)
1433 application_t *app = va_arg (*args, application_t *);
1434 u64 handle = va_arg (*args, u64);
1435 u32 sm_index = va_arg (*args, u32);
1436 int verbose = va_arg (*args, int);
1437 stream_session_t *listener;
1443 s = format (s, "%-40s%-20s%-15s%-15s%-10s", "Connection", "App",
1444 "API Client", "ListenerID", "SegManager");
1446 s = format (s, "%-40s%-20s", "Connection", "App");
1451 app_name = app_get_name_from_reg_index (app);
1452 listener = listen_session_get_from_handle (handle);
1453 str = format (0, "%U", format_stream_session, listener, verbose);
1457 s = format (s, "%-40s%-20s%-15u%-15u%-10u", str, app_name,
1458 app->api_client_index, handle, sm_index);
1461 s = format (s, "%-40s%-20s", str, app_name);
1463 vec_free (app_name);
1468 application_format_connects (application_t * app, int verbose)
1470 svm_fifo_segment_private_t *fifo_segment;
1471 vlib_main_t *vm = vlib_get_main ();
1472 segment_manager_t *sm;
1473 u8 *app_name, *s = 0;
1479 vlib_cli_output (vm, "%-40s%-20s%-15s%-10s", "Connection", "App",
1480 "API Client", "SegManager");
1482 vlib_cli_output (vm, "%-40s%-20s", "Connection", "App");
1487 if (app->connects_seg_manager == (u32) ~ 0)
1490 app_name = app_get_name_from_reg_index (app);
1492 /* Across all fifo segments */
1493 sm = segment_manager_get (app->connects_seg_manager);
1496 segment_manager_foreach_segment_w_lock (fifo_segment, sm, ({
1500 fifo = svm_fifo_segment_get_fifo_list (fifo_segment);
1503 u32 session_index, thread_index;
1504 stream_session_t *session;
1506 session_index = fifo->master_session_index;
1507 thread_index = fifo->master_thread_index;
1509 session = session_get (session_index, thread_index);
1510 str = format (0, "%U", format_stream_session, session, verbose);
1513 s = format (s, "%-40s%-20s%-15u%-10u", str, app_name,
1514 app->api_client_index, app->connects_seg_manager);
1516 s = format (s, "%-40s%-20s", str, app_name);
1518 vlib_cli_output (vm, "%v", s);
1519 vec_reset_length (s);
1528 vec_free (app_name);
1532 application_format_local_sessions (application_t * app, int verbose)
1534 vlib_main_t *vm = vlib_get_main ();
1535 local_session_t *ls;
1536 transport_proto_t tp;
1542 vlib_cli_output (vm, "%-40s%-15s%-20s", "Connection", "ServerApp",
1548 pool_foreach (ls, app->local_listen_sessions, ({
1549 tp = session_type_transport_proto(ls->listener_session_type);
1550 conn = format (0, "[L][%U] *:%u", format_transport_proto_short, tp,
1552 vlib_cli_output (vm, "%-40v%-15u%-20s", conn, ls->app_index, "*");
1553 vec_reset_length (conn);
1555 pool_foreach (ls, app->local_sessions, ({
1556 tp = session_type_transport_proto(ls->listener_session_type);
1557 conn = format (0, "[L][%U] *:%u", format_transport_proto_short, tp,
1559 vlib_cli_output (vm, "%-40v%-15u%-20u", conn, ls->app_index,
1561 vec_reset_length (conn);
1569 application_format_local_connects (application_t * app, int verbose)
1571 vlib_main_t *vm = vlib_get_main ();
1572 u32 app_index, session_index;
1573 application_t *server;
1574 local_session_t *ls;
1582 vlib_cli_output (vm, "%-40s%-15s%-20s%-10s", "Connection", "App",
1583 "Peer App", "SegManager");
1585 vlib_cli_output (vm, "%-40s%-15s%-20s", "Connection", "App",
1591 hash_foreach (client_key, value, app->local_connects, ({
1592 application_client_local_connect_key_parse (client_key, &app_index,
1594 server = application_get (app_index);
1595 ls = application_get_local_session (server, session_index);
1596 vlib_cli_output (vm, "%-40s%-15s%-20s", "TODO", ls->app_index, ls->client_index);
1602 format_application (u8 * s, va_list * args)
1604 application_t *app = va_arg (*args, application_t *);
1605 CLIB_UNUSED (int verbose) = va_arg (*args, int);
1606 segment_manager_properties_t *props;
1607 const u8 *app_ns_name;
1613 s = format (s, "%-10s%-20s%-15s%-15s%-15s%-15s%-15s", "Index", "Name",
1614 "API Client", "Namespace", "Add seg size", "Rx-f size",
1617 s = format (s, "%-10s%-20s%-15s%-40s", "Index", "Name", "API Client",
1622 app_name = app_get_name (app);
1623 app_ns_name = app_namespace_id_from_index (app->ns_index);
1624 props = application_segment_manager_properties (app);
1626 s = format (s, "%-10u%-20s%-15d%-15u%-15U%-15U%-15U", app->index,
1627 app_name, app->api_client_index, app->ns_index,
1628 format_memory_size, props->add_segment_size,
1629 format_memory_size, props->rx_fifo_size, format_memory_size,
1630 props->tx_fifo_size);
1632 s = format (s, "%-10u%-20s%-15d%-40s", app->index, app_name,
1633 app->api_client_index, app_ns_name);
1639 application_format_all_listeners (vlib_main_t * vm, int do_local, int verbose)
1645 if (!pool_elts (app_pool))
1647 vlib_cli_output (vm, "No active server bindings");
1653 application_format_local_sessions (0, verbose);
1655 pool_foreach (app, app_pool, ({
1656 if (!pool_elts (app->local_sessions)
1657 && !pool_elts(app->local_connects))
1659 application_format_local_sessions (app, verbose);
1665 vlib_cli_output (vm, "%U", format_application_listener, 0 /* header */ ,
1669 pool_foreach (app, app_pool, ({
1670 if (hash_elts (app->listeners_table) == 0)
1672 hash_foreach (handle, sm_index, app->listeners_table, ({
1673 vlib_cli_output (vm, "%U", format_application_listener, app,
1674 handle, sm_index, verbose);
1682 application_format_all_clients (vlib_main_t * vm, int do_local, int verbose)
1686 if (!pool_elts (app_pool))
1688 vlib_cli_output (vm, "No active apps");
1694 application_format_local_connects (0, verbose);
1697 pool_foreach (app, app_pool, ({
1698 if (app->local_connects)
1699 application_format_local_connects (app, verbose);
1705 application_format_connects (0, verbose);
1708 pool_foreach (app, app_pool, ({
1709 if (app->connects_seg_manager == (u32)~0)
1711 application_format_connects (app, verbose);
1717 static clib_error_t *
1718 show_app_command_fn (vlib_main_t * vm, unformat_input_t * input,
1719 vlib_cli_command_t * cmd)
1721 int do_server = 0, do_client = 0, do_local = 0;
1725 session_cli_return_if_not_enabled ();
1727 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1729 if (unformat (input, "server"))
1731 else if (unformat (input, "client"))
1733 else if (unformat (input, "local"))
1735 else if (unformat (input, "verbose"))
1742 application_format_all_listeners (vm, do_local, verbose);
1745 application_format_all_clients (vm, do_local, verbose);
1747 /* Print app related info */
1748 if (!do_server && !do_client)
1750 vlib_cli_output (vm, "%U", format_application, 0, verbose);
1752 pool_foreach (app, app_pool, ({
1753 vlib_cli_output (vm, "%U", format_application, app, verbose);
1762 VLIB_CLI_COMMAND (show_app_command, static) =
1765 .short_help = "show app [server|client] [verbose]",
1766 .function = show_app_command_fn,
1771 * fd.io coding-style-patch-verification: ON
1774 * eval: (c-set-style "gnu")