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;
177 transport_connection_t *tc;
179 session_accepted_msg_t *mp;
180 session_event_t *evt;
184 app = application_get (app_wrk->app_index);
185 app_mq = app_wrk->event_queue;
186 if (mq_try_lock_and_alloc_msg (app_mq, msg))
189 evt = svm_msg_q_msg_data (app_mq, msg);
190 clib_memset (evt, 0, sizeof (*evt));
191 evt->event_type = SESSION_CTRL_EVT_ACCEPTED;
192 mp = (session_accepted_msg_t *) evt->data;
193 clib_memset (mp, 0, sizeof (*mp));
194 mp->context = app->app_index;
195 mp->server_rx_fifo = pointer_to_uword (s->rx_fifo);
196 mp->server_tx_fifo = pointer_to_uword (s->tx_fifo);
197 mp->segment_handle = session_segment_handle (s);
199 if (session_has_transport (s))
201 listener = listen_session_get (s->listener_index);
202 al = app_listener_get (app, listener->al_index);
203 mp->listener_handle = app_listener_handle (al);
204 if (application_is_proxy (app))
207 app_worker_first_listener (app_wrk, session_get_fib_proto (s),
208 session_get_transport_proto (s));
210 mp->listener_handle = listen_session_get_handle (listener);
212 vpp_queue = session_main_get_vpp_event_queue (s->thread_index);
213 mp->vpp_event_queue_address = pointer_to_uword (vpp_queue);
214 mp->handle = session_handle (s);
215 tc = transport_get_connection (session_get_transport_proto (s),
216 s->connection_index, s->thread_index);
217 mp->port = tc->rmt_port;
218 mp->is_ip4 = tc->is_ip4;
219 clib_memcpy_fast (&mp->ip, &tc->rmt_ip, sizeof (tc->rmt_ip));
225 ct = (ct_connection_t *) session_get_transport (s);
226 listener = listen_session_get (s->listener_index);
227 al = app_listener_get (app, listener->al_index);
228 mp->listener_handle = app_listener_handle (al);
229 mp->is_ip4 = session_type_is_ip4 (listener->session_type);
230 mp->handle = session_handle (s);
231 mp->port = ct->c_rmt_port;
232 vpp_queue = session_main_get_vpp_event_queue (0);
233 mp->vpp_event_queue_address = pointer_to_uword (vpp_queue);
235 svm_msg_q_add_and_unlock (app_mq, msg);
241 mq_send_session_close_evt (app_worker_t * app_wrk, session_handle_t sh,
242 session_evt_type_t evt_type)
244 svm_msg_q_msg_t _msg, *msg = &_msg;
245 session_disconnected_msg_t *mp;
247 session_event_t *evt;
249 app_mq = app_wrk->event_queue;
250 if (mq_try_lock_and_alloc_msg (app_mq, msg))
252 evt = svm_msg_q_msg_data (app_mq, msg);
253 clib_memset (evt, 0, sizeof (*evt));
254 evt->event_type = evt_type;
255 mp = (session_disconnected_msg_t *) evt->data;
257 mp->context = app_wrk->api_client_index;
258 svm_msg_q_add_and_unlock (app_mq, msg);
262 mq_notify_close_subscribers (u32 app_index, session_handle_t sh,
263 svm_fifo_t * f, session_evt_type_t evt_type)
265 app_worker_t *app_wrk;
269 app = application_get (app_index);
273 for (i = 0; i < f->n_subscribers; i++)
275 if (!(app_wrk = application_get_worker (app, f->subscribers[i])))
277 mq_send_session_close_evt (app_wrk, sh, SESSION_CTRL_EVT_DISCONNECTED);
282 mq_send_session_disconnected_cb (session_t * s)
284 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
285 session_handle_t sh = session_handle (s);
287 mq_send_session_close_evt (app_wrk, session_handle (s),
288 SESSION_CTRL_EVT_DISCONNECTED);
290 if (svm_fifo_n_subscribers (s->rx_fifo))
291 mq_notify_close_subscribers (app_wrk->app_index, sh, s->rx_fifo,
292 SESSION_CTRL_EVT_DISCONNECTED);
296 mq_send_session_reset_cb (session_t * s)
298 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
299 session_handle_t sh = session_handle (s);
301 mq_send_session_close_evt (app_wrk, sh, SESSION_CTRL_EVT_RESET);
303 if (svm_fifo_n_subscribers (s->rx_fifo))
304 mq_notify_close_subscribers (app_wrk->app_index, sh, s->rx_fifo,
305 SESSION_CTRL_EVT_RESET);
309 mq_send_session_connected_cb (u32 app_wrk_index, u32 api_context,
310 session_t * s, u8 is_fail)
312 svm_msg_q_msg_t _msg, *msg = &_msg;
313 session_connected_msg_t *mp;
314 svm_msg_q_t *vpp_mq, *app_mq;
315 transport_connection_t *tc;
316 app_worker_t *app_wrk;
317 session_event_t *evt;
319 app_wrk = app_worker_get (app_wrk_index);
320 app_mq = app_wrk->event_queue;
323 clib_warning ("app %u with api index: %u not attached",
324 app_wrk->app_index, app_wrk->api_client_index);
328 if (mq_try_lock_and_alloc_msg (app_mq, msg))
331 evt = svm_msg_q_msg_data (app_mq, msg);
332 clib_memset (evt, 0, sizeof (*evt));
333 evt->event_type = SESSION_CTRL_EVT_CONNECTED;
334 mp = (session_connected_msg_t *) evt->data;
335 clib_memset (mp, 0, sizeof (*mp));
336 mp->context = api_context;
341 if (session_has_transport (s))
343 tc = session_get_transport (s);
350 vpp_mq = session_main_get_vpp_event_queue (s->thread_index);
351 mp->handle = session_handle (s);
352 mp->vpp_event_queue_address = pointer_to_uword (vpp_mq);
353 clib_memcpy_fast (mp->lcl_ip, &tc->lcl_ip, sizeof (tc->lcl_ip));
354 mp->is_ip4 = tc->is_ip4;
355 mp->lcl_port = tc->lcl_port;
356 mp->server_rx_fifo = pointer_to_uword (s->rx_fifo);
357 mp->server_tx_fifo = pointer_to_uword (s->tx_fifo);
358 mp->segment_handle = session_segment_handle (s);
362 ct_connection_t *cct;
365 cct = (ct_connection_t *) session_get_transport (s);
366 mp->handle = session_handle (s);
367 mp->lcl_port = cct->c_lcl_port;
368 mp->is_ip4 = cct->c_is_ip4;
369 vpp_mq = session_main_get_vpp_event_queue (0);
370 mp->vpp_event_queue_address = pointer_to_uword (vpp_mq);
371 mp->server_rx_fifo = pointer_to_uword (s->rx_fifo);
372 mp->server_tx_fifo = pointer_to_uword (s->tx_fifo);
373 mp->segment_handle = session_segment_handle (s);
374 ss = ct_session_get_peer (s);
375 mp->ct_rx_fifo = pointer_to_uword (ss->tx_fifo);
376 mp->ct_tx_fifo = pointer_to_uword (ss->rx_fifo);
377 mp->ct_segment_handle = session_segment_handle (ss);
381 mp->retval = is_fail ?
382 clib_host_to_net_u32 (VNET_API_ERROR_SESSION_CONNECT) : 0;
384 svm_msg_q_add_and_unlock (app_mq, msg);
389 mq_send_session_bound_cb (u32 app_wrk_index, u32 api_context,
390 session_handle_t handle, int rv)
392 svm_msg_q_msg_t _msg, *msg = &_msg;
393 svm_msg_q_t *app_mq, *vpp_evt_q;
394 transport_connection_t *tc;
395 session_bound_msg_t *mp;
396 app_worker_t *app_wrk;
397 session_event_t *evt;
401 app_wrk = app_worker_get (app_wrk_index);
402 app_mq = app_wrk->event_queue;
405 clib_warning ("app %u with api index: %u not attached",
406 app_wrk->app_index, app_wrk->api_client_index);
410 if (mq_try_lock_and_alloc_msg (app_mq, msg))
413 evt = svm_msg_q_msg_data (app_mq, msg);
414 clib_memset (evt, 0, sizeof (*evt));
415 evt->event_type = SESSION_CTRL_EVT_BOUND;
416 mp = (session_bound_msg_t *) evt->data;
417 mp->context = api_context;
423 al = app_listener_get_w_handle (handle);
424 if (al->session_index != SESSION_INVALID_INDEX)
425 ls = app_listener_get_session (al);
427 ls = app_listener_get_local_session (al);
428 tc = listen_session_get_transport (ls);
429 mp->lcl_port = tc->lcl_port;
430 mp->lcl_is_ip4 = tc->is_ip4;
431 clib_memcpy_fast (mp->lcl_ip, &tc->lcl_ip, sizeof (tc->lcl_ip));
433 vpp_evt_q = session_main_get_vpp_event_queue (0);
434 mp->vpp_evt_q = pointer_to_uword (vpp_evt_q);
436 if (session_transport_service_type (ls) == TRANSPORT_SERVICE_CL)
438 mp->rx_fifo = pointer_to_uword (ls->rx_fifo);
439 mp->tx_fifo = pointer_to_uword (ls->tx_fifo);
444 svm_msg_q_add_and_unlock (app_mq, msg);
449 mq_app_tx_callback (session_t * s)
451 if (session_has_transport (s))
453 return ct_session_tx (s);
456 static session_cb_vft_t session_mq_cb_vft = {
457 .session_accept_callback = mq_send_session_accepted_cb,
458 .session_disconnect_callback = mq_send_session_disconnected_cb,
459 .session_connected_callback = mq_send_session_connected_cb,
460 .session_reset_callback = mq_send_session_reset_cb,
461 .builtin_app_tx_callback = mq_app_tx_callback,
462 .add_segment_callback = send_add_segment_callback,
463 .del_segment_callback = send_del_segment_callback,
467 vl_api_session_enable_disable_t_handler (vl_api_session_enable_disable_t * mp)
469 vl_api_session_enable_disable_reply_t *rmp;
470 vlib_main_t *vm = vlib_get_main ();
473 vnet_session_enable_disable (vm, mp->is_enable);
474 REPLY_MACRO (VL_API_SESSION_ENABLE_DISABLE_REPLY);
478 vl_api_application_attach_t_handler (vl_api_application_attach_t * mp)
480 int rv = 0, fds[SESSION_N_FD_TYPE], n_fds = 0;
481 vl_api_application_attach_reply_t *rmp;
482 ssvm_private_t *segp, *evt_q_segment;
483 vnet_app_attach_args_t _a, *a = &_a;
484 vl_api_registration_t *reg;
487 reg = vl_api_client_index_to_registration (mp->client_index);
491 if (session_main_is_enabled () == 0)
493 rv = VNET_API_ERROR_FEATURE_DISABLED;
497 STATIC_ASSERT (sizeof (u64) * APP_OPTIONS_N_OPTIONS <=
498 sizeof (mp->options),
499 "Out of options, fix api message definition");
501 clib_memset (a, 0, sizeof (*a));
502 a->api_client_index = mp->client_index;
503 a->options = mp->options;
504 a->session_cb_vft = &session_mq_cb_vft;
505 if (mp->namespace_id_len > 64)
507 rv = VNET_API_ERROR_INVALID_VALUE;
511 if (mp->namespace_id_len)
513 vec_validate (a->namespace_id, mp->namespace_id_len - 1);
514 clib_memcpy_fast (a->namespace_id, mp->namespace_id,
515 mp->namespace_id_len);
518 if ((rv = vnet_application_attach (a)))
520 clib_warning ("attach returned: %d", rv);
521 vec_free (a->namespace_id);
524 vec_free (a->namespace_id);
526 /* Send event queues segment */
527 if ((evt_q_segment = session_main_get_evt_q_segment ()))
529 fd_flags |= SESSION_FD_F_VPP_MQ_SEGMENT;
530 fds[n_fds] = evt_q_segment->fd;
533 /* Send fifo segment fd if needed */
534 if (ssvm_type (a->segment) == SSVM_SEGMENT_MEMFD)
536 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
537 fds[n_fds] = a->segment->fd;
540 if (a->options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
542 fd_flags |= SESSION_FD_F_MQ_EVENTFD;
543 fds[n_fds] = svm_msg_q_get_producer_eventfd (a->app_evt_q);
550 REPLY_MACRO2 (VL_API_APPLICATION_ATTACH_REPLY, ({
554 rmp->app_index = clib_host_to_net_u32 (a->app_index);
555 rmp->segment_name_length = 0;
556 rmp->segment_size = segp->ssvm_size;
557 if (vec_len (segp->name))
559 memcpy (rmp->segment_name, segp->name, vec_len (segp->name));
560 rmp->segment_name_length = vec_len (segp->name);
562 rmp->app_event_queue_address = pointer_to_uword (a->app_evt_q);
564 rmp->fd_flags = fd_flags;
565 rmp->segment_handle = clib_host_to_net_u64 (a->segment_handle);
571 session_send_fds (reg, fds, n_fds);
575 vl_api_application_detach_t_handler (vl_api_application_detach_t * mp)
577 vl_api_application_detach_reply_t *rmp;
578 int rv = VNET_API_ERROR_INVALID_VALUE_2;
579 vnet_app_detach_args_t _a, *a = &_a;
582 if (session_main_is_enabled () == 0)
584 rv = VNET_API_ERROR_FEATURE_DISABLED;
588 app = application_lookup (mp->client_index);
591 a->app_index = app->app_index;
592 a->api_client_index = mp->client_index;
593 rv = vnet_application_detach (a);
597 REPLY_MACRO (VL_API_APPLICATION_DETACH_REPLY);
601 vl_api_bind_uri_t_handler (vl_api_bind_uri_t * mp)
603 vl_api_bind_uri_reply_t *rmp;
604 vnet_listen_args_t _a, *a = &_a;
605 application_t *app = 0;
606 app_worker_t *app_wrk;
609 if (session_main_is_enabled () == 0)
611 rv = VNET_API_ERROR_FEATURE_DISABLED;
615 app = application_lookup (mp->client_index);
618 clib_memset (a, 0, sizeof (*a));
619 a->uri = (char *) mp->uri;
620 a->app_index = app->app_index;
621 rv = vnet_bind_uri (a);
625 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
630 REPLY_MACRO (VL_API_BIND_URI_REPLY);
634 app_wrk = application_get_worker (app, 0);
635 mq_send_session_bound_cb (app_wrk->wrk_index, mp->context, a->handle,
641 vl_api_unbind_uri_t_handler (vl_api_unbind_uri_t * mp)
643 vl_api_unbind_uri_reply_t *rmp;
645 vnet_unlisten_args_t _a, *a = &_a;
648 if (session_main_is_enabled () == 0)
650 rv = VNET_API_ERROR_FEATURE_DISABLED;
654 app = application_lookup (mp->client_index);
657 a->uri = (char *) mp->uri;
658 a->app_index = app->app_index;
659 rv = vnet_unbind_uri (a);
663 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
667 REPLY_MACRO (VL_API_UNBIND_URI_REPLY);
671 vl_api_connect_uri_t_handler (vl_api_connect_uri_t * mp)
673 vl_api_connect_uri_reply_t *rmp;
674 vnet_connect_args_t _a, *a = &_a;
678 if (session_main_is_enabled () == 0)
680 rv = VNET_API_ERROR_FEATURE_DISABLED;
684 app = application_lookup (mp->client_index);
687 clib_memset (a, 0, sizeof (*a));
688 a->uri = (char *) mp->uri;
689 a->api_context = mp->context;
690 a->app_index = app->app_index;
691 if ((rv = vnet_connect_uri (a)))
692 clib_warning ("connect_uri returned: %d", rv);
696 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
700 * Don't reply to stream (tcp) connects. The reply will come once
701 * the connection is established. In case of the redirects, the reply
702 * will come from the server app.
708 REPLY_MACRO (VL_API_CONNECT_URI_REPLY);
712 vl_api_disconnect_session_t_handler (vl_api_disconnect_session_t * mp)
714 vl_api_disconnect_session_reply_t *rmp;
715 vnet_disconnect_args_t _a, *a = &_a;
719 if (session_main_is_enabled () == 0)
721 rv = VNET_API_ERROR_FEATURE_DISABLED;
725 app = application_lookup (mp->client_index);
728 a->handle = mp->handle;
729 a->app_index = app->app_index;
730 rv = vnet_disconnect_session (a);
734 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
738 REPLY_MACRO2 (VL_API_DISCONNECT_SESSION_REPLY, rmp->handle = mp->handle);
742 vl_api_disconnect_session_reply_t_handler (vl_api_disconnect_session_reply_t *
745 vnet_disconnect_args_t _a, *a = &_a;
748 /* Client objected to disconnecting the session, log and continue */
751 clib_warning ("client retval %d", mp->retval);
755 /* Disconnect has been confirmed. Confirm close to transport */
756 app = application_lookup (mp->context);
759 a->handle = mp->handle;
760 a->app_index = app->app_index;
761 vnet_disconnect_session (a);
766 vl_api_map_another_segment_reply_t_handler (vl_api_map_another_segment_reply_t
769 clib_warning ("not implemented");
773 vl_api_bind_sock_t_handler (vl_api_bind_sock_t * mp)
775 vnet_listen_args_t _a, *a = &_a;
776 vl_api_bind_sock_reply_t *rmp;
777 application_t *app = 0;
778 app_worker_t *app_wrk;
779 ip46_address_t *ip46;
782 if (session_main_is_enabled () == 0)
784 rv = VNET_API_ERROR_FEATURE_DISABLED;
788 app = application_lookup (mp->client_index);
791 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
795 ip46 = (ip46_address_t *) mp->ip;
796 clib_memset (a, 0, sizeof (*a));
797 a->sep.is_ip4 = mp->is_ip4;
799 a->sep.port = mp->port;
800 a->sep.fib_index = mp->vrf;
801 a->sep.sw_if_index = ENDPOINT_INVALID_INDEX;
802 a->sep.transport_proto = mp->proto;
803 a->app_index = app->app_index;
804 a->wrk_map_index = mp->wrk_index;
806 if ((rv = vnet_listen (a)))
807 clib_warning ("listen returned: %d", rv);
810 /* Actual reply sent only over mq */
811 REPLY_MACRO (VL_API_BIND_SOCK_REPLY);
815 app_wrk = application_get_worker (app, mp->wrk_index);
816 mq_send_session_bound_cb (app_wrk->wrk_index, mp->context, a->handle,
822 vl_api_unbind_sock_t_handler (vl_api_unbind_sock_t * mp)
824 vl_api_unbind_sock_reply_t *rmp;
825 vnet_unlisten_args_t _a, *a = &_a;
826 app_worker_t *app_wrk;
827 application_t *app = 0;
830 if (session_main_is_enabled () == 0)
832 rv = VNET_API_ERROR_FEATURE_DISABLED;
836 app = application_lookup (mp->client_index);
839 a->app_index = app->app_index;
840 a->handle = mp->handle;
841 a->wrk_map_index = mp->wrk_index;
842 if ((rv = vnet_unlisten (a)))
843 clib_warning ("unlisten returned: %d", rv);
847 REPLY_MACRO (VL_API_UNBIND_SOCK_REPLY);
850 * Send reply over msg queue
852 svm_msg_q_msg_t _msg, *msg = &_msg;
853 session_unlisten_reply_msg_t *ump;
855 session_event_t *evt;
860 app_wrk = application_get_worker (app, a->wrk_map_index);
864 app_mq = app_wrk->event_queue;
865 if (mq_try_lock_and_alloc_msg (app_mq, msg))
868 evt = svm_msg_q_msg_data (app_mq, msg);
869 clib_memset (evt, 0, sizeof (*evt));
870 evt->event_type = SESSION_CTRL_EVT_UNLISTEN_REPLY;
871 ump = (session_unlisten_reply_msg_t *) evt->data;
872 ump->context = mp->context;
873 ump->handle = mp->handle;
875 svm_msg_q_add_and_unlock (app_mq, msg);
879 vl_api_connect_sock_t_handler (vl_api_connect_sock_t * mp)
881 vl_api_connect_sock_reply_t *rmp;
882 vnet_connect_args_t _a, *a = &_a;
883 application_t *app = 0;
886 if (session_main_is_enabled () == 0)
888 rv = VNET_API_ERROR_FEATURE_DISABLED;
892 app = application_lookup (mp->client_index);
895 svm_queue_t *client_q;
896 ip46_address_t *ip46 = (ip46_address_t *) mp->ip;
898 clib_memset (a, 0, sizeof (*a));
899 client_q = vl_api_client_index_to_input_queue (mp->client_index);
900 mp->client_queue_address = pointer_to_uword (client_q);
901 a->sep.is_ip4 = mp->is_ip4;
903 a->sep.port = mp->port;
904 a->sep.transport_proto = mp->proto;
905 a->sep.peer.fib_index = mp->vrf;
906 a->sep.peer.sw_if_index = ENDPOINT_INVALID_INDEX;
907 if (mp->hostname_len)
909 vec_validate (a->sep_ext.hostname, mp->hostname_len - 1);
910 clib_memcpy_fast (a->sep_ext.hostname, mp->hostname,
913 a->api_context = mp->context;
914 a->app_index = app->app_index;
915 a->wrk_map_index = mp->wrk_index;
916 if ((rv = vnet_connect (a)))
917 clib_warning ("connect returned: %u", rv);
918 vec_free (a->sep_ext.hostname);
922 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
928 /* Got some error, relay it */
931 REPLY_MACRO (VL_API_CONNECT_SOCK_REPLY);
935 app_worker_t *app_wrk = application_get_worker (app, mp->wrk_index);
936 mq_send_session_connected_cb (app_wrk->wrk_index, mp->context, 0, 1);
941 vl_api_app_worker_add_del_t_handler (vl_api_app_worker_add_del_t * mp)
943 int rv = 0, fds[SESSION_N_FD_TYPE], n_fds = 0;
944 vl_api_app_worker_add_del_reply_t *rmp;
945 vl_api_registration_t *reg;
949 if (!session_main_is_enabled ())
951 rv = VNET_API_ERROR_FEATURE_DISABLED;
955 reg = vl_api_client_index_to_registration (mp->client_index);
959 app = application_get_if_valid (clib_net_to_host_u32 (mp->app_index));
962 rv = VNET_API_ERROR_INVALID_VALUE;
966 vnet_app_worker_add_del_args_t args = {
967 .app_index = app->app_index,
968 .wrk_map_index = clib_net_to_host_u32 (mp->wrk_index),
969 .api_client_index = mp->client_index,
972 rv = vnet_app_worker_add_del (&args);
975 clib_warning ("app worker add/del returned: %d", rv);
982 /* Send fifo segment fd if needed */
983 if (ssvm_type (args.segment) == SSVM_SEGMENT_MEMFD)
985 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
986 fds[n_fds] = args.segment->fd;
989 if (application_segment_manager_properties (app)->use_mq_eventfd)
991 fd_flags |= SESSION_FD_F_MQ_EVENTFD;
992 fds[n_fds] = svm_msg_q_get_producer_eventfd (args.evt_q);
998 REPLY_MACRO2 (VL_API_APP_WORKER_ADD_DEL_REPLY, ({
999 rmp->is_add = mp->is_add;
1000 rmp->wrk_index = clib_host_to_net_u32 (args.wrk_map_index);
1001 rmp->segment_handle = clib_host_to_net_u64 (args.segment_handle);
1002 if (!rv && mp->is_add)
1004 if (vec_len (args.segment->name))
1006 memcpy (rmp->segment_name, args.segment->name,
1007 vec_len (args.segment->name));
1008 rmp->segment_name_length = vec_len (args.segment->name);
1010 rmp->app_event_queue_address = pointer_to_uword (args.evt_q);
1012 rmp->fd_flags = fd_flags;
1018 session_send_fds (reg, fds, n_fds);
1022 vl_api_app_namespace_add_del_t_handler (vl_api_app_namespace_add_del_t * mp)
1024 vl_api_app_namespace_add_del_reply_t *rmp;
1025 u32 appns_index = 0;
1028 if (!session_main_is_enabled ())
1030 rv = VNET_API_ERROR_FEATURE_DISABLED;
1034 if (mp->namespace_id_len > ARRAY_LEN (mp->namespace_id))
1036 rv = VNET_API_ERROR_INVALID_VALUE;
1040 vec_validate (ns_id, mp->namespace_id_len - 1);
1041 clib_memcpy_fast (ns_id, mp->namespace_id, mp->namespace_id_len);
1042 vnet_app_namespace_add_del_args_t args = {
1044 .secret = clib_net_to_host_u64 (mp->secret),
1045 .sw_if_index = clib_net_to_host_u32 (mp->sw_if_index),
1046 .ip4_fib_id = clib_net_to_host_u32 (mp->ip4_fib_id),
1047 .ip6_fib_id = clib_net_to_host_u32 (mp->ip6_fib_id),
1050 rv = vnet_app_namespace_add_del (&args);
1053 appns_index = app_namespace_index_from_id (ns_id);
1054 if (appns_index == APP_NAMESPACE_INVALID_INDEX)
1056 clib_warning ("app ns lookup failed");
1057 rv = VNET_API_ERROR_UNSPECIFIED;
1064 REPLY_MACRO2 (VL_API_APP_NAMESPACE_ADD_DEL_REPLY, ({
1066 rmp->appns_index = clib_host_to_net_u32 (appns_index);
1072 vl_api_session_rule_add_del_t_handler (vl_api_session_rule_add_del_t * mp)
1074 vl_api_session_rule_add_del_reply_t *rmp;
1075 session_rule_add_del_args_t args;
1076 session_rule_table_add_del_args_t *table_args = &args.table_args;
1080 clib_memset (&args, 0, sizeof (args));
1081 fib_proto = mp->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
1083 table_args->lcl.fp_len = mp->lcl_plen;
1084 table_args->lcl.fp_proto = fib_proto;
1085 table_args->rmt.fp_len = mp->rmt_plen;
1086 table_args->rmt.fp_proto = fib_proto;
1087 table_args->lcl_port = mp->lcl_port;
1088 table_args->rmt_port = mp->rmt_port;
1089 table_args->action_index = clib_net_to_host_u32 (mp->action_index);
1090 table_args->is_add = mp->is_add;
1091 mp->tag[sizeof (mp->tag) - 1] = 0;
1092 table_args->tag = format (0, "%s", mp->tag);
1093 args.appns_index = clib_net_to_host_u32 (mp->appns_index);
1094 args.scope = mp->scope;
1095 args.transport_proto = mp->transport_proto;
1097 clib_memset (&table_args->lcl.fp_addr, 0, sizeof (table_args->lcl.fp_addr));
1098 clib_memset (&table_args->rmt.fp_addr, 0, sizeof (table_args->rmt.fp_addr));
1099 ip_set (&table_args->lcl.fp_addr, mp->lcl_ip, mp->is_ip4);
1100 ip_set (&table_args->rmt.fp_addr, mp->rmt_ip, mp->is_ip4);
1101 rv = vnet_session_rule_add_del (&args);
1103 clib_warning ("rule add del returned: %d", rv);
1104 vec_free (table_args->tag);
1105 REPLY_MACRO (VL_API_SESSION_RULE_ADD_DEL_REPLY);
1109 send_session_rule_details4 (mma_rule_16_t * rule, u8 is_local,
1110 u8 transport_proto, u32 appns_index, u8 * tag,
1111 vl_api_registration_t * reg, u32 context)
1113 vl_api_session_rules_details_t *rmp = 0;
1114 session_mask_or_match_4_t *match =
1115 (session_mask_or_match_4_t *) & rule->match;
1116 session_mask_or_match_4_t *mask =
1117 (session_mask_or_match_4_t *) & rule->mask;
1119 rmp = vl_msg_api_alloc (sizeof (*rmp));
1120 clib_memset (rmp, 0, sizeof (*rmp));
1121 rmp->_vl_msg_id = ntohs (VL_API_SESSION_RULES_DETAILS);
1122 rmp->context = context;
1125 clib_memcpy_fast (rmp->lcl_ip, &match->lcl_ip, sizeof (match->lcl_ip));
1126 clib_memcpy_fast (rmp->rmt_ip, &match->rmt_ip, sizeof (match->rmt_ip));
1127 rmp->lcl_plen = ip4_mask_to_preflen (&mask->lcl_ip);
1128 rmp->rmt_plen = ip4_mask_to_preflen (&mask->rmt_ip);
1129 rmp->lcl_port = match->lcl_port;
1130 rmp->rmt_port = match->rmt_port;
1131 rmp->action_index = clib_host_to_net_u32 (rule->action_index);
1133 is_local ? SESSION_RULE_SCOPE_LOCAL : SESSION_RULE_SCOPE_GLOBAL;
1134 rmp->transport_proto = transport_proto;
1135 rmp->appns_index = clib_host_to_net_u32 (appns_index);
1138 clib_memcpy_fast (rmp->tag, tag, vec_len (tag));
1139 rmp->tag[vec_len (tag)] = 0;
1142 vl_api_send_msg (reg, (u8 *) rmp);
1146 send_session_rule_details6 (mma_rule_40_t * rule, u8 is_local,
1147 u8 transport_proto, u32 appns_index, u8 * tag,
1148 vl_api_registration_t * reg, u32 context)
1150 vl_api_session_rules_details_t *rmp = 0;
1151 session_mask_or_match_6_t *match =
1152 (session_mask_or_match_6_t *) & rule->match;
1153 session_mask_or_match_6_t *mask =
1154 (session_mask_or_match_6_t *) & rule->mask;
1156 rmp = vl_msg_api_alloc (sizeof (*rmp));
1157 clib_memset (rmp, 0, sizeof (*rmp));
1158 rmp->_vl_msg_id = ntohs (VL_API_SESSION_RULES_DETAILS);
1159 rmp->context = context;
1162 clib_memcpy_fast (rmp->lcl_ip, &match->lcl_ip, sizeof (match->lcl_ip));
1163 clib_memcpy_fast (rmp->rmt_ip, &match->rmt_ip, sizeof (match->rmt_ip));
1164 rmp->lcl_plen = ip6_mask_to_preflen (&mask->lcl_ip);
1165 rmp->rmt_plen = ip6_mask_to_preflen (&mask->rmt_ip);
1166 rmp->lcl_port = match->lcl_port;
1167 rmp->rmt_port = match->rmt_port;
1168 rmp->action_index = clib_host_to_net_u32 (rule->action_index);
1170 is_local ? SESSION_RULE_SCOPE_LOCAL : SESSION_RULE_SCOPE_GLOBAL;
1171 rmp->transport_proto = transport_proto;
1172 rmp->appns_index = clib_host_to_net_u32 (appns_index);
1175 clib_memcpy_fast (rmp->tag, tag, vec_len (tag));
1176 rmp->tag[vec_len (tag)] = 0;
1179 vl_api_send_msg (reg, (u8 *) rmp);
1183 send_session_rules_table_details (session_rules_table_t * srt, u8 fib_proto,
1184 u8 tp, u8 is_local, u32 appns_index,
1185 vl_api_registration_t * reg, u32 context)
1187 mma_rule_16_t *rule16;
1188 mma_rule_40_t *rule40;
1189 mma_rules_table_16_t *srt16;
1190 mma_rules_table_40_t *srt40;
1193 if (is_local || fib_proto == FIB_PROTOCOL_IP4)
1197 srt16 = &srt->session_rules_tables_16;
1198 pool_foreach (rule16, srt16->rules, ({
1199 ri = mma_rules_table_rule_index_16 (srt16, rule16);
1200 tag = session_rules_table_rule_tag (srt, ri, 1);
1201 send_session_rule_details4 (rule16, is_local, tp, appns_index, tag,
1206 if (is_local || fib_proto == FIB_PROTOCOL_IP6)
1210 srt40 = &srt->session_rules_tables_40;
1211 pool_foreach (rule40, srt40->rules, ({
1212 ri = mma_rules_table_rule_index_40 (srt40, rule40);
1213 tag = session_rules_table_rule_tag (srt, ri, 1);
1214 send_session_rule_details6 (rule40, is_local, tp, appns_index, tag,
1222 vl_api_session_rules_dump_t_handler (vl_api_one_map_server_dump_t * mp)
1224 vl_api_registration_t *reg;
1225 session_table_t *st;
1228 reg = vl_api_client_index_to_registration (mp->client_index);
1233 session_table_foreach (st, ({
1234 for (tp = 0; tp < TRANSPORT_N_PROTO; tp++)
1236 send_session_rules_table_details (&st->session_rules[tp],
1237 st->active_fib_proto, tp,
1238 st->is_local, st->appns_index, reg,
1246 vl_api_application_tls_cert_add_t_handler (vl_api_application_tls_cert_add_t *
1249 vl_api_app_namespace_add_del_reply_t *rmp;
1250 vnet_app_add_tls_cert_args_t _a, *a = &_a;
1251 clib_error_t *error;
1255 if (!session_main_is_enabled ())
1257 rv = VNET_API_ERROR_FEATURE_DISABLED;
1260 if (!(app = application_lookup (mp->client_index)))
1262 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
1265 clib_memset (a, 0, sizeof (*a));
1266 a->app_index = app->app_index;
1267 cert_len = clib_net_to_host_u16 (mp->cert_len);
1268 if (cert_len > 10000)
1270 rv = VNET_API_ERROR_INVALID_VALUE;
1273 vec_validate (a->cert, cert_len);
1274 clib_memcpy_fast (a->cert, mp->cert, cert_len);
1275 if ((error = vnet_app_add_tls_cert (a)))
1277 rv = clib_error_get_code (error);
1278 clib_error_report (error);
1282 REPLY_MACRO (VL_API_APPLICATION_TLS_CERT_ADD_REPLY);
1286 vl_api_application_tls_key_add_t_handler (vl_api_application_tls_key_add_t *
1289 vl_api_app_namespace_add_del_reply_t *rmp;
1290 vnet_app_add_tls_key_args_t _a, *a = &_a;
1291 clib_error_t *error;
1295 if (!session_main_is_enabled ())
1297 rv = VNET_API_ERROR_FEATURE_DISABLED;
1300 if (!(app = application_lookup (mp->client_index)))
1302 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
1305 clib_memset (a, 0, sizeof (*a));
1306 a->app_index = app->app_index;
1307 key_len = clib_net_to_host_u16 (mp->key_len);
1308 if (key_len > 10000)
1310 rv = VNET_API_ERROR_INVALID_VALUE;
1313 vec_validate (a->key, key_len);
1314 clib_memcpy_fast (a->key, mp->key, key_len);
1315 if ((error = vnet_app_add_tls_key (a)))
1317 rv = clib_error_get_code (error);
1318 clib_error_report (error);
1322 REPLY_MACRO (VL_API_APPLICATION_TLS_KEY_ADD_REPLY);
1325 static clib_error_t *
1326 application_reaper_cb (u32 client_index)
1328 application_t *app = application_lookup (client_index);
1329 vnet_app_detach_args_t _a, *a = &_a;
1332 a->app_index = app->app_index;
1333 a->api_client_index = client_index;
1334 vnet_application_detach (a);
1339 VL_MSG_API_REAPER_FUNCTION (application_reaper_cb);
1341 #define vl_msg_name_crc_list
1342 #include <vnet/vnet_all_api_h.h>
1343 #undef vl_msg_name_crc_list
1346 setup_message_id_table (api_main_t * am)
1348 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
1349 foreach_vl_msg_name_crc_session;
1354 * session_api_hookup
1355 * Add uri's API message handlers to the table.
1356 * vlib has alread mapped shared memory and
1357 * added the client registration handlers.
1358 * See .../open-repo/vlib/memclnt_vlib.c:memclnt_process()
1360 static clib_error_t *
1361 session_api_hookup (vlib_main_t * vm)
1363 api_main_t *am = &api_main;
1366 vl_msg_api_set_handlers(VL_API_##N, #n, \
1367 vl_api_##n##_t_handler, \
1369 vl_api_##n##_t_endian, \
1370 vl_api_##n##_t_print, \
1371 sizeof(vl_api_##n##_t), 1);
1372 foreach_session_api_msg;
1376 * Messages which bounce off the data-plane to
1377 * an API client. Simply tells the message handling infra not
1378 * to free the message.
1380 * Bounced message handlers MUST NOT block the data plane
1382 am->message_bounce[VL_API_CONNECT_URI] = 1;
1383 am->message_bounce[VL_API_CONNECT_SOCK] = 1;
1386 * Set up the (msg_name, crc, message-id) table
1388 setup_message_id_table (am);
1393 VLIB_API_INIT_FUNCTION (session_api_hookup);
1396 * fd.io coding-style-patch-verification: ON
1399 * eval: (c-set-style "gnu")