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, *sm_indices = 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 vec_add1 (sm_indices, sm_index);
74 sm = segment_manager_get (sm_index);
78 for (i = 0; i < vec_len (handles); i++)
80 /* Cleanup listener */
81 a->app_index = app->app_index;
82 a->wrk_map_index = app_wrk->wrk_map_index;
83 a->handle = handles[i];
84 (void) vnet_unlisten (a);
86 sm = segment_manager_get_if_valid (sm_indices[i]);
87 if (sm && !segment_manager_app_detached (sm))
89 sm->first_is_protected = 0;
90 segment_manager_init_free (sm);
93 vec_reset_length (handles);
94 vec_free (sm_indices);
95 hash_free (app_wrk->listeners_table);
98 * Connects segment manager cleanup
101 if (app_wrk->connects_seg_manager != APP_INVALID_SEGMENT_MANAGER_INDEX)
103 sm = segment_manager_get (app_wrk->connects_seg_manager);
104 sm->app_wrk_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
105 sm->first_is_protected = 0;
106 segment_manager_init_free (sm);
113 for (i = 0; i < vec_len (app_wrk->half_open_table); i++)
115 if (!app_wrk->half_open_table[i])
119 hash_foreach (handle, sm_index, app_wrk->half_open_table[i], ({
120 vec_add1 (handles, handle);
124 for (j = 0; j < vec_len (handles); j++)
125 session_cleanup_half_open (i, handles[j]);
127 hash_free (app_wrk->half_open_table[i]);
128 vec_reset_length (handles);
131 vec_free (app_wrk->half_open_table);
134 /* If first segment manager is used by a listener that recently
135 * stopped listening, mark it as detached */
136 if (app_wrk->first_segment_manager != app_wrk->connects_seg_manager
137 && (sm = segment_manager_get_if_valid (app_wrk->first_segment_manager)))
139 sm->first_is_protected = 0;
140 sm->app_wrk_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
141 /* .. and has no fifos, e.g. it might be used for redirected sessions,
143 if (!segment_manager_has_fifos (sm))
144 segment_manager_free (sm);
148 clib_memset (app_wrk, 0xfe, sizeof (*app_wrk));
149 pool_put (app_workers, app_wrk);
153 app_worker_get_app (u32 wrk_index)
155 app_worker_t *app_wrk;
156 app_wrk = app_worker_get_if_valid (wrk_index);
159 return application_get_if_valid (app_wrk->app_index);
162 static segment_manager_t *
163 app_worker_alloc_segment_manager (app_worker_t * app_wrk)
165 segment_manager_t *sm = 0;
167 /* If the first segment manager is not in use, don't allocate a new one */
168 if (app_wrk->first_segment_manager != APP_INVALID_SEGMENT_MANAGER_INDEX
169 && app_wrk->first_segment_manager_in_use == 0)
171 sm = segment_manager_get (app_wrk->first_segment_manager);
172 app_wrk->first_segment_manager_in_use = 1;
176 sm = segment_manager_alloc ();
177 sm->app_wrk_index = app_wrk->wrk_index;
183 app_worker_alloc_session_fifos (segment_manager_t * sm, session_t * s)
185 svm_fifo_t *rx_fifo = 0, *tx_fifo = 0;
188 if ((rv = segment_manager_alloc_session_fifos (sm, s->thread_index,
189 &rx_fifo, &tx_fifo)))
192 rx_fifo->master_session_index = s->session_index;
193 rx_fifo->master_thread_index = s->thread_index;
195 tx_fifo->master_session_index = s->session_index;
196 tx_fifo->master_thread_index = s->thread_index;
198 s->rx_fifo = rx_fifo;
199 s->tx_fifo = tx_fifo;
204 app_worker_init_listener (app_worker_t * app_wrk, session_t * ls)
206 segment_manager_t *sm;
208 /* Allocate segment manager. All sessions derived out of a listen session
209 * have fifos allocated by the same segment manager. */
210 if (!(sm = app_worker_alloc_segment_manager (app_wrk)))
211 return SESSION_E_ALLOC;
213 /* Keep track of the segment manager for the listener or this worker */
214 hash_set (app_wrk->listeners_table, listen_session_get_handle (ls),
215 segment_manager_index (sm));
217 if (transport_connection_is_cless (session_get_transport (ls)))
220 return SESSION_E_NOSUPPORT;
221 return app_worker_alloc_session_fifos (sm, ls);
227 app_worker_start_listen (app_worker_t * app_wrk,
228 app_listener_t * app_listener)
233 if (clib_bitmap_get (app_listener->workers, app_wrk->wrk_map_index))
234 return SESSION_E_ALREADY_LISTENING;
236 app_listener->workers = clib_bitmap_set (app_listener->workers,
237 app_wrk->wrk_map_index, 1);
239 if (app_listener->session_index != SESSION_INVALID_INDEX)
241 ls = session_get (app_listener->session_index, 0);
242 if ((rv = app_worker_init_listener (app_wrk, ls)))
246 if (app_listener->local_index != SESSION_INVALID_INDEX)
248 ls = session_get (app_listener->local_index, 0);
249 if ((rv = app_worker_init_listener (app_wrk, ls)))
257 app_worker_stop_listen_session (app_worker_t * app_wrk, session_t * ls)
259 session_handle_t handle;
260 segment_manager_t *sm;
263 handle = listen_session_get_handle (ls);
264 sm_indexp = hash_get (app_wrk->listeners_table, handle);
265 if (PREDICT_FALSE (!sm_indexp))
268 /* Dealloc fifos, if any (dgram listeners) */
271 segment_manager_dealloc_fifos (ls->rx_fifo, ls->tx_fifo);
272 ls->tx_fifo = ls->rx_fifo = 0;
275 /* Try to cleanup segment manager */
276 sm = segment_manager_get (*sm_indexp);
277 if (sm && app_wrk->first_segment_manager != *sm_indexp)
279 segment_manager_app_detach (sm);
280 if (!segment_manager_has_fifos (sm))
281 segment_manager_free (sm);
284 hash_unset (app_wrk->listeners_table, handle);
288 app_worker_stop_listen (app_worker_t * app_wrk, app_listener_t * al)
292 if (!clib_bitmap_get (al->workers, app_wrk->wrk_map_index))
295 if (al->session_index != SESSION_INVALID_INDEX)
297 ls = listen_session_get (al->session_index);
298 app_worker_stop_listen_session (app_wrk, ls);
301 if (al->local_index != SESSION_INVALID_INDEX)
303 ls = listen_session_get (al->local_index);
304 app_worker_stop_listen_session (app_wrk, ls);
307 clib_bitmap_set_no_check (al->workers, app_wrk->wrk_map_index, 0);
308 if (clib_bitmap_is_zero (al->workers))
309 app_listener_cleanup (al);
315 app_worker_init_accepted (session_t * s)
317 app_worker_t *app_wrk;
318 segment_manager_t *sm;
322 listener = listen_session_get_from_handle (s->listener_handle);
323 app_wrk = application_listener_select_worker (listener);
324 s->app_wrk_index = app_wrk->wrk_index;
326 app = application_get (app_wrk->app_index);
327 if (app->cb_fns.fifo_tuning_callback)
328 s->flags |= SESSION_F_CUSTOM_FIFO_TUNING;
330 sm = app_worker_get_listen_segment_manager (app_wrk, listener);
331 if (app_worker_alloc_session_fifos (sm, s))
338 app_worker_accept_notify (app_worker_t * app_wrk, session_t * s)
340 application_t *app = application_get (app_wrk->app_index);
341 return app->cb_fns.session_accept_callback (s);
345 app_worker_init_connected (app_worker_t * app_wrk, session_t * s)
347 application_t *app = application_get (app_wrk->app_index);
348 segment_manager_t *sm;
350 /* Allocate fifos for session, unless the app is a builtin proxy */
351 if (!application_is_builtin_proxy (app))
353 sm = app_worker_get_connect_segment_manager (app_wrk);
354 return app_worker_alloc_session_fifos (sm, s);
357 if (app->cb_fns.fifo_tuning_callback)
358 s->flags |= SESSION_F_CUSTOM_FIFO_TUNING;
364 app_worker_connect_notify (app_worker_t * app_wrk, session_t * s,
365 session_error_t err, u32 opaque)
367 application_t *app = application_get (app_wrk->app_index);
368 return app->cb_fns.session_connected_callback (app_wrk->wrk_index, opaque,
373 app_worker_add_half_open (app_worker_t * app_wrk, transport_proto_t tp,
374 session_handle_t ho_handle,
375 session_handle_t wrk_handle)
377 ASSERT (vlib_get_thread_index () == 0);
378 vec_validate (app_wrk->half_open_table, tp);
379 hash_set (app_wrk->half_open_table[tp], ho_handle, wrk_handle);
384 app_worker_del_half_open (app_worker_t * app_wrk, transport_proto_t tp,
385 session_handle_t ho_handle)
387 ASSERT (vlib_get_thread_index () == 0);
388 hash_unset (app_wrk->half_open_table[tp], ho_handle);
393 app_worker_lookup_half_open (app_worker_t * app_wrk, transport_proto_t tp,
394 session_handle_t ho_handle)
398 /* No locking because all updates are done from main thread */
399 ho_wrk_handlep = hash_get (app_wrk->half_open_table[tp], ho_handle);
401 return SESSION_INVALID_HANDLE;
403 return *ho_wrk_handlep;
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_or_alloc_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, session_endpoint_t * sep,
511 /* Make sure we have a segment manager for connects */
512 app_worker_alloc_connects_segment_manager (app);
514 if ((rv = session_open (app->wrk_index, sep, api_context)))
521 app_worker_session_fifo_tuning (app_worker_t * app_wrk, session_t * s,
523 session_ft_action_t act, u32 len)
525 application_t *app = application_get (app_wrk->app_index);
526 return app->cb_fns.fifo_tuning_callback (s, f, act, len);
530 app_worker_alloc_connects_segment_manager (app_worker_t * app_wrk)
532 segment_manager_t *sm;
534 if (app_wrk->connects_seg_manager == APP_INVALID_SEGMENT_MANAGER_INDEX)
536 sm = app_worker_alloc_segment_manager (app_wrk);
539 app_wrk->connects_seg_manager = segment_manager_index (sm);
545 app_worker_get_connect_segment_manager (app_worker_t * app)
547 ASSERT (app->connects_seg_manager != (u32) ~ 0);
548 return segment_manager_get (app->connects_seg_manager);
552 app_worker_get_or_alloc_connect_segment_manager (app_worker_t * app_wrk)
554 if (app_wrk->connects_seg_manager == (u32) ~ 0)
555 app_worker_alloc_connects_segment_manager (app_wrk);
556 return segment_manager_get (app_wrk->connects_seg_manager);
560 app_worker_get_listen_segment_manager (app_worker_t * app,
561 session_t * listener)
564 smp = hash_get (app->listeners_table, listen_session_get_handle (listener));
565 ALWAYS_ASSERT (smp != 0);
566 return segment_manager_get (*smp);
570 app_worker_first_listener (app_worker_t * app_wrk, u8 fib_proto,
578 sst = session_type_from_proto_and_ip (transport_proto,
579 fib_proto == FIB_PROTOCOL_IP4);
582 hash_foreach (handle, sm_index, app_wrk->listeners_table, ({
583 listener = listen_session_get_from_handle (handle);
584 if (listener->session_type == sst
585 && !(listener->flags & SESSION_F_PROXY))
594 app_worker_proxy_listener (app_worker_t * app_wrk, u8 fib_proto,
602 sst = session_type_from_proto_and_ip (transport_proto,
603 fib_proto == FIB_PROTOCOL_IP4);
606 hash_foreach (handle, sm_index, app_wrk->listeners_table, ({
607 listener = listen_session_get_from_handle (handle);
608 if (listener->session_type == sst && (listener->flags & SESSION_F_PROXY))
617 * Send an API message to the external app, to map new segment
620 app_worker_add_segment_notify (app_worker_t * app_wrk, u64 segment_handle)
622 application_t *app = application_get (app_wrk->app_index);
624 return app->cb_fns.add_segment_callback (app_wrk->wrk_index,
629 app_worker_del_segment_notify (app_worker_t * app_wrk, u64 segment_handle)
631 application_t *app = application_get (app_wrk->app_index);
632 return app->cb_fns.del_segment_callback (app_wrk->wrk_index,
637 app_worker_application_is_builtin (app_worker_t * app_wrk)
639 return app_wrk->app_is_builtin;
643 app_send_io_evt_rx (app_worker_t * app_wrk, session_t * s)
645 session_event_t *evt;
649 if (app_worker_application_is_builtin (app_wrk))
650 return app_worker_builtin_rx (app_wrk, s);
652 if (svm_fifo_has_event (s->rx_fifo))
655 mq = app_wrk->event_queue;
658 if (PREDICT_FALSE (svm_msg_q_is_full (mq)))
660 clib_warning ("evt q full");
661 svm_msg_q_unlock (mq);
665 if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
667 clib_warning ("evt q rings full");
668 svm_msg_q_unlock (mq);
672 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
673 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
674 evt->session_index = s->rx_fifo->client_session_index;
675 evt->event_type = SESSION_IO_EVT_RX;
677 (void) svm_fifo_set_event (s->rx_fifo);
678 svm_msg_q_add_and_unlock (mq, &msg);
684 app_send_io_evt_tx (app_worker_t * app_wrk, session_t * s)
687 session_event_t *evt;
690 if (app_worker_application_is_builtin (app_wrk))
691 return app_worker_builtin_tx (app_wrk, s);
693 mq = app_wrk->event_queue;
696 if (PREDICT_FALSE (svm_msg_q_is_full (mq)))
698 clib_warning ("evt q full");
699 svm_msg_q_unlock (mq);
703 if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
705 clib_warning ("evt q rings full");
706 svm_msg_q_unlock (mq);
710 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
711 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
712 evt->event_type = SESSION_IO_EVT_TX;
713 evt->session_index = s->tx_fifo->client_session_index;
715 svm_msg_q_add_and_unlock (mq, &msg);
720 typedef int (app_send_evt_handler_fn) (app_worker_t *app,
722 static app_send_evt_handler_fn * const app_send_evt_handler_fns[2] = {
729 * Send event to application
731 * Logic from queue perspective is blocking. However, if queue is full,
735 app_worker_lock_and_send_event (app_worker_t * app, session_t * s,
738 return app_send_evt_handler_fns[evt_type] (app, s);
742 format_app_worker_listener (u8 * s, va_list * args)
744 app_worker_t *app_wrk = va_arg (*args, app_worker_t *);
745 u64 handle = va_arg (*args, u64);
746 u32 sm_index = va_arg (*args, u32);
747 int verbose = va_arg (*args, int);
755 s = format (s, "%-40s%-25s%=10s%-15s%-15s%-10s", "Connection", "App",
756 "Wrk", "API Client", "ListenerID", "SegManager");
758 s = format (s, "%-40s%-25s%=10s", "Connection", "App", "Wrk");
763 app_name = application_name_from_index (app_wrk->app_index);
764 listener = listen_session_get_from_handle (handle);
765 str = format (0, "%U", format_session, listener, verbose);
770 buf = format (0, "%u(%u)", app_wrk->wrk_map_index, app_wrk->wrk_index);
771 s = format (s, "%-40s%-25s%=10v%-15u%-15u%-10u", str, app_name,
772 buf, app_wrk->api_client_index, handle, sm_index);
776 s = format (s, "%-40s%-25s%=10u", str, app_name, app_wrk->wrk_map_index);
782 format_app_worker (u8 * s, va_list * args)
784 app_worker_t *app_wrk = va_arg (*args, app_worker_t *);
787 s = format (s, "%U wrk-index %u app-index %u map-index %u "
788 "api-client-index %d\n", format_white_space, indent,
789 app_wrk->wrk_index, app_wrk->app_index, app_wrk->wrk_map_index,
790 app_wrk->api_client_index);
795 app_worker_format_connects (app_worker_t * app_wrk, int verbose)
797 segment_manager_t *sm;
802 segment_manager_format_sessions (0, verbose);
806 if (app_wrk->connects_seg_manager == (u32) ~ 0)
809 sm = segment_manager_get (app_wrk->connects_seg_manager);
810 segment_manager_format_sessions (sm, verbose);
814 * fd.io coding-style-patch-verification: ON
817 * eval: (c-set-style "gnu")