src/vcl/vcl_bapi.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 #include <vlibmemory/api.h>
  18
  19 #include <vnet/format_fns.h>
  20 #include <vnet/session/session.api_enum.h>
  21 #include <vnet/session/session.api_types.h>
  22
  23 #define REPLY_MSG_ID_BASE msg_id_base
  24
  25 static u16 msg_id_base;
  26
  27 static u8 *
  28 format_api_error (u8 * s, va_list * args)
  29 {
  30   i32 error = va_arg (*args, u32);
  31   uword *p;
  32
  33   p = hash_get (vcm->error_string_by_error_number, -error);
  34
  35   if (p)
  36     s = format (s, "%s (%d)", p[0], error);
  37   else
  38     s = format (s, "%d", error);
  39   return s;
  40 }
  41
  42 static void
  43   vl_api_session_enable_disable_reply_t_handler
  44   (vl_api_session_enable_disable_reply_t * mp)
  45 {
  46   vcl_worker_t *wrk = vcl_worker_get (0);
  47
  48   if (mp->retval)
  49     {
  50       clib_warning ("VCL<%d>: session_enable_disable failed: %U", getpid (),
  51                     format_api_error, ntohl (mp->retval));
  52     }
  53   else
  54     wrk->bapi_app_state = STATE_APP_ENABLED;
  55 }
  56
  57 static void
  58 vl_api_app_attach_reply_t_handler (vl_api_app_attach_reply_t * mp)
  59 {
  60   vcl_worker_t *wrk = vcl_worker_get (0);
  61   u64 segment_handle;
  62   int *fds = 0, i, rv;
  63   u32 n_fds = 0;
  64   char *segment_name = 0;
  65
  66   if (mp->retval)
  67     {
  68       VERR ("attach failed: %U", format_api_error, ntohl (mp->retval));
  69       goto failed;
  70     }
  71
  72   vcl_set_worker_index (0);
  73
  74   segment_handle = clib_net_to_host_u64 (mp->segment_handle);
  75   if (segment_handle == VCL_INVALID_SEGMENT_HANDLE)
  76     {
  77       VERR ("invalid segment handle");
  78       goto failed;
  79     }
  80
  81   if (mp->n_fds)
  82     {
  83       vec_validate (fds, mp->n_fds);
  84       if (vl_socket_client_recv_fd_msg2 (&wrk->bapi_sock_ctx, fds, mp->n_fds,
  85                                          5))
  86         goto failed;
  87
  88       if (mp->fd_flags & SESSION_FD_F_VPP_MQ_SEGMENT)
  89         if (vcl_segment_attach (vcl_vpp_worker_segment_handle (0),
  90                                 "vpp-mq-seg", SSVM_SEGMENT_MEMFD,
  91                                 fds[n_fds++]))
  92           goto failed;
  93
  94       if (mp->fd_flags & SESSION_FD_F_MEMFD_SEGMENT)
  95         {
  96           segment_name = vl_api_from_api_to_new_c_string (&mp->segment_name);
  97           rv =
  98             vcl_segment_attach (segment_handle, segment_name,
  99                                 SSVM_SEGMENT_MEMFD, fds[n_fds++]);
 100           vec_free (segment_name);
 101           if (rv != 0)
 102             goto failed;
 103         }
 104
 105       vcl_segment_attach_mq (segment_handle, mp->app_mq, 0,
 106                              &wrk->app_event_queue);
 107
 108       if (mp->fd_flags & SESSION_FD_F_MQ_EVENTFD)
 109         {
 110           svm_msg_q_set_eventfd (wrk->app_event_queue, fds[n_fds]);
 111           vcl_mq_epoll_add_evfd (wrk, wrk->app_event_queue);
 112           n_fds++;
 113         }
 114
 115       vcl_segment_discover_mqs (vcl_vpp_worker_segment_handle (0), fds + n_fds,
 116                                 mp->n_fds - n_fds);
 117       vcl_segment_attach_mq (vcl_vpp_worker_segment_handle (0),
 118                              mp->vpp_ctrl_mq, mp->vpp_ctrl_mq_thread,
 119                              &wrk->ctrl_mq);
 120       vcm->ctrl_mq = wrk->ctrl_mq;
 121
 122       vec_free (fds);
 123     }
 124   else
 125     {
 126       segment_name = vl_api_from_api_to_new_c_string (&mp->segment_name);
 127       rv =
 128         vcl_segment_attach (segment_handle, segment_name, SSVM_SEGMENT_SHM,
 129                             -1);
 130       vec_free (segment_name);
 131       if (rv != 0)
 132         goto failed;
 133     }
 134
 135   vcm->app_index = clib_net_to_host_u32 (mp->app_index);
 136   wrk->bapi_app_state = STATE_APP_ATTACHED;
 137   return;
 138
 139 failed:
 140   wrk->bapi_app_state = STATE_APP_FAILED;
 141   for (i = clib_max (n_fds - 1, 0); i < vec_len (fds); i++)
 142     close (fds[i]);
 143   vec_free (fds);
 144 }
 145
 146 static void
 147 vl_api_app_worker_add_del_reply_t_handler (vl_api_app_worker_add_del_reply_t *
 148                                            mp)
 149 {
 150   int n_fds = 0, *fds = 0, i, rv;
 151   u64 segment_handle;
 152   vcl_worker_t *wrk;
 153   u32 wrk_index;
 154   char *segment_name = 0;
 155
 156   if (!mp->is_add)
 157     return;
 158
 159   wrk_index = mp->context;
 160   wrk = vcl_worker_get_if_valid (wrk_index);
 161   if (!wrk)
 162     return;
 163
 164   if (mp->retval)
 165     {
 166       clib_warning ("VCL<%d>: add/del worker failed: %U", getpid (),
 167                     format_api_error, ntohl (mp->retval));
 168       goto failed;
 169     }
 170
 171   vcl_set_worker_index (wrk_index);
 172   wrk->vpp_wrk_index = clib_net_to_host_u32 (mp->wrk_index);
 173   wrk->ctrl_mq = vcm->ctrl_mq;
 174
 175   segment_handle = clib_net_to_host_u64 (mp->segment_handle);
 176   if (segment_handle == VCL_INVALID_SEGMENT_HANDLE)
 177     {
 178       clib_warning ("invalid segment handle");
 179       goto failed;
 180     }
 181
 182   if (mp->n_fds)
 183     {
 184       vec_validate (fds, mp->n_fds);
 185       if (vl_socket_client_recv_fd_msg2 (&wrk->bapi_sock_ctx, fds, mp->n_fds,
 186                                          5))
 187         goto failed;
 188
 189       if (mp->fd_flags & SESSION_FD_F_VPP_MQ_SEGMENT)
 190         if (vcl_segment_attach (vcl_vpp_worker_segment_handle (wrk_index),
 191                                 "vpp-worker-seg", SSVM_SEGMENT_MEMFD,
 192                                 fds[n_fds++]))
 193           goto failed;
 194
 195       if (mp->fd_flags & SESSION_FD_F_MEMFD_SEGMENT)
 196         {
 197           segment_name = vl_api_from_api_to_new_c_string (&mp->segment_name);
 198           rv =
 199             vcl_segment_attach (segment_handle, segment_name,
 200                                 SSVM_SEGMENT_MEMFD, fds[n_fds++]);
 201           vec_free (segment_name);
 202           if (rv != 0)
 203             goto failed;
 204         }
 205
 206       vcl_segment_attach_mq (segment_handle, mp->app_event_queue_address, 0,
 207                              &wrk->app_event_queue);
 208
 209       if (mp->fd_flags & SESSION_FD_F_MQ_EVENTFD)
 210         {
 211           svm_msg_q_set_eventfd (wrk->app_event_queue, fds[n_fds]);
 212           vcl_mq_epoll_add_evfd (wrk, wrk->app_event_queue);
 213           n_fds++;
 214         }
 215
 216       vec_free (fds);
 217     }
 218   else
 219     {
 220       segment_name = vl_api_from_api_to_new_c_string (&mp->segment_name);
 221       rv =
 222         vcl_segment_attach (segment_handle, segment_name, SSVM_SEGMENT_SHM,
 223                             -1);
 224       vec_free (segment_name);
 225       if (rv != 0)
 226         goto failed;
 227     }
 228   wrk->bapi_app_state = STATE_APP_READY;
 229   VDBG (0, "worker %u vpp-worker %u added", wrk_index, wrk->vpp_wrk_index);
 230   return;
 231
 232 failed:
 233   wrk->bapi_app_state = STATE_APP_FAILED;
 234   for (i = clib_max (n_fds - 1, 0); i < vec_len (fds); i++)
 235     close (fds[i]);
 236   vec_free (fds);
 237 }
 238
 239 static void
 240 vl_api_app_add_cert_key_pair_reply_t_handler (
 241   vl_api_app_add_cert_key_pair_reply_t *mp)
 242 {
 243   vcl_worker_t *wrk = vcl_worker_get_current ();
 244
 245   if (mp->retval)
 246     {
 247       VDBG (0, "Adding cert and key failed: %U", format_api_error,
 248             ntohl (mp->retval));
 249       return;
 250     }
 251   wrk->bapi_return = clib_net_to_host_u32 (mp->index);
 252   wrk->bapi_app_state = STATE_APP_READY;
 253 }
 254
 255 static void
 256 vl_api_app_del_cert_key_pair_reply_t_handler (
 257   vl_api_app_del_cert_key_pair_reply_t *mp)
 258 {
 259   if (mp->retval)
 260     {
 261       VDBG (0, "Deleting cert and key failed: %U", format_api_error,
 262             ntohl (mp->retval));
 263       return;
 264     }
 265 }
 266
 267 #define foreach_sock_msg                                                      \
 268   _ (SESSION_ENABLE_DISABLE_REPLY, session_enable_disable_reply)              \
 269   _ (APP_ATTACH_REPLY, app_attach_reply)                                      \
 270   _ (APP_ADD_CERT_KEY_PAIR_REPLY, app_add_cert_key_pair_reply)                \
 271   _ (APP_DEL_CERT_KEY_PAIR_REPLY, app_del_cert_key_pair_reply)                \
 272   _ (APP_WORKER_ADD_DEL_REPLY, app_worker_add_del_reply)
 273
 274 #define vl_print(handle, ...) fformat (handle, __VA_ARGS__)
 275 #define vl_endianfun          /* define message structures */
 276 #include <vnet/session/session.api.h>
 277 #undef vl_endianfun
 278
 279 /* instantiate all the print functions we know about */
 280 #define vl_printfun
 281 #include <vnet/session/session.api.h>
 282 #undef vl_printfun
 283
 284 #define vl_api_version(n, v) static u32 api_version = v;
 285 #include <vnet/session/session.api.h>
 286 #undef vl_api_version
 287
 288 static void
 289 vcl_bapi_hookup (void)
 290 {
 291   u8 *msg_base_lookup_name = format (0, "session_%08x%c", api_version, 0);
 292
 293   REPLY_MSG_ID_BASE =
 294     vl_client_get_first_plugin_msg_id ((char *) msg_base_lookup_name);
 295
 296   vec_free (msg_base_lookup_name);
 297
 298   if (REPLY_MSG_ID_BASE == (u16) ~0)
 299     return;
 300
 301 #define _(N, n)                                                               \
 302   vl_msg_api_set_handlers (                                                   \
 303     REPLY_MSG_ID_BASE + VL_API_##N, #n, vl_api_##n##_t_handler,               \
 304     vl_noop_handler, vl_api_##n##_t_endian, vl_api_##n##_t_print,             \
 305     sizeof (vl_api_##n##_t), 1, vl_api_##n##_t_print_json,                    \
 306     vl_api_##n##_t_tojson, vl_api_##n##_t_fromjson);
 307   foreach_sock_msg;
 308 #undef _
 309 }
 310
 311 /*
 312  * VPP-API message functions
 313  */
 314 static void
 315 vcl_bapi_send_session_enable_disable (u8 is_enable)
 316 {
 317   vcl_worker_t *wrk = vcl_worker_get_current ();
 318   vl_api_session_enable_disable_t *bmp;
 319   bmp = vl_msg_api_alloc (sizeof (*bmp));
 320   memset (bmp, 0, sizeof (*bmp));
 321
 322   bmp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_SESSION_ENABLE_DISABLE);
 323   bmp->client_index = wrk->api_client_handle;
 324   bmp->context = htonl (0xfeedface);
 325   bmp->is_enable = is_enable;
 326   vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & bmp);
 327 }
 328
 329 void
 330 vcl_bapi_send_attach (void)
 331 {
 332   vcl_worker_t *wrk = vcl_worker_get_current ();
 333   u8 tls_engine = CRYPTO_ENGINE_OPENSSL;
 334   vl_api_app_attach_t *bmp;
 335   u8 nsid_len = vec_len (vcm->cfg.namespace_id);
 336   u8 app_is_proxy = (vcm->cfg.app_proxy_transport_tcp ||
 337                      vcm->cfg.app_proxy_transport_udp);
 338
 339   tls_engine = vcm->cfg.tls_engine ? vcm->cfg.tls_engine : tls_engine;
 340
 341   bmp = vl_msg_api_alloc (sizeof (*bmp));
 342   memset (bmp, 0, sizeof (*bmp));
 343
 344   bmp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_APP_ATTACH);
 345   bmp->client_index = wrk->api_client_handle;
 346   bmp->context = htonl (0xfeedface);
 347   bmp->options[APP_OPTIONS_FLAGS] =
 348     APP_OPTIONS_FLAGS_ACCEPT_REDIRECT | APP_OPTIONS_FLAGS_ADD_SEGMENT |
 349     (vcm->cfg.app_scope_local ? APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE : 0) |
 350     (vcm->cfg.app_scope_global ? APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE : 0) |
 351     (app_is_proxy ? APP_OPTIONS_FLAGS_IS_PROXY : 0) |
 352     (vcm->cfg.use_mq_eventfd ? APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD : 0);
 353   bmp->options[APP_OPTIONS_PROXY_TRANSPORT] =
 354     (u64) ((vcm->cfg.app_proxy_transport_tcp ? 1 << TRANSPORT_PROTO_TCP : 0) |
 355            (vcm->cfg.app_proxy_transport_udp ? 1 << TRANSPORT_PROTO_UDP : 0));
 356   bmp->options[APP_OPTIONS_SEGMENT_SIZE] = vcm->cfg.segment_size;
 357   bmp->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = vcm->cfg.add_segment_size;
 358   bmp->options[APP_OPTIONS_RX_FIFO_SIZE] = vcm->cfg.rx_fifo_size;
 359   bmp->options[APP_OPTIONS_TX_FIFO_SIZE] = vcm->cfg.tx_fifo_size;
 360   bmp->options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] =
 361     vcm->cfg.preallocated_fifo_pairs;
 362   bmp->options[APP_OPTIONS_EVT_QUEUE_SIZE] = vcm->cfg.event_queue_size;
 363   bmp->options[APP_OPTIONS_TLS_ENGINE] = tls_engine;
 364   if (nsid_len)
 365     {
 366       vl_api_vec_to_api_string (vcm->cfg.namespace_id, &bmp->namespace_id);
 367       bmp->options[APP_OPTIONS_NAMESPACE_SECRET] = vcm->cfg.namespace_secret;
 368     }
 369   vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & bmp);
 370 }
 371
 372 void
 373 vcl_bapi_send_detach (void)
 374 {
 375   vcl_worker_t *wrk = vcl_worker_get_current ();
 376   vl_api_application_detach_t *bmp;
 377   bmp = vl_msg_api_alloc (sizeof (*bmp));
 378   memset (bmp, 0, sizeof (*bmp));
 379
 380   bmp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_APPLICATION_DETACH);
 381   bmp->client_index = wrk->api_client_handle;
 382   bmp->context = htonl (0xfeedface);
 383   vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & bmp);
 384 }
 385
 386 static void
 387 vcl_bapi_send_app_worker_add_del (u8 is_add)
 388 {
 389   vcl_worker_t *wrk = vcl_worker_get_current ();
 390   vl_api_app_worker_add_del_t *mp;
 391
 392   mp = vl_msg_api_alloc (sizeof (*mp));
 393   memset (mp, 0, sizeof (*mp));
 394
 395   mp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_APP_WORKER_ADD_DEL);
 396   mp->client_index = wrk->api_client_handle;
 397   mp->app_index = clib_host_to_net_u32 (vcm->app_index);
 398   mp->context = wrk->wrk_index;
 399   mp->is_add = is_add;
 400   if (!is_add)
 401     mp->wrk_index = clib_host_to_net_u32 (wrk->vpp_wrk_index);
 402
 403   vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & mp);
 404 }
 405
 406 static void
 407 vcl_bapi_send_child_worker_del (vcl_worker_t * child_wrk)
 408 {
 409   vcl_worker_t *wrk = vcl_worker_get_current ();
 410   vl_api_app_worker_add_del_t *mp;
 411
 412   mp = vl_msg_api_alloc (sizeof (*mp));
 413   memset (mp, 0, sizeof (*mp));
 414
 415   mp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_APP_WORKER_ADD_DEL);
 416   mp->client_index = wrk->api_client_handle;
 417   mp->app_index = clib_host_to_net_u32 (vcm->app_index);
 418   mp->context = wrk->wrk_index;
 419   mp->is_add = 0;
 420   mp->wrk_index = clib_host_to_net_u32 (child_wrk->vpp_wrk_index);
 421
 422   vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & mp);
 423 }
 424
 425 static void
 426 vcl_bapi_send_app_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair)
 427 {
 428   vcl_worker_t *wrk = vcl_worker_get_current ();
 429   u32 cert_len = ckpair->cert_len;
 430   u32 key_len = ckpair->key_len;
 431   vl_api_app_add_cert_key_pair_t *bmp;
 432
 433   bmp = vl_msg_api_alloc (sizeof (*bmp) + cert_len + key_len);
 434   clib_memset (bmp, 0, sizeof (*bmp) + cert_len + key_len);
 435
 436   bmp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_APP_ADD_CERT_KEY_PAIR);
 437   bmp->client_index = wrk->api_client_handle;
 438   bmp->context = wrk->wrk_index;
 439   bmp->cert_len = clib_host_to_net_u16 (cert_len);
 440   bmp->certkey_len = clib_host_to_net_u16 (key_len + cert_len);
 441   clib_memcpy_fast (bmp->certkey, ckpair->cert, cert_len);
 442   clib_memcpy_fast (bmp->certkey + cert_len, ckpair->key, key_len);
 443
 444   vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) &bmp);
 445 }
 446
 447 static void
 448 vcl_bapi_send_app_del_cert_key_pair (u32 ckpair_index)
 449 {
 450   vcl_worker_t *wrk = vcl_worker_get_current ();
 451   vl_api_app_del_cert_key_pair_t *bmp;
 452   bmp = vl_msg_api_alloc (sizeof (*bmp));
 453   clib_memset (bmp, 0, sizeof (*bmp));
 454
 455   bmp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_APP_DEL_CERT_KEY_PAIR);
 456   bmp->client_index = wrk->api_client_handle;
 457   bmp->context = wrk->wrk_index;
 458   bmp->index = clib_host_to_net_u32 (ckpair_index);
 459   vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) &bmp);
 460 }
 461
 462 u32
 463 vcl_bapi_max_nsid_len (void)
 464 {
 465   vl_api_app_attach_t *mp;
 466   return (sizeof (mp->namespace_id) - 1);
 467 }
 468
 469 static void
 470 vcl_bapi_init_error_string_table (void)
 471 {
 472   vcm->error_string_by_error_number = hash_create (0, sizeof (uword));
 473
 474 #define _(n, v, s) hash_set (vcm->error_string_by_error_number, -v, s);
 475   foreach_vnet_api_error;
 476 #undef _
 477
 478   hash_set (vcm->error_string_by_error_number, 99, "Misc");
 479 }
 480
 481 static void
 482 vcl_bapi_cleanup (void)
 483 {
 484   socket_client_main_t *scm = &socket_client_main;
 485   api_main_t *am = vlibapi_get_main ();
 486
 487   am->my_client_index = ~0;
 488   am->my_registration = 0;
 489   am->vl_input_queue = 0;
 490   am->msg_index_by_name_and_crc = 0;
 491   scm->socket_fd = 0;
 492
 493   vl_client_api_unmap ();
 494 }
 495
 496 static int
 497 vcl_bapi_connect_to_vpp (void)
 498 {
 499   vcl_worker_t *wrk = vcl_worker_get_current ();
 500   vppcom_cfg_t *vcl_cfg = &vcm->cfg;
 501   int rv = VPPCOM_OK;
 502   api_main_t *am;
 503   u8 *wrk_name;
 504
 505   wrk_name = format (0, "%v-wrk-%u%c", vcm->app_name, wrk->wrk_index, 0);
 506
 507   /* Make sure api is cleaned up in case this is a connect from a
 508    * forked worker */
 509   vcl_bapi_cleanup ();
 510
 511   vlibapi_set_main (&wrk->bapi_api_ctx);
 512   vlibapi_set_memory_client_main (&wrk->bapi_mem_ctx);
 513
 514   if (!vcl_cfg->vpp_bapi_socket_name)
 515     {
 516       rv = VPPCOM_EINVAL;
 517       goto error;
 518     }
 519
 520   if (vl_socket_client_connect2 (&wrk->bapi_sock_ctx,
 521                                  (char *) vcl_cfg->vpp_bapi_socket_name,
 522                                  (char *) wrk_name,
 523                                  0 /* default rx/tx buffer */ ))
 524     {
 525       VERR ("app (%s) socket connect failed!", wrk_name);
 526       rv = VPPCOM_ECONNREFUSED;
 527       goto error;
 528     }
 529
 530   if (vl_socket_client_init_shm2 (&wrk->bapi_sock_ctx, 0,
 531                                   1 /* want_pthread */ ))
 532     {
 533       VERR ("app (%s) init shm failed!", wrk_name);
 534       rv = VPPCOM_ECONNREFUSED;
 535       goto error;
 536     }
 537   vcl_bapi_hookup ();
 538
 539   am = vlibapi_get_main ();
 540   wrk->vl_input_queue = am->shmem_hdr->vl_input_queue;
 541   wrk->api_client_handle = (u32) am->my_client_index;
 542
 543   VDBG (0, "app (%s) is connected to VPP!", wrk_name);
 544   vcl_evt (VCL_EVT_INIT, vcm);
 545
 546 error:
 547   vec_free (wrk_name);
 548   return rv;
 549 }
 550
 551 void
 552 vcl_bapi_disconnect_from_vpp (void)
 553 {
 554   vcl_worker_t *wrk = vcl_worker_get_current ();
 555   vppcom_cfg_t *vcl_cfg = &vcm->cfg;
 556
 557   if (vcl_cfg->vpp_bapi_socket_name)
 558     vl_socket_client_disconnect2 (&wrk->bapi_sock_ctx);
 559   else
 560     vl_client_disconnect_from_vlib ();
 561 }
 562
 563 static const char *
 564 vcl_bapi_app_state_str (vcl_bapi_app_state_t state)
 565 {
 566   char *st;
 567
 568   switch (state)
 569     {
 570     case STATE_APP_START:
 571       st = "STATE_APP_START";
 572       break;
 573
 574     case STATE_APP_CONN_VPP:
 575       st = "STATE_APP_CONN_VPP";
 576       break;
 577
 578     case STATE_APP_ENABLED:
 579       st = "STATE_APP_ENABLED";
 580       break;
 581
 582     case STATE_APP_ATTACHED:
 583       st = "STATE_APP_ATTACHED";
 584       break;
 585
 586     default:
 587       st = "UNKNOWN_APP_STATE";
 588       break;
 589     }
 590
 591   return st;
 592 }
 593
 594 static int
 595 vcl_bapi_wait_for_wrk_state_change (vcl_bapi_app_state_t app_state)
 596 {
 597   vcl_worker_t *wrk = vcl_worker_get_current ();
 598   f64 timeout = clib_time_now (&wrk->clib_time) + vcm->cfg.app_timeout;
 599
 600   while (clib_time_now (&wrk->clib_time) < timeout)
 601     {
 602       if (wrk->bapi_app_state == app_state)
 603         return VPPCOM_OK;
 604       if (wrk->bapi_app_state == STATE_APP_FAILED)
 605         return VPPCOM_ECONNABORTED;
 606     }
 607   VDBG (0, "timeout waiting for state %s, current state %d",
 608         vcl_bapi_app_state_str (app_state), wrk->bapi_app_state);
 609   vcl_evt (VCL_EVT_SESSION_TIMEOUT, vcm, bapi_app_state);
 610
 611   return VPPCOM_ETIMEDOUT;
 612 }
 613
 614 static int
 615 vcl_bapi_session_enable (void)
 616 {
 617   vcl_worker_t *wrk = vcl_worker_get_current ();
 618   int rv;
 619
 620   if (wrk->bapi_app_state != STATE_APP_ENABLED)
 621     {
 622       vcl_bapi_send_session_enable_disable (1 /* is_enabled == TRUE */ );
 623       rv = vcl_bapi_wait_for_wrk_state_change (STATE_APP_ENABLED);
 624       if (PREDICT_FALSE (rv))
 625         {
 626           VDBG (0, "application session enable timed out! returning %d (%s)",
 627                 rv, vppcom_retval_str (rv));
 628           return rv;
 629         }
 630     }
 631   return VPPCOM_OK;
 632 }
 633
 634 static int
 635 vcl_bapi_init (void)
 636 {
 637   vcl_worker_t *wrk = vcl_worker_get_current ();
 638   int rv;
 639
 640   wrk->bapi_app_state = STATE_APP_START;
 641   vcl_bapi_init_error_string_table ();
 642   rv = vcl_bapi_connect_to_vpp ();
 643   if (rv)
 644     {
 645       VERR ("couldn't connect to VPP!");
 646       return rv;
 647     }
 648   VDBG (0, "sending session enable");
 649   rv = vcl_bapi_session_enable ();
 650   if (rv)
 651     {
 652       VERR ("vppcom_app_session_enable() failed!");
 653       return rv;
 654     }
 655
 656   return 0;
 657 }
 658
 659 int
 660 vcl_bapi_attach (void)
 661 {
 662   int rv;
 663
 664   /* API hookup and connect to VPP */
 665   if ((rv = vcl_bapi_init ()))
 666     return rv;
 667
 668   vcl_bapi_send_attach ();
 669   rv = vcl_bapi_wait_for_wrk_state_change (STATE_APP_ATTACHED);
 670   if (PREDICT_FALSE (rv))
 671     {
 672       VDBG (0, "application attach timed out! returning %d (%s)", rv,
 673             vppcom_retval_str (rv));
 674       return rv;
 675     }
 676
 677   return 0;
 678 }
 679
 680 int
 681 vcl_bapi_app_worker_add (void)
 682 {
 683   vcl_worker_t *wrk = vcl_worker_get_current ();
 684
 685   if (vcl_bapi_connect_to_vpp ())
 686     return -1;
 687
 688   wrk->bapi_app_state = STATE_APP_ADDING_WORKER;
 689   vcl_bapi_send_app_worker_add_del (1 /* is_add */ );
 690   if (vcl_bapi_wait_for_wrk_state_change (STATE_APP_READY))
 691     return -1;
 692   return 0;
 693 }
 694
 695 void
 696 vcl_bapi_app_worker_del (vcl_worker_t * wrk)
 697 {
 698   /* Notify vpp that the worker is going away */
 699   if (wrk->wrk_index == vcl_get_worker_index ())
 700     vcl_bapi_send_app_worker_add_del (0 /* is_add */ );
 701   else
 702     vcl_bapi_send_child_worker_del (wrk);
 703
 704   /* Disconnect the binary api */
 705   if (vec_len (vcm->workers) == 1)
 706     vcl_bapi_disconnect_from_vpp ();
 707   else
 708     vl_client_send_disconnect (1 /* vpp should cleanup */ );
 709 }
 710
 711 int
 712 vcl_bapi_recv_fds (vcl_worker_t * wrk, int *fds, int n_fds)
 713 {
 714   clib_error_t *err;
 715
 716   if ((err = vl_socket_client_recv_fd_msg2 (&wrk->bapi_sock_ctx, fds, n_fds,
 717                                             5)))
 718     {
 719       clib_error_report (err);
 720       return -1;
 721     }
 722
 723   return 0;
 724 }
 725
 726 int
 727 vcl_bapi_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair)
 728 {
 729   vcl_worker_t *wrk = vcl_worker_get_current ();
 730
 731   if (ckpair->key_len == 0 || ckpair->key_len == ~0)
 732     return VPPCOM_EINVAL;
 733
 734   vcl_bapi_send_app_add_cert_key_pair (ckpair);
 735   wrk->bapi_app_state = STATE_APP_ADDING_TLS_DATA;
 736   vcl_bapi_wait_for_wrk_state_change (STATE_APP_READY);
 737   if (wrk->bapi_app_state == STATE_APP_READY)
 738     return wrk->bapi_return;
 739   return VPPCOM_EFAULT;
 740 }
 741
 742 int
 743 vcl_bapi_del_cert_key_pair (u32 ckpair_index)
 744 {
 745   /* Don't wait for reply */
 746   vcl_bapi_send_app_del_cert_key_pair (ckpair_index);
 747   return 0;
 748 }
 749
 750 int
 751 vcl_bapi_worker_set (void)
 752 {
 753   vcl_worker_t *wrk = vcl_worker_get_current ();
 754   int i;
 755
 756   /* Find the first worker with the same pid */
 757   for (i = 0; i < vec_len (vcm->workers); i++)
 758     {
 759       if (i == wrk->wrk_index)
 760         continue;
 761       if (vcm->workers[i].current_pid == wrk->current_pid)
 762         {
 763           wrk->vl_input_queue = vcm->workers[i].vl_input_queue;
 764           wrk->api_client_handle = vcm->workers[i].api_client_handle;
 765           return 0;
 766         }
 767     }
 768   return -1;
 769 }
 770
 771 /*
 772  * fd.io coding-style-patch-verification: ON
 773  *
 774  * Local Variables:
 775  * eval: (c-set-style "gnu")
 776  * End:
 777  */