src/vcl/vcl_private.c

   1 /*
   2  * Copyright (c) 2018 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 pthread_key_t vcl_worker_stop_key;
  19
  20 static const char *
  21 vppcom_app_state_str (app_state_t state)
  22 {
  23   char *st;
  24
  25   switch (state)
  26     {
  27     case STATE_APP_START:
  28       st = "STATE_APP_START";
  29       break;
  30
  31     case STATE_APP_CONN_VPP:
  32       st = "STATE_APP_CONN_VPP";
  33       break;
  34
  35     case STATE_APP_ENABLED:
  36       st = "STATE_APP_ENABLED";
  37       break;
  38
  39     case STATE_APP_ATTACHED:
  40       st = "STATE_APP_ATTACHED";
  41       break;
  42
  43     default:
  44       st = "UNKNOWN_APP_STATE";
  45       break;
  46     }
  47
  48   return st;
  49 }
  50
  51 int
  52 vcl_wait_for_app_state_change (app_state_t app_state)
  53 {
  54   vcl_worker_t *wrk = vcl_worker_get_current ();
  55   f64 timeout = clib_time_now (&wrk->clib_time) + vcm->cfg.app_timeout;
  56
  57   while (clib_time_now (&wrk->clib_time) < timeout)
  58     {
  59       if (vcm->app_state == app_state)
  60         return VPPCOM_OK;
  61       if (vcm->app_state == STATE_APP_FAILED)
  62         return VPPCOM_ECONNABORTED;
  63     }
  64   VDBG (0, "VCL<%d>: timeout waiting for state %s (%d)", getpid (),
  65         vppcom_app_state_str (app_state), app_state);
  66   vcl_evt (VCL_EVT_SESSION_TIMEOUT, vcm, app_state);
  67
  68   return VPPCOM_ETIMEDOUT;
  69 }
  70
  71 vcl_cut_through_registration_t *
  72 vcl_ct_registration_lock_and_alloc (vcl_worker_t * wrk)
  73 {
  74   vcl_cut_through_registration_t *cr;
  75   clib_spinlock_lock (&wrk->ct_registration_lock);
  76   pool_get (wrk->cut_through_registrations, cr);
  77   memset (cr, 0, sizeof (*cr));
  78   cr->epoll_evt_conn_index = -1;
  79   return cr;
  80 }
  81
  82 u32
  83 vcl_ct_registration_index (vcl_worker_t * wrk,
  84                            vcl_cut_through_registration_t * ctr)
  85 {
  86   return (ctr - wrk->cut_through_registrations);
  87 }
  88
  89 void
  90 vcl_ct_registration_lock (vcl_worker_t * wrk)
  91 {
  92   clib_spinlock_lock (&wrk->ct_registration_lock);
  93 }
  94
  95 void
  96 vcl_ct_registration_unlock (vcl_worker_t * wrk)
  97 {
  98   clib_spinlock_unlock (&wrk->ct_registration_lock);
  99 }
 100
 101 vcl_cut_through_registration_t *
 102 vcl_ct_registration_get (vcl_worker_t * wrk, u32 ctr_index)
 103 {
 104   if (pool_is_free_index (wrk->cut_through_registrations, ctr_index))
 105     return 0;
 106   return pool_elt_at_index (wrk->cut_through_registrations, ctr_index);
 107 }
 108
 109 vcl_cut_through_registration_t *
 110 vcl_ct_registration_lock_and_lookup (vcl_worker_t * wrk, uword mq_addr)
 111 {
 112   uword *p;
 113   clib_spinlock_lock (&wrk->ct_registration_lock);
 114   p = hash_get (wrk->ct_registration_by_mq, mq_addr);
 115   if (!p)
 116     return 0;
 117   return vcl_ct_registration_get (wrk, p[0]);
 118 }
 119
 120 void
 121 vcl_ct_registration_lookup_add (vcl_worker_t * wrk, uword mq_addr,
 122                                 u32 ctr_index)
 123 {
 124   hash_set (wrk->ct_registration_by_mq, mq_addr, ctr_index);
 125 }
 126
 127 void
 128 vcl_ct_registration_lookup_del (vcl_worker_t * wrk, uword mq_addr)
 129 {
 130   hash_unset (wrk->ct_registration_by_mq, mq_addr);
 131 }
 132
 133 void
 134 vcl_ct_registration_del (vcl_worker_t * wrk,
 135                          vcl_cut_through_registration_t * ctr)
 136 {
 137   pool_put (wrk->cut_through_registrations, ctr);
 138 }
 139
 140 vcl_mq_evt_conn_t *
 141 vcl_mq_evt_conn_alloc (vcl_worker_t * wrk)
 142 {
 143   vcl_mq_evt_conn_t *mqc;
 144   pool_get (wrk->mq_evt_conns, mqc);
 145   memset (mqc, 0, sizeof (*mqc));
 146   return mqc;
 147 }
 148
 149 u32
 150 vcl_mq_evt_conn_index (vcl_worker_t * wrk, vcl_mq_evt_conn_t * mqc)
 151 {
 152   return (mqc - wrk->mq_evt_conns);
 153 }
 154
 155 vcl_mq_evt_conn_t *
 156 vcl_mq_evt_conn_get (vcl_worker_t * wrk, u32 mq_conn_idx)
 157 {
 158   return pool_elt_at_index (wrk->mq_evt_conns, mq_conn_idx);
 159 }
 160
 161 int
 162 vcl_mq_epoll_add_evfd (vcl_worker_t * wrk, svm_msg_q_t * mq)
 163 {
 164   struct epoll_event e = { 0 };
 165   vcl_mq_evt_conn_t *mqc;
 166   u32 mqc_index;
 167   int mq_fd;
 168
 169   mq_fd = svm_msg_q_get_consumer_eventfd (mq);
 170
 171   if (wrk->mqs_epfd < 0 || mq_fd == -1)
 172     return -1;
 173
 174   mqc = vcl_mq_evt_conn_alloc (wrk);
 175   mqc_index = vcl_mq_evt_conn_index (wrk, mqc);
 176   mqc->mq_fd = mq_fd;
 177   mqc->mq = mq;
 178
 179   e.events = EPOLLIN;
 180   e.data.u32 = mqc_index;
 181   if (epoll_ctl (wrk->mqs_epfd, EPOLL_CTL_ADD, mq_fd, &e) < 0)
 182     {
 183       clib_warning ("failed to add mq eventfd to mq epoll fd");
 184       return -1;
 185     }
 186
 187   return mqc_index;
 188 }
 189
 190 int
 191 vcl_mq_epoll_del_evfd (vcl_worker_t * wrk, u32 mqc_index)
 192 {
 193   vcl_mq_evt_conn_t *mqc;
 194
 195   if (wrk->mqs_epfd || mqc_index == ~0)
 196     return -1;
 197
 198   mqc = vcl_mq_evt_conn_get (wrk, mqc_index);
 199   if (epoll_ctl (wrk->mqs_epfd, EPOLL_CTL_DEL, mqc->mq_fd, 0) < 0)
 200     {
 201       clib_warning ("failed to del mq eventfd to mq epoll fd");
 202       return -1;
 203     }
 204   return 0;
 205 }
 206
 207 static vcl_worker_t *
 208 vcl_worker_alloc (void)
 209 {
 210   vcl_worker_t *wrk;
 211   pool_get (vcm->workers, wrk);
 212   memset (wrk, 0, sizeof (*wrk));
 213   wrk->wrk_index = wrk - vcm->workers;
 214   return wrk;
 215 }
 216
 217 static void
 218 vcl_worker_free (vcl_worker_t * wrk)
 219 {
 220   pool_put (vcm->workers, wrk);
 221 }
 222
 223 static void
 224 vcl_worker_cleanup (void *arg)
 225 {
 226   vcl_worker_t *wrk = vcl_worker_get_current ();
 227   VDBG (0, "cleaning up worker %u", wrk->wrk_index);
 228   vcl_send_app_worker_add_del (0 /* is_add */ );
 229   close (wrk->mqs_epfd);
 230   hash_free (wrk->session_index_by_vpp_handles);
 231   hash_free (wrk->ct_registration_by_mq);
 232   clib_spinlock_free (&wrk->ct_registration_lock);
 233   vec_free (wrk->mq_events);
 234   vec_free (wrk->mq_msg_vector);
 235   vcl_set_worker_index (~0);
 236   vcl_worker_free (wrk);
 237 }
 238
 239 vcl_worker_t *
 240 vcl_worker_alloc_and_init ()
 241 {
 242   vcl_worker_t *wrk;
 243
 244   /* This was initialized already */
 245   if (vcl_get_worker_index () != ~0)
 246     return 0;
 247
 248   if (pool_elts (vcm->workers) == vcm->cfg.max_workers)
 249     {
 250       VDBG (0, "max-workers %u limit reached", vcm->cfg.max_workers);
 251       return 0;
 252     }
 253
 254   clib_spinlock_lock (&vcm->workers_lock);
 255   wrk = vcl_worker_alloc ();
 256   vcl_set_worker_index (wrk->wrk_index);
 257
 258   wrk->mqs_epfd = -1;
 259   if (vcm->cfg.use_mq_eventfd)
 260     {
 261       wrk->mqs_epfd = epoll_create (1);
 262       if (wrk->mqs_epfd < 0)
 263         {
 264           clib_unix_warning ("epoll_create() returned");
 265           return 0;
 266         }
 267     }
 268
 269   wrk->session_index_by_vpp_handles = hash_create (0, sizeof (uword));
 270   wrk->ct_registration_by_mq = hash_create (0, sizeof (uword));
 271   clib_spinlock_init (&wrk->ct_registration_lock);
 272   clib_time_init (&wrk->clib_time);
 273   vec_validate (wrk->mq_events, 64);
 274   vec_validate (wrk->mq_msg_vector, 128);
 275   vec_reset_length (wrk->mq_msg_vector);
 276
 277   if (wrk->wrk_index == 0)
 278     {
 279       clib_spinlock_unlock (&vcm->workers_lock);
 280       return wrk;
 281     }
 282
 283   vcm->app_state = STATE_APP_ADDING_WORKER;
 284   vcl_send_app_worker_add_del (1 /* is_add */ );
 285   if (vcl_wait_for_app_state_change (STATE_APP_READY))
 286     {
 287       clib_warning ("failed to add worker to vpp");
 288       return 0;
 289     }
 290
 291   if (pthread_key_create (&vcl_worker_stop_key, vcl_worker_cleanup))
 292     clib_warning ("failed to add pthread cleanup function");
 293
 294   clib_spinlock_unlock (&vcm->workers_lock);
 295
 296   VDBG (0, "added worker %u", wrk->wrk_index);
 297
 298   return wrk;
 299 }
 300
 301 /*
 302  * fd.io coding-style-patch-verification: ON
 303  *
 304  * Local Variables:
 305  * eval: (c-set-style "gnu")
 306  * End:
 307  */