2 * Copyright (c) 2015-2019 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 #include <vnet/vnet.h>
17 #include <vlibmemory/api.h>
18 #include <vnet/session/application.h>
19 #include <vnet/session/application_interface.h>
20 #include <vnet/session/application_local.h>
21 #include <vnet/session/session_rules_table.h>
22 #include <vnet/session/session_table.h>
23 #include <vnet/session/session.h>
25 #include <vnet/vnet_msg_enum.h>
27 #define vl_typedefs /* define message structures */
28 #include <vnet/vnet_all_api_h.h>
31 #define vl_endianfun /* define message structures */
32 #include <vnet/vnet_all_api_h.h>
35 /* instantiate all the print functions we know about */
36 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
38 #include <vnet/vnet_all_api_h.h>
41 #include <vlibapi/api_helper_macros.h>
43 #define foreach_session_api_msg \
44 _(MAP_ANOTHER_SEGMENT_REPLY, map_another_segment_reply) \
45 _(APPLICATION_ATTACH, application_attach) \
46 _(APP_ATTACH, app_attach) \
47 _(APPLICATION_DETACH, application_detach) \
48 _(BIND_URI, bind_uri) \
49 _(UNBIND_URI, unbind_uri) \
50 _(CONNECT_URI, connect_uri) \
51 _(DISCONNECT_SESSION, disconnect_session) \
52 _(DISCONNECT_SESSION_REPLY, disconnect_session_reply) \
53 _(BIND_SOCK, bind_sock) \
54 _(UNBIND_SOCK, unbind_sock) \
55 _(CONNECT_SOCK, connect_sock) \
56 _(SESSION_ENABLE_DISABLE, session_enable_disable) \
57 _(APP_NAMESPACE_ADD_DEL, app_namespace_add_del) \
58 _(SESSION_RULE_ADD_DEL, session_rule_add_del) \
59 _(SESSION_RULES_DUMP, session_rules_dump) \
60 _(APPLICATION_TLS_CERT_ADD, application_tls_cert_add) \
61 _(APPLICATION_TLS_KEY_ADD, application_tls_key_add) \
62 _(APP_ADD_CERT_KEY_PAIR, app_add_cert_key_pair) \
63 _(APP_DEL_CERT_KEY_PAIR, app_del_cert_key_pair) \
64 _(APP_WORKER_ADD_DEL, app_worker_add_del) \
67 session_send_fds (vl_api_registration_t * reg, int fds[], int n_fds)
70 if (vl_api_registration_file_index (reg) == VL_API_INVALID_FI)
72 clib_warning ("can't send memfd fd");
75 error = vl_api_send_fd_msg (reg, fds, n_fds);
78 clib_error_report (error);
85 send_add_segment_callback (u32 api_client_index, u64 segment_handle)
87 int fds[SESSION_N_FD_TYPE], n_fds = 0;
88 vl_api_map_another_segment_t *mp;
89 vl_api_registration_t *reg;
94 reg = vl_mem_api_client_index_to_registration (api_client_index);
97 clib_warning ("no api registration for client: %u", api_client_index);
101 fs = segment_manager_get_segment_w_handle (segment_handle);
103 if (ssvm_type (sp) == SSVM_SEGMENT_MEMFD)
105 if (vl_api_registration_file_index (reg) == VL_API_INVALID_FI)
107 clib_warning ("can't send memfd fd");
111 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
116 mp = vl_mem_api_alloc_as_if_client_w_reg (reg, sizeof (*mp));
117 clib_memset (mp, 0, sizeof (*mp));
118 mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_MAP_ANOTHER_SEGMENT);
119 mp->segment_size = sp->ssvm_size;
120 mp->fd_flags = fd_flags;
121 mp->segment_handle = clib_host_to_net_u64 (segment_handle);
122 strncpy ((char *) mp->segment_name, (char *) sp->name,
123 sizeof (mp->segment_name) - 1);
125 vl_msg_api_send_shmem (reg->vl_input_queue, (u8 *) & mp);
128 return session_send_fds (reg, fds, n_fds);
134 send_del_segment_callback (u32 api_client_index, u64 segment_handle)
136 vl_api_unmap_segment_t *mp;
137 vl_api_registration_t *reg;
139 reg = vl_mem_api_client_index_to_registration (api_client_index);
142 clib_warning ("no registration: %u", api_client_index);
146 mp = vl_mem_api_alloc_as_if_client_w_reg (reg, sizeof (*mp));
147 clib_memset (mp, 0, sizeof (*mp));
148 mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_UNMAP_SEGMENT);
149 mp->segment_handle = clib_host_to_net_u64 (segment_handle);
150 vl_msg_api_send_shmem (reg->vl_input_queue, (u8 *) & mp);
156 mq_try_lock_and_alloc_msg (svm_msg_q_t * app_mq, svm_msg_q_msg_t * msg)
162 rv = svm_msg_q_lock_and_alloc_msg_w_ring (app_mq,
163 SESSION_MQ_CTRL_EVT_RING,
170 clib_warning ("failed to alloc msg");
175 mq_send_session_accepted_cb (session_t * s)
177 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
178 svm_msg_q_msg_t _msg, *msg = &_msg;
179 svm_msg_q_t *vpp_queue, *app_mq;
181 session_accepted_msg_t *mp;
182 session_event_t *evt;
185 app = application_get (app_wrk->app_index);
186 app_mq = app_wrk->event_queue;
187 if (mq_try_lock_and_alloc_msg (app_mq, msg))
190 evt = svm_msg_q_msg_data (app_mq, msg);
191 clib_memset (evt, 0, sizeof (*evt));
192 evt->event_type = SESSION_CTRL_EVT_ACCEPTED;
193 mp = (session_accepted_msg_t *) evt->data;
194 clib_memset (mp, 0, sizeof (*mp));
195 mp->context = app->app_index;
196 mp->server_rx_fifo = pointer_to_uword (s->rx_fifo);
197 mp->server_tx_fifo = pointer_to_uword (s->tx_fifo);
198 mp->segment_handle = session_segment_handle (s);
200 if (session_has_transport (s))
202 listener = listen_session_get_from_handle (s->listener_handle);
203 mp->listener_handle = app_listen_session_handle (listener);
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);
216 session_get_endpoint (s, &mp->rmt, 0 /* is_lcl */ );
222 ct = (ct_connection_t *) session_get_transport (s);
223 listener = listen_session_get_from_handle (s->listener_handle);
224 mp->listener_handle = app_listen_session_handle (listener);
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_endpoint_t tep;
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);
424 session_get_endpoint (ls, &tep, 1 /* is_lcl */ );
425 mp->lcl_port = tep.port;
426 mp->lcl_is_ip4 = tep.is_ip4;
427 clib_memcpy_fast (mp->lcl_ip, &tep.ip, sizeof (tep.ip));
429 vpp_evt_q = session_main_get_vpp_event_queue (0);
430 mp->vpp_evt_q = pointer_to_uword (vpp_evt_q);
432 if (session_transport_service_type (ls) == TRANSPORT_SERVICE_CL)
434 mp->rx_fifo = pointer_to_uword (ls->rx_fifo);
435 mp->tx_fifo = pointer_to_uword (ls->tx_fifo);
440 svm_msg_q_add_and_unlock (app_mq, msg);
445 mq_send_unlisten_reply (app_worker_t * app_wrk, session_handle_t sh,
448 svm_msg_q_msg_t _msg, *msg = &_msg;
449 session_unlisten_reply_msg_t *ump;
451 session_event_t *evt;
453 app_mq = app_wrk->event_queue;
454 if (mq_try_lock_and_alloc_msg (app_mq, msg))
457 evt = svm_msg_q_msg_data (app_mq, msg);
458 clib_memset (evt, 0, sizeof (*evt));
459 evt->event_type = SESSION_CTRL_EVT_UNLISTEN_REPLY;
460 ump = (session_unlisten_reply_msg_t *) evt->data;
461 ump->context = context;
464 svm_msg_q_add_and_unlock (app_mq, msg);
468 mq_send_session_migrate_cb (session_t * s, session_handle_t new_sh)
470 clib_warning ("not supported");
473 static session_cb_vft_t session_mq_cb_vft = {
474 .session_accept_callback = mq_send_session_accepted_cb,
475 .session_disconnect_callback = mq_send_session_disconnected_cb,
476 .session_connected_callback = mq_send_session_connected_cb,
477 .session_reset_callback = mq_send_session_reset_cb,
478 .session_migrate_callback = mq_send_session_migrate_cb,
479 .add_segment_callback = send_add_segment_callback,
480 .del_segment_callback = send_del_segment_callback,
484 vl_api_session_enable_disable_t_handler (vl_api_session_enable_disable_t * mp)
486 vl_api_session_enable_disable_reply_t *rmp;
487 vlib_main_t *vm = vlib_get_main ();
490 vnet_session_enable_disable (vm, mp->is_enable);
491 REPLY_MACRO (VL_API_SESSION_ENABLE_DISABLE_REPLY);
494 /* ### WILL BE DEPRECATED POST 20.01 ### */
496 vl_api_application_attach_t_handler (vl_api_application_attach_t * mp)
498 int rv = 0, fds[SESSION_N_FD_TYPE], n_fds = 0;
499 vl_api_application_attach_reply_t *rmp;
500 ssvm_private_t *segp, *evt_q_segment;
501 vnet_app_attach_args_t _a, *a = &_a;
502 vl_api_registration_t *reg;
505 reg = vl_api_client_index_to_registration (mp->client_index);
509 if (session_main_is_enabled () == 0)
511 rv = VNET_API_ERROR_FEATURE_DISABLED;
515 STATIC_ASSERT (sizeof (u64) * APP_OPTIONS_N_OPTIONS <=
516 sizeof (mp->options),
517 "Out of options, fix api message definition");
519 clib_memset (a, 0, sizeof (*a));
520 a->api_client_index = mp->client_index;
521 a->options = mp->options;
522 a->session_cb_vft = &session_mq_cb_vft;
523 if (mp->namespace_id_len > 64)
525 rv = VNET_API_ERROR_INVALID_VALUE;
529 if (mp->namespace_id_len)
531 vec_validate (a->namespace_id, mp->namespace_id_len - 1);
532 clib_memcpy_fast (a->namespace_id, mp->namespace_id,
533 mp->namespace_id_len);
536 if ((rv = vnet_application_attach (a)))
538 clib_warning ("attach returned: %d", rv);
539 vec_free (a->namespace_id);
542 vec_free (a->namespace_id);
544 /* Send event queues segment */
545 if ((evt_q_segment = session_main_get_evt_q_segment ()))
547 fd_flags |= SESSION_FD_F_VPP_MQ_SEGMENT;
548 fds[n_fds] = evt_q_segment->fd;
551 /* Send fifo segment fd if needed */
552 if (ssvm_type (a->segment) == SSVM_SEGMENT_MEMFD)
554 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
555 fds[n_fds] = a->segment->fd;
558 if (a->options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
560 fd_flags |= SESSION_FD_F_MQ_EVENTFD;
561 fds[n_fds] = svm_msg_q_get_producer_eventfd (a->app_evt_q);
568 REPLY_MACRO2 (VL_API_APPLICATION_ATTACH_REPLY, ({
572 rmp->app_index = clib_host_to_net_u32 (a->app_index);
573 rmp->segment_name_length = 0;
574 rmp->segment_size = segp->ssvm_size;
575 if (vec_len (segp->name))
577 memcpy (rmp->segment_name, segp->name, vec_len (segp->name));
578 rmp->segment_name_length = vec_len (segp->name);
580 rmp->app_event_queue_address = pointer_to_uword (a->app_evt_q);
582 rmp->fd_flags = fd_flags;
583 rmp->segment_handle = clib_host_to_net_u64 (a->segment_handle);
589 session_send_fds (reg, fds, n_fds);
593 vl_api_app_attach_t_handler (vl_api_app_attach_t * mp)
595 int rv = 0, fds[SESSION_N_FD_TYPE], n_fds = 0;
596 vl_api_app_attach_reply_t *rmp;
597 ssvm_private_t *segp, *evt_q_segment;
598 vnet_app_attach_args_t _a, *a = &_a;
599 u8 fd_flags = 0, ctrl_thread;
600 vl_api_registration_t *reg;
601 svm_msg_q_t *ctrl_mq;
603 reg = vl_api_client_index_to_registration (mp->client_index);
607 if (session_main_is_enabled () == 0)
609 rv = VNET_API_ERROR_FEATURE_DISABLED;
613 STATIC_ASSERT (sizeof (u64) * APP_OPTIONS_N_OPTIONS <=
614 sizeof (mp->options),
615 "Out of options, fix api message definition");
617 clib_memset (a, 0, sizeof (*a));
618 a->api_client_index = mp->client_index;
619 a->options = mp->options;
620 a->session_cb_vft = &session_mq_cb_vft;
621 if (mp->namespace_id_len > 64)
623 rv = VNET_API_ERROR_INVALID_VALUE;
627 if (mp->namespace_id_len)
629 vec_validate (a->namespace_id, mp->namespace_id_len - 1);
630 clib_memcpy_fast (a->namespace_id, mp->namespace_id,
631 mp->namespace_id_len);
634 if ((rv = vnet_application_attach (a)))
636 clib_warning ("attach returned: %d", rv);
637 vec_free (a->namespace_id);
640 vec_free (a->namespace_id);
642 /* Send event queues segment */
643 if ((evt_q_segment = session_main_get_evt_q_segment ()))
645 fd_flags |= SESSION_FD_F_VPP_MQ_SEGMENT;
646 fds[n_fds] = evt_q_segment->fd;
649 /* Send fifo segment fd if needed */
650 if (ssvm_type (a->segment) == SSVM_SEGMENT_MEMFD)
652 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
653 fds[n_fds] = a->segment->fd;
656 if (a->options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
658 fd_flags |= SESSION_FD_F_MQ_EVENTFD;
659 fds[n_fds] = svm_msg_q_get_producer_eventfd (a->app_evt_q);
665 ctrl_thread = vlib_num_workers ()? 1 : 0;
666 ctrl_mq = session_main_get_vpp_event_queue (ctrl_thread);
668 REPLY_MACRO2 (VL_API_APP_ATTACH_REPLY, ({
672 rmp->app_index = clib_host_to_net_u32 (a->app_index);
673 rmp->app_mq = pointer_to_uword (a->app_evt_q);
674 rmp->vpp_ctrl_mq = pointer_to_uword (ctrl_mq);
675 rmp->vpp_ctrl_mq_thread = ctrl_thread;
677 rmp->fd_flags = fd_flags;
678 if (vec_len (segp->name))
680 memcpy (rmp->segment_name, segp->name, vec_len (segp->name));
681 rmp->segment_name_length = vec_len (segp->name);
683 rmp->segment_size = segp->ssvm_size;
684 rmp->segment_handle = clib_host_to_net_u64 (a->segment_handle);
690 session_send_fds (reg, fds, n_fds);
693 /* ### WILL BE DEPRECATED POST 20.01 ### */
695 vl_api_application_detach_t_handler (vl_api_application_detach_t * mp)
697 vl_api_application_detach_reply_t *rmp;
698 int rv = VNET_API_ERROR_INVALID_VALUE_2;
699 vnet_app_detach_args_t _a, *a = &_a;
702 if (session_main_is_enabled () == 0)
704 rv = VNET_API_ERROR_FEATURE_DISABLED;
708 app = application_lookup (mp->client_index);
711 a->app_index = app->app_index;
712 a->api_client_index = mp->client_index;
713 rv = vnet_application_detach (a);
717 REPLY_MACRO (VL_API_APPLICATION_DETACH_REPLY);
720 /* ### WILL BE DEPRECATED POST 20.01 ### */
722 vl_api_bind_uri_t_handler (vl_api_bind_uri_t * mp)
724 vl_api_bind_uri_reply_t *rmp;
725 vnet_listen_args_t _a, *a = &_a;
726 application_t *app = 0;
727 app_worker_t *app_wrk;
730 if (session_main_is_enabled () == 0)
732 rv = VNET_API_ERROR_FEATURE_DISABLED;
736 app = application_lookup (mp->client_index);
739 clib_memset (a, 0, sizeof (*a));
740 a->uri = (char *) mp->uri;
741 a->app_index = app->app_index;
742 rv = vnet_bind_uri (a);
746 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
751 REPLY_MACRO (VL_API_BIND_URI_REPLY);
755 app_wrk = application_get_worker (app, 0);
756 mq_send_session_bound_cb (app_wrk->wrk_index, mp->context, a->handle,
761 /* ### WILL BE DEPRECATED POST 20.01 ### */
763 vl_api_unbind_uri_t_handler (vl_api_unbind_uri_t * mp)
765 vl_api_unbind_uri_reply_t *rmp;
767 vnet_unlisten_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->uri = (char *) mp->uri;
780 a->app_index = app->app_index;
781 a->wrk_map_index = 0;
782 rv = vnet_unbind_uri (a);
786 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
790 REPLY_MACRO (VL_API_UNBIND_URI_REPLY);
793 /* ### WILL BE DEPRECATED POST 20.01 ### */
795 vl_api_connect_uri_t_handler (vl_api_connect_uri_t * mp)
797 vl_api_connect_uri_reply_t *rmp;
798 vnet_connect_args_t _a, *a = &_a;
802 if (session_main_is_enabled () == 0)
804 rv = VNET_API_ERROR_FEATURE_DISABLED;
808 app = application_lookup (mp->client_index);
811 clib_memset (a, 0, sizeof (*a));
812 a->uri = (char *) mp->uri;
813 a->api_context = mp->context;
814 a->app_index = app->app_index;
815 if ((rv = vnet_connect_uri (a)))
816 clib_warning ("connect_uri returned: %d", rv);
820 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
824 * Don't reply to stream (tcp) connects. The reply will come once
825 * the connection is established. In case of the redirects, the reply
826 * will come from the server app.
832 REPLY_MACRO (VL_API_CONNECT_URI_REPLY);
835 /* ### WILL BE DEPRECATED POST 20.01 ### */
837 vl_api_disconnect_session_t_handler (vl_api_disconnect_session_t * mp)
839 vl_api_disconnect_session_reply_t *rmp;
840 vnet_disconnect_args_t _a, *a = &_a;
844 if (session_main_is_enabled () == 0)
846 rv = VNET_API_ERROR_FEATURE_DISABLED;
850 app = application_lookup (mp->client_index);
853 a->handle = mp->handle;
854 a->app_index = app->app_index;
855 rv = vnet_disconnect_session (a);
859 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
863 REPLY_MACRO2 (VL_API_DISCONNECT_SESSION_REPLY, rmp->handle = mp->handle);
866 /* ### WILL BE DEPRECATED POST 20.01 ### */
868 vl_api_disconnect_session_reply_t_handler (vl_api_disconnect_session_reply_t *
871 vnet_disconnect_args_t _a, *a = &_a;
874 /* Client objected to disconnecting the session, log and continue */
877 clib_warning ("client retval %d", mp->retval);
881 /* Disconnect has been confirmed. Confirm close to transport */
882 app = application_lookup (mp->context);
885 a->handle = mp->handle;
886 a->app_index = app->app_index;
887 vnet_disconnect_session (a);
892 vl_api_map_another_segment_reply_t_handler (vl_api_map_another_segment_reply_t
895 clib_warning ("not implemented");
898 /* ### WILL BE DEPRECATED POST 20.01 ### */
900 vl_api_bind_sock_t_handler (vl_api_bind_sock_t * mp)
902 vnet_listen_args_t _a, *a = &_a;
903 vl_api_bind_sock_reply_t *rmp;
904 application_t *app = 0;
905 app_worker_t *app_wrk;
906 ip46_address_t *ip46;
909 if (session_main_is_enabled () == 0)
911 rv = VNET_API_ERROR_FEATURE_DISABLED;
915 app = application_lookup (mp->client_index);
918 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
922 ip46 = (ip46_address_t *) mp->ip;
923 clib_memset (a, 0, sizeof (*a));
924 a->sep.is_ip4 = mp->is_ip4;
926 a->sep.port = mp->port;
927 a->sep.fib_index = mp->vrf;
928 a->sep.sw_if_index = ENDPOINT_INVALID_INDEX;
929 a->sep.transport_proto = mp->proto;
930 a->app_index = app->app_index;
931 a->wrk_map_index = mp->wrk_index;
933 if ((rv = vnet_listen (a)))
934 clib_warning ("listen returned: %d", rv);
937 /* Actual reply sent only over mq */
938 REPLY_MACRO (VL_API_BIND_SOCK_REPLY);
942 app_wrk = application_get_worker (app, mp->wrk_index);
943 mq_send_session_bound_cb (app_wrk->wrk_index, mp->context, a->handle,
948 /* ### WILL BE DEPRECATED POST 20.01 ### */
950 vl_api_unbind_sock_t_handler (vl_api_unbind_sock_t * mp)
952 vl_api_unbind_sock_reply_t *rmp;
953 vnet_unlisten_args_t _a, *a = &_a;
954 app_worker_t *app_wrk;
955 application_t *app = 0;
958 if (session_main_is_enabled () == 0)
960 rv = VNET_API_ERROR_FEATURE_DISABLED;
964 app = application_lookup (mp->client_index);
967 a->app_index = app->app_index;
968 a->handle = mp->handle;
969 a->wrk_map_index = mp->wrk_index;
970 if ((rv = vnet_unlisten (a)))
971 clib_warning ("unlisten returned: %d", rv);
975 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
979 REPLY_MACRO (VL_API_UNBIND_SOCK_REPLY);
984 app_wrk = application_get_worker (app, a->wrk_map_index);
988 mq_send_unlisten_reply (app_wrk, mp->handle, mp->context, rv);
991 /* ### WILL BE DEPRECATED POST 20.01 ### */
993 vl_api_connect_sock_t_handler (vl_api_connect_sock_t * mp)
995 vl_api_connect_sock_reply_t *rmp;
996 vnet_connect_args_t _a, *a = &_a;
997 application_t *app = 0;
1000 if (session_main_is_enabled () == 0)
1002 rv = VNET_API_ERROR_FEATURE_DISABLED;
1006 app = application_lookup (mp->client_index);
1009 svm_queue_t *client_q;
1010 ip46_address_t *ip46 = (ip46_address_t *) mp->ip;
1012 clib_memset (a, 0, sizeof (*a));
1013 client_q = vl_api_client_index_to_input_queue (mp->client_index);
1014 mp->client_queue_address = pointer_to_uword (client_q);
1015 a->sep.is_ip4 = mp->is_ip4;
1017 a->sep.port = mp->port;
1018 a->sep.transport_proto = mp->proto;
1019 a->sep.peer.fib_index = mp->vrf;
1020 a->sep.peer.sw_if_index = ENDPOINT_INVALID_INDEX;
1021 a->sep_ext.parent_handle = mp->parent_handle;
1022 if (mp->hostname_len)
1024 vec_validate (a->sep_ext.hostname, mp->hostname_len - 1);
1025 clib_memcpy_fast (a->sep_ext.hostname, mp->hostname,
1028 a->api_context = mp->context;
1029 a->app_index = app->app_index;
1030 a->wrk_map_index = mp->wrk_index;
1031 if ((rv = vnet_connect (a)))
1032 clib_warning ("connect returned: %U", format_vnet_api_errno, rv);
1033 vec_free (a->sep_ext.hostname);
1037 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
1043 /* Got some error, relay it */
1046 REPLY_MACRO (VL_API_CONNECT_SOCK_REPLY);
1050 app_worker_t *app_wrk = application_get_worker (app, mp->wrk_index);
1051 mq_send_session_connected_cb (app_wrk->wrk_index, mp->context, 0, 1);
1056 vl_api_app_worker_add_del_t_handler (vl_api_app_worker_add_del_t * mp)
1058 int rv = 0, fds[SESSION_N_FD_TYPE], n_fds = 0;
1059 vl_api_app_worker_add_del_reply_t *rmp;
1060 vl_api_registration_t *reg;
1064 if (session_main_is_enabled () == 0)
1066 rv = VNET_API_ERROR_FEATURE_DISABLED;
1070 reg = vl_api_client_index_to_registration (mp->client_index);
1074 app = application_get_if_valid (clib_net_to_host_u32 (mp->app_index));
1077 rv = VNET_API_ERROR_INVALID_VALUE;
1081 vnet_app_worker_add_del_args_t args = {
1082 .app_index = app->app_index,
1083 .wrk_map_index = clib_net_to_host_u32 (mp->wrk_index),
1084 .api_client_index = mp->client_index,
1085 .is_add = mp->is_add
1087 rv = vnet_app_worker_add_del (&args);
1090 clib_warning ("app worker add/del returned: %d", rv);
1097 /* Send fifo segment fd if needed */
1098 if (ssvm_type (args.segment) == SSVM_SEGMENT_MEMFD)
1100 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
1101 fds[n_fds] = args.segment->fd;
1104 if (application_segment_manager_properties (app)->use_mq_eventfd)
1106 fd_flags |= SESSION_FD_F_MQ_EVENTFD;
1107 fds[n_fds] = svm_msg_q_get_producer_eventfd (args.evt_q);
1113 REPLY_MACRO2 (VL_API_APP_WORKER_ADD_DEL_REPLY, ({
1114 rmp->is_add = mp->is_add;
1115 rmp->wrk_index = clib_host_to_net_u32 (args.wrk_map_index);
1116 rmp->segment_handle = clib_host_to_net_u64 (args.segment_handle);
1117 if (!rv && mp->is_add)
1119 if (vec_len (args.segment->name))
1121 memcpy (rmp->segment_name, args.segment->name,
1122 vec_len (args.segment->name));
1123 rmp->segment_name_length = vec_len (args.segment->name);
1125 rmp->app_event_queue_address = pointer_to_uword (args.evt_q);
1127 rmp->fd_flags = fd_flags;
1133 session_send_fds (reg, fds, n_fds);
1137 vl_api_app_namespace_add_del_t_handler (vl_api_app_namespace_add_del_t * mp)
1139 vl_api_app_namespace_add_del_reply_t *rmp;
1140 u32 appns_index = 0;
1143 if (session_main_is_enabled () == 0)
1145 rv = VNET_API_ERROR_FEATURE_DISABLED;
1149 if (mp->namespace_id_len > ARRAY_LEN (mp->namespace_id))
1151 rv = VNET_API_ERROR_INVALID_VALUE;
1155 vec_validate (ns_id, mp->namespace_id_len - 1);
1156 clib_memcpy_fast (ns_id, mp->namespace_id, mp->namespace_id_len);
1157 vnet_app_namespace_add_del_args_t args = {
1159 .secret = clib_net_to_host_u64 (mp->secret),
1160 .sw_if_index = clib_net_to_host_u32 (mp->sw_if_index),
1161 .ip4_fib_id = clib_net_to_host_u32 (mp->ip4_fib_id),
1162 .ip6_fib_id = clib_net_to_host_u32 (mp->ip6_fib_id),
1165 rv = vnet_app_namespace_add_del (&args);
1168 appns_index = app_namespace_index_from_id (ns_id);
1169 if (appns_index == APP_NAMESPACE_INVALID_INDEX)
1171 clib_warning ("app ns lookup failed");
1172 rv = VNET_API_ERROR_UNSPECIFIED;
1179 REPLY_MACRO2 (VL_API_APP_NAMESPACE_ADD_DEL_REPLY, ({
1181 rmp->appns_index = clib_host_to_net_u32 (appns_index);
1187 vl_api_session_rule_add_del_t_handler (vl_api_session_rule_add_del_t * mp)
1189 vl_api_session_rule_add_del_reply_t *rmp;
1190 session_rule_add_del_args_t args;
1191 session_rule_table_add_del_args_t *table_args = &args.table_args;
1195 clib_memset (&args, 0, sizeof (args));
1196 fib_proto = mp->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
1198 table_args->lcl.fp_len = mp->lcl_plen;
1199 table_args->lcl.fp_proto = fib_proto;
1200 table_args->rmt.fp_len = mp->rmt_plen;
1201 table_args->rmt.fp_proto = fib_proto;
1202 table_args->lcl_port = mp->lcl_port;
1203 table_args->rmt_port = mp->rmt_port;
1204 table_args->action_index = clib_net_to_host_u32 (mp->action_index);
1205 table_args->is_add = mp->is_add;
1206 mp->tag[sizeof (mp->tag) - 1] = 0;
1207 table_args->tag = format (0, "%s", mp->tag);
1208 args.appns_index = clib_net_to_host_u32 (mp->appns_index);
1209 args.scope = mp->scope;
1210 args.transport_proto = mp->transport_proto;
1212 clib_memset (&table_args->lcl.fp_addr, 0, sizeof (table_args->lcl.fp_addr));
1213 clib_memset (&table_args->rmt.fp_addr, 0, sizeof (table_args->rmt.fp_addr));
1214 ip_set (&table_args->lcl.fp_addr, mp->lcl_ip, mp->is_ip4);
1215 ip_set (&table_args->rmt.fp_addr, mp->rmt_ip, mp->is_ip4);
1216 rv = vnet_session_rule_add_del (&args);
1218 clib_warning ("rule add del returned: %d", rv);
1219 vec_free (table_args->tag);
1220 REPLY_MACRO (VL_API_SESSION_RULE_ADD_DEL_REPLY);
1224 send_session_rule_details4 (mma_rule_16_t * rule, u8 is_local,
1225 u8 transport_proto, u32 appns_index, u8 * tag,
1226 vl_api_registration_t * reg, u32 context)
1228 vl_api_session_rules_details_t *rmp = 0;
1229 session_mask_or_match_4_t *match =
1230 (session_mask_or_match_4_t *) & rule->match;
1231 session_mask_or_match_4_t *mask =
1232 (session_mask_or_match_4_t *) & rule->mask;
1234 rmp = vl_msg_api_alloc (sizeof (*rmp));
1235 clib_memset (rmp, 0, sizeof (*rmp));
1236 rmp->_vl_msg_id = ntohs (VL_API_SESSION_RULES_DETAILS);
1237 rmp->context = context;
1240 clib_memcpy_fast (rmp->lcl_ip, &match->lcl_ip, sizeof (match->lcl_ip));
1241 clib_memcpy_fast (rmp->rmt_ip, &match->rmt_ip, sizeof (match->rmt_ip));
1242 rmp->lcl_plen = ip4_mask_to_preflen (&mask->lcl_ip);
1243 rmp->rmt_plen = ip4_mask_to_preflen (&mask->rmt_ip);
1244 rmp->lcl_port = match->lcl_port;
1245 rmp->rmt_port = match->rmt_port;
1246 rmp->action_index = clib_host_to_net_u32 (rule->action_index);
1248 is_local ? SESSION_RULE_SCOPE_LOCAL : SESSION_RULE_SCOPE_GLOBAL;
1249 rmp->transport_proto = transport_proto;
1250 rmp->appns_index = clib_host_to_net_u32 (appns_index);
1253 clib_memcpy_fast (rmp->tag, tag, vec_len (tag));
1254 rmp->tag[vec_len (tag)] = 0;
1257 vl_api_send_msg (reg, (u8 *) rmp);
1261 send_session_rule_details6 (mma_rule_40_t * rule, u8 is_local,
1262 u8 transport_proto, u32 appns_index, u8 * tag,
1263 vl_api_registration_t * reg, u32 context)
1265 vl_api_session_rules_details_t *rmp = 0;
1266 session_mask_or_match_6_t *match =
1267 (session_mask_or_match_6_t *) & rule->match;
1268 session_mask_or_match_6_t *mask =
1269 (session_mask_or_match_6_t *) & rule->mask;
1271 rmp = vl_msg_api_alloc (sizeof (*rmp));
1272 clib_memset (rmp, 0, sizeof (*rmp));
1273 rmp->_vl_msg_id = ntohs (VL_API_SESSION_RULES_DETAILS);
1274 rmp->context = context;
1277 clib_memcpy_fast (rmp->lcl_ip, &match->lcl_ip, sizeof (match->lcl_ip));
1278 clib_memcpy_fast (rmp->rmt_ip, &match->rmt_ip, sizeof (match->rmt_ip));
1279 rmp->lcl_plen = ip6_mask_to_preflen (&mask->lcl_ip);
1280 rmp->rmt_plen = ip6_mask_to_preflen (&mask->rmt_ip);
1281 rmp->lcl_port = match->lcl_port;
1282 rmp->rmt_port = match->rmt_port;
1283 rmp->action_index = clib_host_to_net_u32 (rule->action_index);
1285 is_local ? SESSION_RULE_SCOPE_LOCAL : SESSION_RULE_SCOPE_GLOBAL;
1286 rmp->transport_proto = transport_proto;
1287 rmp->appns_index = clib_host_to_net_u32 (appns_index);
1290 clib_memcpy_fast (rmp->tag, tag, vec_len (tag));
1291 rmp->tag[vec_len (tag)] = 0;
1294 vl_api_send_msg (reg, (u8 *) rmp);
1298 send_session_rules_table_details (session_rules_table_t * srt, u8 fib_proto,
1299 u8 tp, u8 is_local, u32 appns_index,
1300 vl_api_registration_t * reg, u32 context)
1302 mma_rule_16_t *rule16;
1303 mma_rule_40_t *rule40;
1304 mma_rules_table_16_t *srt16;
1305 mma_rules_table_40_t *srt40;
1308 if (is_local || fib_proto == FIB_PROTOCOL_IP4)
1312 srt16 = &srt->session_rules_tables_16;
1313 pool_foreach (rule16, srt16->rules, ({
1314 ri = mma_rules_table_rule_index_16 (srt16, rule16);
1315 tag = session_rules_table_rule_tag (srt, ri, 1);
1316 send_session_rule_details4 (rule16, is_local, tp, appns_index, tag,
1321 if (is_local || fib_proto == FIB_PROTOCOL_IP6)
1325 srt40 = &srt->session_rules_tables_40;
1326 pool_foreach (rule40, srt40->rules, ({
1327 ri = mma_rules_table_rule_index_40 (srt40, rule40);
1328 tag = session_rules_table_rule_tag (srt, ri, 1);
1329 send_session_rule_details6 (rule40, is_local, tp, appns_index, tag,
1337 vl_api_session_rules_dump_t_handler (vl_api_one_map_server_dump_t * mp)
1339 vl_api_registration_t *reg;
1340 session_table_t *st;
1343 reg = vl_api_client_index_to_registration (mp->client_index);
1348 session_table_foreach (st, ({
1349 for (tp = 0; tp < TRANSPORT_N_PROTO; tp++)
1351 send_session_rules_table_details (&st->session_rules[tp],
1352 st->active_fib_proto, tp,
1353 st->is_local, st->appns_index, reg,
1361 vl_api_app_add_cert_key_pair_t_handler (vl_api_app_add_cert_key_pair_t * mp)
1363 vl_api_app_add_cert_key_pair_reply_t *rmp;
1364 vnet_app_add_cert_key_pair_args_t _a, *a = &_a;
1365 u32 certkey_len, key_len, cert_len;
1367 if (session_main_is_enabled () == 0)
1369 rv = VNET_API_ERROR_FEATURE_DISABLED;
1373 cert_len = clib_net_to_host_u16 (mp->cert_len);
1374 if (cert_len > 10000)
1376 rv = VNET_API_ERROR_INVALID_VALUE;
1380 certkey_len = clib_net_to_host_u16 (mp->certkey_len);
1381 if (certkey_len < cert_len)
1383 rv = VNET_API_ERROR_INVALID_VALUE;
1387 key_len = certkey_len - cert_len;
1388 if (key_len > 10000)
1390 rv = VNET_API_ERROR_INVALID_VALUE;
1394 clib_memset (a, 0, sizeof (*a));
1395 vec_validate (a->cert, cert_len);
1396 vec_validate (a->key, key_len);
1397 clib_memcpy_fast (a->cert, mp->certkey, cert_len);
1398 clib_memcpy_fast (a->key, mp->certkey + cert_len, key_len);
1399 rv = vnet_app_add_cert_key_pair (a);
1405 REPLY_MACRO2 (VL_API_APP_ADD_CERT_KEY_PAIR_REPLY, ({
1407 rmp->index = a->index;
1413 vl_api_app_del_cert_key_pair_t_handler (vl_api_app_del_cert_key_pair_t * mp)
1415 vl_api_app_del_cert_key_pair_reply_t *rmp;
1417 if (session_main_is_enabled () == 0)
1419 rv = VNET_API_ERROR_FEATURE_DISABLED;
1422 rv = vnet_app_del_cert_key_pair (mp->index);
1425 REPLY_MACRO (VL_API_APP_ADD_CERT_KEY_PAIR_REPLY);
1428 /* ### WILL BE DEPRECATED POST 20.01 ### */
1430 vl_api_application_tls_cert_add_t_handler (vl_api_application_tls_cert_add_t *
1433 vl_api_application_tls_cert_add_reply_t *rmp;
1434 app_cert_key_pair_t *ckpair;
1438 if (session_main_is_enabled () == 0)
1440 rv = VNET_API_ERROR_FEATURE_DISABLED;
1443 if (!(app = application_lookup (mp->client_index)))
1445 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
1448 cert_len = clib_net_to_host_u16 (mp->cert_len);
1449 if (cert_len > 10000)
1451 rv = VNET_API_ERROR_INVALID_VALUE;
1454 ckpair = app_cert_key_pair_get_default ();
1455 vec_validate (ckpair->cert, cert_len);
1456 clib_memcpy_fast (ckpair->cert, mp->cert, cert_len);
1459 REPLY_MACRO (VL_API_APPLICATION_TLS_CERT_ADD_REPLY);
1462 /* ### WILL BE DEPRECATED POST 20.01 ### */
1464 vl_api_application_tls_key_add_t_handler (vl_api_application_tls_key_add_t *
1467 vl_api_application_tls_key_add_reply_t *rmp;
1468 app_cert_key_pair_t *ckpair;
1472 if (session_main_is_enabled () == 0)
1474 rv = VNET_API_ERROR_FEATURE_DISABLED;
1477 if (!(app = application_lookup (mp->client_index)))
1479 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
1482 key_len = clib_net_to_host_u16 (mp->key_len);
1483 if (key_len > 10000)
1485 rv = VNET_API_ERROR_INVALID_VALUE;
1488 ckpair = app_cert_key_pair_get_default ();
1489 vec_validate (ckpair->key, key_len);
1490 clib_memcpy_fast (ckpair->key, mp->key, key_len);
1492 REPLY_MACRO (VL_API_APPLICATION_TLS_KEY_ADD_REPLY);
1495 static clib_error_t *
1496 application_reaper_cb (u32 client_index)
1498 application_t *app = application_lookup (client_index);
1499 vnet_app_detach_args_t _a, *a = &_a;
1502 a->app_index = app->app_index;
1503 a->api_client_index = client_index;
1504 vnet_application_detach (a);
1509 VL_MSG_API_REAPER_FUNCTION (application_reaper_cb);
1511 #define vl_msg_name_crc_list
1512 #include <vnet/vnet_all_api_h.h>
1513 #undef vl_msg_name_crc_list
1516 setup_message_id_table (api_main_t * am)
1518 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
1519 foreach_vl_msg_name_crc_session;
1524 * session_api_hookup
1525 * Add uri's API message handlers to the table.
1526 * vlib has already mapped shared memory and
1527 * added the client registration handlers.
1528 * See .../open-repo/vlib/memclnt_vlib.c:memclnt_process()
1530 static clib_error_t *
1531 session_api_hookup (vlib_main_t * vm)
1533 api_main_t *am = &api_main;
1536 vl_msg_api_set_handlers(VL_API_##N, #n, \
1537 vl_api_##n##_t_handler, \
1539 vl_api_##n##_t_endian, \
1540 vl_api_##n##_t_print, \
1541 sizeof(vl_api_##n##_t), 1);
1542 foreach_session_api_msg;
1546 * Messages which bounce off the data-plane to
1547 * an API client. Simply tells the message handling infra not
1548 * to free the message.
1550 * Bounced message handlers MUST NOT block the data plane
1552 am->message_bounce[VL_API_CONNECT_URI] = 1;
1553 am->message_bounce[VL_API_CONNECT_SOCK] = 1;
1556 * Set up the (msg_name, crc, message-id) table
1558 setup_message_id_table (am);
1563 VLIB_API_INIT_FUNCTION (session_api_hookup);
1566 * fd.io coding-style-patch-verification: ON
1569 * eval: (c-set-style "gnu")