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) \
56 send_add_segment_callback (u32 api_client_index, const u8 * segment_name,
59 vl_api_map_another_segment_t *mp;
60 unix_shared_memory_queue_t *q;
62 q = vl_api_client_index_to_input_queue (api_client_index);
67 mp = vl_msg_api_alloc (sizeof (*mp));
68 memset (mp, 0, sizeof (*mp));
69 mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_MAP_ANOTHER_SEGMENT);
70 mp->segment_size = segment_size;
71 strncpy ((char *) mp->segment_name, (char *) segment_name,
72 sizeof (mp->segment_name) - 1);
74 vl_msg_api_send_shmem (q, (u8 *) & mp);
80 send_session_accept_callback (stream_session_t * s)
82 vl_api_accept_session_t *mp;
83 unix_shared_memory_queue_t *q, *vpp_queue;
84 application_t *server = application_get (s->app_index);
85 transport_connection_t *tc;
86 transport_proto_vft_t *tp_vft;
87 stream_session_t *listener;
89 q = vl_api_client_index_to_input_queue (server->api_client_index);
90 vpp_queue = session_manager_get_vpp_event_queue (s->thread_index);
95 mp = vl_msg_api_alloc (sizeof (*mp));
96 memset (mp, 0, sizeof (*mp));
98 mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_ACCEPT_SESSION);
99 mp->context = server->index;
100 listener = listen_session_get (s->session_type, s->listener_index);
101 tp_vft = session_get_transport_vft (s->session_type);
102 tc = tp_vft->get_connection (s->connection_index, s->thread_index);
103 mp->listener_handle = listen_session_get_handle (listener);
104 mp->handle = stream_session_handle (s);
105 mp->server_rx_fifo = pointer_to_uword (s->server_rx_fifo);
106 mp->server_tx_fifo = pointer_to_uword (s->server_tx_fifo);
107 mp->vpp_event_queue_address = pointer_to_uword (vpp_queue);
108 mp->port = tc->rmt_port;
109 mp->is_ip4 = tc->is_ip4;
110 clib_memcpy (&mp->ip, &tc->rmt_ip, sizeof (tc->rmt_ip));
111 vl_msg_api_send_shmem (q, (u8 *) & mp);
117 send_session_disconnect_callback (stream_session_t * s)
119 vl_api_disconnect_session_t *mp;
120 unix_shared_memory_queue_t *q;
121 application_t *app = application_get (s->app_index);
123 q = vl_api_client_index_to_input_queue (app->api_client_index);
128 mp = vl_msg_api_alloc (sizeof (*mp));
129 memset (mp, 0, sizeof (*mp));
130 mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_DISCONNECT_SESSION);
131 mp->handle = stream_session_handle (s);
132 vl_msg_api_send_shmem (q, (u8 *) & mp);
136 send_session_reset_callback (stream_session_t * s)
138 vl_api_reset_session_t *mp;
139 unix_shared_memory_queue_t *q;
140 application_t *app = application_get (s->app_index);
142 q = vl_api_client_index_to_input_queue (app->api_client_index);
147 mp = vl_msg_api_alloc (sizeof (*mp));
148 memset (mp, 0, sizeof (*mp));
149 mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_RESET_SESSION);
150 mp->handle = stream_session_handle (s);
151 vl_msg_api_send_shmem (q, (u8 *) & mp);
155 send_session_connected_callback (u32 app_index, u32 api_context,
156 stream_session_t * s, u8 is_fail)
158 vl_api_connect_session_reply_t *mp;
159 unix_shared_memory_queue_t *q;
161 unix_shared_memory_queue_t *vpp_queue;
163 app = application_get (app_index);
164 q = vl_api_client_index_to_input_queue (app->api_client_index);
169 mp = vl_msg_api_alloc (sizeof (*mp));
170 mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_CONNECT_SESSION_REPLY);
171 mp->context = api_context;
174 vpp_queue = session_manager_get_vpp_event_queue (s->thread_index);
175 mp->server_rx_fifo = pointer_to_uword (s->server_rx_fifo);
176 mp->server_tx_fifo = pointer_to_uword (s->server_tx_fifo);
177 mp->handle = stream_session_handle (s);
178 mp->vpp_event_queue_address = pointer_to_uword (vpp_queue);
183 mp->retval = clib_host_to_net_u32 (VNET_API_ERROR_SESSION_CONNECT_FAIL);
186 vl_msg_api_send_shmem (q, (u8 *) & mp);
191 * Redirect a connect_uri message to the indicated server.
192 * Only sent if the server has bound the related port with
193 * URI_OPTIONS_FLAGS_USE_FIFO
196 redirect_connect_callback (u32 server_api_client_index, void *mp_arg)
198 vl_api_connect_uri_t *mp = mp_arg;
199 unix_shared_memory_queue_t *server_q, *client_q;
200 vlib_main_t *vm = vlib_get_main ();
201 f64 timeout = vlib_time_now (vm) + 0.5;
205 server_q = vl_api_client_index_to_input_queue (server_api_client_index);
209 rv = VNET_API_ERROR_INVALID_VALUE;
213 client_q = vl_api_client_index_to_input_queue (mp->client_index);
216 rv = VNET_API_ERROR_INVALID_VALUE_2;
220 /* Tell the server the client's API queue address, so it can reply */
221 mp->client_queue_address = pointer_to_uword (client_q);
222 app = application_lookup (mp->client_index);
225 clib_warning ("no client application");
229 mp->options[SESSION_OPTIONS_RX_FIFO_SIZE] = app->sm_properties.rx_fifo_size;
230 mp->options[SESSION_OPTIONS_TX_FIFO_SIZE] = app->sm_properties.tx_fifo_size;
233 * Bounce message handlers MUST NOT block the data-plane.
234 * Spin waiting for the queue lock, but
237 while (vlib_time_now (vm) < timeout)
240 unix_shared_memory_queue_add (server_q, (u8 *) & mp, 1 /*nowait */ );
243 /* correctly enqueued */
245 return VNET_CONNECT_REDIRECTED;
247 /* continue spinning, wait for pthread_mutex_trylock to work */
251 /* queue stuffed, drop the msg */
253 rv = VNET_API_ERROR_QUEUE_FULL;
258 /* Dispose of the message */
259 vl_msg_api_free (mp);
263 static session_cb_vft_t uri_session_cb_vft = {
264 .session_accept_callback = send_session_accept_callback,
265 .session_disconnect_callback = send_session_disconnect_callback,
266 .session_connected_callback = send_session_connected_callback,
267 .session_reset_callback = send_session_reset_callback,
268 .add_segment_callback = send_add_segment_callback,
269 .redirect_connect_callback = redirect_connect_callback
273 vl_api_session_enable_disable_t_handler (vl_api_session_enable_disable_t * mp)
275 vl_api_session_enable_disable_reply_t *rmp;
276 vlib_main_t *vm = vlib_get_main ();
279 vnet_session_enable_disable (vm, mp->is_enable);
280 REPLY_MACRO (VL_API_SESSION_ENABLE_DISABLE_REPLY);
284 vl_api_application_attach_t_handler (vl_api_application_attach_t * mp)
286 vl_api_application_attach_reply_t *rmp;
287 vnet_app_attach_args_t _a, *a = &_a;
290 if (session_manager_is_enabled () == 0)
292 rv = VNET_API_ERROR_FEATURE_DISABLED;
296 STATIC_ASSERT (sizeof (u64) * SESSION_OPTIONS_N_OPTIONS <=
297 sizeof (mp->options),
298 "Out of options, fix api message definition");
300 memset (a, 0, sizeof (*a));
302 a->api_client_index = mp->client_index;
303 a->options = mp->options;
304 a->session_cb_vft = &uri_session_cb_vft;
306 rv = vnet_application_attach (a);
311 REPLY_MACRO2 (VL_API_APPLICATION_ATTACH_REPLY, ({
314 rmp->segment_name_length = 0;
316 rmp->segment_size = a->segment_size;
317 if (a->segment_name_length)
319 memcpy (rmp->segment_name, a->segment_name,
320 a->segment_name_length);
321 rmp->segment_name_length = a->segment_name_length;
323 rmp->app_event_queue_address = a->app_event_queue_address;
330 vl_api_application_detach_t_handler (vl_api_application_detach_t * mp)
332 vl_api_application_detach_reply_t *rmp;
333 int rv = VNET_API_ERROR_INVALID_VALUE_2;
334 vnet_app_detach_args_t _a, *a = &_a;
337 if (session_manager_is_enabled () == 0)
339 rv = VNET_API_ERROR_FEATURE_DISABLED;
343 app = application_lookup (mp->client_index);
346 a->app_index = app->index;
347 rv = vnet_application_detach (a);
351 REPLY_MACRO (VL_API_APPLICATION_DETACH_REPLY);
355 vl_api_bind_uri_t_handler (vl_api_bind_uri_t * mp)
357 vl_api_bind_uri_reply_t *rmp;
358 vnet_bind_args_t _a, *a = &_a;
362 if (session_manager_is_enabled () == 0)
364 rv = VNET_API_ERROR_FEATURE_DISABLED;
368 app = application_lookup (mp->client_index);
371 memset (a, 0, sizeof (*a));
372 a->uri = (char *) mp->uri;
373 a->app_index = app->index;
374 rv = vnet_bind_uri (a);
378 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
382 REPLY_MACRO (VL_API_BIND_URI_REPLY);
386 vl_api_unbind_uri_t_handler (vl_api_unbind_uri_t * mp)
388 vl_api_unbind_uri_reply_t *rmp;
390 vnet_unbind_args_t _a, *a = &_a;
393 if (session_manager_is_enabled () == 0)
395 rv = VNET_API_ERROR_FEATURE_DISABLED;
399 app = application_lookup (mp->client_index);
402 a->uri = (char *) mp->uri;
403 a->app_index = app->index;
404 rv = vnet_unbind_uri (a);
408 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
412 REPLY_MACRO (VL_API_UNBIND_URI_REPLY);
416 vl_api_connect_uri_t_handler (vl_api_connect_uri_t * mp)
418 vl_api_connect_session_reply_t *rmp;
419 vnet_connect_args_t _a, *a = &_a;
423 if (session_manager_is_enabled () == 0)
425 rv = VNET_API_ERROR_FEATURE_DISABLED;
429 app = application_lookup (mp->client_index);
432 a->uri = (char *) mp->uri;
433 a->api_context = mp->context;
434 a->app_index = app->index;
436 rv = vnet_connect_uri (a);
440 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
443 if (rv == 0 || rv == VNET_CONNECT_REDIRECTED)
446 /* Got some error, relay it */
450 REPLY_MACRO (VL_API_CONNECT_SESSION_REPLY);
455 vl_api_disconnect_session_t_handler (vl_api_disconnect_session_t * mp)
457 vl_api_disconnect_session_reply_t *rmp;
458 vnet_disconnect_args_t _a, *a = &_a;
462 if (session_manager_is_enabled () == 0)
464 rv = VNET_API_ERROR_FEATURE_DISABLED;
468 app = application_lookup (mp->client_index);
471 a->handle = mp->handle;
472 a->app_index = app->index;
473 rv = vnet_disconnect_session (a);
477 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
481 REPLY_MACRO (VL_API_DISCONNECT_SESSION_REPLY);
485 vl_api_disconnect_session_reply_t_handler (vl_api_disconnect_session_reply_t *
488 vnet_disconnect_args_t _a, *a = &_a;
491 /* Client objected to disconnecting the session, log and continue */
494 clib_warning ("client retval %d", mp->retval);
498 /* Disconnect has been confirmed. Confirm close to transport */
499 app = application_lookup (mp->client_index);
502 a->handle = mp->handle;
503 a->app_index = app->index;
504 vnet_disconnect_session (a);
509 vl_api_reset_session_reply_t_handler (vl_api_reset_session_reply_t * mp)
513 u32 index, thread_index;
515 app = application_lookup (mp->client_index);
519 stream_session_parse_handle (mp->handle, &index, &thread_index);
520 s = stream_session_get_if_valid (index, thread_index);
521 if (s == 0 || app->index != s->app_index)
523 clib_warning ("Invalid session!");
527 /* Client objected to resetting the session, log and continue */
530 clib_warning ("client retval %d", mp->retval);
534 /* This comes as a response to a reset, transport only waiting for
535 * confirmation to remove connection state, no need to disconnect */
536 stream_session_cleanup (s);
540 vl_api_accept_session_reply_t_handler (vl_api_accept_session_reply_t * mp)
543 u32 session_index, thread_index;
544 vnet_disconnect_args_t _a, *a = &_a;
546 /* Server isn't interested, kill the session */
549 a->app_index = mp->context;
550 a->handle = mp->handle;
551 vnet_disconnect_session (a);
555 stream_session_parse_handle (mp->handle, &session_index, &thread_index);
556 s = stream_session_get_if_valid (session_index, thread_index);
559 clib_warning ("session doesn't exist");
562 if (s->app_index != mp->context)
564 clib_warning ("app doesn't own session");
568 s->session_state = SESSION_STATE_READY;
573 vl_api_map_another_segment_reply_t_handler (vl_api_map_another_segment_reply_t
576 clib_warning ("not implemented");
580 vl_api_bind_sock_t_handler (vl_api_bind_sock_t * mp)
582 vl_api_bind_sock_reply_t *rmp;
583 vnet_bind_args_t _a, *a = &_a;
584 int rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
587 if (session_manager_is_enabled () == 0)
589 rv = VNET_API_ERROR_FEATURE_DISABLED;
593 app = application_lookup (mp->client_index);
596 ip46_address_t *ip46 = (ip46_address_t *) mp->ip;
598 memset (a, 0, sizeof (*a));
599 a->tep.is_ip4 = mp->is_ip4;
601 a->tep.port = mp->port;
602 a->tep.vrf = mp->vrf;
603 a->app_index = app->index;
608 REPLY_MACRO (VL_API_BIND_SOCK_REPLY);
612 vl_api_unbind_sock_t_handler (vl_api_unbind_sock_t * mp)
614 vl_api_unbind_sock_reply_t *rmp;
615 vnet_unbind_args_t _a, *a = &_a;
617 int rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
619 if (session_manager_is_enabled () == 0)
621 rv = VNET_API_ERROR_FEATURE_DISABLED;
625 app = application_lookup (mp->client_index);
628 a->app_index = mp->client_index;
629 a->handle = mp->handle;
630 rv = vnet_unbind (a);
634 REPLY_MACRO (VL_API_UNBIND_SOCK_REPLY);
638 vl_api_connect_sock_t_handler (vl_api_connect_sock_t * mp)
640 vl_api_connect_session_reply_t *rmp;
641 vnet_connect_args_t _a, *a = &_a;
645 if (session_manager_is_enabled () == 0)
647 rv = VNET_API_ERROR_FEATURE_DISABLED;
651 app = application_lookup (mp->client_index);
654 unix_shared_memory_queue_t *client_q;
655 ip46_address_t *ip46 = (ip46_address_t *) mp->ip;
657 client_q = vl_api_client_index_to_input_queue (mp->client_index);
658 mp->client_queue_address = pointer_to_uword (client_q);
659 a->tep.is_ip4 = mp->is_ip4;
661 a->tep.port = mp->port;
662 a->tep.vrf = mp->vrf;
663 a->api_context = mp->context;
664 a->app_index = app->index;
665 a->proto = mp->proto;
667 rv = vnet_connect (a);
671 rv = VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
674 if (rv == 0 || rv == VNET_CONNECT_REDIRECTED)
677 /* Got some error, relay it */
680 REPLY_MACRO (VL_API_CONNECT_SESSION_REPLY);
683 static clib_error_t *
684 application_reaper_cb (u32 client_index)
686 application_t *app = application_lookup (client_index);
687 vnet_app_detach_args_t _a, *a = &_a;
690 a->app_index = app->index;
691 vnet_application_detach (a);
696 VL_MSG_API_REAPER_FUNCTION (application_reaper_cb);
698 #define vl_msg_name_crc_list
699 #include <vnet/vnet_all_api_h.h>
700 #undef vl_msg_name_crc_list
703 setup_message_id_table (api_main_t * am)
705 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
706 foreach_vl_msg_name_crc_session;
712 * Add uri's API message handlers to the table.
713 * vlib has alread mapped shared memory and
714 * added the client registration handlers.
715 * See .../open-repo/vlib/memclnt_vlib.c:memclnt_process()
717 static clib_error_t *
718 session_api_hookup (vlib_main_t * vm)
720 api_main_t *am = &api_main;
723 vl_msg_api_set_handlers(VL_API_##N, #n, \
724 vl_api_##n##_t_handler, \
726 vl_api_##n##_t_endian, \
727 vl_api_##n##_t_print, \
728 sizeof(vl_api_##n##_t), 1);
729 foreach_session_api_msg;
733 * Messages which bounce off the data-plane to
734 * an API client. Simply tells the message handling infra not
735 * to free the message.
737 * Bounced message handlers MUST NOT block the data plane
739 am->message_bounce[VL_API_CONNECT_URI] = 1;
740 am->message_bounce[VL_API_CONNECT_SOCK] = 1;
743 * Set up the (msg_name, crc, message-id) table
745 setup_message_id_table (am);
750 VLIB_API_INIT_FUNCTION (session_api_hookup);
753 * fd.io coding-style-patch-verification: ON
756 * eval: (c-set-style "gnu")