2 * Copyright (c) 2015-2019 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with 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 <vnet/vnet.h>
17 #include <vlibmemory/api.h>
18 #include <vnet/session/application.h>
19 #include <vnet/session/application_interface.h>
20 #include <vnet/session/application_local.h>
21 #include <vnet/session/session_rules_table.h>
22 #include <vnet/session/session_table.h>
23 #include <vnet/session/session.h>
25 #include <vnet/vnet_msg_enum.h>
27 #define vl_typedefs /* define message structures */
28 #include <vnet/vnet_all_api_h.h>
31 #define vl_endianfun /* define message structures */
32 #include <vnet/vnet_all_api_h.h>
35 /* instantiate all the print functions we know about */
36 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
38 #include <vnet/vnet_all_api_h.h>
41 #include <vlibapi/api_helper_macros.h>
43 #define foreach_session_api_msg \
44 _(MAP_ANOTHER_SEGMENT_REPLY, map_another_segment_reply) \
45 _(APPLICATION_ATTACH, application_attach) \
46 _(APPLICATION_DETACH, application_detach) \
47 _(BIND_URI, bind_uri) \
48 _(UNBIND_URI, unbind_uri) \
49 _(CONNECT_URI, connect_uri) \
50 _(DISCONNECT_SESSION, disconnect_session) \
51 _(DISCONNECT_SESSION_REPLY, disconnect_session_reply) \
52 _(BIND_SOCK, bind_sock) \
53 _(UNBIND_SOCK, unbind_sock) \
54 _(CONNECT_SOCK, connect_sock) \
55 _(SESSION_ENABLE_DISABLE, session_enable_disable) \
56 _(APP_NAMESPACE_ADD_DEL, app_namespace_add_del) \
57 _(SESSION_RULE_ADD_DEL, session_rule_add_del) \
58 _(SESSION_RULES_DUMP, session_rules_dump) \
59 _(APPLICATION_TLS_CERT_ADD, application_tls_cert_add) \
60 _(APPLICATION_TLS_KEY_ADD, application_tls_key_add) \
61 _(APP_WORKER_ADD_DEL, app_worker_add_del) \
64 session_send_fds (vl_api_registration_t * reg, int fds[], int n_fds)
67 if (vl_api_registration_file_index (reg) == VL_API_INVALID_FI)
69 clib_warning ("can't send memfd fd");
72 error = vl_api_send_fd_msg (reg, fds, n_fds);
75 clib_error_report (error);
82 send_add_segment_callback (u32 api_client_index, u64 segment_handle)
84 int fds[SESSION_N_FD_TYPE], n_fds = 0;
85 vl_api_map_another_segment_t *mp;
86 vl_api_registration_t *reg;
91 reg = vl_mem_api_client_index_to_registration (api_client_index);
94 clib_warning ("no api registration for client: %u", api_client_index);
98 fs = segment_manager_get_segment_w_handle (segment_handle);
100 if (ssvm_type (sp) == SSVM_SEGMENT_MEMFD)
102 if (vl_api_registration_file_index (reg) == VL_API_INVALID_FI)
104 clib_warning ("can't send memfd fd");
108 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
113 mp = vl_mem_api_alloc_as_if_client_w_reg (reg, sizeof (*mp));
114 clib_memset (mp, 0, sizeof (*mp));
115 mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_MAP_ANOTHER_SEGMENT);
116 mp->segment_size = sp->ssvm_size;
117 mp->fd_flags = fd_flags;
118 mp->segment_handle = clib_host_to_net_u64 (segment_handle);
119 strncpy ((char *) mp->segment_name, (char *) sp->name,
120 sizeof (mp->segment_name) - 1);
122 vl_msg_api_send_shmem (reg->vl_input_queue, (u8 *) & mp);
125 return session_send_fds (reg, fds, n_fds);
131 send_del_segment_callback (u32 api_client_index, u64 segment_handle)
133 vl_api_unmap_segment_t *mp;
134 vl_api_registration_t *reg;
136 reg = vl_mem_api_client_index_to_registration (api_client_index);
139 clib_warning ("no registration: %u", api_client_index);
143 mp = vl_mem_api_alloc_as_if_client_w_reg (reg, sizeof (*mp));
144 clib_memset (mp, 0, sizeof (*mp));
145 mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_UNMAP_SEGMENT);
146 mp->segment_handle = clib_host_to_net_u64 (segment_handle);
147 vl_msg_api_send_shmem (reg->vl_input_queue, (u8 *) & mp);
153 mq_try_lock_and_alloc_msg (svm_msg_q_t * app_mq, svm_msg_q_msg_t * msg)
159 rv = svm_msg_q_lock_and_alloc_msg_w_ring (app_mq,
160 SESSION_MQ_CTRL_EVT_RING,
167 clib_warning ("failed to alloc msg");
172 mq_send_session_accepted_cb (session_t * s)
174 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
175 svm_msg_q_msg_t _msg, *msg = &_msg;
176 svm_msg_q_t *vpp_queue, *app_mq;
178 session_accepted_msg_t *mp;
179 session_event_t *evt;
182 app = application_get (app_wrk->app_index);
183 app_mq = app_wrk->event_queue;
184 if (mq_try_lock_and_alloc_msg (app_mq, msg))
187 evt = svm_msg_q_msg_data (app_mq, msg);
188 clib_memset (evt, 0, sizeof (*evt));
189 evt->event_type = SESSION_CTRL_EVT_ACCEPTED;
190 mp = (session_accepted_msg_t *) evt->data;
191 clib_memset (mp, 0, sizeof (*mp));
192 mp->context = app->app_index;
193 mp->server_rx_fifo = pointer_to_uword (s->rx_fifo);
194 mp->server_tx_fifo = pointer_to_uword (s->tx_fifo);
195 mp->segment_handle = session_segment_handle (s);
197 if (session_has_transport (s))
199 listener = listen_session_get_from_handle (s->listener_handle);
200 mp->listener_handle = app_listen_session_handle (listener);
201 if (application_is_proxy (app))
204 app_worker_first_listener (app_wrk, session_get_fib_proto (s),
205 session_get_transport_proto (s));
207 mp->listener_handle = listen_session_get_handle (listener);
209 vpp_queue = session_main_get_vpp_event_queue (s->thread_index);
210 mp->vpp_event_queue_address = pointer_to_uword (vpp_queue);
211 mp->handle = session_handle (s);
213 session_get_endpoint (s, &mp->rmt, 0 /* is_lcl */ );
219 ct = (ct_connection_t *) session_get_transport (s);
220 listener = listen_session_get_from_handle (s->listener_handle);
221 mp->listener_handle = app_listen_session_handle (listener);
222 mp->rmt.is_ip4 = session_type_is_ip4 (listener->session_type);
223 mp->rmt.port = ct->c_rmt_port;
224 mp->handle = session_handle (s);
225 vpp_queue = session_main_get_vpp_event_queue (0);
226 mp->vpp_event_queue_address = pointer_to_uword (vpp_queue);
228 svm_msg_q_add_and_unlock (app_mq, msg);
234 mq_send_session_close_evt (app_worker_t * app_wrk, session_handle_t sh,
235 session_evt_type_t evt_type)
237 svm_msg_q_msg_t _msg, *msg = &_msg;
238 session_disconnected_msg_t *mp;
240 session_event_t *evt;
242 app_mq = app_wrk->event_queue;
243 if (mq_try_lock_and_alloc_msg (app_mq, msg))
245 evt = svm_msg_q_msg_data (app_mq, msg);
246 clib_memset (evt, 0, sizeof (*evt));
247 evt->event_type = evt_type;
248 mp = (session_disconnected_msg_t *) evt->data;
250 mp->context = app_wrk->api_client_index;
251 svm_msg_q_add_and_unlock (app_mq, msg);
255 mq_notify_close_subscribers (u32 app_index, session_handle_t sh,
256 svm_fifo_t * f, session_evt_type_t evt_type)
258 app_worker_t *app_wrk;
262 app = application_get (app_index);
266 for (i = 0; i < f->n_subscribers; i++)
268 if (!(app_wrk = application_get_worker (app, f->subscribers[i])))
270 mq_send_session_close_evt (app_wrk, sh, SESSION_CTRL_EVT_DISCONNECTED);
275 mq_send_session_disconnected_cb (session_t * s)
277 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
278 session_handle_t sh = session_handle (s);
280 mq_send_session_close_evt (app_wrk, session_handle (s),
281 SESSION_CTRL_EVT_DISCONNECTED);
283 if (svm_fifo_n_subscribers (s->rx_fifo))
284 mq_notify_close_subscribers (app_wrk->app_index, sh, s->rx_fifo,
285 SESSION_CTRL_EVT_DISCONNECTED);
289 mq_send_session_reset_cb (session_t * s)
291 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
292 session_handle_t sh = session_handle (s);
294 mq_send_session_close_evt (app_wrk, sh, SESSION_CTRL_EVT_RESET);
296 if (svm_fifo_n_subscribers (s->rx_fifo))
297 mq_notify_close_subscribers (app_wrk->app_index, sh, s->rx_fifo,
298 SESSION_CTRL_EVT_RESET);
302 mq_send_session_connected_cb (u32 app_wrk_index, u32 api_context,
303 session_t * s, u8 is_fail)
305 svm_msg_q_msg_t _msg, *msg = &_msg;
306 session_connected_msg_t *mp;
307 svm_msg_q_t *vpp_mq, *app_mq;
308 transport_connection_t *tc;
309 app_worker_t *app_wrk;
310 session_event_t *evt;
312 app_wrk = app_worker_get (app_wrk_index);
313 app_mq = app_wrk->event_queue;
316 clib_warning ("app %u with api index: %u not attached",
317 app_wrk->app_index, app_wrk->api_client_index);
321 if (mq_try_lock_and_alloc_msg (app_mq, msg))
324 evt = svm_msg_q_msg_data (app_mq, msg);
325 clib_memset (evt, 0, sizeof (*evt));
326 evt->event_type = SESSION_CTRL_EVT_CONNECTED;
327 mp = (session_connected_msg_t *) evt->data;
328 clib_memset (mp, 0, sizeof (*mp));
329 mp->context = api_context;
334 if (session_has_transport (s))
336 tc = session_get_transport (s);
343 vpp_mq = session_main_get_vpp_event_queue (s->thread_index);
344 mp->handle = session_handle (s);
345 mp->vpp_event_queue_address = pointer_to_uword (vpp_mq);
347 session_get_endpoint (s, &mp->lcl, 1 /* is_lcl */ );
349 mp->server_rx_fifo = pointer_to_uword (s->rx_fifo);
350 mp->server_tx_fifo = pointer_to_uword (s->tx_fifo);
351 mp->segment_handle = session_segment_handle (s);
355 ct_connection_t *cct;
358 cct = (ct_connection_t *) session_get_transport (s);
359 mp->handle = session_handle (s);
360 mp->lcl.port = cct->c_lcl_port;
361 mp->lcl.is_ip4 = cct->c_is_ip4;
362 vpp_mq = session_main_get_vpp_event_queue (0);
363 mp->vpp_event_queue_address = pointer_to_uword (vpp_mq);
364 mp->server_rx_fifo = pointer_to_uword (s->rx_fifo);
365 mp->server_tx_fifo = pointer_to_uword (s->tx_fifo);
366 mp->segment_handle = session_segment_handle (s);
367 ss = ct_session_get_peer (s);
368 mp->ct_rx_fifo = pointer_to_uword (ss->tx_fifo);
369 mp->ct_tx_fifo = pointer_to_uword (ss->rx_fifo);
370 mp->ct_segment_handle = session_segment_handle (ss);
374 mp->retval = is_fail ?
375 clib_host_to_net_u32 (VNET_API_ERROR_SESSION_CONNECT) : 0;
377 svm_msg_q_add_and_unlock (app_mq, msg);
382 mq_send_session_bound_cb (u32 app_wrk_index, u32 api_context,
383 session_handle_t handle, int rv)
385 svm_msg_q_msg_t _msg, *msg = &_msg;
386 svm_msg_q_t *app_mq, *vpp_evt_q;
387 transport_endpoint_t tep;
388 session_bound_msg_t *mp;
389 app_worker_t *app_wrk;
390 session_event_t *evt;
393 app_wrk = app_worker_get (app_wrk_index);
394 app_mq = app_wrk->event_queue;
397 clib_warning ("app %u with api index: %u not attached",
398 app_wrk->app_index, app_wrk->api_client_index);
402 if (mq_try_lock_and_alloc_msg (app_mq, msg))
405 evt = svm_msg_q_msg_data (app_mq, msg);
406 clib_memset (evt, 0, sizeof (*evt));
407 evt->event_type = SESSION_CTRL_EVT_BOUND;
408 mp = (session_bound_msg_t *) evt->data;
409 mp->context = api_context;
415 al = app_listener_get_w_handle (handle);
416 if (al->session_index != SESSION_INVALID_INDEX)
417 ls = app_listener_get_session (al);
419 ls = app_listener_get_local_session (al);
421 session_get_endpoint (ls, &tep, 1 /* is_lcl */ );
422 mp->lcl_port = tep.port;
423 mp->lcl_is_ip4 = tep.is_ip4;
424 clib_memcpy_fast (mp->lcl_ip, &tep.ip, sizeof (tep.ip));
426 vpp_evt_q = session_main_get_vpp_event_queue (0);
427 mp->vpp_evt_q = pointer_to_uword (vpp_evt_q);
429 if (session_transport_service_type (ls) == TRANSPORT_SERVICE_CL)
431 mp->rx_fifo = pointer_to_uword (ls->rx_fifo);
432 mp->tx_fifo = pointer_to_uword (ls->tx_fifo);
437 svm_msg_q_add_and_unlock (app_mq, msg);
442 mq_send_session_migrate_cb (session_t * s, session_handle_t new_sh)
444 clib_warning ("not supported");
448 static session_cb_vft_t session_mq_cb_vft = {
449 .session_accept_callback = mq_send_session_accepted_cb,
450 .session_disconnect_callback = mq_send_session_disconnected_cb,
451 .session_connected_callback = mq_send_session_connected_cb,
452 .session_reset_callback = mq_send_session_reset_cb,
453 .session_migrate_callback = mq_send_session_migrate_cb,
454 .add_segment_callback = send_add_segment_callback,
455 .del_segment_callback = send_del_segment_callback,
459 vl_api_session_enable_disable_t_handler (vl_api_session_enable_disable_t * mp)
461 vl_api_session_enable_disable_reply_t *rmp;
462 vlib_main_t *vm = vlib_get_main ();
465 vnet_session_enable_disable (vm, mp->is_enable);
466 REPLY_MACRO (VL_API_SESSION_ENABLE_DISABLE_REPLY);
470 vl_api_application_attach_t_handler (vl_api_application_attach_t * mp)
472 int rv = 0, fds[SESSION_N_FD_TYPE], n_fds = 0;
473 vl_api_application_attach_reply_t *rmp;
474 ssvm_private_t *segp, *evt_q_segment;
475 vnet_app_attach_args_t _a, *a = &_a;
476 vl_api_registration_t *reg;
479 reg = vl_api_client_index_to_registration (mp->client_index);
483 if (session_main_is_enabled () == 0)
485 rv = VNET_API_ERROR_FEATURE_DISABLED;
489 STATIC_ASSERT (sizeof (u64) * APP_OPTIONS_N_OPTIONS <=
490 sizeof (mp->options),
491 "Out of options, fix api message definition");
493 clib_memset (a, 0, sizeof (*a));
494 a->api_client_index = mp->client_index;
495 a->options = mp->options;
496 a->session_cb_vft = &session_mq_cb_vft;
497 if (mp->namespace_id_len > 64)
499 rv = VNET_API_ERROR_INVALID_VALUE;
503 if (mp->namespace_id_len)
505 vec_validate (a->namespace_id, mp->namespace_id_len - 1);
506 clib_memcpy_fast (a->namespace_id, mp->namespace_id,
507 mp->namespace_id_len);
510 if ((rv = vnet_application_attach (a)))
512 clib_warning ("attach returned: %d", rv);
513 vec_free (a->namespace_id);
516 vec_free (a->namespace_id);
518 /* Send event queues segment */
519 if ((evt_q_segment = session_main_get_evt_q_segment ()))
521 fd_flags |= SESSION_FD_F_VPP_MQ_SEGMENT;
522 fds[n_fds] = evt_q_segment->fd;
525 /* Send fifo segment fd if needed */
526 if (ssvm_type (a->segment) == SSVM_SEGMENT_MEMFD)
528 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
529 fds[n_fds] = a->segment->fd;
532 if (a->options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
534 fd_flags |= SESSION_FD_F_MQ_EVENTFD;
535 fds[n_fds] = svm_msg_q_get_producer_eventfd (a->app_evt_q);
542 REPLY_MACRO2 (VL_API_APPLICATION_ATTACH_REPLY, ({
546 rmp->app_index = clib_host_to_net_u32 (a->app_index);
547 rmp->segment_name_length = 0;
548 rmp->segment_size = segp->ssvm_size;
549 if (vec_len (segp->name))
551 memcpy (rmp->segment_name, segp->name, vec_len (segp->name));
552 rmp->segment_name_length = vec_len (segp->name);
554 rmp->app_event_queue_address = pointer_to_uword (a->app_evt_q);
556 rmp->fd_flags = fd_flags;
557 rmp->segment_handle = clib_host_to_net_u64 (a->segment_handle);
563 session_send_fds (reg, fds, n_fds);
567 vl_api_application_detach_t_handler (vl_api_application_detach_t * mp)
569 vl_api_application_detach_reply_t *rmp;
570 int rv = VNET_API_ERROR_INVALID_VALUE_2;
571 vnet_app_detach_args_t _a, *a = &_a;
574 if (session_main_is_enabled () == 0)
576 rv = VNET_API_ERROR_FEATURE_DISABLED;
580 app = application_lookup (mp->client_index);
583 a->app_index = app->app_index;
584 a->api_client_index = mp->client_index;
585 rv = vnet_application_detach (a);
589 REPLY_MACRO (VL_API_APPLICATION_DETACH_REPLY);
593 vl_api_bind_uri_t_handler (vl_api_bind_uri_t * mp)
595 vl_api_bind_uri_reply_t *rmp;
596 vnet_listen_args_t _a, *a = &_a;
597 application_t *app = 0;
598 app_worker_t *app_wrk;
601 if (session_main_is_enabled () == 0)
603 rv = VNET_API_ERROR_FEATURE_DISABLED;
607 app = application_lookup (mp->client_index);
610 clib_memset (a, 0, sizeof (*a));
611 a->uri = (char *) mp->uri;
612 a->app_index = app->app_index;
613 rv = vnet_bind_uri (a);
617 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
622 REPLY_MACRO (VL_API_BIND_URI_REPLY);
626 app_wrk = application_get_worker (app, 0);
627 mq_send_session_bound_cb (app_wrk->wrk_index, mp->context, a->handle,
633 vl_api_unbind_uri_t_handler (vl_api_unbind_uri_t * mp)
635 vl_api_unbind_uri_reply_t *rmp;
637 vnet_unlisten_args_t _a, *a = &_a;
640 if (session_main_is_enabled () == 0)
642 rv = VNET_API_ERROR_FEATURE_DISABLED;
646 app = application_lookup (mp->client_index);
649 a->uri = (char *) mp->uri;
650 a->app_index = app->app_index;
651 a->wrk_map_index = 0;
652 rv = vnet_unbind_uri (a);
656 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
660 REPLY_MACRO (VL_API_UNBIND_URI_REPLY);
664 vl_api_connect_uri_t_handler (vl_api_connect_uri_t * mp)
666 vl_api_connect_uri_reply_t *rmp;
667 vnet_connect_args_t _a, *a = &_a;
671 if (session_main_is_enabled () == 0)
673 rv = VNET_API_ERROR_FEATURE_DISABLED;
677 app = application_lookup (mp->client_index);
680 clib_memset (a, 0, sizeof (*a));
681 a->uri = (char *) mp->uri;
682 a->api_context = mp->context;
683 a->app_index = app->app_index;
684 if ((rv = vnet_connect_uri (a)))
685 clib_warning ("connect_uri returned: %d", rv);
689 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
693 * Don't reply to stream (tcp) connects. The reply will come once
694 * the connection is established. In case of the redirects, the reply
695 * will come from the server app.
701 REPLY_MACRO (VL_API_CONNECT_URI_REPLY);
705 vl_api_disconnect_session_t_handler (vl_api_disconnect_session_t * mp)
707 vl_api_disconnect_session_reply_t *rmp;
708 vnet_disconnect_args_t _a, *a = &_a;
712 if (session_main_is_enabled () == 0)
714 rv = VNET_API_ERROR_FEATURE_DISABLED;
718 app = application_lookup (mp->client_index);
721 a->handle = mp->handle;
722 a->app_index = app->app_index;
723 rv = vnet_disconnect_session (a);
727 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
731 REPLY_MACRO2 (VL_API_DISCONNECT_SESSION_REPLY, rmp->handle = mp->handle);
735 vl_api_disconnect_session_reply_t_handler (vl_api_disconnect_session_reply_t *
738 vnet_disconnect_args_t _a, *a = &_a;
741 /* Client objected to disconnecting the session, log and continue */
744 clib_warning ("client retval %d", mp->retval);
748 /* Disconnect has been confirmed. Confirm close to transport */
749 app = application_lookup (mp->context);
752 a->handle = mp->handle;
753 a->app_index = app->app_index;
754 vnet_disconnect_session (a);
759 vl_api_map_another_segment_reply_t_handler (vl_api_map_another_segment_reply_t
762 clib_warning ("not implemented");
766 vl_api_bind_sock_t_handler (vl_api_bind_sock_t * mp)
768 vnet_listen_args_t _a, *a = &_a;
769 vl_api_bind_sock_reply_t *rmp;
770 application_t *app = 0;
771 app_worker_t *app_wrk;
772 ip46_address_t *ip46;
775 if (session_main_is_enabled () == 0)
777 rv = VNET_API_ERROR_FEATURE_DISABLED;
781 app = application_lookup (mp->client_index);
784 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
788 ip46 = (ip46_address_t *) mp->ip;
789 clib_memset (a, 0, sizeof (*a));
790 a->sep.is_ip4 = mp->is_ip4;
792 a->sep.port = mp->port;
793 a->sep.fib_index = mp->vrf;
794 a->sep.sw_if_index = ENDPOINT_INVALID_INDEX;
795 a->sep.transport_proto = mp->proto;
796 a->app_index = app->app_index;
797 a->wrk_map_index = mp->wrk_index;
799 if ((rv = vnet_listen (a)))
800 clib_warning ("listen returned: %d", rv);
803 /* Actual reply sent only over mq */
804 REPLY_MACRO (VL_API_BIND_SOCK_REPLY);
808 app_wrk = application_get_worker (app, mp->wrk_index);
809 mq_send_session_bound_cb (app_wrk->wrk_index, mp->context, a->handle,
815 vl_api_unbind_sock_t_handler (vl_api_unbind_sock_t * mp)
817 vl_api_unbind_sock_reply_t *rmp;
818 vnet_unlisten_args_t _a, *a = &_a;
819 app_worker_t *app_wrk;
820 application_t *app = 0;
823 if (session_main_is_enabled () == 0)
825 rv = VNET_API_ERROR_FEATURE_DISABLED;
829 app = application_lookup (mp->client_index);
832 a->app_index = app->app_index;
833 a->handle = mp->handle;
834 a->wrk_map_index = mp->wrk_index;
835 if ((rv = vnet_unlisten (a)))
836 clib_warning ("unlisten returned: %d", rv);
840 REPLY_MACRO (VL_API_UNBIND_SOCK_REPLY);
843 * Send reply over msg queue
845 svm_msg_q_msg_t _msg, *msg = &_msg;
846 session_unlisten_reply_msg_t *ump;
848 session_event_t *evt;
853 app_wrk = application_get_worker (app, a->wrk_map_index);
857 app_mq = app_wrk->event_queue;
858 if (mq_try_lock_and_alloc_msg (app_mq, msg))
861 evt = svm_msg_q_msg_data (app_mq, msg);
862 clib_memset (evt, 0, sizeof (*evt));
863 evt->event_type = SESSION_CTRL_EVT_UNLISTEN_REPLY;
864 ump = (session_unlisten_reply_msg_t *) evt->data;
865 ump->context = mp->context;
866 ump->handle = mp->handle;
868 svm_msg_q_add_and_unlock (app_mq, msg);
872 vl_api_connect_sock_t_handler (vl_api_connect_sock_t * mp)
874 vl_api_connect_sock_reply_t *rmp;
875 vnet_connect_args_t _a, *a = &_a;
876 application_t *app = 0;
879 if (session_main_is_enabled () == 0)
881 rv = VNET_API_ERROR_FEATURE_DISABLED;
885 app = application_lookup (mp->client_index);
888 svm_queue_t *client_q;
889 ip46_address_t *ip46 = (ip46_address_t *) mp->ip;
891 clib_memset (a, 0, sizeof (*a));
892 client_q = vl_api_client_index_to_input_queue (mp->client_index);
893 mp->client_queue_address = pointer_to_uword (client_q);
894 a->sep.is_ip4 = mp->is_ip4;
896 a->sep.port = mp->port;
897 a->sep.transport_proto = mp->proto;
898 a->sep.peer.fib_index = mp->vrf;
899 a->sep.peer.sw_if_index = ENDPOINT_INVALID_INDEX;
900 a->sep_ext.parent_handle = mp->parent_handle;
901 if (mp->hostname_len)
903 vec_validate (a->sep_ext.hostname, mp->hostname_len - 1);
904 clib_memcpy_fast (a->sep_ext.hostname, mp->hostname,
907 a->api_context = mp->context;
908 a->app_index = app->app_index;
909 a->wrk_map_index = mp->wrk_index;
910 if ((rv = vnet_connect (a)))
911 clib_warning ("connect returned: %U", format_vnet_api_errno, rv);
912 vec_free (a->sep_ext.hostname);
916 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
922 /* Got some error, relay it */
925 REPLY_MACRO (VL_API_CONNECT_SOCK_REPLY);
929 app_worker_t *app_wrk = application_get_worker (app, mp->wrk_index);
930 mq_send_session_connected_cb (app_wrk->wrk_index, mp->context, 0, 1);
935 vl_api_app_worker_add_del_t_handler (vl_api_app_worker_add_del_t * mp)
937 int rv = 0, fds[SESSION_N_FD_TYPE], n_fds = 0;
938 vl_api_app_worker_add_del_reply_t *rmp;
939 vl_api_registration_t *reg;
943 if (!session_main_is_enabled ())
945 rv = VNET_API_ERROR_FEATURE_DISABLED;
949 reg = vl_api_client_index_to_registration (mp->client_index);
953 app = application_get_if_valid (clib_net_to_host_u32 (mp->app_index));
956 rv = VNET_API_ERROR_INVALID_VALUE;
960 vnet_app_worker_add_del_args_t args = {
961 .app_index = app->app_index,
962 .wrk_map_index = clib_net_to_host_u32 (mp->wrk_index),
963 .api_client_index = mp->client_index,
966 rv = vnet_app_worker_add_del (&args);
969 clib_warning ("app worker add/del returned: %d", rv);
976 /* Send fifo segment fd if needed */
977 if (ssvm_type (args.segment) == SSVM_SEGMENT_MEMFD)
979 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
980 fds[n_fds] = args.segment->fd;
983 if (application_segment_manager_properties (app)->use_mq_eventfd)
985 fd_flags |= SESSION_FD_F_MQ_EVENTFD;
986 fds[n_fds] = svm_msg_q_get_producer_eventfd (args.evt_q);
992 REPLY_MACRO2 (VL_API_APP_WORKER_ADD_DEL_REPLY, ({
993 rmp->is_add = mp->is_add;
994 rmp->wrk_index = clib_host_to_net_u32 (args.wrk_map_index);
995 rmp->segment_handle = clib_host_to_net_u64 (args.segment_handle);
996 if (!rv && mp->is_add)
998 if (vec_len (args.segment->name))
1000 memcpy (rmp->segment_name, args.segment->name,
1001 vec_len (args.segment->name));
1002 rmp->segment_name_length = vec_len (args.segment->name);
1004 rmp->app_event_queue_address = pointer_to_uword (args.evt_q);
1006 rmp->fd_flags = fd_flags;
1012 session_send_fds (reg, fds, n_fds);
1016 vl_api_app_namespace_add_del_t_handler (vl_api_app_namespace_add_del_t * mp)
1018 vl_api_app_namespace_add_del_reply_t *rmp;
1019 u32 appns_index = 0;
1022 if (!session_main_is_enabled ())
1024 rv = VNET_API_ERROR_FEATURE_DISABLED;
1028 if (mp->namespace_id_len > ARRAY_LEN (mp->namespace_id))
1030 rv = VNET_API_ERROR_INVALID_VALUE;
1034 vec_validate (ns_id, mp->namespace_id_len - 1);
1035 clib_memcpy_fast (ns_id, mp->namespace_id, mp->namespace_id_len);
1036 vnet_app_namespace_add_del_args_t args = {
1038 .secret = clib_net_to_host_u64 (mp->secret),
1039 .sw_if_index = clib_net_to_host_u32 (mp->sw_if_index),
1040 .ip4_fib_id = clib_net_to_host_u32 (mp->ip4_fib_id),
1041 .ip6_fib_id = clib_net_to_host_u32 (mp->ip6_fib_id),
1044 rv = vnet_app_namespace_add_del (&args);
1047 appns_index = app_namespace_index_from_id (ns_id);
1048 if (appns_index == APP_NAMESPACE_INVALID_INDEX)
1050 clib_warning ("app ns lookup failed");
1051 rv = VNET_API_ERROR_UNSPECIFIED;
1058 REPLY_MACRO2 (VL_API_APP_NAMESPACE_ADD_DEL_REPLY, ({
1060 rmp->appns_index = clib_host_to_net_u32 (appns_index);
1066 vl_api_session_rule_add_del_t_handler (vl_api_session_rule_add_del_t * mp)
1068 vl_api_session_rule_add_del_reply_t *rmp;
1069 session_rule_add_del_args_t args;
1070 session_rule_table_add_del_args_t *table_args = &args.table_args;
1074 clib_memset (&args, 0, sizeof (args));
1075 fib_proto = mp->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
1077 table_args->lcl.fp_len = mp->lcl_plen;
1078 table_args->lcl.fp_proto = fib_proto;
1079 table_args->rmt.fp_len = mp->rmt_plen;
1080 table_args->rmt.fp_proto = fib_proto;
1081 table_args->lcl_port = mp->lcl_port;
1082 table_args->rmt_port = mp->rmt_port;
1083 table_args->action_index = clib_net_to_host_u32 (mp->action_index);
1084 table_args->is_add = mp->is_add;
1085 mp->tag[sizeof (mp->tag) - 1] = 0;
1086 table_args->tag = format (0, "%s", mp->tag);
1087 args.appns_index = clib_net_to_host_u32 (mp->appns_index);
1088 args.scope = mp->scope;
1089 args.transport_proto = mp->transport_proto;
1091 clib_memset (&table_args->lcl.fp_addr, 0, sizeof (table_args->lcl.fp_addr));
1092 clib_memset (&table_args->rmt.fp_addr, 0, sizeof (table_args->rmt.fp_addr));
1093 ip_set (&table_args->lcl.fp_addr, mp->lcl_ip, mp->is_ip4);
1094 ip_set (&table_args->rmt.fp_addr, mp->rmt_ip, mp->is_ip4);
1095 rv = vnet_session_rule_add_del (&args);
1097 clib_warning ("rule add del returned: %d", rv);
1098 vec_free (table_args->tag);
1099 REPLY_MACRO (VL_API_SESSION_RULE_ADD_DEL_REPLY);
1103 send_session_rule_details4 (mma_rule_16_t * rule, u8 is_local,
1104 u8 transport_proto, u32 appns_index, u8 * tag,
1105 vl_api_registration_t * reg, u32 context)
1107 vl_api_session_rules_details_t *rmp = 0;
1108 session_mask_or_match_4_t *match =
1109 (session_mask_or_match_4_t *) & rule->match;
1110 session_mask_or_match_4_t *mask =
1111 (session_mask_or_match_4_t *) & rule->mask;
1113 rmp = vl_msg_api_alloc (sizeof (*rmp));
1114 clib_memset (rmp, 0, sizeof (*rmp));
1115 rmp->_vl_msg_id = ntohs (VL_API_SESSION_RULES_DETAILS);
1116 rmp->context = context;
1119 clib_memcpy_fast (rmp->lcl_ip, &match->lcl_ip, sizeof (match->lcl_ip));
1120 clib_memcpy_fast (rmp->rmt_ip, &match->rmt_ip, sizeof (match->rmt_ip));
1121 rmp->lcl_plen = ip4_mask_to_preflen (&mask->lcl_ip);
1122 rmp->rmt_plen = ip4_mask_to_preflen (&mask->rmt_ip);
1123 rmp->lcl_port = match->lcl_port;
1124 rmp->rmt_port = match->rmt_port;
1125 rmp->action_index = clib_host_to_net_u32 (rule->action_index);
1127 is_local ? SESSION_RULE_SCOPE_LOCAL : SESSION_RULE_SCOPE_GLOBAL;
1128 rmp->transport_proto = transport_proto;
1129 rmp->appns_index = clib_host_to_net_u32 (appns_index);
1132 clib_memcpy_fast (rmp->tag, tag, vec_len (tag));
1133 rmp->tag[vec_len (tag)] = 0;
1136 vl_api_send_msg (reg, (u8 *) rmp);
1140 send_session_rule_details6 (mma_rule_40_t * rule, u8 is_local,
1141 u8 transport_proto, u32 appns_index, u8 * tag,
1142 vl_api_registration_t * reg, u32 context)
1144 vl_api_session_rules_details_t *rmp = 0;
1145 session_mask_or_match_6_t *match =
1146 (session_mask_or_match_6_t *) & rule->match;
1147 session_mask_or_match_6_t *mask =
1148 (session_mask_or_match_6_t *) & rule->mask;
1150 rmp = vl_msg_api_alloc (sizeof (*rmp));
1151 clib_memset (rmp, 0, sizeof (*rmp));
1152 rmp->_vl_msg_id = ntohs (VL_API_SESSION_RULES_DETAILS);
1153 rmp->context = context;
1156 clib_memcpy_fast (rmp->lcl_ip, &match->lcl_ip, sizeof (match->lcl_ip));
1157 clib_memcpy_fast (rmp->rmt_ip, &match->rmt_ip, sizeof (match->rmt_ip));
1158 rmp->lcl_plen = ip6_mask_to_preflen (&mask->lcl_ip);
1159 rmp->rmt_plen = ip6_mask_to_preflen (&mask->rmt_ip);
1160 rmp->lcl_port = match->lcl_port;
1161 rmp->rmt_port = match->rmt_port;
1162 rmp->action_index = clib_host_to_net_u32 (rule->action_index);
1164 is_local ? SESSION_RULE_SCOPE_LOCAL : SESSION_RULE_SCOPE_GLOBAL;
1165 rmp->transport_proto = transport_proto;
1166 rmp->appns_index = clib_host_to_net_u32 (appns_index);
1169 clib_memcpy_fast (rmp->tag, tag, vec_len (tag));
1170 rmp->tag[vec_len (tag)] = 0;
1173 vl_api_send_msg (reg, (u8 *) rmp);
1177 send_session_rules_table_details (session_rules_table_t * srt, u8 fib_proto,
1178 u8 tp, u8 is_local, u32 appns_index,
1179 vl_api_registration_t * reg, u32 context)
1181 mma_rule_16_t *rule16;
1182 mma_rule_40_t *rule40;
1183 mma_rules_table_16_t *srt16;
1184 mma_rules_table_40_t *srt40;
1187 if (is_local || fib_proto == FIB_PROTOCOL_IP4)
1191 srt16 = &srt->session_rules_tables_16;
1192 pool_foreach (rule16, srt16->rules, ({
1193 ri = mma_rules_table_rule_index_16 (srt16, rule16);
1194 tag = session_rules_table_rule_tag (srt, ri, 1);
1195 send_session_rule_details4 (rule16, is_local, tp, appns_index, tag,
1200 if (is_local || fib_proto == FIB_PROTOCOL_IP6)
1204 srt40 = &srt->session_rules_tables_40;
1205 pool_foreach (rule40, srt40->rules, ({
1206 ri = mma_rules_table_rule_index_40 (srt40, rule40);
1207 tag = session_rules_table_rule_tag (srt, ri, 1);
1208 send_session_rule_details6 (rule40, is_local, tp, appns_index, tag,
1216 vl_api_session_rules_dump_t_handler (vl_api_one_map_server_dump_t * mp)
1218 vl_api_registration_t *reg;
1219 session_table_t *st;
1222 reg = vl_api_client_index_to_registration (mp->client_index);
1227 session_table_foreach (st, ({
1228 for (tp = 0; tp < TRANSPORT_N_PROTO; tp++)
1230 send_session_rules_table_details (&st->session_rules[tp],
1231 st->active_fib_proto, tp,
1232 st->is_local, st->appns_index, reg,
1240 vl_api_application_tls_cert_add_t_handler (vl_api_application_tls_cert_add_t *
1243 vl_api_app_namespace_add_del_reply_t *rmp;
1244 vnet_app_add_tls_cert_args_t _a, *a = &_a;
1245 clib_error_t *error;
1249 if (!session_main_is_enabled ())
1251 rv = VNET_API_ERROR_FEATURE_DISABLED;
1254 if (!(app = application_lookup (mp->client_index)))
1256 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
1259 clib_memset (a, 0, sizeof (*a));
1260 a->app_index = app->app_index;
1261 cert_len = clib_net_to_host_u16 (mp->cert_len);
1262 if (cert_len > 10000)
1264 rv = VNET_API_ERROR_INVALID_VALUE;
1267 vec_validate (a->cert, cert_len);
1268 clib_memcpy_fast (a->cert, mp->cert, cert_len);
1269 if ((error = vnet_app_add_tls_cert (a)))
1271 rv = clib_error_get_code (error);
1272 clib_error_report (error);
1276 REPLY_MACRO (VL_API_APPLICATION_TLS_CERT_ADD_REPLY);
1280 vl_api_application_tls_key_add_t_handler (vl_api_application_tls_key_add_t *
1283 vl_api_app_namespace_add_del_reply_t *rmp;
1284 vnet_app_add_tls_key_args_t _a, *a = &_a;
1285 clib_error_t *error;
1289 if (!session_main_is_enabled ())
1291 rv = VNET_API_ERROR_FEATURE_DISABLED;
1294 if (!(app = application_lookup (mp->client_index)))
1296 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
1299 clib_memset (a, 0, sizeof (*a));
1300 a->app_index = app->app_index;
1301 key_len = clib_net_to_host_u16 (mp->key_len);
1302 if (key_len > 10000)
1304 rv = VNET_API_ERROR_INVALID_VALUE;
1307 vec_validate (a->key, key_len);
1308 clib_memcpy_fast (a->key, mp->key, key_len);
1309 if ((error = vnet_app_add_tls_key (a)))
1311 rv = clib_error_get_code (error);
1312 clib_error_report (error);
1316 REPLY_MACRO (VL_API_APPLICATION_TLS_KEY_ADD_REPLY);
1319 static clib_error_t *
1320 application_reaper_cb (u32 client_index)
1322 application_t *app = application_lookup (client_index);
1323 vnet_app_detach_args_t _a, *a = &_a;
1326 a->app_index = app->app_index;
1327 a->api_client_index = client_index;
1328 vnet_application_detach (a);
1333 VL_MSG_API_REAPER_FUNCTION (application_reaper_cb);
1335 #define vl_msg_name_crc_list
1336 #include <vnet/vnet_all_api_h.h>
1337 #undef vl_msg_name_crc_list
1340 setup_message_id_table (api_main_t * am)
1342 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
1343 foreach_vl_msg_name_crc_session;
1348 * session_api_hookup
1349 * Add uri's API message handlers to the table.
1350 * vlib has already mapped shared memory and
1351 * added the client registration handlers.
1352 * See .../open-repo/vlib/memclnt_vlib.c:memclnt_process()
1354 static clib_error_t *
1355 session_api_hookup (vlib_main_t * vm)
1357 api_main_t *am = &api_main;
1360 vl_msg_api_set_handlers(VL_API_##N, #n, \
1361 vl_api_##n##_t_handler, \
1363 vl_api_##n##_t_endian, \
1364 vl_api_##n##_t_print, \
1365 sizeof(vl_api_##n##_t), 1);
1366 foreach_session_api_msg;
1370 * Messages which bounce off the data-plane to
1371 * an API client. Simply tells the message handling infra not
1372 * to free the message.
1374 * Bounced message handlers MUST NOT block the data plane
1376 am->message_bounce[VL_API_CONNECT_URI] = 1;
1377 am->message_bounce[VL_API_CONNECT_SOCK] = 1;
1380 * Set up the (msg_name, crc, message-id) table
1382 setup_message_id_table (am);
1387 VLIB_API_INIT_FUNCTION (session_api_hookup);
1390 * fd.io coding-style-patch-verification: ON
1393 * eval: (c-set-style "gnu")