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)
57 clib_warning ("VCL<%d>: session_enable_disable failed: %U", getpid (),
58 format_api_error, ntohl (mp->retval));
61 vcm->bapi_app_state = STATE_APP_ENABLED;
65 vl_api_app_attach_reply_t_handler (vl_api_app_attach_reply_t * mp)
67 vcl_worker_t *wrk = vcl_worker_get (0);
72 char *segment_name = 0;
76 VERR ("attach failed: %U", format_api_error, ntohl (mp->retval));
80 wrk->app_event_queue = uword_to_pointer (mp->app_mq, svm_msg_q_t *);
81 ctrl_mq = uword_to_pointer (mp->vpp_ctrl_mq, svm_msg_q_t *);
82 vec_validate (wrk->vpp_event_queues, mp->vpp_ctrl_mq_thread);
83 wrk->vpp_event_queues[mp->vpp_ctrl_mq_thread] = ctrl_mq;
84 vcm->ctrl_mq = wrk->ctrl_mq = ctrl_mq;
85 segment_handle = clib_net_to_host_u64 (mp->segment_handle);
86 if (segment_handle == VCL_INVALID_SEGMENT_HANDLE)
88 VERR ("invalid segment handle");
94 vec_validate (fds, mp->n_fds);
95 if (vl_socket_client_recv_fd_msg2 (&wrk->bapi_sock_ctx, fds, mp->n_fds,
99 if (mp->fd_flags & SESSION_FD_F_VPP_MQ_SEGMENT)
100 if (vcl_segment_attach (vcl_vpp_worker_segment_handle (0),
101 "vpp-mq-seg", SSVM_SEGMENT_MEMFD,
105 if (mp->fd_flags & SESSION_FD_F_MEMFD_SEGMENT)
107 segment_name = vl_api_from_api_to_new_c_string (&mp->segment_name);
109 vcl_segment_attach (segment_handle, segment_name,
110 SSVM_SEGMENT_MEMFD, fds[n_fds++]);
111 vec_free (segment_name);
117 if (mp->fd_flags & SESSION_FD_F_MQ_EVENTFD)
119 svm_msg_q_set_consumer_eventfd (wrk->app_event_queue, fds[n_fds]);
120 vcl_mq_epoll_add_evfd (wrk, wrk->app_event_queue);
128 segment_name = vl_api_from_api_to_new_c_string (&mp->segment_name);
130 vcl_segment_attach (segment_handle, segment_name, SSVM_SEGMENT_SHM,
132 vec_free (segment_name);
137 vcm->app_index = clib_net_to_host_u32 (mp->app_index);
138 vcm->bapi_app_state = STATE_APP_ATTACHED;
142 vcm->bapi_app_state = STATE_APP_FAILED;
143 for (i = clib_max (n_fds - 1, 0); i < vec_len (fds); i++)
149 vl_api_app_worker_add_del_reply_t_handler (vl_api_app_worker_add_del_reply_t *
152 int n_fds = 0, *fds = 0, i, rv;
156 char *segment_name = 0;
160 clib_warning ("VCL<%d>: add/del worker failed: %U", getpid (),
161 format_api_error, ntohl (mp->retval));
168 wrk_index = mp->context;
169 wrk = vcl_worker_get_if_valid (wrk_index);
173 wrk->vpp_wrk_index = clib_net_to_host_u32 (mp->wrk_index);
174 wrk->app_event_queue = uword_to_pointer (mp->app_event_queue_address,
176 wrk->ctrl_mq = vcm->ctrl_mq;
178 segment_handle = clib_net_to_host_u64 (mp->segment_handle);
179 if (segment_handle == VCL_INVALID_SEGMENT_HANDLE)
181 clib_warning ("invalid segment handle");
187 vec_validate (fds, mp->n_fds);
188 if (vl_socket_client_recv_fd_msg2 (&wrk->bapi_sock_ctx, fds, mp->n_fds,
192 if (mp->fd_flags & SESSION_FD_F_VPP_MQ_SEGMENT)
193 if (vcl_segment_attach (vcl_vpp_worker_segment_handle (wrk_index),
194 "vpp-worker-seg", SSVM_SEGMENT_MEMFD,
198 if (mp->fd_flags & SESSION_FD_F_MEMFD_SEGMENT)
200 segment_name = vl_api_from_api_to_new_c_string (&mp->segment_name);
202 vcl_segment_attach (segment_handle, segment_name,
203 SSVM_SEGMENT_MEMFD, fds[n_fds++]);
204 vec_free (segment_name);
209 if (mp->fd_flags & SESSION_FD_F_MQ_EVENTFD)
211 svm_msg_q_set_consumer_eventfd (wrk->app_event_queue, fds[n_fds]);
212 vcl_mq_epoll_add_evfd (wrk, wrk->app_event_queue);
220 segment_name = vl_api_from_api_to_new_c_string (&mp->segment_name);
222 vcl_segment_attach (segment_handle, segment_name, SSVM_SEGMENT_SHM,
224 vec_free (segment_name);
228 vcm->bapi_app_state = STATE_APP_READY;
229 VDBG (0, "worker %u vpp-worker %u added", wrk_index, wrk->vpp_wrk_index);
233 vcm->bapi_app_state = STATE_APP_FAILED;
234 for (i = clib_max (n_fds - 1, 0); i < vec_len (fds); i++)
240 vl_api_application_tls_cert_add_reply_t_handler
241 (vl_api_application_tls_cert_add_reply_t * mp)
244 VDBG (0, "add cert failed: %U", format_api_error, ntohl (mp->retval));
245 vcm->bapi_app_state = STATE_APP_READY;
249 vl_api_application_tls_key_add_reply_t_handler
250 (vl_api_application_tls_key_add_reply_t * mp)
253 VDBG (0, "add key failed: %U", format_api_error, ntohl (mp->retval));
254 vcm->bapi_app_state = STATE_APP_READY;
257 #define foreach_sock_msg \
258 _(SESSION_ENABLE_DISABLE_REPLY, session_enable_disable_reply) \
259 _(APP_ATTACH_REPLY, app_attach_reply) \
260 _(APPLICATION_TLS_CERT_ADD_REPLY, application_tls_cert_add_reply) \
261 _(APPLICATION_TLS_KEY_ADD_REPLY, application_tls_key_add_reply) \
262 _(APP_WORKER_ADD_DEL_REPLY, app_worker_add_del_reply) \
265 vcl_bapi_hookup (void)
268 vl_msg_api_set_handlers(VL_API_##N, #n, \
269 vl_api_##n##_t_handler, \
271 vl_api_##n##_t_endian, \
272 vl_api_##n##_t_print, \
273 sizeof(vl_api_##n##_t), 1);
279 * VPP-API message functions
282 vcl_bapi_send_session_enable_disable (u8 is_enable)
284 vcl_worker_t *wrk = vcl_worker_get_current ();
285 vl_api_session_enable_disable_t *bmp;
286 bmp = vl_msg_api_alloc (sizeof (*bmp));
287 memset (bmp, 0, sizeof (*bmp));
289 bmp->_vl_msg_id = ntohs (VL_API_SESSION_ENABLE_DISABLE);
290 bmp->client_index = wrk->api_client_handle;
291 bmp->context = htonl (0xfeedface);
292 bmp->is_enable = is_enable;
293 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & bmp);
297 vcl_bapi_send_attach (void)
299 vcl_worker_t *wrk = vcl_worker_get_current ();
300 u8 tls_engine = CRYPTO_ENGINE_OPENSSL;
301 vl_api_app_attach_t *bmp;
302 u8 nsid_len = vec_len (vcm->cfg.namespace_id);
303 u8 app_is_proxy = (vcm->cfg.app_proxy_transport_tcp ||
304 vcm->cfg.app_proxy_transport_udp);
306 tls_engine = vcm->cfg.tls_engine ? vcm->cfg.tls_engine : tls_engine;
308 bmp = vl_msg_api_alloc (sizeof (*bmp));
309 memset (bmp, 0, sizeof (*bmp));
311 bmp->_vl_msg_id = ntohs (VL_API_APP_ATTACH);
312 bmp->client_index = wrk->api_client_handle;
313 bmp->context = htonl (0xfeedface);
314 bmp->options[APP_OPTIONS_FLAGS] =
315 APP_OPTIONS_FLAGS_ACCEPT_REDIRECT | APP_OPTIONS_FLAGS_ADD_SEGMENT |
316 (vcm->cfg.app_scope_local ? APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE : 0) |
317 (vcm->cfg.app_scope_global ? APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE : 0) |
318 (app_is_proxy ? APP_OPTIONS_FLAGS_IS_PROXY : 0) |
319 (vcm->cfg.use_mq_eventfd ? APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD : 0);
320 bmp->options[APP_OPTIONS_PROXY_TRANSPORT] =
321 (u64) ((vcm->cfg.app_proxy_transport_tcp ? 1 << TRANSPORT_PROTO_TCP : 0) |
322 (vcm->cfg.app_proxy_transport_udp ? 1 << TRANSPORT_PROTO_UDP : 0));
323 bmp->options[APP_OPTIONS_SEGMENT_SIZE] = vcm->cfg.segment_size;
324 bmp->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = vcm->cfg.add_segment_size;
325 bmp->options[APP_OPTIONS_RX_FIFO_SIZE] = vcm->cfg.rx_fifo_size;
326 bmp->options[APP_OPTIONS_TX_FIFO_SIZE] = vcm->cfg.tx_fifo_size;
327 bmp->options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] =
328 vcm->cfg.preallocated_fifo_pairs;
329 bmp->options[APP_OPTIONS_EVT_QUEUE_SIZE] = vcm->cfg.event_queue_size;
330 bmp->options[APP_OPTIONS_TLS_ENGINE] = tls_engine;
333 vl_api_vec_to_api_string (vcm->cfg.namespace_id, &bmp->namespace_id);
334 bmp->options[APP_OPTIONS_NAMESPACE_SECRET] = vcm->cfg.namespace_secret;
336 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & bmp);
340 vcl_bapi_send_detach (void)
342 vcl_worker_t *wrk = vcl_worker_get_current ();
343 vl_api_application_detach_t *bmp;
344 bmp = vl_msg_api_alloc (sizeof (*bmp));
345 memset (bmp, 0, sizeof (*bmp));
347 bmp->_vl_msg_id = ntohs (VL_API_APPLICATION_DETACH);
348 bmp->client_index = wrk->api_client_handle;
349 bmp->context = htonl (0xfeedface);
350 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & bmp);
354 vcl_bapi_send_app_worker_add_del (u8 is_add)
356 vcl_worker_t *wrk = vcl_worker_get_current ();
357 vl_api_app_worker_add_del_t *mp;
359 mp = vl_msg_api_alloc (sizeof (*mp));
360 memset (mp, 0, sizeof (*mp));
362 mp->_vl_msg_id = ntohs (VL_API_APP_WORKER_ADD_DEL);
363 mp->client_index = wrk->api_client_handle;
364 mp->app_index = clib_host_to_net_u32 (vcm->app_index);
365 mp->context = wrk->wrk_index;
368 mp->wrk_index = clib_host_to_net_u32 (wrk->vpp_wrk_index);
370 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & mp);
374 vcl_bapi_send_child_worker_del (vcl_worker_t * child_wrk)
376 vcl_worker_t *wrk = vcl_worker_get_current ();
377 vl_api_app_worker_add_del_t *mp;
379 mp = vl_msg_api_alloc (sizeof (*mp));
380 memset (mp, 0, sizeof (*mp));
382 mp->_vl_msg_id = ntohs (VL_API_APP_WORKER_ADD_DEL);
383 mp->client_index = wrk->api_client_handle;
384 mp->app_index = clib_host_to_net_u32 (vcm->app_index);
385 mp->context = wrk->wrk_index;
387 mp->wrk_index = clib_host_to_net_u32 (child_wrk->vpp_wrk_index);
389 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & mp);
393 vcl_bapi_send_application_tls_cert_add (vcl_session_t * session, char *cert,
396 vcl_worker_t *wrk = vcl_worker_get_current ();
397 vl_api_application_tls_cert_add_t *cert_mp;
399 cert_mp = vl_msg_api_alloc (sizeof (*cert_mp) + cert_len);
400 clib_memset (cert_mp, 0, sizeof (*cert_mp));
401 cert_mp->_vl_msg_id = ntohs (VL_API_APPLICATION_TLS_CERT_ADD);
402 cert_mp->client_index = wrk->api_client_handle;
403 cert_mp->context = session->session_index;
404 cert_mp->cert_len = clib_host_to_net_u16 (cert_len);
405 clib_memcpy_fast (cert_mp->cert, cert, cert_len);
406 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & cert_mp);
410 vcl_bapi_send_application_tls_key_add (vcl_session_t * session, char *key,
413 vcl_worker_t *wrk = vcl_worker_get_current ();
414 vl_api_application_tls_key_add_t *key_mp;
416 key_mp = vl_msg_api_alloc (sizeof (*key_mp) + key_len);
417 clib_memset (key_mp, 0, sizeof (*key_mp));
418 key_mp->_vl_msg_id = ntohs (VL_API_APPLICATION_TLS_KEY_ADD);
419 key_mp->client_index = wrk->api_client_handle;
420 key_mp->context = session->session_index;
421 key_mp->key_len = clib_host_to_net_u16 (key_len);
422 clib_memcpy_fast (key_mp->key, key, key_len);
423 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & key_mp);
427 vcl_bapi_max_nsid_len (void)
429 vl_api_app_attach_t *mp;
430 return (sizeof (mp->namespace_id) - 1);
434 vcl_bapi_init_error_string_table (void)
436 vcm->error_string_by_error_number = hash_create (0, sizeof (uword));
438 #define _(n, v, s) hash_set (vcm->error_string_by_error_number, -v, s);
439 foreach_vnet_api_error;
442 hash_set (vcm->error_string_by_error_number, 99, "Misc");
446 vcl_bapi_cleanup (void)
448 socket_client_main_t *scm = &socket_client_main;
449 api_main_t *am = vlibapi_get_main ();
451 am->my_client_index = ~0;
452 am->my_registration = 0;
453 am->vl_input_queue = 0;
454 am->msg_index_by_name_and_crc = 0;
457 vl_client_api_unmap ();
461 vcl_bapi_connect_to_vpp (void)
463 vcl_worker_t *wrk = vcl_worker_get_current ();
464 vppcom_cfg_t *vcl_cfg = &vcm->cfg;
469 wrk_name = format (0, "%v-wrk-%u%c", vcm->app_name, wrk->wrk_index, 0);
471 /* Make sure api is cleaned up in case this is a connect from a
475 vlibapi_set_main (&wrk->bapi_api_ctx);
476 vlibapi_set_memory_client_main (&wrk->bapi_shm_ctx);
479 if (vcl_cfg->vpp_bapi_socket_name)
481 if (vl_socket_client_connect2 (&wrk->bapi_sock_ctx,
482 (char *) vcl_cfg->vpp_bapi_socket_name,
484 0 /* default rx/tx buffer */ ))
486 VERR ("app (%s) socket connect failed!", wrk_name);
487 rv = VPPCOM_ECONNREFUSED;
491 if (vl_socket_client_init_shm2 (&wrk->bapi_sock_ctx, 0,
492 1 /* want_pthread */ ))
494 VERR ("app (%s) init shm failed!", wrk_name);
495 rv = VPPCOM_ECONNREFUSED;
501 if (!vcl_cfg->vpp_bapi_filename)
502 vcl_cfg->vpp_bapi_filename = format (0, "/vpe-api%c", 0);
504 vl_set_memory_root_path ((char *) vcl_cfg->vpp_bapi_chroot);
506 VDBG (0, "app (%s) connecting to VPP api (%s)...",
507 wrk_name, vcl_cfg->vpp_bapi_filename);
509 if (vl_client_connect_to_vlib ((char *) vcl_cfg->vpp_bapi_filename,
511 vcm->cfg.vpp_api_q_length) < 0)
513 VERR ("app (%s) connect failed!", wrk_name);
514 rv = VPPCOM_ECONNREFUSED;
519 am = vlibapi_get_main ();
520 wrk->vl_input_queue = am->shmem_hdr->vl_input_queue;
521 wrk->api_client_handle = (u32) am->my_client_index;
523 VDBG (0, "app (%s) is connected to VPP!", wrk_name);
524 vcl_evt (VCL_EVT_INIT, vcm);
532 vcl_bapi_disconnect_from_vpp (void)
534 vcl_worker_t *wrk = vcl_worker_get_current ();
535 vppcom_cfg_t *vcl_cfg = &vcm->cfg;
537 if (vcl_cfg->vpp_bapi_socket_name)
538 vl_socket_client_disconnect2 (&wrk->bapi_sock_ctx);
540 vl_client_disconnect_from_vlib ();
544 vcl_bapi_app_state_str (vcl_bapi_app_state_t state)
550 case STATE_APP_START:
551 st = "STATE_APP_START";
554 case STATE_APP_CONN_VPP:
555 st = "STATE_APP_CONN_VPP";
558 case STATE_APP_ENABLED:
559 st = "STATE_APP_ENABLED";
562 case STATE_APP_ATTACHED:
563 st = "STATE_APP_ATTACHED";
567 st = "UNKNOWN_APP_STATE";
575 vcl_bapi_wait_for_app_state_change (vcl_bapi_app_state_t app_state)
577 vcl_worker_t *wrk = vcl_worker_get_current ();
578 f64 timeout = clib_time_now (&wrk->clib_time) + vcm->cfg.app_timeout;
580 while (clib_time_now (&wrk->clib_time) < timeout)
582 if (vcm->bapi_app_state == app_state)
584 if (vcm->bapi_app_state == STATE_APP_FAILED)
585 return VPPCOM_ECONNABORTED;
587 VDBG (0, "timeout waiting for state %s (%d)",
588 vcl_bapi_app_state_str (app_state), app_state);
589 vcl_evt (VCL_EVT_SESSION_TIMEOUT, vcm, bapi_app_state);
591 return VPPCOM_ETIMEDOUT;
595 vcl_bapi_session_enable (void)
599 if (vcm->bapi_app_state != STATE_APP_ENABLED)
601 vcl_bapi_send_session_enable_disable (1 /* is_enabled == TRUE */ );
602 rv = vcl_bapi_wait_for_app_state_change (STATE_APP_ENABLED);
603 if (PREDICT_FALSE (rv))
605 VDBG (0, "application session enable timed out! returning %d (%s)",
606 rv, vppcom_retval_str (rv));
618 vcm->bapi_app_state = STATE_APP_START;
619 vcl_bapi_init_error_string_table ();
620 rv = vcl_bapi_connect_to_vpp ();
623 VERR ("couldn't connect to VPP!");
626 VDBG (0, "sending session enable");
627 rv = vcl_bapi_session_enable ();
630 VERR ("vppcom_app_session_enable() failed!");
638 vcl_bapi_attach (void)
642 /* API hookup and connect to VPP */
643 if ((rv = vcl_bapi_init ()))
646 vcl_bapi_send_attach ();
647 rv = vcl_bapi_wait_for_app_state_change (STATE_APP_ATTACHED);
648 if (PREDICT_FALSE (rv))
650 VDBG (0, "application attach timed out! returning %d (%s)", rv,
651 vppcom_retval_str (rv));
659 vcl_bapi_app_worker_add (void)
661 if (vcl_bapi_connect_to_vpp ())
664 vcm->bapi_app_state = STATE_APP_ADDING_WORKER;
665 vcl_bapi_send_app_worker_add_del (1 /* is_add */ );
666 if (vcl_bapi_wait_for_app_state_change (STATE_APP_READY))
672 vcl_bapi_app_worker_del (vcl_worker_t * wrk)
674 /* Notify vpp that the worker is going away */
675 if (wrk->wrk_index == vcl_get_worker_index ())
676 vcl_bapi_send_app_worker_add_del (0 /* is_add */ );
678 vcl_bapi_send_child_worker_del (wrk);
680 /* Disconnect the binary api */
681 if (vec_len (vcm->workers) == 1)
682 vcl_bapi_disconnect_from_vpp ();
684 vl_client_send_disconnect (1 /* vpp should cleanup */ );
688 vcl_bapi_recv_fds (vcl_worker_t * wrk, int *fds, int n_fds)
692 if ((err = vl_socket_client_recv_fd_msg2 (&wrk->bapi_sock_ctx, fds, n_fds,
695 clib_error_report (err);
703 vppcom_session_tls_add_cert (uint32_t session_handle, char *cert,
707 vcl_worker_t *wrk = vcl_worker_get_current ();
708 vcl_session_t *session = 0;
710 session = vcl_session_get_w_handle (wrk, session_handle);
712 return VPPCOM_EBADFD;
714 if (cert_len == 0 || cert_len == ~0)
715 return VPPCOM_EBADFD;
718 * Send listen request to vpp and wait for reply
720 vcl_bapi_send_application_tls_cert_add (session, cert, cert_len);
721 vcm->bapi_app_state = STATE_APP_ADDING_TLS_DATA;
722 vcl_bapi_wait_for_app_state_change (STATE_APP_READY);
727 vppcom_session_tls_add_key (uint32_t session_handle, char *key,
731 vcl_worker_t *wrk = vcl_worker_get_current ();
732 vcl_session_t *session = 0;
734 session = vcl_session_get_w_handle (wrk, session_handle);
736 return VPPCOM_EBADFD;
738 if (key_len == 0 || key_len == ~0)
739 return VPPCOM_EBADFD;
741 vcl_bapi_send_application_tls_key_add (session, key, key_len);
742 vcm->bapi_app_state = STATE_APP_ADDING_TLS_DATA;
743 vcl_bapi_wait_for_app_state_change (STATE_APP_READY);
748 vcl_bapi_worker_set (void)
750 vcl_worker_t *wrk = vcl_worker_get_current ();
753 /* Find the first worker with the same pid */
754 for (i = 0; i < vec_len (vcm->workers); i++)
756 if (i == wrk->wrk_index)
758 if (vcm->workers[i].current_pid == wrk->current_pid)
760 wrk->vl_input_queue = vcm->workers[i].vl_input_queue;
761 wrk->api_client_handle = vcm->workers[i].api_client_handle;
769 * fd.io coding-style-patch-verification: ON
772 * eval: (c-set-style "gnu")