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_get_name (app), 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_del (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_del (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_new ();
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;
153 u32 fifo_segment_index;
156 if ((rv = segment_manager_alloc_session_fifos (sm, &rx_fifo, &tx_fifo,
157 &fifo_segment_index)))
160 rx_fifo->master_session_index = s->session_index;
161 rx_fifo->master_thread_index = s->thread_index;
163 tx_fifo->master_session_index = s->session_index;
164 tx_fifo->master_thread_index = s->thread_index;
166 s->rx_fifo = rx_fifo;
167 s->tx_fifo = tx_fifo;
172 app_worker_init_listener (app_worker_t * app_wrk, session_t * ls)
174 segment_manager_t *sm;
176 /* Allocate segment manager. All sessions derived out of a listen session
177 * have fifos allocated by the same segment manager. */
178 if (!(sm = app_worker_alloc_segment_manager (app_wrk)))
181 /* Keep track of the segment manager for the listener or this worker */
182 hash_set (app_wrk->listeners_table, listen_session_get_handle (ls),
183 segment_manager_index (sm));
185 if (session_transport_service_type (ls) == TRANSPORT_SERVICE_CL)
187 if (!ls->rx_fifo && app_worker_alloc_session_fifos (sm, ls))
194 app_worker_start_listen (app_worker_t * app_wrk,
195 app_listener_t * app_listener)
199 if (clib_bitmap_get (app_listener->workers, app_wrk->wrk_map_index))
200 return VNET_API_ERROR_ADDRESS_IN_USE;
202 app_listener->workers = clib_bitmap_set (app_listener->workers,
203 app_wrk->wrk_map_index, 1);
205 if (app_listener->session_index != SESSION_INVALID_INDEX)
207 ls = session_get (app_listener->session_index, 0);
208 if (app_worker_init_listener (app_wrk, ls))
212 if (app_listener->local_index != SESSION_INVALID_INDEX)
214 ls = session_get (app_listener->local_index, 0);
215 if (app_worker_init_listener (app_wrk, ls))
223 app_worker_stop_listen_session (app_worker_t * app_wrk, session_t * ls)
225 session_handle_t handle;
226 segment_manager_t *sm;
229 handle = listen_session_get_handle (ls);
230 sm_indexp = hash_get (app_wrk->listeners_table, handle);
231 if (PREDICT_FALSE (!sm_indexp))
234 sm = segment_manager_get (*sm_indexp);
235 if (app_wrk->first_segment_manager == *sm_indexp)
237 /* Delete sessions but don't remove segment manager */
238 app_wrk->first_segment_manager_in_use = 0;
239 segment_manager_del_sessions (sm);
243 segment_manager_init_del (sm);
245 hash_unset (app_wrk->listeners_table, handle);
249 app_worker_stop_listen (app_worker_t * app_wrk, app_listener_t * al)
253 if (!clib_bitmap_get (al->workers, app_wrk->wrk_map_index))
256 if (al->session_index != SESSION_INVALID_INDEX)
258 ls = listen_session_get (al->session_index);
259 app_worker_stop_listen_session (app_wrk, ls);
262 if (al->local_index != SESSION_INVALID_INDEX)
264 ls = listen_session_get (al->local_index);
265 app_worker_stop_listen_session (app_wrk, ls);
268 clib_bitmap_set_no_check (al->workers, app_wrk->wrk_map_index, 0);
269 if (clib_bitmap_is_zero (al->workers))
270 app_listener_cleanup (al);
276 app_worker_init_accepted (session_t * s)
278 app_worker_t *app_wrk;
279 segment_manager_t *sm;
282 listener = listen_session_get (s->listener_index);
283 app_wrk = application_listener_select_worker (listener);
284 s->app_wrk_index = app_wrk->wrk_index;
286 sm = app_worker_get_listen_segment_manager (app_wrk, listener);
287 if (app_worker_alloc_session_fifos (sm, s))
294 app_worker_accept_notify (app_worker_t * app_wrk, session_t * s)
296 application_t *app = application_get (app_wrk->app_index);
297 return app->cb_fns.session_accept_callback (s);
301 app_worker_init_connected (app_worker_t * app_wrk, session_t * s)
303 application_t *app = application_get (app_wrk->app_index);
304 segment_manager_t *sm;
306 /* Allocate fifos for session, unless the app is a builtin proxy */
307 if (!application_is_builtin_proxy (app))
309 sm = app_worker_get_connect_segment_manager (app_wrk);
310 if (app_worker_alloc_session_fifos (sm, s))
317 app_worker_connect_notify (app_worker_t * app_wrk, session_t * s, u32 opaque)
319 application_t *app = application_get (app_wrk->app_index);
320 return app->cb_fns.session_connected_callback (app_wrk->wrk_index, opaque,
321 s, s == 0 /* is_fail */ );
325 app_worker_own_session (app_worker_t * app_wrk, session_t * s)
327 segment_manager_t *sm;
328 svm_fifo_t *rxf, *txf;
330 if (s->session_state == SESSION_STATE_LISTENING)
331 return application_change_listener_owner (s, app_wrk);
333 s->app_wrk_index = app_wrk->wrk_index;
344 sm = app_worker_get_or_alloc_connect_segment_manager (app_wrk);
345 if (app_worker_alloc_session_fifos (sm, s))
348 if (!svm_fifo_is_empty (rxf))
350 clib_memcpy_fast (s->rx_fifo->data, rxf->data, rxf->nitems);
351 s->rx_fifo->head = rxf->head;
352 s->rx_fifo->tail = rxf->tail;
353 s->rx_fifo->cursize = rxf->cursize;
356 if (!svm_fifo_is_empty (txf))
358 clib_memcpy_fast (s->tx_fifo->data, txf->data, txf->nitems);
359 s->tx_fifo->head = txf->head;
360 s->tx_fifo->tail = txf->tail;
361 s->tx_fifo->cursize = txf->cursize;
364 segment_manager_dealloc_fifos (rxf, txf);
370 app_worker_connect_session (app_worker_t * app, session_endpoint_t * sep,
375 /* Make sure we have a segment manager for connects */
376 app_worker_alloc_connects_segment_manager (app);
378 if ((rv = session_open (app->wrk_index, sep, api_context)))
385 app_worker_alloc_connects_segment_manager (app_worker_t * app_wrk)
387 segment_manager_t *sm;
389 if (app_wrk->connects_seg_manager == APP_INVALID_SEGMENT_MANAGER_INDEX)
391 sm = app_worker_alloc_segment_manager (app_wrk);
394 app_wrk->connects_seg_manager = segment_manager_index (sm);
400 app_worker_get_connect_segment_manager (app_worker_t * app)
402 ASSERT (app->connects_seg_manager != (u32) ~ 0);
403 return segment_manager_get (app->connects_seg_manager);
407 app_worker_get_or_alloc_connect_segment_manager (app_worker_t * app_wrk)
409 if (app_wrk->connects_seg_manager == (u32) ~ 0)
410 app_worker_alloc_connects_segment_manager (app_wrk);
411 return segment_manager_get (app_wrk->connects_seg_manager);
415 app_worker_get_listen_segment_manager (app_worker_t * app,
416 session_t * listener)
419 smp = hash_get (app->listeners_table, listen_session_get_handle (listener));
421 return segment_manager_get (*smp);
425 app_worker_first_listener (app_worker_t * app_wrk, u8 fib_proto,
433 sst = session_type_from_proto_and_ip (transport_proto,
434 fib_proto == FIB_PROTOCOL_IP4);
437 hash_foreach (handle, sm_index, app_wrk->listeners_table, ({
438 listener = listen_session_get_from_handle (handle);
439 if (listener->session_type == sst
440 && listener->enqueue_epoch != SESSION_PROXY_LISTENER_INDEX)
449 app_worker_proxy_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->enqueue_epoch == SESSION_PROXY_LISTENER_INDEX)
473 * Send an API message to the external app, to map new segment
476 app_worker_add_segment_notify (app_worker_t * app_wrk, u64 segment_handle)
478 application_t *app = application_get (app_wrk->app_index);
479 return app->cb_fns.add_segment_callback (app_wrk->api_client_index,
484 app_worker_del_segment_notify (app_worker_t * app_wrk, u64 segment_handle)
486 application_t *app = application_get (app_wrk->app_index);
487 return app->cb_fns.del_segment_callback (app_wrk->api_client_index,
492 app_worker_application_is_builtin (app_worker_t * app_wrk)
494 return app_wrk->app_is_builtin;
498 app_enqueue_evt (svm_msg_q_t * mq, svm_msg_q_msg_t * msg, u8 lock)
500 if (PREDICT_FALSE (svm_msg_q_is_full (mq)))
502 clib_warning ("evt q full");
503 svm_msg_q_free_msg (mq, msg);
505 svm_msg_q_unlock (mq);
511 svm_msg_q_add_and_unlock (mq, msg);
515 /* Even when not locking the ring, we must wait for queue mutex */
516 if (svm_msg_q_add (mq, msg, SVM_Q_WAIT))
518 clib_warning ("msg q add returned");
525 app_send_io_evt_rx (app_worker_t * app_wrk, session_t * s, u8 lock)
527 session_event_t *evt;
531 if (PREDICT_FALSE (s->session_state != SESSION_STATE_READY
532 && s->session_state != SESSION_STATE_LISTENING))
534 /* Session is closed so app will never clean up. Flush rx fifo */
535 if (s->session_state == SESSION_STATE_CLOSED)
536 svm_fifo_dequeue_drop_all (s->rx_fifo);
540 if (app_worker_application_is_builtin (app_wrk))
542 application_t *app = application_get (app_wrk->app_index);
543 return app->cb_fns.builtin_app_rx_callback (s);
546 if (svm_fifo_has_event (s->rx_fifo))
549 mq = app_wrk->event_queue;
553 if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
555 clib_warning ("evt q rings full");
557 svm_msg_q_unlock (mq);
561 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
562 ASSERT (!svm_msg_q_msg_is_invalid (&msg));
564 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
565 evt->session_index = s->rx_fifo->client_session_index;
566 evt->event_type = SESSION_IO_EVT_RX;
568 (void) svm_fifo_set_event (s->rx_fifo);
570 if (app_enqueue_evt (mq, &msg, lock))
576 app_send_io_evt_tx (app_worker_t * app_wrk, session_t * s, u8 lock)
579 session_event_t *evt;
582 if (app_worker_application_is_builtin (app_wrk))
585 mq = app_wrk->event_queue;
589 if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
591 clib_warning ("evt q rings full");
593 svm_msg_q_unlock (mq);
597 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
598 ASSERT (!svm_msg_q_msg_is_invalid (&msg));
600 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
601 evt->event_type = SESSION_IO_EVT_TX;
602 evt->session_index = s->tx_fifo->client_session_index;
604 return app_enqueue_evt (mq, &msg, lock);
608 typedef int (app_send_evt_handler_fn) (app_worker_t *app,
611 static app_send_evt_handler_fn * const app_send_evt_handler_fns[2] = {
618 * Send event to application
620 * Logic from queue perspective is non-blocking. If there's
621 * not enough space to enqueue a message, we return.
624 app_worker_send_event (app_worker_t * app, session_t * s, u8 evt_type)
626 ASSERT (app && evt_type <= SESSION_IO_EVT_TX);
627 return app_send_evt_handler_fns[evt_type] (app, s, 0 /* lock */ );
631 * Send event to application
633 * Logic from queue perspective is blocking. However, if queue is full,
637 app_worker_lock_and_send_event (app_worker_t * app, session_t * s,
640 return app_send_evt_handler_fns[evt_type] (app, s, 1 /* lock */ );
644 format_app_worker_listener (u8 * s, va_list * args)
646 app_worker_t *app_wrk = va_arg (*args, app_worker_t *);
647 u64 handle = va_arg (*args, u64);
648 u32 sm_index = va_arg (*args, u32);
649 int verbose = va_arg (*args, int);
657 s = format (s, "%-40s%-25s%=10s%-15s%-15s%-10s", "Connection", "App",
658 "Wrk", "API Client", "ListenerID", "SegManager");
660 s = format (s, "%-40s%-25s%=10s", "Connection", "App", "Wrk");
665 app_name = application_name_from_index (app_wrk->app_index);
666 listener = listen_session_get_from_handle (handle);
667 str = format (0, "%U", format_session, listener, verbose);
672 sprintf (buf, "%u(%u)", app_wrk->wrk_map_index, app_wrk->wrk_index);
673 s = format (s, "%-40s%-25s%=10s%-15u%-15u%-10u", str, app_name,
674 buf, app_wrk->api_client_index, handle, sm_index);
677 s = format (s, "%-40s%-25s%=10u", str, app_name, app_wrk->wrk_map_index);
683 format_app_worker (u8 * s, va_list * args)
685 app_worker_t *app_wrk = va_arg (*args, app_worker_t *);
688 s = format (s, "%U wrk-index %u app-index %u map-index %u "
689 "api-client-index %d\n", format_white_space, indent,
690 app_wrk->wrk_index, app_wrk->app_index, app_wrk->wrk_map_index,
691 app_wrk->api_client_index);
696 app_worker_format_connects (app_worker_t * app_wrk, int verbose)
698 svm_fifo_segment_private_t *fifo_segment;
699 vlib_main_t *vm = vlib_get_main ();
700 segment_manager_t *sm;
708 vlib_cli_output (vm, "%-40s%-20s%-15s%-10s", "Connection", "App",
709 "API Client", "SegManager");
711 vlib_cli_output (vm, "%-40s%-20s", "Connection", "App");
715 if (app_wrk->connects_seg_manager == (u32) ~ 0)
718 app_name = application_name_from_index (app_wrk->app_index);
720 /* Across all fifo segments */
721 sm = segment_manager_get (app_wrk->connects_seg_manager);
724 segment_manager_foreach_segment_w_lock (fifo_segment, sm, ({
728 fifo = svm_fifo_segment_get_fifo_list (fifo_segment);
731 u32 session_index, thread_index;
734 session_index = fifo->master_session_index;
735 thread_index = fifo->master_thread_index;
737 session = session_get (session_index, thread_index);
738 str = format (0, "%U", format_session, session, verbose);
741 s = format (s, "%-40s%-20s%-15u%-10u", str, app_name,
742 app_wrk->api_client_index, app_wrk->connects_seg_manager);
744 s = format (s, "%-40s%-20s", str, app_name);
746 vlib_cli_output (vm, "%v", s);
747 vec_reset_length (s);
758 * fd.io coding-style-patch-verification: ON
761 * eval: (c-set-style "gnu")