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_local.h>
17 #include <vnet/session/session.h>
19 typedef struct ct_connection_
21 transport_connection_t connection;
24 u32 transport_listener_index;
25 transport_proto_t actual_tp;
28 ct_connection_t *connections;
31 ct_connection_alloc (void)
35 pool_get_zero (connections, ct);
36 ct->c_c_index = ct - connections;
37 ct->c_thread_index = 0;
44 ct_connection_get (u32 ct_index)
46 if (pool_is_free_index (connections, ct_index))
48 return pool_elt_at_index (connections, ct_index);
52 ct_connection_free (ct_connection_t * ct)
55 memset (ct, 0xfc, sizeof (*ct));
56 pool_put (connections, ct);
60 application_local_listener_session_endpoint (session_t * ll,
61 session_endpoint_t * sep)
64 ct = (ct_connection_t *) session_get_transport (ll);
65 sep->transport_proto = ct->actual_tp;
66 sep->port = ct->c_lcl_port;
67 sep->is_ip4 = ct->c_is_ip4;
71 app_worker_local_session_alloc (app_worker_t * app_wrk)
74 pool_get (app_wrk->local_sessions, s);
75 clib_memset (s, 0, sizeof (*s));
76 s->app_wrk_index = app_wrk->wrk_index;
77 s->session_index = s - app_wrk->local_sessions;
78 s->session_type = session_type_from_proto_and_ip (TRANSPORT_PROTO_NONE, 0);
83 app_worker_local_session_free (app_worker_t * app_wrk, local_session_t * s)
85 pool_put (app_wrk->local_sessions, s);
87 clib_memset (s, 0xfc, sizeof (*s));
91 app_worker_get_local_session (app_worker_t * app_wrk, u32 session_index)
93 if (pool_is_free_index (app_wrk->local_sessions, session_index))
95 return pool_elt_at_index (app_wrk->local_sessions, session_index);
99 app_worker_get_local_session_from_handle (session_handle_t handle)
101 app_worker_t *server_wrk;
102 u32 session_index, server_wrk_index;
103 local_session_parse_handle (handle, &server_wrk_index, &session_index);
104 server_wrk = app_worker_get_if_valid (server_wrk_index);
107 return app_worker_get_local_session (server_wrk, session_index);
111 application_client_local_connect_key (local_session_t * ls)
113 return (((u64) ls->app_wrk_index) << 32 | (u64) ls->session_index);
117 application_client_local_connect_key_parse (u64 key, u32 * app_wrk_index,
120 *app_wrk_index = key >> 32;
121 *session_index = key & 0xFFFFFFFF;
125 app_worker_local_sessions_free (app_worker_t * app_wrk)
127 u32 index, server_wrk_index, session_index;
128 u64 handle, *handles = 0;
129 app_worker_t *server_wrk;
130 segment_manager_t *sm;
137 if (app_wrk->local_sessions)
140 pool_foreach (ls, app_wrk->local_sessions, ({
141 app_worker_local_session_disconnect (app_wrk->wrk_index, ls);
149 vec_reset_length (handles);
151 hash_foreach (handle, index, app_wrk->local_connects, ({
152 vec_add1 (handles, handle);
156 for (i = 0; i < vec_len (handles); i++)
158 application_client_local_connect_key_parse (handles[i],
161 server_wrk = app_worker_get_if_valid (server_wrk_index);
164 ls = app_worker_get_local_session (server_wrk, session_index);
165 app_worker_local_session_disconnect (app_wrk->wrk_index, ls);
169 sm = segment_manager_get (app_wrk->local_segment_manager);
170 sm->app_wrk_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
171 segment_manager_del (sm);
175 app_worker_local_session_cleanup (app_worker_t * client_wrk,
176 app_worker_t * server_wrk,
177 local_session_t * ls)
179 svm_fifo_segment_private_t *seg;
181 segment_manager_t *sm;
185 /* Retrieve listener transport type as it is the one that decides where
186 * the fifos are allocated */
187 has_transport = application_local_session_listener_has_transport (ls);
189 sm = app_worker_get_local_segment_manager_w_session (server_wrk, ls);
192 listener = listen_session_get (ls->listener_index);
193 sm = app_worker_get_listen_segment_manager (server_wrk, listener);
196 seg = segment_manager_get_segment (sm, ls->svm_segment_index);
199 client_key = application_client_local_connect_key (ls);
200 hash_unset (client_wrk->local_connects, client_key);
205 application_t *server = application_get (server_wrk->app_index);
206 u64 segment_handle = segment_manager_segment_handle (sm, seg);
207 server->cb_fns.del_segment_callback (server_wrk->api_client_index,
211 application_t *client = application_get (client_wrk->app_index);
212 client->cb_fns.del_segment_callback (client_wrk->api_client_index,
215 segment_manager_del_segment (sm, seg);
218 app_worker_local_session_free (server_wrk, ls);
224 app_worker_local_session_connect_notify (local_session_t * ls)
226 svm_fifo_segment_private_t *seg;
227 app_worker_t *client_wrk, *server_wrk;
228 segment_manager_t *sm;
229 application_t *client;
234 client_wrk = app_worker_get (ls->client_wrk_index);
235 server_wrk = app_worker_get (ls->app_wrk_index);
236 client = application_get (client_wrk->app_index);
238 sm = app_worker_get_local_segment_manager_w_session (server_wrk, ls);
239 seg = segment_manager_get_segment_w_lock (sm, ls->svm_segment_index);
240 segment_handle = segment_manager_segment_handle (sm, seg);
241 if ((rv = client->cb_fns.add_segment_callback (client_wrk->api_client_index,
244 clib_warning ("failed to notify client %u of new segment",
245 ls->client_wrk_index);
246 segment_manager_segment_reader_unlock (sm);
247 app_worker_local_session_disconnect (ls->client_wrk_index, ls);
252 segment_manager_segment_reader_unlock (sm);
255 client->cb_fns.session_connected_callback (client_wrk->wrk_index,
257 (session_t *) ls, is_fail);
259 client_key = application_client_local_connect_key (ls);
260 hash_set (client_wrk->local_connects, client_key, client_key);
265 application_local_session_fix_eventds (svm_msg_q_t * sq, svm_msg_q_t * cq)
270 * segment manager initializes only the producer eventds, since vpp is
271 * typically the producer. But for local sessions, we also pass to the
272 * apps the mqs they listen on for events from peer apps, so they are also
275 fd = svm_msg_q_get_producer_eventfd (sq);
276 svm_msg_q_set_consumer_eventfd (sq, fd);
277 fd = svm_msg_q_get_producer_eventfd (cq);
278 svm_msg_q_set_consumer_eventfd (cq, fd);
282 app_worker_local_session_connect (app_worker_t * client_wrk,
283 app_worker_t * server_wrk,
284 session_t * ll, u32 opaque)
286 u32 seg_size, evt_q_sz, evt_q_elts, margin = 16 << 10;
287 u32 round_rx_fifo_sz, round_tx_fifo_sz, sm_index;
288 segment_manager_properties_t *props, *cprops;
289 int rv, has_transport, seg_index;
290 svm_fifo_segment_private_t *seg;
291 application_t *server, *client;
292 segment_manager_t *sm;
294 svm_msg_q_t *sq, *cq;
297 ls = app_worker_local_session_alloc (server_wrk);
298 server = application_get (server_wrk->app_index);
299 client = application_get (client_wrk->app_index);
301 props = application_segment_manager_properties (server);
302 cprops = application_segment_manager_properties (client);
303 evt_q_elts = props->evt_q_size + cprops->evt_q_size;
304 evt_q_sz = segment_manager_evt_q_expected_size (evt_q_elts);
305 round_rx_fifo_sz = 1 << max_log2 (props->rx_fifo_size);
306 round_tx_fifo_sz = 1 << max_log2 (props->tx_fifo_size);
307 seg_size = round_rx_fifo_sz + round_tx_fifo_sz + evt_q_sz + margin;
309 has_transport = session_has_transport (ll);
312 /* Local sessions don't have backing transport */
313 transport_connection_t *tc;
314 tc = session_get_transport (ll);
315 ls->port = tc->lcl_port;
316 sm = app_worker_get_local_segment_manager (server_wrk);
320 session_t *sl = (session_t *) ll;
321 transport_connection_t *tc;
322 tc = listen_session_get_transport (sl);
323 ls->port = tc->lcl_port;
324 sm = app_worker_get_listen_segment_manager (server_wrk, sl);
327 seg_index = segment_manager_add_segment (sm, seg_size);
330 clib_warning ("failed to add new cut-through segment");
333 seg = segment_manager_get_segment_w_lock (sm, seg_index);
334 sq = segment_manager_alloc_queue (seg, props);
335 cq = segment_manager_alloc_queue (seg, cprops);
337 if (props->use_mq_eventfd)
338 application_local_session_fix_eventds (sq, cq);
340 ls->server_evt_q = pointer_to_uword (sq);
341 ls->client_evt_q = pointer_to_uword (cq);
342 rv = segment_manager_try_alloc_fifos (seg, props->rx_fifo_size,
344 &ls->rx_fifo, &ls->tx_fifo);
347 clib_warning ("failed to add fifos in cut-through segment");
348 segment_manager_segment_reader_unlock (sm);
351 sm_index = segment_manager_index (sm);
352 ls->rx_fifo->ct_session_index = ls->session_index;
353 ls->tx_fifo->ct_session_index = ls->session_index;
354 ls->rx_fifo->segment_manager = sm_index;
355 ls->tx_fifo->segment_manager = sm_index;
356 ls->rx_fifo->segment_index = seg_index;
357 ls->tx_fifo->segment_index = seg_index;
358 ls->svm_segment_index = seg_index;
359 ls->listener_index = ll->session_index;
360 ls->client_wrk_index = client_wrk->wrk_index;
361 ls->client_opaque = opaque;
362 ls->listener_session_type = ll->session_type;
363 ls->session_state = SESSION_STATE_READY;
365 segment_handle = segment_manager_segment_handle (sm, seg);
366 if ((rv = server->cb_fns.add_segment_callback (server_wrk->api_client_index,
369 clib_warning ("failed to notify server of new segment");
370 segment_manager_segment_reader_unlock (sm);
373 segment_manager_segment_reader_unlock (sm);
374 if ((rv = server->cb_fns.session_accept_callback ((session_t *) ls)))
376 clib_warning ("failed to send accept cut-through notify to server");
379 if (server->flags & APP_OPTIONS_FLAGS_IS_BUILTIN)
380 app_worker_local_session_connect_notify (ls);
386 segment_manager_del_segment (sm, seg);
391 app_worker_local_session_disconnect (u32 app_wrk_index, local_session_t * ls)
393 app_worker_t *client_wrk, *server_wrk;
395 client_wrk = app_worker_get_if_valid (ls->client_wrk_index);
396 server_wrk = app_worker_get (ls->app_wrk_index);
398 if (ls->session_state == SESSION_STATE_CLOSED)
399 return app_worker_local_session_cleanup (client_wrk, server_wrk, ls);
401 if (app_wrk_index == ls->client_wrk_index)
403 mq_send_local_session_disconnected_cb (ls->app_wrk_index, ls);
409 return app_worker_local_session_cleanup (client_wrk, server_wrk,
412 else if (ls->session_state < SESSION_STATE_READY)
414 application_t *client = application_get (client_wrk->app_index);
415 client->cb_fns.session_connected_callback (client_wrk->wrk_index,
419 ls->session_state = SESSION_STATE_CLOSED;
420 return app_worker_local_session_cleanup (client_wrk, server_wrk,
425 mq_send_local_session_disconnected_cb (client_wrk->wrk_index, ls);
429 ls->session_state = SESSION_STATE_CLOSED;
435 app_worker_local_session_disconnect_w_index (u32 app_wrk_index, u32 ls_index)
437 app_worker_t *app_wrk;
439 app_wrk = app_worker_get (app_wrk_index);
440 ls = app_worker_get_local_session (app_wrk, ls_index);
441 return app_worker_local_session_disconnect (app_wrk_index, ls);
445 app_worker_format_local_sessions (app_worker_t * app_wrk, int verbose)
447 vlib_main_t *vm = vlib_get_main ();
448 app_worker_t *client_wrk;
450 transport_proto_t tp;
456 vlib_cli_output (vm, "%-40s%-15s%-20s", "Connection", "ServerApp",
461 if (!pool_elts (app_wrk->local_sessions)
462 && !pool_elts (app_wrk->local_connects))
466 pool_foreach (ls, app_wrk->local_sessions, ({
467 tp = session_type_transport_proto(ls->listener_session_type);
468 conn = format (0, "[L][%U] *:%u", format_transport_proto_short, tp,
470 client_wrk = app_worker_get (ls->client_wrk_index);
471 vlib_cli_output (vm, "%-40v%-15u%-20u", conn, ls->app_index,
472 client_wrk->app_index);
473 vec_reset_length (conn);
481 app_worker_format_local_connects (app_worker_t * app, int verbose)
483 vlib_main_t *vm = vlib_get_main ();
484 u32 app_wrk_index, session_index;
485 app_worker_t *server_wrk;
494 vlib_cli_output (vm, "%-40s%-15s%-20s%-10s", "Connection", "App",
495 "Peer App", "SegManager");
497 vlib_cli_output (vm, "%-40s%-15s%-20s", "Connection", "App",
502 if (!app->local_connects)
506 hash_foreach (client_key, value, app->local_connects, ({
507 application_client_local_connect_key_parse (client_key, &app_wrk_index,
509 server_wrk = app_worker_get (app_wrk_index);
510 ls = app_worker_get_local_session (server_wrk, session_index);
511 vlib_cli_output (vm, "%-40s%-15s%-20s", "TODO", ls->app_wrk_index,
512 ls->client_wrk_index);
518 ct_start_listen (u32 app_listener_index, transport_endpoint_t * tep)
520 session_endpoint_cfg_t *sep;
523 sep = (session_endpoint_cfg_t *) tep;
524 ct = ct_connection_alloc ();
525 ct->server_wrk = sep->app_wrk_index;
526 ct->c_is_ip4 = sep->is_ip4;
527 clib_memcpy (&ct->c_lcl_ip, &sep->ip, sizeof (sep->ip));
528 ct->c_lcl_port = sep->port;
529 ct->actual_tp = sep->transport_proto;
530 return ct->c_c_index;
534 ct_stop_listen (u32 ct_index)
537 ct = ct_connection_get (ct_index);
538 ct_connection_free (ct);
542 transport_connection_t *
543 ct_listener_get (u32 ct_index)
545 return (transport_connection_t *) ct_connection_get (ct_index);
549 format_ct_connection_id (u8 * s, va_list * args)
551 ct_connection_t *ct = va_arg (*args, ct_connection_t *);
556 s = format (s, "[%d:%d][CT:%U] %U:%d->%U:%d", ct->c_thread_index,
557 ct->c_s_index, format_transport_proto_short, ct->actual_tp,
558 format_ip4_address, &ct->c_lcl_ip4,
559 clib_net_to_host_u16 (ct->c_lcl_port), format_ip4_address,
560 &ct->c_rmt_ip4, clib_net_to_host_u16 (ct->c_rmt_port));
564 s = format (s, "[%d:%d][CT:%U] %U:%d->%U:%d", ct->c_thread_index,
565 ct->c_s_index, format_transport_proto_short, ct->actual_tp,
566 format_ip6_address, &ct->c_lcl_ip6,
567 clib_net_to_host_u16 (ct->c_lcl_port), format_ip6_address,
568 &ct->c_rmt_ip6, clib_net_to_host_u16 (ct->c_rmt_port));
575 format_ct_listener (u8 * s, va_list * args)
577 u32 tc_index = va_arg (*args, u32);
578 u32 __clib_unused verbose = va_arg (*args, u32);
579 ct_connection_t *ct = ct_connection_get (tc_index);
580 s = format (s, "%-50U", format_ct_connection_id, ct);
582 s = format (s, "%-15s", "LISTEN");
587 const static transport_proto_vft_t cut_thru_proto = {
588 .start_listen = ct_start_listen,
589 .stop_listen = ct_stop_listen,
590 .get_listener = ct_listener_get,
591 .tx_type = TRANSPORT_TX_INTERNAL,
592 .service_type = TRANSPORT_SERVICE_APP,
593 .format_listener = format_ct_listener,
597 static clib_error_t *
598 ct_transport_init (vlib_main_t * vm)
600 transport_register_protocol (TRANSPORT_PROTO_NONE, &cut_thru_proto,
601 FIB_PROTOCOL_IP4, ~0);
605 VLIB_INIT_FUNCTION (ct_transport_init);
608 * fd.io coding-style-patch-verification: ON
611 * eval: (c-set-style "gnu")