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 _(APPLICATION_TLS_CERT_ADD, application_tls_cert_add) \
53 _(APPLICATION_TLS_KEY_ADD, application_tls_key_add) \
54 _(APP_ADD_CERT_KEY_PAIR, app_add_cert_key_pair) \
55 _(APP_DEL_CERT_KEY_PAIR, app_del_cert_key_pair) \
56 _(APP_WORKER_ADD_DEL, app_worker_add_del) \
58 static transport_proto_t
59 api_session_transport_proto_decode (const vl_api_transport_proto_t * api_tp)
63 case TRANSPORT_PROTO_API_TCP:
64 return TRANSPORT_PROTO_TCP;
65 case TRANSPORT_PROTO_API_UDP:
66 return TRANSPORT_PROTO_UDP;
67 case TRANSPORT_PROTO_API_TLS:
68 return TRANSPORT_PROTO_TLS;
69 case TRANSPORT_PROTO_API_UDPC:
70 return TRANSPORT_PROTO_UDPC;
71 case TRANSPORT_PROTO_API_QUIC:
72 return TRANSPORT_PROTO_QUIC;
74 return TRANSPORT_PROTO_NONE;
78 static vl_api_transport_proto_t
79 api_session_transport_proto_encode (const transport_proto_t tp)
83 case TRANSPORT_PROTO_TCP:
84 return TRANSPORT_PROTO_API_TCP;
85 case TRANSPORT_PROTO_UDP:
86 return TRANSPORT_PROTO_API_UDP;
87 case TRANSPORT_PROTO_TLS:
88 return TRANSPORT_PROTO_API_TLS;
89 case TRANSPORT_PROTO_UDPC:
90 return TRANSPORT_PROTO_API_UDPC;
91 case TRANSPORT_PROTO_QUIC:
92 return TRANSPORT_PROTO_API_QUIC;
94 return TRANSPORT_PROTO_API_NONE;
99 session_send_fds (vl_api_registration_t * reg, int fds[], int n_fds)
102 if (vl_api_registration_file_index (reg) == VL_API_INVALID_FI)
104 clib_warning ("can't send memfd fd");
107 error = vl_api_send_fd_msg (reg, fds, n_fds);
110 clib_error_report (error);
117 mq_try_lock_and_alloc_msg (svm_msg_q_t * app_mq, svm_msg_q_msg_t * msg)
123 rv = svm_msg_q_lock_and_alloc_msg_w_ring (app_mq,
124 SESSION_MQ_CTRL_EVT_RING,
131 clib_warning ("failed to alloc msg");
136 mq_send_session_accepted_cb (session_t * s)
138 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
139 svm_msg_q_msg_t _msg, *msg = &_msg;
140 svm_msg_q_t *vpp_queue, *app_mq;
142 session_accepted_msg_t *mp;
143 session_event_t *evt;
146 app = application_get (app_wrk->app_index);
147 app_mq = app_wrk->event_queue;
148 if (mq_try_lock_and_alloc_msg (app_mq, msg))
151 evt = svm_msg_q_msg_data (app_mq, msg);
152 clib_memset (evt, 0, sizeof (*evt));
153 evt->event_type = SESSION_CTRL_EVT_ACCEPTED;
154 mp = (session_accepted_msg_t *) evt->data;
155 clib_memset (mp, 0, sizeof (*mp));
156 mp->context = app->app_index;
157 mp->server_rx_fifo = pointer_to_uword (s->rx_fifo);
158 mp->server_tx_fifo = pointer_to_uword (s->tx_fifo);
159 mp->segment_handle = session_segment_handle (s);
160 mp->flags = s->flags;
162 if (session_has_transport (s))
164 listener = listen_session_get_from_handle (s->listener_handle);
165 mp->listener_handle = app_listen_session_handle (listener);
166 if (application_is_proxy (app))
169 app_worker_first_listener (app_wrk, session_get_fib_proto (s),
170 session_get_transport_proto (s));
172 mp->listener_handle = listen_session_get_handle (listener);
174 vpp_queue = session_main_get_vpp_event_queue (s->thread_index);
175 mp->vpp_event_queue_address = pointer_to_uword (vpp_queue);
176 mp->handle = session_handle (s);
178 session_get_endpoint (s, &mp->rmt, 0 /* is_lcl */ );
184 ct = (ct_connection_t *) session_get_transport (s);
185 listener = listen_session_get_from_handle (s->listener_handle);
186 mp->listener_handle = app_listen_session_handle (listener);
187 mp->rmt.is_ip4 = session_type_is_ip4 (listener->session_type);
188 mp->rmt.port = ct->c_rmt_port;
189 mp->handle = session_handle (s);
190 vpp_queue = session_main_get_vpp_event_queue (0);
191 mp->vpp_event_queue_address = pointer_to_uword (vpp_queue);
193 svm_msg_q_add_and_unlock (app_mq, msg);
199 mq_send_session_close_evt (app_worker_t * app_wrk, session_handle_t sh,
200 session_evt_type_t evt_type)
202 svm_msg_q_msg_t _msg, *msg = &_msg;
203 session_disconnected_msg_t *mp;
205 session_event_t *evt;
207 app_mq = app_wrk->event_queue;
208 if (mq_try_lock_and_alloc_msg (app_mq, msg))
210 evt = svm_msg_q_msg_data (app_mq, msg);
211 clib_memset (evt, 0, sizeof (*evt));
212 evt->event_type = evt_type;
213 mp = (session_disconnected_msg_t *) evt->data;
215 mp->context = app_wrk->api_client_index;
216 svm_msg_q_add_and_unlock (app_mq, msg);
220 mq_notify_close_subscribers (u32 app_index, session_handle_t sh,
221 svm_fifo_t * f, session_evt_type_t evt_type)
223 app_worker_t *app_wrk;
227 app = application_get (app_index);
231 for (i = 0; i < f->n_subscribers; i++)
233 if (!(app_wrk = application_get_worker (app, f->subscribers[i])))
235 mq_send_session_close_evt (app_wrk, sh, SESSION_CTRL_EVT_DISCONNECTED);
240 mq_send_session_disconnected_cb (session_t * s)
242 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
243 session_handle_t sh = session_handle (s);
245 mq_send_session_close_evt (app_wrk, session_handle (s),
246 SESSION_CTRL_EVT_DISCONNECTED);
248 if (svm_fifo_n_subscribers (s->rx_fifo))
249 mq_notify_close_subscribers (app_wrk->app_index, sh, s->rx_fifo,
250 SESSION_CTRL_EVT_DISCONNECTED);
254 mq_send_session_reset_cb (session_t * s)
256 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
257 session_handle_t sh = session_handle (s);
259 mq_send_session_close_evt (app_wrk, sh, SESSION_CTRL_EVT_RESET);
261 if (svm_fifo_n_subscribers (s->rx_fifo))
262 mq_notify_close_subscribers (app_wrk->app_index, sh, s->rx_fifo,
263 SESSION_CTRL_EVT_RESET);
267 mq_send_session_connected_cb (u32 app_wrk_index, u32 api_context,
268 session_t * s, u8 is_fail)
270 svm_msg_q_msg_t _msg, *msg = &_msg;
271 session_connected_msg_t *mp;
272 svm_msg_q_t *vpp_mq, *app_mq;
273 transport_connection_t *tc;
274 app_worker_t *app_wrk;
275 session_event_t *evt;
277 app_wrk = app_worker_get (app_wrk_index);
278 app_mq = app_wrk->event_queue;
281 clib_warning ("app %u with api index: %u not attached",
282 app_wrk->app_index, app_wrk->api_client_index);
286 if (mq_try_lock_and_alloc_msg (app_mq, msg))
289 evt = svm_msg_q_msg_data (app_mq, msg);
290 clib_memset (evt, 0, sizeof (*evt));
291 evt->event_type = SESSION_CTRL_EVT_CONNECTED;
292 mp = (session_connected_msg_t *) evt->data;
293 clib_memset (mp, 0, sizeof (*mp));
294 mp->context = api_context;
299 if (session_has_transport (s))
301 tc = session_get_transport (s);
308 vpp_mq = session_main_get_vpp_event_queue (s->thread_index);
309 mp->handle = session_handle (s);
310 mp->vpp_event_queue_address = pointer_to_uword (vpp_mq);
312 session_get_endpoint (s, &mp->lcl, 1 /* is_lcl */ );
314 mp->server_rx_fifo = pointer_to_uword (s->rx_fifo);
315 mp->server_tx_fifo = pointer_to_uword (s->tx_fifo);
316 mp->segment_handle = session_segment_handle (s);
320 ct_connection_t *cct;
323 cct = (ct_connection_t *) session_get_transport (s);
324 mp->handle = session_handle (s);
325 mp->lcl.port = cct->c_lcl_port;
326 mp->lcl.is_ip4 = cct->c_is_ip4;
327 vpp_mq = session_main_get_vpp_event_queue (0);
328 mp->vpp_event_queue_address = pointer_to_uword (vpp_mq);
329 mp->server_rx_fifo = pointer_to_uword (s->rx_fifo);
330 mp->server_tx_fifo = pointer_to_uword (s->tx_fifo);
331 mp->segment_handle = session_segment_handle (s);
332 ss = ct_session_get_peer (s);
333 mp->ct_rx_fifo = pointer_to_uword (ss->tx_fifo);
334 mp->ct_tx_fifo = pointer_to_uword (ss->rx_fifo);
335 mp->ct_segment_handle = session_segment_handle (ss);
339 mp->retval = is_fail ?
340 clib_host_to_net_u32 (VNET_API_ERROR_SESSION_CONNECT) : 0;
342 svm_msg_q_add_and_unlock (app_mq, msg);
347 mq_send_session_bound_cb (u32 app_wrk_index, u32 api_context,
348 session_handle_t handle, int rv)
350 svm_msg_q_msg_t _msg, *msg = &_msg;
351 svm_msg_q_t *app_mq, *vpp_evt_q;
352 transport_endpoint_t tep;
353 session_bound_msg_t *mp;
354 app_worker_t *app_wrk;
355 session_event_t *evt;
358 app_wrk = app_worker_get (app_wrk_index);
359 app_mq = app_wrk->event_queue;
362 clib_warning ("app %u with api index: %u not attached",
363 app_wrk->app_index, app_wrk->api_client_index);
367 if (mq_try_lock_and_alloc_msg (app_mq, msg))
370 evt = svm_msg_q_msg_data (app_mq, msg);
371 clib_memset (evt, 0, sizeof (*evt));
372 evt->event_type = SESSION_CTRL_EVT_BOUND;
373 mp = (session_bound_msg_t *) evt->data;
374 mp->context = api_context;
380 al = app_listener_get_w_handle (handle);
381 if (al->session_index != SESSION_INVALID_INDEX)
382 ls = app_listener_get_session (al);
384 ls = app_listener_get_local_session (al);
386 session_get_endpoint (ls, &tep, 1 /* is_lcl */ );
387 mp->lcl_port = tep.port;
388 mp->lcl_is_ip4 = tep.is_ip4;
389 clib_memcpy_fast (mp->lcl_ip, &tep.ip, sizeof (tep.ip));
391 vpp_evt_q = session_main_get_vpp_event_queue (0);
392 mp->vpp_evt_q = pointer_to_uword (vpp_evt_q);
394 if (session_transport_service_type (ls) == TRANSPORT_SERVICE_CL)
396 mp->rx_fifo = pointer_to_uword (ls->rx_fifo);
397 mp->tx_fifo = pointer_to_uword (ls->tx_fifo);
402 svm_msg_q_add_and_unlock (app_mq, msg);
407 mq_send_unlisten_reply (app_worker_t * app_wrk, session_handle_t sh,
410 svm_msg_q_msg_t _msg, *msg = &_msg;
411 session_unlisten_reply_msg_t *ump;
413 session_event_t *evt;
415 app_mq = app_wrk->event_queue;
416 if (mq_try_lock_and_alloc_msg (app_mq, msg))
419 evt = svm_msg_q_msg_data (app_mq, msg);
420 clib_memset (evt, 0, sizeof (*evt));
421 evt->event_type = SESSION_CTRL_EVT_UNLISTEN_REPLY;
422 ump = (session_unlisten_reply_msg_t *) evt->data;
423 ump->context = context;
426 svm_msg_q_add_and_unlock (app_mq, msg);
430 mq_send_session_migrate_cb (session_t * s, session_handle_t new_sh)
432 svm_msg_q_msg_t _msg, *msg = &_msg;
433 session_migrated_msg_t *mp;
434 svm_msg_q_t *vpp_evt_q;
435 app_worker_t *app_wrk;
436 session_event_t *evt;
439 app_wrk = app_worker_get (s->app_wrk_index);
440 app_mq = app_wrk->event_queue;
441 if (mq_try_lock_and_alloc_msg (app_mq, msg))
444 evt = svm_msg_q_msg_data (app_mq, msg);
445 clib_memset (evt, 0, sizeof (*evt));
446 evt->event_type = SESSION_CTRL_EVT_MIGRATED;
447 mp = (session_migrated_msg_t *) evt->data;
448 mp->handle = session_handle (s);
449 mp->new_handle = new_sh;
450 mp->vpp_thread_index = session_thread_from_handle (new_sh);
451 vpp_evt_q = session_main_get_vpp_event_queue (mp->vpp_thread_index);
452 mp->vpp_evt_q = pointer_to_uword (vpp_evt_q);
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 /* Only propagate session cleanup notification */
561 if (ntf == SESSION_CLEANUP_TRANSPORT)
564 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
568 app_mq = app_wrk->event_queue;
569 if (mq_try_lock_and_alloc_msg (app_mq, msg))
572 evt = svm_msg_q_msg_data (app_mq, msg);
573 clib_memset (evt, 0, sizeof (*evt));
574 evt->event_type = SESSION_CTRL_EVT_CLEANUP;
575 mp = (session_cleanup_msg_t *) evt->data;
576 mp->handle = session_handle (s);
577 svm_msg_q_add_and_unlock (app_mq, msg);
580 static session_cb_vft_t session_mq_cb_vft = {
581 .session_accept_callback = mq_send_session_accepted_cb,
582 .session_disconnect_callback = mq_send_session_disconnected_cb,
583 .session_connected_callback = mq_send_session_connected_cb,
584 .session_reset_callback = mq_send_session_reset_cb,
585 .session_migrate_callback = mq_send_session_migrate_cb,
586 .session_cleanup_callback = mq_send_session_cleanup_cb,
587 .add_segment_callback = mq_send_add_segment_cb,
588 .del_segment_callback = mq_send_del_segment_cb,
592 vl_api_session_enable_disable_t_handler (vl_api_session_enable_disable_t * mp)
594 vl_api_session_enable_disable_reply_t *rmp;
595 vlib_main_t *vm = vlib_get_main ();
598 vnet_session_enable_disable (vm, mp->is_enable);
599 REPLY_MACRO (VL_API_SESSION_ENABLE_DISABLE_REPLY);
603 vl_api_app_attach_t_handler (vl_api_app_attach_t * mp)
605 int rv = 0, fds[SESSION_N_FD_TYPE], n_fds = 0;
606 vl_api_app_attach_reply_t *rmp;
607 ssvm_private_t *segp, *evt_q_segment;
608 vnet_app_attach_args_t _a, *a = &_a;
609 u8 fd_flags = 0, ctrl_thread;
610 vl_api_registration_t *reg;
611 svm_msg_q_t *ctrl_mq;
613 reg = vl_api_client_index_to_registration (mp->client_index);
617 if (session_main_is_enabled () == 0)
619 rv = VNET_API_ERROR_FEATURE_DISABLED;
623 STATIC_ASSERT (sizeof (u64) * APP_OPTIONS_N_OPTIONS <=
624 sizeof (mp->options),
625 "Out of options, fix api message definition");
627 clib_memset (a, 0, sizeof (*a));
628 a->api_client_index = mp->client_index;
629 a->options = mp->options;
630 a->session_cb_vft = &session_mq_cb_vft;
632 a->namespace_id = vl_api_from_api_to_new_vec (&mp->namespace_id);
634 if ((rv = vnet_application_attach (a)))
636 clib_warning ("attach returned: %d", rv);
637 vec_free (a->namespace_id);
640 vec_free (a->namespace_id);
642 /* Send event queues segment */
643 if ((evt_q_segment = session_main_get_evt_q_segment ()))
645 fd_flags |= SESSION_FD_F_VPP_MQ_SEGMENT;
646 fds[n_fds] = evt_q_segment->fd;
649 /* Send fifo segment fd if needed */
650 if (ssvm_type (a->segment) == SSVM_SEGMENT_MEMFD)
652 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
653 fds[n_fds] = a->segment->fd;
656 if (a->options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
658 fd_flags |= SESSION_FD_F_MQ_EVENTFD;
659 fds[n_fds] = svm_msg_q_get_producer_eventfd (a->app_evt_q);
665 REPLY_MACRO2 (VL_API_APP_ATTACH_REPLY, ({
668 ctrl_thread = vlib_num_workers () ? 1 : 0;
669 ctrl_mq = session_main_get_vpp_event_queue (ctrl_thread);
671 rmp->app_index = clib_host_to_net_u32 (a->app_index);
672 rmp->app_mq = pointer_to_uword (a->app_evt_q);
673 rmp->vpp_ctrl_mq = pointer_to_uword (ctrl_mq);
674 rmp->vpp_ctrl_mq_thread = ctrl_thread;
676 rmp->fd_flags = fd_flags;
677 if (vec_len (segp->name))
679 vl_api_vec_to_api_string (segp->name, &rmp->segment_name);
681 rmp->segment_size = segp->ssvm_size;
682 rmp->segment_handle = clib_host_to_net_u64 (a->segment_handle);
688 session_send_fds (reg, fds, n_fds);
692 vl_api_app_worker_add_del_t_handler (vl_api_app_worker_add_del_t * mp)
694 int rv = 0, fds[SESSION_N_FD_TYPE], n_fds = 0;
695 vl_api_app_worker_add_del_reply_t *rmp;
696 vl_api_registration_t *reg;
700 if (session_main_is_enabled () == 0)
702 rv = VNET_API_ERROR_FEATURE_DISABLED;
706 reg = vl_api_client_index_to_registration (mp->client_index);
710 app = application_get_if_valid (clib_net_to_host_u32 (mp->app_index));
713 rv = VNET_API_ERROR_INVALID_VALUE;
717 vnet_app_worker_add_del_args_t args = {
718 .app_index = app->app_index,
719 .wrk_map_index = clib_net_to_host_u32 (mp->wrk_index),
720 .api_client_index = mp->client_index,
723 rv = vnet_app_worker_add_del (&args);
726 clib_warning ("app worker add/del returned: %d", rv);
733 /* Send fifo segment fd if needed */
734 if (ssvm_type (args.segment) == SSVM_SEGMENT_MEMFD)
736 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
737 fds[n_fds] = args.segment->fd;
740 if (application_segment_manager_properties (app)->use_mq_eventfd)
742 fd_flags |= SESSION_FD_F_MQ_EVENTFD;
743 fds[n_fds] = svm_msg_q_get_producer_eventfd (args.evt_q);
749 REPLY_MACRO2 (VL_API_APP_WORKER_ADD_DEL_REPLY, ({
750 rmp->is_add = mp->is_add;
751 rmp->wrk_index = clib_host_to_net_u32 (args.wrk_map_index);
752 rmp->segment_handle = clib_host_to_net_u64 (args.segment_handle);
753 if (!rv && mp->is_add)
755 if (vec_len (args.segment->name))
757 vl_api_vec_to_api_string (args.segment->name, &rmp->segment_name);
759 rmp->app_event_queue_address = pointer_to_uword (args.evt_q);
761 rmp->fd_flags = fd_flags;
767 session_send_fds (reg, fds, n_fds);
771 vl_api_application_detach_t_handler (vl_api_application_detach_t * mp)
773 vl_api_application_detach_reply_t *rmp;
774 int rv = VNET_API_ERROR_INVALID_VALUE_2;
775 vnet_app_detach_args_t _a, *a = &_a;
778 if (session_main_is_enabled () == 0)
780 rv = VNET_API_ERROR_FEATURE_DISABLED;
784 app = application_lookup (mp->client_index);
787 a->app_index = app->app_index;
788 a->api_client_index = mp->client_index;
789 rv = vnet_application_detach (a);
793 REPLY_MACRO (VL_API_APPLICATION_DETACH_REPLY);
797 vl_api_app_namespace_add_del_t_handler (vl_api_app_namespace_add_del_t * mp)
799 vl_api_app_namespace_add_del_reply_t *rmp;
803 if (session_main_is_enabled () == 0)
805 rv = VNET_API_ERROR_FEATURE_DISABLED;
809 ns_id = vl_api_from_api_to_new_vec (&mp->namespace_id);
811 vnet_app_namespace_add_del_args_t args = {
813 .secret = clib_net_to_host_u64 (mp->secret),
814 .sw_if_index = clib_net_to_host_u32 (mp->sw_if_index),
815 .ip4_fib_id = clib_net_to_host_u32 (mp->ip4_fib_id),
816 .ip6_fib_id = clib_net_to_host_u32 (mp->ip6_fib_id),
819 rv = vnet_app_namespace_add_del (&args);
822 appns_index = app_namespace_index_from_id (ns_id);
823 if (appns_index == APP_NAMESPACE_INVALID_INDEX)
825 clib_warning ("app ns lookup failed");
826 rv = VNET_API_ERROR_UNSPECIFIED;
833 REPLY_MACRO2 (VL_API_APP_NAMESPACE_ADD_DEL_REPLY, ({
835 rmp->appns_index = clib_host_to_net_u32 (appns_index);
841 vl_api_session_rule_add_del_t_handler (vl_api_session_rule_add_del_t * mp)
843 vl_api_session_rule_add_del_reply_t *rmp;
844 session_rule_add_del_args_t args;
845 session_rule_table_add_del_args_t *table_args = &args.table_args;
848 clib_memset (&args, 0, sizeof (args));
850 ip_prefix_decode (&mp->lcl, &table_args->lcl);
851 ip_prefix_decode (&mp->rmt, &table_args->rmt);
853 table_args->lcl_port = mp->lcl_port;
854 table_args->rmt_port = mp->rmt_port;
855 table_args->action_index = clib_net_to_host_u32 (mp->action_index);
856 table_args->is_add = mp->is_add;
857 mp->tag[sizeof (mp->tag) - 1] = 0;
858 table_args->tag = format (0, "%s", mp->tag);
859 args.appns_index = clib_net_to_host_u32 (mp->appns_index);
860 args.scope = mp->scope;
861 args.transport_proto =
862 api_session_transport_proto_decode (&mp->transport_proto) ==
863 TRANSPORT_PROTO_UDP ? 1 : 0;
865 rv = vnet_session_rule_add_del (&args);
867 clib_warning ("rule add del returned: %d", rv);
868 vec_free (table_args->tag);
869 REPLY_MACRO (VL_API_SESSION_RULE_ADD_DEL_REPLY);
873 send_session_rule_details4 (mma_rule_16_t * rule, u8 is_local,
874 u8 transport_proto, u32 appns_index, u8 * tag,
875 vl_api_registration_t * reg, u32 context)
877 vl_api_session_rules_details_t *rmp = 0;
878 session_mask_or_match_4_t *match =
879 (session_mask_or_match_4_t *) & rule->match;
880 session_mask_or_match_4_t *mask =
881 (session_mask_or_match_4_t *) & rule->mask;
882 fib_prefix_t lcl, rmt;
884 rmp = vl_msg_api_alloc (sizeof (*rmp));
885 clib_memset (rmp, 0, sizeof (*rmp));
886 rmp->_vl_msg_id = ntohs (VL_API_SESSION_RULES_DETAILS);
887 rmp->context = context;
889 clib_memset (&lcl, 0, sizeof (lcl));
890 clib_memset (&rmt, 0, sizeof (rmt));
891 ip_set (&lcl.fp_addr, &match->lcl_ip, 1);
892 ip_set (&rmt.fp_addr, &match->rmt_ip, 1);
893 lcl.fp_len = ip4_mask_to_preflen (&mask->lcl_ip);
894 rmt.fp_len = ip4_mask_to_preflen (&mask->rmt_ip);
896 ip_prefix_encode (&lcl, &rmp->lcl);
897 ip_prefix_encode (&rmt, &rmp->rmt);
898 rmp->lcl_port = match->lcl_port;
899 rmp->rmt_port = match->rmt_port;
900 rmp->action_index = clib_host_to_net_u32 (rule->action_index);
902 is_local ? SESSION_RULE_SCOPE_API_LOCAL : SESSION_RULE_SCOPE_API_GLOBAL;
903 rmp->transport_proto = api_session_transport_proto_encode (transport_proto);
904 rmp->appns_index = clib_host_to_net_u32 (appns_index);
907 clib_memcpy_fast (rmp->tag, tag, vec_len (tag));
908 rmp->tag[vec_len (tag)] = 0;
911 vl_api_send_msg (reg, (u8 *) rmp);
915 send_session_rule_details6 (mma_rule_40_t * rule, u8 is_local,
916 u8 transport_proto, u32 appns_index, u8 * tag,
917 vl_api_registration_t * reg, u32 context)
919 vl_api_session_rules_details_t *rmp = 0;
920 session_mask_or_match_6_t *match =
921 (session_mask_or_match_6_t *) & rule->match;
922 session_mask_or_match_6_t *mask =
923 (session_mask_or_match_6_t *) & rule->mask;
924 fib_prefix_t lcl, rmt;
926 rmp = vl_msg_api_alloc (sizeof (*rmp));
927 clib_memset (rmp, 0, sizeof (*rmp));
928 rmp->_vl_msg_id = ntohs (VL_API_SESSION_RULES_DETAILS);
929 rmp->context = context;
931 clib_memset (&lcl, 0, sizeof (lcl));
932 clib_memset (&rmt, 0, sizeof (rmt));
933 ip_set (&lcl.fp_addr, &match->lcl_ip, 0);
934 ip_set (&rmt.fp_addr, &match->rmt_ip, 0);
935 lcl.fp_len = ip6_mask_to_preflen (&mask->lcl_ip);
936 rmt.fp_len = ip6_mask_to_preflen (&mask->rmt_ip);
938 ip_prefix_encode (&lcl, &rmp->lcl);
939 ip_prefix_encode (&rmt, &rmp->rmt);
940 rmp->lcl_port = match->lcl_port;
941 rmp->rmt_port = match->rmt_port;
942 rmp->action_index = clib_host_to_net_u32 (rule->action_index);
944 is_local ? SESSION_RULE_SCOPE_API_LOCAL : SESSION_RULE_SCOPE_API_GLOBAL;
945 rmp->transport_proto = api_session_transport_proto_encode (transport_proto);
946 rmp->appns_index = clib_host_to_net_u32 (appns_index);
949 clib_memcpy_fast (rmp->tag, tag, vec_len (tag));
950 rmp->tag[vec_len (tag)] = 0;
953 vl_api_send_msg (reg, (u8 *) rmp);
957 send_session_rules_table_details (session_rules_table_t * srt, u8 fib_proto,
958 u8 tp, u8 is_local, u32 appns_index,
959 vl_api_registration_t * reg, u32 context)
961 mma_rule_16_t *rule16;
962 mma_rule_40_t *rule40;
963 mma_rules_table_16_t *srt16;
964 mma_rules_table_40_t *srt40;
967 if (is_local || fib_proto == FIB_PROTOCOL_IP4)
971 srt16 = &srt->session_rules_tables_16;
972 pool_foreach (rule16, srt16->rules, ({
973 ri = mma_rules_table_rule_index_16 (srt16, rule16);
974 tag = session_rules_table_rule_tag (srt, ri, 1);
975 send_session_rule_details4 (rule16, is_local, tp, appns_index, tag,
980 if (is_local || fib_proto == FIB_PROTOCOL_IP6)
984 srt40 = &srt->session_rules_tables_40;
985 pool_foreach (rule40, srt40->rules, ({
986 ri = mma_rules_table_rule_index_40 (srt40, rule40);
987 tag = session_rules_table_rule_tag (srt, ri, 1);
988 send_session_rule_details6 (rule40, is_local, tp, appns_index, tag,
996 vl_api_session_rules_dump_t_handler (vl_api_one_map_server_dump_t * mp)
998 vl_api_registration_t *reg;
1002 reg = vl_api_client_index_to_registration (mp->client_index);
1007 session_table_foreach (st, ({
1008 for (tp = 0; tp < TRANSPORT_N_PROTOS; tp++)
1010 send_session_rules_table_details (&st->session_rules[tp],
1011 st->active_fib_proto, tp,
1012 st->is_local, st->appns_index, reg,
1020 vl_api_app_add_cert_key_pair_t_handler (vl_api_app_add_cert_key_pair_t * mp)
1022 vl_api_app_add_cert_key_pair_reply_t *rmp;
1023 vnet_app_add_cert_key_pair_args_t _a, *a = &_a;
1024 u32 certkey_len, key_len, cert_len;
1026 if (session_main_is_enabled () == 0)
1028 rv = VNET_API_ERROR_FEATURE_DISABLED;
1032 cert_len = clib_net_to_host_u16 (mp->cert_len);
1033 if (cert_len > 10000)
1035 rv = VNET_API_ERROR_INVALID_VALUE;
1039 certkey_len = clib_net_to_host_u16 (mp->certkey_len);
1040 if (certkey_len < cert_len)
1042 rv = VNET_API_ERROR_INVALID_VALUE;
1046 key_len = certkey_len - cert_len;
1047 if (key_len > 10000)
1049 rv = VNET_API_ERROR_INVALID_VALUE;
1053 clib_memset (a, 0, sizeof (*a));
1054 vec_validate (a->cert, cert_len);
1055 vec_validate (a->key, key_len);
1056 clib_memcpy_fast (a->cert, mp->certkey, cert_len);
1057 clib_memcpy_fast (a->key, mp->certkey + cert_len, key_len);
1058 rv = vnet_app_add_cert_key_pair (a);
1064 REPLY_MACRO2 (VL_API_APP_ADD_CERT_KEY_PAIR_REPLY, ({
1066 rmp->index = clib_host_to_net_u32 (a->index);
1072 vl_api_app_del_cert_key_pair_t_handler (vl_api_app_del_cert_key_pair_t * mp)
1074 vl_api_app_del_cert_key_pair_reply_t *rmp;
1077 if (session_main_is_enabled () == 0)
1079 rv = VNET_API_ERROR_FEATURE_DISABLED;
1082 ckpair_index = clib_net_to_host_u32 (mp->index);
1083 rv = vnet_app_del_cert_key_pair (ckpair_index);
1086 REPLY_MACRO (VL_API_APP_DEL_CERT_KEY_PAIR_REPLY);
1089 /* ### WILL BE DEPRECATED POST 20.01 ### */
1091 vl_api_application_tls_cert_add_t_handler (vl_api_application_tls_cert_add_t *
1094 vl_api_application_tls_cert_add_reply_t *rmp;
1095 app_cert_key_pair_t *ckpair;
1099 if (session_main_is_enabled () == 0)
1101 rv = VNET_API_ERROR_FEATURE_DISABLED;
1104 if (!(app = application_lookup (mp->client_index)))
1106 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
1109 cert_len = clib_net_to_host_u16 (mp->cert_len);
1110 if (cert_len > 10000)
1112 rv = VNET_API_ERROR_INVALID_VALUE;
1115 ckpair = app_cert_key_pair_get_default ();
1116 vec_validate (ckpair->cert, cert_len);
1117 clib_memcpy_fast (ckpair->cert, mp->cert, cert_len);
1120 REPLY_MACRO (VL_API_APPLICATION_TLS_CERT_ADD_REPLY);
1123 /* ### WILL BE DEPRECATED POST 20.01 ### */
1125 vl_api_application_tls_key_add_t_handler (vl_api_application_tls_key_add_t *
1128 vl_api_application_tls_key_add_reply_t *rmp;
1129 app_cert_key_pair_t *ckpair;
1133 if (session_main_is_enabled () == 0)
1135 rv = VNET_API_ERROR_FEATURE_DISABLED;
1138 if (!(app = application_lookup (mp->client_index)))
1140 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
1143 key_len = clib_net_to_host_u16 (mp->key_len);
1144 if (key_len > 10000)
1146 rv = VNET_API_ERROR_INVALID_VALUE;
1149 ckpair = app_cert_key_pair_get_default ();
1150 vec_validate (ckpair->key, key_len);
1151 clib_memcpy_fast (ckpair->key, mp->key, key_len);
1153 REPLY_MACRO (VL_API_APPLICATION_TLS_KEY_ADD_REPLY);
1156 static clib_error_t *
1157 application_reaper_cb (u32 client_index)
1159 application_t *app = application_lookup (client_index);
1160 vnet_app_detach_args_t _a, *a = &_a;
1163 a->app_index = app->app_index;
1164 a->api_client_index = client_index;
1165 vnet_application_detach (a);
1170 VL_MSG_API_REAPER_FUNCTION (application_reaper_cb);
1172 #define vl_msg_name_crc_list
1173 #include <vnet/vnet_all_api_h.h>
1174 #undef vl_msg_name_crc_list
1177 setup_message_id_table (api_main_t * am)
1179 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
1180 foreach_vl_msg_name_crc_session;
1185 * session_api_hookup
1186 * Add uri's API message handlers to the table.
1187 * vlib has already mapped shared memory and
1188 * added the client registration handlers.
1189 * See .../open-repo/vlib/memclnt_vlib.c:memclnt_process()
1191 static clib_error_t *
1192 session_api_hookup (vlib_main_t * vm)
1194 api_main_t *am = vlibapi_get_main ();
1197 vl_msg_api_set_handlers(VL_API_##N, #n, \
1198 vl_api_##n##_t_handler, \
1200 vl_api_##n##_t_endian, \
1201 vl_api_##n##_t_print, \
1202 sizeof(vl_api_##n##_t), 1);
1203 foreach_session_api_msg;
1207 * Set up the (msg_name, crc, message-id) table
1209 setup_message_id_table (am);
1214 VLIB_API_INIT_FUNCTION (session_api_hookup);
1217 * fd.io coding-style-patch-verification: ON
1220 * eval: (c-set-style "gnu")