2 * Copyright (c) 2018-2019 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 #include <vcl/vcl_private.h>
17 #include <vlibmemory/api.h>
18 #include <vpp/api/vpe_msg_enum.h>
20 #define vl_typedefs /* define message structures */
21 #include <vpp/api/vpe_all_api_h.h>
24 /* declare message handlers for each api */
26 #define vl_endianfun /* define message structures */
27 #include <vpp/api/vpe_all_api_h.h>
30 /* instantiate all the print functions we know about */
31 #define vl_print(handle, ...)
33 #include <vpp/api/vpe_all_api_h.h>
37 format_api_error (u8 * s, va_list * args)
39 i32 error = va_arg (*args, u32);
42 p = hash_get (vcm->error_string_by_error_number, -error);
45 s = format (s, "%s (%d)", p[0], error);
47 s = format (s, "%d", error);
52 vl_api_session_enable_disable_reply_t_handler
53 (vl_api_session_enable_disable_reply_t * mp)
55 vcl_worker_t *wrk = vcl_worker_get (0);
59 clib_warning ("VCL<%d>: session_enable_disable failed: %U", getpid (),
60 format_api_error, ntohl (mp->retval));
63 wrk->bapi_app_state = STATE_APP_ENABLED;
67 vl_api_app_attach_reply_t_handler (vl_api_app_attach_reply_t * mp)
69 vcl_worker_t *wrk = vcl_worker_get (0);
73 char *segment_name = 0;
77 VERR ("attach failed: %U", format_api_error, ntohl (mp->retval));
81 vcl_set_worker_index (0);
83 segment_handle = clib_net_to_host_u64 (mp->segment_handle);
84 if (segment_handle == VCL_INVALID_SEGMENT_HANDLE)
86 VERR ("invalid segment handle");
92 vec_validate (fds, mp->n_fds);
93 if (vl_socket_client_recv_fd_msg2 (&wrk->bapi_sock_ctx, fds, mp->n_fds,
97 if (mp->fd_flags & SESSION_FD_F_VPP_MQ_SEGMENT)
98 if (vcl_segment_attach (vcl_vpp_worker_segment_handle (0),
99 "vpp-mq-seg", SSVM_SEGMENT_MEMFD,
103 if (mp->fd_flags & SESSION_FD_F_MEMFD_SEGMENT)
105 segment_name = vl_api_from_api_to_new_c_string (&mp->segment_name);
107 vcl_segment_attach (segment_handle, segment_name,
108 SSVM_SEGMENT_MEMFD, fds[n_fds++]);
109 vec_free (segment_name);
114 vcl_segment_attach_mq (segment_handle, mp->app_mq, 0,
115 &wrk->app_event_queue);
117 if (mp->fd_flags & SESSION_FD_F_MQ_EVENTFD)
119 svm_msg_q_set_eventfd (wrk->app_event_queue, fds[n_fds]);
120 vcl_mq_epoll_add_evfd (wrk, wrk->app_event_queue);
124 vcl_segment_discover_mqs (vcl_vpp_worker_segment_handle (0), fds + n_fds,
126 vcl_segment_attach_mq (vcl_vpp_worker_segment_handle (0),
127 mp->vpp_ctrl_mq, mp->vpp_ctrl_mq_thread,
129 vcm->ctrl_mq = wrk->ctrl_mq;
135 segment_name = vl_api_from_api_to_new_c_string (&mp->segment_name);
137 vcl_segment_attach (segment_handle, segment_name, SSVM_SEGMENT_SHM,
139 vec_free (segment_name);
144 vcm->app_index = clib_net_to_host_u32 (mp->app_index);
145 wrk->bapi_app_state = STATE_APP_ATTACHED;
149 wrk->bapi_app_state = STATE_APP_FAILED;
150 for (i = clib_max (n_fds - 1, 0); i < vec_len (fds); i++)
156 vl_api_app_worker_add_del_reply_t_handler (vl_api_app_worker_add_del_reply_t *
159 int n_fds = 0, *fds = 0, i, rv;
163 char *segment_name = 0;
168 wrk_index = mp->context;
169 wrk = vcl_worker_get_if_valid (wrk_index);
175 clib_warning ("VCL<%d>: add/del worker failed: %U", getpid (),
176 format_api_error, ntohl (mp->retval));
180 vcl_set_worker_index (wrk_index);
181 wrk->vpp_wrk_index = clib_net_to_host_u32 (mp->wrk_index);
182 wrk->ctrl_mq = vcm->ctrl_mq;
184 segment_handle = clib_net_to_host_u64 (mp->segment_handle);
185 if (segment_handle == VCL_INVALID_SEGMENT_HANDLE)
187 clib_warning ("invalid segment handle");
193 vec_validate (fds, mp->n_fds);
194 if (vl_socket_client_recv_fd_msg2 (&wrk->bapi_sock_ctx, fds, mp->n_fds,
198 if (mp->fd_flags & SESSION_FD_F_VPP_MQ_SEGMENT)
199 if (vcl_segment_attach (vcl_vpp_worker_segment_handle (wrk_index),
200 "vpp-worker-seg", SSVM_SEGMENT_MEMFD,
204 if (mp->fd_flags & SESSION_FD_F_MEMFD_SEGMENT)
206 segment_name = vl_api_from_api_to_new_c_string (&mp->segment_name);
208 vcl_segment_attach (segment_handle, segment_name,
209 SSVM_SEGMENT_MEMFD, fds[n_fds++]);
210 vec_free (segment_name);
215 vcl_segment_attach_mq (segment_handle, mp->app_event_queue_address, 0,
216 &wrk->app_event_queue);
218 if (mp->fd_flags & SESSION_FD_F_MQ_EVENTFD)
220 svm_msg_q_set_eventfd (wrk->app_event_queue, fds[n_fds]);
221 vcl_mq_epoll_add_evfd (wrk, wrk->app_event_queue);
229 segment_name = vl_api_from_api_to_new_c_string (&mp->segment_name);
231 vcl_segment_attach (segment_handle, segment_name, SSVM_SEGMENT_SHM,
233 vec_free (segment_name);
237 wrk->bapi_app_state = STATE_APP_READY;
238 VDBG (0, "worker %u vpp-worker %u added", wrk_index, wrk->vpp_wrk_index);
242 wrk->bapi_app_state = STATE_APP_FAILED;
243 for (i = clib_max (n_fds - 1, 0); i < vec_len (fds); i++)
249 vl_api_app_add_cert_key_pair_reply_t_handler (
250 vl_api_app_add_cert_key_pair_reply_t *mp)
252 vcl_worker_t *wrk = vcl_worker_get_current ();
256 VDBG (0, "Adding cert and key failed: %U", format_api_error,
260 wrk->bapi_return = clib_net_to_host_u32 (mp->index);
261 wrk->bapi_app_state = STATE_APP_READY;
265 vl_api_app_del_cert_key_pair_reply_t_handler (
266 vl_api_app_del_cert_key_pair_reply_t *mp)
270 VDBG (0, "Deleting cert and key failed: %U", format_api_error,
276 #define foreach_sock_msg \
277 _ (SESSION_ENABLE_DISABLE_REPLY, session_enable_disable_reply) \
278 _ (APP_ATTACH_REPLY, app_attach_reply) \
279 _ (APP_ADD_CERT_KEY_PAIR_REPLY, app_add_cert_key_pair_reply) \
280 _ (APP_DEL_CERT_KEY_PAIR_REPLY, app_del_cert_key_pair_reply) \
281 _ (APP_WORKER_ADD_DEL_REPLY, app_worker_add_del_reply)
284 vcl_bapi_hookup (void)
287 vl_msg_api_set_handlers(VL_API_##N, #n, \
288 vl_api_##n##_t_handler, \
290 vl_api_##n##_t_endian, \
291 vl_api_##n##_t_print, \
292 sizeof(vl_api_##n##_t), 1);
298 * VPP-API message functions
301 vcl_bapi_send_session_enable_disable (u8 is_enable)
303 vcl_worker_t *wrk = vcl_worker_get_current ();
304 vl_api_session_enable_disable_t *bmp;
305 bmp = vl_msg_api_alloc (sizeof (*bmp));
306 memset (bmp, 0, sizeof (*bmp));
308 bmp->_vl_msg_id = ntohs (VL_API_SESSION_ENABLE_DISABLE);
309 bmp->client_index = wrk->api_client_handle;
310 bmp->context = htonl (0xfeedface);
311 bmp->is_enable = is_enable;
312 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & bmp);
316 vcl_bapi_send_attach (void)
318 vcl_worker_t *wrk = vcl_worker_get_current ();
319 u8 tls_engine = CRYPTO_ENGINE_OPENSSL;
320 vl_api_app_attach_t *bmp;
321 u8 nsid_len = vec_len (vcm->cfg.namespace_id);
322 u8 app_is_proxy = (vcm->cfg.app_proxy_transport_tcp ||
323 vcm->cfg.app_proxy_transport_udp);
325 tls_engine = vcm->cfg.tls_engine ? vcm->cfg.tls_engine : tls_engine;
327 bmp = vl_msg_api_alloc (sizeof (*bmp));
328 memset (bmp, 0, sizeof (*bmp));
330 bmp->_vl_msg_id = ntohs (VL_API_APP_ATTACH);
331 bmp->client_index = wrk->api_client_handle;
332 bmp->context = htonl (0xfeedface);
333 bmp->options[APP_OPTIONS_FLAGS] =
334 APP_OPTIONS_FLAGS_ACCEPT_REDIRECT | APP_OPTIONS_FLAGS_ADD_SEGMENT |
335 (vcm->cfg.app_scope_local ? APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE : 0) |
336 (vcm->cfg.app_scope_global ? APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE : 0) |
337 (app_is_proxy ? APP_OPTIONS_FLAGS_IS_PROXY : 0) |
338 (vcm->cfg.use_mq_eventfd ? APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD : 0);
339 bmp->options[APP_OPTIONS_PROXY_TRANSPORT] =
340 (u64) ((vcm->cfg.app_proxy_transport_tcp ? 1 << TRANSPORT_PROTO_TCP : 0) |
341 (vcm->cfg.app_proxy_transport_udp ? 1 << TRANSPORT_PROTO_UDP : 0));
342 bmp->options[APP_OPTIONS_SEGMENT_SIZE] = vcm->cfg.segment_size;
343 bmp->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = vcm->cfg.add_segment_size;
344 bmp->options[APP_OPTIONS_RX_FIFO_SIZE] = vcm->cfg.rx_fifo_size;
345 bmp->options[APP_OPTIONS_TX_FIFO_SIZE] = vcm->cfg.tx_fifo_size;
346 bmp->options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] =
347 vcm->cfg.preallocated_fifo_pairs;
348 bmp->options[APP_OPTIONS_EVT_QUEUE_SIZE] = vcm->cfg.event_queue_size;
349 bmp->options[APP_OPTIONS_TLS_ENGINE] = tls_engine;
352 vl_api_vec_to_api_string (vcm->cfg.namespace_id, &bmp->namespace_id);
353 bmp->options[APP_OPTIONS_NAMESPACE_SECRET] = vcm->cfg.namespace_secret;
355 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & bmp);
359 vcl_bapi_send_detach (void)
361 vcl_worker_t *wrk = vcl_worker_get_current ();
362 vl_api_application_detach_t *bmp;
363 bmp = vl_msg_api_alloc (sizeof (*bmp));
364 memset (bmp, 0, sizeof (*bmp));
366 bmp->_vl_msg_id = ntohs (VL_API_APPLICATION_DETACH);
367 bmp->client_index = wrk->api_client_handle;
368 bmp->context = htonl (0xfeedface);
369 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & bmp);
373 vcl_bapi_send_app_worker_add_del (u8 is_add)
375 vcl_worker_t *wrk = vcl_worker_get_current ();
376 vl_api_app_worker_add_del_t *mp;
378 mp = vl_msg_api_alloc (sizeof (*mp));
379 memset (mp, 0, sizeof (*mp));
381 mp->_vl_msg_id = ntohs (VL_API_APP_WORKER_ADD_DEL);
382 mp->client_index = wrk->api_client_handle;
383 mp->app_index = clib_host_to_net_u32 (vcm->app_index);
384 mp->context = wrk->wrk_index;
387 mp->wrk_index = clib_host_to_net_u32 (wrk->vpp_wrk_index);
389 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & mp);
393 vcl_bapi_send_child_worker_del (vcl_worker_t * child_wrk)
395 vcl_worker_t *wrk = vcl_worker_get_current ();
396 vl_api_app_worker_add_del_t *mp;
398 mp = vl_msg_api_alloc (sizeof (*mp));
399 memset (mp, 0, sizeof (*mp));
401 mp->_vl_msg_id = ntohs (VL_API_APP_WORKER_ADD_DEL);
402 mp->client_index = wrk->api_client_handle;
403 mp->app_index = clib_host_to_net_u32 (vcm->app_index);
404 mp->context = wrk->wrk_index;
406 mp->wrk_index = clib_host_to_net_u32 (child_wrk->vpp_wrk_index);
408 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & mp);
412 vcl_bapi_send_app_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair)
414 vcl_worker_t *wrk = vcl_worker_get_current ();
415 u32 cert_len = test_srv_crt_rsa_len;
416 u32 key_len = test_srv_key_rsa_len;
417 vl_api_app_add_cert_key_pair_t *bmp;
419 bmp = vl_msg_api_alloc (sizeof (*bmp) + cert_len + key_len);
420 clib_memset (bmp, 0, sizeof (*bmp) + cert_len + key_len);
422 bmp->_vl_msg_id = ntohs (VL_API_APP_ADD_CERT_KEY_PAIR);
423 bmp->client_index = wrk->api_client_handle;
424 bmp->context = wrk->wrk_index;
425 bmp->cert_len = clib_host_to_net_u16 (cert_len);
426 bmp->certkey_len = clib_host_to_net_u16 (key_len + cert_len);
427 clib_memcpy_fast (bmp->certkey, test_srv_crt_rsa, cert_len);
428 clib_memcpy_fast (bmp->certkey + cert_len, test_srv_key_rsa, key_len);
430 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) &bmp);
434 vcl_bapi_send_app_del_cert_key_pair (u32 ckpair_index)
436 vcl_worker_t *wrk = vcl_worker_get_current ();
437 vl_api_app_del_cert_key_pair_t *bmp;
438 bmp = vl_msg_api_alloc (sizeof (*bmp));
439 clib_memset (bmp, 0, sizeof (*bmp));
441 bmp->_vl_msg_id = ntohs (VL_API_APP_DEL_CERT_KEY_PAIR);
442 bmp->client_index = wrk->api_client_handle;
443 bmp->context = wrk->wrk_index;
444 bmp->index = clib_host_to_net_u32 (ckpair_index);
445 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) &bmp);
449 vcl_bapi_max_nsid_len (void)
451 vl_api_app_attach_t *mp;
452 return (sizeof (mp->namespace_id) - 1);
456 vcl_bapi_init_error_string_table (void)
458 vcm->error_string_by_error_number = hash_create (0, sizeof (uword));
460 #define _(n, v, s) hash_set (vcm->error_string_by_error_number, -v, s);
461 foreach_vnet_api_error;
464 hash_set (vcm->error_string_by_error_number, 99, "Misc");
468 vcl_bapi_cleanup (void)
470 socket_client_main_t *scm = &socket_client_main;
471 api_main_t *am = vlibapi_get_main ();
473 am->my_client_index = ~0;
474 am->my_registration = 0;
475 am->vl_input_queue = 0;
476 am->msg_index_by_name_and_crc = 0;
479 vl_client_api_unmap ();
483 vcl_bapi_connect_to_vpp (void)
485 vcl_worker_t *wrk = vcl_worker_get_current ();
486 vppcom_cfg_t *vcl_cfg = &vcm->cfg;
491 wrk_name = format (0, "%v-wrk-%u%c", vcm->app_name, wrk->wrk_index, 0);
493 /* Make sure api is cleaned up in case this is a connect from a
497 vlibapi_set_main (&wrk->bapi_api_ctx);
500 if (!vcl_cfg->vpp_bapi_socket_name)
506 if (vl_socket_client_connect2 (&wrk->bapi_sock_ctx,
507 (char *) vcl_cfg->vpp_bapi_socket_name,
509 0 /* default rx/tx buffer */ ))
511 VERR ("app (%s) socket connect failed!", wrk_name);
512 rv = VPPCOM_ECONNREFUSED;
516 if (vl_socket_client_init_shm2 (&wrk->bapi_sock_ctx, 0,
517 1 /* want_pthread */ ))
519 VERR ("app (%s) init shm failed!", wrk_name);
520 rv = VPPCOM_ECONNREFUSED;
524 am = vlibapi_get_main ();
525 wrk->vl_input_queue = am->shmem_hdr->vl_input_queue;
526 wrk->api_client_handle = (u32) am->my_client_index;
528 VDBG (0, "app (%s) is connected to VPP!", wrk_name);
529 vcl_evt (VCL_EVT_INIT, vcm);
537 vcl_bapi_disconnect_from_vpp (void)
539 vcl_worker_t *wrk = vcl_worker_get_current ();
540 vppcom_cfg_t *vcl_cfg = &vcm->cfg;
542 if (vcl_cfg->vpp_bapi_socket_name)
543 vl_socket_client_disconnect2 (&wrk->bapi_sock_ctx);
545 vl_client_disconnect_from_vlib ();
549 vcl_bapi_app_state_str (vcl_bapi_app_state_t state)
555 case STATE_APP_START:
556 st = "STATE_APP_START";
559 case STATE_APP_CONN_VPP:
560 st = "STATE_APP_CONN_VPP";
563 case STATE_APP_ENABLED:
564 st = "STATE_APP_ENABLED";
567 case STATE_APP_ATTACHED:
568 st = "STATE_APP_ATTACHED";
572 st = "UNKNOWN_APP_STATE";
580 vcl_bapi_wait_for_wrk_state_change (vcl_bapi_app_state_t app_state)
582 vcl_worker_t *wrk = vcl_worker_get_current ();
583 f64 timeout = clib_time_now (&wrk->clib_time) + vcm->cfg.app_timeout;
585 while (clib_time_now (&wrk->clib_time) < timeout)
587 if (wrk->bapi_app_state == app_state)
589 if (wrk->bapi_app_state == STATE_APP_FAILED)
590 return VPPCOM_ECONNABORTED;
592 VDBG (0, "timeout waiting for state %s (%d)",
593 vcl_bapi_app_state_str (app_state), app_state);
594 vcl_evt (VCL_EVT_SESSION_TIMEOUT, vcm, bapi_app_state);
596 return VPPCOM_ETIMEDOUT;
600 vcl_bapi_session_enable (void)
602 vcl_worker_t *wrk = vcl_worker_get_current ();
605 if (wrk->bapi_app_state != STATE_APP_ENABLED)
607 vcl_bapi_send_session_enable_disable (1 /* is_enabled == TRUE */ );
608 rv = vcl_bapi_wait_for_wrk_state_change (STATE_APP_ENABLED);
609 if (PREDICT_FALSE (rv))
611 VDBG (0, "application session enable timed out! returning %d (%s)",
612 rv, vppcom_retval_str (rv));
622 vcl_worker_t *wrk = vcl_worker_get_current ();
625 wrk->bapi_app_state = STATE_APP_START;
626 vcl_bapi_init_error_string_table ();
627 rv = vcl_bapi_connect_to_vpp ();
630 VERR ("couldn't connect to VPP!");
633 VDBG (0, "sending session enable");
634 rv = vcl_bapi_session_enable ();
637 VERR ("vppcom_app_session_enable() failed!");
645 vcl_bapi_attach (void)
649 /* API hookup and connect to VPP */
650 if ((rv = vcl_bapi_init ()))
653 vcl_bapi_send_attach ();
654 rv = vcl_bapi_wait_for_wrk_state_change (STATE_APP_ATTACHED);
655 if (PREDICT_FALSE (rv))
657 VDBG (0, "application attach timed out! returning %d (%s)", rv,
658 vppcom_retval_str (rv));
666 vcl_bapi_app_worker_add (void)
668 vcl_worker_t *wrk = vcl_worker_get_current ();
670 if (vcl_bapi_connect_to_vpp ())
673 wrk->bapi_app_state = STATE_APP_ADDING_WORKER;
674 vcl_bapi_send_app_worker_add_del (1 /* is_add */ );
675 if (vcl_bapi_wait_for_wrk_state_change (STATE_APP_READY))
681 vcl_bapi_app_worker_del (vcl_worker_t * wrk)
683 /* Notify vpp that the worker is going away */
684 if (wrk->wrk_index == vcl_get_worker_index ())
685 vcl_bapi_send_app_worker_add_del (0 /* is_add */ );
687 vcl_bapi_send_child_worker_del (wrk);
689 /* Disconnect the binary api */
690 if (vec_len (vcm->workers) == 1)
691 vcl_bapi_disconnect_from_vpp ();
693 vl_client_send_disconnect (1 /* vpp should cleanup */ );
697 vcl_bapi_recv_fds (vcl_worker_t * wrk, int *fds, int n_fds)
701 if ((err = vl_socket_client_recv_fd_msg2 (&wrk->bapi_sock_ctx, fds, n_fds,
704 clib_error_report (err);
712 vcl_bapi_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair)
714 vcl_worker_t *wrk = vcl_worker_get_current ();
716 if (ckpair->key_len == 0 || ckpair->key_len == ~0)
717 return VPPCOM_EINVAL;
719 vcl_bapi_send_app_add_cert_key_pair (ckpair);
720 wrk->bapi_app_state = STATE_APP_ADDING_TLS_DATA;
721 vcl_bapi_wait_for_wrk_state_change (STATE_APP_READY);
722 if (wrk->bapi_app_state == STATE_APP_READY)
723 return wrk->bapi_return;
724 return VPPCOM_EFAULT;
728 vcl_bapi_del_cert_key_pair (u32 ckpair_index)
730 /* Don't wait for reply */
731 vcl_bapi_send_app_del_cert_key_pair (ckpair_index);
736 vcl_bapi_worker_set (void)
738 vcl_worker_t *wrk = vcl_worker_get_current ();
741 /* Find the first worker with the same pid */
742 for (i = 0; i < vec_len (vcm->workers); i++)
744 if (i == wrk->wrk_index)
746 if (vcm->workers[i].current_pid == wrk->current_pid)
748 wrk->vl_input_queue = vcm->workers[i].vl_input_queue;
749 wrk->api_client_handle = vcm->workers[i].api_client_handle;
757 * fd.io coding-style-patch-verification: ON
760 * eval: (c-set-style "gnu")