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;
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, &mp->rmt, 0 /* is_lcl */ );
221 ct = (ct_connection_t *) session_get_transport (s);
222 listener = listen_session_get (s->listener_index);
223 al = app_listener_get (app, listener->al_index);
224 mp->listener_handle = app_listener_handle (al);
225 mp->rmt.is_ip4 = session_type_is_ip4 (listener->session_type);
226 mp->rmt.port = ct->c_rmt_port;
227 mp->handle = session_handle (s);
228 vpp_queue = session_main_get_vpp_event_queue (0);
229 mp->vpp_event_queue_address = pointer_to_uword (vpp_queue);
231 svm_msg_q_add_and_unlock (app_mq, msg);
237 mq_send_session_close_evt (app_worker_t * app_wrk, session_handle_t sh,
238 session_evt_type_t evt_type)
240 svm_msg_q_msg_t _msg, *msg = &_msg;
241 session_disconnected_msg_t *mp;
243 session_event_t *evt;
245 app_mq = app_wrk->event_queue;
246 if (mq_try_lock_and_alloc_msg (app_mq, msg))
248 evt = svm_msg_q_msg_data (app_mq, msg);
249 clib_memset (evt, 0, sizeof (*evt));
250 evt->event_type = evt_type;
251 mp = (session_disconnected_msg_t *) evt->data;
253 mp->context = app_wrk->api_client_index;
254 svm_msg_q_add_and_unlock (app_mq, msg);
258 mq_notify_close_subscribers (u32 app_index, session_handle_t sh,
259 svm_fifo_t * f, session_evt_type_t evt_type)
261 app_worker_t *app_wrk;
265 app = application_get (app_index);
269 for (i = 0; i < f->n_subscribers; i++)
271 if (!(app_wrk = application_get_worker (app, f->subscribers[i])))
273 mq_send_session_close_evt (app_wrk, sh, SESSION_CTRL_EVT_DISCONNECTED);
278 mq_send_session_disconnected_cb (session_t * s)
280 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
281 session_handle_t sh = session_handle (s);
283 mq_send_session_close_evt (app_wrk, session_handle (s),
284 SESSION_CTRL_EVT_DISCONNECTED);
286 if (svm_fifo_n_subscribers (s->rx_fifo))
287 mq_notify_close_subscribers (app_wrk->app_index, sh, s->rx_fifo,
288 SESSION_CTRL_EVT_DISCONNECTED);
292 mq_send_session_reset_cb (session_t * s)
294 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
295 session_handle_t sh = session_handle (s);
297 mq_send_session_close_evt (app_wrk, sh, SESSION_CTRL_EVT_RESET);
299 if (svm_fifo_n_subscribers (s->rx_fifo))
300 mq_notify_close_subscribers (app_wrk->app_index, sh, s->rx_fifo,
301 SESSION_CTRL_EVT_RESET);
305 mq_send_session_connected_cb (u32 app_wrk_index, u32 api_context,
306 session_t * s, u8 is_fail)
308 svm_msg_q_msg_t _msg, *msg = &_msg;
309 session_connected_msg_t *mp;
310 svm_msg_q_t *vpp_mq, *app_mq;
311 transport_connection_t *tc;
312 app_worker_t *app_wrk;
313 session_event_t *evt;
315 app_wrk = app_worker_get (app_wrk_index);
316 app_mq = app_wrk->event_queue;
319 clib_warning ("app %u with api index: %u not attached",
320 app_wrk->app_index, app_wrk->api_client_index);
324 if (mq_try_lock_and_alloc_msg (app_mq, msg))
327 evt = svm_msg_q_msg_data (app_mq, msg);
328 clib_memset (evt, 0, sizeof (*evt));
329 evt->event_type = SESSION_CTRL_EVT_CONNECTED;
330 mp = (session_connected_msg_t *) evt->data;
331 clib_memset (mp, 0, sizeof (*mp));
332 mp->context = api_context;
337 if (session_has_transport (s))
339 tc = session_get_transport (s);
346 vpp_mq = session_main_get_vpp_event_queue (s->thread_index);
347 mp->handle = session_handle (s);
348 mp->vpp_event_queue_address = pointer_to_uword (vpp_mq);
350 session_get_endpoint (s, &mp->lcl, 1 /* is_lcl */ );
352 mp->server_rx_fifo = pointer_to_uword (s->rx_fifo);
353 mp->server_tx_fifo = pointer_to_uword (s->tx_fifo);
354 mp->segment_handle = session_segment_handle (s);
358 ct_connection_t *cct;
361 cct = (ct_connection_t *) session_get_transport (s);
362 mp->handle = session_handle (s);
363 mp->lcl.port = cct->c_lcl_port;
364 mp->lcl.is_ip4 = cct->c_is_ip4;
365 vpp_mq = session_main_get_vpp_event_queue (0);
366 mp->vpp_event_queue_address = pointer_to_uword (vpp_mq);
367 mp->server_rx_fifo = pointer_to_uword (s->rx_fifo);
368 mp->server_tx_fifo = pointer_to_uword (s->tx_fifo);
369 mp->segment_handle = session_segment_handle (s);
370 ss = ct_session_get_peer (s);
371 mp->ct_rx_fifo = pointer_to_uword (ss->tx_fifo);
372 mp->ct_tx_fifo = pointer_to_uword (ss->rx_fifo);
373 mp->ct_segment_handle = session_segment_handle (ss);
377 mp->retval = is_fail ?
378 clib_host_to_net_u32 (VNET_API_ERROR_SESSION_CONNECT) : 0;
380 svm_msg_q_add_and_unlock (app_mq, msg);
385 mq_send_session_bound_cb (u32 app_wrk_index, u32 api_context,
386 session_handle_t handle, int rv)
388 svm_msg_q_msg_t _msg, *msg = &_msg;
389 svm_msg_q_t *app_mq, *vpp_evt_q;
390 transport_connection_t *tc;
391 session_bound_msg_t *mp;
392 app_worker_t *app_wrk;
393 session_event_t *evt;
396 app_wrk = app_worker_get (app_wrk_index);
397 app_mq = app_wrk->event_queue;
400 clib_warning ("app %u with api index: %u not attached",
401 app_wrk->app_index, app_wrk->api_client_index);
405 if (mq_try_lock_and_alloc_msg (app_mq, msg))
408 evt = svm_msg_q_msg_data (app_mq, msg);
409 clib_memset (evt, 0, sizeof (*evt));
410 evt->event_type = SESSION_CTRL_EVT_BOUND;
411 mp = (session_bound_msg_t *) evt->data;
412 mp->context = api_context;
418 al = app_listener_get_w_handle (handle);
419 if (al->session_index != SESSION_INVALID_INDEX)
420 ls = app_listener_get_session (al);
422 ls = app_listener_get_local_session (al);
423 tc = listen_session_get_transport (ls);
424 mp->lcl_port = tc->lcl_port;
425 mp->lcl_is_ip4 = tc->is_ip4;
426 clib_memcpy_fast (mp->lcl_ip, &tc->lcl_ip, sizeof (tc->lcl_ip));
428 vpp_evt_q = session_main_get_vpp_event_queue (0);
429 mp->vpp_evt_q = pointer_to_uword (vpp_evt_q);
431 if (session_transport_service_type (ls) == TRANSPORT_SERVICE_CL)
433 mp->rx_fifo = pointer_to_uword (ls->rx_fifo);
434 mp->tx_fifo = pointer_to_uword (ls->tx_fifo);
439 svm_msg_q_add_and_unlock (app_mq, msg);
443 static session_cb_vft_t session_mq_cb_vft = {
444 .session_accept_callback = mq_send_session_accepted_cb,
445 .session_disconnect_callback = mq_send_session_disconnected_cb,
446 .session_connected_callback = mq_send_session_connected_cb,
447 .session_reset_callback = mq_send_session_reset_cb,
448 .add_segment_callback = send_add_segment_callback,
449 .del_segment_callback = send_del_segment_callback,
453 vl_api_session_enable_disable_t_handler (vl_api_session_enable_disable_t * mp)
455 vl_api_session_enable_disable_reply_t *rmp;
456 vlib_main_t *vm = vlib_get_main ();
459 vnet_session_enable_disable (vm, mp->is_enable);
460 REPLY_MACRO (VL_API_SESSION_ENABLE_DISABLE_REPLY);
464 vl_api_application_attach_t_handler (vl_api_application_attach_t * mp)
466 int rv = 0, fds[SESSION_N_FD_TYPE], n_fds = 0;
467 vl_api_application_attach_reply_t *rmp;
468 ssvm_private_t *segp, *evt_q_segment;
469 vnet_app_attach_args_t _a, *a = &_a;
470 vl_api_registration_t *reg;
473 reg = vl_api_client_index_to_registration (mp->client_index);
477 if (session_main_is_enabled () == 0)
479 rv = VNET_API_ERROR_FEATURE_DISABLED;
483 STATIC_ASSERT (sizeof (u64) * APP_OPTIONS_N_OPTIONS <=
484 sizeof (mp->options),
485 "Out of options, fix api message definition");
487 clib_memset (a, 0, sizeof (*a));
488 a->api_client_index = mp->client_index;
489 a->options = mp->options;
490 a->session_cb_vft = &session_mq_cb_vft;
491 if (mp->namespace_id_len > 64)
493 rv = VNET_API_ERROR_INVALID_VALUE;
497 if (mp->namespace_id_len)
499 vec_validate (a->namespace_id, mp->namespace_id_len - 1);
500 clib_memcpy_fast (a->namespace_id, mp->namespace_id,
501 mp->namespace_id_len);
504 if ((rv = vnet_application_attach (a)))
506 clib_warning ("attach returned: %d", rv);
507 vec_free (a->namespace_id);
510 vec_free (a->namespace_id);
512 /* Send event queues segment */
513 if ((evt_q_segment = session_main_get_evt_q_segment ()))
515 fd_flags |= SESSION_FD_F_VPP_MQ_SEGMENT;
516 fds[n_fds] = evt_q_segment->fd;
519 /* Send fifo segment fd if needed */
520 if (ssvm_type (a->segment) == SSVM_SEGMENT_MEMFD)
522 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
523 fds[n_fds] = a->segment->fd;
526 if (a->options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
528 fd_flags |= SESSION_FD_F_MQ_EVENTFD;
529 fds[n_fds] = svm_msg_q_get_producer_eventfd (a->app_evt_q);
536 REPLY_MACRO2 (VL_API_APPLICATION_ATTACH_REPLY, ({
540 rmp->app_index = clib_host_to_net_u32 (a->app_index);
541 rmp->segment_name_length = 0;
542 rmp->segment_size = segp->ssvm_size;
543 if (vec_len (segp->name))
545 memcpy (rmp->segment_name, segp->name, vec_len (segp->name));
546 rmp->segment_name_length = vec_len (segp->name);
548 rmp->app_event_queue_address = pointer_to_uword (a->app_evt_q);
550 rmp->fd_flags = fd_flags;
551 rmp->segment_handle = clib_host_to_net_u64 (a->segment_handle);
557 session_send_fds (reg, fds, n_fds);
561 vl_api_application_detach_t_handler (vl_api_application_detach_t * mp)
563 vl_api_application_detach_reply_t *rmp;
564 int rv = VNET_API_ERROR_INVALID_VALUE_2;
565 vnet_app_detach_args_t _a, *a = &_a;
568 if (session_main_is_enabled () == 0)
570 rv = VNET_API_ERROR_FEATURE_DISABLED;
574 app = application_lookup (mp->client_index);
577 a->app_index = app->app_index;
578 a->api_client_index = mp->client_index;
579 rv = vnet_application_detach (a);
583 REPLY_MACRO (VL_API_APPLICATION_DETACH_REPLY);
587 vl_api_bind_uri_t_handler (vl_api_bind_uri_t * mp)
589 vl_api_bind_uri_reply_t *rmp;
590 vnet_listen_args_t _a, *a = &_a;
591 application_t *app = 0;
592 app_worker_t *app_wrk;
595 if (session_main_is_enabled () == 0)
597 rv = VNET_API_ERROR_FEATURE_DISABLED;
601 app = application_lookup (mp->client_index);
604 clib_memset (a, 0, sizeof (*a));
605 a->uri = (char *) mp->uri;
606 a->app_index = app->app_index;
607 rv = vnet_bind_uri (a);
611 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
616 REPLY_MACRO (VL_API_BIND_URI_REPLY);
620 app_wrk = application_get_worker (app, 0);
621 mq_send_session_bound_cb (app_wrk->wrk_index, mp->context, a->handle,
627 vl_api_unbind_uri_t_handler (vl_api_unbind_uri_t * mp)
629 vl_api_unbind_uri_reply_t *rmp;
631 vnet_unlisten_args_t _a, *a = &_a;
634 if (session_main_is_enabled () == 0)
636 rv = VNET_API_ERROR_FEATURE_DISABLED;
640 app = application_lookup (mp->client_index);
643 a->uri = (char *) mp->uri;
644 a->app_index = app->app_index;
645 rv = vnet_unbind_uri (a);
649 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
653 REPLY_MACRO (VL_API_UNBIND_URI_REPLY);
657 vl_api_connect_uri_t_handler (vl_api_connect_uri_t * mp)
659 vl_api_connect_uri_reply_t *rmp;
660 vnet_connect_args_t _a, *a = &_a;
664 if (session_main_is_enabled () == 0)
666 rv = VNET_API_ERROR_FEATURE_DISABLED;
670 app = application_lookup (mp->client_index);
673 clib_memset (a, 0, sizeof (*a));
674 a->uri = (char *) mp->uri;
675 a->api_context = mp->context;
676 a->app_index = app->app_index;
677 if ((rv = vnet_connect_uri (a)))
678 clib_warning ("connect_uri returned: %d", rv);
682 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
686 * Don't reply to stream (tcp) connects. The reply will come once
687 * the connection is established. In case of the redirects, the reply
688 * will come from the server app.
694 REPLY_MACRO (VL_API_CONNECT_URI_REPLY);
698 vl_api_disconnect_session_t_handler (vl_api_disconnect_session_t * mp)
700 vl_api_disconnect_session_reply_t *rmp;
701 vnet_disconnect_args_t _a, *a = &_a;
705 if (session_main_is_enabled () == 0)
707 rv = VNET_API_ERROR_FEATURE_DISABLED;
711 app = application_lookup (mp->client_index);
714 a->handle = mp->handle;
715 a->app_index = app->app_index;
716 rv = vnet_disconnect_session (a);
720 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
724 REPLY_MACRO2 (VL_API_DISCONNECT_SESSION_REPLY, rmp->handle = mp->handle);
728 vl_api_disconnect_session_reply_t_handler (vl_api_disconnect_session_reply_t *
731 vnet_disconnect_args_t _a, *a = &_a;
734 /* Client objected to disconnecting the session, log and continue */
737 clib_warning ("client retval %d", mp->retval);
741 /* Disconnect has been confirmed. Confirm close to transport */
742 app = application_lookup (mp->context);
745 a->handle = mp->handle;
746 a->app_index = app->app_index;
747 vnet_disconnect_session (a);
752 vl_api_map_another_segment_reply_t_handler (vl_api_map_another_segment_reply_t
755 clib_warning ("not implemented");
759 vl_api_bind_sock_t_handler (vl_api_bind_sock_t * mp)
761 vnet_listen_args_t _a, *a = &_a;
762 vl_api_bind_sock_reply_t *rmp;
763 application_t *app = 0;
764 app_worker_t *app_wrk;
765 ip46_address_t *ip46;
768 if (session_main_is_enabled () == 0)
770 rv = VNET_API_ERROR_FEATURE_DISABLED;
774 app = application_lookup (mp->client_index);
777 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
781 ip46 = (ip46_address_t *) mp->ip;
782 clib_memset (a, 0, sizeof (*a));
783 a->sep.is_ip4 = mp->is_ip4;
785 a->sep.port = mp->port;
786 a->sep.fib_index = mp->vrf;
787 a->sep.sw_if_index = ENDPOINT_INVALID_INDEX;
788 a->sep.transport_proto = mp->proto;
789 a->app_index = app->app_index;
790 a->wrk_map_index = mp->wrk_index;
792 if ((rv = vnet_listen (a)))
793 clib_warning ("listen returned: %d", rv);
796 /* Actual reply sent only over mq */
797 REPLY_MACRO (VL_API_BIND_SOCK_REPLY);
801 app_wrk = application_get_worker (app, mp->wrk_index);
802 mq_send_session_bound_cb (app_wrk->wrk_index, mp->context, a->handle,
808 vl_api_unbind_sock_t_handler (vl_api_unbind_sock_t * mp)
810 vl_api_unbind_sock_reply_t *rmp;
811 vnet_unlisten_args_t _a, *a = &_a;
812 app_worker_t *app_wrk;
813 application_t *app = 0;
816 if (session_main_is_enabled () == 0)
818 rv = VNET_API_ERROR_FEATURE_DISABLED;
822 app = application_lookup (mp->client_index);
825 a->app_index = app->app_index;
826 a->handle = mp->handle;
827 a->wrk_map_index = mp->wrk_index;
828 if ((rv = vnet_unlisten (a)))
829 clib_warning ("unlisten returned: %d", rv);
833 REPLY_MACRO (VL_API_UNBIND_SOCK_REPLY);
836 * Send reply over msg queue
838 svm_msg_q_msg_t _msg, *msg = &_msg;
839 session_unlisten_reply_msg_t *ump;
841 session_event_t *evt;
846 app_wrk = application_get_worker (app, a->wrk_map_index);
850 app_mq = app_wrk->event_queue;
851 if (mq_try_lock_and_alloc_msg (app_mq, msg))
854 evt = svm_msg_q_msg_data (app_mq, msg);
855 clib_memset (evt, 0, sizeof (*evt));
856 evt->event_type = SESSION_CTRL_EVT_UNLISTEN_REPLY;
857 ump = (session_unlisten_reply_msg_t *) evt->data;
858 ump->context = mp->context;
859 ump->handle = mp->handle;
861 svm_msg_q_add_and_unlock (app_mq, msg);
865 vl_api_connect_sock_t_handler (vl_api_connect_sock_t * mp)
867 vl_api_connect_sock_reply_t *rmp;
868 vnet_connect_args_t _a, *a = &_a;
869 application_t *app = 0;
872 if (session_main_is_enabled () == 0)
874 rv = VNET_API_ERROR_FEATURE_DISABLED;
878 app = application_lookup (mp->client_index);
881 svm_queue_t *client_q;
882 ip46_address_t *ip46 = (ip46_address_t *) mp->ip;
884 clib_memset (a, 0, sizeof (*a));
885 client_q = vl_api_client_index_to_input_queue (mp->client_index);
886 mp->client_queue_address = pointer_to_uword (client_q);
887 a->sep.is_ip4 = mp->is_ip4;
889 a->sep.port = mp->port;
890 a->sep.transport_proto = mp->proto;
891 a->sep.peer.fib_index = mp->vrf;
892 a->sep.peer.sw_if_index = ENDPOINT_INVALID_INDEX;
893 if (mp->hostname_len)
895 vec_validate (a->sep_ext.hostname, mp->hostname_len - 1);
896 clib_memcpy_fast (a->sep_ext.hostname, mp->hostname,
899 a->api_context = mp->context;
900 a->app_index = app->app_index;
901 a->wrk_map_index = mp->wrk_index;
902 if ((rv = vnet_connect (a)))
903 clib_warning ("connect returned: %u", rv);
904 vec_free (a->sep_ext.hostname);
908 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
914 /* Got some error, relay it */
917 REPLY_MACRO (VL_API_CONNECT_SOCK_REPLY);
921 app_worker_t *app_wrk = application_get_worker (app, mp->wrk_index);
922 mq_send_session_connected_cb (app_wrk->wrk_index, mp->context, 0, 1);
927 vl_api_app_worker_add_del_t_handler (vl_api_app_worker_add_del_t * mp)
929 int rv = 0, fds[SESSION_N_FD_TYPE], n_fds = 0;
930 vl_api_app_worker_add_del_reply_t *rmp;
931 vl_api_registration_t *reg;
935 if (!session_main_is_enabled ())
937 rv = VNET_API_ERROR_FEATURE_DISABLED;
941 reg = vl_api_client_index_to_registration (mp->client_index);
945 app = application_get_if_valid (clib_net_to_host_u32 (mp->app_index));
948 rv = VNET_API_ERROR_INVALID_VALUE;
952 vnet_app_worker_add_del_args_t args = {
953 .app_index = app->app_index,
954 .wrk_map_index = clib_net_to_host_u32 (mp->wrk_index),
955 .api_client_index = mp->client_index,
958 rv = vnet_app_worker_add_del (&args);
961 clib_warning ("app worker add/del returned: %d", rv);
968 /* Send fifo segment fd if needed */
969 if (ssvm_type (args.segment) == SSVM_SEGMENT_MEMFD)
971 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
972 fds[n_fds] = args.segment->fd;
975 if (application_segment_manager_properties (app)->use_mq_eventfd)
977 fd_flags |= SESSION_FD_F_MQ_EVENTFD;
978 fds[n_fds] = svm_msg_q_get_producer_eventfd (args.evt_q);
984 REPLY_MACRO2 (VL_API_APP_WORKER_ADD_DEL_REPLY, ({
985 rmp->is_add = mp->is_add;
986 rmp->wrk_index = clib_host_to_net_u32 (args.wrk_map_index);
987 rmp->segment_handle = clib_host_to_net_u64 (args.segment_handle);
988 if (!rv && mp->is_add)
990 if (vec_len (args.segment->name))
992 memcpy (rmp->segment_name, args.segment->name,
993 vec_len (args.segment->name));
994 rmp->segment_name_length = vec_len (args.segment->name);
996 rmp->app_event_queue_address = pointer_to_uword (args.evt_q);
998 rmp->fd_flags = fd_flags;
1004 session_send_fds (reg, fds, n_fds);
1008 vl_api_app_namespace_add_del_t_handler (vl_api_app_namespace_add_del_t * mp)
1010 vl_api_app_namespace_add_del_reply_t *rmp;
1011 u32 appns_index = 0;
1014 if (!session_main_is_enabled ())
1016 rv = VNET_API_ERROR_FEATURE_DISABLED;
1020 if (mp->namespace_id_len > ARRAY_LEN (mp->namespace_id))
1022 rv = VNET_API_ERROR_INVALID_VALUE;
1026 vec_validate (ns_id, mp->namespace_id_len - 1);
1027 clib_memcpy_fast (ns_id, mp->namespace_id, mp->namespace_id_len);
1028 vnet_app_namespace_add_del_args_t args = {
1030 .secret = clib_net_to_host_u64 (mp->secret),
1031 .sw_if_index = clib_net_to_host_u32 (mp->sw_if_index),
1032 .ip4_fib_id = clib_net_to_host_u32 (mp->ip4_fib_id),
1033 .ip6_fib_id = clib_net_to_host_u32 (mp->ip6_fib_id),
1036 rv = vnet_app_namespace_add_del (&args);
1039 appns_index = app_namespace_index_from_id (ns_id);
1040 if (appns_index == APP_NAMESPACE_INVALID_INDEX)
1042 clib_warning ("app ns lookup failed");
1043 rv = VNET_API_ERROR_UNSPECIFIED;
1050 REPLY_MACRO2 (VL_API_APP_NAMESPACE_ADD_DEL_REPLY, ({
1052 rmp->appns_index = clib_host_to_net_u32 (appns_index);
1058 vl_api_session_rule_add_del_t_handler (vl_api_session_rule_add_del_t * mp)
1060 vl_api_session_rule_add_del_reply_t *rmp;
1061 session_rule_add_del_args_t args;
1062 session_rule_table_add_del_args_t *table_args = &args.table_args;
1066 clib_memset (&args, 0, sizeof (args));
1067 fib_proto = mp->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
1069 table_args->lcl.fp_len = mp->lcl_plen;
1070 table_args->lcl.fp_proto = fib_proto;
1071 table_args->rmt.fp_len = mp->rmt_plen;
1072 table_args->rmt.fp_proto = fib_proto;
1073 table_args->lcl_port = mp->lcl_port;
1074 table_args->rmt_port = mp->rmt_port;
1075 table_args->action_index = clib_net_to_host_u32 (mp->action_index);
1076 table_args->is_add = mp->is_add;
1077 mp->tag[sizeof (mp->tag) - 1] = 0;
1078 table_args->tag = format (0, "%s", mp->tag);
1079 args.appns_index = clib_net_to_host_u32 (mp->appns_index);
1080 args.scope = mp->scope;
1081 args.transport_proto = mp->transport_proto;
1083 clib_memset (&table_args->lcl.fp_addr, 0, sizeof (table_args->lcl.fp_addr));
1084 clib_memset (&table_args->rmt.fp_addr, 0, sizeof (table_args->rmt.fp_addr));
1085 ip_set (&table_args->lcl.fp_addr, mp->lcl_ip, mp->is_ip4);
1086 ip_set (&table_args->rmt.fp_addr, mp->rmt_ip, mp->is_ip4);
1087 rv = vnet_session_rule_add_del (&args);
1089 clib_warning ("rule add del returned: %d", rv);
1090 vec_free (table_args->tag);
1091 REPLY_MACRO (VL_API_SESSION_RULE_ADD_DEL_REPLY);
1095 send_session_rule_details4 (mma_rule_16_t * rule, u8 is_local,
1096 u8 transport_proto, u32 appns_index, u8 * tag,
1097 vl_api_registration_t * reg, u32 context)
1099 vl_api_session_rules_details_t *rmp = 0;
1100 session_mask_or_match_4_t *match =
1101 (session_mask_or_match_4_t *) & rule->match;
1102 session_mask_or_match_4_t *mask =
1103 (session_mask_or_match_4_t *) & rule->mask;
1105 rmp = vl_msg_api_alloc (sizeof (*rmp));
1106 clib_memset (rmp, 0, sizeof (*rmp));
1107 rmp->_vl_msg_id = ntohs (VL_API_SESSION_RULES_DETAILS);
1108 rmp->context = context;
1111 clib_memcpy_fast (rmp->lcl_ip, &match->lcl_ip, sizeof (match->lcl_ip));
1112 clib_memcpy_fast (rmp->rmt_ip, &match->rmt_ip, sizeof (match->rmt_ip));
1113 rmp->lcl_plen = ip4_mask_to_preflen (&mask->lcl_ip);
1114 rmp->rmt_plen = ip4_mask_to_preflen (&mask->rmt_ip);
1115 rmp->lcl_port = match->lcl_port;
1116 rmp->rmt_port = match->rmt_port;
1117 rmp->action_index = clib_host_to_net_u32 (rule->action_index);
1119 is_local ? SESSION_RULE_SCOPE_LOCAL : SESSION_RULE_SCOPE_GLOBAL;
1120 rmp->transport_proto = transport_proto;
1121 rmp->appns_index = clib_host_to_net_u32 (appns_index);
1124 clib_memcpy_fast (rmp->tag, tag, vec_len (tag));
1125 rmp->tag[vec_len (tag)] = 0;
1128 vl_api_send_msg (reg, (u8 *) rmp);
1132 send_session_rule_details6 (mma_rule_40_t * rule, u8 is_local,
1133 u8 transport_proto, u32 appns_index, u8 * tag,
1134 vl_api_registration_t * reg, u32 context)
1136 vl_api_session_rules_details_t *rmp = 0;
1137 session_mask_or_match_6_t *match =
1138 (session_mask_or_match_6_t *) & rule->match;
1139 session_mask_or_match_6_t *mask =
1140 (session_mask_or_match_6_t *) & rule->mask;
1142 rmp = vl_msg_api_alloc (sizeof (*rmp));
1143 clib_memset (rmp, 0, sizeof (*rmp));
1144 rmp->_vl_msg_id = ntohs (VL_API_SESSION_RULES_DETAILS);
1145 rmp->context = context;
1148 clib_memcpy_fast (rmp->lcl_ip, &match->lcl_ip, sizeof (match->lcl_ip));
1149 clib_memcpy_fast (rmp->rmt_ip, &match->rmt_ip, sizeof (match->rmt_ip));
1150 rmp->lcl_plen = ip6_mask_to_preflen (&mask->lcl_ip);
1151 rmp->rmt_plen = ip6_mask_to_preflen (&mask->rmt_ip);
1152 rmp->lcl_port = match->lcl_port;
1153 rmp->rmt_port = match->rmt_port;
1154 rmp->action_index = clib_host_to_net_u32 (rule->action_index);
1156 is_local ? SESSION_RULE_SCOPE_LOCAL : SESSION_RULE_SCOPE_GLOBAL;
1157 rmp->transport_proto = transport_proto;
1158 rmp->appns_index = clib_host_to_net_u32 (appns_index);
1161 clib_memcpy_fast (rmp->tag, tag, vec_len (tag));
1162 rmp->tag[vec_len (tag)] = 0;
1165 vl_api_send_msg (reg, (u8 *) rmp);
1169 send_session_rules_table_details (session_rules_table_t * srt, u8 fib_proto,
1170 u8 tp, u8 is_local, u32 appns_index,
1171 vl_api_registration_t * reg, u32 context)
1173 mma_rule_16_t *rule16;
1174 mma_rule_40_t *rule40;
1175 mma_rules_table_16_t *srt16;
1176 mma_rules_table_40_t *srt40;
1179 if (is_local || fib_proto == FIB_PROTOCOL_IP4)
1183 srt16 = &srt->session_rules_tables_16;
1184 pool_foreach (rule16, srt16->rules, ({
1185 ri = mma_rules_table_rule_index_16 (srt16, rule16);
1186 tag = session_rules_table_rule_tag (srt, ri, 1);
1187 send_session_rule_details4 (rule16, is_local, tp, appns_index, tag,
1192 if (is_local || fib_proto == FIB_PROTOCOL_IP6)
1196 srt40 = &srt->session_rules_tables_40;
1197 pool_foreach (rule40, srt40->rules, ({
1198 ri = mma_rules_table_rule_index_40 (srt40, rule40);
1199 tag = session_rules_table_rule_tag (srt, ri, 1);
1200 send_session_rule_details6 (rule40, is_local, tp, appns_index, tag,
1208 vl_api_session_rules_dump_t_handler (vl_api_one_map_server_dump_t * mp)
1210 vl_api_registration_t *reg;
1211 session_table_t *st;
1214 reg = vl_api_client_index_to_registration (mp->client_index);
1219 session_table_foreach (st, ({
1220 for (tp = 0; tp < TRANSPORT_N_PROTO; tp++)
1222 send_session_rules_table_details (&st->session_rules[tp],
1223 st->active_fib_proto, tp,
1224 st->is_local, st->appns_index, reg,
1232 vl_api_application_tls_cert_add_t_handler (vl_api_application_tls_cert_add_t *
1235 vl_api_app_namespace_add_del_reply_t *rmp;
1236 vnet_app_add_tls_cert_args_t _a, *a = &_a;
1237 clib_error_t *error;
1241 if (!session_main_is_enabled ())
1243 rv = VNET_API_ERROR_FEATURE_DISABLED;
1246 if (!(app = application_lookup (mp->client_index)))
1248 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
1251 clib_memset (a, 0, sizeof (*a));
1252 a->app_index = app->app_index;
1253 cert_len = clib_net_to_host_u16 (mp->cert_len);
1254 if (cert_len > 10000)
1256 rv = VNET_API_ERROR_INVALID_VALUE;
1259 vec_validate (a->cert, cert_len);
1260 clib_memcpy_fast (a->cert, mp->cert, cert_len);
1261 if ((error = vnet_app_add_tls_cert (a)))
1263 rv = clib_error_get_code (error);
1264 clib_error_report (error);
1268 REPLY_MACRO (VL_API_APPLICATION_TLS_CERT_ADD_REPLY);
1272 vl_api_application_tls_key_add_t_handler (vl_api_application_tls_key_add_t *
1275 vl_api_app_namespace_add_del_reply_t *rmp;
1276 vnet_app_add_tls_key_args_t _a, *a = &_a;
1277 clib_error_t *error;
1281 if (!session_main_is_enabled ())
1283 rv = VNET_API_ERROR_FEATURE_DISABLED;
1286 if (!(app = application_lookup (mp->client_index)))
1288 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
1291 clib_memset (a, 0, sizeof (*a));
1292 a->app_index = app->app_index;
1293 key_len = clib_net_to_host_u16 (mp->key_len);
1294 if (key_len > 10000)
1296 rv = VNET_API_ERROR_INVALID_VALUE;
1299 vec_validate (a->key, key_len);
1300 clib_memcpy_fast (a->key, mp->key, key_len);
1301 if ((error = vnet_app_add_tls_key (a)))
1303 rv = clib_error_get_code (error);
1304 clib_error_report (error);
1308 REPLY_MACRO (VL_API_APPLICATION_TLS_KEY_ADD_REPLY);
1311 static clib_error_t *
1312 application_reaper_cb (u32 client_index)
1314 application_t *app = application_lookup (client_index);
1315 vnet_app_detach_args_t _a, *a = &_a;
1318 a->app_index = app->app_index;
1319 a->api_client_index = client_index;
1320 vnet_application_detach (a);
1325 VL_MSG_API_REAPER_FUNCTION (application_reaper_cb);
1327 #define vl_msg_name_crc_list
1328 #include <vnet/vnet_all_api_h.h>
1329 #undef vl_msg_name_crc_list
1332 setup_message_id_table (api_main_t * am)
1334 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
1335 foreach_vl_msg_name_crc_session;
1340 * session_api_hookup
1341 * Add uri's API message handlers to the table.
1342 * vlib has already mapped shared memory and
1343 * added the client registration handlers.
1344 * See .../open-repo/vlib/memclnt_vlib.c:memclnt_process()
1346 static clib_error_t *
1347 session_api_hookup (vlib_main_t * vm)
1349 api_main_t *am = &api_main;
1352 vl_msg_api_set_handlers(VL_API_##N, #n, \
1353 vl_api_##n##_t_handler, \
1355 vl_api_##n##_t_endian, \
1356 vl_api_##n##_t_print, \
1357 sizeof(vl_api_##n##_t), 1);
1358 foreach_session_api_msg;
1362 * Messages which bounce off the data-plane to
1363 * an API client. Simply tells the message handling infra not
1364 * to free the message.
1366 * Bounced message handlers MUST NOT block the data plane
1368 am->message_bounce[VL_API_CONNECT_URI] = 1;
1369 am->message_bounce[VL_API_CONNECT_SOCK] = 1;
1372 * Set up the (msg_name, crc, message-id) table
1374 setup_message_id_table (am);
1379 VLIB_API_INIT_FUNCTION (session_api_hookup);
1382 * fd.io coding-style-patch-verification: ON
1385 * eval: (c-set-style "gnu")