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 (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_private_t *segment;
94 segment_index = vcl_segment_table_lookup (segment_handle);
95 if (segment_index == (u32) ~ 0)
97 segment = svm_fifo_segment_get_segment (segment_index);
98 svm_fifo_segment_delete (segment);
99 vcl_segment_table_del (segment_handle);
103 vcl_vpp_worker_segment_handle (u32 wrk_index)
105 return (VCL_INVALID_SEGMENT_HANDLE - wrk_index - 1);
109 vl_api_application_attach_reply_t_handler (vl_api_application_attach_reply_t *
112 vcl_worker_t *wrk = vcl_worker_get (0);
119 clib_warning ("VCL<%d>: attach failed: %U", getpid (),
120 format_api_error, ntohl (mp->retval));
124 wrk->app_event_queue = uword_to_pointer (mp->app_event_queue_address,
126 segment_handle = clib_net_to_host_u64 (mp->segment_handle);
127 if (segment_handle == VCL_INVALID_SEGMENT_HANDLE)
129 clib_warning ("invalid segment handle");
135 vec_validate (fds, mp->n_fds);
136 vl_socket_client_recv_fd_msg (fds, mp->n_fds, 5);
138 if (mp->fd_flags & SESSION_FD_F_VPP_MQ_SEGMENT)
139 if (vcl_segment_attach (vcl_vpp_worker_segment_handle (0),
140 "vpp-mq-seg", SSVM_SEGMENT_MEMFD,
144 if (mp->fd_flags & SESSION_FD_F_MEMFD_SEGMENT)
145 if (vcl_segment_attach (segment_handle, (char *) mp->segment_name,
146 SSVM_SEGMENT_MEMFD, fds[n_fds++]))
149 if (mp->fd_flags & SESSION_FD_F_MQ_EVENTFD)
151 svm_msg_q_set_consumer_eventfd (wrk->app_event_queue, fds[n_fds]);
152 vcl_mq_epoll_add_evfd (wrk, wrk->app_event_queue);
160 if (vcl_segment_attach (segment_handle, (char *) mp->segment_name,
161 SSVM_SEGMENT_SHM, -1))
165 vcm->app_index = clib_net_to_host_u32 (mp->app_index);
166 vcm->app_state = STATE_APP_ATTACHED;
170 vl_api_app_worker_add_del_reply_t_handler (vl_api_app_worker_add_del_reply_t *
173 int n_fds = 0, *fds = 0;
180 clib_warning ("VCL<%d>: add/del worker failed: %U", getpid (),
181 format_api_error, ntohl (mp->retval));
184 wrk_index = mp->context;
185 wrk = vcl_worker_get (wrk_index);
186 wrk->vpp_wrk_index = clib_net_to_host_u32 (mp->wrk_index);
191 wrk->app_event_queue = uword_to_pointer (mp->app_event_queue_address,
194 segment_handle = clib_net_to_host_u64 (mp->segment_handle);
195 if (segment_handle == VCL_INVALID_SEGMENT_HANDLE)
197 clib_warning ("invalid segment handle");
203 vec_validate (fds, mp->n_fds);
204 vl_socket_client_recv_fd_msg (fds, mp->n_fds, 5);
206 if (mp->fd_flags & SESSION_FD_F_VPP_MQ_SEGMENT)
207 if (vcl_segment_attach
208 (vcl_vpp_worker_segment_handle (wrk->wrk_index), "vpp-worker-seg",
209 SSVM_SEGMENT_MEMFD, fds[n_fds++]))
212 if (mp->fd_flags & SESSION_FD_F_MEMFD_SEGMENT)
213 if (vcl_segment_attach (segment_handle, (char *) mp->segment_name,
214 SSVM_SEGMENT_MEMFD, fds[n_fds++]))
217 if (mp->fd_flags & SESSION_FD_F_MQ_EVENTFD)
219 svm_msg_q_set_consumer_eventfd (wrk->app_event_queue, fds[n_fds]);
220 vcl_mq_epoll_add_evfd (wrk, wrk->app_event_queue);
228 if (vcl_segment_attach (segment_handle, (char *) mp->segment_name,
229 SSVM_SEGMENT_SHM, -1))
232 vcm->app_state = STATE_APP_READY;
233 VDBG (0, "worker %u vpp-worker %u added", wrk_index, wrk->vpp_wrk_index);
237 vcm->app_state = STATE_APP_FAILED;
241 vl_api_application_detach_reply_t_handler (vl_api_application_detach_reply_t *
245 clib_warning ("VCL<%d>: detach failed: %U", getpid (), format_api_error,
248 vcm->app_state = STATE_APP_ENABLED;
252 vl_api_map_another_segment_t_handler (vl_api_map_another_segment_t * mp)
254 ssvm_segment_type_t seg_type = SSVM_SEGMENT_SHM;
260 vl_socket_client_recv_fd_msg (&fd, 1, 5);
261 seg_type = SSVM_SEGMENT_MEMFD;
264 segment_handle = clib_net_to_host_u64 (mp->segment_handle);
265 if (segment_handle == VCL_INVALID_SEGMENT_HANDLE)
267 clib_warning ("invalid segment handle");
271 if (vcl_segment_attach (segment_handle, (char *) mp->segment_name,
274 clib_warning ("VCL<%d>: svm_fifo_segment_attach ('%s') failed",
275 getpid (), mp->segment_name);
279 VDBG (1, "VCL<%d>: mapped new segment '%s' size %d", getpid (),
280 mp->segment_name, mp->segment_size);
284 vl_api_unmap_segment_t_handler (vl_api_unmap_segment_t * mp)
286 u64 segment_handle = clib_net_to_host_u64 (mp->segment_handle);
287 vcl_segment_detach (segment_handle);
288 VDBG (1, "Unmapped segment: %d", segment_handle);
292 vl_api_app_cut_through_registration_add_t_handler
293 (vl_api_app_cut_through_registration_add_t * mp)
295 vcl_cut_through_registration_t *ctr;
302 ASSERT (mp->n_fds == 2);
303 vec_validate (fds, mp->n_fds);
304 vl_socket_client_recv_fd_msg (fds, mp->n_fds, 5);
307 wrk = vcl_worker_get (mp->wrk_index);
308 ctr = vcl_ct_registration_lock_and_alloc (wrk);
309 ctr->mq = uword_to_pointer (mp->evt_q_address, svm_msg_q_t *);
310 ctr->peer_mq = uword_to_pointer (mp->peer_evt_q_address, svm_msg_q_t *);
311 VDBG (0, "Adding ct registration %u", vcl_ct_registration_index (wrk, ctr));
313 if (mp->n_fds && (mp->fd_flags & SESSION_FD_F_MQ_EVENTFD))
315 svm_msg_q_set_consumer_eventfd (ctr->mq, fds[0]);
316 svm_msg_q_set_producer_eventfd (ctr->peer_mq, fds[1]);
317 mqc_index = vcl_mq_epoll_add_evfd (wrk, ctr->mq);
318 ctr->epoll_evt_conn_index = mqc_index;
321 vcl_ct_registration_lookup_add (wrk, mp->evt_q_address,
322 vcl_ct_registration_index (wrk, ctr));
323 vcl_ct_registration_unlock (wrk);
327 vl_api_bind_sock_reply_t_handler (vl_api_bind_sock_reply_t * mp)
329 /* Expecting a similar message on mq. So ignore this */
330 VDBG (1, "VCL<%d>: bapi msg vpp handle 0x%llx, sid %u: bind retval: %u!",
331 getpid (), mp->handle, mp->context, mp->retval);
335 vl_api_unbind_sock_reply_t_handler (vl_api_unbind_sock_reply_t * mp)
338 clib_warning ("VCL<%d>: ERROR: sid %u: unbind failed: %U",
339 getpid (), mp->context, format_api_error,
343 VDBG (1, "VCL<%d>: sid %u: unbind succeeded!", getpid (), mp->context);
347 vl_api_disconnect_session_reply_t_handler (vl_api_disconnect_session_reply_t *
351 clib_warning ("VCL<%d>: ERROR: sid %u: disconnect failed: %U",
352 getpid (), mp->context, format_api_error,
357 vl_api_connect_session_reply_t_handler (vl_api_connect_sock_reply_t * mp)
360 clib_warning ("VCL<%d>: ERROR: sid %u: connect failed: %U",
361 getpid (), mp->context, format_api_error,
365 #define foreach_sock_msg \
366 _(SESSION_ENABLE_DISABLE_REPLY, session_enable_disable_reply) \
367 _(BIND_SOCK_REPLY, bind_sock_reply) \
368 _(UNBIND_SOCK_REPLY, unbind_sock_reply) \
369 _(CONNECT_SESSION_REPLY, connect_session_reply) \
370 _(DISCONNECT_SESSION_REPLY, disconnect_session_reply) \
371 _(APPLICATION_ATTACH_REPLY, application_attach_reply) \
372 _(APPLICATION_DETACH_REPLY, application_detach_reply) \
373 _(MAP_ANOTHER_SEGMENT, map_another_segment) \
374 _(UNMAP_SEGMENT, unmap_segment) \
375 _(APP_CUT_THROUGH_REGISTRATION_ADD, app_cut_through_registration_add) \
376 _(APP_WORKER_ADD_DEL_REPLY, app_worker_add_del_reply) \
379 vppcom_api_hookup (void)
382 vl_msg_api_set_handlers(VL_API_##N, #n, \
383 vl_api_##n##_t_handler, \
385 vl_api_##n##_t_endian, \
386 vl_api_##n##_t_print, \
387 sizeof(vl_api_##n##_t), 1);
393 * VPP-API message functions
396 vppcom_send_session_enable_disable (u8 is_enable)
398 vcl_worker_t *wrk = vcl_worker_get_current ();
399 vl_api_session_enable_disable_t *bmp;
400 bmp = vl_msg_api_alloc (sizeof (*bmp));
401 memset (bmp, 0, sizeof (*bmp));
403 bmp->_vl_msg_id = ntohs (VL_API_SESSION_ENABLE_DISABLE);
404 bmp->client_index = wrk->my_client_index;
405 bmp->context = htonl (0xfeedface);
406 bmp->is_enable = is_enable;
407 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & bmp);
411 vppcom_app_send_attach (void)
413 vcl_worker_t *wrk = vcl_worker_get_current ();
414 vl_api_application_attach_t *bmp;
415 u8 nsid_len = vec_len (vcm->cfg.namespace_id);
416 u8 app_is_proxy = (vcm->cfg.app_proxy_transport_tcp ||
417 vcm->cfg.app_proxy_transport_udp);
419 bmp = vl_msg_api_alloc (sizeof (*bmp));
420 memset (bmp, 0, sizeof (*bmp));
422 bmp->_vl_msg_id = ntohs (VL_API_APPLICATION_ATTACH);
423 bmp->client_index = wrk->my_client_index;
424 bmp->context = htonl (0xfeedface);
425 bmp->options[APP_OPTIONS_FLAGS] =
426 APP_OPTIONS_FLAGS_ACCEPT_REDIRECT | APP_OPTIONS_FLAGS_ADD_SEGMENT |
427 (vcm->cfg.app_scope_local ? APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE : 0) |
428 (vcm->cfg.app_scope_global ? APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE : 0) |
429 (app_is_proxy ? APP_OPTIONS_FLAGS_IS_PROXY : 0) |
430 APP_OPTIONS_FLAGS_USE_MQ_FOR_CTRL_MSGS |
431 (vcm->cfg.use_mq_eventfd ? APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD : 0);
432 bmp->options[APP_OPTIONS_PROXY_TRANSPORT] =
433 (u64) ((vcm->cfg.app_proxy_transport_tcp ? 1 << TRANSPORT_PROTO_TCP : 0) |
434 (vcm->cfg.app_proxy_transport_udp ? 1 << TRANSPORT_PROTO_UDP : 0));
435 bmp->options[APP_OPTIONS_SEGMENT_SIZE] = vcm->cfg.segment_size;
436 bmp->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = vcm->cfg.add_segment_size;
437 bmp->options[APP_OPTIONS_RX_FIFO_SIZE] = vcm->cfg.rx_fifo_size;
438 bmp->options[APP_OPTIONS_TX_FIFO_SIZE] = vcm->cfg.tx_fifo_size;
439 bmp->options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] =
440 vcm->cfg.preallocated_fifo_pairs;
441 bmp->options[APP_OPTIONS_EVT_QUEUE_SIZE] = vcm->cfg.event_queue_size;
444 bmp->namespace_id_len = nsid_len;
445 clib_memcpy_fast (bmp->namespace_id, vcm->cfg.namespace_id, nsid_len);
446 bmp->options[APP_OPTIONS_NAMESPACE_SECRET] = vcm->cfg.namespace_secret;
448 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & bmp);
452 vppcom_app_send_detach (void)
454 vcl_worker_t *wrk = vcl_worker_get_current ();
455 vl_api_application_detach_t *bmp;
456 bmp = vl_msg_api_alloc (sizeof (*bmp));
457 memset (bmp, 0, sizeof (*bmp));
459 bmp->_vl_msg_id = ntohs (VL_API_APPLICATION_DETACH);
460 bmp->client_index = wrk->my_client_index;
461 bmp->context = htonl (0xfeedface);
462 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & bmp);
466 vcl_send_app_worker_add_del (u8 is_add)
468 vcl_worker_t *wrk = vcl_worker_get_current ();
469 vl_api_app_worker_add_del_t *mp;
470 u32 wrk_index = wrk->wrk_index;
472 mp = vl_msg_api_alloc (sizeof (*mp));
473 memset (mp, 0, sizeof (*mp));
475 mp->_vl_msg_id = ntohs (VL_API_APP_WORKER_ADD_DEL);
476 mp->client_index = wrk->my_client_index;
477 mp->app_index = clib_host_to_net_u32 (vcm->app_index);
478 mp->context = wrk_index;
481 mp->wrk_index = clib_host_to_net_u32 (wrk_index);
483 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & mp);
487 vppcom_send_connect_sock (vcl_session_t * session)
489 vcl_worker_t *wrk = vcl_worker_get_current ();
490 vl_api_connect_sock_t *cmp;
492 cmp = vl_msg_api_alloc (sizeof (*cmp));
493 memset (cmp, 0, sizeof (*cmp));
494 cmp->_vl_msg_id = ntohs (VL_API_CONNECT_SOCK);
495 cmp->client_index = wrk->my_client_index;
496 cmp->context = session->session_index;
497 cmp->wrk_index = wrk->vpp_wrk_index;
498 cmp->is_ip4 = session->transport.is_ip4;
499 clib_memcpy_fast (cmp->ip, &session->transport.rmt_ip, sizeof (cmp->ip));
500 cmp->port = session->transport.rmt_port;
501 cmp->proto = session->session_type;
502 clib_memcpy_fast (cmp->options, session->options, sizeof (cmp->options));
503 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & cmp);
507 vppcom_send_disconnect_session (u64 vpp_handle)
509 vcl_worker_t *wrk = vcl_worker_get_current ();
510 vl_api_disconnect_session_t *dmp;
512 dmp = vl_msg_api_alloc (sizeof (*dmp));
513 memset (dmp, 0, sizeof (*dmp));
514 dmp->_vl_msg_id = ntohs (VL_API_DISCONNECT_SESSION);
515 dmp->client_index = wrk->my_client_index;
516 dmp->handle = vpp_handle;
517 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & dmp);
520 /* VPP combines bind and listen as one operation. VCL manages the separation
521 * of bind and listen locally via vppcom_session_bind() and
522 * vppcom_session_listen() */
524 vppcom_send_bind_sock (vcl_session_t * session)
526 vcl_worker_t *wrk = vcl_worker_get_current ();
527 vl_api_bind_sock_t *bmp;
529 /* Assumes caller has acquired spinlock: vcm->sessions_lockp */
530 bmp = vl_msg_api_alloc (sizeof (*bmp));
531 memset (bmp, 0, sizeof (*bmp));
533 bmp->_vl_msg_id = ntohs (VL_API_BIND_SOCK);
534 bmp->client_index = wrk->my_client_index;
535 bmp->context = session->session_index;
536 bmp->wrk_index = wrk->vpp_wrk_index;
537 bmp->is_ip4 = session->transport.is_ip4;
538 clib_memcpy_fast (bmp->ip, &session->transport.lcl_ip, sizeof (bmp->ip));
539 bmp->port = session->transport.lcl_port;
540 bmp->proto = session->session_type;
541 clib_memcpy_fast (bmp->options, session->options, sizeof (bmp->options));
542 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & bmp);
546 vppcom_send_unbind_sock (u64 vpp_handle)
548 vcl_worker_t *wrk = vcl_worker_get_current ();
549 vl_api_unbind_sock_t *ump;
551 ump = vl_msg_api_alloc (sizeof (*ump));
552 memset (ump, 0, sizeof (*ump));
554 ump->_vl_msg_id = ntohs (VL_API_UNBIND_SOCK);
555 ump->client_index = wrk->my_client_index;
556 ump->wrk_index = wrk->vpp_wrk_index;
557 ump->handle = vpp_handle;
558 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & ump);
562 vppcom_send_accept_session_reply (u64 handle, u32 context, int retval)
564 vcl_worker_t *wrk = vcl_worker_get_current ();
565 vl_api_accept_session_reply_t *rmp;
567 rmp = vl_msg_api_alloc (sizeof (*rmp));
568 memset (rmp, 0, sizeof (*rmp));
569 rmp->_vl_msg_id = ntohs (VL_API_ACCEPT_SESSION_REPLY);
570 rmp->retval = htonl (retval);
571 rmp->context = context;
572 rmp->handle = handle;
573 vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & rmp);
577 vcl_max_nsid_len (void)
579 vl_api_application_attach_t *mp;
580 return (sizeof (mp->namespace_id) - 1);
584 vppcom_init_error_string_table (void)
586 vcm->error_string_by_error_number = hash_create (0, sizeof (uword));
588 #define _(n, v, s) hash_set (vcm->error_string_by_error_number, -v, s);
589 foreach_vnet_api_error;
592 hash_set (vcm->error_string_by_error_number, 99, "Misc");
596 vppcom_connect_to_vpp (char *app_name)
598 vcl_worker_t *wrk = vcl_worker_get_current ();
599 api_main_t *am = &api_main;
600 vppcom_cfg_t *vcl_cfg = &vcm->cfg;
602 if (vcl_cfg->vpp_api_socket_name)
604 if (vl_socket_client_connect ((char *) vcl_cfg->vpp_api_socket_name,
605 app_name, 0 /* default rx/tx buffer */ ))
607 VERR ("app (%s) socket connect failed!", app_name);
608 return VPPCOM_ECONNREFUSED;
611 if (vl_socket_client_init_shm (0))
613 VERR ("app (%s) init shm failed!", app_name);
614 return VPPCOM_ECONNREFUSED;
619 if (!vcl_cfg->vpp_api_filename)
620 vcl_cfg->vpp_api_filename = format (0, "/vpe-api%c", 0);
622 VDBG (0, "app (%s) connecting to VPP api (%s)...",
623 app_name, vcl_cfg->vpp_api_filename);
625 if (vl_client_connect_to_vlib ((char *) vcl_cfg->vpp_api_filename,
626 app_name, vcm->cfg.vpp_api_q_length) < 0)
628 VERR ("app (%s) connect failed!", app_name);
629 return VPPCOM_ECONNREFUSED;
634 wrk->vl_input_queue = am->shmem_hdr->vl_input_queue;
635 wrk->my_client_index = (u32) am->my_client_index;
636 wrk->wrk_state = STATE_APP_CONN_VPP;
638 VDBG (0, "app (%s) is connected to VPP!", app_name);
639 vcl_evt (VCL_EVT_INIT, vcm);
644 * fd.io coding-style-patch-verification: ON
647 * eval: (c-set-style "gnu")