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 #define vl_calcsizefun
 280 #include <vnet/session/session.api.h>
 281 #undef vl_calcsizefun
 282
 283 /* instantiate all the print functions we know about */
 284 #define vl_printfun
 285 #include <vnet/session/session.api.h>
 286 #undef vl_printfun
 287
 288 #define vl_api_version(n, v) static u32 api_version = v;
 289 #include <vnet/session/session.api.h>
 290 #undef vl_api_version
 291
 292 static void
 293 vcl_bapi_hookup (void)
 294 {
 295   u8 *msg_base_lookup_name = format (0, "session_%08x%c", api_version, 0);
 296
 297   REPLY_MSG_ID_BASE =
 298     vl_client_get_first_plugin_msg_id ((char *) msg_base_lookup_name);
 299
 300   vec_free (msg_base_lookup_name);
 301
 302   if (REPLY_MSG_ID_BASE == (u16) ~0)
 303     return;
 304
 305 #define _(N, n)                                                               \
 306   vl_msg_api_set_handlers (                                                   \
 307     REPLY_MSG_ID_BASE + VL_API_##N, #n, vl_api_##n##_t_handler,               \
 308     vl_noop_handler, vl_api_##n##_t_endian, vl_api_##n##_t_print,             \
 309     sizeof (vl_api_##n##_t), 1, vl_api_##n##_t_print_json,                    \
 310     vl_api_##n##_t_tojson, vl_api_##n##_t_fromjson,                           \
 311     vl_api_##n##_t_calc_size);
 312   foreach_sock_msg;
 313 #undef _
 314 }
 315
 316 /*
 317  * VPP-API message functions
 318  */
 319 static void
 320 vcl_bapi_send_session_enable_disable (u8 is_enable)
 321 {
 322   vcl_worker_t *wrk = vcl_worker_get_current ();
 323   vl_api_session_enable_disable_t *bmp;
 324   bmp = vl_msg_api_alloc (sizeof (*bmp));
 325   memset (bmp, 0, sizeof (*bmp));
 326
 327   bmp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_SESSION_ENABLE_DISABLE);
 328   bmp->client_index = wrk->api_client_handle;
 329   bmp->context = htonl (0xfeedface);
 330   bmp->is_enable = is_enable;
 331   vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & bmp);
 332 }
 333
 334 void
 335 vcl_bapi_send_attach (void)
 336 {
 337   vcl_worker_t *wrk = vcl_worker_get_current ();
 338   u8 tls_engine = CRYPTO_ENGINE_OPENSSL;
 339   vl_api_app_attach_t *bmp;
 340   u8 nsid_len = vec_len (vcm->cfg.namespace_id);
 341   u8 app_is_proxy = (vcm->cfg.app_proxy_transport_tcp ||
 342                      vcm->cfg.app_proxy_transport_udp);
 343
 344   tls_engine = vcm->cfg.tls_engine ? vcm->cfg.tls_engine : tls_engine;
 345
 346   bmp = vl_msg_api_alloc (sizeof (*bmp));
 347   memset (bmp, 0, sizeof (*bmp));
 348
 349   bmp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_APP_ATTACH);
 350   bmp->client_index = wrk->api_client_handle;
 351   bmp->context = htonl (0xfeedface);
 352   bmp->options[APP_OPTIONS_FLAGS] =
 353     APP_OPTIONS_FLAGS_ACCEPT_REDIRECT | APP_OPTIONS_FLAGS_ADD_SEGMENT |
 354     (vcm->cfg.app_scope_local ? APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE : 0) |
 355     (vcm->cfg.app_scope_global ? APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE : 0) |
 356     (app_is_proxy ? APP_OPTIONS_FLAGS_IS_PROXY : 0) |
 357     (vcm->cfg.use_mq_eventfd ? APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD : 0);
 358   bmp->options[APP_OPTIONS_PROXY_TRANSPORT] =
 359     (u64) ((vcm->cfg.app_proxy_transport_tcp ? 1 << TRANSPORT_PROTO_TCP : 0) |
 360            (vcm->cfg.app_proxy_transport_udp ? 1 << TRANSPORT_PROTO_UDP : 0));
 361   bmp->options[APP_OPTIONS_SEGMENT_SIZE] = vcm->cfg.segment_size;
 362   bmp->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = vcm->cfg.add_segment_size;
 363   bmp->options[APP_OPTIONS_RX_FIFO_SIZE] = vcm->cfg.rx_fifo_size;
 364   bmp->options[APP_OPTIONS_TX_FIFO_SIZE] = vcm->cfg.tx_fifo_size;
 365   bmp->options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] =
 366     vcm->cfg.preallocated_fifo_pairs;
 367   bmp->options[APP_OPTIONS_EVT_QUEUE_SIZE] = vcm->cfg.event_queue_size;
 368   bmp->options[APP_OPTIONS_TLS_ENGINE] = tls_engine;
 369   if (nsid_len)
 370     {
 371       vl_api_vec_to_api_string (vcm->cfg.namespace_id, &bmp->namespace_id);
 372       bmp->options[APP_OPTIONS_NAMESPACE_SECRET] = vcm->cfg.namespace_secret;
 373     }
 374   vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & bmp);
 375 }
 376
 377 void
 378 vcl_bapi_send_detach (void)
 379 {
 380   vcl_worker_t *wrk = vcl_worker_get_current ();
 381   vl_api_application_detach_t *bmp;
 382   bmp = vl_msg_api_alloc (sizeof (*bmp));
 383   memset (bmp, 0, sizeof (*bmp));
 384
 385   bmp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_APPLICATION_DETACH);
 386   bmp->client_index = wrk->api_client_handle;
 387   bmp->context = htonl (0xfeedface);
 388   vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & bmp);
 389 }
 390
 391 static void
 392 vcl_bapi_send_app_worker_add_del (u8 is_add)
 393 {
 394   vcl_worker_t *wrk = vcl_worker_get_current ();
 395   vl_api_app_worker_add_del_t *mp;
 396
 397   mp = vl_msg_api_alloc (sizeof (*mp));
 398   memset (mp, 0, sizeof (*mp));
 399
 400   mp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_APP_WORKER_ADD_DEL);
 401   mp->client_index = wrk->api_client_handle;
 402   mp->app_index = clib_host_to_net_u32 (vcm->app_index);
 403   mp->context = wrk->wrk_index;
 404   mp->is_add = is_add;
 405   if (!is_add)
 406     mp->wrk_index = clib_host_to_net_u32 (wrk->vpp_wrk_index);
 407
 408   vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & mp);
 409 }
 410
 411 static void
 412 vcl_bapi_send_child_worker_del (vcl_worker_t * child_wrk)
 413 {
 414   vcl_worker_t *wrk = vcl_worker_get_current ();
 415   vl_api_app_worker_add_del_t *mp;
 416
 417   mp = vl_msg_api_alloc (sizeof (*mp));
 418   memset (mp, 0, sizeof (*mp));
 419
 420   mp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_APP_WORKER_ADD_DEL);
 421   mp->client_index = wrk->api_client_handle;
 422   mp->app_index = clib_host_to_net_u32 (vcm->app_index);
 423   mp->context = wrk->wrk_index;
 424   mp->is_add = 0;
 425   mp->wrk_index = clib_host_to_net_u32 (child_wrk->vpp_wrk_index);
 426
 427   vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & mp);
 428 }
 429
 430 static void
 431 vcl_bapi_send_app_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair)
 432 {
 433   vcl_worker_t *wrk = vcl_worker_get_current ();
 434   u32 cert_len = ckpair->cert_len;
 435   u32 key_len = ckpair->key_len;
 436   vl_api_app_add_cert_key_pair_t *bmp;
 437
 438   bmp = vl_msg_api_alloc (sizeof (*bmp) + cert_len + key_len);
 439   clib_memset (bmp, 0, sizeof (*bmp) + cert_len + key_len);
 440
 441   bmp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_APP_ADD_CERT_KEY_PAIR);
 442   bmp->client_index = wrk->api_client_handle;
 443   bmp->context = wrk->wrk_index;
 444   bmp->cert_len = clib_host_to_net_u16 (cert_len);
 445   bmp->certkey_len = clib_host_to_net_u16 (key_len + cert_len);
 446   clib_memcpy_fast (bmp->certkey, ckpair->cert, cert_len);
 447   clib_memcpy_fast (bmp->certkey + cert_len, ckpair->key, key_len);
 448
 449   vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) &bmp);
 450 }
 451
 452 static void
 453 vcl_bapi_send_app_del_cert_key_pair (u32 ckpair_index)
 454 {
 455   vcl_worker_t *wrk = vcl_worker_get_current ();
 456   vl_api_app_del_cert_key_pair_t *bmp;
 457   bmp = vl_msg_api_alloc (sizeof (*bmp));
 458   clib_memset (bmp, 0, sizeof (*bmp));
 459
 460   bmp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_APP_DEL_CERT_KEY_PAIR);
 461   bmp->client_index = wrk->api_client_handle;
 462   bmp->context = wrk->wrk_index;
 463   bmp->index = clib_host_to_net_u32 (ckpair_index);
 464   vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) &bmp);
 465 }
 466
 467 u32
 468 vcl_bapi_max_nsid_len (void)
 469 {
 470   vl_api_app_attach_t *mp;
 471   return (sizeof (mp->namespace_id) - 1);
 472 }
 473
 474 static void
 475 vcl_bapi_init_error_string_table (void)
 476 {
 477   vcm->error_string_by_error_number = hash_create (0, sizeof (uword));
 478
 479 #define _(n, v, s) hash_set (vcm->error_string_by_error_number, -v, s);
 480   foreach_vnet_api_error;
 481 #undef _
 482
 483   hash_set (vcm->error_string_by_error_number, 99, "Misc");
 484 }
 485
 486 static void
 487 vcl_bapi_cleanup (void)
 488 {
 489   socket_client_main_t *scm = &socket_client_main;
 490   api_main_t *am = vlibapi_get_main ();
 491
 492   am->my_client_index = ~0;
 493   am->my_registration = 0;
 494   am->vl_input_queue = 0;
 495   am->msg_index_by_name_and_crc = 0;
 496   scm->socket_fd = 0;
 497
 498   vl_client_api_unmap ();
 499 }
 500
 501 static int
 502 vcl_bapi_connect_to_vpp (void)
 503 {
 504   vcl_worker_t *wrk = vcl_worker_get_current ();
 505   vppcom_cfg_t *vcl_cfg = &vcm->cfg;
 506   int rv = VPPCOM_OK;
 507   api_main_t *am;
 508   u8 *wrk_name;
 509
 510   wrk_name = format (0, "%v-wrk-%u%c", vcm->app_name, wrk->wrk_index, 0);
 511
 512   /* Make sure api is cleaned up in case this is a connect from a
 513    * forked worker */
 514   vcl_bapi_cleanup ();
 515
 516   vlibapi_set_main (&wrk->bapi_api_ctx);
 517   vlibapi_set_memory_client_main (&wrk->bapi_mem_ctx);
 518
 519   if (!vcl_cfg->vpp_bapi_socket_name)
 520     {
 521       rv = VPPCOM_EINVAL;
 522       goto error;
 523     }
 524
 525   if (vl_socket_client_connect2 (&wrk->bapi_sock_ctx,
 526                                  (char *) vcl_cfg->vpp_bapi_socket_name,
 527                                  (char *) wrk_name,
 528                                  0 /* default rx/tx buffer */ ))
 529     {
 530       VERR ("app (%s) socket connect failed!", wrk_name);
 531       rv = VPPCOM_ECONNREFUSED;
 532       goto error;
 533     }
 534
 535   if (vl_socket_client_init_shm2 (&wrk->bapi_sock_ctx, 0,
 536                                   1 /* want_pthread */ ))
 537     {
 538       VERR ("app (%s) init shm failed!", wrk_name);
 539       rv = VPPCOM_ECONNREFUSED;
 540       goto error;
 541     }
 542   vcl_bapi_hookup ();
 543
 544   am = vlibapi_get_main ();
 545   wrk->vl_input_queue = am->shmem_hdr->vl_input_queue;
 546   wrk->api_client_handle = (u32) am->my_client_index;
 547
 548   VDBG (0, "app (%s) is connected to VPP!", wrk_name);
 549   vcl_evt (VCL_EVT_INIT, vcm);
 550
 551 error:
 552   vec_free (wrk_name);
 553   return rv;
 554 }
 555
 556 void
 557 vcl_bapi_disconnect_from_vpp (void)
 558 {
 559   vcl_worker_t *wrk = vcl_worker_get_current ();
 560   vppcom_cfg_t *vcl_cfg = &vcm->cfg;
 561
 562   if (vcl_cfg->vpp_bapi_socket_name)
 563     vl_socket_client_disconnect2 (&wrk->bapi_sock_ctx);
 564   else
 565     vl_client_disconnect_from_vlib ();
 566 }
 567
 568 static const char *
 569 vcl_bapi_app_state_str (vcl_bapi_app_state_t state)
 570 {
 571   char *st;
 572
 573   switch (state)
 574     {
 575     case STATE_APP_START:
 576       st = "STATE_APP_START";
 577       break;
 578
 579     case STATE_APP_CONN_VPP:
 580       st = "STATE_APP_CONN_VPP";
 581       break;
 582
 583     case STATE_APP_ENABLED:
 584       st = "STATE_APP_ENABLED";
 585       break;
 586
 587     case STATE_APP_ATTACHED:
 588       st = "STATE_APP_ATTACHED";
 589       break;
 590
 591     default:
 592       st = "UNKNOWN_APP_STATE";
 593       break;
 594     }
 595
 596   return st;
 597 }
 598
 599 static int
 600 vcl_bapi_wait_for_wrk_state_change (vcl_bapi_app_state_t app_state)
 601 {
 602   vcl_worker_t *wrk = vcl_worker_get_current ();
 603   f64 timeout = clib_time_now (&wrk->clib_time) + vcm->cfg.app_timeout;
 604
 605   while (clib_time_now (&wrk->clib_time) < timeout)
 606     {
 607       if (wrk->bapi_app_state == app_state)
 608         return VPPCOM_OK;
 609       if (wrk->bapi_app_state == STATE_APP_FAILED)
 610         return VPPCOM_ECONNABORTED;
 611     }
 612   VDBG (0, "timeout waiting for state %s, current state %d",
 613         vcl_bapi_app_state_str (app_state), wrk->bapi_app_state);
 614   vcl_evt (VCL_EVT_SESSION_TIMEOUT, vcm, bapi_app_state);
 615
 616   return VPPCOM_ETIMEDOUT;
 617 }
 618
 619 static int
 620 vcl_bapi_session_enable (void)
 621 {
 622   vcl_worker_t *wrk = vcl_worker_get_current ();
 623   int rv;
 624
 625   if (wrk->bapi_app_state != STATE_APP_ENABLED)
 626     {
 627       vcl_bapi_send_session_enable_disable (1 /* is_enabled == TRUE */ );
 628       rv = vcl_bapi_wait_for_wrk_state_change (STATE_APP_ENABLED);
 629       if (PREDICT_FALSE (rv))
 630         {
 631           VDBG (0, "application session enable timed out! returning %d (%s)",
 632                 rv, vppcom_retval_str (rv));
 633           return rv;
 634         }
 635     }
 636   return VPPCOM_OK;
 637 }
 638
 639 static int
 640 vcl_bapi_init (void)
 641 {
 642   vcl_worker_t *wrk = vcl_worker_get_current ();
 643   int rv;
 644
 645   wrk->bapi_app_state = STATE_APP_START;
 646   vcl_bapi_init_error_string_table ();
 647   rv = vcl_bapi_connect_to_vpp ();
 648   if (rv)
 649     {
 650       VERR ("couldn't connect to VPP!");
 651       return rv;
 652     }
 653   VDBG (0, "sending session enable");
 654   rv = vcl_bapi_session_enable ();
 655   if (rv)
 656     {
 657       VERR ("vppcom_app_session_enable() failed!");
 658       return rv;
 659     }
 660
 661   return 0;
 662 }
 663
 664 int
 665 vcl_bapi_attach (void)
 666 {
 667   int rv;
 668
 669   /* API hookup and connect to VPP */
 670   if ((rv = vcl_bapi_init ()))
 671     return rv;
 672
 673   vcl_bapi_send_attach ();
 674   rv = vcl_bapi_wait_for_wrk_state_change (STATE_APP_ATTACHED);
 675   if (PREDICT_FALSE (rv))
 676     {
 677       VDBG (0, "application attach timed out! returning %d (%s)", rv,
 678             vppcom_retval_str (rv));
 679       return rv;
 680     }
 681
 682   return 0;
 683 }
 684
 685 int
 686 vcl_bapi_app_worker_add (void)
 687 {
 688   vcl_worker_t *wrk = vcl_worker_get_current ();
 689
 690   if (vcl_bapi_connect_to_vpp ())
 691     return -1;
 692
 693   wrk->bapi_app_state = STATE_APP_ADDING_WORKER;
 694   vcl_bapi_send_app_worker_add_del (1 /* is_add */ );
 695   if (vcl_bapi_wait_for_wrk_state_change (STATE_APP_READY))
 696     return -1;
 697   return 0;
 698 }
 699
 700 void
 701 vcl_bapi_app_worker_del (vcl_worker_t * wrk)
 702 {
 703   /* Notify vpp that the worker is going away */
 704   if (wrk->wrk_index == vcl_get_worker_index ())
 705     vcl_bapi_send_app_worker_add_del (0 /* is_add */ );
 706   else
 707     vcl_bapi_send_child_worker_del (wrk);
 708
 709   /* Disconnect the binary api */
 710   if (vec_len (vcm->workers) == 1)
 711     vcl_bapi_disconnect_from_vpp ();
 712   else
 713     vl_client_send_disconnect (1 /* vpp should cleanup */ );
 714 }
 715
 716 int
 717 vcl_bapi_recv_fds (vcl_worker_t * wrk, int *fds, int n_fds)
 718 {
 719   clib_error_t *err;
 720
 721   if ((err = vl_socket_client_recv_fd_msg2 (&wrk->bapi_sock_ctx, fds, n_fds,
 722                                             5)))
 723     {
 724       clib_error_report (err);
 725       return -1;
 726     }
 727
 728   return 0;
 729 }
 730
 731 int
 732 vcl_bapi_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair)
 733 {
 734   vcl_worker_t *wrk = vcl_worker_get_current ();
 735
 736   if (ckpair->key_len == 0 || ckpair->key_len == ~0)
 737     return VPPCOM_EINVAL;
 738
 739   vcl_bapi_send_app_add_cert_key_pair (ckpair);
 740   wrk->bapi_app_state = STATE_APP_ADDING_TLS_DATA;
 741   vcl_bapi_wait_for_wrk_state_change (STATE_APP_READY);
 742   if (wrk->bapi_app_state == STATE_APP_READY)
 743     return wrk->bapi_return;
 744   return VPPCOM_EFAULT;
 745 }
 746
 747 int
 748 vcl_bapi_del_cert_key_pair (u32 ckpair_index)
 749 {
 750   /* Don't wait for reply */
 751   vcl_bapi_send_app_del_cert_key_pair (ckpair_index);
 752   return 0;
 753 }
 754
 755 int
 756 vcl_bapi_worker_set (void)
 757 {
 758   vcl_worker_t *wrk = vcl_worker_get_current ();
 759   int i;
 760
 761   /* Find the first worker with the same pid */
 762   for (i = 0; i < vec_len (vcm->workers); i++)
 763     {
 764       if (i == wrk->wrk_index)
 765         continue;
 766       if (vcm->workers[i].current_pid == wrk->current_pid)
 767         {
 768           wrk->vl_input_queue = vcm->workers[i].vl_input_queue;
 769           wrk->api_client_handle = vcm->workers[i].api_client_handle;
 770           return 0;
 771         }
 772     }
 773   return -1;
 774 }
 775
 776 /*
 777  * fd.io coding-style-patch-verification: ON
 778  *
 779  * Local Variables:
 780  * eval: (c-set-style "gnu")
 781  * End:
 782  */