2 * Copyright (c) 2015-2016 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/session_rules_table.h>
21 #include <vnet/session/session_table.h>
23 #include <vnet/vnet_msg_enum.h>
25 #define vl_typedefs /* define message structures */
26 #include <vnet/vnet_all_api_h.h>
29 #define vl_endianfun /* define message structures */
30 #include <vnet/vnet_all_api_h.h>
33 /* instantiate all the print functions we know about */
34 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
36 #include <vnet/vnet_all_api_h.h>
39 #include <vlibapi/api_helper_macros.h>
41 #define foreach_session_api_msg \
42 _(MAP_ANOTHER_SEGMENT_REPLY, map_another_segment_reply) \
43 _(APPLICATION_ATTACH, application_attach) \
44 _(APPLICATION_DETACH, application_detach) \
45 _(BIND_URI, bind_uri) \
46 _(UNBIND_URI, unbind_uri) \
47 _(CONNECT_URI, connect_uri) \
48 _(DISCONNECT_SESSION, disconnect_session) \
49 _(DISCONNECT_SESSION_REPLY, disconnect_session_reply) \
50 _(ACCEPT_SESSION_REPLY, accept_session_reply) \
51 _(RESET_SESSION_REPLY, reset_session_reply) \
52 _(BIND_SOCK, bind_sock) \
53 _(UNBIND_SOCK, unbind_sock) \
54 _(CONNECT_SOCK, connect_sock) \
55 _(SESSION_ENABLE_DISABLE, session_enable_disable) \
56 _(APP_NAMESPACE_ADD_DEL, app_namespace_add_del) \
57 _(SESSION_RULE_ADD_DEL, session_rule_add_del) \
58 _(SESSION_RULES_DUMP, session_rules_dump) \
59 _(APPLICATION_TLS_CERT_ADD, application_tls_cert_add) \
60 _(APPLICATION_TLS_KEY_ADD, application_tls_key_add) \
63 session_send_memfd_fd (vl_api_registration_t * reg, const ssvm_private_t * sp)
66 if (vl_api_registration_file_index (reg) == VL_API_INVALID_FI)
68 clib_warning ("can't send memfd fd");
71 error = vl_api_send_fd_msg (reg, sp->fd);
74 clib_error_report (error);
81 send_add_segment_callback (u32 api_client_index, const ssvm_private_t * sp)
83 vl_api_map_another_segment_t *mp;
84 vl_api_registration_t *reg;
86 reg = vl_mem_api_client_index_to_registration (api_client_index);
89 clib_warning ("no registration: %u", api_client_index);
93 if (ssvm_type (sp) == SSVM_SEGMENT_MEMFD
94 && vl_api_registration_file_index (reg) == VL_API_INVALID_FI)
96 clib_warning ("can't send memfd fd");
100 mp = vl_msg_api_alloc_as_if_client (sizeof (*mp));
101 memset (mp, 0, sizeof (*mp));
102 mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_MAP_ANOTHER_SEGMENT);
103 mp->segment_size = sp->ssvm_size;
104 strncpy ((char *) mp->segment_name, (char *) sp->name,
105 sizeof (mp->segment_name) - 1);
107 vl_msg_api_send_shmem (reg->vl_input_queue, (u8 *) & mp);
109 if (ssvm_type (sp) == SSVM_SEGMENT_MEMFD)
110 return session_send_memfd_fd (reg, sp);
116 send_del_segment_callback (u32 api_client_index, const ssvm_private_t * fs)
118 vl_api_unmap_segment_t *mp;
119 vl_api_registration_t *reg;
121 reg = vl_mem_api_client_index_to_registration (api_client_index);
124 clib_warning ("no registration: %u", api_client_index);
128 if (ssvm_type (fs) == SSVM_SEGMENT_MEMFD
129 && vl_api_registration_file_index (reg) == VL_API_INVALID_FI)
131 clib_warning ("can't send memfd fd");
135 mp = vl_msg_api_alloc_as_if_client (sizeof (*mp));
136 memset (mp, 0, sizeof (*mp));
137 mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_UNMAP_SEGMENT);
138 strncpy ((char *) mp->segment_name, (char *) fs->name,
139 sizeof (mp->segment_name) - 1);
141 vl_msg_api_send_shmem (reg->vl_input_queue, (u8 *) & mp);
143 if (ssvm_type (fs) == SSVM_SEGMENT_MEMFD)
144 return session_send_memfd_fd (reg, fs);
150 send_session_accept_callback (stream_session_t * s)
152 application_t *server = application_get (s->app_index);
153 transport_proto_vft_t *tp_vft;
154 vl_api_accept_session_t *mp;
155 vl_api_registration_t *reg;
156 transport_connection_t *tc;
157 stream_session_t *listener;
158 svm_msg_q_t *vpp_queue;
160 reg = vl_mem_api_client_index_to_registration (server->api_client_index);
163 clib_warning ("no registration: %u", server->api_client_index);
167 mp = vl_mem_api_alloc_as_if_client_w_reg (reg, sizeof (*mp));
168 memset (mp, 0, sizeof (*mp));
170 mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_ACCEPT_SESSION);
171 mp->context = server->index;
172 mp->server_rx_fifo = pointer_to_uword (s->server_rx_fifo);
173 mp->server_tx_fifo = pointer_to_uword (s->server_tx_fifo);
175 if (session_has_transport (s))
177 listener = listen_session_get (s->listener_index);
178 mp->listener_handle = listen_session_get_handle (listener);
179 if (application_is_proxy (server))
182 application_first_listener (server, session_get_fib_proto (s),
183 session_get_transport_proto (s));
185 mp->listener_handle = listen_session_get_handle (listener);
187 vpp_queue = session_manager_get_vpp_event_queue (s->thread_index);
188 mp->vpp_event_queue_address = pointer_to_uword (vpp_queue);
189 mp->handle = session_handle (s);
190 tp_vft = transport_protocol_get_vft (session_get_transport_proto (s));
191 tc = tp_vft->get_connection (s->connection_index, s->thread_index);
192 mp->port = tc->rmt_port;
193 mp->is_ip4 = tc->is_ip4;
194 clib_memcpy (&mp->ip, &tc->rmt_ip, sizeof (tc->rmt_ip));
198 local_session_t *ls = (local_session_t *) s;
200 if (application_local_session_listener_has_transport (ls))
202 listener = listen_session_get (ls->listener_index);
203 mp->listener_handle = listen_session_get_handle (listener);
204 mp->is_ip4 = session_type_is_ip4 (listener->session_type);
208 ll = application_get_local_listen_session (server,
210 if (ll->transport_listener_index != ~0)
212 listener = listen_session_get (ll->transport_listener_index);
213 mp->listener_handle = listen_session_get_handle (listener);
217 mp->listener_handle = application_local_session_handle (ll);
219 mp->is_ip4 = session_type_is_ip4 (ll->listener_session_type);
221 mp->handle = application_local_session_handle (ls);
223 mp->vpp_event_queue_address = ls->client_evt_q;
224 mp->server_event_queue_address = ls->server_evt_q;
226 vl_msg_api_send_shmem (reg->vl_input_queue, (u8 *) & mp);
232 send_local_session_disconnect_callback (u32 app_index, local_session_t * ls)
234 application_t *app = application_get (app_index);
235 vl_api_disconnect_session_t *mp;
236 vl_api_registration_t *reg;
238 reg = vl_mem_api_client_index_to_registration (app->api_client_index);
241 clib_warning ("no registration: %u", app->api_client_index);
245 mp = vl_mem_api_alloc_as_if_client_w_reg (reg, sizeof (*mp));
246 memset (mp, 0, sizeof (*mp));
247 mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_DISCONNECT_SESSION);
248 mp->handle = application_local_session_handle (ls);
249 mp->context = app->api_client_index;
250 vl_msg_api_send_shmem (reg->vl_input_queue, (u8 *) & mp);
254 send_session_disconnect_callback (stream_session_t * s)
256 application_t *app = application_get (s->app_index);
257 vl_api_disconnect_session_t *mp;
258 vl_api_registration_t *reg;
260 reg = vl_mem_api_client_index_to_registration (app->api_client_index);
263 clib_warning ("no registration: %u", app->api_client_index);
267 mp = vl_mem_api_alloc_as_if_client_w_reg (reg, sizeof (*mp));
268 memset (mp, 0, sizeof (*mp));
269 mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_DISCONNECT_SESSION);
270 mp->handle = session_handle (s);
271 mp->context = app->api_client_index;
272 vl_msg_api_send_shmem (reg->vl_input_queue, (u8 *) & mp);
276 send_session_reset_callback (stream_session_t * s)
278 application_t *app = application_get (s->app_index);
279 vl_api_registration_t *reg;
280 vl_api_reset_session_t *mp;
282 reg = vl_mem_api_client_index_to_registration (app->api_client_index);
285 clib_warning ("no registration: %u", app->api_client_index);
289 mp = vl_mem_api_alloc_as_if_client_w_reg (reg, sizeof (*mp));
290 memset (mp, 0, sizeof (*mp));
291 mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_RESET_SESSION);
292 mp->handle = session_handle (s);
293 vl_msg_api_send_shmem (reg->vl_input_queue, (u8 *) & mp);
297 send_session_connected_callback (u32 app_index, u32 api_context,
298 stream_session_t * s, u8 is_fail)
300 vl_api_connect_session_reply_t *mp;
301 transport_connection_t *tc;
302 vl_api_registration_t *reg;
303 svm_msg_q_t *vpp_queue;
306 app = application_get (app_index);
307 reg = vl_mem_api_client_index_to_registration (app->api_client_index);
310 clib_warning ("no registration: %u", app->api_client_index);
314 mp = vl_mem_api_alloc_as_if_client_w_reg (reg, sizeof (*mp));
315 mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_CONNECT_SESSION_REPLY);
316 mp->context = api_context;
321 if (session_has_transport (s))
323 tc = session_get_transport (s);
330 vpp_queue = session_manager_get_vpp_event_queue (s->thread_index);
331 mp->handle = session_handle (s);
332 mp->vpp_event_queue_address = pointer_to_uword (vpp_queue);
333 clib_memcpy (mp->lcl_ip, &tc->lcl_ip, sizeof (tc->lcl_ip));
334 mp->is_ip4 = tc->is_ip4;
335 mp->lcl_port = tc->lcl_port;
336 mp->server_rx_fifo = pointer_to_uword (s->server_rx_fifo);
337 mp->server_tx_fifo = pointer_to_uword (s->server_tx_fifo);
341 local_session_t *ls = (local_session_t *) s;
342 mp->handle = application_local_session_handle (ls);
343 mp->lcl_port = ls->port;
344 mp->vpp_event_queue_address = ls->server_evt_q;
345 mp->client_event_queue_address = ls->client_evt_q;
346 mp->server_rx_fifo = pointer_to_uword (s->server_tx_fifo);
347 mp->server_tx_fifo = pointer_to_uword (s->server_rx_fifo);
351 mp->retval = is_fail ?
352 clib_host_to_net_u32 (VNET_API_ERROR_SESSION_CONNECT) : 0;
353 vl_msg_api_send_shmem (reg->vl_input_queue, (u8 *) & mp);
357 static session_cb_vft_t session_cb_vft = {
358 .session_accept_callback = send_session_accept_callback,
359 .session_disconnect_callback = send_session_disconnect_callback,
360 .session_connected_callback = send_session_connected_callback,
361 .session_reset_callback = send_session_reset_callback,
362 .add_segment_callback = send_add_segment_callback,
363 .del_segment_callback = send_del_segment_callback,
367 mq_send_session_accepted_cb (stream_session_t * s)
369 application_t *app = application_get (s->app_index);
370 svm_msg_q_msg_t _msg, *msg = &_msg;
371 svm_msg_q_t *vpp_queue, *app_mq;
372 transport_proto_vft_t *tp_vft;
373 transport_connection_t *tc;
374 stream_session_t *listener;
375 session_accepted_msg_t *mp;
376 session_event_t *evt;
378 app_mq = app->event_queue;
379 svm_msg_q_lock_and_alloc_msg_w_ring (app_mq, SESSION_MQ_CTRL_EVT_RING,
381 svm_msg_q_unlock (app_mq);
383 evt = svm_msg_q_msg_data (app_mq, msg);
384 memset (evt, 0, sizeof (*evt));
385 evt->event_type = SESSION_CTRL_EVT_ACCEPTED;
386 mp = (session_accepted_msg_t *) evt->data;
387 mp->context = app->index;
388 mp->server_rx_fifo = pointer_to_uword (s->server_rx_fifo);
389 mp->server_tx_fifo = pointer_to_uword (s->server_tx_fifo);
391 if (session_has_transport (s))
393 listener = listen_session_get (s->listener_index);
394 mp->listener_handle = listen_session_get_handle (listener);
395 if (application_is_proxy (app))
398 application_first_listener (app, session_get_fib_proto (s),
399 session_get_transport_proto (s));
401 mp->listener_handle = listen_session_get_handle (listener);
403 vpp_queue = session_manager_get_vpp_event_queue (s->thread_index);
404 mp->vpp_event_queue_address = pointer_to_uword (vpp_queue);
405 mp->handle = session_handle (s);
406 tp_vft = transport_protocol_get_vft (session_get_transport_proto (s));
407 tc = tp_vft->get_connection (s->connection_index, s->thread_index);
408 mp->port = tc->rmt_port;
409 mp->is_ip4 = tc->is_ip4;
410 clib_memcpy (&mp->ip, &tc->rmt_ip, sizeof (tc->rmt_ip));
414 local_session_t *ls = (local_session_t *) s;
416 if (application_local_session_listener_has_transport (ls))
418 listener = listen_session_get (ls->listener_index);
419 mp->listener_handle = listen_session_get_handle (listener);
420 mp->is_ip4 = session_type_is_ip4 (listener->session_type);
424 ll = application_get_local_listen_session (app, ls->listener_index);
425 if (ll->transport_listener_index != ~0)
427 listener = listen_session_get (ll->transport_listener_index);
428 mp->listener_handle = listen_session_get_handle (listener);
432 mp->listener_handle = application_local_session_handle (ll);
434 mp->is_ip4 = session_type_is_ip4 (ll->listener_session_type);
436 mp->handle = application_local_session_handle (ls);
438 mp->vpp_event_queue_address = ls->client_evt_q;
439 mp->server_event_queue_address = ls->server_evt_q;
441 svm_msg_q_add (app_mq, msg, SVM_Q_WAIT);
447 mq_send_session_disconnected_cb (stream_session_t * s)
449 application_t *app = application_get (s->app_index);
450 svm_msg_q_msg_t _msg, *msg = &_msg;
451 session_disconnected_msg_t *mp;
453 session_event_t *evt;
455 app_mq = app->event_queue;
456 svm_msg_q_lock_and_alloc_msg_w_ring (app_mq, SESSION_MQ_CTRL_EVT_RING,
458 svm_msg_q_unlock (app_mq);
459 evt = svm_msg_q_msg_data (app_mq, msg);
460 memset (evt, 0, sizeof (*evt));
461 evt->event_type = SESSION_CTRL_EVT_DISCONNECTED;
462 mp = (session_disconnected_msg_t *) evt->data;
463 mp->handle = session_handle (s);
464 mp->context = app->api_client_index;
465 svm_msg_q_add (app_mq, msg, SVM_Q_WAIT);
469 mq_send_session_reset_cb (stream_session_t * s)
471 application_t *app = application_get (s->app_index);
472 svm_msg_q_msg_t _msg, *msg = &_msg;
473 session_reset_msg_t *mp;
475 session_event_t *evt;
477 app_mq = app->event_queue;
478 svm_msg_q_lock_and_alloc_msg_w_ring (app_mq, SESSION_MQ_CTRL_EVT_RING,
480 svm_msg_q_unlock (app_mq);
481 evt = svm_msg_q_msg_data (app_mq, msg);
482 memset (evt, 0, sizeof (*evt));
483 evt->event_type = SESSION_CTRL_EVT_RESET;
484 mp = (session_reset_msg_t *) evt->data;
485 mp->handle = session_handle (s);
486 svm_msg_q_add (app_mq, msg, SVM_Q_WAIT);
490 mq_send_session_connected_cb (u32 app_index, u32 api_context,
491 stream_session_t * s, u8 is_fail)
493 svm_msg_q_msg_t _msg, *msg = &_msg;
494 session_connected_msg_t *mp;
495 svm_msg_q_t *vpp_mq, *app_mq;
496 transport_connection_t *tc;
497 session_event_t *evt;
500 app = application_get (app_index);
501 app_mq = app->event_queue;
504 clib_warning ("app %u with api index: %u not attached", app->index,
505 app->api_client_index);
509 svm_msg_q_lock_and_alloc_msg_w_ring (app_mq, SESSION_MQ_CTRL_EVT_RING,
511 svm_msg_q_unlock (app_mq);
512 evt = svm_msg_q_msg_data (app_mq, msg);
513 memset (evt, 0, sizeof (*evt));
514 evt->event_type = SESSION_CTRL_EVT_CONNECTED;
515 mp = (session_connected_msg_t *) evt->data;
516 mp->context = api_context;
521 if (session_has_transport (s))
523 tc = session_get_transport (s);
530 vpp_mq = session_manager_get_vpp_event_queue (s->thread_index);
531 mp->handle = session_handle (s);
532 mp->vpp_event_queue_address = pointer_to_uword (vpp_mq);
533 clib_memcpy (mp->lcl_ip, &tc->lcl_ip, sizeof (tc->lcl_ip));
534 mp->is_ip4 = tc->is_ip4;
535 mp->lcl_port = tc->lcl_port;
536 mp->server_rx_fifo = pointer_to_uword (s->server_rx_fifo);
537 mp->server_tx_fifo = pointer_to_uword (s->server_tx_fifo);
541 local_session_t *ls = (local_session_t *) s;
542 mp->handle = application_local_session_handle (ls);
543 mp->lcl_port = ls->port;
544 mp->vpp_event_queue_address = ls->server_evt_q;
545 mp->client_event_queue_address = ls->client_evt_q;
546 mp->server_rx_fifo = pointer_to_uword (s->server_tx_fifo);
547 mp->server_tx_fifo = pointer_to_uword (s->server_rx_fifo);
551 mp->retval = is_fail ?
552 clib_host_to_net_u32 (VNET_API_ERROR_SESSION_CONNECT) : 0;
554 svm_msg_q_add (app_mq, msg, SVM_Q_WAIT);
558 static session_cb_vft_t session_mq_cb_vft = {
559 .session_accept_callback = mq_send_session_accepted_cb,
560 .session_disconnect_callback = mq_send_session_disconnected_cb,
561 .session_connected_callback = mq_send_session_connected_cb,
562 .session_reset_callback = mq_send_session_reset_cb,
563 .add_segment_callback = send_add_segment_callback,
564 .del_segment_callback = send_del_segment_callback,
568 vl_api_session_enable_disable_t_handler (vl_api_session_enable_disable_t * mp)
570 vl_api_session_enable_disable_reply_t *rmp;
571 vlib_main_t *vm = vlib_get_main ();
574 vnet_session_enable_disable (vm, mp->is_enable);
575 REPLY_MACRO (VL_API_SESSION_ENABLE_DISABLE_REPLY);
579 vl_api_application_attach_t_handler (vl_api_application_attach_t * mp)
581 vl_api_application_attach_reply_t *rmp;
582 ssvm_private_t *segp, *evt_q_segment;
583 vnet_app_attach_args_t _a, *a = &_a;
584 vl_api_registration_t *reg;
585 clib_error_t *error = 0;
588 reg = vl_api_client_index_to_registration (mp->client_index);
592 if (session_manager_is_enabled () == 0)
594 rv = VNET_API_ERROR_FEATURE_DISABLED;
598 STATIC_ASSERT (sizeof (u64) * APP_OPTIONS_N_OPTIONS <=
599 sizeof (mp->options),
600 "Out of options, fix api message definition");
602 memset (a, 0, sizeof (*a));
603 a->api_client_index = mp->client_index;
604 a->options = mp->options;
606 if (a->options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_USE_MQ_FOR_CTRL_MSGS)
607 a->session_cb_vft = &session_mq_cb_vft;
609 a->session_cb_vft = &session_cb_vft;
611 if (mp->namespace_id_len > 64)
613 rv = VNET_API_ERROR_INVALID_VALUE;
617 if (mp->namespace_id_len)
619 vec_validate (a->namespace_id, mp->namespace_id_len - 1);
620 clib_memcpy (a->namespace_id, mp->namespace_id, mp->namespace_id_len);
623 if ((error = vnet_application_attach (a)))
625 rv = clib_error_get_code (error);
626 clib_error_report (error);
628 vec_free (a->namespace_id);
633 REPLY_MACRO2 (VL_API_APPLICATION_ATTACH_REPLY, ({
637 rmp->segment_name_length = 0;
638 rmp->segment_size = segp->ssvm_size;
639 if (vec_len (segp->name))
641 memcpy (rmp->segment_name, segp->name, vec_len (segp->name));
642 rmp->segment_name_length = vec_len (segp->name);
644 rmp->app_event_queue_address = a->app_event_queue_address;
652 /* Send fifo segment fd if needed */
653 if (ssvm_type (a->segment) == SSVM_SEGMENT_MEMFD)
654 session_send_memfd_fd (reg, a->segment);
655 /* Send event queues segment */
656 if ((evt_q_segment = session_manager_get_evt_q_segment ()))
657 session_send_memfd_fd (reg, evt_q_segment);
661 vl_api_application_detach_t_handler (vl_api_application_detach_t * mp)
663 vl_api_application_detach_reply_t *rmp;
664 int rv = VNET_API_ERROR_INVALID_VALUE_2;
665 vnet_app_detach_args_t _a, *a = &_a;
668 if (session_manager_is_enabled () == 0)
670 rv = VNET_API_ERROR_FEATURE_DISABLED;
674 app = application_lookup (mp->client_index);
677 a->app_index = app->index;
678 rv = vnet_application_detach (a);
682 REPLY_MACRO (VL_API_APPLICATION_DETACH_REPLY);
686 vl_api_bind_uri_t_handler (vl_api_bind_uri_t * mp)
688 transport_connection_t *tc = 0;
689 vnet_bind_args_t _a, *a = &_a;
690 vl_api_bind_uri_reply_t *rmp;
692 application_t *app = 0;
693 svm_msg_q_t *vpp_evt_q;
696 if (session_manager_is_enabled () == 0)
698 rv = VNET_API_ERROR_FEATURE_DISABLED;
702 app = application_lookup (mp->client_index);
705 memset (a, 0, sizeof (*a));
706 a->uri = (char *) mp->uri;
707 a->app_index = app->index;
708 rv = vnet_bind_uri (a);
712 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
718 REPLY_MACRO2 (VL_API_BIND_URI_REPLY, ({
721 rmp->handle = a->handle;
722 if (app && application_has_global_scope (app))
724 s = listen_session_get_from_handle (a->handle);
725 tc = listen_session_get_transport (s);
726 rmp->lcl_is_ip4 = tc->is_ip4;
727 rmp->lcl_port = tc->lcl_port;
728 clib_memcpy (rmp->lcl_ip, &tc->lcl_ip, sizeof(tc->lcl_ip));
729 if (session_transport_service_type (s) == TRANSPORT_SERVICE_CL)
731 rmp->rx_fifo = pointer_to_uword (s->server_rx_fifo);
732 rmp->tx_fifo = pointer_to_uword (s->server_tx_fifo);
733 vpp_evt_q = session_manager_get_vpp_event_queue (0);
734 rmp->vpp_evt_q = pointer_to_uword (vpp_evt_q);
743 vl_api_unbind_uri_t_handler (vl_api_unbind_uri_t * mp)
745 vl_api_unbind_uri_reply_t *rmp;
747 vnet_unbind_args_t _a, *a = &_a;
750 if (session_manager_is_enabled () == 0)
752 rv = VNET_API_ERROR_FEATURE_DISABLED;
756 app = application_lookup (mp->client_index);
759 a->uri = (char *) mp->uri;
760 a->app_index = app->index;
761 rv = vnet_unbind_uri (a);
765 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
769 REPLY_MACRO (VL_API_UNBIND_URI_REPLY);
773 vl_api_connect_uri_t_handler (vl_api_connect_uri_t * mp)
775 vl_api_connect_session_reply_t *rmp;
776 vnet_connect_args_t _a, *a = &_a;
778 clib_error_t *error = 0;
781 if (session_manager_is_enabled () == 0)
783 rv = VNET_API_ERROR_FEATURE_DISABLED;
787 app = application_lookup (mp->client_index);
790 a->uri = (char *) mp->uri;
791 a->api_context = mp->context;
792 a->app_index = app->index;
793 if ((error = vnet_connect_uri (a)))
795 rv = clib_error_get_code (error);
796 clib_error_report (error);
801 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
805 * Don't reply to stream (tcp) connects. The reply will come once
806 * the connection is established. In case of the redirects, the reply
807 * will come from the server app.
814 REPLY_MACRO (VL_API_CONNECT_SESSION_REPLY);
819 vl_api_disconnect_session_t_handler (vl_api_disconnect_session_t * mp)
821 vl_api_disconnect_session_reply_t *rmp;
822 vnet_disconnect_args_t _a, *a = &_a;
826 if (session_manager_is_enabled () == 0)
828 rv = VNET_API_ERROR_FEATURE_DISABLED;
832 app = application_lookup (mp->client_index);
835 a->handle = mp->handle;
836 a->app_index = app->index;
837 rv = vnet_disconnect_session (a);
841 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
845 REPLY_MACRO2 (VL_API_DISCONNECT_SESSION_REPLY, rmp->handle = mp->handle);
849 vl_api_disconnect_session_reply_t_handler (vl_api_disconnect_session_reply_t *
852 vnet_disconnect_args_t _a, *a = &_a;
855 /* Client objected to disconnecting the session, log and continue */
858 clib_warning ("client retval %d", mp->retval);
862 /* Disconnect has been confirmed. Confirm close to transport */
863 app = application_lookup (mp->context);
866 a->handle = mp->handle;
867 a->app_index = app->index;
868 vnet_disconnect_session (a);
873 vl_api_reset_session_reply_t_handler (vl_api_reset_session_reply_t * mp)
877 u32 index, thread_index;
879 app = application_lookup (mp->client_index);
883 session_parse_handle (mp->handle, &index, &thread_index);
884 s = session_get_if_valid (index, thread_index);
885 if (s == 0 || app->index != s->app_index)
887 clib_warning ("Invalid session!");
891 /* Client objected to resetting the session, log and continue */
894 clib_warning ("client retval %d", mp->retval);
898 /* This comes as a response to a reset, transport only waiting for
899 * confirmation to remove connection state, no need to disconnect */
900 stream_session_cleanup (s);
904 vl_api_accept_session_reply_t_handler (vl_api_accept_session_reply_t * mp)
906 vnet_disconnect_args_t _a = { 0 }, *a = &_a;
910 /* Server isn't interested, kill the session */
913 a->app_index = mp->context;
914 a->handle = mp->handle;
915 vnet_disconnect_session (a);
919 if (session_handle_is_local (mp->handle))
921 ls = application_get_local_session_from_handle (mp->handle);
922 if (!ls || ls->app_index != mp->context)
924 clib_warning ("server %u doesn't own local handle %llu",
925 mp->context, mp->handle);
928 if (application_local_session_connect_notify (ls))
930 ls->session_state = SESSION_STATE_READY;
934 s = session_get_from_handle_if_valid (mp->handle);
937 clib_warning ("session doesn't exist");
940 if (s->app_index != mp->context)
942 clib_warning ("app doesn't own session");
945 s->session_state = SESSION_STATE_READY;
950 vl_api_map_another_segment_reply_t_handler (vl_api_map_another_segment_reply_t
953 clib_warning ("not implemented");
957 vl_api_bind_sock_t_handler (vl_api_bind_sock_t * mp)
959 vl_api_bind_sock_reply_t *rmp;
960 vnet_bind_args_t _a, *a = &_a;
963 application_t *app = 0;
965 transport_connection_t *tc = 0;
966 ip46_address_t *ip46;
967 svm_msg_q_t *vpp_evt_q;
969 if (session_manager_is_enabled () == 0)
971 rv = VNET_API_ERROR_FEATURE_DISABLED;
975 app = application_lookup (mp->client_index);
978 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
982 ip46 = (ip46_address_t *) mp->ip;
983 memset (a, 0, sizeof (*a));
984 a->sep.is_ip4 = mp->is_ip4;
986 a->sep.port = mp->port;
987 a->sep.fib_index = mp->vrf;
988 a->sep.sw_if_index = ENDPOINT_INVALID_INDEX;
989 a->sep.transport_proto = mp->proto;
990 a->app_index = app->index;
992 if ((error = vnet_bind (a)))
994 rv = clib_error_get_code (error);
995 clib_error_report (error);
1000 REPLY_MACRO2 (VL_API_BIND_SOCK_REPLY,({
1003 rmp->handle = a->handle;
1004 rmp->lcl_port = mp->port;
1005 rmp->lcl_is_ip4 = mp->is_ip4;
1006 if (app && application_has_global_scope (app))
1008 s = listen_session_get_from_handle (a->handle);
1009 tc = listen_session_get_transport (s);
1010 clib_memcpy (rmp->lcl_ip, &tc->lcl_ip, sizeof (tc->lcl_ip));
1011 if (session_transport_service_type (s) == TRANSPORT_SERVICE_CL)
1013 rmp->rx_fifo = pointer_to_uword (s->server_rx_fifo);
1014 rmp->tx_fifo = pointer_to_uword (s->server_tx_fifo);
1015 vpp_evt_q = session_manager_get_vpp_event_queue (0);
1016 rmp->vpp_evt_q = pointer_to_uword (vpp_evt_q);
1025 vl_api_unbind_sock_t_handler (vl_api_unbind_sock_t * mp)
1027 vl_api_unbind_sock_reply_t *rmp;
1028 vnet_unbind_args_t _a, *a = &_a;
1030 clib_error_t *error;
1033 if (session_manager_is_enabled () == 0)
1035 rv = VNET_API_ERROR_FEATURE_DISABLED;
1039 app = application_lookup (mp->client_index);
1042 a->app_index = app->index;
1043 a->handle = mp->handle;
1044 if ((error = vnet_unbind (a)))
1046 rv = clib_error_get_code (error);
1047 clib_error_report (error);
1052 REPLY_MACRO (VL_API_UNBIND_SOCK_REPLY);
1056 vl_api_connect_sock_t_handler (vl_api_connect_sock_t * mp)
1058 vl_api_connect_session_reply_t *rmp;
1059 vnet_connect_args_t _a, *a = &_a;
1061 clib_error_t *error = 0;
1064 if (session_manager_is_enabled () == 0)
1066 rv = VNET_API_ERROR_FEATURE_DISABLED;
1070 app = application_lookup (mp->client_index);
1073 svm_queue_t *client_q;
1074 ip46_address_t *ip46 = (ip46_address_t *) mp->ip;
1076 memset (a, 0, sizeof (*a));
1077 client_q = vl_api_client_index_to_input_queue (mp->client_index);
1078 mp->client_queue_address = pointer_to_uword (client_q);
1079 a->sep.is_ip4 = mp->is_ip4;
1081 a->sep.port = mp->port;
1082 a->sep.transport_proto = mp->proto;
1083 a->sep.fib_index = mp->vrf;
1084 a->sep.sw_if_index = ENDPOINT_INVALID_INDEX;
1085 if (mp->hostname_len)
1087 vec_validate (a->sep.hostname, mp->hostname_len - 1);
1088 clib_memcpy (a->sep.hostname, mp->hostname, mp->hostname_len);
1090 a->api_context = mp->context;
1091 a->app_index = app->index;
1092 if ((error = vnet_connect (a)))
1094 rv = clib_error_get_code (error);
1095 clib_error_report (error);
1097 vec_free (a->sep.hostname);
1101 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
1107 /* Got some error, relay it */
1110 REPLY_MACRO (VL_API_CONNECT_SESSION_REPLY);
1114 vl_api_app_namespace_add_del_t_handler (vl_api_app_namespace_add_del_t * mp)
1116 vl_api_app_namespace_add_del_reply_t *rmp;
1117 clib_error_t *error = 0;
1118 u32 appns_index = 0;
1121 if (!session_manager_is_enabled ())
1123 rv = VNET_API_ERROR_FEATURE_DISABLED;
1127 if (mp->namespace_id_len > ARRAY_LEN (mp->namespace_id))
1129 rv = VNET_API_ERROR_INVALID_VALUE;
1133 vec_validate (ns_id, mp->namespace_id_len - 1);
1134 clib_memcpy (ns_id, mp->namespace_id, mp->namespace_id_len);
1135 vnet_app_namespace_add_del_args_t args = {
1137 .secret = clib_net_to_host_u64 (mp->secret),
1138 .sw_if_index = clib_net_to_host_u32 (mp->sw_if_index),
1139 .ip4_fib_id = clib_net_to_host_u32 (mp->ip4_fib_id),
1140 .ip6_fib_id = clib_net_to_host_u32 (mp->ip6_fib_id),
1143 error = vnet_app_namespace_add_del (&args);
1146 rv = clib_error_get_code (error);
1147 clib_error_report (error);
1151 appns_index = app_namespace_index_from_id (ns_id);
1152 if (appns_index == APP_NAMESPACE_INVALID_INDEX)
1154 clib_warning ("app ns lookup failed");
1155 rv = VNET_API_ERROR_UNSPECIFIED;
1162 REPLY_MACRO2 (VL_API_APP_NAMESPACE_ADD_DEL_REPLY, ({
1164 rmp->appns_index = clib_host_to_net_u32 (appns_index);
1170 vl_api_session_rule_add_del_t_handler (vl_api_session_rule_add_del_t * mp)
1172 vl_api_session_rule_add_del_reply_t *rmp;
1173 session_rule_add_del_args_t args;
1174 session_rule_table_add_del_args_t *table_args = &args.table_args;
1175 clib_error_t *error;
1179 memset (&args, 0, sizeof (args));
1180 fib_proto = mp->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
1182 table_args->lcl.fp_len = mp->lcl_plen;
1183 table_args->lcl.fp_proto = fib_proto;
1184 table_args->rmt.fp_len = mp->rmt_plen;
1185 table_args->rmt.fp_proto = fib_proto;
1186 table_args->lcl_port = mp->lcl_port;
1187 table_args->rmt_port = mp->rmt_port;
1188 table_args->action_index = clib_net_to_host_u32 (mp->action_index);
1189 table_args->is_add = mp->is_add;
1190 mp->tag[sizeof (mp->tag) - 1] = 0;
1191 table_args->tag = format (0, "%s", mp->tag);
1192 args.appns_index = clib_net_to_host_u32 (mp->appns_index);
1193 args.scope = mp->scope;
1194 args.transport_proto = mp->transport_proto;
1196 memset (&table_args->lcl.fp_addr, 0, sizeof (table_args->lcl.fp_addr));
1197 memset (&table_args->rmt.fp_addr, 0, sizeof (table_args->rmt.fp_addr));
1198 ip_set (&table_args->lcl.fp_addr, mp->lcl_ip, mp->is_ip4);
1199 ip_set (&table_args->rmt.fp_addr, mp->rmt_ip, mp->is_ip4);
1200 error = vnet_session_rule_add_del (&args);
1203 rv = clib_error_get_code (error);
1204 clib_error_report (error);
1206 vec_free (table_args->tag);
1207 REPLY_MACRO (VL_API_SESSION_RULE_ADD_DEL_REPLY);
1211 send_session_rule_details4 (mma_rule_16_t * rule, u8 is_local,
1212 u8 transport_proto, u32 appns_index, u8 * tag,
1213 vl_api_registration_t * reg, u32 context)
1215 vl_api_session_rules_details_t *rmp = 0;
1216 session_mask_or_match_4_t *match =
1217 (session_mask_or_match_4_t *) & rule->match;
1218 session_mask_or_match_4_t *mask =
1219 (session_mask_or_match_4_t *) & rule->mask;
1221 rmp = vl_msg_api_alloc (sizeof (*rmp));
1222 memset (rmp, 0, sizeof (*rmp));
1223 rmp->_vl_msg_id = ntohs (VL_API_SESSION_RULES_DETAILS);
1224 rmp->context = context;
1227 clib_memcpy (rmp->lcl_ip, &match->lcl_ip, sizeof (match->lcl_ip));
1228 clib_memcpy (rmp->rmt_ip, &match->rmt_ip, sizeof (match->rmt_ip));
1229 rmp->lcl_plen = ip4_mask_to_preflen (&mask->lcl_ip);
1230 rmp->rmt_plen = ip4_mask_to_preflen (&mask->rmt_ip);
1231 rmp->lcl_port = match->lcl_port;
1232 rmp->rmt_port = match->rmt_port;
1233 rmp->action_index = clib_host_to_net_u32 (rule->action_index);
1235 is_local ? SESSION_RULE_SCOPE_LOCAL : SESSION_RULE_SCOPE_GLOBAL;
1236 rmp->transport_proto = transport_proto;
1237 rmp->appns_index = clib_host_to_net_u32 (appns_index);
1240 clib_memcpy (rmp->tag, tag, vec_len (tag));
1241 rmp->tag[vec_len (tag)] = 0;
1244 vl_api_send_msg (reg, (u8 *) rmp);
1248 send_session_rule_details6 (mma_rule_40_t * rule, u8 is_local,
1249 u8 transport_proto, u32 appns_index, u8 * tag,
1250 vl_api_registration_t * reg, u32 context)
1252 vl_api_session_rules_details_t *rmp = 0;
1253 session_mask_or_match_6_t *match =
1254 (session_mask_or_match_6_t *) & rule->match;
1255 session_mask_or_match_6_t *mask =
1256 (session_mask_or_match_6_t *) & rule->mask;
1258 rmp = vl_msg_api_alloc (sizeof (*rmp));
1259 memset (rmp, 0, sizeof (*rmp));
1260 rmp->_vl_msg_id = ntohs (VL_API_SESSION_RULES_DETAILS);
1261 rmp->context = context;
1264 clib_memcpy (rmp->lcl_ip, &match->lcl_ip, sizeof (match->lcl_ip));
1265 clib_memcpy (rmp->rmt_ip, &match->rmt_ip, sizeof (match->rmt_ip));
1266 rmp->lcl_plen = ip6_mask_to_preflen (&mask->lcl_ip);
1267 rmp->rmt_plen = ip6_mask_to_preflen (&mask->rmt_ip);
1268 rmp->lcl_port = match->lcl_port;
1269 rmp->rmt_port = match->rmt_port;
1270 rmp->action_index = clib_host_to_net_u32 (rule->action_index);
1272 is_local ? SESSION_RULE_SCOPE_LOCAL : SESSION_RULE_SCOPE_GLOBAL;
1273 rmp->transport_proto = transport_proto;
1274 rmp->appns_index = clib_host_to_net_u32 (appns_index);
1277 clib_memcpy (rmp->tag, tag, vec_len (tag));
1278 rmp->tag[vec_len (tag)] = 0;
1281 vl_api_send_msg (reg, (u8 *) rmp);
1285 send_session_rules_table_details (session_rules_table_t * srt, u8 fib_proto,
1286 u8 tp, u8 is_local, u32 appns_index,
1287 vl_api_registration_t * reg, u32 context)
1289 mma_rule_16_t *rule16;
1290 mma_rule_40_t *rule40;
1291 mma_rules_table_16_t *srt16;
1292 mma_rules_table_40_t *srt40;
1295 if (is_local || fib_proto == FIB_PROTOCOL_IP4)
1299 srt16 = &srt->session_rules_tables_16;
1300 pool_foreach (rule16, srt16->rules, ({
1301 ri = mma_rules_table_rule_index_16 (srt16, rule16);
1302 tag = session_rules_table_rule_tag (srt, ri, 1);
1303 send_session_rule_details4 (rule16, is_local, tp, appns_index, tag,
1308 if (is_local || fib_proto == FIB_PROTOCOL_IP6)
1312 srt40 = &srt->session_rules_tables_40;
1313 pool_foreach (rule40, srt40->rules, ({
1314 ri = mma_rules_table_rule_index_40 (srt40, rule40);
1315 tag = session_rules_table_rule_tag (srt, ri, 1);
1316 send_session_rule_details6 (rule40, is_local, tp, appns_index, tag,
1324 vl_api_session_rules_dump_t_handler (vl_api_one_map_server_dump_t * mp)
1326 vl_api_registration_t *reg;
1327 session_table_t *st;
1330 reg = vl_api_client_index_to_registration (mp->client_index);
1335 session_table_foreach (st, ({
1336 for (tp = 0; tp < TRANSPORT_N_PROTO; tp++)
1338 send_session_rules_table_details (&st->session_rules[tp],
1339 st->active_fib_proto, tp,
1340 st->is_local, st->appns_index, reg,
1348 vl_api_application_tls_cert_add_t_handler (vl_api_application_tls_cert_add_t *
1351 vl_api_app_namespace_add_del_reply_t *rmp;
1352 vnet_app_add_tls_cert_args_t _a, *a = &_a;
1353 clib_error_t *error;
1357 if (!session_manager_is_enabled ())
1359 rv = VNET_API_ERROR_FEATURE_DISABLED;
1362 if (!(app = application_lookup (mp->client_index)))
1364 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
1367 memset (a, 0, sizeof (*a));
1368 a->app_index = app->index;
1369 cert_len = clib_net_to_host_u16 (mp->cert_len);
1370 if (cert_len > 10000)
1372 rv = VNET_API_ERROR_INVALID_VALUE;
1375 vec_validate (a->cert, cert_len);
1376 clib_memcpy (a->cert, mp->cert, cert_len);
1377 if ((error = vnet_app_add_tls_cert (a)))
1379 rv = clib_error_get_code (error);
1380 clib_error_report (error);
1384 REPLY_MACRO (VL_API_APPLICATION_TLS_CERT_ADD_REPLY);
1388 vl_api_application_tls_key_add_t_handler (vl_api_application_tls_key_add_t *
1391 vl_api_app_namespace_add_del_reply_t *rmp;
1392 vnet_app_add_tls_key_args_t _a, *a = &_a;
1393 clib_error_t *error;
1397 if (!session_manager_is_enabled ())
1399 rv = VNET_API_ERROR_FEATURE_DISABLED;
1402 if (!(app = application_lookup (mp->client_index)))
1404 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
1407 memset (a, 0, sizeof (*a));
1408 a->app_index = app->index;
1409 key_len = clib_net_to_host_u16 (mp->key_len);
1410 if (key_len > 10000)
1412 rv = VNET_API_ERROR_INVALID_VALUE;
1415 vec_validate (a->key, key_len);
1416 clib_memcpy (a->key, mp->key, key_len);
1417 if ((error = vnet_app_add_tls_key (a)))
1419 rv = clib_error_get_code (error);
1420 clib_error_report (error);
1424 REPLY_MACRO (VL_API_APPLICATION_TLS_KEY_ADD_REPLY);
1427 static clib_error_t *
1428 application_reaper_cb (u32 client_index)
1430 application_t *app = application_lookup (client_index);
1431 vnet_app_detach_args_t _a, *a = &_a;
1434 a->app_index = app->index;
1435 vnet_application_detach (a);
1440 VL_MSG_API_REAPER_FUNCTION (application_reaper_cb);
1442 #define vl_msg_name_crc_list
1443 #include <vnet/vnet_all_api_h.h>
1444 #undef vl_msg_name_crc_list
1447 setup_message_id_table (api_main_t * am)
1449 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
1450 foreach_vl_msg_name_crc_session;
1455 * session_api_hookup
1456 * Add uri's API message handlers to the table.
1457 * vlib has alread mapped shared memory and
1458 * added the client registration handlers.
1459 * See .../open-repo/vlib/memclnt_vlib.c:memclnt_process()
1461 static clib_error_t *
1462 session_api_hookup (vlib_main_t * vm)
1464 api_main_t *am = &api_main;
1467 vl_msg_api_set_handlers(VL_API_##N, #n, \
1468 vl_api_##n##_t_handler, \
1470 vl_api_##n##_t_endian, \
1471 vl_api_##n##_t_print, \
1472 sizeof(vl_api_##n##_t), 1);
1473 foreach_session_api_msg;
1477 * Messages which bounce off the data-plane to
1478 * an API client. Simply tells the message handling infra not
1479 * to free the message.
1481 * Bounced message handlers MUST NOT block the data plane
1483 am->message_bounce[VL_API_CONNECT_URI] = 1;
1484 am->message_bounce[VL_API_CONNECT_SOCK] = 1;
1487 * Set up the (msg_name, crc, message-id) table
1489 setup_message_id_table (am);
1494 VLIB_API_INIT_FUNCTION (session_api_hookup);
1497 * fd.io coding-style-patch-verification: ON
1500 * eval: (c-set-style "gnu")