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 _(APP_ATTACH, app_attach) \
47 _(APPLICATION_DETACH, application_detach) \
48 _(BIND_URI, bind_uri) \
49 _(UNBIND_URI, unbind_uri) \
50 _(CONNECT_URI, connect_uri) \
51 _(DISCONNECT_SESSION, disconnect_session) \
52 _(DISCONNECT_SESSION_REPLY, disconnect_session_reply) \
53 _(BIND_SOCK, bind_sock) \
54 _(UNBIND_SOCK, unbind_sock) \
55 _(CONNECT_SOCK, connect_sock) \
56 _(SESSION_ENABLE_DISABLE, session_enable_disable) \
57 _(APP_NAMESPACE_ADD_DEL, app_namespace_add_del) \
58 _(SESSION_RULE_ADD_DEL, session_rule_add_del) \
59 _(SESSION_RULES_DUMP, session_rules_dump) \
60 _(APPLICATION_TLS_CERT_ADD, application_tls_cert_add) \
61 _(APPLICATION_TLS_KEY_ADD, application_tls_key_add) \
62 _(APP_WORKER_ADD_DEL, app_worker_add_del) \
65 session_send_fds (vl_api_registration_t * reg, int fds[], int n_fds)
68 if (vl_api_registration_file_index (reg) == VL_API_INVALID_FI)
70 clib_warning ("can't send memfd fd");
73 error = vl_api_send_fd_msg (reg, fds, n_fds);
76 clib_error_report (error);
83 send_add_segment_callback (u32 api_client_index, u64 segment_handle)
85 int fds[SESSION_N_FD_TYPE], n_fds = 0;
86 vl_api_map_another_segment_t *mp;
87 vl_api_registration_t *reg;
92 reg = vl_mem_api_client_index_to_registration (api_client_index);
95 clib_warning ("no api registration for client: %u", api_client_index);
99 fs = segment_manager_get_segment_w_handle (segment_handle);
101 if (ssvm_type (sp) == SSVM_SEGMENT_MEMFD)
103 if (vl_api_registration_file_index (reg) == VL_API_INVALID_FI)
105 clib_warning ("can't send memfd fd");
109 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
114 mp = vl_mem_api_alloc_as_if_client_w_reg (reg, sizeof (*mp));
115 clib_memset (mp, 0, sizeof (*mp));
116 mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_MAP_ANOTHER_SEGMENT);
117 mp->segment_size = sp->ssvm_size;
118 mp->fd_flags = fd_flags;
119 mp->segment_handle = clib_host_to_net_u64 (segment_handle);
120 strncpy ((char *) mp->segment_name, (char *) sp->name,
121 sizeof (mp->segment_name) - 1);
123 vl_msg_api_send_shmem (reg->vl_input_queue, (u8 *) & mp);
126 return session_send_fds (reg, fds, n_fds);
132 send_del_segment_callback (u32 api_client_index, u64 segment_handle)
134 vl_api_unmap_segment_t *mp;
135 vl_api_registration_t *reg;
137 reg = vl_mem_api_client_index_to_registration (api_client_index);
140 clib_warning ("no registration: %u", api_client_index);
144 mp = vl_mem_api_alloc_as_if_client_w_reg (reg, sizeof (*mp));
145 clib_memset (mp, 0, sizeof (*mp));
146 mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_UNMAP_SEGMENT);
147 mp->segment_handle = clib_host_to_net_u64 (segment_handle);
148 vl_msg_api_send_shmem (reg->vl_input_queue, (u8 *) & mp);
154 mq_try_lock_and_alloc_msg (svm_msg_q_t * app_mq, svm_msg_q_msg_t * msg)
160 rv = svm_msg_q_lock_and_alloc_msg_w_ring (app_mq,
161 SESSION_MQ_CTRL_EVT_RING,
168 clib_warning ("failed to alloc msg");
173 mq_send_session_accepted_cb (session_t * s)
175 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
176 svm_msg_q_msg_t _msg, *msg = &_msg;
177 svm_msg_q_t *vpp_queue, *app_mq;
179 session_accepted_msg_t *mp;
180 session_event_t *evt;
183 app = application_get (app_wrk->app_index);
184 app_mq = app_wrk->event_queue;
185 if (mq_try_lock_and_alloc_msg (app_mq, msg))
188 evt = svm_msg_q_msg_data (app_mq, msg);
189 clib_memset (evt, 0, sizeof (*evt));
190 evt->event_type = SESSION_CTRL_EVT_ACCEPTED;
191 mp = (session_accepted_msg_t *) evt->data;
192 clib_memset (mp, 0, sizeof (*mp));
193 mp->context = app->app_index;
194 mp->server_rx_fifo = pointer_to_uword (s->rx_fifo);
195 mp->server_tx_fifo = pointer_to_uword (s->tx_fifo);
196 mp->segment_handle = session_segment_handle (s);
198 if (session_has_transport (s))
200 listener = listen_session_get_from_handle (s->listener_handle);
201 mp->listener_handle = app_listen_session_handle (listener);
202 if (application_is_proxy (app))
205 app_worker_first_listener (app_wrk, session_get_fib_proto (s),
206 session_get_transport_proto (s));
208 mp->listener_handle = listen_session_get_handle (listener);
210 vpp_queue = session_main_get_vpp_event_queue (s->thread_index);
211 mp->vpp_event_queue_address = pointer_to_uword (vpp_queue);
212 mp->handle = session_handle (s);
214 session_get_endpoint (s, &mp->rmt, 0 /* is_lcl */ );
220 ct = (ct_connection_t *) session_get_transport (s);
221 listener = listen_session_get_from_handle (s->listener_handle);
222 mp->listener_handle = app_listen_session_handle (listener);
223 mp->rmt.is_ip4 = session_type_is_ip4 (listener->session_type);
224 mp->rmt.port = ct->c_rmt_port;
225 mp->handle = session_handle (s);
226 vpp_queue = session_main_get_vpp_event_queue (0);
227 mp->vpp_event_queue_address = pointer_to_uword (vpp_queue);
229 svm_msg_q_add_and_unlock (app_mq, msg);
235 mq_send_session_close_evt (app_worker_t * app_wrk, session_handle_t sh,
236 session_evt_type_t evt_type)
238 svm_msg_q_msg_t _msg, *msg = &_msg;
239 session_disconnected_msg_t *mp;
241 session_event_t *evt;
243 app_mq = app_wrk->event_queue;
244 if (mq_try_lock_and_alloc_msg (app_mq, msg))
246 evt = svm_msg_q_msg_data (app_mq, msg);
247 clib_memset (evt, 0, sizeof (*evt));
248 evt->event_type = evt_type;
249 mp = (session_disconnected_msg_t *) evt->data;
251 mp->context = app_wrk->api_client_index;
252 svm_msg_q_add_and_unlock (app_mq, msg);
256 mq_notify_close_subscribers (u32 app_index, session_handle_t sh,
257 svm_fifo_t * f, session_evt_type_t evt_type)
259 app_worker_t *app_wrk;
263 app = application_get (app_index);
267 for (i = 0; i < f->n_subscribers; i++)
269 if (!(app_wrk = application_get_worker (app, f->subscribers[i])))
271 mq_send_session_close_evt (app_wrk, sh, SESSION_CTRL_EVT_DISCONNECTED);
276 mq_send_session_disconnected_cb (session_t * s)
278 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
279 session_handle_t sh = session_handle (s);
281 mq_send_session_close_evt (app_wrk, session_handle (s),
282 SESSION_CTRL_EVT_DISCONNECTED);
284 if (svm_fifo_n_subscribers (s->rx_fifo))
285 mq_notify_close_subscribers (app_wrk->app_index, sh, s->rx_fifo,
286 SESSION_CTRL_EVT_DISCONNECTED);
290 mq_send_session_reset_cb (session_t * s)
292 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
293 session_handle_t sh = session_handle (s);
295 mq_send_session_close_evt (app_wrk, sh, SESSION_CTRL_EVT_RESET);
297 if (svm_fifo_n_subscribers (s->rx_fifo))
298 mq_notify_close_subscribers (app_wrk->app_index, sh, s->rx_fifo,
299 SESSION_CTRL_EVT_RESET);
303 mq_send_session_connected_cb (u32 app_wrk_index, u32 api_context,
304 session_t * s, u8 is_fail)
306 svm_msg_q_msg_t _msg, *msg = &_msg;
307 session_connected_msg_t *mp;
308 svm_msg_q_t *vpp_mq, *app_mq;
309 transport_connection_t *tc;
310 app_worker_t *app_wrk;
311 session_event_t *evt;
313 app_wrk = app_worker_get (app_wrk_index);
314 app_mq = app_wrk->event_queue;
317 clib_warning ("app %u with api index: %u not attached",
318 app_wrk->app_index, app_wrk->api_client_index);
322 if (mq_try_lock_and_alloc_msg (app_mq, msg))
325 evt = svm_msg_q_msg_data (app_mq, msg);
326 clib_memset (evt, 0, sizeof (*evt));
327 evt->event_type = SESSION_CTRL_EVT_CONNECTED;
328 mp = (session_connected_msg_t *) evt->data;
329 clib_memset (mp, 0, sizeof (*mp));
330 mp->context = api_context;
335 if (session_has_transport (s))
337 tc = session_get_transport (s);
344 vpp_mq = session_main_get_vpp_event_queue (s->thread_index);
345 mp->handle = session_handle (s);
346 mp->vpp_event_queue_address = pointer_to_uword (vpp_mq);
348 session_get_endpoint (s, &mp->lcl, 1 /* is_lcl */ );
350 mp->server_rx_fifo = pointer_to_uword (s->rx_fifo);
351 mp->server_tx_fifo = pointer_to_uword (s->tx_fifo);
352 mp->segment_handle = session_segment_handle (s);
356 ct_connection_t *cct;
359 cct = (ct_connection_t *) session_get_transport (s);
360 mp->handle = session_handle (s);
361 mp->lcl.port = cct->c_lcl_port;
362 mp->lcl.is_ip4 = cct->c_is_ip4;
363 vpp_mq = session_main_get_vpp_event_queue (0);
364 mp->vpp_event_queue_address = pointer_to_uword (vpp_mq);
365 mp->server_rx_fifo = pointer_to_uword (s->rx_fifo);
366 mp->server_tx_fifo = pointer_to_uword (s->tx_fifo);
367 mp->segment_handle = session_segment_handle (s);
368 ss = ct_session_get_peer (s);
369 mp->ct_rx_fifo = pointer_to_uword (ss->tx_fifo);
370 mp->ct_tx_fifo = pointer_to_uword (ss->rx_fifo);
371 mp->ct_segment_handle = session_segment_handle (ss);
375 mp->retval = is_fail ?
376 clib_host_to_net_u32 (VNET_API_ERROR_SESSION_CONNECT) : 0;
378 svm_msg_q_add_and_unlock (app_mq, msg);
383 mq_send_session_bound_cb (u32 app_wrk_index, u32 api_context,
384 session_handle_t handle, int rv)
386 svm_msg_q_msg_t _msg, *msg = &_msg;
387 svm_msg_q_t *app_mq, *vpp_evt_q;
388 transport_endpoint_t tep;
389 session_bound_msg_t *mp;
390 app_worker_t *app_wrk;
391 session_event_t *evt;
394 app_wrk = app_worker_get (app_wrk_index);
395 app_mq = app_wrk->event_queue;
398 clib_warning ("app %u with api index: %u not attached",
399 app_wrk->app_index, app_wrk->api_client_index);
403 if (mq_try_lock_and_alloc_msg (app_mq, msg))
406 evt = svm_msg_q_msg_data (app_mq, msg);
407 clib_memset (evt, 0, sizeof (*evt));
408 evt->event_type = SESSION_CTRL_EVT_BOUND;
409 mp = (session_bound_msg_t *) evt->data;
410 mp->context = api_context;
416 al = app_listener_get_w_handle (handle);
417 if (al->session_index != SESSION_INVALID_INDEX)
418 ls = app_listener_get_session (al);
420 ls = app_listener_get_local_session (al);
422 session_get_endpoint (ls, &tep, 1 /* is_lcl */ );
423 mp->lcl_port = tep.port;
424 mp->lcl_is_ip4 = tep.is_ip4;
425 clib_memcpy_fast (mp->lcl_ip, &tep.ip, sizeof (tep.ip));
427 vpp_evt_q = session_main_get_vpp_event_queue (0);
428 mp->vpp_evt_q = pointer_to_uword (vpp_evt_q);
430 if (session_transport_service_type (ls) == TRANSPORT_SERVICE_CL)
432 mp->rx_fifo = pointer_to_uword (ls->rx_fifo);
433 mp->tx_fifo = pointer_to_uword (ls->tx_fifo);
438 svm_msg_q_add_and_unlock (app_mq, msg);
443 mq_send_unlisten_reply (app_worker_t * app_wrk, session_handle_t sh,
446 svm_msg_q_msg_t _msg, *msg = &_msg;
447 session_unlisten_reply_msg_t *ump;
449 session_event_t *evt;
451 app_mq = app_wrk->event_queue;
452 if (mq_try_lock_and_alloc_msg (app_mq, msg))
455 evt = svm_msg_q_msg_data (app_mq, msg);
456 clib_memset (evt, 0, sizeof (*evt));
457 evt->event_type = SESSION_CTRL_EVT_UNLISTEN_REPLY;
458 ump = (session_unlisten_reply_msg_t *) evt->data;
459 ump->context = context;
462 svm_msg_q_add_and_unlock (app_mq, msg);
466 mq_send_session_migrate_cb (session_t * s, session_handle_t new_sh)
468 clib_warning ("not supported");
471 static session_cb_vft_t session_mq_cb_vft = {
472 .session_accept_callback = mq_send_session_accepted_cb,
473 .session_disconnect_callback = mq_send_session_disconnected_cb,
474 .session_connected_callback = mq_send_session_connected_cb,
475 .session_reset_callback = mq_send_session_reset_cb,
476 .session_migrate_callback = mq_send_session_migrate_cb,
477 .add_segment_callback = send_add_segment_callback,
478 .del_segment_callback = send_del_segment_callback,
482 vl_api_session_enable_disable_t_handler (vl_api_session_enable_disable_t * mp)
484 vl_api_session_enable_disable_reply_t *rmp;
485 vlib_main_t *vm = vlib_get_main ();
488 vnet_session_enable_disable (vm, mp->is_enable);
489 REPLY_MACRO (VL_API_SESSION_ENABLE_DISABLE_REPLY);
492 /* ### WILL BE DEPRECATED POST 20.01 ### */
494 vl_api_application_attach_t_handler (vl_api_application_attach_t * mp)
496 int rv = 0, fds[SESSION_N_FD_TYPE], n_fds = 0;
497 vl_api_application_attach_reply_t *rmp;
498 ssvm_private_t *segp, *evt_q_segment;
499 vnet_app_attach_args_t _a, *a = &_a;
500 vl_api_registration_t *reg;
503 reg = vl_api_client_index_to_registration (mp->client_index);
507 if (session_main_is_enabled () == 0)
509 rv = VNET_API_ERROR_FEATURE_DISABLED;
513 STATIC_ASSERT (sizeof (u64) * APP_OPTIONS_N_OPTIONS <=
514 sizeof (mp->options),
515 "Out of options, fix api message definition");
517 clib_memset (a, 0, sizeof (*a));
518 a->api_client_index = mp->client_index;
519 a->options = mp->options;
520 a->session_cb_vft = &session_mq_cb_vft;
521 if (mp->namespace_id_len > 64)
523 rv = VNET_API_ERROR_INVALID_VALUE;
527 if (mp->namespace_id_len)
529 vec_validate (a->namespace_id, mp->namespace_id_len - 1);
530 clib_memcpy_fast (a->namespace_id, mp->namespace_id,
531 mp->namespace_id_len);
534 if ((rv = vnet_application_attach (a)))
536 clib_warning ("attach returned: %d", rv);
537 vec_free (a->namespace_id);
540 vec_free (a->namespace_id);
542 /* Send event queues segment */
543 if ((evt_q_segment = session_main_get_evt_q_segment ()))
545 fd_flags |= SESSION_FD_F_VPP_MQ_SEGMENT;
546 fds[n_fds] = evt_q_segment->fd;
549 /* Send fifo segment fd if needed */
550 if (ssvm_type (a->segment) == SSVM_SEGMENT_MEMFD)
552 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
553 fds[n_fds] = a->segment->fd;
556 if (a->options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
558 fd_flags |= SESSION_FD_F_MQ_EVENTFD;
559 fds[n_fds] = svm_msg_q_get_producer_eventfd (a->app_evt_q);
566 REPLY_MACRO2 (VL_API_APPLICATION_ATTACH_REPLY, ({
570 rmp->app_index = clib_host_to_net_u32 (a->app_index);
571 rmp->segment_name_length = 0;
572 rmp->segment_size = segp->ssvm_size;
573 if (vec_len (segp->name))
575 memcpy (rmp->segment_name, segp->name, vec_len (segp->name));
576 rmp->segment_name_length = vec_len (segp->name);
578 rmp->app_event_queue_address = pointer_to_uword (a->app_evt_q);
580 rmp->fd_flags = fd_flags;
581 rmp->segment_handle = clib_host_to_net_u64 (a->segment_handle);
587 session_send_fds (reg, fds, n_fds);
591 vl_api_app_attach_t_handler (vl_api_app_attach_t * mp)
593 int rv = 0, fds[SESSION_N_FD_TYPE], n_fds = 0;
594 vl_api_app_attach_reply_t *rmp;
595 ssvm_private_t *segp, *evt_q_segment;
596 vnet_app_attach_args_t _a, *a = &_a;
597 u8 fd_flags = 0, ctrl_thread;
598 vl_api_registration_t *reg;
599 svm_msg_q_t *ctrl_mq;
601 reg = vl_api_client_index_to_registration (mp->client_index);
605 if (session_main_is_enabled () == 0)
607 rv = VNET_API_ERROR_FEATURE_DISABLED;
611 STATIC_ASSERT (sizeof (u64) * APP_OPTIONS_N_OPTIONS <=
612 sizeof (mp->options),
613 "Out of options, fix api message definition");
615 clib_memset (a, 0, sizeof (*a));
616 a->api_client_index = mp->client_index;
617 a->options = mp->options;
618 a->session_cb_vft = &session_mq_cb_vft;
619 if (mp->namespace_id_len > 64)
621 rv = VNET_API_ERROR_INVALID_VALUE;
625 if (mp->namespace_id_len)
627 vec_validate (a->namespace_id, mp->namespace_id_len - 1);
628 clib_memcpy_fast (a->namespace_id, mp->namespace_id,
629 mp->namespace_id_len);
632 if ((rv = vnet_application_attach (a)))
634 clib_warning ("attach returned: %d", rv);
635 vec_free (a->namespace_id);
638 vec_free (a->namespace_id);
640 /* Send event queues segment */
641 if ((evt_q_segment = session_main_get_evt_q_segment ()))
643 fd_flags |= SESSION_FD_F_VPP_MQ_SEGMENT;
644 fds[n_fds] = evt_q_segment->fd;
647 /* Send fifo segment fd if needed */
648 if (ssvm_type (a->segment) == SSVM_SEGMENT_MEMFD)
650 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
651 fds[n_fds] = a->segment->fd;
654 if (a->options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
656 fd_flags |= SESSION_FD_F_MQ_EVENTFD;
657 fds[n_fds] = svm_msg_q_get_producer_eventfd (a->app_evt_q);
663 ctrl_thread = vlib_num_workers ()? 1 : 0;
664 ctrl_mq = session_main_get_vpp_event_queue (ctrl_thread);
666 REPLY_MACRO2 (VL_API_APP_ATTACH_REPLY, ({
670 rmp->app_index = clib_host_to_net_u32 (a->app_index);
671 rmp->app_mq = pointer_to_uword (a->app_evt_q);
672 rmp->vpp_ctrl_mq = pointer_to_uword (ctrl_mq);
673 rmp->vpp_ctrl_mq_thread = ctrl_thread;
675 rmp->fd_flags = fd_flags;
676 if (vec_len (segp->name))
678 memcpy (rmp->segment_name, segp->name, vec_len (segp->name));
679 rmp->segment_name_length = vec_len (segp->name);
681 rmp->segment_size = segp->ssvm_size;
682 rmp->segment_handle = clib_host_to_net_u64 (a->segment_handle);
688 session_send_fds (reg, fds, n_fds);
691 /* ### WILL BE DEPRECATED POST 20.01 ### */
693 vl_api_application_detach_t_handler (vl_api_application_detach_t * mp)
695 vl_api_application_detach_reply_t *rmp;
696 int rv = VNET_API_ERROR_INVALID_VALUE_2;
697 vnet_app_detach_args_t _a, *a = &_a;
700 if (session_main_is_enabled () == 0)
702 rv = VNET_API_ERROR_FEATURE_DISABLED;
706 app = application_lookup (mp->client_index);
709 a->app_index = app->app_index;
710 a->api_client_index = mp->client_index;
711 rv = vnet_application_detach (a);
715 REPLY_MACRO (VL_API_APPLICATION_DETACH_REPLY);
718 /* ### WILL BE DEPRECATED POST 20.01 ### */
720 vl_api_bind_uri_t_handler (vl_api_bind_uri_t * mp)
722 vl_api_bind_uri_reply_t *rmp;
723 vnet_listen_args_t _a, *a = &_a;
724 application_t *app = 0;
725 app_worker_t *app_wrk;
728 if (session_main_is_enabled () == 0)
730 rv = VNET_API_ERROR_FEATURE_DISABLED;
734 app = application_lookup (mp->client_index);
737 clib_memset (a, 0, sizeof (*a));
738 a->uri = (char *) mp->uri;
739 a->app_index = app->app_index;
740 rv = vnet_bind_uri (a);
744 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
749 REPLY_MACRO (VL_API_BIND_URI_REPLY);
753 app_wrk = application_get_worker (app, 0);
754 mq_send_session_bound_cb (app_wrk->wrk_index, mp->context, a->handle,
759 /* ### WILL BE DEPRECATED POST 20.01 ### */
761 vl_api_unbind_uri_t_handler (vl_api_unbind_uri_t * mp)
763 vl_api_unbind_uri_reply_t *rmp;
765 vnet_unlisten_args_t _a, *a = &_a;
768 if (session_main_is_enabled () == 0)
770 rv = VNET_API_ERROR_FEATURE_DISABLED;
774 app = application_lookup (mp->client_index);
777 a->uri = (char *) mp->uri;
778 a->app_index = app->app_index;
779 a->wrk_map_index = 0;
780 rv = vnet_unbind_uri (a);
784 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
788 REPLY_MACRO (VL_API_UNBIND_URI_REPLY);
791 /* ### WILL BE DEPRECATED POST 20.01 ### */
793 vl_api_connect_uri_t_handler (vl_api_connect_uri_t * mp)
795 vl_api_connect_uri_reply_t *rmp;
796 vnet_connect_args_t _a, *a = &_a;
800 if (session_main_is_enabled () == 0)
802 rv = VNET_API_ERROR_FEATURE_DISABLED;
806 app = application_lookup (mp->client_index);
809 clib_memset (a, 0, sizeof (*a));
810 a->uri = (char *) mp->uri;
811 a->api_context = mp->context;
812 a->app_index = app->app_index;
813 if ((rv = vnet_connect_uri (a)))
814 clib_warning ("connect_uri returned: %d", rv);
818 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
822 * Don't reply to stream (tcp) connects. The reply will come once
823 * the connection is established. In case of the redirects, the reply
824 * will come from the server app.
830 REPLY_MACRO (VL_API_CONNECT_URI_REPLY);
833 /* ### WILL BE DEPRECATED POST 20.01 ### */
835 vl_api_disconnect_session_t_handler (vl_api_disconnect_session_t * mp)
837 vl_api_disconnect_session_reply_t *rmp;
838 vnet_disconnect_args_t _a, *a = &_a;
842 if (session_main_is_enabled () == 0)
844 rv = VNET_API_ERROR_FEATURE_DISABLED;
848 app = application_lookup (mp->client_index);
851 a->handle = mp->handle;
852 a->app_index = app->app_index;
853 rv = vnet_disconnect_session (a);
857 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
861 REPLY_MACRO2 (VL_API_DISCONNECT_SESSION_REPLY, rmp->handle = mp->handle);
864 /* ### WILL BE DEPRECATED POST 20.01 ### */
866 vl_api_disconnect_session_reply_t_handler (vl_api_disconnect_session_reply_t *
869 vnet_disconnect_args_t _a, *a = &_a;
872 /* Client objected to disconnecting the session, log and continue */
875 clib_warning ("client retval %d", mp->retval);
879 /* Disconnect has been confirmed. Confirm close to transport */
880 app = application_lookup (mp->context);
883 a->handle = mp->handle;
884 a->app_index = app->app_index;
885 vnet_disconnect_session (a);
890 vl_api_map_another_segment_reply_t_handler (vl_api_map_another_segment_reply_t
893 clib_warning ("not implemented");
896 /* ### WILL BE DEPRECATED POST 20.01 ### */
898 vl_api_bind_sock_t_handler (vl_api_bind_sock_t * mp)
900 vnet_listen_args_t _a, *a = &_a;
901 vl_api_bind_sock_reply_t *rmp;
902 application_t *app = 0;
903 app_worker_t *app_wrk;
904 ip46_address_t *ip46;
907 if (session_main_is_enabled () == 0)
909 rv = VNET_API_ERROR_FEATURE_DISABLED;
913 app = application_lookup (mp->client_index);
916 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
920 ip46 = (ip46_address_t *) mp->ip;
921 clib_memset (a, 0, sizeof (*a));
922 a->sep.is_ip4 = mp->is_ip4;
924 a->sep.port = mp->port;
925 a->sep.fib_index = mp->vrf;
926 a->sep.sw_if_index = ENDPOINT_INVALID_INDEX;
927 a->sep.transport_proto = mp->proto;
928 a->app_index = app->app_index;
929 a->wrk_map_index = mp->wrk_index;
931 if ((rv = vnet_listen (a)))
932 clib_warning ("listen returned: %d", rv);
935 /* Actual reply sent only over mq */
936 REPLY_MACRO (VL_API_BIND_SOCK_REPLY);
940 app_wrk = application_get_worker (app, mp->wrk_index);
941 mq_send_session_bound_cb (app_wrk->wrk_index, mp->context, a->handle,
946 /* ### WILL BE DEPRECATED POST 20.01 ### */
948 vl_api_unbind_sock_t_handler (vl_api_unbind_sock_t * mp)
950 vl_api_unbind_sock_reply_t *rmp;
951 vnet_unlisten_args_t _a, *a = &_a;
952 app_worker_t *app_wrk;
953 application_t *app = 0;
956 if (session_main_is_enabled () == 0)
958 rv = VNET_API_ERROR_FEATURE_DISABLED;
962 app = application_lookup (mp->client_index);
965 a->app_index = app->app_index;
966 a->handle = mp->handle;
967 a->wrk_map_index = mp->wrk_index;
968 if ((rv = vnet_unlisten (a)))
969 clib_warning ("unlisten returned: %d", rv);
973 REPLY_MACRO (VL_API_UNBIND_SOCK_REPLY);
975 app_wrk = application_get_worker (app, a->wrk_map_index);
979 mq_send_unlisten_reply (app_wrk, mp->handle, mp->context, rv);
982 /* ### WILL BE DEPRECATED POST 20.01 ### */
984 vl_api_connect_sock_t_handler (vl_api_connect_sock_t * mp)
986 vl_api_connect_sock_reply_t *rmp;
987 vnet_connect_args_t _a, *a = &_a;
988 application_t *app = 0;
991 if (session_main_is_enabled () == 0)
993 rv = VNET_API_ERROR_FEATURE_DISABLED;
997 app = application_lookup (mp->client_index);
1000 svm_queue_t *client_q;
1001 ip46_address_t *ip46 = (ip46_address_t *) mp->ip;
1003 clib_memset (a, 0, sizeof (*a));
1004 client_q = vl_api_client_index_to_input_queue (mp->client_index);
1005 mp->client_queue_address = pointer_to_uword (client_q);
1006 a->sep.is_ip4 = mp->is_ip4;
1008 a->sep.port = mp->port;
1009 a->sep.transport_proto = mp->proto;
1010 a->sep.peer.fib_index = mp->vrf;
1011 a->sep.peer.sw_if_index = ENDPOINT_INVALID_INDEX;
1012 a->sep_ext.parent_handle = mp->parent_handle;
1013 if (mp->hostname_len)
1015 vec_validate (a->sep_ext.hostname, mp->hostname_len - 1);
1016 clib_memcpy_fast (a->sep_ext.hostname, mp->hostname,
1019 a->api_context = mp->context;
1020 a->app_index = app->app_index;
1021 a->wrk_map_index = mp->wrk_index;
1022 if ((rv = vnet_connect (a)))
1023 clib_warning ("connect returned: %U", format_vnet_api_errno, rv);
1024 vec_free (a->sep_ext.hostname);
1028 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
1034 /* Got some error, relay it */
1037 REPLY_MACRO (VL_API_CONNECT_SOCK_REPLY);
1041 app_worker_t *app_wrk = application_get_worker (app, mp->wrk_index);
1042 mq_send_session_connected_cb (app_wrk->wrk_index, mp->context, 0, 1);
1047 vl_api_app_worker_add_del_t_handler (vl_api_app_worker_add_del_t * mp)
1049 int rv = 0, fds[SESSION_N_FD_TYPE], n_fds = 0;
1050 vl_api_app_worker_add_del_reply_t *rmp;
1051 vl_api_registration_t *reg;
1055 if (!session_main_is_enabled ())
1057 rv = VNET_API_ERROR_FEATURE_DISABLED;
1061 reg = vl_api_client_index_to_registration (mp->client_index);
1065 app = application_get_if_valid (clib_net_to_host_u32 (mp->app_index));
1068 rv = VNET_API_ERROR_INVALID_VALUE;
1072 vnet_app_worker_add_del_args_t args = {
1073 .app_index = app->app_index,
1074 .wrk_map_index = clib_net_to_host_u32 (mp->wrk_index),
1075 .api_client_index = mp->client_index,
1076 .is_add = mp->is_add
1078 rv = vnet_app_worker_add_del (&args);
1081 clib_warning ("app worker add/del returned: %d", rv);
1088 /* Send fifo segment fd if needed */
1089 if (ssvm_type (args.segment) == SSVM_SEGMENT_MEMFD)
1091 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
1092 fds[n_fds] = args.segment->fd;
1095 if (application_segment_manager_properties (app)->use_mq_eventfd)
1097 fd_flags |= SESSION_FD_F_MQ_EVENTFD;
1098 fds[n_fds] = svm_msg_q_get_producer_eventfd (args.evt_q);
1104 REPLY_MACRO2 (VL_API_APP_WORKER_ADD_DEL_REPLY, ({
1105 rmp->is_add = mp->is_add;
1106 rmp->wrk_index = clib_host_to_net_u32 (args.wrk_map_index);
1107 rmp->segment_handle = clib_host_to_net_u64 (args.segment_handle);
1108 if (!rv && mp->is_add)
1110 if (vec_len (args.segment->name))
1112 memcpy (rmp->segment_name, args.segment->name,
1113 vec_len (args.segment->name));
1114 rmp->segment_name_length = vec_len (args.segment->name);
1116 rmp->app_event_queue_address = pointer_to_uword (args.evt_q);
1118 rmp->fd_flags = fd_flags;
1124 session_send_fds (reg, fds, n_fds);
1128 vl_api_app_namespace_add_del_t_handler (vl_api_app_namespace_add_del_t * mp)
1130 vl_api_app_namespace_add_del_reply_t *rmp;
1131 u32 appns_index = 0;
1134 if (!session_main_is_enabled ())
1136 rv = VNET_API_ERROR_FEATURE_DISABLED;
1140 if (mp->namespace_id_len > ARRAY_LEN (mp->namespace_id))
1142 rv = VNET_API_ERROR_INVALID_VALUE;
1146 vec_validate (ns_id, mp->namespace_id_len - 1);
1147 clib_memcpy_fast (ns_id, mp->namespace_id, mp->namespace_id_len);
1148 vnet_app_namespace_add_del_args_t args = {
1150 .secret = clib_net_to_host_u64 (mp->secret),
1151 .sw_if_index = clib_net_to_host_u32 (mp->sw_if_index),
1152 .ip4_fib_id = clib_net_to_host_u32 (mp->ip4_fib_id),
1153 .ip6_fib_id = clib_net_to_host_u32 (mp->ip6_fib_id),
1156 rv = vnet_app_namespace_add_del (&args);
1159 appns_index = app_namespace_index_from_id (ns_id);
1160 if (appns_index == APP_NAMESPACE_INVALID_INDEX)
1162 clib_warning ("app ns lookup failed");
1163 rv = VNET_API_ERROR_UNSPECIFIED;
1170 REPLY_MACRO2 (VL_API_APP_NAMESPACE_ADD_DEL_REPLY, ({
1172 rmp->appns_index = clib_host_to_net_u32 (appns_index);
1178 vl_api_session_rule_add_del_t_handler (vl_api_session_rule_add_del_t * mp)
1180 vl_api_session_rule_add_del_reply_t *rmp;
1181 session_rule_add_del_args_t args;
1182 session_rule_table_add_del_args_t *table_args = &args.table_args;
1186 clib_memset (&args, 0, sizeof (args));
1187 fib_proto = mp->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
1189 table_args->lcl.fp_len = mp->lcl_plen;
1190 table_args->lcl.fp_proto = fib_proto;
1191 table_args->rmt.fp_len = mp->rmt_plen;
1192 table_args->rmt.fp_proto = fib_proto;
1193 table_args->lcl_port = mp->lcl_port;
1194 table_args->rmt_port = mp->rmt_port;
1195 table_args->action_index = clib_net_to_host_u32 (mp->action_index);
1196 table_args->is_add = mp->is_add;
1197 mp->tag[sizeof (mp->tag) - 1] = 0;
1198 table_args->tag = format (0, "%s", mp->tag);
1199 args.appns_index = clib_net_to_host_u32 (mp->appns_index);
1200 args.scope = mp->scope;
1201 args.transport_proto = mp->transport_proto;
1203 clib_memset (&table_args->lcl.fp_addr, 0, sizeof (table_args->lcl.fp_addr));
1204 clib_memset (&table_args->rmt.fp_addr, 0, sizeof (table_args->rmt.fp_addr));
1205 ip_set (&table_args->lcl.fp_addr, mp->lcl_ip, mp->is_ip4);
1206 ip_set (&table_args->rmt.fp_addr, mp->rmt_ip, mp->is_ip4);
1207 rv = vnet_session_rule_add_del (&args);
1209 clib_warning ("rule add del returned: %d", rv);
1210 vec_free (table_args->tag);
1211 REPLY_MACRO (VL_API_SESSION_RULE_ADD_DEL_REPLY);
1215 send_session_rule_details4 (mma_rule_16_t * rule, u8 is_local,
1216 u8 transport_proto, u32 appns_index, u8 * tag,
1217 vl_api_registration_t * reg, u32 context)
1219 vl_api_session_rules_details_t *rmp = 0;
1220 session_mask_or_match_4_t *match =
1221 (session_mask_or_match_4_t *) & rule->match;
1222 session_mask_or_match_4_t *mask =
1223 (session_mask_or_match_4_t *) & rule->mask;
1225 rmp = vl_msg_api_alloc (sizeof (*rmp));
1226 clib_memset (rmp, 0, sizeof (*rmp));
1227 rmp->_vl_msg_id = ntohs (VL_API_SESSION_RULES_DETAILS);
1228 rmp->context = context;
1231 clib_memcpy_fast (rmp->lcl_ip, &match->lcl_ip, sizeof (match->lcl_ip));
1232 clib_memcpy_fast (rmp->rmt_ip, &match->rmt_ip, sizeof (match->rmt_ip));
1233 rmp->lcl_plen = ip4_mask_to_preflen (&mask->lcl_ip);
1234 rmp->rmt_plen = ip4_mask_to_preflen (&mask->rmt_ip);
1235 rmp->lcl_port = match->lcl_port;
1236 rmp->rmt_port = match->rmt_port;
1237 rmp->action_index = clib_host_to_net_u32 (rule->action_index);
1239 is_local ? SESSION_RULE_SCOPE_LOCAL : SESSION_RULE_SCOPE_GLOBAL;
1240 rmp->transport_proto = transport_proto;
1241 rmp->appns_index = clib_host_to_net_u32 (appns_index);
1244 clib_memcpy_fast (rmp->tag, tag, vec_len (tag));
1245 rmp->tag[vec_len (tag)] = 0;
1248 vl_api_send_msg (reg, (u8 *) rmp);
1252 send_session_rule_details6 (mma_rule_40_t * rule, u8 is_local,
1253 u8 transport_proto, u32 appns_index, u8 * tag,
1254 vl_api_registration_t * reg, u32 context)
1256 vl_api_session_rules_details_t *rmp = 0;
1257 session_mask_or_match_6_t *match =
1258 (session_mask_or_match_6_t *) & rule->match;
1259 session_mask_or_match_6_t *mask =
1260 (session_mask_or_match_6_t *) & rule->mask;
1262 rmp = vl_msg_api_alloc (sizeof (*rmp));
1263 clib_memset (rmp, 0, sizeof (*rmp));
1264 rmp->_vl_msg_id = ntohs (VL_API_SESSION_RULES_DETAILS);
1265 rmp->context = context;
1268 clib_memcpy_fast (rmp->lcl_ip, &match->lcl_ip, sizeof (match->lcl_ip));
1269 clib_memcpy_fast (rmp->rmt_ip, &match->rmt_ip, sizeof (match->rmt_ip));
1270 rmp->lcl_plen = ip6_mask_to_preflen (&mask->lcl_ip);
1271 rmp->rmt_plen = ip6_mask_to_preflen (&mask->rmt_ip);
1272 rmp->lcl_port = match->lcl_port;
1273 rmp->rmt_port = match->rmt_port;
1274 rmp->action_index = clib_host_to_net_u32 (rule->action_index);
1276 is_local ? SESSION_RULE_SCOPE_LOCAL : SESSION_RULE_SCOPE_GLOBAL;
1277 rmp->transport_proto = transport_proto;
1278 rmp->appns_index = clib_host_to_net_u32 (appns_index);
1281 clib_memcpy_fast (rmp->tag, tag, vec_len (tag));
1282 rmp->tag[vec_len (tag)] = 0;
1285 vl_api_send_msg (reg, (u8 *) rmp);
1289 send_session_rules_table_details (session_rules_table_t * srt, u8 fib_proto,
1290 u8 tp, u8 is_local, u32 appns_index,
1291 vl_api_registration_t * reg, u32 context)
1293 mma_rule_16_t *rule16;
1294 mma_rule_40_t *rule40;
1295 mma_rules_table_16_t *srt16;
1296 mma_rules_table_40_t *srt40;
1299 if (is_local || fib_proto == FIB_PROTOCOL_IP4)
1303 srt16 = &srt->session_rules_tables_16;
1304 pool_foreach (rule16, srt16->rules, ({
1305 ri = mma_rules_table_rule_index_16 (srt16, rule16);
1306 tag = session_rules_table_rule_tag (srt, ri, 1);
1307 send_session_rule_details4 (rule16, is_local, tp, appns_index, tag,
1312 if (is_local || fib_proto == FIB_PROTOCOL_IP6)
1316 srt40 = &srt->session_rules_tables_40;
1317 pool_foreach (rule40, srt40->rules, ({
1318 ri = mma_rules_table_rule_index_40 (srt40, rule40);
1319 tag = session_rules_table_rule_tag (srt, ri, 1);
1320 send_session_rule_details6 (rule40, is_local, tp, appns_index, tag,
1328 vl_api_session_rules_dump_t_handler (vl_api_one_map_server_dump_t * mp)
1330 vl_api_registration_t *reg;
1331 session_table_t *st;
1334 reg = vl_api_client_index_to_registration (mp->client_index);
1339 session_table_foreach (st, ({
1340 for (tp = 0; tp < TRANSPORT_N_PROTO; tp++)
1342 send_session_rules_table_details (&st->session_rules[tp],
1343 st->active_fib_proto, tp,
1344 st->is_local, st->appns_index, reg,
1352 vl_api_application_tls_cert_add_t_handler (vl_api_application_tls_cert_add_t *
1355 vl_api_app_namespace_add_del_reply_t *rmp;
1356 vnet_app_add_tls_cert_args_t _a, *a = &_a;
1357 clib_error_t *error;
1361 if (!session_main_is_enabled ())
1363 rv = VNET_API_ERROR_FEATURE_DISABLED;
1366 if (!(app = application_lookup (mp->client_index)))
1368 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
1371 clib_memset (a, 0, sizeof (*a));
1372 a->app_index = app->app_index;
1373 cert_len = clib_net_to_host_u16 (mp->cert_len);
1374 if (cert_len > 10000)
1376 rv = VNET_API_ERROR_INVALID_VALUE;
1379 vec_validate (a->cert, cert_len);
1380 clib_memcpy_fast (a->cert, mp->cert, cert_len);
1381 if ((error = vnet_app_add_tls_cert (a)))
1383 rv = clib_error_get_code (error);
1384 clib_error_report (error);
1388 REPLY_MACRO (VL_API_APPLICATION_TLS_CERT_ADD_REPLY);
1392 vl_api_application_tls_key_add_t_handler (vl_api_application_tls_key_add_t *
1395 vl_api_app_namespace_add_del_reply_t *rmp;
1396 vnet_app_add_tls_key_args_t _a, *a = &_a;
1397 clib_error_t *error;
1401 if (!session_main_is_enabled ())
1403 rv = VNET_API_ERROR_FEATURE_DISABLED;
1406 if (!(app = application_lookup (mp->client_index)))
1408 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
1411 clib_memset (a, 0, sizeof (*a));
1412 a->app_index = app->app_index;
1413 key_len = clib_net_to_host_u16 (mp->key_len);
1414 if (key_len > 10000)
1416 rv = VNET_API_ERROR_INVALID_VALUE;
1419 vec_validate (a->key, key_len);
1420 clib_memcpy_fast (a->key, mp->key, key_len);
1421 if ((error = vnet_app_add_tls_key (a)))
1423 rv = clib_error_get_code (error);
1424 clib_error_report (error);
1428 REPLY_MACRO (VL_API_APPLICATION_TLS_KEY_ADD_REPLY);
1431 static clib_error_t *
1432 application_reaper_cb (u32 client_index)
1434 application_t *app = application_lookup (client_index);
1435 vnet_app_detach_args_t _a, *a = &_a;
1438 a->app_index = app->app_index;
1439 a->api_client_index = client_index;
1440 vnet_application_detach (a);
1445 VL_MSG_API_REAPER_FUNCTION (application_reaper_cb);
1447 #define vl_msg_name_crc_list
1448 #include <vnet/vnet_all_api_h.h>
1449 #undef vl_msg_name_crc_list
1452 setup_message_id_table (api_main_t * am)
1454 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
1455 foreach_vl_msg_name_crc_session;
1460 * session_api_hookup
1461 * Add uri's API message handlers to the table.
1462 * vlib has already mapped shared memory and
1463 * added the client registration handlers.
1464 * See .../open-repo/vlib/memclnt_vlib.c:memclnt_process()
1466 static clib_error_t *
1467 session_api_hookup (vlib_main_t * vm)
1469 api_main_t *am = &api_main;
1472 vl_msg_api_set_handlers(VL_API_##N, #n, \
1473 vl_api_##n##_t_handler, \
1475 vl_api_##n##_t_endian, \
1476 vl_api_##n##_t_print, \
1477 sizeof(vl_api_##n##_t), 1);
1478 foreach_session_api_msg;
1482 * Messages which bounce off the data-plane to
1483 * an API client. Simply tells the message handling infra not
1484 * to free the message.
1486 * Bounced message handlers MUST NOT block the data plane
1488 am->message_bounce[VL_API_CONNECT_URI] = 1;
1489 am->message_bounce[VL_API_CONNECT_SOCK] = 1;
1492 * Set up the (msg_name, crc, message-id) table
1494 setup_message_id_table (am);
1499 VLIB_API_INIT_FUNCTION (session_api_hookup);
1502 * fd.io coding-style-patch-verification: ON
1505 * eval: (c-set-style "gnu")