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;
71 hash_foreach (handle, sm_index, app_wrk->listeners_table, ({
72 ls = listen_session_get_from_handle (handle);
73 al = app_listener_get (app, ls->al_index);
74 vec_add1 (handles, app_listener_handle (al));
75 sm = segment_manager_get (sm_index);
76 sm->app_wrk_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
80 for (i = 0; i < vec_len (handles); i++)
82 a->app_index = app->app_index;
83 a->wrk_map_index = app_wrk->wrk_map_index;
84 a->handle = handles[i];
85 /* seg manager is removed when unbind completes */
86 (void) vnet_unlisten (a);
90 * Connects segment manager cleanup
93 if (app_wrk->connects_seg_manager != APP_INVALID_SEGMENT_MANAGER_INDEX)
95 sm = segment_manager_get (app_wrk->connects_seg_manager);
96 sm->app_wrk_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
97 sm->first_is_protected = 0;
98 segment_manager_init_free (sm);
101 /* If first segment manager is used by a listener */
102 if (app_wrk->first_segment_manager != APP_INVALID_SEGMENT_MANAGER_INDEX
103 && app_wrk->first_segment_manager != app_wrk->connects_seg_manager)
105 sm = segment_manager_get (app_wrk->first_segment_manager);
106 sm->first_is_protected = 0;
107 sm->app_wrk_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
108 /* .. and has no fifos, e.g. it might be used for redirected sessions,
110 if (!segment_manager_has_fifos (sm))
111 segment_manager_free (sm);
114 pool_put (app_workers, app_wrk);
116 clib_memset (app_wrk, 0xfe, sizeof (*app_wrk));
120 app_worker_get_app (u32 wrk_index)
122 app_worker_t *app_wrk;
123 app_wrk = app_worker_get_if_valid (wrk_index);
126 return application_get_if_valid (app_wrk->app_index);
129 static segment_manager_t *
130 app_worker_alloc_segment_manager (app_worker_t * app_wrk)
132 segment_manager_t *sm = 0;
134 /* If the first segment manager is not in use, don't allocate a new one */
135 if (app_wrk->first_segment_manager != APP_INVALID_SEGMENT_MANAGER_INDEX
136 && app_wrk->first_segment_manager_in_use == 0)
138 sm = segment_manager_get (app_wrk->first_segment_manager);
139 app_wrk->first_segment_manager_in_use = 1;
143 sm = segment_manager_alloc ();
144 sm->app_wrk_index = app_wrk->wrk_index;
150 app_worker_alloc_session_fifos (segment_manager_t * sm, session_t * s)
152 svm_fifo_t *rx_fifo = 0, *tx_fifo = 0;
155 if ((rv = segment_manager_alloc_session_fifos (sm, &rx_fifo, &tx_fifo)))
158 rx_fifo->master_session_index = s->session_index;
159 rx_fifo->master_thread_index = s->thread_index;
161 tx_fifo->master_session_index = s->session_index;
162 tx_fifo->master_thread_index = s->thread_index;
164 s->rx_fifo = rx_fifo;
165 s->tx_fifo = tx_fifo;
170 app_worker_init_listener (app_worker_t * app_wrk, session_t * ls)
172 segment_manager_t *sm;
174 /* Allocate segment manager. All sessions derived out of a listen session
175 * have fifos allocated by the same segment manager. */
176 if (!(sm = app_worker_alloc_segment_manager (app_wrk)))
179 /* Keep track of the segment manager for the listener or this worker */
180 hash_set (app_wrk->listeners_table, listen_session_get_handle (ls),
181 segment_manager_index (sm));
183 if (session_transport_service_type (ls) == TRANSPORT_SERVICE_CL)
185 if (!ls->rx_fifo && app_worker_alloc_session_fifos (sm, ls))
192 app_worker_start_listen (app_worker_t * app_wrk,
193 app_listener_t * app_listener)
197 if (clib_bitmap_get (app_listener->workers, app_wrk->wrk_map_index))
198 return VNET_API_ERROR_ADDRESS_IN_USE;
200 app_listener->workers = clib_bitmap_set (app_listener->workers,
201 app_wrk->wrk_map_index, 1);
203 if (app_listener->session_index != SESSION_INVALID_INDEX)
205 ls = session_get (app_listener->session_index, 0);
206 if (app_worker_init_listener (app_wrk, ls))
210 if (app_listener->local_index != SESSION_INVALID_INDEX)
212 ls = session_get (app_listener->local_index, 0);
213 if (app_worker_init_listener (app_wrk, ls))
221 app_worker_stop_listen_session (app_worker_t * app_wrk, session_t * ls)
223 session_handle_t handle;
224 segment_manager_t *sm;
227 handle = listen_session_get_handle (ls);
228 sm_indexp = hash_get (app_wrk->listeners_table, handle);
229 if (PREDICT_FALSE (!sm_indexp))
232 sm = segment_manager_get (*sm_indexp);
233 if (app_wrk->first_segment_manager == *sm_indexp)
235 /* Delete sessions but don't remove segment manager */
236 app_wrk->first_segment_manager_in_use = 0;
237 segment_manager_del_sessions (sm);
241 segment_manager_init_free (sm);
243 hash_unset (app_wrk->listeners_table, handle);
247 app_worker_stop_listen (app_worker_t * app_wrk, app_listener_t * al)
251 if (!clib_bitmap_get (al->workers, app_wrk->wrk_map_index))
254 if (al->session_index != SESSION_INVALID_INDEX)
256 ls = listen_session_get (al->session_index);
257 app_worker_stop_listen_session (app_wrk, ls);
260 if (al->local_index != SESSION_INVALID_INDEX)
262 ls = listen_session_get (al->local_index);
263 app_worker_stop_listen_session (app_wrk, ls);
266 clib_bitmap_set_no_check (al->workers, app_wrk->wrk_map_index, 0);
267 if (clib_bitmap_is_zero (al->workers))
268 app_listener_cleanup (al);
274 app_worker_init_accepted (session_t * s)
276 app_worker_t *app_wrk;
277 segment_manager_t *sm;
280 listener = listen_session_get (s->listener_index);
281 app_wrk = application_listener_select_worker (listener);
282 s->app_wrk_index = app_wrk->wrk_index;
284 sm = app_worker_get_listen_segment_manager (app_wrk, listener);
285 if (app_worker_alloc_session_fifos (sm, s))
292 app_worker_accept_notify (app_worker_t * app_wrk, session_t * s)
294 application_t *app = application_get (app_wrk->app_index);
295 return app->cb_fns.session_accept_callback (s);
299 app_worker_init_connected (app_worker_t * app_wrk, session_t * s)
301 application_t *app = application_get (app_wrk->app_index);
302 segment_manager_t *sm;
304 /* Allocate fifos for session, unless the app is a builtin proxy */
305 if (!application_is_builtin_proxy (app))
307 sm = app_worker_get_connect_segment_manager (app_wrk);
308 if (app_worker_alloc_session_fifos (sm, s))
315 app_worker_connect_notify (app_worker_t * app_wrk, session_t * s, u32 opaque)
317 application_t *app = application_get (app_wrk->app_index);
318 return app->cb_fns.session_connected_callback (app_wrk->wrk_index, opaque,
319 s, s == 0 /* is_fail */ );
323 app_worker_close_notify (app_worker_t * app_wrk, session_t * s)
325 application_t *app = application_get (app_wrk->app_index);
326 app->cb_fns.session_disconnect_callback (s);
331 app_worker_reset_notify (app_worker_t * app_wrk, session_t * s)
333 application_t *app = application_get (app_wrk->app_index);
334 app->cb_fns.session_reset_callback (s);
339 app_worker_builtin_rx (app_worker_t * app_wrk, session_t * s)
341 application_t *app = application_get (app_wrk->app_index);
342 app->cb_fns.builtin_app_rx_callback (s);
347 app_worker_builtin_tx (app_worker_t * app_wrk, session_t * s)
349 application_t *app = application_get (app_wrk->app_index);
351 if (!app->cb_fns.builtin_app_tx_callback)
354 app->cb_fns.builtin_app_tx_callback (s);
359 app_worker_own_session (app_worker_t * app_wrk, session_t * s)
361 segment_manager_t *sm;
362 svm_fifo_t *rxf, *txf;
364 if (s->session_state == SESSION_STATE_LISTENING)
365 return application_change_listener_owner (s, app_wrk);
367 s->app_wrk_index = app_wrk->wrk_index;
378 sm = app_worker_get_or_alloc_connect_segment_manager (app_wrk);
379 if (app_worker_alloc_session_fifos (sm, s))
382 if (!svm_fifo_is_empty_cons (rxf))
383 svm_fifo_clone (s->rx_fifo, rxf);
385 if (!svm_fifo_is_empty_cons (txf))
386 svm_fifo_clone (s->tx_fifo, txf);
388 segment_manager_dealloc_fifos (rxf, txf);
394 app_worker_connect_session (app_worker_t * app, session_endpoint_t * sep,
399 /* Make sure we have a segment manager for connects */
400 app_worker_alloc_connects_segment_manager (app);
402 if ((rv = session_open (app->wrk_index, sep, api_context)))
409 app_worker_alloc_connects_segment_manager (app_worker_t * app_wrk)
411 segment_manager_t *sm;
413 if (app_wrk->connects_seg_manager == APP_INVALID_SEGMENT_MANAGER_INDEX)
415 sm = app_worker_alloc_segment_manager (app_wrk);
418 app_wrk->connects_seg_manager = segment_manager_index (sm);
424 app_worker_get_connect_segment_manager (app_worker_t * app)
426 ASSERT (app->connects_seg_manager != (u32) ~ 0);
427 return segment_manager_get (app->connects_seg_manager);
431 app_worker_get_or_alloc_connect_segment_manager (app_worker_t * app_wrk)
433 if (app_wrk->connects_seg_manager == (u32) ~ 0)
434 app_worker_alloc_connects_segment_manager (app_wrk);
435 return segment_manager_get (app_wrk->connects_seg_manager);
439 app_worker_get_listen_segment_manager (app_worker_t * app,
440 session_t * listener)
443 smp = hash_get (app->listeners_table, listen_session_get_handle (listener));
445 return segment_manager_get (*smp);
449 app_worker_first_listener (app_worker_t * app_wrk, u8 fib_proto,
457 sst = session_type_from_proto_and_ip (transport_proto,
458 fib_proto == FIB_PROTOCOL_IP4);
461 hash_foreach (handle, sm_index, app_wrk->listeners_table, ({
462 listener = listen_session_get_from_handle (handle);
463 if (listener->session_type == sst
464 && !(listener->flags & SESSION_F_PROXY))
473 app_worker_proxy_listener (app_worker_t * app_wrk, u8 fib_proto,
481 sst = session_type_from_proto_and_ip (transport_proto,
482 fib_proto == FIB_PROTOCOL_IP4);
485 hash_foreach (handle, sm_index, app_wrk->listeners_table, ({
486 listener = listen_session_get_from_handle (handle);
487 if (listener->session_type == sst && (listener->flags & SESSION_F_PROXY))
496 * Send an API message to the external app, to map new segment
499 app_worker_add_segment_notify (app_worker_t * app_wrk, u64 segment_handle)
501 application_t *app = application_get (app_wrk->app_index);
502 return app->cb_fns.add_segment_callback (app_wrk->api_client_index,
507 app_worker_del_segment_notify (app_worker_t * app_wrk, u64 segment_handle)
509 application_t *app = application_get (app_wrk->app_index);
510 return app->cb_fns.del_segment_callback (app_wrk->api_client_index,
515 app_worker_application_is_builtin (app_worker_t * app_wrk)
517 return app_wrk->app_is_builtin;
521 app_enqueue_evt (svm_msg_q_t * mq, svm_msg_q_msg_t * msg, u8 lock)
523 if (PREDICT_FALSE (svm_msg_q_is_full (mq)))
525 clib_warning ("evt q full");
526 svm_msg_q_free_msg (mq, msg);
528 svm_msg_q_unlock (mq);
534 svm_msg_q_add_and_unlock (mq, msg);
538 /* Even when not locking the ring, we must wait for queue mutex */
539 if (svm_msg_q_add (mq, msg, SVM_Q_WAIT))
541 clib_warning ("msg q add returned");
548 app_send_io_evt_rx (app_worker_t * app_wrk, session_t * s, u8 lock)
550 session_event_t *evt;
554 if (PREDICT_FALSE (s->session_state != SESSION_STATE_READY
555 && s->session_state != SESSION_STATE_LISTENING))
558 if (app_worker_application_is_builtin (app_wrk))
559 return app_worker_builtin_rx (app_wrk, s);
561 if (svm_fifo_has_event (s->rx_fifo))
564 mq = app_wrk->event_queue;
568 if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
570 clib_warning ("evt q rings full");
572 svm_msg_q_unlock (mq);
576 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
577 ASSERT (!svm_msg_q_msg_is_invalid (&msg));
579 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
580 evt->session_index = s->rx_fifo->client_session_index;
581 evt->event_type = SESSION_IO_EVT_RX;
583 (void) svm_fifo_set_event (s->rx_fifo);
585 if (app_enqueue_evt (mq, &msg, lock))
591 app_send_io_evt_tx (app_worker_t * app_wrk, session_t * s, u8 lock)
594 session_event_t *evt;
597 if (app_worker_application_is_builtin (app_wrk))
598 return app_worker_builtin_tx (app_wrk, s);
600 mq = app_wrk->event_queue;
604 if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
606 clib_warning ("evt q rings full");
608 svm_msg_q_unlock (mq);
612 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
613 ASSERT (!svm_msg_q_msg_is_invalid (&msg));
615 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
616 evt->event_type = SESSION_IO_EVT_TX;
617 evt->session_index = s->tx_fifo->client_session_index;
619 return app_enqueue_evt (mq, &msg, lock);
623 typedef int (app_send_evt_handler_fn) (app_worker_t *app,
626 static app_send_evt_handler_fn * const app_send_evt_handler_fns[2] = {
633 * Send event to application
635 * Logic from queue perspective is non-blocking. If there's
636 * not enough space to enqueue a message, we return.
639 app_worker_send_event (app_worker_t * app, session_t * s, u8 evt_type)
641 ASSERT (app && evt_type <= SESSION_IO_EVT_TX);
642 return app_send_evt_handler_fns[evt_type] (app, s, 0 /* lock */ );
646 * Send event to application
648 * Logic from queue perspective is blocking. However, if queue is full,
652 app_worker_lock_and_send_event (app_worker_t * app, session_t * s,
655 return app_send_evt_handler_fns[evt_type] (app, s, 1 /* lock */ );
659 format_app_worker_listener (u8 * s, va_list * args)
661 app_worker_t *app_wrk = va_arg (*args, app_worker_t *);
662 u64 handle = va_arg (*args, u64);
663 u32 sm_index = va_arg (*args, u32);
664 int verbose = va_arg (*args, int);
672 s = format (s, "%-40s%-25s%=10s%-15s%-15s%-10s", "Connection", "App",
673 "Wrk", "API Client", "ListenerID", "SegManager");
675 s = format (s, "%-40s%-25s%=10s", "Connection", "App", "Wrk");
680 app_name = application_name_from_index (app_wrk->app_index);
681 listener = listen_session_get_from_handle (handle);
682 str = format (0, "%U", format_session, listener, verbose);
687 sprintf (buf, "%u(%u)", app_wrk->wrk_map_index, app_wrk->wrk_index);
688 s = format (s, "%-40s%-25s%=10s%-15u%-15u%-10u", str, app_name,
689 buf, app_wrk->api_client_index, handle, sm_index);
692 s = format (s, "%-40s%-25s%=10u", str, app_name, app_wrk->wrk_map_index);
698 format_app_worker (u8 * s, va_list * args)
700 app_worker_t *app_wrk = va_arg (*args, app_worker_t *);
703 s = format (s, "%U wrk-index %u app-index %u map-index %u "
704 "api-client-index %d\n", format_white_space, indent,
705 app_wrk->wrk_index, app_wrk->app_index, app_wrk->wrk_map_index,
706 app_wrk->api_client_index);
711 app_worker_format_connects (app_worker_t * app_wrk, int verbose)
713 segment_manager_t *sm;
718 segment_manager_format_sessions (0, verbose);
722 if (app_wrk->connects_seg_manager == (u32) ~ 0)
725 sm = segment_manager_get (app_wrk->connects_seg_manager);
726 segment_manager_format_sessions (sm, verbose);
730 * fd.io coding-style-patch-verification: ON
733 * eval: (c-set-style "gnu")