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_QUIC:
70 return TRANSPORT_PROTO_QUIC;
72 return TRANSPORT_PROTO_NONE;
76 static vl_api_transport_proto_t
77 api_session_transport_proto_encode (const transport_proto_t tp)
81 case TRANSPORT_PROTO_TCP:
82 return TRANSPORT_PROTO_API_TCP;
83 case TRANSPORT_PROTO_UDP:
84 return TRANSPORT_PROTO_API_UDP;
85 case TRANSPORT_PROTO_TLS:
86 return TRANSPORT_PROTO_API_TLS;
87 case TRANSPORT_PROTO_QUIC:
88 return TRANSPORT_PROTO_API_QUIC;
90 return TRANSPORT_PROTO_API_NONE;
95 session_send_fds (vl_api_registration_t * reg, int fds[], int n_fds)
98 if (vl_api_registration_file_index (reg) == VL_API_INVALID_FI)
99 return SESSION_E_BAPI_NO_FD;
100 error = vl_api_send_fd_msg (reg, fds, n_fds);
103 clib_error_report (error);
104 return SESSION_E_BAPI_SEND_FD;
110 mq_try_lock_and_alloc_msg (svm_msg_q_t * app_mq, svm_msg_q_msg_t * msg)
116 rv = svm_msg_q_lock_and_alloc_msg_w_ring (app_mq,
117 SESSION_MQ_CTRL_EVT_RING,
124 clib_warning ("failed to alloc msg");
129 mq_send_session_accepted_cb (session_t * s)
131 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
132 svm_msg_q_msg_t _msg, *msg = &_msg;
133 svm_msg_q_t *vpp_queue, *app_mq;
135 session_accepted_msg_t *mp;
136 session_event_t *evt;
139 app = application_get (app_wrk->app_index);
140 app_mq = app_wrk->event_queue;
141 if (mq_try_lock_and_alloc_msg (app_mq, msg))
142 return SESSION_E_MQ_MSG_ALLOC;
144 evt = svm_msg_q_msg_data (app_mq, msg);
145 clib_memset (evt, 0, sizeof (*evt));
146 evt->event_type = SESSION_CTRL_EVT_ACCEPTED;
147 mp = (session_accepted_msg_t *) evt->data;
148 clib_memset (mp, 0, sizeof (*mp));
149 mp->context = app->app_index;
150 mp->server_rx_fifo = pointer_to_uword (s->rx_fifo);
151 mp->server_tx_fifo = pointer_to_uword (s->tx_fifo);
152 mp->segment_handle = session_segment_handle (s);
153 mp->flags = s->flags;
155 if (session_has_transport (s))
157 listener = listen_session_get_from_handle (s->listener_handle);
158 mp->listener_handle = app_listen_session_handle (listener);
159 if (application_is_proxy (app))
162 app_worker_first_listener (app_wrk, session_get_fib_proto (s),
163 session_get_transport_proto (s));
165 mp->listener_handle = listen_session_get_handle (listener);
167 vpp_queue = session_main_get_vpp_event_queue (s->thread_index);
168 mp->vpp_event_queue_address = pointer_to_uword (vpp_queue);
169 mp->handle = session_handle (s);
171 session_get_endpoint (s, &mp->rmt, 0 /* is_lcl */ );
177 ct = (ct_connection_t *) session_get_transport (s);
178 listener = listen_session_get_from_handle (s->listener_handle);
179 mp->listener_handle = app_listen_session_handle (listener);
180 mp->rmt.is_ip4 = session_type_is_ip4 (listener->session_type);
181 mp->rmt.port = ct->c_rmt_port;
182 mp->handle = session_handle (s);
183 vpp_queue = session_main_get_vpp_event_queue (0);
184 mp->vpp_event_queue_address = pointer_to_uword (vpp_queue);
186 svm_msg_q_add_and_unlock (app_mq, msg);
192 mq_send_session_close_evt (app_worker_t * app_wrk, session_handle_t sh,
193 session_evt_type_t evt_type)
195 svm_msg_q_msg_t _msg, *msg = &_msg;
196 session_disconnected_msg_t *mp;
198 session_event_t *evt;
200 app_mq = app_wrk->event_queue;
201 if (mq_try_lock_and_alloc_msg (app_mq, msg))
203 evt = svm_msg_q_msg_data (app_mq, msg);
204 clib_memset (evt, 0, sizeof (*evt));
205 evt->event_type = evt_type;
206 mp = (session_disconnected_msg_t *) evt->data;
208 mp->context = app_wrk->api_client_index;
209 svm_msg_q_add_and_unlock (app_mq, msg);
213 mq_notify_close_subscribers (u32 app_index, session_handle_t sh,
214 svm_fifo_t * f, session_evt_type_t evt_type)
216 app_worker_t *app_wrk;
220 app = application_get (app_index);
224 for (i = 0; i < f->n_subscribers; i++)
226 if (!(app_wrk = application_get_worker (app, f->subscribers[i])))
228 mq_send_session_close_evt (app_wrk, sh, SESSION_CTRL_EVT_DISCONNECTED);
233 mq_send_session_disconnected_cb (session_t * s)
235 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
236 session_handle_t sh = session_handle (s);
238 mq_send_session_close_evt (app_wrk, session_handle (s),
239 SESSION_CTRL_EVT_DISCONNECTED);
241 if (svm_fifo_n_subscribers (s->rx_fifo))
242 mq_notify_close_subscribers (app_wrk->app_index, sh, s->rx_fifo,
243 SESSION_CTRL_EVT_DISCONNECTED);
247 mq_send_session_reset_cb (session_t * s)
249 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
250 session_handle_t sh = session_handle (s);
252 mq_send_session_close_evt (app_wrk, sh, SESSION_CTRL_EVT_RESET);
254 if (svm_fifo_n_subscribers (s->rx_fifo))
255 mq_notify_close_subscribers (app_wrk->app_index, sh, s->rx_fifo,
256 SESSION_CTRL_EVT_RESET);
260 mq_send_session_connected_cb (u32 app_wrk_index, u32 api_context,
261 session_t * s, session_error_t err)
263 svm_msg_q_msg_t _msg, *msg = &_msg;
264 session_connected_msg_t *mp;
265 svm_msg_q_t *vpp_mq, *app_mq;
266 transport_connection_t *tc;
267 app_worker_t *app_wrk;
268 session_event_t *evt;
270 app_wrk = app_worker_get (app_wrk_index);
271 app_mq = app_wrk->event_queue;
274 clib_warning ("app %u with api index: %u not attached",
275 app_wrk->app_index, app_wrk->api_client_index);
279 if (mq_try_lock_and_alloc_msg (app_mq, msg))
280 return SESSION_E_MQ_MSG_ALLOC;
282 evt = svm_msg_q_msg_data (app_mq, msg);
283 clib_memset (evt, 0, sizeof (*evt));
284 evt->event_type = SESSION_CTRL_EVT_CONNECTED;
285 mp = (session_connected_msg_t *) evt->data;
286 clib_memset (mp, 0, sizeof (*mp));
287 mp->context = api_context;
292 if (session_has_transport (s))
294 tc = session_get_transport (s);
297 clib_warning ("failed to retrieve transport!");
298 err = SESSION_E_REFUSED;
302 vpp_mq = session_main_get_vpp_event_queue (s->thread_index);
303 mp->handle = session_handle (s);
304 mp->vpp_event_queue_address = pointer_to_uword (vpp_mq);
306 session_get_endpoint (s, &mp->lcl, 1 /* is_lcl */ );
308 mp->server_rx_fifo = pointer_to_uword (s->rx_fifo);
309 mp->server_tx_fifo = pointer_to_uword (s->tx_fifo);
310 mp->segment_handle = session_segment_handle (s);
314 ct_connection_t *cct;
317 cct = (ct_connection_t *) session_get_transport (s);
318 mp->handle = session_handle (s);
319 mp->lcl.port = cct->c_lcl_port;
320 mp->lcl.is_ip4 = cct->c_is_ip4;
321 vpp_mq = session_main_get_vpp_event_queue (0);
322 mp->vpp_event_queue_address = pointer_to_uword (vpp_mq);
323 mp->server_rx_fifo = pointer_to_uword (s->rx_fifo);
324 mp->server_tx_fifo = pointer_to_uword (s->tx_fifo);
325 mp->segment_handle = session_segment_handle (s);
326 ss = ct_session_get_peer (s);
327 mp->ct_rx_fifo = pointer_to_uword (ss->tx_fifo);
328 mp->ct_tx_fifo = pointer_to_uword (ss->rx_fifo);
329 mp->ct_segment_handle = session_segment_handle (ss);
335 svm_msg_q_add_and_unlock (app_mq, msg);
340 mq_send_session_bound_cb (u32 app_wrk_index, u32 api_context,
341 session_handle_t handle, int rv)
343 svm_msg_q_msg_t _msg, *msg = &_msg;
344 svm_msg_q_t *app_mq, *vpp_evt_q;
345 transport_endpoint_t tep;
346 session_bound_msg_t *mp;
347 app_worker_t *app_wrk;
348 session_event_t *evt;
351 app_wrk = app_worker_get (app_wrk_index);
352 app_mq = app_wrk->event_queue;
355 clib_warning ("app %u with api index: %u not attached",
356 app_wrk->app_index, app_wrk->api_client_index);
360 if (mq_try_lock_and_alloc_msg (app_mq, msg))
361 return SESSION_E_MQ_MSG_ALLOC;
363 evt = svm_msg_q_msg_data (app_mq, msg);
364 clib_memset (evt, 0, sizeof (*evt));
365 evt->event_type = SESSION_CTRL_EVT_BOUND;
366 mp = (session_bound_msg_t *) evt->data;
367 mp->context = api_context;
373 al = app_listener_get_w_handle (handle);
374 if (al->session_index != SESSION_INVALID_INDEX)
375 ls = app_listener_get_session (al);
377 ls = app_listener_get_local_session (al);
379 session_get_endpoint (ls, &tep, 1 /* is_lcl */ );
380 mp->lcl_port = tep.port;
381 mp->lcl_is_ip4 = tep.is_ip4;
382 clib_memcpy_fast (mp->lcl_ip, &tep.ip, sizeof (tep.ip));
384 vpp_evt_q = session_main_get_vpp_event_queue (0);
385 mp->vpp_evt_q = pointer_to_uword (vpp_evt_q);
387 if (session_transport_service_type (ls) == TRANSPORT_SERVICE_CL)
389 mp->rx_fifo = pointer_to_uword (ls->rx_fifo);
390 mp->tx_fifo = pointer_to_uword (ls->tx_fifo);
395 svm_msg_q_add_and_unlock (app_mq, msg);
400 mq_send_unlisten_reply (app_worker_t * app_wrk, session_handle_t sh,
403 svm_msg_q_msg_t _msg, *msg = &_msg;
404 session_unlisten_reply_msg_t *ump;
406 session_event_t *evt;
408 app_mq = app_wrk->event_queue;
409 if (mq_try_lock_and_alloc_msg (app_mq, msg))
412 evt = svm_msg_q_msg_data (app_mq, msg);
413 clib_memset (evt, 0, sizeof (*evt));
414 evt->event_type = SESSION_CTRL_EVT_UNLISTEN_REPLY;
415 ump = (session_unlisten_reply_msg_t *) evt->data;
416 ump->context = context;
419 svm_msg_q_add_and_unlock (app_mq, msg);
423 mq_send_session_migrate_cb (session_t * s, session_handle_t new_sh)
425 svm_msg_q_msg_t _msg, *msg = &_msg;
426 session_migrated_msg_t *mp;
427 svm_msg_q_t *vpp_evt_q;
428 app_worker_t *app_wrk;
429 session_event_t *evt;
432 app_wrk = app_worker_get (s->app_wrk_index);
433 app_mq = app_wrk->event_queue;
434 if (mq_try_lock_and_alloc_msg (app_mq, msg))
437 evt = svm_msg_q_msg_data (app_mq, msg);
438 clib_memset (evt, 0, sizeof (*evt));
439 evt->event_type = SESSION_CTRL_EVT_MIGRATED;
440 mp = (session_migrated_msg_t *) evt->data;
441 mp->handle = session_handle (s);
442 mp->new_handle = new_sh;
443 mp->vpp_thread_index = session_thread_from_handle (new_sh);
444 vpp_evt_q = session_main_get_vpp_event_queue (mp->vpp_thread_index);
445 mp->vpp_evt_q = pointer_to_uword (vpp_evt_q);
446 svm_msg_q_add_and_unlock (app_mq, msg);
450 mq_send_add_segment_cb (u32 app_wrk_index, u64 segment_handle)
452 int fds[SESSION_N_FD_TYPE], n_fds = 0;
453 svm_msg_q_msg_t _msg, *msg = &_msg;
454 session_app_add_segment_msg_t *mp;
455 vl_api_registration_t *reg;
456 app_worker_t *app_wrk;
457 session_event_t *evt;
463 app_wrk = app_worker_get (app_wrk_index);
465 reg = vl_mem_api_client_index_to_registration (app_wrk->api_client_index);
468 clib_warning ("no api registration for client: %u",
469 app_wrk->api_client_index);
473 fs = segment_manager_get_segment_w_handle (segment_handle);
475 if (ssvm_type (sp) == SSVM_SEGMENT_MEMFD)
477 if (vl_api_registration_file_index (reg) == VL_API_INVALID_FI)
479 clib_warning ("can't send memfd fd");
483 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
488 app_mq = app_wrk->event_queue;
489 if (mq_try_lock_and_alloc_msg (app_mq, msg))
493 session_send_fds (reg, fds, n_fds);
495 evt = svm_msg_q_msg_data (app_mq, msg);
496 clib_memset (evt, 0, sizeof (*evt));
497 evt->event_type = SESSION_CTRL_EVT_APP_ADD_SEGMENT;
498 mp = (session_app_add_segment_msg_t *) evt->data;
499 clib_memset (mp, 0, sizeof (*mp));
500 mp->segment_size = sp->ssvm_size;
501 mp->fd_flags = fd_flags;
502 mp->segment_handle = segment_handle;
503 strncpy ((char *) mp->segment_name, (char *) sp->name,
504 sizeof (mp->segment_name) - 1);
506 svm_msg_q_add_and_unlock (app_mq, msg);
512 mq_send_del_segment_cb (u32 app_wrk_index, u64 segment_handle)
514 svm_msg_q_msg_t _msg, *msg = &_msg;
515 session_app_del_segment_msg_t *mp;
516 vl_api_registration_t *reg;
517 app_worker_t *app_wrk;
518 session_event_t *evt;
521 app_wrk = app_worker_get (app_wrk_index);
522 reg = vl_mem_api_client_index_to_registration (app_wrk->api_client_index);
525 clib_warning ("no registration: %u", app_wrk->api_client_index);
529 app_mq = app_wrk->event_queue;
530 if (mq_try_lock_and_alloc_msg (app_mq, msg))
533 evt = svm_msg_q_msg_data (app_mq, msg);
534 clib_memset (evt, 0, sizeof (*evt));
535 evt->event_type = SESSION_CTRL_EVT_APP_DEL_SEGMENT;
536 mp = (session_app_del_segment_msg_t *) evt->data;
537 clib_memset (mp, 0, sizeof (*mp));
538 mp->segment_handle = segment_handle;
539 svm_msg_q_add_and_unlock (app_mq, msg);
545 mq_send_session_cleanup_cb (session_t * s, session_cleanup_ntf_t ntf)
547 svm_msg_q_msg_t _msg, *msg = &_msg;
548 session_cleanup_msg_t *mp;
550 session_event_t *evt;
551 app_worker_t *app_wrk;
553 /* Only propagate session cleanup notification */
554 if (ntf == SESSION_CLEANUP_TRANSPORT)
557 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
561 app_mq = app_wrk->event_queue;
562 if (mq_try_lock_and_alloc_msg (app_mq, msg))
565 evt = svm_msg_q_msg_data (app_mq, msg);
566 clib_memset (evt, 0, sizeof (*evt));
567 evt->event_type = SESSION_CTRL_EVT_CLEANUP;
568 mp = (session_cleanup_msg_t *) evt->data;
569 mp->handle = session_handle (s);
570 svm_msg_q_add_and_unlock (app_mq, msg);
573 static session_cb_vft_t session_mq_cb_vft = {
574 .session_accept_callback = mq_send_session_accepted_cb,
575 .session_disconnect_callback = mq_send_session_disconnected_cb,
576 .session_connected_callback = mq_send_session_connected_cb,
577 .session_reset_callback = mq_send_session_reset_cb,
578 .session_migrate_callback = mq_send_session_migrate_cb,
579 .session_cleanup_callback = mq_send_session_cleanup_cb,
580 .add_segment_callback = mq_send_add_segment_cb,
581 .del_segment_callback = mq_send_del_segment_cb,
585 vl_api_session_enable_disable_t_handler (vl_api_session_enable_disable_t * mp)
587 vl_api_session_enable_disable_reply_t *rmp;
588 vlib_main_t *vm = vlib_get_main ();
591 vnet_session_enable_disable (vm, mp->is_enable);
592 REPLY_MACRO (VL_API_SESSION_ENABLE_DISABLE_REPLY);
596 vl_api_app_attach_t_handler (vl_api_app_attach_t * mp)
598 int rv = 0, fds[SESSION_N_FD_TYPE], n_fds = 0;
599 vl_api_app_attach_reply_t *rmp;
600 ssvm_private_t *segp, *evt_q_segment;
601 vnet_app_attach_args_t _a, *a = &_a;
602 u8 fd_flags = 0, ctrl_thread;
603 vl_api_registration_t *reg;
604 svm_msg_q_t *ctrl_mq;
606 reg = vl_api_client_index_to_registration (mp->client_index);
610 if (session_main_is_enabled () == 0)
612 rv = VNET_API_ERROR_FEATURE_DISABLED;
616 STATIC_ASSERT (sizeof (u64) * APP_OPTIONS_N_OPTIONS <=
617 sizeof (mp->options),
618 "Out of options, fix api message definition");
620 clib_memset (a, 0, sizeof (*a));
621 a->api_client_index = mp->client_index;
622 a->options = mp->options;
623 a->session_cb_vft = &session_mq_cb_vft;
625 a->namespace_id = vl_api_from_api_to_new_vec (&mp->namespace_id);
627 if ((rv = vnet_application_attach (a)))
629 clib_warning ("attach returned: %d", rv);
630 vec_free (a->namespace_id);
633 vec_free (a->namespace_id);
635 /* Send event queues segment */
636 if ((evt_q_segment = session_main_get_evt_q_segment ()))
638 fd_flags |= SESSION_FD_F_VPP_MQ_SEGMENT;
639 fds[n_fds] = evt_q_segment->fd;
642 /* Send fifo segment fd if needed */
643 if (ssvm_type (a->segment) == SSVM_SEGMENT_MEMFD)
645 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
646 fds[n_fds] = a->segment->fd;
649 if (a->options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
651 fd_flags |= SESSION_FD_F_MQ_EVENTFD;
652 fds[n_fds] = svm_msg_q_get_producer_eventfd (a->app_evt_q);
658 REPLY_MACRO2 (VL_API_APP_ATTACH_REPLY, ({
661 ctrl_thread = vlib_num_workers () ? 1 : 0;
662 ctrl_mq = session_main_get_vpp_event_queue (ctrl_thread);
664 rmp->app_index = clib_host_to_net_u32 (a->app_index);
665 rmp->app_mq = pointer_to_uword (a->app_evt_q);
666 rmp->vpp_ctrl_mq = pointer_to_uword (ctrl_mq);
667 rmp->vpp_ctrl_mq_thread = ctrl_thread;
669 rmp->fd_flags = fd_flags;
670 if (vec_len (segp->name))
672 vl_api_vec_to_api_string (segp->name, &rmp->segment_name);
674 rmp->segment_size = segp->ssvm_size;
675 rmp->segment_handle = clib_host_to_net_u64 (a->segment_handle);
681 session_send_fds (reg, fds, n_fds);
685 vl_api_app_worker_add_del_t_handler (vl_api_app_worker_add_del_t * mp)
687 int rv = 0, fds[SESSION_N_FD_TYPE], n_fds = 0;
688 vl_api_app_worker_add_del_reply_t *rmp;
689 vl_api_registration_t *reg;
693 if (session_main_is_enabled () == 0)
695 rv = VNET_API_ERROR_FEATURE_DISABLED;
699 reg = vl_api_client_index_to_registration (mp->client_index);
703 app = application_get_if_valid (clib_net_to_host_u32 (mp->app_index));
706 rv = VNET_API_ERROR_INVALID_VALUE;
710 vnet_app_worker_add_del_args_t args = {
711 .app_index = app->app_index,
712 .wrk_map_index = clib_net_to_host_u32 (mp->wrk_index),
713 .api_client_index = mp->client_index,
716 rv = vnet_app_worker_add_del (&args);
719 clib_warning ("app worker add/del returned: %d", rv);
726 /* Send fifo segment fd if needed */
727 if (ssvm_type (args.segment) == SSVM_SEGMENT_MEMFD)
729 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
730 fds[n_fds] = args.segment->fd;
733 if (application_segment_manager_properties (app)->use_mq_eventfd)
735 fd_flags |= SESSION_FD_F_MQ_EVENTFD;
736 fds[n_fds] = svm_msg_q_get_producer_eventfd (args.evt_q);
742 REPLY_MACRO2 (VL_API_APP_WORKER_ADD_DEL_REPLY, ({
743 rmp->is_add = mp->is_add;
744 rmp->wrk_index = clib_host_to_net_u32 (args.wrk_map_index);
745 rmp->segment_handle = clib_host_to_net_u64 (args.segment_handle);
746 if (!rv && mp->is_add)
748 if (vec_len (args.segment->name))
750 vl_api_vec_to_api_string (args.segment->name, &rmp->segment_name);
752 rmp->app_event_queue_address = pointer_to_uword (args.evt_q);
754 rmp->fd_flags = fd_flags;
760 session_send_fds (reg, fds, n_fds);
764 vl_api_application_detach_t_handler (vl_api_application_detach_t * mp)
766 vl_api_application_detach_reply_t *rmp;
767 int rv = VNET_API_ERROR_INVALID_VALUE_2;
768 vnet_app_detach_args_t _a, *a = &_a;
771 if (session_main_is_enabled () == 0)
773 rv = VNET_API_ERROR_FEATURE_DISABLED;
777 app = application_lookup (mp->client_index);
780 a->app_index = app->app_index;
781 a->api_client_index = mp->client_index;
782 rv = vnet_application_detach (a);
786 REPLY_MACRO (VL_API_APPLICATION_DETACH_REPLY);
790 vl_api_app_namespace_add_del_t_handler (vl_api_app_namespace_add_del_t * mp)
792 vl_api_app_namespace_add_del_reply_t *rmp;
796 if (session_main_is_enabled () == 0)
798 rv = VNET_API_ERROR_FEATURE_DISABLED;
802 ns_id = vl_api_from_api_to_new_vec (&mp->namespace_id);
804 vnet_app_namespace_add_del_args_t args = {
806 .secret = clib_net_to_host_u64 (mp->secret),
807 .sw_if_index = clib_net_to_host_u32 (mp->sw_if_index),
808 .ip4_fib_id = clib_net_to_host_u32 (mp->ip4_fib_id),
809 .ip6_fib_id = clib_net_to_host_u32 (mp->ip6_fib_id),
812 rv = vnet_app_namespace_add_del (&args);
815 appns_index = app_namespace_index_from_id (ns_id);
816 if (appns_index == APP_NAMESPACE_INVALID_INDEX)
818 clib_warning ("app ns lookup failed");
819 rv = VNET_API_ERROR_UNSPECIFIED;
826 REPLY_MACRO2 (VL_API_APP_NAMESPACE_ADD_DEL_REPLY, ({
828 rmp->appns_index = clib_host_to_net_u32 (appns_index);
834 vl_api_session_rule_add_del_t_handler (vl_api_session_rule_add_del_t * mp)
836 vl_api_session_rule_add_del_reply_t *rmp;
837 session_rule_add_del_args_t args;
838 session_rule_table_add_del_args_t *table_args = &args.table_args;
841 clib_memset (&args, 0, sizeof (args));
843 ip_prefix_decode (&mp->lcl, &table_args->lcl);
844 ip_prefix_decode (&mp->rmt, &table_args->rmt);
846 table_args->lcl_port = mp->lcl_port;
847 table_args->rmt_port = mp->rmt_port;
848 table_args->action_index = clib_net_to_host_u32 (mp->action_index);
849 table_args->is_add = mp->is_add;
850 mp->tag[sizeof (mp->tag) - 1] = 0;
851 table_args->tag = format (0, "%s", mp->tag);
852 args.appns_index = clib_net_to_host_u32 (mp->appns_index);
853 args.scope = mp->scope;
854 args.transport_proto =
855 api_session_transport_proto_decode (&mp->transport_proto) ==
856 TRANSPORT_PROTO_UDP ? 1 : 0;
858 rv = vnet_session_rule_add_del (&args);
860 clib_warning ("rule add del returned: %d", rv);
861 vec_free (table_args->tag);
862 REPLY_MACRO (VL_API_SESSION_RULE_ADD_DEL_REPLY);
866 send_session_rule_details4 (mma_rule_16_t * rule, u8 is_local,
867 u8 transport_proto, u32 appns_index, u8 * tag,
868 vl_api_registration_t * reg, u32 context)
870 vl_api_session_rules_details_t *rmp = 0;
871 session_mask_or_match_4_t *match =
872 (session_mask_or_match_4_t *) & rule->match;
873 session_mask_or_match_4_t *mask =
874 (session_mask_or_match_4_t *) & rule->mask;
875 fib_prefix_t lcl, rmt;
877 rmp = vl_msg_api_alloc (sizeof (*rmp));
878 clib_memset (rmp, 0, sizeof (*rmp));
879 rmp->_vl_msg_id = ntohs (VL_API_SESSION_RULES_DETAILS);
880 rmp->context = context;
882 clib_memset (&lcl, 0, sizeof (lcl));
883 clib_memset (&rmt, 0, sizeof (rmt));
884 ip_set (&lcl.fp_addr, &match->lcl_ip, 1);
885 ip_set (&rmt.fp_addr, &match->rmt_ip, 1);
886 lcl.fp_len = ip4_mask_to_preflen (&mask->lcl_ip);
887 rmt.fp_len = ip4_mask_to_preflen (&mask->rmt_ip);
889 ip_prefix_encode (&lcl, &rmp->lcl);
890 ip_prefix_encode (&rmt, &rmp->rmt);
891 rmp->lcl_port = match->lcl_port;
892 rmp->rmt_port = match->rmt_port;
893 rmp->action_index = clib_host_to_net_u32 (rule->action_index);
895 is_local ? SESSION_RULE_SCOPE_API_LOCAL : SESSION_RULE_SCOPE_API_GLOBAL;
896 rmp->transport_proto = api_session_transport_proto_encode (transport_proto);
897 rmp->appns_index = clib_host_to_net_u32 (appns_index);
900 clib_memcpy_fast (rmp->tag, tag, vec_len (tag));
901 rmp->tag[vec_len (tag)] = 0;
904 vl_api_send_msg (reg, (u8 *) rmp);
908 send_session_rule_details6 (mma_rule_40_t * rule, u8 is_local,
909 u8 transport_proto, u32 appns_index, u8 * tag,
910 vl_api_registration_t * reg, u32 context)
912 vl_api_session_rules_details_t *rmp = 0;
913 session_mask_or_match_6_t *match =
914 (session_mask_or_match_6_t *) & rule->match;
915 session_mask_or_match_6_t *mask =
916 (session_mask_or_match_6_t *) & rule->mask;
917 fib_prefix_t lcl, rmt;
919 rmp = vl_msg_api_alloc (sizeof (*rmp));
920 clib_memset (rmp, 0, sizeof (*rmp));
921 rmp->_vl_msg_id = ntohs (VL_API_SESSION_RULES_DETAILS);
922 rmp->context = context;
924 clib_memset (&lcl, 0, sizeof (lcl));
925 clib_memset (&rmt, 0, sizeof (rmt));
926 ip_set (&lcl.fp_addr, &match->lcl_ip, 0);
927 ip_set (&rmt.fp_addr, &match->rmt_ip, 0);
928 lcl.fp_len = ip6_mask_to_preflen (&mask->lcl_ip);
929 rmt.fp_len = ip6_mask_to_preflen (&mask->rmt_ip);
931 ip_prefix_encode (&lcl, &rmp->lcl);
932 ip_prefix_encode (&rmt, &rmp->rmt);
933 rmp->lcl_port = match->lcl_port;
934 rmp->rmt_port = match->rmt_port;
935 rmp->action_index = clib_host_to_net_u32 (rule->action_index);
937 is_local ? SESSION_RULE_SCOPE_API_LOCAL : SESSION_RULE_SCOPE_API_GLOBAL;
938 rmp->transport_proto = api_session_transport_proto_encode (transport_proto);
939 rmp->appns_index = clib_host_to_net_u32 (appns_index);
942 clib_memcpy_fast (rmp->tag, tag, vec_len (tag));
943 rmp->tag[vec_len (tag)] = 0;
946 vl_api_send_msg (reg, (u8 *) rmp);
950 send_session_rules_table_details (session_rules_table_t * srt, u8 fib_proto,
951 u8 tp, u8 is_local, u32 appns_index,
952 vl_api_registration_t * reg, u32 context)
954 mma_rule_16_t *rule16;
955 mma_rule_40_t *rule40;
956 mma_rules_table_16_t *srt16;
957 mma_rules_table_40_t *srt40;
960 if (is_local || fib_proto == FIB_PROTOCOL_IP4)
964 srt16 = &srt->session_rules_tables_16;
965 pool_foreach (rule16, srt16->rules, ({
966 ri = mma_rules_table_rule_index_16 (srt16, rule16);
967 tag = session_rules_table_rule_tag (srt, ri, 1);
968 send_session_rule_details4 (rule16, is_local, tp, appns_index, tag,
973 if (is_local || fib_proto == FIB_PROTOCOL_IP6)
977 srt40 = &srt->session_rules_tables_40;
978 pool_foreach (rule40, srt40->rules, ({
979 ri = mma_rules_table_rule_index_40 (srt40, rule40);
980 tag = session_rules_table_rule_tag (srt, ri, 1);
981 send_session_rule_details6 (rule40, is_local, tp, appns_index, tag,
989 vl_api_session_rules_dump_t_handler (vl_api_one_map_server_dump_t * mp)
991 vl_api_registration_t *reg;
995 reg = vl_api_client_index_to_registration (mp->client_index);
1000 session_table_foreach (st, ({
1001 for (tp = 0; tp < TRANSPORT_N_PROTOS; tp++)
1003 send_session_rules_table_details (&st->session_rules[tp],
1004 st->active_fib_proto, tp,
1005 st->is_local, st->appns_index, reg,
1013 vl_api_app_add_cert_key_pair_t_handler (vl_api_app_add_cert_key_pair_t * mp)
1015 vl_api_app_add_cert_key_pair_reply_t *rmp;
1016 vnet_app_add_cert_key_pair_args_t _a, *a = &_a;
1017 u32 certkey_len, key_len, cert_len;
1019 if (session_main_is_enabled () == 0)
1021 rv = VNET_API_ERROR_FEATURE_DISABLED;
1025 cert_len = clib_net_to_host_u16 (mp->cert_len);
1026 if (cert_len > 10000)
1028 rv = VNET_API_ERROR_INVALID_VALUE;
1032 certkey_len = clib_net_to_host_u16 (mp->certkey_len);
1033 if (certkey_len < cert_len)
1035 rv = VNET_API_ERROR_INVALID_VALUE;
1039 key_len = certkey_len - cert_len;
1040 if (key_len > 10000)
1042 rv = VNET_API_ERROR_INVALID_VALUE;
1046 clib_memset (a, 0, sizeof (*a));
1047 vec_validate (a->cert, cert_len);
1048 vec_validate (a->key, key_len);
1049 clib_memcpy_fast (a->cert, mp->certkey, cert_len);
1050 clib_memcpy_fast (a->key, mp->certkey + cert_len, key_len);
1051 rv = vnet_app_add_cert_key_pair (a);
1057 REPLY_MACRO2 (VL_API_APP_ADD_CERT_KEY_PAIR_REPLY, ({
1059 rmp->index = clib_host_to_net_u32 (a->index);
1065 vl_api_app_del_cert_key_pair_t_handler (vl_api_app_del_cert_key_pair_t * mp)
1067 vl_api_app_del_cert_key_pair_reply_t *rmp;
1070 if (session_main_is_enabled () == 0)
1072 rv = VNET_API_ERROR_FEATURE_DISABLED;
1075 ckpair_index = clib_net_to_host_u32 (mp->index);
1076 rv = vnet_app_del_cert_key_pair (ckpair_index);
1079 REPLY_MACRO (VL_API_APP_DEL_CERT_KEY_PAIR_REPLY);
1082 /* ### WILL BE DEPRECATED POST 20.01 ### */
1084 vl_api_application_tls_cert_add_t_handler (vl_api_application_tls_cert_add_t *
1087 vl_api_application_tls_cert_add_reply_t *rmp;
1088 app_cert_key_pair_t *ckpair;
1092 if (session_main_is_enabled () == 0)
1094 rv = VNET_API_ERROR_FEATURE_DISABLED;
1097 if (!(app = application_lookup (mp->client_index)))
1099 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
1102 cert_len = clib_net_to_host_u16 (mp->cert_len);
1103 if (cert_len > 10000)
1105 rv = VNET_API_ERROR_INVALID_VALUE;
1108 ckpair = app_cert_key_pair_get_default ();
1109 vec_validate (ckpair->cert, cert_len);
1110 clib_memcpy_fast (ckpair->cert, mp->cert, cert_len);
1113 REPLY_MACRO (VL_API_APPLICATION_TLS_CERT_ADD_REPLY);
1116 /* ### WILL BE DEPRECATED POST 20.01 ### */
1118 vl_api_application_tls_key_add_t_handler (vl_api_application_tls_key_add_t *
1121 vl_api_application_tls_key_add_reply_t *rmp;
1122 app_cert_key_pair_t *ckpair;
1126 if (session_main_is_enabled () == 0)
1128 rv = VNET_API_ERROR_FEATURE_DISABLED;
1131 if (!(app = application_lookup (mp->client_index)))
1133 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
1136 key_len = clib_net_to_host_u16 (mp->key_len);
1137 if (key_len > 10000)
1139 rv = VNET_API_ERROR_INVALID_VALUE;
1142 ckpair = app_cert_key_pair_get_default ();
1143 vec_validate (ckpair->key, key_len);
1144 clib_memcpy_fast (ckpair->key, mp->key, key_len);
1146 REPLY_MACRO (VL_API_APPLICATION_TLS_KEY_ADD_REPLY);
1149 static clib_error_t *
1150 application_reaper_cb (u32 client_index)
1152 application_t *app = application_lookup (client_index);
1153 vnet_app_detach_args_t _a, *a = &_a;
1156 a->app_index = app->app_index;
1157 a->api_client_index = client_index;
1158 vnet_application_detach (a);
1163 VL_MSG_API_REAPER_FUNCTION (application_reaper_cb);
1165 #define vl_msg_name_crc_list
1166 #include <vnet/vnet_all_api_h.h>
1167 #undef vl_msg_name_crc_list
1170 setup_message_id_table (api_main_t * am)
1172 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
1173 foreach_vl_msg_name_crc_session;
1178 * session_api_hookup
1179 * Add uri's API message handlers to the table.
1180 * vlib has already mapped shared memory and
1181 * added the client registration handlers.
1182 * See .../open-repo/vlib/memclnt_vlib.c:memclnt_process()
1184 static clib_error_t *
1185 session_api_hookup (vlib_main_t * vm)
1187 api_main_t *am = vlibapi_get_main ();
1190 vl_msg_api_set_handlers(VL_API_##N, #n, \
1191 vl_api_##n##_t_handler, \
1193 vl_api_##n##_t_endian, \
1194 vl_api_##n##_t_print, \
1195 sizeof(vl_api_##n##_t), 1);
1196 foreach_session_api_msg;
1200 * Set up the (msg_name, crc, message-id) table
1202 setup_message_id_table (am);
1207 VLIB_API_INIT_FUNCTION (session_api_hookup);
1210 * fd.io coding-style-patch-verification: ON
1213 * eval: (c-set-style "gnu")