2 * Copyright (c) 2018 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_segment_attach (u64 segment_handle, char *name, ssvm_segment_type_t type,
68 svm_fifo_segment_create_args_t _a, *a = &_a;
71 memset (a, 0, sizeof (*a));
72 a->segment_name = (char *) name;
73 a->segment_type = type;
75 if (type == SSVM_SEGMENT_MEMFD)
78 if ((rv = svm_fifo_segment_attach (&vcm->segment_main, a)))
80 clib_warning ("svm_fifo_segment_attach ('%s') failed", name);
83 vcl_segment_table_add (segment_handle, a->new_segment_indices[0]);
84 vec_reset_length (a->new_segment_indices);
89 vcl_segment_detach (u64 segment_handle)
91 svm_fifo_segment_main_t *sm = &vcm->segment_main;
92 svm_fifo_segment_private_t *segment;
95 segment_index = vcl_segment_table_lookup (segment_handle);
96 if (segment_index == (u32) ~ 0)
98 segment = svm_fifo_segment_get_segment (sm, segment_index);
99 svm_fifo_segment_delete (sm, segment);
100 vcl_segment_table_del (segment_handle);
104 vcl_vpp_worker_segment_handle (u32 wrk_index)
106 return (VCL_INVALID_SEGMENT_HANDLE - wrk_index - 1);
110 vl_api_application_attach_reply_t_handler (vl_api_application_attach_reply_t *
113 vcl_worker_t *wrk = vcl_worker_get (0);
120 clib_warning ("VCL<%d>: attach failed: %U", getpid (),
121 format_api_error, ntohl (mp->retval));
125 wrk->app_event_queue = uword_to_pointer (mp->app_event_queue_address,
127 segment_handle = clib_net_to_host_u64 (mp->segment_handle);
128 if (segment_handle == VCL_INVALID_SEGMENT_HANDLE)
130 clib_warning ("invalid segment handle");
136 vec_validate (fds, mp->n_fds);
137 vl_socket_client_recv_fd_msg (fds, mp->n_fds, 5);
139 if (mp->fd_flags & SESSION_FD_F_VPP_MQ_SEGMENT)
140 if (vcl_segment_attach (vcl_vpp_worker_segment_handle (0),
141 "vpp-mq-seg", SSVM_SEGMENT_MEMFD,
145 if (mp->fd_flags & SESSION_FD_F_MEMFD_SEGMENT)
146 if (vcl_segment_attach (segment_handle, (char *) mp->segment_name,
147 SSVM_SEGMENT_MEMFD, fds[n_fds++]))
150 if (mp->fd_flags & SESSION_FD_F_MQ_EVENTFD)
152 svm_msg_q_set_consumer_eventfd (wrk->app_event_queue, fds[n_fds]);
153 vcl_mq_epoll_add_evfd (wrk, wrk->app_event_queue);
161 if (vcl_segment_attach (segment_handle, (char *) mp->segment_name,
162 SSVM_SEGMENT_SHM, -1))
166 vcm->app_index = clib_net_to_host_u32 (mp->app_index);
167 vcm->app_state = STATE_APP_ATTACHED;
171 vl_api_app_worker_add_del_reply_t_handler (vl_api_app_worker_add_del_reply_t *
174 int n_fds = 0, *fds = 0;
181 clib_warning ("VCL<%d>: add/del worker failed: %U", getpid (),
182 format_api_error, ntohl (mp->retval));
189 wrk_index = mp->context;
190 wrk = vcl_worker_get_if_valid (wrk_index);
194 wrk->vpp_wrk_index = clib_net_to_host_u32 (mp->wrk_index);
195 wrk->app_event_queue = uword_to_pointer (mp->app_event_queue_address,
198 segment_handle = clib_net_to_host_u64 (mp->segment_handle);
199 if (segment_handle == VCL_INVALID_SEGMENT_HANDLE)
201 clib_warning ("invalid segment handle");
207 vec_validate (fds, mp->n_fds);
208 vl_socket_client_recv_fd_msg (fds, mp->n_fds, 5);
210 if (mp->fd_flags & SESSION_FD_F_VPP_MQ_SEGMENT)
211 if (vcl_segment_attach (vcl_vpp_worker_segment_handle (wrk_index),
212 "vpp-worker-seg", SSVM_SEGMENT_MEMFD,
216 if (mp->fd_flags & SESSION_FD_F_MEMFD_SEGMENT)
217 if (vcl_segment_attach (segment_handle, (char *) mp->segment_name,
218 SSVM_SEGMENT_MEMFD, fds[n_fds++]))
221 if (mp->fd_flags & SESSION_FD_F_MQ_EVENTFD)
223 svm_msg_q_set_consumer_eventfd (wrk->app_event_queue, fds[n_fds]);
224 vcl_mq_epoll_add_evfd (wrk, wrk->app_event_queue);
232 if (vcl_segment_attach (segment_handle, (char *) mp->segment_name,
233 SSVM_SEGMENT_SHM, -1))
236 vcm->app_state = STATE_APP_READY;
237 VDBG (0, "worker %u vpp-worker %u added", wrk_index, wrk->vpp_wrk_index);
241 vcm->app_state = STATE_APP_FAILED;
245 vl_api_application_detach_reply_t_handler (vl_api_application_detach_reply_t *
249 clib_warning ("VCL<%d>: detach failed: %U", getpid (), format_api_error,
252 vcm->app_state = STATE_APP_ENABLED;
256 vl_api_map_another_segment_t_handler (vl_api_map_another_segment_t * mp)
258 ssvm_segment_type_t seg_type = SSVM_SEGMENT_SHM;
264 vl_socket_client_recv_fd_msg (&fd, 1, 5);
265 seg_type = SSVM_SEGMENT_MEMFD;
268 segment_handle = clib_net_to_host_u64 (mp->segment_handle);
269 if (segment_handle == VCL_INVALID_SEGMENT_HANDLE)
271 clib_warning ("invalid segment handle");
275 if (vcl_segment_attach (segment_handle, (char *) mp->segment_name,
278 clib_warning ("VCL<%d>: svm_fifo_segment_attach ('%s') failed",
279 getpid (), mp->segment_name);
283 VDBG (1, "VCL<%d>: mapped new segment '%s' size %d", getpid (),
284 mp->segment_name, mp->segment_size);
288 vl_api_unmap_segment_t_handler (vl_api_unmap_segment_t * mp)
290 u64 segment_handle = clib_net_to_host_u64 (mp->segment_handle);
291 vcl_segment_detach (segment_handle);
292 VDBG (1, "Unmapped segment: %d", segment_handle);
296 vl_api_app_cut_through_registration_add_t_handler
297 (vl_api_app_cut_through_registration_add_t * mp)
299 vcl_cut_through_registration_t *ctr;
306 ASSERT (mp->n_fds == 2);
307 vec_validate (fds, mp->n_fds);
308 vl_socket_client_recv_fd_msg (fds, mp->n_fds, 5);
311 wrk = vcl_worker_get (mp->wrk_index);
312 ctr = vcl_ct_registration_lock_and_alloc (wrk);
313 ctr->mq = uword_to_pointer (mp->evt_q_address, svm_msg_q_t *);
314 ctr->peer_mq = uword_to_pointer (mp->peer_evt_q_address, svm_msg_q_t *);
315 VDBG (0, "Adding ct registration %u", vcl_ct_registration_index (wrk, ctr));
317 if (mp->n_fds && (mp->fd_flags & SESSION_FD_F_MQ_EVENTFD))
319 svm_msg_q_set_consumer_eventfd (ctr->mq, fds[0]);
320 svm_msg_q_set_producer_eventfd (ctr->peer_mq, fds[1]);
321 mqc_index = vcl_mq_epoll_add_evfd (wrk, ctr->mq);
322 ctr->epoll_evt_conn_index = mqc_index;
325 vcl_ct_registration_lookup_add (wrk, mp->evt_q_address,
326 vcl_ct_registration_index (wrk, ctr));
327 vcl_ct_registration_unlock (wrk);
331 vl_api_bind_sock_reply_t_handler (vl_api_bind_sock_reply_t * mp)
333 /* Expecting a similar message on mq. So ignore this */
334 VDBG (0, "bapi msg vpp handle 0x%llx, sid %u: bind retval: %u!",
335 getpid (), mp->handle, mp->context, mp->retval);
339 vl_api_unbind_sock_reply_t_handler (vl_api_unbind_sock_reply_t * mp)
342 clib_warning ("VCL<%d>: ERROR: sid %u: unbind failed: %U",
343 getpid (), mp->context, format_api_error,
347 VDBG (1, "VCL<%d>: sid %u: unbind succeeded!", getpid (), mp->context);
351 vl_api_disconnect_session_reply_t_handler (vl_api_disconnect_session_reply_t *
355 clib_warning ("VCL<%d>: ERROR: sid %u: disconnect failed: %U",
356 getpid (), mp->context, format_api_error,
361 vl_api_connect_session_reply_t_handler (vl_api_connect_sock_reply_t * mp)
364 clib_warning ("VCL<%d>: ERROR: sid %u: connect failed: %U",
365 getpid (), mp->context, format_api_error,
369 #define foreach_sock_msg \
370 _(SESSION_ENABLE_DISABLE_REPLY, session_enable_disable_reply) \
371 _(BIND_SOCK_REPLY, bind_sock_reply) \
372 _(UNBIND_SOCK_REPLY, unbind_sock_reply) \
373 _(CONNECT_SESSION_REPLY, connect_session_reply) \
374 _(DISCONNECT_SESSION_REPLY, disconnect_session_reply) \
375 _(APPLICATION_ATTACH_REPLY, application_attach_reply) \
376 _(APPLICATION_DETACH_REPLY, application_detach_reply) \
377 _(MAP_ANOTHER_SEGMENT, map_another_segment) \
378 _(UNMAP_SEGMENT, unmap_segment) \
379 _(APP_CUT_THROUGH_REGISTRATION_ADD, app_cut_through_registration_add) \
380 _(APP_WORKER_ADD_DEL_REPLY, app_worker_add_del_reply) \
383 vppcom_api_hookup (void)
386 vl_msg_api_set_handlers(VL_API_##N, #n, \
387 vl_api_##n##_t_handler, \
389 vl_api_##n##_t_endian, \
390 vl_api_##n##_t_print, \
391 sizeof(vl_api_##n##_t), 1);
397 * VPP-API message functions
400 vppcom_send_session_enable_disable (u8 is_enable)
402 vcl_worker_t *wrk = vcl_worker_get_current ();
403 vl_api_session_enable_disable_t *bmp;
404 bmp = vl_msg_api_alloc (sizeof (*bmp));
405 memset (bmp, 0, sizeof (*bmp));
407 bmp->_vl_msg_id = ntohs (VL_API_SESSION_ENABLE_DISABLE);
408 bmp->client_index = wrk->my_client_index;
409 bmp->context = htonl (0xfeedface);
410 bmp->is_enable = is_enable;
411 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & bmp);
415 vppcom_app_send_attach (void)
417 vcl_worker_t *wrk = vcl_worker_get_current ();
418 vl_api_application_attach_t *bmp;
419 u8 nsid_len = vec_len (vcm->cfg.namespace_id);
420 u8 app_is_proxy = (vcm->cfg.app_proxy_transport_tcp ||
421 vcm->cfg.app_proxy_transport_udp);
423 bmp = vl_msg_api_alloc (sizeof (*bmp));
424 memset (bmp, 0, sizeof (*bmp));
426 bmp->_vl_msg_id = ntohs (VL_API_APPLICATION_ATTACH);
427 bmp->client_index = wrk->my_client_index;
428 bmp->context = htonl (0xfeedface);
429 bmp->options[APP_OPTIONS_FLAGS] =
430 APP_OPTIONS_FLAGS_ACCEPT_REDIRECT | APP_OPTIONS_FLAGS_ADD_SEGMENT |
431 (vcm->cfg.app_scope_local ? APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE : 0) |
432 (vcm->cfg.app_scope_global ? APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE : 0) |
433 (app_is_proxy ? APP_OPTIONS_FLAGS_IS_PROXY : 0) |
434 APP_OPTIONS_FLAGS_USE_MQ_FOR_CTRL_MSGS |
435 (vcm->cfg.use_mq_eventfd ? APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD : 0);
436 bmp->options[APP_OPTIONS_PROXY_TRANSPORT] =
437 (u64) ((vcm->cfg.app_proxy_transport_tcp ? 1 << TRANSPORT_PROTO_TCP : 0) |
438 (vcm->cfg.app_proxy_transport_udp ? 1 << TRANSPORT_PROTO_UDP : 0));
439 bmp->options[APP_OPTIONS_SEGMENT_SIZE] = vcm->cfg.segment_size;
440 bmp->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = vcm->cfg.add_segment_size;
441 bmp->options[APP_OPTIONS_RX_FIFO_SIZE] = vcm->cfg.rx_fifo_size;
442 bmp->options[APP_OPTIONS_TX_FIFO_SIZE] = vcm->cfg.tx_fifo_size;
443 bmp->options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] =
444 vcm->cfg.preallocated_fifo_pairs;
445 bmp->options[APP_OPTIONS_EVT_QUEUE_SIZE] = vcm->cfg.event_queue_size;
448 bmp->namespace_id_len = nsid_len;
449 clib_memcpy_fast (bmp->namespace_id, vcm->cfg.namespace_id, nsid_len);
450 bmp->options[APP_OPTIONS_NAMESPACE_SECRET] = vcm->cfg.namespace_secret;
452 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & bmp);
456 vppcom_app_send_detach (void)
458 vcl_worker_t *wrk = vcl_worker_get_current ();
459 vl_api_application_detach_t *bmp;
460 bmp = vl_msg_api_alloc (sizeof (*bmp));
461 memset (bmp, 0, sizeof (*bmp));
463 bmp->_vl_msg_id = ntohs (VL_API_APPLICATION_DETACH);
464 bmp->client_index = wrk->my_client_index;
465 bmp->context = htonl (0xfeedface);
466 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & bmp);
470 vcl_send_app_worker_add_del (u8 is_add)
472 vcl_worker_t *wrk = vcl_worker_get_current ();
473 vl_api_app_worker_add_del_t *mp;
475 mp = vl_msg_api_alloc (sizeof (*mp));
476 memset (mp, 0, sizeof (*mp));
478 mp->_vl_msg_id = ntohs (VL_API_APP_WORKER_ADD_DEL);
479 mp->client_index = wrk->my_client_index;
480 mp->app_index = clib_host_to_net_u32 (vcm->app_index);
481 mp->context = wrk->wrk_index;
484 mp->wrk_index = clib_host_to_net_u32 (wrk->vpp_wrk_index);
486 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & mp);
490 vcl_send_child_worker_del (vcl_worker_t * child_wrk)
492 vcl_worker_t *wrk = vcl_worker_get_current ();
493 vl_api_app_worker_add_del_t *mp;
495 mp = vl_msg_api_alloc (sizeof (*mp));
496 memset (mp, 0, sizeof (*mp));
498 mp->_vl_msg_id = ntohs (VL_API_APP_WORKER_ADD_DEL);
499 mp->client_index = wrk->my_client_index;
500 mp->app_index = clib_host_to_net_u32 (vcm->app_index);
501 mp->context = wrk->wrk_index;
503 mp->wrk_index = clib_host_to_net_u32 (child_wrk->vpp_wrk_index);
505 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & mp);
509 vppcom_send_connect_sock (vcl_session_t * session)
511 vcl_worker_t *wrk = vcl_worker_get_current ();
512 vl_api_connect_sock_t *cmp;
514 cmp = vl_msg_api_alloc (sizeof (*cmp));
515 memset (cmp, 0, sizeof (*cmp));
516 cmp->_vl_msg_id = ntohs (VL_API_CONNECT_SOCK);
517 cmp->client_index = wrk->my_client_index;
518 cmp->context = session->session_index;
519 cmp->wrk_index = wrk->vpp_wrk_index;
520 cmp->is_ip4 = session->transport.is_ip4;
521 clib_memcpy_fast (cmp->ip, &session->transport.rmt_ip, sizeof (cmp->ip));
522 cmp->port = session->transport.rmt_port;
523 cmp->proto = session->session_type;
524 clib_memcpy_fast (cmp->options, session->options, sizeof (cmp->options));
525 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & cmp);
529 vppcom_send_disconnect_session (u64 vpp_handle)
531 vcl_worker_t *wrk = vcl_worker_get_current ();
532 vl_api_disconnect_session_t *dmp;
534 dmp = vl_msg_api_alloc (sizeof (*dmp));
535 memset (dmp, 0, sizeof (*dmp));
536 dmp->_vl_msg_id = ntohs (VL_API_DISCONNECT_SESSION);
537 dmp->client_index = wrk->my_client_index;
538 dmp->handle = vpp_handle;
539 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & dmp);
542 /* VPP combines bind and listen as one operation. VCL manages the separation
543 * of bind and listen locally via vppcom_session_bind() and
544 * vppcom_session_listen() */
546 vppcom_send_bind_sock (vcl_session_t * session)
548 vcl_worker_t *wrk = vcl_worker_get_current ();
549 vl_api_bind_sock_t *bmp;
551 /* Assumes caller has acquired spinlock: vcm->sessions_lockp */
552 bmp = vl_msg_api_alloc (sizeof (*bmp));
553 memset (bmp, 0, sizeof (*bmp));
555 bmp->_vl_msg_id = ntohs (VL_API_BIND_SOCK);
556 bmp->client_index = wrk->my_client_index;
557 bmp->context = session->session_index;
558 bmp->wrk_index = wrk->vpp_wrk_index;
559 bmp->is_ip4 = session->transport.is_ip4;
560 clib_memcpy_fast (bmp->ip, &session->transport.lcl_ip, sizeof (bmp->ip));
561 bmp->port = session->transport.lcl_port;
562 bmp->proto = session->session_type;
563 clib_memcpy_fast (bmp->options, session->options, sizeof (bmp->options));
564 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & bmp);
568 vppcom_send_unbind_sock (u64 vpp_handle)
570 vcl_worker_t *wrk = vcl_worker_get_current ();
571 vl_api_unbind_sock_t *ump;
573 ump = vl_msg_api_alloc (sizeof (*ump));
574 memset (ump, 0, sizeof (*ump));
576 ump->_vl_msg_id = ntohs (VL_API_UNBIND_SOCK);
577 ump->client_index = wrk->my_client_index;
578 ump->wrk_index = wrk->vpp_wrk_index;
579 ump->handle = vpp_handle;
580 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & ump);
584 vppcom_send_accept_session_reply (u64 handle, u32 context, int retval)
586 vcl_worker_t *wrk = vcl_worker_get_current ();
587 vl_api_accept_session_reply_t *rmp;
589 rmp = vl_msg_api_alloc (sizeof (*rmp));
590 memset (rmp, 0, sizeof (*rmp));
591 rmp->_vl_msg_id = ntohs (VL_API_ACCEPT_SESSION_REPLY);
592 rmp->retval = htonl (retval);
593 rmp->context = context;
594 rmp->handle = handle;
595 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & rmp);
599 vcl_max_nsid_len (void)
601 vl_api_application_attach_t *mp;
602 return (sizeof (mp->namespace_id) - 1);
606 vppcom_init_error_string_table (void)
608 vcm->error_string_by_error_number = hash_create (0, sizeof (uword));
610 #define _(n, v, s) hash_set (vcm->error_string_by_error_number, -v, s);
611 foreach_vnet_api_error;
614 hash_set (vcm->error_string_by_error_number, 99, "Misc");
618 vppcom_connect_to_vpp (char *app_name)
620 vcl_worker_t *wrk = vcl_worker_get_current ();
621 api_main_t *am = &api_main;
622 vppcom_cfg_t *vcl_cfg = &vcm->cfg;
624 if (vcl_cfg->vpp_api_socket_name)
626 if (vl_socket_client_connect ((char *) vcl_cfg->vpp_api_socket_name,
627 app_name, 0 /* default rx/tx buffer */ ))
629 VERR ("app (%s) socket connect failed!", app_name);
630 return VPPCOM_ECONNREFUSED;
633 if (vl_socket_client_init_shm (0))
635 VERR ("app (%s) init shm failed!", app_name);
636 return VPPCOM_ECONNREFUSED;
641 if (!vcl_cfg->vpp_api_filename)
642 vcl_cfg->vpp_api_filename = format (0, "/vpe-api%c", 0);
644 VDBG (0, "app (%s) connecting to VPP api (%s)...",
645 app_name, vcl_cfg->vpp_api_filename);
647 if (vl_client_connect_to_vlib ((char *) vcl_cfg->vpp_api_filename,
648 app_name, vcm->cfg.vpp_api_q_length) < 0)
650 VERR ("app (%s) connect failed!", app_name);
651 return VPPCOM_ECONNREFUSED;
656 wrk->vl_input_queue = am->shmem_hdr->vl_input_queue;
657 wrk->my_client_index = (u32) am->my_client_index;
658 wrk->wrk_state = STATE_APP_CONN_VPP;
660 VDBG (0, "app (%s) is connected to VPP!", app_name);
661 vcl_evt (VCL_EVT_INIT, vcm);
666 * fd.io coding-style-patch-verification: ON
669 * eval: (c-set-style "gnu")