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_cb (u32 app_wrk_index, session_handle_t sh, u32 context,
332 session_unlisten_reply_msg_t m = { 0 };
333 app_worker_t *app_wrk;
335 app_wrk = app_worker_get (app_wrk_index);
340 app_wrk_send_ctrl_evt (app_wrk, SESSION_CTRL_EVT_UNLISTEN_REPLY, &m,
345 mq_send_session_migrate_cb (session_t * s, session_handle_t new_sh)
347 session_migrated_msg_t m = { 0 };
348 fifo_segment_t *eq_seg;
349 app_worker_t *app_wrk;
353 thread_index = session_thread_from_handle (new_sh);
354 app_wrk = app_worker_get (s->app_wrk_index);
355 app = application_get (app_wrk->app_index);
356 eq_seg = application_get_rx_mqs_segment (app);
358 m.handle = session_handle (s);
359 m.new_handle = new_sh;
360 m.vpp_thread_index = thread_index;
361 m.vpp_evt_q = fifo_segment_msg_q_offset (eq_seg, thread_index);
362 m.segment_handle = SESSION_INVALID_HANDLE;
364 app_wrk_send_ctrl_evt (app_wrk, SESSION_CTRL_EVT_MIGRATED, &m, sizeof (m));
368 mq_send_add_segment_cb (u32 app_wrk_index, u64 segment_handle)
370 session_app_add_segment_msg_t m = { 0 };
371 vl_api_registration_t *reg;
372 app_worker_t *app_wrk;
377 app_wrk = app_worker_get (app_wrk_index);
379 reg = vl_mem_api_client_index_to_registration (app_wrk->api_client_index);
382 clib_warning ("no api registration for client: %u",
383 app_wrk->api_client_index);
387 fs = segment_manager_get_segment_w_handle (segment_handle);
389 if (ssvm_type (sp) == SSVM_SEGMENT_MEMFD)
391 if (vl_api_registration_file_index (reg) == VL_API_INVALID_FI)
393 clib_warning ("can't send memfd fd");
397 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
400 m.segment_size = sp->ssvm_size;
401 m.fd_flags = fd_flags;
402 m.segment_handle = segment_handle;
403 strncpy ((char *) m.segment_name, (char *) sp->name,
404 sizeof (m.segment_name) - 1);
406 app_wrk_send_ctrl_evt_fd (app_wrk, SESSION_CTRL_EVT_APP_ADD_SEGMENT, &m,
413 mq_send_del_segment_cb (u32 app_wrk_index, u64 segment_handle)
415 session_app_del_segment_msg_t m = { 0 };
416 vl_api_registration_t *reg;
417 app_worker_t *app_wrk;
419 app_wrk = app_worker_get (app_wrk_index);
420 reg = vl_mem_api_client_index_to_registration (app_wrk->api_client_index);
423 clib_warning ("no registration: %u", app_wrk->api_client_index);
427 m.segment_handle = segment_handle;
429 app_wrk_send_ctrl_evt (app_wrk, SESSION_CTRL_EVT_APP_DEL_SEGMENT, &m,
436 mq_send_session_cleanup_cb (session_t * s, session_cleanup_ntf_t ntf)
438 session_cleanup_msg_t m = { 0 };
439 app_worker_t *app_wrk;
441 /* Propagate transport cleanup notifications only if app didn't close */
442 if (ntf == SESSION_CLEANUP_TRANSPORT
443 && s->session_state != SESSION_STATE_TRANSPORT_DELETED)
446 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
450 m.handle = session_handle (s);
453 app_wrk_send_ctrl_evt (app_wrk, SESSION_CTRL_EVT_CLEANUP, &m, sizeof (m));
457 mq_send_io_rx_event (session_t *s)
459 session_event_t *mq_evt;
460 svm_msg_q_msg_t mq_msg;
461 app_worker_t *app_wrk;
464 if (svm_fifo_has_event (s->rx_fifo))
467 app_wrk = app_worker_get (s->app_wrk_index);
468 mq = app_wrk->event_queue;
470 mq_msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
471 mq_evt = svm_msg_q_msg_data (mq, &mq_msg);
473 mq_evt->event_type = SESSION_IO_EVT_RX;
474 mq_evt->session_index = s->rx_fifo->shr->client_session_index;
476 (void) svm_fifo_set_event (s->rx_fifo);
478 svm_msg_q_add_raw (mq, &mq_msg);
484 mq_send_io_tx_event (session_t *s)
486 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
487 svm_msg_q_t *mq = app_wrk->event_queue;
488 session_event_t *mq_evt;
489 svm_msg_q_msg_t mq_msg;
491 mq_msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
492 mq_evt = svm_msg_q_msg_data (mq, &mq_msg);
494 mq_evt->event_type = SESSION_IO_EVT_TX;
495 mq_evt->session_index = s->tx_fifo->shr->client_session_index;
497 svm_msg_q_add_raw (mq, &mq_msg);
502 static session_cb_vft_t session_mq_cb_vft = {
503 .session_accept_callback = mq_send_session_accepted_cb,
504 .session_disconnect_callback = mq_send_session_disconnected_cb,
505 .session_connected_callback = mq_send_session_connected_cb,
506 .session_reset_callback = mq_send_session_reset_cb,
507 .session_migrate_callback = mq_send_session_migrate_cb,
508 .session_cleanup_callback = mq_send_session_cleanup_cb,
509 .session_listened_callback = mq_send_session_bound_cb,
510 .session_unlistened_callback = mq_send_unlisten_cb,
511 .add_segment_callback = mq_send_add_segment_cb,
512 .del_segment_callback = mq_send_del_segment_cb,
513 .builtin_app_rx_callback = mq_send_io_rx_event,
514 .builtin_app_tx_callback = mq_send_io_tx_event,
518 vl_api_session_enable_disable_t_handler (vl_api_session_enable_disable_t * mp)
520 vl_api_session_enable_disable_reply_t *rmp;
521 vlib_main_t *vm = vlib_get_main ();
524 vnet_session_enable_disable (vm, mp->is_enable);
525 REPLY_MACRO (VL_API_SESSION_ENABLE_DISABLE_REPLY);
529 vl_api_session_sapi_enable_disable_t_handler (
530 vl_api_session_sapi_enable_disable_t *mp)
532 vl_api_session_sapi_enable_disable_reply_t *rmp;
535 rv = appns_sapi_enable_disable (mp->is_enable);
536 REPLY_MACRO (VL_API_SESSION_SAPI_ENABLE_DISABLE_REPLY);
540 vl_api_app_attach_t_handler (vl_api_app_attach_t * mp)
542 int rv = 0, *fds = 0, n_fds = 0, n_workers, i;
543 fifo_segment_t *segp, *rx_mqs_seg = 0;
544 vnet_app_attach_args_t _a, *a = &_a;
545 vl_api_app_attach_reply_t *rmp;
546 u8 fd_flags = 0, ctrl_thread;
547 vl_api_registration_t *reg;
551 reg = vl_api_client_index_to_registration (mp->client_index);
555 n_workers = vlib_num_workers ();
556 if (!session_main_is_enabled () || appns_sapi_enabled ())
558 rv = VNET_API_ERROR_FEATURE_DISABLED;
561 /* Only support binary api with socket transport */
562 if (vl_api_registration_file_index (reg) == VL_API_INVALID_FI)
564 rv = VNET_API_ERROR_APP_UNSUPPORTED_CFG;
568 STATIC_ASSERT (sizeof (u64) * APP_OPTIONS_N_OPTIONS <=
569 sizeof (mp->options),
570 "Out of options, fix api message definition");
572 clib_memset (a, 0, sizeof (*a));
573 a->api_client_index = mp->client_index;
574 a->options = mp->options;
575 a->session_cb_vft = &session_mq_cb_vft;
576 a->namespace_id = vl_api_from_api_to_new_vec (mp, &mp->namespace_id);
578 if ((rv = vnet_application_attach (a)))
580 clib_warning ("attach returned: %U", format_session_error, rv);
581 rv = VNET_API_ERROR_UNSPECIFIED;
582 vec_free (a->namespace_id);
585 vec_free (a->namespace_id);
587 vec_validate (fds, 3 /* segs + tx evtfd */ + n_workers);
589 /* Send rx mqs segment */
590 app = application_get (a->app_index);
591 rx_mqs_seg = application_get_rx_mqs_segment (app);
593 fd_flags |= SESSION_FD_F_VPP_MQ_SEGMENT;
594 fds[n_fds] = rx_mqs_seg->ssvm.fd;
597 /* Send fifo segment fd if needed */
598 if (ssvm_type (a->segment) == SSVM_SEGMENT_MEMFD)
600 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
601 fds[n_fds] = a->segment->fd;
604 if (a->options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
606 fd_flags |= SESSION_FD_F_MQ_EVENTFD;
607 fds[n_fds] = svm_msg_q_get_eventfd (a->app_evt_q);
611 if (application_use_private_rx_mqs ())
613 fd_flags |= SESSION_FD_F_VPP_MQ_EVENTFD;
614 for (i = 0; i < n_workers + 1; i++)
616 rx_mq = application_rx_mq_get (app, i);
617 fds[n_fds] = svm_msg_q_get_eventfd (rx_mq);
625 VL_API_APP_ATTACH_REPLY,
626 ((!rv) ? vec_len (((fifo_segment_t *) a->segment)->ssvm.name) : 0), ({
629 ctrl_thread = n_workers ? 1 : 0;
630 segp = (fifo_segment_t *) a->segment;
631 rmp->app_index = clib_host_to_net_u32 (a->app_index);
632 rmp->app_mq = fifo_segment_msg_q_offset (segp, 0);
634 fifo_segment_msg_q_offset (rx_mqs_seg, ctrl_thread);
635 rmp->vpp_ctrl_mq_thread = ctrl_thread;
637 rmp->fd_flags = fd_flags;
638 if (vec_len (segp->ssvm.name))
640 vl_api_vec_to_api_string (segp->ssvm.name, &rmp->segment_name);
642 rmp->segment_size = segp->ssvm.ssvm_size;
643 rmp->segment_handle = clib_host_to_net_u64 (a->segment_handle);
649 session_send_fds (reg, fds, n_fds);
654 vl_api_app_worker_add_del_t_handler (vl_api_app_worker_add_del_t * mp)
656 int rv = 0, fds[SESSION_N_FD_TYPE], n_fds = 0;
657 vl_api_app_worker_add_del_reply_t *rmp;
658 vl_api_registration_t *reg;
662 if (!session_main_is_enabled () || appns_sapi_enabled ())
664 rv = VNET_API_ERROR_FEATURE_DISABLED;
668 reg = vl_api_client_index_to_registration (mp->client_index);
672 app = application_get_if_valid (clib_net_to_host_u32 (mp->app_index));
675 rv = VNET_API_ERROR_INVALID_VALUE;
679 vnet_app_worker_add_del_args_t args = {
680 .app_index = app->app_index,
681 .wrk_map_index = clib_net_to_host_u32 (mp->wrk_index),
682 .api_client_index = mp->client_index,
685 rv = vnet_app_worker_add_del (&args);
688 clib_warning ("app worker add/del returned: %U", format_session_error,
690 rv = VNET_API_ERROR_UNSPECIFIED;
697 /* Send fifo segment fd if needed */
698 if (ssvm_type (args.segment) == SSVM_SEGMENT_MEMFD)
700 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
701 fds[n_fds] = args.segment->fd;
704 if (application_segment_manager_properties (app)->use_mq_eventfd)
706 fd_flags |= SESSION_FD_F_MQ_EVENTFD;
707 fds[n_fds] = svm_msg_q_get_eventfd (args.evt_q);
714 VL_API_APP_WORKER_ADD_DEL_REPLY,
715 ((!rv && mp->is_add) ? vec_len (args.segment->name) : 0), ({
716 rmp->is_add = mp->is_add;
717 rmp->wrk_index = clib_host_to_net_u32 (args.wrk_map_index);
718 if (!rv && mp->is_add)
720 rmp->segment_handle = clib_host_to_net_u64 (args.segment_handle);
721 rmp->app_event_queue_address =
722 fifo_segment_msg_q_offset ((fifo_segment_t *) args.segment, 0);
724 rmp->fd_flags = fd_flags;
725 if (vec_len (args.segment->name))
727 vl_api_vec_to_api_string (args.segment->name,
735 session_send_fds (reg, fds, n_fds);
739 vl_api_application_detach_t_handler (vl_api_application_detach_t * mp)
741 vl_api_application_detach_reply_t *rmp;
742 int rv = VNET_API_ERROR_INVALID_VALUE_2;
743 vnet_app_detach_args_t _a, *a = &_a;
746 if (!session_main_is_enabled () || appns_sapi_enabled ())
748 rv = VNET_API_ERROR_FEATURE_DISABLED;
752 app = application_lookup (mp->client_index);
755 a->app_index = app->app_index;
756 a->api_client_index = mp->client_index;
757 rv = vnet_application_detach (a);
760 clib_warning ("vnet_application_detach: %U", format_session_error,
762 rv = VNET_API_ERROR_UNSPECIFIED;
767 REPLY_MACRO (VL_API_APPLICATION_DETACH_REPLY);
771 vl_api_app_namespace_add_del_t_handler (vl_api_app_namespace_add_del_t * mp)
773 vl_api_app_namespace_add_del_reply_t *rmp;
777 if (session_main_is_enabled () == 0)
779 rv = VNET_API_ERROR_FEATURE_DISABLED;
783 ns_id = vl_api_from_api_to_new_vec (mp, &mp->namespace_id);
785 vnet_app_namespace_add_del_args_t args = {
788 .secret = clib_net_to_host_u64 (mp->secret),
789 .sw_if_index = clib_net_to_host_u32 (mp->sw_if_index),
790 .ip4_fib_id = clib_net_to_host_u32 (mp->ip4_fib_id),
791 .ip6_fib_id = clib_net_to_host_u32 (mp->ip6_fib_id),
794 rv = vnet_app_namespace_add_del (&args);
797 appns_index = app_namespace_index_from_id (ns_id);
798 if (appns_index == APP_NAMESPACE_INVALID_INDEX)
800 clib_warning ("app ns lookup failed");
801 rv = VNET_API_ERROR_UNSPECIFIED;
808 REPLY_MACRO2 (VL_API_APP_NAMESPACE_ADD_DEL_REPLY, ({
810 rmp->appns_index = clib_host_to_net_u32 (appns_index);
816 vl_api_app_namespace_add_del_v2_t_handler (
817 vl_api_app_namespace_add_del_v2_t *mp)
819 vl_api_app_namespace_add_del_v2_reply_t *rmp;
824 if (session_main_is_enabled () == 0)
826 rv = VNET_API_ERROR_FEATURE_DISABLED;
830 mp->namespace_id[sizeof (mp->namespace_id) - 1] = 0;
831 ns_id = format (0, "%s", &mp->namespace_id);
833 vnet_app_namespace_add_del_args_t args = {
836 .secret = clib_net_to_host_u64 (mp->secret),
837 .sw_if_index = clib_net_to_host_u32 (mp->sw_if_index),
838 .ip4_fib_id = clib_net_to_host_u32 (mp->ip4_fib_id),
839 .ip6_fib_id = clib_net_to_host_u32 (mp->ip6_fib_id),
842 rv = vnet_app_namespace_add_del (&args);
845 appns_index = app_namespace_index_from_id (ns_id);
846 if (appns_index == APP_NAMESPACE_INVALID_INDEX)
848 clib_warning ("app ns lookup failed id:%s", ns_id);
849 rv = VNET_API_ERROR_UNSPECIFIED;
855 REPLY_MACRO2 (VL_API_APP_NAMESPACE_ADD_DEL_V2_REPLY, ({
857 rmp->appns_index = clib_host_to_net_u32 (appns_index);
862 vl_api_app_namespace_add_del_v4_t_handler (
863 vl_api_app_namespace_add_del_v4_t *mp)
865 vl_api_app_namespace_add_del_v4_reply_t *rmp;
866 u8 *ns_id = 0, *sock_name = 0;
869 if (session_main_is_enabled () == 0)
871 rv = VNET_API_ERROR_FEATURE_DISABLED;
874 mp->namespace_id[sizeof (mp->namespace_id) - 1] = 0;
875 ns_id = format (0, "%s", &mp->namespace_id);
876 sock_name = vl_api_from_api_to_new_vec (mp, &mp->sock_name);
877 vnet_app_namespace_add_del_args_t args = {
879 .sock_name = sock_name,
880 .secret = clib_net_to_host_u64 (mp->secret),
881 .sw_if_index = clib_net_to_host_u32 (mp->sw_if_index),
882 .ip4_fib_id = clib_net_to_host_u32 (mp->ip4_fib_id),
883 .ip6_fib_id = clib_net_to_host_u32 (mp->ip6_fib_id),
884 .is_add = mp->is_add,
886 rv = vnet_app_namespace_add_del (&args);
887 if (!rv && mp->is_add)
889 appns_index = app_namespace_index_from_id (ns_id);
890 if (appns_index == APP_NAMESPACE_INVALID_INDEX)
892 clib_warning ("app ns lookup failed id:%s", ns_id);
893 rv = VNET_API_ERROR_UNSPECIFIED;
897 vec_free (sock_name);
899 REPLY_MACRO2 (VL_API_APP_NAMESPACE_ADD_DEL_V4_REPLY, ({
901 rmp->appns_index = clib_host_to_net_u32 (appns_index);
906 vl_api_app_namespace_add_del_v3_t_handler (
907 vl_api_app_namespace_add_del_v3_t *mp)
909 vl_api_app_namespace_add_del_v3_reply_t *rmp;
910 u8 *ns_id = 0, *sock_name = 0, *api_sock_name = 0;
913 if (session_main_is_enabled () == 0)
915 rv = VNET_API_ERROR_FEATURE_DISABLED;
918 mp->namespace_id[sizeof (mp->namespace_id) - 1] = 0;
919 ns_id = format (0, "%s", &mp->namespace_id);
920 api_sock_name = vl_api_from_api_to_new_vec (mp, &mp->sock_name);
921 mp->netns[sizeof (mp->netns) - 1] = 0;
922 if (strlen ((char *) mp->netns) != 0)
925 format (0, "abstract:%v,netns_name=%s", api_sock_name, &mp->netns);
929 sock_name = api_sock_name;
930 api_sock_name = 0; // for vec_free
933 vnet_app_namespace_add_del_args_t args = {
935 .sock_name = sock_name,
936 .secret = clib_net_to_host_u64 (mp->secret),
937 .sw_if_index = clib_net_to_host_u32 (mp->sw_if_index),
938 .ip4_fib_id = clib_net_to_host_u32 (mp->ip4_fib_id),
939 .ip6_fib_id = clib_net_to_host_u32 (mp->ip6_fib_id),
940 .is_add = mp->is_add,
942 rv = vnet_app_namespace_add_del (&args);
943 if (!rv && mp->is_add)
945 appns_index = app_namespace_index_from_id (ns_id);
946 if (appns_index == APP_NAMESPACE_INVALID_INDEX)
948 clib_warning ("app ns lookup failed id:%s", ns_id);
949 rv = VNET_API_ERROR_UNSPECIFIED;
953 vec_free (sock_name);
954 vec_free (api_sock_name);
956 REPLY_MACRO2 (VL_API_APP_NAMESPACE_ADD_DEL_V3_REPLY, ({
958 rmp->appns_index = clib_host_to_net_u32 (appns_index);
963 vl_api_session_rule_add_del_t_handler (vl_api_session_rule_add_del_t * mp)
965 vl_api_session_rule_add_del_reply_t *rmp;
966 session_rule_add_del_args_t args;
967 session_rule_table_add_del_args_t *table_args = &args.table_args;
970 clib_memset (&args, 0, sizeof (args));
972 ip_prefix_decode (&mp->lcl, &table_args->lcl);
973 ip_prefix_decode (&mp->rmt, &table_args->rmt);
975 table_args->lcl_port = mp->lcl_port;
976 table_args->rmt_port = mp->rmt_port;
977 table_args->action_index = clib_net_to_host_u32 (mp->action_index);
978 table_args->is_add = mp->is_add;
979 mp->tag[sizeof (mp->tag) - 1] = 0;
980 table_args->tag = format (0, "%s", mp->tag);
981 args.appns_index = clib_net_to_host_u32 (mp->appns_index);
982 args.scope = mp->scope;
983 args.transport_proto =
984 api_session_transport_proto_decode (&mp->transport_proto) ==
985 TRANSPORT_PROTO_UDP ? 1 : 0;
987 rv = vnet_session_rule_add_del (&args);
990 clib_warning ("rule add del returned: %U", format_session_error, rv);
991 rv = VNET_API_ERROR_UNSPECIFIED;
993 vec_free (table_args->tag);
994 REPLY_MACRO (VL_API_SESSION_RULE_ADD_DEL_REPLY);
998 send_session_rule_details4 (mma_rule_16_t * rule, u8 is_local,
999 u8 transport_proto, u32 appns_index, u8 * tag,
1000 vl_api_registration_t * reg, u32 context)
1002 vl_api_session_rules_details_t *rmp = 0;
1003 session_mask_or_match_4_t *match =
1004 (session_mask_or_match_4_t *) & rule->match;
1005 session_mask_or_match_4_t *mask =
1006 (session_mask_or_match_4_t *) & rule->mask;
1007 fib_prefix_t lcl, rmt;
1009 rmp = vl_msg_api_alloc (sizeof (*rmp));
1010 clib_memset (rmp, 0, sizeof (*rmp));
1011 rmp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_SESSION_RULES_DETAILS);
1012 rmp->context = context;
1014 clib_memset (&lcl, 0, sizeof (lcl));
1015 clib_memset (&rmt, 0, sizeof (rmt));
1016 ip_set (&lcl.fp_addr, &match->lcl_ip, 1);
1017 ip_set (&rmt.fp_addr, &match->rmt_ip, 1);
1018 lcl.fp_len = ip4_mask_to_preflen (&mask->lcl_ip);
1019 rmt.fp_len = ip4_mask_to_preflen (&mask->rmt_ip);
1021 ip_prefix_encode (&lcl, &rmp->lcl);
1022 ip_prefix_encode (&rmt, &rmp->rmt);
1023 rmp->lcl_port = match->lcl_port;
1024 rmp->rmt_port = match->rmt_port;
1025 rmp->action_index = clib_host_to_net_u32 (rule->action_index);
1027 is_local ? SESSION_RULE_SCOPE_API_LOCAL : SESSION_RULE_SCOPE_API_GLOBAL;
1028 rmp->transport_proto = api_session_transport_proto_encode (transport_proto);
1029 rmp->appns_index = clib_host_to_net_u32 (appns_index);
1032 clib_memcpy_fast (rmp->tag, tag, vec_len (tag));
1033 rmp->tag[vec_len (tag)] = 0;
1036 vl_api_send_msg (reg, (u8 *) rmp);
1040 send_session_rule_details6 (mma_rule_40_t * rule, u8 is_local,
1041 u8 transport_proto, u32 appns_index, u8 * tag,
1042 vl_api_registration_t * reg, u32 context)
1044 vl_api_session_rules_details_t *rmp = 0;
1045 session_mask_or_match_6_t *match =
1046 (session_mask_or_match_6_t *) & rule->match;
1047 session_mask_or_match_6_t *mask =
1048 (session_mask_or_match_6_t *) & rule->mask;
1049 fib_prefix_t lcl, rmt;
1051 rmp = vl_msg_api_alloc (sizeof (*rmp));
1052 clib_memset (rmp, 0, sizeof (*rmp));
1053 rmp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_SESSION_RULES_DETAILS);
1054 rmp->context = context;
1056 clib_memset (&lcl, 0, sizeof (lcl));
1057 clib_memset (&rmt, 0, sizeof (rmt));
1058 ip_set (&lcl.fp_addr, &match->lcl_ip, 0);
1059 ip_set (&rmt.fp_addr, &match->rmt_ip, 0);
1060 lcl.fp_len = ip6_mask_to_preflen (&mask->lcl_ip);
1061 rmt.fp_len = ip6_mask_to_preflen (&mask->rmt_ip);
1063 ip_prefix_encode (&lcl, &rmp->lcl);
1064 ip_prefix_encode (&rmt, &rmp->rmt);
1065 rmp->lcl_port = match->lcl_port;
1066 rmp->rmt_port = match->rmt_port;
1067 rmp->action_index = clib_host_to_net_u32 (rule->action_index);
1069 is_local ? SESSION_RULE_SCOPE_API_LOCAL : SESSION_RULE_SCOPE_API_GLOBAL;
1070 rmp->transport_proto = api_session_transport_proto_encode (transport_proto);
1071 rmp->appns_index = clib_host_to_net_u32 (appns_index);
1074 clib_memcpy_fast (rmp->tag, tag, vec_len (tag));
1075 rmp->tag[vec_len (tag)] = 0;
1078 vl_api_send_msg (reg, (u8 *) rmp);
1082 send_session_rules_table_details (session_rules_table_t * srt, u8 fib_proto,
1083 u8 tp, u8 is_local, u32 appns_index,
1084 vl_api_registration_t * reg, u32 context)
1086 mma_rule_16_t *rule16;
1087 mma_rule_40_t *rule40;
1088 mma_rules_table_16_t *srt16;
1089 mma_rules_table_40_t *srt40;
1092 if (is_local || fib_proto == FIB_PROTOCOL_IP4)
1096 srt16 = &srt->session_rules_tables_16;
1097 pool_foreach (rule16, srt16->rules) {
1098 ri = mma_rules_table_rule_index_16 (srt16, rule16);
1099 tag = session_rules_table_rule_tag (srt, ri, 1);
1100 send_session_rule_details4 (rule16, is_local, tp, appns_index, tag,
1105 if (is_local || fib_proto == FIB_PROTOCOL_IP6)
1109 srt40 = &srt->session_rules_tables_40;
1110 pool_foreach (rule40, srt40->rules) {
1111 ri = mma_rules_table_rule_index_40 (srt40, rule40);
1112 tag = session_rules_table_rule_tag (srt, ri, 1);
1113 send_session_rule_details6 (rule40, is_local, tp, appns_index, tag,
1121 vl_api_session_rules_dump_t_handler (vl_api_session_rules_dump_t * mp)
1123 vl_api_registration_t *reg;
1124 session_table_t *st;
1127 reg = vl_api_client_index_to_registration (mp->client_index);
1132 session_table_foreach (st, ({
1133 for (tp = 0; tp < TRANSPORT_N_PROTOS; tp++)
1135 send_session_rules_table_details (&st->session_rules[tp],
1136 st->active_fib_proto, tp,
1137 st->is_local, st->appns_index, reg,
1145 vl_api_app_add_cert_key_pair_t_handler (vl_api_app_add_cert_key_pair_t * mp)
1147 vl_api_app_add_cert_key_pair_reply_t *rmp;
1148 vnet_app_add_cert_key_pair_args_t _a, *a = &_a;
1149 u32 certkey_len, key_len, cert_len;
1151 if (session_main_is_enabled () == 0)
1153 rv = VNET_API_ERROR_FEATURE_DISABLED;
1157 cert_len = clib_net_to_host_u16 (mp->cert_len);
1158 if (cert_len > 10000)
1160 rv = VNET_API_ERROR_INVALID_VALUE;
1164 certkey_len = clib_net_to_host_u16 (mp->certkey_len);
1165 if (certkey_len < cert_len)
1167 rv = VNET_API_ERROR_INVALID_VALUE;
1171 key_len = certkey_len - cert_len;
1172 if (key_len > 10000)
1174 rv = VNET_API_ERROR_INVALID_VALUE;
1178 clib_memset (a, 0, sizeof (*a));
1179 a->cert = mp->certkey;
1180 a->key = mp->certkey + cert_len;
1181 a->cert_len = cert_len;
1182 a->key_len = key_len;
1183 rv = vnet_app_add_cert_key_pair (a);
1187 REPLY_MACRO2 (VL_API_APP_ADD_CERT_KEY_PAIR_REPLY, ({
1189 rmp->index = clib_host_to_net_u32 (a->index);
1195 vl_api_app_del_cert_key_pair_t_handler (vl_api_app_del_cert_key_pair_t * mp)
1197 vl_api_app_del_cert_key_pair_reply_t *rmp;
1200 if (session_main_is_enabled () == 0)
1202 rv = VNET_API_ERROR_FEATURE_DISABLED;
1205 ckpair_index = clib_net_to_host_u32 (mp->index);
1206 rv = vnet_app_del_cert_key_pair (ckpair_index);
1209 clib_warning ("vnet_app_del_cert_key_pair: %U", format_session_error,
1211 rv = VNET_API_ERROR_UNSPECIFIED;
1215 REPLY_MACRO (VL_API_APP_DEL_CERT_KEY_PAIR_REPLY);
1218 static clib_error_t *
1219 application_reaper_cb (u32 client_index)
1221 application_t *app = application_lookup (client_index);
1222 vnet_app_detach_args_t _a, *a = &_a;
1225 a->app_index = app->app_index;
1226 a->api_client_index = client_index;
1227 vnet_application_detach (a);
1232 VL_MSG_API_REAPER_FUNCTION (application_reaper_cb);
1235 * Socket api functions
1239 mq_send_add_segment_sapi_cb (u32 app_wrk_index, u64 segment_handle)
1241 session_app_add_segment_msg_t m = { 0 };
1242 app_worker_t *app_wrk;
1247 app_wrk = app_worker_get (app_wrk_index);
1249 fs = segment_manager_get_segment_w_handle (segment_handle);
1251 ASSERT (ssvm_type (sp) == SSVM_SEGMENT_MEMFD);
1253 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
1255 m.segment_size = sp->ssvm_size;
1256 m.fd_flags = fd_flags;
1257 m.segment_handle = segment_handle;
1258 strncpy ((char *) m.segment_name, (char *) sp->name,
1259 sizeof (m.segment_name) - 1);
1261 app_wrk_send_ctrl_evt_fd (app_wrk, SESSION_CTRL_EVT_APP_ADD_SEGMENT, &m,
1262 sizeof (m), sp->fd);
1268 mq_send_del_segment_sapi_cb (u32 app_wrk_index, u64 segment_handle)
1270 session_app_del_segment_msg_t m = { 0 };
1271 app_worker_t *app_wrk;
1273 app_wrk = app_worker_get (app_wrk_index);
1275 m.segment_handle = segment_handle;
1277 app_wrk_send_ctrl_evt (app_wrk, SESSION_CTRL_EVT_APP_DEL_SEGMENT, &m,
1283 static session_cb_vft_t session_mq_sapi_cb_vft = {
1284 .session_accept_callback = mq_send_session_accepted_cb,
1285 .session_disconnect_callback = mq_send_session_disconnected_cb,
1286 .session_connected_callback = mq_send_session_connected_cb,
1287 .session_reset_callback = mq_send_session_reset_cb,
1288 .session_migrate_callback = mq_send_session_migrate_cb,
1289 .session_cleanup_callback = mq_send_session_cleanup_cb,
1290 .session_listened_callback = mq_send_session_bound_cb,
1291 .session_unlistened_callback = mq_send_unlisten_cb,
1292 .add_segment_callback = mq_send_add_segment_sapi_cb,
1293 .del_segment_callback = mq_send_del_segment_sapi_cb,
1294 .builtin_app_rx_callback = mq_send_io_rx_event,
1295 .builtin_app_tx_callback = mq_send_io_tx_event,
1299 session_api_attach_handler (app_namespace_t * app_ns, clib_socket_t * cs,
1300 app_sapi_attach_msg_t * mp)
1302 int rv = 0, *fds = 0, n_fds = 0, i, n_workers;
1303 vnet_app_attach_args_t _a, *a = &_a;
1304 app_sapi_attach_reply_msg_t *rmp;
1305 u8 fd_flags = 0, ctrl_thread;
1306 app_ns_api_handle_t *handle;
1307 fifo_segment_t *rx_mqs_seg;
1308 app_sapi_msg_t msg = { 0 };
1309 app_worker_t *app_wrk;
1313 /* Make sure name is null terminated */
1316 clib_memset (a, 0, sizeof (*a));
1317 a->api_client_index = appns_sapi_socket_handle (app_ns, cs);
1318 a->name = format (0, "%s", (char *) mp->name);
1319 a->options = mp->options;
1320 a->session_cb_vft = &session_mq_sapi_cb_vft;
1321 a->use_sock_api = 1;
1322 a->options[APP_OPTIONS_NAMESPACE] = app_namespace_index (app_ns);
1324 if ((rv = vnet_application_attach (a)))
1326 clib_warning ("attach returned: %d", rv);
1330 n_workers = vlib_num_workers ();
1331 vec_validate (fds, 3 /* segs + tx evtfd */ + n_workers);
1333 /* Send event queues segment */
1334 app = application_get (a->app_index);
1335 rx_mqs_seg = application_get_rx_mqs_segment (app);
1337 fd_flags |= SESSION_FD_F_VPP_MQ_SEGMENT;
1338 fds[n_fds] = rx_mqs_seg->ssvm.fd;
1341 /* Send fifo segment fd if needed */
1342 if (ssvm_type (a->segment) == SSVM_SEGMENT_MEMFD)
1344 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
1345 fds[n_fds] = a->segment->fd;
1348 if (a->options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
1350 fd_flags |= SESSION_FD_F_MQ_EVENTFD;
1351 fds[n_fds] = svm_msg_q_get_eventfd (a->app_evt_q);
1355 if (application_use_private_rx_mqs ())
1357 fd_flags |= SESSION_FD_F_VPP_MQ_EVENTFD;
1358 for (i = 0; i < n_workers + 1; i++)
1360 rx_mq = application_rx_mq_get (app, i);
1361 fds[n_fds] = svm_msg_q_get_eventfd (rx_mq);
1368 msg.type = APP_SAPI_MSG_TYPE_ATTACH_REPLY;
1369 rmp = &msg.attach_reply;
1373 ctrl_thread = n_workers ? 1 : 0;
1374 rmp->app_index = a->app_index;
1376 fifo_segment_msg_q_offset ((fifo_segment_t *) a->segment, 0);
1377 rmp->vpp_ctrl_mq = fifo_segment_msg_q_offset (rx_mqs_seg, ctrl_thread);
1378 rmp->vpp_ctrl_mq_thread = ctrl_thread;
1380 rmp->fd_flags = fd_flags;
1381 /* No segment name and size since we only support memfds
1382 * in this configuration */
1383 rmp->segment_handle = a->segment_handle;
1384 rmp->api_client_handle = a->api_client_index;
1386 /* Update app index for socket */
1387 handle = (app_ns_api_handle_t *) & cs->private_data;
1388 app_wrk = application_get_worker (app, 0);
1389 handle->aah_app_wrk_index = app_wrk->wrk_index;
1392 clib_socket_sendmsg (cs, &msg, sizeof (msg), fds, n_fds);
1398 sapi_socket_close_w_handle (u32 api_handle)
1400 app_namespace_t *app_ns = app_namespace_get (api_handle >> 16);
1401 u16 sock_index = api_handle & 0xffff;
1402 app_ns_api_handle_t *handle;
1406 cs = appns_sapi_get_socket (app_ns, sock_index);
1410 handle = (app_ns_api_handle_t *) & cs->private_data;
1411 cf = clib_file_get (&file_main, handle->aah_file_index);
1412 clib_file_del (&file_main, cf);
1414 clib_socket_close (cs);
1415 appns_sapi_free_socket (app_ns, cs);
1419 sapi_add_del_worker_handler (app_namespace_t * app_ns,
1421 app_sapi_worker_add_del_msg_t * mp)
1423 int rv = 0, fds[SESSION_N_FD_TYPE], n_fds = 0;
1424 app_sapi_worker_add_del_reply_msg_t *rmp;
1425 app_ns_api_handle_t *handle;
1426 app_sapi_msg_t msg = { 0 };
1427 app_worker_t *app_wrk;
1428 u32 sapi_handle = -1;
1432 app = application_get_if_valid (mp->app_index);
1435 rv = SESSION_E_INVALID;
1439 sapi_handle = appns_sapi_socket_handle (app_ns, cs);
1441 vnet_app_worker_add_del_args_t args = {
1442 .app_index = app->app_index,
1443 .wrk_map_index = mp->wrk_index,
1444 .api_client_index = sapi_handle,
1445 .is_add = mp->is_add
1447 rv = vnet_app_worker_add_del (&args);
1450 clib_warning ("app worker add/del returned: %U", format_session_error,
1458 /* Send fifo segment fd if needed */
1459 if (ssvm_type (args.segment) == SSVM_SEGMENT_MEMFD)
1461 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
1462 fds[n_fds] = args.segment->fd;
1465 if (application_segment_manager_properties (app)->use_mq_eventfd)
1467 fd_flags |= SESSION_FD_F_MQ_EVENTFD;
1468 fds[n_fds] = svm_msg_q_get_eventfd (args.evt_q);
1474 /* With app sock api socket expected to be closed, no reply */
1475 if (!mp->is_add && appns_sapi_enabled ())
1478 msg.type = APP_SAPI_MSG_TYPE_ADD_DEL_WORKER_REPLY;
1479 rmp = &msg.worker_add_del_reply;
1481 rmp->is_add = mp->is_add;
1482 rmp->api_client_handle = sapi_handle;
1483 rmp->wrk_index = args.wrk_map_index;
1484 if (!rv && mp->is_add)
1486 rmp->segment_handle = args.segment_handle;
1487 /* No segment name and size. This supports only memfds */
1488 rmp->app_event_queue_address =
1489 fifo_segment_msg_q_offset ((fifo_segment_t *) args.segment, 0);
1491 rmp->fd_flags = fd_flags;
1493 /* Update app index for socket */
1494 handle = (app_ns_api_handle_t *) & cs->private_data;
1495 app_wrk = application_get_worker (app, args.wrk_map_index);
1496 handle->aah_app_wrk_index = app_wrk->wrk_index;
1499 clib_socket_sendmsg (cs, &msg, sizeof (msg), fds, n_fds);
1502 /* This is a workaround for the case when session layer starts reading
1503 * the socket before the client actualy sends the data
1505 static clib_error_t *
1506 sapi_socket_receive_wait (clib_socket_t *cs, u8 *msg, u32 msg_len)
1513 err = clib_socket_recvmsg (cs, msg, msg_len, 0, 0);
1528 sapi_add_del_cert_key_handler (app_namespace_t *app_ns, clib_socket_t *cs,
1529 app_sapi_cert_key_add_del_msg_t *mp)
1531 vnet_app_add_cert_key_pair_args_t _a, *a = &_a;
1532 app_sapi_cert_key_add_del_reply_msg_t *rmp;
1533 app_sapi_msg_t msg = { 0 };
1538 const u32 max_certkey_len = 2e4, max_cert_len = 1e4, max_key_len = 1e4;
1543 if (mp->certkey_len > max_certkey_len)
1545 rv = SESSION_E_INVALID;
1549 vec_validate (certkey, mp->certkey_len - 1);
1551 err = sapi_socket_receive_wait (cs, certkey, mp->certkey_len);
1554 clib_error_report (err);
1555 rv = SESSION_E_INVALID;
1559 if (mp->cert_len > max_cert_len)
1561 rv = SESSION_E_INVALID;
1565 if (mp->certkey_len < mp->cert_len)
1567 rv = SESSION_E_INVALID;
1571 key_len = mp->certkey_len - mp->cert_len;
1572 if (key_len > max_key_len)
1574 rv = SESSION_E_INVALID;
1578 clib_memset (a, 0, sizeof (*a));
1580 a->key = certkey + mp->cert_len;
1581 a->cert_len = mp->cert_len;
1582 a->key_len = key_len;
1583 rv = vnet_app_add_cert_key_pair (a);
1589 rv = vnet_app_del_cert_key_pair (mp->index);
1594 msg.type = APP_SAPI_MSG_TYPE_ADD_DEL_CERT_KEY_REPLY;
1595 rmp = &msg.cert_key_add_del_reply;
1597 rmp->context = mp->context;
1598 if (!rv && mp->is_add)
1599 rmp->index = a->index;
1601 clib_socket_sendmsg (cs, &msg, sizeof (msg), 0, 0);
1605 sapi_socket_detach (app_namespace_t * app_ns, clib_socket_t * cs)
1607 app_ns_api_handle_t *handle;
1608 app_worker_t *app_wrk;
1609 u32 api_client_handle;
1611 api_client_handle = appns_sapi_socket_handle (app_ns, cs);
1613 /* Cleanup everything because app worker closed socket or crashed */
1614 handle = (app_ns_api_handle_t *) & cs->private_data;
1615 app_wrk = app_worker_get_if_valid (handle->aah_app_wrk_index);
1619 vnet_app_worker_add_del_args_t args = {
1620 .app_index = app_wrk->app_index,
1621 .wrk_map_index = app_wrk->wrk_map_index,
1622 .api_client_index = api_client_handle,
1625 /* Send rpc to main thread for worker barrier */
1626 vlib_rpc_call_main_thread (vnet_app_worker_add_del, (u8 *) & args,
1630 static clib_error_t *
1631 sapi_sock_read_ready (clib_file_t * cf)
1633 app_ns_api_handle_t *handle = (app_ns_api_handle_t *) & cf->private_data;
1634 vlib_main_t *vm = vlib_get_main ();
1635 app_sapi_msg_t msg = { 0 };
1636 app_namespace_t *app_ns;
1637 clib_error_t *err = 0;
1640 app_ns = app_namespace_get (handle->aah_app_ns_index);
1641 cs = appns_sapi_get_socket (app_ns, handle->aah_sock_index);
1645 err = clib_socket_recvmsg (cs, &msg, sizeof (msg), 0, 0);
1648 clib_error_free (err);
1649 sapi_socket_detach (app_ns, cs);
1653 handle = (app_ns_api_handle_t *) & cs->private_data;
1655 vlib_worker_thread_barrier_sync (vm);
1659 case APP_SAPI_MSG_TYPE_ATTACH:
1660 session_api_attach_handler (app_ns, cs, &msg.attach);
1662 case APP_SAPI_MSG_TYPE_ADD_DEL_WORKER:
1663 sapi_add_del_worker_handler (app_ns, cs, &msg.worker_add_del);
1665 case APP_SAPI_MSG_TYPE_ADD_DEL_CERT_KEY:
1666 sapi_add_del_cert_key_handler (app_ns, cs, &msg.cert_key_add_del);
1669 clib_warning ("app wrk %u unknown message type: %u",
1670 handle->aah_app_wrk_index, msg.type);
1674 vlib_worker_thread_barrier_release (vm);
1680 static clib_error_t *
1681 sapi_sock_write_ready (clib_file_t * cf)
1683 app_ns_api_handle_t *handle = (app_ns_api_handle_t *) & cf->private_data;
1684 clib_warning ("called for app ns %u", handle->aah_app_ns_index);
1688 static clib_error_t *
1689 sapi_sock_error (clib_file_t * cf)
1691 app_ns_api_handle_t *handle = (app_ns_api_handle_t *) & cf->private_data;
1692 app_namespace_t *app_ns;
1695 app_ns = app_namespace_get (handle->aah_app_ns_index);
1696 cs = appns_sapi_get_socket (app_ns, handle->aah_sock_index);
1700 sapi_socket_detach (app_ns, cs);
1704 static clib_error_t *
1705 sapi_sock_accept_ready (clib_file_t * scf)
1707 app_ns_api_handle_t handle = *(app_ns_api_handle_t *) & scf->private_data;
1708 app_namespace_t *app_ns;
1709 clib_file_t cf = { 0 };
1710 clib_error_t *err = 0;
1711 clib_socket_t *ccs, *scs;
1713 /* Listener files point to namespace */
1714 app_ns = app_namespace_get (handle.aah_app_ns_index);
1717 * Initialize client socket
1719 ccs = appns_sapi_alloc_socket (app_ns);
1721 /* Grab server socket after client is initialized */
1722 scs = appns_sapi_get_socket (app_ns, handle.aah_sock_index);
1726 err = clib_socket_accept (scs, ccs);
1729 clib_error_report (err);
1733 cf.read_function = sapi_sock_read_ready;
1734 cf.write_function = sapi_sock_write_ready;
1735 cf.error_function = sapi_sock_error;
1736 cf.file_descriptor = ccs->fd;
1737 /* File points to app namespace and socket */
1738 handle.aah_sock_index = appns_sapi_socket_index (app_ns, ccs);
1739 cf.private_data = handle.as_u64;
1740 cf.description = format (0, "app sock conn fd: %d", ccs->fd);
1742 /* Poll until we get an attach message. Socket points to file and
1743 * application that owns the socket */
1744 handle.aah_app_wrk_index = APP_INVALID_INDEX;
1745 handle.aah_file_index = clib_file_add (&file_main, &cf);
1746 ccs->private_data = handle.as_u64;
1751 appns_sapi_free_socket (app_ns, ccs);
1756 appns_sapi_del_ns_socket (app_namespace_t *app_ns)
1758 app_ns_api_handle_t *handle;
1761 pool_foreach (cs, app_ns->app_sockets)
1763 handle = (app_ns_api_handle_t *) &cs->private_data;
1764 clib_file_del_by_index (&file_main, handle->aah_file_index);
1766 clib_socket_close (cs);
1767 clib_socket_free (cs);
1769 pool_free (app_ns->app_sockets);
1773 appns_sapi_add_ns_socket (app_namespace_t * app_ns)
1775 char *subdir = "/app_ns_sockets/";
1776 app_ns_api_handle_t *handle;
1777 clib_file_t cf = { 0 };
1778 struct stat file_stat;
1783 snprintf (dir, sizeof (dir), "%s%s", vlib_unix_get_runtime_dir (), subdir);
1785 if (!app_ns->sock_name)
1786 app_ns->sock_name = format (0, "%s%v%c", dir, app_ns->ns_id, 0);
1789 * Create and initialize socket to listen on
1791 cs = appns_sapi_alloc_socket (app_ns);
1792 cs->config = (char *) vec_dup (app_ns->sock_name);
1793 cs->flags = CLIB_SOCKET_F_IS_SERVER |
1794 CLIB_SOCKET_F_ALLOW_GROUP_WRITE |
1795 CLIB_SOCKET_F_SEQPACKET | CLIB_SOCKET_F_PASSCRED;
1797 if (clib_socket_prefix_get_type (cs->config) == CLIB_SOCKET_TYPE_UNIX)
1799 err = vlib_unix_recursive_mkdir ((char *) dir);
1802 clib_error_report (err);
1803 return SESSION_E_SYSCALL;
1807 if ((err = clib_socket_init (cs)))
1809 clib_error_report (err);
1813 if (clib_socket_prefix_get_type (cs->config) == CLIB_SOCKET_TYPE_UNIX &&
1814 stat ((char *) app_ns->sock_name, &file_stat) == -1)
1820 cf.read_function = sapi_sock_accept_ready;
1821 cf.file_descriptor = cs->fd;
1822 /* File points to namespace */
1823 handle = (app_ns_api_handle_t *) & cf.private_data;
1824 handle->aah_app_ns_index = app_namespace_index (app_ns);
1825 handle->aah_sock_index = appns_sapi_socket_index (app_ns, cs);
1826 cf.description = format (0, "app sock listener: %s", app_ns->sock_name);
1828 /* Socket points to clib file index */
1829 handle = (app_ns_api_handle_t *) & cs->private_data;
1830 handle->aah_file_index = clib_file_add (&file_main, &cf);
1831 handle->aah_app_wrk_index = APP_INVALID_INDEX;
1836 #include <vnet/session/session.api.c>
1837 static clib_error_t *
1838 session_api_hookup (vlib_main_t *vm)
1841 * Set up the (msg_name, crc, message-id) table
1843 REPLY_MSG_ID_BASE = setup_message_id_table ();
1848 VLIB_API_INIT_FUNCTION (session_api_hookup);
1851 * fd.io coding-style-patch-verification: ON
1854 * eval: (c-set-style "gnu")