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)
103 return SESSION_E_BAPI_NO_FD;
104 error = vl_api_send_fd_msg (reg, fds, n_fds);
107 clib_error_report (error);
108 return SESSION_E_BAPI_SEND_FD;
114 mq_try_lock_and_alloc_msg (svm_msg_q_t * app_mq, svm_msg_q_msg_t * msg)
120 rv = svm_msg_q_lock_and_alloc_msg_w_ring (app_mq,
121 SESSION_MQ_CTRL_EVT_RING,
128 clib_warning ("failed to alloc msg");
133 mq_send_session_accepted_cb (session_t * s)
135 app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
136 svm_msg_q_msg_t _msg, *msg = &_msg;
137 svm_msg_q_t *vpp_queue, *app_mq;
139 session_accepted_msg_t *mp;
140 session_event_t *evt;
143 app = application_get (app_wrk->app_index);
144 app_mq = app_wrk->event_queue;
145 if (mq_try_lock_and_alloc_msg (app_mq, msg))
146 return SESSION_E_MQ_MSG_ALLOC;
148 evt = svm_msg_q_msg_data (app_mq, msg);
149 clib_memset (evt, 0, sizeof (*evt));
150 evt->event_type = SESSION_CTRL_EVT_ACCEPTED;
151 mp = (session_accepted_msg_t *) evt->data;
152 clib_memset (mp, 0, sizeof (*mp));
153 mp->context = app->app_index;
154 mp->server_rx_fifo = pointer_to_uword (s->rx_fifo);
155 mp->server_tx_fifo = pointer_to_uword (s->tx_fifo);
156 mp->segment_handle = session_segment_handle (s);
157 mp->flags = s->flags;
159 if (session_has_transport (s))
161 listener = listen_session_get_from_handle (s->listener_handle);
162 mp->listener_handle = app_listen_session_handle (listener);
163 if (application_is_proxy (app))
166 app_worker_first_listener (app_wrk, session_get_fib_proto (s),
167 session_get_transport_proto (s));
169 mp->listener_handle = listen_session_get_handle (listener);
171 vpp_queue = session_main_get_vpp_event_queue (s->thread_index);
172 mp->vpp_event_queue_address = pointer_to_uword (vpp_queue);
173 mp->handle = session_handle (s);
175 session_get_endpoint (s, &mp->rmt, 0 /* is_lcl */ );
181 ct = (ct_connection_t *) session_get_transport (s);
182 listener = listen_session_get_from_handle (s->listener_handle);
183 mp->listener_handle = app_listen_session_handle (listener);
184 mp->rmt.is_ip4 = session_type_is_ip4 (listener->session_type);
185 mp->rmt.port = ct->c_rmt_port;
186 mp->handle = session_handle (s);
187 vpp_queue = session_main_get_vpp_event_queue (0);
188 mp->vpp_event_queue_address = pointer_to_uword (vpp_queue);
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->n_subscribers; i++)
230 if (!(app_wrk = application_get_worker (app, f->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 *mp;
269 svm_msg_q_t *vpp_mq, *app_mq;
270 transport_connection_t *tc;
271 app_worker_t *app_wrk;
272 session_event_t *evt;
274 app_wrk = app_worker_get (app_wrk_index);
275 app_mq = app_wrk->event_queue;
278 clib_warning ("app %u with api index: %u not attached",
279 app_wrk->app_index, app_wrk->api_client_index);
283 if (mq_try_lock_and_alloc_msg (app_mq, msg))
284 return SESSION_E_MQ_MSG_ALLOC;
286 evt = svm_msg_q_msg_data (app_mq, msg);
287 clib_memset (evt, 0, sizeof (*evt));
288 evt->event_type = SESSION_CTRL_EVT_CONNECTED;
289 mp = (session_connected_msg_t *) evt->data;
290 clib_memset (mp, 0, sizeof (*mp));
291 mp->context = api_context;
296 if (session_has_transport (s))
298 tc = session_get_transport (s);
301 clib_warning ("failed to retrieve transport!");
302 err = SESSION_E_REFUSED;
306 vpp_mq = session_main_get_vpp_event_queue (s->thread_index);
307 mp->handle = session_handle (s);
308 mp->vpp_event_queue_address = pointer_to_uword (vpp_mq);
310 session_get_endpoint (s, &mp->lcl, 1 /* is_lcl */ );
312 mp->server_rx_fifo = pointer_to_uword (s->rx_fifo);
313 mp->server_tx_fifo = pointer_to_uword (s->tx_fifo);
314 mp->segment_handle = session_segment_handle (s);
318 ct_connection_t *cct;
321 cct = (ct_connection_t *) session_get_transport (s);
322 mp->handle = session_handle (s);
323 mp->lcl.port = cct->c_lcl_port;
324 mp->lcl.is_ip4 = cct->c_is_ip4;
325 vpp_mq = session_main_get_vpp_event_queue (0);
326 mp->vpp_event_queue_address = pointer_to_uword (vpp_mq);
327 mp->server_rx_fifo = pointer_to_uword (s->rx_fifo);
328 mp->server_tx_fifo = pointer_to_uword (s->tx_fifo);
329 mp->segment_handle = session_segment_handle (s);
330 ss = ct_session_get_peer (s);
331 mp->ct_rx_fifo = pointer_to_uword (ss->tx_fifo);
332 mp->ct_tx_fifo = pointer_to_uword (ss->rx_fifo);
333 mp->ct_segment_handle = session_segment_handle (ss);
339 svm_msg_q_add_and_unlock (app_mq, msg);
344 mq_send_session_bound_cb (u32 app_wrk_index, u32 api_context,
345 session_handle_t handle, int rv)
347 svm_msg_q_msg_t _msg, *msg = &_msg;
348 svm_msg_q_t *app_mq, *vpp_evt_q;
349 transport_endpoint_t tep;
350 session_bound_msg_t *mp;
351 app_worker_t *app_wrk;
352 session_event_t *evt;
355 app_wrk = app_worker_get (app_wrk_index);
356 app_mq = app_wrk->event_queue;
359 clib_warning ("app %u with api index: %u not attached",
360 app_wrk->app_index, app_wrk->api_client_index);
364 if (mq_try_lock_and_alloc_msg (app_mq, msg))
365 return SESSION_E_MQ_MSG_ALLOC;
367 evt = svm_msg_q_msg_data (app_mq, msg);
368 clib_memset (evt, 0, sizeof (*evt));
369 evt->event_type = SESSION_CTRL_EVT_BOUND;
370 mp = (session_bound_msg_t *) evt->data;
371 mp->context = api_context;
377 al = app_listener_get_w_handle (handle);
378 if (al->session_index != SESSION_INVALID_INDEX)
379 ls = app_listener_get_session (al);
381 ls = app_listener_get_local_session (al);
383 session_get_endpoint (ls, &tep, 1 /* is_lcl */ );
384 mp->lcl_port = tep.port;
385 mp->lcl_is_ip4 = tep.is_ip4;
386 clib_memcpy_fast (mp->lcl_ip, &tep.ip, sizeof (tep.ip));
388 vpp_evt_q = session_main_get_vpp_event_queue (0);
389 mp->vpp_evt_q = pointer_to_uword (vpp_evt_q);
391 if (session_transport_service_type (ls) == TRANSPORT_SERVICE_CL)
393 mp->rx_fifo = pointer_to_uword (ls->rx_fifo);
394 mp->tx_fifo = pointer_to_uword (ls->tx_fifo);
399 svm_msg_q_add_and_unlock (app_mq, msg);
404 mq_send_unlisten_reply (app_worker_t * app_wrk, session_handle_t sh,
407 svm_msg_q_msg_t _msg, *msg = &_msg;
408 session_unlisten_reply_msg_t *ump;
410 session_event_t *evt;
412 app_mq = app_wrk->event_queue;
413 if (mq_try_lock_and_alloc_msg (app_mq, msg))
416 evt = svm_msg_q_msg_data (app_mq, msg);
417 clib_memset (evt, 0, sizeof (*evt));
418 evt->event_type = SESSION_CTRL_EVT_UNLISTEN_REPLY;
419 ump = (session_unlisten_reply_msg_t *) evt->data;
420 ump->context = context;
423 svm_msg_q_add_and_unlock (app_mq, msg);
427 mq_send_session_migrate_cb (session_t * s, session_handle_t new_sh)
429 svm_msg_q_msg_t _msg, *msg = &_msg;
430 session_migrated_msg_t *mp;
431 svm_msg_q_t *vpp_evt_q;
432 app_worker_t *app_wrk;
433 session_event_t *evt;
436 app_wrk = app_worker_get (s->app_wrk_index);
437 app_mq = app_wrk->event_queue;
438 if (mq_try_lock_and_alloc_msg (app_mq, msg))
441 evt = svm_msg_q_msg_data (app_mq, msg);
442 clib_memset (evt, 0, sizeof (*evt));
443 evt->event_type = SESSION_CTRL_EVT_MIGRATED;
444 mp = (session_migrated_msg_t *) evt->data;
445 mp->handle = session_handle (s);
446 mp->new_handle = new_sh;
447 mp->vpp_thread_index = session_thread_from_handle (new_sh);
448 vpp_evt_q = session_main_get_vpp_event_queue (mp->vpp_thread_index);
449 mp->vpp_evt_q = pointer_to_uword (vpp_evt_q);
450 svm_msg_q_add_and_unlock (app_mq, msg);
454 mq_send_add_segment_cb (u32 app_wrk_index, u64 segment_handle)
456 int fds[SESSION_N_FD_TYPE], n_fds = 0;
457 svm_msg_q_msg_t _msg, *msg = &_msg;
458 session_app_add_segment_msg_t *mp;
459 vl_api_registration_t *reg;
460 app_worker_t *app_wrk;
461 session_event_t *evt;
467 app_wrk = app_worker_get (app_wrk_index);
469 reg = vl_mem_api_client_index_to_registration (app_wrk->api_client_index);
472 clib_warning ("no api registration for client: %u",
473 app_wrk->api_client_index);
477 fs = segment_manager_get_segment_w_handle (segment_handle);
479 if (ssvm_type (sp) == SSVM_SEGMENT_MEMFD)
481 if (vl_api_registration_file_index (reg) == VL_API_INVALID_FI)
483 clib_warning ("can't send memfd fd");
487 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
492 app_mq = app_wrk->event_queue;
493 if (mq_try_lock_and_alloc_msg (app_mq, msg))
497 session_send_fds (reg, fds, n_fds);
499 evt = svm_msg_q_msg_data (app_mq, msg);
500 clib_memset (evt, 0, sizeof (*evt));
501 evt->event_type = SESSION_CTRL_EVT_APP_ADD_SEGMENT;
502 mp = (session_app_add_segment_msg_t *) evt->data;
503 clib_memset (mp, 0, sizeof (*mp));
504 mp->segment_size = sp->ssvm_size;
505 mp->fd_flags = fd_flags;
506 mp->segment_handle = segment_handle;
507 strncpy ((char *) mp->segment_name, (char *) sp->name,
508 sizeof (mp->segment_name) - 1);
510 svm_msg_q_add_and_unlock (app_mq, msg);
516 mq_send_del_segment_cb (u32 app_wrk_index, u64 segment_handle)
518 svm_msg_q_msg_t _msg, *msg = &_msg;
519 session_app_del_segment_msg_t *mp;
520 vl_api_registration_t *reg;
521 app_worker_t *app_wrk;
522 session_event_t *evt;
525 app_wrk = app_worker_get (app_wrk_index);
526 reg = vl_mem_api_client_index_to_registration (app_wrk->api_client_index);
529 clib_warning ("no registration: %u", app_wrk->api_client_index);
533 app_mq = app_wrk->event_queue;
534 if (mq_try_lock_and_alloc_msg (app_mq, msg))
537 evt = svm_msg_q_msg_data (app_mq, msg);
538 clib_memset (evt, 0, sizeof (*evt));
539 evt->event_type = SESSION_CTRL_EVT_APP_DEL_SEGMENT;
540 mp = (session_app_del_segment_msg_t *) evt->data;
541 clib_memset (mp, 0, sizeof (*mp));
542 mp->segment_handle = segment_handle;
543 svm_msg_q_add_and_unlock (app_mq, msg);
549 mq_send_session_cleanup_cb (session_t * s, session_cleanup_ntf_t ntf)
551 svm_msg_q_msg_t _msg, *msg = &_msg;
552 session_cleanup_msg_t *mp;
554 session_event_t *evt;
555 app_worker_t *app_wrk;
557 /* Only propagate session cleanup notification */
558 if (ntf == SESSION_CLEANUP_TRANSPORT)
561 app_wrk = app_worker_get_if_valid (s->app_wrk_index);
565 app_mq = app_wrk->event_queue;
566 if (mq_try_lock_and_alloc_msg (app_mq, msg))
569 evt = svm_msg_q_msg_data (app_mq, msg);
570 clib_memset (evt, 0, sizeof (*evt));
571 evt->event_type = SESSION_CTRL_EVT_CLEANUP;
572 mp = (session_cleanup_msg_t *) evt->data;
573 mp->handle = session_handle (s);
574 svm_msg_q_add_and_unlock (app_mq, msg);
577 static session_cb_vft_t session_mq_cb_vft = {
578 .session_accept_callback = mq_send_session_accepted_cb,
579 .session_disconnect_callback = mq_send_session_disconnected_cb,
580 .session_connected_callback = mq_send_session_connected_cb,
581 .session_reset_callback = mq_send_session_reset_cb,
582 .session_migrate_callback = mq_send_session_migrate_cb,
583 .session_cleanup_callback = mq_send_session_cleanup_cb,
584 .add_segment_callback = mq_send_add_segment_cb,
585 .del_segment_callback = mq_send_del_segment_cb,
589 vl_api_session_enable_disable_t_handler (vl_api_session_enable_disable_t * mp)
591 vl_api_session_enable_disable_reply_t *rmp;
592 vlib_main_t *vm = vlib_get_main ();
595 vnet_session_enable_disable (vm, mp->is_enable);
596 REPLY_MACRO (VL_API_SESSION_ENABLE_DISABLE_REPLY);
600 vl_api_app_attach_t_handler (vl_api_app_attach_t * mp)
602 int rv = 0, fds[SESSION_N_FD_TYPE], n_fds = 0;
603 vl_api_app_attach_reply_t *rmp;
604 ssvm_private_t *segp, *evt_q_segment;
605 vnet_app_attach_args_t _a, *a = &_a;
606 u8 fd_flags = 0, ctrl_thread;
607 vl_api_registration_t *reg;
608 svm_msg_q_t *ctrl_mq;
610 reg = vl_api_client_index_to_registration (mp->client_index);
614 if (session_main_is_enabled () == 0)
616 rv = VNET_API_ERROR_FEATURE_DISABLED;
620 STATIC_ASSERT (sizeof (u64) * APP_OPTIONS_N_OPTIONS <=
621 sizeof (mp->options),
622 "Out of options, fix api message definition");
624 clib_memset (a, 0, sizeof (*a));
625 a->api_client_index = mp->client_index;
626 a->options = mp->options;
627 a->session_cb_vft = &session_mq_cb_vft;
629 a->namespace_id = vl_api_from_api_to_new_vec (&mp->namespace_id);
631 if ((rv = vnet_application_attach (a)))
633 clib_warning ("attach returned: %d", rv);
634 vec_free (a->namespace_id);
637 vec_free (a->namespace_id);
639 /* Send event queues segment */
640 if ((evt_q_segment = session_main_get_evt_q_segment ()))
642 fd_flags |= SESSION_FD_F_VPP_MQ_SEGMENT;
643 fds[n_fds] = evt_q_segment->fd;
646 /* Send fifo segment fd if needed */
647 if (ssvm_type (a->segment) == SSVM_SEGMENT_MEMFD)
649 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
650 fds[n_fds] = a->segment->fd;
653 if (a->options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
655 fd_flags |= SESSION_FD_F_MQ_EVENTFD;
656 fds[n_fds] = svm_msg_q_get_producer_eventfd (a->app_evt_q);
662 REPLY_MACRO2 (VL_API_APP_ATTACH_REPLY, ({
665 ctrl_thread = vlib_num_workers () ? 1 : 0;
666 ctrl_mq = session_main_get_vpp_event_queue (ctrl_thread);
668 rmp->app_index = clib_host_to_net_u32 (a->app_index);
669 rmp->app_mq = pointer_to_uword (a->app_evt_q);
670 rmp->vpp_ctrl_mq = pointer_to_uword (ctrl_mq);
671 rmp->vpp_ctrl_mq_thread = ctrl_thread;
673 rmp->fd_flags = fd_flags;
674 if (vec_len (segp->name))
676 vl_api_vec_to_api_string (segp->name, &rmp->segment_name);
678 rmp->segment_size = segp->ssvm_size;
679 rmp->segment_handle = clib_host_to_net_u64 (a->segment_handle);
685 session_send_fds (reg, fds, n_fds);
689 vl_api_app_worker_add_del_t_handler (vl_api_app_worker_add_del_t * mp)
691 int rv = 0, fds[SESSION_N_FD_TYPE], n_fds = 0;
692 vl_api_app_worker_add_del_reply_t *rmp;
693 vl_api_registration_t *reg;
697 if (session_main_is_enabled () == 0)
699 rv = VNET_API_ERROR_FEATURE_DISABLED;
703 reg = vl_api_client_index_to_registration (mp->client_index);
707 app = application_get_if_valid (clib_net_to_host_u32 (mp->app_index));
710 rv = VNET_API_ERROR_INVALID_VALUE;
714 vnet_app_worker_add_del_args_t args = {
715 .app_index = app->app_index,
716 .wrk_map_index = clib_net_to_host_u32 (mp->wrk_index),
717 .api_client_index = mp->client_index,
720 rv = vnet_app_worker_add_del (&args);
723 clib_warning ("app worker add/del returned: %d", rv);
730 /* Send fifo segment fd if needed */
731 if (ssvm_type (args.segment) == SSVM_SEGMENT_MEMFD)
733 fd_flags |= SESSION_FD_F_MEMFD_SEGMENT;
734 fds[n_fds] = args.segment->fd;
737 if (application_segment_manager_properties (app)->use_mq_eventfd)
739 fd_flags |= SESSION_FD_F_MQ_EVENTFD;
740 fds[n_fds] = svm_msg_q_get_producer_eventfd (args.evt_q);
746 REPLY_MACRO2 (VL_API_APP_WORKER_ADD_DEL_REPLY, ({
747 rmp->is_add = mp->is_add;
748 rmp->wrk_index = clib_host_to_net_u32 (args.wrk_map_index);
749 rmp->segment_handle = clib_host_to_net_u64 (args.segment_handle);
750 if (!rv && mp->is_add)
752 if (vec_len (args.segment->name))
754 vl_api_vec_to_api_string (args.segment->name, &rmp->segment_name);
756 rmp->app_event_queue_address = pointer_to_uword (args.evt_q);
758 rmp->fd_flags = fd_flags;
764 session_send_fds (reg, fds, n_fds);
768 vl_api_application_detach_t_handler (vl_api_application_detach_t * mp)
770 vl_api_application_detach_reply_t *rmp;
771 int rv = VNET_API_ERROR_INVALID_VALUE_2;
772 vnet_app_detach_args_t _a, *a = &_a;
775 if (session_main_is_enabled () == 0)
777 rv = VNET_API_ERROR_FEATURE_DISABLED;
781 app = application_lookup (mp->client_index);
784 a->app_index = app->app_index;
785 a->api_client_index = mp->client_index;
786 rv = vnet_application_detach (a);
790 REPLY_MACRO (VL_API_APPLICATION_DETACH_REPLY);
794 vl_api_app_namespace_add_del_t_handler (vl_api_app_namespace_add_del_t * mp)
796 vl_api_app_namespace_add_del_reply_t *rmp;
800 if (session_main_is_enabled () == 0)
802 rv = VNET_API_ERROR_FEATURE_DISABLED;
806 ns_id = vl_api_from_api_to_new_vec (&mp->namespace_id);
808 vnet_app_namespace_add_del_args_t args = {
810 .secret = clib_net_to_host_u64 (mp->secret),
811 .sw_if_index = clib_net_to_host_u32 (mp->sw_if_index),
812 .ip4_fib_id = clib_net_to_host_u32 (mp->ip4_fib_id),
813 .ip6_fib_id = clib_net_to_host_u32 (mp->ip6_fib_id),
816 rv = vnet_app_namespace_add_del (&args);
819 appns_index = app_namespace_index_from_id (ns_id);
820 if (appns_index == APP_NAMESPACE_INVALID_INDEX)
822 clib_warning ("app ns lookup failed");
823 rv = VNET_API_ERROR_UNSPECIFIED;
830 REPLY_MACRO2 (VL_API_APP_NAMESPACE_ADD_DEL_REPLY, ({
832 rmp->appns_index = clib_host_to_net_u32 (appns_index);
838 vl_api_session_rule_add_del_t_handler (vl_api_session_rule_add_del_t * mp)
840 vl_api_session_rule_add_del_reply_t *rmp;
841 session_rule_add_del_args_t args;
842 session_rule_table_add_del_args_t *table_args = &args.table_args;
845 clib_memset (&args, 0, sizeof (args));
847 ip_prefix_decode (&mp->lcl, &table_args->lcl);
848 ip_prefix_decode (&mp->rmt, &table_args->rmt);
850 table_args->lcl_port = mp->lcl_port;
851 table_args->rmt_port = mp->rmt_port;
852 table_args->action_index = clib_net_to_host_u32 (mp->action_index);
853 table_args->is_add = mp->is_add;
854 mp->tag[sizeof (mp->tag) - 1] = 0;
855 table_args->tag = format (0, "%s", mp->tag);
856 args.appns_index = clib_net_to_host_u32 (mp->appns_index);
857 args.scope = mp->scope;
858 args.transport_proto =
859 api_session_transport_proto_decode (&mp->transport_proto) ==
860 TRANSPORT_PROTO_UDP ? 1 : 0;
862 rv = vnet_session_rule_add_del (&args);
864 clib_warning ("rule add del returned: %d", rv);
865 vec_free (table_args->tag);
866 REPLY_MACRO (VL_API_SESSION_RULE_ADD_DEL_REPLY);
870 send_session_rule_details4 (mma_rule_16_t * rule, u8 is_local,
871 u8 transport_proto, u32 appns_index, u8 * tag,
872 vl_api_registration_t * reg, u32 context)
874 vl_api_session_rules_details_t *rmp = 0;
875 session_mask_or_match_4_t *match =
876 (session_mask_or_match_4_t *) & rule->match;
877 session_mask_or_match_4_t *mask =
878 (session_mask_or_match_4_t *) & rule->mask;
879 fib_prefix_t lcl, rmt;
881 rmp = vl_msg_api_alloc (sizeof (*rmp));
882 clib_memset (rmp, 0, sizeof (*rmp));
883 rmp->_vl_msg_id = ntohs (VL_API_SESSION_RULES_DETAILS);
884 rmp->context = context;
886 clib_memset (&lcl, 0, sizeof (lcl));
887 clib_memset (&rmt, 0, sizeof (rmt));
888 ip_set (&lcl.fp_addr, &match->lcl_ip, 1);
889 ip_set (&rmt.fp_addr, &match->rmt_ip, 1);
890 lcl.fp_len = ip4_mask_to_preflen (&mask->lcl_ip);
891 rmt.fp_len = ip4_mask_to_preflen (&mask->rmt_ip);
893 ip_prefix_encode (&lcl, &rmp->lcl);
894 ip_prefix_encode (&rmt, &rmp->rmt);
895 rmp->lcl_port = match->lcl_port;
896 rmp->rmt_port = match->rmt_port;
897 rmp->action_index = clib_host_to_net_u32 (rule->action_index);
899 is_local ? SESSION_RULE_SCOPE_API_LOCAL : SESSION_RULE_SCOPE_API_GLOBAL;
900 rmp->transport_proto = api_session_transport_proto_encode (transport_proto);
901 rmp->appns_index = clib_host_to_net_u32 (appns_index);
904 clib_memcpy_fast (rmp->tag, tag, vec_len (tag));
905 rmp->tag[vec_len (tag)] = 0;
908 vl_api_send_msg (reg, (u8 *) rmp);
912 send_session_rule_details6 (mma_rule_40_t * rule, u8 is_local,
913 u8 transport_proto, u32 appns_index, u8 * tag,
914 vl_api_registration_t * reg, u32 context)
916 vl_api_session_rules_details_t *rmp = 0;
917 session_mask_or_match_6_t *match =
918 (session_mask_or_match_6_t *) & rule->match;
919 session_mask_or_match_6_t *mask =
920 (session_mask_or_match_6_t *) & rule->mask;
921 fib_prefix_t lcl, rmt;
923 rmp = vl_msg_api_alloc (sizeof (*rmp));
924 clib_memset (rmp, 0, sizeof (*rmp));
925 rmp->_vl_msg_id = ntohs (VL_API_SESSION_RULES_DETAILS);
926 rmp->context = context;
928 clib_memset (&lcl, 0, sizeof (lcl));
929 clib_memset (&rmt, 0, sizeof (rmt));
930 ip_set (&lcl.fp_addr, &match->lcl_ip, 0);
931 ip_set (&rmt.fp_addr, &match->rmt_ip, 0);
932 lcl.fp_len = ip6_mask_to_preflen (&mask->lcl_ip);
933 rmt.fp_len = ip6_mask_to_preflen (&mask->rmt_ip);
935 ip_prefix_encode (&lcl, &rmp->lcl);
936 ip_prefix_encode (&rmt, &rmp->rmt);
937 rmp->lcl_port = match->lcl_port;
938 rmp->rmt_port = match->rmt_port;
939 rmp->action_index = clib_host_to_net_u32 (rule->action_index);
941 is_local ? SESSION_RULE_SCOPE_API_LOCAL : SESSION_RULE_SCOPE_API_GLOBAL;
942 rmp->transport_proto = api_session_transport_proto_encode (transport_proto);
943 rmp->appns_index = clib_host_to_net_u32 (appns_index);
946 clib_memcpy_fast (rmp->tag, tag, vec_len (tag));
947 rmp->tag[vec_len (tag)] = 0;
950 vl_api_send_msg (reg, (u8 *) rmp);
954 send_session_rules_table_details (session_rules_table_t * srt, u8 fib_proto,
955 u8 tp, u8 is_local, u32 appns_index,
956 vl_api_registration_t * reg, u32 context)
958 mma_rule_16_t *rule16;
959 mma_rule_40_t *rule40;
960 mma_rules_table_16_t *srt16;
961 mma_rules_table_40_t *srt40;
964 if (is_local || fib_proto == FIB_PROTOCOL_IP4)
968 srt16 = &srt->session_rules_tables_16;
969 pool_foreach (rule16, srt16->rules, ({
970 ri = mma_rules_table_rule_index_16 (srt16, rule16);
971 tag = session_rules_table_rule_tag (srt, ri, 1);
972 send_session_rule_details4 (rule16, is_local, tp, appns_index, tag,
977 if (is_local || fib_proto == FIB_PROTOCOL_IP6)
981 srt40 = &srt->session_rules_tables_40;
982 pool_foreach (rule40, srt40->rules, ({
983 ri = mma_rules_table_rule_index_40 (srt40, rule40);
984 tag = session_rules_table_rule_tag (srt, ri, 1);
985 send_session_rule_details6 (rule40, is_local, tp, appns_index, tag,
993 vl_api_session_rules_dump_t_handler (vl_api_one_map_server_dump_t * mp)
995 vl_api_registration_t *reg;
999 reg = vl_api_client_index_to_registration (mp->client_index);
1004 session_table_foreach (st, ({
1005 for (tp = 0; tp < TRANSPORT_N_PROTOS; tp++)
1007 send_session_rules_table_details (&st->session_rules[tp],
1008 st->active_fib_proto, tp,
1009 st->is_local, st->appns_index, reg,
1017 vl_api_app_add_cert_key_pair_t_handler (vl_api_app_add_cert_key_pair_t * mp)
1019 vl_api_app_add_cert_key_pair_reply_t *rmp;
1020 vnet_app_add_cert_key_pair_args_t _a, *a = &_a;
1021 u32 certkey_len, key_len, cert_len;
1023 if (session_main_is_enabled () == 0)
1025 rv = VNET_API_ERROR_FEATURE_DISABLED;
1029 cert_len = clib_net_to_host_u16 (mp->cert_len);
1030 if (cert_len > 10000)
1032 rv = VNET_API_ERROR_INVALID_VALUE;
1036 certkey_len = clib_net_to_host_u16 (mp->certkey_len);
1037 if (certkey_len < cert_len)
1039 rv = VNET_API_ERROR_INVALID_VALUE;
1043 key_len = certkey_len - cert_len;
1044 if (key_len > 10000)
1046 rv = VNET_API_ERROR_INVALID_VALUE;
1050 clib_memset (a, 0, sizeof (*a));
1051 vec_validate (a->cert, cert_len);
1052 vec_validate (a->key, key_len);
1053 clib_memcpy_fast (a->cert, mp->certkey, cert_len);
1054 clib_memcpy_fast (a->key, mp->certkey + cert_len, key_len);
1055 rv = vnet_app_add_cert_key_pair (a);
1061 REPLY_MACRO2 (VL_API_APP_ADD_CERT_KEY_PAIR_REPLY, ({
1063 rmp->index = clib_host_to_net_u32 (a->index);
1069 vl_api_app_del_cert_key_pair_t_handler (vl_api_app_del_cert_key_pair_t * mp)
1071 vl_api_app_del_cert_key_pair_reply_t *rmp;
1074 if (session_main_is_enabled () == 0)
1076 rv = VNET_API_ERROR_FEATURE_DISABLED;
1079 ckpair_index = clib_net_to_host_u32 (mp->index);
1080 rv = vnet_app_del_cert_key_pair (ckpair_index);
1083 REPLY_MACRO (VL_API_APP_DEL_CERT_KEY_PAIR_REPLY);
1086 /* ### WILL BE DEPRECATED POST 20.01 ### */
1088 vl_api_application_tls_cert_add_t_handler (vl_api_application_tls_cert_add_t *
1091 vl_api_application_tls_cert_add_reply_t *rmp;
1092 app_cert_key_pair_t *ckpair;
1096 if (session_main_is_enabled () == 0)
1098 rv = VNET_API_ERROR_FEATURE_DISABLED;
1101 if (!(app = application_lookup (mp->client_index)))
1103 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
1106 cert_len = clib_net_to_host_u16 (mp->cert_len);
1107 if (cert_len > 10000)
1109 rv = VNET_API_ERROR_INVALID_VALUE;
1112 ckpair = app_cert_key_pair_get_default ();
1113 vec_validate (ckpair->cert, cert_len);
1114 clib_memcpy_fast (ckpair->cert, mp->cert, cert_len);
1117 REPLY_MACRO (VL_API_APPLICATION_TLS_CERT_ADD_REPLY);
1120 /* ### WILL BE DEPRECATED POST 20.01 ### */
1122 vl_api_application_tls_key_add_t_handler (vl_api_application_tls_key_add_t *
1125 vl_api_application_tls_key_add_reply_t *rmp;
1126 app_cert_key_pair_t *ckpair;
1130 if (session_main_is_enabled () == 0)
1132 rv = VNET_API_ERROR_FEATURE_DISABLED;
1135 if (!(app = application_lookup (mp->client_index)))
1137 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
1140 key_len = clib_net_to_host_u16 (mp->key_len);
1141 if (key_len > 10000)
1143 rv = VNET_API_ERROR_INVALID_VALUE;
1146 ckpair = app_cert_key_pair_get_default ();
1147 vec_validate (ckpair->key, key_len);
1148 clib_memcpy_fast (ckpair->key, mp->key, key_len);
1150 REPLY_MACRO (VL_API_APPLICATION_TLS_KEY_ADD_REPLY);
1153 static clib_error_t *
1154 application_reaper_cb (u32 client_index)
1156 application_t *app = application_lookup (client_index);
1157 vnet_app_detach_args_t _a, *a = &_a;
1160 a->app_index = app->app_index;
1161 a->api_client_index = client_index;
1162 vnet_application_detach (a);
1167 VL_MSG_API_REAPER_FUNCTION (application_reaper_cb);
1169 #define vl_msg_name_crc_list
1170 #include <vnet/vnet_all_api_h.h>
1171 #undef vl_msg_name_crc_list
1174 setup_message_id_table (api_main_t * am)
1176 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
1177 foreach_vl_msg_name_crc_session;
1182 * session_api_hookup
1183 * Add uri's API message handlers to the table.
1184 * vlib has already mapped shared memory and
1185 * added the client registration handlers.
1186 * See .../open-repo/vlib/memclnt_vlib.c:memclnt_process()
1188 static clib_error_t *
1189 session_api_hookup (vlib_main_t * vm)
1191 api_main_t *am = vlibapi_get_main ();
1194 vl_msg_api_set_handlers(VL_API_##N, #n, \
1195 vl_api_##n##_t_handler, \
1197 vl_api_##n##_t_endian, \
1198 vl_api_##n##_t_print, \
1199 sizeof(vl_api_##n##_t), 1);
1200 foreach_session_api_msg;
1204 * Set up the (msg_name, crc, message-id) table
1206 setup_message_id_table (am);
1211 VLIB_API_INIT_FUNCTION (session_api_hookup);
1214 * fd.io coding-style-patch-verification: ON
1217 * eval: (c-set-style "gnu")