src/vcl/vcl_locked.c

   1 /*
   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
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   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.
  14  */
  15
  16 #include <vcl/vcl_locked.h>
  17 #include <vcl/vcl_private.h>
  18
  19 typedef struct vcl_locked_session_
  20 {
  21   clib_spinlock_t lock;
  22   u32 session_index;
  23   u32 worker_index;
  24   u32 vls_index;
  25   u32 *workers_subscribed;
  26   clib_bitmap_t *listeners;
  27 } vcl_locked_session_t;
  28
  29 typedef struct vls_local_
  30 {
  31   int vls_wrk_index;
  32   volatile int vls_mt_n_threads;
  33   pthread_mutex_t vls_mt_mq_mlock;
  34   pthread_mutex_t vls_mt_spool_mlock;
  35   volatile u8 select_mp_check;
  36   volatile u8 epoll_mp_check;
  37 } vls_process_local_t;
  38
  39 static vls_process_local_t vls_local;
  40 static vls_process_local_t *vlsl = &vls_local;
  41
  42 typedef struct vls_main_
  43 {
  44   vcl_locked_session_t *vls_pool;
  45   clib_rwlock_t vls_table_lock;
  46   uword *session_index_to_vlsh_table;
  47 } vls_main_t;
  48
  49 vls_main_t *vlsm;
  50
  51 static inline void
  52 vls_table_rlock (void)
  53 {
  54   clib_rwlock_reader_lock (&vlsm->vls_table_lock);
  55 }
  56
  57 static inline void
  58 vls_table_runlock (void)
  59 {
  60   clib_rwlock_reader_unlock (&vlsm->vls_table_lock);
  61 }
  62
  63 static inline void
  64 vls_table_wlock (void)
  65 {
  66   clib_rwlock_writer_lock (&vlsm->vls_table_lock);
  67 }
  68
  69 static inline void
  70 vls_table_wunlock (void)
  71 {
  72   clib_rwlock_writer_unlock (&vlsm->vls_table_lock);
  73 }
  74
  75 typedef enum
  76 {
  77   VLS_MT_OP_READ,
  78   VLS_MT_OP_WRITE,
  79   VLS_MT_OP_SPOOL,
  80   VLS_MT_OP_XPOLL,
  81 } vls_mt_ops_t;
  82
  83 typedef enum
  84 {
  85   VLS_MT_LOCK_MQ = 1 << 0,
  86   VLS_MT_LOCK_SPOOL = 1 << 1
  87 } vls_mt_lock_type_t;
  88
  89 static void
  90 vls_mt_add (void)
  91 {
  92   vlsl->vls_mt_n_threads += 1;
  93   vcl_set_worker_index (vlsl->vls_wrk_index);
  94 }
  95
  96 static inline void
  97 vls_mt_mq_lock (void)
  98 {
  99   pthread_mutex_lock (&vlsl->vls_mt_mq_mlock);
 100 }
 101
 102 static inline void
 103 vls_mt_mq_unlock (void)
 104 {
 105   pthread_mutex_unlock (&vlsl->vls_mt_mq_mlock);
 106 }
 107
 108 static inline void
 109 vls_mt_spool_lock (void)
 110 {
 111   pthread_mutex_lock (&vlsl->vls_mt_spool_mlock);
 112 }
 113
 114 static inline void
 115 vls_mt_create_unlock (void)
 116 {
 117   pthread_mutex_unlock (&vlsl->vls_mt_spool_mlock);
 118 }
 119
 120 static void
 121 vls_mt_locks_init (void)
 122 {
 123   pthread_mutex_init (&vlsl->vls_mt_mq_mlock, NULL);
 124   pthread_mutex_init (&vlsl->vls_mt_spool_mlock, NULL);
 125 }
 126
 127 static inline vcl_session_handle_t
 128 vls_to_sh (vcl_locked_session_t * vls)
 129 {
 130   return vcl_session_handle_from_index (vls->session_index);
 131 }
 132
 133 static inline vcl_session_handle_t
 134 vls_to_sh_tu (vcl_locked_session_t * vls)
 135 {
 136   vcl_session_handle_t sh;
 137   sh = vls_to_sh (vls);
 138   vls_table_runlock ();
 139   return sh;
 140 }
 141
 142 static vls_handle_t
 143 vls_alloc (vcl_session_handle_t sh)
 144 {
 145   vcl_locked_session_t *vls;
 146
 147   vls_table_wlock ();
 148   pool_get (vlsm->vls_pool, vls);
 149   vls->session_index = vppcom_session_index (sh);
 150   vls->worker_index = vppcom_session_worker (sh);
 151   vls->vls_index = vls - vlsm->vls_pool;
 152   hash_set (vlsm->session_index_to_vlsh_table, vls->session_index,
 153             vls->vls_index);
 154   clib_spinlock_init (&vls->lock);
 155   vls_table_wunlock ();
 156   return vls->vls_index;
 157 }
 158
 159 static vcl_locked_session_t *
 160 vls_get (vls_handle_t vlsh)
 161 {
 162   if (pool_is_free_index (vlsm->vls_pool, vlsh))
 163     return 0;
 164   return pool_elt_at_index (vlsm->vls_pool, vlsh);
 165 }
 166
 167 static void
 168 vls_free (vcl_locked_session_t * vls)
 169 {
 170   ASSERT (vls != 0);
 171   hash_unset (vlsm->session_index_to_vlsh_table, vls->session_index);
 172   clib_spinlock_free (&vls->lock);
 173   pool_put (vlsm->vls_pool, vls);
 174 }
 175
 176 static vcl_locked_session_t *
 177 vls_get_and_lock (vls_handle_t vlsh)
 178 {
 179   vcl_locked_session_t *vls;
 180   if (pool_is_free_index (vlsm->vls_pool, vlsh))
 181     return 0;
 182   vls = pool_elt_at_index (vlsm->vls_pool, vlsh);
 183   clib_spinlock_lock (&vls->lock);
 184   return vls;
 185 }
 186
 187 static vcl_locked_session_t *
 188 vls_get_w_dlock (vls_handle_t vlsh)
 189 {
 190   vcl_locked_session_t *vls;
 191   vls_table_rlock ();
 192   vls = vls_get_and_lock (vlsh);
 193   if (!vls)
 194     vls_table_runlock ();
 195   return vls;
 196 }
 197
 198 static inline void
 199 vls_lock (vcl_locked_session_t * vls)
 200 {
 201   clib_spinlock_lock (&vls->lock);
 202 }
 203
 204 static inline void
 205 vls_unlock (vcl_locked_session_t * vls)
 206 {
 207   clib_spinlock_unlock (&vls->lock);
 208 }
 209
 210 static inline void
 211 vls_get_and_unlock (vls_handle_t vlsh)
 212 {
 213   vcl_locked_session_t *vls;
 214   vls_table_rlock ();
 215   vls = vls_get (vlsh);
 216   vls_unlock (vls);
 217   vls_table_runlock ();
 218 }
 219
 220 static inline void
 221 vls_dunlock (vcl_locked_session_t * vls)
 222 {
 223   vls_unlock (vls);
 224   vls_table_runlock ();
 225 }
 226
 227 vcl_session_handle_t
 228 vlsh_to_sh (vls_handle_t vlsh)
 229 {
 230   vcl_locked_session_t *vls;
 231   int rv;
 232
 233   vls = vls_get_w_dlock (vlsh);
 234   if (!vls)
 235     return INVALID_SESSION_ID;
 236   rv = vls_to_sh (vls);
 237   vls_dunlock (vls);
 238   return rv;
 239 }
 240
 241 vcl_session_handle_t
 242 vlsh_to_session_index (vls_handle_t vlsh)
 243 {
 244   vcl_session_handle_t sh;
 245   sh = vlsh_to_sh (vlsh);
 246   return vppcom_session_index (sh);
 247 }
 248
 249 vls_handle_t
 250 vls_si_to_vlsh (u32 session_index)
 251 {
 252   uword *vlshp;
 253   vlshp = hash_get (vlsm->session_index_to_vlsh_table, session_index);
 254   return vlshp ? *vlshp : VLS_INVALID_HANDLE;
 255 }
 256
 257 vls_handle_t
 258 vls_session_index_to_vlsh (uint32_t session_index)
 259 {
 260   vls_handle_t vlsh;
 261
 262   vls_table_rlock ();
 263   vlsh = vls_si_to_vlsh (session_index);
 264   vls_table_runlock ();
 265
 266   return vlsh;
 267 }
 268
 269 u8
 270 vls_is_shared (vcl_locked_session_t * vls)
 271 {
 272   return vec_len (vls->workers_subscribed);
 273 }
 274
 275 u8
 276 vls_is_shared_by_wrk (vcl_locked_session_t * vls, u32 wrk_index)
 277 {
 278   int i;
 279   for (i = 0; i < vec_len (vls->workers_subscribed); i++)
 280     if (vls->workers_subscribed[i] == wrk_index)
 281       return 1;
 282   return 0;
 283 }
 284
 285 static void
 286 vls_listener_wrk_set (vcl_locked_session_t * vls, u32 wrk_index, u8 is_active)
 287 {
 288   clib_bitmap_set (vls->listeners, wrk_index, is_active);
 289 }
 290
 291 static u8
 292 vls_listener_wrk_is_active (vcl_locked_session_t * vls, u32 wrk_index)
 293 {
 294   return (clib_bitmap_get (vls->listeners, wrk_index) == 1);
 295 }
 296
 297 static void
 298 vls_listener_wrk_start_listen (vcl_locked_session_t * vls, u32 wrk_index)
 299 {
 300   vppcom_session_listen (vls_to_sh (vls), ~0);
 301   vls_listener_wrk_set (vls, wrk_index, 1 /* is_active */ );
 302 }
 303
 304 static void
 305 vls_listener_wrk_stop_listen (vcl_locked_session_t * vls, u32 wrk_index)
 306 {
 307   vcl_worker_t *wrk;
 308   vcl_session_t *s;
 309
 310   wrk = vcl_worker_get (wrk_index);
 311   s = vcl_session_get (wrk, vls->session_index);
 312   if (s->session_state != STATE_LISTEN)
 313     return;
 314   vppcom_send_unbind_sock (wrk, s->vpp_handle);
 315   s->session_state = STATE_LISTEN_NO_MQ;
 316   vls_listener_wrk_set (vls, wrk_index, 0 /* is_active */ );
 317 }
 318
 319 int
 320 vls_unshare_session (vcl_locked_session_t * vls, vcl_worker_t * wrk)
 321 {
 322   int i, do_disconnect;
 323   vcl_session_t *s;
 324
 325   s = vcl_session_get (wrk, vls->session_index);
 326   if (s->session_state == STATE_LISTEN)
 327     vls_listener_wrk_set (vls, wrk->wrk_index, 0 /* is_active */ );
 328
 329   for (i = 0; i < vec_len (vls->workers_subscribed); i++)
 330     {
 331       if (vls->workers_subscribed[i] != wrk->wrk_index)
 332         continue;
 333
 334       if (s->rx_fifo)
 335         {
 336           svm_fifo_del_subscriber (s->rx_fifo, wrk->vpp_wrk_index);
 337           svm_fifo_del_subscriber (s->tx_fifo, wrk->vpp_wrk_index);
 338         }
 339       vec_del1 (vls->workers_subscribed, i);
 340       do_disconnect = s->session_state == STATE_LISTEN;
 341       vcl_session_cleanup (wrk, s, vcl_session_handle (s), do_disconnect);
 342       return 0;
 343     }
 344
 345   /* Return, if this is not the owning worker */
 346   if (vls->worker_index != wrk->wrk_index)
 347     return 0;
 348
 349   /* Check if we can change owner or close */
 350   if (vec_len (vls->workers_subscribed))
 351     {
 352       vls->worker_index = vls->workers_subscribed[0];
 353       vec_del1 (vls->workers_subscribed, 0);
 354       vcl_send_session_worker_update (wrk, s, vls->worker_index);
 355       if (vec_len (vls->workers_subscribed))
 356         clib_warning ("more workers need to be updated");
 357     }
 358   else
 359     {
 360       vcl_session_cleanup (wrk, s, vcl_session_handle (s),
 361                            1 /* do_disconnect */ );
 362     }
 363
 364   return 0;
 365 }
 366
 367 void
 368 vls_share_vcl_session (vcl_worker_t * wrk, vcl_session_t * s)
 369 {
 370   vcl_locked_session_t *vls;
 371
 372   vls = vls_get (vls_si_to_vlsh (s->session_index));
 373   if (!vls)
 374     return;
 375   vls_lock (vls);
 376   vec_add1 (vls->workers_subscribed, wrk->wrk_index);
 377   if (s->rx_fifo)
 378     {
 379       svm_fifo_add_subscriber (s->rx_fifo, wrk->vpp_wrk_index);
 380       svm_fifo_add_subscriber (s->tx_fifo, wrk->vpp_wrk_index);
 381     }
 382   else if (s->session_state == STATE_LISTEN)
 383     {
 384       s->session_state = STATE_LISTEN_NO_MQ;
 385     }
 386
 387   vls_unlock (vls);
 388 }
 389
 390 void
 391 vls_worker_copy_on_fork (vcl_worker_t * parent_wrk)
 392 {
 393   vcl_worker_t *wrk = vcl_worker_get_current ();
 394   vcl_session_t *s;
 395
 396   wrk->vpp_event_queues = vec_dup (parent_wrk->vpp_event_queues);
 397   wrk->sessions = pool_dup (parent_wrk->sessions);
 398   wrk->session_index_by_vpp_handles =
 399     hash_dup (parent_wrk->session_index_by_vpp_handles);
 400   vls_table_wlock ();
 401
 402   /* *INDENT-OFF* */
 403   pool_foreach (s, wrk->sessions, ({
 404     vls_share_vcl_session (wrk, s);
 405   }));
 406   /* *INDENT-ON* */
 407
 408   vls_table_wunlock ();
 409 }
 410
 411 static void
 412 vls_mt_acq_locks (vcl_locked_session_t * vls, vls_mt_ops_t op, int *locks_acq)
 413 {
 414   vcl_worker_t *wrk = vcl_worker_get_current ();
 415   vcl_session_t *s = 0;
 416   int is_nonblk = 0;
 417
 418   if (vls)
 419     {
 420       s = vcl_session_get (wrk, vls->session_index);
 421       if (PREDICT_FALSE (!s))
 422         return;
 423       is_nonblk = VCL_SESS_ATTR_TEST (s->attr, VCL_SESS_ATTR_NONBLOCK);
 424     }
 425
 426   switch (op)
 427     {
 428     case VLS_MT_OP_READ:
 429       if (!is_nonblk)
 430         is_nonblk = vcl_session_read_ready (s) != 0;
 431       if (!is_nonblk)
 432         {
 433           vls_mt_mq_lock ();
 434           *locks_acq |= VLS_MT_LOCK_MQ;
 435         }
 436       break;
 437     case VLS_MT_OP_WRITE:
 438       ASSERT (s);
 439       if (!is_nonblk)
 440         is_nonblk = vcl_session_write_ready (s) != 0;
 441       if (!is_nonblk)
 442         {
 443           vls_mt_mq_lock ();
 444           *locks_acq |= VLS_MT_LOCK_MQ;
 445         }
 446       break;
 447     case VLS_MT_OP_XPOLL:
 448       vls_mt_mq_lock ();
 449       *locks_acq |= VLS_MT_LOCK_MQ;
 450       break;
 451     case VLS_MT_OP_SPOOL:
 452       vls_mt_spool_lock ();
 453       *locks_acq |= VLS_MT_LOCK_SPOOL;
 454       break;
 455     default:
 456       break;
 457     }
 458 }
 459
 460 static void
 461 vls_mt_rel_locks (int locks_acq)
 462 {
 463   if (locks_acq & VLS_MT_LOCK_MQ)
 464     vls_mt_mq_unlock ();
 465   if (locks_acq & VLS_MT_LOCK_SPOOL)
 466     vls_mt_create_unlock ();
 467 }
 468
 469 #define vls_mt_guard(_vls, _op)                         \
 470   int _locks_acq = 0;                                   \
 471   if (PREDICT_FALSE (vcl_get_worker_index () == ~0));   \
 472     vls_mt_add ();                                      \
 473   if (PREDICT_FALSE (vlsl->vls_mt_n_threads > 1))       \
 474     vls_mt_acq_locks (_vls, _op, &_locks_acq);          \
 475
 476 #define vls_mt_unguard()                                \
 477   if (PREDICT_FALSE (_locks_acq))                       \
 478     vls_mt_rel_locks (_locks_acq)
 479
 480 int
 481 vls_write (vls_handle_t vlsh, void *buf, size_t nbytes)
 482 {
 483   vcl_locked_session_t *vls;
 484   int rv;
 485
 486   if (!(vls = vls_get_w_dlock (vlsh)))
 487     return VPPCOM_EBADFD;
 488
 489   vls_mt_guard (vls, VLS_MT_OP_WRITE);
 490   rv = vppcom_session_write (vls_to_sh_tu (vls), buf, nbytes);
 491   vls_mt_unguard ();
 492   vls_get_and_unlock (vlsh);
 493   return rv;
 494 }
 495
 496 int
 497 vls_write_msg (vls_handle_t vlsh, void *buf, size_t nbytes)
 498 {
 499   vcl_locked_session_t *vls;
 500   int rv;
 501
 502   if (!(vls = vls_get_w_dlock (vlsh)))
 503     return VPPCOM_EBADFD;
 504   vls_mt_guard (vls, VLS_MT_OP_WRITE);
 505   rv = vppcom_session_write_msg (vls_to_sh_tu (vls), buf, nbytes);
 506   vls_mt_unguard ();
 507   vls_get_and_unlock (vlsh);
 508   return rv;
 509 }
 510
 511 int
 512 vls_sendto (vls_handle_t vlsh, void *buf, int buflen, int flags,
 513             vppcom_endpt_t * ep)
 514 {
 515   vcl_locked_session_t *vls;
 516   int rv;
 517
 518   if (!(vls = vls_get_w_dlock (vlsh)))
 519     return VPPCOM_EBADFD;
 520   vls_mt_guard (vls, VLS_MT_OP_WRITE);
 521   rv = vppcom_session_sendto (vls_to_sh_tu (vls), buf, buflen, flags, ep);
 522   vls_mt_unguard ();
 523   vls_get_and_unlock (vlsh);
 524   return rv;
 525 }
 526
 527 ssize_t
 528 vls_read (vls_handle_t vlsh, void *buf, size_t nbytes)
 529 {
 530   vcl_locked_session_t *vls;
 531   int rv;
 532
 533   if (!(vls = vls_get_w_dlock (vlsh)))
 534     return VPPCOM_EBADFD;
 535   vls_mt_guard (vls, VLS_MT_OP_READ);
 536   rv = vppcom_session_read (vls_to_sh_tu (vls), buf, nbytes);
 537   vls_mt_unguard ();
 538   vls_get_and_unlock (vlsh);
 539   return rv;
 540 }
 541
 542 ssize_t
 543 vls_recvfrom (vls_handle_t vlsh, void *buffer, uint32_t buflen, int flags,
 544               vppcom_endpt_t * ep)
 545 {
 546   vcl_locked_session_t *vls;
 547   int rv;
 548
 549   if (!(vls = vls_get_w_dlock (vlsh)))
 550     return VPPCOM_EBADFD;
 551   vls_mt_guard (vls, VLS_MT_OP_READ);
 552   rv = vppcom_session_recvfrom (vls_to_sh_tu (vls), buffer, buflen, flags,
 553                                 ep);
 554   vls_mt_unguard ();
 555   vls_get_and_unlock (vlsh);
 556   return rv;
 557 }
 558
 559 int
 560 vls_attr (vls_handle_t vlsh, uint32_t op, void *buffer, uint32_t * buflen)
 561 {
 562   vcl_locked_session_t *vls;
 563   int rv;
 564
 565   if (!(vls = vls_get_w_dlock (vlsh)))
 566     return VPPCOM_EBADFD;
 567   rv = vppcom_session_attr (vls_to_sh_tu (vls), op, buffer, buflen);
 568   vls_get_and_unlock (vlsh);
 569   return rv;
 570 }
 571
 572 int
 573 vls_bind (vls_handle_t vlsh, vppcom_endpt_t * ep)
 574 {
 575   vcl_locked_session_t *vls;
 576   int rv;
 577
 578   if (!(vls = vls_get_w_dlock (vlsh)))
 579     return VPPCOM_EBADFD;
 580   rv = vppcom_session_bind (vls_to_sh_tu (vls), ep);
 581   vls_get_and_unlock (vlsh);
 582   return rv;
 583 }
 584
 585 int
 586 vls_listen (vls_handle_t vlsh, int q_len)
 587 {
 588   vcl_locked_session_t *vls;
 589   int rv;
 590
 591   if (!(vls = vls_get_w_dlock (vlsh)))
 592     return VPPCOM_EBADFD;
 593   vls_mt_guard (vls, VLS_MT_OP_XPOLL);
 594   rv = vppcom_session_listen (vls_to_sh_tu (vls), q_len);
 595   vls_mt_unguard ();
 596   vls_get_and_unlock (vlsh);
 597   return rv;
 598 }
 599
 600 int
 601 vls_connect (vls_handle_t vlsh, vppcom_endpt_t * server_ep)
 602 {
 603   vcl_locked_session_t *vls;
 604   int rv;
 605
 606   if (!(vls = vls_get_w_dlock (vlsh)))
 607     return VPPCOM_EBADFD;
 608   vls_mt_guard (vls, VLS_MT_OP_XPOLL);
 609   rv = vppcom_session_connect (vls_to_sh_tu (vls), server_ep);
 610   vls_mt_unguard ();
 611   vls_get_and_unlock (vlsh);
 612   return rv;
 613 }
 614
 615 static inline void
 616 vls_mp_checks (vcl_locked_session_t * vls, int is_add)
 617 {
 618   vcl_worker_t *wrk = vcl_worker_get_current ();
 619   vcl_session_t *s;
 620
 621   s = vcl_session_get (wrk, vls->session_index);
 622   switch (s->session_state)
 623     {
 624     case STATE_LISTEN:
 625       if (is_add)
 626         {
 627           if (vls->worker_index == wrk->wrk_index)
 628             vls_listener_wrk_set (vls, wrk->wrk_index, 1 /* is_active */ );
 629           break;
 630         }
 631       vls_listener_wrk_stop_listen (vls, vls->worker_index);
 632       break;
 633     case STATE_LISTEN_NO_MQ:
 634       if (!is_add)
 635         break;
 636
 637       /* Register worker as listener */
 638       vls_listener_wrk_start_listen (vls, wrk->wrk_index);
 639
 640       /* If owner worker did not attempt to accept/xpoll on the session,
 641        * force a listen stop for it, since it may not be interested in
 642        * accepting new sessions.
 643        * This is pretty much a hack done to give app workers the illusion
 644        * that it is fine to listen and not accept new sessions for a
 645        * given listener. Without it, we would accumulate unhandled
 646        * accepts on the passive worker message queue. */
 647       if (!vls_listener_wrk_is_active (vls, vls->worker_index))
 648         vls_listener_wrk_stop_listen (vls, vls->worker_index);
 649       break;
 650     default:
 651       break;
 652     }
 653 }
 654
 655 vls_handle_t
 656 vls_accept (vls_handle_t listener_vlsh, vppcom_endpt_t * ep, int flags)
 657 {
 658   vls_handle_t accepted_vlsh;
 659   vcl_locked_session_t *vls;
 660   int sh;
 661
 662   if (!(vls = vls_get_w_dlock (listener_vlsh)))
 663     return VPPCOM_EBADFD;
 664   if (vcl_n_workers () > 1)
 665     vls_mp_checks (vls, 1 /* is_add */ );
 666   vls_mt_guard (vls, VLS_MT_OP_SPOOL);
 667   sh = vppcom_session_accept (vls_to_sh_tu (vls), ep, flags);
 668   vls_mt_unguard ();
 669   vls_get_and_unlock (listener_vlsh);
 670   if (sh < 0)
 671     return sh;
 672   accepted_vlsh = vls_alloc (sh);
 673   if (PREDICT_FALSE (accepted_vlsh == VLS_INVALID_HANDLE))
 674     vppcom_session_close (sh);
 675   return accepted_vlsh;
 676 }
 677
 678 vls_handle_t
 679 vls_create (uint8_t proto, uint8_t is_nonblocking)
 680 {
 681   vcl_session_handle_t sh;
 682   vls_handle_t vlsh;
 683
 684   vls_mt_guard (0, VLS_MT_OP_SPOOL);
 685   sh = vppcom_session_create (proto, is_nonblocking);
 686   vls_mt_unguard ();
 687   if (sh == INVALID_SESSION_ID)
 688     return VLS_INVALID_HANDLE;
 689
 690   vlsh = vls_alloc (sh);
 691   if (PREDICT_FALSE (vlsh == VLS_INVALID_HANDLE))
 692     vppcom_session_close (sh);
 693
 694   return vlsh;
 695 }
 696
 697 int
 698 vls_close (vls_handle_t vlsh)
 699 {
 700   vcl_locked_session_t *vls;
 701   int rv;
 702
 703   vls_table_wlock ();
 704
 705   vls = vls_get_and_lock (vlsh);
 706   if (!vls)
 707     {
 708       vls_table_wunlock ();
 709       return VPPCOM_EBADFD;
 710     }
 711
 712   vls_mt_guard (0, VLS_MT_OP_SPOOL);
 713   if (vls_is_shared (vls))
 714     {
 715       /* At least two workers share the session so vls won't be freed */
 716       vls_unshare_session (vls, vcl_worker_get_current ());
 717       vls_unlock (vls);
 718       vls_mt_unguard ();
 719       vls_table_wunlock ();
 720       return VPPCOM_OK;
 721     }
 722
 723   rv = vppcom_session_close (vls_to_sh (vls));
 724   vls_free (vls);
 725   vls_mt_unguard ();
 726
 727   vls_table_wunlock ();
 728
 729   return rv;
 730 }
 731
 732 vls_handle_t
 733 vls_epoll_create (void)
 734 {
 735   vcl_session_handle_t sh;
 736   vls_handle_t vlsh;
 737
 738   sh = vppcom_epoll_create ();
 739   if (sh == INVALID_SESSION_ID)
 740     return VLS_INVALID_HANDLE;
 741
 742   vlsh = vls_alloc (sh);
 743   if (vlsh == VLS_INVALID_HANDLE)
 744     vppcom_session_close (sh);
 745
 746   return vlsh;
 747 }
 748
 749 static void
 750 vls_epoll_ctl_mp_checks (vcl_locked_session_t * vls, int op)
 751 {
 752   if (vcl_n_workers () <= 1)
 753     {
 754       vlsl->epoll_mp_check = 1;
 755       return;
 756     }
 757
 758   if (op == EPOLL_CTL_MOD)
 759     return;
 760
 761   vlsl->epoll_mp_check = 1;
 762   vls_mp_checks (vls, op == EPOLL_CTL_ADD);
 763 }
 764
 765 int
 766 vls_epoll_ctl (vls_handle_t ep_vlsh, int op, vls_handle_t vlsh,
 767                struct epoll_event *event)
 768 {
 769   vcl_locked_session_t *ep_vls, *vls;
 770   vcl_session_handle_t ep_sh, sh;
 771   int rv;
 772
 773   vls_table_rlock ();
 774   ep_vls = vls_get_and_lock (ep_vlsh);
 775   vls = vls_get_and_lock (vlsh);
 776   ep_sh = vls_to_sh (ep_vls);
 777   sh = vls_to_sh (vls);
 778
 779   if (PREDICT_FALSE (!vlsl->epoll_mp_check))
 780     vls_epoll_ctl_mp_checks (vls, op);
 781
 782   vls_table_runlock ();
 783
 784   rv = vppcom_epoll_ctl (ep_sh, op, sh, event);
 785
 786   vls_table_rlock ();
 787   ep_vls = vls_get (ep_vlsh);
 788   vls = vls_get (vlsh);
 789   vls_unlock (vls);
 790   vls_unlock (ep_vls);
 791   vls_table_runlock ();
 792   return rv;
 793 }
 794
 795 int
 796 vls_epoll_wait (vls_handle_t ep_vlsh, struct epoll_event *events,
 797                 int maxevents, double wait_for_time)
 798 {
 799   vcl_locked_session_t *vls;
 800   int rv;
 801
 802   if (!(vls = vls_get_w_dlock (ep_vlsh)))
 803     return VPPCOM_EBADFD;
 804   vls_mt_guard (0, VLS_MT_OP_XPOLL);
 805   rv = vppcom_epoll_wait (vls_to_sh_tu (vls), events, maxevents,
 806                           wait_for_time);
 807   vls_mt_unguard ();
 808   vls_get_and_unlock (ep_vlsh);
 809   return rv;
 810 }
 811
 812 static void
 813 vls_select_mp_checks (vcl_si_set * read_map)
 814 {
 815   vcl_locked_session_t *vls;
 816   vcl_worker_t *wrk;
 817   vcl_session_t *s;
 818   u32 si;
 819
 820   if (vcl_n_workers () <= 1)
 821     {
 822       vlsl->select_mp_check = 1;
 823       return;
 824     }
 825
 826   if (!read_map)
 827     return;
 828
 829   vlsl->select_mp_check = 1;
 830   wrk = vcl_worker_get_current ();
 831
 832   /* *INDENT-OFF* */
 833   clib_bitmap_foreach (si, read_map, ({
 834     s = vcl_session_get (wrk, si);
 835     if (s->session_state == STATE_LISTEN)
 836       {
 837         vls = vls_get (vls_session_index_to_vlsh (si));
 838         vls_mp_checks (vls, 1 /* is_add */);
 839       }
 840   }));
 841   /* *INDENT-ON* */
 842 }
 843
 844 int
 845 vls_select (int n_bits, vcl_si_set * read_map, vcl_si_set * write_map,
 846             vcl_si_set * except_map, double wait_for_time)
 847 {
 848   int rv;
 849
 850   vls_mt_guard (0, VLS_MT_OP_XPOLL);
 851   if (PREDICT_FALSE (!vlsl->select_mp_check))
 852     vls_select_mp_checks (read_map);
 853   rv = vppcom_select (n_bits, read_map, write_map, except_map, wait_for_time);
 854   vls_mt_unguard ();
 855   return rv;
 856 }
 857
 858 static void
 859 vls_unshare_vcl_worker_sessions (vcl_worker_t * wrk)
 860 {
 861   u32 current_wrk, is_current;
 862   vcl_locked_session_t *vls;
 863   vcl_session_t *s;
 864
 865   current_wrk = vcl_get_worker_index ();
 866   is_current = current_wrk == wrk->wrk_index;
 867   vls_table_wlock ();
 868
 869   /* *INDENT-OFF* */
 870   pool_foreach (s, wrk->sessions, ({
 871     vls = vls_get (vls_si_to_vlsh (s->session_index));
 872     if (vls && (is_current || vls_is_shared_by_wrk (vls, current_wrk)))
 873       vls_unshare_session (vls, wrk);
 874   }));
 875   /* *INDENT-ON* */
 876
 877   vls_table_wunlock ();
 878 }
 879
 880 static void
 881 vls_cleanup_vcl_worker (vcl_worker_t * wrk)
 882 {
 883   /* Unshare sessions and also cleanup worker since child may have
 884    * called _exit () and therefore vcl may not catch the event */
 885   vls_unshare_vcl_worker_sessions (wrk);
 886   vcl_worker_cleanup (wrk, 1 /* notify vpp */ );
 887 }
 888
 889 static void
 890 vls_cleanup_forked_child (vcl_worker_t * wrk, vcl_worker_t * child_wrk)
 891 {
 892   vcl_worker_t *sub_child;
 893   int tries = 0;
 894
 895   if (child_wrk->forked_child != ~0)
 896     {
 897       sub_child = vcl_worker_get_if_valid (child_wrk->forked_child);
 898       if (sub_child)
 899         {
 900           /* Wait a bit, maybe the process is going away */
 901           while (kill (sub_child->current_pid, 0) >= 0 && tries++ < 50)
 902             usleep (1e3);
 903           if (kill (sub_child->current_pid, 0) < 0)
 904             vls_cleanup_forked_child (child_wrk, sub_child);
 905         }
 906     }
 907   vls_cleanup_vcl_worker (child_wrk);
 908   VDBG (0, "Cleaned up forked child wrk %u", child_wrk->wrk_index);
 909   wrk->forked_child = ~0;
 910 }
 911
 912 static struct sigaction old_sa;
 913
 914 static void
 915 vls_intercept_sigchld_handler (int signum, siginfo_t * si, void *uc)
 916 {
 917   vcl_worker_t *wrk, *child_wrk;
 918
 919   if (vcl_get_worker_index () == ~0)
 920     return;
 921
 922   if (sigaction (SIGCHLD, &old_sa, 0))
 923     {
 924       VERR ("couldn't restore sigchld");
 925       exit (-1);
 926     }
 927
 928   wrk = vcl_worker_get_current ();
 929   if (wrk->forked_child == ~0)
 930     return;
 931
 932   child_wrk = vcl_worker_get_if_valid (wrk->forked_child);
 933   if (!child_wrk)
 934     goto done;
 935
 936   if (si && si->si_pid != child_wrk->current_pid)
 937     {
 938       VDBG (0, "unexpected child pid %u", si->si_pid);
 939       goto done;
 940     }
 941   vls_cleanup_forked_child (wrk, child_wrk);
 942
 943 done:
 944   if (old_sa.sa_flags & SA_SIGINFO)
 945     {
 946       void (*fn) (int, siginfo_t *, void *) = old_sa.sa_sigaction;
 947       fn (signum, si, uc);
 948     }
 949   else
 950     {
 951       void (*fn) (int) = old_sa.sa_handler;
 952       if (fn)
 953         fn (signum);
 954     }
 955 }
 956
 957 static void
 958 vls_incercept_sigchld ()
 959 {
 960   struct sigaction sa;
 961   clib_memset (&sa, 0, sizeof (sa));
 962   sa.sa_sigaction = vls_intercept_sigchld_handler;
 963   sa.sa_flags = SA_SIGINFO;
 964   if (sigaction (SIGCHLD, &sa, &old_sa))
 965     {
 966       VERR ("couldn't intercept sigchld");
 967       exit (-1);
 968     }
 969 }
 970
 971 static void
 972 vls_app_pre_fork (void)
 973 {
 974   vls_incercept_sigchld ();
 975   vcl_flush_mq_events ();
 976 }
 977
 978 static void
 979 vls_app_fork_child_handler (void)
 980 {
 981   vcl_worker_t *parent_wrk;
 982   int rv, parent_wrk_index;
 983   u8 *child_name;
 984
 985   parent_wrk_index = vcl_get_worker_index ();
 986   VDBG (0, "initializing forked child %u with parent wrk %u", getpid (),
 987         parent_wrk_index);
 988
 989   /*
 990    * Allocate worker
 991    */
 992   vcl_set_worker_index (~0);
 993   if (!vcl_worker_alloc_and_init ())
 994     VERR ("couldn't allocate new worker");
 995
 996   /*
 997    * Attach to binary api
 998    */
 999   child_name = format (0, "%v-child-%u%c", vcm->app_name, getpid (), 0);
1000   vcl_cleanup_bapi ();
1001   vppcom_api_hookup ();
1002   vcm->app_state = STATE_APP_START;
1003   rv = vppcom_connect_to_vpp ((char *) child_name);
1004   vec_free (child_name);
1005   if (rv)
1006     {
1007       VERR ("couldn't connect to VPP!");
1008       return;
1009     }
1010
1011   /*
1012    * Register worker with vpp and share sessions
1013    */
1014   vcl_worker_register_with_vpp ();
1015   parent_wrk = vcl_worker_get (parent_wrk_index);
1016   vls_worker_copy_on_fork (parent_wrk);
1017   parent_wrk->forked_child = vcl_get_worker_index ();
1018
1019   /* Reset number of threads and set wrk index */
1020   vlsl->vls_mt_n_threads = 0;
1021   vlsl->vls_wrk_index = vcl_get_worker_index ();
1022   vlsl->select_mp_check = 0;
1023   vlsl->epoll_mp_check = 0;
1024   vls_mt_locks_init ();
1025
1026   VDBG (0, "forked child main worker initialized");
1027   vcm->forking = 0;
1028 }
1029
1030 static void
1031 vls_app_fork_parent_handler (void)
1032 {
1033   vcm->forking = 1;
1034   while (vcm->forking)
1035     ;
1036 }
1037
1038 void
1039 vls_app_exit (void)
1040 {
1041   /* Unshare the sessions. VCL will clean up the worker */
1042   vls_unshare_vcl_worker_sessions (vcl_worker_get_current ());
1043 }
1044
1045 int
1046 vls_app_create (char *app_name)
1047 {
1048   int rv;
1049
1050   if ((rv = vppcom_app_create (app_name)))
1051     return rv;
1052   vlsm = clib_mem_alloc (sizeof (vls_main_t));
1053   clib_memset (vlsm, 0, sizeof (*vlsm));
1054   clib_rwlock_init (&vlsm->vls_table_lock);
1055   pthread_atfork (vls_app_pre_fork, vls_app_fork_parent_handler,
1056                   vls_app_fork_child_handler);
1057   atexit (vls_app_exit);
1058   vlsl->vls_wrk_index = vcl_get_worker_index ();
1059   vls_mt_locks_init ();
1060   return VPPCOM_OK;
1061 }
1062
1063 /*
1064  * fd.io coding-style-patch-verification: ON
1065  *
1066  * Local Variables:
1067  * eval: (c-set-style "gnu")
1068  * End:
1069  */