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>
20 #include <vnet/vnet_msg_enum.h>
21 #include "application_interface.h"
23 #define vl_typedefs /* define message structures */
24 #include <vnet/vnet_all_api_h.h>
27 #define vl_endianfun /* define message structures */
28 #include <vnet/vnet_all_api_h.h>
31 /* instantiate all the print functions we know about */
32 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
34 #include <vnet/vnet_all_api_h.h>
37 #include <vlibapi/api_helper_macros.h>
39 #define foreach_session_api_msg \
40 _(MAP_ANOTHER_SEGMENT_REPLY, map_another_segment_reply) \
41 _(APPLICATION_ATTACH, application_attach) \
42 _(APPLICATION_DETACH, application_detach) \
43 _(BIND_URI, bind_uri) \
44 _(UNBIND_URI, unbind_uri) \
45 _(CONNECT_URI, connect_uri) \
46 _(DISCONNECT_SESSION, disconnect_session) \
47 _(DISCONNECT_SESSION_REPLY, disconnect_session_reply) \
48 _(ACCEPT_SESSION_REPLY, accept_session_reply) \
49 _(RESET_SESSION_REPLY, reset_session_reply) \
50 _(BIND_SOCK, bind_sock) \
51 _(UNBIND_SOCK, unbind_sock) \
52 _(CONNECT_SOCK, connect_sock) \
53 _(SESSION_ENABLE_DISABLE, session_enable_disable) \
54 _(APP_NAMESPACE_ADD_DEL, app_namespace_add_del) \
57 send_add_segment_callback (u32 api_client_index, const u8 * segment_name,
60 vl_api_map_another_segment_t *mp;
61 unix_shared_memory_queue_t *q;
63 q = vl_api_client_index_to_input_queue (api_client_index);
68 mp = vl_msg_api_alloc (sizeof (*mp));
69 memset (mp, 0, sizeof (*mp));
70 mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_MAP_ANOTHER_SEGMENT);
71 mp->segment_size = segment_size;
72 strncpy ((char *) mp->segment_name, (char *) segment_name,
73 sizeof (mp->segment_name) - 1);
75 vl_msg_api_send_shmem (q, (u8 *) & mp);
81 send_session_accept_callback (stream_session_t * s)
83 vl_api_accept_session_t *mp;
84 unix_shared_memory_queue_t *q, *vpp_queue;
85 application_t *server = application_get (s->app_index);
86 transport_connection_t *tc;
87 transport_proto_vft_t *tp_vft;
88 stream_session_t *listener;
90 q = vl_api_client_index_to_input_queue (server->api_client_index);
91 vpp_queue = session_manager_get_vpp_event_queue (s->thread_index);
96 mp = vl_msg_api_alloc (sizeof (*mp));
97 memset (mp, 0, sizeof (*mp));
99 mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_ACCEPT_SESSION);
100 mp->context = server->index;
101 listener = listen_session_get (s->session_type, s->listener_index);
102 tp_vft = transport_protocol_get_vft (s->session_type);
103 tc = tp_vft->get_connection (s->connection_index, s->thread_index);
104 mp->listener_handle = listen_session_get_handle (listener);
105 mp->handle = session_handle (s);
106 mp->server_rx_fifo = pointer_to_uword (s->server_rx_fifo);
107 mp->server_tx_fifo = pointer_to_uword (s->server_tx_fifo);
108 mp->vpp_event_queue_address = pointer_to_uword (vpp_queue);
109 mp->port = tc->rmt_port;
110 mp->is_ip4 = tc->is_ip4;
111 clib_memcpy (&mp->ip, &tc->rmt_ip, sizeof (tc->rmt_ip));
112 vl_msg_api_send_shmem (q, (u8 *) & mp);
118 send_session_disconnect_callback (stream_session_t * s)
120 vl_api_disconnect_session_t *mp;
121 unix_shared_memory_queue_t *q;
122 application_t *app = application_get (s->app_index);
124 q = vl_api_client_index_to_input_queue (app->api_client_index);
129 mp = vl_msg_api_alloc (sizeof (*mp));
130 memset (mp, 0, sizeof (*mp));
131 mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_DISCONNECT_SESSION);
132 mp->handle = session_handle (s);
133 vl_msg_api_send_shmem (q, (u8 *) & mp);
137 send_session_reset_callback (stream_session_t * s)
139 vl_api_reset_session_t *mp;
140 unix_shared_memory_queue_t *q;
141 application_t *app = application_get (s->app_index);
143 q = vl_api_client_index_to_input_queue (app->api_client_index);
148 mp = vl_msg_api_alloc (sizeof (*mp));
149 memset (mp, 0, sizeof (*mp));
150 mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_RESET_SESSION);
151 mp->handle = session_handle (s);
152 vl_msg_api_send_shmem (q, (u8 *) & mp);
156 send_session_connected_callback (u32 app_index, u32 api_context,
157 stream_session_t * s, u8 is_fail)
159 vl_api_connect_session_reply_t *mp;
160 unix_shared_memory_queue_t *q;
162 unix_shared_memory_queue_t *vpp_queue;
163 transport_connection_t *tc;
165 app = application_get (app_index);
166 q = vl_api_client_index_to_input_queue (app->api_client_index);
171 mp = vl_msg_api_alloc (sizeof (*mp));
172 mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_CONNECT_SESSION_REPLY);
173 mp->context = api_context;
178 tc = session_get_transport (s);
185 vpp_queue = session_manager_get_vpp_event_queue (s->thread_index);
186 mp->server_rx_fifo = pointer_to_uword (s->server_rx_fifo);
187 mp->server_tx_fifo = pointer_to_uword (s->server_tx_fifo);
188 mp->handle = session_handle (s);
189 mp->vpp_event_queue_address = pointer_to_uword (vpp_queue);
190 clib_memcpy (mp->lcl_ip, &tc->lcl_ip, sizeof (tc->lcl_ip));
191 mp->is_ip4 = tc->is_ip4;
192 mp->lcl_port = tc->lcl_port;
195 mp->retval = is_fail ?
196 clib_host_to_net_u32 (VNET_API_ERROR_SESSION_CONNECT) : 0;
197 vl_msg_api_send_shmem (q, (u8 *) & mp);
202 * Redirect a connect_uri message to the indicated server.
203 * Only sent if the server has bound the related port with
204 * URI_OPTIONS_FLAGS_USE_FIFO
207 redirect_connect_callback (u32 server_api_client_index, void *mp_arg)
209 vl_api_connect_sock_t *mp = mp_arg;
210 unix_shared_memory_queue_t *server_q, *client_q;
211 vlib_main_t *vm = vlib_get_main ();
212 f64 timeout = vlib_time_now (vm) + 0.5;
216 server_q = vl_api_client_index_to_input_queue (server_api_client_index);
220 rv = VNET_API_ERROR_INVALID_VALUE;
224 client_q = vl_api_client_index_to_input_queue (mp->client_index);
227 rv = VNET_API_ERROR_INVALID_VALUE_2;
231 /* Tell the server the client's API queue address, so it can reply */
232 mp->client_queue_address = pointer_to_uword (client_q);
233 app = application_lookup (mp->client_index);
236 clib_warning ("no client application");
240 mp->options[SESSION_OPTIONS_RX_FIFO_SIZE] = app->sm_properties.rx_fifo_size;
241 mp->options[SESSION_OPTIONS_TX_FIFO_SIZE] = app->sm_properties.tx_fifo_size;
244 * Bounce message handlers MUST NOT block the data-plane.
245 * Spin waiting for the queue lock, but
248 while (vlib_time_now (vm) < timeout)
251 unix_shared_memory_queue_add (server_q, (u8 *) & mp, 1 /*nowait */ );
254 /* correctly enqueued */
256 return VNET_API_ERROR_SESSION_REDIRECT;
258 /* continue spinning, wait for pthread_mutex_trylock to work */
262 /* queue stuffed, drop the msg */
264 rv = VNET_API_ERROR_QUEUE_FULL;
269 /* Dispose of the message */
270 vl_msg_api_free (mp);
274 static session_cb_vft_t session_cb_vft = {
275 .session_accept_callback = send_session_accept_callback,
276 .session_disconnect_callback = send_session_disconnect_callback,
277 .session_connected_callback = send_session_connected_callback,
278 .session_reset_callback = send_session_reset_callback,
279 .add_segment_callback = send_add_segment_callback,
280 .redirect_connect_callback = redirect_connect_callback
284 vl_api_session_enable_disable_t_handler (vl_api_session_enable_disable_t * mp)
286 vl_api_session_enable_disable_reply_t *rmp;
287 vlib_main_t *vm = vlib_get_main ();
290 vnet_session_enable_disable (vm, mp->is_enable);
291 REPLY_MACRO (VL_API_SESSION_ENABLE_DISABLE_REPLY);
295 vl_api_application_attach_t_handler (vl_api_application_attach_t * mp)
297 vl_api_application_attach_reply_t *rmp;
298 vnet_app_attach_args_t _a, *a = &_a;
299 clib_error_t *error = 0;
302 if (session_manager_is_enabled () == 0)
304 rv = VNET_API_ERROR_FEATURE_DISABLED;
308 STATIC_ASSERT (sizeof (u64) * SESSION_OPTIONS_N_OPTIONS <=
309 sizeof (mp->options),
310 "Out of options, fix api message definition");
312 memset (a, 0, sizeof (*a));
313 a->api_client_index = mp->client_index;
314 a->options = mp->options;
315 a->session_cb_vft = &session_cb_vft;
317 if (mp->namespace_id_len > 64)
319 rv = VNET_API_ERROR_INVALID_VALUE;
323 if (mp->namespace_id_len)
325 vec_validate (a->namespace_id, mp->namespace_id_len - 1);
326 clib_memcpy (a->namespace_id, mp->namespace_id, mp->namespace_id_len);
329 if ((error = vnet_application_attach (a)))
331 rv = clib_error_get_code (error);
332 clib_error_report (error);
334 vec_free (a->namespace_id);
339 REPLY_MACRO2 (VL_API_APPLICATION_ATTACH_REPLY, ({
342 rmp->segment_name_length = 0;
343 rmp->segment_size = a->segment_size;
344 if (a->segment_name_length)
346 memcpy (rmp->segment_name, a->segment_name,
347 a->segment_name_length);
348 rmp->segment_name_length = a->segment_name_length;
350 rmp->app_event_queue_address = a->app_event_queue_address;
357 vl_api_application_detach_t_handler (vl_api_application_detach_t * mp)
359 vl_api_application_detach_reply_t *rmp;
360 int rv = VNET_API_ERROR_INVALID_VALUE_2;
361 vnet_app_detach_args_t _a, *a = &_a;
364 if (session_manager_is_enabled () == 0)
366 rv = VNET_API_ERROR_FEATURE_DISABLED;
370 app = application_lookup (mp->client_index);
373 a->app_index = app->index;
374 rv = vnet_application_detach (a);
378 REPLY_MACRO (VL_API_APPLICATION_DETACH_REPLY);
382 vl_api_bind_uri_t_handler (vl_api_bind_uri_t * mp)
384 vl_api_bind_uri_reply_t *rmp;
385 vnet_bind_args_t _a, *a = &_a;
389 if (session_manager_is_enabled () == 0)
391 rv = VNET_API_ERROR_FEATURE_DISABLED;
395 app = application_lookup (mp->client_index);
398 memset (a, 0, sizeof (*a));
399 a->uri = (char *) mp->uri;
400 a->app_index = app->index;
401 rv = vnet_bind_uri (a);
405 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
409 REPLY_MACRO (VL_API_BIND_URI_REPLY);
413 vl_api_unbind_uri_t_handler (vl_api_unbind_uri_t * mp)
415 vl_api_unbind_uri_reply_t *rmp;
417 vnet_unbind_args_t _a, *a = &_a;
420 if (session_manager_is_enabled () == 0)
422 rv = VNET_API_ERROR_FEATURE_DISABLED;
426 app = application_lookup (mp->client_index);
429 a->uri = (char *) mp->uri;
430 a->app_index = app->index;
431 rv = vnet_unbind_uri (a);
435 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
439 REPLY_MACRO (VL_API_UNBIND_URI_REPLY);
443 vl_api_connect_uri_t_handler (vl_api_connect_uri_t * mp)
445 vl_api_connect_session_reply_t *rmp;
446 vnet_connect_args_t _a, *a = &_a;
448 clib_error_t *error = 0;
451 if (session_manager_is_enabled () == 0)
453 rv = VNET_API_ERROR_FEATURE_DISABLED;
457 app = application_lookup (mp->client_index);
460 a->uri = (char *) mp->uri;
461 a->api_context = mp->context;
462 a->app_index = app->index;
464 if ((error = vnet_connect_uri (a)))
466 rv = clib_error_get_code (error);
467 if (rv != VNET_API_ERROR_SESSION_REDIRECT)
468 clib_error_report (error);
473 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
477 * Don't reply to stream (tcp) connects. The reply will come once
478 * the connection is established. In case of the redirects, the reply
479 * will come from the server app.
481 if (rv == 0 || rv == VNET_API_ERROR_SESSION_REDIRECT)
486 REPLY_MACRO (VL_API_CONNECT_SESSION_REPLY);
491 vl_api_disconnect_session_t_handler (vl_api_disconnect_session_t * mp)
493 vl_api_disconnect_session_reply_t *rmp;
494 vnet_disconnect_args_t _a, *a = &_a;
498 if (session_manager_is_enabled () == 0)
500 rv = VNET_API_ERROR_FEATURE_DISABLED;
504 app = application_lookup (mp->client_index);
507 a->handle = mp->handle;
508 a->app_index = app->index;
509 rv = vnet_disconnect_session (a);
513 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
517 REPLY_MACRO (VL_API_DISCONNECT_SESSION_REPLY);
521 vl_api_disconnect_session_reply_t_handler (vl_api_disconnect_session_reply_t *
524 vnet_disconnect_args_t _a, *a = &_a;
527 /* Client objected to disconnecting the session, log and continue */
530 clib_warning ("client retval %d", mp->retval);
534 /* Disconnect has been confirmed. Confirm close to transport */
535 app = application_lookup (mp->client_index);
538 a->handle = mp->handle;
539 a->app_index = app->index;
540 vnet_disconnect_session (a);
545 vl_api_reset_session_reply_t_handler (vl_api_reset_session_reply_t * mp)
549 u32 index, thread_index;
551 app = application_lookup (mp->client_index);
555 session_parse_handle (mp->handle, &index, &thread_index);
556 s = session_get_if_valid (index, thread_index);
557 if (s == 0 || app->index != s->app_index)
559 clib_warning ("Invalid session!");
563 /* Client objected to resetting the session, log and continue */
566 clib_warning ("client retval %d", mp->retval);
570 /* This comes as a response to a reset, transport only waiting for
571 * confirmation to remove connection state, no need to disconnect */
572 stream_session_cleanup (s);
576 vl_api_accept_session_reply_t_handler (vl_api_accept_session_reply_t * mp)
579 u32 session_index, thread_index;
580 vnet_disconnect_args_t _a, *a = &_a;
582 /* Server isn't interested, kill the session */
585 a->app_index = mp->context;
586 a->handle = mp->handle;
587 vnet_disconnect_session (a);
591 session_parse_handle (mp->handle, &session_index, &thread_index);
592 s = session_get_if_valid (session_index, thread_index);
595 clib_warning ("session doesn't exist");
598 if (s->app_index != mp->context)
600 clib_warning ("app doesn't own session");
603 s->session_state = SESSION_STATE_READY;
608 vl_api_map_another_segment_reply_t_handler (vl_api_map_another_segment_reply_t
611 clib_warning ("not implemented");
615 vl_api_bind_sock_t_handler (vl_api_bind_sock_t * mp)
617 vl_api_bind_sock_reply_t *rmp;
618 vnet_bind_args_t _a, *a = &_a;
623 if (session_manager_is_enabled () == 0)
625 rv = VNET_API_ERROR_FEATURE_DISABLED;
629 app = application_lookup (mp->client_index);
632 ip46_address_t *ip46 = (ip46_address_t *) mp->ip;
633 memset (a, 0, sizeof (*a));
634 a->sep.is_ip4 = mp->is_ip4;
636 a->sep.port = mp->port;
637 a->sep.fib_index = mp->vrf;
638 a->sep.sw_if_index = ENDPOINT_INVALID_INDEX;
639 a->sep.transport_proto = mp->proto;
640 a->app_index = app->index;
642 if ((error = vnet_bind (a)))
644 rv = clib_error_get_code (error);
645 clib_error_report (error);
650 REPLY_MACRO2 (VL_API_BIND_SOCK_REPLY,({
652 rmp->handle = a->handle;
658 vl_api_unbind_sock_t_handler (vl_api_unbind_sock_t * mp)
660 vl_api_unbind_sock_reply_t *rmp;
661 vnet_unbind_args_t _a, *a = &_a;
666 if (session_manager_is_enabled () == 0)
668 rv = VNET_API_ERROR_FEATURE_DISABLED;
672 app = application_lookup (mp->client_index);
675 a->app_index = mp->client_index;
676 a->handle = mp->handle;
677 if ((error = vnet_unbind (a)))
679 rv = clib_error_get_code (error);
680 clib_error_report (error);
685 REPLY_MACRO (VL_API_UNBIND_SOCK_REPLY);
689 vl_api_connect_sock_t_handler (vl_api_connect_sock_t * mp)
691 vl_api_connect_session_reply_t *rmp;
692 vnet_connect_args_t _a, *a = &_a;
694 clib_error_t *error = 0;
697 if (session_manager_is_enabled () == 0)
699 rv = VNET_API_ERROR_FEATURE_DISABLED;
703 app = application_lookup (mp->client_index);
706 unix_shared_memory_queue_t *client_q;
707 ip46_address_t *ip46 = (ip46_address_t *) mp->ip;
709 client_q = vl_api_client_index_to_input_queue (mp->client_index);
710 mp->client_queue_address = pointer_to_uword (client_q);
711 a->sep.is_ip4 = mp->is_ip4;
713 a->sep.port = mp->port;
714 a->sep.transport_proto = mp->proto;
715 a->sep.fib_index = mp->vrf;
716 a->sep.sw_if_index = ENDPOINT_INVALID_INDEX;
717 a->api_context = mp->context;
718 a->app_index = app->index;
720 if ((error = vnet_connect (a)))
722 rv = clib_error_get_code (error);
723 if (rv != VNET_API_ERROR_SESSION_REDIRECT)
724 clib_error_report (error);
729 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
732 if (rv == 0 || rv == VNET_API_ERROR_SESSION_REDIRECT)
735 /* Got some error, relay it */
738 REPLY_MACRO (VL_API_CONNECT_SESSION_REPLY);
742 vl_api_app_namespace_add_del_t_handler (vl_api_app_namespace_add_del_t * mp)
744 vl_api_app_namespace_add_del_reply_t *rmp;
746 clib_error_t *error = 0;
748 if (!session_manager_is_enabled ())
750 rv = VNET_API_ERROR_FEATURE_DISABLED;
754 if (mp->namespace_id_len > ARRAY_LEN (mp->namespace_id))
756 rv = VNET_API_ERROR_INVALID_VALUE;
760 vec_validate (ns_id, mp->namespace_id_len - 1);
761 clib_memcpy (ns_id, mp->namespace_id, mp->namespace_id_len);
762 vnet_app_namespace_add_del_args_t args = {
764 .secret = clib_net_to_host_u64 (mp->secret),
765 .sw_if_index = clib_net_to_host_u32 (mp->sw_if_index),
766 .ip4_fib_id = clib_net_to_host_u32 (mp->ip4_fib_id),
767 .ip6_fib_id = clib_net_to_host_u32 (mp->ip6_fib_id),
770 error = vnet_app_namespace_add_del (&args);
773 rv = clib_error_get_code (error);
774 clib_error_report (error);
778 REPLY_MACRO (VL_API_APP_NAMESPACE_ADD_DEL_REPLY);
781 static clib_error_t *
782 application_reaper_cb (u32 client_index)
784 application_t *app = application_lookup (client_index);
785 vnet_app_detach_args_t _a, *a = &_a;
788 a->app_index = app->index;
789 vnet_application_detach (a);
794 VL_MSG_API_REAPER_FUNCTION (application_reaper_cb);
796 #define vl_msg_name_crc_list
797 #include <vnet/vnet_all_api_h.h>
798 #undef vl_msg_name_crc_list
801 setup_message_id_table (api_main_t * am)
803 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
804 foreach_vl_msg_name_crc_session;
810 * Add uri's API message handlers to the table.
811 * vlib has alread mapped shared memory and
812 * added the client registration handlers.
813 * See .../open-repo/vlib/memclnt_vlib.c:memclnt_process()
815 static clib_error_t *
816 session_api_hookup (vlib_main_t * vm)
818 api_main_t *am = &api_main;
821 vl_msg_api_set_handlers(VL_API_##N, #n, \
822 vl_api_##n##_t_handler, \
824 vl_api_##n##_t_endian, \
825 vl_api_##n##_t_print, \
826 sizeof(vl_api_##n##_t), 1);
827 foreach_session_api_msg;
831 * Messages which bounce off the data-plane to
832 * an API client. Simply tells the message handling infra not
833 * to free the message.
835 * Bounced message handlers MUST NOT block the data plane
837 am->message_bounce[VL_API_CONNECT_URI] = 1;
838 am->message_bounce[VL_API_CONNECT_SOCK] = 1;
841 * Set up the (msg_name, crc, message-id) table
843 setup_message_id_table (am);
848 VLIB_API_INIT_FUNCTION (session_api_hookup);
851 * fd.io coding-style-patch-verification: ON
854 * eval: (c-set-style "gnu")