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 svm_fifo_segment_private_t *fs;
87 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;
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 (s->listener_index);
201 al = app_listener_get (app, listener->al_index);
202 mp->listener_handle = app_listener_handle (al);
203 if (application_is_proxy (app))
206 app_worker_first_listener (app_wrk, session_get_fib_proto (s),
207 session_get_transport_proto (s));
209 mp->listener_handle = listen_session_get_handle (listener);
211 vpp_queue = session_main_get_vpp_event_queue (s->thread_index);
212 mp->vpp_event_queue_address = pointer_to_uword (vpp_queue);
213 mp->handle = session_handle (s);
215 session_get_endpoint (s, (ip46_address_t *) mp->ip, &mp->port,
216 &mp->is_ip4, 0 /* is_lcl */ );
222 ct = (ct_connection_t *) session_get_transport (s);
223 listener = listen_session_get (s->listener_index);
224 al = app_listener_get (app, listener->al_index);
225 mp->listener_handle = app_listener_handle (al);
226 mp->is_ip4 = session_type_is_ip4 (listener->session_type);
227 mp->handle = session_handle (s);
228 mp->port = ct->c_rmt_port;
229 vpp_queue = session_main_get_vpp_event_queue (0);
230 mp->vpp_event_queue_address = pointer_to_uword (vpp_queue);
232 svm_msg_q_add_and_unlock (app_mq, msg);
238 mq_send_session_close_evt (app_worker_t * app_wrk, session_handle_t sh,
239 session_evt_type_t evt_type)
241 svm_msg_q_msg_t _msg, *msg = &_msg;
242 session_disconnected_msg_t *mp;
244 session_event_t *evt;
246 app_mq = app_wrk->event_queue;
247 if (mq_try_lock_and_alloc_msg (app_mq, msg))
249 evt = svm_msg_q_msg_data (app_mq, msg);
250 clib_memset (evt, 0, sizeof (*evt));
251 evt->event_type = evt_type;
252 mp = (session_disconnected_msg_t *) evt->data;
254 mp->context = app_wrk->api_client_index;
255 svm_msg_q_add_and_unlock (app_mq, msg);
259 mq_notify_close_subscribers (u32 app_index, session_handle_t sh,
260 svm_fifo_t * f, session_evt_type_t evt_type)
262 app_worker_t *app_wrk;
266 app = application_get (app_index);
270 for (i = 0; i < f->n_subscribers; i++)
272 if (!(app_wrk = application_get_worker (app, f->subscribers[i])))
274 mq_send_session_close_evt (app_wrk, sh, SESSION_CTRL_EVT_DISCONNECTED);
279 mq_send_session_disconnected_cb (session_t * s)
281 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
282 session_handle_t sh = session_handle (s);
284 mq_send_session_close_evt (app_wrk, session_handle (s),
285 SESSION_CTRL_EVT_DISCONNECTED);
287 if (svm_fifo_n_subscribers (s->rx_fifo))
288 mq_notify_close_subscribers (app_wrk->app_index, sh, s->rx_fifo,
289 SESSION_CTRL_EVT_DISCONNECTED);
293 mq_send_session_reset_cb (session_t * s)
295 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
296 session_handle_t sh = session_handle (s);
298 mq_send_session_close_evt (app_wrk, sh, SESSION_CTRL_EVT_RESET);
300 if (svm_fifo_n_subscribers (s->rx_fifo))
301 mq_notify_close_subscribers (app_wrk->app_index, sh, s->rx_fifo,
302 SESSION_CTRL_EVT_RESET);
306 mq_send_session_connected_cb (u32 app_wrk_index, u32 api_context,
307 session_t * s, u8 is_fail)
309 svm_msg_q_msg_t _msg, *msg = &_msg;
310 session_connected_msg_t *mp;
311 svm_msg_q_t *vpp_mq, *app_mq;
312 transport_connection_t *tc;
313 app_worker_t *app_wrk;
314 session_event_t *evt;
316 app_wrk = app_worker_get (app_wrk_index);
317 app_mq = app_wrk->event_queue;
320 clib_warning ("app %u with api index: %u not attached",
321 app_wrk->app_index, app_wrk->api_client_index);
325 if (mq_try_lock_and_alloc_msg (app_mq, msg))
328 evt = svm_msg_q_msg_data (app_mq, msg);
329 clib_memset (evt, 0, sizeof (*evt));
330 evt->event_type = SESSION_CTRL_EVT_CONNECTED;
331 mp = (session_connected_msg_t *) evt->data;
332 clib_memset (mp, 0, sizeof (*mp));
333 mp->context = api_context;
338 if (session_has_transport (s))
340 tc = session_get_transport (s);
347 vpp_mq = session_main_get_vpp_event_queue (s->thread_index);
348 mp->handle = session_handle (s);
349 mp->vpp_event_queue_address = pointer_to_uword (vpp_mq);
351 session_get_endpoint (s, (ip46_address_t *) mp->lcl_ip, &mp->lcl_port,
352 &mp->is_ip4, 1 /* is_lcl */ );
354 mp->server_rx_fifo = pointer_to_uword (s->rx_fifo);
355 mp->server_tx_fifo = pointer_to_uword (s->tx_fifo);
356 mp->segment_handle = session_segment_handle (s);
360 ct_connection_t *cct;
363 cct = (ct_connection_t *) session_get_transport (s);
364 mp->handle = session_handle (s);
365 mp->lcl_port = cct->c_lcl_port;
366 mp->is_ip4 = cct->c_is_ip4;
367 vpp_mq = session_main_get_vpp_event_queue (0);
368 mp->vpp_event_queue_address = pointer_to_uword (vpp_mq);
369 mp->server_rx_fifo = pointer_to_uword (s->rx_fifo);
370 mp->server_tx_fifo = pointer_to_uword (s->tx_fifo);
371 mp->segment_handle = session_segment_handle (s);
372 ss = ct_session_get_peer (s);
373 mp->ct_rx_fifo = pointer_to_uword (ss->tx_fifo);
374 mp->ct_tx_fifo = pointer_to_uword (ss->rx_fifo);
375 mp->ct_segment_handle = session_segment_handle (ss);
379 mp->retval = is_fail ?
380 clib_host_to_net_u32 (VNET_API_ERROR_SESSION_CONNECT) : 0;
382 svm_msg_q_add_and_unlock (app_mq, msg);
387 mq_send_session_bound_cb (u32 app_wrk_index, u32 api_context,
388 session_handle_t handle, int rv)
390 svm_msg_q_msg_t _msg, *msg = &_msg;
391 svm_msg_q_t *app_mq, *vpp_evt_q;
392 transport_connection_t *tc;
393 session_bound_msg_t *mp;
394 app_worker_t *app_wrk;
395 session_event_t *evt;
398 app_wrk = app_worker_get (app_wrk_index);
399 app_mq = app_wrk->event_queue;
402 clib_warning ("app %u with api index: %u not attached",
403 app_wrk->app_index, app_wrk->api_client_index);
407 if (mq_try_lock_and_alloc_msg (app_mq, msg))
410 evt = svm_msg_q_msg_data (app_mq, msg);
411 clib_memset (evt, 0, sizeof (*evt));
412 evt->event_type = SESSION_CTRL_EVT_BOUND;
413 mp = (session_bound_msg_t *) evt->data;
414 mp->context = api_context;
420 al = app_listener_get_w_handle (handle);
421 if (al->session_index != SESSION_INVALID_INDEX)
422 ls = app_listener_get_session (al);
424 ls = app_listener_get_local_session (al);
425 tc = listen_session_get_transport (ls);
426 mp->lcl_port = tc->lcl_port;
427 mp->lcl_is_ip4 = tc->is_ip4;
428 clib_memcpy_fast (mp->lcl_ip, &tc->lcl_ip, sizeof (tc->lcl_ip));
430 vpp_evt_q = session_main_get_vpp_event_queue (0);
431 mp->vpp_evt_q = pointer_to_uword (vpp_evt_q);
433 if (session_transport_service_type (ls) == TRANSPORT_SERVICE_CL)
435 mp->rx_fifo = pointer_to_uword (ls->rx_fifo);
436 mp->tx_fifo = pointer_to_uword (ls->tx_fifo);
441 svm_msg_q_add_and_unlock (app_mq, msg);
445 static session_cb_vft_t session_mq_cb_vft = {
446 .session_accept_callback = mq_send_session_accepted_cb,
447 .session_disconnect_callback = mq_send_session_disconnected_cb,
448 .session_connected_callback = mq_send_session_connected_cb,
449 .session_reset_callback = mq_send_session_reset_cb,
450 .add_segment_callback = send_add_segment_callback,
451 .del_segment_callback = send_del_segment_callback,
455 vl_api_session_enable_disable_t_handler (vl_api_session_enable_disable_t * mp)
457 vl_api_session_enable_disable_reply_t *rmp;
458 vlib_main_t *vm = vlib_get_main ();
461 vnet_session_enable_disable (vm, mp->is_enable);
462 REPLY_MACRO (VL_API_SESSION_ENABLE_DISABLE_REPLY);
466 vl_api_application_attach_t_handler (vl_api_application_attach_t * mp)
468 int rv = 0, fds[SESSION_N_FD_TYPE], n_fds = 0;
469 vl_api_application_attach_reply_t *rmp;
470 ssvm_private_t *segp, *evt_q_segment;
471 vnet_app_attach_args_t _a, *a = &_a;
472 vl_api_registration_t *reg;
475 reg = vl_api_client_index_to_registration (mp->client_index);
479 if (session_main_is_enabled () == 0)
481 rv = VNET_API_ERROR_FEATURE_DISABLED;
485 STATIC_ASSERT (sizeof (u64) * APP_OPTIONS_N_OPTIONS <=
486 sizeof (mp->options),
487 "Out of options, fix api message definition");
489 clib_memset (a, 0, sizeof (*a));
490 a->api_client_index = mp->client_index;
491 a->options = mp->options;
492 a->session_cb_vft = &session_mq_cb_vft;
493 if (mp->namespace_id_len > 64)
495 rv = VNET_API_ERROR_INVALID_VALUE;
499 if (mp->namespace_id_len)
501 vec_validate (a->namespace_id, mp->namespace_id_len - 1);
502 clib_memcpy_fast (a->namespace_id, mp->namespace_id,
503 mp->namespace_id_len);
506 if ((rv = vnet_application_attach (a)))
508 clib_warning ("attach returned: %d", rv);
509 vec_free (a->namespace_id);
512 vec_free (a->namespace_id);
514 /* Send event queues segment */
515 if ((evt_q_segment = session_main_get_evt_q_segment ()))
517 fd_flags |= SESSION_FD_F_VPP_MQ_SEGMENT;
518 fds[n_fds] = evt_q_segment->fd;
521 /* Send fifo segment fd if needed */
522 if (ssvm_type (a->segment) == SSVM_SEGMENT_MEMFD)
524 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
525 fds[n_fds] = a->segment->fd;
528 if (a->options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
530 fd_flags |= SESSION_FD_F_MQ_EVENTFD;
531 fds[n_fds] = svm_msg_q_get_producer_eventfd (a->app_evt_q);
538 REPLY_MACRO2 (VL_API_APPLICATION_ATTACH_REPLY, ({
542 rmp->app_index = clib_host_to_net_u32 (a->app_index);
543 rmp->segment_name_length = 0;
544 rmp->segment_size = segp->ssvm_size;
545 if (vec_len (segp->name))
547 memcpy (rmp->segment_name, segp->name, vec_len (segp->name));
548 rmp->segment_name_length = vec_len (segp->name);
550 rmp->app_event_queue_address = pointer_to_uword (a->app_evt_q);
552 rmp->fd_flags = fd_flags;
553 rmp->segment_handle = clib_host_to_net_u64 (a->segment_handle);
559 session_send_fds (reg, fds, n_fds);
563 vl_api_application_detach_t_handler (vl_api_application_detach_t * mp)
565 vl_api_application_detach_reply_t *rmp;
566 int rv = VNET_API_ERROR_INVALID_VALUE_2;
567 vnet_app_detach_args_t _a, *a = &_a;
570 if (session_main_is_enabled () == 0)
572 rv = VNET_API_ERROR_FEATURE_DISABLED;
576 app = application_lookup (mp->client_index);
579 a->app_index = app->app_index;
580 a->api_client_index = mp->client_index;
581 rv = vnet_application_detach (a);
585 REPLY_MACRO (VL_API_APPLICATION_DETACH_REPLY);
589 vl_api_bind_uri_t_handler (vl_api_bind_uri_t * mp)
591 vl_api_bind_uri_reply_t *rmp;
592 vnet_listen_args_t _a, *a = &_a;
593 application_t *app = 0;
594 app_worker_t *app_wrk;
597 if (session_main_is_enabled () == 0)
599 rv = VNET_API_ERROR_FEATURE_DISABLED;
603 app = application_lookup (mp->client_index);
606 clib_memset (a, 0, sizeof (*a));
607 a->uri = (char *) mp->uri;
608 a->app_index = app->app_index;
609 rv = vnet_bind_uri (a);
613 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
618 REPLY_MACRO (VL_API_BIND_URI_REPLY);
622 app_wrk = application_get_worker (app, 0);
623 mq_send_session_bound_cb (app_wrk->wrk_index, mp->context, a->handle,
629 vl_api_unbind_uri_t_handler (vl_api_unbind_uri_t * mp)
631 vl_api_unbind_uri_reply_t *rmp;
633 vnet_unlisten_args_t _a, *a = &_a;
636 if (session_main_is_enabled () == 0)
638 rv = VNET_API_ERROR_FEATURE_DISABLED;
642 app = application_lookup (mp->client_index);
645 a->uri = (char *) mp->uri;
646 a->app_index = app->app_index;
647 rv = vnet_unbind_uri (a);
651 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
655 REPLY_MACRO (VL_API_UNBIND_URI_REPLY);
659 vl_api_connect_uri_t_handler (vl_api_connect_uri_t * mp)
661 vl_api_connect_uri_reply_t *rmp;
662 vnet_connect_args_t _a, *a = &_a;
666 if (session_main_is_enabled () == 0)
668 rv = VNET_API_ERROR_FEATURE_DISABLED;
672 app = application_lookup (mp->client_index);
675 clib_memset (a, 0, sizeof (*a));
676 a->uri = (char *) mp->uri;
677 a->api_context = mp->context;
678 a->app_index = app->app_index;
679 if ((rv = vnet_connect_uri (a)))
680 clib_warning ("connect_uri returned: %d", rv);
684 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
688 * Don't reply to stream (tcp) connects. The reply will come once
689 * the connection is established. In case of the redirects, the reply
690 * will come from the server app.
696 REPLY_MACRO (VL_API_CONNECT_URI_REPLY);
700 vl_api_disconnect_session_t_handler (vl_api_disconnect_session_t * mp)
702 vl_api_disconnect_session_reply_t *rmp;
703 vnet_disconnect_args_t _a, *a = &_a;
707 if (session_main_is_enabled () == 0)
709 rv = VNET_API_ERROR_FEATURE_DISABLED;
713 app = application_lookup (mp->client_index);
716 a->handle = mp->handle;
717 a->app_index = app->app_index;
718 rv = vnet_disconnect_session (a);
722 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
726 REPLY_MACRO2 (VL_API_DISCONNECT_SESSION_REPLY, rmp->handle = mp->handle);
730 vl_api_disconnect_session_reply_t_handler (vl_api_disconnect_session_reply_t *
733 vnet_disconnect_args_t _a, *a = &_a;
736 /* Client objected to disconnecting the session, log and continue */
739 clib_warning ("client retval %d", mp->retval);
743 /* Disconnect has been confirmed. Confirm close to transport */
744 app = application_lookup (mp->context);
747 a->handle = mp->handle;
748 a->app_index = app->app_index;
749 vnet_disconnect_session (a);
754 vl_api_map_another_segment_reply_t_handler (vl_api_map_another_segment_reply_t
757 clib_warning ("not implemented");
761 vl_api_bind_sock_t_handler (vl_api_bind_sock_t * mp)
763 vnet_listen_args_t _a, *a = &_a;
764 vl_api_bind_sock_reply_t *rmp;
765 application_t *app = 0;
766 app_worker_t *app_wrk;
767 ip46_address_t *ip46;
770 if (session_main_is_enabled () == 0)
772 rv = VNET_API_ERROR_FEATURE_DISABLED;
776 app = application_lookup (mp->client_index);
779 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
783 ip46 = (ip46_address_t *) mp->ip;
784 clib_memset (a, 0, sizeof (*a));
785 a->sep.is_ip4 = mp->is_ip4;
787 a->sep.port = mp->port;
788 a->sep.fib_index = mp->vrf;
789 a->sep.sw_if_index = ENDPOINT_INVALID_INDEX;
790 a->sep.transport_proto = mp->proto;
791 a->app_index = app->app_index;
792 a->wrk_map_index = mp->wrk_index;
794 if ((rv = vnet_listen (a)))
795 clib_warning ("listen returned: %d", rv);
798 /* Actual reply sent only over mq */
799 REPLY_MACRO (VL_API_BIND_SOCK_REPLY);
803 app_wrk = application_get_worker (app, mp->wrk_index);
804 mq_send_session_bound_cb (app_wrk->wrk_index, mp->context, a->handle,
810 vl_api_unbind_sock_t_handler (vl_api_unbind_sock_t * mp)
812 vl_api_unbind_sock_reply_t *rmp;
813 vnet_unlisten_args_t _a, *a = &_a;
814 app_worker_t *app_wrk;
815 application_t *app = 0;
818 if (session_main_is_enabled () == 0)
820 rv = VNET_API_ERROR_FEATURE_DISABLED;
824 app = application_lookup (mp->client_index);
827 a->app_index = app->app_index;
828 a->handle = mp->handle;
829 a->wrk_map_index = mp->wrk_index;
830 if ((rv = vnet_unlisten (a)))
831 clib_warning ("unlisten returned: %d", rv);
835 REPLY_MACRO (VL_API_UNBIND_SOCK_REPLY);
838 * Send reply over msg queue
840 svm_msg_q_msg_t _msg, *msg = &_msg;
841 session_unlisten_reply_msg_t *ump;
843 session_event_t *evt;
848 app_wrk = application_get_worker (app, a->wrk_map_index);
852 app_mq = app_wrk->event_queue;
853 if (mq_try_lock_and_alloc_msg (app_mq, msg))
856 evt = svm_msg_q_msg_data (app_mq, msg);
857 clib_memset (evt, 0, sizeof (*evt));
858 evt->event_type = SESSION_CTRL_EVT_UNLISTEN_REPLY;
859 ump = (session_unlisten_reply_msg_t *) evt->data;
860 ump->context = mp->context;
861 ump->handle = mp->handle;
863 svm_msg_q_add_and_unlock (app_mq, msg);
867 vl_api_connect_sock_t_handler (vl_api_connect_sock_t * mp)
869 vl_api_connect_sock_reply_t *rmp;
870 vnet_connect_args_t _a, *a = &_a;
871 application_t *app = 0;
874 if (session_main_is_enabled () == 0)
876 rv = VNET_API_ERROR_FEATURE_DISABLED;
880 app = application_lookup (mp->client_index);
883 svm_queue_t *client_q;
884 ip46_address_t *ip46 = (ip46_address_t *) mp->ip;
886 clib_memset (a, 0, sizeof (*a));
887 client_q = vl_api_client_index_to_input_queue (mp->client_index);
888 mp->client_queue_address = pointer_to_uword (client_q);
889 a->sep.is_ip4 = mp->is_ip4;
891 a->sep.port = mp->port;
892 a->sep.transport_proto = mp->proto;
893 a->sep.peer.fib_index = mp->vrf;
894 a->sep.peer.sw_if_index = ENDPOINT_INVALID_INDEX;
895 if (mp->hostname_len)
897 vec_validate (a->sep_ext.hostname, mp->hostname_len - 1);
898 clib_memcpy_fast (a->sep_ext.hostname, mp->hostname,
901 a->api_context = mp->context;
902 a->app_index = app->app_index;
903 a->wrk_map_index = mp->wrk_index;
904 if ((rv = vnet_connect (a)))
905 clib_warning ("connect returned: %u", rv);
906 vec_free (a->sep_ext.hostname);
910 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
916 /* Got some error, relay it */
919 REPLY_MACRO (VL_API_CONNECT_SOCK_REPLY);
923 app_worker_t *app_wrk = application_get_worker (app, mp->wrk_index);
924 mq_send_session_connected_cb (app_wrk->wrk_index, mp->context, 0, 1);
929 vl_api_app_worker_add_del_t_handler (vl_api_app_worker_add_del_t * mp)
931 int rv = 0, fds[SESSION_N_FD_TYPE], n_fds = 0;
932 vl_api_app_worker_add_del_reply_t *rmp;
933 vl_api_registration_t *reg;
937 if (!session_main_is_enabled ())
939 rv = VNET_API_ERROR_FEATURE_DISABLED;
943 reg = vl_api_client_index_to_registration (mp->client_index);
947 app = application_get_if_valid (clib_net_to_host_u32 (mp->app_index));
950 rv = VNET_API_ERROR_INVALID_VALUE;
954 vnet_app_worker_add_del_args_t args = {
955 .app_index = app->app_index,
956 .wrk_map_index = clib_net_to_host_u32 (mp->wrk_index),
957 .api_client_index = mp->client_index,
960 rv = vnet_app_worker_add_del (&args);
963 clib_warning ("app worker add/del returned: %d", rv);
970 /* Send fifo segment fd if needed */
971 if (ssvm_type (args.segment) == SSVM_SEGMENT_MEMFD)
973 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
974 fds[n_fds] = args.segment->fd;
977 if (application_segment_manager_properties (app)->use_mq_eventfd)
979 fd_flags |= SESSION_FD_F_MQ_EVENTFD;
980 fds[n_fds] = svm_msg_q_get_producer_eventfd (args.evt_q);
986 REPLY_MACRO2 (VL_API_APP_WORKER_ADD_DEL_REPLY, ({
987 rmp->is_add = mp->is_add;
988 rmp->wrk_index = clib_host_to_net_u32 (args.wrk_map_index);
989 rmp->segment_handle = clib_host_to_net_u64 (args.segment_handle);
990 if (!rv && mp->is_add)
992 if (vec_len (args.segment->name))
994 memcpy (rmp->segment_name, args.segment->name,
995 vec_len (args.segment->name));
996 rmp->segment_name_length = vec_len (args.segment->name);
998 rmp->app_event_queue_address = pointer_to_uword (args.evt_q);
1000 rmp->fd_flags = fd_flags;
1006 session_send_fds (reg, fds, n_fds);
1010 vl_api_app_namespace_add_del_t_handler (vl_api_app_namespace_add_del_t * mp)
1012 vl_api_app_namespace_add_del_reply_t *rmp;
1013 u32 appns_index = 0;
1016 if (!session_main_is_enabled ())
1018 rv = VNET_API_ERROR_FEATURE_DISABLED;
1022 if (mp->namespace_id_len > ARRAY_LEN (mp->namespace_id))
1024 rv = VNET_API_ERROR_INVALID_VALUE;
1028 vec_validate (ns_id, mp->namespace_id_len - 1);
1029 clib_memcpy_fast (ns_id, mp->namespace_id, mp->namespace_id_len);
1030 vnet_app_namespace_add_del_args_t args = {
1032 .secret = clib_net_to_host_u64 (mp->secret),
1033 .sw_if_index = clib_net_to_host_u32 (mp->sw_if_index),
1034 .ip4_fib_id = clib_net_to_host_u32 (mp->ip4_fib_id),
1035 .ip6_fib_id = clib_net_to_host_u32 (mp->ip6_fib_id),
1038 rv = vnet_app_namespace_add_del (&args);
1041 appns_index = app_namespace_index_from_id (ns_id);
1042 if (appns_index == APP_NAMESPACE_INVALID_INDEX)
1044 clib_warning ("app ns lookup failed");
1045 rv = VNET_API_ERROR_UNSPECIFIED;
1052 REPLY_MACRO2 (VL_API_APP_NAMESPACE_ADD_DEL_REPLY, ({
1054 rmp->appns_index = clib_host_to_net_u32 (appns_index);
1060 vl_api_session_rule_add_del_t_handler (vl_api_session_rule_add_del_t * mp)
1062 vl_api_session_rule_add_del_reply_t *rmp;
1063 session_rule_add_del_args_t args;
1064 session_rule_table_add_del_args_t *table_args = &args.table_args;
1068 clib_memset (&args, 0, sizeof (args));
1069 fib_proto = mp->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
1071 table_args->lcl.fp_len = mp->lcl_plen;
1072 table_args->lcl.fp_proto = fib_proto;
1073 table_args->rmt.fp_len = mp->rmt_plen;
1074 table_args->rmt.fp_proto = fib_proto;
1075 table_args->lcl_port = mp->lcl_port;
1076 table_args->rmt_port = mp->rmt_port;
1077 table_args->action_index = clib_net_to_host_u32 (mp->action_index);
1078 table_args->is_add = mp->is_add;
1079 mp->tag[sizeof (mp->tag) - 1] = 0;
1080 table_args->tag = format (0, "%s", mp->tag);
1081 args.appns_index = clib_net_to_host_u32 (mp->appns_index);
1082 args.scope = mp->scope;
1083 args.transport_proto = mp->transport_proto;
1085 clib_memset (&table_args->lcl.fp_addr, 0, sizeof (table_args->lcl.fp_addr));
1086 clib_memset (&table_args->rmt.fp_addr, 0, sizeof (table_args->rmt.fp_addr));
1087 ip_set (&table_args->lcl.fp_addr, mp->lcl_ip, mp->is_ip4);
1088 ip_set (&table_args->rmt.fp_addr, mp->rmt_ip, mp->is_ip4);
1089 rv = vnet_session_rule_add_del (&args);
1091 clib_warning ("rule add del returned: %d", rv);
1092 vec_free (table_args->tag);
1093 REPLY_MACRO (VL_API_SESSION_RULE_ADD_DEL_REPLY);
1097 send_session_rule_details4 (mma_rule_16_t * rule, u8 is_local,
1098 u8 transport_proto, u32 appns_index, u8 * tag,
1099 vl_api_registration_t * reg, u32 context)
1101 vl_api_session_rules_details_t *rmp = 0;
1102 session_mask_or_match_4_t *match =
1103 (session_mask_or_match_4_t *) & rule->match;
1104 session_mask_or_match_4_t *mask =
1105 (session_mask_or_match_4_t *) & rule->mask;
1107 rmp = vl_msg_api_alloc (sizeof (*rmp));
1108 clib_memset (rmp, 0, sizeof (*rmp));
1109 rmp->_vl_msg_id = ntohs (VL_API_SESSION_RULES_DETAILS);
1110 rmp->context = context;
1113 clib_memcpy_fast (rmp->lcl_ip, &match->lcl_ip, sizeof (match->lcl_ip));
1114 clib_memcpy_fast (rmp->rmt_ip, &match->rmt_ip, sizeof (match->rmt_ip));
1115 rmp->lcl_plen = ip4_mask_to_preflen (&mask->lcl_ip);
1116 rmp->rmt_plen = ip4_mask_to_preflen (&mask->rmt_ip);
1117 rmp->lcl_port = match->lcl_port;
1118 rmp->rmt_port = match->rmt_port;
1119 rmp->action_index = clib_host_to_net_u32 (rule->action_index);
1121 is_local ? SESSION_RULE_SCOPE_LOCAL : SESSION_RULE_SCOPE_GLOBAL;
1122 rmp->transport_proto = transport_proto;
1123 rmp->appns_index = clib_host_to_net_u32 (appns_index);
1126 clib_memcpy_fast (rmp->tag, tag, vec_len (tag));
1127 rmp->tag[vec_len (tag)] = 0;
1130 vl_api_send_msg (reg, (u8 *) rmp);
1134 send_session_rule_details6 (mma_rule_40_t * rule, u8 is_local,
1135 u8 transport_proto, u32 appns_index, u8 * tag,
1136 vl_api_registration_t * reg, u32 context)
1138 vl_api_session_rules_details_t *rmp = 0;
1139 session_mask_or_match_6_t *match =
1140 (session_mask_or_match_6_t *) & rule->match;
1141 session_mask_or_match_6_t *mask =
1142 (session_mask_or_match_6_t *) & rule->mask;
1144 rmp = vl_msg_api_alloc (sizeof (*rmp));
1145 clib_memset (rmp, 0, sizeof (*rmp));
1146 rmp->_vl_msg_id = ntohs (VL_API_SESSION_RULES_DETAILS);
1147 rmp->context = context;
1150 clib_memcpy_fast (rmp->lcl_ip, &match->lcl_ip, sizeof (match->lcl_ip));
1151 clib_memcpy_fast (rmp->rmt_ip, &match->rmt_ip, sizeof (match->rmt_ip));
1152 rmp->lcl_plen = ip6_mask_to_preflen (&mask->lcl_ip);
1153 rmp->rmt_plen = ip6_mask_to_preflen (&mask->rmt_ip);
1154 rmp->lcl_port = match->lcl_port;
1155 rmp->rmt_port = match->rmt_port;
1156 rmp->action_index = clib_host_to_net_u32 (rule->action_index);
1158 is_local ? SESSION_RULE_SCOPE_LOCAL : SESSION_RULE_SCOPE_GLOBAL;
1159 rmp->transport_proto = transport_proto;
1160 rmp->appns_index = clib_host_to_net_u32 (appns_index);
1163 clib_memcpy_fast (rmp->tag, tag, vec_len (tag));
1164 rmp->tag[vec_len (tag)] = 0;
1167 vl_api_send_msg (reg, (u8 *) rmp);
1171 send_session_rules_table_details (session_rules_table_t * srt, u8 fib_proto,
1172 u8 tp, u8 is_local, u32 appns_index,
1173 vl_api_registration_t * reg, u32 context)
1175 mma_rule_16_t *rule16;
1176 mma_rule_40_t *rule40;
1177 mma_rules_table_16_t *srt16;
1178 mma_rules_table_40_t *srt40;
1181 if (is_local || fib_proto == FIB_PROTOCOL_IP4)
1185 srt16 = &srt->session_rules_tables_16;
1186 pool_foreach (rule16, srt16->rules, ({
1187 ri = mma_rules_table_rule_index_16 (srt16, rule16);
1188 tag = session_rules_table_rule_tag (srt, ri, 1);
1189 send_session_rule_details4 (rule16, is_local, tp, appns_index, tag,
1194 if (is_local || fib_proto == FIB_PROTOCOL_IP6)
1198 srt40 = &srt->session_rules_tables_40;
1199 pool_foreach (rule40, srt40->rules, ({
1200 ri = mma_rules_table_rule_index_40 (srt40, rule40);
1201 tag = session_rules_table_rule_tag (srt, ri, 1);
1202 send_session_rule_details6 (rule40, is_local, tp, appns_index, tag,
1210 vl_api_session_rules_dump_t_handler (vl_api_one_map_server_dump_t * mp)
1212 vl_api_registration_t *reg;
1213 session_table_t *st;
1216 reg = vl_api_client_index_to_registration (mp->client_index);
1221 session_table_foreach (st, ({
1222 for (tp = 0; tp < TRANSPORT_N_PROTO; tp++)
1224 send_session_rules_table_details (&st->session_rules[tp],
1225 st->active_fib_proto, tp,
1226 st->is_local, st->appns_index, reg,
1234 vl_api_application_tls_cert_add_t_handler (vl_api_application_tls_cert_add_t *
1237 vl_api_app_namespace_add_del_reply_t *rmp;
1238 vnet_app_add_tls_cert_args_t _a, *a = &_a;
1239 clib_error_t *error;
1243 if (!session_main_is_enabled ())
1245 rv = VNET_API_ERROR_FEATURE_DISABLED;
1248 if (!(app = application_lookup (mp->client_index)))
1250 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
1253 clib_memset (a, 0, sizeof (*a));
1254 a->app_index = app->app_index;
1255 cert_len = clib_net_to_host_u16 (mp->cert_len);
1256 if (cert_len > 10000)
1258 rv = VNET_API_ERROR_INVALID_VALUE;
1261 vec_validate (a->cert, cert_len);
1262 clib_memcpy_fast (a->cert, mp->cert, cert_len);
1263 if ((error = vnet_app_add_tls_cert (a)))
1265 rv = clib_error_get_code (error);
1266 clib_error_report (error);
1270 REPLY_MACRO (VL_API_APPLICATION_TLS_CERT_ADD_REPLY);
1274 vl_api_application_tls_key_add_t_handler (vl_api_application_tls_key_add_t *
1277 vl_api_app_namespace_add_del_reply_t *rmp;
1278 vnet_app_add_tls_key_args_t _a, *a = &_a;
1279 clib_error_t *error;
1283 if (!session_main_is_enabled ())
1285 rv = VNET_API_ERROR_FEATURE_DISABLED;
1288 if (!(app = application_lookup (mp->client_index)))
1290 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
1293 clib_memset (a, 0, sizeof (*a));
1294 a->app_index = app->app_index;
1295 key_len = clib_net_to_host_u16 (mp->key_len);
1296 if (key_len > 10000)
1298 rv = VNET_API_ERROR_INVALID_VALUE;
1301 vec_validate (a->key, key_len);
1302 clib_memcpy_fast (a->key, mp->key, key_len);
1303 if ((error = vnet_app_add_tls_key (a)))
1305 rv = clib_error_get_code (error);
1306 clib_error_report (error);
1310 REPLY_MACRO (VL_API_APPLICATION_TLS_KEY_ADD_REPLY);
1313 static clib_error_t *
1314 application_reaper_cb (u32 client_index)
1316 application_t *app = application_lookup (client_index);
1317 vnet_app_detach_args_t _a, *a = &_a;
1320 a->app_index = app->app_index;
1321 a->api_client_index = client_index;
1322 vnet_application_detach (a);
1327 VL_MSG_API_REAPER_FUNCTION (application_reaper_cb);
1329 #define vl_msg_name_crc_list
1330 #include <vnet/vnet_all_api_h.h>
1331 #undef vl_msg_name_crc_list
1334 setup_message_id_table (api_main_t * am)
1336 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
1337 foreach_vl_msg_name_crc_session;
1342 * session_api_hookup
1343 * Add uri's API message handlers to the table.
1344 * vlib has already mapped shared memory and
1345 * added the client registration handlers.
1346 * See .../open-repo/vlib/memclnt_vlib.c:memclnt_process()
1348 static clib_error_t *
1349 session_api_hookup (vlib_main_t * vm)
1351 api_main_t *am = &api_main;
1354 vl_msg_api_set_handlers(VL_API_##N, #n, \
1355 vl_api_##n##_t_handler, \
1357 vl_api_##n##_t_endian, \
1358 vl_api_##n##_t_print, \
1359 sizeof(vl_api_##n##_t), 1);
1360 foreach_session_api_msg;
1364 * Messages which bounce off the data-plane to
1365 * an API client. Simply tells the message handling infra not
1366 * to free the message.
1368 * Bounced message handlers MUST NOT block the data plane
1370 am->message_bounce[VL_API_CONNECT_URI] = 1;
1371 am->message_bounce[VL_API_CONNECT_SOCK] = 1;
1374 * Set up the (msg_name, crc, message-id) table
1376 setup_message_id_table (am);
1381 VLIB_API_INIT_FUNCTION (session_api_hookup);
1384 * fd.io coding-style-patch-verification: ON
1387 * eval: (c-set-style "gnu")