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 ssvm_segment_attach (char *name, ssvm_segment_type_t type, int fd)
67 svm_fifo_segment_create_args_t _a, *a = &_a;
70 memset (a, 0, sizeof (*a));
71 a->segment_name = (char *) name;
72 a->segment_type = type;
74 if (type == SSVM_SEGMENT_MEMFD)
77 if ((rv = svm_fifo_segment_attach (a)))
79 clib_warning ("svm_fifo_segment_attach ('%s') failed", name);
82 vec_reset_length (a->new_segment_indices);
87 vl_api_application_attach_reply_t_handler (vl_api_application_attach_reply_t *
90 vcl_worker_t *wrk = vcl_worker_get (0);
96 clib_warning ("VCL<%d>: attach failed: %U", getpid (),
97 format_api_error, ntohl (mp->retval));
101 wrk->app_event_queue = uword_to_pointer (mp->app_event_queue_address,
105 vec_validate (fds, mp->n_fds);
106 vl_socket_client_recv_fd_msg (fds, mp->n_fds, 5);
108 if (mp->fd_flags & SESSION_FD_F_VPP_MQ_SEGMENT)
109 if (ssvm_segment_attach ("vpp-mq-seg", SSVM_SEGMENT_MEMFD,
113 if (mp->fd_flags & SESSION_FD_F_MEMFD_SEGMENT)
114 if (ssvm_segment_attach ((char *) mp->segment_name,
115 SSVM_SEGMENT_MEMFD, fds[n_fds++]))
118 if (mp->fd_flags & SESSION_FD_F_MQ_EVENTFD)
120 svm_msg_q_set_consumer_eventfd (wrk->app_event_queue, fds[n_fds]);
121 vcl_mq_epoll_add_evfd (wrk, wrk->app_event_queue);
129 if (ssvm_segment_attach ((char *) mp->segment_name, SSVM_SEGMENT_SHM,
134 vcm->app_state = STATE_APP_ATTACHED;
138 vl_api_app_worker_add_del_reply_t_handler (vl_api_app_worker_add_del_reply_t *
141 int n_fds = 0, *fds = 0;
147 clib_warning ("VCL<%d>: add/del worker failed: %U", getpid (),
148 format_api_error, ntohl (mp->retval));
151 wrk_index = clib_net_to_host_u32 (mp->wrk_index);
152 if (mp->context != wrk_index)
154 clib_warning ("VCL<%d>: wrk numbering doesn't match ours: %u, vpp: %u",
155 getpid (), mp->context, wrk_index);
158 wrk = vcl_worker_get (wrk_index);
159 wrk->app_event_queue = uword_to_pointer (mp->app_event_queue_address,
164 vec_validate (fds, mp->n_fds);
165 vl_socket_client_recv_fd_msg (fds, mp->n_fds, 5);
167 if (mp->fd_flags & SESSION_FD_F_VPP_MQ_SEGMENT)
168 if (ssvm_segment_attach ("vpp-worker-seg", SSVM_SEGMENT_MEMFD,
172 if (mp->fd_flags & SESSION_FD_F_MEMFD_SEGMENT)
173 if (ssvm_segment_attach ((char *) mp->segment_name,
174 SSVM_SEGMENT_MEMFD, fds[n_fds++]))
177 if (mp->fd_flags & SESSION_FD_F_MQ_EVENTFD)
179 svm_msg_q_set_consumer_eventfd (wrk->app_event_queue, fds[n_fds]);
180 vcl_mq_epoll_add_evfd (wrk, wrk->app_event_queue);
188 if (ssvm_segment_attach ((char *) mp->segment_name, SSVM_SEGMENT_SHM,
192 vcm->app_state = STATE_APP_READY;
196 vcm->app_state = STATE_APP_FAILED;
200 vl_api_application_detach_reply_t_handler (vl_api_application_detach_reply_t *
204 clib_warning ("VCL<%d>: detach failed: %U", getpid (), format_api_error,
207 vcm->app_state = STATE_APP_ENABLED;
211 vl_api_map_another_segment_t_handler (vl_api_map_another_segment_t * mp)
213 ssvm_segment_type_t seg_type = SSVM_SEGMENT_SHM;
216 vcm->mounting_segment = 1;
220 vl_socket_client_recv_fd_msg (&fd, 1, 5);
221 seg_type = SSVM_SEGMENT_MEMFD;
224 if (PREDICT_FALSE (ssvm_segment_attach ((char *) mp->segment_name,
227 clib_warning ("VCL<%d>: svm_fifo_segment_attach ('%s') failed",
228 getpid (), mp->segment_name);
232 VDBG (1, "VCL<%d>: mapped new segment '%s' size %d", getpid (),
233 mp->segment_name, mp->segment_size);
234 vcm->mounting_segment = 0;
238 vl_api_unmap_segment_t_handler (vl_api_unmap_segment_t * mp)
242 * XXX Need segment_name to session_id hash,
243 * XXX - have sessionID by handle hash currently
246 VDBG (1, "Unmapped segment '%s'", mp->segment_name);
250 vl_api_app_cut_through_registration_add_t_handler
251 (vl_api_app_cut_through_registration_add_t * mp)
253 vcl_cut_through_registration_t *ctr;
260 ASSERT (mp->n_fds == 2);
261 vec_validate (fds, mp->n_fds);
262 vl_socket_client_recv_fd_msg (fds, mp->n_fds, 5);
265 wrk = vcl_worker_get (mp->wrk_index);
266 ctr = vcl_ct_registration_lock_and_alloc (wrk);
267 ctr->mq = uword_to_pointer (mp->evt_q_address, svm_msg_q_t *);
268 ctr->peer_mq = uword_to_pointer (mp->peer_evt_q_address, svm_msg_q_t *);
269 VDBG (0, "Adding ct registration %u", vcl_ct_registration_index (wrk, ctr));
271 if (mp->n_fds && (mp->fd_flags & SESSION_FD_F_MQ_EVENTFD))
273 svm_msg_q_set_consumer_eventfd (ctr->mq, fds[0]);
274 svm_msg_q_set_producer_eventfd (ctr->peer_mq, fds[1]);
275 mqc_index = vcl_mq_epoll_add_evfd (wrk, ctr->mq);
276 ctr->epoll_evt_conn_index = mqc_index;
279 vcl_ct_registration_lookup_add (wrk, mp->evt_q_address,
280 vcl_ct_registration_index (wrk, ctr));
281 vcl_ct_registration_unlock (wrk);
285 vl_api_bind_sock_reply_t_handler (vl_api_bind_sock_reply_t * mp)
287 /* Expecting a similar message on mq. So ignore this */
288 VDBG (1, "VCL<%d>: bapi msg vpp handle 0x%llx, sid %u: bind retval: %u!",
289 getpid (), mp->handle, mp->context, mp->retval);
293 vl_api_unbind_sock_reply_t_handler (vl_api_unbind_sock_reply_t * mp)
296 clib_warning ("VCL<%d>: ERROR: sid %u: unbind failed: %U",
297 getpid (), mp->context, format_api_error,
301 VDBG (1, "VCL<%d>: sid %u: unbind succeeded!", getpid (), mp->context);
305 vl_api_disconnect_session_reply_t_handler (vl_api_disconnect_session_reply_t *
309 clib_warning ("VCL<%d>: ERROR: sid %u: disconnect failed: %U",
310 getpid (), mp->context, format_api_error,
315 vl_api_connect_sock_reply_t_handler (vl_api_connect_sock_reply_t * mp)
318 clib_warning ("VCL<%d>: ERROR: sid %u: connect failed: %U",
319 getpid (), mp->context, format_api_error,
323 #define foreach_sock_msg \
324 _(SESSION_ENABLE_DISABLE_REPLY, session_enable_disable_reply) \
325 _(BIND_SOCK_REPLY, bind_sock_reply) \
326 _(UNBIND_SOCK_REPLY, unbind_sock_reply) \
327 _(CONNECT_SOCK_REPLY, connect_sock_reply) \
328 _(DISCONNECT_SESSION_REPLY, disconnect_session_reply) \
329 _(APPLICATION_ATTACH_REPLY, application_attach_reply) \
330 _(APPLICATION_DETACH_REPLY, application_detach_reply) \
331 _(MAP_ANOTHER_SEGMENT, map_another_segment) \
332 _(UNMAP_SEGMENT, unmap_segment) \
333 _(APP_CUT_THROUGH_REGISTRATION_ADD, app_cut_through_registration_add) \
334 _(APP_WORKER_ADD_DEL_REPLY, app_worker_add_del_reply) \
337 vppcom_api_hookup (void)
340 vl_msg_api_set_handlers(VL_API_##N, #n, \
341 vl_api_##n##_t_handler, \
343 vl_api_##n##_t_endian, \
344 vl_api_##n##_t_print, \
345 sizeof(vl_api_##n##_t), 1);
351 * VPP-API message functions
354 vppcom_send_session_enable_disable (u8 is_enable)
356 vl_api_session_enable_disable_t *bmp;
357 bmp = vl_msg_api_alloc (sizeof (*bmp));
358 memset (bmp, 0, sizeof (*bmp));
360 bmp->_vl_msg_id = ntohs (VL_API_SESSION_ENABLE_DISABLE);
361 bmp->client_index = vcm->my_client_index;
362 bmp->context = htonl (0xfeedface);
363 bmp->is_enable = is_enable;
364 vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & bmp);
368 vppcom_app_send_attach (void)
370 vl_api_application_attach_t *bmp;
371 u8 nsid_len = vec_len (vcm->cfg.namespace_id);
372 u8 app_is_proxy = (vcm->cfg.app_proxy_transport_tcp ||
373 vcm->cfg.app_proxy_transport_udp);
375 bmp = vl_msg_api_alloc (sizeof (*bmp));
376 memset (bmp, 0, sizeof (*bmp));
378 bmp->_vl_msg_id = ntohs (VL_API_APPLICATION_ATTACH);
379 bmp->client_index = vcm->my_client_index;
380 bmp->context = htonl (0xfeedface);
381 bmp->options[APP_OPTIONS_FLAGS] =
382 APP_OPTIONS_FLAGS_ACCEPT_REDIRECT | APP_OPTIONS_FLAGS_ADD_SEGMENT |
383 (vcm->cfg.app_scope_local ? APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE : 0) |
384 (vcm->cfg.app_scope_global ? APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE : 0) |
385 (app_is_proxy ? APP_OPTIONS_FLAGS_IS_PROXY : 0) |
386 APP_OPTIONS_FLAGS_USE_MQ_FOR_CTRL_MSGS |
387 (vcm->cfg.use_mq_eventfd ? APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD : 0);
388 bmp->options[APP_OPTIONS_PROXY_TRANSPORT] =
389 (u64) ((vcm->cfg.app_proxy_transport_tcp ? 1 << TRANSPORT_PROTO_TCP : 0) |
390 (vcm->cfg.app_proxy_transport_udp ? 1 << TRANSPORT_PROTO_UDP : 0));
391 bmp->options[APP_OPTIONS_SEGMENT_SIZE] = vcm->cfg.segment_size;
392 bmp->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = vcm->cfg.add_segment_size;
393 bmp->options[APP_OPTIONS_RX_FIFO_SIZE] = vcm->cfg.rx_fifo_size;
394 bmp->options[APP_OPTIONS_TX_FIFO_SIZE] = vcm->cfg.tx_fifo_size;
395 bmp->options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] =
396 vcm->cfg.preallocated_fifo_pairs;
397 bmp->options[APP_OPTIONS_EVT_QUEUE_SIZE] = vcm->cfg.event_queue_size;
400 bmp->namespace_id_len = nsid_len;
401 clib_memcpy (bmp->namespace_id, vcm->cfg.namespace_id, nsid_len);
402 bmp->options[APP_OPTIONS_NAMESPACE_SECRET] = vcm->cfg.namespace_secret;
404 vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & bmp);
408 vppcom_app_send_detach (void)
410 vl_api_application_detach_t *bmp;
411 bmp = vl_msg_api_alloc (sizeof (*bmp));
412 memset (bmp, 0, sizeof (*bmp));
414 bmp->_vl_msg_id = ntohs (VL_API_APPLICATION_DETACH);
415 bmp->client_index = vcm->my_client_index;
416 bmp->context = htonl (0xfeedface);
417 vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & bmp);
421 vcl_send_app_worker_add_del (u8 is_add)
423 vcl_worker_t *wrk = vcl_worker_get_current ();
424 vl_api_app_worker_add_del_t *mp;
425 u32 wrk_index = wrk->wrk_index;
427 mp = vl_msg_api_alloc (sizeof (*mp));
428 memset (mp, 0, sizeof (*mp));
430 mp->_vl_msg_id = ntohs (VL_API_APP_WORKER_ADD_DEL);
431 mp->client_index = vcm->my_client_index;
432 mp->context = wrk_index;
435 mp->wrk_index = clib_host_to_net_u32 (wrk_index);
437 vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & mp);
441 vppcom_send_connect_sock (vcl_session_t * session)
443 vl_api_connect_sock_t *cmp;
445 cmp = vl_msg_api_alloc (sizeof (*cmp));
446 memset (cmp, 0, sizeof (*cmp));
447 cmp->_vl_msg_id = ntohs (VL_API_CONNECT_SOCK);
448 cmp->client_index = vcm->my_client_index;
449 cmp->context = session->session_index;
450 cmp->wrk_index = vcl_get_worker_index ();
451 cmp->is_ip4 = session->transport.is_ip4;
452 clib_memcpy (cmp->ip, &session->transport.rmt_ip, sizeof (cmp->ip));
453 cmp->port = session->transport.rmt_port;
454 cmp->proto = session->session_type;
455 clib_memcpy (cmp->options, session->options, sizeof (cmp->options));
456 vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & cmp);
460 vppcom_send_disconnect_session (u64 vpp_handle)
462 vl_api_disconnect_session_t *dmp;
464 dmp = vl_msg_api_alloc (sizeof (*dmp));
465 memset (dmp, 0, sizeof (*dmp));
466 dmp->_vl_msg_id = ntohs (VL_API_DISCONNECT_SESSION);
467 dmp->client_index = vcm->my_client_index;
468 dmp->handle = vpp_handle;
469 vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & dmp);
472 /* VPP combines bind and listen as one operation. VCL manages the separation
473 * of bind and listen locally via vppcom_session_bind() and
474 * vppcom_session_listen() */
476 vppcom_send_bind_sock (vcl_session_t * session)
478 vl_api_bind_sock_t *bmp;
480 /* Assumes caller has acquired spinlock: vcm->sessions_lockp */
481 bmp = vl_msg_api_alloc (sizeof (*bmp));
482 memset (bmp, 0, sizeof (*bmp));
484 bmp->_vl_msg_id = ntohs (VL_API_BIND_SOCK);
485 bmp->client_index = vcm->my_client_index;
486 bmp->context = session->session_index;
487 bmp->wrk_index = vcl_get_worker_index ();
488 bmp->is_ip4 = session->transport.is_ip4;
489 clib_memcpy (bmp->ip, &session->transport.lcl_ip, sizeof (bmp->ip));
490 bmp->port = session->transport.lcl_port;
491 bmp->proto = session->session_type;
492 clib_memcpy (bmp->options, session->options, sizeof (bmp->options));
493 vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & bmp);
497 vppcom_send_unbind_sock (u64 vpp_handle)
499 vl_api_unbind_sock_t *ump;
501 ump = vl_msg_api_alloc (sizeof (*ump));
502 memset (ump, 0, sizeof (*ump));
504 ump->_vl_msg_id = ntohs (VL_API_UNBIND_SOCK);
505 ump->client_index = vcm->my_client_index;
506 ump->wrk_index = vcl_get_worker_index ();
507 ump->handle = vpp_handle;
508 vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & ump);
512 vppcom_send_accept_session_reply (u64 handle, u32 context, int retval)
514 vl_api_accept_session_reply_t *rmp;
516 rmp = vl_msg_api_alloc (sizeof (*rmp));
517 memset (rmp, 0, sizeof (*rmp));
518 rmp->_vl_msg_id = ntohs (VL_API_ACCEPT_SESSION_REPLY);
519 rmp->retval = htonl (retval);
520 rmp->context = context;
521 rmp->handle = handle;
522 vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & rmp);
526 vcl_max_nsid_len (void)
528 vl_api_application_attach_t *mp;
529 return (sizeof (mp->namespace_id) - 1);
533 vppcom_init_error_string_table (void)
535 vcm->error_string_by_error_number = hash_create (0, sizeof (uword));
537 #define _(n, v, s) hash_set (vcm->error_string_by_error_number, -v, s);
538 foreach_vnet_api_error;
541 hash_set (vcm->error_string_by_error_number, 99, "Misc");
545 vppcom_connect_to_vpp (char *app_name)
547 api_main_t *am = &api_main;
548 vppcom_cfg_t *vcl_cfg = &vcm->cfg;
550 if (vcl_cfg->vpp_api_socket_name)
552 if (vl_socket_client_connect ((char *) vcl_cfg->vpp_api_socket_name,
553 app_name, 0 /* default rx/tx buffer */ ))
555 clib_warning ("VCL<%d>: app (%s) socket connect failed!",
556 getpid (), app_name);
557 return VPPCOM_ECONNREFUSED;
560 if (vl_socket_client_init_shm (0))
562 clib_warning ("VCL<%d>: app (%s) init shm failed!",
563 getpid (), app_name);
564 return VPPCOM_ECONNREFUSED;
569 if (!vcl_cfg->vpp_api_filename)
570 vcl_cfg->vpp_api_filename = format (0, "/vpe-api%c", 0);
572 VDBG (0, "VCL<%d>: app (%s) connecting to VPP api (%s)...", getpid (),
573 app_name, vcl_cfg->vpp_api_filename);
575 if (vl_client_connect_to_vlib ((char *) vcl_cfg->vpp_api_filename,
576 app_name, vcm->cfg.vpp_api_q_length) < 0)
578 clib_warning ("VCL<%d>: app (%s) connect failed!", getpid (),
580 return VPPCOM_ECONNREFUSED;
585 vcm->vl_input_queue = am->shmem_hdr->vl_input_queue;
586 vcm->my_client_index = (u32) am->my_client_index;
587 vcm->app_state = STATE_APP_CONN_VPP;
589 VDBG (0, "VCL<%d>: app (%s) is connected to VPP!", getpid (), app_name);
591 vcl_evt (VCL_EVT_INIT, vcm);
596 * fd.io coding-style-patch-verification: ON
599 * eval: (c-set-style "gnu")