src/vcl/vcl_private.c

   1 /*
   2  * Copyright (c) 2018-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_private.h>
  17
  18 static pthread_key_t vcl_worker_stop_key;
  19
  20 vcl_mq_evt_conn_t *
  21 vcl_mq_evt_conn_alloc (vcl_worker_t * wrk)
  22 {
  23   vcl_mq_evt_conn_t *mqc;
  24   pool_get (wrk->mq_evt_conns, mqc);
  25   memset (mqc, 0, sizeof (*mqc));
  26   return mqc;
  27 }
  28
  29 u32
  30 vcl_mq_evt_conn_index (vcl_worker_t * wrk, vcl_mq_evt_conn_t * mqc)
  31 {
  32   return (mqc - wrk->mq_evt_conns);
  33 }
  34
  35 vcl_mq_evt_conn_t *
  36 vcl_mq_evt_conn_get (vcl_worker_t * wrk, u32 mq_conn_idx)
  37 {
  38   return pool_elt_at_index (wrk->mq_evt_conns, mq_conn_idx);
  39 }
  40
  41 int
  42 vcl_mq_epoll_add_evfd (vcl_worker_t * wrk, svm_msg_q_t * mq)
  43 {
  44   struct epoll_event e = { 0 };
  45   vcl_mq_evt_conn_t *mqc;
  46   u32 mqc_index;
  47   int mq_fd;
  48
  49   mq_fd = svm_msg_q_get_eventfd (mq);
  50
  51   if (wrk->mqs_epfd < 0 || mq_fd == -1)
  52     return -1;
  53
  54   mqc = vcl_mq_evt_conn_alloc (wrk);
  55   mqc_index = vcl_mq_evt_conn_index (wrk, mqc);
  56   mqc->mq_fd = mq_fd;
  57   mqc->mq = mq;
  58
  59   e.events = EPOLLIN;
  60   e.data.u32 = mqc_index;
  61   if (epoll_ctl (wrk->mqs_epfd, EPOLL_CTL_ADD, mq_fd, &e) < 0)
  62     {
  63       VDBG (0, "failed to add mq eventfd to mq epoll fd");
  64       return -1;
  65     }
  66
  67   return mqc_index;
  68 }
  69
  70 int
  71 vcl_mq_epoll_del_evfd (vcl_worker_t * wrk, u32 mqc_index)
  72 {
  73   vcl_mq_evt_conn_t *mqc;
  74
  75   if (wrk->mqs_epfd || mqc_index == ~0)
  76     return -1;
  77
  78   mqc = vcl_mq_evt_conn_get (wrk, mqc_index);
  79   if (epoll_ctl (wrk->mqs_epfd, EPOLL_CTL_DEL, mqc->mq_fd, 0) < 0)
  80     {
  81       VDBG (0, "failed to del mq eventfd to mq epoll fd");
  82       return -1;
  83     }
  84   return 0;
  85 }
  86
  87 static vcl_worker_t *
  88 vcl_worker_alloc (void)
  89 {
  90   vcl_worker_t *wrk;
  91   pool_get (vcm->workers, wrk);
  92   memset (wrk, 0, sizeof (*wrk));
  93   wrk->wrk_index = wrk - vcm->workers;
  94   wrk->forked_child = ~0;
  95   return wrk;
  96 }
  97
  98 static void
  99 vcl_worker_free (vcl_worker_t * wrk)
 100 {
 101   pool_put (vcm->workers, wrk);
 102 }
 103
 104 int
 105 vcl_api_app_worker_add (void)
 106 {
 107   if (vcm->cfg.vpp_app_socket_api)
 108     return vcl_sapi_app_worker_add ();
 109
 110   return vcl_bapi_app_worker_add ();
 111 }
 112
 113 void
 114 vcl_api_app_worker_del (vcl_worker_t * wrk)
 115 {
 116   if (vcm->cfg.vpp_app_socket_api)
 117     return vcl_sapi_app_worker_del (wrk);
 118
 119   vcl_bapi_app_worker_del (wrk);
 120 }
 121
 122 void
 123 vcl_worker_cleanup (vcl_worker_t * wrk, u8 notify_vpp)
 124 {
 125   clib_spinlock_lock (&vcm->workers_lock);
 126   if (notify_vpp)
 127     vcl_api_app_worker_del (wrk);
 128
 129   if (wrk->mqs_epfd > 0)
 130     close (wrk->mqs_epfd);
 131   pool_free (wrk->sessions);
 132   pool_free (wrk->mq_evt_conns);
 133   hash_free (wrk->session_index_by_vpp_handles);
 134   vec_free (wrk->mq_events);
 135   vec_free (wrk->mq_msg_vector);
 136   vec_free (wrk->unhandled_evts_vector);
 137   vec_free (wrk->pending_session_wrk_updates);
 138   clib_bitmap_free (wrk->rd_bitmap);
 139   clib_bitmap_free (wrk->wr_bitmap);
 140   clib_bitmap_free (wrk->ex_bitmap);
 141   vcl_worker_free (wrk);
 142   clib_spinlock_unlock (&vcm->workers_lock);
 143 }
 144
 145 static void
 146 vcl_worker_cleanup_cb (void *arg)
 147 {
 148   vcl_worker_t *wrk;
 149   u32 wrk_index;
 150
 151   wrk_index = vcl_get_worker_index ();
 152   wrk = vcl_worker_get_if_valid (wrk_index);
 153   if (!wrk)
 154     return;
 155
 156   vcl_worker_cleanup (wrk, 1 /* notify vpp */ );
 157   vcl_set_worker_index (~0);
 158   VDBG (0, "cleaned up worker %u", wrk_index);
 159 }
 160
 161 vcl_worker_t *
 162 vcl_worker_alloc_and_init ()
 163 {
 164   vcl_worker_t *wrk;
 165
 166   /* This was initialized already */
 167   if (vcl_get_worker_index () != ~0)
 168     return 0;
 169
 170   /* Use separate heap map entry for worker */
 171   clib_mem_set_thread_index ();
 172
 173   if (pool_elts (vcm->workers) == vcm->cfg.max_workers)
 174     {
 175       VDBG (0, "max-workers %u limit reached", vcm->cfg.max_workers);
 176       return 0;
 177     }
 178
 179   clib_spinlock_lock (&vcm->workers_lock);
 180   wrk = vcl_worker_alloc ();
 181   vcl_set_worker_index (wrk->wrk_index);
 182   wrk->thread_id = pthread_self ();
 183   wrk->current_pid = getpid ();
 184
 185   wrk->mqs_epfd = -1;
 186   if (vcm->cfg.use_mq_eventfd)
 187     {
 188       wrk->vcl_needs_real_epoll = 1;
 189       wrk->mqs_epfd = epoll_create (1);
 190       wrk->vcl_needs_real_epoll = 0;
 191       if (wrk->mqs_epfd < 0)
 192         {
 193           clib_unix_warning ("epoll_create() returned");
 194           goto done;
 195         }
 196     }
 197
 198   wrk->ep_lt_current = VCL_INVALID_SESSION_INDEX;
 199   wrk->session_index_by_vpp_handles = hash_create (0, sizeof (uword));
 200   clib_time_init (&wrk->clib_time);
 201   vec_validate (wrk->mq_events, 64);
 202   vec_validate (wrk->mq_msg_vector, 128);
 203   vec_reset_length (wrk->mq_msg_vector);
 204   vec_validate (wrk->unhandled_evts_vector, 128);
 205   vec_reset_length (wrk->unhandled_evts_vector);
 206   clib_spinlock_unlock (&vcm->workers_lock);
 207
 208 done:
 209   return wrk;
 210 }
 211
 212 int
 213 vcl_worker_register_with_vpp (void)
 214 {
 215   vcl_worker_t *wrk = vcl_worker_get_current ();
 216
 217   clib_spinlock_lock (&vcm->workers_lock);
 218
 219   if (vcl_api_app_worker_add ())
 220     {
 221       VDBG (0, "failed to add worker to vpp");
 222       clib_spinlock_unlock (&vcm->workers_lock);
 223       return -1;
 224     }
 225   if (pthread_key_create (&vcl_worker_stop_key, vcl_worker_cleanup_cb))
 226     VDBG (0, "failed to add pthread cleanup function");
 227   if (pthread_setspecific (vcl_worker_stop_key, &wrk->thread_id))
 228     VDBG (0, "failed to setup key value");
 229
 230   clib_spinlock_unlock (&vcm->workers_lock);
 231
 232   VDBG (0, "added worker %u", wrk->wrk_index);
 233   return 0;
 234 }
 235
 236 svm_msg_q_t *
 237 vcl_worker_ctrl_mq (vcl_worker_t * wrk)
 238 {
 239   return wrk->ctrl_mq;
 240 }
 241
 242 int
 243 vcl_session_read_ready (vcl_session_t * s)
 244 {
 245   if (PREDICT_FALSE (s->flags & VCL_SESSION_F_IS_VEP))
 246     {
 247       VDBG (0, "ERROR: session %u: cannot read from an epoll session!",
 248             s->session_index);
 249       return VPPCOM_EBADFD;
 250     }
 251
 252   if (vcl_session_is_open (s))
 253     {
 254       if (vcl_session_is_ct (s))
 255         return svm_fifo_max_dequeue_cons (s->ct_rx_fifo);
 256
 257       if (s->is_dgram)
 258         {
 259           session_dgram_pre_hdr_t ph;
 260           u32 max_deq;
 261
 262           max_deq = svm_fifo_max_dequeue_cons (s->rx_fifo);
 263           if (max_deq <= SESSION_CONN_HDR_LEN)
 264             return 0;
 265           if (svm_fifo_peek (s->rx_fifo, 0, sizeof (ph), (u8 *) & ph) < 0)
 266             return 0;
 267           if (ph.data_length + SESSION_CONN_HDR_LEN > max_deq)
 268             return 0;
 269
 270           return ph.data_length;
 271         }
 272
 273       return svm_fifo_max_dequeue_cons (s->rx_fifo);
 274     }
 275   else if (s->session_state == VCL_STATE_LISTEN)
 276     {
 277       return clib_fifo_elts (s->accept_evts_fifo);
 278     }
 279   else
 280     {
 281       return (s->session_state == VCL_STATE_DISCONNECT) ?
 282         VPPCOM_ECONNRESET : VPPCOM_ENOTCONN;
 283     }
 284 }
 285
 286 int
 287 vcl_session_write_ready (vcl_session_t * s)
 288 {
 289   if (PREDICT_FALSE (s->flags & VCL_SESSION_F_IS_VEP))
 290     {
 291       VDBG (0, "session %u [0x%llx]: cannot write to an epoll session!",
 292             s->session_index, s->vpp_handle);
 293       return VPPCOM_EBADFD;
 294     }
 295
 296   if (vcl_session_is_open (s))
 297     {
 298       if (vcl_session_is_ct (s))
 299         return svm_fifo_max_enqueue_prod (s->ct_tx_fifo);
 300
 301       if (s->is_dgram)
 302         {
 303           u32 max_enq = svm_fifo_max_enqueue_prod (s->tx_fifo);
 304
 305           if (max_enq <= sizeof (session_dgram_hdr_t))
 306             return 0;
 307           return max_enq - sizeof (session_dgram_hdr_t);
 308         }
 309
 310       return svm_fifo_max_enqueue_prod (s->tx_fifo);
 311     }
 312   else if (s->session_state == VCL_STATE_LISTEN)
 313     {
 314       if (s->tx_fifo)
 315         return svm_fifo_max_enqueue_prod (s->tx_fifo);
 316       else
 317         return VPPCOM_EBADFD;
 318     }
 319   else if (s->session_state == VCL_STATE_UPDATED)
 320     {
 321       return 0;
 322     }
 323   else
 324     {
 325       return (s->session_state == VCL_STATE_DISCONNECT) ?
 326         VPPCOM_ECONNRESET : VPPCOM_ENOTCONN;
 327     }
 328 }
 329
 330 int
 331 vcl_session_alloc_ext_cfg (vcl_session_t *s,
 332                            transport_endpt_ext_cfg_type_t type, u32 len)
 333 {
 334   if (s->ext_config)
 335     return -1;
 336
 337   s->ext_config = clib_mem_alloc (len);
 338   clib_memset (s->ext_config, 0, len);
 339   s->ext_config->len = len;
 340   s->ext_config->type = type;
 341
 342   return 0;
 343 }
 344
 345 int
 346 vcl_segment_attach (u64 segment_handle, char *name, ssvm_segment_type_t type,
 347                     int fd)
 348 {
 349   fifo_segment_create_args_t _a, *a = &_a;
 350   int rv;
 351
 352   memset (a, 0, sizeof (*a));
 353   a->segment_name = name;
 354   a->segment_type = type;
 355
 356   if (type == SSVM_SEGMENT_MEMFD)
 357     a->memfd_fd = fd;
 358
 359   clib_rwlock_writer_lock (&vcm->segment_table_lock);
 360
 361   if ((rv = fifo_segment_attach (&vcm->segment_main, a)))
 362     {
 363       clib_warning ("svm_fifo_segment_attach ('%s') failed", name);
 364       return rv;
 365     }
 366   hash_set (vcm->segment_table, segment_handle, a->new_segment_indices[0]);
 367
 368   clib_rwlock_writer_unlock (&vcm->segment_table_lock);
 369
 370   vec_free (a->new_segment_indices);
 371   return 0;
 372 }
 373
 374 u32
 375 vcl_segment_table_lookup (u64 segment_handle)
 376 {
 377   uword *seg_indexp;
 378
 379   clib_rwlock_reader_lock (&vcm->segment_table_lock);
 380   seg_indexp = hash_get (vcm->segment_table, segment_handle);
 381   clib_rwlock_reader_unlock (&vcm->segment_table_lock);
 382
 383   if (!seg_indexp)
 384     return VCL_INVALID_SEGMENT_INDEX;
 385   return ((u32) * seg_indexp);
 386 }
 387
 388 void
 389 vcl_segment_detach (u64 segment_handle)
 390 {
 391   fifo_segment_main_t *sm = &vcm->segment_main;
 392   fifo_segment_t *segment;
 393   u32 segment_index;
 394
 395   segment_index = vcl_segment_table_lookup (segment_handle);
 396   if (segment_index == (u32) ~ 0)
 397     return;
 398
 399   clib_rwlock_writer_lock (&vcm->segment_table_lock);
 400
 401   segment = fifo_segment_get_segment (sm, segment_index);
 402   fifo_segment_delete (sm, segment);
 403   hash_unset (vcm->segment_table, segment_handle);
 404
 405   clib_rwlock_writer_unlock (&vcm->segment_table_lock);
 406
 407   VDBG (0, "detached segment %u handle %u", segment_index, segment_handle);
 408 }
 409
 410 int
 411 vcl_segment_attach_session (uword segment_handle, uword rxf_offset,
 412                             uword txf_offset, uword mq_offset, u8 is_ct,
 413                             vcl_session_t *s)
 414 {
 415   u32 fs_index, eqs_index;
 416   svm_fifo_t *rxf, *txf;
 417   fifo_segment_t *fs;
 418   u64 eqs_handle;
 419
 420   fs_index = vcl_segment_table_lookup (segment_handle);
 421   if (fs_index == VCL_INVALID_SEGMENT_INDEX)
 422     {
 423       VDBG (0, "ERROR: segment for session %u is not mounted!",
 424             s->session_index);
 425       return -1;
 426     }
 427
 428   if (!is_ct && mq_offset != (uword) ~0)
 429     {
 430       eqs_handle = vcl_vpp_worker_segment_handle (0);
 431       eqs_index = vcl_segment_table_lookup (eqs_handle);
 432       ASSERT (eqs_index != VCL_INVALID_SEGMENT_INDEX);
 433     }
 434
 435   clib_rwlock_reader_lock (&vcm->segment_table_lock);
 436
 437   fs = fifo_segment_get_segment (&vcm->segment_main, fs_index);
 438   rxf = fifo_segment_alloc_fifo_w_offset (fs, rxf_offset);
 439   txf = fifo_segment_alloc_fifo_w_offset (fs, txf_offset);
 440   rxf->segment_index = fs_index;
 441   txf->segment_index = fs_index;
 442
 443   if (!is_ct && mq_offset != (uword) ~0)
 444     {
 445       fs = fifo_segment_get_segment (&vcm->segment_main, eqs_index);
 446       s->vpp_evt_q =
 447         fifo_segment_msg_q_attach (fs, mq_offset, rxf->shr->slice_index);
 448     }
 449
 450   clib_rwlock_reader_unlock (&vcm->segment_table_lock);
 451
 452   if (!is_ct)
 453     {
 454       rxf->shr->client_session_index = s->session_index;
 455       txf->shr->client_session_index = s->session_index;
 456       rxf->client_thread_index = vcl_get_worker_index ();
 457       txf->client_thread_index = vcl_get_worker_index ();
 458       s->rx_fifo = rxf;
 459       s->tx_fifo = txf;
 460     }
 461   else
 462     {
 463       s->ct_rx_fifo = rxf;
 464       s->ct_tx_fifo = txf;
 465     }
 466
 467   return 0;
 468 }
 469
 470 void
 471 vcl_session_detach_fifos (vcl_session_t *s)
 472 {
 473   fifo_segment_t *fs;
 474
 475   if (!s->rx_fifo)
 476     return;
 477
 478   clib_rwlock_reader_lock (&vcm->segment_table_lock);
 479
 480   fs = fifo_segment_get_segment_if_valid (&vcm->segment_main,
 481                                           s->rx_fifo->segment_index);
 482   if (!fs)
 483     goto done;
 484
 485   fifo_segment_free_client_fifo (fs, s->rx_fifo);
 486   fifo_segment_free_client_fifo (fs, s->tx_fifo);
 487   if (s->ct_rx_fifo)
 488     {
 489       fs = fifo_segment_get_segment_if_valid (&vcm->segment_main,
 490                                               s->ct_rx_fifo->segment_index);
 491       if (!fs)
 492         goto done;
 493
 494       fifo_segment_free_client_fifo (fs, s->ct_rx_fifo);
 495       fifo_segment_free_client_fifo (fs, s->ct_tx_fifo);
 496     }
 497
 498 done:
 499   clib_rwlock_reader_unlock (&vcm->segment_table_lock);
 500 }
 501
 502 int
 503 vcl_segment_attach_mq (uword segment_handle, uword mq_offset, u32 mq_index,
 504                        svm_msg_q_t **mq)
 505 {
 506   fifo_segment_t *fs;
 507   u32 fs_index;
 508
 509   fs_index = vcl_segment_table_lookup (segment_handle);
 510   if (fs_index == VCL_INVALID_SEGMENT_INDEX)
 511     {
 512       VDBG (0, "ERROR: mq segment %lx for is not attached!", segment_handle);
 513       return -1;
 514     }
 515
 516   clib_rwlock_reader_lock (&vcm->segment_table_lock);
 517
 518   fs = fifo_segment_get_segment (&vcm->segment_main, fs_index);
 519   *mq = fifo_segment_msg_q_attach (fs, mq_offset, mq_index);
 520
 521   clib_rwlock_reader_unlock (&vcm->segment_table_lock);
 522
 523   return 0;
 524 }
 525
 526 int
 527 vcl_segment_discover_mqs (uword segment_handle, int *fds, u32 n_fds)
 528 {
 529   fifo_segment_t *fs;
 530   u32 fs_index;
 531
 532   fs_index = vcl_segment_table_lookup (segment_handle);
 533   if (fs_index == VCL_INVALID_SEGMENT_INDEX)
 534     {
 535       VDBG (0, "ERROR: mq segment %lx for is not attached!", segment_handle);
 536       return -1;
 537     }
 538
 539   clib_rwlock_reader_lock (&vcm->segment_table_lock);
 540
 541   fs = fifo_segment_get_segment (&vcm->segment_main, fs_index);
 542   fifo_segment_msg_qs_discover (fs, fds, n_fds);
 543
 544   clib_rwlock_reader_unlock (&vcm->segment_table_lock);
 545
 546   return 0;
 547 }
 548
 549 svm_fifo_chunk_t *
 550 vcl_segment_alloc_chunk (uword segment_handle, u32 slice_index, u32 size,
 551                          uword *offset)
 552 {
 553   svm_fifo_chunk_t *c;
 554   fifo_segment_t *fs;
 555   u32 fs_index;
 556
 557   fs_index = vcl_segment_table_lookup (segment_handle);
 558   if (fs_index == VCL_INVALID_SEGMENT_INDEX)
 559     {
 560       VDBG (0, "ERROR: mq segment %lx for is not attached!", segment_handle);
 561       return 0;
 562     }
 563
 564   clib_rwlock_reader_lock (&vcm->segment_table_lock);
 565
 566   fs = fifo_segment_get_segment (&vcm->segment_main, fs_index);
 567   c = fifo_segment_alloc_chunk_w_slice (fs, slice_index, size);
 568   *offset = fifo_segment_chunk_offset (fs, c);
 569
 570   clib_rwlock_reader_unlock (&vcm->segment_table_lock);
 571
 572   return c;
 573 }
 574
 575 int
 576 vcl_session_share_fifos (vcl_session_t *s, svm_fifo_t *rxf, svm_fifo_t *txf)
 577 {
 578   vcl_worker_t *wrk = vcl_worker_get_current ();
 579   fifo_segment_t *fs;
 580
 581   clib_rwlock_reader_lock (&vcm->segment_table_lock);
 582
 583   fs = fifo_segment_get_segment (&vcm->segment_main, rxf->segment_index);
 584   s->rx_fifo = fifo_segment_duplicate_fifo (fs, rxf);
 585   s->tx_fifo = fifo_segment_duplicate_fifo (fs, txf);
 586
 587   clib_rwlock_reader_unlock (&vcm->segment_table_lock);
 588
 589   svm_fifo_add_subscriber (s->rx_fifo, wrk->vpp_wrk_index);
 590   svm_fifo_add_subscriber (s->tx_fifo, wrk->vpp_wrk_index);
 591
 592   return 0;
 593 }
 594
 595 /*
 596  * fd.io coding-style-patch-verification: ON
 597  *
 598  * Local Variables:
 599  * eval: (c-set-style "gnu")
 600  * End:
 601  */