2 * Copyright (c) 2017 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (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.
19 #include <svm/svm_fifo_segment.h>
20 #include <vlibmemory/api.h>
21 #include <vpp/api/vpe_msg_enum.h>
22 #include <vnet/session/application_interface.h>
23 #include <vcl/vppcom.h>
24 #include <vlib/unix/unix.h>
25 #include <vppinfra/vec_bootstrap.h>
27 #define vl_typedefs /* define message structures */
28 #include <vpp/api/vpe_all_api_h.h>
31 /* declare message handlers for each api */
33 #define vl_endianfun /* define message structures */
34 #include <vpp/api/vpe_all_api_h.h>
37 /* instantiate all the print functions we know about */
38 #define vl_print(handle, ...)
40 #include <vpp/api/vpe_all_api_h.h>
44 /* Set VPPCOM_DEBUG_INIT 2 for connection debug,
45 * 3 for read/write debug output
47 * export VCL_DEBUG=<#> to set dynamically.
49 #define VPPCOM_DEBUG_INIT 1
51 #define VPPCOM_DEBUG_INIT 0
54 #define VPPCOM_DEBUG vcm->debug
57 * VPPCOM Private definitions and functions.
77 typedef struct epoll_event vppcom_epoll_event_t;
84 vppcom_epoll_event_t ev;
85 #define VEP_DEFAULT_ET_MASK (EPOLLIN|EPOLLOUT)
86 #define VEP_UNSUPPORTED_EVENTS (EPOLLONESHOT|EPOLLEXCLUSIVE)
98 volatile session_state_t state;
100 svm_fifo_t *server_rx_fifo;
101 svm_fifo_t *server_tx_fifo;
106 unix_shared_memory_queue_t *vpp_event_queue;
108 /* Socket configuration state */
109 /* TBD: covert 'is_*' vars to bit in u8 flags; */
119 vppcom_ip46_t lcl_addr;
120 vppcom_ip46_t peer_addr;
121 u16 lcl_port; // network order
122 u16 peer_port; // network order
124 u64 client_queue_address;
128 typedef struct vppcom_cfg_t_
133 u32 add_segment_size;
134 u32 preallocated_fifo_pairs;
137 u32 event_queue_size;
138 u32 listen_queue_size;
139 u8 app_proxy_transport_tcp;
140 u8 app_proxy_transport_udp;
144 u64 namespace_secret;
150 typedef struct vppcom_main_t_
154 u32 *client_session_index_fifo;
155 volatile u32 bind_session_index;
158 /* vpe input queue */
159 unix_shared_memory_queue_t *vl_input_queue;
161 /* API client handle */
165 clib_spinlock_t sessions_lockp;
168 /* Hash table for disconnect processing */
169 uword *session_index_by_vpp_handles;
172 clib_bitmap_t *rd_bitmap;
173 clib_bitmap_t *wr_bitmap;
174 clib_bitmap_t *ex_bitmap;
176 /* Our event queue */
177 unix_shared_memory_queue_t *app_event_queue;
179 /* unique segment name counter */
180 u32 unique_segment_index;
182 /* For deadman timers */
183 clib_time_t clib_time;
185 /* State of the connection, shared between msg RX thread and main thread */
186 volatile app_state_t app_state;
190 /* VNET_API_ERROR_FOO -> "Foo" hash table */
191 uword *error_string_by_error_number;
194 /* NOTE: _vppcom_main is only used until the heap is allocated.
195 * Do not access it directly -- use vcm which will point to
196 * the heap allocated copy after init.
198 static vppcom_main_t _vppcom_main = {
199 .debug = VPPCOM_DEBUG_INIT,
200 .my_client_index = ~0
203 static vppcom_main_t *vcm = &_vppcom_main;
205 #define VCL_LOCK_AND_GET_SESSION(I, S) \
207 clib_spinlock_lock (&vcm->sessions_lockp); \
208 rv = vppcom_session_at_index (I, S); \
209 if (PREDICT_FALSE (rv)) \
211 clib_spinlock_unlock (&vcm->sessions_lockp); \
213 if (VPPCOM_DEBUG > 0) \
214 clib_warning ("[%s] ERROR: Invalid ##I (%u)!", \
222 vppcom_app_state_str (app_state_t state)
228 case STATE_APP_START:
229 st = "STATE_APP_START";
232 case STATE_APP_CONN_VPP:
233 st = "STATE_APP_CONN_VPP";
236 case STATE_APP_ENABLED:
237 st = "STATE_APP_ENABLED";
240 case STATE_APP_ATTACHED:
241 st = "STATE_APP_ATTACHED";
245 st = "UNKNOWN_APP_STATE";
253 vppcom_session_state_str (session_state_t state)
264 st = "STATE_CONNECT";
275 case STATE_DISCONNECT:
276 st = "STATE_DISCONNECT";
284 st = "UNKNOWN_STATE";
292 * VPPCOM Utility Functions
295 vppcom_session_at_index (u32 session_index, session_t * volatile *sess)
297 /* Assumes that caller has acquired spinlock: vcm->sessions_lockp */
298 if (PREDICT_FALSE ((session_index == ~0) ||
299 pool_is_free_index (vcm->sessions, session_index)))
301 clib_warning ("[%d] invalid session, sid (%u) has been closed!",
302 getpid (), session_index);
303 return VPPCOM_EBADFD;
305 *sess = pool_elt_at_index (vcm->sessions, session_index);
310 vppcom_connect_to_vpp (char *app_name)
312 api_main_t *am = &api_main;
314 if (VPPCOM_DEBUG > 0)
315 printf ("\nConnecting to VPP api...");
316 if (vl_client_connect_to_vlib ("/vpe-api", app_name, 32) < 0)
318 clib_warning ("[%d] connect to vpp (%s) failed!", getpid (), app_name);
319 return VPPCOM_ECONNREFUSED;
322 vcm->vl_input_queue = am->shmem_hdr->vl_input_queue;
323 vcm->my_client_index = am->my_client_index;
324 if (VPPCOM_DEBUG > 0)
325 printf (" connected!\n");
327 vcm->app_state = STATE_APP_CONN_VPP;
332 format_api_error (u8 * s, va_list * args)
334 i32 error = va_arg (*args, u32);
337 p = hash_get (vcm->error_string_by_error_number, -error);
340 s = format (s, "%s (%d)", p[0], error);
342 s = format (s, "%d", error);
347 vppcom_init_error_string_table (void)
349 vcm->error_string_by_error_number = hash_create (0, sizeof (uword));
351 #define _(n,v,s) hash_set (vcm->error_string_by_error_number, -v, s);
352 foreach_vnet_api_error;
355 hash_set (vcm->error_string_by_error_number, 99, "Misc");
359 vppcom_wait_for_app_state_change (app_state_t app_state)
361 f64 timeout = clib_time_now (&vcm->clib_time) + vcm->cfg.app_timeout;
363 while (clib_time_now (&vcm->clib_time) < timeout)
365 if (vcm->app_state == app_state)
368 if (VPPCOM_DEBUG > 0)
369 clib_warning ("[%d] timeout waiting for state %s (%d)", getpid (),
370 vppcom_app_state_str (app_state), app_state);
371 return VPPCOM_ETIMEDOUT;
375 vppcom_wait_for_session_state_change (u32 session_index,
376 session_state_t state,
379 f64 timeout = clib_time_now (&vcm->clib_time) + wait_for_time;
380 session_t *volatile session;
385 clib_spinlock_lock (&vcm->sessions_lockp);
386 rv = vppcom_session_at_index (session_index, &session);
387 if (PREDICT_FALSE (rv))
389 clib_spinlock_unlock (&vcm->sessions_lockp);
392 if (session->state == state)
394 clib_spinlock_unlock (&vcm->sessions_lockp);
397 clib_spinlock_unlock (&vcm->sessions_lockp);
399 while (clib_time_now (&vcm->clib_time) < timeout);
401 if (VPPCOM_DEBUG > 0)
402 clib_warning ("[%d] timeout waiting for state %s (%d)", getpid (),
403 vppcom_session_state_str (state), state);
404 return VPPCOM_ETIMEDOUT;
408 vppcom_wait_for_client_session_index (f64 wait_for_time)
410 f64 timeout = clib_time_now (&vcm->clib_time) + wait_for_time;
414 if (clib_fifo_elts (vcm->client_session_index_fifo))
417 while (clib_time_now (&vcm->clib_time) < timeout);
419 if (wait_for_time == 0)
420 return VPPCOM_EAGAIN;
422 if (VPPCOM_DEBUG > 0)
423 clib_warning ("[%d] timeout waiting for client_session_index", getpid ());
424 return VPPCOM_ETIMEDOUT;
428 * VPP-API message functions
431 vppcom_send_session_enable_disable (u8 is_enable)
433 vl_api_session_enable_disable_t *bmp;
434 bmp = vl_msg_api_alloc (sizeof (*bmp));
435 memset (bmp, 0, sizeof (*bmp));
437 bmp->_vl_msg_id = ntohs (VL_API_SESSION_ENABLE_DISABLE);
438 bmp->client_index = vcm->my_client_index;
439 bmp->context = htonl (0xfeedface);
440 bmp->is_enable = is_enable;
441 vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & bmp);
445 vppcom_app_session_enable (void)
449 if (vcm->app_state != STATE_APP_ENABLED)
451 vppcom_send_session_enable_disable (1 /* is_enabled == TRUE */ );
452 rv = vppcom_wait_for_app_state_change (STATE_APP_ENABLED);
453 if (PREDICT_FALSE (rv))
455 if (VPPCOM_DEBUG > 0)
456 clib_warning ("[%d] Session enable timed out, rv = %s (%d)",
457 getpid (), vppcom_retval_str (rv), rv);
465 vl_api_session_enable_disable_reply_t_handler
466 (vl_api_session_enable_disable_reply_t * mp)
470 clib_warning ("[%d] session_enable_disable failed: %U", getpid (),
471 format_api_error, ntohl (mp->retval));
474 vcm->app_state = STATE_APP_ENABLED;
478 vppcom_app_send_attach (void)
480 vl_api_application_attach_t *bmp;
481 u8 nsid_len = vec_len (vcm->cfg.namespace_id);
482 u8 app_is_proxy = (vcm->cfg.app_proxy_transport_tcp ||
483 vcm->cfg.app_proxy_transport_udp);
485 bmp = vl_msg_api_alloc (sizeof (*bmp));
486 memset (bmp, 0, sizeof (*bmp));
488 bmp->_vl_msg_id = ntohs (VL_API_APPLICATION_ATTACH);
489 bmp->client_index = vcm->my_client_index;
490 bmp->context = htonl (0xfeedface);
491 bmp->options[APP_OPTIONS_FLAGS] =
492 APP_OPTIONS_FLAGS_ACCEPT_REDIRECT | APP_OPTIONS_FLAGS_ADD_SEGMENT |
493 (vcm->cfg.app_scope_local ? APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE : 0) |
494 (vcm->cfg.app_scope_global ? APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE : 0) |
495 (app_is_proxy ? APP_OPTIONS_FLAGS_IS_PROXY : 0);
496 bmp->options[APP_OPTIONS_PROXY_TRANSPORT] =
497 (vcm->cfg.app_proxy_transport_tcp ? 1 << TRANSPORT_PROTO_TCP : 0) |
498 (vcm->cfg.app_proxy_transport_udp ? 1 << TRANSPORT_PROTO_UDP : 0);
499 bmp->options[SESSION_OPTIONS_SEGMENT_SIZE] = vcm->cfg.segment_size;
500 bmp->options[SESSION_OPTIONS_ADD_SEGMENT_SIZE] = vcm->cfg.add_segment_size;
501 bmp->options[SESSION_OPTIONS_RX_FIFO_SIZE] = vcm->cfg.rx_fifo_size;
502 bmp->options[SESSION_OPTIONS_TX_FIFO_SIZE] = vcm->cfg.tx_fifo_size;
505 bmp->namespace_id_len = nsid_len;
506 clib_memcpy (bmp->namespace_id, vcm->cfg.namespace_id, nsid_len);
507 bmp->options[APP_OPTIONS_NAMESPACE_SECRET] = vcm->cfg.namespace_secret;
509 vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & bmp);
513 vppcom_app_attach (void)
517 vppcom_app_send_attach ();
518 rv = vppcom_wait_for_app_state_change (STATE_APP_ATTACHED);
519 if (PREDICT_FALSE (rv))
521 if (VPPCOM_DEBUG > 0)
522 clib_warning ("[%d] application attach timed out, rv = %s (%d)",
523 getpid (), vppcom_retval_str (rv), rv);
530 vppcom_app_detach (void)
532 vl_api_application_detach_t *bmp;
533 bmp = vl_msg_api_alloc (sizeof (*bmp));
534 memset (bmp, 0, sizeof (*bmp));
536 bmp->_vl_msg_id = ntohs (VL_API_APPLICATION_DETACH);
537 bmp->client_index = vcm->my_client_index;
538 bmp->context = htonl (0xfeedface);
539 vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & bmp);
543 vl_api_application_attach_reply_t_handler (vl_api_application_attach_reply_t *
546 static svm_fifo_segment_create_args_t _a;
547 svm_fifo_segment_create_args_t *a = &_a;
550 memset (a, 0, sizeof (*a));
553 clib_warning ("[%d] attach failed: %U", getpid (),
554 format_api_error, ntohl (mp->retval));
558 if (mp->segment_name_length == 0)
560 clib_warning ("[%d] segment_name_length zero", getpid ());
564 a->segment_name = (char *) mp->segment_name;
565 a->segment_size = mp->segment_size;
567 ASSERT (mp->app_event_queue_address);
569 /* Attach to the segment vpp created */
570 rv = svm_fifo_segment_attach (a);
571 vec_reset_length (a->new_segment_indices);
572 if (PREDICT_FALSE (rv))
574 clib_warning ("[%d] svm_fifo_segment_attach ('%s') failed", getpid (),
579 vcm->app_event_queue =
580 uword_to_pointer (mp->app_event_queue_address,
581 unix_shared_memory_queue_t *);
583 vcm->app_state = STATE_APP_ATTACHED;
587 vl_api_application_detach_reply_t_handler (vl_api_application_detach_reply_t *
591 clib_warning ("[%d] detach failed: %U", getpid (), format_api_error,
594 vcm->app_state = STATE_APP_ENABLED;
598 vl_api_disconnect_session_reply_t_handler (vl_api_disconnect_session_reply_t *
602 u32 session_index = ~0;
604 p = hash_get (vcm->session_index_by_vpp_handles, mp->handle);
607 session_t *session = 0;
610 session_index = p[0];
611 hash_unset (vcm->session_index_by_vpp_handles, mp->handle);
612 clib_spinlock_lock (&vcm->sessions_lockp);
613 rv = vppcom_session_at_index (session_index, &session);
614 if (PREDICT_FALSE (rv))
616 if (VPPCOM_DEBUG > 1)
617 clib_warning ("[%d] invalid session, sid %u has been closed!",
618 getpid (), session_index);
622 if (VPPCOM_DEBUG > 1)
623 clib_warning ("[%d] vpp handle 0x%llx, sid %u disconnected!",
624 getpid (), mp->handle, session_index);
626 session->state = STATE_DISCONNECT;
628 clib_spinlock_unlock (&vcm->sessions_lockp);
632 if (VPPCOM_DEBUG > 1)
633 clib_warning ("[%d] couldn't find session: unknown vpp handle 0x%llx",
634 getpid (), mp->handle);
638 clib_warning ("[%d] disconnect_session vpp handle 0x%llx, sid %u "
639 "failed: %U", getpid (), mp->handle, session_index,
640 format_api_error, ntohl (mp->retval));
644 vl_api_map_another_segment_t_handler (vl_api_map_another_segment_t * mp)
646 static svm_fifo_segment_create_args_t _a;
647 svm_fifo_segment_create_args_t *a = &_a;
650 memset (a, 0, sizeof (*a));
651 a->segment_name = (char *) mp->segment_name;
652 a->segment_size = mp->segment_size;
653 /* Attach to the segment vpp created */
654 rv = svm_fifo_segment_attach (a);
655 vec_reset_length (a->new_segment_indices);
656 if (PREDICT_FALSE (rv))
658 clib_warning ("[%d] svm_fifo_segment_attach ('%s') failed",
659 getpid (), mp->segment_name);
662 if (VPPCOM_DEBUG > 1)
663 clib_warning ("[%d] mapped new segment '%s' size %d", getpid (),
664 mp->segment_name, mp->segment_size);
668 vl_api_disconnect_session_t_handler (vl_api_disconnect_session_t * mp)
670 session_t *session = 0;
671 vl_api_disconnect_session_reply_t *rmp;
675 p = hash_get (vcm->session_index_by_vpp_handles, mp->handle);
679 clib_spinlock_lock (&vcm->sessions_lockp);
680 rval = vppcom_session_at_index (p[0], &session);
681 if (PREDICT_FALSE (rval))
683 if (VPPCOM_DEBUG > 1)
684 clib_warning ("[%d] invalid session, sid (%u) has been closed!",
688 pool_put (vcm->sessions, session);
689 clib_spinlock_unlock (&vcm->sessions_lockp);
690 hash_unset (vcm->session_index_by_vpp_handles, mp->handle);
694 clib_warning ("[%d] couldn't find session: unknown vpp handle 0x%llx",
695 getpid (), mp->handle);
699 rmp = vl_msg_api_alloc (sizeof (*rmp));
700 memset (rmp, 0, sizeof (*rmp));
702 rmp->_vl_msg_id = ntohs (VL_API_DISCONNECT_SESSION_REPLY);
703 rmp->retval = htonl (rv);
704 rmp->handle = mp->handle;
705 vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & rmp);
709 vl_api_reset_session_t_handler (vl_api_reset_session_t * mp)
711 session_t *session = 0;
712 vl_api_reset_session_reply_t *rmp;
716 p = hash_get (vcm->session_index_by_vpp_handles, mp->handle);
720 clib_spinlock_lock (&vcm->sessions_lockp);
721 rval = vppcom_session_at_index (p[0], &session);
722 if (PREDICT_FALSE (rval))
724 if (VPPCOM_DEBUG > 1)
725 clib_warning ("[%d] invalid session, sid (%u) has been closed!",
729 pool_put (vcm->sessions, session);
730 clib_spinlock_unlock (&vcm->sessions_lockp);
731 hash_unset (vcm->session_index_by_vpp_handles, mp->handle);
735 clib_warning ("[%d] couldn't find session: unknown vpp handle 0x%llx",
736 getpid (), mp->handle);
740 rmp = vl_msg_api_alloc (sizeof (*rmp));
741 memset (rmp, 0, sizeof (*rmp));
742 rmp->_vl_msg_id = ntohs (VL_API_RESET_SESSION_REPLY);
743 rmp->retval = htonl (rv);
744 rmp->handle = mp->handle;
745 vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & rmp);
749 vl_api_connect_session_reply_t_handler (vl_api_connect_session_reply_t * mp)
753 svm_fifo_t *rx_fifo, *tx_fifo;
759 clib_warning ("[%d] connect failed: %U", getpid (), format_api_error,
764 session_index = mp->context;
765 if (VPPCOM_DEBUG > 1)
766 clib_warning ("[%d] session_index = %d 0x%08x", getpid (),
767 session_index, session_index);
769 clib_spinlock_lock (&vcm->sessions_lockp);
770 if (pool_is_free_index (vcm->sessions, session_index))
772 clib_spinlock_unlock (&vcm->sessions_lockp);
773 if (VPPCOM_DEBUG > 1)
774 clib_warning ("[%d] invalid session, sid %d is closed!",
775 getpid (), session_index);
779 /* We've been redirected */
780 if (mp->segment_name_length > 0)
782 static svm_fifo_segment_create_args_t _a;
783 svm_fifo_segment_create_args_t *a = &_a;
786 memset (a, 0, sizeof (*a));
787 a->segment_name = (char *) mp->segment_name;
788 if (VPPCOM_DEBUG > 1)
789 clib_warning ("[%d] cut-thru segment: %s\n",
790 getpid (), a->segment_name);
792 rv = svm_fifo_segment_attach (a);
793 vec_reset_length (a->new_segment_indices);
794 if (PREDICT_FALSE (rv))
796 clib_spinlock_unlock (&vcm->sessions_lockp);
797 clib_warning ("[%d] sm_fifo_segment_attach ('%s') failed",
798 getpid (), a->segment_name);
806 session = pool_elt_at_index (vcm->sessions, session_index);
807 session->is_cut_thru = is_cut_thru;
808 session->vpp_event_queue = uword_to_pointer (mp->vpp_event_queue_address,
809 unix_shared_memory_queue_t *);
811 rx_fifo = uword_to_pointer (mp->server_rx_fifo, svm_fifo_t *);
812 rx_fifo->client_session_index = session_index;
813 tx_fifo = uword_to_pointer (mp->server_tx_fifo, svm_fifo_t *);
814 tx_fifo->client_session_index = session_index;
816 session->server_rx_fifo = rx_fifo;
817 session->server_tx_fifo = tx_fifo;
818 session->vpp_handle = mp->handle;
819 session->state = STATE_CONNECT;
821 /* Add it to lookup table */
822 hash_set (vcm->session_index_by_vpp_handles, mp->handle, session_index);
824 if (VPPCOM_DEBUG > 1)
825 clib_warning ("[%d] client sid %d, vpp handle 0x%llx\n"
826 " session_rx_fifo %p, refcnt %d\n"
827 " session_tx_fifo %p, refcnt %d",
828 getpid (), session_index, mp->handle,
829 session->server_rx_fifo,
830 session->server_rx_fifo->refcnt,
831 session->server_tx_fifo, session->server_tx_fifo->refcnt);
833 clib_spinlock_unlock (&vcm->sessions_lockp);
837 vppcom_send_connect_sock (session_t * session, u32 session_index)
839 vl_api_connect_sock_t *cmp;
841 /* Assumes caller as acquired the spinlock: vcm->sessions_lockp */
842 session->is_server = 0;
843 cmp = vl_msg_api_alloc (sizeof (*cmp));
844 memset (cmp, 0, sizeof (*cmp));
845 cmp->_vl_msg_id = ntohs (VL_API_CONNECT_SOCK);
846 cmp->client_index = vcm->my_client_index;
847 cmp->context = session_index;
849 if (VPPCOM_DEBUG > 1)
850 clib_warning ("[%d] session_index = %d 0x%08x",
851 getpid (), session_index, session_index);
853 cmp->vrf = session->vrf;
854 cmp->is_ip4 = session->peer_addr.is_ip4;
855 clib_memcpy (cmp->ip, &session->peer_addr.ip46, sizeof (cmp->ip));
856 cmp->port = session->peer_port;
857 cmp->proto = session->proto;
858 clib_memcpy (cmp->options, session->options, sizeof (cmp->options));
859 vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & cmp);
863 vppcom_send_disconnect (session_t * session)
865 vl_api_disconnect_session_t *dmp;
867 /* Assumes caller as acquired the spinlock: vcm->sessions_lockp */
868 dmp = vl_msg_api_alloc (sizeof (*dmp));
869 memset (dmp, 0, sizeof (*dmp));
870 dmp->_vl_msg_id = ntohs (VL_API_DISCONNECT_SESSION);
871 dmp->client_index = vcm->my_client_index;
872 dmp->handle = session->vpp_handle;
873 vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & dmp);
877 vl_api_bind_sock_reply_t_handler (vl_api_bind_sock_reply_t * mp)
879 session_t *session = 0;
883 clib_warning ("[%d] bind failed: %U", getpid (), format_api_error,
886 ASSERT (vcm->bind_session_index != ~0);
888 clib_spinlock_lock (&vcm->sessions_lockp);
889 rv = vppcom_session_at_index (vcm->bind_session_index, &session);
892 session->vpp_handle = mp->handle;
893 hash_set (vcm->session_index_by_vpp_handles, mp->handle,
894 vcm->bind_session_index);
895 session->state = mp->retval ? STATE_FAILED : STATE_LISTEN;
896 vcm->bind_session_index = ~0;
898 clib_spinlock_unlock (&vcm->sessions_lockp);
902 vl_api_unbind_sock_reply_t_handler (vl_api_unbind_sock_reply_t * mp)
904 session_t *session = 0;
907 clib_spinlock_lock (&vcm->sessions_lockp);
908 rv = vppcom_session_at_index (vcm->bind_session_index, &session);
911 if ((VPPCOM_DEBUG > 1) && (mp->retval))
912 clib_warning ("[%d] unbind failed: %U", getpid (), format_api_error,
915 vcm->bind_session_index = ~0;
916 session->state = STATE_START;
918 clib_spinlock_unlock (&vcm->sessions_lockp);
922 format_ip4_address (u8 * s, va_list * args)
924 u8 *a = va_arg (*args, u8 *);
925 return format (s, "%d.%d.%d.%d", a[0], a[1], a[2], a[3]);
929 format_ip6_address (u8 * s, va_list * args)
931 ip6_address_t *a = va_arg (*args, ip6_address_t *);
932 u32 i, i_max_n_zero, max_n_zeros, i_first_zero, n_zeros, last_double_colon;
934 i_max_n_zero = ARRAY_LEN (a->as_u16);
936 i_first_zero = i_max_n_zero;
938 for (i = 0; i < ARRAY_LEN (a->as_u16); i++)
940 u32 is_zero = a->as_u16[i] == 0;
941 if (is_zero && i_first_zero >= ARRAY_LEN (a->as_u16))
947 if ((!is_zero && n_zeros > max_n_zeros)
948 || (i + 1 >= ARRAY_LEN (a->as_u16) && n_zeros > max_n_zeros))
950 i_max_n_zero = i_first_zero;
951 max_n_zeros = n_zeros;
952 i_first_zero = ARRAY_LEN (a->as_u16);
957 last_double_colon = 0;
958 for (i = 0; i < ARRAY_LEN (a->as_u16); i++)
960 if (i == i_max_n_zero && max_n_zeros > 1)
962 s = format (s, "::");
963 i += max_n_zeros - 1;
964 last_double_colon = 1;
968 s = format (s, "%s%x",
969 (last_double_colon || i == 0) ? "" : ":",
970 clib_net_to_host_u16 (a->as_u16[i]));
971 last_double_colon = 0;
978 /* Format an IP46 address. */
980 format_ip46_address (u8 * s, va_list * args)
982 ip46_address_t *ip46 = va_arg (*args, ip46_address_t *);
983 ip46_type_t type = va_arg (*args, ip46_type_t);
989 is_ip4 = ip46_address_is_ip4 (ip46);
1000 format (s, "%U", format_ip4_address, &ip46->ip4) :
1001 format (s, "%U", format_ip6_address, &ip46->ip6);
1005 vppcom_send_accept_session_reply (u32 handle, int retval)
1007 vl_api_accept_session_reply_t *rmp;
1009 rmp = vl_msg_api_alloc (sizeof (*rmp));
1010 memset (rmp, 0, sizeof (*rmp));
1011 rmp->_vl_msg_id = ntohs (VL_API_ACCEPT_SESSION_REPLY);
1012 rmp->retval = htonl (retval);
1013 rmp->handle = handle;
1014 vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & rmp);
1018 vl_api_accept_session_t_handler (vl_api_accept_session_t * mp)
1020 svm_fifo_t *rx_fifo, *tx_fifo;
1025 clib_spinlock_lock (&vcm->sessions_lockp);
1026 if (!clib_fifo_free_elts (vcm->client_session_index_fifo))
1028 clib_warning ("[%d] client session queue is full!", getpid ());
1029 vppcom_send_accept_session_reply (VNET_API_ERROR_QUEUE_FULL,
1031 clib_spinlock_unlock (&vcm->sessions_lockp);
1035 /* Allocate local session and set it up */
1036 pool_get (vcm->sessions, session);
1037 memset (session, 0, sizeof (*session));
1038 session_index = session - vcm->sessions;
1040 rx_fifo = uword_to_pointer (mp->server_rx_fifo, svm_fifo_t *);
1041 rx_fifo->client_session_index = session_index;
1042 tx_fifo = uword_to_pointer (mp->server_tx_fifo, svm_fifo_t *);
1043 tx_fifo->client_session_index = session_index;
1045 session->vpp_handle = mp->handle;
1046 session->server_rx_fifo = rx_fifo;
1047 session->server_tx_fifo = tx_fifo;
1048 session->vpp_event_queue = uword_to_pointer (mp->vpp_event_queue_address,
1049 unix_shared_memory_queue_t *);
1050 session->state = STATE_ACCEPT;
1051 session->is_cut_thru = 0;
1052 session->is_server = 1;
1053 session->peer_port = mp->port;
1054 session->peer_addr.is_ip4 = mp->is_ip4;
1055 clib_memcpy (&session->peer_addr.ip46, mp->ip,
1056 sizeof (session->peer_addr.ip46));
1058 /* Add it to lookup table */
1059 hash_set (vcm->session_index_by_vpp_handles, mp->handle, session_index);
1061 p = hash_get (vcm->session_index_by_vpp_handles, mp->listener_handle);
1065 session_t *listen_session;
1067 rval = vppcom_session_at_index (p[0], &listen_session);
1068 if (PREDICT_FALSE (rval))
1070 if (VPPCOM_DEBUG > 1)
1071 clib_warning ("[%d] invalid listen session, sid (%u) "
1072 "has been closed!", getpid (), p[0]);
1076 session->lcl_port = listen_session->lcl_port;
1077 session->lcl_addr = listen_session->lcl_addr;
1079 clib_spinlock_unlock (&vcm->sessions_lockp);
1080 hash_unset (vcm->session_index_by_vpp_handles, mp->handle);
1084 clib_warning ("[%d] couldn't find listen session: unknown vpp "
1085 "listener handle %llx", getpid (), mp->listener_handle);
1088 /* TBD: move client_session_index_fifo into listener session */
1089 clib_fifo_add1 (vcm->client_session_index_fifo, session_index);
1090 clib_spinlock_unlock (&vcm->sessions_lockp);
1092 if (VPPCOM_DEBUG > 1)
1094 u8 *ip_str = format (0, "%U", format_ip46_address, &mp->ip, mp->is_ip4);
1095 clib_warning ("[%d] received request to accept session (sid %d) "
1096 "from %s:%d", getpid (), session_index, ip_str,
1097 clib_net_to_host_u16 (mp->port));
1103 vppcom_send_connect_session_reply (session_t * session, int retval)
1105 vl_api_connect_session_reply_t *rmp;
1107 unix_shared_memory_queue_t *client_q;
1109 rmp = vl_msg_api_alloc (sizeof (*rmp));
1110 memset (rmp, 0, sizeof (*rmp));
1112 rmp->_vl_msg_id = ntohs (VL_API_CONNECT_SESSION_REPLY);
1113 rmp->context = session->client_context;
1114 rmp->retval = htonl (retval);
1115 rmp->handle = session->vpp_handle;
1116 rmp->server_rx_fifo = pointer_to_uword (session->server_rx_fifo);
1117 rmp->server_tx_fifo = pointer_to_uword (session->server_tx_fifo);
1118 rmp->vpp_event_queue_address = pointer_to_uword (session->vpp_event_queue);
1119 rmp->segment_size = vcm->cfg.segment_size;
1120 len = vec_len (session->segment_name);
1121 rmp->segment_name_length = clib_min (len, sizeof (rmp->segment_name));
1122 clib_memcpy (rmp->segment_name, session->segment_name,
1123 rmp->segment_name_length - 1);
1124 clib_memcpy (rmp->lcl_ip, session->lcl_addr.ip46.as_u8,
1125 sizeof (rmp->lcl_ip));
1126 rmp->is_ip4 = session->lcl_addr.is_ip4;
1127 client_q = uword_to_pointer (session->client_queue_address,
1128 unix_shared_memory_queue_t *);
1130 vl_msg_api_send_shmem (client_q, (u8 *) & rmp);
1134 * Acting as server for redirected connect requests
1137 vl_api_connect_sock_t_handler (vl_api_connect_sock_t * mp)
1140 session_t *session = 0;
1142 clib_spinlock_lock (&vcm->sessions_lockp);
1143 if (!clib_fifo_free_elts (vcm->client_session_index_fifo))
1145 if (VPPCOM_DEBUG > 1)
1146 clib_warning ("[%d] client session queue is full!", getpid ());
1147 clib_spinlock_unlock (&vcm->sessions_lockp);
1148 vppcom_send_accept_session_reply (VNET_API_ERROR_QUEUE_FULL, 0);
1152 pool_get (vcm->sessions, session);
1153 memset (session, 0, sizeof (*session));
1154 session_index = session - vcm->sessions;
1156 session->client_context = mp->context;
1157 session->vpp_handle = session_index;
1158 session->client_queue_address = mp->client_queue_address;
1159 session->is_cut_thru = 1;
1160 session->is_server = 1;
1161 session->peer_port = mp->port;
1162 session->peer_addr.is_ip4 = mp->is_ip4;
1163 clib_memcpy (&session->peer_addr.ip46, mp->ip,
1164 sizeof (session->peer_addr.ip46));
1166 session->state = STATE_ACCEPT;
1167 clib_fifo_add1 (vcm->client_session_index_fifo, session_index);
1168 if (VPPCOM_DEBUG > 1)
1170 ("[%d] Got a cut-thru connect request to client: "
1171 "sid %d, clib_fifo_elts %u!\n", getpid (), session_index,
1172 clib_fifo_elts (vcm->client_session_index_fifo));
1173 clib_spinlock_unlock (&vcm->sessions_lockp);
1177 vppcom_send_bind_sock (session_t * session)
1179 vl_api_bind_sock_t *bmp;
1181 /* Assumes caller has acquired spinlock: vcm->sessions_lockp */
1182 session->is_server = 1;
1183 bmp = vl_msg_api_alloc (sizeof (*bmp));
1184 memset (bmp, 0, sizeof (*bmp));
1186 bmp->_vl_msg_id = ntohs (VL_API_BIND_SOCK);
1187 bmp->client_index = vcm->my_client_index;
1188 bmp->context = htonl (0xfeedface);
1189 bmp->vrf = session->vrf;
1190 bmp->is_ip4 = session->lcl_addr.is_ip4;
1191 clib_memcpy (bmp->ip, &session->lcl_addr.ip46, sizeof (bmp->ip));
1192 bmp->port = session->lcl_port;
1193 bmp->proto = session->proto;
1194 clib_memcpy (bmp->options, session->options, sizeof (bmp->options));
1195 vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & bmp);
1199 vppcom_send_unbind_sock (u32 session_index)
1201 vl_api_unbind_sock_t *ump;
1202 session_t *session = 0;
1205 clib_spinlock_lock (&vcm->sessions_lockp);
1206 rv = vppcom_session_at_index (session_index, &session);
1207 if (PREDICT_FALSE (rv))
1209 clib_spinlock_unlock (&vcm->sessions_lockp);
1210 if (VPPCOM_DEBUG > 0)
1211 clib_warning ("[%d] invalid session, sid (%u) has been closed!",
1212 getpid (), session_index);
1216 ump = vl_msg_api_alloc (sizeof (*ump));
1217 memset (ump, 0, sizeof (*ump));
1219 ump->_vl_msg_id = ntohs (VL_API_UNBIND_SOCK);
1220 ump->client_index = vcm->my_client_index;
1221 ump->handle = session->vpp_handle;
1222 clib_spinlock_unlock (&vcm->sessions_lockp);
1223 vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & ump);
1227 vppcom_session_unbind_cut_thru (session_t * session, u32 session_index)
1229 svm_fifo_segment_main_t *sm = &svm_fifo_segment_main;
1230 svm_fifo_segment_private_t *seg;
1233 if (VPPCOM_DEBUG > 1)
1234 clib_warning ("[%d] sid %d, seg_nxd %d:\n"
1235 " server_rx_fifo %p, refcnt = %d\n"
1236 " server_tx_fifo %p, refcnt = %d",
1237 getpid (), session_index, session->sm_seg_index,
1238 session->server_rx_fifo, session->server_rx_fifo->refcnt,
1239 session->server_tx_fifo, session->server_tx_fifo->refcnt);
1241 seg = vec_elt_at_index (sm->segments, session->sm_seg_index);
1242 svm_fifo_segment_free_fifo (seg, session->server_rx_fifo,
1243 FIFO_SEGMENT_RX_FREELIST);
1244 svm_fifo_segment_free_fifo (seg, session->server_tx_fifo,
1245 FIFO_SEGMENT_TX_FREELIST);
1246 svm_fifo_segment_delete (seg);
1252 vppcom_session_unbind (u32 session_index)
1256 clib_spinlock_lock (&vcm->sessions_lockp);
1257 if (PREDICT_FALSE (pool_is_free_index (vcm->sessions, session_index)))
1259 clib_spinlock_unlock (&vcm->sessions_lockp);
1260 if (VPPCOM_DEBUG > 1)
1261 clib_warning ("[%d] invalid session, sid (%u) has been closed!",
1262 getpid (), session_index);
1263 return VPPCOM_EBADFD;
1265 clib_spinlock_unlock (&vcm->sessions_lockp);
1267 vcm->bind_session_index = session_index;
1268 vppcom_send_unbind_sock (session_index);
1269 rv = vppcom_wait_for_session_state_change (session_index, STATE_START,
1270 vcm->cfg.session_timeout);
1271 if (PREDICT_FALSE (rv))
1273 vcm->bind_session_index = ~0;
1274 if (VPPCOM_DEBUG > 0)
1275 clib_warning ("[%d] server unbind timed out, rv = %s (%d)",
1276 getpid (), vppcom_retval_str (rv), rv);
1283 vppcom_session_disconnect (u32 session_index)
1288 clib_spinlock_lock (&vcm->sessions_lockp);
1289 rv = vppcom_session_at_index (session_index, &session);
1290 if (PREDICT_FALSE (rv))
1292 clib_spinlock_unlock (&vcm->sessions_lockp);
1293 if (VPPCOM_DEBUG > 1)
1294 clib_warning ("[%d] invalid session, sid (%u) has been closed!",
1295 getpid (), session_index);
1299 if (!session->is_cut_thru)
1301 vppcom_send_disconnect (session);
1302 clib_spinlock_unlock (&vcm->sessions_lockp);
1304 rv = vppcom_wait_for_session_state_change (session_index,
1305 STATE_DISCONNECT, 1.0);
1306 /* TBD: Force clean up on error/timeout since there is no other
1307 * way to recover from a failed disconnect.
1309 if ((VPPCOM_DEBUG > 0) && (rv < 0))
1310 clib_warning ("[%d] disconnect (session %d) failed, rv = %s (%d)",
1311 getpid (), session_index, vppcom_retval_str (rv), rv);
1315 /* TBD: Handle cut-thru disconnect */
1316 clib_spinlock_unlock (&vcm->sessions_lockp);
1322 #define foreach_sock_msg \
1323 _(SESSION_ENABLE_DISABLE_REPLY, session_enable_disable_reply) \
1324 _(BIND_SOCK_REPLY, bind_sock_reply) \
1325 _(UNBIND_SOCK_REPLY, unbind_sock_reply) \
1326 _(ACCEPT_SESSION, accept_session) \
1327 _(CONNECT_SOCK, connect_sock) \
1328 _(CONNECT_SESSION_REPLY, connect_session_reply) \
1329 _(DISCONNECT_SESSION, disconnect_session) \
1330 _(DISCONNECT_SESSION_REPLY, disconnect_session_reply) \
1331 _(RESET_SESSION, reset_session) \
1332 _(APPLICATION_ATTACH_REPLY, application_attach_reply) \
1333 _(APPLICATION_DETACH_REPLY, application_detach_reply) \
1334 _(MAP_ANOTHER_SEGMENT, map_another_segment)
1337 vppcom_api_hookup (void)
1340 vl_msg_api_set_handlers(VL_API_##N, #n, \
1341 vl_api_##n##_t_handler, \
1343 vl_api_##n##_t_endian, \
1344 vl_api_##n##_t_print, \
1345 sizeof(vl_api_##n##_t), 1);
1351 vppcom_cfg_init (vppcom_cfg_t * vcl_cfg)
1355 vcl_cfg->heapsize = (256ULL << 20);
1356 vcl_cfg->segment_baseva = 0x200000000ULL;
1357 vcl_cfg->segment_size = (256 << 20);
1358 vcl_cfg->add_segment_size = (128 << 20);
1359 vcl_cfg->preallocated_fifo_pairs = 8;
1360 vcl_cfg->rx_fifo_size = (1 << 20);
1361 vcl_cfg->tx_fifo_size = (1 << 20);
1362 vcl_cfg->event_queue_size = 2048;
1363 vcl_cfg->listen_queue_size = CLIB_CACHE_LINE_BYTES / sizeof (u32);
1364 vcl_cfg->app_timeout = 10 * 60.0;
1365 vcl_cfg->session_timeout = 10 * 60.0;
1366 vcl_cfg->accept_timeout = 60.0;
1370 vppcom_cfg_heapsize (char *conf_fname)
1372 vppcom_cfg_t *vcl_cfg = &vcm->cfg;
1385 fp = fopen (conf_fname, "r");
1388 if (VPPCOM_DEBUG > 0)
1389 fprintf (stderr, "open configuration file '%s' failed\n", conf_fname);
1392 argv = calloc (1, sizeof (char *));
1398 if (fgets (inbuf, 4096, fp) == 0)
1400 p = strtok (inbuf, " \t\n");
1406 char **tmp = realloc (argv, argc * sizeof (char *));
1410 arg = strndup (p, 1024);
1413 argv[argc - 1] = arg;
1414 p = strtok (NULL, " \t\n");
1421 char **tmp = realloc (argv, (argc + 1) * sizeof (char *));
1428 * Look for and parse the "heapsize" config parameter.
1429 * Manual since none of the clib infra has been bootstrapped yet.
1431 * Format: heapsize <nn>[mM][gG]
1434 for (i = 1; i < (argc - 1); i++)
1436 if (!strncmp (argv[i], "heapsize", 8))
1438 sizep = (u8 *) argv[i + 1];
1440 while (*sizep >= '0' && *sizep <= '9')
1443 size += *sizep++ - '0';
1447 if (VPPCOM_DEBUG > 0)
1448 clib_warning ("[%d] parse error '%s %s', "
1449 "using default heapsize %lld (0x%llx)",
1450 getpid (), argv[i], argv[i + 1],
1451 vcl_cfg->heapsize, vcl_cfg->heapsize);
1455 if (*sizep == 'g' || *sizep == 'G')
1456 vcl_cfg->heapsize = size << 30;
1457 else if (*sizep == 'm' || *sizep == 'M')
1458 vcl_cfg->heapsize = size << 20;
1461 if (VPPCOM_DEBUG > 0)
1462 clib_warning ("[%d] parse error '%s %s', "
1463 "using default heapsize %lld (0x%llx)",
1464 getpid (), argv[i], argv[i + 1],
1465 vcl_cfg->heapsize, vcl_cfg->heapsize);
1477 vcl_mem = mmap (0, vcl_cfg->heapsize, PROT_READ | PROT_WRITE,
1478 MAP_SHARED | MAP_ANONYMOUS, -1, 0);
1479 if (vcl_mem == MAP_FAILED)
1481 clib_unix_error ("[%d] ERROR: mmap(0, %lld == 0x%llx, "
1482 "PROT_READ | PROT_WRITE,MAP_SHARED | MAP_ANONYMOUS, "
1484 getpid (), vcl_cfg->heapsize, vcl_cfg->heapsize);
1487 heap = clib_mem_init (vcl_mem, vcl_cfg->heapsize);
1490 clib_warning ("[%d] ERROR: clib_mem_init() failed!", getpid ());
1493 vcl_mem = clib_mem_alloc (sizeof (_vppcom_main));
1496 clib_warning ("[%d] ERROR: clib_mem_alloc() failed!", getpid ());
1500 clib_memcpy (vcl_mem, &_vppcom_main, sizeof (_vppcom_main));
1503 if (VPPCOM_DEBUG > 0)
1504 clib_warning ("[%d] allocated VCL heap = %p, size %lld (0x%llx)",
1505 getpid (), heap, vcl_cfg->heapsize, vcl_cfg->heapsize);
1509 vppcom_cfg_read (char *conf_fname)
1511 vppcom_cfg_t *vcl_cfg = &vcm->cfg;
1513 unformat_input_t _input, *input = &_input;
1514 unformat_input_t _line_input, *line_input = &_line_input;
1515 u8 vc_cfg_input = 0;
1520 fd = open (conf_fname, O_RDONLY);
1523 if (VPPCOM_DEBUG > 0)
1524 clib_warning ("[%d] open configuration file '%s' failed!",
1525 getpid (), conf_fname);
1529 if (fstat (fd, &s) < 0)
1531 if (VPPCOM_DEBUG > 0)
1532 clib_warning ("[%d] failed to stat `%s'", getpid (), conf_fname);
1536 if (!(S_ISREG (s.st_mode) || S_ISLNK (s.st_mode)))
1538 if (VPPCOM_DEBUG > 0)
1539 clib_warning ("[%d] not a regular file `%s'", getpid (), conf_fname);
1543 unformat_init_clib_file (input, fd);
1545 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1547 (void) unformat_user (input, unformat_line_input, line_input);
1548 unformat_skip_white_space (line_input);
1550 if (unformat (line_input, "vcl {"))
1558 if (unformat (line_input, "heapsize %s", &chroot_path))
1560 vec_terminate_c_string (chroot_path);
1561 if (VPPCOM_DEBUG > 0)
1562 clib_warning ("[%d] configured heapsize %s, "
1563 "actual heapsize %lld (0x%llx)",
1564 getpid (), chroot_path, vcl_cfg->heapsize,
1566 vec_free (chroot_path);
1568 else if (unformat (line_input, "api-prefix %s", &chroot_path))
1570 vec_terminate_c_string (chroot_path);
1571 vl_set_memory_root_path ((char *) chroot_path);
1572 if (VPPCOM_DEBUG > 0)
1573 clib_warning ("[%d] configured api-prefix %s",
1574 getpid (), chroot_path);
1575 chroot_path = 0; /* Don't vec_free() it! */
1577 else if (unformat (line_input, "uid %d", &uid))
1579 vl_set_memory_uid (uid);
1580 if (VPPCOM_DEBUG > 0)
1581 clib_warning ("[%d] configured uid %d", getpid (), uid);
1583 else if (unformat (line_input, "gid %d", &gid))
1585 vl_set_memory_gid (gid);
1586 if (VPPCOM_DEBUG > 0)
1587 clib_warning ("[%d] configured gid %d", getpid (), gid);
1589 else if (unformat (line_input, "segment-baseva 0x%lx",
1590 &vcl_cfg->segment_baseva))
1592 if (VPPCOM_DEBUG > 0)
1593 clib_warning ("[%d] configured segment_baseva 0x%lx",
1594 getpid (), vcl_cfg->segment_baseva);
1596 else if (unformat (line_input, "segment-size 0x%lx",
1597 &vcl_cfg->segment_size))
1599 if (VPPCOM_DEBUG > 0)
1600 clib_warning ("[%d] configured segment_size 0x%lx (%ld)",
1601 getpid (), vcl_cfg->segment_size,
1602 vcl_cfg->segment_size);
1604 else if (unformat (line_input, "segment-size %ld",
1605 &vcl_cfg->segment_size))
1607 if (VPPCOM_DEBUG > 0)
1608 clib_warning ("[%d] configured segment_size %ld (0x%lx)",
1609 getpid (), vcl_cfg->segment_size,
1610 vcl_cfg->segment_size);
1612 else if (unformat (line_input, "add-segment-size 0x%lx",
1613 &vcl_cfg->add_segment_size))
1615 if (VPPCOM_DEBUG > 0)
1617 ("[%d] configured add_segment_size 0x%lx (%ld)",
1618 getpid (), vcl_cfg->add_segment_size,
1619 vcl_cfg->add_segment_size);
1621 else if (unformat (line_input, "add-segment-size %ld",
1622 &vcl_cfg->add_segment_size))
1624 if (VPPCOM_DEBUG > 0)
1626 ("[%d] configured add_segment_size %ld (0x%lx)",
1627 getpid (), vcl_cfg->add_segment_size,
1628 vcl_cfg->add_segment_size);
1630 else if (unformat (line_input, "preallocated-fifo-pairs %d",
1631 &vcl_cfg->preallocated_fifo_pairs))
1633 if (VPPCOM_DEBUG > 0)
1634 clib_warning ("[%d] configured preallocated_fifo_pairs "
1635 "%d (0x%x)", getpid (),
1636 vcl_cfg->preallocated_fifo_pairs,
1637 vcl_cfg->preallocated_fifo_pairs);
1639 else if (unformat (line_input, "rx-fifo-size 0x%lx",
1640 &vcl_cfg->rx_fifo_size))
1642 if (VPPCOM_DEBUG > 0)
1643 clib_warning ("[%d] configured rx_fifo_size 0x%lx (%ld)",
1644 getpid (), vcl_cfg->rx_fifo_size,
1645 vcl_cfg->rx_fifo_size);
1647 else if (unformat (line_input, "rx-fifo-size %ld",
1648 &vcl_cfg->rx_fifo_size))
1650 if (VPPCOM_DEBUG > 0)
1651 clib_warning ("[%d] configured rx_fifo_size %ld (0x%lx)",
1652 getpid (), vcl_cfg->rx_fifo_size,
1653 vcl_cfg->rx_fifo_size);
1655 else if (unformat (line_input, "tx-fifo-size 0x%lx",
1656 &vcl_cfg->tx_fifo_size))
1658 if (VPPCOM_DEBUG > 0)
1659 clib_warning ("[%d] configured tx_fifo_size 0x%lx (%ld)",
1660 getpid (), vcl_cfg->tx_fifo_size,
1661 vcl_cfg->tx_fifo_size);
1663 else if (unformat (line_input, "tx-fifo-size %ld",
1664 &vcl_cfg->tx_fifo_size))
1666 if (VPPCOM_DEBUG > 0)
1667 clib_warning ("[%d] configured tx_fifo_size %ld (0x%lx)",
1668 getpid (), vcl_cfg->tx_fifo_size,
1669 vcl_cfg->tx_fifo_size);
1671 else if (unformat (line_input, "event-queue-size 0x%lx",
1672 &vcl_cfg->event_queue_size))
1674 if (VPPCOM_DEBUG > 0)
1675 clib_warning ("[%d] configured event_queue_size 0x%lx (%ld)",
1676 getpid (), vcl_cfg->event_queue_size,
1677 vcl_cfg->event_queue_size);
1679 else if (unformat (line_input, "event-queue-size %ld",
1680 &vcl_cfg->event_queue_size))
1682 if (VPPCOM_DEBUG > 0)
1683 clib_warning ("[%d] configured event_queue_size %ld (0x%lx)",
1684 getpid (), vcl_cfg->event_queue_size,
1685 vcl_cfg->event_queue_size);
1687 else if (unformat (line_input, "listen-queue-size 0x%lx",
1688 &vcl_cfg->listen_queue_size))
1690 if (VPPCOM_DEBUG > 0)
1691 clib_warning ("[%d] configured listen_queue_size 0x%lx (%ld)",
1692 getpid (), vcl_cfg->listen_queue_size,
1693 vcl_cfg->listen_queue_size);
1695 else if (unformat (line_input, "listen-queue-size %ld",
1696 &vcl_cfg->listen_queue_size))
1698 if (VPPCOM_DEBUG > 0)
1699 clib_warning ("[%d] configured listen_queue_size %ld (0x%lx)",
1700 getpid (), vcl_cfg->listen_queue_size,
1701 vcl_cfg->listen_queue_size);
1703 else if (unformat (line_input, "app-timeout %f",
1704 &vcl_cfg->app_timeout))
1706 if (VPPCOM_DEBUG > 0)
1707 clib_warning ("[%d] configured app_timeout %f",
1708 getpid (), vcl_cfg->app_timeout);
1710 else if (unformat (line_input, "session-timeout %f",
1711 &vcl_cfg->session_timeout))
1713 if (VPPCOM_DEBUG > 0)
1714 clib_warning ("[%d] configured session_timeout %f",
1715 getpid (), vcl_cfg->session_timeout);
1717 else if (unformat (line_input, "accept-timeout %f",
1718 &vcl_cfg->accept_timeout))
1720 if (VPPCOM_DEBUG > 0)
1721 clib_warning ("[%d] configured accept_timeout %f",
1722 getpid (), vcl_cfg->accept_timeout);
1724 else if (unformat (line_input, "app-proxy-transport-tcp"))
1726 vcl_cfg->app_proxy_transport_tcp = 1;
1727 if (VPPCOM_DEBUG > 0)
1728 clib_warning ("[%d] configured app_proxy_transport_tcp (%d)",
1729 getpid (), vcl_cfg->app_proxy_transport_tcp);
1731 else if (unformat (line_input, "app-proxy-transport-udp"))
1733 vcl_cfg->app_proxy_transport_udp = 1;
1734 if (VPPCOM_DEBUG > 0)
1735 clib_warning ("[%d] configured app_proxy_transport_udp (%d)",
1736 getpid (), vcl_cfg->app_proxy_transport_udp);
1738 else if (unformat (line_input, "app-scope-local"))
1740 vcl_cfg->app_scope_local = 1;
1741 if (VPPCOM_DEBUG > 0)
1742 clib_warning ("[%d] configured app_scope_local (%d)",
1743 getpid (), vcl_cfg->app_scope_local);
1745 else if (unformat (line_input, "app-scope-global"))
1747 vcl_cfg->app_scope_global = 1;
1748 if (VPPCOM_DEBUG > 0)
1749 clib_warning ("[%d] configured app_scope_global (%d)",
1750 getpid (), vcl_cfg->app_scope_global);
1752 else if (unformat (line_input, "namespace-secret %lu",
1753 &vcl_cfg->namespace_secret))
1755 if (VPPCOM_DEBUG > 0)
1757 ("[%d] configured namespace_secret %lu (0x%lx)",
1758 getpid (), vcl_cfg->namespace_secret,
1759 vcl_cfg->namespace_secret);
1761 else if (unformat (line_input, "namespace-id %v",
1762 &vcl_cfg->namespace_id))
1764 vl_api_application_attach_t *mp;
1765 u32 max_nsid_vec_len = sizeof (mp->namespace_id) - 1;
1766 u32 nsid_vec_len = vec_len (vcl_cfg->namespace_id);
1767 if (nsid_vec_len > max_nsid_vec_len)
1769 _vec_len (vcl_cfg->namespace_id) = max_nsid_vec_len;
1770 if (VPPCOM_DEBUG > 0)
1771 clib_warning ("[%d] configured namespace_id is too long,"
1772 " truncated to %d characters!", getpid (),
1776 if (VPPCOM_DEBUG > 0)
1777 clib_warning ("[%d] configured namespace_id %v",
1778 getpid (), vcl_cfg->namespace_id);
1780 else if (unformat (line_input, "}"))
1783 if (VPPCOM_DEBUG > 0)
1784 clib_warning ("[%d] completed parsing vppcom config!",
1790 if (line_input->buffer[line_input->index] != '#')
1792 clib_warning ("[%d] Unknown vppcom config option: '%s'",
1794 &line_input->buffer[line_input->index]);
1801 unformat_free (input);
1809 * VPPCOM Public API functions
1812 vppcom_app_create (char *app_name)
1814 vppcom_cfg_t *vcl_cfg = &vcm->cfg;
1825 vppcom_cfg_init (vcl_cfg);
1826 env_var_str = getenv (VPPCOM_ENV_DEBUG);
1830 if (sscanf (env_var_str, "%u", &tmp) != 1)
1831 clib_warning ("[%d] Invalid debug level specified in "
1832 "the environment variable "
1834 " (%s)!\n", getpid (), env_var_str);
1838 clib_warning ("[%d] configured debug level (%u) from "
1839 VPPCOM_ENV_DEBUG "!", getpid (), vcm->debug);
1842 conf_fname = getenv (VPPCOM_ENV_CONF);
1845 conf_fname = VPPCOM_CONF_DEFAULT;
1846 if (VPPCOM_DEBUG > 0)
1847 clib_warning ("[%d] getenv '%s' failed!", getpid (),
1850 vppcom_cfg_heapsize (conf_fname);
1851 clib_fifo_validate (vcm->client_session_index_fifo,
1852 vcm->cfg.listen_queue_size);
1853 vppcom_cfg_read (conf_fname);
1854 env_var_str = getenv (VPPCOM_ENV_APP_NAMESPACE_ID);
1857 u32 ns_id_vec_len = strlen (env_var_str);
1859 vec_reset_length (vcm->cfg.namespace_id);
1860 vec_validate (vcm->cfg.namespace_id, ns_id_vec_len - 1);
1861 clib_memcpy (vcm->cfg.namespace_id, env_var_str, ns_id_vec_len);
1863 if (VPPCOM_DEBUG > 0)
1864 clib_warning ("[%d] configured namespace_id (%v) from "
1865 VPPCOM_ENV_APP_NAMESPACE_ID "!", getpid (),
1866 vcm->cfg.namespace_id);
1868 env_var_str = getenv (VPPCOM_ENV_APP_NAMESPACE_SECRET);
1872 if (sscanf (env_var_str, "%lu", &tmp) != 1)
1873 clib_warning ("[%d] Invalid namespace secret specified in "
1874 "the environment variable "
1875 VPPCOM_ENV_APP_NAMESPACE_SECRET
1876 " (%s)!\n", getpid (), env_var_str);
1879 vcm->cfg.namespace_secret = tmp;
1880 if (VPPCOM_DEBUG > 0)
1881 clib_warning ("[%d] configured namespace secret (%lu) from "
1882 VPPCOM_ENV_APP_NAMESPACE_ID "!", getpid (),
1883 vcm->cfg.namespace_secret);
1886 if (getenv (VPPCOM_ENV_APP_PROXY_TRANSPORT_TCP))
1888 vcm->cfg.app_proxy_transport_tcp = 1;
1889 if (VPPCOM_DEBUG > 0)
1890 clib_warning ("[%d] configured app_proxy_transport_tcp (%u) from "
1891 VPPCOM_ENV_APP_PROXY_TRANSPORT_TCP "!", getpid (),
1892 vcm->cfg.app_proxy_transport_tcp);
1894 if (getenv (VPPCOM_ENV_APP_PROXY_TRANSPORT_UDP))
1896 vcm->cfg.app_proxy_transport_udp = 1;
1897 if (VPPCOM_DEBUG > 0)
1898 clib_warning ("[%d] configured app_proxy_transport_udp (%u) from "
1899 VPPCOM_ENV_APP_PROXY_TRANSPORT_UDP "!", getpid (),
1900 vcm->cfg.app_proxy_transport_udp);
1902 if (getenv (VPPCOM_ENV_APP_SCOPE_LOCAL))
1904 vcm->cfg.app_scope_local = 1;
1905 if (VPPCOM_DEBUG > 0)
1906 clib_warning ("[%d] configured app_scope_local (%u) from "
1907 VPPCOM_ENV_APP_SCOPE_LOCAL "!", getpid (),
1908 vcm->cfg.app_scope_local);
1910 if (getenv (VPPCOM_ENV_APP_SCOPE_GLOBAL))
1912 vcm->cfg.app_scope_global = 1;
1913 if (VPPCOM_DEBUG > 0)
1914 clib_warning ("[%d] configured app_scope_global (%u) from "
1915 VPPCOM_ENV_APP_SCOPE_GLOBAL "!", getpid (),
1916 vcm->cfg.app_scope_global);
1919 vcm->bind_session_index = ~0;
1920 vcm->main_cpu = os_get_thread_index ();
1921 heap = clib_mem_get_per_cpu_heap ();
1922 h = mheap_header (heap);
1924 /* make the main heap thread-safe */
1925 h->flags |= MHEAP_FLAG_THREAD_SAFE;
1927 vcm->session_index_by_vpp_handles = hash_create (0, sizeof (uword));
1929 clib_time_init (&vcm->clib_time);
1930 vppcom_init_error_string_table ();
1931 svm_fifo_segment_init (vcl_cfg->segment_baseva,
1932 20 /* timeout in secs */ );
1933 clib_spinlock_init (&vcm->sessions_lockp);
1934 vppcom_api_hookup ();
1937 if (vcm->my_client_index == ~0)
1939 vcm->app_state = STATE_APP_START;
1940 rv = vppcom_connect_to_vpp (app_name);
1943 clib_warning ("[%d] couldn't connect to VPP.", getpid ());
1947 if (VPPCOM_DEBUG > 0)
1948 clib_warning ("[%d] sending session enable", getpid ());
1950 rv = vppcom_app_session_enable ();
1953 clib_warning ("[%d] vppcom_app_session_enable() failed!",
1958 if (VPPCOM_DEBUG > 0)
1959 clib_warning ("[%d] sending app attach", getpid ());
1961 rv = vppcom_app_attach ();
1964 clib_warning ("[%d] vppcom_app_attach() failed!", getpid ());
1968 if (VPPCOM_DEBUG > 0)
1969 clib_warning ("[%d] app_name '%s', my_client_index %d (0x%x)",
1970 getpid (), app_name, vcm->my_client_index,
1971 vcm->my_client_index);
1978 vppcom_app_destroy (void)
1982 if (vcm->my_client_index == ~0)
1985 if (VPPCOM_DEBUG > 0)
1986 clib_warning ("[%d] detaching from VPP, my_client_index %d (0x%x)",
1987 getpid (), vcm->my_client_index, vcm->my_client_index);
1989 vppcom_app_detach ();
1990 rv = vppcom_wait_for_app_state_change (STATE_APP_ENABLED);
1991 if (PREDICT_FALSE (rv))
1993 if (VPPCOM_DEBUG > 0)
1994 clib_warning ("[%d] application detach timed out, rv = %s (%d)",
1995 getpid (), vppcom_retval_str (rv), rv);
1997 vl_client_disconnect_from_vlib ();
1998 vcm->my_client_index = ~0;
1999 vcm->app_state = STATE_APP_START;
2003 vppcom_session_create (u32 vrf, u8 proto, u8 is_nonblocking)
2008 clib_spinlock_lock (&vcm->sessions_lockp);
2009 pool_get (vcm->sessions, session);
2010 memset (session, 0, sizeof (*session));
2011 session_index = session - vcm->sessions;
2014 session->proto = proto;
2015 session->state = STATE_START;
2016 session->is_nonblocking = is_nonblocking ? 1 : 0;
2017 clib_spinlock_unlock (&vcm->sessions_lockp);
2019 if (VPPCOM_DEBUG > 0)
2020 clib_warning ("[%d] sid %d", getpid (), session_index);
2022 return (int) session_index;
2026 vppcom_session_close (uint32_t session_index)
2028 session_t *session = 0;
2037 session_state_t state;
2039 clib_spinlock_lock (&vcm->sessions_lockp);
2040 rv = vppcom_session_at_index (session_index, &session);
2041 if (PREDICT_FALSE (rv))
2043 if (VPPCOM_DEBUG > 0)
2044 clib_warning ("[%d] invalid session, sid (%u) has been closed!",
2045 getpid (), session_index);
2046 clib_spinlock_unlock (&vcm->sessions_lockp);
2049 is_server = session->is_server;
2050 is_listen = session->is_listen;
2051 is_cut_thru = session->is_cut_thru;
2052 is_vep = session->is_vep;
2053 is_vep_session = session->is_vep_session;
2054 next_sid = session->vep.next_sid;
2055 vep_idx = session->vep.vep_idx;
2056 state = session->state;
2057 clib_spinlock_unlock (&vcm->sessions_lockp);
2059 if (VPPCOM_DEBUG > 0)
2060 clib_warning ("[%d] sid %d", getpid (), session_index);
2064 while (next_sid != ~0)
2066 rv = vppcom_epoll_ctl (session_index, EPOLL_CTL_DEL, next_sid, 0);
2067 if ((VPPCOM_DEBUG > 0) && (rv < 0))
2068 clib_warning ("[%d] EPOLL_CTL_DEL vep_idx %u, sid %u failed, "
2069 "rv = %s (%d)", getpid (), vep_idx, next_sid,
2070 vppcom_retval_str (rv), rv);
2072 clib_spinlock_lock (&vcm->sessions_lockp);
2073 rv = vppcom_session_at_index (session_index, &session);
2074 if (PREDICT_FALSE (rv))
2076 if (VPPCOM_DEBUG > 0)
2078 ("[%d] invalid session, sid (%u) has been closed!",
2079 getpid (), session_index);
2080 clib_spinlock_unlock (&vcm->sessions_lockp);
2083 next_sid = session->vep.next_sid;
2084 clib_spinlock_unlock (&vcm->sessions_lockp);
2091 rv = vppcom_epoll_ctl (vep_idx, EPOLL_CTL_DEL, session_index, 0);
2092 if ((VPPCOM_DEBUG > 0) && (rv < 0))
2093 clib_warning ("[%d] EPOLL_CTL_DEL vep_idx %u, sid %u failed, "
2094 "rv = %s (%d)", getpid (), vep_idx, session_index,
2095 vppcom_retval_str (rv), rv);
2098 if (is_cut_thru && is_server && (state == STATE_ACCEPT))
2100 rv = vppcom_session_unbind_cut_thru (session, session_index);
2101 if ((VPPCOM_DEBUG > 0) && (rv < 0))
2102 clib_warning ("[%d] unbind cut-thru (session %d) failed, "
2104 getpid (), session_index,
2105 vppcom_retval_str (rv), rv);
2107 else if (is_server && is_listen)
2109 rv = vppcom_session_unbind (session_index);
2110 if ((VPPCOM_DEBUG > 0) && (rv < 0))
2111 clib_warning ("[%d] unbind (session %d) failed, rv = %s (%d)",
2112 getpid (), session_index,
2113 vppcom_retval_str (rv), rv);
2115 else if (state == STATE_CONNECT)
2116 if (vppcom_session_disconnect (session_index))
2119 clib_spinlock_lock (&vcm->sessions_lockp);
2120 pool_put_index (vcm->sessions, session_index);
2121 clib_spinlock_unlock (&vcm->sessions_lockp);
2127 vppcom_session_bind (uint32_t session_index, vppcom_endpt_t * ep)
2129 session_t *session = 0;
2133 return VPPCOM_EINVAL;
2135 clib_spinlock_lock (&vcm->sessions_lockp);
2136 rv = vppcom_session_at_index (session_index, &session);
2137 if (PREDICT_FALSE (rv))
2139 clib_spinlock_unlock (&vcm->sessions_lockp);
2140 if (VPPCOM_DEBUG > 0)
2141 clib_warning ("[%d] invalid session, sid (%u) has been closed!",
2142 getpid (), session_index);
2146 if (session->is_vep)
2148 clib_spinlock_unlock (&vcm->sessions_lockp);
2149 if (VPPCOM_DEBUG > 0)
2150 clib_warning ("[%d] invalid session, sid (%u) is an epoll session!",
2151 getpid (), session_index);
2152 return VPPCOM_EBADFD;
2155 session->vrf = ep->vrf;
2156 session->lcl_addr.is_ip4 = ep->is_ip4;
2157 session->lcl_addr.ip46 = to_ip46 (!ep->is_ip4, ep->ip);
2158 session->lcl_port = ep->port;
2160 if (VPPCOM_DEBUG > 0)
2161 clib_warning ("[%d] sid %d, bound to lcl address %U lcl port %u",
2162 getpid (), session_index, format_ip46_address,
2163 &session->lcl_addr.ip46, session->lcl_addr.is_ip4,
2164 clib_net_to_host_u16 (session->lcl_port));
2166 clib_spinlock_unlock (&vcm->sessions_lockp);
2171 vppcom_session_listen (uint32_t listen_session_index, uint32_t q_len)
2173 session_t *listen_session = 0;
2176 clib_spinlock_lock (&vcm->sessions_lockp);
2177 rv = vppcom_session_at_index (listen_session_index, &listen_session);
2178 if (PREDICT_FALSE (rv))
2180 clib_spinlock_unlock (&vcm->sessions_lockp);
2181 if (VPPCOM_DEBUG > 0)
2182 clib_warning ("[%d] invalid session, sid (%u) has been closed!",
2183 getpid (), listen_session_index);
2187 if (listen_session->is_vep)
2189 clib_spinlock_unlock (&vcm->sessions_lockp);
2190 if (VPPCOM_DEBUG > 0)
2191 clib_warning ("[%d] invalid session, sid (%u) is an epoll session!",
2192 getpid (), listen_session_index);
2193 return VPPCOM_EBADFD;
2196 if (listen_session->is_listen)
2198 clib_spinlock_unlock (&vcm->sessions_lockp);
2199 if (VPPCOM_DEBUG > 0)
2200 clib_warning ("[%d] sid (%u) is already in listen state!",
2201 getpid (), listen_session_index);
2205 if (VPPCOM_DEBUG > 0)
2206 clib_warning ("[%d] sid %d", getpid (), listen_session_index);
2208 ASSERT (vcm->bind_session_index == ~0);
2209 vcm->bind_session_index = listen_session_index;
2210 vppcom_send_bind_sock (listen_session);
2211 clib_spinlock_unlock (&vcm->sessions_lockp);
2213 vppcom_wait_for_session_state_change (listen_session_index, STATE_LISTEN,
2214 vcm->cfg.session_timeout);
2215 if (PREDICT_FALSE (rv))
2217 vcm->bind_session_index = ~0;
2218 if (VPPCOM_DEBUG > 0)
2219 clib_warning ("[%d] server listen timed out, rv = %d (%d)",
2220 getpid (), vppcom_retval_str (rv), rv);
2224 clib_spinlock_lock (&vcm->sessions_lockp);
2225 rv = vppcom_session_at_index (listen_session_index, &listen_session);
2226 if (PREDICT_FALSE (rv))
2228 clib_spinlock_unlock (&vcm->sessions_lockp);
2229 if (VPPCOM_DEBUG > 0)
2230 clib_warning ("[%d] invalid session, sid (%u) has been closed!",
2231 getpid (), listen_session_index);
2234 listen_session->is_listen = 1;
2235 clib_fifo_validate (vcm->client_session_index_fifo, q_len);
2236 clib_spinlock_unlock (&vcm->sessions_lockp);
2242 vppcom_session_accept (uint32_t listen_session_index, vppcom_endpt_t * ep,
2243 uint32_t flags, double wait_for_time)
2245 session_t *listen_session = 0;
2246 session_t *client_session = 0;
2247 u32 client_session_index = ~0;
2252 clib_spinlock_lock (&vcm->sessions_lockp);
2253 rv = vppcom_session_at_index (listen_session_index, &listen_session);
2254 if (PREDICT_FALSE (rv))
2256 clib_spinlock_unlock (&vcm->sessions_lockp);
2257 if (VPPCOM_DEBUG > 0)
2258 clib_warning ("[%d] invalid session, sid (%u) has been closed!",
2259 getpid (), listen_session_index);
2263 if (listen_session->is_vep)
2265 clib_spinlock_unlock (&vcm->sessions_lockp);
2266 if (VPPCOM_DEBUG > 0)
2267 clib_warning ("[%d] invalid session, sid (%u) is an epoll session!",
2268 getpid (), listen_session_index);
2269 return VPPCOM_EBADFD;
2272 if (listen_session->state != STATE_LISTEN)
2274 clib_spinlock_unlock (&vcm->sessions_lockp);
2275 if (VPPCOM_DEBUG > 0)
2276 clib_warning ("[%d] session not in listen state, state = %s",
2278 vppcom_session_state_str (listen_session->state));
2279 return VPPCOM_EBADFD;
2281 wait_for = listen_session->is_nonblocking ? 0 :
2282 (wait_for_time < 0) ? vcm->cfg.accept_timeout : wait_for_time;
2284 if (VPPCOM_DEBUG > 0)
2285 clib_warning ("[%d] sid %d: %s (%d)", getpid (),
2286 listen_session_index,
2287 vppcom_session_state_str (listen_session->state),
2288 listen_session->state);
2289 clib_spinlock_unlock (&vcm->sessions_lockp);
2293 rv = vppcom_wait_for_client_session_index (wait_for);
2296 if ((VPPCOM_DEBUG > 0))
2297 clib_warning ("[%d] sid %d, accept timed out, rv = %s (%d)",
2298 getpid (), listen_session_index,
2299 vppcom_retval_str (rv), rv);
2300 if ((wait_for == 0) || (wait_for_time > 0))
2307 clib_spinlock_lock (&vcm->sessions_lockp);
2308 clib_fifo_sub1 (vcm->client_session_index_fifo, client_session_index);
2309 rv = vppcom_session_at_index (client_session_index, &client_session);
2310 ASSERT (rv == VPPCOM_OK);
2311 ASSERT (client_session->peer_addr.is_ip4 ==
2312 listen_session->lcl_addr.is_ip4);
2314 client_session->is_nonblocking = (flags & O_NONBLOCK) ? 1 : 0;
2315 if (VPPCOM_DEBUG > 0)
2316 clib_warning ("[%d] Got a request: client sid %d, flags %d, "
2317 " is_nonblocking %u", getpid (), client_session_index,
2318 flags, client_session->is_nonblocking);
2320 ep->vrf = client_session->vrf;
2321 ep->is_cut_thru = client_session->is_cut_thru;
2322 ep->is_ip4 = client_session->peer_addr.is_ip4;
2323 ep->port = client_session->peer_port;
2324 if (client_session->peer_addr.is_ip4)
2325 clib_memcpy (ep->ip, &client_session->peer_addr.ip46.ip4,
2326 sizeof (ip4_address_t));
2328 clib_memcpy (ep->ip, &client_session->peer_addr.ip46.ip6,
2329 sizeof (ip6_address_t));
2331 if (client_session->is_server && client_session->is_cut_thru)
2333 static svm_fifo_segment_create_args_t _a;
2334 svm_fifo_segment_create_args_t *a = &_a;
2335 svm_fifo_segment_private_t *seg;
2337 cut_thru_str = "cut-thru ";
2339 /* Create the segment */
2340 memset (a, 0, sizeof (*a));
2341 a->segment_name = (char *)
2342 format ((u8 *) a->segment_name, "%d:segment%d%c",
2343 getpid (), vcm->unique_segment_index++, 0);
2344 a->segment_size = vcm->cfg.segment_size;
2345 a->preallocated_fifo_pairs = vcm->cfg.preallocated_fifo_pairs;
2346 a->rx_fifo_size = vcm->cfg.rx_fifo_size;
2347 a->tx_fifo_size = vcm->cfg.tx_fifo_size;
2349 rv = svm_fifo_segment_create (a);
2350 if (PREDICT_FALSE (rv))
2352 if (VPPCOM_DEBUG > 1)
2353 clib_warning ("[%d] svm_fifo_segment_create ('%s') failed",
2354 getpid (), a->segment_name);
2355 vec_reset_length (a->new_segment_indices);
2356 rv = VNET_API_ERROR_URI_FIFO_CREATE_FAILED;
2357 vppcom_send_connect_session_reply (client_session, rv);
2358 clib_spinlock_unlock (&vcm->sessions_lockp);
2359 return VPPCOM_ENOMEM;
2362 client_session->segment_name = vec_dup ((u8 *) a->segment_name);
2363 client_session->sm_seg_index = a->new_segment_indices[0];
2364 vec_free (a->new_segment_indices);
2366 seg = svm_fifo_segment_get_segment (client_session->sm_seg_index);
2367 client_session->server_rx_fifo =
2368 svm_fifo_segment_alloc_fifo (seg, vcm->cfg.rx_fifo_size,
2369 FIFO_SEGMENT_RX_FREELIST);
2370 if (PREDICT_FALSE (!client_session->server_rx_fifo))
2372 svm_fifo_segment_delete (seg);
2373 clib_warning ("[%d] rx fifo alloc failed, size %ld (0x%lx)",
2374 getpid (), vcm->cfg.rx_fifo_size,
2375 vcm->cfg.rx_fifo_size);
2376 rv = VNET_API_ERROR_URI_FIFO_CREATE_FAILED;
2377 vppcom_send_connect_session_reply (client_session, rv);
2378 clib_spinlock_unlock (&vcm->sessions_lockp);
2379 return VPPCOM_ENOMEM;
2381 client_session->server_rx_fifo->master_session_index =
2382 client_session_index;
2384 client_session->server_tx_fifo =
2385 svm_fifo_segment_alloc_fifo (seg, vcm->cfg.tx_fifo_size,
2386 FIFO_SEGMENT_TX_FREELIST);
2387 if (PREDICT_FALSE (!client_session->server_tx_fifo))
2389 svm_fifo_segment_delete (seg);
2390 if (VPPCOM_DEBUG > 1)
2391 clib_warning ("[%d] tx fifo alloc failed, size %ld (0x%lx)",
2392 getpid (), vcm->cfg.tx_fifo_size,
2393 vcm->cfg.tx_fifo_size);
2394 rv = VNET_API_ERROR_URI_FIFO_CREATE_FAILED;
2395 vppcom_send_connect_session_reply (client_session, rv);
2396 clib_spinlock_unlock (&vcm->sessions_lockp);
2397 return VPPCOM_ENOMEM;
2399 client_session->server_tx_fifo->master_session_index =
2400 client_session_index;
2402 if (VPPCOM_DEBUG > 1)
2403 clib_warning ("[%d] created segment '%s': rx_fifo %p, tx_fifo %p",
2404 getpid (), client_session->segment_name,
2405 client_session->server_rx_fifo,
2406 client_session->server_tx_fifo);
2408 #ifdef CUT_THRU_EVENT_QUEUE /* TBD */
2411 ssvm_shared_header_t *sh = seg->ssvm.sh;
2413 ssvm_lock_non_recursive (sh, 1);
2414 oldheap = ssvm_push_heap (sh);
2415 event_q = client_session->vpp_event_queue =
2416 unix_shared_memory_queue_init (vcm->cfg.event_queue_size,
2417 sizeof (session_fifo_event_t),
2418 getpid (), 0 /* signal not sent */ );
2419 ssvm_pop_heap (oldheap);
2420 ssvm_unlock_non_recursive (sh);
2423 vppcom_send_connect_session_reply (client_session, 0);
2428 vppcom_send_accept_session_reply (0, client_session->vpp_handle);
2431 if (VPPCOM_DEBUG > 0)
2432 clib_warning ("[%d] sid %d, accepted %sconnection to peer address "
2434 getpid (), client_session_index, cut_thru_str,
2435 format_ip46_address, &client_session->peer_addr.ip46,
2436 client_session->peer_addr.is_ip4,
2437 clib_net_to_host_u16 (client_session->peer_port));
2439 clib_spinlock_unlock (&vcm->sessions_lockp);
2440 return (int) client_session_index;
2444 vppcom_session_connect (uint32_t session_index, vppcom_endpt_t * server_ep)
2446 session_t *session = 0;
2449 clib_spinlock_lock (&vcm->sessions_lockp);
2450 rv = vppcom_session_at_index (session_index, &session);
2451 if (PREDICT_FALSE (rv))
2453 clib_spinlock_unlock (&vcm->sessions_lockp);
2454 if (VPPCOM_DEBUG > 0)
2455 clib_warning ("[%d] invalid session, sid (%u) has been closed!",
2456 getpid (), session_index);
2460 if (session->is_vep)
2462 clib_spinlock_unlock (&vcm->sessions_lockp);
2463 if (VPPCOM_DEBUG > 0)
2464 clib_warning ("[%d] invalid session, sid (%u) is an epoll session!",
2465 getpid (), session_index);
2466 return VPPCOM_EBADFD;
2469 if (session->state == STATE_CONNECT)
2471 clib_spinlock_unlock (&vcm->sessions_lockp);
2472 if (VPPCOM_DEBUG > 0)
2473 clib_warning ("[%d] session, sid (%u) already connected!",
2474 getpid (), session_index);
2478 session->vrf = server_ep->vrf;
2479 session->peer_addr.is_ip4 = server_ep->is_ip4;
2480 session->peer_addr.ip46 = to_ip46 (!server_ep->is_ip4, server_ep->ip);
2481 session->peer_port = server_ep->port;
2483 if (VPPCOM_DEBUG > 0)
2485 u8 *ip_str = format (0, "%U", format_ip46_address,
2486 &session->peer_addr.ip46,
2487 session->peer_addr.is_ip4);
2488 clib_warning ("[%d] connect sid %d to %s server port %d proto %s",
2489 getpid (), session_index, ip_str,
2490 clib_net_to_host_u16 (session->peer_port),
2491 session->proto ? "UDP" : "TCP");
2495 vppcom_send_connect_sock (session, session_index);
2496 clib_spinlock_unlock (&vcm->sessions_lockp);
2497 rv = vppcom_wait_for_session_state_change (session_index, STATE_CONNECT,
2498 vcm->cfg.session_timeout);
2499 if (PREDICT_FALSE (rv))
2501 if (VPPCOM_DEBUG > 0)
2502 clib_warning ("[%d] connect timed out, rv = %s (%d)",
2503 getpid (), vppcom_retval_str (rv), rv);
2506 if (VPPCOM_DEBUG > 0)
2507 clib_warning ("[%d] sid %d connected!", getpid (), session_index);
2513 vppcom_session_read_internal (uint32_t session_index, void *buf, int n,
2516 session_t *session = 0;
2517 svm_fifo_t *rx_fifo;
2525 clib_spinlock_lock (&vcm->sessions_lockp);
2526 rv = vppcom_session_at_index (session_index, &session);
2527 if (PREDICT_FALSE (rv))
2529 clib_spinlock_unlock (&vcm->sessions_lockp);
2530 if (VPPCOM_DEBUG > 0)
2531 clib_warning ("[%d] invalid session, sid (%u) has been closed!",
2532 getpid (), session_index);
2536 if (session->is_vep)
2538 clib_spinlock_unlock (&vcm->sessions_lockp);
2539 if (VPPCOM_DEBUG > 0)
2540 clib_warning ("[%d] invalid session, sid (%u) is an epoll session!",
2541 getpid (), session_index);
2542 return VPPCOM_EBADFD;
2545 if (session->state == STATE_DISCONNECT)
2547 clib_spinlock_unlock (&vcm->sessions_lockp);
2548 if (VPPCOM_DEBUG > 0)
2549 clib_warning ("[%d] sid (%u) has been closed by remote peer!",
2550 getpid (), session_index);
2551 return VPPCOM_ECONNRESET;
2554 rx_fifo = ((!session->is_cut_thru || session->is_server) ?
2555 session->server_rx_fifo : session->server_tx_fifo);
2556 fifo_str = ((!session->is_cut_thru || session->is_server) ?
2557 "server_rx_fifo" : "server_tx_fifo");
2559 ((EPOLLET | EPOLLIN) & session->vep.ev.events) == (EPOLLET | EPOLLIN);
2560 clib_spinlock_unlock (&vcm->sessions_lockp);
2565 n_read = svm_fifo_peek (rx_fifo, 0, n, buf);
2567 n_read = svm_fifo_dequeue_nowait (rx_fifo, n, buf);
2569 while (!session->is_nonblocking && (n_read <= 0));
2571 if (poll_et && (n_read <= 0))
2573 clib_spinlock_lock (&vcm->sessions_lockp);
2574 session->vep.et_mask |= EPOLLIN;
2575 clib_spinlock_unlock (&vcm->sessions_lockp);
2578 if ((VPPCOM_DEBUG > 2) && (n_read > 0))
2579 clib_warning ("[%d] sid %d, read %d bytes from %s (%p)", getpid (),
2580 session_index, n_read, fifo_str, rx_fifo);
2582 return (n_read <= 0) ? VPPCOM_EAGAIN : n_read;
2586 vppcom_session_read (uint32_t session_index, void *buf, int n)
2588 return (vppcom_session_read_internal (session_index, buf, n, 0));
2592 vppcom_session_peek (uint32_t session_index, void *buf, int n)
2594 return (vppcom_session_read_internal (session_index, buf, n, 1));
2598 vppcom_session_read_ready (session_t * session, u32 session_index)
2600 svm_fifo_t *rx_fifo = 0;
2604 /* Assumes caller has acquired spinlock: vcm->sessions_lockp */
2605 if (session->is_vep)
2607 clib_spinlock_unlock (&vcm->sessions_lockp);
2608 if (VPPCOM_DEBUG > 0)
2609 clib_warning ("[%d] invalid session, sid (%u) is an epoll session!",
2610 getpid (), session_index);
2611 return VPPCOM_EBADFD;
2614 if (session->state == STATE_DISCONNECT)
2616 if (VPPCOM_DEBUG > 0)
2617 clib_warning ("[%d] sid (%u) has been closed by remote peer!",
2618 getpid (), session_index);
2619 return VPPCOM_ECONNRESET;
2622 if (session->is_listen)
2623 ready = clib_fifo_elts (vcm->client_session_index_fifo);
2626 rx_fifo = ((!session->is_cut_thru || session->is_server) ?
2627 session->server_rx_fifo : session->server_tx_fifo);
2629 ready = svm_fifo_max_dequeue (rx_fifo);
2633 ((EPOLLET | EPOLLIN) & session->vep.ev.events) == (EPOLLET | EPOLLIN);
2634 if (poll_et && (ready == 0))
2636 if (VPPCOM_DEBUG > 11)
2637 clib_warning ("[%d] sid %d: current vep.et_mask = 0x%x", getpid (),
2638 session_index, session->vep.et_mask);
2639 session->vep.et_mask |= EPOLLIN;
2640 if (VPPCOM_DEBUG > 11)
2641 clib_warning ("[%d] sid %d: updated vep.et_mask = 0x%x", getpid (),
2642 session_index, session->vep.et_mask);
2645 if (session->vep.et_mask && (VPPCOM_DEBUG > 11))
2646 clib_warning ("[%d] sid %d, is_listen %u, peek %s (%p), ready = %d, "
2648 getpid (), session_index, session->is_listen,
2649 session->is_server ? "server_rx_fifo" : "server_tx_fifo",
2650 rx_fifo, ready, session->vep.et_mask);
2655 vppcom_session_write (uint32_t session_index, void *buf, int n)
2657 session_t *session = 0;
2658 svm_fifo_t *tx_fifo;
2659 unix_shared_memory_queue_t *q;
2660 session_fifo_event_t evt;
2667 clib_spinlock_lock (&vcm->sessions_lockp);
2668 rv = vppcom_session_at_index (session_index, &session);
2669 if (PREDICT_FALSE (rv))
2671 clib_spinlock_unlock (&vcm->sessions_lockp);
2672 if (VPPCOM_DEBUG > 0)
2673 clib_warning ("[%d] invalid session, sid (%u) has been closed!",
2674 getpid (), session_index);
2678 if (session->is_vep)
2680 clib_spinlock_unlock (&vcm->sessions_lockp);
2681 if (VPPCOM_DEBUG > 0)
2682 clib_warning ("[%d] invalid session, sid (%u) is an epoll session!",
2683 getpid (), session_index);
2684 return VPPCOM_EBADFD;
2687 if (session->state == STATE_DISCONNECT)
2689 clib_spinlock_unlock (&vcm->sessions_lockp);
2690 if (VPPCOM_DEBUG > 0)
2691 clib_warning ("[%d] sid (%u) has been closed by remote peer!",
2692 getpid (), session_index);
2693 return VPPCOM_ECONNRESET;
2696 tx_fifo = ((!session->is_cut_thru || session->is_server) ?
2697 session->server_tx_fifo : session->server_rx_fifo);
2698 fifo_str = ((!session->is_cut_thru || session->is_server) ?
2699 "server_tx_fifo" : "server_rx_fifo");
2700 q = session->vpp_event_queue;
2701 poll_et = (((EPOLLET | EPOLLOUT) & session->vep.ev.events) ==
2702 (EPOLLET | EPOLLOUT));
2703 clib_spinlock_unlock (&vcm->sessions_lockp);
2707 n_write = svm_fifo_enqueue_nowait (tx_fifo, n, buf);
2709 while (!session->is_nonblocking && (n_write <= 0));
2711 /* If event wasn't set, add one */
2712 if (!session->is_cut_thru && (n_write > 0) && svm_fifo_set_event (tx_fifo))
2716 /* Fabricate TX event, send to vpp */
2718 evt.event_type = FIFO_EVENT_APP_TX;
2720 rval = vppcom_session_at_index (session_index, &session);
2721 if (PREDICT_FALSE (rval))
2723 if (VPPCOM_DEBUG > 1)
2724 clib_warning ("[%d] invalid session, sid (%u) has been closed!",
2725 getpid (), session_index);
2729 unix_shared_memory_queue_add (q, (u8 *) & evt,
2730 0 /* do wait for mutex */ );
2733 if (poll_et && (n_write <= 0))
2735 clib_spinlock_lock (&vcm->sessions_lockp);
2736 session->vep.et_mask |= EPOLLOUT;
2737 clib_spinlock_unlock (&vcm->sessions_lockp);
2740 if (VPPCOM_DEBUG > 2)
2743 clib_warning ("[%d] sid %d, FIFO-FULL %s (%p)", getpid (),
2744 session_index, fifo_str, tx_fifo);
2746 clib_warning ("[%d] sid %d, wrote %d bytes to %s (%p)", getpid (),
2747 session_index, n_write, fifo_str, tx_fifo);
2749 return (n_write < 0) ? VPPCOM_EAGAIN : n_write;
2753 vppcom_session_write_ready (session_t * session, u32 session_index)
2755 svm_fifo_t *tx_fifo;
2760 /* Assumes caller has acquired spinlock: vcm->sessions_lockp */
2761 if (session->is_vep)
2763 clib_spinlock_unlock (&vcm->sessions_lockp);
2764 if (VPPCOM_DEBUG > 0)
2765 clib_warning ("[%d] invalid session, sid (%u) is an epoll session!",
2766 getpid (), session_index);
2767 return VPPCOM_EBADFD;
2770 if (session->state == STATE_DISCONNECT)
2772 if (VPPCOM_DEBUG > 0)
2773 clib_warning ("[%d] sid (%u) has been closed by remote peer!",
2774 getpid (), session_index);
2775 return VPPCOM_ECONNRESET;
2778 tx_fifo = ((!session->is_cut_thru || session->is_server) ?
2779 session->server_tx_fifo : session->server_rx_fifo);
2780 fifo_str = ((!session->is_cut_thru || session->is_server) ?
2781 "server_tx_fifo" : "server_rx_fifo");
2783 ready = svm_fifo_max_enqueue (tx_fifo);
2785 if (VPPCOM_DEBUG > 3)
2786 clib_warning ("[%d] sid %d, peek %s (%p), ready = %d", getpid (),
2787 session_index, fifo_str, tx_fifo, ready);
2788 poll_et = (((EPOLLET | EPOLLOUT) & session->vep.ev.events) ==
2789 (EPOLLET | EPOLLOUT));
2790 if (poll_et && (ready == 0))
2791 session->vep.et_mask |= EPOLLOUT;
2797 vppcom_select (unsigned long n_bits, unsigned long *read_map,
2798 unsigned long *write_map, unsigned long *except_map,
2799 double time_to_wait)
2802 session_t *session = 0;
2803 int rv, bits_set = 0;
2804 f64 timeout = clib_time_now (&vcm->clib_time) + time_to_wait;
2805 u32 minbits = clib_max (n_bits, BITS (uword));
2807 ASSERT (sizeof (clib_bitmap_t) == sizeof (long int));
2809 if (n_bits && read_map)
2811 clib_bitmap_validate (vcm->rd_bitmap, minbits);
2812 clib_memcpy (vcm->rd_bitmap, read_map, vec_len (vcm->rd_bitmap));
2813 memset (read_map, 0, vec_len (vcm->rd_bitmap));
2815 if (n_bits && write_map)
2817 clib_bitmap_validate (vcm->wr_bitmap, minbits);
2818 clib_memcpy (vcm->wr_bitmap, write_map, vec_len (vcm->wr_bitmap));
2819 memset (write_map, 0, vec_len (vcm->wr_bitmap));
2821 if (n_bits && except_map)
2823 clib_bitmap_validate (vcm->ex_bitmap, minbits);
2824 clib_memcpy (vcm->ex_bitmap, except_map, vec_len (vcm->ex_bitmap));
2825 memset (except_map, 0, vec_len (vcm->ex_bitmap));
2835 clib_bitmap_foreach (session_index, vcm->rd_bitmap,
2837 clib_spinlock_lock (&vcm->sessions_lockp);
2838 rv = vppcom_session_at_index (session_index, &session);
2841 clib_spinlock_unlock (&vcm->sessions_lockp);
2842 if (VPPCOM_DEBUG > 1)
2843 clib_warning ("[%d] session %d specified in "
2844 "read_map is closed.", getpid (),
2846 bits_set = VPPCOM_EBADFD;
2850 rv = vppcom_session_read_ready (session, session_index);
2851 clib_spinlock_unlock (&vcm->sessions_lockp);
2852 if (except_map && vcm->ex_bitmap &&
2853 clib_bitmap_get (vcm->ex_bitmap, session_index) &&
2856 // TBD: clib_warning
2857 clib_bitmap_set_no_check (except_map, session_index, 1);
2862 // TBD: clib_warning
2863 clib_bitmap_set_no_check (read_map, session_index, 1);
2871 clib_bitmap_foreach (session_index, vcm->wr_bitmap,
2873 clib_spinlock_lock (&vcm->sessions_lockp);
2874 rv = vppcom_session_at_index (session_index, &session);
2877 clib_spinlock_unlock (&vcm->sessions_lockp);
2878 if (VPPCOM_DEBUG > 0)
2879 clib_warning ("[%d] session %d specified in "
2880 "write_map is closed.", getpid (),
2882 bits_set = VPPCOM_EBADFD;
2886 rv = vppcom_session_write_ready (session, session_index);
2887 clib_spinlock_unlock (&vcm->sessions_lockp);
2888 if (write_map && (rv > 0))
2890 // TBD: clib_warning
2891 clib_bitmap_set_no_check (write_map, session_index, 1);
2899 clib_bitmap_foreach (session_index, vcm->ex_bitmap,
2901 clib_spinlock_lock (&vcm->sessions_lockp);
2902 rv = vppcom_session_at_index (session_index, &session);
2905 clib_spinlock_unlock (&vcm->sessions_lockp);
2906 if (VPPCOM_DEBUG > 1)
2907 clib_warning ("[%d] session %d specified in "
2908 "except_map is closed.", getpid (),
2910 bits_set = VPPCOM_EBADFD;
2914 rv = vppcom_session_read_ready (session, session_index);
2915 clib_spinlock_unlock (&vcm->sessions_lockp);
2918 // TBD: clib_warning
2919 clib_bitmap_set_no_check (except_map, session_index, 1);
2927 while (clib_time_now (&vcm->clib_time) < timeout);
2934 vep_verify_epoll_chain (u32 vep_idx)
2937 vppcom_epoll_t *vep;
2941 if (VPPCOM_DEBUG <= 1)
2944 /* Assumes caller has acquired spinlock: vcm->sessions_lockp */
2945 rv = vppcom_session_at_index (vep_idx, &session);
2946 if (PREDICT_FALSE (rv))
2948 clib_warning ("[%d] ERROR: Invalid vep_idx (%u)!", getpid (), vep_idx);
2951 if (PREDICT_FALSE (!session->is_vep))
2953 clib_warning ("[%d] ERROR: vep_idx (%u) is not a vep!", getpid (),
2957 clib_warning ("[%d] vep_idx (%u): Dumping epoll chain\n"
2960 " is_vep_session = %u\n"
2961 " wait_cont_idx = 0x%x (%u)\n"
2963 vep_idx, session->is_vep, session->is_vep_session,
2964 session->wait_cont_idx, session->wait_cont_idx);
2967 vep = &session->vep;
2968 sid = vep->next_sid;
2971 rv = vppcom_session_at_index (sid, &session);
2972 if (PREDICT_FALSE (rv))
2974 clib_warning ("[%d] ERROR: Invalid sid (%u)!", getpid (), sid);
2977 if (PREDICT_FALSE (session->is_vep))
2978 clib_warning ("[%d] ERROR: sid (%u) is a vep!",
2979 getpid (), vep_idx);
2980 else if (PREDICT_FALSE (!session->is_vep_session))
2982 clib_warning ("[%d] ERROR: session (%u) is not a vep session!",
2986 if (PREDICT_FALSE (session->vep.vep_idx != vep_idx))
2987 clib_warning ("[%d] ERROR: session (%u) vep_idx (%u) != "
2988 "vep_idx (%u)!", getpid (),
2989 sid, session->vep.vep_idx, vep_idx);
2990 if (session->is_vep_session)
2992 clib_warning ("vep_idx[%u]: sid 0x%x (%u)\n"
2994 " next_sid = 0x%x (%u)\n"
2995 " prev_sid = 0x%x (%u)\n"
2996 " vep_idx = 0x%x (%u)\n"
2997 " ev.events = 0x%x\n"
2998 " ev.data.u64 = 0x%llx\n"
3002 vep->next_sid, vep->next_sid,
3003 vep->prev_sid, vep->prev_sid,
3004 vep->vep_idx, vep->vep_idx,
3005 vep->ev.events, vep->ev.data.u64, vep->et_mask);
3012 clib_warning ("[%d] vep_idx (%u): Dump complete!\n", getpid (), vep_idx);
3016 vppcom_epoll_create (void)
3018 session_t *vep_session;
3021 clib_spinlock_lock (&vcm->sessions_lockp);
3022 pool_get (vcm->sessions, vep_session);
3023 memset (vep_session, 0, sizeof (*vep_session));
3024 vep_idx = vep_session - vcm->sessions;
3026 vep_session->is_vep = 1;
3027 vep_session->vep.vep_idx = ~0;
3028 vep_session->vep.next_sid = ~0;
3029 vep_session->vep.prev_sid = ~0;
3030 vep_session->wait_cont_idx = ~0;
3031 clib_spinlock_unlock (&vcm->sessions_lockp);
3033 if (VPPCOM_DEBUG > 0)
3034 clib_warning ("[%d] Created vep_idx %u!", getpid (), vep_idx);
3040 vppcom_epoll_ctl (uint32_t vep_idx, int op, uint32_t session_index,
3041 struct epoll_event *event)
3043 session_t *vep_session;
3047 if (vep_idx == session_index)
3049 if (VPPCOM_DEBUG > 0)
3050 clib_warning ("[%d] ERROR: vep_idx == session_index (%u)!",
3051 getpid (), vep_idx);
3052 return VPPCOM_EINVAL;
3055 clib_spinlock_lock (&vcm->sessions_lockp);
3056 rv = vppcom_session_at_index (vep_idx, &vep_session);
3057 if (PREDICT_FALSE (rv))
3059 if (VPPCOM_DEBUG > 0)
3060 clib_warning ("[%d] ERROR: Invalid vep_idx (%u)!", vep_idx);
3063 if (PREDICT_FALSE (!vep_session->is_vep))
3065 if (VPPCOM_DEBUG > 0)
3066 clib_warning ("[%d] ERROR: vep_idx (%u) is not a vep!",
3067 getpid (), vep_idx);
3072 ASSERT (vep_session->vep.vep_idx == ~0);
3073 ASSERT (vep_session->vep.prev_sid == ~0);
3075 rv = vppcom_session_at_index (session_index, &session);
3076 if (PREDICT_FALSE (rv))
3078 if (VPPCOM_DEBUG > 0)
3079 clib_warning ("[%d] ERROR: Invalid session_index (%u)!",
3080 getpid (), session_index);
3083 if (PREDICT_FALSE (session->is_vep))
3085 if (VPPCOM_DEBUG > 0)
3086 clib_warning ("ERROR: session_index (%u) is a vep!", vep_idx);
3094 if (PREDICT_FALSE (!event))
3096 clib_warning ("[%d] ERROR: EPOLL_CTL_ADD: NULL pointer to "
3097 "epoll_event structure!", getpid ());
3101 if (vep_session->vep.next_sid != ~0)
3103 session_t *next_session;
3104 rv = vppcom_session_at_index (vep_session->vep.next_sid,
3106 if (PREDICT_FALSE (rv))
3108 if (VPPCOM_DEBUG > 0)
3109 clib_warning ("[%d] ERROR: EPOLL_CTL_ADD: Invalid "
3110 "vep.next_sid (%u) on vep_idx (%u)!",
3111 getpid (), vep_session->vep.next_sid, vep_idx);
3114 ASSERT (next_session->vep.prev_sid == vep_idx);
3115 next_session->vep.prev_sid = session_index;
3117 session->vep.next_sid = vep_session->vep.next_sid;
3118 session->vep.prev_sid = vep_idx;
3119 session->vep.vep_idx = vep_idx;
3120 session->vep.et_mask = VEP_DEFAULT_ET_MASK;
3121 session->vep.ev = *event;
3122 session->is_vep_session = 1;
3123 vep_session->vep.next_sid = session_index;
3124 if (VPPCOM_DEBUG > 1)
3125 clib_warning ("[%d] EPOLL_CTL_ADD: vep_idx %u, sid %u, events 0x%x,"
3126 " data 0x%llx!", getpid (), vep_idx, session_index,
3127 event->events, event->data.u64);
3131 if (PREDICT_FALSE (!event))
3133 clib_warning ("[%d] ERROR: EPOLL_CTL_MOD: NULL pointer to "
3134 "epoll_event structure!", getpid ());
3138 if (PREDICT_FALSE (!session->is_vep_session &&
3139 (session->vep.vep_idx != vep_idx)))
3141 if (VPPCOM_DEBUG > 0)
3143 if (!session->is_vep_session)
3144 clib_warning ("[%d] ERROR: EPOLL_CTL_MOD: session (%u) "
3145 "is not a vep session!",
3146 getpid (), session_index);
3148 clib_warning ("[%d] ERROR: EPOLL_CTL_MOD: session (%u) "
3149 "vep_idx (%u) != vep_idx (%u)!",
3150 getpid (), session_index,
3151 session->vep.vep_idx, vep_idx);
3156 session->vep.et_mask = VEP_DEFAULT_ET_MASK;
3157 session->vep.ev = *event;
3158 if (VPPCOM_DEBUG > 1)
3159 clib_warning ("[%d] EPOLL_CTL_MOD: vep_idx %u, sid %u, events 0x%x,"
3160 " data 0x%llx!", getpid (), vep_idx, session_index,
3161 event->events, event->data.u64);
3165 if (PREDICT_FALSE (!session->is_vep_session &&
3166 (session->vep.vep_idx != vep_idx)))
3168 if (VPPCOM_DEBUG > 0)
3170 if (!session->is_vep_session)
3171 clib_warning ("[%d] ERROR: EPOLL_CTL_DEL: session (%u) "
3172 "is not a vep session!",
3173 getpid (), session_index);
3175 clib_warning ("[%d] ERROR: EPOLL_CTL_DEL: session (%u) "
3176 "vep_idx (%u) != vep_idx (%u)!",
3177 getpid (), session_index,
3178 session->vep.vep_idx, vep_idx);
3184 vep_session->wait_cont_idx =
3185 (vep_session->wait_cont_idx == session_index) ?
3186 session->vep.next_sid : vep_session->wait_cont_idx;
3188 if (session->vep.prev_sid == vep_idx)
3189 vep_session->vep.next_sid = session->vep.next_sid;
3192 session_t *prev_session;
3193 rv = vppcom_session_at_index (session->vep.prev_sid, &prev_session);
3194 if (PREDICT_FALSE (rv))
3196 if (VPPCOM_DEBUG > 0)
3197 clib_warning ("[%d] ERROR: EPOLL_CTL_DEL: Invalid "
3198 "vep.prev_sid (%u) on sid (%u)!",
3199 getpid (), session->vep.prev_sid,
3203 ASSERT (prev_session->vep.next_sid == session_index);
3204 prev_session->vep.next_sid = session->vep.next_sid;
3206 if (session->vep.next_sid != ~0)
3208 session_t *next_session;
3209 rv = vppcom_session_at_index (session->vep.next_sid, &next_session);
3210 if (PREDICT_FALSE (rv))
3212 if (VPPCOM_DEBUG > 0)
3213 clib_warning ("[%d] ERROR: EPOLL_CTL_DEL: Invalid "
3214 "vep.next_sid (%u) on sid (%u)!",
3215 getpid (), session->vep.next_sid,
3219 ASSERT (next_session->vep.prev_sid == session_index);
3220 next_session->vep.prev_sid = session->vep.prev_sid;
3223 memset (&session->vep, 0, sizeof (session->vep));
3224 session->vep.next_sid = ~0;
3225 session->vep.prev_sid = ~0;
3226 session->vep.vep_idx = ~0;
3227 session->is_vep_session = 0;
3228 if (VPPCOM_DEBUG > 1)
3229 clib_warning ("[%d] EPOLL_CTL_DEL: vep_idx %u, sid %u!",
3230 getpid (), vep_idx, session_index);
3234 clib_warning ("[%d] ERROR: Invalid operation (%d)!", getpid (), op);
3238 vep_verify_epoll_chain (vep_idx);
3241 clib_spinlock_unlock (&vcm->sessions_lockp);
3246 vppcom_epoll_wait (uint32_t vep_idx, struct epoll_event *events,
3247 int maxevents, double wait_for_time)
3249 session_t *vep_session;
3251 f64 timeout = clib_time_now (&vcm->clib_time) + wait_for_time;
3252 u32 keep_trying = 1;
3254 u32 vep_next_sid, wait_cont_idx;
3257 if (PREDICT_FALSE (maxevents <= 0))
3259 if (VPPCOM_DEBUG > 0)
3260 clib_warning ("[%d] ERROR: Invalid maxevents (%d)!",
3261 getpid (), maxevents);
3262 return VPPCOM_EINVAL;
3264 memset (events, 0, sizeof (*events) * maxevents);
3266 VCL_LOCK_AND_GET_SESSION (vep_idx, &vep_session);
3267 vep_next_sid = vep_session->vep.next_sid;
3268 is_vep = vep_session->is_vep;
3269 wait_cont_idx = vep_session->wait_cont_idx;
3270 clib_spinlock_unlock (&vcm->sessions_lockp);
3272 if (PREDICT_FALSE (!is_vep))
3274 if (VPPCOM_DEBUG > 0)
3275 clib_warning ("[%d] ERROR: vep_idx (%u) is not a vep!",
3276 getpid (), vep_idx);
3280 if (PREDICT_FALSE (vep_next_sid == ~0))
3282 if (VPPCOM_DEBUG > 0)
3283 clib_warning ("[%d] WARNING: vep_idx (%u) is empty!",
3284 getpid (), vep_idx);
3294 for (sid = (wait_cont_idx == ~0) ? vep_next_sid : wait_cont_idx;
3295 sid != ~0; sid = next_sid)
3297 u32 session_events, et_mask, clear_et_mask, session_vep_idx;
3298 u8 add_event, is_vep_session;
3300 u64 session_ev_data;
3302 VCL_LOCK_AND_GET_SESSION (sid, &session);
3303 next_sid = session->vep.next_sid;
3304 session_events = session->vep.ev.events;
3305 et_mask = session->vep.et_mask;
3306 is_vep = session->is_vep;
3307 is_vep_session = session->is_vep_session;
3308 session_vep_idx = session->vep.vep_idx;
3309 session_ev_data = session->vep.ev.data.u64;
3310 clib_spinlock_unlock (&vcm->sessions_lockp);
3312 if (PREDICT_FALSE (is_vep))
3314 if (VPPCOM_DEBUG > 0)
3315 clib_warning ("[%d] ERROR: sid (%u) is a vep!",
3316 getpid (), vep_idx);
3320 if (PREDICT_FALSE (!is_vep_session))
3322 if (VPPCOM_DEBUG > 0)
3323 clib_warning ("[%d] ERROR: session (%u) is not "
3324 "a vep session!", getpid (), sid);
3328 if (PREDICT_FALSE (session_vep_idx != vep_idx))
3330 clib_warning ("[%d] ERROR: session (%u) "
3331 "vep_idx (%u) != vep_idx (%u)!",
3332 getpid (), sid, session->vep.vep_idx, vep_idx);
3337 add_event = clear_et_mask = 0;
3339 if (EPOLLIN & session_events)
3341 VCL_LOCK_AND_GET_SESSION (sid, &session);
3342 ready = vppcom_session_read_ready (session, sid);
3343 clib_spinlock_unlock (&vcm->sessions_lockp);
3344 if ((ready > 0) && (EPOLLIN & et_mask))
3347 events[num_ev].events |= EPOLLIN;
3348 if (((EPOLLET | EPOLLIN) & session_events) ==
3349 (EPOLLET | EPOLLIN))
3350 clear_et_mask |= EPOLLIN;
3357 case VPPCOM_ECONNRESET:
3358 events[num_ev].events |= EPOLLHUP | EPOLLRDHUP;
3362 events[num_ev].events |= EPOLLERR;
3368 if (EPOLLOUT & session_events)
3370 VCL_LOCK_AND_GET_SESSION (sid, &session);
3371 ready = vppcom_session_write_ready (session, sid);
3372 clib_spinlock_unlock (&vcm->sessions_lockp);
3373 if ((ready > 0) && (EPOLLOUT & et_mask))
3376 events[num_ev].events |= EPOLLOUT;
3377 if (((EPOLLET | EPOLLOUT) & session_events) ==
3378 (EPOLLET | EPOLLOUT))
3379 clear_et_mask |= EPOLLOUT;
3386 case VPPCOM_ECONNRESET:
3387 events[num_ev].events |= EPOLLHUP;
3391 events[num_ev].events |= EPOLLERR;
3399 events[num_ev].data.u64 = session_ev_data;
3400 if (EPOLLONESHOT & session_events)
3402 VCL_LOCK_AND_GET_SESSION (sid, &session);
3403 session->vep.ev.events = 0;
3404 clib_spinlock_unlock (&vcm->sessions_lockp);
3407 if (num_ev == maxevents)
3409 VCL_LOCK_AND_GET_SESSION (vep_idx, &vep_session);
3410 vep_session->wait_cont_idx = next_sid;
3411 clib_spinlock_unlock (&vcm->sessions_lockp);
3415 if (wait_cont_idx != ~0)
3418 next_sid = vep_next_sid;
3419 else if (next_sid == wait_cont_idx)
3423 if (wait_for_time != -1)
3424 keep_trying = (clib_time_now (&vcm->clib_time) <= timeout) ? 1 : 0;
3426 while ((num_ev == 0) && keep_trying);
3428 if (wait_cont_idx != ~0)
3430 VCL_LOCK_AND_GET_SESSION (vep_idx, &vep_session);
3431 vep_session->wait_cont_idx = ~0;
3432 clib_spinlock_unlock (&vcm->sessions_lockp);
3435 return (rv != VPPCOM_OK) ? rv : num_ev;
3439 vppcom_session_attr (uint32_t session_index, uint32_t op,
3440 void *buffer, uint32_t * buflen)
3444 u32 *flags = buffer;
3445 vppcom_endpt_t *ep = buffer;
3447 VCL_LOCK_AND_GET_SESSION (session_index, &session);
3450 case VPPCOM_ATTR_GET_NREAD:
3451 rv = vppcom_session_read_ready (session, session_index);
3452 if (VPPCOM_DEBUG > 2)
3453 clib_warning ("[%d] VPPCOM_ATTR_GET_NREAD: sid %u, nread = %d",
3458 case VPPCOM_ATTR_GET_NWRITE:
3459 rv = vppcom_session_write_ready (session, session_index);
3460 if (VPPCOM_DEBUG > 2)
3461 clib_warning ("[%d] VPPCOM_ATTR_GET_NWRITE: sid %u, nwrite = %d",
3462 getpid (), session_index, rv);
3466 case VPPCOM_ATTR_GET_FLAGS:
3467 if (buffer && buflen && (*buflen >= sizeof (*flags)))
3469 *flags = O_RDWR | ((session->is_nonblocking) ? O_NONBLOCK : 0);
3470 *buflen = sizeof (*flags);
3471 if (VPPCOM_DEBUG > 2)
3472 clib_warning ("[%d] VPPCOM_ATTR_GET_FLAGS: sid %u, "
3473 "flags = 0x%08x, is_nonblocking = %u", getpid (),
3474 session_index, *flags, session->is_nonblocking);
3480 case VPPCOM_ATTR_SET_FLAGS:
3481 if (buffer && buflen && (*buflen >= sizeof (*flags)))
3483 session->is_nonblocking = (*flags & O_NONBLOCK) ? 1 : 0;
3484 if (VPPCOM_DEBUG > 2)
3485 clib_warning ("[%d] VPPCOM_ATTR_SET_FLAGS: sid %u, "
3486 "flags = 0x%08x, is_nonblocking = %u",
3487 getpid (), *flags, session->is_nonblocking);
3493 case VPPCOM_ATTR_GET_PEER_ADDR:
3494 if (buffer && buflen && (*buflen >= sizeof (*ep)))
3496 ep->vrf = session->vrf;
3497 ep->is_ip4 = session->peer_addr.is_ip4;
3498 ep->port = session->peer_port;
3499 if (session->peer_addr.is_ip4)
3500 clib_memcpy (ep->ip, &session->peer_addr.ip46.ip4,
3501 sizeof (ip4_address_t));
3503 clib_memcpy (ep->ip, &session->peer_addr.ip46.ip6,
3504 sizeof (ip6_address_t));
3505 *buflen = sizeof (*ep);
3506 if (VPPCOM_DEBUG > 1)
3507 clib_warning ("[%d] VPPCOM_ATTR_GET_PEER_ADDR: sid %u, is_ip4 = "
3508 "%u, addr = %U, port %u", getpid (),
3509 session_index, ep->is_ip4, format_ip46_address,
3510 &session->peer_addr.ip46, ep->is_ip4,
3511 clib_net_to_host_u16 (ep->port));
3517 case VPPCOM_ATTR_GET_LCL_ADDR:
3518 if (buffer && buflen && (*buflen >= sizeof (*ep)))
3520 ep->vrf = session->vrf;
3521 ep->is_ip4 = session->lcl_addr.is_ip4;
3522 ep->port = session->lcl_port;
3523 if (session->lcl_addr.is_ip4)
3524 clib_memcpy (ep->ip, &session->lcl_addr.ip46.ip4,
3525 sizeof (ip4_address_t));
3527 clib_memcpy (ep->ip, &session->lcl_addr.ip46.ip6,
3528 sizeof (ip6_address_t));
3529 *buflen = sizeof (*ep);
3530 if (VPPCOM_DEBUG > 1)
3531 clib_warning ("[%d] VPPCOM_ATTR_GET_LCL_ADDR: sid %u, is_ip4 = "
3532 "%u, addr = %U port %d", getpid (),
3533 session_index, ep->is_ip4, format_ip46_address,
3534 &session->lcl_addr.ip46, ep->is_ip4,
3535 clib_net_to_host_u16 (ep->port));
3541 case VPPCOM_ATTR_SET_REUSEADDR:
3544 case VPPCOM_ATTR_SET_BROADCAST:
3547 case VPPCOM_ATTR_SET_V6ONLY:
3550 case VPPCOM_ATTR_SET_KEEPALIVE:
3553 case VPPCOM_ATTR_SET_TCP_KEEPIDLE:
3556 case VPPCOM_ATTR_SET_TCP_KEEPINTVL:
3565 clib_spinlock_unlock (&vcm->sessions_lockp);
3570 vppcom_session_recvfrom (uint32_t session_index, void *buffer,
3571 uint32_t buflen, int flags, vppcom_endpt_t * ep)
3574 session_t *session = 0;
3578 clib_spinlock_lock (&vcm->sessions_lockp);
3579 rv = vppcom_session_at_index (session_index, &session);
3580 if (PREDICT_FALSE (rv))
3582 clib_spinlock_unlock (&vcm->sessions_lockp);
3583 if (VPPCOM_DEBUG > 0)
3584 clib_warning ("[%d] invalid session, sid (%u) has been closed!",
3585 getpid (), session_index);
3587 clib_spinlock_unlock (&vcm->sessions_lockp);
3590 ep->vrf = session->vrf;
3591 ep->is_ip4 = session->peer_addr.is_ip4;
3592 ep->port = session->peer_port;
3593 if (session->peer_addr.is_ip4)
3594 clib_memcpy (ep->ip, &session->peer_addr.ip46.ip4,
3595 sizeof (ip4_address_t));
3597 clib_memcpy (ep->ip, &session->peer_addr.ip46.ip6,
3598 sizeof (ip6_address_t));
3599 clib_spinlock_unlock (&vcm->sessions_lockp);
3603 rv = vppcom_session_read (session_index, buffer, buflen);
3604 else if (flags & MSG_PEEK)
3605 rv = vppcom_session_peek (session_index, buffer, buflen);
3608 clib_warning ("[%d] Unsupport flags for recvfrom %d", getpid (), flags);
3609 rv = VPPCOM_EAFNOSUPPORT;
3617 vppcom_session_sendto (uint32_t session_index, void *buffer,
3618 uint32_t buflen, int flags, vppcom_endpt_t * ep)
3621 return VPPCOM_EINVAL;
3626 return VPPCOM_EINVAL;
3631 // TBD check the flags and do the right thing
3632 if (VPPCOM_DEBUG > 2)
3633 clib_warning ("[%d] handling flags 0x%u (%d) not implemented yet.",
3634 getpid (), flags, flags);
3637 return (vppcom_session_write (session_index, buffer, buflen));
3641 * fd.io coding-style-patch-verification: ON
3644 * eval: (c-set-style "gnu")