2 * Copyright (c) 2019 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/session.h>
21 * Pool of workers associated to apps
23 static app_worker_t *app_workers;
26 app_worker_alloc (application_t * app)
28 app_worker_t *app_wrk;
29 pool_get (app_workers, app_wrk);
30 clib_memset (app_wrk, 0, sizeof (*app_wrk));
31 app_wrk->wrk_index = app_wrk - app_workers;
32 app_wrk->app_index = app->app_index;
33 app_wrk->wrk_map_index = ~0;
34 app_wrk->connects_seg_manager = APP_INVALID_SEGMENT_MANAGER_INDEX;
35 app_wrk->first_segment_manager = APP_INVALID_SEGMENT_MANAGER_INDEX;
36 clib_spinlock_init (&app_wrk->detached_seg_managers_lock);
37 APP_DBG ("New app %v worker %u", app->name, app_wrk->wrk_index);
42 app_worker_get (u32 wrk_index)
44 return pool_elt_at_index (app_workers, wrk_index);
48 app_worker_get_if_valid (u32 wrk_index)
50 if (pool_is_free_index (app_workers, wrk_index))
52 return pool_elt_at_index (app_workers, wrk_index);
56 app_worker_free (app_worker_t * app_wrk)
58 application_t *app = application_get (app_wrk->app_index);
59 vnet_unlisten_args_t _a, *a = &_a;
60 u64 handle, *handles = 0, *sm_indices = 0;
61 segment_manager_t *sm;
71 hash_foreach (handle, sm_index, app_wrk->listeners_table, ({
72 ls = listen_session_get_from_handle (handle);
73 vec_add1 (handles, app_listen_session_handle (ls));
74 vec_add1 (sm_indices, sm_index);
75 sm = segment_manager_get (sm_index);
79 for (i = 0; i < vec_len (handles); i++)
81 /* Cleanup listener */
82 a->app_index = app->app_index;
83 a->wrk_map_index = app_wrk->wrk_map_index;
84 a->handle = handles[i];
85 (void) vnet_unlisten (a);
87 sm = segment_manager_get_if_valid (sm_indices[i]);
88 if (sm && !segment_manager_app_detached (sm))
90 sm->first_is_protected = 0;
91 segment_manager_init_free (sm);
94 vec_reset_length (handles);
95 vec_free (sm_indices);
96 hash_free (app_wrk->listeners_table);
99 * Connects segment manager cleanup
102 if (app_wrk->connects_seg_manager != APP_INVALID_SEGMENT_MANAGER_INDEX)
104 sm = segment_manager_get (app_wrk->connects_seg_manager);
105 sm->app_wrk_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
106 sm->first_is_protected = 0;
107 segment_manager_init_free (sm);
114 for (i = 0; i < vec_len (app_wrk->half_open_table); i++)
116 if (!app_wrk->half_open_table[i])
120 hash_foreach (handle, sm_index, app_wrk->half_open_table[i], ({
121 vec_add1 (handles, handle);
125 for (j = 0; j < vec_len (handles); j++)
126 session_cleanup_half_open (i, handles[j]);
128 hash_free (app_wrk->half_open_table[i]);
129 vec_reset_length (handles);
132 vec_free (app_wrk->half_open_table);
136 * Detached listener segment managers cleanup
138 for (i = 0; i < vec_len (app_wrk->detached_seg_managers); i++)
140 sm = segment_manager_get (app_wrk->detached_seg_managers[i]);
141 segment_manager_init_free (sm);
143 vec_free (app_wrk->detached_seg_managers);
144 clib_spinlock_free (&app_wrk->detached_seg_managers_lock);
146 /* If first segment manager is used by a listener that recently
147 * stopped listening, mark it as detached */
148 if (app_wrk->first_segment_manager != app_wrk->connects_seg_manager
149 && (sm = segment_manager_get_if_valid (app_wrk->first_segment_manager))
150 && !segment_manager_app_detached (sm))
152 sm->first_is_protected = 0;
153 sm->app_wrk_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
154 segment_manager_init_free (sm);
158 clib_memset (app_wrk, 0xfe, sizeof (*app_wrk));
159 pool_put (app_workers, app_wrk);
163 app_worker_get_app (u32 wrk_index)
165 app_worker_t *app_wrk;
166 app_wrk = app_worker_get_if_valid (wrk_index);
169 return application_get_if_valid (app_wrk->app_index);
172 static segment_manager_t *
173 app_worker_alloc_segment_manager (app_worker_t * app_wrk)
175 segment_manager_t *sm = 0;
177 /* If the first segment manager is not in use, don't allocate a new one */
178 if (app_wrk->first_segment_manager != APP_INVALID_SEGMENT_MANAGER_INDEX
179 && app_wrk->first_segment_manager_in_use == 0)
181 sm = segment_manager_get (app_wrk->first_segment_manager);
182 app_wrk->first_segment_manager_in_use = 1;
186 sm = segment_manager_alloc ();
188 sm->app_wrk_index = app_wrk->wrk_index;
189 segment_manager_init (sm);
194 app_worker_alloc_session_fifos (segment_manager_t * sm, session_t * s)
196 svm_fifo_t *rx_fifo = 0, *tx_fifo = 0;
199 if ((rv = segment_manager_alloc_session_fifos (sm, s->thread_index,
200 &rx_fifo, &tx_fifo)))
203 rx_fifo->master_session_index = s->session_index;
204 rx_fifo->master_thread_index = s->thread_index;
206 tx_fifo->master_session_index = s->session_index;
207 tx_fifo->master_thread_index = s->thread_index;
209 s->rx_fifo = rx_fifo;
210 s->tx_fifo = tx_fifo;
215 app_worker_init_listener (app_worker_t * app_wrk, session_t * ls)
217 segment_manager_t *sm;
219 /* Allocate segment manager. All sessions derived out of a listen session
220 * have fifos allocated by the same segment manager. */
221 if (!(sm = app_worker_alloc_segment_manager (app_wrk)))
222 return SESSION_E_ALLOC;
224 /* Keep track of the segment manager for the listener or this worker */
225 hash_set (app_wrk->listeners_table, listen_session_get_handle (ls),
226 segment_manager_index (sm));
228 if (transport_connection_is_cless (session_get_transport (ls)))
231 return SESSION_E_NOSUPPORT;
232 return app_worker_alloc_session_fifos (sm, ls);
238 app_worker_start_listen (app_worker_t * app_wrk,
239 app_listener_t * app_listener)
244 if (clib_bitmap_get (app_listener->workers, app_wrk->wrk_map_index))
245 return SESSION_E_ALREADY_LISTENING;
247 app_listener->workers = clib_bitmap_set (app_listener->workers,
248 app_wrk->wrk_map_index, 1);
250 if (app_listener->session_index != SESSION_INVALID_INDEX)
252 ls = session_get (app_listener->session_index, 0);
253 if ((rv = app_worker_init_listener (app_wrk, ls)))
257 if (app_listener->local_index != SESSION_INVALID_INDEX)
259 ls = session_get (app_listener->local_index, 0);
260 if ((rv = app_worker_init_listener (app_wrk, ls)))
268 app_worker_add_detached_sm (app_worker_t * app_wrk, u32 sm_index)
270 vec_add1 (app_wrk->detached_seg_managers, sm_index);
274 app_worker_del_detached_sm (app_worker_t * app_wrk, u32 sm_index)
278 clib_spinlock_lock (&app_wrk->detached_seg_managers_lock);
279 for (i = 0; i < vec_len (app_wrk->detached_seg_managers); i++)
281 if (app_wrk->detached_seg_managers[i] == sm_index)
283 vec_del1 (app_wrk->detached_seg_managers, i);
287 clib_spinlock_unlock (&app_wrk->detached_seg_managers_lock);
291 app_worker_stop_listen_session (app_worker_t * app_wrk, session_t * ls)
293 session_handle_t handle;
294 segment_manager_t *sm;
297 handle = listen_session_get_handle (ls);
298 sm_indexp = hash_get (app_wrk->listeners_table, handle);
299 if (PREDICT_FALSE (!sm_indexp))
302 /* Dealloc fifos, if any (dgram listeners) */
305 segment_manager_dealloc_fifos (ls->rx_fifo, ls->tx_fifo);
306 ls->tx_fifo = ls->rx_fifo = 0;
309 /* Try to cleanup segment manager */
310 sm = segment_manager_get (*sm_indexp);
311 if (sm && app_wrk->first_segment_manager != *sm_indexp)
313 segment_manager_app_detach (sm);
314 if (!segment_manager_has_fifos (sm))
315 segment_manager_free (sm);
318 /* Track segment manager in case app detaches and all the
319 * outstanding sessions need to be closed */
320 app_worker_add_detached_sm (app_wrk, *sm_indexp);
321 sm->flags |= SEG_MANAGER_F_DETACHED_LISTENER;
325 hash_unset (app_wrk->listeners_table, handle);
329 app_worker_stop_listen (app_worker_t * app_wrk, app_listener_t * al)
333 if (!clib_bitmap_get (al->workers, app_wrk->wrk_map_index))
336 if (al->session_index != SESSION_INVALID_INDEX)
338 ls = listen_session_get (al->session_index);
339 app_worker_stop_listen_session (app_wrk, ls);
342 if (al->local_index != SESSION_INVALID_INDEX)
344 ls = listen_session_get (al->local_index);
345 app_worker_stop_listen_session (app_wrk, ls);
348 clib_bitmap_set_no_check (al->workers, app_wrk->wrk_map_index, 0);
349 if (clib_bitmap_is_zero (al->workers))
350 app_listener_cleanup (al);
356 app_worker_init_accepted (session_t * s)
358 app_worker_t *app_wrk;
359 segment_manager_t *sm;
363 listener = listen_session_get_from_handle (s->listener_handle);
364 app_wrk = application_listener_select_worker (listener);
365 s->app_wrk_index = app_wrk->wrk_index;
367 app = application_get (app_wrk->app_index);
368 if (app->cb_fns.fifo_tuning_callback)
369 s->flags |= SESSION_F_CUSTOM_FIFO_TUNING;
371 sm = app_worker_get_listen_segment_manager (app_wrk, listener);
372 if (app_worker_alloc_session_fifos (sm, s))
379 app_worker_accept_notify (app_worker_t * app_wrk, session_t * s)
381 application_t *app = application_get (app_wrk->app_index);
382 return app->cb_fns.session_accept_callback (s);
386 app_worker_init_connected (app_worker_t * app_wrk, session_t * s)
388 application_t *app = application_get (app_wrk->app_index);
389 segment_manager_t *sm;
391 /* Allocate fifos for session, unless the app is a builtin proxy */
392 if (!application_is_builtin_proxy (app))
394 sm = app_worker_get_connect_segment_manager (app_wrk);
395 return app_worker_alloc_session_fifos (sm, s);
398 if (app->cb_fns.fifo_tuning_callback)
399 s->flags |= SESSION_F_CUSTOM_FIFO_TUNING;
405 app_worker_connect_notify (app_worker_t * app_wrk, session_t * s,
406 session_error_t err, u32 opaque)
408 application_t *app = application_get (app_wrk->app_index);
409 return app->cb_fns.session_connected_callback (app_wrk->wrk_index, opaque,
414 app_worker_add_half_open (app_worker_t * app_wrk, transport_proto_t tp,
415 session_handle_t ho_handle,
416 session_handle_t wrk_handle)
418 ASSERT (vlib_get_thread_index () == 0);
419 vec_validate (app_wrk->half_open_table, tp);
420 hash_set (app_wrk->half_open_table[tp], ho_handle, wrk_handle);
425 app_worker_del_half_open (app_worker_t * app_wrk, transport_proto_t tp,
426 session_handle_t ho_handle)
428 ASSERT (vlib_get_thread_index () == 0);
429 hash_unset (app_wrk->half_open_table[tp], ho_handle);
434 app_worker_lookup_half_open (app_worker_t * app_wrk, transport_proto_t tp,
435 session_handle_t ho_handle)
439 /* No locking because all updates are done from main thread */
440 ho_wrk_handlep = hash_get (app_wrk->half_open_table[tp], ho_handle);
442 return SESSION_INVALID_HANDLE;
444 return *ho_wrk_handlep;
448 app_worker_close_notify (app_worker_t * app_wrk, session_t * s)
450 application_t *app = application_get (app_wrk->app_index);
451 app->cb_fns.session_disconnect_callback (s);
456 app_worker_transport_closed_notify (app_worker_t * app_wrk, session_t * s)
458 application_t *app = application_get (app_wrk->app_index);
459 if (app->cb_fns.session_transport_closed_callback)
460 app->cb_fns.session_transport_closed_callback (s);
465 app_worker_reset_notify (app_worker_t * app_wrk, session_t * s)
467 application_t *app = application_get (app_wrk->app_index);
468 app->cb_fns.session_reset_callback (s);
473 app_worker_cleanup_notify (app_worker_t * app_wrk, session_t * s,
474 session_cleanup_ntf_t ntf)
476 application_t *app = application_get (app_wrk->app_index);
477 if (app->cb_fns.session_cleanup_callback)
478 app->cb_fns.session_cleanup_callback (s, ntf);
483 app_worker_builtin_rx (app_worker_t * app_wrk, session_t * s)
485 application_t *app = application_get (app_wrk->app_index);
486 app->cb_fns.builtin_app_rx_callback (s);
491 app_worker_builtin_tx (app_worker_t * app_wrk, session_t * s)
493 application_t *app = application_get (app_wrk->app_index);
495 if (!app->cb_fns.builtin_app_tx_callback)
498 app->cb_fns.builtin_app_tx_callback (s);
503 app_worker_migrate_notify (app_worker_t * app_wrk, session_t * s,
504 session_handle_t new_sh)
506 application_t *app = application_get (app_wrk->app_index);
507 app->cb_fns.session_migrate_callback (s, new_sh);
512 app_worker_own_session (app_worker_t * app_wrk, session_t * s)
514 segment_manager_t *sm;
515 svm_fifo_t *rxf, *txf;
517 if (s->session_state == SESSION_STATE_LISTENING)
518 return application_change_listener_owner (s, app_wrk);
520 s->app_wrk_index = app_wrk->wrk_index;
531 sm = app_worker_get_or_alloc_connect_segment_manager (app_wrk);
532 if (app_worker_alloc_session_fifos (sm, s))
535 if (!svm_fifo_is_empty_cons (rxf))
536 svm_fifo_clone (s->rx_fifo, rxf);
538 if (!svm_fifo_is_empty_cons (txf))
539 svm_fifo_clone (s->tx_fifo, txf);
541 segment_manager_dealloc_fifos (rxf, txf);
547 app_worker_connect_session (app_worker_t * app_wrk, session_endpoint_t * sep,
552 /* Make sure we have a segment manager for connects */
553 if (app_worker_alloc_connects_segment_manager (app_wrk))
554 return SESSION_E_ALLOC;
556 if ((rv = session_open (app_wrk->wrk_index, sep, api_context)))
563 app_worker_session_fifo_tuning (app_worker_t * app_wrk, session_t * s,
565 session_ft_action_t act, u32 len)
567 application_t *app = application_get (app_wrk->app_index);
568 return app->cb_fns.fifo_tuning_callback (s, f, act, len);
572 app_worker_alloc_connects_segment_manager (app_worker_t * app_wrk)
574 segment_manager_t *sm;
576 if (app_wrk->connects_seg_manager == APP_INVALID_SEGMENT_MANAGER_INDEX)
578 sm = app_worker_alloc_segment_manager (app_wrk);
581 app_wrk->connects_seg_manager = segment_manager_index (sm);
587 app_worker_get_connect_segment_manager (app_worker_t * app)
589 ASSERT (app->connects_seg_manager != (u32) ~ 0);
590 return segment_manager_get (app->connects_seg_manager);
594 app_worker_get_or_alloc_connect_segment_manager (app_worker_t * app_wrk)
596 if (app_wrk->connects_seg_manager == (u32) ~ 0)
597 app_worker_alloc_connects_segment_manager (app_wrk);
598 return segment_manager_get (app_wrk->connects_seg_manager);
602 app_worker_get_listen_segment_manager (app_worker_t * app,
603 session_t * listener)
606 smp = hash_get (app->listeners_table, listen_session_get_handle (listener));
607 ALWAYS_ASSERT (smp != 0);
608 return segment_manager_get (*smp);
612 app_worker_first_listener (app_worker_t * app_wrk, u8 fib_proto,
620 sst = session_type_from_proto_and_ip (transport_proto,
621 fib_proto == FIB_PROTOCOL_IP4);
624 hash_foreach (handle, sm_index, app_wrk->listeners_table, ({
625 listener = listen_session_get_from_handle (handle);
626 if (listener->session_type == sst
627 && !(listener->flags & SESSION_F_PROXY))
636 app_worker_proxy_listener (app_worker_t * app_wrk, u8 fib_proto,
644 sst = session_type_from_proto_and_ip (transport_proto,
645 fib_proto == FIB_PROTOCOL_IP4);
648 hash_foreach (handle, sm_index, app_wrk->listeners_table, ({
649 listener = listen_session_get_from_handle (handle);
650 if (listener->session_type == sst && (listener->flags & SESSION_F_PROXY))
659 * Send an API message to the external app, to map new segment
662 app_worker_add_segment_notify (app_worker_t * app_wrk, u64 segment_handle)
664 application_t *app = application_get (app_wrk->app_index);
666 return app->cb_fns.add_segment_callback (app_wrk->wrk_index,
671 app_worker_del_segment_notify (app_worker_t * app_wrk, u64 segment_handle)
673 application_t *app = application_get (app_wrk->app_index);
674 return app->cb_fns.del_segment_callback (app_wrk->wrk_index,
679 app_worker_application_is_builtin (app_worker_t * app_wrk)
681 return app_wrk->app_is_builtin;
685 app_send_io_evt_rx (app_worker_t * app_wrk, session_t * s)
687 session_event_t *evt;
691 if (app_worker_application_is_builtin (app_wrk))
692 return app_worker_builtin_rx (app_wrk, s);
694 if (svm_fifo_has_event (s->rx_fifo))
697 mq = app_wrk->event_queue;
700 if (PREDICT_FALSE (svm_msg_q_is_full (mq)))
702 clib_warning ("evt q full");
703 svm_msg_q_unlock (mq);
707 if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
709 clib_warning ("evt q rings full");
710 svm_msg_q_unlock (mq);
714 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
715 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
716 evt->session_index = s->rx_fifo->client_session_index;
717 evt->event_type = SESSION_IO_EVT_RX;
719 (void) svm_fifo_set_event (s->rx_fifo);
720 svm_msg_q_add_and_unlock (mq, &msg);
726 app_send_io_evt_tx (app_worker_t * app_wrk, session_t * s)
729 session_event_t *evt;
732 if (app_worker_application_is_builtin (app_wrk))
733 return app_worker_builtin_tx (app_wrk, s);
735 mq = app_wrk->event_queue;
738 if (PREDICT_FALSE (svm_msg_q_is_full (mq)))
740 clib_warning ("evt q full");
741 svm_msg_q_unlock (mq);
745 if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
747 clib_warning ("evt q rings full");
748 svm_msg_q_unlock (mq);
752 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
753 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
754 evt->event_type = SESSION_IO_EVT_TX;
755 evt->session_index = s->tx_fifo->client_session_index;
757 svm_msg_q_add_and_unlock (mq, &msg);
762 typedef int (app_send_evt_handler_fn) (app_worker_t *app,
764 static app_send_evt_handler_fn * const app_send_evt_handler_fns[2] = {
771 * Send event to application
773 * Logic from queue perspective is blocking. However, if queue is full,
777 app_worker_lock_and_send_event (app_worker_t * app, session_t * s,
780 return app_send_evt_handler_fns[evt_type] (app, s);
784 format_app_worker_listener (u8 * s, va_list * args)
786 app_worker_t *app_wrk = va_arg (*args, app_worker_t *);
787 u64 handle = va_arg (*args, u64);
788 u32 sm_index = va_arg (*args, u32);
789 int verbose = va_arg (*args, int);
797 s = format (s, "%-40s%-25s%=10s%-15s%-15s%-10s", "Connection", "App",
798 "Wrk", "API Client", "ListenerID", "SegManager");
800 s = format (s, "%-40s%-25s%=10s", "Connection", "App", "Wrk");
805 app_name = application_name_from_index (app_wrk->app_index);
806 listener = listen_session_get_from_handle (handle);
807 str = format (0, "%U", format_session, listener, verbose);
812 buf = format (0, "%u(%u)", app_wrk->wrk_map_index, app_wrk->wrk_index);
813 s = format (s, "%-40v%-25v%=10v%-15u%-15u%-10u", str, app_name,
814 buf, app_wrk->api_client_index, handle, sm_index);
818 s = format (s, "%-40v%-25v%=10u", str, app_name, app_wrk->wrk_map_index);
826 format_app_worker (u8 * s, va_list * args)
828 app_worker_t *app_wrk = va_arg (*args, app_worker_t *);
831 s = format (s, "%U wrk-index %u app-index %u map-index %u "
832 "api-client-index %d\n", format_white_space, indent,
833 app_wrk->wrk_index, app_wrk->app_index, app_wrk->wrk_map_index,
834 app_wrk->api_client_index);
839 app_worker_format_connects (app_worker_t * app_wrk, int verbose)
841 segment_manager_t *sm;
846 segment_manager_format_sessions (0, verbose);
850 if (app_wrk->connects_seg_manager == (u32) ~ 0)
853 sm = segment_manager_get (app_wrk->connects_seg_manager);
854 segment_manager_format_sessions (sm, verbose);
858 * fd.io coding-style-patch-verification: ON
861 * eval: (c-set-style "gnu")