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>
24 #include <vnet/ip/ip_types_api.h>
26 #include <vnet/format_fns.h>
27 #include <vnet/session/session.api_enum.h>
28 #include <vnet/session/session.api_types.h>
30 #define REPLY_MSG_ID_BASE session_main.msg_id_base
31 #include <vlibapi/api_helper_macros.h>
33 static transport_proto_t
34 api_session_transport_proto_decode (const vl_api_transport_proto_t * api_tp)
38 case TRANSPORT_PROTO_API_TCP:
39 return TRANSPORT_PROTO_TCP;
40 case TRANSPORT_PROTO_API_UDP:
41 return TRANSPORT_PROTO_UDP;
42 case TRANSPORT_PROTO_API_TLS:
43 return TRANSPORT_PROTO_TLS;
44 case TRANSPORT_PROTO_API_QUIC:
45 return TRANSPORT_PROTO_QUIC;
47 return TRANSPORT_PROTO_NONE;
51 static vl_api_transport_proto_t
52 api_session_transport_proto_encode (const transport_proto_t tp)
56 case TRANSPORT_PROTO_TCP:
57 return TRANSPORT_PROTO_API_TCP;
58 case TRANSPORT_PROTO_UDP:
59 return TRANSPORT_PROTO_API_UDP;
60 case TRANSPORT_PROTO_TLS:
61 return TRANSPORT_PROTO_API_TLS;
62 case TRANSPORT_PROTO_QUIC:
63 return TRANSPORT_PROTO_API_QUIC;
65 return TRANSPORT_PROTO_API_NONE;
70 session_send_fds (vl_api_registration_t * reg, int fds[], int n_fds)
73 if (vl_api_registration_file_index (reg) == VL_API_INVALID_FI)
74 return SESSION_E_BAPI_NO_FD;
75 error = vl_api_send_fd_msg (reg, fds, n_fds);
78 clib_error_report (error);
79 return SESSION_E_BAPI_SEND_FD;
85 mq_send_session_accepted_cb (session_t * s)
87 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
88 session_accepted_msg_t m = { 0 };
89 fifo_segment_t *eq_seg;
93 app = application_get (app_wrk->app_index);
95 m.context = app->app_index;
96 m.server_rx_fifo = fifo_segment_fifo_offset (s->rx_fifo);
97 m.server_tx_fifo = fifo_segment_fifo_offset (s->tx_fifo);
98 m.segment_handle = session_segment_handle (s);
101 eq_seg = application_get_rx_mqs_segment (app);
103 if (session_has_transport (s))
105 listener = listen_session_get_from_handle (s->listener_handle);
106 m.listener_handle = app_listen_session_handle (listener);
107 if (application_is_proxy (app))
110 app_worker_first_listener (app_wrk, session_get_fib_proto (s),
111 session_get_transport_proto (s));
113 m.listener_handle = listen_session_get_handle (listener);
115 m.vpp_event_queue_address =
116 fifo_segment_msg_q_offset (eq_seg, s->thread_index);
117 m.mq_index = s->thread_index;
118 m.handle = session_handle (s);
120 session_get_endpoint (s, &m.rmt, 0 /* is_lcl */);
121 session_get_endpoint (s, &m.lcl, 1 /* is_lcl */);
127 ct = (ct_connection_t *) session_get_transport (s);
128 listener = listen_session_get_from_handle (s->listener_handle);
129 m.listener_handle = app_listen_session_handle (listener);
130 m.rmt.is_ip4 = session_type_is_ip4 (listener->session_type);
131 m.rmt.port = ct->c_rmt_port;
132 m.lcl.port = ct->c_lcl_port;
133 m.handle = session_handle (s);
134 m.vpp_event_queue_address =
135 fifo_segment_msg_q_offset (eq_seg, s->thread_index);
136 m.mq_index = s->thread_index;
139 if (application_original_dst_is_enabled (app))
141 session_get_original_dst (&m.lcl, &m.rmt,
142 session_get_transport_proto (s),
143 &m.original_dst_ip4, &m.original_dst_port);
146 app_wrk_send_ctrl_evt (app_wrk, SESSION_CTRL_EVT_ACCEPTED, &m, sizeof (m));
152 mq_send_session_close_evt (app_worker_t * app_wrk, session_handle_t sh,
153 session_evt_type_t evt_type)
155 session_disconnected_msg_t m = { 0 };
158 m.context = app_wrk->api_client_index;
160 app_wrk_send_ctrl_evt (app_wrk, evt_type, &m, sizeof (m));
164 mq_notify_close_subscribers (u32 app_index, session_handle_t sh,
165 svm_fifo_t * f, session_evt_type_t evt_type)
167 app_worker_t *app_wrk;
171 app = application_get (app_index);
175 for (i = 0; i < f->shr->n_subscribers; i++)
177 if (!(app_wrk = application_get_worker (app, f->shr->subscribers[i])))
179 mq_send_session_close_evt (app_wrk, sh, SESSION_CTRL_EVT_DISCONNECTED);
184 mq_send_session_disconnected_cb (session_t * s)
186 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
187 session_handle_t sh = session_handle (s);
189 mq_send_session_close_evt (app_wrk, session_handle (s),
190 SESSION_CTRL_EVT_DISCONNECTED);
192 if (svm_fifo_n_subscribers (s->rx_fifo))
193 mq_notify_close_subscribers (app_wrk->app_index, sh, s->rx_fifo,
194 SESSION_CTRL_EVT_DISCONNECTED);
198 mq_send_session_reset_cb (session_t * s)
200 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
201 session_handle_t sh = session_handle (s);
203 mq_send_session_close_evt (app_wrk, sh, SESSION_CTRL_EVT_RESET);
205 if (svm_fifo_n_subscribers (s->rx_fifo))
206 mq_notify_close_subscribers (app_wrk->app_index, sh, s->rx_fifo,
207 SESSION_CTRL_EVT_RESET);
211 mq_send_session_connected_cb (u32 app_wrk_index, u32 api_context,
212 session_t * s, session_error_t err)
214 session_connected_msg_t m = { 0 };
215 transport_connection_t *tc;
216 fifo_segment_t *eq_seg;
217 app_worker_t *app_wrk;
220 app_wrk = app_worker_get (app_wrk_index);
222 m.context = api_context;
228 app = application_get (app_wrk->app_index);
229 eq_seg = application_get_rx_mqs_segment (app);
231 if (session_has_transport (s))
233 tc = session_get_transport (s);
236 clib_warning ("failed to retrieve transport!");
237 m.retval = SESSION_E_REFUSED;
241 m.handle = session_handle (s);
242 m.vpp_event_queue_address =
243 fifo_segment_msg_q_offset (eq_seg, s->thread_index);
245 session_get_endpoint (s, &m.lcl, 1 /* is_lcl */);
247 m.server_rx_fifo = fifo_segment_fifo_offset (s->rx_fifo);
248 m.server_tx_fifo = fifo_segment_fifo_offset (s->tx_fifo);
249 m.segment_handle = session_segment_handle (s);
250 m.mq_index = s->thread_index;
254 ct_connection_t *cct;
257 cct = (ct_connection_t *) session_get_transport (s);
258 m.handle = session_handle (s);
259 m.lcl.port = cct->c_lcl_port;
260 m.lcl.is_ip4 = cct->c_is_ip4;
261 m.vpp_event_queue_address =
262 fifo_segment_msg_q_offset (eq_seg, s->thread_index);
263 m.server_rx_fifo = fifo_segment_fifo_offset (s->rx_fifo);
264 m.server_tx_fifo = fifo_segment_fifo_offset (s->tx_fifo);
265 m.segment_handle = session_segment_handle (s);
266 ss = ct_session_get_peer (s);
267 m.ct_rx_fifo = fifo_segment_fifo_offset (ss->tx_fifo);
268 m.ct_tx_fifo = fifo_segment_fifo_offset (ss->rx_fifo);
269 m.ct_segment_handle = session_segment_handle (ss);
270 m.mq_index = s->thread_index;
273 /* Setup client session index in advance, in case data arrives
274 * before the app processes message and updates it */
275 s->rx_fifo->shr->client_session_index = api_context;
276 s->tx_fifo->shr->client_session_index = api_context;
280 app_wrk_send_ctrl_evt (app_wrk, SESSION_CTRL_EVT_CONNECTED, &m, sizeof (m));
286 mq_send_session_bound_cb (u32 app_wrk_index, u32 api_context,
287 session_handle_t handle, int rv)
289 session_bound_msg_t m = { 0 };
290 transport_endpoint_t tep;
291 fifo_segment_t *eq_seg;
292 app_worker_t *app_wrk;
297 app_wrk = app_worker_get (app_wrk_index);
299 m.context = api_context;
306 al = app_listener_get_w_handle (handle);
307 if (al->session_index != SESSION_INVALID_INDEX)
308 ls = app_listener_get_session (al);
310 ls = app_listener_get_local_session (al);
312 session_get_endpoint (ls, &tep, 1 /* is_lcl */);
313 m.lcl_port = tep.port;
314 m.lcl_is_ip4 = tep.is_ip4;
315 clib_memcpy_fast (m.lcl_ip, &tep.ip, sizeof (tep.ip));
316 app = application_get (app_wrk->app_index);
317 eq_seg = application_get_rx_mqs_segment (app);
318 m.vpp_evt_q = fifo_segment_msg_q_offset (eq_seg, ls->thread_index);
319 m.mq_index = ls->thread_index;
321 if (session_transport_service_type (ls) == TRANSPORT_SERVICE_CL &&
324 m.mq_index = transport_cl_thread ();
325 m.vpp_evt_q = fifo_segment_msg_q_offset (eq_seg, m.mq_index);
326 m.rx_fifo = fifo_segment_fifo_offset (ls->rx_fifo);
327 m.tx_fifo = fifo_segment_fifo_offset (ls->tx_fifo);
328 m.segment_handle = session_segment_handle (ls);
333 app_wrk_send_ctrl_evt (app_wrk, SESSION_CTRL_EVT_BOUND, &m, sizeof (m));
339 mq_send_unlisten_reply (app_worker_t * app_wrk, session_handle_t sh,
342 session_unlisten_reply_msg_t m = { 0 };
347 app_wrk_send_ctrl_evt (app_wrk, SESSION_CTRL_EVT_UNLISTEN_REPLY, &m,
352 mq_send_session_migrate_cb (session_t * s, session_handle_t new_sh)
354 session_migrated_msg_t m = { 0 };
355 fifo_segment_t *eq_seg;
356 app_worker_t *app_wrk;
360 thread_index = session_thread_from_handle (new_sh);
361 app_wrk = app_worker_get (s->app_wrk_index);
362 app = application_get (app_wrk->app_index);
363 eq_seg = application_get_rx_mqs_segment (app);
365 m.handle = session_handle (s);
366 m.new_handle = new_sh;
367 m.vpp_thread_index = thread_index;
368 m.vpp_evt_q = fifo_segment_msg_q_offset (eq_seg, thread_index);
369 m.segment_handle = SESSION_INVALID_HANDLE;
371 app_wrk_send_ctrl_evt (app_wrk, SESSION_CTRL_EVT_MIGRATED, &m, sizeof (m));
375 mq_send_add_segment_cb (u32 app_wrk_index, u64 segment_handle)
377 session_app_add_segment_msg_t m = { 0 };
378 vl_api_registration_t *reg;
379 app_worker_t *app_wrk;
384 app_wrk = app_worker_get (app_wrk_index);
386 reg = vl_mem_api_client_index_to_registration (app_wrk->api_client_index);
389 clib_warning ("no api registration for client: %u",
390 app_wrk->api_client_index);
394 fs = segment_manager_get_segment_w_handle (segment_handle);
396 if (ssvm_type (sp) == SSVM_SEGMENT_MEMFD)
398 if (vl_api_registration_file_index (reg) == VL_API_INVALID_FI)
400 clib_warning ("can't send memfd fd");
404 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
407 m.segment_size = sp->ssvm_size;
408 m.fd_flags = fd_flags;
409 m.segment_handle = segment_handle;
410 strncpy ((char *) m.segment_name, (char *) sp->name,
411 sizeof (m.segment_name) - 1);
413 app_wrk_send_ctrl_evt_fd (app_wrk, SESSION_CTRL_EVT_APP_ADD_SEGMENT, &m,
420 mq_send_del_segment_cb (u32 app_wrk_index, u64 segment_handle)
422 session_app_del_segment_msg_t m = { 0 };
423 vl_api_registration_t *reg;
424 app_worker_t *app_wrk;
426 app_wrk = app_worker_get (app_wrk_index);
427 reg = vl_mem_api_client_index_to_registration (app_wrk->api_client_index);
430 clib_warning ("no registration: %u", app_wrk->api_client_index);
434 m.segment_handle = segment_handle;
436 app_wrk_send_ctrl_evt (app_wrk, SESSION_CTRL_EVT_APP_DEL_SEGMENT, &m,
443 mq_send_session_cleanup_cb (session_t * s, session_cleanup_ntf_t ntf)
445 session_cleanup_msg_t m = { 0 };
446 app_worker_t *app_wrk;
448 /* Propagate transport cleanup notifications only if app didn't close */
449 if (ntf == SESSION_CLEANUP_TRANSPORT
450 && s->session_state != SESSION_STATE_TRANSPORT_DELETED)
453 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
457 m.handle = session_handle (s);
460 app_wrk_send_ctrl_evt (app_wrk, SESSION_CTRL_EVT_CLEANUP, &m, sizeof (m));
464 mq_send_io_rx_event (session_t *s)
466 session_event_t *mq_evt;
467 svm_msg_q_msg_t mq_msg;
468 app_worker_t *app_wrk;
471 if (svm_fifo_has_event (s->rx_fifo))
474 app_wrk = app_worker_get (s->app_wrk_index);
475 mq = app_wrk->event_queue;
477 mq_msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
478 mq_evt = svm_msg_q_msg_data (mq, &mq_msg);
480 mq_evt->event_type = SESSION_IO_EVT_RX;
481 mq_evt->session_index = s->rx_fifo->shr->client_session_index;
483 (void) svm_fifo_set_event (s->rx_fifo);
485 svm_msg_q_add_raw (mq, &mq_msg);
491 mq_send_io_tx_event (session_t *s)
493 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
494 svm_msg_q_t *mq = app_wrk->event_queue;
495 session_event_t *mq_evt;
496 svm_msg_q_msg_t mq_msg;
498 mq_msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
499 mq_evt = svm_msg_q_msg_data (mq, &mq_msg);
501 mq_evt->event_type = SESSION_IO_EVT_TX;
502 mq_evt->session_index = s->tx_fifo->shr->client_session_index;
504 svm_msg_q_add_raw (mq, &mq_msg);
509 static session_cb_vft_t session_mq_cb_vft = {
510 .session_accept_callback = mq_send_session_accepted_cb,
511 .session_disconnect_callback = mq_send_session_disconnected_cb,
512 .session_connected_callback = mq_send_session_connected_cb,
513 .session_reset_callback = mq_send_session_reset_cb,
514 .session_migrate_callback = mq_send_session_migrate_cb,
515 .session_cleanup_callback = mq_send_session_cleanup_cb,
516 .add_segment_callback = mq_send_add_segment_cb,
517 .del_segment_callback = mq_send_del_segment_cb,
518 .builtin_app_rx_callback = mq_send_io_rx_event,
519 .builtin_app_tx_callback = mq_send_io_tx_event,
523 vl_api_session_enable_disable_t_handler (vl_api_session_enable_disable_t * mp)
525 vl_api_session_enable_disable_reply_t *rmp;
526 vlib_main_t *vm = vlib_get_main ();
529 vnet_session_enable_disable (vm, mp->is_enable);
530 REPLY_MACRO (VL_API_SESSION_ENABLE_DISABLE_REPLY);
534 vl_api_session_sapi_enable_disable_t_handler (
535 vl_api_session_sapi_enable_disable_t *mp)
537 vl_api_session_sapi_enable_disable_reply_t *rmp;
540 rv = appns_sapi_enable_disable (mp->is_enable);
541 REPLY_MACRO (VL_API_SESSION_SAPI_ENABLE_DISABLE_REPLY);
545 vl_api_app_attach_t_handler (vl_api_app_attach_t * mp)
547 int rv = 0, *fds = 0, n_fds = 0, n_workers, i;
548 fifo_segment_t *segp, *rx_mqs_seg = 0;
549 vnet_app_attach_args_t _a, *a = &_a;
550 vl_api_app_attach_reply_t *rmp;
551 u8 fd_flags = 0, ctrl_thread;
552 vl_api_registration_t *reg;
556 reg = vl_api_client_index_to_registration (mp->client_index);
560 n_workers = vlib_num_workers ();
561 if (!session_main_is_enabled () || appns_sapi_enabled ())
563 rv = VNET_API_ERROR_FEATURE_DISABLED;
566 /* Only support binary api with socket transport */
567 if (vl_api_registration_file_index (reg) == VL_API_INVALID_FI)
569 rv = VNET_API_ERROR_APP_UNSUPPORTED_CFG;
573 STATIC_ASSERT (sizeof (u64) * APP_OPTIONS_N_OPTIONS <=
574 sizeof (mp->options),
575 "Out of options, fix api message definition");
577 clib_memset (a, 0, sizeof (*a));
578 a->api_client_index = mp->client_index;
579 a->options = mp->options;
580 a->session_cb_vft = &session_mq_cb_vft;
581 a->namespace_id = vl_api_from_api_to_new_vec (mp, &mp->namespace_id);
583 if ((rv = vnet_application_attach (a)))
585 clib_warning ("attach returned: %U", format_session_error, rv);
586 rv = VNET_API_ERROR_UNSPECIFIED;
587 vec_free (a->namespace_id);
590 vec_free (a->namespace_id);
592 vec_validate (fds, 3 /* segs + tx evtfd */ + n_workers);
594 /* Send rx mqs segment */
595 app = application_get (a->app_index);
596 rx_mqs_seg = application_get_rx_mqs_segment (app);
598 fd_flags |= SESSION_FD_F_VPP_MQ_SEGMENT;
599 fds[n_fds] = rx_mqs_seg->ssvm.fd;
602 /* Send fifo segment fd if needed */
603 if (ssvm_type (a->segment) == SSVM_SEGMENT_MEMFD)
605 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
606 fds[n_fds] = a->segment->fd;
609 if (a->options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
611 fd_flags |= SESSION_FD_F_MQ_EVENTFD;
612 fds[n_fds] = svm_msg_q_get_eventfd (a->app_evt_q);
616 if (application_use_private_rx_mqs ())
618 fd_flags |= SESSION_FD_F_VPP_MQ_EVENTFD;
619 for (i = 0; i < n_workers + 1; i++)
621 rx_mq = application_rx_mq_get (app, i);
622 fds[n_fds] = svm_msg_q_get_eventfd (rx_mq);
630 VL_API_APP_ATTACH_REPLY,
631 ((!rv) ? vec_len (((fifo_segment_t *) a->segment)->ssvm.name) : 0), ({
634 ctrl_thread = n_workers ? 1 : 0;
635 segp = (fifo_segment_t *) a->segment;
636 rmp->app_index = clib_host_to_net_u32 (a->app_index);
637 rmp->app_mq = fifo_segment_msg_q_offset (segp, 0);
639 fifo_segment_msg_q_offset (rx_mqs_seg, ctrl_thread);
640 rmp->vpp_ctrl_mq_thread = ctrl_thread;
642 rmp->fd_flags = fd_flags;
643 if (vec_len (segp->ssvm.name))
645 vl_api_vec_to_api_string (segp->ssvm.name, &rmp->segment_name);
647 rmp->segment_size = segp->ssvm.ssvm_size;
648 rmp->segment_handle = clib_host_to_net_u64 (a->segment_handle);
654 session_send_fds (reg, fds, n_fds);
659 vl_api_app_worker_add_del_t_handler (vl_api_app_worker_add_del_t * mp)
661 int rv = 0, fds[SESSION_N_FD_TYPE], n_fds = 0;
662 vl_api_app_worker_add_del_reply_t *rmp;
663 vl_api_registration_t *reg;
667 if (!session_main_is_enabled () || appns_sapi_enabled ())
669 rv = VNET_API_ERROR_FEATURE_DISABLED;
673 reg = vl_api_client_index_to_registration (mp->client_index);
677 app = application_get_if_valid (clib_net_to_host_u32 (mp->app_index));
680 rv = VNET_API_ERROR_INVALID_VALUE;
684 vnet_app_worker_add_del_args_t args = {
685 .app_index = app->app_index,
686 .wrk_map_index = clib_net_to_host_u32 (mp->wrk_index),
687 .api_client_index = mp->client_index,
690 rv = vnet_app_worker_add_del (&args);
693 clib_warning ("app worker add/del returned: %U", format_session_error,
695 rv = VNET_API_ERROR_UNSPECIFIED;
702 /* Send fifo segment fd if needed */
703 if (ssvm_type (args.segment) == SSVM_SEGMENT_MEMFD)
705 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
706 fds[n_fds] = args.segment->fd;
709 if (application_segment_manager_properties (app)->use_mq_eventfd)
711 fd_flags |= SESSION_FD_F_MQ_EVENTFD;
712 fds[n_fds] = svm_msg_q_get_eventfd (args.evt_q);
719 VL_API_APP_WORKER_ADD_DEL_REPLY,
720 ((!rv && mp->is_add) ? vec_len (args.segment->name) : 0), ({
721 rmp->is_add = mp->is_add;
722 rmp->wrk_index = clib_host_to_net_u32 (args.wrk_map_index);
723 rmp->segment_handle = clib_host_to_net_u64 (args.segment_handle);
724 if (!rv && mp->is_add)
726 rmp->app_event_queue_address =
727 fifo_segment_msg_q_offset ((fifo_segment_t *) args.segment, 0);
729 rmp->fd_flags = fd_flags;
730 if (vec_len (args.segment->name))
732 vl_api_vec_to_api_string (args.segment->name,
740 session_send_fds (reg, fds, n_fds);
744 vl_api_application_detach_t_handler (vl_api_application_detach_t * mp)
746 vl_api_application_detach_reply_t *rmp;
747 int rv = VNET_API_ERROR_INVALID_VALUE_2;
748 vnet_app_detach_args_t _a, *a = &_a;
751 if (!session_main_is_enabled () || appns_sapi_enabled ())
753 rv = VNET_API_ERROR_FEATURE_DISABLED;
757 app = application_lookup (mp->client_index);
760 a->app_index = app->app_index;
761 a->api_client_index = mp->client_index;
762 rv = vnet_application_detach (a);
765 clib_warning ("vnet_application_detach: %U", format_session_error,
767 rv = VNET_API_ERROR_UNSPECIFIED;
772 REPLY_MACRO (VL_API_APPLICATION_DETACH_REPLY);
776 vl_api_app_namespace_add_del_t_handler (vl_api_app_namespace_add_del_t * mp)
778 vl_api_app_namespace_add_del_reply_t *rmp;
782 if (session_main_is_enabled () == 0)
784 rv = VNET_API_ERROR_FEATURE_DISABLED;
788 ns_id = vl_api_from_api_to_new_vec (mp, &mp->namespace_id);
790 vnet_app_namespace_add_del_args_t args = {
793 .secret = clib_net_to_host_u64 (mp->secret),
794 .sw_if_index = clib_net_to_host_u32 (mp->sw_if_index),
795 .ip4_fib_id = clib_net_to_host_u32 (mp->ip4_fib_id),
796 .ip6_fib_id = clib_net_to_host_u32 (mp->ip6_fib_id),
799 rv = vnet_app_namespace_add_del (&args);
802 appns_index = app_namespace_index_from_id (ns_id);
803 if (appns_index == APP_NAMESPACE_INVALID_INDEX)
805 clib_warning ("app ns lookup failed");
806 rv = VNET_API_ERROR_UNSPECIFIED;
813 REPLY_MACRO2 (VL_API_APP_NAMESPACE_ADD_DEL_REPLY, ({
815 rmp->appns_index = clib_host_to_net_u32 (appns_index);
821 vl_api_app_namespace_add_del_v2_t_handler (
822 vl_api_app_namespace_add_del_v2_t *mp)
824 vl_api_app_namespace_add_del_v2_reply_t *rmp;
829 if (session_main_is_enabled () == 0)
831 rv = VNET_API_ERROR_FEATURE_DISABLED;
835 mp->namespace_id[sizeof (mp->namespace_id) - 1] = 0;
836 ns_id = format (0, "%s", &mp->namespace_id);
838 vnet_app_namespace_add_del_args_t args = {
841 .secret = clib_net_to_host_u64 (mp->secret),
842 .sw_if_index = clib_net_to_host_u32 (mp->sw_if_index),
843 .ip4_fib_id = clib_net_to_host_u32 (mp->ip4_fib_id),
844 .ip6_fib_id = clib_net_to_host_u32 (mp->ip6_fib_id),
847 rv = vnet_app_namespace_add_del (&args);
850 appns_index = app_namespace_index_from_id (ns_id);
851 if (appns_index == APP_NAMESPACE_INVALID_INDEX)
853 clib_warning ("app ns lookup failed id:%s", ns_id);
854 rv = VNET_API_ERROR_UNSPECIFIED;
860 REPLY_MACRO2 (VL_API_APP_NAMESPACE_ADD_DEL_V2_REPLY, ({
862 rmp->appns_index = clib_host_to_net_u32 (appns_index);
867 vl_api_app_namespace_add_del_v4_t_handler (
868 vl_api_app_namespace_add_del_v4_t *mp)
870 vl_api_app_namespace_add_del_v4_reply_t *rmp;
871 u8 *ns_id = 0, *sock_name = 0;
874 if (session_main_is_enabled () == 0)
876 rv = VNET_API_ERROR_FEATURE_DISABLED;
879 mp->namespace_id[sizeof (mp->namespace_id) - 1] = 0;
880 ns_id = format (0, "%s", &mp->namespace_id);
881 sock_name = vl_api_from_api_to_new_vec (mp, &mp->sock_name);
882 vnet_app_namespace_add_del_args_t args = {
884 .sock_name = sock_name,
885 .secret = clib_net_to_host_u64 (mp->secret),
886 .sw_if_index = clib_net_to_host_u32 (mp->sw_if_index),
887 .ip4_fib_id = clib_net_to_host_u32 (mp->ip4_fib_id),
888 .ip6_fib_id = clib_net_to_host_u32 (mp->ip6_fib_id),
889 .is_add = mp->is_add,
891 rv = vnet_app_namespace_add_del (&args);
892 if (!rv && mp->is_add)
894 appns_index = app_namespace_index_from_id (ns_id);
895 if (appns_index == APP_NAMESPACE_INVALID_INDEX)
897 clib_warning ("app ns lookup failed id:%s", ns_id);
898 rv = VNET_API_ERROR_UNSPECIFIED;
902 vec_free (sock_name);
904 REPLY_MACRO2 (VL_API_APP_NAMESPACE_ADD_DEL_V4_REPLY, ({
906 rmp->appns_index = clib_host_to_net_u32 (appns_index);
911 vl_api_app_namespace_add_del_v3_t_handler (
912 vl_api_app_namespace_add_del_v3_t *mp)
914 vl_api_app_namespace_add_del_v3_reply_t *rmp;
915 u8 *ns_id = 0, *sock_name = 0, *api_sock_name = 0;
918 if (session_main_is_enabled () == 0)
920 rv = VNET_API_ERROR_FEATURE_DISABLED;
923 mp->namespace_id[sizeof (mp->namespace_id) - 1] = 0;
924 ns_id = format (0, "%s", &mp->namespace_id);
925 api_sock_name = vl_api_from_api_to_new_vec (mp, &mp->sock_name);
926 mp->netns[sizeof (mp->netns) - 1] = 0;
927 if (strlen ((char *) mp->netns) != 0)
930 format (0, "abstract:%v,netns_name=%s", api_sock_name, &mp->netns);
934 sock_name = api_sock_name;
935 api_sock_name = 0; // for vec_free
938 vnet_app_namespace_add_del_args_t args = {
940 .sock_name = sock_name,
941 .secret = clib_net_to_host_u64 (mp->secret),
942 .sw_if_index = clib_net_to_host_u32 (mp->sw_if_index),
943 .ip4_fib_id = clib_net_to_host_u32 (mp->ip4_fib_id),
944 .ip6_fib_id = clib_net_to_host_u32 (mp->ip6_fib_id),
945 .is_add = mp->is_add,
947 rv = vnet_app_namespace_add_del (&args);
948 if (!rv && mp->is_add)
950 appns_index = app_namespace_index_from_id (ns_id);
951 if (appns_index == APP_NAMESPACE_INVALID_INDEX)
953 clib_warning ("app ns lookup failed id:%s", ns_id);
954 rv = VNET_API_ERROR_UNSPECIFIED;
958 vec_free (sock_name);
959 vec_free (api_sock_name);
961 REPLY_MACRO2 (VL_API_APP_NAMESPACE_ADD_DEL_V3_REPLY, ({
963 rmp->appns_index = clib_host_to_net_u32 (appns_index);
968 vl_api_session_rule_add_del_t_handler (vl_api_session_rule_add_del_t * mp)
970 vl_api_session_rule_add_del_reply_t *rmp;
971 session_rule_add_del_args_t args;
972 session_rule_table_add_del_args_t *table_args = &args.table_args;
975 clib_memset (&args, 0, sizeof (args));
977 ip_prefix_decode (&mp->lcl, &table_args->lcl);
978 ip_prefix_decode (&mp->rmt, &table_args->rmt);
980 table_args->lcl_port = mp->lcl_port;
981 table_args->rmt_port = mp->rmt_port;
982 table_args->action_index = clib_net_to_host_u32 (mp->action_index);
983 table_args->is_add = mp->is_add;
984 mp->tag[sizeof (mp->tag) - 1] = 0;
985 table_args->tag = format (0, "%s", mp->tag);
986 args.appns_index = clib_net_to_host_u32 (mp->appns_index);
987 args.scope = mp->scope;
988 args.transport_proto =
989 api_session_transport_proto_decode (&mp->transport_proto) ==
990 TRANSPORT_PROTO_UDP ? 1 : 0;
992 rv = vnet_session_rule_add_del (&args);
995 clib_warning ("rule add del returned: %U", format_session_error, rv);
996 rv = VNET_API_ERROR_UNSPECIFIED;
998 vec_free (table_args->tag);
999 REPLY_MACRO (VL_API_SESSION_RULE_ADD_DEL_REPLY);
1003 send_session_rule_details4 (mma_rule_16_t * rule, u8 is_local,
1004 u8 transport_proto, u32 appns_index, u8 * tag,
1005 vl_api_registration_t * reg, u32 context)
1007 vl_api_session_rules_details_t *rmp = 0;
1008 session_mask_or_match_4_t *match =
1009 (session_mask_or_match_4_t *) & rule->match;
1010 session_mask_or_match_4_t *mask =
1011 (session_mask_or_match_4_t *) & rule->mask;
1012 fib_prefix_t lcl, rmt;
1014 rmp = vl_msg_api_alloc (sizeof (*rmp));
1015 clib_memset (rmp, 0, sizeof (*rmp));
1016 rmp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_SESSION_RULES_DETAILS);
1017 rmp->context = context;
1019 clib_memset (&lcl, 0, sizeof (lcl));
1020 clib_memset (&rmt, 0, sizeof (rmt));
1021 ip_set (&lcl.fp_addr, &match->lcl_ip, 1);
1022 ip_set (&rmt.fp_addr, &match->rmt_ip, 1);
1023 lcl.fp_len = ip4_mask_to_preflen (&mask->lcl_ip);
1024 rmt.fp_len = ip4_mask_to_preflen (&mask->rmt_ip);
1026 ip_prefix_encode (&lcl, &rmp->lcl);
1027 ip_prefix_encode (&rmt, &rmp->rmt);
1028 rmp->lcl_port = match->lcl_port;
1029 rmp->rmt_port = match->rmt_port;
1030 rmp->action_index = clib_host_to_net_u32 (rule->action_index);
1032 is_local ? SESSION_RULE_SCOPE_API_LOCAL : SESSION_RULE_SCOPE_API_GLOBAL;
1033 rmp->transport_proto = api_session_transport_proto_encode (transport_proto);
1034 rmp->appns_index = clib_host_to_net_u32 (appns_index);
1037 clib_memcpy_fast (rmp->tag, tag, vec_len (tag));
1038 rmp->tag[vec_len (tag)] = 0;
1041 vl_api_send_msg (reg, (u8 *) rmp);
1045 send_session_rule_details6 (mma_rule_40_t * rule, u8 is_local,
1046 u8 transport_proto, u32 appns_index, u8 * tag,
1047 vl_api_registration_t * reg, u32 context)
1049 vl_api_session_rules_details_t *rmp = 0;
1050 session_mask_or_match_6_t *match =
1051 (session_mask_or_match_6_t *) & rule->match;
1052 session_mask_or_match_6_t *mask =
1053 (session_mask_or_match_6_t *) & rule->mask;
1054 fib_prefix_t lcl, rmt;
1056 rmp = vl_msg_api_alloc (sizeof (*rmp));
1057 clib_memset (rmp, 0, sizeof (*rmp));
1058 rmp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_SESSION_RULES_DETAILS);
1059 rmp->context = context;
1061 clib_memset (&lcl, 0, sizeof (lcl));
1062 clib_memset (&rmt, 0, sizeof (rmt));
1063 ip_set (&lcl.fp_addr, &match->lcl_ip, 0);
1064 ip_set (&rmt.fp_addr, &match->rmt_ip, 0);
1065 lcl.fp_len = ip6_mask_to_preflen (&mask->lcl_ip);
1066 rmt.fp_len = ip6_mask_to_preflen (&mask->rmt_ip);
1068 ip_prefix_encode (&lcl, &rmp->lcl);
1069 ip_prefix_encode (&rmt, &rmp->rmt);
1070 rmp->lcl_port = match->lcl_port;
1071 rmp->rmt_port = match->rmt_port;
1072 rmp->action_index = clib_host_to_net_u32 (rule->action_index);
1074 is_local ? SESSION_RULE_SCOPE_API_LOCAL : SESSION_RULE_SCOPE_API_GLOBAL;
1075 rmp->transport_proto = api_session_transport_proto_encode (transport_proto);
1076 rmp->appns_index = clib_host_to_net_u32 (appns_index);
1079 clib_memcpy_fast (rmp->tag, tag, vec_len (tag));
1080 rmp->tag[vec_len (tag)] = 0;
1083 vl_api_send_msg (reg, (u8 *) rmp);
1087 send_session_rules_table_details (session_rules_table_t * srt, u8 fib_proto,
1088 u8 tp, u8 is_local, u32 appns_index,
1089 vl_api_registration_t * reg, u32 context)
1091 mma_rule_16_t *rule16;
1092 mma_rule_40_t *rule40;
1093 mma_rules_table_16_t *srt16;
1094 mma_rules_table_40_t *srt40;
1097 if (is_local || fib_proto == FIB_PROTOCOL_IP4)
1101 srt16 = &srt->session_rules_tables_16;
1102 pool_foreach (rule16, srt16->rules) {
1103 ri = mma_rules_table_rule_index_16 (srt16, rule16);
1104 tag = session_rules_table_rule_tag (srt, ri, 1);
1105 send_session_rule_details4 (rule16, is_local, tp, appns_index, tag,
1110 if (is_local || fib_proto == FIB_PROTOCOL_IP6)
1114 srt40 = &srt->session_rules_tables_40;
1115 pool_foreach (rule40, srt40->rules) {
1116 ri = mma_rules_table_rule_index_40 (srt40, rule40);
1117 tag = session_rules_table_rule_tag (srt, ri, 1);
1118 send_session_rule_details6 (rule40, is_local, tp, appns_index, tag,
1126 vl_api_session_rules_dump_t_handler (vl_api_session_rules_dump_t * mp)
1128 vl_api_registration_t *reg;
1129 session_table_t *st;
1132 reg = vl_api_client_index_to_registration (mp->client_index);
1137 session_table_foreach (st, ({
1138 for (tp = 0; tp < TRANSPORT_N_PROTOS; tp++)
1140 send_session_rules_table_details (&st->session_rules[tp],
1141 st->active_fib_proto, tp,
1142 st->is_local, st->appns_index, reg,
1150 vl_api_app_add_cert_key_pair_t_handler (vl_api_app_add_cert_key_pair_t * mp)
1152 vl_api_app_add_cert_key_pair_reply_t *rmp;
1153 vnet_app_add_cert_key_pair_args_t _a, *a = &_a;
1154 u32 certkey_len, key_len, cert_len;
1156 if (session_main_is_enabled () == 0)
1158 rv = VNET_API_ERROR_FEATURE_DISABLED;
1162 cert_len = clib_net_to_host_u16 (mp->cert_len);
1163 if (cert_len > 10000)
1165 rv = VNET_API_ERROR_INVALID_VALUE;
1169 certkey_len = clib_net_to_host_u16 (mp->certkey_len);
1170 if (certkey_len < cert_len)
1172 rv = VNET_API_ERROR_INVALID_VALUE;
1176 key_len = certkey_len - cert_len;
1177 if (key_len > 10000)
1179 rv = VNET_API_ERROR_INVALID_VALUE;
1183 clib_memset (a, 0, sizeof (*a));
1184 a->cert = mp->certkey;
1185 a->key = mp->certkey + cert_len;
1186 a->cert_len = cert_len;
1187 a->key_len = key_len;
1188 rv = vnet_app_add_cert_key_pair (a);
1192 REPLY_MACRO2 (VL_API_APP_ADD_CERT_KEY_PAIR_REPLY, ({
1194 rmp->index = clib_host_to_net_u32 (a->index);
1200 vl_api_app_del_cert_key_pair_t_handler (vl_api_app_del_cert_key_pair_t * mp)
1202 vl_api_app_del_cert_key_pair_reply_t *rmp;
1205 if (session_main_is_enabled () == 0)
1207 rv = VNET_API_ERROR_FEATURE_DISABLED;
1210 ckpair_index = clib_net_to_host_u32 (mp->index);
1211 rv = vnet_app_del_cert_key_pair (ckpair_index);
1214 clib_warning ("vnet_app_del_cert_key_pair: %U", format_session_error,
1216 rv = VNET_API_ERROR_UNSPECIFIED;
1220 REPLY_MACRO (VL_API_APP_DEL_CERT_KEY_PAIR_REPLY);
1223 static clib_error_t *
1224 application_reaper_cb (u32 client_index)
1226 application_t *app = application_lookup (client_index);
1227 vnet_app_detach_args_t _a, *a = &_a;
1230 a->app_index = app->app_index;
1231 a->api_client_index = client_index;
1232 vnet_application_detach (a);
1237 VL_MSG_API_REAPER_FUNCTION (application_reaper_cb);
1240 * Socket api functions
1244 mq_send_add_segment_sapi_cb (u32 app_wrk_index, u64 segment_handle)
1246 session_app_add_segment_msg_t m = { 0 };
1247 app_worker_t *app_wrk;
1252 app_wrk = app_worker_get (app_wrk_index);
1254 fs = segment_manager_get_segment_w_handle (segment_handle);
1256 ASSERT (ssvm_type (sp) == SSVM_SEGMENT_MEMFD);
1258 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
1260 m.segment_size = sp->ssvm_size;
1261 m.fd_flags = fd_flags;
1262 m.segment_handle = segment_handle;
1263 strncpy ((char *) m.segment_name, (char *) sp->name,
1264 sizeof (m.segment_name) - 1);
1266 app_wrk_send_ctrl_evt_fd (app_wrk, SESSION_CTRL_EVT_APP_ADD_SEGMENT, &m,
1267 sizeof (m), sp->fd);
1273 mq_send_del_segment_sapi_cb (u32 app_wrk_index, u64 segment_handle)
1275 session_app_del_segment_msg_t m = { 0 };
1276 app_worker_t *app_wrk;
1278 app_wrk = app_worker_get (app_wrk_index);
1280 m.segment_handle = segment_handle;
1282 app_wrk_send_ctrl_evt (app_wrk, SESSION_CTRL_EVT_APP_DEL_SEGMENT, &m,
1288 static session_cb_vft_t session_mq_sapi_cb_vft = {
1289 .session_accept_callback = mq_send_session_accepted_cb,
1290 .session_disconnect_callback = mq_send_session_disconnected_cb,
1291 .session_connected_callback = mq_send_session_connected_cb,
1292 .session_reset_callback = mq_send_session_reset_cb,
1293 .session_migrate_callback = mq_send_session_migrate_cb,
1294 .session_cleanup_callback = mq_send_session_cleanup_cb,
1295 .add_segment_callback = mq_send_add_segment_sapi_cb,
1296 .del_segment_callback = mq_send_del_segment_sapi_cb,
1297 .builtin_app_rx_callback = mq_send_io_rx_event,
1298 .builtin_app_tx_callback = mq_send_io_tx_event,
1302 session_api_attach_handler (app_namespace_t * app_ns, clib_socket_t * cs,
1303 app_sapi_attach_msg_t * mp)
1305 int rv = 0, *fds = 0, n_fds = 0, i, n_workers;
1306 vnet_app_attach_args_t _a, *a = &_a;
1307 app_sapi_attach_reply_msg_t *rmp;
1308 u8 fd_flags = 0, ctrl_thread;
1309 app_ns_api_handle_t *handle;
1310 fifo_segment_t *rx_mqs_seg;
1311 app_sapi_msg_t msg = { 0 };
1312 app_worker_t *app_wrk;
1316 /* Make sure name is null terminated */
1319 clib_memset (a, 0, sizeof (*a));
1320 a->api_client_index = appns_sapi_socket_handle (app_ns, cs);
1321 a->name = format (0, "%s", (char *) mp->name);
1322 a->options = mp->options;
1323 a->session_cb_vft = &session_mq_sapi_cb_vft;
1324 a->use_sock_api = 1;
1325 a->options[APP_OPTIONS_NAMESPACE] = app_namespace_index (app_ns);
1327 if ((rv = vnet_application_attach (a)))
1329 clib_warning ("attach returned: %d", rv);
1333 n_workers = vlib_num_workers ();
1334 vec_validate (fds, 3 /* segs + tx evtfd */ + n_workers);
1336 /* Send event queues segment */
1337 app = application_get (a->app_index);
1338 rx_mqs_seg = application_get_rx_mqs_segment (app);
1340 fd_flags |= SESSION_FD_F_VPP_MQ_SEGMENT;
1341 fds[n_fds] = rx_mqs_seg->ssvm.fd;
1344 /* Send fifo segment fd if needed */
1345 if (ssvm_type (a->segment) == SSVM_SEGMENT_MEMFD)
1347 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
1348 fds[n_fds] = a->segment->fd;
1351 if (a->options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
1353 fd_flags |= SESSION_FD_F_MQ_EVENTFD;
1354 fds[n_fds] = svm_msg_q_get_eventfd (a->app_evt_q);
1358 if (application_use_private_rx_mqs ())
1360 fd_flags |= SESSION_FD_F_VPP_MQ_EVENTFD;
1361 for (i = 0; i < n_workers + 1; i++)
1363 rx_mq = application_rx_mq_get (app, i);
1364 fds[n_fds] = svm_msg_q_get_eventfd (rx_mq);
1371 msg.type = APP_SAPI_MSG_TYPE_ATTACH_REPLY;
1372 rmp = &msg.attach_reply;
1376 ctrl_thread = n_workers ? 1 : 0;
1377 rmp->app_index = a->app_index;
1379 fifo_segment_msg_q_offset ((fifo_segment_t *) a->segment, 0);
1380 rmp->vpp_ctrl_mq = fifo_segment_msg_q_offset (rx_mqs_seg, ctrl_thread);
1381 rmp->vpp_ctrl_mq_thread = ctrl_thread;
1383 rmp->fd_flags = fd_flags;
1384 /* No segment name and size since we only support memfds
1385 * in this configuration */
1386 rmp->segment_handle = a->segment_handle;
1387 rmp->api_client_handle = a->api_client_index;
1389 /* Update app index for socket */
1390 handle = (app_ns_api_handle_t *) & cs->private_data;
1391 app_wrk = application_get_worker (app, 0);
1392 handle->aah_app_wrk_index = app_wrk->wrk_index;
1395 clib_socket_sendmsg (cs, &msg, sizeof (msg), fds, n_fds);
1401 sapi_socket_close_w_handle (u32 api_handle)
1403 app_namespace_t *app_ns = app_namespace_get (api_handle >> 16);
1404 u16 sock_index = api_handle & 0xffff;
1405 app_ns_api_handle_t *handle;
1409 cs = appns_sapi_get_socket (app_ns, sock_index);
1413 handle = (app_ns_api_handle_t *) & cs->private_data;
1414 cf = clib_file_get (&file_main, handle->aah_file_index);
1415 clib_file_del (&file_main, cf);
1417 clib_socket_close (cs);
1418 appns_sapi_free_socket (app_ns, cs);
1422 sapi_add_del_worker_handler (app_namespace_t * app_ns,
1424 app_sapi_worker_add_del_msg_t * mp)
1426 int rv = 0, fds[SESSION_N_FD_TYPE], n_fds = 0;
1427 app_sapi_worker_add_del_reply_msg_t *rmp;
1428 app_ns_api_handle_t *handle;
1429 app_sapi_msg_t msg = { 0 };
1430 app_worker_t *app_wrk;
1431 u32 sapi_handle = -1;
1435 app = application_get_if_valid (mp->app_index);
1438 rv = SESSION_E_INVALID;
1442 sapi_handle = appns_sapi_socket_handle (app_ns, cs);
1444 vnet_app_worker_add_del_args_t args = {
1445 .app_index = app->app_index,
1446 .wrk_map_index = mp->wrk_index,
1447 .api_client_index = sapi_handle,
1448 .is_add = mp->is_add
1450 rv = vnet_app_worker_add_del (&args);
1453 clib_warning ("app worker add/del returned: %U", format_session_error,
1461 /* Send fifo segment fd if needed */
1462 if (ssvm_type (args.segment) == SSVM_SEGMENT_MEMFD)
1464 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
1465 fds[n_fds] = args.segment->fd;
1468 if (application_segment_manager_properties (app)->use_mq_eventfd)
1470 fd_flags |= SESSION_FD_F_MQ_EVENTFD;
1471 fds[n_fds] = svm_msg_q_get_eventfd (args.evt_q);
1477 msg.type = APP_SAPI_MSG_TYPE_ADD_DEL_WORKER_REPLY;
1478 rmp = &msg.worker_add_del_reply;
1480 rmp->is_add = mp->is_add;
1481 rmp->api_client_handle = sapi_handle;
1482 rmp->wrk_index = args.wrk_map_index;
1483 rmp->segment_handle = args.segment_handle;
1484 if (!rv && mp->is_add)
1486 /* No segment name and size. This supports only memfds */
1487 rmp->app_event_queue_address =
1488 fifo_segment_msg_q_offset ((fifo_segment_t *) args.segment, 0);
1490 rmp->fd_flags = fd_flags;
1492 /* Update app index for socket */
1493 handle = (app_ns_api_handle_t *) & cs->private_data;
1494 app_wrk = application_get_worker (app, args.wrk_map_index);
1495 handle->aah_app_wrk_index = app_wrk->wrk_index;
1498 clib_socket_sendmsg (cs, &msg, sizeof (msg), fds, n_fds);
1501 /* This is a workaround for the case when session layer starts reading
1502 * the socket before the client actualy sends the data
1504 static clib_error_t *
1505 sapi_socket_receive_wait (clib_socket_t *cs, u8 *msg, u32 msg_len)
1512 err = clib_socket_recvmsg (cs, msg, msg_len, 0, 0);
1527 sapi_add_del_cert_key_handler (app_namespace_t *app_ns, clib_socket_t *cs,
1528 app_sapi_cert_key_add_del_msg_t *mp)
1530 vnet_app_add_cert_key_pair_args_t _a, *a = &_a;
1531 app_sapi_cert_key_add_del_reply_msg_t *rmp;
1532 app_sapi_msg_t msg = { 0 };
1537 const u32 max_certkey_len = 2e4, max_cert_len = 1e4, max_key_len = 1e4;
1542 if (mp->certkey_len > max_certkey_len)
1544 rv = SESSION_E_INVALID;
1548 vec_validate (certkey, mp->certkey_len - 1);
1550 err = sapi_socket_receive_wait (cs, certkey, mp->certkey_len);
1553 clib_error_report (err);
1554 rv = SESSION_E_INVALID;
1558 if (mp->cert_len > max_cert_len)
1560 rv = SESSION_E_INVALID;
1564 if (mp->certkey_len < mp->cert_len)
1566 rv = SESSION_E_INVALID;
1570 key_len = mp->certkey_len - mp->cert_len;
1571 if (key_len > max_key_len)
1573 rv = SESSION_E_INVALID;
1577 clib_memset (a, 0, sizeof (*a));
1579 a->key = certkey + mp->cert_len;
1580 a->cert_len = mp->cert_len;
1581 a->key_len = key_len;
1582 rv = vnet_app_add_cert_key_pair (a);
1588 rv = vnet_app_del_cert_key_pair (mp->index);
1593 msg.type = APP_SAPI_MSG_TYPE_ADD_DEL_CERT_KEY_REPLY;
1594 rmp = &msg.cert_key_add_del_reply;
1596 rmp->context = mp->context;
1597 if (!rv && mp->is_add)
1598 rmp->index = a->index;
1600 clib_socket_sendmsg (cs, &msg, sizeof (msg), 0, 0);
1604 sapi_socket_detach (app_namespace_t * app_ns, clib_socket_t * cs)
1606 app_ns_api_handle_t *handle;
1607 app_worker_t *app_wrk;
1608 u32 api_client_handle;
1610 api_client_handle = appns_sapi_socket_handle (app_ns, cs);
1612 /* Cleanup everything because app worker closed socket or crashed */
1613 handle = (app_ns_api_handle_t *) & cs->private_data;
1614 app_wrk = app_worker_get_if_valid (handle->aah_app_wrk_index);
1618 vnet_app_worker_add_del_args_t args = {
1619 .app_index = app_wrk->app_index,
1620 .wrk_map_index = app_wrk->wrk_map_index,
1621 .api_client_index = api_client_handle,
1624 /* Send rpc to main thread for worker barrier */
1625 vlib_rpc_call_main_thread (vnet_app_worker_add_del, (u8 *) & args,
1629 static clib_error_t *
1630 sapi_sock_read_ready (clib_file_t * cf)
1632 app_ns_api_handle_t *handle = (app_ns_api_handle_t *) & cf->private_data;
1633 vlib_main_t *vm = vlib_get_main ();
1634 app_sapi_msg_t msg = { 0 };
1635 app_namespace_t *app_ns;
1636 clib_error_t *err = 0;
1639 app_ns = app_namespace_get (handle->aah_app_ns_index);
1640 cs = appns_sapi_get_socket (app_ns, handle->aah_sock_index);
1644 err = clib_socket_recvmsg (cs, &msg, sizeof (msg), 0, 0);
1647 clib_error_free (err);
1648 sapi_socket_detach (app_ns, cs);
1652 handle = (app_ns_api_handle_t *) & cs->private_data;
1654 vlib_worker_thread_barrier_sync (vm);
1658 case APP_SAPI_MSG_TYPE_ATTACH:
1659 session_api_attach_handler (app_ns, cs, &msg.attach);
1661 case APP_SAPI_MSG_TYPE_ADD_DEL_WORKER:
1662 sapi_add_del_worker_handler (app_ns, cs, &msg.worker_add_del);
1664 case APP_SAPI_MSG_TYPE_ADD_DEL_CERT_KEY:
1665 sapi_add_del_cert_key_handler (app_ns, cs, &msg.cert_key_add_del);
1668 clib_warning ("app wrk %u unknown message type: %u",
1669 handle->aah_app_wrk_index, msg.type);
1673 vlib_worker_thread_barrier_release (vm);
1679 static clib_error_t *
1680 sapi_sock_write_ready (clib_file_t * cf)
1682 app_ns_api_handle_t *handle = (app_ns_api_handle_t *) & cf->private_data;
1683 clib_warning ("called for app ns %u", handle->aah_app_ns_index);
1687 static clib_error_t *
1688 sapi_sock_error (clib_file_t * cf)
1690 app_ns_api_handle_t *handle = (app_ns_api_handle_t *) & cf->private_data;
1691 app_namespace_t *app_ns;
1694 app_ns = app_namespace_get (handle->aah_app_ns_index);
1695 cs = appns_sapi_get_socket (app_ns, handle->aah_sock_index);
1699 sapi_socket_detach (app_ns, cs);
1703 static clib_error_t *
1704 sapi_sock_accept_ready (clib_file_t * scf)
1706 app_ns_api_handle_t handle = *(app_ns_api_handle_t *) & scf->private_data;
1707 app_namespace_t *app_ns;
1708 clib_file_t cf = { 0 };
1709 clib_error_t *err = 0;
1710 clib_socket_t *ccs, *scs;
1712 /* Listener files point to namespace */
1713 app_ns = app_namespace_get (handle.aah_app_ns_index);
1716 * Initialize client socket
1718 ccs = appns_sapi_alloc_socket (app_ns);
1720 /* Grab server socket after client is initialized */
1721 scs = appns_sapi_get_socket (app_ns, handle.aah_sock_index);
1725 err = clib_socket_accept (scs, ccs);
1728 clib_error_report (err);
1732 cf.read_function = sapi_sock_read_ready;
1733 cf.write_function = sapi_sock_write_ready;
1734 cf.error_function = sapi_sock_error;
1735 cf.file_descriptor = ccs->fd;
1736 /* File points to app namespace and socket */
1737 handle.aah_sock_index = appns_sapi_socket_index (app_ns, ccs);
1738 cf.private_data = handle.as_u64;
1739 cf.description = format (0, "app sock conn fd: %d", ccs->fd);
1741 /* Poll until we get an attach message. Socket points to file and
1742 * application that owns the socket */
1743 handle.aah_app_wrk_index = APP_INVALID_INDEX;
1744 handle.aah_file_index = clib_file_add (&file_main, &cf);
1745 ccs->private_data = handle.as_u64;
1750 appns_sapi_free_socket (app_ns, ccs);
1755 appns_sapi_del_ns_socket (app_namespace_t *app_ns)
1757 app_ns_api_handle_t *handle;
1760 pool_foreach (cs, app_ns->app_sockets)
1762 handle = (app_ns_api_handle_t *) &cs->private_data;
1763 clib_file_del_by_index (&file_main, handle->aah_file_index);
1765 clib_socket_close (cs);
1766 clib_socket_free (cs);
1768 pool_free (app_ns->app_sockets);
1772 appns_sapi_add_ns_socket (app_namespace_t * app_ns)
1774 char *subdir = "/app_ns_sockets/";
1775 app_ns_api_handle_t *handle;
1776 clib_file_t cf = { 0 };
1777 struct stat file_stat;
1782 snprintf (dir, sizeof (dir), "%s%s", vlib_unix_get_runtime_dir (), subdir);
1784 if (!app_ns->sock_name)
1785 app_ns->sock_name = format (0, "%s%v%c", dir, app_ns->ns_id, 0);
1788 * Create and initialize socket to listen on
1790 cs = appns_sapi_alloc_socket (app_ns);
1791 cs->config = (char *) vec_dup (app_ns->sock_name);
1792 cs->flags = CLIB_SOCKET_F_IS_SERVER |
1793 CLIB_SOCKET_F_ALLOW_GROUP_WRITE |
1794 CLIB_SOCKET_F_SEQPACKET | CLIB_SOCKET_F_PASSCRED;
1796 if (clib_socket_prefix_get_type (cs->config) == CLIB_SOCKET_TYPE_UNIX)
1798 err = vlib_unix_recursive_mkdir ((char *) dir);
1801 clib_error_report (err);
1802 return SESSION_E_SYSCALL;
1806 if ((err = clib_socket_init (cs)))
1808 clib_error_report (err);
1812 if (clib_socket_prefix_get_type (cs->config) == CLIB_SOCKET_TYPE_UNIX &&
1813 stat ((char *) app_ns->sock_name, &file_stat) == -1)
1819 cf.read_function = sapi_sock_accept_ready;
1820 cf.file_descriptor = cs->fd;
1821 /* File points to namespace */
1822 handle = (app_ns_api_handle_t *) & cf.private_data;
1823 handle->aah_app_ns_index = app_namespace_index (app_ns);
1824 handle->aah_sock_index = appns_sapi_socket_index (app_ns, cs);
1825 cf.description = format (0, "app sock listener: %s", app_ns->sock_name);
1827 /* Socket points to clib file index */
1828 handle = (app_ns_api_handle_t *) & cs->private_data;
1829 handle->aah_file_index = clib_file_add (&file_main, &cf);
1830 handle->aah_app_wrk_index = APP_INVALID_INDEX;
1835 #include <vnet/session/session.api.c>
1836 static clib_error_t *
1837 session_api_hookup (vlib_main_t *vm)
1840 * Set up the (msg_name, crc, message-id) table
1842 REPLY_MSG_ID_BASE = setup_message_id_table ();
1847 VLIB_API_INIT_FUNCTION (session_api_hookup);
1850 * fd.io coding-style-patch-verification: ON
1853 * eval: (c-set-style "gnu")