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 send_app_cut_through_registration_add (u32 api_client_index,
154 u32 wrk_map_index, u64 mq_addr,
157 vl_api_app_cut_through_registration_add_t *mp;
158 vl_api_registration_t *reg;
159 svm_msg_q_t *mq, *peer_mq;
162 reg = vl_mem_api_client_index_to_registration (api_client_index);
165 clib_warning ("no registration: %u", api_client_index);
169 mp = vl_mem_api_alloc_as_if_client_w_reg (reg, sizeof (*mp));
170 clib_memset (mp, 0, sizeof (*mp));
172 clib_host_to_net_u16 (VL_API_APP_CUT_THROUGH_REGISTRATION_ADD);
174 mp->evt_q_address = mq_addr;
175 mp->peer_evt_q_address = peer_mq_addr;
176 mp->wrk_index = wrk_map_index;
178 mq = uword_to_pointer (mq_addr, svm_msg_q_t *);
179 peer_mq = uword_to_pointer (peer_mq_addr, svm_msg_q_t *);
181 if (svm_msg_q_get_producer_eventfd (mq) != -1)
183 mp->fd_flags |= SESSION_FD_F_MQ_EVENTFD;
185 /* app will overwrite exactly the fds we pass here. So
186 * when we swap mq with peer_mq (accept vs connect) the
187 * fds will still be valid */
188 fds[0] = svm_msg_q_get_consumer_eventfd (mq);
189 fds[1] = svm_msg_q_get_producer_eventfd (peer_mq);
192 vl_msg_api_send_shmem (reg->vl_input_queue, (u8 *) & mp);
195 session_send_fds (reg, fds, mp->n_fds);
201 mq_try_lock_and_alloc_msg (svm_msg_q_t * app_mq, svm_msg_q_msg_t * msg)
207 rv = svm_msg_q_lock_and_alloc_msg_w_ring (app_mq,
208 SESSION_MQ_CTRL_EVT_RING,
215 clib_warning ("failed to alloc msg");
220 mq_send_session_accepted_cb (session_t * s)
222 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
223 svm_msg_q_msg_t _msg, *msg = &_msg;
224 svm_msg_q_t *vpp_queue, *app_mq;
225 transport_connection_t *tc;
227 session_accepted_msg_t *mp;
228 session_event_t *evt;
232 app = application_get (app_wrk->app_index);
233 app_mq = app_wrk->event_queue;
234 if (mq_try_lock_and_alloc_msg (app_mq, msg))
237 evt = svm_msg_q_msg_data (app_mq, msg);
238 clib_memset (evt, 0, sizeof (*evt));
239 evt->event_type = SESSION_CTRL_EVT_ACCEPTED;
240 mp = (session_accepted_msg_t *) evt->data;
241 clib_memset (mp, 0, sizeof (*mp));
242 mp->context = app->app_index;
243 mp->server_rx_fifo = pointer_to_uword (s->rx_fifo);
244 mp->server_tx_fifo = pointer_to_uword (s->tx_fifo);
245 mp->segment_handle = session_segment_handle (s);
247 if (session_has_transport (s))
249 listener = listen_session_get (s->listener_index);
250 al = app_listener_get (app, listener->al_index);
251 mp->listener_handle = app_listener_handle (al);
252 if (application_is_proxy (app))
255 app_worker_first_listener (app_wrk, session_get_fib_proto (s),
256 session_get_transport_proto (s));
258 mp->listener_handle = listen_session_get_handle (listener);
260 vpp_queue = session_main_get_vpp_event_queue (s->thread_index);
261 mp->vpp_event_queue_address = pointer_to_uword (vpp_queue);
262 mp->handle = session_handle (s);
263 tc = transport_get_connection (session_get_transport_proto (s),
264 s->connection_index, s->thread_index);
265 mp->port = tc->rmt_port;
266 mp->is_ip4 = tc->is_ip4;
267 clib_memcpy_fast (&mp->ip, &tc->rmt_ip, sizeof (tc->rmt_ip));
271 u8 main_thread = vlib_num_workers ()? 1 : 0;
274 ct = (ct_connection_t *) session_get_transport (s);
275 send_app_cut_through_registration_add (app_wrk->api_client_index,
276 app_wrk->wrk_map_index,
280 listener = listen_session_get (s->listener_index);
281 al = app_listener_get (app, listener->al_index);
282 mp->listener_handle = app_listener_handle (al);
283 mp->is_ip4 = session_type_is_ip4 (listener->session_type);
284 mp->handle = session_handle (s);
285 mp->port = ct->c_rmt_port;
286 vpp_queue = session_main_get_vpp_event_queue (main_thread);
287 mp->vpp_event_queue_address = pointer_to_uword (vpp_queue);
288 mp->client_event_queue_address = ct->client_evt_q;
289 mp->server_event_queue_address = ct->server_evt_q;
291 svm_msg_q_add_and_unlock (app_mq, msg);
297 mq_send_session_close_evt (app_worker_t * app_wrk, session_handle_t sh,
298 session_evt_type_t evt_type)
300 svm_msg_q_msg_t _msg, *msg = &_msg;
301 session_disconnected_msg_t *mp;
303 session_event_t *evt;
305 app_mq = app_wrk->event_queue;
306 if (mq_try_lock_and_alloc_msg (app_mq, msg))
308 evt = svm_msg_q_msg_data (app_mq, msg);
309 clib_memset (evt, 0, sizeof (*evt));
310 evt->event_type = evt_type;
311 mp = (session_disconnected_msg_t *) evt->data;
313 mp->context = app_wrk->api_client_index;
314 svm_msg_q_add_and_unlock (app_mq, msg);
318 mq_notify_close_subscribers (u32 app_index, session_handle_t sh,
319 svm_fifo_t * f, session_evt_type_t evt_type)
321 app_worker_t *app_wrk;
325 app = application_get (app_index);
329 for (i = 0; i < f->n_subscribers; i++)
331 if (!(app_wrk = application_get_worker (app, f->subscribers[i])))
333 mq_send_session_close_evt (app_wrk, sh, SESSION_CTRL_EVT_DISCONNECTED);
338 mq_send_session_disconnected_cb (session_t * s)
340 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
341 session_handle_t sh = session_handle (s);
343 mq_send_session_close_evt (app_wrk, session_handle (s),
344 SESSION_CTRL_EVT_DISCONNECTED);
346 if (svm_fifo_n_subscribers (s->rx_fifo))
347 mq_notify_close_subscribers (app_wrk->app_index, sh, s->rx_fifo,
348 SESSION_CTRL_EVT_DISCONNECTED);
352 mq_send_session_reset_cb (session_t * s)
354 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
355 session_handle_t sh = session_handle (s);
357 mq_send_session_close_evt (app_wrk, sh, SESSION_CTRL_EVT_RESET);
359 if (svm_fifo_n_subscribers (s->rx_fifo))
360 mq_notify_close_subscribers (app_wrk->app_index, sh, s->rx_fifo,
361 SESSION_CTRL_EVT_RESET);
365 mq_send_session_connected_cb (u32 app_wrk_index, u32 api_context,
366 session_t * s, u8 is_fail)
368 svm_msg_q_msg_t _msg, *msg = &_msg;
369 session_connected_msg_t *mp;
370 svm_msg_q_t *vpp_mq, *app_mq;
371 transport_connection_t *tc;
372 app_worker_t *app_wrk;
373 session_event_t *evt;
375 app_wrk = app_worker_get (app_wrk_index);
376 app_mq = app_wrk->event_queue;
379 clib_warning ("app %u with api index: %u not attached",
380 app_wrk->app_index, app_wrk->api_client_index);
384 if (mq_try_lock_and_alloc_msg (app_mq, msg))
387 evt = svm_msg_q_msg_data (app_mq, msg);
388 clib_memset (evt, 0, sizeof (*evt));
389 evt->event_type = SESSION_CTRL_EVT_CONNECTED;
390 mp = (session_connected_msg_t *) evt->data;
391 clib_memset (mp, 0, sizeof (*mp));
392 mp->context = api_context;
397 if (session_has_transport (s))
399 tc = session_get_transport (s);
406 vpp_mq = session_main_get_vpp_event_queue (s->thread_index);
407 mp->handle = session_handle (s);
408 mp->vpp_event_queue_address = pointer_to_uword (vpp_mq);
409 clib_memcpy_fast (mp->lcl_ip, &tc->lcl_ip, sizeof (tc->lcl_ip));
410 mp->is_ip4 = tc->is_ip4;
411 mp->lcl_port = tc->lcl_port;
412 mp->server_rx_fifo = pointer_to_uword (s->rx_fifo);
413 mp->server_tx_fifo = pointer_to_uword (s->tx_fifo);
414 mp->segment_handle = session_segment_handle (s);
418 u8 main_thread = vlib_num_workers ()? 1 : 0;
419 ct_connection_t *cct;
422 cct = (ct_connection_t *) session_get_transport (s);
423 send_app_cut_through_registration_add (app_wrk->api_client_index,
424 app_wrk->wrk_map_index,
428 mp->handle = session_handle (s);
429 mp->lcl_port = cct->c_lcl_port;
430 vpp_mq = session_main_get_vpp_event_queue (main_thread);
431 mp->vpp_event_queue_address = pointer_to_uword (vpp_mq);
432 mp->client_event_queue_address = cct->client_evt_q;
433 mp->server_event_queue_address = cct->server_evt_q;
434 ss = ct_session_get_peer (s);
435 mp->server_rx_fifo = pointer_to_uword (ss->tx_fifo);
436 mp->server_tx_fifo = pointer_to_uword (ss->rx_fifo);
437 mp->segment_handle = session_segment_handle (ss);
441 mp->retval = is_fail ?
442 clib_host_to_net_u32 (VNET_API_ERROR_SESSION_CONNECT) : 0;
444 svm_msg_q_add_and_unlock (app_mq, msg);
449 mq_send_session_bound_cb (u32 app_wrk_index, u32 api_context,
450 session_handle_t handle, int rv)
452 svm_msg_q_msg_t _msg, *msg = &_msg;
453 svm_msg_q_t *app_mq, *vpp_evt_q;
454 transport_connection_t *tc;
455 session_bound_msg_t *mp;
456 app_worker_t *app_wrk;
457 session_event_t *evt;
461 app_wrk = app_worker_get (app_wrk_index);
462 app_mq = app_wrk->event_queue;
465 clib_warning ("app %u with api index: %u not attached",
466 app_wrk->app_index, app_wrk->api_client_index);
470 if (mq_try_lock_and_alloc_msg (app_mq, msg))
473 evt = svm_msg_q_msg_data (app_mq, msg);
474 clib_memset (evt, 0, sizeof (*evt));
475 evt->event_type = SESSION_CTRL_EVT_BOUND;
476 mp = (session_bound_msg_t *) evt->data;
477 mp->context = api_context;
483 al = app_listener_get_w_handle (handle);
484 if (al->session_index != SESSION_INVALID_INDEX)
485 ls = app_listener_get_session (al);
487 ls = app_listener_get_local_session (al);
488 tc = listen_session_get_transport (ls);
489 mp->lcl_port = tc->lcl_port;
490 mp->lcl_is_ip4 = tc->is_ip4;
491 clib_memcpy_fast (mp->lcl_ip, &tc->lcl_ip, sizeof (tc->lcl_ip));
493 vpp_evt_q = session_main_get_vpp_event_queue (0);
494 mp->vpp_evt_q = pointer_to_uword (vpp_evt_q);
496 if (session_transport_service_type (ls) == TRANSPORT_SERVICE_CL)
498 mp->rx_fifo = pointer_to_uword (ls->rx_fifo);
499 mp->tx_fifo = pointer_to_uword (ls->tx_fifo);
504 svm_msg_q_add_and_unlock (app_mq, msg);
508 static session_cb_vft_t session_mq_cb_vft = {
509 .session_accept_callback = mq_send_session_accepted_cb,
510 .session_disconnect_callback = mq_send_session_disconnected_cb,
511 .session_connected_callback = mq_send_session_connected_cb,
512 .session_reset_callback = mq_send_session_reset_cb,
513 .add_segment_callback = send_add_segment_callback,
514 .del_segment_callback = send_del_segment_callback,
518 vl_api_session_enable_disable_t_handler (vl_api_session_enable_disable_t * mp)
520 vl_api_session_enable_disable_reply_t *rmp;
521 vlib_main_t *vm = vlib_get_main ();
524 vnet_session_enable_disable (vm, mp->is_enable);
525 REPLY_MACRO (VL_API_SESSION_ENABLE_DISABLE_REPLY);
529 vl_api_application_attach_t_handler (vl_api_application_attach_t * mp)
531 int rv = 0, fds[SESSION_N_FD_TYPE], n_fds = 0;
532 vl_api_application_attach_reply_t *rmp;
533 ssvm_private_t *segp, *evt_q_segment;
534 vnet_app_attach_args_t _a, *a = &_a;
535 vl_api_registration_t *reg;
538 reg = vl_api_client_index_to_registration (mp->client_index);
542 if (session_main_is_enabled () == 0)
544 rv = VNET_API_ERROR_FEATURE_DISABLED;
548 STATIC_ASSERT (sizeof (u64) * APP_OPTIONS_N_OPTIONS <=
549 sizeof (mp->options),
550 "Out of options, fix api message definition");
552 clib_memset (a, 0, sizeof (*a));
553 a->api_client_index = mp->client_index;
554 a->options = mp->options;
555 a->session_cb_vft = &session_mq_cb_vft;
556 if (mp->namespace_id_len > 64)
558 rv = VNET_API_ERROR_INVALID_VALUE;
562 if (mp->namespace_id_len)
564 vec_validate (a->namespace_id, mp->namespace_id_len - 1);
565 clib_memcpy_fast (a->namespace_id, mp->namespace_id,
566 mp->namespace_id_len);
569 if ((rv = vnet_application_attach (a)))
571 clib_warning ("attach returned: %d", rv);
572 vec_free (a->namespace_id);
575 vec_free (a->namespace_id);
577 /* Send event queues segment */
578 if ((evt_q_segment = session_main_get_evt_q_segment ()))
580 fd_flags |= SESSION_FD_F_VPP_MQ_SEGMENT;
581 fds[n_fds] = evt_q_segment->fd;
584 /* Send fifo segment fd if needed */
585 if (ssvm_type (a->segment) == SSVM_SEGMENT_MEMFD)
587 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
588 fds[n_fds] = a->segment->fd;
591 if (a->options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
593 fd_flags |= SESSION_FD_F_MQ_EVENTFD;
594 fds[n_fds] = svm_msg_q_get_producer_eventfd (a->app_evt_q);
601 REPLY_MACRO2 (VL_API_APPLICATION_ATTACH_REPLY, ({
605 rmp->app_index = clib_host_to_net_u32 (a->app_index);
606 rmp->segment_name_length = 0;
607 rmp->segment_size = segp->ssvm_size;
608 if (vec_len (segp->name))
610 memcpy (rmp->segment_name, segp->name, vec_len (segp->name));
611 rmp->segment_name_length = vec_len (segp->name);
613 rmp->app_event_queue_address = pointer_to_uword (a->app_evt_q);
615 rmp->fd_flags = fd_flags;
616 rmp->segment_handle = clib_host_to_net_u64 (a->segment_handle);
622 session_send_fds (reg, fds, n_fds);
626 vl_api_application_detach_t_handler (vl_api_application_detach_t * mp)
628 vl_api_application_detach_reply_t *rmp;
629 int rv = VNET_API_ERROR_INVALID_VALUE_2;
630 vnet_app_detach_args_t _a, *a = &_a;
633 if (session_main_is_enabled () == 0)
635 rv = VNET_API_ERROR_FEATURE_DISABLED;
639 app = application_lookup (mp->client_index);
642 a->app_index = app->app_index;
643 a->api_client_index = mp->client_index;
644 rv = vnet_application_detach (a);
648 REPLY_MACRO (VL_API_APPLICATION_DETACH_REPLY);
652 vl_api_bind_uri_t_handler (vl_api_bind_uri_t * mp)
654 vl_api_bind_uri_reply_t *rmp;
655 vnet_listen_args_t _a, *a = &_a;
656 application_t *app = 0;
657 app_worker_t *app_wrk;
660 if (session_main_is_enabled () == 0)
662 rv = VNET_API_ERROR_FEATURE_DISABLED;
666 app = application_lookup (mp->client_index);
669 clib_memset (a, 0, sizeof (*a));
670 a->uri = (char *) mp->uri;
671 a->app_index = app->app_index;
672 rv = vnet_bind_uri (a);
676 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
681 REPLY_MACRO (VL_API_BIND_URI_REPLY);
685 app_wrk = application_get_worker (app, 0);
686 mq_send_session_bound_cb (app_wrk->wrk_index, mp->context, a->handle,
692 vl_api_unbind_uri_t_handler (vl_api_unbind_uri_t * mp)
694 vl_api_unbind_uri_reply_t *rmp;
696 vnet_unlisten_args_t _a, *a = &_a;
699 if (session_main_is_enabled () == 0)
701 rv = VNET_API_ERROR_FEATURE_DISABLED;
705 app = application_lookup (mp->client_index);
708 a->uri = (char *) mp->uri;
709 a->app_index = app->app_index;
710 rv = vnet_unbind_uri (a);
714 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
718 REPLY_MACRO (VL_API_UNBIND_URI_REPLY);
722 vl_api_connect_uri_t_handler (vl_api_connect_uri_t * mp)
724 vl_api_connect_uri_reply_t *rmp;
725 vnet_connect_args_t _a, *a = &_a;
729 if (session_main_is_enabled () == 0)
731 rv = VNET_API_ERROR_FEATURE_DISABLED;
735 app = application_lookup (mp->client_index);
738 clib_memset (a, 0, sizeof (*a));
739 a->uri = (char *) mp->uri;
740 a->api_context = mp->context;
741 a->app_index = app->app_index;
742 if ((rv = vnet_connect_uri (a)))
743 clib_warning ("connect_uri returned: %d", rv);
747 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
751 * Don't reply to stream (tcp) connects. The reply will come once
752 * the connection is established. In case of the redirects, the reply
753 * will come from the server app.
759 REPLY_MACRO (VL_API_CONNECT_URI_REPLY);
763 vl_api_disconnect_session_t_handler (vl_api_disconnect_session_t * mp)
765 vl_api_disconnect_session_reply_t *rmp;
766 vnet_disconnect_args_t _a, *a = &_a;
770 if (session_main_is_enabled () == 0)
772 rv = VNET_API_ERROR_FEATURE_DISABLED;
776 app = application_lookup (mp->client_index);
779 a->handle = mp->handle;
780 a->app_index = app->app_index;
781 rv = vnet_disconnect_session (a);
785 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
789 REPLY_MACRO2 (VL_API_DISCONNECT_SESSION_REPLY, rmp->handle = mp->handle);
793 vl_api_disconnect_session_reply_t_handler (vl_api_disconnect_session_reply_t *
796 vnet_disconnect_args_t _a, *a = &_a;
799 /* Client objected to disconnecting the session, log and continue */
802 clib_warning ("client retval %d", mp->retval);
806 /* Disconnect has been confirmed. Confirm close to transport */
807 app = application_lookup (mp->context);
810 a->handle = mp->handle;
811 a->app_index = app->app_index;
812 vnet_disconnect_session (a);
817 vl_api_map_another_segment_reply_t_handler (vl_api_map_another_segment_reply_t
820 clib_warning ("not implemented");
824 vl_api_bind_sock_t_handler (vl_api_bind_sock_t * mp)
826 vnet_listen_args_t _a, *a = &_a;
827 vl_api_bind_sock_reply_t *rmp;
828 application_t *app = 0;
829 app_worker_t *app_wrk;
830 ip46_address_t *ip46;
833 if (session_main_is_enabled () == 0)
835 rv = VNET_API_ERROR_FEATURE_DISABLED;
839 app = application_lookup (mp->client_index);
842 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
846 ip46 = (ip46_address_t *) mp->ip;
847 clib_memset (a, 0, sizeof (*a));
848 a->sep.is_ip4 = mp->is_ip4;
850 a->sep.port = mp->port;
851 a->sep.fib_index = mp->vrf;
852 a->sep.sw_if_index = ENDPOINT_INVALID_INDEX;
853 a->sep.transport_proto = mp->proto;
854 a->app_index = app->app_index;
855 a->wrk_map_index = mp->wrk_index;
857 if ((rv = vnet_listen (a)))
858 clib_warning ("listen returned: %d", rv);
861 /* Actual reply sent only over mq */
862 REPLY_MACRO (VL_API_BIND_SOCK_REPLY);
866 app_wrk = application_get_worker (app, mp->wrk_index);
867 mq_send_session_bound_cb (app_wrk->wrk_index, mp->context, a->handle,
873 vl_api_unbind_sock_t_handler (vl_api_unbind_sock_t * mp)
875 vl_api_unbind_sock_reply_t *rmp;
876 vnet_unlisten_args_t _a, *a = &_a;
877 app_worker_t *app_wrk;
878 application_t *app = 0;
881 if (session_main_is_enabled () == 0)
883 rv = VNET_API_ERROR_FEATURE_DISABLED;
887 app = application_lookup (mp->client_index);
890 a->app_index = app->app_index;
891 a->handle = mp->handle;
892 a->wrk_map_index = mp->wrk_index;
893 if ((rv = vnet_unlisten (a)))
894 clib_warning ("unlisten returned: %d", rv);
898 REPLY_MACRO (VL_API_UNBIND_SOCK_REPLY);
901 * Send reply over msg queue
903 svm_msg_q_msg_t _msg, *msg = &_msg;
904 session_unlisten_reply_msg_t *ump;
906 session_event_t *evt;
911 app_wrk = application_get_worker (app, a->wrk_map_index);
915 app_mq = app_wrk->event_queue;
916 if (mq_try_lock_and_alloc_msg (app_mq, msg))
919 evt = svm_msg_q_msg_data (app_mq, msg);
920 clib_memset (evt, 0, sizeof (*evt));
921 evt->event_type = SESSION_CTRL_EVT_UNLISTEN_REPLY;
922 ump = (session_unlisten_reply_msg_t *) evt->data;
923 ump->context = mp->context;
924 ump->handle = mp->handle;
926 svm_msg_q_add_and_unlock (app_mq, msg);
930 vl_api_connect_sock_t_handler (vl_api_connect_sock_t * mp)
932 vl_api_connect_sock_reply_t *rmp;
933 vnet_connect_args_t _a, *a = &_a;
934 application_t *app = 0;
937 if (session_main_is_enabled () == 0)
939 rv = VNET_API_ERROR_FEATURE_DISABLED;
943 app = application_lookup (mp->client_index);
946 svm_queue_t *client_q;
947 ip46_address_t *ip46 = (ip46_address_t *) mp->ip;
949 clib_memset (a, 0, sizeof (*a));
950 client_q = vl_api_client_index_to_input_queue (mp->client_index);
951 mp->client_queue_address = pointer_to_uword (client_q);
952 a->sep.is_ip4 = mp->is_ip4;
954 a->sep.port = mp->port;
955 a->sep.transport_proto = mp->proto;
956 a->sep.peer.fib_index = mp->vrf;
957 a->sep.peer.sw_if_index = ENDPOINT_INVALID_INDEX;
958 if (mp->hostname_len)
960 vec_validate (a->sep_ext.hostname, mp->hostname_len - 1);
961 clib_memcpy_fast (a->sep_ext.hostname, mp->hostname,
964 a->api_context = mp->context;
965 a->app_index = app->app_index;
966 a->wrk_map_index = mp->wrk_index;
967 if ((rv = vnet_connect (a)))
968 clib_warning ("connect returned: %u", rv);
969 vec_free (a->sep_ext.hostname);
973 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
979 /* Got some error, relay it */
982 REPLY_MACRO (VL_API_CONNECT_SOCK_REPLY);
986 app_worker_t *app_wrk = application_get_worker (app, mp->wrk_index);
987 mq_send_session_connected_cb (app_wrk->wrk_index, mp->context, 0, 1);
992 vl_api_app_worker_add_del_t_handler (vl_api_app_worker_add_del_t * mp)
994 int rv = 0, fds[SESSION_N_FD_TYPE], n_fds = 0;
995 vl_api_app_worker_add_del_reply_t *rmp;
996 vl_api_registration_t *reg;
1000 if (!session_main_is_enabled ())
1002 rv = VNET_API_ERROR_FEATURE_DISABLED;
1006 reg = vl_api_client_index_to_registration (mp->client_index);
1010 app = application_get_if_valid (clib_net_to_host_u32 (mp->app_index));
1013 rv = VNET_API_ERROR_INVALID_VALUE;
1017 vnet_app_worker_add_del_args_t args = {
1018 .app_index = app->app_index,
1019 .wrk_map_index = clib_net_to_host_u32 (mp->wrk_index),
1020 .api_client_index = mp->client_index,
1021 .is_add = mp->is_add
1023 rv = vnet_app_worker_add_del (&args);
1026 clib_warning ("app worker add/del returned: %d", rv);
1033 /* Send fifo segment fd if needed */
1034 if (ssvm_type (args.segment) == SSVM_SEGMENT_MEMFD)
1036 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
1037 fds[n_fds] = args.segment->fd;
1040 if (application_segment_manager_properties (app)->use_mq_eventfd)
1042 fd_flags |= SESSION_FD_F_MQ_EVENTFD;
1043 fds[n_fds] = svm_msg_q_get_producer_eventfd (args.evt_q);
1049 REPLY_MACRO2 (VL_API_APP_WORKER_ADD_DEL_REPLY, ({
1050 rmp->is_add = mp->is_add;
1051 rmp->wrk_index = clib_host_to_net_u32 (args.wrk_map_index);
1052 rmp->segment_handle = clib_host_to_net_u64 (args.segment_handle);
1053 if (!rv && mp->is_add)
1055 if (vec_len (args.segment->name))
1057 memcpy (rmp->segment_name, args.segment->name,
1058 vec_len (args.segment->name));
1059 rmp->segment_name_length = vec_len (args.segment->name);
1061 rmp->app_event_queue_address = pointer_to_uword (args.evt_q);
1063 rmp->fd_flags = fd_flags;
1069 session_send_fds (reg, fds, n_fds);
1073 vl_api_app_namespace_add_del_t_handler (vl_api_app_namespace_add_del_t * mp)
1075 vl_api_app_namespace_add_del_reply_t *rmp;
1076 u32 appns_index = 0;
1079 if (!session_main_is_enabled ())
1081 rv = VNET_API_ERROR_FEATURE_DISABLED;
1085 if (mp->namespace_id_len > ARRAY_LEN (mp->namespace_id))
1087 rv = VNET_API_ERROR_INVALID_VALUE;
1091 vec_validate (ns_id, mp->namespace_id_len - 1);
1092 clib_memcpy_fast (ns_id, mp->namespace_id, mp->namespace_id_len);
1093 vnet_app_namespace_add_del_args_t args = {
1095 .secret = clib_net_to_host_u64 (mp->secret),
1096 .sw_if_index = clib_net_to_host_u32 (mp->sw_if_index),
1097 .ip4_fib_id = clib_net_to_host_u32 (mp->ip4_fib_id),
1098 .ip6_fib_id = clib_net_to_host_u32 (mp->ip6_fib_id),
1101 rv = vnet_app_namespace_add_del (&args);
1104 appns_index = app_namespace_index_from_id (ns_id);
1105 if (appns_index == APP_NAMESPACE_INVALID_INDEX)
1107 clib_warning ("app ns lookup failed");
1108 rv = VNET_API_ERROR_UNSPECIFIED;
1115 REPLY_MACRO2 (VL_API_APP_NAMESPACE_ADD_DEL_REPLY, ({
1117 rmp->appns_index = clib_host_to_net_u32 (appns_index);
1123 vl_api_session_rule_add_del_t_handler (vl_api_session_rule_add_del_t * mp)
1125 vl_api_session_rule_add_del_reply_t *rmp;
1126 session_rule_add_del_args_t args;
1127 session_rule_table_add_del_args_t *table_args = &args.table_args;
1131 clib_memset (&args, 0, sizeof (args));
1132 fib_proto = mp->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
1134 table_args->lcl.fp_len = mp->lcl_plen;
1135 table_args->lcl.fp_proto = fib_proto;
1136 table_args->rmt.fp_len = mp->rmt_plen;
1137 table_args->rmt.fp_proto = fib_proto;
1138 table_args->lcl_port = mp->lcl_port;
1139 table_args->rmt_port = mp->rmt_port;
1140 table_args->action_index = clib_net_to_host_u32 (mp->action_index);
1141 table_args->is_add = mp->is_add;
1142 mp->tag[sizeof (mp->tag) - 1] = 0;
1143 table_args->tag = format (0, "%s", mp->tag);
1144 args.appns_index = clib_net_to_host_u32 (mp->appns_index);
1145 args.scope = mp->scope;
1146 args.transport_proto = mp->transport_proto;
1148 clib_memset (&table_args->lcl.fp_addr, 0, sizeof (table_args->lcl.fp_addr));
1149 clib_memset (&table_args->rmt.fp_addr, 0, sizeof (table_args->rmt.fp_addr));
1150 ip_set (&table_args->lcl.fp_addr, mp->lcl_ip, mp->is_ip4);
1151 ip_set (&table_args->rmt.fp_addr, mp->rmt_ip, mp->is_ip4);
1152 rv = vnet_session_rule_add_del (&args);
1154 clib_warning ("rule add del returned: %d", rv);
1155 vec_free (table_args->tag);
1156 REPLY_MACRO (VL_API_SESSION_RULE_ADD_DEL_REPLY);
1160 send_session_rule_details4 (mma_rule_16_t * rule, u8 is_local,
1161 u8 transport_proto, u32 appns_index, u8 * tag,
1162 vl_api_registration_t * reg, u32 context)
1164 vl_api_session_rules_details_t *rmp = 0;
1165 session_mask_or_match_4_t *match =
1166 (session_mask_or_match_4_t *) & rule->match;
1167 session_mask_or_match_4_t *mask =
1168 (session_mask_or_match_4_t *) & rule->mask;
1170 rmp = vl_msg_api_alloc (sizeof (*rmp));
1171 clib_memset (rmp, 0, sizeof (*rmp));
1172 rmp->_vl_msg_id = ntohs (VL_API_SESSION_RULES_DETAILS);
1173 rmp->context = context;
1176 clib_memcpy_fast (rmp->lcl_ip, &match->lcl_ip, sizeof (match->lcl_ip));
1177 clib_memcpy_fast (rmp->rmt_ip, &match->rmt_ip, sizeof (match->rmt_ip));
1178 rmp->lcl_plen = ip4_mask_to_preflen (&mask->lcl_ip);
1179 rmp->rmt_plen = ip4_mask_to_preflen (&mask->rmt_ip);
1180 rmp->lcl_port = match->lcl_port;
1181 rmp->rmt_port = match->rmt_port;
1182 rmp->action_index = clib_host_to_net_u32 (rule->action_index);
1184 is_local ? SESSION_RULE_SCOPE_LOCAL : SESSION_RULE_SCOPE_GLOBAL;
1185 rmp->transport_proto = transport_proto;
1186 rmp->appns_index = clib_host_to_net_u32 (appns_index);
1189 clib_memcpy_fast (rmp->tag, tag, vec_len (tag));
1190 rmp->tag[vec_len (tag)] = 0;
1193 vl_api_send_msg (reg, (u8 *) rmp);
1197 send_session_rule_details6 (mma_rule_40_t * rule, u8 is_local,
1198 u8 transport_proto, u32 appns_index, u8 * tag,
1199 vl_api_registration_t * reg, u32 context)
1201 vl_api_session_rules_details_t *rmp = 0;
1202 session_mask_or_match_6_t *match =
1203 (session_mask_or_match_6_t *) & rule->match;
1204 session_mask_or_match_6_t *mask =
1205 (session_mask_or_match_6_t *) & rule->mask;
1207 rmp = vl_msg_api_alloc (sizeof (*rmp));
1208 clib_memset (rmp, 0, sizeof (*rmp));
1209 rmp->_vl_msg_id = ntohs (VL_API_SESSION_RULES_DETAILS);
1210 rmp->context = context;
1213 clib_memcpy_fast (rmp->lcl_ip, &match->lcl_ip, sizeof (match->lcl_ip));
1214 clib_memcpy_fast (rmp->rmt_ip, &match->rmt_ip, sizeof (match->rmt_ip));
1215 rmp->lcl_plen = ip6_mask_to_preflen (&mask->lcl_ip);
1216 rmp->rmt_plen = ip6_mask_to_preflen (&mask->rmt_ip);
1217 rmp->lcl_port = match->lcl_port;
1218 rmp->rmt_port = match->rmt_port;
1219 rmp->action_index = clib_host_to_net_u32 (rule->action_index);
1221 is_local ? SESSION_RULE_SCOPE_LOCAL : SESSION_RULE_SCOPE_GLOBAL;
1222 rmp->transport_proto = transport_proto;
1223 rmp->appns_index = clib_host_to_net_u32 (appns_index);
1226 clib_memcpy_fast (rmp->tag, tag, vec_len (tag));
1227 rmp->tag[vec_len (tag)] = 0;
1230 vl_api_send_msg (reg, (u8 *) rmp);
1234 send_session_rules_table_details (session_rules_table_t * srt, u8 fib_proto,
1235 u8 tp, u8 is_local, u32 appns_index,
1236 vl_api_registration_t * reg, u32 context)
1238 mma_rule_16_t *rule16;
1239 mma_rule_40_t *rule40;
1240 mma_rules_table_16_t *srt16;
1241 mma_rules_table_40_t *srt40;
1244 if (is_local || fib_proto == FIB_PROTOCOL_IP4)
1248 srt16 = &srt->session_rules_tables_16;
1249 pool_foreach (rule16, srt16->rules, ({
1250 ri = mma_rules_table_rule_index_16 (srt16, rule16);
1251 tag = session_rules_table_rule_tag (srt, ri, 1);
1252 send_session_rule_details4 (rule16, is_local, tp, appns_index, tag,
1257 if (is_local || fib_proto == FIB_PROTOCOL_IP6)
1261 srt40 = &srt->session_rules_tables_40;
1262 pool_foreach (rule40, srt40->rules, ({
1263 ri = mma_rules_table_rule_index_40 (srt40, rule40);
1264 tag = session_rules_table_rule_tag (srt, ri, 1);
1265 send_session_rule_details6 (rule40, is_local, tp, appns_index, tag,
1273 vl_api_session_rules_dump_t_handler (vl_api_one_map_server_dump_t * mp)
1275 vl_api_registration_t *reg;
1276 session_table_t *st;
1279 reg = vl_api_client_index_to_registration (mp->client_index);
1284 session_table_foreach (st, ({
1285 for (tp = 0; tp < TRANSPORT_N_PROTO; tp++)
1287 send_session_rules_table_details (&st->session_rules[tp],
1288 st->active_fib_proto, tp,
1289 st->is_local, st->appns_index, reg,
1297 vl_api_application_tls_cert_add_t_handler (vl_api_application_tls_cert_add_t *
1300 vl_api_app_namespace_add_del_reply_t *rmp;
1301 vnet_app_add_tls_cert_args_t _a, *a = &_a;
1302 clib_error_t *error;
1306 if (!session_main_is_enabled ())
1308 rv = VNET_API_ERROR_FEATURE_DISABLED;
1311 if (!(app = application_lookup (mp->client_index)))
1313 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
1316 clib_memset (a, 0, sizeof (*a));
1317 a->app_index = app->app_index;
1318 cert_len = clib_net_to_host_u16 (mp->cert_len);
1319 if (cert_len > 10000)
1321 rv = VNET_API_ERROR_INVALID_VALUE;
1324 vec_validate (a->cert, cert_len);
1325 clib_memcpy_fast (a->cert, mp->cert, cert_len);
1326 if ((error = vnet_app_add_tls_cert (a)))
1328 rv = clib_error_get_code (error);
1329 clib_error_report (error);
1333 REPLY_MACRO (VL_API_APPLICATION_TLS_CERT_ADD_REPLY);
1337 vl_api_application_tls_key_add_t_handler (vl_api_application_tls_key_add_t *
1340 vl_api_app_namespace_add_del_reply_t *rmp;
1341 vnet_app_add_tls_key_args_t _a, *a = &_a;
1342 clib_error_t *error;
1346 if (!session_main_is_enabled ())
1348 rv = VNET_API_ERROR_FEATURE_DISABLED;
1351 if (!(app = application_lookup (mp->client_index)))
1353 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
1356 clib_memset (a, 0, sizeof (*a));
1357 a->app_index = app->app_index;
1358 key_len = clib_net_to_host_u16 (mp->key_len);
1359 if (key_len > 10000)
1361 rv = VNET_API_ERROR_INVALID_VALUE;
1364 vec_validate (a->key, key_len);
1365 clib_memcpy_fast (a->key, mp->key, key_len);
1366 if ((error = vnet_app_add_tls_key (a)))
1368 rv = clib_error_get_code (error);
1369 clib_error_report (error);
1373 REPLY_MACRO (VL_API_APPLICATION_TLS_KEY_ADD_REPLY);
1376 static clib_error_t *
1377 application_reaper_cb (u32 client_index)
1379 application_t *app = application_lookup (client_index);
1380 vnet_app_detach_args_t _a, *a = &_a;
1383 a->app_index = app->app_index;
1384 a->api_client_index = client_index;
1385 vnet_application_detach (a);
1390 VL_MSG_API_REAPER_FUNCTION (application_reaper_cb);
1392 #define vl_msg_name_crc_list
1393 #include <vnet/vnet_all_api_h.h>
1394 #undef vl_msg_name_crc_list
1397 setup_message_id_table (api_main_t * am)
1399 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
1400 foreach_vl_msg_name_crc_session;
1405 * session_api_hookup
1406 * Add uri's API message handlers to the table.
1407 * vlib has alread mapped shared memory and
1408 * added the client registration handlers.
1409 * See .../open-repo/vlib/memclnt_vlib.c:memclnt_process()
1411 static clib_error_t *
1412 session_api_hookup (vlib_main_t * vm)
1414 api_main_t *am = &api_main;
1417 vl_msg_api_set_handlers(VL_API_##N, #n, \
1418 vl_api_##n##_t_handler, \
1420 vl_api_##n##_t_endian, \
1421 vl_api_##n##_t_print, \
1422 sizeof(vl_api_##n##_t), 1);
1423 foreach_session_api_msg;
1427 * Messages which bounce off the data-plane to
1428 * an API client. Simply tells the message handling infra not
1429 * to free the message.
1431 * Bounced message handlers MUST NOT block the data plane
1433 am->message_bounce[VL_API_CONNECT_URI] = 1;
1434 am->message_bounce[VL_API_CONNECT_SOCK] = 1;
1437 * Set up the (msg_name, crc, message-id) table
1439 setup_message_id_table (am);
1444 VLIB_API_INIT_FUNCTION (session_api_hookup);
1447 * fd.io coding-style-patch-verification: ON
1450 * eval: (c-set-style "gnu")