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 clib_spinlock_init (&app_wrk->detached_seg_managers_lock);
36 APP_DBG ("New app %v worker %u", app->name, app_wrk->wrk_index);
41 app_worker_get (u32 wrk_index)
43 return pool_elt_at_index (app_workers, wrk_index);
47 app_worker_get_if_valid (u32 wrk_index)
49 if (pool_is_free_index (app_workers, wrk_index))
51 return pool_elt_at_index (app_workers, wrk_index);
55 app_worker_free (app_worker_t * app_wrk)
57 application_t *app = application_get (app_wrk->app_index);
58 vnet_unlisten_args_t _a, *a = &_a;
59 u64 handle, *handles = 0, *sm_indices = 0;
60 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 pool_foreach (sh, app_wrk->half_open_table)
115 session_cleanup_half_open (*sh);
117 pool_free (app_wrk->half_open_table);
120 * Detached listener segment managers cleanup
122 for (i = 0; i < vec_len (app_wrk->detached_seg_managers); i++)
124 sm = segment_manager_get (app_wrk->detached_seg_managers[i]);
125 segment_manager_init_free (sm);
127 vec_free (app_wrk->detached_seg_managers);
128 clib_spinlock_free (&app_wrk->detached_seg_managers_lock);
131 clib_memset (app_wrk, 0xfe, sizeof (*app_wrk));
132 pool_put (app_workers, app_wrk);
136 app_worker_get_app (u32 wrk_index)
138 app_worker_t *app_wrk;
139 app_wrk = app_worker_get_if_valid (wrk_index);
142 return application_get_if_valid (app_wrk->app_index);
145 static segment_manager_t *
146 app_worker_alloc_segment_manager (app_worker_t * app_wrk)
148 segment_manager_t *sm;
150 sm = segment_manager_alloc ();
151 sm->app_wrk_index = app_wrk->wrk_index;
152 segment_manager_init (sm);
157 app_worker_alloc_session_fifos (segment_manager_t * sm, session_t * s)
159 svm_fifo_t *rx_fifo = 0, *tx_fifo = 0;
162 if ((rv = segment_manager_alloc_session_fifos (sm, s->thread_index,
163 &rx_fifo, &tx_fifo)))
166 rx_fifo->shr->master_session_index = s->session_index;
167 rx_fifo->master_thread_index = s->thread_index;
169 tx_fifo->shr->master_session_index = s->session_index;
170 tx_fifo->master_thread_index = s->thread_index;
172 s->rx_fifo = rx_fifo;
173 s->tx_fifo = tx_fifo;
178 app_worker_init_listener (app_worker_t * app_wrk, session_t * ls)
180 segment_manager_t *sm;
182 /* Allocate segment manager. All sessions derived out of a listen session
183 * have fifos allocated by the same segment manager. */
184 if (!(sm = app_worker_alloc_segment_manager (app_wrk)))
185 return SESSION_E_ALLOC;
187 /* Keep track of the segment manager for the listener or this worker */
188 hash_set (app_wrk->listeners_table, listen_session_get_handle (ls),
189 segment_manager_index (sm));
191 if (transport_connection_is_cless (session_get_transport (ls)))
194 return SESSION_E_NOSUPPORT;
195 return app_worker_alloc_session_fifos (sm, ls);
201 app_worker_start_listen (app_worker_t * app_wrk,
202 app_listener_t * app_listener)
207 if (clib_bitmap_get (app_listener->workers, app_wrk->wrk_map_index))
208 return SESSION_E_ALREADY_LISTENING;
210 app_listener->workers = clib_bitmap_set (app_listener->workers,
211 app_wrk->wrk_map_index, 1);
213 if (app_listener->session_index != SESSION_INVALID_INDEX)
215 ls = session_get (app_listener->session_index, 0);
216 if ((rv = app_worker_init_listener (app_wrk, ls)))
220 if (app_listener->local_index != SESSION_INVALID_INDEX)
222 ls = session_get (app_listener->local_index, 0);
223 if ((rv = app_worker_init_listener (app_wrk, ls)))
231 app_worker_add_detached_sm (app_worker_t * app_wrk, u32 sm_index)
233 vec_add1 (app_wrk->detached_seg_managers, sm_index);
237 app_worker_del_detached_sm (app_worker_t * app_wrk, u32 sm_index)
241 clib_spinlock_lock (&app_wrk->detached_seg_managers_lock);
242 for (i = 0; i < vec_len (app_wrk->detached_seg_managers); i++)
244 if (app_wrk->detached_seg_managers[i] == sm_index)
246 vec_del1 (app_wrk->detached_seg_managers, i);
250 clib_spinlock_unlock (&app_wrk->detached_seg_managers_lock);
254 app_worker_stop_listen_session (app_worker_t * app_wrk, session_t * ls)
256 session_handle_t handle;
257 segment_manager_t *sm;
259 session_state_t *states = 0;
261 handle = listen_session_get_handle (ls);
262 sm_indexp = hash_get (app_wrk->listeners_table, handle);
263 if (PREDICT_FALSE (!sm_indexp))
266 /* Dealloc fifos, if any (dgram listeners) */
269 segment_manager_dealloc_fifos (ls->rx_fifo, ls->tx_fifo);
270 ls->tx_fifo = ls->rx_fifo = 0;
273 /* Try to cleanup segment manager */
274 sm = segment_manager_get (*sm_indexp);
277 segment_manager_app_detach (sm);
278 if (!segment_manager_has_fifos (sm))
280 /* Empty segment manager, cleanup it up */
281 segment_manager_free (sm);
285 /* Delete sessions in CREATED state */
286 vec_add1 (states, SESSION_STATE_CREATED);
287 segment_manager_del_sessions_filter (sm, states);
290 /* Track segment manager in case app detaches and all the
291 * outstanding sessions need to be closed */
292 app_worker_add_detached_sm (app_wrk, *sm_indexp);
293 sm->flags |= SEG_MANAGER_F_DETACHED_LISTENER;
297 hash_unset (app_wrk->listeners_table, handle);
301 app_worker_stop_listen (app_worker_t * app_wrk, app_listener_t * al)
305 if (!clib_bitmap_get (al->workers, app_wrk->wrk_map_index))
308 if (al->session_index != SESSION_INVALID_INDEX)
310 ls = listen_session_get (al->session_index);
311 app_worker_stop_listen_session (app_wrk, ls);
314 if (al->local_index != SESSION_INVALID_INDEX)
316 ls = listen_session_get (al->local_index);
317 app_worker_stop_listen_session (app_wrk, ls);
320 clib_bitmap_set_no_check (al->workers, app_wrk->wrk_map_index, 0);
321 if (clib_bitmap_is_zero (al->workers))
322 app_listener_cleanup (al);
328 app_worker_init_accepted (session_t * s)
330 app_worker_t *app_wrk;
331 segment_manager_t *sm;
335 listener = listen_session_get_from_handle (s->listener_handle);
336 app_wrk = application_listener_select_worker (listener);
337 s->app_wrk_index = app_wrk->wrk_index;
339 app = application_get (app_wrk->app_index);
340 if (app->cb_fns.fifo_tuning_callback)
341 s->flags |= SESSION_F_CUSTOM_FIFO_TUNING;
343 sm = app_worker_get_listen_segment_manager (app_wrk, listener);
344 if (app_worker_alloc_session_fifos (sm, s))
351 app_worker_accept_notify (app_worker_t * app_wrk, session_t * s)
353 application_t *app = application_get (app_wrk->app_index);
354 return app->cb_fns.session_accept_callback (s);
358 app_worker_init_connected (app_worker_t * app_wrk, session_t * s)
360 application_t *app = application_get (app_wrk->app_index);
361 segment_manager_t *sm;
363 if (app->cb_fns.fifo_tuning_callback)
364 s->flags |= SESSION_F_CUSTOM_FIFO_TUNING;
366 /* Allocate fifos for session, unless the app is a builtin proxy */
367 if (application_is_builtin_proxy (app))
370 sm = app_worker_get_connect_segment_manager (app_wrk);
371 return app_worker_alloc_session_fifos (sm, s);
375 app_worker_connect_notify (app_worker_t * app_wrk, session_t * s,
376 session_error_t err, u32 opaque)
378 application_t *app = application_get (app_wrk->app_index);
379 return app->cb_fns.session_connected_callback (app_wrk->wrk_index, opaque,
384 app_worker_add_half_open (app_worker_t *app_wrk, session_handle_t sh)
386 session_handle_t *shp;
388 ASSERT (vlib_get_thread_index () == 0);
389 pool_get (app_wrk->half_open_table, shp);
392 return (shp - app_wrk->half_open_table);
396 app_worker_del_half_open (app_worker_t *app_wrk, session_t *s)
398 application_t *app = application_get (app_wrk->app_index);
399 ASSERT (vlib_get_thread_index () <= 1);
400 pool_put_index (app_wrk->half_open_table, s->ho_index);
401 if (app->cb_fns.half_open_cleanup_callback)
402 app->cb_fns.half_open_cleanup_callback (s);
407 app_worker_close_notify (app_worker_t * app_wrk, session_t * s)
409 application_t *app = application_get (app_wrk->app_index);
410 app->cb_fns.session_disconnect_callback (s);
415 app_worker_transport_closed_notify (app_worker_t * app_wrk, session_t * s)
417 application_t *app = application_get (app_wrk->app_index);
418 if (app->cb_fns.session_transport_closed_callback)
419 app->cb_fns.session_transport_closed_callback (s);
424 app_worker_reset_notify (app_worker_t * app_wrk, session_t * s)
426 application_t *app = application_get (app_wrk->app_index);
427 app->cb_fns.session_reset_callback (s);
432 app_worker_cleanup_notify (app_worker_t * app_wrk, session_t * s,
433 session_cleanup_ntf_t ntf)
435 application_t *app = application_get (app_wrk->app_index);
436 if (app->cb_fns.session_cleanup_callback)
437 app->cb_fns.session_cleanup_callback (s, ntf);
442 app_worker_builtin_rx (app_worker_t * app_wrk, session_t * s)
444 application_t *app = application_get (app_wrk->app_index);
445 app->cb_fns.builtin_app_rx_callback (s);
450 app_worker_builtin_tx (app_worker_t * app_wrk, session_t * s)
452 application_t *app = application_get (app_wrk->app_index);
454 if (!app->cb_fns.builtin_app_tx_callback)
457 app->cb_fns.builtin_app_tx_callback (s);
462 app_worker_migrate_notify (app_worker_t * app_wrk, session_t * s,
463 session_handle_t new_sh)
465 application_t *app = application_get (app_wrk->app_index);
466 app->cb_fns.session_migrate_callback (s, new_sh);
471 app_worker_own_session (app_worker_t * app_wrk, session_t * s)
473 segment_manager_t *sm;
474 svm_fifo_t *rxf, *txf;
476 if (s->session_state == SESSION_STATE_LISTENING)
477 return application_change_listener_owner (s, app_wrk);
479 s->app_wrk_index = app_wrk->wrk_index;
490 sm = app_worker_get_connect_segment_manager (app_wrk);
491 if (app_worker_alloc_session_fifos (sm, s))
494 if (!svm_fifo_is_empty_cons (rxf))
495 svm_fifo_clone (s->rx_fifo, rxf);
497 if (!svm_fifo_is_empty_cons (txf))
498 svm_fifo_clone (s->tx_fifo, txf);
500 segment_manager_dealloc_fifos (rxf, txf);
506 app_worker_connect_session (app_worker_t *app_wrk, session_endpoint_cfg_t *sep,
507 session_handle_t *rsh)
509 sep->app_wrk_index = app_wrk->wrk_index;
511 return session_open (sep, rsh);
515 app_worker_session_fifo_tuning (app_worker_t * app_wrk, session_t * s,
517 session_ft_action_t act, u32 len)
519 application_t *app = application_get (app_wrk->app_index);
520 return app->cb_fns.fifo_tuning_callback (s, f, act, len);
524 app_worker_get_connect_segment_manager (app_worker_t * app)
526 ASSERT (app->connects_seg_manager != (u32) ~ 0);
527 return segment_manager_get (app->connects_seg_manager);
531 app_worker_get_listen_segment_manager (app_worker_t * app,
532 session_t * listener)
535 smp = hash_get (app->listeners_table, listen_session_get_handle (listener));
536 ALWAYS_ASSERT (smp != 0);
537 return segment_manager_get (*smp);
541 app_worker_first_listener (app_worker_t * app_wrk, u8 fib_proto,
549 sst = session_type_from_proto_and_ip (transport_proto,
550 fib_proto == FIB_PROTOCOL_IP4);
553 hash_foreach (handle, sm_index, app_wrk->listeners_table, ({
554 listener = listen_session_get_from_handle (handle);
555 if (listener->session_type == sst
556 && !(listener->flags & SESSION_F_PROXY))
565 app_worker_proxy_listener (app_worker_t * app_wrk, u8 fib_proto,
573 sst = session_type_from_proto_and_ip (transport_proto,
574 fib_proto == FIB_PROTOCOL_IP4);
577 hash_foreach (handle, sm_index, app_wrk->listeners_table, ({
578 listener = listen_session_get_from_handle (handle);
579 if (listener->session_type == sst && (listener->flags & SESSION_F_PROXY))
588 * Send an API message to the external app, to map new segment
591 app_worker_add_segment_notify (app_worker_t * app_wrk, u64 segment_handle)
593 application_t *app = application_get (app_wrk->app_index);
595 return app->cb_fns.add_segment_callback (app_wrk->wrk_index,
600 app_worker_del_segment_notify (app_worker_t * app_wrk, u64 segment_handle)
602 application_t *app = application_get (app_wrk->app_index);
603 return app->cb_fns.del_segment_callback (app_wrk->wrk_index,
608 app_worker_application_is_builtin (app_worker_t * app_wrk)
610 return app_wrk->app_is_builtin;
614 app_send_io_evt_rx (app_worker_t * app_wrk, session_t * s)
616 session_event_t *evt;
620 if (app_worker_application_is_builtin (app_wrk))
621 return app_worker_builtin_rx (app_wrk, s);
623 if (svm_fifo_has_event (s->rx_fifo))
626 mq = app_wrk->event_queue;
629 if (PREDICT_FALSE (svm_msg_q_is_full (mq)))
631 clib_warning ("evt q full");
632 svm_msg_q_unlock (mq);
636 if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
638 clib_warning ("evt q rings full");
639 svm_msg_q_unlock (mq);
643 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
644 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
645 evt->session_index = s->rx_fifo->shr->client_session_index;
646 evt->event_type = SESSION_IO_EVT_RX;
648 (void) svm_fifo_set_event (s->rx_fifo);
649 svm_msg_q_add_and_unlock (mq, &msg);
655 app_send_io_evt_tx (app_worker_t * app_wrk, session_t * s)
658 session_event_t *evt;
661 if (app_worker_application_is_builtin (app_wrk))
662 return app_worker_builtin_tx (app_wrk, s);
664 mq = app_wrk->event_queue;
667 if (PREDICT_FALSE (svm_msg_q_is_full (mq)))
669 clib_warning ("evt q full");
670 svm_msg_q_unlock (mq);
674 if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
676 clib_warning ("evt q rings full");
677 svm_msg_q_unlock (mq);
681 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
682 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
683 evt->event_type = SESSION_IO_EVT_TX;
684 evt->session_index = s->tx_fifo->shr->client_session_index;
686 svm_msg_q_add_and_unlock (mq, &msg);
691 typedef int (app_send_evt_handler_fn) (app_worker_t *app,
693 static app_send_evt_handler_fn * const app_send_evt_handler_fns[2] = {
700 * Send event to application
702 * Logic from queue perspective is blocking. However, if queue is full,
706 app_worker_lock_and_send_event (app_worker_t * app, session_t * s,
709 return app_send_evt_handler_fns[evt_type] (app, s);
713 format_app_worker_listener (u8 * s, va_list * args)
715 app_worker_t *app_wrk = va_arg (*args, app_worker_t *);
716 u64 handle = va_arg (*args, u64);
717 u32 sm_index = va_arg (*args, u32);
718 int verbose = va_arg (*args, int);
726 s = format (s, "%-40s%-25s%-10s%-15s%-15s%-10s", "Connection", "App",
727 "Wrk", "API Client", "ListenerID", "SegManager");
729 s = format (s, "%-40s%-25s%-10s", "Connection", "App", "Wrk");
734 app_name = application_name_from_index (app_wrk->app_index);
735 listener = listen_session_get_from_handle (handle);
736 str = format (0, "%U", format_session, listener, verbose);
741 buf = format (0, "%u(%u)", app_wrk->wrk_map_index, app_wrk->wrk_index);
742 s = format (s, "%-40v%-25v%-10v%-15u%-15u%-10u", str, app_name,
743 buf, app_wrk->api_client_index, handle, sm_index);
747 s = format (s, "%-40v%-25v%=10u", str, app_name, app_wrk->wrk_map_index);
755 format_app_worker (u8 * s, va_list * args)
757 app_worker_t *app_wrk = va_arg (*args, app_worker_t *);
760 s = format (s, "%U wrk-index %u app-index %u map-index %u "
761 "api-client-index %d\n", format_white_space, indent,
762 app_wrk->wrk_index, app_wrk->app_index, app_wrk->wrk_map_index,
763 app_wrk->api_client_index);
768 app_worker_format_connects (app_worker_t * app_wrk, int verbose)
770 segment_manager_t *sm;
775 segment_manager_format_sessions (0, verbose);
779 if (app_wrk->connects_seg_manager == (u32) ~ 0)
782 sm = segment_manager_get (app_wrk->connects_seg_manager);
783 segment_manager_format_sessions (sm, verbose);
787 * fd.io coding-style-patch-verification: ON
790 * eval: (c-set-style "gnu")