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)))
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 (session_transport_service_type (ls) == TRANSPORT_SERVICE_CL)
184 if (!ls->rx_fifo && app_worker_alloc_session_fifos (sm, ls))
191 app_worker_start_listen (app_worker_t * app_wrk,
192 app_listener_t * app_listener)
196 if (clib_bitmap_get (app_listener->workers, app_wrk->wrk_map_index))
197 return VNET_API_ERROR_ADDRESS_IN_USE;
199 app_listener->workers = clib_bitmap_set (app_listener->workers,
200 app_wrk->wrk_map_index, 1);
202 if (app_listener->session_index != SESSION_INVALID_INDEX)
204 ls = session_get (app_listener->session_index, 0);
205 if (app_worker_init_listener (app_wrk, ls))
209 if (app_listener->local_index != SESSION_INVALID_INDEX)
211 ls = session_get (app_listener->local_index, 0);
212 if (app_worker_init_listener (app_wrk, ls))
220 app_worker_stop_listen_session (app_worker_t * app_wrk, session_t * ls)
222 session_handle_t handle;
223 segment_manager_t *sm;
226 handle = listen_session_get_handle (ls);
227 sm_indexp = hash_get (app_wrk->listeners_table, handle);
228 if (PREDICT_FALSE (!sm_indexp))
231 sm = segment_manager_get (*sm_indexp);
232 if (app_wrk->first_segment_manager == *sm_indexp)
234 /* Delete sessions but don't remove segment manager */
235 app_wrk->first_segment_manager_in_use = 0;
236 segment_manager_del_sessions (sm);
240 segment_manager_init_free (sm);
242 hash_unset (app_wrk->listeners_table, handle);
246 app_worker_stop_listen (app_worker_t * app_wrk, app_listener_t * al)
250 if (!clib_bitmap_get (al->workers, app_wrk->wrk_map_index))
253 if (al->session_index != SESSION_INVALID_INDEX)
255 ls = listen_session_get (al->session_index);
256 app_worker_stop_listen_session (app_wrk, ls);
259 if (al->local_index != SESSION_INVALID_INDEX)
261 ls = listen_session_get (al->local_index);
262 app_worker_stop_listen_session (app_wrk, ls);
265 clib_bitmap_set_no_check (al->workers, app_wrk->wrk_map_index, 0);
266 if (clib_bitmap_is_zero (al->workers))
267 app_listener_cleanup (al);
273 app_worker_init_accepted (session_t * s)
275 app_worker_t *app_wrk;
276 segment_manager_t *sm;
279 listener = listen_session_get_from_handle (s->listener_handle);
280 app_wrk = application_listener_select_worker (listener);
281 s->app_wrk_index = app_wrk->wrk_index;
283 sm = app_worker_get_listen_segment_manager (app_wrk, listener);
284 if (app_worker_alloc_session_fifos (sm, s))
291 app_worker_accept_notify (app_worker_t * app_wrk, session_t * s)
293 application_t *app = application_get (app_wrk->app_index);
294 return app->cb_fns.session_accept_callback (s);
298 app_worker_init_connected (app_worker_t * app_wrk, session_t * s)
300 application_t *app = application_get (app_wrk->app_index);
301 segment_manager_t *sm;
303 /* Allocate fifos for session, unless the app is a builtin proxy */
304 if (!application_is_builtin_proxy (app))
306 sm = app_worker_get_connect_segment_manager (app_wrk);
307 if (app_worker_alloc_session_fifos (sm, s))
314 app_worker_connect_notify (app_worker_t * app_wrk, session_t * s, u32 opaque)
316 application_t *app = application_get (app_wrk->app_index);
317 return app->cb_fns.session_connected_callback (app_wrk->wrk_index, opaque,
318 s, s == 0 /* is_fail */ );
322 app_worker_close_notify (app_worker_t * app_wrk, session_t * s)
324 application_t *app = application_get (app_wrk->app_index);
325 app->cb_fns.session_disconnect_callback (s);
330 app_worker_transport_closed_notify (app_worker_t * app_wrk, session_t * s)
332 application_t *app = application_get (app_wrk->app_index);
333 if (app->cb_fns.session_transport_closed_callback)
334 app->cb_fns.session_transport_closed_callback (s);
339 app_worker_reset_notify (app_worker_t * app_wrk, session_t * s)
341 application_t *app = application_get (app_wrk->app_index);
342 app->cb_fns.session_reset_callback (s);
347 app_worker_cleanup_notify (app_worker_t * app_wrk, session_t * s,
348 session_cleanup_ntf_t ntf)
350 application_t *app = application_get (app_wrk->app_index);
351 if (app->cb_fns.session_cleanup_callback)
352 app->cb_fns.session_cleanup_callback (s, ntf);
357 app_worker_builtin_rx (app_worker_t * app_wrk, session_t * s)
359 application_t *app = application_get (app_wrk->app_index);
360 app->cb_fns.builtin_app_rx_callback (s);
365 app_worker_builtin_tx (app_worker_t * app_wrk, session_t * s)
367 application_t *app = application_get (app_wrk->app_index);
369 if (!app->cb_fns.builtin_app_tx_callback)
372 app->cb_fns.builtin_app_tx_callback (s);
377 app_worker_migrate_notify (app_worker_t * app_wrk, session_t * s,
378 session_handle_t new_sh)
380 application_t *app = application_get (app_wrk->app_index);
381 app->cb_fns.session_migrate_callback (s, new_sh);
386 app_worker_own_session (app_worker_t * app_wrk, session_t * s)
388 segment_manager_t *sm;
389 svm_fifo_t *rxf, *txf;
391 if (s->session_state == SESSION_STATE_LISTENING)
392 return application_change_listener_owner (s, app_wrk);
394 s->app_wrk_index = app_wrk->wrk_index;
405 sm = app_worker_get_or_alloc_connect_segment_manager (app_wrk);
406 if (app_worker_alloc_session_fifos (sm, s))
409 if (!svm_fifo_is_empty_cons (rxf))
410 svm_fifo_clone (s->rx_fifo, rxf);
412 if (!svm_fifo_is_empty_cons (txf))
413 svm_fifo_clone (s->tx_fifo, txf);
415 segment_manager_dealloc_fifos (rxf, txf);
421 app_worker_connect_session (app_worker_t * app, session_endpoint_t * sep,
426 /* Make sure we have a segment manager for connects */
427 app_worker_alloc_connects_segment_manager (app);
429 if ((rv = session_open (app->wrk_index, sep, api_context)))
436 app_worker_alloc_connects_segment_manager (app_worker_t * app_wrk)
438 segment_manager_t *sm;
440 if (app_wrk->connects_seg_manager == APP_INVALID_SEGMENT_MANAGER_INDEX)
442 sm = app_worker_alloc_segment_manager (app_wrk);
445 app_wrk->connects_seg_manager = segment_manager_index (sm);
451 app_worker_get_connect_segment_manager (app_worker_t * app)
453 ASSERT (app->connects_seg_manager != (u32) ~ 0);
454 return segment_manager_get (app->connects_seg_manager);
458 app_worker_get_or_alloc_connect_segment_manager (app_worker_t * app_wrk)
460 if (app_wrk->connects_seg_manager == (u32) ~ 0)
461 app_worker_alloc_connects_segment_manager (app_wrk);
462 return segment_manager_get (app_wrk->connects_seg_manager);
466 app_worker_get_listen_segment_manager (app_worker_t * app,
467 session_t * listener)
470 smp = hash_get (app->listeners_table, listen_session_get_handle (listener));
472 return segment_manager_get (*smp);
476 app_worker_first_listener (app_worker_t * app_wrk, u8 fib_proto,
484 sst = session_type_from_proto_and_ip (transport_proto,
485 fib_proto == FIB_PROTOCOL_IP4);
488 hash_foreach (handle, sm_index, app_wrk->listeners_table, ({
489 listener = listen_session_get_from_handle (handle);
490 if (listener->session_type == sst
491 && !(listener->flags & SESSION_F_PROXY))
500 app_worker_proxy_listener (app_worker_t * app_wrk, u8 fib_proto,
508 sst = session_type_from_proto_and_ip (transport_proto,
509 fib_proto == FIB_PROTOCOL_IP4);
512 hash_foreach (handle, sm_index, app_wrk->listeners_table, ({
513 listener = listen_session_get_from_handle (handle);
514 if (listener->session_type == sst && (listener->flags & SESSION_F_PROXY))
523 * Send an API message to the external app, to map new segment
526 app_worker_add_segment_notify (app_worker_t * app_wrk, u64 segment_handle)
528 application_t *app = application_get (app_wrk->app_index);
530 return app->cb_fns.add_segment_callback (app_wrk->wrk_index,
535 app_worker_del_segment_notify (app_worker_t * app_wrk, u64 segment_handle)
537 application_t *app = application_get (app_wrk->app_index);
538 return app->cb_fns.del_segment_callback (app_wrk->wrk_index,
543 app_worker_application_is_builtin (app_worker_t * app_wrk)
545 return app_wrk->app_is_builtin;
549 app_send_io_evt_rx (app_worker_t * app_wrk, session_t * s)
551 session_event_t *evt;
555 if (app_worker_application_is_builtin (app_wrk))
556 return app_worker_builtin_rx (app_wrk, s);
558 /* Make sure the session is in established state within external apps.
559 * Should be removed once we confirm closes to apps */
560 if (PREDICT_FALSE (s->session_state != SESSION_STATE_READY
561 && s->session_state != SESSION_STATE_LISTENING))
564 if (svm_fifo_has_event (s->rx_fifo))
567 mq = app_wrk->event_queue;
570 if (PREDICT_FALSE (svm_msg_q_is_full (mq)))
572 clib_warning ("evt q full");
573 svm_msg_q_unlock (mq);
577 if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
579 clib_warning ("evt q rings full");
580 svm_msg_q_unlock (mq);
584 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
585 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
586 evt->session_index = s->rx_fifo->client_session_index;
587 evt->event_type = SESSION_IO_EVT_RX;
589 (void) svm_fifo_set_event (s->rx_fifo);
590 svm_msg_q_add_and_unlock (mq, &msg);
596 app_send_io_evt_tx (app_worker_t * app_wrk, session_t * s)
599 session_event_t *evt;
602 if (app_worker_application_is_builtin (app_wrk))
603 return app_worker_builtin_tx (app_wrk, s);
605 mq = app_wrk->event_queue;
608 if (PREDICT_FALSE (svm_msg_q_is_full (mq)))
610 clib_warning ("evt q full");
611 svm_msg_q_unlock (mq);
615 if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
617 clib_warning ("evt q rings full");
618 svm_msg_q_unlock (mq);
622 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
623 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
624 evt->event_type = SESSION_IO_EVT_TX;
625 evt->session_index = s->tx_fifo->client_session_index;
627 svm_msg_q_add_and_unlock (mq, &msg);
632 typedef int (app_send_evt_handler_fn) (app_worker_t *app,
634 static app_send_evt_handler_fn * const app_send_evt_handler_fns[2] = {
641 * Send event to application
643 * Logic from queue perspective is blocking. However, if queue is full,
647 app_worker_lock_and_send_event (app_worker_t * app, session_t * s,
650 return app_send_evt_handler_fns[evt_type] (app, s);
654 format_app_worker_listener (u8 * s, va_list * args)
656 app_worker_t *app_wrk = va_arg (*args, app_worker_t *);
657 u64 handle = va_arg (*args, u64);
658 u32 sm_index = va_arg (*args, u32);
659 int verbose = va_arg (*args, int);
667 s = format (s, "%-40s%-25s%=10s%-15s%-15s%-10s", "Connection", "App",
668 "Wrk", "API Client", "ListenerID", "SegManager");
670 s = format (s, "%-40s%-25s%=10s", "Connection", "App", "Wrk");
675 app_name = application_name_from_index (app_wrk->app_index);
676 listener = listen_session_get_from_handle (handle);
677 str = format (0, "%U", format_session, listener, verbose);
682 sprintf (buf, "%u(%u)", app_wrk->wrk_map_index, app_wrk->wrk_index);
683 s = format (s, "%-40s%-25s%=10s%-15u%-15u%-10u", str, app_name,
684 buf, app_wrk->api_client_index, handle, sm_index);
687 s = format (s, "%-40s%-25s%=10u", str, app_name, app_wrk->wrk_map_index);
693 format_app_worker (u8 * s, va_list * args)
695 app_worker_t *app_wrk = va_arg (*args, app_worker_t *);
698 s = format (s, "%U wrk-index %u app-index %u map-index %u "
699 "api-client-index %d\n", format_white_space, indent,
700 app_wrk->wrk_index, app_wrk->app_index, app_wrk->wrk_map_index,
701 app_wrk->api_client_index);
706 app_worker_format_connects (app_worker_t * app_wrk, int verbose)
708 segment_manager_t *sm;
713 segment_manager_format_sessions (0, verbose);
717 if (app_wrk->connects_seg_manager == (u32) ~ 0)
720 sm = segment_manager_get (app_wrk->connects_seg_manager);
721 segment_manager_format_sessions (sm, verbose);
725 * fd.io coding-style-patch-verification: ON
728 * eval: (c-set-style "gnu")