2 * Copyright (c) 2015-2019 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 #include <vnet/vnet.h>
17 #include <vlibmemory/api.h>
18 #include <vnet/session/application.h>
19 #include <vnet/session/application_interface.h>
20 #include <vnet/session/application_local.h>
21 #include <vnet/session/session_rules_table.h>
22 #include <vnet/session/session_table.h>
23 #include <vnet/session/session.h>
25 #include <vnet/ip/ip_types_api.h>
27 #include <vnet/vnet_msg_enum.h>
29 #define vl_typedefs /* define message structures */
30 #include <vnet/vnet_all_api_h.h>
33 #define vl_endianfun /* define message structures */
34 #include <vnet/vnet_all_api_h.h>
37 /* instantiate all the print functions we know about */
38 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
40 #include <vnet/vnet_all_api_h.h>
43 #include <vlibapi/api_helper_macros.h>
45 #define foreach_session_api_msg \
46 _(APP_ATTACH, app_attach) \
47 _(APPLICATION_DETACH, application_detach) \
48 _(SESSION_ENABLE_DISABLE, session_enable_disable) \
49 _(APP_NAMESPACE_ADD_DEL, app_namespace_add_del) \
50 _(SESSION_RULE_ADD_DEL, session_rule_add_del) \
51 _(SESSION_RULES_DUMP, session_rules_dump) \
52 _(APP_ADD_CERT_KEY_PAIR, app_add_cert_key_pair) \
53 _(APP_DEL_CERT_KEY_PAIR, app_del_cert_key_pair) \
54 _(APP_WORKER_ADD_DEL, app_worker_add_del) \
56 static transport_proto_t
57 api_session_transport_proto_decode (const vl_api_transport_proto_t * api_tp)
61 case TRANSPORT_PROTO_API_TCP:
62 return TRANSPORT_PROTO_TCP;
63 case TRANSPORT_PROTO_API_UDP:
64 return TRANSPORT_PROTO_UDP;
65 case TRANSPORT_PROTO_API_TLS:
66 return TRANSPORT_PROTO_TLS;
67 case TRANSPORT_PROTO_API_QUIC:
68 return TRANSPORT_PROTO_QUIC;
70 return TRANSPORT_PROTO_NONE;
74 static vl_api_transport_proto_t
75 api_session_transport_proto_encode (const transport_proto_t tp)
79 case TRANSPORT_PROTO_TCP:
80 return TRANSPORT_PROTO_API_TCP;
81 case TRANSPORT_PROTO_UDP:
82 return TRANSPORT_PROTO_API_UDP;
83 case TRANSPORT_PROTO_TLS:
84 return TRANSPORT_PROTO_API_TLS;
85 case TRANSPORT_PROTO_QUIC:
86 return TRANSPORT_PROTO_API_QUIC;
88 return TRANSPORT_PROTO_API_NONE;
93 session_send_fds (vl_api_registration_t * reg, int fds[], int n_fds)
96 if (vl_api_registration_file_index (reg) == VL_API_INVALID_FI)
97 return SESSION_E_BAPI_NO_FD;
98 error = vl_api_send_fd_msg (reg, fds, n_fds);
101 clib_error_report (error);
102 return SESSION_E_BAPI_SEND_FD;
108 mq_try_lock_and_alloc_msg (svm_msg_q_t * app_mq, svm_msg_q_msg_t * msg)
114 rv = svm_msg_q_lock_and_alloc_msg_w_ring (app_mq,
115 SESSION_MQ_CTRL_EVT_RING,
122 clib_warning ("failed to alloc msg");
127 mq_send_session_accepted_cb (session_t * s)
129 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
130 svm_msg_q_msg_t _msg, *msg = &_msg;
131 session_accepted_msg_t m = { 0 };
133 fifo_segment_t *eq_seg;
135 session_event_t *evt;
138 app = application_get (app_wrk->app_index);
140 m.context = app->app_index;
141 m.server_rx_fifo = fifo_segment_fifo_offset (s->rx_fifo);
142 m.server_tx_fifo = fifo_segment_fifo_offset (s->tx_fifo);
143 m.segment_handle = session_segment_handle (s);
146 eq_seg = application_get_rx_mqs_segment (app);
148 if (session_has_transport (s))
150 listener = listen_session_get_from_handle (s->listener_handle);
151 m.listener_handle = app_listen_session_handle (listener);
152 if (application_is_proxy (app))
155 app_worker_first_listener (app_wrk, session_get_fib_proto (s),
156 session_get_transport_proto (s));
158 m.listener_handle = listen_session_get_handle (listener);
160 m.vpp_event_queue_address =
161 fifo_segment_msg_q_offset (eq_seg, s->thread_index);
162 m.mq_index = s->thread_index;
163 m.handle = session_handle (s);
165 session_get_endpoint (s, &m.rmt, 0 /* is_lcl */);
171 ct = (ct_connection_t *) session_get_transport (s);
172 listener = listen_session_get_from_handle (s->listener_handle);
173 m.listener_handle = app_listen_session_handle (listener);
174 m.rmt.is_ip4 = session_type_is_ip4 (listener->session_type);
175 m.rmt.port = ct->c_rmt_port;
176 m.handle = session_handle (s);
177 m.vpp_event_queue_address =
178 fifo_segment_msg_q_offset (eq_seg, s->thread_index);
179 m.mq_index = s->thread_index;
182 app_mq = app_wrk->event_queue;
183 if (mq_try_lock_and_alloc_msg (app_mq, msg))
184 return SESSION_E_MQ_MSG_ALLOC;
186 evt = svm_msg_q_msg_data (app_mq, msg);
187 clib_memset (evt, 0, sizeof (*evt));
188 evt->event_type = SESSION_CTRL_EVT_ACCEPTED;
189 clib_memcpy_fast (evt->data, &m, sizeof (m));
190 svm_msg_q_add_and_unlock (app_mq, msg);
196 mq_send_session_close_evt (app_worker_t * app_wrk, session_handle_t sh,
197 session_evt_type_t evt_type)
199 svm_msg_q_msg_t _msg, *msg = &_msg;
200 session_disconnected_msg_t *mp;
202 session_event_t *evt;
204 app_mq = app_wrk->event_queue;
205 if (mq_try_lock_and_alloc_msg (app_mq, msg))
207 evt = svm_msg_q_msg_data (app_mq, msg);
208 clib_memset (evt, 0, sizeof (*evt));
209 evt->event_type = evt_type;
210 mp = (session_disconnected_msg_t *) evt->data;
212 mp->context = app_wrk->api_client_index;
213 svm_msg_q_add_and_unlock (app_mq, msg);
217 mq_notify_close_subscribers (u32 app_index, session_handle_t sh,
218 svm_fifo_t * f, session_evt_type_t evt_type)
220 app_worker_t *app_wrk;
224 app = application_get (app_index);
228 for (i = 0; i < f->shr->n_subscribers; i++)
230 if (!(app_wrk = application_get_worker (app, f->shr->subscribers[i])))
232 mq_send_session_close_evt (app_wrk, sh, SESSION_CTRL_EVT_DISCONNECTED);
237 mq_send_session_disconnected_cb (session_t * s)
239 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
240 session_handle_t sh = session_handle (s);
242 mq_send_session_close_evt (app_wrk, session_handle (s),
243 SESSION_CTRL_EVT_DISCONNECTED);
245 if (svm_fifo_n_subscribers (s->rx_fifo))
246 mq_notify_close_subscribers (app_wrk->app_index, sh, s->rx_fifo,
247 SESSION_CTRL_EVT_DISCONNECTED);
251 mq_send_session_reset_cb (session_t * s)
253 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
254 session_handle_t sh = session_handle (s);
256 mq_send_session_close_evt (app_wrk, sh, SESSION_CTRL_EVT_RESET);
258 if (svm_fifo_n_subscribers (s->rx_fifo))
259 mq_notify_close_subscribers (app_wrk->app_index, sh, s->rx_fifo,
260 SESSION_CTRL_EVT_RESET);
264 mq_send_session_connected_cb (u32 app_wrk_index, u32 api_context,
265 session_t * s, session_error_t err)
267 svm_msg_q_msg_t _msg, *msg = &_msg;
268 session_connected_msg_t m = { 0 };
270 transport_connection_t *tc;
271 fifo_segment_t *eq_seg;
272 app_worker_t *app_wrk;
273 session_event_t *evt;
276 app_wrk = app_worker_get (app_wrk_index);
278 m.context = api_context;
284 app = application_get (app_wrk->app_index);
285 eq_seg = application_get_rx_mqs_segment (app);
287 if (session_has_transport (s))
289 tc = session_get_transport (s);
292 clib_warning ("failed to retrieve transport!");
293 m.retval = SESSION_E_REFUSED;
297 m.handle = session_handle (s);
298 m.vpp_event_queue_address =
299 fifo_segment_msg_q_offset (eq_seg, s->thread_index);
301 session_get_endpoint (s, &m.lcl, 1 /* is_lcl */);
303 m.server_rx_fifo = fifo_segment_fifo_offset (s->rx_fifo);
304 m.server_tx_fifo = fifo_segment_fifo_offset (s->tx_fifo);
305 m.segment_handle = session_segment_handle (s);
309 ct_connection_t *cct;
312 cct = (ct_connection_t *) session_get_transport (s);
313 m.handle = session_handle (s);
314 m.lcl.port = cct->c_lcl_port;
315 m.lcl.is_ip4 = cct->c_is_ip4;
316 m.vpp_event_queue_address =
317 fifo_segment_msg_q_offset (eq_seg, s->thread_index);
318 m.server_rx_fifo = fifo_segment_fifo_offset (s->rx_fifo);
319 m.server_tx_fifo = fifo_segment_fifo_offset (s->tx_fifo);
320 m.segment_handle = session_segment_handle (s);
321 ss = ct_session_get_peer (s);
322 m.ct_rx_fifo = fifo_segment_fifo_offset (ss->tx_fifo);
323 m.ct_tx_fifo = fifo_segment_fifo_offset (ss->rx_fifo);
324 m.ct_segment_handle = session_segment_handle (ss);
327 /* Setup client session index in advance, in case data arrives
328 * before the app processes message and updates it */
329 s->rx_fifo->shr->client_session_index = api_context;
330 s->tx_fifo->shr->client_session_index = api_context;
334 app_mq = app_wrk->event_queue;
336 if (mq_try_lock_and_alloc_msg (app_mq, msg))
337 return SESSION_E_MQ_MSG_ALLOC;
339 evt = svm_msg_q_msg_data (app_mq, msg);
340 clib_memset (evt, 0, sizeof (*evt));
341 evt->event_type = SESSION_CTRL_EVT_CONNECTED;
342 clib_memcpy_fast (evt->data, &m, sizeof (m));
344 svm_msg_q_add_and_unlock (app_mq, msg);
349 mq_send_session_bound_cb (u32 app_wrk_index, u32 api_context,
350 session_handle_t handle, int rv)
352 svm_msg_q_msg_t _msg, *msg = &_msg;
353 session_bound_msg_t m = { 0 };
355 transport_endpoint_t tep;
356 fifo_segment_t *eq_seg;
357 app_worker_t *app_wrk;
358 session_event_t *evt;
363 app_wrk = app_worker_get (app_wrk_index);
365 m.context = api_context;
372 al = app_listener_get_w_handle (handle);
373 if (al->session_index != SESSION_INVALID_INDEX)
374 ls = app_listener_get_session (al);
376 ls = app_listener_get_local_session (al);
378 session_get_endpoint (ls, &tep, 1 /* is_lcl */);
379 m.lcl_port = tep.port;
380 m.lcl_is_ip4 = tep.is_ip4;
381 clib_memcpy_fast (m.lcl_ip, &tep.ip, sizeof (tep.ip));
382 app = application_get (app_wrk->app_index);
383 eq_seg = application_get_rx_mqs_segment (app);
384 m.vpp_evt_q = fifo_segment_msg_q_offset (eq_seg, ls->thread_index);
386 if (session_transport_service_type (ls) == TRANSPORT_SERVICE_CL &&
389 m.rx_fifo = fifo_segment_fifo_offset (ls->rx_fifo);
390 m.tx_fifo = fifo_segment_fifo_offset (ls->tx_fifo);
391 m.segment_handle = session_segment_handle (ls);
396 app_mq = app_wrk->event_queue;
398 if (mq_try_lock_and_alloc_msg (app_mq, msg))
399 return SESSION_E_MQ_MSG_ALLOC;
401 evt = svm_msg_q_msg_data (app_mq, msg);
402 clib_memset (evt, 0, sizeof (*evt));
403 evt->event_type = SESSION_CTRL_EVT_BOUND;
404 clib_memcpy_fast (evt->data, &m, sizeof (m));
406 svm_msg_q_add_and_unlock (app_mq, msg);
411 mq_send_unlisten_reply (app_worker_t * app_wrk, session_handle_t sh,
414 svm_msg_q_msg_t _msg, *msg = &_msg;
415 session_unlisten_reply_msg_t *ump;
417 session_event_t *evt;
419 app_mq = app_wrk->event_queue;
420 if (mq_try_lock_and_alloc_msg (app_mq, msg))
423 evt = svm_msg_q_msg_data (app_mq, msg);
424 clib_memset (evt, 0, sizeof (*evt));
425 evt->event_type = SESSION_CTRL_EVT_UNLISTEN_REPLY;
426 ump = (session_unlisten_reply_msg_t *) evt->data;
427 ump->context = context;
430 svm_msg_q_add_and_unlock (app_mq, msg);
434 mq_send_session_migrate_cb (session_t * s, session_handle_t new_sh)
436 svm_msg_q_msg_t _msg, *msg = &_msg;
437 session_migrated_msg_t m = { 0 };
438 fifo_segment_t *eq_seg;
439 app_worker_t *app_wrk;
440 session_event_t *evt;
445 thread_index = session_thread_from_handle (new_sh);
446 app_wrk = app_worker_get (s->app_wrk_index);
447 app_mq = app_wrk->event_queue;
448 app = application_get (app_wrk->app_index);
449 eq_seg = application_get_rx_mqs_segment (app);
451 m.handle = session_handle (s);
452 m.new_handle = new_sh;
453 m.vpp_thread_index = thread_index;
454 m.vpp_evt_q = fifo_segment_msg_q_offset (eq_seg, thread_index);
455 m.segment_handle = SESSION_INVALID_HANDLE;
457 if (mq_try_lock_and_alloc_msg (app_mq, msg))
460 evt = svm_msg_q_msg_data (app_mq, msg);
461 clib_memset (evt, 0, sizeof (*evt));
462 evt->event_type = SESSION_CTRL_EVT_MIGRATED;
463 clib_memcpy_fast (evt->data, &m, sizeof (m));
465 svm_msg_q_add_and_unlock (app_mq, msg);
469 mq_send_add_segment_cb (u32 app_wrk_index, u64 segment_handle)
471 int fds[SESSION_N_FD_TYPE], n_fds = 0;
472 svm_msg_q_msg_t _msg, *msg = &_msg;
473 session_app_add_segment_msg_t *mp;
474 vl_api_registration_t *reg;
475 app_worker_t *app_wrk;
476 session_event_t *evt;
482 app_wrk = app_worker_get (app_wrk_index);
484 reg = vl_mem_api_client_index_to_registration (app_wrk->api_client_index);
487 clib_warning ("no api registration for client: %u",
488 app_wrk->api_client_index);
492 fs = segment_manager_get_segment_w_handle (segment_handle);
494 if (ssvm_type (sp) == SSVM_SEGMENT_MEMFD)
496 if (vl_api_registration_file_index (reg) == VL_API_INVALID_FI)
498 clib_warning ("can't send memfd fd");
502 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
507 app_mq = app_wrk->event_queue;
508 if (mq_try_lock_and_alloc_msg (app_mq, msg))
512 session_send_fds (reg, fds, n_fds);
514 evt = svm_msg_q_msg_data (app_mq, msg);
515 clib_memset (evt, 0, sizeof (*evt));
516 evt->event_type = SESSION_CTRL_EVT_APP_ADD_SEGMENT;
517 mp = (session_app_add_segment_msg_t *) evt->data;
518 clib_memset (mp, 0, sizeof (*mp));
519 mp->segment_size = sp->ssvm_size;
520 mp->fd_flags = fd_flags;
521 mp->segment_handle = segment_handle;
522 strncpy ((char *) mp->segment_name, (char *) sp->name,
523 sizeof (mp->segment_name) - 1);
525 svm_msg_q_add_and_unlock (app_mq, msg);
531 mq_send_del_segment_cb (u32 app_wrk_index, u64 segment_handle)
533 svm_msg_q_msg_t _msg, *msg = &_msg;
534 session_app_del_segment_msg_t *mp;
535 vl_api_registration_t *reg;
536 app_worker_t *app_wrk;
537 session_event_t *evt;
540 app_wrk = app_worker_get (app_wrk_index);
541 reg = vl_mem_api_client_index_to_registration (app_wrk->api_client_index);
544 clib_warning ("no registration: %u", app_wrk->api_client_index);
548 app_mq = app_wrk->event_queue;
549 if (mq_try_lock_and_alloc_msg (app_mq, msg))
552 evt = svm_msg_q_msg_data (app_mq, msg);
553 clib_memset (evt, 0, sizeof (*evt));
554 evt->event_type = SESSION_CTRL_EVT_APP_DEL_SEGMENT;
555 mp = (session_app_del_segment_msg_t *) evt->data;
556 clib_memset (mp, 0, sizeof (*mp));
557 mp->segment_handle = segment_handle;
558 svm_msg_q_add_and_unlock (app_mq, msg);
564 mq_send_session_cleanup_cb (session_t * s, session_cleanup_ntf_t ntf)
566 svm_msg_q_msg_t _msg, *msg = &_msg;
567 session_cleanup_msg_t *mp;
569 session_event_t *evt;
570 app_worker_t *app_wrk;
572 /* Propagate transport cleanup notifications only if app didn't close */
573 if (ntf == SESSION_CLEANUP_TRANSPORT
574 && s->session_state != SESSION_STATE_TRANSPORT_DELETED)
577 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
581 app_mq = app_wrk->event_queue;
582 if (mq_try_lock_and_alloc_msg (app_mq, msg))
585 evt = svm_msg_q_msg_data (app_mq, msg);
586 clib_memset (evt, 0, sizeof (*evt));
587 evt->event_type = SESSION_CTRL_EVT_CLEANUP;
588 mp = (session_cleanup_msg_t *) evt->data;
589 mp->handle = session_handle (s);
591 svm_msg_q_add_and_unlock (app_mq, msg);
594 static session_cb_vft_t session_mq_cb_vft = {
595 .session_accept_callback = mq_send_session_accepted_cb,
596 .session_disconnect_callback = mq_send_session_disconnected_cb,
597 .session_connected_callback = mq_send_session_connected_cb,
598 .session_reset_callback = mq_send_session_reset_cb,
599 .session_migrate_callback = mq_send_session_migrate_cb,
600 .session_cleanup_callback = mq_send_session_cleanup_cb,
601 .add_segment_callback = mq_send_add_segment_cb,
602 .del_segment_callback = mq_send_del_segment_cb,
606 vl_api_session_enable_disable_t_handler (vl_api_session_enable_disable_t * mp)
608 vl_api_session_enable_disable_reply_t *rmp;
609 vlib_main_t *vm = vlib_get_main ();
612 vnet_session_enable_disable (vm, mp->is_enable);
613 REPLY_MACRO (VL_API_SESSION_ENABLE_DISABLE_REPLY);
617 vl_api_app_attach_t_handler (vl_api_app_attach_t * mp)
619 int rv = 0, *fds = 0, n_fds = 0, n_workers, i;
620 fifo_segment_t *segp, *rx_mqs_seg = 0;
621 vnet_app_attach_args_t _a, *a = &_a;
622 vl_api_app_attach_reply_t *rmp;
623 u8 fd_flags = 0, ctrl_thread;
624 vl_api_registration_t *reg;
628 reg = vl_api_client_index_to_registration (mp->client_index);
632 n_workers = vlib_num_workers ();
633 if (!session_main_is_enabled () || appns_sapi_enabled ())
635 rv = VNET_API_ERROR_FEATURE_DISABLED;
638 /* Only support binary api with socket transport */
639 if (vl_api_registration_file_index (reg) == VL_API_INVALID_FI)
641 rv = VNET_API_ERROR_APP_UNSUPPORTED_CFG;
645 STATIC_ASSERT (sizeof (u64) * APP_OPTIONS_N_OPTIONS <=
646 sizeof (mp->options),
647 "Out of options, fix api message definition");
649 clib_memset (a, 0, sizeof (*a));
650 a->api_client_index = mp->client_index;
651 a->options = mp->options;
652 a->session_cb_vft = &session_mq_cb_vft;
653 a->namespace_id = vl_api_from_api_to_new_vec (mp, &mp->namespace_id);
655 if ((rv = vnet_application_attach (a)))
657 clib_warning ("attach returned: %d", rv);
658 vec_free (a->namespace_id);
661 vec_free (a->namespace_id);
663 vec_validate (fds, 3 /* segs + tx evtfd */ + n_workers);
665 /* Send rx mqs segment */
666 app = application_get (a->app_index);
667 rx_mqs_seg = application_get_rx_mqs_segment (app);
669 fd_flags |= SESSION_FD_F_VPP_MQ_SEGMENT;
670 fds[n_fds] = rx_mqs_seg->ssvm.fd;
673 /* Send fifo segment fd if needed */
674 if (ssvm_type (a->segment) == SSVM_SEGMENT_MEMFD)
676 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
677 fds[n_fds] = a->segment->fd;
680 if (a->options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
682 fd_flags |= SESSION_FD_F_MQ_EVENTFD;
683 fds[n_fds] = svm_msg_q_get_eventfd (a->app_evt_q);
687 if (application_use_private_rx_mqs ())
689 fd_flags |= SESSION_FD_F_VPP_MQ_EVENTFD;
690 for (i = 0; i < n_workers + 1; i++)
692 rx_mq = application_rx_mq_get (app, i);
693 fds[n_fds] = svm_msg_q_get_eventfd (rx_mq);
700 REPLY_MACRO2 (VL_API_APP_ATTACH_REPLY, ({
703 ctrl_thread = n_workers ? 1 : 0;
704 segp = (fifo_segment_t *) a->segment;
705 rmp->app_index = clib_host_to_net_u32 (a->app_index);
706 rmp->app_mq = fifo_segment_msg_q_offset (segp, 0);
707 rmp->vpp_ctrl_mq = fifo_segment_msg_q_offset (rx_mqs_seg, ctrl_thread);
708 rmp->vpp_ctrl_mq_thread = ctrl_thread;
710 rmp->fd_flags = fd_flags;
711 if (vec_len (segp->ssvm.name))
713 vl_api_vec_to_api_string (segp->ssvm.name, &rmp->segment_name);
715 rmp->segment_size = segp->ssvm.ssvm_size;
716 rmp->segment_handle = clib_host_to_net_u64 (a->segment_handle);
722 session_send_fds (reg, fds, n_fds);
727 vl_api_app_worker_add_del_t_handler (vl_api_app_worker_add_del_t * mp)
729 int rv = 0, fds[SESSION_N_FD_TYPE], n_fds = 0;
730 vl_api_app_worker_add_del_reply_t *rmp;
731 vl_api_registration_t *reg;
735 if (!session_main_is_enabled () || appns_sapi_enabled ())
737 rv = VNET_API_ERROR_FEATURE_DISABLED;
741 reg = vl_api_client_index_to_registration (mp->client_index);
745 app = application_get_if_valid (clib_net_to_host_u32 (mp->app_index));
748 rv = VNET_API_ERROR_INVALID_VALUE;
752 vnet_app_worker_add_del_args_t args = {
753 .app_index = app->app_index,
754 .wrk_map_index = clib_net_to_host_u32 (mp->wrk_index),
755 .api_client_index = mp->client_index,
758 rv = vnet_app_worker_add_del (&args);
761 clib_warning ("app worker add/del returned: %d", rv);
768 /* Send fifo segment fd if needed */
769 if (ssvm_type (args.segment) == SSVM_SEGMENT_MEMFD)
771 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
772 fds[n_fds] = args.segment->fd;
775 if (application_segment_manager_properties (app)->use_mq_eventfd)
777 fd_flags |= SESSION_FD_F_MQ_EVENTFD;
778 fds[n_fds] = svm_msg_q_get_eventfd (args.evt_q);
784 REPLY_MACRO2 (VL_API_APP_WORKER_ADD_DEL_REPLY, ({
785 rmp->is_add = mp->is_add;
786 rmp->wrk_index = clib_host_to_net_u32 (args.wrk_map_index);
787 rmp->segment_handle = clib_host_to_net_u64 (args.segment_handle);
788 if (!rv && mp->is_add)
790 rmp->app_event_queue_address =
791 fifo_segment_msg_q_offset ((fifo_segment_t *) args.segment, 0);
793 rmp->fd_flags = fd_flags;
794 if (vec_len (args.segment->name))
796 vl_api_vec_to_api_string (args.segment->name, &rmp->segment_name);
803 session_send_fds (reg, fds, n_fds);
807 vl_api_application_detach_t_handler (vl_api_application_detach_t * mp)
809 vl_api_application_detach_reply_t *rmp;
810 int rv = VNET_API_ERROR_INVALID_VALUE_2;
811 vnet_app_detach_args_t _a, *a = &_a;
814 if (!session_main_is_enabled () || appns_sapi_enabled ())
816 rv = VNET_API_ERROR_FEATURE_DISABLED;
820 app = application_lookup (mp->client_index);
823 a->app_index = app->app_index;
824 a->api_client_index = mp->client_index;
825 rv = vnet_application_detach (a);
829 REPLY_MACRO (VL_API_APPLICATION_DETACH_REPLY);
833 vl_api_app_namespace_add_del_t_handler (vl_api_app_namespace_add_del_t * mp)
835 vl_api_app_namespace_add_del_reply_t *rmp;
839 if (session_main_is_enabled () == 0)
841 rv = VNET_API_ERROR_FEATURE_DISABLED;
845 ns_id = vl_api_from_api_to_new_vec (mp, &mp->namespace_id);
847 vnet_app_namespace_add_del_args_t args = {
849 .secret = clib_net_to_host_u64 (mp->secret),
850 .sw_if_index = clib_net_to_host_u32 (mp->sw_if_index),
851 .ip4_fib_id = clib_net_to_host_u32 (mp->ip4_fib_id),
852 .ip6_fib_id = clib_net_to_host_u32 (mp->ip6_fib_id),
855 rv = vnet_app_namespace_add_del (&args);
858 appns_index = app_namespace_index_from_id (ns_id);
859 if (appns_index == APP_NAMESPACE_INVALID_INDEX)
861 clib_warning ("app ns lookup failed");
862 rv = VNET_API_ERROR_UNSPECIFIED;
869 REPLY_MACRO2 (VL_API_APP_NAMESPACE_ADD_DEL_REPLY, ({
871 rmp->appns_index = clib_host_to_net_u32 (appns_index);
877 vl_api_session_rule_add_del_t_handler (vl_api_session_rule_add_del_t * mp)
879 vl_api_session_rule_add_del_reply_t *rmp;
880 session_rule_add_del_args_t args;
881 session_rule_table_add_del_args_t *table_args = &args.table_args;
884 clib_memset (&args, 0, sizeof (args));
886 ip_prefix_decode (&mp->lcl, &table_args->lcl);
887 ip_prefix_decode (&mp->rmt, &table_args->rmt);
889 table_args->lcl_port = mp->lcl_port;
890 table_args->rmt_port = mp->rmt_port;
891 table_args->action_index = clib_net_to_host_u32 (mp->action_index);
892 table_args->is_add = mp->is_add;
893 mp->tag[sizeof (mp->tag) - 1] = 0;
894 table_args->tag = format (0, "%s", mp->tag);
895 args.appns_index = clib_net_to_host_u32 (mp->appns_index);
896 args.scope = mp->scope;
897 args.transport_proto =
898 api_session_transport_proto_decode (&mp->transport_proto) ==
899 TRANSPORT_PROTO_UDP ? 1 : 0;
901 rv = vnet_session_rule_add_del (&args);
903 clib_warning ("rule add del returned: %d", rv);
904 vec_free (table_args->tag);
905 REPLY_MACRO (VL_API_SESSION_RULE_ADD_DEL_REPLY);
909 send_session_rule_details4 (mma_rule_16_t * rule, u8 is_local,
910 u8 transport_proto, u32 appns_index, u8 * tag,
911 vl_api_registration_t * reg, u32 context)
913 vl_api_session_rules_details_t *rmp = 0;
914 session_mask_or_match_4_t *match =
915 (session_mask_or_match_4_t *) & rule->match;
916 session_mask_or_match_4_t *mask =
917 (session_mask_or_match_4_t *) & rule->mask;
918 fib_prefix_t lcl, rmt;
920 rmp = vl_msg_api_alloc (sizeof (*rmp));
921 clib_memset (rmp, 0, sizeof (*rmp));
922 rmp->_vl_msg_id = ntohs (VL_API_SESSION_RULES_DETAILS);
923 rmp->context = context;
925 clib_memset (&lcl, 0, sizeof (lcl));
926 clib_memset (&rmt, 0, sizeof (rmt));
927 ip_set (&lcl.fp_addr, &match->lcl_ip, 1);
928 ip_set (&rmt.fp_addr, &match->rmt_ip, 1);
929 lcl.fp_len = ip4_mask_to_preflen (&mask->lcl_ip);
930 rmt.fp_len = ip4_mask_to_preflen (&mask->rmt_ip);
932 ip_prefix_encode (&lcl, &rmp->lcl);
933 ip_prefix_encode (&rmt, &rmp->rmt);
934 rmp->lcl_port = match->lcl_port;
935 rmp->rmt_port = match->rmt_port;
936 rmp->action_index = clib_host_to_net_u32 (rule->action_index);
938 is_local ? SESSION_RULE_SCOPE_API_LOCAL : SESSION_RULE_SCOPE_API_GLOBAL;
939 rmp->transport_proto = api_session_transport_proto_encode (transport_proto);
940 rmp->appns_index = clib_host_to_net_u32 (appns_index);
943 clib_memcpy_fast (rmp->tag, tag, vec_len (tag));
944 rmp->tag[vec_len (tag)] = 0;
947 vl_api_send_msg (reg, (u8 *) rmp);
951 send_session_rule_details6 (mma_rule_40_t * rule, u8 is_local,
952 u8 transport_proto, u32 appns_index, u8 * tag,
953 vl_api_registration_t * reg, u32 context)
955 vl_api_session_rules_details_t *rmp = 0;
956 session_mask_or_match_6_t *match =
957 (session_mask_or_match_6_t *) & rule->match;
958 session_mask_or_match_6_t *mask =
959 (session_mask_or_match_6_t *) & rule->mask;
960 fib_prefix_t lcl, rmt;
962 rmp = vl_msg_api_alloc (sizeof (*rmp));
963 clib_memset (rmp, 0, sizeof (*rmp));
964 rmp->_vl_msg_id = ntohs (VL_API_SESSION_RULES_DETAILS);
965 rmp->context = context;
967 clib_memset (&lcl, 0, sizeof (lcl));
968 clib_memset (&rmt, 0, sizeof (rmt));
969 ip_set (&lcl.fp_addr, &match->lcl_ip, 0);
970 ip_set (&rmt.fp_addr, &match->rmt_ip, 0);
971 lcl.fp_len = ip6_mask_to_preflen (&mask->lcl_ip);
972 rmt.fp_len = ip6_mask_to_preflen (&mask->rmt_ip);
974 ip_prefix_encode (&lcl, &rmp->lcl);
975 ip_prefix_encode (&rmt, &rmp->rmt);
976 rmp->lcl_port = match->lcl_port;
977 rmp->rmt_port = match->rmt_port;
978 rmp->action_index = clib_host_to_net_u32 (rule->action_index);
980 is_local ? SESSION_RULE_SCOPE_API_LOCAL : SESSION_RULE_SCOPE_API_GLOBAL;
981 rmp->transport_proto = api_session_transport_proto_encode (transport_proto);
982 rmp->appns_index = clib_host_to_net_u32 (appns_index);
985 clib_memcpy_fast (rmp->tag, tag, vec_len (tag));
986 rmp->tag[vec_len (tag)] = 0;
989 vl_api_send_msg (reg, (u8 *) rmp);
993 send_session_rules_table_details (session_rules_table_t * srt, u8 fib_proto,
994 u8 tp, u8 is_local, u32 appns_index,
995 vl_api_registration_t * reg, u32 context)
997 mma_rule_16_t *rule16;
998 mma_rule_40_t *rule40;
999 mma_rules_table_16_t *srt16;
1000 mma_rules_table_40_t *srt40;
1003 if (is_local || fib_proto == FIB_PROTOCOL_IP4)
1007 srt16 = &srt->session_rules_tables_16;
1008 pool_foreach (rule16, srt16->rules) {
1009 ri = mma_rules_table_rule_index_16 (srt16, rule16);
1010 tag = session_rules_table_rule_tag (srt, ri, 1);
1011 send_session_rule_details4 (rule16, is_local, tp, appns_index, tag,
1016 if (is_local || fib_proto == FIB_PROTOCOL_IP6)
1020 srt40 = &srt->session_rules_tables_40;
1021 pool_foreach (rule40, srt40->rules) {
1022 ri = mma_rules_table_rule_index_40 (srt40, rule40);
1023 tag = session_rules_table_rule_tag (srt, ri, 1);
1024 send_session_rule_details6 (rule40, is_local, tp, appns_index, tag,
1032 vl_api_session_rules_dump_t_handler (vl_api_session_rules_dump_t * mp)
1034 vl_api_registration_t *reg;
1035 session_table_t *st;
1038 reg = vl_api_client_index_to_registration (mp->client_index);
1043 session_table_foreach (st, ({
1044 for (tp = 0; tp < TRANSPORT_N_PROTOS; tp++)
1046 send_session_rules_table_details (&st->session_rules[tp],
1047 st->active_fib_proto, tp,
1048 st->is_local, st->appns_index, reg,
1056 vl_api_app_add_cert_key_pair_t_handler (vl_api_app_add_cert_key_pair_t * mp)
1058 vl_api_app_add_cert_key_pair_reply_t *rmp;
1059 vnet_app_add_cert_key_pair_args_t _a, *a = &_a;
1060 u32 certkey_len, key_len, cert_len;
1062 if (session_main_is_enabled () == 0)
1064 rv = VNET_API_ERROR_FEATURE_DISABLED;
1068 cert_len = clib_net_to_host_u16 (mp->cert_len);
1069 if (cert_len > 10000)
1071 rv = VNET_API_ERROR_INVALID_VALUE;
1075 certkey_len = clib_net_to_host_u16 (mp->certkey_len);
1076 if (certkey_len < cert_len)
1078 rv = VNET_API_ERROR_INVALID_VALUE;
1082 key_len = certkey_len - cert_len;
1083 if (key_len > 10000)
1085 rv = VNET_API_ERROR_INVALID_VALUE;
1089 clib_memset (a, 0, sizeof (*a));
1090 a->cert = mp->certkey;
1091 a->key = mp->certkey + cert_len;
1092 a->cert_len = cert_len;
1093 a->key_len = key_len;
1094 rv = vnet_app_add_cert_key_pair (a);
1098 REPLY_MACRO2 (VL_API_APP_ADD_CERT_KEY_PAIR_REPLY, ({
1100 rmp->index = clib_host_to_net_u32 (a->index);
1106 vl_api_app_del_cert_key_pair_t_handler (vl_api_app_del_cert_key_pair_t * mp)
1108 vl_api_app_del_cert_key_pair_reply_t *rmp;
1111 if (session_main_is_enabled () == 0)
1113 rv = VNET_API_ERROR_FEATURE_DISABLED;
1116 ckpair_index = clib_net_to_host_u32 (mp->index);
1117 rv = vnet_app_del_cert_key_pair (ckpair_index);
1120 REPLY_MACRO (VL_API_APP_DEL_CERT_KEY_PAIR_REPLY);
1123 static clib_error_t *
1124 application_reaper_cb (u32 client_index)
1126 application_t *app = application_lookup (client_index);
1127 vnet_app_detach_args_t _a, *a = &_a;
1130 a->app_index = app->app_index;
1131 a->api_client_index = client_index;
1132 vnet_application_detach (a);
1137 VL_MSG_API_REAPER_FUNCTION (application_reaper_cb);
1139 #define vl_msg_name_crc_list
1140 #include <vnet/vnet_all_api_h.h>
1141 #undef vl_msg_name_crc_list
1144 setup_message_id_table (api_main_t * am)
1146 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
1147 foreach_vl_msg_name_crc_session;
1152 * session_api_hookup
1153 * Add uri's API message handlers to the table.
1154 * vlib has already mapped shared memory and
1155 * added the client registration handlers.
1156 * See .../open-repo/vlib/memclnt_vlib.c:memclnt_process()
1158 static clib_error_t *
1159 session_api_hookup (vlib_main_t * vm)
1161 api_main_t *am = vlibapi_get_main ();
1164 vl_msg_api_set_handlers(VL_API_##N, #n, \
1165 vl_api_##n##_t_handler, \
1167 vl_api_##n##_t_endian, \
1168 vl_api_##n##_t_print, \
1169 sizeof(vl_api_##n##_t), 1);
1170 foreach_session_api_msg;
1174 * Set up the (msg_name, crc, message-id) table
1176 setup_message_id_table (am);
1181 VLIB_API_INIT_FUNCTION (session_api_hookup);
1184 * Socket api functions
1188 sapi_send_fds (app_worker_t * app_wrk, int *fds, int n_fds)
1190 app_sapi_msg_t smsg = { 0 };
1191 app_namespace_t *app_ns;
1196 app = application_get (app_wrk->app_index);
1197 app_ns = app_namespace_get (app->ns_index);
1198 cs_index = appns_sapi_handle_sock_index (app_wrk->api_client_index);
1199 cs = appns_sapi_get_socket (app_ns, cs_index);
1200 if (PREDICT_FALSE (!cs))
1203 /* There's no payload for the message only the type */
1204 smsg.type = APP_SAPI_MSG_TYPE_SEND_FDS;
1205 clib_socket_sendmsg (cs, &smsg, sizeof (smsg), fds, n_fds);
1209 mq_send_add_segment_sapi_cb (u32 app_wrk_index, u64 segment_handle)
1211 int fds[SESSION_N_FD_TYPE], n_fds = 0;
1212 svm_msg_q_msg_t _msg, *msg = &_msg;
1213 session_app_add_segment_msg_t *mp;
1214 app_worker_t *app_wrk;
1215 session_event_t *evt;
1216 svm_msg_q_t *app_mq;
1221 app_wrk = app_worker_get (app_wrk_index);
1223 fs = segment_manager_get_segment_w_handle (segment_handle);
1225 ASSERT (ssvm_type (sp) == SSVM_SEGMENT_MEMFD);
1227 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
1228 fds[n_fds] = sp->fd;
1231 app_mq = app_wrk->event_queue;
1232 if (mq_try_lock_and_alloc_msg (app_mq, msg))
1236 * Send the fd over api socket
1238 sapi_send_fds (app_wrk, fds, n_fds);
1241 * Send the actual message over mq
1243 evt = svm_msg_q_msg_data (app_mq, msg);
1244 clib_memset (evt, 0, sizeof (*evt));
1245 evt->event_type = SESSION_CTRL_EVT_APP_ADD_SEGMENT;
1246 mp = (session_app_add_segment_msg_t *) evt->data;
1247 clib_memset (mp, 0, sizeof (*mp));
1248 mp->segment_size = sp->ssvm_size;
1249 mp->fd_flags = fd_flags;
1250 mp->segment_handle = segment_handle;
1251 strncpy ((char *) mp->segment_name, (char *) sp->name,
1252 sizeof (mp->segment_name) - 1);
1254 svm_msg_q_add_and_unlock (app_mq, msg);
1260 mq_send_del_segment_sapi_cb (u32 app_wrk_index, u64 segment_handle)
1262 svm_msg_q_msg_t _msg, *msg = &_msg;
1263 session_app_del_segment_msg_t *mp;
1264 app_worker_t *app_wrk;
1265 session_event_t *evt;
1266 svm_msg_q_t *app_mq;
1268 app_wrk = app_worker_get (app_wrk_index);
1270 app_mq = app_wrk->event_queue;
1271 if (mq_try_lock_and_alloc_msg (app_mq, msg))
1274 evt = svm_msg_q_msg_data (app_mq, msg);
1275 clib_memset (evt, 0, sizeof (*evt));
1276 evt->event_type = SESSION_CTRL_EVT_APP_DEL_SEGMENT;
1277 mp = (session_app_del_segment_msg_t *) evt->data;
1278 clib_memset (mp, 0, sizeof (*mp));
1279 mp->segment_handle = segment_handle;
1280 svm_msg_q_add_and_unlock (app_mq, msg);
1285 static session_cb_vft_t session_mq_sapi_cb_vft = {
1286 .session_accept_callback = mq_send_session_accepted_cb,
1287 .session_disconnect_callback = mq_send_session_disconnected_cb,
1288 .session_connected_callback = mq_send_session_connected_cb,
1289 .session_reset_callback = mq_send_session_reset_cb,
1290 .session_migrate_callback = mq_send_session_migrate_cb,
1291 .session_cleanup_callback = mq_send_session_cleanup_cb,
1292 .add_segment_callback = mq_send_add_segment_sapi_cb,
1293 .del_segment_callback = mq_send_del_segment_sapi_cb,
1297 session_api_attach_handler (app_namespace_t * app_ns, clib_socket_t * cs,
1298 app_sapi_attach_msg_t * mp)
1300 int rv = 0, *fds = 0, n_fds = 0, i, n_workers;
1301 vnet_app_attach_args_t _a, *a = &_a;
1302 app_sapi_attach_reply_msg_t *rmp;
1303 u8 fd_flags = 0, ctrl_thread;
1304 app_ns_api_handle_t *handle;
1305 fifo_segment_t *rx_mqs_seg;
1306 app_sapi_msg_t msg = { 0 };
1307 app_worker_t *app_wrk;
1311 /* Make sure name is null terminated */
1314 clib_memset (a, 0, sizeof (*a));
1315 a->api_client_index = appns_sapi_socket_handle (app_ns, cs);
1316 a->name = format (0, "%s", (char *) mp->name);
1317 a->options = mp->options;
1318 a->session_cb_vft = &session_mq_sapi_cb_vft;
1319 a->use_sock_api = 1;
1320 a->options[APP_OPTIONS_NAMESPACE] = app_namespace_index (app_ns);
1322 if ((rv = vnet_application_attach (a)))
1324 clib_warning ("attach returned: %d", rv);
1328 n_workers = vlib_num_workers ();
1329 vec_validate (fds, 3 /* segs + tx evtfd */ + n_workers);
1331 /* Send event queues segment */
1332 app = application_get (a->app_index);
1333 rx_mqs_seg = application_get_rx_mqs_segment (app);
1335 fd_flags |= SESSION_FD_F_VPP_MQ_SEGMENT;
1336 fds[n_fds] = rx_mqs_seg->ssvm.fd;
1339 /* Send fifo segment fd if needed */
1340 if (ssvm_type (a->segment) == SSVM_SEGMENT_MEMFD)
1342 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
1343 fds[n_fds] = a->segment->fd;
1346 if (a->options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
1348 fd_flags |= SESSION_FD_F_MQ_EVENTFD;
1349 fds[n_fds] = svm_msg_q_get_eventfd (a->app_evt_q);
1353 if (application_use_private_rx_mqs ())
1355 fd_flags |= SESSION_FD_F_VPP_MQ_EVENTFD;
1356 for (i = 0; i < n_workers + 1; i++)
1358 rx_mq = application_rx_mq_get (app, i);
1359 fds[n_fds] = svm_msg_q_get_eventfd (rx_mq);
1366 msg.type = APP_SAPI_MSG_TYPE_ATTACH_REPLY;
1367 rmp = &msg.attach_reply;
1371 ctrl_thread = n_workers ? 1 : 0;
1372 rmp->app_index = a->app_index;
1374 fifo_segment_msg_q_offset ((fifo_segment_t *) a->segment, 0);
1375 rmp->vpp_ctrl_mq = fifo_segment_msg_q_offset (rx_mqs_seg, ctrl_thread);
1376 rmp->vpp_ctrl_mq_thread = ctrl_thread;
1378 rmp->fd_flags = fd_flags;
1379 /* No segment name and size since we only support memfds
1380 * in this configuration */
1381 rmp->segment_handle = a->segment_handle;
1382 rmp->api_client_handle = a->api_client_index;
1384 /* Update app index for socket */
1385 handle = (app_ns_api_handle_t *) & cs->private_data;
1386 app_wrk = application_get_worker (app, 0);
1387 handle->aah_app_wrk_index = app_wrk->wrk_index;
1390 clib_socket_sendmsg (cs, &msg, sizeof (msg), fds, n_fds);
1396 sapi_socket_close_w_handle (u32 api_handle)
1398 app_namespace_t *app_ns = app_namespace_get (api_handle >> 16);
1399 u16 sock_index = api_handle & 0xffff;
1400 app_ns_api_handle_t *handle;
1404 cs = appns_sapi_get_socket (app_ns, sock_index);
1408 handle = (app_ns_api_handle_t *) & cs->private_data;
1409 cf = clib_file_get (&file_main, handle->aah_file_index);
1410 clib_file_del (&file_main, cf);
1412 clib_socket_close (cs);
1413 appns_sapi_free_socket (app_ns, cs);
1417 sapi_add_del_worker_handler (app_namespace_t * app_ns,
1419 app_sapi_worker_add_del_msg_t * mp)
1421 int rv = 0, fds[SESSION_N_FD_TYPE], n_fds = 0;
1422 app_sapi_worker_add_del_reply_msg_t *rmp;
1423 app_ns_api_handle_t *handle;
1424 app_sapi_msg_t msg = { 0 };
1425 app_worker_t *app_wrk;
1426 u32 sapi_handle = -1;
1430 app = application_get_if_valid (mp->app_index);
1433 rv = VNET_API_ERROR_INVALID_VALUE;
1437 sapi_handle = appns_sapi_socket_handle (app_ns, cs);
1439 vnet_app_worker_add_del_args_t args = {
1440 .app_index = app->app_index,
1441 .wrk_map_index = mp->wrk_index,
1442 .api_client_index = sapi_handle,
1443 .is_add = mp->is_add
1445 rv = vnet_app_worker_add_del (&args);
1448 clib_warning ("app worker add/del returned: %d", rv);
1454 sapi_socket_close_w_handle (sapi_handle);
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 msg.type = APP_SAPI_MSG_TYPE_ADD_DEL_WORKER_REPLY;
1475 rmp = &msg.worker_add_del_reply;
1477 rmp->is_add = mp->is_add;
1478 rmp->api_client_handle = sapi_handle;
1479 rmp->wrk_index = args.wrk_map_index;
1480 rmp->segment_handle = args.segment_handle;
1481 if (!rv && mp->is_add)
1483 /* No segment name and size. This supports only memfds */
1484 rmp->app_event_queue_address =
1485 fifo_segment_msg_q_offset ((fifo_segment_t *) args.segment, 0);
1487 rmp->fd_flags = fd_flags;
1489 /* Update app index for socket */
1490 handle = (app_ns_api_handle_t *) & cs->private_data;
1491 app_wrk = application_get_worker (app, args.wrk_map_index);
1492 handle->aah_app_wrk_index = app_wrk->wrk_index;
1495 clib_socket_sendmsg (cs, &msg, sizeof (msg), fds, n_fds);
1499 sapi_socket_detach (app_namespace_t * app_ns, clib_socket_t * cs)
1501 app_ns_api_handle_t *handle;
1502 app_worker_t *app_wrk;
1503 u32 api_client_handle;
1505 api_client_handle = appns_sapi_socket_handle (app_ns, cs);
1506 sapi_socket_close_w_handle (api_client_handle);
1508 /* Cleanup everything because app worker closed socket or crashed */
1509 handle = (app_ns_api_handle_t *) & cs->private_data;
1510 app_wrk = app_worker_get (handle->aah_app_wrk_index);
1512 vnet_app_worker_add_del_args_t args = {
1513 .app_index = app_wrk->app_index,
1514 .wrk_map_index = app_wrk->wrk_map_index,
1515 .api_client_index = api_client_handle,
1518 /* Send rpc to main thread for worker barrier */
1519 vlib_rpc_call_main_thread (vnet_app_worker_add_del, (u8 *) & args,
1523 static clib_error_t *
1524 sapi_sock_read_ready (clib_file_t * cf)
1526 app_ns_api_handle_t *handle = (app_ns_api_handle_t *) & cf->private_data;
1527 vlib_main_t *vm = vlib_get_main ();
1528 app_sapi_msg_t msg = { 0 };
1529 app_namespace_t *app_ns;
1530 clib_error_t *err = 0;
1533 app_ns = app_namespace_get (handle->aah_app_ns_index);
1534 cs = appns_sapi_get_socket (app_ns, handle->aah_sock_index);
1538 err = clib_socket_recvmsg (cs, &msg, sizeof (msg), 0, 0);
1541 clib_error_free (err);
1542 sapi_socket_detach (app_ns, cs);
1546 handle = (app_ns_api_handle_t *) & cs->private_data;
1548 vlib_worker_thread_barrier_sync (vm);
1552 case APP_SAPI_MSG_TYPE_ATTACH:
1553 session_api_attach_handler (app_ns, cs, &msg.attach);
1555 case APP_SAPI_MSG_TYPE_ADD_DEL_WORKER:
1556 sapi_add_del_worker_handler (app_ns, cs, &msg.worker_add_del);
1559 clib_warning ("app wrk %u unknown message type: %u",
1560 handle->aah_app_wrk_index, msg.type);
1564 vlib_worker_thread_barrier_release (vm);
1570 static clib_error_t *
1571 sapi_sock_write_ready (clib_file_t * cf)
1573 app_ns_api_handle_t *handle = (app_ns_api_handle_t *) & cf->private_data;
1574 clib_warning ("called for app ns %u", handle->aah_app_ns_index);
1578 static clib_error_t *
1579 sapi_sock_error (clib_file_t * cf)
1581 app_ns_api_handle_t *handle = (app_ns_api_handle_t *) & cf->private_data;
1582 app_namespace_t *app_ns;
1585 app_ns = app_namespace_get (handle->aah_app_ns_index);
1586 cs = appns_sapi_get_socket (app_ns, handle->aah_sock_index);
1590 sapi_socket_detach (app_ns, cs);
1594 static clib_error_t *
1595 sapi_sock_accept_ready (clib_file_t * scf)
1597 app_ns_api_handle_t handle = *(app_ns_api_handle_t *) & scf->private_data;
1598 app_namespace_t *app_ns;
1599 clib_file_t cf = { 0 };
1600 clib_error_t *err = 0;
1601 clib_socket_t *ccs, *scs;
1603 /* Listener files point to namespace */
1604 app_ns = app_namespace_get (handle.aah_app_ns_index);
1607 * Initialize client socket
1609 ccs = appns_sapi_alloc_socket (app_ns);
1611 /* Grab server socket after client is initialized */
1612 scs = appns_sapi_get_socket (app_ns, handle.aah_sock_index);
1616 err = clib_socket_accept (scs, ccs);
1619 clib_error_report (err);
1623 cf.read_function = sapi_sock_read_ready;
1624 cf.write_function = sapi_sock_write_ready;
1625 cf.error_function = sapi_sock_error;
1626 cf.file_descriptor = ccs->fd;
1627 /* File points to app namespace and socket */
1628 handle.aah_sock_index = appns_sapi_socket_index (app_ns, ccs);
1629 cf.private_data = handle.as_u64;
1630 cf.description = format (0, "app sock conn fd: %d", ccs->fd);
1632 /* Poll until we get an attach message. Socket points to file and
1633 * application that owns the socket */
1634 handle.aah_app_wrk_index = APP_INVALID_INDEX;
1635 handle.aah_file_index = clib_file_add (&file_main, &cf);
1636 ccs->private_data = handle.as_u64;
1641 appns_sapi_free_socket (app_ns, ccs);
1646 appns_sapi_add_ns_socket (app_namespace_t * app_ns)
1648 char *subdir = "/app_ns_sockets/";
1649 app_ns_api_handle_t *handle;
1650 clib_file_t cf = { 0 };
1651 struct stat file_stat;
1657 vec_add (dir, vlib_unix_get_runtime_dir (),
1658 strlen (vlib_unix_get_runtime_dir ()));
1659 vec_add (dir, (u8 *) subdir, strlen (subdir));
1661 err = vlib_unix_recursive_mkdir ((char *) dir);
1664 clib_error_report (err);
1669 app_ns->sock_name = format (0, "%v%v%c", dir, app_ns->ns_id, 0);
1672 * Create and initialize socket to listen on
1674 cs = appns_sapi_alloc_socket (app_ns);
1675 cs->config = (char *) app_ns->sock_name;
1676 cs->flags = CLIB_SOCKET_F_IS_SERVER |
1677 CLIB_SOCKET_F_ALLOW_GROUP_WRITE |
1678 CLIB_SOCKET_F_SEQPACKET | CLIB_SOCKET_F_PASSCRED;
1680 if ((err = clib_socket_init (cs)))
1682 clib_error_report (err);
1687 if (stat ((char *) app_ns->sock_name, &file_stat) == -1)
1696 cf.read_function = sapi_sock_accept_ready;
1697 cf.file_descriptor = cs->fd;
1698 /* File points to namespace */
1699 handle = (app_ns_api_handle_t *) & cf.private_data;
1700 handle->aah_app_ns_index = app_namespace_index (app_ns);
1701 handle->aah_sock_index = appns_sapi_socket_index (app_ns, cs);
1702 cf.description = format (0, "app sock listener: %s", app_ns->sock_name);
1704 /* Socket points to clib file index */
1705 handle = (app_ns_api_handle_t *) & cs->private_data;
1706 handle->aah_file_index = clib_file_add (&file_main, &cf);
1707 handle->aah_app_wrk_index = APP_INVALID_INDEX;
1715 * fd.io coding-style-patch-verification: ON
1718 * eval: (c-set-style "gnu")