2 * Copyright (c) 2019 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (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 <vcl/vcl_locked.h>
17 #include <vcl/vcl_private.h>
19 typedef struct vls_shared_data_
23 u32 *workers_subscribed;
24 clib_bitmap_t *listeners;
27 typedef struct vcl_locked_session_
33 u32 shared_data_index;
34 /** VCL session owned by different workers because of migration */
35 u32 owner_vcl_wrk_index;
36 uword *vcl_wrk_index_to_session_index;
37 } vcl_locked_session_t;
39 typedef struct vls_worker_
41 vcl_locked_session_t *vls_pool;
42 uword *session_index_to_vlsh_table;
46 typedef struct vls_local_
49 volatile int vls_mt_n_threads;
50 pthread_mutex_t vls_mt_mq_mlock;
51 pthread_mutex_t vls_mt_spool_mlock;
52 volatile u8 select_mp_check;
53 volatile u8 epoll_mp_check;
54 } vls_process_local_t;
56 static vls_process_local_t vls_local;
57 static vls_process_local_t *vlsl = &vls_local;
59 typedef struct vls_main_
61 vls_worker_t *workers;
62 clib_rwlock_t vls_table_lock;
63 /** Pool of data shared by sessions owned by different workers */
64 vls_shared_data_t *shared_data_pool;
65 clib_rwlock_t shared_data_lock;
70 typedef enum vls_rpc_msg_type_
72 VLS_RPC_CLONE_AND_SHARE,
76 typedef struct vls_rpc_msg_
82 typedef struct vls_clone_and_share_msg_
84 u32 vls_index; /**< vls to be shared */
85 u32 session_index; /**< vcl session to be shared */
86 u32 origin_vls_wrk; /**< vls worker that initiated the rpc */
87 u32 origin_vls_index; /**< vls session of the originator */
88 u32 origin_vcl_wrk; /**< vcl worker that initiated the rpc */
89 u32 origin_session_index; /**< vcl session of the originator */
90 } vls_clone_and_share_msg_t;
92 typedef struct vls_sess_cleanup_msg_
94 u32 session_index; /**< vcl session to be cleaned */
95 u32 origin_vcl_wrk; /**< worker that initiated the rpc */
96 } vls_sess_cleanup_msg_t;
98 void vls_send_session_cleanup_rpc (vcl_worker_t * wrk,
99 u32 dst_wrk_index, u32 dst_session_index);
100 void vls_send_clone_and_share_rpc (vcl_worker_t * wrk,
101 vcl_locked_session_t * vls,
102 u32 session_index, u32 vls_wrk_index,
103 u32 dst_wrk_index, u32 dst_vls_index,
104 u32 dst_session_index);
108 vls_get_worker_index (void)
110 if (vls_mt_wrk_supported ())
111 return vlsl->vls_wrk_index;
113 return vcl_get_worker_index ();
117 vls_shared_data_alloc (void)
119 vls_shared_data_t *vls_shd;
122 clib_rwlock_writer_lock (&vlsm->shared_data_lock);
123 pool_get_zero (vlsm->shared_data_pool, vls_shd);
124 clib_spinlock_init (&vls_shd->lock);
125 shd_index = vls_shd - vlsm->shared_data_pool;
126 clib_rwlock_writer_unlock (&vlsm->shared_data_lock);
132 vls_shared_data_index (vls_shared_data_t * vls_shd)
134 return vls_shd - vlsm->shared_data_pool;
138 vls_shared_data_get (u32 shd_index)
140 if (pool_is_free_index (vlsm->shared_data_pool, shd_index))
142 return pool_elt_at_index (vlsm->shared_data_pool, shd_index);
146 vls_shared_data_free (u32 shd_index)
148 vls_shared_data_t *vls_shd;
150 clib_rwlock_writer_lock (&vlsm->shared_data_lock);
151 vls_shd = vls_shared_data_get (shd_index);
152 clib_spinlock_free (&vls_shd->lock);
153 clib_bitmap_free (vls_shd->listeners);
154 vec_free (vls_shd->workers_subscribed);
155 pool_put (vlsm->shared_data_pool, vls_shd);
156 clib_rwlock_writer_unlock (&vlsm->shared_data_lock);
160 vls_shared_data_pool_rlock (void)
162 clib_rwlock_reader_lock (&vlsm->shared_data_lock);
166 vls_shared_data_pool_runlock (void)
168 clib_rwlock_reader_unlock (&vlsm->shared_data_lock);
172 vls_mt_table_rlock (void)
174 if (vlsl->vls_mt_n_threads > 1)
175 clib_rwlock_reader_lock (&vlsm->vls_table_lock);
179 vls_mt_table_runlock (void)
181 if (vlsl->vls_mt_n_threads > 1)
182 clib_rwlock_reader_unlock (&vlsm->vls_table_lock);
186 vls_mt_table_wlock (void)
188 if (vlsl->vls_mt_n_threads > 1)
189 clib_rwlock_writer_lock (&vlsm->vls_table_lock);
193 vls_mt_table_wunlock (void)
195 if (vlsl->vls_mt_n_threads > 1)
196 clib_rwlock_writer_unlock (&vlsm->vls_table_lock);
209 VLS_MT_LOCK_MQ = 1 << 0,
210 VLS_MT_LOCK_SPOOL = 1 << 1
211 } vls_mt_lock_type_t;
216 vlsl->vls_mt_n_threads += 1;
218 /* If multi-thread workers are supported, for each new thread register a new
219 * vcl worker with vpp. Otherwise, all threads use the same vcl worker, so
220 * update the vcl worker's thread local worker index variable */
221 if (vls_mt_wrk_supported ())
222 vls_register_vcl_worker ();
224 vcl_set_worker_index (vlsl->vls_wrk_index);
228 vls_mt_mq_lock (void)
230 pthread_mutex_lock (&vlsl->vls_mt_mq_mlock);
234 vls_mt_mq_unlock (void)
236 pthread_mutex_unlock (&vlsl->vls_mt_mq_mlock);
240 vls_mt_spool_lock (void)
242 pthread_mutex_lock (&vlsl->vls_mt_spool_mlock);
246 vls_mt_create_unlock (void)
248 pthread_mutex_unlock (&vlsl->vls_mt_spool_mlock);
252 vls_mt_locks_init (void)
254 pthread_mutex_init (&vlsl->vls_mt_mq_mlock, NULL);
255 pthread_mutex_init (&vlsl->vls_mt_spool_mlock, NULL);
259 vls_is_shared (vcl_locked_session_t * vls)
261 return (vls->shared_data_index != ~0);
265 vls_lock (vcl_locked_session_t * vls)
267 if ((vlsl->vls_mt_n_threads > 1) || vls_is_shared (vls))
268 clib_spinlock_lock (&vls->lock);
272 vls_unlock (vcl_locked_session_t * vls)
274 if ((vlsl->vls_mt_n_threads > 1) || vls_is_shared (vls))
275 clib_spinlock_unlock (&vls->lock);
278 static inline vcl_session_handle_t
279 vls_to_sh (vcl_locked_session_t * vls)
281 return vcl_session_handle_from_index (vls->session_index);
284 static inline vcl_session_handle_t
285 vls_to_sh_tu (vcl_locked_session_t * vls)
287 vcl_session_handle_t sh;
288 sh = vls_to_sh (vls);
289 vls_mt_table_runlock ();
293 static vls_worker_t *
294 vls_worker_get_current (void)
296 return pool_elt_at_index (vlsm->workers, vls_get_worker_index ());
300 vls_worker_alloc (void)
304 pool_get_zero (vlsm->workers, wrk);
305 wrk->wrk_index = vcl_get_worker_index ();
309 vls_worker_free (vls_worker_t * wrk)
311 hash_free (wrk->session_index_to_vlsh_table);
312 pool_free (wrk->vls_pool);
313 pool_put (vlsm->workers, wrk);
316 static vls_worker_t *
317 vls_worker_get (u32 wrk_index)
319 if (pool_is_free_index (vlsm->workers, wrk_index))
321 return pool_elt_at_index (vlsm->workers, wrk_index);
325 vls_alloc (vcl_session_handle_t sh)
327 vls_worker_t *wrk = vls_worker_get_current ();
328 vcl_locked_session_t *vls;
330 vls_mt_table_wlock ();
332 pool_get_zero (wrk->vls_pool, vls);
333 vls->session_index = vppcom_session_index (sh);
334 vls->worker_index = vppcom_session_worker (sh);
335 vls->vls_index = vls - wrk->vls_pool;
336 vls->shared_data_index = ~0;
337 hash_set (wrk->session_index_to_vlsh_table, vls->session_index,
339 if (vls_mt_wrk_supported ())
341 hash_set (vls->vcl_wrk_index_to_session_index, vls->worker_index,
343 vls->owner_vcl_wrk_index = vls->worker_index;
345 clib_spinlock_init (&vls->lock);
347 vls_mt_table_wunlock ();
348 return vls->vls_index;
351 static vcl_locked_session_t *
352 vls_get (vls_handle_t vlsh)
354 vls_worker_t *wrk = vls_worker_get_current ();
355 if (pool_is_free_index (wrk->vls_pool, vlsh))
357 return pool_elt_at_index (wrk->vls_pool, vlsh);
361 vls_free (vcl_locked_session_t * vls)
363 vls_worker_t *wrk = vls_worker_get_current ();
366 hash_unset (wrk->session_index_to_vlsh_table, vls->session_index);
367 clib_spinlock_free (&vls->lock);
368 pool_put (wrk->vls_pool, vls);
371 static vcl_locked_session_t *
372 vls_get_and_lock (vls_handle_t vlsh)
374 vls_worker_t *wrk = vls_worker_get_current ();
375 vcl_locked_session_t *vls;
376 if (pool_is_free_index (wrk->vls_pool, vlsh))
378 vls = pool_elt_at_index (wrk->vls_pool, vlsh);
383 static vcl_locked_session_t *
384 vls_get_w_dlock (vls_handle_t vlsh)
386 vcl_locked_session_t *vls;
387 vls_mt_table_rlock ();
388 vls = vls_get_and_lock (vlsh);
390 vls_mt_table_runlock ();
395 vls_get_and_unlock (vls_handle_t vlsh)
397 vcl_locked_session_t *vls;
398 vls_mt_table_rlock ();
399 vls = vls_get (vlsh);
401 vls_mt_table_runlock ();
405 vls_dunlock (vcl_locked_session_t * vls)
408 vls_mt_table_runlock ();
411 static vcl_locked_session_t *
412 vls_session_get (vls_worker_t * wrk, u32 vls_index)
414 if (pool_is_free_index (wrk->vls_pool, vls_index))
416 return pool_elt_at_index (wrk->vls_pool, vls_index);
420 vlsh_to_sh (vls_handle_t vlsh)
422 vcl_locked_session_t *vls;
425 vls = vls_get_w_dlock (vlsh);
427 return INVALID_SESSION_ID;
428 rv = vls_to_sh (vls);
434 vlsh_to_session_index (vls_handle_t vlsh)
436 vcl_session_handle_t sh;
437 sh = vlsh_to_sh (vlsh);
438 return vppcom_session_index (sh);
442 vls_si_to_vlsh (u32 session_index)
444 vls_worker_t *wrk = vls_worker_get_current ();
446 vlshp = hash_get (wrk->session_index_to_vlsh_table, session_index);
447 return vlshp ? *vlshp : VLS_INVALID_HANDLE;
451 vls_session_index_to_vlsh (uint32_t session_index)
455 vls_mt_table_rlock ();
456 vlsh = vls_si_to_vlsh (session_index);
457 vls_mt_table_runlock ();
463 vls_is_shared_by_wrk (vcl_locked_session_t * vls, u32 wrk_index)
465 vls_shared_data_t *vls_shd;
468 if (vls->shared_data_index == ~0)
471 vls_shared_data_pool_rlock ();
473 vls_shd = vls_shared_data_get (vls->shared_data_index);
474 clib_spinlock_lock (&vls_shd->lock);
476 for (i = 0; i < vec_len (vls_shd->workers_subscribed); i++)
477 if (vls_shd->workers_subscribed[i] == wrk_index)
479 clib_spinlock_unlock (&vls_shd->lock);
480 vls_shared_data_pool_runlock ();
483 clib_spinlock_unlock (&vls_shd->lock);
485 vls_shared_data_pool_runlock ();
490 vls_listener_wrk_set (vcl_locked_session_t * vls, u32 wrk_index, u8 is_active)
492 vls_shared_data_t *vls_shd;
494 if (vls->shared_data_index == ~0)
496 clib_warning ("not a shared session");
500 vls_shared_data_pool_rlock ();
502 vls_shd = vls_shared_data_get (vls->shared_data_index);
504 clib_spinlock_lock (&vls_shd->lock);
505 clib_bitmap_set (vls_shd->listeners, wrk_index, is_active);
506 clib_spinlock_unlock (&vls_shd->lock);
508 vls_shared_data_pool_runlock ();
512 vls_shared_get_owner (vcl_locked_session_t * vls)
514 vls_shared_data_t *vls_shd;
517 vls_shared_data_pool_rlock ();
519 vls_shd = vls_shared_data_get (vls->shared_data_index);
520 owner_wrk = vls_shd->owner_wrk_index;
522 vls_shared_data_pool_runlock ();
528 vls_listener_wrk_is_active (vcl_locked_session_t * vls, u32 wrk_index)
530 vls_shared_data_t *vls_shd;
533 if (vls->shared_data_index == ~0)
535 clib_warning ("not a shared session");
539 vls_shared_data_pool_rlock ();
541 vls_shd = vls_shared_data_get (vls->shared_data_index);
543 clib_spinlock_lock (&vls_shd->lock);
544 is_set = clib_bitmap_get (vls_shd->listeners, wrk_index);
545 clib_spinlock_unlock (&vls_shd->lock);
547 vls_shared_data_pool_runlock ();
549 return (is_set == 1);
553 vls_listener_wrk_start_listen (vcl_locked_session_t * vls, u32 wrk_index)
555 vppcom_session_listen (vls_to_sh (vls), ~0);
556 vls_listener_wrk_set (vls, wrk_index, 1 /* is_active */ );
560 vls_listener_wrk_stop_listen (vcl_locked_session_t * vls, u32 wrk_index)
565 wrk = vcl_worker_get (wrk_index);
566 s = vcl_session_get (wrk, vls->session_index);
567 if (s->session_state != STATE_LISTEN)
569 vcl_send_session_unlisten (wrk, s);
570 s->session_state = STATE_LISTEN_NO_MQ;
571 vls_listener_wrk_set (vls, wrk_index, 0 /* is_active */ );
575 vls_shared_data_subscriber_position (vls_shared_data_t * vls_shd,
580 for (i = 0; i < vec_len (vls_shd->workers_subscribed); i++)
582 if (vls_shd->workers_subscribed[i] == wrk_index)
589 vls_unshare_session (vcl_locked_session_t * vls, vcl_worker_t * wrk)
591 vls_shared_data_t *vls_shd;
592 int do_disconnect, pos;
596 if (vls->shared_data_index == ~0)
599 s = vcl_session_get (wrk, vls->session_index);
600 if (s->session_state == STATE_LISTEN)
601 vls_listener_wrk_set (vls, wrk->wrk_index, 0 /* is_active */ );
603 vls_shared_data_pool_rlock ();
605 vls_shd = vls_shared_data_get (vls->shared_data_index);
606 clib_spinlock_lock (&vls_shd->lock);
608 pos = vls_shared_data_subscriber_position (vls_shd, wrk->wrk_index);
611 clib_warning ("worker %u not subscribed for vls %u", wrk->wrk_index,
617 * Unsubscribe from share data and fifos
621 svm_fifo_del_subscriber (s->rx_fifo, wrk->vpp_wrk_index);
622 svm_fifo_del_subscriber (s->tx_fifo, wrk->vpp_wrk_index);
624 vec_del1 (vls_shd->workers_subscribed, pos);
629 n_subscribers = vec_len (vls_shd->workers_subscribed);
630 do_disconnect = s->session_state == STATE_LISTEN || !n_subscribers;
631 vcl_session_cleanup (wrk, s, vcl_session_handle (s), do_disconnect);
634 * No subscriber left, cleanup shared data
638 u32 shd_index = vls_shared_data_index (vls_shd);
640 clib_spinlock_unlock (&vls_shd->lock);
641 vls_shared_data_pool_runlock ();
643 vls_shared_data_free (shd_index);
645 /* All locks have been dropped */
649 /* Return, if this is not the owning worker */
650 if (vls_shd->owner_wrk_index != wrk->wrk_index)
653 ASSERT (vec_len (vls_shd->workers_subscribed));
656 * Check if we can change owner or close
658 vls_shd->owner_wrk_index = vls_shd->workers_subscribed[0];
659 vcl_send_session_worker_update (wrk, s, vls_shd->owner_wrk_index);
661 /* XXX is this still needed? */
662 if (vec_len (vls_shd->workers_subscribed) > 1)
663 clib_warning ("more workers need to be updated");
667 clib_spinlock_unlock (&vls_shd->lock);
668 vls_shared_data_pool_runlock ();
674 vls_init_share_session (vls_worker_t * vls_wrk, vcl_locked_session_t * vls)
676 vls_shared_data_t *vls_shd;
678 u32 vls_shd_index = vls_shared_data_alloc ();
680 vls_shared_data_pool_rlock ();
682 vls_shd = vls_shared_data_get (vls_shd_index);
683 vls_shd->owner_wrk_index = vls_wrk->wrk_index;
684 vls->shared_data_index = vls_shd_index;
685 vec_add1 (vls_shd->workers_subscribed, vls_wrk->wrk_index);
687 vls_shared_data_pool_runlock ();
691 vls_share_session (vls_worker_t * vls_wrk, vcl_locked_session_t * vls)
693 vcl_worker_t *vcl_wrk = vcl_worker_get (vls_wrk->wrk_index);
694 vls_shared_data_t *vls_shd;
697 s = vcl_session_get (vcl_wrk, vls->session_index);
700 clib_warning ("wrk %u session %u vls %u NOT AVAILABLE",
701 vcl_wrk->wrk_index, vls->session_index, vls->vls_index);
705 ASSERT (vls->shared_data_index != ~0);
707 /* Reinit session lock */
708 clib_spinlock_init (&vls->lock);
710 vls_shared_data_pool_rlock ();
712 vls_shd = vls_shared_data_get (vls->shared_data_index);
714 clib_spinlock_lock (&vls_shd->lock);
715 vec_add1 (vls_shd->workers_subscribed, vls_wrk->wrk_index);
716 clib_spinlock_unlock (&vls_shd->lock);
718 vls_shared_data_pool_runlock ();
722 svm_fifo_add_subscriber (s->rx_fifo, vcl_wrk->vpp_wrk_index);
723 svm_fifo_add_subscriber (s->tx_fifo, vcl_wrk->vpp_wrk_index);
725 else if (s->session_state == STATE_LISTEN)
727 s->session_state = STATE_LISTEN_NO_MQ;
732 vls_share_sessions (vls_worker_t * vls_parent_wrk, vls_worker_t * vls_wrk)
734 vcl_locked_session_t *vls, *parent_vls;
737 pool_foreach (vls, vls_wrk->vls_pool, ({
738 /* Initialize sharing on parent session */
739 if (vls->shared_data_index == ~0)
741 parent_vls = vls_session_get (vls_parent_wrk, vls->vls_index);
742 vls_init_share_session (vls_parent_wrk, parent_vls);
743 vls->shared_data_index = parent_vls->shared_data_index;
745 vls_share_session (vls_wrk, vls);
751 vls_worker_copy_on_fork (vcl_worker_t * parent_wrk)
753 vls_worker_t *vls_wrk = vls_worker_get_current (), *vls_parent_wrk;
754 vcl_worker_t *wrk = vcl_worker_get_current ();
759 wrk->vpp_event_queues = vec_dup (parent_wrk->vpp_event_queues);
760 wrk->sessions = pool_dup (parent_wrk->sessions);
761 wrk->session_index_by_vpp_handles =
762 hash_dup (parent_wrk->session_index_by_vpp_handles);
767 vls_parent_wrk = vls_worker_get (parent_wrk->wrk_index);
768 vls_wrk->session_index_to_vlsh_table =
769 hash_dup (vls_parent_wrk->session_index_to_vlsh_table);
770 vls_wrk->vls_pool = pool_dup (vls_parent_wrk->vls_pool);
772 vls_share_sessions (vls_parent_wrk, vls_wrk);
776 vls_mt_acq_locks (vcl_locked_session_t * vls, vls_mt_ops_t op, int *locks_acq)
778 vcl_worker_t *wrk = vcl_worker_get_current ();
779 vcl_session_t *s = 0;
784 s = vcl_session_get (wrk, vls->session_index);
785 if (PREDICT_FALSE (!s))
787 is_nonblk = VCL_SESS_ATTR_TEST (s->attr, VCL_SESS_ATTR_NONBLOCK);
794 is_nonblk = vcl_session_read_ready (s) != 0;
798 *locks_acq |= VLS_MT_LOCK_MQ;
801 case VLS_MT_OP_WRITE:
804 is_nonblk = vcl_session_write_ready (s) != 0;
808 *locks_acq |= VLS_MT_LOCK_MQ;
811 case VLS_MT_OP_XPOLL:
813 *locks_acq |= VLS_MT_LOCK_MQ;
815 case VLS_MT_OP_SPOOL:
816 vls_mt_spool_lock ();
817 *locks_acq |= VLS_MT_LOCK_SPOOL;
825 vls_mt_rel_locks (int locks_acq)
827 if (locks_acq & VLS_MT_LOCK_MQ)
829 if (locks_acq & VLS_MT_LOCK_SPOOL)
830 vls_mt_create_unlock ();
834 vls_mt_session_should_migrate (vcl_locked_session_t * vls)
836 return (vls_mt_wrk_supported ()
837 && vls->worker_index != vcl_get_worker_index ());
841 vls_mt_session_migrate (vcl_locked_session_t * vls)
843 u32 wrk_index = vcl_get_worker_index ();
846 vcl_session_t *session;
849 ASSERT (vls_mt_wrk_supported () && vls->worker_index != wrk_index);
852 * VCL session on current vcl worker already allocated. Update current
853 * owner worker and index and return
855 if ((p = hash_get (vls->vcl_wrk_index_to_session_index, wrk_index)))
857 vls->worker_index = wrk_index;
858 vls->session_index = (u32) p[0];
863 * Ask vcl worker that owns the original vcl session to clone it into
864 * current vcl worker session pool
867 if (!(p = hash_get (vls->vcl_wrk_index_to_session_index,
868 vls->owner_vcl_wrk_index)))
870 VERR ("session in owner worker(%u) is free", vls->owner_vcl_wrk_index);
875 src_sid = (u32) p[0];
876 wrk = vcl_worker_get_current ();
877 session = vcl_session_alloc (wrk);
878 sid = session->session_index;
879 vls_send_clone_and_share_rpc (wrk, vls, sid, vls_get_worker_index (),
880 vls->owner_vcl_wrk_index, vls->vls_index,
882 session->session_index = sid;
883 vls->worker_index = wrk_index;
884 vls->session_index = sid;
885 hash_set (vls->vcl_wrk_index_to_session_index, wrk_index, sid);
886 VDBG (1, "migrate session of worker (session): %u (%u) -> %u (%u)",
887 vls->owner_vcl_wrk_index, src_sid, wrk_index, sid);
889 if (PREDICT_FALSE (session->is_vep && session->vep.next_sh != ~0))
891 /* TODO: rollback? */
892 VERR ("can't migrate nonempty epoll session");
896 else if (PREDICT_FALSE (!session->is_vep &&
897 session->session_state != STATE_CLOSED))
899 /* TODO: rollback? */
900 VERR ("migrate NOT supported, session_status (%u)",
901 session->session_state);
910 if (PREDICT_FALSE (vcl_get_worker_index () == ~0))
914 #define vls_mt_guard(_vls, _op) \
915 int _locks_acq = 0; \
916 if (vls_mt_wrk_supported ()) \
918 if (PREDICT_FALSE (_vls \
919 && ((vcl_locked_session_t *)_vls)->worker_index != \
920 vcl_get_worker_index ())) \
921 vls_mt_session_migrate (_vls); \
925 if (PREDICT_FALSE (vlsl->vls_mt_n_threads > 1)) \
926 vls_mt_acq_locks (_vls, _op, &_locks_acq); \
929 #define vls_mt_unguard() \
930 if (PREDICT_FALSE (_locks_acq)) \
931 vls_mt_rel_locks (_locks_acq)
934 vls_write (vls_handle_t vlsh, void *buf, size_t nbytes)
936 vcl_locked_session_t *vls;
940 if (!(vls = vls_get_w_dlock (vlsh)))
941 return VPPCOM_EBADFD;
943 vls_mt_guard (vls, VLS_MT_OP_WRITE);
944 rv = vppcom_session_write (vls_to_sh_tu (vls), buf, nbytes);
946 vls_get_and_unlock (vlsh);
951 vls_write_msg (vls_handle_t vlsh, void *buf, size_t nbytes)
953 vcl_locked_session_t *vls;
957 if (!(vls = vls_get_w_dlock (vlsh)))
958 return VPPCOM_EBADFD;
959 vls_mt_guard (vls, VLS_MT_OP_WRITE);
960 rv = vppcom_session_write_msg (vls_to_sh_tu (vls), buf, nbytes);
962 vls_get_and_unlock (vlsh);
967 vls_sendto (vls_handle_t vlsh, void *buf, int buflen, int flags,
970 vcl_locked_session_t *vls;
974 if (!(vls = vls_get_w_dlock (vlsh)))
975 return VPPCOM_EBADFD;
976 vls_mt_guard (vls, VLS_MT_OP_WRITE);
977 rv = vppcom_session_sendto (vls_to_sh_tu (vls), buf, buflen, flags, ep);
979 vls_get_and_unlock (vlsh);
984 vls_read (vls_handle_t vlsh, void *buf, size_t nbytes)
986 vcl_locked_session_t *vls;
990 if (!(vls = vls_get_w_dlock (vlsh)))
991 return VPPCOM_EBADFD;
992 vls_mt_guard (vls, VLS_MT_OP_READ);
993 rv = vppcom_session_read (vls_to_sh_tu (vls), buf, nbytes);
995 vls_get_and_unlock (vlsh);
1000 vls_recvfrom (vls_handle_t vlsh, void *buffer, uint32_t buflen, int flags,
1001 vppcom_endpt_t * ep)
1003 vcl_locked_session_t *vls;
1007 if (!(vls = vls_get_w_dlock (vlsh)))
1008 return VPPCOM_EBADFD;
1009 vls_mt_guard (vls, VLS_MT_OP_READ);
1010 rv = vppcom_session_recvfrom (vls_to_sh_tu (vls), buffer, buflen, flags,
1013 vls_get_and_unlock (vlsh);
1018 vls_attr (vls_handle_t vlsh, uint32_t op, void *buffer, uint32_t * buflen)
1020 vcl_locked_session_t *vls;
1024 if (!(vls = vls_get_w_dlock (vlsh)))
1025 return VPPCOM_EBADFD;
1026 if (vls_mt_session_should_migrate (vls))
1027 vls_mt_session_migrate (vls);
1028 rv = vppcom_session_attr (vls_to_sh_tu (vls), op, buffer, buflen);
1029 vls_get_and_unlock (vlsh);
1034 vls_bind (vls_handle_t vlsh, vppcom_endpt_t * ep)
1036 vcl_locked_session_t *vls;
1040 if (!(vls = vls_get_w_dlock (vlsh)))
1041 return VPPCOM_EBADFD;
1042 rv = vppcom_session_bind (vls_to_sh_tu (vls), ep);
1043 vls_get_and_unlock (vlsh);
1048 vls_listen (vls_handle_t vlsh, int q_len)
1050 vcl_locked_session_t *vls;
1054 if (!(vls = vls_get_w_dlock (vlsh)))
1055 return VPPCOM_EBADFD;
1056 vls_mt_guard (vls, VLS_MT_OP_XPOLL);
1057 rv = vppcom_session_listen (vls_to_sh_tu (vls), q_len);
1059 vls_get_and_unlock (vlsh);
1064 vls_connect (vls_handle_t vlsh, vppcom_endpt_t * server_ep)
1066 vcl_locked_session_t *vls;
1070 if (!(vls = vls_get_w_dlock (vlsh)))
1071 return VPPCOM_EBADFD;
1072 vls_mt_guard (vls, VLS_MT_OP_XPOLL);
1073 rv = vppcom_session_connect (vls_to_sh_tu (vls), server_ep);
1075 vls_get_and_unlock (vlsh);
1080 vls_mp_checks (vcl_locked_session_t * vls, int is_add)
1082 vcl_worker_t *wrk = vcl_worker_get_current ();
1086 if (vls_mt_wrk_supported ())
1089 s = vcl_session_get (wrk, vls->session_index);
1090 switch (s->session_state)
1095 vls_listener_wrk_set (vls, vls->worker_index, 1 /* is_active */ );
1098 vls_listener_wrk_stop_listen (vls, vls->worker_index);
1100 case STATE_LISTEN_NO_MQ:
1104 /* Register worker as listener */
1105 vls_listener_wrk_start_listen (vls, wrk->wrk_index);
1107 /* If owner worker did not attempt to accept/xpoll on the session,
1108 * force a listen stop for it, since it may not be interested in
1109 * accepting new sessions.
1110 * This is pretty much a hack done to give app workers the illusion
1111 * that it is fine to listen and not accept new sessions for a
1112 * given listener. Without it, we would accumulate unhandled
1113 * accepts on the passive worker message queue. */
1114 owner_wrk = vls_shared_get_owner (vls);
1115 if (!vls_listener_wrk_is_active (vls, owner_wrk))
1116 vls_listener_wrk_stop_listen (vls, owner_wrk);
1124 vls_accept (vls_handle_t listener_vlsh, vppcom_endpt_t * ep, int flags)
1126 vls_handle_t accepted_vlsh;
1127 vcl_locked_session_t *vls;
1131 if (!(vls = vls_get_w_dlock (listener_vlsh)))
1132 return VPPCOM_EBADFD;
1133 if (vcl_n_workers () > 1)
1134 vls_mp_checks (vls, 1 /* is_add */ );
1135 vls_mt_guard (vls, VLS_MT_OP_SPOOL);
1136 sh = vppcom_session_accept (vls_to_sh_tu (vls), ep, flags);
1138 vls_get_and_unlock (listener_vlsh);
1141 accepted_vlsh = vls_alloc (sh);
1142 if (PREDICT_FALSE (accepted_vlsh == VLS_INVALID_HANDLE))
1143 vppcom_session_close (sh);
1144 return accepted_vlsh;
1148 vls_create (uint8_t proto, uint8_t is_nonblocking)
1150 vcl_session_handle_t sh;
1154 vls_mt_guard (0, VLS_MT_OP_SPOOL);
1155 sh = vppcom_session_create (proto, is_nonblocking);
1157 if (sh == INVALID_SESSION_ID)
1158 return VLS_INVALID_HANDLE;
1160 vlsh = vls_alloc (sh);
1161 if (PREDICT_FALSE (vlsh == VLS_INVALID_HANDLE))
1162 vppcom_session_close (sh);
1168 vls_mt_session_cleanup (vcl_locked_session_t * vls)
1170 u32 session_index, wrk_index, current_vcl_wrk;
1171 vcl_worker_t *wrk = vcl_worker_get_current ();
1173 ASSERT (vls_mt_wrk_supported ());
1175 current_vcl_wrk = vcl_get_worker_index ();
1178 hash_foreach (wrk_index, session_index, vls->vcl_wrk_index_to_session_index,
1180 if (current_vcl_wrk != wrk_index)
1181 vls_send_session_cleanup_rpc (wrk, wrk_index, session_index);
1184 hash_free (vls->vcl_wrk_index_to_session_index);
1188 vls_close (vls_handle_t vlsh)
1190 vcl_locked_session_t *vls;
1194 vls_mt_table_wlock ();
1196 vls = vls_get_and_lock (vlsh);
1199 vls_mt_table_wunlock ();
1200 return VPPCOM_EBADFD;
1203 vls_mt_guard (vls, VLS_MT_OP_SPOOL);
1205 if (vls_is_shared (vls))
1206 rv = vls_unshare_session (vls, vcl_worker_get_current ());
1208 rv = vppcom_session_close (vls_to_sh (vls));
1210 if (vls_mt_wrk_supported ())
1211 vls_mt_session_cleanup (vls);
1216 vls_mt_table_wunlock ();
1222 vls_epoll_create (void)
1224 vcl_session_handle_t sh;
1229 sh = vppcom_epoll_create ();
1230 if (sh == INVALID_SESSION_ID)
1231 return VLS_INVALID_HANDLE;
1233 vlsh = vls_alloc (sh);
1234 if (vlsh == VLS_INVALID_HANDLE)
1235 vppcom_session_close (sh);
1241 vls_epoll_ctl_mp_checks (vcl_locked_session_t * vls, int op)
1243 if (vcl_n_workers () <= 1)
1245 vlsl->epoll_mp_check = 1;
1249 if (op == EPOLL_CTL_MOD)
1252 vlsl->epoll_mp_check = 1;
1253 vls_mp_checks (vls, op == EPOLL_CTL_ADD);
1257 vls_epoll_ctl (vls_handle_t ep_vlsh, int op, vls_handle_t vlsh,
1258 struct epoll_event *event)
1260 vcl_locked_session_t *ep_vls, *vls;
1261 vcl_session_handle_t ep_sh, sh;
1265 vls_mt_table_rlock ();
1266 ep_vls = vls_get_and_lock (ep_vlsh);
1267 vls = vls_get_and_lock (vlsh);
1269 if (vls_mt_session_should_migrate (ep_vls))
1270 vls_mt_session_migrate (ep_vls);
1272 ep_sh = vls_to_sh (ep_vls);
1273 sh = vls_to_sh (vls);
1275 if (PREDICT_FALSE (!vlsl->epoll_mp_check))
1276 vls_epoll_ctl_mp_checks (vls, op);
1278 vls_mt_table_runlock ();
1280 rv = vppcom_epoll_ctl (ep_sh, op, sh, event);
1282 vls_mt_table_rlock ();
1283 ep_vls = vls_get (ep_vlsh);
1284 vls = vls_get (vlsh);
1286 vls_unlock (ep_vls);
1287 vls_mt_table_runlock ();
1292 vls_epoll_wait (vls_handle_t ep_vlsh, struct epoll_event *events,
1293 int maxevents, double wait_for_time)
1295 vcl_locked_session_t *vls;
1299 if (!(vls = vls_get_w_dlock (ep_vlsh)))
1300 return VPPCOM_EBADFD;
1301 vls_mt_guard (0, VLS_MT_OP_XPOLL);
1302 rv = vppcom_epoll_wait (vls_to_sh_tu (vls), events, maxevents,
1305 vls_get_and_unlock (ep_vlsh);
1310 vls_select_mp_checks (vcl_si_set * read_map)
1312 vcl_locked_session_t *vls;
1317 if (vcl_n_workers () <= 1)
1319 vlsl->select_mp_check = 1;
1326 vlsl->select_mp_check = 1;
1327 wrk = vcl_worker_get_current ();
1330 clib_bitmap_foreach (si, read_map, ({
1331 s = vcl_session_get (wrk, si);
1332 if (s->session_state == STATE_LISTEN)
1334 vls = vls_get (vls_session_index_to_vlsh (si));
1335 vls_mp_checks (vls, 1 /* is_add */);
1342 vls_select (int n_bits, vcl_si_set * read_map, vcl_si_set * write_map,
1343 vcl_si_set * except_map, double wait_for_time)
1348 vls_mt_guard (0, VLS_MT_OP_XPOLL);
1349 if (PREDICT_FALSE (!vlsl->select_mp_check))
1350 vls_select_mp_checks (read_map);
1351 rv = vppcom_select (n_bits, read_map, write_map, except_map, wait_for_time);
1357 vls_unshare_vcl_worker_sessions (vcl_worker_t * wrk)
1359 u32 current_wrk, is_current;
1360 vcl_locked_session_t *vls;
1363 if (pool_elts (vcm->workers) <= 1)
1366 current_wrk = vcl_get_worker_index ();
1367 is_current = current_wrk == wrk->wrk_index;
1370 pool_foreach (s, wrk->sessions, ({
1371 vls = vls_get (vls_si_to_vlsh (s->session_index));
1372 if (vls && (is_current || vls_is_shared_by_wrk (vls, current_wrk)))
1373 vls_unshare_session (vls, wrk);
1379 vls_cleanup_vcl_worker (vcl_worker_t * wrk)
1381 vls_worker_t *vls_wrk = vls_worker_get (wrk->wrk_index);
1383 /* Unshare sessions and also cleanup worker since child may have
1384 * called _exit () and therefore vcl may not catch the event */
1385 vls_unshare_vcl_worker_sessions (wrk);
1386 vcl_worker_cleanup (wrk, 1 /* notify vpp */ );
1388 vls_worker_free (vls_wrk);
1392 vls_cleanup_forked_child (vcl_worker_t * wrk, vcl_worker_t * child_wrk)
1394 vcl_worker_t *sub_child;
1397 if (child_wrk->forked_child != ~0)
1399 sub_child = vcl_worker_get_if_valid (child_wrk->forked_child);
1402 /* Wait a bit, maybe the process is going away */
1403 while (kill (sub_child->current_pid, 0) >= 0 && tries++ < 50)
1405 if (kill (sub_child->current_pid, 0) < 0)
1406 vls_cleanup_forked_child (child_wrk, sub_child);
1409 vls_cleanup_vcl_worker (child_wrk);
1410 VDBG (0, "Cleaned up forked child wrk %u", child_wrk->wrk_index);
1411 wrk->forked_child = ~0;
1414 static struct sigaction old_sa;
1417 vls_intercept_sigchld_handler (int signum, siginfo_t * si, void *uc)
1419 vcl_worker_t *wrk, *child_wrk;
1421 if (vcl_get_worker_index () == ~0)
1424 if (sigaction (SIGCHLD, &old_sa, 0))
1426 VERR ("couldn't restore sigchld");
1430 wrk = vcl_worker_get_current ();
1431 if (wrk->forked_child == ~0)
1434 child_wrk = vcl_worker_get_if_valid (wrk->forked_child);
1438 if (si && si->si_pid != child_wrk->current_pid)
1440 VDBG (0, "unexpected child pid %u", si->si_pid);
1443 vls_cleanup_forked_child (wrk, child_wrk);
1446 if (old_sa.sa_flags & SA_SIGINFO)
1448 void (*fn) (int, siginfo_t *, void *) = old_sa.sa_sigaction;
1449 fn (signum, si, uc);
1453 void (*fn) (int) = old_sa.sa_handler;
1460 vls_incercept_sigchld ()
1462 struct sigaction sa;
1463 clib_memset (&sa, 0, sizeof (sa));
1464 sa.sa_sigaction = vls_intercept_sigchld_handler;
1465 sa.sa_flags = SA_SIGINFO;
1466 if (sigaction (SIGCHLD, &sa, &old_sa))
1468 VERR ("couldn't intercept sigchld");
1474 vls_app_pre_fork (void)
1476 vls_incercept_sigchld ();
1477 vcl_flush_mq_events ();
1481 vls_app_fork_child_handler (void)
1483 vcl_worker_t *parent_wrk;
1484 int rv, parent_wrk_index;
1487 parent_wrk_index = vcl_get_worker_index ();
1488 VDBG (0, "initializing forked child %u with parent wrk %u", getpid (),
1492 * Allocate worker vcl
1494 vcl_set_worker_index (~0);
1495 if (!vcl_worker_alloc_and_init ())
1496 VERR ("couldn't allocate new worker");
1499 * Attach to binary api
1501 child_name = format (0, "%v-child-%u%c", vcm->app_name, getpid (), 0);
1502 vcl_cleanup_bapi ();
1503 vppcom_api_hookup ();
1504 vcm->app_state = STATE_APP_START;
1505 rv = vppcom_connect_to_vpp ((char *) child_name);
1506 vec_free (child_name);
1509 VERR ("couldn't connect to VPP!");
1514 * Allocate/initialize vls worker
1516 vls_worker_alloc ();
1519 * Register worker with vpp and share sessions
1521 vcl_worker_register_with_vpp ();
1522 parent_wrk = vcl_worker_get (parent_wrk_index);
1523 vls_worker_copy_on_fork (parent_wrk);
1524 parent_wrk->forked_child = vcl_get_worker_index ();
1526 /* Reset number of threads and set wrk index */
1527 vlsl->vls_mt_n_threads = 0;
1528 vlsl->vls_wrk_index = vcl_get_worker_index ();
1529 vlsl->select_mp_check = 0;
1530 vlsl->epoll_mp_check = 0;
1531 vls_mt_locks_init ();
1533 VDBG (0, "forked child main worker initialized");
1538 vls_app_fork_parent_handler (void)
1541 while (vcm->forking)
1548 vls_worker_t *wrk = vls_worker_get_current ();
1550 /* Unshare the sessions. VCL will clean up the worker */
1551 vls_unshare_vcl_worker_sessions (vcl_worker_get_current ());
1552 vls_worker_free (wrk);
1556 vls_clone_and_share_rpc_handler (void *args)
1558 vls_clone_and_share_msg_t *msg = (vls_clone_and_share_msg_t *) args;
1559 vls_worker_t *wrk = vls_worker_get_current (), *dst_wrk;
1560 vcl_locked_session_t *vls, *dst_vls;
1561 vcl_worker_t *vcl_wrk = vcl_worker_get_current (), *dst_vcl_wrk;
1562 vcl_session_t *s, *dst_s;
1564 vls = vls_session_get (wrk, msg->vls_index);
1566 if (!vls_mt_wrk_supported ())
1567 vls_init_share_session (wrk, vls);
1569 s = vcl_session_get (vcl_wrk, msg->session_index);
1570 dst_wrk = vls_worker_get (msg->origin_vls_wrk);
1571 dst_vcl_wrk = vcl_worker_get (msg->origin_vcl_wrk);
1572 dst_vls = vls_session_get (dst_wrk, msg->origin_vls_index);
1573 dst_vls->shared_data_index = vls->shared_data_index;
1574 dst_s = vcl_session_get (dst_vcl_wrk, msg->origin_session_index);
1575 clib_memcpy (dst_s, s, sizeof (*s));
1577 dst_vcl_wrk->rpc_done = 1;
1579 VDBG (1, "proces session clone of worker (session): %u (%u) -> %u (%u)",
1580 vcl_wrk->wrk_index, msg->session_index, dst_vcl_wrk->wrk_index,
1581 msg->origin_session_index);
1585 vls_session_cleanup_rpc_handler (void *args)
1587 vls_sess_cleanup_msg_t *msg = (vls_sess_cleanup_msg_t *) args;
1588 vcl_worker_t *wrk = vcl_worker_get_current ();
1589 vcl_worker_t *dst_wrk = vcl_worker_get (msg->origin_vcl_wrk);
1591 vppcom_session_close (vcl_session_handle_from_index (msg->session_index));
1593 dst_wrk->rpc_done = 1;
1595 VDBG (1, "proces session cleanup of worker (session): %u (%u) from %u ()",
1596 wrk->wrk_index, msg->session_index, dst_wrk->wrk_index);
1600 vls_rpc_handler (void *args)
1602 vls_rpc_msg_t *msg = (vls_rpc_msg_t *) args;
1605 case VLS_RPC_CLONE_AND_SHARE:
1606 vls_clone_and_share_rpc_handler (msg->data);
1608 case VLS_RPC_SESS_CLEANUP:
1609 vls_session_cleanup_rpc_handler (msg->data);
1617 vls_send_clone_and_share_rpc (vcl_worker_t * wrk,
1618 vcl_locked_session_t * vls, u32 session_index,
1619 u32 vls_wrk_index, u32 dst_wrk_index,
1620 u32 dst_vls_index, u32 dst_session_index)
1622 u8 data[sizeof (u8) + sizeof (vls_clone_and_share_msg_t)];
1623 vls_clone_and_share_msg_t *msg;
1627 rpc = (vls_rpc_msg_t *) & data;
1628 rpc->type = VLS_RPC_CLONE_AND_SHARE;
1629 msg = (vls_clone_and_share_msg_t *) & rpc->data;
1630 msg->origin_vls_wrk = vls_wrk_index;
1631 msg->origin_vls_index = vls->vls_index;
1632 msg->origin_vcl_wrk = wrk->wrk_index;
1633 msg->origin_session_index = session_index;
1634 msg->vls_index = dst_vls_index;
1635 msg->session_index = dst_session_index;
1638 ret = vcl_send_worker_rpc (dst_wrk_index, rpc, sizeof (data));
1640 VDBG (1, "send session clone to wrk (session): %u (%u) -> %u (%u), ret=%d",
1641 dst_wrk_index, msg->session_index, msg->origin_vcl_wrk,
1642 msg->origin_session_index, ret);
1643 while (!ret && !wrk->rpc_done)
1648 vls_send_session_cleanup_rpc (vcl_worker_t * wrk,
1649 u32 dst_wrk_index, u32 dst_session_index)
1651 u8 data[sizeof (u8) + sizeof (vls_sess_cleanup_msg_t)];
1652 vls_sess_cleanup_msg_t *msg;
1656 rpc = (vls_rpc_msg_t *) & data;
1657 rpc->type = VLS_RPC_SESS_CLEANUP;
1658 msg = (vls_sess_cleanup_msg_t *) & rpc->data;
1659 msg->origin_vcl_wrk = wrk->wrk_index;
1660 msg->session_index = dst_session_index;
1663 ret = vcl_send_worker_rpc (dst_wrk_index, rpc, sizeof (data));
1665 VDBG (1, "send session cleanup to wrk (session): %u (%u) from %u, ret=%d",
1666 dst_wrk_index, msg->session_index, msg->origin_vcl_wrk, ret);
1667 while (!ret && !wrk->rpc_done)
1672 vls_app_create (char *app_name)
1676 if ((rv = vppcom_app_create (app_name)))
1679 vlsm = clib_mem_alloc (sizeof (vls_main_t));
1680 clib_memset (vlsm, 0, sizeof (*vlsm));
1681 clib_rwlock_init (&vlsm->vls_table_lock);
1682 clib_rwlock_init (&vlsm->shared_data_lock);
1683 pool_alloc (vlsm->workers, vcm->cfg.max_workers);
1685 pthread_atfork (vls_app_pre_fork, vls_app_fork_parent_handler,
1686 vls_app_fork_child_handler);
1687 atexit (vls_app_exit);
1688 vls_worker_alloc ();
1689 vlsl->vls_wrk_index = vcl_get_worker_index ();
1690 vls_mt_locks_init ();
1691 vcm->wrk_rpc_fn = vls_rpc_handler;
1696 vls_use_eventfd (void)
1698 return vcm->cfg.use_mq_eventfd;
1702 vls_mt_wrk_supported (void)
1704 return vcm->cfg.mt_wrk_supported;
1708 vls_use_real_epoll (void)
1710 if (vcl_get_worker_index () == ~0)
1713 return vcl_worker_get_current ()->vcl_needs_real_epoll;
1717 vls_register_vcl_worker (void)
1719 if (vppcom_worker_register () != VPPCOM_OK)
1721 VERR ("failed to register worker");
1727 * fd.io coding-style-patch-verification: ON
1730 * eval: (c-set-style "gnu")