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_try_lock_and_alloc_msg (svm_msg_q_t * app_mq, svm_msg_q_msg_t * msg)
91 rv = svm_msg_q_lock_and_alloc_msg_w_ring (app_mq,
92 SESSION_MQ_CTRL_EVT_RING,
97 * Break the loop if mq is full, usually this is because the
98 * app has crashed or is hanging on somewhere.
105 clib_warning ("failed to alloc msg");
110 mq_send_session_accepted_cb (session_t * s)
112 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
113 svm_msg_q_msg_t _msg, *msg = &_msg;
114 session_accepted_msg_t m = { 0 };
116 fifo_segment_t *eq_seg;
118 session_event_t *evt;
121 app = application_get (app_wrk->app_index);
123 m.context = app->app_index;
124 m.server_rx_fifo = fifo_segment_fifo_offset (s->rx_fifo);
125 m.server_tx_fifo = fifo_segment_fifo_offset (s->tx_fifo);
126 m.segment_handle = session_segment_handle (s);
129 eq_seg = application_get_rx_mqs_segment (app);
131 if (session_has_transport (s))
133 listener = listen_session_get_from_handle (s->listener_handle);
134 m.listener_handle = app_listen_session_handle (listener);
135 if (application_is_proxy (app))
138 app_worker_first_listener (app_wrk, session_get_fib_proto (s),
139 session_get_transport_proto (s));
141 m.listener_handle = listen_session_get_handle (listener);
143 m.vpp_event_queue_address =
144 fifo_segment_msg_q_offset (eq_seg, s->thread_index);
145 m.mq_index = s->thread_index;
146 m.handle = session_handle (s);
148 session_get_endpoint (s, &m.rmt, 0 /* is_lcl */);
149 session_get_endpoint (s, &m.lcl, 1 /* is_lcl */);
155 ct = (ct_connection_t *) session_get_transport (s);
156 listener = listen_session_get_from_handle (s->listener_handle);
157 m.listener_handle = app_listen_session_handle (listener);
158 m.rmt.is_ip4 = session_type_is_ip4 (listener->session_type);
159 m.rmt.port = ct->c_rmt_port;
160 m.lcl.port = ct->c_lcl_port;
161 m.handle = session_handle (s);
162 m.vpp_event_queue_address =
163 fifo_segment_msg_q_offset (eq_seg, s->thread_index);
164 m.mq_index = s->thread_index;
167 app_mq = app_wrk->event_queue;
168 if (mq_try_lock_and_alloc_msg (app_mq, msg))
169 return SESSION_E_MQ_MSG_ALLOC;
171 evt = svm_msg_q_msg_data (app_mq, msg);
172 clib_memset (evt, 0, sizeof (*evt));
173 evt->event_type = SESSION_CTRL_EVT_ACCEPTED;
174 clib_memcpy_fast (evt->data, &m, sizeof (m));
175 svm_msg_q_add_and_unlock (app_mq, msg);
181 mq_send_session_close_evt (app_worker_t * app_wrk, session_handle_t sh,
182 session_evt_type_t evt_type)
184 svm_msg_q_msg_t _msg, *msg = &_msg;
185 session_disconnected_msg_t *mp;
187 session_event_t *evt;
189 app_mq = app_wrk->event_queue;
190 if (mq_try_lock_and_alloc_msg (app_mq, msg))
192 evt = svm_msg_q_msg_data (app_mq, msg);
193 clib_memset (evt, 0, sizeof (*evt));
194 evt->event_type = evt_type;
195 mp = (session_disconnected_msg_t *) evt->data;
197 mp->context = app_wrk->api_client_index;
198 svm_msg_q_add_and_unlock (app_mq, msg);
202 mq_notify_close_subscribers (u32 app_index, session_handle_t sh,
203 svm_fifo_t * f, session_evt_type_t evt_type)
205 app_worker_t *app_wrk;
209 app = application_get (app_index);
213 for (i = 0; i < f->shr->n_subscribers; i++)
215 if (!(app_wrk = application_get_worker (app, f->shr->subscribers[i])))
217 mq_send_session_close_evt (app_wrk, sh, SESSION_CTRL_EVT_DISCONNECTED);
222 mq_send_session_disconnected_cb (session_t * s)
224 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
225 session_handle_t sh = session_handle (s);
227 mq_send_session_close_evt (app_wrk, session_handle (s),
228 SESSION_CTRL_EVT_DISCONNECTED);
230 if (svm_fifo_n_subscribers (s->rx_fifo))
231 mq_notify_close_subscribers (app_wrk->app_index, sh, s->rx_fifo,
232 SESSION_CTRL_EVT_DISCONNECTED);
236 mq_send_session_reset_cb (session_t * s)
238 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
239 session_handle_t sh = session_handle (s);
241 mq_send_session_close_evt (app_wrk, sh, SESSION_CTRL_EVT_RESET);
243 if (svm_fifo_n_subscribers (s->rx_fifo))
244 mq_notify_close_subscribers (app_wrk->app_index, sh, s->rx_fifo,
245 SESSION_CTRL_EVT_RESET);
249 mq_send_session_connected_cb (u32 app_wrk_index, u32 api_context,
250 session_t * s, session_error_t err)
252 svm_msg_q_msg_t _msg, *msg = &_msg;
253 session_connected_msg_t m = { 0 };
255 transport_connection_t *tc;
256 fifo_segment_t *eq_seg;
257 app_worker_t *app_wrk;
258 session_event_t *evt;
261 app_wrk = app_worker_get (app_wrk_index);
263 m.context = api_context;
269 app = application_get (app_wrk->app_index);
270 eq_seg = application_get_rx_mqs_segment (app);
272 if (session_has_transport (s))
274 tc = session_get_transport (s);
277 clib_warning ("failed to retrieve transport!");
278 m.retval = SESSION_E_REFUSED;
282 m.handle = session_handle (s);
283 m.vpp_event_queue_address =
284 fifo_segment_msg_q_offset (eq_seg, s->thread_index);
286 session_get_endpoint (s, &m.lcl, 1 /* is_lcl */);
288 m.server_rx_fifo = fifo_segment_fifo_offset (s->rx_fifo);
289 m.server_tx_fifo = fifo_segment_fifo_offset (s->tx_fifo);
290 m.segment_handle = session_segment_handle (s);
291 m.mq_index = s->thread_index;
295 ct_connection_t *cct;
298 cct = (ct_connection_t *) session_get_transport (s);
299 m.handle = session_handle (s);
300 m.lcl.port = cct->c_lcl_port;
301 m.lcl.is_ip4 = cct->c_is_ip4;
302 m.vpp_event_queue_address =
303 fifo_segment_msg_q_offset (eq_seg, s->thread_index);
304 m.server_rx_fifo = fifo_segment_fifo_offset (s->rx_fifo);
305 m.server_tx_fifo = fifo_segment_fifo_offset (s->tx_fifo);
306 m.segment_handle = session_segment_handle (s);
307 ss = ct_session_get_peer (s);
308 m.ct_rx_fifo = fifo_segment_fifo_offset (ss->tx_fifo);
309 m.ct_tx_fifo = fifo_segment_fifo_offset (ss->rx_fifo);
310 m.ct_segment_handle = session_segment_handle (ss);
311 m.mq_index = s->thread_index;
314 /* Setup client session index in advance, in case data arrives
315 * before the app processes message and updates it */
316 s->rx_fifo->shr->client_session_index = api_context;
317 s->tx_fifo->shr->client_session_index = api_context;
321 app_mq = app_wrk->event_queue;
323 if (mq_try_lock_and_alloc_msg (app_mq, msg))
324 return SESSION_E_MQ_MSG_ALLOC;
326 evt = svm_msg_q_msg_data (app_mq, msg);
327 clib_memset (evt, 0, sizeof (*evt));
328 evt->event_type = SESSION_CTRL_EVT_CONNECTED;
329 clib_memcpy_fast (evt->data, &m, sizeof (m));
331 svm_msg_q_add_and_unlock (app_mq, msg);
336 mq_send_session_bound_cb (u32 app_wrk_index, u32 api_context,
337 session_handle_t handle, int rv)
339 svm_msg_q_msg_t _msg, *msg = &_msg;
340 session_bound_msg_t m = { 0 };
342 transport_endpoint_t tep;
343 fifo_segment_t *eq_seg;
344 app_worker_t *app_wrk;
345 session_event_t *evt;
350 app_wrk = app_worker_get (app_wrk_index);
352 m.context = api_context;
359 al = app_listener_get_w_handle (handle);
360 if (al->session_index != SESSION_INVALID_INDEX)
361 ls = app_listener_get_session (al);
363 ls = app_listener_get_local_session (al);
365 session_get_endpoint (ls, &tep, 1 /* is_lcl */);
366 m.lcl_port = tep.port;
367 m.lcl_is_ip4 = tep.is_ip4;
368 clib_memcpy_fast (m.lcl_ip, &tep.ip, sizeof (tep.ip));
369 app = application_get (app_wrk->app_index);
370 eq_seg = application_get_rx_mqs_segment (app);
371 m.vpp_evt_q = fifo_segment_msg_q_offset (eq_seg, ls->thread_index);
372 m.mq_index = ls->thread_index;
374 if (session_transport_service_type (ls) == TRANSPORT_SERVICE_CL &&
377 m.rx_fifo = fifo_segment_fifo_offset (ls->rx_fifo);
378 m.tx_fifo = fifo_segment_fifo_offset (ls->tx_fifo);
379 m.segment_handle = session_segment_handle (ls);
384 app_mq = app_wrk->event_queue;
386 if (mq_try_lock_and_alloc_msg (app_mq, msg))
387 return SESSION_E_MQ_MSG_ALLOC;
389 evt = svm_msg_q_msg_data (app_mq, msg);
390 clib_memset (evt, 0, sizeof (*evt));
391 evt->event_type = SESSION_CTRL_EVT_BOUND;
392 clib_memcpy_fast (evt->data, &m, sizeof (m));
394 svm_msg_q_add_and_unlock (app_mq, msg);
399 mq_send_unlisten_reply (app_worker_t * app_wrk, session_handle_t sh,
402 svm_msg_q_msg_t _msg, *msg = &_msg;
403 session_unlisten_reply_msg_t *ump;
405 session_event_t *evt;
407 app_mq = app_wrk->event_queue;
408 if (mq_try_lock_and_alloc_msg (app_mq, msg))
411 evt = svm_msg_q_msg_data (app_mq, msg);
412 clib_memset (evt, 0, sizeof (*evt));
413 evt->event_type = SESSION_CTRL_EVT_UNLISTEN_REPLY;
414 ump = (session_unlisten_reply_msg_t *) evt->data;
415 ump->context = context;
418 svm_msg_q_add_and_unlock (app_mq, msg);
422 mq_send_session_migrate_cb (session_t * s, session_handle_t new_sh)
424 svm_msg_q_msg_t _msg, *msg = &_msg;
425 session_migrated_msg_t m = { 0 };
426 fifo_segment_t *eq_seg;
427 app_worker_t *app_wrk;
428 session_event_t *evt;
433 thread_index = session_thread_from_handle (new_sh);
434 app_wrk = app_worker_get (s->app_wrk_index);
435 app_mq = app_wrk->event_queue;
436 app = application_get (app_wrk->app_index);
437 eq_seg = application_get_rx_mqs_segment (app);
439 m.handle = session_handle (s);
440 m.new_handle = new_sh;
441 m.vpp_thread_index = thread_index;
442 m.vpp_evt_q = fifo_segment_msg_q_offset (eq_seg, thread_index);
443 m.segment_handle = SESSION_INVALID_HANDLE;
445 if (mq_try_lock_and_alloc_msg (app_mq, msg))
448 evt = svm_msg_q_msg_data (app_mq, msg);
449 clib_memset (evt, 0, sizeof (*evt));
450 evt->event_type = SESSION_CTRL_EVT_MIGRATED;
451 clib_memcpy_fast (evt->data, &m, sizeof (m));
453 svm_msg_q_add_and_unlock (app_mq, msg);
457 mq_send_add_segment_cb (u32 app_wrk_index, u64 segment_handle)
459 int fds[SESSION_N_FD_TYPE], n_fds = 0;
460 svm_msg_q_msg_t _msg, *msg = &_msg;
461 session_app_add_segment_msg_t *mp;
462 vl_api_registration_t *reg;
463 app_worker_t *app_wrk;
464 session_event_t *evt;
470 app_wrk = app_worker_get (app_wrk_index);
472 reg = vl_mem_api_client_index_to_registration (app_wrk->api_client_index);
475 clib_warning ("no api registration for client: %u",
476 app_wrk->api_client_index);
480 fs = segment_manager_get_segment_w_handle (segment_handle);
482 if (ssvm_type (sp) == SSVM_SEGMENT_MEMFD)
484 if (vl_api_registration_file_index (reg) == VL_API_INVALID_FI)
486 clib_warning ("can't send memfd fd");
490 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
495 app_mq = app_wrk->event_queue;
496 if (mq_try_lock_and_alloc_msg (app_mq, msg))
500 session_send_fds (reg, fds, n_fds);
502 evt = svm_msg_q_msg_data (app_mq, msg);
503 clib_memset (evt, 0, sizeof (*evt));
504 evt->event_type = SESSION_CTRL_EVT_APP_ADD_SEGMENT;
505 mp = (session_app_add_segment_msg_t *) evt->data;
506 clib_memset (mp, 0, sizeof (*mp));
507 mp->segment_size = sp->ssvm_size;
508 mp->fd_flags = fd_flags;
509 mp->segment_handle = segment_handle;
510 strncpy ((char *) mp->segment_name, (char *) sp->name,
511 sizeof (mp->segment_name) - 1);
513 svm_msg_q_add_and_unlock (app_mq, msg);
519 mq_send_del_segment_cb (u32 app_wrk_index, u64 segment_handle)
521 svm_msg_q_msg_t _msg, *msg = &_msg;
522 session_app_del_segment_msg_t *mp;
523 vl_api_registration_t *reg;
524 app_worker_t *app_wrk;
525 session_event_t *evt;
528 app_wrk = app_worker_get (app_wrk_index);
529 reg = vl_mem_api_client_index_to_registration (app_wrk->api_client_index);
532 clib_warning ("no registration: %u", app_wrk->api_client_index);
536 app_mq = app_wrk->event_queue;
537 if (mq_try_lock_and_alloc_msg (app_mq, msg))
540 evt = svm_msg_q_msg_data (app_mq, msg);
541 clib_memset (evt, 0, sizeof (*evt));
542 evt->event_type = SESSION_CTRL_EVT_APP_DEL_SEGMENT;
543 mp = (session_app_del_segment_msg_t *) evt->data;
544 clib_memset (mp, 0, sizeof (*mp));
545 mp->segment_handle = segment_handle;
546 svm_msg_q_add_and_unlock (app_mq, msg);
552 mq_send_session_cleanup_cb (session_t * s, session_cleanup_ntf_t ntf)
554 svm_msg_q_msg_t _msg, *msg = &_msg;
555 session_cleanup_msg_t *mp;
557 session_event_t *evt;
558 app_worker_t *app_wrk;
560 /* Propagate transport cleanup notifications only if app didn't close */
561 if (ntf == SESSION_CLEANUP_TRANSPORT
562 && s->session_state != SESSION_STATE_TRANSPORT_DELETED)
565 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
569 app_mq = app_wrk->event_queue;
570 if (mq_try_lock_and_alloc_msg (app_mq, msg))
573 evt = svm_msg_q_msg_data (app_mq, msg);
574 clib_memset (evt, 0, sizeof (*evt));
575 evt->event_type = SESSION_CTRL_EVT_CLEANUP;
576 mp = (session_cleanup_msg_t *) evt->data;
577 mp->handle = session_handle (s);
579 svm_msg_q_add_and_unlock (app_mq, msg);
582 static session_cb_vft_t session_mq_cb_vft = {
583 .session_accept_callback = mq_send_session_accepted_cb,
584 .session_disconnect_callback = mq_send_session_disconnected_cb,
585 .session_connected_callback = mq_send_session_connected_cb,
586 .session_reset_callback = mq_send_session_reset_cb,
587 .session_migrate_callback = mq_send_session_migrate_cb,
588 .session_cleanup_callback = mq_send_session_cleanup_cb,
589 .add_segment_callback = mq_send_add_segment_cb,
590 .del_segment_callback = mq_send_del_segment_cb,
594 vl_api_session_enable_disable_t_handler (vl_api_session_enable_disable_t * mp)
596 vl_api_session_enable_disable_reply_t *rmp;
597 vlib_main_t *vm = vlib_get_main ();
600 vnet_session_enable_disable (vm, mp->is_enable);
601 REPLY_MACRO (VL_API_SESSION_ENABLE_DISABLE_REPLY);
605 vl_api_session_sapi_enable_disable_t_handler (
606 vl_api_session_sapi_enable_disable_t *mp)
608 vl_api_session_sapi_enable_disable_reply_t *rmp;
611 rv = appns_sapi_enable_disable (mp->is_enable);
612 REPLY_MACRO (VL_API_SESSION_SAPI_ENABLE_DISABLE_REPLY);
616 vl_api_app_attach_t_handler (vl_api_app_attach_t * mp)
618 int rv = 0, *fds = 0, n_fds = 0, n_workers, i;
619 fifo_segment_t *segp, *rx_mqs_seg = 0;
620 vnet_app_attach_args_t _a, *a = &_a;
621 vl_api_app_attach_reply_t *rmp;
622 u8 fd_flags = 0, ctrl_thread;
623 vl_api_registration_t *reg;
627 reg = vl_api_client_index_to_registration (mp->client_index);
631 n_workers = vlib_num_workers ();
632 if (!session_main_is_enabled () || appns_sapi_enabled ())
634 rv = VNET_API_ERROR_FEATURE_DISABLED;
637 /* Only support binary api with socket transport */
638 if (vl_api_registration_file_index (reg) == VL_API_INVALID_FI)
640 rv = VNET_API_ERROR_APP_UNSUPPORTED_CFG;
644 STATIC_ASSERT (sizeof (u64) * APP_OPTIONS_N_OPTIONS <=
645 sizeof (mp->options),
646 "Out of options, fix api message definition");
648 clib_memset (a, 0, sizeof (*a));
649 a->api_client_index = mp->client_index;
650 a->options = mp->options;
651 a->session_cb_vft = &session_mq_cb_vft;
652 a->namespace_id = vl_api_from_api_to_new_vec (mp, &mp->namespace_id);
654 if ((rv = vnet_application_attach (a)))
656 clib_warning ("attach returned: %d", rv);
657 vec_free (a->namespace_id);
660 vec_free (a->namespace_id);
662 vec_validate (fds, 3 /* segs + tx evtfd */ + n_workers);
664 /* Send rx mqs segment */
665 app = application_get (a->app_index);
666 rx_mqs_seg = application_get_rx_mqs_segment (app);
668 fd_flags |= SESSION_FD_F_VPP_MQ_SEGMENT;
669 fds[n_fds] = rx_mqs_seg->ssvm.fd;
672 /* Send fifo segment fd if needed */
673 if (ssvm_type (a->segment) == SSVM_SEGMENT_MEMFD)
675 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
676 fds[n_fds] = a->segment->fd;
679 if (a->options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
681 fd_flags |= SESSION_FD_F_MQ_EVENTFD;
682 fds[n_fds] = svm_msg_q_get_eventfd (a->app_evt_q);
686 if (application_use_private_rx_mqs ())
688 fd_flags |= SESSION_FD_F_VPP_MQ_EVENTFD;
689 for (i = 0; i < n_workers + 1; i++)
691 rx_mq = application_rx_mq_get (app, i);
692 fds[n_fds] = svm_msg_q_get_eventfd (rx_mq);
699 REPLY_MACRO2 (VL_API_APP_ATTACH_REPLY, ({
702 ctrl_thread = n_workers ? 1 : 0;
703 segp = (fifo_segment_t *) a->segment;
704 rmp->app_index = clib_host_to_net_u32 (a->app_index);
705 rmp->app_mq = fifo_segment_msg_q_offset (segp, 0);
706 rmp->vpp_ctrl_mq = fifo_segment_msg_q_offset (rx_mqs_seg, ctrl_thread);
707 rmp->vpp_ctrl_mq_thread = ctrl_thread;
709 rmp->fd_flags = fd_flags;
710 if (vec_len (segp->ssvm.name))
712 vl_api_vec_to_api_string (segp->ssvm.name, &rmp->segment_name);
714 rmp->segment_size = segp->ssvm.ssvm_size;
715 rmp->segment_handle = clib_host_to_net_u64 (a->segment_handle);
721 session_send_fds (reg, fds, n_fds);
726 vl_api_app_worker_add_del_t_handler (vl_api_app_worker_add_del_t * mp)
728 int rv = 0, fds[SESSION_N_FD_TYPE], n_fds = 0;
729 vl_api_app_worker_add_del_reply_t *rmp;
730 vl_api_registration_t *reg;
734 if (!session_main_is_enabled () || appns_sapi_enabled ())
736 rv = VNET_API_ERROR_FEATURE_DISABLED;
740 reg = vl_api_client_index_to_registration (mp->client_index);
744 app = application_get_if_valid (clib_net_to_host_u32 (mp->app_index));
747 rv = VNET_API_ERROR_INVALID_VALUE;
751 vnet_app_worker_add_del_args_t args = {
752 .app_index = app->app_index,
753 .wrk_map_index = clib_net_to_host_u32 (mp->wrk_index),
754 .api_client_index = mp->client_index,
757 rv = vnet_app_worker_add_del (&args);
760 clib_warning ("app worker add/del returned: %d", rv);
767 /* Send fifo segment fd if needed */
768 if (ssvm_type (args.segment) == SSVM_SEGMENT_MEMFD)
770 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
771 fds[n_fds] = args.segment->fd;
774 if (application_segment_manager_properties (app)->use_mq_eventfd)
776 fd_flags |= SESSION_FD_F_MQ_EVENTFD;
777 fds[n_fds] = svm_msg_q_get_eventfd (args.evt_q);
783 REPLY_MACRO2 (VL_API_APP_WORKER_ADD_DEL_REPLY, ({
784 rmp->is_add = mp->is_add;
785 rmp->wrk_index = clib_host_to_net_u32 (args.wrk_map_index);
786 rmp->segment_handle = clib_host_to_net_u64 (args.segment_handle);
787 if (!rv && mp->is_add)
789 rmp->app_event_queue_address =
790 fifo_segment_msg_q_offset ((fifo_segment_t *) args.segment, 0);
792 rmp->fd_flags = fd_flags;
793 if (vec_len (args.segment->name))
795 vl_api_vec_to_api_string (args.segment->name, &rmp->segment_name);
802 session_send_fds (reg, fds, n_fds);
806 vl_api_application_detach_t_handler (vl_api_application_detach_t * mp)
808 vl_api_application_detach_reply_t *rmp;
809 int rv = VNET_API_ERROR_INVALID_VALUE_2;
810 vnet_app_detach_args_t _a, *a = &_a;
813 if (!session_main_is_enabled () || appns_sapi_enabled ())
815 rv = VNET_API_ERROR_FEATURE_DISABLED;
819 app = application_lookup (mp->client_index);
822 a->app_index = app->app_index;
823 a->api_client_index = mp->client_index;
824 rv = vnet_application_detach (a);
828 REPLY_MACRO (VL_API_APPLICATION_DETACH_REPLY);
832 vl_api_app_namespace_add_del_t_handler (vl_api_app_namespace_add_del_t * mp)
834 vl_api_app_namespace_add_del_reply_t *rmp;
838 if (session_main_is_enabled () == 0)
840 rv = VNET_API_ERROR_FEATURE_DISABLED;
844 ns_id = vl_api_from_api_to_new_vec (mp, &mp->namespace_id);
846 vnet_app_namespace_add_del_args_t args = {
850 .secret = clib_net_to_host_u64 (mp->secret),
851 .sw_if_index = clib_net_to_host_u32 (mp->sw_if_index),
852 .ip4_fib_id = clib_net_to_host_u32 (mp->ip4_fib_id),
853 .ip6_fib_id = clib_net_to_host_u32 (mp->ip6_fib_id),
856 rv = vnet_app_namespace_add_del (&args);
859 appns_index = app_namespace_index_from_id (ns_id);
860 if (appns_index == APP_NAMESPACE_INVALID_INDEX)
862 clib_warning ("app ns lookup failed");
863 rv = VNET_API_ERROR_UNSPECIFIED;
870 REPLY_MACRO2 (VL_API_APP_NAMESPACE_ADD_DEL_REPLY, ({
872 rmp->appns_index = clib_host_to_net_u32 (appns_index);
878 vl_api_app_namespace_add_del_v2_t_handler (
879 vl_api_app_namespace_add_del_v2_t *mp)
881 vl_api_app_namespace_add_del_v2_reply_t *rmp;
882 u8 *ns_id = 0, *netns = 0;
886 if (session_main_is_enabled () == 0)
888 rv = VNET_API_ERROR_FEATURE_DISABLED;
892 mp->namespace_id[sizeof (mp->namespace_id) - 1] = 0;
893 mp->netns[sizeof (mp->netns) - 1] = 0;
894 ns_id = format (0, "%s", &mp->namespace_id);
895 netns = format (0, "%s", &mp->netns);
897 vnet_app_namespace_add_del_args_t args = {
901 .secret = clib_net_to_host_u64 (mp->secret),
902 .sw_if_index = clib_net_to_host_u32 (mp->sw_if_index),
903 .ip4_fib_id = clib_net_to_host_u32 (mp->ip4_fib_id),
904 .ip6_fib_id = clib_net_to_host_u32 (mp->ip6_fib_id),
907 rv = vnet_app_namespace_add_del (&args);
910 appns_index = app_namespace_index_from_id (ns_id);
911 if (appns_index == APP_NAMESPACE_INVALID_INDEX)
913 clib_warning ("app ns lookup failed id:%s", ns_id);
914 rv = VNET_API_ERROR_UNSPECIFIED;
921 REPLY_MACRO2 (VL_API_APP_NAMESPACE_ADD_DEL_V2_REPLY, ({
923 rmp->appns_index = clib_host_to_net_u32 (appns_index);
928 vl_api_app_namespace_add_del_v3_t_handler (
929 vl_api_app_namespace_add_del_v3_t *mp)
931 vl_api_app_namespace_add_del_v3_reply_t *rmp;
932 u8 *ns_id = 0, *netns = 0, *sock_name = 0;
935 if (session_main_is_enabled () == 0)
937 rv = VNET_API_ERROR_FEATURE_DISABLED;
940 mp->namespace_id[sizeof (mp->namespace_id) - 1] = 0;
941 mp->netns[sizeof (mp->netns) - 1] = 0;
942 ns_id = format (0, "%s", &mp->namespace_id);
943 netns = format (0, "%s", &mp->netns);
944 sock_name = vl_api_from_api_to_new_vec (mp, &mp->sock_name);
945 vnet_app_namespace_add_del_args_t args = {
948 .sock_name = sock_name,
949 .secret = clib_net_to_host_u64 (mp->secret),
950 .sw_if_index = clib_net_to_host_u32 (mp->sw_if_index),
951 .ip4_fib_id = clib_net_to_host_u32 (mp->ip4_fib_id),
952 .ip6_fib_id = clib_net_to_host_u32 (mp->ip6_fib_id),
953 .is_add = mp->is_add,
955 rv = vnet_app_namespace_add_del (&args);
956 if (!rv && mp->is_add)
958 appns_index = app_namespace_index_from_id (ns_id);
959 if (appns_index == APP_NAMESPACE_INVALID_INDEX)
961 clib_warning ("app ns lookup failed id:%s", ns_id);
962 rv = VNET_API_ERROR_UNSPECIFIED;
967 vec_free (sock_name);
969 REPLY_MACRO2 (VL_API_APP_NAMESPACE_ADD_DEL_V3_REPLY, ({
971 rmp->appns_index = clib_host_to_net_u32 (appns_index);
976 vl_api_session_rule_add_del_t_handler (vl_api_session_rule_add_del_t * mp)
978 vl_api_session_rule_add_del_reply_t *rmp;
979 session_rule_add_del_args_t args;
980 session_rule_table_add_del_args_t *table_args = &args.table_args;
983 clib_memset (&args, 0, sizeof (args));
985 ip_prefix_decode (&mp->lcl, &table_args->lcl);
986 ip_prefix_decode (&mp->rmt, &table_args->rmt);
988 table_args->lcl_port = mp->lcl_port;
989 table_args->rmt_port = mp->rmt_port;
990 table_args->action_index = clib_net_to_host_u32 (mp->action_index);
991 table_args->is_add = mp->is_add;
992 mp->tag[sizeof (mp->tag) - 1] = 0;
993 table_args->tag = format (0, "%s", mp->tag);
994 args.appns_index = clib_net_to_host_u32 (mp->appns_index);
995 args.scope = mp->scope;
996 args.transport_proto =
997 api_session_transport_proto_decode (&mp->transport_proto) ==
998 TRANSPORT_PROTO_UDP ? 1 : 0;
1000 rv = vnet_session_rule_add_del (&args);
1002 clib_warning ("rule add del returned: %d", rv);
1003 vec_free (table_args->tag);
1004 REPLY_MACRO (VL_API_SESSION_RULE_ADD_DEL_REPLY);
1008 send_session_rule_details4 (mma_rule_16_t * rule, u8 is_local,
1009 u8 transport_proto, u32 appns_index, u8 * tag,
1010 vl_api_registration_t * reg, u32 context)
1012 vl_api_session_rules_details_t *rmp = 0;
1013 session_mask_or_match_4_t *match =
1014 (session_mask_or_match_4_t *) & rule->match;
1015 session_mask_or_match_4_t *mask =
1016 (session_mask_or_match_4_t *) & rule->mask;
1017 fib_prefix_t lcl, rmt;
1019 rmp = vl_msg_api_alloc (sizeof (*rmp));
1020 clib_memset (rmp, 0, sizeof (*rmp));
1021 rmp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_SESSION_RULES_DETAILS);
1022 rmp->context = context;
1024 clib_memset (&lcl, 0, sizeof (lcl));
1025 clib_memset (&rmt, 0, sizeof (rmt));
1026 ip_set (&lcl.fp_addr, &match->lcl_ip, 1);
1027 ip_set (&rmt.fp_addr, &match->rmt_ip, 1);
1028 lcl.fp_len = ip4_mask_to_preflen (&mask->lcl_ip);
1029 rmt.fp_len = ip4_mask_to_preflen (&mask->rmt_ip);
1031 ip_prefix_encode (&lcl, &rmp->lcl);
1032 ip_prefix_encode (&rmt, &rmp->rmt);
1033 rmp->lcl_port = match->lcl_port;
1034 rmp->rmt_port = match->rmt_port;
1035 rmp->action_index = clib_host_to_net_u32 (rule->action_index);
1037 is_local ? SESSION_RULE_SCOPE_API_LOCAL : SESSION_RULE_SCOPE_API_GLOBAL;
1038 rmp->transport_proto = api_session_transport_proto_encode (transport_proto);
1039 rmp->appns_index = clib_host_to_net_u32 (appns_index);
1042 clib_memcpy_fast (rmp->tag, tag, vec_len (tag));
1043 rmp->tag[vec_len (tag)] = 0;
1046 vl_api_send_msg (reg, (u8 *) rmp);
1050 send_session_rule_details6 (mma_rule_40_t * rule, u8 is_local,
1051 u8 transport_proto, u32 appns_index, u8 * tag,
1052 vl_api_registration_t * reg, u32 context)
1054 vl_api_session_rules_details_t *rmp = 0;
1055 session_mask_or_match_6_t *match =
1056 (session_mask_or_match_6_t *) & rule->match;
1057 session_mask_or_match_6_t *mask =
1058 (session_mask_or_match_6_t *) & rule->mask;
1059 fib_prefix_t lcl, rmt;
1061 rmp = vl_msg_api_alloc (sizeof (*rmp));
1062 clib_memset (rmp, 0, sizeof (*rmp));
1063 rmp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_SESSION_RULES_DETAILS);
1064 rmp->context = context;
1066 clib_memset (&lcl, 0, sizeof (lcl));
1067 clib_memset (&rmt, 0, sizeof (rmt));
1068 ip_set (&lcl.fp_addr, &match->lcl_ip, 0);
1069 ip_set (&rmt.fp_addr, &match->rmt_ip, 0);
1070 lcl.fp_len = ip6_mask_to_preflen (&mask->lcl_ip);
1071 rmt.fp_len = ip6_mask_to_preflen (&mask->rmt_ip);
1073 ip_prefix_encode (&lcl, &rmp->lcl);
1074 ip_prefix_encode (&rmt, &rmp->rmt);
1075 rmp->lcl_port = match->lcl_port;
1076 rmp->rmt_port = match->rmt_port;
1077 rmp->action_index = clib_host_to_net_u32 (rule->action_index);
1079 is_local ? SESSION_RULE_SCOPE_API_LOCAL : SESSION_RULE_SCOPE_API_GLOBAL;
1080 rmp->transport_proto = api_session_transport_proto_encode (transport_proto);
1081 rmp->appns_index = clib_host_to_net_u32 (appns_index);
1084 clib_memcpy_fast (rmp->tag, tag, vec_len (tag));
1085 rmp->tag[vec_len (tag)] = 0;
1088 vl_api_send_msg (reg, (u8 *) rmp);
1092 send_session_rules_table_details (session_rules_table_t * srt, u8 fib_proto,
1093 u8 tp, u8 is_local, u32 appns_index,
1094 vl_api_registration_t * reg, u32 context)
1096 mma_rule_16_t *rule16;
1097 mma_rule_40_t *rule40;
1098 mma_rules_table_16_t *srt16;
1099 mma_rules_table_40_t *srt40;
1102 if (is_local || fib_proto == FIB_PROTOCOL_IP4)
1106 srt16 = &srt->session_rules_tables_16;
1107 pool_foreach (rule16, srt16->rules) {
1108 ri = mma_rules_table_rule_index_16 (srt16, rule16);
1109 tag = session_rules_table_rule_tag (srt, ri, 1);
1110 send_session_rule_details4 (rule16, is_local, tp, appns_index, tag,
1115 if (is_local || fib_proto == FIB_PROTOCOL_IP6)
1119 srt40 = &srt->session_rules_tables_40;
1120 pool_foreach (rule40, srt40->rules) {
1121 ri = mma_rules_table_rule_index_40 (srt40, rule40);
1122 tag = session_rules_table_rule_tag (srt, ri, 1);
1123 send_session_rule_details6 (rule40, is_local, tp, appns_index, tag,
1131 vl_api_session_rules_dump_t_handler (vl_api_session_rules_dump_t * mp)
1133 vl_api_registration_t *reg;
1134 session_table_t *st;
1137 reg = vl_api_client_index_to_registration (mp->client_index);
1142 session_table_foreach (st, ({
1143 for (tp = 0; tp < TRANSPORT_N_PROTOS; tp++)
1145 send_session_rules_table_details (&st->session_rules[tp],
1146 st->active_fib_proto, tp,
1147 st->is_local, st->appns_index, reg,
1155 vl_api_app_add_cert_key_pair_t_handler (vl_api_app_add_cert_key_pair_t * mp)
1157 vl_api_app_add_cert_key_pair_reply_t *rmp;
1158 vnet_app_add_cert_key_pair_args_t _a, *a = &_a;
1159 u32 certkey_len, key_len, cert_len;
1161 if (session_main_is_enabled () == 0)
1163 rv = VNET_API_ERROR_FEATURE_DISABLED;
1167 cert_len = clib_net_to_host_u16 (mp->cert_len);
1168 if (cert_len > 10000)
1170 rv = VNET_API_ERROR_INVALID_VALUE;
1174 certkey_len = clib_net_to_host_u16 (mp->certkey_len);
1175 if (certkey_len < cert_len)
1177 rv = VNET_API_ERROR_INVALID_VALUE;
1181 key_len = certkey_len - cert_len;
1182 if (key_len > 10000)
1184 rv = VNET_API_ERROR_INVALID_VALUE;
1188 clib_memset (a, 0, sizeof (*a));
1189 a->cert = mp->certkey;
1190 a->key = mp->certkey + cert_len;
1191 a->cert_len = cert_len;
1192 a->key_len = key_len;
1193 rv = vnet_app_add_cert_key_pair (a);
1197 REPLY_MACRO2 (VL_API_APP_ADD_CERT_KEY_PAIR_REPLY, ({
1199 rmp->index = clib_host_to_net_u32 (a->index);
1205 vl_api_app_del_cert_key_pair_t_handler (vl_api_app_del_cert_key_pair_t * mp)
1207 vl_api_app_del_cert_key_pair_reply_t *rmp;
1210 if (session_main_is_enabled () == 0)
1212 rv = VNET_API_ERROR_FEATURE_DISABLED;
1215 ckpair_index = clib_net_to_host_u32 (mp->index);
1216 rv = vnet_app_del_cert_key_pair (ckpair_index);
1219 REPLY_MACRO (VL_API_APP_DEL_CERT_KEY_PAIR_REPLY);
1222 static clib_error_t *
1223 application_reaper_cb (u32 client_index)
1225 application_t *app = application_lookup (client_index);
1226 vnet_app_detach_args_t _a, *a = &_a;
1229 a->app_index = app->app_index;
1230 a->api_client_index = client_index;
1231 vnet_application_detach (a);
1236 VL_MSG_API_REAPER_FUNCTION (application_reaper_cb);
1239 * Socket api functions
1243 sapi_send_fds (app_worker_t * app_wrk, int *fds, int n_fds)
1245 app_sapi_msg_t smsg = { 0 };
1246 app_namespace_t *app_ns;
1251 app = application_get (app_wrk->app_index);
1252 app_ns = app_namespace_get (app->ns_index);
1253 cs_index = appns_sapi_handle_sock_index (app_wrk->api_client_index);
1254 cs = appns_sapi_get_socket (app_ns, cs_index);
1255 if (PREDICT_FALSE (!cs))
1258 /* There's no payload for the message only the type */
1259 smsg.type = APP_SAPI_MSG_TYPE_SEND_FDS;
1260 clib_socket_sendmsg (cs, &smsg, sizeof (smsg), fds, n_fds);
1264 mq_send_add_segment_sapi_cb (u32 app_wrk_index, u64 segment_handle)
1266 int fds[SESSION_N_FD_TYPE], n_fds = 0;
1267 svm_msg_q_msg_t _msg, *msg = &_msg;
1268 session_app_add_segment_msg_t *mp;
1269 app_worker_t *app_wrk;
1270 session_event_t *evt;
1271 svm_msg_q_t *app_mq;
1276 app_wrk = app_worker_get (app_wrk_index);
1278 fs = segment_manager_get_segment_w_handle (segment_handle);
1280 ASSERT (ssvm_type (sp) == SSVM_SEGMENT_MEMFD);
1282 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
1283 fds[n_fds] = sp->fd;
1286 app_mq = app_wrk->event_queue;
1287 if (mq_try_lock_and_alloc_msg (app_mq, msg))
1291 * Send the fd over api socket
1293 sapi_send_fds (app_wrk, fds, n_fds);
1296 * Send the actual message over mq
1298 evt = svm_msg_q_msg_data (app_mq, msg);
1299 clib_memset (evt, 0, sizeof (*evt));
1300 evt->event_type = SESSION_CTRL_EVT_APP_ADD_SEGMENT;
1301 mp = (session_app_add_segment_msg_t *) evt->data;
1302 clib_memset (mp, 0, sizeof (*mp));
1303 mp->segment_size = sp->ssvm_size;
1304 mp->fd_flags = fd_flags;
1305 mp->segment_handle = segment_handle;
1306 strncpy ((char *) mp->segment_name, (char *) sp->name,
1307 sizeof (mp->segment_name) - 1);
1309 svm_msg_q_add_and_unlock (app_mq, msg);
1315 mq_send_del_segment_sapi_cb (u32 app_wrk_index, u64 segment_handle)
1317 svm_msg_q_msg_t _msg, *msg = &_msg;
1318 session_app_del_segment_msg_t *mp;
1319 app_worker_t *app_wrk;
1320 session_event_t *evt;
1321 svm_msg_q_t *app_mq;
1323 app_wrk = app_worker_get (app_wrk_index);
1325 app_mq = app_wrk->event_queue;
1326 if (mq_try_lock_and_alloc_msg (app_mq, msg))
1329 evt = svm_msg_q_msg_data (app_mq, msg);
1330 clib_memset (evt, 0, sizeof (*evt));
1331 evt->event_type = SESSION_CTRL_EVT_APP_DEL_SEGMENT;
1332 mp = (session_app_del_segment_msg_t *) evt->data;
1333 clib_memset (mp, 0, sizeof (*mp));
1334 mp->segment_handle = segment_handle;
1335 svm_msg_q_add_and_unlock (app_mq, msg);
1340 static session_cb_vft_t session_mq_sapi_cb_vft = {
1341 .session_accept_callback = mq_send_session_accepted_cb,
1342 .session_disconnect_callback = mq_send_session_disconnected_cb,
1343 .session_connected_callback = mq_send_session_connected_cb,
1344 .session_reset_callback = mq_send_session_reset_cb,
1345 .session_migrate_callback = mq_send_session_migrate_cb,
1346 .session_cleanup_callback = mq_send_session_cleanup_cb,
1347 .add_segment_callback = mq_send_add_segment_sapi_cb,
1348 .del_segment_callback = mq_send_del_segment_sapi_cb,
1352 session_api_attach_handler (app_namespace_t * app_ns, clib_socket_t * cs,
1353 app_sapi_attach_msg_t * mp)
1355 int rv = 0, *fds = 0, n_fds = 0, i, n_workers;
1356 vnet_app_attach_args_t _a, *a = &_a;
1357 app_sapi_attach_reply_msg_t *rmp;
1358 u8 fd_flags = 0, ctrl_thread;
1359 app_ns_api_handle_t *handle;
1360 fifo_segment_t *rx_mqs_seg;
1361 app_sapi_msg_t msg = { 0 };
1362 app_worker_t *app_wrk;
1366 /* Make sure name is null terminated */
1369 clib_memset (a, 0, sizeof (*a));
1370 a->api_client_index = appns_sapi_socket_handle (app_ns, cs);
1371 a->name = format (0, "%s", (char *) mp->name);
1372 a->options = mp->options;
1373 a->session_cb_vft = &session_mq_sapi_cb_vft;
1374 a->use_sock_api = 1;
1375 a->options[APP_OPTIONS_NAMESPACE] = app_namespace_index (app_ns);
1377 if ((rv = vnet_application_attach (a)))
1379 clib_warning ("attach returned: %d", rv);
1383 n_workers = vlib_num_workers ();
1384 vec_validate (fds, 3 /* segs + tx evtfd */ + n_workers);
1386 /* Send event queues segment */
1387 app = application_get (a->app_index);
1388 rx_mqs_seg = application_get_rx_mqs_segment (app);
1390 fd_flags |= SESSION_FD_F_VPP_MQ_SEGMENT;
1391 fds[n_fds] = rx_mqs_seg->ssvm.fd;
1394 /* Send fifo segment fd if needed */
1395 if (ssvm_type (a->segment) == SSVM_SEGMENT_MEMFD)
1397 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
1398 fds[n_fds] = a->segment->fd;
1401 if (a->options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
1403 fd_flags |= SESSION_FD_F_MQ_EVENTFD;
1404 fds[n_fds] = svm_msg_q_get_eventfd (a->app_evt_q);
1408 if (application_use_private_rx_mqs ())
1410 fd_flags |= SESSION_FD_F_VPP_MQ_EVENTFD;
1411 for (i = 0; i < n_workers + 1; i++)
1413 rx_mq = application_rx_mq_get (app, i);
1414 fds[n_fds] = svm_msg_q_get_eventfd (rx_mq);
1421 msg.type = APP_SAPI_MSG_TYPE_ATTACH_REPLY;
1422 rmp = &msg.attach_reply;
1426 ctrl_thread = n_workers ? 1 : 0;
1427 rmp->app_index = a->app_index;
1429 fifo_segment_msg_q_offset ((fifo_segment_t *) a->segment, 0);
1430 rmp->vpp_ctrl_mq = fifo_segment_msg_q_offset (rx_mqs_seg, ctrl_thread);
1431 rmp->vpp_ctrl_mq_thread = ctrl_thread;
1433 rmp->fd_flags = fd_flags;
1434 /* No segment name and size since we only support memfds
1435 * in this configuration */
1436 rmp->segment_handle = a->segment_handle;
1437 rmp->api_client_handle = a->api_client_index;
1439 /* Update app index for socket */
1440 handle = (app_ns_api_handle_t *) & cs->private_data;
1441 app_wrk = application_get_worker (app, 0);
1442 handle->aah_app_wrk_index = app_wrk->wrk_index;
1445 clib_socket_sendmsg (cs, &msg, sizeof (msg), fds, n_fds);
1451 sapi_socket_close_w_handle (u32 api_handle)
1453 app_namespace_t *app_ns = app_namespace_get (api_handle >> 16);
1454 u16 sock_index = api_handle & 0xffff;
1455 app_ns_api_handle_t *handle;
1459 cs = appns_sapi_get_socket (app_ns, sock_index);
1463 handle = (app_ns_api_handle_t *) & cs->private_data;
1464 cf = clib_file_get (&file_main, handle->aah_file_index);
1465 clib_file_del (&file_main, cf);
1467 clib_socket_close (cs);
1468 appns_sapi_free_socket (app_ns, cs);
1472 sapi_add_del_worker_handler (app_namespace_t * app_ns,
1474 app_sapi_worker_add_del_msg_t * mp)
1476 int rv = 0, fds[SESSION_N_FD_TYPE], n_fds = 0;
1477 app_sapi_worker_add_del_reply_msg_t *rmp;
1478 app_ns_api_handle_t *handle;
1479 app_sapi_msg_t msg = { 0 };
1480 app_worker_t *app_wrk;
1481 u32 sapi_handle = -1;
1485 app = application_get_if_valid (mp->app_index);
1488 rv = VNET_API_ERROR_INVALID_VALUE;
1492 sapi_handle = appns_sapi_socket_handle (app_ns, cs);
1494 vnet_app_worker_add_del_args_t args = {
1495 .app_index = app->app_index,
1496 .wrk_map_index = mp->wrk_index,
1497 .api_client_index = sapi_handle,
1498 .is_add = mp->is_add
1500 rv = vnet_app_worker_add_del (&args);
1503 clib_warning ("app worker add/del returned: %d", rv);
1510 /* Send fifo segment fd if needed */
1511 if (ssvm_type (args.segment) == SSVM_SEGMENT_MEMFD)
1513 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
1514 fds[n_fds] = args.segment->fd;
1517 if (application_segment_manager_properties (app)->use_mq_eventfd)
1519 fd_flags |= SESSION_FD_F_MQ_EVENTFD;
1520 fds[n_fds] = svm_msg_q_get_eventfd (args.evt_q);
1526 msg.type = APP_SAPI_MSG_TYPE_ADD_DEL_WORKER_REPLY;
1527 rmp = &msg.worker_add_del_reply;
1529 rmp->is_add = mp->is_add;
1530 rmp->api_client_handle = sapi_handle;
1531 rmp->wrk_index = args.wrk_map_index;
1532 rmp->segment_handle = args.segment_handle;
1533 if (!rv && mp->is_add)
1535 /* No segment name and size. This supports only memfds */
1536 rmp->app_event_queue_address =
1537 fifo_segment_msg_q_offset ((fifo_segment_t *) args.segment, 0);
1539 rmp->fd_flags = fd_flags;
1541 /* Update app index for socket */
1542 handle = (app_ns_api_handle_t *) & cs->private_data;
1543 app_wrk = application_get_worker (app, args.wrk_map_index);
1544 handle->aah_app_wrk_index = app_wrk->wrk_index;
1547 clib_socket_sendmsg (cs, &msg, sizeof (msg), fds, n_fds);
1551 sapi_add_del_cert_key_handler (app_namespace_t *app_ns, clib_socket_t *cs,
1552 app_sapi_cert_key_add_del_msg_t *mp)
1554 vnet_app_add_cert_key_pair_args_t _a, *a = &_a;
1555 app_sapi_cert_key_add_del_reply_msg_t *rmp;
1556 app_sapi_msg_t msg = { 0 };
1561 const u32 max_certkey_len = 2e4, max_cert_len = 1e4, max_key_len = 1e4;
1566 if (mp->certkey_len > max_certkey_len)
1568 rv = SESSION_E_INVALID;
1572 vec_validate (certkey, mp->certkey_len - 1);
1573 err = clib_socket_recvmsg (cs, certkey, mp->certkey_len, 0, 0);
1576 clib_error_report (err);
1577 clib_error_free (err);
1578 rv = SESSION_E_INVALID;
1582 if (mp->cert_len > max_cert_len)
1584 rv = SESSION_E_INVALID;
1588 if (mp->certkey_len < mp->cert_len)
1590 rv = SESSION_E_INVALID;
1594 key_len = mp->certkey_len - mp->cert_len;
1595 if (key_len > max_key_len)
1597 rv = SESSION_E_INVALID;
1601 clib_memset (a, 0, sizeof (*a));
1603 a->key = certkey + mp->cert_len;
1604 a->cert_len = mp->cert_len;
1605 a->key_len = key_len;
1606 rv = vnet_app_add_cert_key_pair (a);
1612 rv = vnet_app_del_cert_key_pair (mp->index);
1617 msg.type = APP_SAPI_MSG_TYPE_ADD_DEL_CERT_KEY_REPLY;
1618 rmp = &msg.cert_key_add_del_reply;
1620 rmp->context = mp->context;
1621 if (!rv && mp->is_add)
1622 rmp->index = a->index;
1624 clib_socket_sendmsg (cs, &msg, sizeof (msg), 0, 0);
1628 sapi_socket_detach (app_namespace_t * app_ns, clib_socket_t * cs)
1630 app_ns_api_handle_t *handle;
1631 app_worker_t *app_wrk;
1632 u32 api_client_handle;
1634 api_client_handle = appns_sapi_socket_handle (app_ns, cs);
1636 /* Cleanup everything because app worker closed socket or crashed */
1637 handle = (app_ns_api_handle_t *) & cs->private_data;
1638 app_wrk = app_worker_get (handle->aah_app_wrk_index);
1640 vnet_app_worker_add_del_args_t args = {
1641 .app_index = app_wrk->app_index,
1642 .wrk_map_index = app_wrk->wrk_map_index,
1643 .api_client_index = api_client_handle,
1646 /* Send rpc to main thread for worker barrier */
1647 vlib_rpc_call_main_thread (vnet_app_worker_add_del, (u8 *) & args,
1651 static clib_error_t *
1652 sapi_sock_read_ready (clib_file_t * cf)
1654 app_ns_api_handle_t *handle = (app_ns_api_handle_t *) & cf->private_data;
1655 vlib_main_t *vm = vlib_get_main ();
1656 app_sapi_msg_t msg = { 0 };
1657 app_namespace_t *app_ns;
1658 clib_error_t *err = 0;
1661 app_ns = app_namespace_get (handle->aah_app_ns_index);
1662 cs = appns_sapi_get_socket (app_ns, handle->aah_sock_index);
1666 err = clib_socket_recvmsg (cs, &msg, sizeof (msg), 0, 0);
1669 clib_error_free (err);
1670 sapi_socket_detach (app_ns, cs);
1674 handle = (app_ns_api_handle_t *) & cs->private_data;
1676 vlib_worker_thread_barrier_sync (vm);
1680 case APP_SAPI_MSG_TYPE_ATTACH:
1681 session_api_attach_handler (app_ns, cs, &msg.attach);
1683 case APP_SAPI_MSG_TYPE_ADD_DEL_WORKER:
1684 sapi_add_del_worker_handler (app_ns, cs, &msg.worker_add_del);
1686 case APP_SAPI_MSG_TYPE_ADD_DEL_CERT_KEY:
1687 sapi_add_del_cert_key_handler (app_ns, cs, &msg.cert_key_add_del);
1690 clib_warning ("app wrk %u unknown message type: %u",
1691 handle->aah_app_wrk_index, msg.type);
1695 vlib_worker_thread_barrier_release (vm);
1701 static clib_error_t *
1702 sapi_sock_write_ready (clib_file_t * cf)
1704 app_ns_api_handle_t *handle = (app_ns_api_handle_t *) & cf->private_data;
1705 clib_warning ("called for app ns %u", handle->aah_app_ns_index);
1709 static clib_error_t *
1710 sapi_sock_error (clib_file_t * cf)
1712 app_ns_api_handle_t *handle = (app_ns_api_handle_t *) & cf->private_data;
1713 app_namespace_t *app_ns;
1716 app_ns = app_namespace_get (handle->aah_app_ns_index);
1717 cs = appns_sapi_get_socket (app_ns, handle->aah_sock_index);
1721 sapi_socket_detach (app_ns, cs);
1725 static clib_error_t *
1726 sapi_sock_accept_ready (clib_file_t * scf)
1728 app_ns_api_handle_t handle = *(app_ns_api_handle_t *) & scf->private_data;
1729 app_namespace_t *app_ns;
1730 clib_file_t cf = { 0 };
1731 clib_error_t *err = 0;
1732 clib_socket_t *ccs, *scs;
1734 /* Listener files point to namespace */
1735 app_ns = app_namespace_get (handle.aah_app_ns_index);
1738 * Initialize client socket
1740 ccs = appns_sapi_alloc_socket (app_ns);
1742 /* Grab server socket after client is initialized */
1743 scs = appns_sapi_get_socket (app_ns, handle.aah_sock_index);
1747 err = clib_socket_accept (scs, ccs);
1750 clib_error_report (err);
1754 cf.read_function = sapi_sock_read_ready;
1755 cf.write_function = sapi_sock_write_ready;
1756 cf.error_function = sapi_sock_error;
1757 cf.file_descriptor = ccs->fd;
1758 /* File points to app namespace and socket */
1759 handle.aah_sock_index = appns_sapi_socket_index (app_ns, ccs);
1760 cf.private_data = handle.as_u64;
1761 cf.description = format (0, "app sock conn fd: %d", ccs->fd);
1763 /* Poll until we get an attach message. Socket points to file and
1764 * application that owns the socket */
1765 handle.aah_app_wrk_index = APP_INVALID_INDEX;
1766 handle.aah_file_index = clib_file_add (&file_main, &cf);
1767 ccs->private_data = handle.as_u64;
1772 appns_sapi_free_socket (app_ns, ccs);
1777 appns_sapi_del_ns_socket (app_namespace_t *app_ns)
1779 app_ns_api_handle_t *handle;
1782 pool_foreach (cs, app_ns->app_sockets)
1784 handle = (app_ns_api_handle_t *) &cs->private_data;
1785 clib_file_del_by_index (&file_main, handle->aah_file_index);
1787 clib_socket_close (cs);
1788 clib_socket_free (cs);
1790 pool_free (app_ns->app_sockets);
1794 appns_sapi_add_ns_socket (app_namespace_t * app_ns)
1796 char *subdir = "/app_ns_sockets/";
1797 app_ns_api_handle_t *handle;
1798 clib_file_t cf = { 0 };
1799 struct stat file_stat;
1806 if (!app_ns->sock_name)
1807 app_ns->sock_name = format (0, "@vpp/session/%v%c", app_ns->ns_id, 0);
1808 if (app_ns->sock_name[0] != '@')
1809 return VNET_API_ERROR_INVALID_VALUE;
1813 snprintf (dir, sizeof (dir), "%s%s", vlib_unix_get_runtime_dir (),
1815 err = vlib_unix_recursive_mkdir ((char *) dir);
1818 clib_error_report (err);
1819 return VNET_API_ERROR_SYSCALL_ERROR_1;
1822 if (!app_ns->sock_name)
1823 app_ns->sock_name = format (0, "%s%v%c", dir, app_ns->ns_id, 0);
1827 * Create and initialize socket to listen on
1829 cs = appns_sapi_alloc_socket (app_ns);
1830 cs->config = (char *) vec_dup (app_ns->sock_name);
1831 cs->flags = CLIB_SOCKET_F_IS_SERVER |
1832 CLIB_SOCKET_F_ALLOW_GROUP_WRITE |
1833 CLIB_SOCKET_F_SEQPACKET | CLIB_SOCKET_F_PASSCRED;
1835 if ((err = clib_socket_init_netns (cs, app_ns->netns)))
1837 clib_error_report (err);
1841 if (!app_ns->netns && stat ((char *) app_ns->sock_name, &file_stat) == -1)
1847 cf.read_function = sapi_sock_accept_ready;
1848 cf.file_descriptor = cs->fd;
1849 /* File points to namespace */
1850 handle = (app_ns_api_handle_t *) & cf.private_data;
1851 handle->aah_app_ns_index = app_namespace_index (app_ns);
1852 handle->aah_sock_index = appns_sapi_socket_index (app_ns, cs);
1853 cf.description = format (0, "app sock listener: %s", app_ns->sock_name);
1855 /* Socket points to clib file index */
1856 handle = (app_ns_api_handle_t *) & cs->private_data;
1857 handle->aah_file_index = clib_file_add (&file_main, &cf);
1858 handle->aah_app_wrk_index = APP_INVALID_INDEX;
1864 vl_api_application_tls_cert_add_t_handler (
1865 vl_api_application_tls_cert_add_t *mp)
1871 vl_api_application_tls_key_add_t_handler (vl_api_application_tls_key_add_t *mp)
1876 #include <vnet/session/session.api.c>
1877 static clib_error_t *
1878 session_api_hookup (vlib_main_t *vm)
1881 * Set up the (msg_name, crc, message-id) table
1883 REPLY_MSG_ID_BASE = setup_message_id_table ();
1888 VLIB_API_INIT_FUNCTION (session_api_hookup);
1891 * fd.io coding-style-patch-verification: ON
1894 * eval: (c-set-style "gnu")