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 fifo_segment_t *eq_seg;
216 app_worker_t *app_wrk;
219 app_wrk = app_worker_get (app_wrk_index);
221 m.context = api_context;
227 app = application_get (app_wrk->app_index);
228 eq_seg = application_get_rx_mqs_segment (app);
230 if (session_has_transport (s))
232 m.handle = session_handle (s);
233 m.vpp_event_queue_address =
234 fifo_segment_msg_q_offset (eq_seg, s->thread_index);
236 session_get_endpoint (s, &m.lcl, 1 /* is_lcl */);
238 m.server_rx_fifo = fifo_segment_fifo_offset (s->rx_fifo);
239 m.server_tx_fifo = fifo_segment_fifo_offset (s->tx_fifo);
240 m.segment_handle = session_segment_handle (s);
241 m.mq_index = s->thread_index;
245 ct_connection_t *cct;
247 cct = (ct_connection_t *) session_get_transport (s);
248 m.handle = session_handle (s);
249 m.lcl.port = cct->c_lcl_port;
250 m.lcl.is_ip4 = cct->c_is_ip4;
251 m.vpp_event_queue_address =
252 fifo_segment_msg_q_offset (eq_seg, s->thread_index);
253 m.server_rx_fifo = fifo_segment_fifo_offset (s->rx_fifo);
254 m.server_tx_fifo = fifo_segment_fifo_offset (s->tx_fifo);
255 m.segment_handle = session_segment_handle (s);
256 m.mq_index = s->thread_index;
257 m.ct_rx_fifo = fifo_segment_fifo_offset (cct->client_rx_fifo);
258 m.ct_tx_fifo = fifo_segment_fifo_offset (cct->client_tx_fifo);
259 m.ct_segment_handle = cct->segment_handle;
262 /* Setup client session index in advance, in case data arrives
263 * before the app processes message and updates it */
264 s->rx_fifo->shr->client_session_index = api_context;
265 s->tx_fifo->shr->client_session_index = api_context;
269 app_wrk_send_ctrl_evt (app_wrk, SESSION_CTRL_EVT_CONNECTED, &m, sizeof (m));
275 mq_send_session_bound_cb (u32 app_wrk_index, u32 api_context,
276 session_handle_t handle, int rv)
278 session_bound_msg_t m = { 0 };
279 transport_connection_t *ltc;
280 fifo_segment_t *eq_seg;
281 app_worker_t *app_wrk;
286 app_wrk = app_worker_get (app_wrk_index);
288 m.context = api_context;
295 al = app_listener_get_w_handle (handle);
296 if (al->session_index != SESSION_INVALID_INDEX)
297 ls = app_listener_get_session (al);
299 ls = app_listener_get_local_session (al);
301 ltc = session_get_transport (ls);
302 m.lcl_port = ltc->lcl_port;
303 m.lcl_is_ip4 = ltc->is_ip4;
304 clib_memcpy_fast (m.lcl_ip, <c->lcl_ip, sizeof (m.lcl_ip));
305 app = application_get (app_wrk->app_index);
306 eq_seg = application_get_rx_mqs_segment (app);
307 m.vpp_evt_q = fifo_segment_msg_q_offset (eq_seg, ls->thread_index);
308 m.mq_index = ls->thread_index;
310 if (transport_connection_is_cless (ltc))
313 m.mq_index = transport_cl_thread ();
314 m.vpp_evt_q = fifo_segment_msg_q_offset (eq_seg, m.mq_index);
315 wrk_ls = app_listener_get_wrk_cl_session (al, app_wrk->wrk_map_index);
316 m.rx_fifo = fifo_segment_fifo_offset (wrk_ls->rx_fifo);
317 m.tx_fifo = fifo_segment_fifo_offset (wrk_ls->tx_fifo);
318 m.segment_handle = session_segment_handle (wrk_ls);
323 app_wrk_send_ctrl_evt (app_wrk, SESSION_CTRL_EVT_BOUND, &m, sizeof (m));
329 mq_send_unlisten_reply (app_worker_t * app_wrk, session_handle_t sh,
332 session_unlisten_reply_msg_t m = { 0 };
337 app_wrk_send_ctrl_evt (app_wrk, SESSION_CTRL_EVT_UNLISTEN_REPLY, &m,
342 mq_send_session_migrate_cb (session_t * s, session_handle_t new_sh)
344 session_migrated_msg_t m = { 0 };
345 fifo_segment_t *eq_seg;
346 app_worker_t *app_wrk;
350 thread_index = session_thread_from_handle (new_sh);
351 app_wrk = app_worker_get (s->app_wrk_index);
352 app = application_get (app_wrk->app_index);
353 eq_seg = application_get_rx_mqs_segment (app);
355 m.handle = session_handle (s);
356 m.new_handle = new_sh;
357 m.vpp_thread_index = thread_index;
358 m.vpp_evt_q = fifo_segment_msg_q_offset (eq_seg, thread_index);
359 m.segment_handle = SESSION_INVALID_HANDLE;
361 app_wrk_send_ctrl_evt (app_wrk, SESSION_CTRL_EVT_MIGRATED, &m, sizeof (m));
365 mq_send_add_segment_cb (u32 app_wrk_index, u64 segment_handle)
367 session_app_add_segment_msg_t m = { 0 };
368 vl_api_registration_t *reg;
369 app_worker_t *app_wrk;
374 app_wrk = app_worker_get (app_wrk_index);
376 reg = vl_mem_api_client_index_to_registration (app_wrk->api_client_index);
379 clib_warning ("no api registration for client: %u",
380 app_wrk->api_client_index);
384 fs = segment_manager_get_segment_w_handle (segment_handle);
386 if (ssvm_type (sp) == SSVM_SEGMENT_MEMFD)
388 if (vl_api_registration_file_index (reg) == VL_API_INVALID_FI)
390 clib_warning ("can't send memfd fd");
394 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
397 m.segment_size = sp->ssvm_size;
398 m.fd_flags = fd_flags;
399 m.segment_handle = segment_handle;
400 strncpy ((char *) m.segment_name, (char *) sp->name,
401 sizeof (m.segment_name) - 1);
403 app_wrk_send_ctrl_evt_fd (app_wrk, SESSION_CTRL_EVT_APP_ADD_SEGMENT, &m,
410 mq_send_del_segment_cb (u32 app_wrk_index, u64 segment_handle)
412 session_app_del_segment_msg_t m = { 0 };
413 vl_api_registration_t *reg;
414 app_worker_t *app_wrk;
416 app_wrk = app_worker_get (app_wrk_index);
417 reg = vl_mem_api_client_index_to_registration (app_wrk->api_client_index);
420 clib_warning ("no registration: %u", app_wrk->api_client_index);
424 m.segment_handle = segment_handle;
426 app_wrk_send_ctrl_evt (app_wrk, SESSION_CTRL_EVT_APP_DEL_SEGMENT, &m,
433 mq_send_session_cleanup_cb (session_t * s, session_cleanup_ntf_t ntf)
435 session_cleanup_msg_t m = { 0 };
436 app_worker_t *app_wrk;
438 /* Propagate transport cleanup notifications only if app didn't close */
439 if (ntf == SESSION_CLEANUP_TRANSPORT
440 && s->session_state != SESSION_STATE_TRANSPORT_DELETED)
443 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
447 m.handle = session_handle (s);
450 app_wrk_send_ctrl_evt (app_wrk, SESSION_CTRL_EVT_CLEANUP, &m, sizeof (m));
454 mq_send_io_rx_event (session_t *s)
456 session_event_t *mq_evt;
457 svm_msg_q_msg_t mq_msg;
458 app_worker_t *app_wrk;
461 if (svm_fifo_has_event (s->rx_fifo))
464 app_wrk = app_worker_get (s->app_wrk_index);
465 mq = app_wrk->event_queue;
467 mq_msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
468 mq_evt = svm_msg_q_msg_data (mq, &mq_msg);
470 mq_evt->event_type = SESSION_IO_EVT_RX;
471 mq_evt->session_index = s->rx_fifo->shr->client_session_index;
473 (void) svm_fifo_set_event (s->rx_fifo);
475 svm_msg_q_add_raw (mq, &mq_msg);
481 mq_send_io_tx_event (session_t *s)
483 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
484 svm_msg_q_t *mq = app_wrk->event_queue;
485 session_event_t *mq_evt;
486 svm_msg_q_msg_t mq_msg;
488 mq_msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
489 mq_evt = svm_msg_q_msg_data (mq, &mq_msg);
491 mq_evt->event_type = SESSION_IO_EVT_TX;
492 mq_evt->session_index = s->tx_fifo->shr->client_session_index;
494 svm_msg_q_add_raw (mq, &mq_msg);
499 static session_cb_vft_t session_mq_cb_vft = {
500 .session_accept_callback = mq_send_session_accepted_cb,
501 .session_disconnect_callback = mq_send_session_disconnected_cb,
502 .session_connected_callback = mq_send_session_connected_cb,
503 .session_reset_callback = mq_send_session_reset_cb,
504 .session_migrate_callback = mq_send_session_migrate_cb,
505 .session_cleanup_callback = mq_send_session_cleanup_cb,
506 .add_segment_callback = mq_send_add_segment_cb,
507 .del_segment_callback = mq_send_del_segment_cb,
508 .builtin_app_rx_callback = mq_send_io_rx_event,
509 .builtin_app_tx_callback = mq_send_io_tx_event,
513 vl_api_session_enable_disable_t_handler (vl_api_session_enable_disable_t * mp)
515 vl_api_session_enable_disable_reply_t *rmp;
516 vlib_main_t *vm = vlib_get_main ();
519 vnet_session_enable_disable (vm, mp->is_enable);
520 REPLY_MACRO (VL_API_SESSION_ENABLE_DISABLE_REPLY);
524 vl_api_session_sapi_enable_disable_t_handler (
525 vl_api_session_sapi_enable_disable_t *mp)
527 vl_api_session_sapi_enable_disable_reply_t *rmp;
530 rv = appns_sapi_enable_disable (mp->is_enable);
531 REPLY_MACRO (VL_API_SESSION_SAPI_ENABLE_DISABLE_REPLY);
535 vl_api_app_attach_t_handler (vl_api_app_attach_t * mp)
537 int rv = 0, *fds = 0, n_fds = 0, n_workers, i;
538 fifo_segment_t *segp, *rx_mqs_seg = 0;
539 vnet_app_attach_args_t _a, *a = &_a;
540 vl_api_app_attach_reply_t *rmp;
541 u8 fd_flags = 0, ctrl_thread;
542 vl_api_registration_t *reg;
546 reg = vl_api_client_index_to_registration (mp->client_index);
550 n_workers = vlib_num_workers ();
551 if (!session_main_is_enabled () || appns_sapi_enabled ())
553 rv = VNET_API_ERROR_FEATURE_DISABLED;
556 /* Only support binary api with socket transport */
557 if (vl_api_registration_file_index (reg) == VL_API_INVALID_FI)
559 rv = VNET_API_ERROR_APP_UNSUPPORTED_CFG;
563 STATIC_ASSERT (sizeof (u64) * APP_OPTIONS_N_OPTIONS <=
564 sizeof (mp->options),
565 "Out of options, fix api message definition");
567 clib_memset (a, 0, sizeof (*a));
568 a->api_client_index = mp->client_index;
569 a->options = mp->options;
570 a->session_cb_vft = &session_mq_cb_vft;
571 a->namespace_id = vl_api_from_api_to_new_vec (mp, &mp->namespace_id);
573 if ((rv = vnet_application_attach (a)))
575 clib_warning ("attach returned: %U", format_session_error, rv);
576 rv = VNET_API_ERROR_UNSPECIFIED;
577 vec_free (a->namespace_id);
580 vec_free (a->namespace_id);
582 vec_validate (fds, 3 /* segs + tx evtfd */ + n_workers);
584 /* Send rx mqs segment */
585 app = application_get (a->app_index);
586 rx_mqs_seg = application_get_rx_mqs_segment (app);
588 fd_flags |= SESSION_FD_F_VPP_MQ_SEGMENT;
589 fds[n_fds] = rx_mqs_seg->ssvm.fd;
592 /* Send fifo segment fd if needed */
593 if (ssvm_type (a->segment) == SSVM_SEGMENT_MEMFD)
595 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
596 fds[n_fds] = a->segment->fd;
599 if (a->options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
601 fd_flags |= SESSION_FD_F_MQ_EVENTFD;
602 fds[n_fds] = svm_msg_q_get_eventfd (a->app_evt_q);
606 if (application_use_private_rx_mqs ())
608 fd_flags |= SESSION_FD_F_VPP_MQ_EVENTFD;
609 for (i = 0; i < n_workers + 1; i++)
611 rx_mq = application_rx_mq_get (app, i);
612 fds[n_fds] = svm_msg_q_get_eventfd (rx_mq);
620 VL_API_APP_ATTACH_REPLY,
621 ((!rv) ? vec_len (((fifo_segment_t *) a->segment)->ssvm.name) : 0), ({
624 ctrl_thread = n_workers ? 1 : 0;
625 segp = (fifo_segment_t *) a->segment;
626 rmp->app_index = clib_host_to_net_u32 (a->app_index);
627 rmp->app_mq = fifo_segment_msg_q_offset (segp, 0);
629 fifo_segment_msg_q_offset (rx_mqs_seg, ctrl_thread);
630 rmp->vpp_ctrl_mq_thread = ctrl_thread;
632 rmp->fd_flags = fd_flags;
633 if (vec_len (segp->ssvm.name))
635 vl_api_vec_to_api_string (segp->ssvm.name, &rmp->segment_name);
637 rmp->segment_size = segp->ssvm.ssvm_size;
638 rmp->segment_handle = clib_host_to_net_u64 (a->segment_handle);
644 session_send_fds (reg, fds, n_fds);
649 vl_api_app_worker_add_del_t_handler (vl_api_app_worker_add_del_t * mp)
651 int rv = 0, fds[SESSION_N_FD_TYPE], n_fds = 0;
652 vl_api_app_worker_add_del_reply_t *rmp;
653 vl_api_registration_t *reg;
657 if (!session_main_is_enabled () || appns_sapi_enabled ())
659 rv = VNET_API_ERROR_FEATURE_DISABLED;
663 reg = vl_api_client_index_to_registration (mp->client_index);
667 app = application_get_if_valid (clib_net_to_host_u32 (mp->app_index));
670 rv = VNET_API_ERROR_INVALID_VALUE;
674 vnet_app_worker_add_del_args_t args = {
675 .app_index = app->app_index,
676 .wrk_map_index = clib_net_to_host_u32 (mp->wrk_index),
677 .api_client_index = mp->client_index,
680 rv = vnet_app_worker_add_del (&args);
683 clib_warning ("app worker add/del returned: %U", format_session_error,
685 rv = VNET_API_ERROR_UNSPECIFIED;
692 /* Send fifo segment fd if needed */
693 if (ssvm_type (args.segment) == SSVM_SEGMENT_MEMFD)
695 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
696 fds[n_fds] = args.segment->fd;
699 if (application_segment_manager_properties (app)->use_mq_eventfd)
701 fd_flags |= SESSION_FD_F_MQ_EVENTFD;
702 fds[n_fds] = svm_msg_q_get_eventfd (args.evt_q);
709 VL_API_APP_WORKER_ADD_DEL_REPLY,
710 ((!rv && mp->is_add) ? vec_len (args.segment->name) : 0), ({
711 rmp->is_add = mp->is_add;
712 rmp->wrk_index = clib_host_to_net_u32 (args.wrk_map_index);
713 if (!rv && mp->is_add)
715 rmp->segment_handle = clib_host_to_net_u64 (args.segment_handle);
716 rmp->app_event_queue_address =
717 fifo_segment_msg_q_offset ((fifo_segment_t *) args.segment, 0);
719 rmp->fd_flags = fd_flags;
720 if (vec_len (args.segment->name))
722 vl_api_vec_to_api_string (args.segment->name,
730 session_send_fds (reg, fds, n_fds);
734 vl_api_application_detach_t_handler (vl_api_application_detach_t * mp)
736 vl_api_application_detach_reply_t *rmp;
737 int rv = VNET_API_ERROR_INVALID_VALUE_2;
738 vnet_app_detach_args_t _a, *a = &_a;
741 if (!session_main_is_enabled () || appns_sapi_enabled ())
743 rv = VNET_API_ERROR_FEATURE_DISABLED;
747 app = application_lookup (mp->client_index);
750 a->app_index = app->app_index;
751 a->api_client_index = mp->client_index;
752 rv = vnet_application_detach (a);
755 clib_warning ("vnet_application_detach: %U", format_session_error,
757 rv = VNET_API_ERROR_UNSPECIFIED;
762 REPLY_MACRO (VL_API_APPLICATION_DETACH_REPLY);
766 vl_api_app_namespace_add_del_t_handler (vl_api_app_namespace_add_del_t * mp)
768 vl_api_app_namespace_add_del_reply_t *rmp;
772 if (session_main_is_enabled () == 0)
774 rv = VNET_API_ERROR_FEATURE_DISABLED;
778 ns_id = vl_api_from_api_to_new_vec (mp, &mp->namespace_id);
780 vnet_app_namespace_add_del_args_t args = {
783 .secret = clib_net_to_host_u64 (mp->secret),
784 .sw_if_index = clib_net_to_host_u32 (mp->sw_if_index),
785 .ip4_fib_id = clib_net_to_host_u32 (mp->ip4_fib_id),
786 .ip6_fib_id = clib_net_to_host_u32 (mp->ip6_fib_id),
789 rv = vnet_app_namespace_add_del (&args);
792 appns_index = app_namespace_index_from_id (ns_id);
793 if (appns_index == APP_NAMESPACE_INVALID_INDEX)
795 clib_warning ("app ns lookup failed");
796 rv = VNET_API_ERROR_UNSPECIFIED;
803 REPLY_MACRO2 (VL_API_APP_NAMESPACE_ADD_DEL_REPLY, ({
805 rmp->appns_index = clib_host_to_net_u32 (appns_index);
811 vl_api_app_namespace_add_del_v2_t_handler (
812 vl_api_app_namespace_add_del_v2_t *mp)
814 vl_api_app_namespace_add_del_v2_reply_t *rmp;
819 if (session_main_is_enabled () == 0)
821 rv = VNET_API_ERROR_FEATURE_DISABLED;
825 mp->namespace_id[sizeof (mp->namespace_id) - 1] = 0;
826 ns_id = format (0, "%s", &mp->namespace_id);
828 vnet_app_namespace_add_del_args_t args = {
831 .secret = clib_net_to_host_u64 (mp->secret),
832 .sw_if_index = clib_net_to_host_u32 (mp->sw_if_index),
833 .ip4_fib_id = clib_net_to_host_u32 (mp->ip4_fib_id),
834 .ip6_fib_id = clib_net_to_host_u32 (mp->ip6_fib_id),
837 rv = vnet_app_namespace_add_del (&args);
840 appns_index = app_namespace_index_from_id (ns_id);
841 if (appns_index == APP_NAMESPACE_INVALID_INDEX)
843 clib_warning ("app ns lookup failed id:%s", ns_id);
844 rv = VNET_API_ERROR_UNSPECIFIED;
850 REPLY_MACRO2 (VL_API_APP_NAMESPACE_ADD_DEL_V2_REPLY, ({
852 rmp->appns_index = clib_host_to_net_u32 (appns_index);
857 vl_api_app_namespace_add_del_v4_t_handler (
858 vl_api_app_namespace_add_del_v4_t *mp)
860 vl_api_app_namespace_add_del_v4_reply_t *rmp;
861 u8 *ns_id = 0, *sock_name = 0;
864 if (session_main_is_enabled () == 0)
866 rv = VNET_API_ERROR_FEATURE_DISABLED;
869 mp->namespace_id[sizeof (mp->namespace_id) - 1] = 0;
870 ns_id = format (0, "%s", &mp->namespace_id);
871 sock_name = vl_api_from_api_to_new_vec (mp, &mp->sock_name);
872 vnet_app_namespace_add_del_args_t args = {
874 .sock_name = sock_name,
875 .secret = clib_net_to_host_u64 (mp->secret),
876 .sw_if_index = clib_net_to_host_u32 (mp->sw_if_index),
877 .ip4_fib_id = clib_net_to_host_u32 (mp->ip4_fib_id),
878 .ip6_fib_id = clib_net_to_host_u32 (mp->ip6_fib_id),
879 .is_add = mp->is_add,
881 rv = vnet_app_namespace_add_del (&args);
882 if (!rv && mp->is_add)
884 appns_index = app_namespace_index_from_id (ns_id);
885 if (appns_index == APP_NAMESPACE_INVALID_INDEX)
887 clib_warning ("app ns lookup failed id:%s", ns_id);
888 rv = VNET_API_ERROR_UNSPECIFIED;
892 vec_free (sock_name);
894 REPLY_MACRO2 (VL_API_APP_NAMESPACE_ADD_DEL_V4_REPLY, ({
896 rmp->appns_index = clib_host_to_net_u32 (appns_index);
901 vl_api_app_namespace_add_del_v3_t_handler (
902 vl_api_app_namespace_add_del_v3_t *mp)
904 vl_api_app_namespace_add_del_v3_reply_t *rmp;
905 u8 *ns_id = 0, *sock_name = 0, *api_sock_name = 0;
908 if (session_main_is_enabled () == 0)
910 rv = VNET_API_ERROR_FEATURE_DISABLED;
913 mp->namespace_id[sizeof (mp->namespace_id) - 1] = 0;
914 ns_id = format (0, "%s", &mp->namespace_id);
915 api_sock_name = vl_api_from_api_to_new_vec (mp, &mp->sock_name);
916 mp->netns[sizeof (mp->netns) - 1] = 0;
917 if (strlen ((char *) mp->netns) != 0)
920 format (0, "abstract:%v,netns_name=%s", api_sock_name, &mp->netns);
924 sock_name = api_sock_name;
925 api_sock_name = 0; // for vec_free
928 vnet_app_namespace_add_del_args_t args = {
930 .sock_name = sock_name,
931 .secret = clib_net_to_host_u64 (mp->secret),
932 .sw_if_index = clib_net_to_host_u32 (mp->sw_if_index),
933 .ip4_fib_id = clib_net_to_host_u32 (mp->ip4_fib_id),
934 .ip6_fib_id = clib_net_to_host_u32 (mp->ip6_fib_id),
935 .is_add = mp->is_add,
937 rv = vnet_app_namespace_add_del (&args);
938 if (!rv && mp->is_add)
940 appns_index = app_namespace_index_from_id (ns_id);
941 if (appns_index == APP_NAMESPACE_INVALID_INDEX)
943 clib_warning ("app ns lookup failed id:%s", ns_id);
944 rv = VNET_API_ERROR_UNSPECIFIED;
948 vec_free (sock_name);
949 vec_free (api_sock_name);
951 REPLY_MACRO2 (VL_API_APP_NAMESPACE_ADD_DEL_V3_REPLY, ({
953 rmp->appns_index = clib_host_to_net_u32 (appns_index);
958 vl_api_session_rule_add_del_t_handler (vl_api_session_rule_add_del_t * mp)
960 vl_api_session_rule_add_del_reply_t *rmp;
961 session_rule_add_del_args_t args;
962 session_rule_table_add_del_args_t *table_args = &args.table_args;
965 clib_memset (&args, 0, sizeof (args));
967 ip_prefix_decode (&mp->lcl, &table_args->lcl);
968 ip_prefix_decode (&mp->rmt, &table_args->rmt);
970 table_args->lcl_port = mp->lcl_port;
971 table_args->rmt_port = mp->rmt_port;
972 table_args->action_index = clib_net_to_host_u32 (mp->action_index);
973 table_args->is_add = mp->is_add;
974 mp->tag[sizeof (mp->tag) - 1] = 0;
975 table_args->tag = format (0, "%s", mp->tag);
976 args.appns_index = clib_net_to_host_u32 (mp->appns_index);
977 args.scope = mp->scope;
978 args.transport_proto =
979 api_session_transport_proto_decode (&mp->transport_proto) ==
980 TRANSPORT_PROTO_UDP ? 1 : 0;
982 rv = vnet_session_rule_add_del (&args);
985 clib_warning ("rule add del returned: %U", format_session_error, rv);
986 rv = VNET_API_ERROR_UNSPECIFIED;
988 vec_free (table_args->tag);
989 REPLY_MACRO (VL_API_SESSION_RULE_ADD_DEL_REPLY);
993 send_session_rule_details4 (mma_rule_16_t * rule, u8 is_local,
994 u8 transport_proto, u32 appns_index, u8 * tag,
995 vl_api_registration_t * reg, u32 context)
997 vl_api_session_rules_details_t *rmp = 0;
998 session_mask_or_match_4_t *match =
999 (session_mask_or_match_4_t *) & rule->match;
1000 session_mask_or_match_4_t *mask =
1001 (session_mask_or_match_4_t *) & rule->mask;
1002 fib_prefix_t lcl, rmt;
1004 rmp = vl_msg_api_alloc (sizeof (*rmp));
1005 clib_memset (rmp, 0, sizeof (*rmp));
1006 rmp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_SESSION_RULES_DETAILS);
1007 rmp->context = context;
1009 clib_memset (&lcl, 0, sizeof (lcl));
1010 clib_memset (&rmt, 0, sizeof (rmt));
1011 ip_set (&lcl.fp_addr, &match->lcl_ip, 1);
1012 ip_set (&rmt.fp_addr, &match->rmt_ip, 1);
1013 lcl.fp_len = ip4_mask_to_preflen (&mask->lcl_ip);
1014 rmt.fp_len = ip4_mask_to_preflen (&mask->rmt_ip);
1016 ip_prefix_encode (&lcl, &rmp->lcl);
1017 ip_prefix_encode (&rmt, &rmp->rmt);
1018 rmp->lcl_port = match->lcl_port;
1019 rmp->rmt_port = match->rmt_port;
1020 rmp->action_index = clib_host_to_net_u32 (rule->action_index);
1022 is_local ? SESSION_RULE_SCOPE_API_LOCAL : SESSION_RULE_SCOPE_API_GLOBAL;
1023 rmp->transport_proto = api_session_transport_proto_encode (transport_proto);
1024 rmp->appns_index = clib_host_to_net_u32 (appns_index);
1027 clib_memcpy_fast (rmp->tag, tag, vec_len (tag));
1028 rmp->tag[vec_len (tag)] = 0;
1031 vl_api_send_msg (reg, (u8 *) rmp);
1035 send_session_rule_details6 (mma_rule_40_t * rule, u8 is_local,
1036 u8 transport_proto, u32 appns_index, u8 * tag,
1037 vl_api_registration_t * reg, u32 context)
1039 vl_api_session_rules_details_t *rmp = 0;
1040 session_mask_or_match_6_t *match =
1041 (session_mask_or_match_6_t *) & rule->match;
1042 session_mask_or_match_6_t *mask =
1043 (session_mask_or_match_6_t *) & rule->mask;
1044 fib_prefix_t lcl, rmt;
1046 rmp = vl_msg_api_alloc (sizeof (*rmp));
1047 clib_memset (rmp, 0, sizeof (*rmp));
1048 rmp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_SESSION_RULES_DETAILS);
1049 rmp->context = context;
1051 clib_memset (&lcl, 0, sizeof (lcl));
1052 clib_memset (&rmt, 0, sizeof (rmt));
1053 ip_set (&lcl.fp_addr, &match->lcl_ip, 0);
1054 ip_set (&rmt.fp_addr, &match->rmt_ip, 0);
1055 lcl.fp_len = ip6_mask_to_preflen (&mask->lcl_ip);
1056 rmt.fp_len = ip6_mask_to_preflen (&mask->rmt_ip);
1058 ip_prefix_encode (&lcl, &rmp->lcl);
1059 ip_prefix_encode (&rmt, &rmp->rmt);
1060 rmp->lcl_port = match->lcl_port;
1061 rmp->rmt_port = match->rmt_port;
1062 rmp->action_index = clib_host_to_net_u32 (rule->action_index);
1064 is_local ? SESSION_RULE_SCOPE_API_LOCAL : SESSION_RULE_SCOPE_API_GLOBAL;
1065 rmp->transport_proto = api_session_transport_proto_encode (transport_proto);
1066 rmp->appns_index = clib_host_to_net_u32 (appns_index);
1069 clib_memcpy_fast (rmp->tag, tag, vec_len (tag));
1070 rmp->tag[vec_len (tag)] = 0;
1073 vl_api_send_msg (reg, (u8 *) rmp);
1077 send_session_rules_table_details (session_rules_table_t * srt, u8 fib_proto,
1078 u8 tp, u8 is_local, u32 appns_index,
1079 vl_api_registration_t * reg, u32 context)
1081 mma_rule_16_t *rule16;
1082 mma_rule_40_t *rule40;
1083 mma_rules_table_16_t *srt16;
1084 mma_rules_table_40_t *srt40;
1087 if (is_local || fib_proto == FIB_PROTOCOL_IP4)
1091 srt16 = &srt->session_rules_tables_16;
1092 pool_foreach (rule16, srt16->rules) {
1093 ri = mma_rules_table_rule_index_16 (srt16, rule16);
1094 tag = session_rules_table_rule_tag (srt, ri, 1);
1095 send_session_rule_details4 (rule16, is_local, tp, appns_index, tag,
1100 if (is_local || fib_proto == FIB_PROTOCOL_IP6)
1104 srt40 = &srt->session_rules_tables_40;
1105 pool_foreach (rule40, srt40->rules) {
1106 ri = mma_rules_table_rule_index_40 (srt40, rule40);
1107 tag = session_rules_table_rule_tag (srt, ri, 1);
1108 send_session_rule_details6 (rule40, is_local, tp, appns_index, tag,
1116 vl_api_session_rules_dump_t_handler (vl_api_session_rules_dump_t * mp)
1118 vl_api_registration_t *reg;
1119 session_table_t *st;
1122 reg = vl_api_client_index_to_registration (mp->client_index);
1127 session_table_foreach (st, ({
1128 for (tp = 0; tp < TRANSPORT_N_PROTOS; tp++)
1130 send_session_rules_table_details (&st->session_rules[tp],
1131 st->active_fib_proto, tp,
1132 st->is_local, st->appns_index, reg,
1140 vl_api_app_add_cert_key_pair_t_handler (vl_api_app_add_cert_key_pair_t * mp)
1142 vl_api_app_add_cert_key_pair_reply_t *rmp;
1143 vnet_app_add_cert_key_pair_args_t _a, *a = &_a;
1144 u32 certkey_len, key_len, cert_len;
1146 if (session_main_is_enabled () == 0)
1148 rv = VNET_API_ERROR_FEATURE_DISABLED;
1152 cert_len = clib_net_to_host_u16 (mp->cert_len);
1153 if (cert_len > 10000)
1155 rv = VNET_API_ERROR_INVALID_VALUE;
1159 certkey_len = clib_net_to_host_u16 (mp->certkey_len);
1160 if (certkey_len < cert_len)
1162 rv = VNET_API_ERROR_INVALID_VALUE;
1166 key_len = certkey_len - cert_len;
1167 if (key_len > 10000)
1169 rv = VNET_API_ERROR_INVALID_VALUE;
1173 clib_memset (a, 0, sizeof (*a));
1174 a->cert = mp->certkey;
1175 a->key = mp->certkey + cert_len;
1176 a->cert_len = cert_len;
1177 a->key_len = key_len;
1178 rv = vnet_app_add_cert_key_pair (a);
1182 REPLY_MACRO2 (VL_API_APP_ADD_CERT_KEY_PAIR_REPLY, ({
1184 rmp->index = clib_host_to_net_u32 (a->index);
1190 vl_api_app_del_cert_key_pair_t_handler (vl_api_app_del_cert_key_pair_t * mp)
1192 vl_api_app_del_cert_key_pair_reply_t *rmp;
1195 if (session_main_is_enabled () == 0)
1197 rv = VNET_API_ERROR_FEATURE_DISABLED;
1200 ckpair_index = clib_net_to_host_u32 (mp->index);
1201 rv = vnet_app_del_cert_key_pair (ckpair_index);
1204 clib_warning ("vnet_app_del_cert_key_pair: %U", format_session_error,
1206 rv = VNET_API_ERROR_UNSPECIFIED;
1210 REPLY_MACRO (VL_API_APP_DEL_CERT_KEY_PAIR_REPLY);
1213 static clib_error_t *
1214 application_reaper_cb (u32 client_index)
1216 application_t *app = application_lookup (client_index);
1217 vnet_app_detach_args_t _a, *a = &_a;
1220 a->app_index = app->app_index;
1221 a->api_client_index = client_index;
1222 vnet_application_detach (a);
1227 VL_MSG_API_REAPER_FUNCTION (application_reaper_cb);
1230 * Socket api functions
1234 mq_send_add_segment_sapi_cb (u32 app_wrk_index, u64 segment_handle)
1236 session_app_add_segment_msg_t m = { 0 };
1237 app_worker_t *app_wrk;
1242 app_wrk = app_worker_get (app_wrk_index);
1244 fs = segment_manager_get_segment_w_handle (segment_handle);
1246 ASSERT (ssvm_type (sp) == SSVM_SEGMENT_MEMFD);
1248 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
1250 m.segment_size = sp->ssvm_size;
1251 m.fd_flags = fd_flags;
1252 m.segment_handle = segment_handle;
1253 strncpy ((char *) m.segment_name, (char *) sp->name,
1254 sizeof (m.segment_name) - 1);
1256 app_wrk_send_ctrl_evt_fd (app_wrk, SESSION_CTRL_EVT_APP_ADD_SEGMENT, &m,
1257 sizeof (m), sp->fd);
1263 mq_send_del_segment_sapi_cb (u32 app_wrk_index, u64 segment_handle)
1265 session_app_del_segment_msg_t m = { 0 };
1266 app_worker_t *app_wrk;
1268 app_wrk = app_worker_get (app_wrk_index);
1270 m.segment_handle = segment_handle;
1272 app_wrk_send_ctrl_evt (app_wrk, SESSION_CTRL_EVT_APP_DEL_SEGMENT, &m,
1278 static session_cb_vft_t session_mq_sapi_cb_vft = {
1279 .session_accept_callback = mq_send_session_accepted_cb,
1280 .session_disconnect_callback = mq_send_session_disconnected_cb,
1281 .session_connected_callback = mq_send_session_connected_cb,
1282 .session_reset_callback = mq_send_session_reset_cb,
1283 .session_migrate_callback = mq_send_session_migrate_cb,
1284 .session_cleanup_callback = mq_send_session_cleanup_cb,
1285 .add_segment_callback = mq_send_add_segment_sapi_cb,
1286 .del_segment_callback = mq_send_del_segment_sapi_cb,
1287 .builtin_app_rx_callback = mq_send_io_rx_event,
1288 .builtin_app_tx_callback = mq_send_io_tx_event,
1292 session_api_attach_handler (app_namespace_t * app_ns, clib_socket_t * cs,
1293 app_sapi_attach_msg_t * mp)
1295 int rv = 0, *fds = 0, n_fds = 0, i, n_workers;
1296 vnet_app_attach_args_t _a, *a = &_a;
1297 app_sapi_attach_reply_msg_t *rmp;
1298 u8 fd_flags = 0, ctrl_thread;
1299 app_ns_api_handle_t *handle;
1300 fifo_segment_t *rx_mqs_seg;
1301 app_sapi_msg_t msg = { 0 };
1302 app_worker_t *app_wrk;
1306 /* Make sure name is null terminated */
1309 clib_memset (a, 0, sizeof (*a));
1310 a->api_client_index = appns_sapi_socket_handle (app_ns, cs);
1311 a->name = format (0, "%s", (char *) mp->name);
1312 a->options = mp->options;
1313 a->session_cb_vft = &session_mq_sapi_cb_vft;
1314 a->use_sock_api = 1;
1315 a->options[APP_OPTIONS_NAMESPACE] = app_namespace_index (app_ns);
1317 if ((rv = vnet_application_attach (a)))
1319 clib_warning ("attach returned: %d", rv);
1323 n_workers = vlib_num_workers ();
1324 vec_validate (fds, 3 /* segs + tx evtfd */ + n_workers);
1326 /* Send event queues segment */
1327 app = application_get (a->app_index);
1328 rx_mqs_seg = application_get_rx_mqs_segment (app);
1330 fd_flags |= SESSION_FD_F_VPP_MQ_SEGMENT;
1331 fds[n_fds] = rx_mqs_seg->ssvm.fd;
1334 /* Send fifo segment fd if needed */
1335 if (ssvm_type (a->segment) == SSVM_SEGMENT_MEMFD)
1337 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
1338 fds[n_fds] = a->segment->fd;
1341 if (a->options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
1343 fd_flags |= SESSION_FD_F_MQ_EVENTFD;
1344 fds[n_fds] = svm_msg_q_get_eventfd (a->app_evt_q);
1348 if (application_use_private_rx_mqs ())
1350 fd_flags |= SESSION_FD_F_VPP_MQ_EVENTFD;
1351 for (i = 0; i < n_workers + 1; i++)
1353 rx_mq = application_rx_mq_get (app, i);
1354 fds[n_fds] = svm_msg_q_get_eventfd (rx_mq);
1361 msg.type = APP_SAPI_MSG_TYPE_ATTACH_REPLY;
1362 rmp = &msg.attach_reply;
1366 ctrl_thread = n_workers ? 1 : 0;
1367 rmp->app_index = a->app_index;
1369 fifo_segment_msg_q_offset ((fifo_segment_t *) a->segment, 0);
1370 rmp->vpp_ctrl_mq = fifo_segment_msg_q_offset (rx_mqs_seg, ctrl_thread);
1371 rmp->vpp_ctrl_mq_thread = ctrl_thread;
1373 rmp->fd_flags = fd_flags;
1374 /* No segment name and size since we only support memfds
1375 * in this configuration */
1376 rmp->segment_handle = a->segment_handle;
1377 rmp->api_client_handle = a->api_client_index;
1379 /* Update app index for socket */
1380 handle = (app_ns_api_handle_t *) & cs->private_data;
1381 app_wrk = application_get_worker (app, 0);
1382 handle->aah_app_wrk_index = app_wrk->wrk_index;
1385 clib_socket_sendmsg (cs, &msg, sizeof (msg), fds, n_fds);
1391 sapi_socket_close_w_handle (u32 api_handle)
1393 app_namespace_t *app_ns = app_namespace_get (api_handle >> 16);
1394 u16 sock_index = api_handle & 0xffff;
1395 app_ns_api_handle_t *handle;
1399 cs = appns_sapi_get_socket (app_ns, sock_index);
1403 handle = (app_ns_api_handle_t *) & cs->private_data;
1404 cf = clib_file_get (&file_main, handle->aah_file_index);
1405 clib_file_del (&file_main, cf);
1407 clib_socket_close (cs);
1408 appns_sapi_free_socket (app_ns, cs);
1412 sapi_add_del_worker_handler (app_namespace_t * app_ns,
1414 app_sapi_worker_add_del_msg_t * mp)
1416 int rv = 0, fds[SESSION_N_FD_TYPE], n_fds = 0;
1417 app_sapi_worker_add_del_reply_msg_t *rmp;
1418 app_ns_api_handle_t *handle;
1419 app_sapi_msg_t msg = { 0 };
1420 app_worker_t *app_wrk;
1421 u32 sapi_handle = -1;
1425 app = application_get_if_valid (mp->app_index);
1428 rv = SESSION_E_INVALID;
1432 sapi_handle = appns_sapi_socket_handle (app_ns, cs);
1434 vnet_app_worker_add_del_args_t args = {
1435 .app_index = app->app_index,
1436 .wrk_map_index = mp->wrk_index,
1437 .api_client_index = sapi_handle,
1438 .is_add = mp->is_add
1440 rv = vnet_app_worker_add_del (&args);
1443 clib_warning ("app worker add/del returned: %U", format_session_error,
1451 /* Send fifo segment fd if needed */
1452 if (ssvm_type (args.segment) == SSVM_SEGMENT_MEMFD)
1454 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
1455 fds[n_fds] = args.segment->fd;
1458 if (application_segment_manager_properties (app)->use_mq_eventfd)
1460 fd_flags |= SESSION_FD_F_MQ_EVENTFD;
1461 fds[n_fds] = svm_msg_q_get_eventfd (args.evt_q);
1467 /* With app sock api socket expected to be closed, no reply */
1468 if (!mp->is_add && appns_sapi_enabled ())
1471 msg.type = APP_SAPI_MSG_TYPE_ADD_DEL_WORKER_REPLY;
1472 rmp = &msg.worker_add_del_reply;
1474 rmp->is_add = mp->is_add;
1475 rmp->api_client_handle = sapi_handle;
1476 rmp->wrk_index = args.wrk_map_index;
1477 if (!rv && mp->is_add)
1479 rmp->segment_handle = args.segment_handle;
1480 /* No segment name and size. This supports only memfds */
1481 rmp->app_event_queue_address =
1482 fifo_segment_msg_q_offset ((fifo_segment_t *) args.segment, 0);
1484 rmp->fd_flags = fd_flags;
1486 /* Update app index for socket */
1487 handle = (app_ns_api_handle_t *) & cs->private_data;
1488 app_wrk = application_get_worker (app, args.wrk_map_index);
1489 handle->aah_app_wrk_index = app_wrk->wrk_index;
1492 clib_socket_sendmsg (cs, &msg, sizeof (msg), fds, n_fds);
1495 /* This is a workaround for the case when session layer starts reading
1496 * the socket before the client actualy sends the data
1498 static clib_error_t *
1499 sapi_socket_receive_wait (clib_socket_t *cs, u8 *msg, u32 msg_len)
1506 err = clib_socket_recvmsg (cs, msg, msg_len, 0, 0);
1521 sapi_add_del_cert_key_handler (app_namespace_t *app_ns, clib_socket_t *cs,
1522 app_sapi_cert_key_add_del_msg_t *mp)
1524 vnet_app_add_cert_key_pair_args_t _a, *a = &_a;
1525 app_sapi_cert_key_add_del_reply_msg_t *rmp;
1526 app_sapi_msg_t msg = { 0 };
1531 const u32 max_certkey_len = 2e4, max_cert_len = 1e4, max_key_len = 1e4;
1536 if (mp->certkey_len > max_certkey_len)
1538 rv = SESSION_E_INVALID;
1542 vec_validate (certkey, mp->certkey_len - 1);
1544 err = sapi_socket_receive_wait (cs, certkey, mp->certkey_len);
1547 clib_error_report (err);
1548 rv = SESSION_E_INVALID;
1552 if (mp->cert_len > max_cert_len)
1554 rv = SESSION_E_INVALID;
1558 if (mp->certkey_len < mp->cert_len)
1560 rv = SESSION_E_INVALID;
1564 key_len = mp->certkey_len - mp->cert_len;
1565 if (key_len > max_key_len)
1567 rv = SESSION_E_INVALID;
1571 clib_memset (a, 0, sizeof (*a));
1573 a->key = certkey + mp->cert_len;
1574 a->cert_len = mp->cert_len;
1575 a->key_len = key_len;
1576 rv = vnet_app_add_cert_key_pair (a);
1582 rv = vnet_app_del_cert_key_pair (mp->index);
1587 msg.type = APP_SAPI_MSG_TYPE_ADD_DEL_CERT_KEY_REPLY;
1588 rmp = &msg.cert_key_add_del_reply;
1590 rmp->context = mp->context;
1591 if (!rv && mp->is_add)
1592 rmp->index = a->index;
1594 clib_socket_sendmsg (cs, &msg, sizeof (msg), 0, 0);
1598 sapi_socket_detach (app_namespace_t * app_ns, clib_socket_t * cs)
1600 app_ns_api_handle_t *handle;
1601 app_worker_t *app_wrk;
1602 u32 api_client_handle;
1604 api_client_handle = appns_sapi_socket_handle (app_ns, cs);
1606 /* Cleanup everything because app worker closed socket or crashed */
1607 handle = (app_ns_api_handle_t *) & cs->private_data;
1608 app_wrk = app_worker_get_if_valid (handle->aah_app_wrk_index);
1612 vnet_app_worker_add_del_args_t args = {
1613 .app_index = app_wrk->app_index,
1614 .wrk_map_index = app_wrk->wrk_map_index,
1615 .api_client_index = api_client_handle,
1618 /* Send rpc to main thread for worker barrier */
1619 vlib_rpc_call_main_thread (vnet_app_worker_add_del, (u8 *) & args,
1623 static clib_error_t *
1624 sapi_sock_read_ready (clib_file_t * cf)
1626 app_ns_api_handle_t *handle = (app_ns_api_handle_t *) & cf->private_data;
1627 vlib_main_t *vm = vlib_get_main ();
1628 app_sapi_msg_t msg = { 0 };
1629 app_namespace_t *app_ns;
1630 clib_error_t *err = 0;
1633 app_ns = app_namespace_get (handle->aah_app_ns_index);
1634 cs = appns_sapi_get_socket (app_ns, handle->aah_sock_index);
1638 err = clib_socket_recvmsg (cs, &msg, sizeof (msg), 0, 0);
1641 clib_error_free (err);
1642 sapi_socket_detach (app_ns, cs);
1646 handle = (app_ns_api_handle_t *) & cs->private_data;
1648 vlib_worker_thread_barrier_sync (vm);
1652 case APP_SAPI_MSG_TYPE_ATTACH:
1653 session_api_attach_handler (app_ns, cs, &msg.attach);
1655 case APP_SAPI_MSG_TYPE_ADD_DEL_WORKER:
1656 sapi_add_del_worker_handler (app_ns, cs, &msg.worker_add_del);
1658 case APP_SAPI_MSG_TYPE_ADD_DEL_CERT_KEY:
1659 sapi_add_del_cert_key_handler (app_ns, cs, &msg.cert_key_add_del);
1662 clib_warning ("app wrk %u unknown message type: %u",
1663 handle->aah_app_wrk_index, msg.type);
1667 vlib_worker_thread_barrier_release (vm);
1673 static clib_error_t *
1674 sapi_sock_write_ready (clib_file_t * cf)
1676 app_ns_api_handle_t *handle = (app_ns_api_handle_t *) & cf->private_data;
1677 clib_warning ("called for app ns %u", handle->aah_app_ns_index);
1681 static clib_error_t *
1682 sapi_sock_error (clib_file_t * cf)
1684 app_ns_api_handle_t *handle = (app_ns_api_handle_t *) & cf->private_data;
1685 app_namespace_t *app_ns;
1688 app_ns = app_namespace_get (handle->aah_app_ns_index);
1689 cs = appns_sapi_get_socket (app_ns, handle->aah_sock_index);
1693 sapi_socket_detach (app_ns, cs);
1697 static clib_error_t *
1698 sapi_sock_accept_ready (clib_file_t * scf)
1700 app_ns_api_handle_t handle = *(app_ns_api_handle_t *) & scf->private_data;
1701 app_namespace_t *app_ns;
1702 clib_file_t cf = { 0 };
1703 clib_error_t *err = 0;
1704 clib_socket_t *ccs, *scs;
1706 /* Listener files point to namespace */
1707 app_ns = app_namespace_get (handle.aah_app_ns_index);
1710 * Initialize client socket
1712 ccs = appns_sapi_alloc_socket (app_ns);
1714 /* Grab server socket after client is initialized */
1715 scs = appns_sapi_get_socket (app_ns, handle.aah_sock_index);
1719 err = clib_socket_accept (scs, ccs);
1722 clib_error_report (err);
1726 cf.read_function = sapi_sock_read_ready;
1727 cf.write_function = sapi_sock_write_ready;
1728 cf.error_function = sapi_sock_error;
1729 cf.file_descriptor = ccs->fd;
1730 /* File points to app namespace and socket */
1731 handle.aah_sock_index = appns_sapi_socket_index (app_ns, ccs);
1732 cf.private_data = handle.as_u64;
1733 cf.description = format (0, "app sock conn fd: %d", ccs->fd);
1735 /* Poll until we get an attach message. Socket points to file and
1736 * application that owns the socket */
1737 handle.aah_app_wrk_index = APP_INVALID_INDEX;
1738 handle.aah_file_index = clib_file_add (&file_main, &cf);
1739 ccs->private_data = handle.as_u64;
1744 appns_sapi_free_socket (app_ns, ccs);
1749 appns_sapi_del_ns_socket (app_namespace_t *app_ns)
1751 app_ns_api_handle_t *handle;
1754 pool_foreach (cs, app_ns->app_sockets)
1756 handle = (app_ns_api_handle_t *) &cs->private_data;
1757 clib_file_del_by_index (&file_main, handle->aah_file_index);
1759 clib_socket_close (cs);
1760 clib_socket_free (cs);
1762 pool_free (app_ns->app_sockets);
1766 appns_sapi_add_ns_socket (app_namespace_t * app_ns)
1768 char *subdir = "/app_ns_sockets/";
1769 app_ns_api_handle_t *handle;
1770 clib_file_t cf = { 0 };
1771 struct stat file_stat;
1776 snprintf (dir, sizeof (dir), "%s%s", vlib_unix_get_runtime_dir (), subdir);
1778 if (!app_ns->sock_name)
1779 app_ns->sock_name = format (0, "%s%v%c", dir, app_ns->ns_id, 0);
1782 * Create and initialize socket to listen on
1784 cs = appns_sapi_alloc_socket (app_ns);
1785 cs->config = (char *) vec_dup (app_ns->sock_name);
1786 cs->flags = CLIB_SOCKET_F_IS_SERVER |
1787 CLIB_SOCKET_F_ALLOW_GROUP_WRITE |
1788 CLIB_SOCKET_F_SEQPACKET | CLIB_SOCKET_F_PASSCRED;
1790 if (clib_socket_prefix_get_type (cs->config) == CLIB_SOCKET_TYPE_UNIX)
1792 err = vlib_unix_recursive_mkdir ((char *) dir);
1795 clib_error_report (err);
1796 return SESSION_E_SYSCALL;
1800 if ((err = clib_socket_init (cs)))
1802 clib_error_report (err);
1806 if (clib_socket_prefix_get_type (cs->config) == CLIB_SOCKET_TYPE_UNIX &&
1807 stat ((char *) app_ns->sock_name, &file_stat) == -1)
1813 cf.read_function = sapi_sock_accept_ready;
1814 cf.file_descriptor = cs->fd;
1815 /* File points to namespace */
1816 handle = (app_ns_api_handle_t *) & cf.private_data;
1817 handle->aah_app_ns_index = app_namespace_index (app_ns);
1818 handle->aah_sock_index = appns_sapi_socket_index (app_ns, cs);
1819 cf.description = format (0, "app sock listener: %s", app_ns->sock_name);
1821 /* Socket points to clib file index */
1822 handle = (app_ns_api_handle_t *) & cs->private_data;
1823 handle->aah_file_index = clib_file_add (&file_main, &cf);
1824 handle->aah_app_wrk_index = APP_INVALID_INDEX;
1829 #include <vnet/session/session.api.c>
1830 static clib_error_t *
1831 session_api_hookup (vlib_main_t *vm)
1834 * Set up the (msg_name, crc, message-id) table
1836 REPLY_MSG_ID_BASE = setup_message_id_table ();
1841 VLIB_API_INIT_FUNCTION (session_api_hookup);
1844 * fd.io coding-style-patch-verification: ON
1847 * eval: (c-set-style "gnu")