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 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;
60 segment_manager_t *sm;
70 hash_foreach (handle, sm_index, app_wrk->listeners_table, ({
71 ls = listen_session_get_from_handle (handle);
72 vec_add1 (handles, app_listen_session_handle (ls));
73 sm = segment_manager_get (sm_index);
74 sm->app_wrk_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
78 for (i = 0; i < vec_len (handles); i++)
80 a->app_index = app->app_index;
81 a->wrk_map_index = app_wrk->wrk_map_index;
82 a->handle = handles[i];
83 /* seg manager is removed when unbind completes */
84 (void) vnet_unlisten (a);
88 * Connects segment manager cleanup
91 if (app_wrk->connects_seg_manager != APP_INVALID_SEGMENT_MANAGER_INDEX)
93 sm = segment_manager_get (app_wrk->connects_seg_manager);
94 sm->app_wrk_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
95 sm->first_is_protected = 0;
96 segment_manager_init_free (sm);
99 /* If first segment manager is used by a listener */
100 if (app_wrk->first_segment_manager != APP_INVALID_SEGMENT_MANAGER_INDEX
101 && app_wrk->first_segment_manager != app_wrk->connects_seg_manager)
103 sm = segment_manager_get (app_wrk->first_segment_manager);
104 sm->first_is_protected = 0;
105 sm->app_wrk_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
106 /* .. and has no fifos, e.g. it might be used for redirected sessions,
108 if (!segment_manager_has_fifos (sm))
109 segment_manager_free (sm);
113 clib_memset (app_wrk, 0xfe, sizeof (*app_wrk));
114 pool_put (app_workers, app_wrk);
118 app_worker_get_app (u32 wrk_index)
120 app_worker_t *app_wrk;
121 app_wrk = app_worker_get_if_valid (wrk_index);
124 return application_get_if_valid (app_wrk->app_index);
127 static segment_manager_t *
128 app_worker_alloc_segment_manager (app_worker_t * app_wrk)
130 segment_manager_t *sm = 0;
132 /* If the first segment manager is not in use, don't allocate a new one */
133 if (app_wrk->first_segment_manager != APP_INVALID_SEGMENT_MANAGER_INDEX
134 && app_wrk->first_segment_manager_in_use == 0)
136 sm = segment_manager_get (app_wrk->first_segment_manager);
137 app_wrk->first_segment_manager_in_use = 1;
141 sm = segment_manager_alloc ();
142 sm->app_wrk_index = app_wrk->wrk_index;
148 app_worker_alloc_session_fifos (segment_manager_t * sm, session_t * s)
150 svm_fifo_t *rx_fifo = 0, *tx_fifo = 0;
153 if ((rv = segment_manager_alloc_session_fifos (sm, s->thread_index,
154 &rx_fifo, &tx_fifo)))
157 rx_fifo->master_session_index = s->session_index;
158 rx_fifo->master_thread_index = s->thread_index;
160 tx_fifo->master_session_index = s->session_index;
161 tx_fifo->master_thread_index = s->thread_index;
163 s->rx_fifo = rx_fifo;
164 s->tx_fifo = tx_fifo;
169 app_worker_init_listener (app_worker_t * app_wrk, session_t * ls)
171 segment_manager_t *sm;
173 /* Allocate segment manager. All sessions derived out of a listen session
174 * have fifos allocated by the same segment manager. */
175 if (!(sm = app_worker_alloc_segment_manager (app_wrk)))
176 return SESSION_E_ALLOC;
178 /* Keep track of the segment manager for the listener or this worker */
179 hash_set (app_wrk->listeners_table, listen_session_get_handle (ls),
180 segment_manager_index (sm));
182 if (transport_connection_is_cless (session_get_transport (ls)))
185 return SESSION_E_NOSUPPORT;
186 return app_worker_alloc_session_fifos (sm, ls);
192 app_worker_start_listen (app_worker_t * app_wrk,
193 app_listener_t * app_listener)
198 if (clib_bitmap_get (app_listener->workers, app_wrk->wrk_map_index))
199 return SESSION_E_ALREADY_LISTENING;
201 app_listener->workers = clib_bitmap_set (app_listener->workers,
202 app_wrk->wrk_map_index, 1);
204 if (app_listener->session_index != SESSION_INVALID_INDEX)
206 ls = session_get (app_listener->session_index, 0);
207 if ((rv = app_worker_init_listener (app_wrk, ls)))
211 if (app_listener->local_index != SESSION_INVALID_INDEX)
213 ls = session_get (app_listener->local_index, 0);
214 if ((rv = app_worker_init_listener (app_wrk, ls)))
222 app_worker_stop_listen_session (app_worker_t * app_wrk, session_t * ls)
224 session_handle_t handle;
225 segment_manager_t *sm;
228 handle = listen_session_get_handle (ls);
229 sm_indexp = hash_get (app_wrk->listeners_table, handle);
230 if (PREDICT_FALSE (!sm_indexp))
233 /* Dealloc fifos first, if any, to avoid cleanup attempt lower */
236 segment_manager_dealloc_fifos (ls->rx_fifo, ls->tx_fifo);
237 ls->tx_fifo = ls->rx_fifo = 0;
240 sm = segment_manager_get (*sm_indexp);
241 if (app_wrk->first_segment_manager == *sm_indexp)
243 /* Delete sessions but don't remove segment manager */
244 app_wrk->first_segment_manager_in_use = 0;
245 segment_manager_del_sessions (sm);
249 segment_manager_init_free (sm);
251 hash_unset (app_wrk->listeners_table, handle);
255 app_worker_stop_listen (app_worker_t * app_wrk, app_listener_t * al)
259 if (!clib_bitmap_get (al->workers, app_wrk->wrk_map_index))
262 if (al->session_index != SESSION_INVALID_INDEX)
264 ls = listen_session_get (al->session_index);
265 app_worker_stop_listen_session (app_wrk, ls);
268 if (al->local_index != SESSION_INVALID_INDEX)
270 ls = listen_session_get (al->local_index);
271 app_worker_stop_listen_session (app_wrk, ls);
274 clib_bitmap_set_no_check (al->workers, app_wrk->wrk_map_index, 0);
275 if (clib_bitmap_is_zero (al->workers))
276 app_listener_cleanup (al);
282 app_worker_init_accepted (session_t * s)
284 app_worker_t *app_wrk;
285 segment_manager_t *sm;
289 listener = listen_session_get_from_handle (s->listener_handle);
290 app_wrk = application_listener_select_worker (listener);
291 s->app_wrk_index = app_wrk->wrk_index;
293 app = application_get (app_wrk->app_index);
294 if (app->cb_fns.fifo_tuning_callback)
295 s->flags |= SESSION_F_CUSTOM_FIFO_TUNING;
297 sm = app_worker_get_listen_segment_manager (app_wrk, listener);
298 if (app_worker_alloc_session_fifos (sm, s))
305 app_worker_accept_notify (app_worker_t * app_wrk, session_t * s)
307 application_t *app = application_get (app_wrk->app_index);
308 return app->cb_fns.session_accept_callback (s);
312 app_worker_init_connected (app_worker_t * app_wrk, session_t * s)
314 application_t *app = application_get (app_wrk->app_index);
315 segment_manager_t *sm;
317 /* Allocate fifos for session, unless the app is a builtin proxy */
318 if (!application_is_builtin_proxy (app))
320 sm = app_worker_get_connect_segment_manager (app_wrk);
321 return app_worker_alloc_session_fifos (sm, s);
324 if (app->cb_fns.fifo_tuning_callback)
325 s->flags |= SESSION_F_CUSTOM_FIFO_TUNING;
331 app_worker_connect_notify (app_worker_t * app_wrk, session_t * s,
332 session_error_t err, u32 opaque)
334 application_t *app = application_get (app_wrk->app_index);
335 return app->cb_fns.session_connected_callback (app_wrk->wrk_index, opaque,
340 app_worker_close_notify (app_worker_t * app_wrk, session_t * s)
342 application_t *app = application_get (app_wrk->app_index);
343 app->cb_fns.session_disconnect_callback (s);
348 app_worker_transport_closed_notify (app_worker_t * app_wrk, session_t * s)
350 application_t *app = application_get (app_wrk->app_index);
351 if (app->cb_fns.session_transport_closed_callback)
352 app->cb_fns.session_transport_closed_callback (s);
357 app_worker_reset_notify (app_worker_t * app_wrk, session_t * s)
359 application_t *app = application_get (app_wrk->app_index);
360 app->cb_fns.session_reset_callback (s);
365 app_worker_cleanup_notify (app_worker_t * app_wrk, session_t * s,
366 session_cleanup_ntf_t ntf)
368 application_t *app = application_get (app_wrk->app_index);
369 if (app->cb_fns.session_cleanup_callback)
370 app->cb_fns.session_cleanup_callback (s, ntf);
375 app_worker_builtin_rx (app_worker_t * app_wrk, session_t * s)
377 application_t *app = application_get (app_wrk->app_index);
378 app->cb_fns.builtin_app_rx_callback (s);
383 app_worker_builtin_tx (app_worker_t * app_wrk, session_t * s)
385 application_t *app = application_get (app_wrk->app_index);
387 if (!app->cb_fns.builtin_app_tx_callback)
390 app->cb_fns.builtin_app_tx_callback (s);
395 app_worker_migrate_notify (app_worker_t * app_wrk, session_t * s,
396 session_handle_t new_sh)
398 application_t *app = application_get (app_wrk->app_index);
399 app->cb_fns.session_migrate_callback (s, new_sh);
404 app_worker_own_session (app_worker_t * app_wrk, session_t * s)
406 segment_manager_t *sm;
407 svm_fifo_t *rxf, *txf;
409 if (s->session_state == SESSION_STATE_LISTENING)
410 return application_change_listener_owner (s, app_wrk);
412 s->app_wrk_index = app_wrk->wrk_index;
423 sm = app_worker_get_or_alloc_connect_segment_manager (app_wrk);
424 if (app_worker_alloc_session_fifos (sm, s))
427 if (!svm_fifo_is_empty_cons (rxf))
428 svm_fifo_clone (s->rx_fifo, rxf);
430 if (!svm_fifo_is_empty_cons (txf))
431 svm_fifo_clone (s->tx_fifo, txf);
433 segment_manager_dealloc_fifos (rxf, txf);
439 app_worker_connect_session (app_worker_t * app, session_endpoint_t * sep,
444 /* Make sure we have a segment manager for connects */
445 app_worker_alloc_connects_segment_manager (app);
447 if ((rv = session_open (app->wrk_index, sep, api_context)))
454 app_worker_session_fifo_tuning (app_worker_t * app_wrk, session_t * s,
456 session_ft_action_t act, u32 len)
458 application_t *app = application_get (app_wrk->app_index);
459 return app->cb_fns.fifo_tuning_callback (s, f, act, len);
463 app_worker_alloc_connects_segment_manager (app_worker_t * app_wrk)
465 segment_manager_t *sm;
467 if (app_wrk->connects_seg_manager == APP_INVALID_SEGMENT_MANAGER_INDEX)
469 sm = app_worker_alloc_segment_manager (app_wrk);
472 app_wrk->connects_seg_manager = segment_manager_index (sm);
478 app_worker_get_connect_segment_manager (app_worker_t * app)
480 ASSERT (app->connects_seg_manager != (u32) ~ 0);
481 return segment_manager_get (app->connects_seg_manager);
485 app_worker_get_or_alloc_connect_segment_manager (app_worker_t * app_wrk)
487 if (app_wrk->connects_seg_manager == (u32) ~ 0)
488 app_worker_alloc_connects_segment_manager (app_wrk);
489 return segment_manager_get (app_wrk->connects_seg_manager);
493 app_worker_get_listen_segment_manager (app_worker_t * app,
494 session_t * listener)
497 smp = hash_get (app->listeners_table, listen_session_get_handle (listener));
498 ALWAYS_ASSERT (smp != 0);
499 return segment_manager_get (*smp);
503 app_worker_first_listener (app_worker_t * app_wrk, u8 fib_proto,
511 sst = session_type_from_proto_and_ip (transport_proto,
512 fib_proto == FIB_PROTOCOL_IP4);
515 hash_foreach (handle, sm_index, app_wrk->listeners_table, ({
516 listener = listen_session_get_from_handle (handle);
517 if (listener->session_type == sst
518 && !(listener->flags & SESSION_F_PROXY))
527 app_worker_proxy_listener (app_worker_t * app_wrk, u8 fib_proto,
535 sst = session_type_from_proto_and_ip (transport_proto,
536 fib_proto == FIB_PROTOCOL_IP4);
539 hash_foreach (handle, sm_index, app_wrk->listeners_table, ({
540 listener = listen_session_get_from_handle (handle);
541 if (listener->session_type == sst && (listener->flags & SESSION_F_PROXY))
550 * Send an API message to the external app, to map new segment
553 app_worker_add_segment_notify (app_worker_t * app_wrk, u64 segment_handle)
555 application_t *app = application_get (app_wrk->app_index);
557 return app->cb_fns.add_segment_callback (app_wrk->wrk_index,
562 app_worker_del_segment_notify (app_worker_t * app_wrk, u64 segment_handle)
564 application_t *app = application_get (app_wrk->app_index);
565 return app->cb_fns.del_segment_callback (app_wrk->wrk_index,
570 app_worker_application_is_builtin (app_worker_t * app_wrk)
572 return app_wrk->app_is_builtin;
576 app_send_io_evt_rx (app_worker_t * app_wrk, session_t * s)
578 session_event_t *evt;
582 if (app_worker_application_is_builtin (app_wrk))
583 return app_worker_builtin_rx (app_wrk, s);
585 if (svm_fifo_has_event (s->rx_fifo))
588 mq = app_wrk->event_queue;
591 if (PREDICT_FALSE (svm_msg_q_is_full (mq)))
593 clib_warning ("evt q full");
594 svm_msg_q_unlock (mq);
598 if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
600 clib_warning ("evt q rings full");
601 svm_msg_q_unlock (mq);
605 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
606 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
607 evt->session_index = s->rx_fifo->client_session_index;
608 evt->event_type = SESSION_IO_EVT_RX;
610 (void) svm_fifo_set_event (s->rx_fifo);
611 svm_msg_q_add_and_unlock (mq, &msg);
617 app_send_io_evt_tx (app_worker_t * app_wrk, session_t * s)
620 session_event_t *evt;
623 if (app_worker_application_is_builtin (app_wrk))
624 return app_worker_builtin_tx (app_wrk, s);
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->event_type = SESSION_IO_EVT_TX;
646 evt->session_index = s->tx_fifo->client_session_index;
648 svm_msg_q_add_and_unlock (mq, &msg);
653 typedef int (app_send_evt_handler_fn) (app_worker_t *app,
655 static app_send_evt_handler_fn * const app_send_evt_handler_fns[2] = {
662 * Send event to application
664 * Logic from queue perspective is blocking. However, if queue is full,
668 app_worker_lock_and_send_event (app_worker_t * app, session_t * s,
671 return app_send_evt_handler_fns[evt_type] (app, s);
675 format_app_worker_listener (u8 * s, va_list * args)
677 app_worker_t *app_wrk = va_arg (*args, app_worker_t *);
678 u64 handle = va_arg (*args, u64);
679 u32 sm_index = va_arg (*args, u32);
680 int verbose = va_arg (*args, int);
688 s = format (s, "%-40s%-25s%=10s%-15s%-15s%-10s", "Connection", "App",
689 "Wrk", "API Client", "ListenerID", "SegManager");
691 s = format (s, "%-40s%-25s%=10s", "Connection", "App", "Wrk");
696 app_name = application_name_from_index (app_wrk->app_index);
697 listener = listen_session_get_from_handle (handle);
698 str = format (0, "%U", format_session, listener, verbose);
703 buf = format (0, "%u(%u)", app_wrk->wrk_map_index, app_wrk->wrk_index);
704 s = format (s, "%-40s%-25s%=10v%-15u%-15u%-10u", str, app_name,
705 buf, app_wrk->api_client_index, handle, sm_index);
709 s = format (s, "%-40s%-25s%=10u", str, app_name, app_wrk->wrk_map_index);
715 format_app_worker (u8 * s, va_list * args)
717 app_worker_t *app_wrk = va_arg (*args, app_worker_t *);
720 s = format (s, "%U wrk-index %u app-index %u map-index %u "
721 "api-client-index %d\n", format_white_space, indent,
722 app_wrk->wrk_index, app_wrk->app_index, app_wrk->wrk_map_index,
723 app_wrk->api_client_index);
728 app_worker_format_connects (app_worker_t * app_wrk, int verbose)
730 segment_manager_t *sm;
735 segment_manager_format_sessions (0, verbose);
739 if (app_wrk->connects_seg_manager == (u32) ~ 0)
742 sm = segment_manager_get (app_wrk->connects_seg_manager);
743 segment_manager_format_sessions (sm, verbose);
747 * fd.io coding-style-patch-verification: ON
750 * eval: (c-set-style "gnu")