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>
19 #include <vnet/format_fns.h>
20 #include <vnet/session/session.api_enum.h>
21 #include <vnet/session/session.api_types.h>
23 #define REPLY_MSG_ID_BASE msg_id_base
25 static u16 msg_id_base;
28 format_api_error (u8 * s, va_list * args)
30 i32 error = va_arg (*args, u32);
33 p = hash_get (vcm->error_string_by_error_number, -error);
36 s = format (s, "%s (%d)", p[0], error);
38 s = format (s, "%d", error);
43 vl_api_session_enable_disable_reply_t_handler
44 (vl_api_session_enable_disable_reply_t * mp)
46 vcl_worker_t *wrk = vcl_worker_get (0);
50 clib_warning ("VCL<%d>: session_enable_disable failed: %U", getpid (),
51 format_api_error, ntohl (mp->retval));
54 wrk->bapi_app_state = STATE_APP_ENABLED;
58 vl_api_app_attach_reply_t_handler (vl_api_app_attach_reply_t * mp)
60 vcl_worker_t *wrk = vcl_worker_get (0);
64 char *segment_name = 0;
68 VERR ("attach failed: %U", format_api_error, ntohl (mp->retval));
72 vcl_set_worker_index (0);
74 segment_handle = clib_net_to_host_u64 (mp->segment_handle);
75 if (segment_handle == VCL_INVALID_SEGMENT_HANDLE)
77 VERR ("invalid segment handle");
83 vec_validate (fds, mp->n_fds);
84 if (vl_socket_client_recv_fd_msg2 (&wrk->bapi_sock_ctx, fds, mp->n_fds,
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,
94 if (mp->fd_flags & SESSION_FD_F_MEMFD_SEGMENT)
96 segment_name = vl_api_from_api_to_new_c_string (&mp->segment_name);
98 vcl_segment_attach (segment_handle, segment_name,
99 SSVM_SEGMENT_MEMFD, fds[n_fds++]);
100 vec_free (segment_name);
105 vcl_segment_attach_mq (segment_handle, mp->app_mq, 0,
106 &wrk->app_event_queue);
108 if (mp->fd_flags & SESSION_FD_F_MQ_EVENTFD)
110 svm_msg_q_set_eventfd (wrk->app_event_queue, fds[n_fds]);
111 vcl_mq_epoll_add_evfd (wrk, wrk->app_event_queue);
115 vcl_segment_discover_mqs (vcl_vpp_worker_segment_handle (0), fds + n_fds,
117 vcl_segment_attach_mq (vcl_vpp_worker_segment_handle (0),
118 mp->vpp_ctrl_mq, mp->vpp_ctrl_mq_thread,
120 vcm->ctrl_mq = wrk->ctrl_mq;
126 segment_name = vl_api_from_api_to_new_c_string (&mp->segment_name);
128 vcl_segment_attach (segment_handle, segment_name, SSVM_SEGMENT_SHM,
130 vec_free (segment_name);
135 vcm->app_index = clib_net_to_host_u32 (mp->app_index);
136 wrk->bapi_app_state = STATE_APP_ATTACHED;
140 wrk->bapi_app_state = STATE_APP_FAILED;
141 for (i = clib_max (n_fds - 1, 0); i < vec_len (fds); i++)
147 vl_api_app_worker_add_del_reply_t_handler (vl_api_app_worker_add_del_reply_t *
150 int n_fds = 0, *fds = 0, i, rv;
154 char *segment_name = 0;
159 wrk_index = mp->context;
160 wrk = vcl_worker_get_if_valid (wrk_index);
166 clib_warning ("VCL<%d>: add/del worker failed: %U", getpid (),
167 format_api_error, ntohl (mp->retval));
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;
175 segment_handle = clib_net_to_host_u64 (mp->segment_handle);
176 if (segment_handle == VCL_INVALID_SEGMENT_HANDLE)
178 clib_warning ("invalid segment handle");
184 vec_validate (fds, mp->n_fds);
185 if (vl_socket_client_recv_fd_msg2 (&wrk->bapi_sock_ctx, fds, mp->n_fds,
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,
195 if (mp->fd_flags & SESSION_FD_F_MEMFD_SEGMENT)
197 segment_name = vl_api_from_api_to_new_c_string (&mp->segment_name);
199 vcl_segment_attach (segment_handle, segment_name,
200 SSVM_SEGMENT_MEMFD, fds[n_fds++]);
201 vec_free (segment_name);
206 vcl_segment_attach_mq (segment_handle, mp->app_event_queue_address, 0,
207 &wrk->app_event_queue);
209 if (mp->fd_flags & SESSION_FD_F_MQ_EVENTFD)
211 svm_msg_q_set_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 wrk->bapi_app_state = STATE_APP_READY;
229 VDBG (0, "worker %u vpp-worker %u added", wrk_index, wrk->vpp_wrk_index);
233 wrk->bapi_app_state = STATE_APP_FAILED;
234 for (i = clib_max (n_fds - 1, 0); i < vec_len (fds); i++)
240 vl_api_app_add_cert_key_pair_reply_t_handler (
241 vl_api_app_add_cert_key_pair_reply_t *mp)
243 vcl_worker_t *wrk = vcl_worker_get_current ();
247 VDBG (0, "Adding cert and key failed: %U", format_api_error,
251 wrk->bapi_return = clib_net_to_host_u32 (mp->index);
252 wrk->bapi_app_state = STATE_APP_READY;
256 vl_api_app_del_cert_key_pair_reply_t_handler (
257 vl_api_app_del_cert_key_pair_reply_t *mp)
261 VDBG (0, "Deleting cert and key failed: %U", format_api_error,
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)
274 #define vl_print(handle, ...) fformat (handle, __VA_ARGS__)
275 #define vl_endianfun /* define message structures */
276 #include <vnet/session/session.api.h>
279 /* instantiate all the print functions we know about */
281 #include <vnet/session/session.api.h>
284 #define vl_api_version(n, v) static u32 api_version = v;
285 #include <vnet/session/session.api.h>
286 #undef vl_api_version
289 vcl_bapi_hookup (void)
291 u8 *msg_base_lookup_name = format (0, "session_%08x%c", api_version, 0);
294 vl_client_get_first_plugin_msg_id ((char *) msg_base_lookup_name);
296 vec_free (msg_base_lookup_name);
298 if (REPLY_MSG_ID_BASE == (u16) ~0)
302 vl_msg_api_set_handlers (REPLY_MSG_ID_BASE + VL_API_##N, #n, \
303 vl_api_##n##_t_handler, vl_noop_handler, \
304 vl_api_##n##_t_endian, vl_api_##n##_t_print, \
305 sizeof (vl_api_##n##_t), 1);
311 * VPP-API message functions
314 vcl_bapi_send_session_enable_disable (u8 is_enable)
316 vcl_worker_t *wrk = vcl_worker_get_current ();
317 vl_api_session_enable_disable_t *bmp;
318 bmp = vl_msg_api_alloc (sizeof (*bmp));
319 memset (bmp, 0, sizeof (*bmp));
321 bmp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_SESSION_ENABLE_DISABLE);
322 bmp->client_index = wrk->api_client_handle;
323 bmp->context = htonl (0xfeedface);
324 bmp->is_enable = is_enable;
325 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & bmp);
329 vcl_bapi_send_attach (void)
331 vcl_worker_t *wrk = vcl_worker_get_current ();
332 u8 tls_engine = CRYPTO_ENGINE_OPENSSL;
333 vl_api_app_attach_t *bmp;
334 u8 nsid_len = vec_len (vcm->cfg.namespace_id);
335 u8 app_is_proxy = (vcm->cfg.app_proxy_transport_tcp ||
336 vcm->cfg.app_proxy_transport_udp);
338 tls_engine = vcm->cfg.tls_engine ? vcm->cfg.tls_engine : tls_engine;
340 bmp = vl_msg_api_alloc (sizeof (*bmp));
341 memset (bmp, 0, sizeof (*bmp));
343 bmp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_APP_ATTACH);
344 bmp->client_index = wrk->api_client_handle;
345 bmp->context = htonl (0xfeedface);
346 bmp->options[APP_OPTIONS_FLAGS] =
347 APP_OPTIONS_FLAGS_ACCEPT_REDIRECT | APP_OPTIONS_FLAGS_ADD_SEGMENT |
348 (vcm->cfg.app_scope_local ? APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE : 0) |
349 (vcm->cfg.app_scope_global ? APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE : 0) |
350 (app_is_proxy ? APP_OPTIONS_FLAGS_IS_PROXY : 0) |
351 (vcm->cfg.use_mq_eventfd ? APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD : 0);
352 bmp->options[APP_OPTIONS_PROXY_TRANSPORT] =
353 (u64) ((vcm->cfg.app_proxy_transport_tcp ? 1 << TRANSPORT_PROTO_TCP : 0) |
354 (vcm->cfg.app_proxy_transport_udp ? 1 << TRANSPORT_PROTO_UDP : 0));
355 bmp->options[APP_OPTIONS_SEGMENT_SIZE] = vcm->cfg.segment_size;
356 bmp->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = vcm->cfg.add_segment_size;
357 bmp->options[APP_OPTIONS_RX_FIFO_SIZE] = vcm->cfg.rx_fifo_size;
358 bmp->options[APP_OPTIONS_TX_FIFO_SIZE] = vcm->cfg.tx_fifo_size;
359 bmp->options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] =
360 vcm->cfg.preallocated_fifo_pairs;
361 bmp->options[APP_OPTIONS_EVT_QUEUE_SIZE] = vcm->cfg.event_queue_size;
362 bmp->options[APP_OPTIONS_TLS_ENGINE] = tls_engine;
365 vl_api_vec_to_api_string (vcm->cfg.namespace_id, &bmp->namespace_id);
366 bmp->options[APP_OPTIONS_NAMESPACE_SECRET] = vcm->cfg.namespace_secret;
368 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & bmp);
372 vcl_bapi_send_detach (void)
374 vcl_worker_t *wrk = vcl_worker_get_current ();
375 vl_api_application_detach_t *bmp;
376 bmp = vl_msg_api_alloc (sizeof (*bmp));
377 memset (bmp, 0, sizeof (*bmp));
379 bmp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_APPLICATION_DETACH);
380 bmp->client_index = wrk->api_client_handle;
381 bmp->context = htonl (0xfeedface);
382 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & bmp);
386 vcl_bapi_send_app_worker_add_del (u8 is_add)
388 vcl_worker_t *wrk = vcl_worker_get_current ();
389 vl_api_app_worker_add_del_t *mp;
391 mp = vl_msg_api_alloc (sizeof (*mp));
392 memset (mp, 0, sizeof (*mp));
394 mp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_APP_WORKER_ADD_DEL);
395 mp->client_index = wrk->api_client_handle;
396 mp->app_index = clib_host_to_net_u32 (vcm->app_index);
397 mp->context = wrk->wrk_index;
400 mp->wrk_index = clib_host_to_net_u32 (wrk->vpp_wrk_index);
402 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & mp);
406 vcl_bapi_send_child_worker_del (vcl_worker_t * child_wrk)
408 vcl_worker_t *wrk = vcl_worker_get_current ();
409 vl_api_app_worker_add_del_t *mp;
411 mp = vl_msg_api_alloc (sizeof (*mp));
412 memset (mp, 0, sizeof (*mp));
414 mp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_APP_WORKER_ADD_DEL);
415 mp->client_index = wrk->api_client_handle;
416 mp->app_index = clib_host_to_net_u32 (vcm->app_index);
417 mp->context = wrk->wrk_index;
419 mp->wrk_index = clib_host_to_net_u32 (child_wrk->vpp_wrk_index);
421 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & mp);
425 vcl_bapi_send_app_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair)
427 vcl_worker_t *wrk = vcl_worker_get_current ();
428 u32 cert_len = ckpair->cert_len;
429 u32 key_len = ckpair->key_len;
430 vl_api_app_add_cert_key_pair_t *bmp;
432 bmp = vl_msg_api_alloc (sizeof (*bmp) + cert_len + key_len);
433 clib_memset (bmp, 0, sizeof (*bmp) + cert_len + key_len);
435 bmp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_APP_ADD_CERT_KEY_PAIR);
436 bmp->client_index = wrk->api_client_handle;
437 bmp->context = wrk->wrk_index;
438 bmp->cert_len = clib_host_to_net_u16 (cert_len);
439 bmp->certkey_len = clib_host_to_net_u16 (key_len + cert_len);
440 clib_memcpy_fast (bmp->certkey, ckpair->cert, cert_len);
441 clib_memcpy_fast (bmp->certkey + cert_len, ckpair->key, key_len);
443 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) &bmp);
447 vcl_bapi_send_app_del_cert_key_pair (u32 ckpair_index)
449 vcl_worker_t *wrk = vcl_worker_get_current ();
450 vl_api_app_del_cert_key_pair_t *bmp;
451 bmp = vl_msg_api_alloc (sizeof (*bmp));
452 clib_memset (bmp, 0, sizeof (*bmp));
454 bmp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_APP_DEL_CERT_KEY_PAIR);
455 bmp->client_index = wrk->api_client_handle;
456 bmp->context = wrk->wrk_index;
457 bmp->index = clib_host_to_net_u32 (ckpair_index);
458 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) &bmp);
462 vcl_bapi_max_nsid_len (void)
464 vl_api_app_attach_t *mp;
465 return (sizeof (mp->namespace_id) - 1);
469 vcl_bapi_init_error_string_table (void)
471 vcm->error_string_by_error_number = hash_create (0, sizeof (uword));
473 #define _(n, v, s) hash_set (vcm->error_string_by_error_number, -v, s);
474 foreach_vnet_api_error;
477 hash_set (vcm->error_string_by_error_number, 99, "Misc");
481 vcl_bapi_cleanup (void)
483 socket_client_main_t *scm = &socket_client_main;
484 api_main_t *am = vlibapi_get_main ();
486 am->my_client_index = ~0;
487 am->my_registration = 0;
488 am->vl_input_queue = 0;
489 am->msg_index_by_name_and_crc = 0;
492 vl_client_api_unmap ();
496 vcl_bapi_connect_to_vpp (void)
498 vcl_worker_t *wrk = vcl_worker_get_current ();
499 vppcom_cfg_t *vcl_cfg = &vcm->cfg;
504 wrk_name = format (0, "%v-wrk-%u%c", vcm->app_name, wrk->wrk_index, 0);
506 /* Make sure api is cleaned up in case this is a connect from a
510 vlibapi_set_main (&wrk->bapi_api_ctx);
511 vlibapi_set_memory_client_main (&wrk->bapi_mem_ctx);
513 if (!vcl_cfg->vpp_bapi_socket_name)
519 if (vl_socket_client_connect2 (&wrk->bapi_sock_ctx,
520 (char *) vcl_cfg->vpp_bapi_socket_name,
522 0 /* default rx/tx buffer */ ))
524 VERR ("app (%s) socket connect failed!", wrk_name);
525 rv = VPPCOM_ECONNREFUSED;
529 if (vl_socket_client_init_shm2 (&wrk->bapi_sock_ctx, 0,
530 1 /* want_pthread */ ))
532 VERR ("app (%s) init shm failed!", wrk_name);
533 rv = VPPCOM_ECONNREFUSED;
538 am = vlibapi_get_main ();
539 wrk->vl_input_queue = am->shmem_hdr->vl_input_queue;
540 wrk->api_client_handle = (u32) am->my_client_index;
542 VDBG (0, "app (%s) is connected to VPP!", wrk_name);
543 vcl_evt (VCL_EVT_INIT, vcm);
551 vcl_bapi_disconnect_from_vpp (void)
553 vcl_worker_t *wrk = vcl_worker_get_current ();
554 vppcom_cfg_t *vcl_cfg = &vcm->cfg;
556 if (vcl_cfg->vpp_bapi_socket_name)
557 vl_socket_client_disconnect2 (&wrk->bapi_sock_ctx);
559 vl_client_disconnect_from_vlib ();
563 vcl_bapi_app_state_str (vcl_bapi_app_state_t state)
569 case STATE_APP_START:
570 st = "STATE_APP_START";
573 case STATE_APP_CONN_VPP:
574 st = "STATE_APP_CONN_VPP";
577 case STATE_APP_ENABLED:
578 st = "STATE_APP_ENABLED";
581 case STATE_APP_ATTACHED:
582 st = "STATE_APP_ATTACHED";
586 st = "UNKNOWN_APP_STATE";
594 vcl_bapi_wait_for_wrk_state_change (vcl_bapi_app_state_t app_state)
596 vcl_worker_t *wrk = vcl_worker_get_current ();
597 f64 timeout = clib_time_now (&wrk->clib_time) + vcm->cfg.app_timeout;
599 while (clib_time_now (&wrk->clib_time) < timeout)
601 if (wrk->bapi_app_state == app_state)
603 if (wrk->bapi_app_state == STATE_APP_FAILED)
604 return VPPCOM_ECONNABORTED;
606 VDBG (0, "timeout waiting for state %s, current state %d",
607 vcl_bapi_app_state_str (app_state), wrk->bapi_app_state);
608 vcl_evt (VCL_EVT_SESSION_TIMEOUT, vcm, bapi_app_state);
610 return VPPCOM_ETIMEDOUT;
614 vcl_bapi_session_enable (void)
616 vcl_worker_t *wrk = vcl_worker_get_current ();
619 if (wrk->bapi_app_state != STATE_APP_ENABLED)
621 vcl_bapi_send_session_enable_disable (1 /* is_enabled == TRUE */ );
622 rv = vcl_bapi_wait_for_wrk_state_change (STATE_APP_ENABLED);
623 if (PREDICT_FALSE (rv))
625 VDBG (0, "application session enable timed out! returning %d (%s)",
626 rv, vppcom_retval_str (rv));
636 vcl_worker_t *wrk = vcl_worker_get_current ();
639 wrk->bapi_app_state = STATE_APP_START;
640 vcl_bapi_init_error_string_table ();
641 rv = vcl_bapi_connect_to_vpp ();
644 VERR ("couldn't connect to VPP!");
647 VDBG (0, "sending session enable");
648 rv = vcl_bapi_session_enable ();
651 VERR ("vppcom_app_session_enable() failed!");
659 vcl_bapi_attach (void)
663 /* API hookup and connect to VPP */
664 if ((rv = vcl_bapi_init ()))
667 vcl_bapi_send_attach ();
668 rv = vcl_bapi_wait_for_wrk_state_change (STATE_APP_ATTACHED);
669 if (PREDICT_FALSE (rv))
671 VDBG (0, "application attach timed out! returning %d (%s)", rv,
672 vppcom_retval_str (rv));
680 vcl_bapi_app_worker_add (void)
682 vcl_worker_t *wrk = vcl_worker_get_current ();
684 if (vcl_bapi_connect_to_vpp ())
687 wrk->bapi_app_state = STATE_APP_ADDING_WORKER;
688 vcl_bapi_send_app_worker_add_del (1 /* is_add */ );
689 if (vcl_bapi_wait_for_wrk_state_change (STATE_APP_READY))
695 vcl_bapi_app_worker_del (vcl_worker_t * wrk)
697 /* Notify vpp that the worker is going away */
698 if (wrk->wrk_index == vcl_get_worker_index ())
699 vcl_bapi_send_app_worker_add_del (0 /* is_add */ );
701 vcl_bapi_send_child_worker_del (wrk);
703 /* Disconnect the binary api */
704 if (vec_len (vcm->workers) == 1)
705 vcl_bapi_disconnect_from_vpp ();
707 vl_client_send_disconnect (1 /* vpp should cleanup */ );
711 vcl_bapi_recv_fds (vcl_worker_t * wrk, int *fds, int n_fds)
715 if ((err = vl_socket_client_recv_fd_msg2 (&wrk->bapi_sock_ctx, fds, n_fds,
718 clib_error_report (err);
726 vcl_bapi_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair)
728 vcl_worker_t *wrk = vcl_worker_get_current ();
730 if (ckpair->key_len == 0 || ckpair->key_len == ~0)
731 return VPPCOM_EINVAL;
733 vcl_bapi_send_app_add_cert_key_pair (ckpair);
734 wrk->bapi_app_state = STATE_APP_ADDING_TLS_DATA;
735 vcl_bapi_wait_for_wrk_state_change (STATE_APP_READY);
736 if (wrk->bapi_app_state == STATE_APP_READY)
737 return wrk->bapi_return;
738 return VPPCOM_EFAULT;
742 vcl_bapi_del_cert_key_pair (u32 ckpair_index)
744 /* Don't wait for reply */
745 vcl_bapi_send_app_del_cert_key_pair (ckpair_index);
750 vcl_bapi_worker_set (void)
752 vcl_worker_t *wrk = vcl_worker_get_current ();
755 /* Find the first worker with the same pid */
756 for (i = 0; i < vec_len (vcm->workers); i++)
758 if (i == wrk->wrk_index)
760 if (vcm->workers[i].current_pid == wrk->current_pid)
762 wrk->vl_input_queue = vcm->workers[i].vl_input_queue;
763 wrk->api_client_handle = vcm->workers[i].api_client_handle;
771 * fd.io coding-style-patch-verification: ON
774 * eval: (c-set-style "gnu")