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 enum ct_segment_flags_
21 CT_SEGMENT_F_CLIENT_DETACHED = 1 << 0,
22 CT_SEGMENT_F_SERVER_DETACHED = 1 << 1,
25 typedef struct ct_segment_
27 u32 client_n_sessions;
28 u32 server_n_sessions;
32 ct_segment_flags_t flags;
35 typedef struct ct_segments_
41 ct_segment_t *segments;
44 typedef struct ct_cleanup_req_
49 typedef struct ct_worker_
51 ct_connection_t *connections; /**< Per-worker connection pools */
52 u32 *pending_connects; /**< Fifo of pending ho indices */
53 ct_cleanup_req_t *pending_cleanups; /**< Fifo of pending indices */
54 u8 have_connects; /**< Set if connect rpc pending */
55 u8 have_cleanups; /**< Set if cleanup rpc pending */
56 clib_spinlock_t pending_connects_lock; /**< Lock for pending connects */
57 u32 *new_connects; /**< Burst of connects to be done */
60 typedef struct ct_main_
62 ct_worker_t *wrk; /**< Per-worker state */
63 u32 n_workers; /**< Number of vpp workers */
64 u32 n_sessions; /**< Cumulative sessions counter */
65 u32 *ho_reusable; /**< Vector of reusable ho indices */
66 clib_spinlock_t ho_reuseable_lock; /**< Lock for reusable ho indices */
67 clib_rwlock_t app_segs_lock; /**< RW lock for seg contexts */
68 uword *app_segs_ctxs_table; /**< App handle to segment pool map */
69 ct_segments_ctx_t *app_seg_ctxs; /**< Pool of ct segment contexts */
70 u32 **fwrk_pending_connects; /**< First wrk pending half-opens */
71 u32 fwrk_thread; /**< First worker thread */
72 u8 fwrk_have_flush; /**< Flag for connect flush rpc */
75 static ct_main_t ct_main;
77 static inline ct_worker_t *
78 ct_worker_get (u32 thread_index)
80 return &ct_main.wrk[thread_index];
83 static ct_connection_t *
84 ct_connection_alloc (u32 thread_index)
86 ct_worker_t *wrk = ct_worker_get (thread_index);
89 pool_get_aligned_safe (wrk->connections, ct, CLIB_CACHE_LINE_BYTES);
90 clib_memset (ct, 0, sizeof (*ct));
91 ct->c_c_index = ct - wrk->connections;
92 ct->c_thread_index = thread_index;
95 ct->seg_ctx_index = ~0;
96 ct->ct_seg_index = ~0;
100 static ct_connection_t *
101 ct_connection_get (u32 ct_index, u32 thread_index)
103 ct_worker_t *wrk = ct_worker_get (thread_index);
105 if (pool_is_free_index (wrk->connections, ct_index))
107 return pool_elt_at_index (wrk->connections, ct_index);
111 ct_connection_free (ct_connection_t * ct)
113 ct_worker_t *wrk = ct_worker_get (ct->c_thread_index);
117 clib_memset (ct, 0xfc, sizeof (*ct));
118 pool_put (wrk->connections, ct);
121 pool_put (wrk->connections, ct);
124 static ct_connection_t *
125 ct_half_open_alloc (void)
127 ct_main_t *cm = &ct_main;
130 clib_spinlock_lock (&cm->ho_reuseable_lock);
131 vec_foreach (hip, cm->ho_reusable)
132 pool_put_index (cm->wrk[cm->fwrk_thread].connections, *hip);
133 vec_reset_length (cm->ho_reusable);
134 clib_spinlock_unlock (&cm->ho_reuseable_lock);
136 return ct_connection_alloc (cm->fwrk_thread);
139 static ct_connection_t *
140 ct_half_open_get (u32 ho_index)
142 ct_main_t *cm = &ct_main;
143 return ct_connection_get (ho_index, cm->fwrk_thread);
147 ct_half_open_add_reusable (u32 ho_index)
149 ct_main_t *cm = &ct_main;
151 clib_spinlock_lock (&cm->ho_reuseable_lock);
152 vec_add1 (cm->ho_reusable, ho_index);
153 clib_spinlock_unlock (&cm->ho_reuseable_lock);
157 ct_session_get_peer (session_t * s)
159 ct_connection_t *ct, *peer_ct;
160 ct = ct_connection_get (s->connection_index, s->thread_index);
161 peer_ct = ct_connection_get (ct->peer_index, s->thread_index);
162 return session_get (peer_ct->c_s_index, s->thread_index);
166 ct_session_endpoint (session_t * ll, session_endpoint_t * sep)
169 ct = (ct_connection_t *) session_get_transport (ll);
170 sep->transport_proto = ct->actual_tp;
171 sep->port = ct->c_lcl_port;
172 sep->is_ip4 = ct->c_is_ip4;
173 ip_copy (&sep->ip, &ct->c_lcl_ip, ct->c_is_ip4);
177 ct_set_invalid_app_wrk (ct_connection_t *ct, u8 is_client)
179 ct_connection_t *peer_ct;
181 peer_ct = ct_connection_get (ct->peer_index, ct->c_thread_index);
185 ct->client_wrk = APP_INVALID_INDEX;
187 ct->client_wrk = APP_INVALID_INDEX;
191 ct->server_wrk = APP_INVALID_INDEX;
193 ct->server_wrk = APP_INVALID_INDEX;
198 ct_session_dealloc_fifos (ct_connection_t *ct, svm_fifo_t *rx_fifo,
201 ct_segments_ctx_t *seg_ctx;
202 ct_main_t *cm = &ct_main;
203 segment_manager_t *sm;
204 app_worker_t *app_wrk;
205 ct_segment_t *ct_seg;
215 sm = segment_manager_get (rx_fifo->segment_manager);
216 seg_index = rx_fifo->segment_index;
218 fs = segment_manager_get_segment_w_lock (sm, seg_index);
219 fifo_segment_free_fifo (fs, rx_fifo);
220 fifo_segment_free_fifo (fs, tx_fifo);
221 segment_manager_segment_reader_unlock (sm);
224 * Atomically update segment context with readers lock
227 clib_rwlock_reader_lock (&cm->app_segs_lock);
229 seg_ctx = pool_elt_at_index (cm->app_seg_ctxs, ct->seg_ctx_index);
230 ct_seg = pool_elt_at_index (seg_ctx->segments, ct->ct_seg_index);
232 if (ct->flags & CT_CONN_F_CLIENT)
235 __atomic_sub_fetch (&ct_seg->client_n_sessions, 1, __ATOMIC_RELAXED);
240 __atomic_sub_fetch (&ct_seg->server_n_sessions, 1, __ATOMIC_RELAXED);
243 clib_rwlock_reader_unlock (&cm->app_segs_lock);
246 * No need to do any app updates, return
253 * Grab exclusive lock and update flags unless some other thread
254 * added more sessions
256 clib_rwlock_writer_lock (&cm->app_segs_lock);
258 seg_ctx = pool_elt_at_index (cm->app_seg_ctxs, ct->seg_ctx_index);
259 ct_seg = pool_elt_at_index (seg_ctx->segments, ct->ct_seg_index);
260 if (ct->flags & CT_CONN_F_CLIENT)
262 cnt = ct_seg->client_n_sessions;
265 ct_seg->flags |= CT_SEGMENT_F_CLIENT_DETACHED;
266 s = session_get (ct->c_s_index, ct->c_thread_index);
267 if (s->app_wrk_index == APP_INVALID_INDEX)
268 ct_set_invalid_app_wrk (ct, 1 /* is_client */);
272 cnt = ct_seg->server_n_sessions;
275 ct_seg->flags |= CT_SEGMENT_F_SERVER_DETACHED;
276 s = session_get (ct->c_s_index, ct->c_thread_index);
277 if (s->app_wrk_index == APP_INVALID_INDEX)
278 ct_set_invalid_app_wrk (ct, 0 /* is_client */);
281 if (!(ct_seg->flags & CT_SEGMENT_F_CLIENT_DETACHED) ||
282 !(ct_seg->flags & CT_SEGMENT_F_SERVER_DETACHED))
286 * Remove segment context because both client and server detached
289 pool_put_index (seg_ctx->segments, ct->ct_seg_index);
292 * No more segment indices left, remove the segments context
294 if (!pool_elts (seg_ctx->segments))
296 u64 table_handle = seg_ctx->client_wrk << 16 | seg_ctx->server_wrk;
297 table_handle = (u64) seg_ctx->sm_index << 32 | table_handle;
298 hash_unset (cm->app_segs_ctxs_table, table_handle);
299 pool_free (seg_ctx->segments);
300 pool_put_index (cm->app_seg_ctxs, ct->seg_ctx_index);
304 * Segment to be removed so notify both apps
307 app_wrk = app_worker_get_if_valid (ct->client_wrk);
308 /* Determine if client app still needs notification, i.e., if it is
309 * still attached. If client detached and this is the last ct session
310 * on this segment, then its connects segment manager should also be
311 * detached, so do not send notification */
314 segment_manager_t *csm;
315 csm = app_worker_get_connect_segment_manager (app_wrk);
316 if (!segment_manager_app_detached (csm))
317 app_worker_del_segment_notify (app_wrk, ct->segment_handle);
320 /* Notify server app and free segment */
321 segment_manager_lock_and_del_segment (sm, seg_index);
323 /* Cleanup segment manager if needed. If server detaches there's a chance
324 * the client's sessions will hold up segment removal */
325 if (segment_manager_app_detached (sm) && !segment_manager_has_fifos (sm))
326 segment_manager_free_safe (sm);
330 clib_rwlock_writer_unlock (&cm->app_segs_lock);
334 ct_session_force_disconnect_server (ct_connection_t *sct)
336 sct->peer_index = ~0;
337 session_transport_closing_notify (&sct->connection);
341 ct_session_connect_notify (session_t *ss, session_error_t err)
343 u32 ss_index, opaque, thread_index;
344 ct_connection_t *sct, *cct;
345 app_worker_t *client_wrk;
348 ss_index = ss->session_index;
349 thread_index = ss->thread_index;
350 sct = (ct_connection_t *) session_get_transport (ss);
351 client_wrk = app_worker_get (sct->client_wrk);
352 opaque = sct->client_opaque;
354 cct = ct_connection_get (sct->peer_index, thread_index);
356 /* Client closed while waiting for reply from server */
357 if (PREDICT_FALSE (!cct))
359 ct_session_force_disconnect_server (sct);
363 session_half_open_delete_notify (&cct->connection);
364 cct->flags &= ~CT_CONN_F_HALF_OPEN;
366 if (PREDICT_FALSE (err))
370 * Alloc client session, server session assumed to be established
373 ASSERT (ss->session_state >= SESSION_STATE_READY);
375 cs = session_alloc (thread_index);
376 ss = session_get (ss_index, thread_index);
377 cs->session_type = ss->session_type;
378 cs->listener_handle = SESSION_INVALID_HANDLE;
379 session_set_state (cs, SESSION_STATE_CONNECTING);
380 cs->app_wrk_index = client_wrk->wrk_index;
381 cs->connection_index = cct->c_c_index;
383 cct->c_s_index = cs->session_index;
385 /* This will allocate fifos for the session. They won't be used for
386 * exchanging data but they will be used to close the connection if
387 * the segment manager/worker is freed */
388 if ((err = app_worker_init_connected (client_wrk, cs)))
391 ct_session_force_disconnect_server (sct);
392 err = SESSION_E_ALLOC;
396 session_set_state (cs, SESSION_STATE_CONNECTING);
398 if (app_worker_connect_notify (client_wrk, cs, 0, opaque))
400 segment_manager_dealloc_fifos (cs->rx_fifo, cs->tx_fifo);
402 ct_session_force_disconnect_server (sct);
406 cs = session_get (cct->c_s_index, cct->c_thread_index);
407 session_set_state (cs, SESSION_STATE_READY);
413 app_worker_connect_notify (client_wrk, 0, err, cct->client_opaque);
417 if (cct->client_rx_fifo)
418 ct_session_dealloc_fifos (cct, cct->client_rx_fifo, cct->client_tx_fifo);
419 ct_connection_free (cct);
423 static inline ct_segment_t *
424 ct_lookup_free_segment (ct_main_t *cm, segment_manager_t *sm,
427 uword free_bytes, max_free_bytes;
428 ct_segment_t *ct_seg, *res = 0;
429 ct_segments_ctx_t *seg_ctx;
433 seg_ctx = pool_elt_at_index (cm->app_seg_ctxs, seg_ctx_index);
434 max_free_bytes = seg_ctx->fifo_pair_bytes;
436 pool_foreach (ct_seg, seg_ctx->segments)
438 /* Client or server has detached so segment cannot be used */
439 fs = segment_manager_get_segment (sm, ct_seg->segment_index);
440 free_bytes = fifo_segment_available_bytes (fs);
441 max_fifos = fifo_segment_size (fs) / seg_ctx->fifo_pair_bytes;
442 if (free_bytes > max_free_bytes &&
443 fifo_segment_num_fifos (fs) / 2 < max_fifos)
445 max_free_bytes = free_bytes;
453 static ct_segment_t *
454 ct_alloc_segment (ct_main_t *cm, app_worker_t *server_wrk, u64 table_handle,
455 segment_manager_t *sm, u32 client_wrk_index)
457 u32 seg_ctx_index = ~0, sm_index, pair_bytes;
458 segment_manager_props_t *props;
459 const u32 margin = 16 << 10;
460 ct_segments_ctx_t *seg_ctx;
461 app_worker_t *client_wrk;
462 u64 seg_size, seg_handle;
463 application_t *server;
464 ct_segment_t *ct_seg;
468 server = application_get (server_wrk->app_index);
469 props = application_segment_manager_properties (server);
470 sm_index = segment_manager_index (sm);
471 pair_bytes = props->rx_fifo_size + props->tx_fifo_size + margin;
474 * Make sure another thread did not alloc a segment while acquiring the lock
477 spp = hash_get (cm->app_segs_ctxs_table, table_handle);
480 seg_ctx_index = *spp;
481 ct_seg = ct_lookup_free_segment (cm, sm, seg_ctx_index);
487 * No segment, try to alloc one and notify the server and the client.
488 * Make sure the segment is not used for other fifos
490 seg_size = clib_max (props->segment_size, 128 << 20);
492 segment_manager_add_segment2 (sm, seg_size, FIFO_SEGMENT_F_CUSTOM_USE);
496 if (seg_ctx_index == ~0)
498 pool_get_zero (cm->app_seg_ctxs, seg_ctx);
499 seg_ctx_index = seg_ctx - cm->app_seg_ctxs;
500 hash_set (cm->app_segs_ctxs_table, table_handle, seg_ctx_index);
501 seg_ctx->server_wrk = server_wrk->wrk_index;
502 seg_ctx->client_wrk = client_wrk_index;
503 seg_ctx->sm_index = sm_index;
504 seg_ctx->fifo_pair_bytes = pair_bytes;
508 seg_ctx = pool_elt_at_index (cm->app_seg_ctxs, seg_ctx_index);
511 pool_get_zero (seg_ctx->segments, ct_seg);
512 ct_seg->segment_index = fs_index;
513 ct_seg->server_n_sessions = 0;
514 ct_seg->client_n_sessions = 0;
515 ct_seg->ct_seg_index = ct_seg - seg_ctx->segments;
516 ct_seg->seg_ctx_index = seg_ctx_index;
518 /* New segment, notify the server and client */
519 seg_handle = segment_manager_make_segment_handle (sm_index, fs_index);
520 if (app_worker_add_segment_notify (server_wrk, seg_handle))
523 client_wrk = app_worker_get (client_wrk_index);
524 if (app_worker_add_segment_notify (client_wrk, seg_handle))
526 app_worker_del_segment_notify (server_wrk, seg_handle);
534 segment_manager_lock_and_del_segment (sm, fs_index);
535 pool_put_index (seg_ctx->segments, ct_seg->seg_ctx_index);
540 ct_init_accepted_session (app_worker_t *server_wrk, ct_connection_t *ct,
541 session_t *ls, session_t *ll)
543 segment_manager_props_t *props;
544 u64 seg_handle, table_handle;
545 u32 sm_index, fs_index = ~0;
546 ct_segments_ctx_t *seg_ctx;
547 ct_main_t *cm = &ct_main;
548 application_t *server;
549 segment_manager_t *sm;
550 ct_segment_t *ct_seg;
555 sm = app_worker_get_listen_segment_manager (server_wrk, ll);
556 sm_index = segment_manager_index (sm);
557 server = application_get (server_wrk->app_index);
558 props = application_segment_manager_properties (server);
560 table_handle = ct->client_wrk << 16 | server_wrk->wrk_index;
561 table_handle = (u64) sm_index << 32 | table_handle;
564 * Check if we already have a segment that can hold the fifos
567 clib_rwlock_reader_lock (&cm->app_segs_lock);
569 spp = hash_get (cm->app_segs_ctxs_table, table_handle);
572 ct_seg = ct_lookup_free_segment (cm, sm, *spp);
575 ct->seg_ctx_index = ct_seg->seg_ctx_index;
576 ct->ct_seg_index = ct_seg->ct_seg_index;
577 fs_index = ct_seg->segment_index;
579 ~(CT_SEGMENT_F_SERVER_DETACHED | CT_SEGMENT_F_CLIENT_DETACHED);
580 __atomic_add_fetch (&ct_seg->server_n_sessions, 1, __ATOMIC_RELAXED);
581 __atomic_add_fetch (&ct_seg->client_n_sessions, 1, __ATOMIC_RELAXED);
585 clib_rwlock_reader_unlock (&cm->app_segs_lock);
588 * If not, grab exclusive lock and allocate segment
592 clib_rwlock_writer_lock (&cm->app_segs_lock);
595 ct_alloc_segment (cm, server_wrk, table_handle, sm, ct->client_wrk);
598 clib_rwlock_writer_unlock (&cm->app_segs_lock);
602 ct->seg_ctx_index = ct_seg->seg_ctx_index;
603 ct->ct_seg_index = ct_seg->ct_seg_index;
604 ct_seg->server_n_sessions += 1;
605 ct_seg->client_n_sessions += 1;
606 fs_index = ct_seg->segment_index;
608 clib_rwlock_writer_unlock (&cm->app_segs_lock);
612 * Allocate and initialize the fifos
614 fs = segment_manager_get_segment_w_lock (sm, fs_index);
615 rv = segment_manager_try_alloc_fifos (
616 fs, ls->thread_index, props->rx_fifo_size, props->tx_fifo_size,
617 &ls->rx_fifo, &ls->tx_fifo);
620 segment_manager_segment_reader_unlock (sm);
622 clib_rwlock_reader_lock (&cm->app_segs_lock);
624 seg_ctx = pool_elt_at_index (cm->app_seg_ctxs, ct->seg_ctx_index);
625 ct_seg = pool_elt_at_index (seg_ctx->segments, ct->ct_seg_index);
626 __atomic_sub_fetch (&ct_seg->server_n_sessions, 1, __ATOMIC_RELAXED);
627 __atomic_sub_fetch (&ct_seg->client_n_sessions, 1, __ATOMIC_RELAXED);
629 clib_rwlock_reader_unlock (&cm->app_segs_lock);
634 ls->rx_fifo->shr->master_session_index = ls->session_index;
635 ls->tx_fifo->shr->master_session_index = ls->session_index;
636 ls->rx_fifo->master_thread_index = ls->thread_index;
637 ls->tx_fifo->master_thread_index = ls->thread_index;
639 seg_handle = segment_manager_segment_handle (sm, fs);
640 segment_manager_segment_reader_unlock (sm);
642 ct->segment_handle = seg_handle;
648 ct_accept_one (u32 thread_index, u32 ho_index)
650 ct_connection_t *sct, *cct, *ho;
651 transport_connection_t *ll_ct;
652 app_worker_t *server_wrk;
653 u32 cct_index, ll_index;
657 * Alloc client ct and initialize from ho
659 cct = ct_connection_alloc (thread_index);
660 cct_index = cct->c_c_index;
662 ho = ct_half_open_get (ho_index);
664 /* Unlikely but half-open session and transport could have been freed */
665 if (PREDICT_FALSE (!ho))
667 ct_connection_free (cct);
671 clib_memcpy (cct, ho, sizeof (*ho));
672 cct->c_c_index = cct_index;
673 cct->c_thread_index = thread_index;
674 cct->flags |= CT_CONN_F_HALF_OPEN;
676 /* Notify session layer that half-open is on a different thread
677 * and mark ho connection index reusable. Avoids another rpc
679 session_half_open_migrate_notify (&cct->connection);
680 session_half_open_migrated_notify (&cct->connection);
681 ct_half_open_add_reusable (ho_index);
684 * Alloc and init server transport
687 ll_index = cct->peer_index;
688 ll = listen_session_get (ll_index);
689 sct = ct_connection_alloc (thread_index);
690 /* Transport not necessarily ct but it might, so grab after sct alloc */
691 ll_ct = listen_session_get_transport (ll);
693 /* Make sure cct is valid after sct alloc */
694 cct = ct_connection_get (cct_index, thread_index);
697 sct->c_lcl_port = ll_ct->lcl_port;
698 sct->c_is_ip4 = cct->c_is_ip4;
699 clib_memcpy (&sct->c_lcl_ip, &cct->c_rmt_ip, sizeof (cct->c_rmt_ip));
700 sct->client_wrk = cct->client_wrk;
701 sct->c_proto = TRANSPORT_PROTO_NONE;
702 sct->client_opaque = cct->client_opaque;
703 sct->actual_tp = cct->actual_tp;
705 sct->peer_index = cct->c_c_index;
706 cct->peer_index = sct->c_c_index;
709 * Accept server session. Client session is created only after
710 * server confirms accept.
712 ss = session_alloc (thread_index);
713 ll = listen_session_get (ll_index);
714 ss->session_type = session_type_from_proto_and_ip (TRANSPORT_PROTO_NONE,
716 ss->connection_index = sct->c_c_index;
717 ss->listener_handle = listen_session_get_handle (ll);
718 session_set_state (ss, SESSION_STATE_CREATED);
720 server_wrk = application_listener_select_worker (ll);
721 ss->app_wrk_index = server_wrk->wrk_index;
723 sct->c_s_index = ss->session_index;
724 sct->server_wrk = ss->app_wrk_index;
726 if (ct_init_accepted_session (server_wrk, sct, ss, ll))
728 ct_session_connect_notify (ss, SESSION_E_ALLOC);
729 ct_connection_free (sct);
734 cct->server_wrk = sct->server_wrk;
735 cct->seg_ctx_index = sct->seg_ctx_index;
736 cct->ct_seg_index = sct->ct_seg_index;
737 cct->client_rx_fifo = ss->tx_fifo;
738 cct->client_tx_fifo = ss->rx_fifo;
739 cct->client_rx_fifo->refcnt++;
740 cct->client_tx_fifo->refcnt++;
741 cct->segment_handle = sct->segment_handle;
743 session_set_state (ss, SESSION_STATE_ACCEPTING);
744 if (app_worker_accept_notify (server_wrk, ss))
746 ct_session_connect_notify (ss, SESSION_E_REFUSED);
747 ct_session_dealloc_fifos (sct, ss->rx_fifo, ss->tx_fifo);
748 ct_connection_free (sct);
754 ct_accept_rpc_wrk_handler (void *rpc_args)
756 u32 thread_index, n_connects, i, n_pending;
757 const u32 max_connects = 32;
761 thread_index = pointer_to_uword (rpc_args);
762 wrk = ct_worker_get (thread_index);
764 /* Connects could be handled without worker barrier so grab lock */
765 clib_spinlock_lock (&wrk->pending_connects_lock);
767 n_pending = clib_fifo_elts (wrk->pending_connects);
768 n_connects = clib_min (n_pending, max_connects);
769 vec_validate (wrk->new_connects, n_connects);
771 for (i = 0; i < n_connects; i++)
772 clib_fifo_sub1 (wrk->pending_connects, wrk->new_connects[i]);
774 if (n_pending == n_connects)
775 wrk->have_connects = 0;
779 clib_spinlock_unlock (&wrk->pending_connects_lock);
781 for (i = 0; i < n_connects; i++)
782 ct_accept_one (thread_index, wrk->new_connects[i]);
785 session_send_rpc_evt_to_thread_force (
786 thread_index, ct_accept_rpc_wrk_handler,
787 uword_to_pointer (thread_index, void *));
791 ct_fwrk_flush_connects (void *rpc_args)
793 u32 thread_index, fwrk_index, n_workers;
794 ct_main_t *cm = &ct_main;
798 fwrk_index = cm->fwrk_thread;
799 n_workers = vec_len (cm->fwrk_pending_connects);
801 for (thread_index = fwrk_index; thread_index < n_workers; thread_index++)
803 if (!vec_len (cm->fwrk_pending_connects[thread_index]))
806 wrk = ct_worker_get (thread_index);
808 /* Connects can be done without worker barrier, grab dst worker lock */
809 if (thread_index != fwrk_index)
810 clib_spinlock_lock (&wrk->pending_connects_lock);
812 clib_fifo_add (wrk->pending_connects,
813 cm->fwrk_pending_connects[thread_index],
814 vec_len (cm->fwrk_pending_connects[thread_index]));
815 if (!wrk->have_connects)
817 wrk->have_connects = 1;
821 if (thread_index != fwrk_index)
822 clib_spinlock_unlock (&wrk->pending_connects_lock);
824 vec_reset_length (cm->fwrk_pending_connects[thread_index]);
827 session_send_rpc_evt_to_thread_force (
828 thread_index, ct_accept_rpc_wrk_handler,
829 uword_to_pointer (thread_index, void *));
832 cm->fwrk_have_flush = 0;
836 ct_program_connect_to_wrk (u32 ho_index)
838 ct_main_t *cm = &ct_main;
841 /* Simple round-robin policy for spreading sessions over workers. We skip
842 * thread index 0, i.e., offset the index by 1, when we have workers as it
843 * is the one dedicated to main thread. Note that n_workers does not include
846 thread_index = cm->n_workers ? (cm->n_sessions % cm->n_workers) + 1 : 0;
848 /* Pospone flushing of connect request to dst worker until after session
849 * layer fully initializes the half-open session. */
850 vec_add1 (cm->fwrk_pending_connects[thread_index], ho_index);
851 if (!cm->fwrk_have_flush)
853 session_send_rpc_evt_to_thread_force (
854 cm->fwrk_thread, ct_fwrk_flush_connects,
855 uword_to_pointer (thread_index, void *));
856 cm->fwrk_have_flush = 1;
861 ct_connect (app_worker_t *client_wrk, session_t *ll,
862 session_endpoint_cfg_t *sep)
868 * Alloc and init client half-open transport
871 ho = ct_half_open_alloc ();
872 ho_index = ho->c_c_index;
873 ho->c_rmt_port = sep->port;
875 ho->c_is_ip4 = sep->is_ip4;
876 ho->client_opaque = sep->opaque;
877 ho->client_wrk = client_wrk->wrk_index;
878 ho->peer_index = ll->session_index;
879 ho->c_proto = TRANSPORT_PROTO_NONE;
880 ho->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
881 clib_memcpy (&ho->c_rmt_ip, &sep->ip, sizeof (sep->ip));
882 ho->flags |= CT_CONN_F_CLIENT;
884 ho->actual_tp = sep->original_tp;
887 * Program connect on a worker, connected reply comes
888 * after server accepts the connection.
890 ct_program_connect_to_wrk (ho_index);
896 ct_start_listen (u32 app_listener_index, transport_endpoint_cfg_t *tep)
898 session_endpoint_cfg_t *sep;
901 sep = (session_endpoint_cfg_t *) tep;
902 ct = ct_connection_alloc (0);
903 ct->server_wrk = sep->app_wrk_index;
904 ct->c_is_ip4 = sep->is_ip4;
905 clib_memcpy (&ct->c_lcl_ip, &sep->ip, sizeof (sep->ip));
906 ct->c_lcl_port = sep->port;
907 ct->c_s_index = app_listener_index;
908 ct->actual_tp = sep->transport_proto;
909 return ct->c_c_index;
913 ct_stop_listen (u32 ct_index)
916 ct = ct_connection_get (ct_index, 0);
917 ct_connection_free (ct);
921 static transport_connection_t *
922 ct_listener_get (u32 ct_index)
924 return (transport_connection_t *) ct_connection_get (ct_index, 0);
927 static transport_connection_t *
928 ct_session_half_open_get (u32 ct_index)
930 return (transport_connection_t *) ct_half_open_get (ct_index);
934 ct_session_cleanup (u32 conn_index, u32 thread_index)
936 ct_connection_t *ct, *peer_ct;
938 ct = ct_connection_get (conn_index, thread_index);
942 peer_ct = ct_connection_get (ct->peer_index, thread_index);
944 peer_ct->peer_index = ~0;
946 ct_connection_free (ct);
950 ct_cleanup_ho (u32 ho_index)
954 ho = ct_half_open_get (ho_index);
955 ct_connection_free (ho);
959 ct_session_connect (transport_endpoint_cfg_t * tep)
961 session_endpoint_cfg_t *sep_ext;
962 session_endpoint_t _sep, *sep = &_sep;
963 app_worker_t *app_wrk;
971 sep_ext = (session_endpoint_cfg_t *) tep;
972 _sep = *(session_endpoint_t *) tep;
973 app_wrk = app_worker_get (sep_ext->app_wrk_index);
974 app = application_get (app_wrk->app_index);
976 sep->transport_proto = sep_ext->original_tp;
977 table_index = application_local_session_table (app);
978 lh = session_lookup_local_endpoint (table_index, sep);
979 if (lh == SESSION_DROP_HANDLE)
980 return SESSION_E_FILTERED;
982 if (lh == SESSION_INVALID_HANDLE)
985 ll = listen_session_get_from_handle (lh);
986 al = app_listener_get_w_session (ll);
989 * Break loop if rule in local table points to connecting app. This
990 * can happen if client is a generic proxy. Route connect through
991 * global table instead.
993 if (al->app_index == app->app_index)
996 return ct_connect (app_wrk, ll, sep_ext);
999 * If nothing found, check the global scope for locally attached
1000 * destinations. Make sure first that we're allowed to.
1004 if (session_endpoint_is_local (sep))
1005 return SESSION_E_NOROUTE;
1007 if (!application_has_global_scope (app))
1008 return SESSION_E_SCOPE;
1010 fib_proto = session_endpoint_fib_proto (sep);
1011 table_index = session_lookup_get_index_for_fib (fib_proto, sep->fib_index);
1012 ll = session_lookup_listener_wildcard (table_index, sep);
1014 /* Avoid connecting app to own listener */
1015 if (ll && ll->app_index != app->app_index)
1016 return ct_connect (app_wrk, ll, sep_ext);
1018 /* Failed to connect but no error */
1019 return SESSION_E_LOCAL_CONNECT;
1023 ct_close_is_reset (ct_connection_t *ct, session_t *s)
1025 if (ct->flags & CT_CONN_F_CLIENT)
1026 return (svm_fifo_max_dequeue (ct->client_rx_fifo) > 0);
1028 return (svm_fifo_max_dequeue (s->rx_fifo) > 0);
1032 ct_session_cleanup_server_session (session_t *s)
1034 ct_connection_t *ct;
1036 ct = (ct_connection_t *) session_get_transport (s);
1037 ct_session_dealloc_fifos (ct, s->rx_fifo, s->tx_fifo);
1039 ct_connection_free (ct);
1043 ct_session_postponed_cleanup (ct_connection_t *ct)
1045 ct_connection_t *peer_ct;
1046 app_worker_t *app_wrk;
1049 s = session_get (ct->c_s_index, ct->c_thread_index);
1050 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
1052 peer_ct = ct_connection_get (ct->peer_index, ct->c_thread_index);
1055 if (ct_close_is_reset (ct, s))
1056 session_transport_reset_notify (&peer_ct->connection);
1058 session_transport_closing_notify (&peer_ct->connection);
1060 session_transport_closed_notify (&ct->connection);
1062 /* It would be cleaner to call session_transport_delete_notify
1063 * but then we can't control session cleanup lower */
1064 session_set_state (s, SESSION_STATE_TRANSPORT_DELETED);
1066 app_worker_cleanup_notify (app_wrk, s, SESSION_CLEANUP_TRANSPORT);
1068 if (ct->flags & CT_CONN_F_CLIENT)
1070 /* Normal free for client session as the fifos are allocated through
1071 * the connects segment manager in a segment that's not shared with
1073 ct_session_dealloc_fifos (ct, ct->client_rx_fifo, ct->client_tx_fifo);
1074 session_program_cleanup (s);
1075 ct_connection_free (ct);
1079 /* Manual session and fifo segment cleanup to avoid implicit
1080 * segment manager cleanups and notifications */
1083 /* Remove custom cleanup notify infra when/if switching to normal
1084 * session cleanup. Note that ct is freed in the cb function */
1085 app_worker_cleanup_notify_custom (app_wrk, s,
1086 SESSION_CLEANUP_SESSION,
1087 ct_session_cleanup_server_session);
1091 ct_connection_free (ct);
1097 ct_handle_cleanups (void *args)
1099 uword thread_index = pointer_to_uword (args);
1100 const u32 max_cleanups = 100;
1101 ct_cleanup_req_t *req;
1102 ct_connection_t *ct;
1103 u32 n_to_handle = 0;
1107 wrk = ct_worker_get (thread_index);
1108 wrk->have_cleanups = 0;
1109 n_to_handle = clib_fifo_elts (wrk->pending_cleanups);
1110 n_to_handle = clib_min (n_to_handle, max_cleanups);
1114 clib_fifo_sub2 (wrk->pending_cleanups, req);
1115 ct = ct_connection_get (req->ct_index, thread_index);
1116 s = session_get (ct->c_s_index, ct->c_thread_index);
1117 if (!svm_fifo_has_event (s->tx_fifo))
1118 ct_session_postponed_cleanup (ct);
1120 clib_fifo_add1 (wrk->pending_cleanups, *req);
1124 if (clib_fifo_elts (wrk->pending_cleanups))
1126 wrk->have_cleanups = 1;
1127 session_send_rpc_evt_to_thread_force (
1128 thread_index, ct_handle_cleanups,
1129 uword_to_pointer (thread_index, void *));
1134 ct_program_cleanup (ct_connection_t *ct)
1136 ct_cleanup_req_t *req;
1140 thread_index = ct->c_thread_index;
1141 wrk = ct_worker_get (ct->c_thread_index);
1143 clib_fifo_add2 (wrk->pending_cleanups, req);
1144 req->ct_index = ct->c_c_index;
1146 if (wrk->have_cleanups)
1149 wrk->have_cleanups = 1;
1150 session_send_rpc_evt_to_thread_force (
1151 thread_index, ct_handle_cleanups, uword_to_pointer (thread_index, void *));
1155 ct_session_close (u32 ct_index, u32 thread_index)
1157 ct_connection_t *ct, *peer_ct;
1160 ct = ct_connection_get (ct_index, thread_index);
1161 s = session_get (ct->c_s_index, ct->c_thread_index);
1162 peer_ct = ct_connection_get (ct->peer_index, thread_index);
1165 peer_ct->peer_index = ~0;
1166 /* Make sure session was allocated */
1167 if (peer_ct->flags & CT_CONN_F_HALF_OPEN)
1169 ct_session_connect_notify (s, SESSION_E_REFUSED);
1170 ct->peer_index = ~0;
1172 else if (peer_ct->c_s_index == ~0)
1174 /* should not happen */
1175 clib_warning ("ct peer without session");
1176 ct_connection_free (peer_ct);
1180 /* Do not send closed notify to make sure pending tx events are
1181 * still delivered and program cleanup */
1182 ct_program_cleanup (ct);
1185 static transport_connection_t *
1186 ct_session_get (u32 ct_index, u32 thread_index)
1188 return (transport_connection_t *) ct_connection_get (ct_index,
1193 format_ct_connection_id (u8 * s, va_list * args)
1195 ct_connection_t *ct = va_arg (*args, ct_connection_t *);
1200 s = format (s, "[%d:%d][CT:%U] %U:%d->%U:%d", ct->c_thread_index,
1201 ct->c_s_index, format_transport_proto_short, ct->actual_tp,
1202 format_ip4_address, &ct->c_lcl_ip4,
1203 clib_net_to_host_u16 (ct->c_lcl_port), format_ip4_address,
1204 &ct->c_rmt_ip4, clib_net_to_host_u16 (ct->c_rmt_port));
1208 s = format (s, "[%d:%d][CT:%U] %U:%d->%U:%d", ct->c_thread_index,
1209 ct->c_s_index, format_transport_proto_short, ct->actual_tp,
1210 format_ip6_address, &ct->c_lcl_ip6,
1211 clib_net_to_host_u16 (ct->c_lcl_port), format_ip6_address,
1212 &ct->c_rmt_ip6, clib_net_to_host_u16 (ct->c_rmt_port));
1219 ct_custom_tx (void *session, transport_send_params_t * sp)
1221 session_t *s = (session_t *) session;
1222 if (session_has_transport (s))
1224 /* If event enqueued towards peer, remove from scheduler and remove
1225 * session tx flag, i.e., accept new tx events. Unset fifo flag now to
1226 * avoid missing events if peer did not clear fifo flag yet, which is
1227 * interpreted as successful notification and session is descheduled. */
1228 svm_fifo_unset_event (s->tx_fifo);
1229 if (!ct_session_tx (s))
1230 sp->flags = TRANSPORT_SND_F_DESCHED;
1232 /* The scheduler uses packet count as a means of upper bounding the amount
1233 * of work done per dispatch. So make it look like we have sent something */
1238 ct_app_rx_evt (transport_connection_t * tc)
1240 ct_connection_t *ct = (ct_connection_t *) tc, *peer_ct;
1243 s = session_get (ct->c_s_index, ct->c_thread_index);
1244 if (session_has_transport (s) || s->session_state < SESSION_STATE_READY)
1246 peer_ct = ct_connection_get (ct->peer_index, tc->thread_index);
1247 if (!peer_ct || (peer_ct->flags & CT_CONN_F_HALF_OPEN))
1249 ps = session_get (peer_ct->c_s_index, peer_ct->c_thread_index);
1250 if (ps->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
1252 return session_dequeue_notify (ps);
1256 format_ct_listener (u8 * s, va_list * args)
1258 u32 tc_index = va_arg (*args, u32);
1259 u32 __clib_unused thread_index = va_arg (*args, u32);
1260 u32 __clib_unused verbose = va_arg (*args, u32);
1261 ct_connection_t *ct = ct_connection_get (tc_index, 0);
1262 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_ct_connection_id, ct);
1264 s = format (s, "%-" SESSION_CLI_STATE_LEN "s", "LISTEN");
1269 format_ct_half_open (u8 *s, va_list *args)
1271 u32 ho_index = va_arg (*args, u32);
1272 u32 verbose = va_arg (*args, u32);
1273 ct_connection_t *ct = ct_half_open_get (ho_index);
1274 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_ct_connection_id, ct);
1276 s = format (s, "%-" SESSION_CLI_STATE_LEN "s", "HALF-OPEN");
1281 format_ct_connection (u8 * s, va_list * args)
1283 ct_connection_t *ct = va_arg (*args, ct_connection_t *);
1284 u32 verbose = va_arg (*args, u32);
1288 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_ct_connection_id, ct);
1291 s = format (s, "%-" SESSION_CLI_STATE_LEN "s", "ESTABLISHED");
1294 s = format (s, "\n");
1301 format_ct_session (u8 * s, va_list * args)
1303 u32 ct_index = va_arg (*args, u32);
1304 u32 thread_index = va_arg (*args, u32);
1305 u32 verbose = va_arg (*args, u32);
1306 ct_connection_t *ct;
1308 ct = ct_connection_get (ct_index, thread_index);
1311 s = format (s, "empty\n");
1315 s = format (s, "%U", format_ct_connection, ct, verbose);
1320 ct_enable_disable (vlib_main_t * vm, u8 is_en)
1322 vlib_thread_main_t *vtm = &vlib_thread_main;
1323 ct_main_t *cm = &ct_main;
1326 cm->n_workers = vlib_num_workers ();
1327 cm->fwrk_thread = transport_cl_thread ();
1328 vec_validate (cm->wrk, vtm->n_vlib_mains);
1329 vec_foreach (wrk, cm->wrk)
1330 clib_spinlock_init (&wrk->pending_connects_lock);
1331 clib_spinlock_init (&cm->ho_reuseable_lock);
1332 clib_rwlock_init (&cm->app_segs_lock);
1333 vec_validate (cm->fwrk_pending_connects, cm->n_workers);
1338 static const transport_proto_vft_t cut_thru_proto = {
1339 .enable = ct_enable_disable,
1340 .start_listen = ct_start_listen,
1341 .stop_listen = ct_stop_listen,
1342 .get_connection = ct_session_get,
1343 .get_listener = ct_listener_get,
1344 .get_half_open = ct_session_half_open_get,
1345 .cleanup = ct_session_cleanup,
1346 .cleanup_ho = ct_cleanup_ho,
1347 .connect = ct_session_connect,
1348 .close = ct_session_close,
1349 .custom_tx = ct_custom_tx,
1350 .app_rx_evt = ct_app_rx_evt,
1351 .format_listener = format_ct_listener,
1352 .format_half_open = format_ct_half_open,
1353 .format_connection = format_ct_session,
1354 .transport_options = {
1357 .tx_type = TRANSPORT_TX_INTERNAL,
1358 .service_type = TRANSPORT_SERVICE_VC,
1364 ct_session_can_tx (session_t *s)
1366 return (s->session_state == SESSION_STATE_READY ||
1367 s->session_state == SESSION_STATE_CLOSING ||
1368 s->session_state == SESSION_STATE_APP_CLOSED);
1372 ct_session_tx (session_t * s)
1374 ct_connection_t *ct, *peer_ct;
1377 if (!ct_session_can_tx (s))
1379 ct = (ct_connection_t *) session_get_transport (s);
1380 peer_ct = ct_connection_get (ct->peer_index, ct->c_thread_index);
1383 peer_s = session_get (peer_ct->c_s_index, peer_ct->c_thread_index);
1384 if (peer_s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
1386 return session_enqueue_notify (peer_s);
1389 static clib_error_t *
1390 ct_transport_init (vlib_main_t * vm)
1392 transport_register_protocol (TRANSPORT_PROTO_NONE, &cut_thru_proto,
1393 FIB_PROTOCOL_IP4, ~0);
1394 transport_register_protocol (TRANSPORT_PROTO_NONE, &cut_thru_proto,
1395 FIB_PROTOCOL_IP6, ~0);
1399 VLIB_INIT_FUNCTION (ct_transport_init);
1402 * fd.io coding-style-patch-verification: ON
1405 * eval: (c-set-style "gnu")