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->app_state = STATE_APP_ENABLED;
65 vcl_vpp_worker_segment_handle (u32 wrk_index)
67 return (VCL_INVALID_SEGMENT_HANDLE - wrk_index - 1);
71 vl_api_app_attach_reply_t_handler (vl_api_app_attach_reply_t * mp)
73 vcl_worker_t *wrk = vcl_worker_get (0);
78 char *segment_name = 0;
82 VERR ("attach failed: %U", format_api_error, ntohl (mp->retval));
86 wrk->app_event_queue = uword_to_pointer (mp->app_mq, svm_msg_q_t *);
87 ctrl_mq = uword_to_pointer (mp->vpp_ctrl_mq, svm_msg_q_t *);
88 vec_validate (wrk->vpp_event_queues, mp->vpp_ctrl_mq_thread);
89 wrk->vpp_event_queues[mp->vpp_ctrl_mq_thread] = ctrl_mq;
90 vcm->ctrl_mq = wrk->ctrl_mq = ctrl_mq;
91 segment_handle = clib_net_to_host_u64 (mp->segment_handle);
92 if (segment_handle == VCL_INVALID_SEGMENT_HANDLE)
94 VERR ("invalid segment handle");
100 vec_validate (fds, mp->n_fds);
101 if (vl_socket_client_recv_fd_msg2 (&wrk->bapi_sock_ctx, fds, mp->n_fds,
105 if (mp->fd_flags & SESSION_FD_F_VPP_MQ_SEGMENT)
106 if (vcl_segment_attach (vcl_vpp_worker_segment_handle (0),
107 "vpp-mq-seg", SSVM_SEGMENT_MEMFD,
111 if (mp->fd_flags & SESSION_FD_F_MEMFD_SEGMENT)
113 segment_name = vl_api_from_api_to_new_c_string (&mp->segment_name);
115 vcl_segment_attach (segment_handle, segment_name,
116 SSVM_SEGMENT_MEMFD, fds[n_fds++]);
117 vec_free (segment_name);
123 if (mp->fd_flags & SESSION_FD_F_MQ_EVENTFD)
125 svm_msg_q_set_consumer_eventfd (wrk->app_event_queue, fds[n_fds]);
126 vcl_mq_epoll_add_evfd (wrk, wrk->app_event_queue);
134 segment_name = vl_api_from_api_to_new_c_string (&mp->segment_name);
136 vcl_segment_attach (segment_handle, segment_name, SSVM_SEGMENT_SHM,
138 vec_free (segment_name);
143 vcm->app_index = clib_net_to_host_u32 (mp->app_index);
144 vcm->app_state = STATE_APP_ATTACHED;
148 vcm->app_state = STATE_APP_FAILED;
149 for (i = clib_max (n_fds - 1, 0); i < vec_len (fds); i++)
155 vl_api_app_worker_add_del_reply_t_handler (vl_api_app_worker_add_del_reply_t *
158 int n_fds = 0, *fds = 0, i, rv;
162 char *segment_name = 0;
166 clib_warning ("VCL<%d>: add/del worker failed: %U", getpid (),
167 format_api_error, ntohl (mp->retval));
174 wrk_index = mp->context;
175 wrk = vcl_worker_get_if_valid (wrk_index);
179 wrk->vpp_wrk_index = clib_net_to_host_u32 (mp->wrk_index);
180 wrk->app_event_queue = uword_to_pointer (mp->app_event_queue_address,
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 if (mp->fd_flags & SESSION_FD_F_MQ_EVENTFD)
217 svm_msg_q_set_consumer_eventfd (wrk->app_event_queue, fds[n_fds]);
218 vcl_mq_epoll_add_evfd (wrk, wrk->app_event_queue);
226 segment_name = vl_api_from_api_to_new_c_string (&mp->segment_name);
228 vcl_segment_attach (segment_handle, segment_name, SSVM_SEGMENT_SHM,
230 vec_free (segment_name);
234 vcm->app_state = STATE_APP_READY;
235 VDBG (0, "worker %u vpp-worker %u added", wrk_index, wrk->vpp_wrk_index);
239 vcm->app_state = STATE_APP_FAILED;
240 for (i = clib_max (n_fds - 1, 0); i < vec_len (fds); i++)
246 vl_api_application_tls_cert_add_reply_t_handler
247 (vl_api_application_tls_cert_add_reply_t * mp)
250 VDBG (0, "add cert failed: %U", format_api_error, ntohl (mp->retval));
251 vcm->app_state = STATE_APP_READY;
255 vl_api_application_tls_key_add_reply_t_handler
256 (vl_api_application_tls_key_add_reply_t * mp)
259 VDBG (0, "add key failed: %U", format_api_error, ntohl (mp->retval));
260 vcm->app_state = STATE_APP_READY;
263 #define foreach_sock_msg \
264 _(SESSION_ENABLE_DISABLE_REPLY, session_enable_disable_reply) \
265 _(APP_ATTACH_REPLY, app_attach_reply) \
266 _(APPLICATION_TLS_CERT_ADD_REPLY, application_tls_cert_add_reply) \
267 _(APPLICATION_TLS_KEY_ADD_REPLY, application_tls_key_add_reply) \
268 _(APP_WORKER_ADD_DEL_REPLY, app_worker_add_del_reply) \
271 vppcom_api_hookup (void)
274 vl_msg_api_set_handlers(VL_API_##N, #n, \
275 vl_api_##n##_t_handler, \
277 vl_api_##n##_t_endian, \
278 vl_api_##n##_t_print, \
279 sizeof(vl_api_##n##_t), 1);
285 * VPP-API message functions
288 vppcom_send_session_enable_disable (u8 is_enable)
290 vcl_worker_t *wrk = vcl_worker_get_current ();
291 vl_api_session_enable_disable_t *bmp;
292 bmp = vl_msg_api_alloc (sizeof (*bmp));
293 memset (bmp, 0, sizeof (*bmp));
295 bmp->_vl_msg_id = ntohs (VL_API_SESSION_ENABLE_DISABLE);
296 bmp->client_index = wrk->my_client_index;
297 bmp->context = htonl (0xfeedface);
298 bmp->is_enable = is_enable;
299 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & bmp);
303 vppcom_app_send_attach (void)
305 vcl_worker_t *wrk = vcl_worker_get_current ();
306 u8 tls_engine = CRYPTO_ENGINE_OPENSSL;
307 vl_api_app_attach_t *bmp;
308 u8 nsid_len = vec_len (vcm->cfg.namespace_id);
309 u8 app_is_proxy = (vcm->cfg.app_proxy_transport_tcp ||
310 vcm->cfg.app_proxy_transport_udp);
312 tls_engine = vcm->cfg.tls_engine ? vcm->cfg.tls_engine : tls_engine;
314 bmp = vl_msg_api_alloc (sizeof (*bmp));
315 memset (bmp, 0, sizeof (*bmp));
317 bmp->_vl_msg_id = ntohs (VL_API_APP_ATTACH);
318 bmp->client_index = wrk->my_client_index;
319 bmp->context = htonl (0xfeedface);
320 bmp->options[APP_OPTIONS_FLAGS] =
321 APP_OPTIONS_FLAGS_ACCEPT_REDIRECT | APP_OPTIONS_FLAGS_ADD_SEGMENT |
322 (vcm->cfg.app_scope_local ? APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE : 0) |
323 (vcm->cfg.app_scope_global ? APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE : 0) |
324 (app_is_proxy ? APP_OPTIONS_FLAGS_IS_PROXY : 0) |
325 (vcm->cfg.use_mq_eventfd ? APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD : 0);
326 bmp->options[APP_OPTIONS_PROXY_TRANSPORT] =
327 (u64) ((vcm->cfg.app_proxy_transport_tcp ? 1 << TRANSPORT_PROTO_TCP : 0) |
328 (vcm->cfg.app_proxy_transport_udp ? 1 << TRANSPORT_PROTO_UDP : 0));
329 bmp->options[APP_OPTIONS_SEGMENT_SIZE] = vcm->cfg.segment_size;
330 bmp->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = vcm->cfg.add_segment_size;
331 bmp->options[APP_OPTIONS_RX_FIFO_SIZE] = vcm->cfg.rx_fifo_size;
332 bmp->options[APP_OPTIONS_TX_FIFO_SIZE] = vcm->cfg.tx_fifo_size;
333 bmp->options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] =
334 vcm->cfg.preallocated_fifo_pairs;
335 bmp->options[APP_OPTIONS_EVT_QUEUE_SIZE] = vcm->cfg.event_queue_size;
336 bmp->options[APP_OPTIONS_TLS_ENGINE] = tls_engine;
339 vl_api_vec_to_api_string (vcm->cfg.namespace_id, &bmp->namespace_id);
340 bmp->options[APP_OPTIONS_NAMESPACE_SECRET] = vcm->cfg.namespace_secret;
342 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & bmp);
346 vppcom_app_send_detach (void)
348 vcl_worker_t *wrk = vcl_worker_get_current ();
349 vl_api_application_detach_t *bmp;
350 bmp = vl_msg_api_alloc (sizeof (*bmp));
351 memset (bmp, 0, sizeof (*bmp));
353 bmp->_vl_msg_id = ntohs (VL_API_APPLICATION_DETACH);
354 bmp->client_index = wrk->my_client_index;
355 bmp->context = htonl (0xfeedface);
356 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & bmp);
360 vcl_send_app_worker_add_del (u8 is_add)
362 vcl_worker_t *wrk = vcl_worker_get_current ();
363 vl_api_app_worker_add_del_t *mp;
365 mp = vl_msg_api_alloc (sizeof (*mp));
366 memset (mp, 0, sizeof (*mp));
368 mp->_vl_msg_id = ntohs (VL_API_APP_WORKER_ADD_DEL);
369 mp->client_index = wrk->my_client_index;
370 mp->app_index = clib_host_to_net_u32 (vcm->app_index);
371 mp->context = wrk->wrk_index;
374 mp->wrk_index = clib_host_to_net_u32 (wrk->vpp_wrk_index);
376 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & mp);
380 vcl_send_child_worker_del (vcl_worker_t * child_wrk)
382 vcl_worker_t *wrk = vcl_worker_get_current ();
383 vl_api_app_worker_add_del_t *mp;
385 mp = vl_msg_api_alloc (sizeof (*mp));
386 memset (mp, 0, sizeof (*mp));
388 mp->_vl_msg_id = ntohs (VL_API_APP_WORKER_ADD_DEL);
389 mp->client_index = wrk->my_client_index;
390 mp->app_index = clib_host_to_net_u32 (vcm->app_index);
391 mp->context = wrk->wrk_index;
393 mp->wrk_index = clib_host_to_net_u32 (child_wrk->vpp_wrk_index);
395 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & mp);
399 vppcom_send_application_tls_cert_add (vcl_session_t * session, char *cert,
402 vcl_worker_t *wrk = vcl_worker_get_current ();
403 vl_api_application_tls_cert_add_t *cert_mp;
405 cert_mp = vl_msg_api_alloc (sizeof (*cert_mp) + cert_len);
406 clib_memset (cert_mp, 0, sizeof (*cert_mp));
407 cert_mp->_vl_msg_id = ntohs (VL_API_APPLICATION_TLS_CERT_ADD);
408 cert_mp->client_index = wrk->my_client_index;
409 cert_mp->context = session->session_index;
410 cert_mp->cert_len = clib_host_to_net_u16 (cert_len);
411 clib_memcpy_fast (cert_mp->cert, cert, cert_len);
412 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & cert_mp);
416 vppcom_send_application_tls_key_add (vcl_session_t * session, char *key,
419 vcl_worker_t *wrk = vcl_worker_get_current ();
420 vl_api_application_tls_key_add_t *key_mp;
422 key_mp = vl_msg_api_alloc (sizeof (*key_mp) + key_len);
423 clib_memset (key_mp, 0, sizeof (*key_mp));
424 key_mp->_vl_msg_id = ntohs (VL_API_APPLICATION_TLS_KEY_ADD);
425 key_mp->client_index = wrk->my_client_index;
426 key_mp->context = session->session_index;
427 key_mp->key_len = clib_host_to_net_u16 (key_len);
428 clib_memcpy_fast (key_mp->key, key, key_len);
429 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & key_mp);
433 vcl_max_nsid_len (void)
435 vl_api_app_attach_t *mp;
436 return (sizeof (mp->namespace_id) - 1);
440 vppcom_init_error_string_table (void)
442 vcm->error_string_by_error_number = hash_create (0, sizeof (uword));
444 #define _(n, v, s) hash_set (vcm->error_string_by_error_number, -v, s);
445 foreach_vnet_api_error;
448 hash_set (vcm->error_string_by_error_number, 99, "Misc");
452 vppcom_connect_to_vpp (char *app_name)
454 vcl_worker_t *wrk = vcl_worker_get_current ();
455 vppcom_cfg_t *vcl_cfg = &vcm->cfg;
458 vlibapi_set_main (&wrk->bapi_api_ctx);
459 vlibapi_set_memory_client_main (&wrk->bapi_shm_ctx);
460 vppcom_api_hookup ();
462 if (vcl_cfg->vpp_api_socket_name)
464 if (vl_socket_client_connect2 (&wrk->bapi_sock_ctx,
465 (char *) vcl_cfg->vpp_api_socket_name,
466 app_name, 0 /* default rx/tx buffer */ ))
468 VERR ("app (%s) socket connect failed!", app_name);
469 return VPPCOM_ECONNREFUSED;
472 if (vl_socket_client_init_shm2 (&wrk->bapi_sock_ctx, 0,
473 1 /* want_pthread */ ))
475 VERR ("app (%s) init shm failed!", app_name);
476 return VPPCOM_ECONNREFUSED;
481 if (!vcl_cfg->vpp_api_filename)
482 vcl_cfg->vpp_api_filename = format (0, "/vpe-api%c", 0);
484 vl_set_memory_root_path ((char *) vcl_cfg->vpp_api_chroot);
486 VDBG (0, "app (%s) connecting to VPP api (%s)...",
487 app_name, vcl_cfg->vpp_api_filename);
489 if (vl_client_connect_to_vlib ((char *) vcl_cfg->vpp_api_filename,
490 app_name, vcm->cfg.vpp_api_q_length) < 0)
492 VERR ("app (%s) connect failed!", app_name);
493 return VPPCOM_ECONNREFUSED;
497 am = vlibapi_get_main ();
498 wrk->vl_input_queue = am->shmem_hdr->vl_input_queue;
499 wrk->my_client_index = (u32) am->my_client_index;
500 wrk->wrk_state = STATE_APP_CONN_VPP;
502 VDBG (0, "app (%s) is connected to VPP!", app_name);
503 vcl_evt (VCL_EVT_INIT, vcm);
508 vppcom_disconnect_from_vpp (void)
510 vcl_worker_t *wrk = vcl_worker_get_current ();
511 vppcom_cfg_t *vcl_cfg = &vcm->cfg;
513 if (vcl_cfg->vpp_api_socket_name)
514 vl_socket_client_disconnect2 (&wrk->bapi_sock_ctx);
516 vl_client_disconnect_from_vlib ();
520 * fd.io coding-style-patch-verification: ON
523 * eval: (c-set-style "gnu")