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_session_table_add_listener (u64 listener_handle, u32 value)
312 /* Session and listener handles have different formats. The latter has
313 * the thread index in the upper 32 bits while the former has the session
314 * type. Knowing that, for listeners we just flip the MSB to 1 */
315 listener_handle |= 1ULL << 63;
316 hash_set (vcm->session_index_by_vpp_handles, listener_handle, value);
319 static inline session_t *
320 vppcom_session_table_lookup_listener (u64 listener_handle)
323 u64 handle = listener_handle | (1ULL << 63);
324 p = hash_get (vcm->session_index_by_vpp_handles, handle);
327 clib_warning ("[%d] couldn't find listen session: unknown vpp "
328 "listener handle %llx", getpid (), listener_handle);
331 if (pool_is_free_index (vcm->sessions, p[0]))
333 if (VPPCOM_DEBUG > 1)
334 clib_warning ("[%d] invalid listen session, sid (%u)", getpid (),
339 return pool_elt_at_index (vcm->sessions, p[0]);
343 vppcom_session_table_del_listener (u64 listener_handle)
345 listener_handle |= 1ULL << 63;
346 hash_unset (vcm->session_index_by_vpp_handles, listener_handle);
350 vppcom_connect_to_vpp (char *app_name)
352 api_main_t *am = &api_main;
354 if (VPPCOM_DEBUG > 0)
355 printf ("\nConnecting to VPP api...");
356 if (vl_client_connect_to_vlib ("/vpe-api", app_name, 32) < 0)
358 clib_warning ("[%d] connect to vpp (%s) failed!", getpid (), app_name);
359 return VPPCOM_ECONNREFUSED;
362 vcm->vl_input_queue = am->shmem_hdr->vl_input_queue;
363 vcm->my_client_index = am->my_client_index;
364 if (VPPCOM_DEBUG > 0)
365 printf (" connected!\n");
367 vcm->app_state = STATE_APP_CONN_VPP;
372 format_api_error (u8 * s, va_list * args)
374 i32 error = va_arg (*args, u32);
377 p = hash_get (vcm->error_string_by_error_number, -error);
380 s = format (s, "%s (%d)", p[0], error);
382 s = format (s, "%d", error);
387 vppcom_init_error_string_table (void)
389 vcm->error_string_by_error_number = hash_create (0, sizeof (uword));
391 #define _(n,v,s) hash_set (vcm->error_string_by_error_number, -v, s);
392 foreach_vnet_api_error;
395 hash_set (vcm->error_string_by_error_number, 99, "Misc");
399 vppcom_wait_for_app_state_change (app_state_t app_state)
401 f64 timeout = clib_time_now (&vcm->clib_time) + vcm->cfg.app_timeout;
403 while (clib_time_now (&vcm->clib_time) < timeout)
405 if (vcm->app_state == app_state)
408 if (VPPCOM_DEBUG > 0)
409 clib_warning ("[%d] timeout waiting for state %s (%d)", getpid (),
410 vppcom_app_state_str (app_state), app_state);
411 return VPPCOM_ETIMEDOUT;
415 vppcom_wait_for_session_state_change (u32 session_index,
416 session_state_t state,
419 f64 timeout = clib_time_now (&vcm->clib_time) + wait_for_time;
420 session_t *volatile session;
425 clib_spinlock_lock (&vcm->sessions_lockp);
426 rv = vppcom_session_at_index (session_index, &session);
427 if (PREDICT_FALSE (rv))
429 clib_spinlock_unlock (&vcm->sessions_lockp);
432 if (session->state == state)
434 clib_spinlock_unlock (&vcm->sessions_lockp);
437 clib_spinlock_unlock (&vcm->sessions_lockp);
439 while (clib_time_now (&vcm->clib_time) < timeout);
441 if (VPPCOM_DEBUG > 0)
442 clib_warning ("[%d] timeout waiting for state %s (%d)", getpid (),
443 vppcom_session_state_str (state), state);
444 return VPPCOM_ETIMEDOUT;
448 vppcom_wait_for_client_session_index (f64 wait_for_time)
450 f64 timeout = clib_time_now (&vcm->clib_time) + wait_for_time;
454 if (clib_fifo_elts (vcm->client_session_index_fifo))
457 while (clib_time_now (&vcm->clib_time) < timeout);
459 if (wait_for_time == 0)
460 return VPPCOM_EAGAIN;
462 if (VPPCOM_DEBUG > 0)
463 clib_warning ("[%d] timeout waiting for client_session_index", getpid ());
464 return VPPCOM_ETIMEDOUT;
468 * VPP-API message functions
471 vppcom_send_session_enable_disable (u8 is_enable)
473 vl_api_session_enable_disable_t *bmp;
474 bmp = vl_msg_api_alloc (sizeof (*bmp));
475 memset (bmp, 0, sizeof (*bmp));
477 bmp->_vl_msg_id = ntohs (VL_API_SESSION_ENABLE_DISABLE);
478 bmp->client_index = vcm->my_client_index;
479 bmp->context = htonl (0xfeedface);
480 bmp->is_enable = is_enable;
481 vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & bmp);
485 vppcom_app_session_enable (void)
489 if (vcm->app_state != STATE_APP_ENABLED)
491 vppcom_send_session_enable_disable (1 /* is_enabled == TRUE */ );
492 rv = vppcom_wait_for_app_state_change (STATE_APP_ENABLED);
493 if (PREDICT_FALSE (rv))
495 if (VPPCOM_DEBUG > 0)
496 clib_warning ("[%d] Session enable timed out, rv = %s (%d)",
497 getpid (), vppcom_retval_str (rv), rv);
505 vl_api_session_enable_disable_reply_t_handler
506 (vl_api_session_enable_disable_reply_t * mp)
510 clib_warning ("[%d] session_enable_disable failed: %U", getpid (),
511 format_api_error, ntohl (mp->retval));
514 vcm->app_state = STATE_APP_ENABLED;
518 vppcom_app_send_attach (void)
520 vl_api_application_attach_t *bmp;
521 u8 nsid_len = vec_len (vcm->cfg.namespace_id);
522 u8 app_is_proxy = (vcm->cfg.app_proxy_transport_tcp ||
523 vcm->cfg.app_proxy_transport_udp);
525 bmp = vl_msg_api_alloc (sizeof (*bmp));
526 memset (bmp, 0, sizeof (*bmp));
528 bmp->_vl_msg_id = ntohs (VL_API_APPLICATION_ATTACH);
529 bmp->client_index = vcm->my_client_index;
530 bmp->context = htonl (0xfeedface);
531 bmp->options[APP_OPTIONS_FLAGS] =
532 APP_OPTIONS_FLAGS_ACCEPT_REDIRECT | APP_OPTIONS_FLAGS_ADD_SEGMENT |
533 (vcm->cfg.app_scope_local ? APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE : 0) |
534 (vcm->cfg.app_scope_global ? APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE : 0) |
535 (app_is_proxy ? APP_OPTIONS_FLAGS_IS_PROXY : 0);
536 bmp->options[APP_OPTIONS_PROXY_TRANSPORT] =
537 (vcm->cfg.app_proxy_transport_tcp ? 1 << TRANSPORT_PROTO_TCP : 0) |
538 (vcm->cfg.app_proxy_transport_udp ? 1 << TRANSPORT_PROTO_UDP : 0);
539 bmp->options[SESSION_OPTIONS_SEGMENT_SIZE] = vcm->cfg.segment_size;
540 bmp->options[SESSION_OPTIONS_ADD_SEGMENT_SIZE] = vcm->cfg.add_segment_size;
541 bmp->options[SESSION_OPTIONS_RX_FIFO_SIZE] = vcm->cfg.rx_fifo_size;
542 bmp->options[SESSION_OPTIONS_TX_FIFO_SIZE] = vcm->cfg.tx_fifo_size;
545 bmp->namespace_id_len = nsid_len;
546 clib_memcpy (bmp->namespace_id, vcm->cfg.namespace_id, nsid_len);
547 bmp->options[APP_OPTIONS_NAMESPACE_SECRET] = vcm->cfg.namespace_secret;
549 vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & bmp);
553 vppcom_app_attach (void)
557 vppcom_app_send_attach ();
558 rv = vppcom_wait_for_app_state_change (STATE_APP_ATTACHED);
559 if (PREDICT_FALSE (rv))
561 if (VPPCOM_DEBUG > 0)
562 clib_warning ("[%d] application attach timed out, rv = %s (%d)",
563 getpid (), vppcom_retval_str (rv), rv);
570 vppcom_app_detach (void)
572 vl_api_application_detach_t *bmp;
573 bmp = vl_msg_api_alloc (sizeof (*bmp));
574 memset (bmp, 0, sizeof (*bmp));
576 bmp->_vl_msg_id = ntohs (VL_API_APPLICATION_DETACH);
577 bmp->client_index = vcm->my_client_index;
578 bmp->context = htonl (0xfeedface);
579 vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & bmp);
583 vl_api_application_attach_reply_t_handler (vl_api_application_attach_reply_t *
586 static svm_fifo_segment_create_args_t _a;
587 svm_fifo_segment_create_args_t *a = &_a;
590 memset (a, 0, sizeof (*a));
593 clib_warning ("[%d] attach failed: %U", getpid (),
594 format_api_error, ntohl (mp->retval));
598 if (mp->segment_name_length == 0)
600 clib_warning ("[%d] segment_name_length zero", getpid ());
604 a->segment_name = (char *) mp->segment_name;
605 a->segment_size = mp->segment_size;
607 ASSERT (mp->app_event_queue_address);
609 /* Attach to the segment vpp created */
610 rv = svm_fifo_segment_attach (a);
611 vec_reset_length (a->new_segment_indices);
612 if (PREDICT_FALSE (rv))
614 clib_warning ("[%d] svm_fifo_segment_attach ('%s') failed", getpid (),
619 vcm->app_event_queue =
620 uword_to_pointer (mp->app_event_queue_address,
621 unix_shared_memory_queue_t *);
623 vcm->app_state = STATE_APP_ATTACHED;
627 vl_api_application_detach_reply_t_handler (vl_api_application_detach_reply_t *
631 clib_warning ("[%d] detach failed: %U", getpid (), format_api_error,
634 vcm->app_state = STATE_APP_ENABLED;
638 vl_api_disconnect_session_reply_t_handler (vl_api_disconnect_session_reply_t *
642 u32 session_index = ~0;
644 p = hash_get (vcm->session_index_by_vpp_handles, mp->handle);
647 session_t *session = 0;
650 session_index = p[0];
651 hash_unset (vcm->session_index_by_vpp_handles, mp->handle);
652 clib_spinlock_lock (&vcm->sessions_lockp);
653 rv = vppcom_session_at_index (session_index, &session);
654 if (PREDICT_FALSE (rv))
656 if (VPPCOM_DEBUG > 1)
657 clib_warning ("[%d] invalid session, sid %u has been closed!",
658 getpid (), session_index);
662 if (VPPCOM_DEBUG > 1)
663 clib_warning ("[%d] vpp handle 0x%llx, sid %u disconnected!",
664 getpid (), mp->handle, session_index);
666 session->state = STATE_DISCONNECT;
668 clib_spinlock_unlock (&vcm->sessions_lockp);
672 if (VPPCOM_DEBUG > 1)
673 clib_warning ("[%d] couldn't find session: unknown vpp handle 0x%llx",
674 getpid (), mp->handle);
678 clib_warning ("[%d] disconnect_session vpp handle 0x%llx, sid %u "
679 "failed: %U", getpid (), mp->handle, session_index,
680 format_api_error, ntohl (mp->retval));
684 vl_api_map_another_segment_t_handler (vl_api_map_another_segment_t * mp)
686 static svm_fifo_segment_create_args_t _a;
687 svm_fifo_segment_create_args_t *a = &_a;
690 memset (a, 0, sizeof (*a));
691 a->segment_name = (char *) mp->segment_name;
692 a->segment_size = mp->segment_size;
693 /* Attach to the segment vpp created */
694 rv = svm_fifo_segment_attach (a);
695 vec_reset_length (a->new_segment_indices);
696 if (PREDICT_FALSE (rv))
698 clib_warning ("[%d] svm_fifo_segment_attach ('%s') failed",
699 getpid (), mp->segment_name);
702 if (VPPCOM_DEBUG > 1)
703 clib_warning ("[%d] mapped new segment '%s' size %d", getpid (),
704 mp->segment_name, mp->segment_size);
708 vl_api_disconnect_session_t_handler (vl_api_disconnect_session_t * mp)
710 session_t *session = 0;
711 vl_api_disconnect_session_reply_t *rmp;
715 p = hash_get (vcm->session_index_by_vpp_handles, mp->handle);
716 if (VPPCOM_DEBUG > 0)
720 clib_warning ("[%d] request to disconnect invalid handle (%u)!",
721 getpid (), mp->handle);
725 clib_warning ("[%d] disconnecting handle %u sid (%u)!", getpid (),
733 clib_spinlock_lock (&vcm->sessions_lockp);
734 rval = vppcom_session_at_index (p[0], &session);
735 if (PREDICT_FALSE (rval))
737 if (VPPCOM_DEBUG > 1)
738 clib_warning ("[%d] invalid session, sid (%u) has been closed!",
742 pool_put (vcm->sessions, session);
743 clib_spinlock_unlock (&vcm->sessions_lockp);
744 hash_unset (vcm->session_index_by_vpp_handles, mp->handle);
748 clib_warning ("[%d] couldn't find session: unknown vpp handle 0x%llx",
749 getpid (), mp->handle);
754 rmp = vl_msg_api_alloc (sizeof (*rmp));
755 memset (rmp, 0, sizeof (*rmp));
757 rmp->_vl_msg_id = ntohs (VL_API_DISCONNECT_SESSION_REPLY);
758 rmp->retval = htonl (rv);
759 rmp->handle = mp->handle;
760 vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & rmp);
764 vl_api_reset_session_t_handler (vl_api_reset_session_t * mp)
766 session_t *session = 0;
767 vl_api_reset_session_reply_t *rmp;
771 p = hash_get (vcm->session_index_by_vpp_handles, mp->handle);
775 clib_spinlock_lock (&vcm->sessions_lockp);
776 rval = vppcom_session_at_index (p[0], &session);
777 if (PREDICT_FALSE (rval))
779 if (VPPCOM_DEBUG > 1)
780 clib_warning ("[%d] invalid session, sid (%u) has been closed!",
784 pool_put (vcm->sessions, session);
785 clib_spinlock_unlock (&vcm->sessions_lockp);
786 hash_unset (vcm->session_index_by_vpp_handles, mp->handle);
790 clib_warning ("[%d] couldn't find session: unknown vpp handle 0x%llx",
791 getpid (), mp->handle);
795 rmp = vl_msg_api_alloc (sizeof (*rmp));
796 memset (rmp, 0, sizeof (*rmp));
797 rmp->_vl_msg_id = ntohs (VL_API_RESET_SESSION_REPLY);
798 rmp->retval = htonl (rv);
799 rmp->handle = mp->handle;
800 vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & rmp);
804 vl_api_connect_session_reply_t_handler (vl_api_connect_session_reply_t * mp)
808 svm_fifo_t *rx_fifo, *tx_fifo;
814 clib_warning ("[%d] connect failed: %U", getpid (), format_api_error,
819 session_index = mp->context;
820 if (VPPCOM_DEBUG > 1)
821 clib_warning ("[%d] session_index = %d 0x%08x", getpid (),
822 session_index, session_index);
824 clib_spinlock_lock (&vcm->sessions_lockp);
825 if (pool_is_free_index (vcm->sessions, session_index))
827 clib_spinlock_unlock (&vcm->sessions_lockp);
828 if (VPPCOM_DEBUG > 1)
829 clib_warning ("[%d] invalid session, sid %d is closed!",
830 getpid (), session_index);
834 /* We've been redirected */
835 if (mp->segment_name_length > 0)
837 static svm_fifo_segment_create_args_t _a;
838 svm_fifo_segment_create_args_t *a = &_a;
841 memset (a, 0, sizeof (*a));
842 a->segment_name = (char *) mp->segment_name;
843 if (VPPCOM_DEBUG > 1)
844 clib_warning ("[%d] cut-thru segment: %s\n",
845 getpid (), a->segment_name);
847 rv = svm_fifo_segment_attach (a);
848 vec_reset_length (a->new_segment_indices);
849 if (PREDICT_FALSE (rv))
851 clib_spinlock_unlock (&vcm->sessions_lockp);
852 clib_warning ("[%d] sm_fifo_segment_attach ('%s') failed",
853 getpid (), a->segment_name);
861 session = pool_elt_at_index (vcm->sessions, session_index);
862 session->is_cut_thru = is_cut_thru;
863 session->vpp_event_queue = uword_to_pointer (mp->vpp_event_queue_address,
864 unix_shared_memory_queue_t *);
866 rx_fifo = uword_to_pointer (mp->server_rx_fifo, svm_fifo_t *);
867 rx_fifo->client_session_index = session_index;
868 tx_fifo = uword_to_pointer (mp->server_tx_fifo, svm_fifo_t *);
869 tx_fifo->client_session_index = session_index;
871 session->server_rx_fifo = rx_fifo;
872 session->server_tx_fifo = tx_fifo;
873 session->vpp_handle = mp->handle;
874 session->state = STATE_CONNECT;
876 /* Add it to lookup table */
877 hash_set (vcm->session_index_by_vpp_handles, mp->handle, session_index);
879 if (VPPCOM_DEBUG > 1)
880 clib_warning ("[%d] client sid %d, vpp handle 0x%llx\n"
881 " session_rx_fifo %p, refcnt %d\n"
882 " session_tx_fifo %p, refcnt %d",
883 getpid (), session_index, mp->handle,
884 session->server_rx_fifo,
885 session->server_rx_fifo->refcnt,
886 session->server_tx_fifo, session->server_tx_fifo->refcnt);
888 clib_spinlock_unlock (&vcm->sessions_lockp);
892 vppcom_send_connect_sock (session_t * session, u32 session_index)
894 vl_api_connect_sock_t *cmp;
896 /* Assumes caller as acquired the spinlock: vcm->sessions_lockp */
897 session->is_server = 0;
898 cmp = vl_msg_api_alloc (sizeof (*cmp));
899 memset (cmp, 0, sizeof (*cmp));
900 cmp->_vl_msg_id = ntohs (VL_API_CONNECT_SOCK);
901 cmp->client_index = vcm->my_client_index;
902 cmp->context = session_index;
904 if (VPPCOM_DEBUG > 1)
905 clib_warning ("[%d] session_index = %d 0x%08x",
906 getpid (), session_index, session_index);
908 cmp->vrf = session->vrf;
909 cmp->is_ip4 = session->peer_addr.is_ip4;
910 clib_memcpy (cmp->ip, &session->peer_addr.ip46, sizeof (cmp->ip));
911 cmp->port = session->peer_port;
912 cmp->proto = session->proto;
913 clib_memcpy (cmp->options, session->options, sizeof (cmp->options));
914 vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & cmp);
918 vppcom_send_disconnect (session_t * session)
920 vl_api_disconnect_session_t *dmp;
922 /* Assumes caller as acquired the spinlock: vcm->sessions_lockp */
923 dmp = vl_msg_api_alloc (sizeof (*dmp));
924 memset (dmp, 0, sizeof (*dmp));
925 dmp->_vl_msg_id = ntohs (VL_API_DISCONNECT_SESSION);
926 dmp->client_index = vcm->my_client_index;
927 dmp->handle = session->vpp_handle;
928 vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & dmp);
932 vl_api_bind_sock_reply_t_handler (vl_api_bind_sock_reply_t * mp)
934 session_t *session = 0;
938 clib_warning ("[%d] bind failed: %U", getpid (), format_api_error,
941 ASSERT (vcm->bind_session_index != ~0);
943 clib_spinlock_lock (&vcm->sessions_lockp);
944 rv = vppcom_session_at_index (vcm->bind_session_index, &session);
947 session->vpp_handle = mp->handle;
948 session->lcl_addr.is_ip4 = mp->lcl_is_ip4;
949 clib_memcpy (&session->lcl_addr.ip46, mp->lcl_ip,
950 sizeof (session->peer_addr.ip46));
951 session->lcl_port = mp->lcl_port;
952 vppcom_session_table_add_listener (mp->handle, vcm->bind_session_index);
953 session->state = mp->retval ? STATE_FAILED : STATE_LISTEN;
954 vcm->bind_session_index = ~0;
956 clib_spinlock_unlock (&vcm->sessions_lockp);
960 vl_api_unbind_sock_reply_t_handler (vl_api_unbind_sock_reply_t * mp)
962 session_t *session = 0;
964 clib_spinlock_lock (&vcm->sessions_lockp);
965 session = vppcom_session_table_lookup_listener (vcm->bind_session_index);
969 if ((VPPCOM_DEBUG > 1) && (mp->retval))
970 clib_warning ("[%d] unbind failed: %U", getpid (), format_api_error,
973 vppcom_session_table_del_listener (vcm->bind_session_index);
974 vcm->bind_session_index = ~0;
975 session->state = STATE_START;
977 clib_spinlock_unlock (&vcm->sessions_lockp);
981 format_ip4_address (u8 * s, va_list * args)
983 u8 *a = va_arg (*args, u8 *);
984 return format (s, "%d.%d.%d.%d", a[0], a[1], a[2], a[3]);
988 format_ip6_address (u8 * s, va_list * args)
990 ip6_address_t *a = va_arg (*args, ip6_address_t *);
991 u32 i, i_max_n_zero, max_n_zeros, i_first_zero, n_zeros, last_double_colon;
993 i_max_n_zero = ARRAY_LEN (a->as_u16);
995 i_first_zero = i_max_n_zero;
997 for (i = 0; i < ARRAY_LEN (a->as_u16); i++)
999 u32 is_zero = a->as_u16[i] == 0;
1000 if (is_zero && i_first_zero >= ARRAY_LEN (a->as_u16))
1006 if ((!is_zero && n_zeros > max_n_zeros)
1007 || (i + 1 >= ARRAY_LEN (a->as_u16) && n_zeros > max_n_zeros))
1009 i_max_n_zero = i_first_zero;
1010 max_n_zeros = n_zeros;
1011 i_first_zero = ARRAY_LEN (a->as_u16);
1016 last_double_colon = 0;
1017 for (i = 0; i < ARRAY_LEN (a->as_u16); i++)
1019 if (i == i_max_n_zero && max_n_zeros > 1)
1021 s = format (s, "::");
1022 i += max_n_zeros - 1;
1023 last_double_colon = 1;
1027 s = format (s, "%s%x",
1028 (last_double_colon || i == 0) ? "" : ":",
1029 clib_net_to_host_u16 (a->as_u16[i]));
1030 last_double_colon = 0;
1037 /* Format an IP46 address. */
1039 format_ip46_address (u8 * s, va_list * args)
1041 ip46_address_t *ip46 = va_arg (*args, ip46_address_t *);
1042 ip46_type_t type = va_arg (*args, ip46_type_t);
1048 is_ip4 = ip46_address_is_ip4 (ip46);
1059 format (s, "%U", format_ip4_address, &ip46->ip4) :
1060 format (s, "%U", format_ip6_address, &ip46->ip6);
1064 vppcom_send_accept_session_reply (u32 handle, int retval)
1066 vl_api_accept_session_reply_t *rmp;
1068 rmp = vl_msg_api_alloc (sizeof (*rmp));
1069 memset (rmp, 0, sizeof (*rmp));
1070 rmp->_vl_msg_id = ntohs (VL_API_ACCEPT_SESSION_REPLY);
1071 rmp->retval = htonl (retval);
1072 rmp->handle = handle;
1073 vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & rmp);
1077 vl_api_accept_session_t_handler (vl_api_accept_session_t * mp)
1079 svm_fifo_t *rx_fifo, *tx_fifo;
1080 session_t *session, *listen_session;
1083 clib_spinlock_lock (&vcm->sessions_lockp);
1084 if (!clib_fifo_free_elts (vcm->client_session_index_fifo))
1086 clib_warning ("[%d] client session queue is full!", getpid ());
1087 vppcom_send_accept_session_reply (mp->handle,
1088 VNET_API_ERROR_QUEUE_FULL);
1089 clib_spinlock_unlock (&vcm->sessions_lockp);
1093 listen_session = vppcom_session_table_lookup_listener (mp->listener_handle);
1094 if (!listen_session)
1096 clib_warning ("[%d] ERROR: couldn't find listen session: unknown vpp "
1097 "listener handle %llx", getpid (), mp->listener_handle);
1098 clib_spinlock_unlock (&vcm->sessions_lockp);
1102 /* Allocate local session and set it up */
1103 pool_get (vcm->sessions, session);
1104 memset (session, 0, sizeof (*session));
1105 session_index = session - vcm->sessions;
1107 rx_fifo = uword_to_pointer (mp->server_rx_fifo, svm_fifo_t *);
1108 rx_fifo->client_session_index = session_index;
1109 tx_fifo = uword_to_pointer (mp->server_tx_fifo, svm_fifo_t *);
1110 tx_fifo->client_session_index = session_index;
1112 session->vpp_handle = mp->handle;
1113 session->server_rx_fifo = rx_fifo;
1114 session->server_tx_fifo = tx_fifo;
1115 session->vpp_event_queue = uword_to_pointer (mp->vpp_event_queue_address,
1116 unix_shared_memory_queue_t *);
1117 session->state = STATE_ACCEPT;
1118 session->is_cut_thru = 0;
1119 session->is_server = 1;
1120 session->peer_port = mp->port;
1121 session->peer_addr.is_ip4 = mp->is_ip4;
1122 clib_memcpy (&session->peer_addr.ip46, mp->ip,
1123 sizeof (session->peer_addr.ip46));
1125 /* Add it to lookup table */
1126 hash_set (vcm->session_index_by_vpp_handles, mp->handle, session_index);
1127 session->lcl_port = listen_session->lcl_port;
1128 session->lcl_addr = listen_session->lcl_addr;
1130 /* TBD: move client_session_index_fifo into listener session */
1131 clib_fifo_add1 (vcm->client_session_index_fifo, session_index);
1133 clib_spinlock_unlock (&vcm->sessions_lockp);
1135 if (VPPCOM_DEBUG > 1)
1137 u8 *ip_str = format (0, "%U", format_ip46_address, &mp->ip, mp->is_ip4);
1138 clib_warning ("[%d] received request to accept session (sid %d) "
1139 "from %s:%d", getpid (), session_index, ip_str,
1140 clib_net_to_host_u16 (mp->port));
1146 vppcom_send_connect_session_reply (session_t * session, int retval)
1148 vl_api_connect_session_reply_t *rmp;
1150 unix_shared_memory_queue_t *client_q;
1152 rmp = vl_msg_api_alloc (sizeof (*rmp));
1153 memset (rmp, 0, sizeof (*rmp));
1155 rmp->_vl_msg_id = ntohs (VL_API_CONNECT_SESSION_REPLY);
1156 rmp->context = session->client_context;
1157 rmp->retval = htonl (retval);
1158 rmp->handle = session->vpp_handle;
1159 rmp->server_rx_fifo = pointer_to_uword (session->server_rx_fifo);
1160 rmp->server_tx_fifo = pointer_to_uword (session->server_tx_fifo);
1161 rmp->vpp_event_queue_address = pointer_to_uword (session->vpp_event_queue);
1162 rmp->segment_size = vcm->cfg.segment_size;
1163 len = vec_len (session->segment_name);
1164 rmp->segment_name_length = clib_min (len, sizeof (rmp->segment_name));
1165 clib_memcpy (rmp->segment_name, session->segment_name,
1166 rmp->segment_name_length - 1);
1167 clib_memcpy (rmp->lcl_ip, session->lcl_addr.ip46.as_u8,
1168 sizeof (rmp->lcl_ip));
1169 rmp->is_ip4 = session->lcl_addr.is_ip4;
1170 client_q = uword_to_pointer (session->client_queue_address,
1171 unix_shared_memory_queue_t *);
1173 vl_msg_api_send_shmem (client_q, (u8 *) & rmp);
1177 * Acting as server for redirected connect requests
1180 vl_api_connect_sock_t_handler (vl_api_connect_sock_t * mp)
1183 session_t *session = 0;
1185 clib_spinlock_lock (&vcm->sessions_lockp);
1186 if (!clib_fifo_free_elts (vcm->client_session_index_fifo))
1188 if (VPPCOM_DEBUG > 1)
1189 clib_warning ("[%d] client session queue is full!", getpid ());
1190 clib_spinlock_unlock (&vcm->sessions_lockp);
1191 /* TBD: fix handle */
1192 vppcom_send_accept_session_reply (0, VNET_API_ERROR_QUEUE_FULL);
1196 pool_get (vcm->sessions, session);
1197 memset (session, 0, sizeof (*session));
1198 session_index = session - vcm->sessions;
1200 session->client_context = mp->context;
1201 session->vpp_handle = session_index;
1202 session->client_queue_address = mp->client_queue_address;
1203 session->is_cut_thru = 1;
1204 session->is_server = 1;
1205 session->peer_port = mp->port;
1206 session->peer_addr.is_ip4 = mp->is_ip4;
1207 clib_memcpy (&session->peer_addr.ip46, mp->ip,
1208 sizeof (session->peer_addr.ip46));
1210 session->state = STATE_ACCEPT;
1211 clib_fifo_add1 (vcm->client_session_index_fifo, session_index);
1212 if (VPPCOM_DEBUG > 1)
1214 ("[%d] Got a cut-thru connect request to client: "
1215 "sid %d, clib_fifo_elts %u!\n", getpid (), session_index,
1216 clib_fifo_elts (vcm->client_session_index_fifo));
1217 clib_spinlock_unlock (&vcm->sessions_lockp);
1221 vppcom_send_bind_sock (session_t * session)
1223 vl_api_bind_sock_t *bmp;
1225 /* Assumes caller has acquired spinlock: vcm->sessions_lockp */
1226 session->is_server = 1;
1227 bmp = vl_msg_api_alloc (sizeof (*bmp));
1228 memset (bmp, 0, sizeof (*bmp));
1230 bmp->_vl_msg_id = ntohs (VL_API_BIND_SOCK);
1231 bmp->client_index = vcm->my_client_index;
1232 bmp->context = htonl (0xfeedface);
1233 bmp->vrf = session->vrf;
1234 bmp->is_ip4 = session->lcl_addr.is_ip4;
1235 clib_memcpy (bmp->ip, &session->lcl_addr.ip46, sizeof (bmp->ip));
1236 bmp->port = session->lcl_port;
1237 bmp->proto = session->proto;
1238 clib_memcpy (bmp->options, session->options, sizeof (bmp->options));
1239 vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & bmp);
1243 vppcom_send_unbind_sock (u32 session_index)
1245 vl_api_unbind_sock_t *ump;
1246 session_t *session = 0;
1249 clib_spinlock_lock (&vcm->sessions_lockp);
1250 rv = vppcom_session_at_index (session_index, &session);
1251 if (PREDICT_FALSE (rv))
1253 clib_spinlock_unlock (&vcm->sessions_lockp);
1254 if (VPPCOM_DEBUG > 0)
1255 clib_warning ("[%d] invalid session, sid (%u) has been closed!",
1256 getpid (), session_index);
1260 ump = vl_msg_api_alloc (sizeof (*ump));
1261 memset (ump, 0, sizeof (*ump));
1263 ump->_vl_msg_id = ntohs (VL_API_UNBIND_SOCK);
1264 ump->client_index = vcm->my_client_index;
1265 ump->handle = session->vpp_handle;
1266 clib_spinlock_unlock (&vcm->sessions_lockp);
1267 vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & ump);
1271 vppcom_session_unbind_cut_thru (session_t * session, u32 session_index)
1273 svm_fifo_segment_main_t *sm = &svm_fifo_segment_main;
1274 svm_fifo_segment_private_t *seg;
1277 if (VPPCOM_DEBUG > 1)
1278 clib_warning ("[%d] sid %d, seg_nxd %d:\n"
1279 " server_rx_fifo %p, refcnt = %d\n"
1280 " server_tx_fifo %p, refcnt = %d",
1281 getpid (), session_index, session->sm_seg_index,
1282 session->server_rx_fifo, session->server_rx_fifo->refcnt,
1283 session->server_tx_fifo, session->server_tx_fifo->refcnt);
1285 seg = vec_elt_at_index (sm->segments, session->sm_seg_index);
1286 svm_fifo_segment_free_fifo (seg, session->server_rx_fifo,
1287 FIFO_SEGMENT_RX_FREELIST);
1288 svm_fifo_segment_free_fifo (seg, session->server_tx_fifo,
1289 FIFO_SEGMENT_TX_FREELIST);
1290 svm_fifo_segment_delete (seg);
1296 vppcom_session_unbind (u32 session_index)
1300 clib_spinlock_lock (&vcm->sessions_lockp);
1301 if (PREDICT_FALSE (pool_is_free_index (vcm->sessions, session_index)))
1303 clib_spinlock_unlock (&vcm->sessions_lockp);
1304 if (VPPCOM_DEBUG > 1)
1305 clib_warning ("[%d] invalid session, sid (%u) has been closed!",
1306 getpid (), session_index);
1307 return VPPCOM_EBADFD;
1309 clib_spinlock_unlock (&vcm->sessions_lockp);
1311 if (vcm->bind_session_index != session_index)
1312 clib_warning ("[%d] ERROR: unbinding a not bound listener %u (%u)",
1313 session_index, vcm->bind_session_index);
1314 vcm->bind_session_index = session_index;
1315 vppcom_send_unbind_sock (session_index);
1316 rv = vppcom_wait_for_session_state_change (session_index, STATE_START,
1317 vcm->cfg.session_timeout);
1318 if (PREDICT_FALSE (rv))
1320 vcm->bind_session_index = ~0;
1321 if (VPPCOM_DEBUG > 0)
1322 clib_warning ("[%d] server unbind timed out, rv = %s (%d)",
1323 getpid (), vppcom_retval_str (rv), rv);
1330 vppcom_session_disconnect (u32 session_index)
1335 clib_spinlock_lock (&vcm->sessions_lockp);
1336 rv = vppcom_session_at_index (session_index, &session);
1337 if (PREDICT_FALSE (rv))
1339 clib_spinlock_unlock (&vcm->sessions_lockp);
1340 if (VPPCOM_DEBUG > 1)
1341 clib_warning ("[%d] invalid session, sid (%u) has been closed!",
1342 getpid (), session_index);
1346 if (!session->is_cut_thru)
1348 if (VPPCOM_DEBUG > 1)
1349 clib_warning ("[%d] disconnecting sid (%u)", getpid (),
1351 vppcom_send_disconnect (session);
1352 clib_spinlock_unlock (&vcm->sessions_lockp);
1354 rv = vppcom_wait_for_session_state_change (session_index,
1355 STATE_DISCONNECT, 1.0);
1356 /* TBD: Force clean up on error/timeout since there is no other
1357 * way to recover from a failed disconnect.
1359 if ((VPPCOM_DEBUG > 0) && (rv < 0))
1360 clib_warning ("[%d] disconnect (session %d) failed, rv = %s (%d)",
1361 getpid (), session_index, vppcom_retval_str (rv), rv);
1365 /* TBD: Handle cut-thru disconnect */
1366 clib_spinlock_unlock (&vcm->sessions_lockp);
1372 #define foreach_sock_msg \
1373 _(SESSION_ENABLE_DISABLE_REPLY, session_enable_disable_reply) \
1374 _(BIND_SOCK_REPLY, bind_sock_reply) \
1375 _(UNBIND_SOCK_REPLY, unbind_sock_reply) \
1376 _(ACCEPT_SESSION, accept_session) \
1377 _(CONNECT_SOCK, connect_sock) \
1378 _(CONNECT_SESSION_REPLY, connect_session_reply) \
1379 _(DISCONNECT_SESSION, disconnect_session) \
1380 _(DISCONNECT_SESSION_REPLY, disconnect_session_reply) \
1381 _(RESET_SESSION, reset_session) \
1382 _(APPLICATION_ATTACH_REPLY, application_attach_reply) \
1383 _(APPLICATION_DETACH_REPLY, application_detach_reply) \
1384 _(MAP_ANOTHER_SEGMENT, map_another_segment)
1387 vppcom_api_hookup (void)
1390 vl_msg_api_set_handlers(VL_API_##N, #n, \
1391 vl_api_##n##_t_handler, \
1393 vl_api_##n##_t_endian, \
1394 vl_api_##n##_t_print, \
1395 sizeof(vl_api_##n##_t), 1);
1401 vppcom_cfg_init (vppcom_cfg_t * vcl_cfg)
1405 vcl_cfg->heapsize = (256ULL << 20);
1406 vcl_cfg->segment_baseva = 0x200000000ULL;
1407 vcl_cfg->segment_size = (256 << 20);
1408 vcl_cfg->add_segment_size = (128 << 20);
1409 vcl_cfg->preallocated_fifo_pairs = 8;
1410 vcl_cfg->rx_fifo_size = (1 << 20);
1411 vcl_cfg->tx_fifo_size = (1 << 20);
1412 vcl_cfg->event_queue_size = 2048;
1413 vcl_cfg->listen_queue_size = CLIB_CACHE_LINE_BYTES / sizeof (u32);
1414 vcl_cfg->app_timeout = 10 * 60.0;
1415 vcl_cfg->session_timeout = 10 * 60.0;
1416 vcl_cfg->accept_timeout = 60.0;
1420 vppcom_cfg_heapsize (char *conf_fname)
1422 vppcom_cfg_t *vcl_cfg = &vcm->cfg;
1435 fp = fopen (conf_fname, "r");
1438 if (VPPCOM_DEBUG > 0)
1439 fprintf (stderr, "open configuration file '%s' failed\n", conf_fname);
1442 argv = calloc (1, sizeof (char *));
1448 if (fgets (inbuf, 4096, fp) == 0)
1450 p = strtok (inbuf, " \t\n");
1456 char **tmp = realloc (argv, argc * sizeof (char *));
1460 arg = strndup (p, 1024);
1463 argv[argc - 1] = arg;
1464 p = strtok (NULL, " \t\n");
1471 char **tmp = realloc (argv, (argc + 1) * sizeof (char *));
1478 * Look for and parse the "heapsize" config parameter.
1479 * Manual since none of the clib infra has been bootstrapped yet.
1481 * Format: heapsize <nn>[mM][gG]
1484 for (i = 1; i < (argc - 1); i++)
1486 if (!strncmp (argv[i], "heapsize", 8))
1488 sizep = (u8 *) argv[i + 1];
1490 while (*sizep >= '0' && *sizep <= '9')
1493 size += *sizep++ - '0';
1497 if (VPPCOM_DEBUG > 0)
1498 clib_warning ("[%d] parse error '%s %s', "
1499 "using default heapsize %lld (0x%llx)",
1500 getpid (), argv[i], argv[i + 1],
1501 vcl_cfg->heapsize, vcl_cfg->heapsize);
1505 if (*sizep == 'g' || *sizep == 'G')
1506 vcl_cfg->heapsize = size << 30;
1507 else if (*sizep == 'm' || *sizep == 'M')
1508 vcl_cfg->heapsize = size << 20;
1511 if (VPPCOM_DEBUG > 0)
1512 clib_warning ("[%d] parse error '%s %s', "
1513 "using default heapsize %lld (0x%llx)",
1514 getpid (), argv[i], argv[i + 1],
1515 vcl_cfg->heapsize, vcl_cfg->heapsize);
1527 vcl_mem = mmap (0, vcl_cfg->heapsize, PROT_READ | PROT_WRITE,
1528 MAP_SHARED | MAP_ANONYMOUS, -1, 0);
1529 if (vcl_mem == MAP_FAILED)
1531 clib_unix_error ("[%d] ERROR: mmap(0, %lld == 0x%llx, "
1532 "PROT_READ | PROT_WRITE,MAP_SHARED | MAP_ANONYMOUS, "
1534 getpid (), vcl_cfg->heapsize, vcl_cfg->heapsize);
1537 heap = clib_mem_init (vcl_mem, vcl_cfg->heapsize);
1540 clib_warning ("[%d] ERROR: clib_mem_init() failed!", getpid ());
1543 vcl_mem = clib_mem_alloc (sizeof (_vppcom_main));
1546 clib_warning ("[%d] ERROR: clib_mem_alloc() failed!", getpid ());
1550 clib_memcpy (vcl_mem, &_vppcom_main, sizeof (_vppcom_main));
1553 if (VPPCOM_DEBUG > 0)
1554 clib_warning ("[%d] allocated VCL heap = %p, size %lld (0x%llx)",
1555 getpid (), heap, vcl_cfg->heapsize, vcl_cfg->heapsize);
1559 vppcom_cfg_read (char *conf_fname)
1561 vppcom_cfg_t *vcl_cfg = &vcm->cfg;
1563 unformat_input_t _input, *input = &_input;
1564 unformat_input_t _line_input, *line_input = &_line_input;
1565 u8 vc_cfg_input = 0;
1570 fd = open (conf_fname, O_RDONLY);
1573 if (VPPCOM_DEBUG > 0)
1574 clib_warning ("[%d] open configuration file '%s' failed!",
1575 getpid (), conf_fname);
1579 if (fstat (fd, &s) < 0)
1581 if (VPPCOM_DEBUG > 0)
1582 clib_warning ("[%d] failed to stat `%s'", getpid (), conf_fname);
1586 if (!(S_ISREG (s.st_mode) || S_ISLNK (s.st_mode)))
1588 if (VPPCOM_DEBUG > 0)
1589 clib_warning ("[%d] not a regular file `%s'", getpid (), conf_fname);
1593 unformat_init_clib_file (input, fd);
1595 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1597 (void) unformat_user (input, unformat_line_input, line_input);
1598 unformat_skip_white_space (line_input);
1600 if (unformat (line_input, "vcl {"))
1608 if (unformat (line_input, "heapsize %s", &chroot_path))
1610 vec_terminate_c_string (chroot_path);
1611 if (VPPCOM_DEBUG > 0)
1612 clib_warning ("[%d] configured heapsize %s, "
1613 "actual heapsize %lld (0x%llx)",
1614 getpid (), chroot_path, vcl_cfg->heapsize,
1616 vec_free (chroot_path);
1618 else if (unformat (line_input, "api-prefix %s", &chroot_path))
1620 vec_terminate_c_string (chroot_path);
1621 vl_set_memory_root_path ((char *) chroot_path);
1622 if (VPPCOM_DEBUG > 0)
1623 clib_warning ("[%d] configured api-prefix %s",
1624 getpid (), chroot_path);
1625 chroot_path = 0; /* Don't vec_free() it! */
1627 else if (unformat (line_input, "uid %d", &uid))
1629 vl_set_memory_uid (uid);
1630 if (VPPCOM_DEBUG > 0)
1631 clib_warning ("[%d] configured uid %d", getpid (), uid);
1633 else if (unformat (line_input, "gid %d", &gid))
1635 vl_set_memory_gid (gid);
1636 if (VPPCOM_DEBUG > 0)
1637 clib_warning ("[%d] configured gid %d", getpid (), gid);
1639 else if (unformat (line_input, "segment-baseva 0x%lx",
1640 &vcl_cfg->segment_baseva))
1642 if (VPPCOM_DEBUG > 0)
1643 clib_warning ("[%d] configured segment_baseva 0x%lx",
1644 getpid (), vcl_cfg->segment_baseva);
1646 else if (unformat (line_input, "segment-size 0x%lx",
1647 &vcl_cfg->segment_size))
1649 if (VPPCOM_DEBUG > 0)
1650 clib_warning ("[%d] configured segment_size 0x%lx (%ld)",
1651 getpid (), vcl_cfg->segment_size,
1652 vcl_cfg->segment_size);
1654 else if (unformat (line_input, "segment-size %ld",
1655 &vcl_cfg->segment_size))
1657 if (VPPCOM_DEBUG > 0)
1658 clib_warning ("[%d] configured segment_size %ld (0x%lx)",
1659 getpid (), vcl_cfg->segment_size,
1660 vcl_cfg->segment_size);
1662 else if (unformat (line_input, "add-segment-size 0x%lx",
1663 &vcl_cfg->add_segment_size))
1665 if (VPPCOM_DEBUG > 0)
1667 ("[%d] configured add_segment_size 0x%lx (%ld)",
1668 getpid (), vcl_cfg->add_segment_size,
1669 vcl_cfg->add_segment_size);
1671 else if (unformat (line_input, "add-segment-size %ld",
1672 &vcl_cfg->add_segment_size))
1674 if (VPPCOM_DEBUG > 0)
1676 ("[%d] configured add_segment_size %ld (0x%lx)",
1677 getpid (), vcl_cfg->add_segment_size,
1678 vcl_cfg->add_segment_size);
1680 else if (unformat (line_input, "preallocated-fifo-pairs %d",
1681 &vcl_cfg->preallocated_fifo_pairs))
1683 if (VPPCOM_DEBUG > 0)
1684 clib_warning ("[%d] configured preallocated_fifo_pairs "
1685 "%d (0x%x)", getpid (),
1686 vcl_cfg->preallocated_fifo_pairs,
1687 vcl_cfg->preallocated_fifo_pairs);
1689 else if (unformat (line_input, "rx-fifo-size 0x%lx",
1690 &vcl_cfg->rx_fifo_size))
1692 if (VPPCOM_DEBUG > 0)
1693 clib_warning ("[%d] configured rx_fifo_size 0x%lx (%ld)",
1694 getpid (), vcl_cfg->rx_fifo_size,
1695 vcl_cfg->rx_fifo_size);
1697 else if (unformat (line_input, "rx-fifo-size %ld",
1698 &vcl_cfg->rx_fifo_size))
1700 if (VPPCOM_DEBUG > 0)
1701 clib_warning ("[%d] configured rx_fifo_size %ld (0x%lx)",
1702 getpid (), vcl_cfg->rx_fifo_size,
1703 vcl_cfg->rx_fifo_size);
1705 else if (unformat (line_input, "tx-fifo-size 0x%lx",
1706 &vcl_cfg->tx_fifo_size))
1708 if (VPPCOM_DEBUG > 0)
1709 clib_warning ("[%d] configured tx_fifo_size 0x%lx (%ld)",
1710 getpid (), vcl_cfg->tx_fifo_size,
1711 vcl_cfg->tx_fifo_size);
1713 else if (unformat (line_input, "tx-fifo-size %ld",
1714 &vcl_cfg->tx_fifo_size))
1716 if (VPPCOM_DEBUG > 0)
1717 clib_warning ("[%d] configured tx_fifo_size %ld (0x%lx)",
1718 getpid (), vcl_cfg->tx_fifo_size,
1719 vcl_cfg->tx_fifo_size);
1721 else if (unformat (line_input, "event-queue-size 0x%lx",
1722 &vcl_cfg->event_queue_size))
1724 if (VPPCOM_DEBUG > 0)
1725 clib_warning ("[%d] configured event_queue_size 0x%lx (%ld)",
1726 getpid (), vcl_cfg->event_queue_size,
1727 vcl_cfg->event_queue_size);
1729 else if (unformat (line_input, "event-queue-size %ld",
1730 &vcl_cfg->event_queue_size))
1732 if (VPPCOM_DEBUG > 0)
1733 clib_warning ("[%d] configured event_queue_size %ld (0x%lx)",
1734 getpid (), vcl_cfg->event_queue_size,
1735 vcl_cfg->event_queue_size);
1737 else if (unformat (line_input, "listen-queue-size 0x%lx",
1738 &vcl_cfg->listen_queue_size))
1740 if (VPPCOM_DEBUG > 0)
1741 clib_warning ("[%d] configured listen_queue_size 0x%lx (%ld)",
1742 getpid (), vcl_cfg->listen_queue_size,
1743 vcl_cfg->listen_queue_size);
1745 else if (unformat (line_input, "listen-queue-size %ld",
1746 &vcl_cfg->listen_queue_size))
1748 if (VPPCOM_DEBUG > 0)
1749 clib_warning ("[%d] configured listen_queue_size %ld (0x%lx)",
1750 getpid (), vcl_cfg->listen_queue_size,
1751 vcl_cfg->listen_queue_size);
1753 else if (unformat (line_input, "app-timeout %f",
1754 &vcl_cfg->app_timeout))
1756 if (VPPCOM_DEBUG > 0)
1757 clib_warning ("[%d] configured app_timeout %f",
1758 getpid (), vcl_cfg->app_timeout);
1760 else if (unformat (line_input, "session-timeout %f",
1761 &vcl_cfg->session_timeout))
1763 if (VPPCOM_DEBUG > 0)
1764 clib_warning ("[%d] configured session_timeout %f",
1765 getpid (), vcl_cfg->session_timeout);
1767 else if (unformat (line_input, "accept-timeout %f",
1768 &vcl_cfg->accept_timeout))
1770 if (VPPCOM_DEBUG > 0)
1771 clib_warning ("[%d] configured accept_timeout %f",
1772 getpid (), vcl_cfg->accept_timeout);
1774 else if (unformat (line_input, "app-proxy-transport-tcp"))
1776 vcl_cfg->app_proxy_transport_tcp = 1;
1777 if (VPPCOM_DEBUG > 0)
1778 clib_warning ("[%d] configured app_proxy_transport_tcp (%d)",
1779 getpid (), vcl_cfg->app_proxy_transport_tcp);
1781 else if (unformat (line_input, "app-proxy-transport-udp"))
1783 vcl_cfg->app_proxy_transport_udp = 1;
1784 if (VPPCOM_DEBUG > 0)
1785 clib_warning ("[%d] configured app_proxy_transport_udp (%d)",
1786 getpid (), vcl_cfg->app_proxy_transport_udp);
1788 else if (unformat (line_input, "app-scope-local"))
1790 vcl_cfg->app_scope_local = 1;
1791 if (VPPCOM_DEBUG > 0)
1792 clib_warning ("[%d] configured app_scope_local (%d)",
1793 getpid (), vcl_cfg->app_scope_local);
1795 else if (unformat (line_input, "app-scope-global"))
1797 vcl_cfg->app_scope_global = 1;
1798 if (VPPCOM_DEBUG > 0)
1799 clib_warning ("[%d] configured app_scope_global (%d)",
1800 getpid (), vcl_cfg->app_scope_global);
1802 else if (unformat (line_input, "namespace-secret %lu",
1803 &vcl_cfg->namespace_secret))
1805 if (VPPCOM_DEBUG > 0)
1807 ("[%d] configured namespace_secret %lu (0x%lx)",
1808 getpid (), vcl_cfg->namespace_secret,
1809 vcl_cfg->namespace_secret);
1811 else if (unformat (line_input, "namespace-id %v",
1812 &vcl_cfg->namespace_id))
1814 vl_api_application_attach_t *mp;
1815 u32 max_nsid_vec_len = sizeof (mp->namespace_id) - 1;
1816 u32 nsid_vec_len = vec_len (vcl_cfg->namespace_id);
1817 if (nsid_vec_len > max_nsid_vec_len)
1819 _vec_len (vcl_cfg->namespace_id) = max_nsid_vec_len;
1820 if (VPPCOM_DEBUG > 0)
1821 clib_warning ("[%d] configured namespace_id is too long,"
1822 " truncated to %d characters!", getpid (),
1826 if (VPPCOM_DEBUG > 0)
1827 clib_warning ("[%d] configured namespace_id %v",
1828 getpid (), vcl_cfg->namespace_id);
1830 else if (unformat (line_input, "}"))
1833 if (VPPCOM_DEBUG > 0)
1834 clib_warning ("[%d] completed parsing vppcom config!",
1840 if (line_input->buffer[line_input->index] != '#')
1842 clib_warning ("[%d] Unknown vppcom config option: '%s'",
1844 &line_input->buffer[line_input->index]);
1851 unformat_free (input);
1859 * VPPCOM Public API functions
1862 vppcom_app_create (char *app_name)
1864 vppcom_cfg_t *vcl_cfg = &vcm->cfg;
1875 vppcom_cfg_init (vcl_cfg);
1876 env_var_str = getenv (VPPCOM_ENV_DEBUG);
1880 if (sscanf (env_var_str, "%u", &tmp) != 1)
1881 clib_warning ("[%d] Invalid debug level specified in "
1882 "the environment variable "
1884 " (%s)!\n", getpid (), env_var_str);
1888 clib_warning ("[%d] configured debug level (%u) from "
1889 VPPCOM_ENV_DEBUG "!", getpid (), vcm->debug);
1892 conf_fname = getenv (VPPCOM_ENV_CONF);
1895 conf_fname = VPPCOM_CONF_DEFAULT;
1896 if (VPPCOM_DEBUG > 0)
1897 clib_warning ("[%d] getenv '%s' failed!", getpid (),
1900 vppcom_cfg_heapsize (conf_fname);
1901 clib_fifo_validate (vcm->client_session_index_fifo,
1902 vcm->cfg.listen_queue_size);
1903 vppcom_cfg_read (conf_fname);
1904 env_var_str = getenv (VPPCOM_ENV_APP_NAMESPACE_ID);
1907 u32 ns_id_vec_len = strlen (env_var_str);
1909 vec_reset_length (vcm->cfg.namespace_id);
1910 vec_validate (vcm->cfg.namespace_id, ns_id_vec_len - 1);
1911 clib_memcpy (vcm->cfg.namespace_id, env_var_str, ns_id_vec_len);
1913 if (VPPCOM_DEBUG > 0)
1914 clib_warning ("[%d] configured namespace_id (%v) from "
1915 VPPCOM_ENV_APP_NAMESPACE_ID "!", getpid (),
1916 vcm->cfg.namespace_id);
1918 env_var_str = getenv (VPPCOM_ENV_APP_NAMESPACE_SECRET);
1922 if (sscanf (env_var_str, "%lu", &tmp) != 1)
1923 clib_warning ("[%d] Invalid namespace secret specified in "
1924 "the environment variable "
1925 VPPCOM_ENV_APP_NAMESPACE_SECRET
1926 " (%s)!\n", getpid (), env_var_str);
1929 vcm->cfg.namespace_secret = tmp;
1930 if (VPPCOM_DEBUG > 0)
1931 clib_warning ("[%d] configured namespace secret (%lu) from "
1932 VPPCOM_ENV_APP_NAMESPACE_ID "!", getpid (),
1933 vcm->cfg.namespace_secret);
1936 if (getenv (VPPCOM_ENV_APP_PROXY_TRANSPORT_TCP))
1938 vcm->cfg.app_proxy_transport_tcp = 1;
1939 if (VPPCOM_DEBUG > 0)
1940 clib_warning ("[%d] configured app_proxy_transport_tcp (%u) from "
1941 VPPCOM_ENV_APP_PROXY_TRANSPORT_TCP "!", getpid (),
1942 vcm->cfg.app_proxy_transport_tcp);
1944 if (getenv (VPPCOM_ENV_APP_PROXY_TRANSPORT_UDP))
1946 vcm->cfg.app_proxy_transport_udp = 1;
1947 if (VPPCOM_DEBUG > 0)
1948 clib_warning ("[%d] configured app_proxy_transport_udp (%u) from "
1949 VPPCOM_ENV_APP_PROXY_TRANSPORT_UDP "!", getpid (),
1950 vcm->cfg.app_proxy_transport_udp);
1952 if (getenv (VPPCOM_ENV_APP_SCOPE_LOCAL))
1954 vcm->cfg.app_scope_local = 1;
1955 if (VPPCOM_DEBUG > 0)
1956 clib_warning ("[%d] configured app_scope_local (%u) from "
1957 VPPCOM_ENV_APP_SCOPE_LOCAL "!", getpid (),
1958 vcm->cfg.app_scope_local);
1960 if (getenv (VPPCOM_ENV_APP_SCOPE_GLOBAL))
1962 vcm->cfg.app_scope_global = 1;
1963 if (VPPCOM_DEBUG > 0)
1964 clib_warning ("[%d] configured app_scope_global (%u) from "
1965 VPPCOM_ENV_APP_SCOPE_GLOBAL "!", getpid (),
1966 vcm->cfg.app_scope_global);
1969 vcm->bind_session_index = ~0;
1970 vcm->main_cpu = os_get_thread_index ();
1971 heap = clib_mem_get_per_cpu_heap ();
1972 h = mheap_header (heap);
1974 /* make the main heap thread-safe */
1975 h->flags |= MHEAP_FLAG_THREAD_SAFE;
1977 vcm->session_index_by_vpp_handles = hash_create (0, sizeof (uword));
1979 clib_time_init (&vcm->clib_time);
1980 vppcom_init_error_string_table ();
1981 svm_fifo_segment_init (vcl_cfg->segment_baseva,
1982 20 /* timeout in secs */ );
1983 clib_spinlock_init (&vcm->sessions_lockp);
1984 vppcom_api_hookup ();
1987 if (vcm->my_client_index == ~0)
1989 vcm->app_state = STATE_APP_START;
1990 rv = vppcom_connect_to_vpp (app_name);
1993 clib_warning ("[%d] couldn't connect to VPP.", getpid ());
1997 if (VPPCOM_DEBUG > 0)
1998 clib_warning ("[%d] sending session enable", getpid ());
2000 rv = vppcom_app_session_enable ();
2003 clib_warning ("[%d] vppcom_app_session_enable() failed!",
2008 if (VPPCOM_DEBUG > 0)
2009 clib_warning ("[%d] sending app attach", getpid ());
2011 rv = vppcom_app_attach ();
2014 clib_warning ("[%d] vppcom_app_attach() failed!", getpid ());
2018 if (VPPCOM_DEBUG > 0)
2019 clib_warning ("[%d] app_name '%s', my_client_index %d (0x%x)",
2020 getpid (), app_name, vcm->my_client_index,
2021 vcm->my_client_index);
2028 vppcom_app_destroy (void)
2032 if (vcm->my_client_index == ~0)
2035 if (VPPCOM_DEBUG > 0)
2036 clib_warning ("[%d] detaching from VPP, my_client_index %d (0x%x)",
2037 getpid (), vcm->my_client_index, vcm->my_client_index);
2039 vppcom_app_detach ();
2040 rv = vppcom_wait_for_app_state_change (STATE_APP_ENABLED);
2041 if (PREDICT_FALSE (rv))
2043 if (VPPCOM_DEBUG > 0)
2044 clib_warning ("[%d] application detach timed out, rv = %s (%d)",
2045 getpid (), vppcom_retval_str (rv), rv);
2047 vl_client_disconnect_from_vlib ();
2048 vcm->my_client_index = ~0;
2049 vcm->app_state = STATE_APP_START;
2053 vppcom_session_create (u32 vrf, u8 proto, u8 is_nonblocking)
2058 clib_spinlock_lock (&vcm->sessions_lockp);
2059 pool_get (vcm->sessions, session);
2060 memset (session, 0, sizeof (*session));
2061 session_index = session - vcm->sessions;
2064 session->proto = proto;
2065 session->state = STATE_START;
2066 session->is_nonblocking = is_nonblocking ? 1 : 0;
2067 clib_spinlock_unlock (&vcm->sessions_lockp);
2069 if (VPPCOM_DEBUG > 0)
2070 clib_warning ("[%d] sid %d", getpid (), session_index);
2072 return (int) session_index;
2076 vppcom_session_close (uint32_t session_index)
2078 session_t *session = 0;
2087 session_state_t state;
2089 clib_spinlock_lock (&vcm->sessions_lockp);
2090 rv = vppcom_session_at_index (session_index, &session);
2091 if (PREDICT_FALSE (rv))
2093 if (VPPCOM_DEBUG > 0)
2094 clib_warning ("[%d] invalid session, sid (%u) has been closed!",
2095 getpid (), session_index);
2096 clib_spinlock_unlock (&vcm->sessions_lockp);
2099 is_server = session->is_server;
2100 is_listen = session->is_listen;
2101 is_cut_thru = session->is_cut_thru;
2102 is_vep = session->is_vep;
2103 is_vep_session = session->is_vep_session;
2104 next_sid = session->vep.next_sid;
2105 vep_idx = session->vep.vep_idx;
2106 state = session->state;
2107 clib_spinlock_unlock (&vcm->sessions_lockp);
2109 if (VPPCOM_DEBUG > 0)
2110 clib_warning ("[%d] sid %d", getpid (), session_index);
2114 while (next_sid != ~0)
2116 rv = vppcom_epoll_ctl (session_index, EPOLL_CTL_DEL, next_sid, 0);
2117 if ((VPPCOM_DEBUG > 0) && (rv < 0))
2118 clib_warning ("[%d] EPOLL_CTL_DEL vep_idx %u, sid %u failed, "
2119 "rv = %s (%d)", getpid (), vep_idx, next_sid,
2120 vppcom_retval_str (rv), rv);
2122 clib_spinlock_lock (&vcm->sessions_lockp);
2123 rv = vppcom_session_at_index (session_index, &session);
2124 if (PREDICT_FALSE (rv))
2126 if (VPPCOM_DEBUG > 0)
2128 ("[%d] invalid session, sid (%u) has been closed!",
2129 getpid (), session_index);
2130 clib_spinlock_unlock (&vcm->sessions_lockp);
2133 next_sid = session->vep.next_sid;
2134 clib_spinlock_unlock (&vcm->sessions_lockp);
2141 rv = vppcom_epoll_ctl (vep_idx, EPOLL_CTL_DEL, session_index, 0);
2142 if ((VPPCOM_DEBUG > 0) && (rv < 0))
2143 clib_warning ("[%d] EPOLL_CTL_DEL vep_idx %u, sid %u failed, "
2144 "rv = %s (%d)", getpid (), vep_idx, session_index,
2145 vppcom_retval_str (rv), rv);
2148 if (is_cut_thru && is_server && (state == STATE_ACCEPT))
2150 rv = vppcom_session_unbind_cut_thru (session, session_index);
2151 if ((VPPCOM_DEBUG > 0) && (rv < 0))
2152 clib_warning ("[%d] unbind cut-thru (session %d) failed, "
2154 getpid (), session_index,
2155 vppcom_retval_str (rv), rv);
2157 else if (is_server && is_listen)
2159 rv = vppcom_session_unbind (session_index);
2160 if ((VPPCOM_DEBUG > 0) && (rv < 0))
2161 clib_warning ("[%d] unbind (session %d) failed, rv = %s (%d)",
2162 getpid (), session_index,
2163 vppcom_retval_str (rv), rv);
2165 else if (state == STATE_CONNECT)
2166 if (vppcom_session_disconnect (session_index))
2169 clib_spinlock_lock (&vcm->sessions_lockp);
2170 pool_put_index (vcm->sessions, session_index);
2171 clib_spinlock_unlock (&vcm->sessions_lockp);
2177 vppcom_session_bind (uint32_t session_index, vppcom_endpt_t * ep)
2179 session_t *session = 0;
2183 return VPPCOM_EINVAL;
2185 clib_spinlock_lock (&vcm->sessions_lockp);
2186 rv = vppcom_session_at_index (session_index, &session);
2187 if (PREDICT_FALSE (rv))
2189 clib_spinlock_unlock (&vcm->sessions_lockp);
2190 if (VPPCOM_DEBUG > 0)
2191 clib_warning ("[%d] invalid session, sid (%u) has been closed!",
2192 getpid (), session_index);
2196 if (session->is_vep)
2198 clib_spinlock_unlock (&vcm->sessions_lockp);
2199 if (VPPCOM_DEBUG > 0)
2200 clib_warning ("[%d] invalid session, sid (%u) is an epoll session!",
2201 getpid (), session_index);
2202 return VPPCOM_EBADFD;
2205 session->vrf = ep->vrf;
2206 session->lcl_addr.is_ip4 = ep->is_ip4;
2207 session->lcl_addr.ip46 = to_ip46 (!ep->is_ip4, ep->ip);
2208 session->lcl_port = ep->port;
2210 if (VPPCOM_DEBUG > 0)
2211 clib_warning ("[%d] sid %d, bound to lcl address %U lcl port %u",
2212 getpid (), session_index, format_ip46_address,
2213 &session->lcl_addr.ip46, session->lcl_addr.is_ip4,
2214 clib_net_to_host_u16 (session->lcl_port));
2216 clib_spinlock_unlock (&vcm->sessions_lockp);
2221 vppcom_session_listen (uint32_t listen_session_index, uint32_t q_len)
2223 session_t *listen_session = 0;
2226 clib_spinlock_lock (&vcm->sessions_lockp);
2227 rv = vppcom_session_at_index (listen_session_index, &listen_session);
2228 if (PREDICT_FALSE (rv))
2230 clib_spinlock_unlock (&vcm->sessions_lockp);
2231 if (VPPCOM_DEBUG > 0)
2232 clib_warning ("[%d] invalid session, sid (%u) has been closed!",
2233 getpid (), listen_session_index);
2237 if (listen_session->is_vep)
2239 clib_spinlock_unlock (&vcm->sessions_lockp);
2240 if (VPPCOM_DEBUG > 0)
2241 clib_warning ("[%d] invalid session, sid (%u) is an epoll session!",
2242 getpid (), listen_session_index);
2243 return VPPCOM_EBADFD;
2246 if (listen_session->is_listen)
2248 clib_spinlock_unlock (&vcm->sessions_lockp);
2249 if (VPPCOM_DEBUG > 0)
2250 clib_warning ("[%d] sid (%u) is already in listen state!",
2251 getpid (), listen_session_index);
2255 if (VPPCOM_DEBUG > 0)
2256 clib_warning ("[%d] sid %d", getpid (), listen_session_index);
2258 ASSERT (vcm->bind_session_index == ~0);
2259 vcm->bind_session_index = listen_session_index;
2260 vppcom_send_bind_sock (listen_session);
2261 clib_spinlock_unlock (&vcm->sessions_lockp);
2263 vppcom_wait_for_session_state_change (listen_session_index, STATE_LISTEN,
2264 vcm->cfg.session_timeout);
2265 if (PREDICT_FALSE (rv))
2267 vcm->bind_session_index = ~0;
2268 if (VPPCOM_DEBUG > 0)
2269 clib_warning ("[%d] server listen timed out, rv = %d (%d)",
2270 getpid (), vppcom_retval_str (rv), rv);
2274 clib_spinlock_lock (&vcm->sessions_lockp);
2275 rv = vppcom_session_at_index (listen_session_index, &listen_session);
2276 if (PREDICT_FALSE (rv))
2278 clib_spinlock_unlock (&vcm->sessions_lockp);
2279 if (VPPCOM_DEBUG > 0)
2280 clib_warning ("[%d] invalid session, sid (%u) has been closed!",
2281 getpid (), listen_session_index);
2284 listen_session->is_listen = 1;
2285 clib_fifo_validate (vcm->client_session_index_fifo, q_len);
2286 clib_spinlock_unlock (&vcm->sessions_lockp);
2292 vppcom_session_accept (uint32_t listen_session_index, vppcom_endpt_t * ep,
2293 uint32_t flags, double wait_for_time)
2295 session_t *listen_session = 0;
2296 session_t *client_session = 0;
2297 u32 client_session_index = ~0;
2302 clib_spinlock_lock (&vcm->sessions_lockp);
2303 rv = vppcom_session_at_index (listen_session_index, &listen_session);
2304 if (PREDICT_FALSE (rv))
2306 clib_spinlock_unlock (&vcm->sessions_lockp);
2307 if (VPPCOM_DEBUG > 0)
2308 clib_warning ("[%d] invalid session, sid (%u) has been closed!",
2309 getpid (), listen_session_index);
2313 if (listen_session->is_vep)
2315 clib_spinlock_unlock (&vcm->sessions_lockp);
2316 if (VPPCOM_DEBUG > 0)
2317 clib_warning ("[%d] invalid session, sid (%u) is an epoll session!",
2318 getpid (), listen_session_index);
2319 return VPPCOM_EBADFD;
2322 if (listen_session->state != STATE_LISTEN)
2324 clib_spinlock_unlock (&vcm->sessions_lockp);
2325 if (VPPCOM_DEBUG > 0)
2326 clib_warning ("[%d] session not in listen state, state = %s",
2328 vppcom_session_state_str (listen_session->state));
2329 return VPPCOM_EBADFD;
2331 wait_for = listen_session->is_nonblocking ? 0 :
2332 (wait_for_time < 0) ? vcm->cfg.accept_timeout : wait_for_time;
2334 if (VPPCOM_DEBUG > 0)
2335 clib_warning ("[%d] sid %d: %s (%d)", getpid (),
2336 listen_session_index,
2337 vppcom_session_state_str (listen_session->state),
2338 listen_session->state);
2339 clib_spinlock_unlock (&vcm->sessions_lockp);
2343 rv = vppcom_wait_for_client_session_index (wait_for);
2346 if ((VPPCOM_DEBUG > 0))
2347 clib_warning ("[%d] sid %d, accept timed out, rv = %s (%d)",
2348 getpid (), listen_session_index,
2349 vppcom_retval_str (rv), rv);
2350 if ((wait_for == 0) || (wait_for_time > 0))
2357 clib_spinlock_lock (&vcm->sessions_lockp);
2358 clib_fifo_sub1 (vcm->client_session_index_fifo, client_session_index);
2359 rv = vppcom_session_at_index (client_session_index, &client_session);
2360 ASSERT (rv == VPPCOM_OK);
2361 ASSERT (client_session->peer_addr.is_ip4 ==
2362 listen_session->lcl_addr.is_ip4);
2364 client_session->is_nonblocking = (flags & O_NONBLOCK) ? 1 : 0;
2365 if (VPPCOM_DEBUG > 0)
2366 clib_warning ("[%d] Got a request: client sid %d, flags %d, "
2367 " is_nonblocking %u", getpid (), client_session_index,
2368 flags, client_session->is_nonblocking);
2370 ep->vrf = client_session->vrf;
2371 ep->is_cut_thru = client_session->is_cut_thru;
2372 ep->is_ip4 = client_session->peer_addr.is_ip4;
2373 ep->port = client_session->peer_port;
2374 if (client_session->peer_addr.is_ip4)
2375 clib_memcpy (ep->ip, &client_session->peer_addr.ip46.ip4,
2376 sizeof (ip4_address_t));
2378 clib_memcpy (ep->ip, &client_session->peer_addr.ip46.ip6,
2379 sizeof (ip6_address_t));
2381 if (client_session->is_server && client_session->is_cut_thru)
2383 static svm_fifo_segment_create_args_t _a;
2384 svm_fifo_segment_create_args_t *a = &_a;
2385 svm_fifo_segment_private_t *seg;
2387 cut_thru_str = "cut-thru ";
2389 /* Create the segment */
2390 memset (a, 0, sizeof (*a));
2391 a->segment_name = (char *)
2392 format ((u8 *) a->segment_name, "%d:segment%d%c",
2393 getpid (), vcm->unique_segment_index++, 0);
2394 a->segment_size = vcm->cfg.segment_size;
2395 a->preallocated_fifo_pairs = vcm->cfg.preallocated_fifo_pairs;
2396 a->rx_fifo_size = vcm->cfg.rx_fifo_size;
2397 a->tx_fifo_size = vcm->cfg.tx_fifo_size;
2399 rv = svm_fifo_segment_create (a);
2400 if (PREDICT_FALSE (rv))
2402 if (VPPCOM_DEBUG > 1)
2403 clib_warning ("[%d] svm_fifo_segment_create ('%s') failed",
2404 getpid (), a->segment_name);
2405 vec_reset_length (a->new_segment_indices);
2406 rv = VNET_API_ERROR_URI_FIFO_CREATE_FAILED;
2407 vppcom_send_connect_session_reply (client_session, rv);
2408 clib_spinlock_unlock (&vcm->sessions_lockp);
2409 return VPPCOM_ENOMEM;
2412 client_session->segment_name = vec_dup ((u8 *) a->segment_name);
2413 client_session->sm_seg_index = a->new_segment_indices[0];
2414 vec_free (a->new_segment_indices);
2416 seg = svm_fifo_segment_get_segment (client_session->sm_seg_index);
2417 client_session->server_rx_fifo =
2418 svm_fifo_segment_alloc_fifo (seg, vcm->cfg.rx_fifo_size,
2419 FIFO_SEGMENT_RX_FREELIST);
2420 if (PREDICT_FALSE (!client_session->server_rx_fifo))
2422 svm_fifo_segment_delete (seg);
2423 clib_warning ("[%d] rx fifo alloc failed, size %ld (0x%lx)",
2424 getpid (), vcm->cfg.rx_fifo_size,
2425 vcm->cfg.rx_fifo_size);
2426 rv = VNET_API_ERROR_URI_FIFO_CREATE_FAILED;
2427 vppcom_send_connect_session_reply (client_session, rv);
2428 clib_spinlock_unlock (&vcm->sessions_lockp);
2429 return VPPCOM_ENOMEM;
2431 client_session->server_rx_fifo->master_session_index =
2432 client_session_index;
2434 client_session->server_tx_fifo =
2435 svm_fifo_segment_alloc_fifo (seg, vcm->cfg.tx_fifo_size,
2436 FIFO_SEGMENT_TX_FREELIST);
2437 if (PREDICT_FALSE (!client_session->server_tx_fifo))
2439 svm_fifo_segment_delete (seg);
2440 if (VPPCOM_DEBUG > 1)
2441 clib_warning ("[%d] tx fifo alloc failed, size %ld (0x%lx)",
2442 getpid (), vcm->cfg.tx_fifo_size,
2443 vcm->cfg.tx_fifo_size);
2444 rv = VNET_API_ERROR_URI_FIFO_CREATE_FAILED;
2445 vppcom_send_connect_session_reply (client_session, rv);
2446 clib_spinlock_unlock (&vcm->sessions_lockp);
2447 return VPPCOM_ENOMEM;
2449 client_session->server_tx_fifo->master_session_index =
2450 client_session_index;
2452 if (VPPCOM_DEBUG > 1)
2453 clib_warning ("[%d] created segment '%s': rx_fifo %p, tx_fifo %p",
2454 getpid (), client_session->segment_name,
2455 client_session->server_rx_fifo,
2456 client_session->server_tx_fifo);
2458 #ifdef CUT_THRU_EVENT_QUEUE /* TBD */
2461 ssvm_shared_header_t *sh = seg->ssvm.sh;
2463 ssvm_lock_non_recursive (sh, 1);
2464 oldheap = ssvm_push_heap (sh);
2465 event_q = client_session->vpp_event_queue =
2466 unix_shared_memory_queue_init (vcm->cfg.event_queue_size,
2467 sizeof (session_fifo_event_t),
2468 getpid (), 0 /* signal not sent */ );
2469 ssvm_pop_heap (oldheap);
2470 ssvm_unlock_non_recursive (sh);
2473 vppcom_send_connect_session_reply (client_session, 0);
2478 vppcom_send_accept_session_reply (client_session->vpp_handle, 0);
2481 if (VPPCOM_DEBUG > 0)
2482 clib_warning ("[%d] sid %d, accepted %sconnection to peer address "
2484 getpid (), client_session_index, cut_thru_str,
2485 format_ip46_address, &client_session->peer_addr.ip46,
2486 client_session->peer_addr.is_ip4,
2487 clib_net_to_host_u16 (client_session->peer_port));
2489 clib_spinlock_unlock (&vcm->sessions_lockp);
2490 return (int) client_session_index;
2494 vppcom_session_connect (uint32_t session_index, vppcom_endpt_t * server_ep)
2496 session_t *session = 0;
2499 clib_spinlock_lock (&vcm->sessions_lockp);
2500 rv = vppcom_session_at_index (session_index, &session);
2501 if (PREDICT_FALSE (rv))
2503 clib_spinlock_unlock (&vcm->sessions_lockp);
2504 if (VPPCOM_DEBUG > 0)
2505 clib_warning ("[%d] invalid session, sid (%u) has been closed!",
2506 getpid (), session_index);
2510 if (session->is_vep)
2512 clib_spinlock_unlock (&vcm->sessions_lockp);
2513 if (VPPCOM_DEBUG > 0)
2514 clib_warning ("[%d] invalid session, sid (%u) is an epoll session!",
2515 getpid (), session_index);
2516 return VPPCOM_EBADFD;
2519 if (session->state == STATE_CONNECT)
2521 clib_spinlock_unlock (&vcm->sessions_lockp);
2522 if (VPPCOM_DEBUG > 0)
2523 clib_warning ("[%d] session, sid (%u) already connected!",
2524 getpid (), session_index);
2528 session->vrf = server_ep->vrf;
2529 session->peer_addr.is_ip4 = server_ep->is_ip4;
2530 session->peer_addr.ip46 = to_ip46 (!server_ep->is_ip4, server_ep->ip);
2531 session->peer_port = server_ep->port;
2533 if (VPPCOM_DEBUG > 0)
2535 u8 *ip_str = format (0, "%U", format_ip46_address,
2536 &session->peer_addr.ip46,
2537 session->peer_addr.is_ip4);
2538 clib_warning ("[%d] connect sid %d to %s server port %d proto %s",
2539 getpid (), session_index, ip_str,
2540 clib_net_to_host_u16 (session->peer_port),
2541 session->proto ? "UDP" : "TCP");
2545 vppcom_send_connect_sock (session, session_index);
2546 clib_spinlock_unlock (&vcm->sessions_lockp);
2547 rv = vppcom_wait_for_session_state_change (session_index, STATE_CONNECT,
2548 vcm->cfg.session_timeout);
2549 if (PREDICT_FALSE (rv))
2551 if (VPPCOM_DEBUG > 0)
2552 clib_warning ("[%d] connect timed out, rv = %s (%d)",
2553 getpid (), vppcom_retval_str (rv), rv);
2556 if (VPPCOM_DEBUG > 0)
2557 clib_warning ("[%d] sid %d connected!", getpid (), session_index);
2563 vppcom_session_read_internal (uint32_t session_index, void *buf, int n,
2566 session_t *session = 0;
2567 svm_fifo_t *rx_fifo;
2575 clib_spinlock_lock (&vcm->sessions_lockp);
2576 rv = vppcom_session_at_index (session_index, &session);
2577 if (PREDICT_FALSE (rv))
2579 clib_spinlock_unlock (&vcm->sessions_lockp);
2580 if (VPPCOM_DEBUG > 0)
2581 clib_warning ("[%d] invalid session, sid (%u) has been closed!",
2582 getpid (), session_index);
2586 if (session->is_vep)
2588 clib_spinlock_unlock (&vcm->sessions_lockp);
2589 if (VPPCOM_DEBUG > 0)
2590 clib_warning ("[%d] invalid session, sid (%u) is an epoll session!",
2591 getpid (), session_index);
2592 return VPPCOM_EBADFD;
2595 if (session->state == STATE_DISCONNECT)
2597 clib_spinlock_unlock (&vcm->sessions_lockp);
2598 if (VPPCOM_DEBUG > 0)
2599 clib_warning ("[%d] sid (%u) has been closed by remote peer!",
2600 getpid (), session_index);
2601 return VPPCOM_ECONNRESET;
2604 rx_fifo = ((!session->is_cut_thru || session->is_server) ?
2605 session->server_rx_fifo : session->server_tx_fifo);
2606 fifo_str = ((!session->is_cut_thru || session->is_server) ?
2607 "server_rx_fifo" : "server_tx_fifo");
2609 ((EPOLLET | EPOLLIN) & session->vep.ev.events) == (EPOLLET | EPOLLIN);
2610 clib_spinlock_unlock (&vcm->sessions_lockp);
2615 n_read = svm_fifo_peek (rx_fifo, 0, n, buf);
2617 n_read = svm_fifo_dequeue_nowait (rx_fifo, n, buf);
2619 while (!session->is_nonblocking && (n_read <= 0));
2621 if (poll_et && (n_read <= 0))
2623 clib_spinlock_lock (&vcm->sessions_lockp);
2624 session->vep.et_mask |= EPOLLIN;
2625 clib_spinlock_unlock (&vcm->sessions_lockp);
2628 if ((VPPCOM_DEBUG > 2) && (n_read > 0))
2629 clib_warning ("[%d] sid %d, read %d bytes from %s (%p)", getpid (),
2630 session_index, n_read, fifo_str, rx_fifo);
2632 return (n_read <= 0) ? VPPCOM_EAGAIN : n_read;
2636 vppcom_session_read (uint32_t session_index, void *buf, int n)
2638 return (vppcom_session_read_internal (session_index, buf, n, 0));
2642 vppcom_session_peek (uint32_t session_index, void *buf, int n)
2644 return (vppcom_session_read_internal (session_index, buf, n, 1));
2648 vppcom_session_read_ready (session_t * session, u32 session_index)
2650 svm_fifo_t *rx_fifo = 0;
2654 /* Assumes caller has acquired spinlock: vcm->sessions_lockp */
2655 if (session->is_vep)
2657 clib_spinlock_unlock (&vcm->sessions_lockp);
2658 if (VPPCOM_DEBUG > 0)
2659 clib_warning ("[%d] invalid session, sid (%u) is an epoll session!",
2660 getpid (), session_index);
2661 return VPPCOM_EBADFD;
2664 if (session->state == STATE_DISCONNECT)
2666 if (VPPCOM_DEBUG > 0)
2667 clib_warning ("[%d] sid (%u) has been closed by remote peer!",
2668 getpid (), session_index);
2669 return VPPCOM_ECONNRESET;
2672 if (session->is_listen)
2673 ready = clib_fifo_elts (vcm->client_session_index_fifo);
2676 rx_fifo = ((!session->is_cut_thru || session->is_server) ?
2677 session->server_rx_fifo : session->server_tx_fifo);
2679 ready = svm_fifo_max_dequeue (rx_fifo);
2683 ((EPOLLET | EPOLLIN) & session->vep.ev.events) == (EPOLLET | EPOLLIN);
2684 if (poll_et && (ready == 0))
2686 if (VPPCOM_DEBUG > 11)
2687 clib_warning ("[%d] sid %d: current vep.et_mask = 0x%x", getpid (),
2688 session_index, session->vep.et_mask);
2689 session->vep.et_mask |= EPOLLIN;
2690 if (VPPCOM_DEBUG > 11)
2691 clib_warning ("[%d] sid %d: updated vep.et_mask = 0x%x", getpid (),
2692 session_index, session->vep.et_mask);
2695 if (session->vep.et_mask && (VPPCOM_DEBUG > 11))
2696 clib_warning ("[%d] sid %d, is_listen %u, peek %s (%p), ready = %d, "
2698 getpid (), session_index, session->is_listen,
2699 session->is_server ? "server_rx_fifo" : "server_tx_fifo",
2700 rx_fifo, ready, session->vep.et_mask);
2705 vppcom_session_write (uint32_t session_index, void *buf, int n)
2707 session_t *session = 0;
2708 svm_fifo_t *tx_fifo;
2709 unix_shared_memory_queue_t *q;
2710 session_fifo_event_t evt;
2717 clib_spinlock_lock (&vcm->sessions_lockp);
2718 rv = vppcom_session_at_index (session_index, &session);
2719 if (PREDICT_FALSE (rv))
2721 clib_spinlock_unlock (&vcm->sessions_lockp);
2722 if (VPPCOM_DEBUG > 0)
2723 clib_warning ("[%d] invalid session, sid (%u) has been closed!",
2724 getpid (), session_index);
2728 if (session->is_vep)
2730 clib_spinlock_unlock (&vcm->sessions_lockp);
2731 if (VPPCOM_DEBUG > 0)
2732 clib_warning ("[%d] invalid session, sid (%u) is an epoll session!",
2733 getpid (), session_index);
2734 return VPPCOM_EBADFD;
2737 if (session->state == STATE_DISCONNECT)
2739 clib_spinlock_unlock (&vcm->sessions_lockp);
2740 if (VPPCOM_DEBUG > 0)
2741 clib_warning ("[%d] sid (%u) has been closed by remote peer!",
2742 getpid (), session_index);
2743 return VPPCOM_ECONNRESET;
2746 tx_fifo = ((!session->is_cut_thru || session->is_server) ?
2747 session->server_tx_fifo : session->server_rx_fifo);
2748 fifo_str = ((!session->is_cut_thru || session->is_server) ?
2749 "server_tx_fifo" : "server_rx_fifo");
2750 q = session->vpp_event_queue;
2751 poll_et = (((EPOLLET | EPOLLOUT) & session->vep.ev.events) ==
2752 (EPOLLET | EPOLLOUT));
2753 clib_spinlock_unlock (&vcm->sessions_lockp);
2757 n_write = svm_fifo_enqueue_nowait (tx_fifo, n, buf);
2759 while (!session->is_nonblocking && (n_write <= 0));
2761 /* If event wasn't set, add one */
2762 if (!session->is_cut_thru && (n_write > 0) && svm_fifo_set_event (tx_fifo))
2766 /* Fabricate TX event, send to vpp */
2768 evt.event_type = FIFO_EVENT_APP_TX;
2770 rval = vppcom_session_at_index (session_index, &session);
2771 if (PREDICT_FALSE (rval))
2773 if (VPPCOM_DEBUG > 1)
2774 clib_warning ("[%d] invalid session, sid (%u) has been closed!",
2775 getpid (), session_index);
2779 unix_shared_memory_queue_add (q, (u8 *) & evt,
2780 0 /* do wait for mutex */ );
2783 if (poll_et && (n_write <= 0))
2785 clib_spinlock_lock (&vcm->sessions_lockp);
2786 session->vep.et_mask |= EPOLLOUT;
2787 clib_spinlock_unlock (&vcm->sessions_lockp);
2790 if (VPPCOM_DEBUG > 2)
2793 clib_warning ("[%d] sid %d, FIFO-FULL %s (%p)", getpid (),
2794 session_index, fifo_str, tx_fifo);
2796 clib_warning ("[%d] sid %d, wrote %d bytes to %s (%p)", getpid (),
2797 session_index, n_write, fifo_str, tx_fifo);
2799 return (n_write < 0) ? VPPCOM_EAGAIN : n_write;
2803 vppcom_session_write_ready (session_t * session, u32 session_index)
2805 svm_fifo_t *tx_fifo;
2810 /* Assumes caller has acquired spinlock: vcm->sessions_lockp */
2811 if (session->is_vep)
2813 clib_spinlock_unlock (&vcm->sessions_lockp);
2814 if (VPPCOM_DEBUG > 0)
2815 clib_warning ("[%d] invalid session, sid (%u) is an epoll session!",
2816 getpid (), session_index);
2817 return VPPCOM_EBADFD;
2820 if (session->state == STATE_DISCONNECT)
2822 if (VPPCOM_DEBUG > 0)
2823 clib_warning ("[%d] sid (%u) has been closed by remote peer!",
2824 getpid (), session_index);
2825 return VPPCOM_ECONNRESET;
2828 tx_fifo = ((!session->is_cut_thru || session->is_server) ?
2829 session->server_tx_fifo : session->server_rx_fifo);
2830 fifo_str = ((!session->is_cut_thru || session->is_server) ?
2831 "server_tx_fifo" : "server_rx_fifo");
2833 ready = svm_fifo_max_enqueue (tx_fifo);
2835 if (VPPCOM_DEBUG > 3)
2836 clib_warning ("[%d] sid %d, peek %s (%p), ready = %d", getpid (),
2837 session_index, fifo_str, tx_fifo, ready);
2838 poll_et = (((EPOLLET | EPOLLOUT) & session->vep.ev.events) ==
2839 (EPOLLET | EPOLLOUT));
2840 if (poll_et && (ready == 0))
2841 session->vep.et_mask |= EPOLLOUT;
2847 vppcom_select (unsigned long n_bits, unsigned long *read_map,
2848 unsigned long *write_map, unsigned long *except_map,
2849 double time_to_wait)
2852 session_t *session = 0;
2853 int rv, bits_set = 0;
2854 f64 timeout = clib_time_now (&vcm->clib_time) + time_to_wait;
2855 u32 minbits = clib_max (n_bits, BITS (uword));
2857 ASSERT (sizeof (clib_bitmap_t) == sizeof (long int));
2859 if (n_bits && read_map)
2861 clib_bitmap_validate (vcm->rd_bitmap, minbits);
2862 clib_memcpy (vcm->rd_bitmap, read_map, vec_len (vcm->rd_bitmap));
2863 memset (read_map, 0, vec_len (vcm->rd_bitmap));
2865 if (n_bits && write_map)
2867 clib_bitmap_validate (vcm->wr_bitmap, minbits);
2868 clib_memcpy (vcm->wr_bitmap, write_map, vec_len (vcm->wr_bitmap));
2869 memset (write_map, 0, vec_len (vcm->wr_bitmap));
2871 if (n_bits && except_map)
2873 clib_bitmap_validate (vcm->ex_bitmap, minbits);
2874 clib_memcpy (vcm->ex_bitmap, except_map, vec_len (vcm->ex_bitmap));
2875 memset (except_map, 0, vec_len (vcm->ex_bitmap));
2885 clib_bitmap_foreach (session_index, vcm->rd_bitmap,
2887 clib_spinlock_lock (&vcm->sessions_lockp);
2888 rv = vppcom_session_at_index (session_index, &session);
2891 clib_spinlock_unlock (&vcm->sessions_lockp);
2892 if (VPPCOM_DEBUG > 1)
2893 clib_warning ("[%d] session %d specified in "
2894 "read_map is closed.", getpid (),
2896 bits_set = VPPCOM_EBADFD;
2900 rv = vppcom_session_read_ready (session, session_index);
2901 clib_spinlock_unlock (&vcm->sessions_lockp);
2902 if (except_map && vcm->ex_bitmap &&
2903 clib_bitmap_get (vcm->ex_bitmap, session_index) &&
2906 // TBD: clib_warning
2907 clib_bitmap_set_no_check (except_map, session_index, 1);
2912 // TBD: clib_warning
2913 clib_bitmap_set_no_check (read_map, session_index, 1);
2921 clib_bitmap_foreach (session_index, vcm->wr_bitmap,
2923 clib_spinlock_lock (&vcm->sessions_lockp);
2924 rv = vppcom_session_at_index (session_index, &session);
2927 clib_spinlock_unlock (&vcm->sessions_lockp);
2928 if (VPPCOM_DEBUG > 0)
2929 clib_warning ("[%d] session %d specified in "
2930 "write_map is closed.", getpid (),
2932 bits_set = VPPCOM_EBADFD;
2936 rv = vppcom_session_write_ready (session, session_index);
2937 clib_spinlock_unlock (&vcm->sessions_lockp);
2938 if (write_map && (rv > 0))
2940 // TBD: clib_warning
2941 clib_bitmap_set_no_check (write_map, session_index, 1);
2949 clib_bitmap_foreach (session_index, vcm->ex_bitmap,
2951 clib_spinlock_lock (&vcm->sessions_lockp);
2952 rv = vppcom_session_at_index (session_index, &session);
2955 clib_spinlock_unlock (&vcm->sessions_lockp);
2956 if (VPPCOM_DEBUG > 1)
2957 clib_warning ("[%d] session %d specified in "
2958 "except_map is closed.", getpid (),
2960 bits_set = VPPCOM_EBADFD;
2964 rv = vppcom_session_read_ready (session, session_index);
2965 clib_spinlock_unlock (&vcm->sessions_lockp);
2968 // TBD: clib_warning
2969 clib_bitmap_set_no_check (except_map, session_index, 1);
2977 while (clib_time_now (&vcm->clib_time) < timeout);
2984 vep_verify_epoll_chain (u32 vep_idx)
2987 vppcom_epoll_t *vep;
2991 if (VPPCOM_DEBUG <= 1)
2994 /* Assumes caller has acquired spinlock: vcm->sessions_lockp */
2995 rv = vppcom_session_at_index (vep_idx, &session);
2996 if (PREDICT_FALSE (rv))
2998 clib_warning ("[%d] ERROR: Invalid vep_idx (%u)!", getpid (), vep_idx);
3001 if (PREDICT_FALSE (!session->is_vep))
3003 clib_warning ("[%d] ERROR: vep_idx (%u) is not a vep!", getpid (),
3007 clib_warning ("[%d] vep_idx (%u): Dumping epoll chain\n"
3010 " is_vep_session = %u\n"
3011 " wait_cont_idx = 0x%x (%u)\n"
3013 vep_idx, session->is_vep, session->is_vep_session,
3014 session->wait_cont_idx, session->wait_cont_idx);
3017 vep = &session->vep;
3018 sid = vep->next_sid;
3021 rv = vppcom_session_at_index (sid, &session);
3022 if (PREDICT_FALSE (rv))
3024 clib_warning ("[%d] ERROR: Invalid sid (%u)!", getpid (), sid);
3027 if (PREDICT_FALSE (session->is_vep))
3028 clib_warning ("[%d] ERROR: sid (%u) is a vep!",
3029 getpid (), vep_idx);
3030 else if (PREDICT_FALSE (!session->is_vep_session))
3032 clib_warning ("[%d] ERROR: session (%u) is not a vep session!",
3036 if (PREDICT_FALSE (session->vep.vep_idx != vep_idx))
3037 clib_warning ("[%d] ERROR: session (%u) vep_idx (%u) != "
3038 "vep_idx (%u)!", getpid (),
3039 sid, session->vep.vep_idx, vep_idx);
3040 if (session->is_vep_session)
3042 clib_warning ("vep_idx[%u]: sid 0x%x (%u)\n"
3044 " next_sid = 0x%x (%u)\n"
3045 " prev_sid = 0x%x (%u)\n"
3046 " vep_idx = 0x%x (%u)\n"
3047 " ev.events = 0x%x\n"
3048 " ev.data.u64 = 0x%llx\n"
3052 vep->next_sid, vep->next_sid,
3053 vep->prev_sid, vep->prev_sid,
3054 vep->vep_idx, vep->vep_idx,
3055 vep->ev.events, vep->ev.data.u64, vep->et_mask);
3062 clib_warning ("[%d] vep_idx (%u): Dump complete!\n", getpid (), vep_idx);
3066 vppcom_epoll_create (void)
3068 session_t *vep_session;
3071 clib_spinlock_lock (&vcm->sessions_lockp);
3072 pool_get (vcm->sessions, vep_session);
3073 memset (vep_session, 0, sizeof (*vep_session));
3074 vep_idx = vep_session - vcm->sessions;
3076 vep_session->is_vep = 1;
3077 vep_session->vep.vep_idx = ~0;
3078 vep_session->vep.next_sid = ~0;
3079 vep_session->vep.prev_sid = ~0;
3080 vep_session->wait_cont_idx = ~0;
3081 clib_spinlock_unlock (&vcm->sessions_lockp);
3083 if (VPPCOM_DEBUG > 0)
3084 clib_warning ("[%d] Created vep_idx %u!", getpid (), vep_idx);
3090 vppcom_epoll_ctl (uint32_t vep_idx, int op, uint32_t session_index,
3091 struct epoll_event *event)
3093 session_t *vep_session;
3097 if (vep_idx == session_index)
3099 if (VPPCOM_DEBUG > 0)
3100 clib_warning ("[%d] ERROR: vep_idx == session_index (%u)!",
3101 getpid (), vep_idx);
3102 return VPPCOM_EINVAL;
3105 clib_spinlock_lock (&vcm->sessions_lockp);
3106 rv = vppcom_session_at_index (vep_idx, &vep_session);
3107 if (PREDICT_FALSE (rv))
3109 if (VPPCOM_DEBUG > 0)
3110 clib_warning ("[%d] ERROR: Invalid vep_idx (%u)!", vep_idx);
3113 if (PREDICT_FALSE (!vep_session->is_vep))
3115 if (VPPCOM_DEBUG > 0)
3116 clib_warning ("[%d] ERROR: vep_idx (%u) is not a vep!",
3117 getpid (), vep_idx);
3122 ASSERT (vep_session->vep.vep_idx == ~0);
3123 ASSERT (vep_session->vep.prev_sid == ~0);
3125 rv = vppcom_session_at_index (session_index, &session);
3126 if (PREDICT_FALSE (rv))
3128 if (VPPCOM_DEBUG > 0)
3129 clib_warning ("[%d] ERROR: Invalid session_index (%u)!",
3130 getpid (), session_index);
3133 if (PREDICT_FALSE (session->is_vep))
3135 if (VPPCOM_DEBUG > 0)
3136 clib_warning ("ERROR: session_index (%u) is a vep!", vep_idx);
3144 if (PREDICT_FALSE (!event))
3146 clib_warning ("[%d] ERROR: EPOLL_CTL_ADD: NULL pointer to "
3147 "epoll_event structure!", getpid ());
3151 if (vep_session->vep.next_sid != ~0)
3153 session_t *next_session;
3154 rv = vppcom_session_at_index (vep_session->vep.next_sid,
3156 if (PREDICT_FALSE (rv))
3158 if (VPPCOM_DEBUG > 0)
3159 clib_warning ("[%d] ERROR: EPOLL_CTL_ADD: Invalid "
3160 "vep.next_sid (%u) on vep_idx (%u)!",
3161 getpid (), vep_session->vep.next_sid, vep_idx);
3164 ASSERT (next_session->vep.prev_sid == vep_idx);
3165 next_session->vep.prev_sid = session_index;
3167 session->vep.next_sid = vep_session->vep.next_sid;
3168 session->vep.prev_sid = vep_idx;
3169 session->vep.vep_idx = vep_idx;
3170 session->vep.et_mask = VEP_DEFAULT_ET_MASK;
3171 session->vep.ev = *event;
3172 session->is_vep_session = 1;
3173 vep_session->vep.next_sid = session_index;
3174 if (VPPCOM_DEBUG > 1)
3175 clib_warning ("[%d] EPOLL_CTL_ADD: vep_idx %u, sid %u, events 0x%x,"
3176 " data 0x%llx!", getpid (), vep_idx, session_index,
3177 event->events, event->data.u64);
3181 if (PREDICT_FALSE (!event))
3183 clib_warning ("[%d] ERROR: EPOLL_CTL_MOD: NULL pointer to "
3184 "epoll_event structure!", getpid ());
3188 if (PREDICT_FALSE (!session->is_vep_session &&
3189 (session->vep.vep_idx != vep_idx)))
3191 if (VPPCOM_DEBUG > 0)
3193 if (!session->is_vep_session)
3194 clib_warning ("[%d] ERROR: EPOLL_CTL_MOD: session (%u) "
3195 "is not a vep session!",
3196 getpid (), session_index);
3198 clib_warning ("[%d] ERROR: EPOLL_CTL_MOD: session (%u) "
3199 "vep_idx (%u) != vep_idx (%u)!",
3200 getpid (), session_index,
3201 session->vep.vep_idx, vep_idx);
3206 session->vep.et_mask = VEP_DEFAULT_ET_MASK;
3207 session->vep.ev = *event;
3208 if (VPPCOM_DEBUG > 1)
3209 clib_warning ("[%d] EPOLL_CTL_MOD: vep_idx %u, sid %u, events 0x%x,"
3210 " data 0x%llx!", getpid (), vep_idx, session_index,
3211 event->events, event->data.u64);
3215 if (PREDICT_FALSE (!session->is_vep_session &&
3216 (session->vep.vep_idx != vep_idx)))
3218 if (VPPCOM_DEBUG > 0)
3220 if (!session->is_vep_session)
3221 clib_warning ("[%d] ERROR: EPOLL_CTL_DEL: session (%u) "
3222 "is not a vep session!",
3223 getpid (), session_index);
3225 clib_warning ("[%d] ERROR: EPOLL_CTL_DEL: session (%u) "
3226 "vep_idx (%u) != vep_idx (%u)!",
3227 getpid (), session_index,
3228 session->vep.vep_idx, vep_idx);
3234 vep_session->wait_cont_idx =
3235 (vep_session->wait_cont_idx == session_index) ?
3236 session->vep.next_sid : vep_session->wait_cont_idx;
3238 if (session->vep.prev_sid == vep_idx)
3239 vep_session->vep.next_sid = session->vep.next_sid;
3242 session_t *prev_session;
3243 rv = vppcom_session_at_index (session->vep.prev_sid, &prev_session);
3244 if (PREDICT_FALSE (rv))
3246 if (VPPCOM_DEBUG > 0)
3247 clib_warning ("[%d] ERROR: EPOLL_CTL_DEL: Invalid "
3248 "vep.prev_sid (%u) on sid (%u)!",
3249 getpid (), session->vep.prev_sid,
3253 ASSERT (prev_session->vep.next_sid == session_index);
3254 prev_session->vep.next_sid = session->vep.next_sid;
3256 if (session->vep.next_sid != ~0)
3258 session_t *next_session;
3259 rv = vppcom_session_at_index (session->vep.next_sid, &next_session);
3260 if (PREDICT_FALSE (rv))
3262 if (VPPCOM_DEBUG > 0)
3263 clib_warning ("[%d] ERROR: EPOLL_CTL_DEL: Invalid "
3264 "vep.next_sid (%u) on sid (%u)!",
3265 getpid (), session->vep.next_sid,
3269 ASSERT (next_session->vep.prev_sid == session_index);
3270 next_session->vep.prev_sid = session->vep.prev_sid;
3273 memset (&session->vep, 0, sizeof (session->vep));
3274 session->vep.next_sid = ~0;
3275 session->vep.prev_sid = ~0;
3276 session->vep.vep_idx = ~0;
3277 session->is_vep_session = 0;
3278 if (VPPCOM_DEBUG > 1)
3279 clib_warning ("[%d] EPOLL_CTL_DEL: vep_idx %u, sid %u!",
3280 getpid (), vep_idx, session_index);
3284 clib_warning ("[%d] ERROR: Invalid operation (%d)!", getpid (), op);
3288 vep_verify_epoll_chain (vep_idx);
3291 clib_spinlock_unlock (&vcm->sessions_lockp);
3296 vppcom_epoll_wait (uint32_t vep_idx, struct epoll_event *events,
3297 int maxevents, double wait_for_time)
3299 session_t *vep_session;
3301 f64 timeout = clib_time_now (&vcm->clib_time) + wait_for_time;
3302 u32 keep_trying = 1;
3304 u32 vep_next_sid, wait_cont_idx;
3307 if (PREDICT_FALSE (maxevents <= 0))
3309 if (VPPCOM_DEBUG > 0)
3310 clib_warning ("[%d] ERROR: Invalid maxevents (%d)!",
3311 getpid (), maxevents);
3312 return VPPCOM_EINVAL;
3314 memset (events, 0, sizeof (*events) * maxevents);
3316 VCL_LOCK_AND_GET_SESSION (vep_idx, &vep_session);
3317 vep_next_sid = vep_session->vep.next_sid;
3318 is_vep = vep_session->is_vep;
3319 wait_cont_idx = vep_session->wait_cont_idx;
3320 clib_spinlock_unlock (&vcm->sessions_lockp);
3322 if (PREDICT_FALSE (!is_vep))
3324 if (VPPCOM_DEBUG > 0)
3325 clib_warning ("[%d] ERROR: vep_idx (%u) is not a vep!",
3326 getpid (), vep_idx);
3330 if (PREDICT_FALSE (vep_next_sid == ~0))
3332 if (VPPCOM_DEBUG > 0)
3333 clib_warning ("[%d] WARNING: vep_idx (%u) is empty!",
3334 getpid (), vep_idx);
3344 for (sid = (wait_cont_idx == ~0) ? vep_next_sid : wait_cont_idx;
3345 sid != ~0; sid = next_sid)
3347 u32 session_events, et_mask, clear_et_mask, session_vep_idx;
3348 u8 add_event, is_vep_session;
3350 u64 session_ev_data;
3352 VCL_LOCK_AND_GET_SESSION (sid, &session);
3353 next_sid = session->vep.next_sid;
3354 session_events = session->vep.ev.events;
3355 et_mask = session->vep.et_mask;
3356 is_vep = session->is_vep;
3357 is_vep_session = session->is_vep_session;
3358 session_vep_idx = session->vep.vep_idx;
3359 session_ev_data = session->vep.ev.data.u64;
3360 clib_spinlock_unlock (&vcm->sessions_lockp);
3362 if (PREDICT_FALSE (is_vep))
3364 if (VPPCOM_DEBUG > 0)
3365 clib_warning ("[%d] ERROR: sid (%u) is a vep!",
3366 getpid (), vep_idx);
3370 if (PREDICT_FALSE (!is_vep_session))
3372 if (VPPCOM_DEBUG > 0)
3373 clib_warning ("[%d] ERROR: session (%u) is not "
3374 "a vep session!", getpid (), sid);
3378 if (PREDICT_FALSE (session_vep_idx != vep_idx))
3380 clib_warning ("[%d] ERROR: session (%u) "
3381 "vep_idx (%u) != vep_idx (%u)!",
3382 getpid (), sid, session->vep.vep_idx, vep_idx);
3387 add_event = clear_et_mask = 0;
3389 if (EPOLLIN & session_events)
3391 VCL_LOCK_AND_GET_SESSION (sid, &session);
3392 ready = vppcom_session_read_ready (session, sid);
3393 clib_spinlock_unlock (&vcm->sessions_lockp);
3394 if ((ready > 0) && (EPOLLIN & et_mask))
3397 events[num_ev].events |= EPOLLIN;
3398 if (((EPOLLET | EPOLLIN) & session_events) ==
3399 (EPOLLET | EPOLLIN))
3400 clear_et_mask |= EPOLLIN;
3407 case VPPCOM_ECONNRESET:
3408 events[num_ev].events |= EPOLLHUP | EPOLLRDHUP;
3412 events[num_ev].events |= EPOLLERR;
3418 if (EPOLLOUT & session_events)
3420 VCL_LOCK_AND_GET_SESSION (sid, &session);
3421 ready = vppcom_session_write_ready (session, sid);
3422 clib_spinlock_unlock (&vcm->sessions_lockp);
3423 if ((ready > 0) && (EPOLLOUT & et_mask))
3426 events[num_ev].events |= EPOLLOUT;
3427 if (((EPOLLET | EPOLLOUT) & session_events) ==
3428 (EPOLLET | EPOLLOUT))
3429 clear_et_mask |= EPOLLOUT;
3436 case VPPCOM_ECONNRESET:
3437 events[num_ev].events |= EPOLLHUP;
3441 events[num_ev].events |= EPOLLERR;
3449 events[num_ev].data.u64 = session_ev_data;
3450 if (EPOLLONESHOT & session_events)
3452 VCL_LOCK_AND_GET_SESSION (sid, &session);
3453 session->vep.ev.events = 0;
3454 clib_spinlock_unlock (&vcm->sessions_lockp);
3457 if (num_ev == maxevents)
3459 VCL_LOCK_AND_GET_SESSION (vep_idx, &vep_session);
3460 vep_session->wait_cont_idx = next_sid;
3461 clib_spinlock_unlock (&vcm->sessions_lockp);
3465 if (wait_cont_idx != ~0)
3468 next_sid = vep_next_sid;
3469 else if (next_sid == wait_cont_idx)
3473 if (wait_for_time != -1)
3474 keep_trying = (clib_time_now (&vcm->clib_time) <= timeout) ? 1 : 0;
3476 while ((num_ev == 0) && keep_trying);
3478 if (wait_cont_idx != ~0)
3480 VCL_LOCK_AND_GET_SESSION (vep_idx, &vep_session);
3481 vep_session->wait_cont_idx = ~0;
3482 clib_spinlock_unlock (&vcm->sessions_lockp);
3485 return (rv != VPPCOM_OK) ? rv : num_ev;
3489 vppcom_session_attr (uint32_t session_index, uint32_t op,
3490 void *buffer, uint32_t * buflen)
3494 u32 *flags = buffer;
3495 vppcom_endpt_t *ep = buffer;
3497 VCL_LOCK_AND_GET_SESSION (session_index, &session);
3500 case VPPCOM_ATTR_GET_NREAD:
3501 rv = vppcom_session_read_ready (session, session_index);
3502 if (VPPCOM_DEBUG > 2)
3503 clib_warning ("[%d] VPPCOM_ATTR_GET_NREAD: sid %u, nread = %d",
3508 case VPPCOM_ATTR_GET_NWRITE:
3509 rv = vppcom_session_write_ready (session, session_index);
3510 if (VPPCOM_DEBUG > 2)
3511 clib_warning ("[%d] VPPCOM_ATTR_GET_NWRITE: sid %u, nwrite = %d",
3512 getpid (), session_index, rv);
3516 case VPPCOM_ATTR_GET_FLAGS:
3517 if (buffer && buflen && (*buflen >= sizeof (*flags)))
3519 *flags = O_RDWR | ((session->is_nonblocking) ? O_NONBLOCK : 0);
3520 *buflen = sizeof (*flags);
3521 if (VPPCOM_DEBUG > 2)
3522 clib_warning ("[%d] VPPCOM_ATTR_GET_FLAGS: sid %u, "
3523 "flags = 0x%08x, is_nonblocking = %u", getpid (),
3524 session_index, *flags, session->is_nonblocking);
3530 case VPPCOM_ATTR_SET_FLAGS:
3531 if (buffer && buflen && (*buflen >= sizeof (*flags)))
3533 session->is_nonblocking = (*flags & O_NONBLOCK) ? 1 : 0;
3534 if (VPPCOM_DEBUG > 2)
3535 clib_warning ("[%d] VPPCOM_ATTR_SET_FLAGS: sid %u, "
3536 "flags = 0x%08x, is_nonblocking = %u",
3537 getpid (), *flags, session->is_nonblocking);
3543 case VPPCOM_ATTR_GET_PEER_ADDR:
3544 if (buffer && buflen && (*buflen >= sizeof (*ep)))
3546 ep->vrf = session->vrf;
3547 ep->is_ip4 = session->peer_addr.is_ip4;
3548 ep->port = session->peer_port;
3549 if (session->peer_addr.is_ip4)
3550 clib_memcpy (ep->ip, &session->peer_addr.ip46.ip4,
3551 sizeof (ip4_address_t));
3553 clib_memcpy (ep->ip, &session->peer_addr.ip46.ip6,
3554 sizeof (ip6_address_t));
3555 *buflen = sizeof (*ep);
3556 if (VPPCOM_DEBUG > 1)
3557 clib_warning ("[%d] VPPCOM_ATTR_GET_PEER_ADDR: sid %u, is_ip4 = "
3558 "%u, addr = %U, port %u", getpid (),
3559 session_index, ep->is_ip4, format_ip46_address,
3560 &session->peer_addr.ip46, ep->is_ip4,
3561 clib_net_to_host_u16 (ep->port));
3567 case VPPCOM_ATTR_GET_LCL_ADDR:
3568 if (buffer && buflen && (*buflen >= sizeof (*ep)))
3570 ep->vrf = session->vrf;
3571 ep->is_ip4 = session->lcl_addr.is_ip4;
3572 ep->port = session->lcl_port;
3573 if (session->lcl_addr.is_ip4)
3574 clib_memcpy (ep->ip, &session->lcl_addr.ip46.ip4,
3575 sizeof (ip4_address_t));
3577 clib_memcpy (ep->ip, &session->lcl_addr.ip46.ip6,
3578 sizeof (ip6_address_t));
3579 *buflen = sizeof (*ep);
3580 if (VPPCOM_DEBUG > 1)
3581 clib_warning ("[%d] VPPCOM_ATTR_GET_LCL_ADDR: sid %u, is_ip4 = "
3582 "%u, addr = %U port %d", getpid (),
3583 session_index, ep->is_ip4, format_ip46_address,
3584 &session->lcl_addr.ip46, ep->is_ip4,
3585 clib_net_to_host_u16 (ep->port));
3591 case VPPCOM_ATTR_SET_REUSEADDR:
3594 case VPPCOM_ATTR_SET_BROADCAST:
3597 case VPPCOM_ATTR_SET_V6ONLY:
3600 case VPPCOM_ATTR_SET_KEEPALIVE:
3603 case VPPCOM_ATTR_SET_TCP_KEEPIDLE:
3606 case VPPCOM_ATTR_SET_TCP_KEEPINTVL:
3615 clib_spinlock_unlock (&vcm->sessions_lockp);
3620 vppcom_session_recvfrom (uint32_t session_index, void *buffer,
3621 uint32_t buflen, int flags, vppcom_endpt_t * ep)
3624 session_t *session = 0;
3628 clib_spinlock_lock (&vcm->sessions_lockp);
3629 rv = vppcom_session_at_index (session_index, &session);
3630 if (PREDICT_FALSE (rv))
3632 clib_spinlock_unlock (&vcm->sessions_lockp);
3633 if (VPPCOM_DEBUG > 0)
3634 clib_warning ("[%d] invalid session, sid (%u) has been closed!",
3635 getpid (), session_index);
3637 clib_spinlock_unlock (&vcm->sessions_lockp);
3640 ep->vrf = session->vrf;
3641 ep->is_ip4 = session->peer_addr.is_ip4;
3642 ep->port = session->peer_port;
3643 if (session->peer_addr.is_ip4)
3644 clib_memcpy (ep->ip, &session->peer_addr.ip46.ip4,
3645 sizeof (ip4_address_t));
3647 clib_memcpy (ep->ip, &session->peer_addr.ip46.ip6,
3648 sizeof (ip6_address_t));
3649 clib_spinlock_unlock (&vcm->sessions_lockp);
3653 rv = vppcom_session_read (session_index, buffer, buflen);
3654 else if (flags & MSG_PEEK)
3655 rv = vppcom_session_peek (session_index, buffer, buflen);
3658 clib_warning ("[%d] Unsupport flags for recvfrom %d", getpid (), flags);
3659 rv = VPPCOM_EAFNOSUPPORT;
3667 vppcom_session_sendto (uint32_t session_index, void *buffer,
3668 uint32_t buflen, int flags, vppcom_endpt_t * ep)
3671 return VPPCOM_EINVAL;
3676 return VPPCOM_EINVAL;
3681 // TBD check the flags and do the right thing
3682 if (VPPCOM_DEBUG > 2)
3683 clib_warning ("[%d] handling flags 0x%u (%d) not implemented yet.",
3684 getpid (), flags, flags);
3687 return (vppcom_session_write (session_index, buffer, buflen));
3691 * fd.io coding-style-patch-verification: ON
3694 * eval: (c-set-style "gnu")