2 * Copyright (c) 2016 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
19 #define __need_IOV_MAX
20 #include <bits/stdio_lim.h>
21 #include <netinet/tcp.h>
23 #include <vppinfra/types.h>
24 #include <vppinfra/time.h>
25 #include <vppinfra/hash.h>
26 #include <vppinfra/pool.h>
28 #include <vcl/vcom_socket.h>
29 #include <vcl/vcom_socket_wrapper.h>
32 #include <vcl/vppcom.h>
35 #define IOV_MAX __IOV_MAX
39 * VCOM_SOCKET Private definitions and functions.
42 typedef struct vcom_socket_main_t_
45 clib_time_t clib_time;
48 /* vcom_socket pool */
49 vcom_socket_t *vsockets;
51 /* Hash table for socketidx to fd mapping */
55 vcom_epoll_t *vepolls;
57 /* Hash table for epollidx to epfd mapping */
58 uword *epollidx_by_epfd;
60 /* common epitem poll for all epfd */
61 /* TBD: epitem poll per epfd */
62 /* vcom_epitem pool */
63 vcom_epitem_t *vepitems;
65 /* Hash table for epitemidx to epfdfd mapping */
66 uword *epitemidx_by_epfdfd;
68 /* Hash table - key:epfd, value:vec of epitemidx */
69 uword *epitemidxs_by_epfd;
70 /* Hash table - key:fd, value:vec of epitemidx */
71 uword *epitemidxs_by_fd;
75 vcom_socket_main_t vcom_socket_main;
79 vcom_socket_open_socket (int domain, int type, int protocol)
83 /* handle domains implemented by vpp */
88 /* get socket type and
89 * handle the socket types supported by vpp */
90 switch (type & ~(SOCK_CLOEXEC | SOCK_NONBLOCK))
94 /* the type argument serves a second purpose,
95 * in addition to specifying a socket type,
96 * it may include the bitwise OR of any of
97 * SOCK_NONBLOCK and SOCK_CLOEXEC, to modify
98 * the behavior of socket. */
99 rv = libc_socket (domain, type, protocol);
118 vcom_socket_open_epoll (int flags)
126 if (flags && (flags & ~EPOLL_CLOEXEC))
131 /* flags can be either zero or EPOLL_CLOEXEC */
132 rv = libc_epoll_create1 (flags);
140 vcom_socket_close_socket (int fd)
144 rv = libc_close (fd);
152 vcom_socket_close_epoll (int epfd)
156 rv = libc_close (epfd);
164 * Public API functions
169 vcom_socket_is_vcom_fd (int fd)
171 vcom_socket_main_t *vsm = &vcom_socket_main;
173 vcom_socket_t *vsock;
175 p = hash_get (vsm->sockidx_by_fd, fd);
179 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
180 if (vsock && vsock->type == SOCKET_TYPE_VPPCOM_BOUND)
187 vcom_socket_is_vcom_epfd (int epfd)
189 vcom_socket_main_t *vsm = &vcom_socket_main;
191 vcom_epoll_t *vepoll;
193 p = hash_get (vsm->epollidx_by_epfd, epfd);
197 vepoll = pool_elt_at_index (vsm->vepolls, p[0]);
198 if (vepoll && vepoll->type == EPOLL_TYPE_VPPCOM_BOUND)
205 vcom_socket_get_sid (int fd)
207 vcom_socket_main_t *vsm = &vcom_socket_main;
209 vcom_socket_t *vsock;
211 p = hash_get (vsm->sockidx_by_fd, fd);
215 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
216 if (vsock && vsock->type == SOCKET_TYPE_VPPCOM_BOUND)
219 return INVALID_SESSION_ID;
223 vcom_socket_get_vep_idx (int epfd)
225 vcom_socket_main_t *vsm = &vcom_socket_main;
227 vcom_epoll_t *vepoll;
229 p = hash_get (vsm->epollidx_by_epfd, epfd);
233 vepoll = pool_elt_at_index (vsm->vepolls, p[0]);
234 if (vepoll && vepoll->type == EPOLL_TYPE_VPPCOM_BOUND)
235 return vepoll->vep_idx;
237 return INVALID_VEP_IDX;
241 vcom_socket_get_sid_and_vsock (int fd, vcom_socket_t ** vsockp)
243 vcom_socket_main_t *vsm = &vcom_socket_main;
245 vcom_socket_t *vsock;
247 p = hash_get (vsm->sockidx_by_fd, fd);
251 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
252 if (vsock && vsock->type == SOCKET_TYPE_VPPCOM_BOUND)
258 return INVALID_SESSION_ID;
262 vcom_socket_get_vep_idx_and_vepoll (int epfd, vcom_epoll_t ** vepollp)
264 vcom_socket_main_t *vsm = &vcom_socket_main;
266 vcom_epoll_t *vepoll;
268 p = hash_get (vsm->epollidx_by_epfd, epfd);
272 vepoll = pool_elt_at_index (vsm->vepolls, p[0]);
273 if (vepoll && vepoll->type == EPOLL_TYPE_VPPCOM_BOUND)
276 return vepoll->vep_idx;
279 return INVALID_VEP_IDX;
284 vcom_socket_close_vepoll (int epfd)
287 vcom_socket_main_t *vsm = &vcom_socket_main;
289 vcom_epoll_t *vepoll;
291 p = hash_get (vsm->epollidx_by_epfd, epfd);
295 vepoll = pool_elt_at_index (vsm->vepolls, p[0]);
299 if (vepoll->type != EPOLL_TYPE_VPPCOM_BOUND)
316 rv = vppcom_session_close (vepoll->vep_idx);
317 rv = vcom_socket_close_epoll (vepoll->epfd);
319 vepoll_init (vepoll);
320 hash_unset (vsm->epollidx_by_epfd, epfd);
321 pool_put (vsm->vepolls, vepoll);
327 vcom_socket_close_vsock (int fd)
330 vcom_socket_main_t *vsm = &vcom_socket_main;
332 vcom_socket_t *vsock;
334 vcom_epitem_t *vepitem;
336 i32 *vepitemidxs = 0;
337 i32 *vepitemidxs_var = 0;
339 p = hash_get (vsm->sockidx_by_fd, fd);
343 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
347 if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
350 rv = vppcom_session_close (vsock->sid);
351 rv = vcom_socket_close_socket (vsock->fd);
353 vsocket_init (vsock);
354 hash_unset (vsm->sockidx_by_fd, fd);
355 pool_put (vsm->vsockets, vsock);
359 * Before calling close(), user should remove
360 * this fd from the epoll-set of all epoll instances,
361 * otherwise resource(epitems) leaks ensues.
365 * 00. close all epoll instances that are marked as "close"
366 * of which this fd is the "last" remaining member.
367 * 01. epitems associated with this fd are intentionally
368 * not removed, see NOTE: above.
371 /* does this fd participate in epoll */
372 p = hash_get (vsm->epitemidxs_by_fd, fd);
375 vepitemidxs = *(i32 **) p;
376 vec_foreach (vepitemidxs_var, vepitemidxs)
378 vepitem = pool_elt_at_index (vsm->vepitems, vepitemidxs_var[0]);
379 if (vepitem && vepitem->fd == fd &&
380 vepitem->type == FD_TYPE_VCOM_SOCKET)
383 vcom_epoll_t *vepoll;
385 vcom_socket_get_vep_idx_and_vepoll (vepitem->epfd,
391 if (vepoll->count == 1)
394 * force count to zero and
395 * close this epoll instance
398 vcom_socket_close_vepoll (vepoll->epfd);
415 vcom_socket_close (int __fd)
419 if (vcom_socket_is_vcom_fd (__fd))
421 rv = vcom_socket_close_vsock (__fd);
423 else if (vcom_socket_is_vcom_epfd (__fd))
425 rv = vcom_socket_close_vepoll (__fd);
436 vcom_socket_read (int __fd, void *__buf, size_t __nbytes)
439 vcom_socket_main_t *vsm = &vcom_socket_main;
441 vcom_socket_t *vsock;
443 p = hash_get (vsm->sockidx_by_fd, __fd);
447 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
451 if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
459 rv = vcom_fcntl (__fd, F_GETFL, 0);
467 if (!(rv & O_NONBLOCK))
471 rv = vppcom_session_read (vsock->sid, __buf, __nbytes);
473 /* coverity[CONSTANT_EXPRESSION_RESULT] */
474 while (rv == -EAGAIN || rv == -EWOULDBLOCK);
477 /* The file descriptor refers to a socket and has been
478 * marked nonblocking(O_NONBLOCK) and the read would
481 /* is non blocking */
482 rv = vppcom_session_read (vsock->sid, __buf, __nbytes);
487 vcom_socket_readv (int __fd, const struct iovec * __iov, int __iovcnt)
490 vcom_socket_main_t *vsm = &vcom_socket_main;
492 vcom_socket_t *vsock;
493 ssize_t total = 0, len = 0;
496 p = hash_get (vsm->sockidx_by_fd, __fd);
500 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
504 if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
507 if (__iov == 0 || __iovcnt == 0 || __iovcnt > IOV_MAX)
511 for (i = 0; i < __iovcnt; ++i)
513 if (SSIZE_MAX - len < __iov[i].iov_len)
515 len += __iov[i].iov_len;
518 rv = vcom_fcntl (__fd, F_GETFL, 0);
525 if (!(rv & O_NONBLOCK))
529 for (i = 0; i < __iovcnt; ++i)
531 rv = vppcom_session_read (vsock->sid, __iov[i].iov_base,
538 if (rv < __iov[i].iov_len)
539 /* Read less than buffer provided, no point to continue */
544 /* coverity[CONSTANT_EXPRESSION_RESULT] */
545 while ((rv == -EAGAIN || rv == -EWOULDBLOCK) && total == 0);
549 /* is non blocking */
550 for (i = 0; i < __iovcnt; ++i)
552 rv = vppcom_session_read (vsock->sid, __iov[i].iov_base,
567 if (rv < __iov[i].iov_len)
568 /* Read less than buffer provided, no point to continue */
576 vcom_socket_write (int __fd, const void *__buf, size_t __n)
579 vcom_socket_main_t *vsm = &vcom_socket_main;
581 vcom_socket_t *vsock;
588 p = hash_get (vsm->sockidx_by_fd, __fd);
592 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
596 if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
599 rv = vppcom_session_write (vsock->sid, (void *) __buf, __n);
604 vcom_socket_writev (int __fd, const struct iovec * __iov, int __iovcnt)
608 vcom_socket_main_t *vsm = &vcom_socket_main;
610 vcom_socket_t *vsock;
613 p = hash_get (vsm->sockidx_by_fd, __fd);
617 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
621 if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
624 if (__iov == 0 || __iovcnt == 0 || __iovcnt > IOV_MAX)
627 for (i = 0; i < __iovcnt; ++i)
629 rv = vppcom_session_write (vsock->sid, __iov[i].iov_base,
645 * RETURN: 0 - invalid cmd
646 * 1 - cmd not handled by vcom and vppcom
647 * 2 - cmd handled by vcom socket resource
648 * 3 - cmd handled by vppcom
650 /* TBD: incomplete list of cmd */
652 vcom_socket_check_fcntl_cmd (int __cmd)
656 /*cmd not handled by vcom and vppcom */
659 case F_DUPFD_CLOEXEC:
662 /* cmd handled by vcom socket resource */
673 /* cmd handled by vcom and vppcom */
678 /* cmd not handled by vcom and vppcom */
686 vcom_session_fcntl_va (int __sid, int __cmd, va_list __ap)
688 int flags = va_arg (__ap, int);
689 int rv = -EOPNOTSUPP;
692 size = sizeof (flags);
693 if (__cmd == F_SETFL)
695 rv = vppcom_session_attr (__sid, VPPCOM_ATTR_SET_FLAGS, &flags, &size);
697 else if (__cmd == F_GETFL)
699 rv = vppcom_session_attr (__sid, VPPCOM_ATTR_GET_FLAGS, &flags, &size);
708 vcom_socket_fcntl_va (int __fd, int __cmd, va_list __ap)
711 vcom_socket_main_t *vsm = &vcom_socket_main;
713 vcom_socket_t *vsock;
715 p = hash_get (vsm->sockidx_by_fd, __fd);
719 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
723 if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
726 switch (vcom_socket_check_fcntl_cmd (__cmd))
732 /*cmd not handled by vcom and vppcom */
734 rv = libc_vfcntl (vsock->fd, __cmd, __ap);
736 /* cmd handled by vcom socket resource */
738 rv = libc_vfcntl (vsock->fd, __cmd, __ap);
740 /* cmd handled by vppcom */
742 rv = vcom_session_fcntl_va (vsock->sid, __cmd, __ap);
754 * RETURN: 0 - invalid cmd
755 * 1 - cmd not handled by vcom and vppcom
756 * 2 - cmd handled by vcom socket resource
757 * 3 - cmd handled by vppcom
760 vcom_socket_check_ioctl_cmd (unsigned long int __cmd)
766 /* cmd handled by vppcom */
771 /* cmd not handled by vcom and vppcom */
780 vcom_session_ioctl_va (int __sid, int __cmd, va_list __ap)
784 if (__cmd == FIONREAD)
785 rv = vppcom_session_attr (__sid, VPPCOM_ATTR_GET_NREAD, 0, 0);
792 vcom_socket_ioctl_va (int __fd, unsigned long int __cmd, va_list __ap)
795 vcom_socket_main_t *vsm = &vcom_socket_main;
797 vcom_socket_t *vsock;
799 p = hash_get (vsm->sockidx_by_fd, __fd);
803 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
807 if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
810 switch (vcom_socket_check_ioctl_cmd (__cmd))
812 /* Not supported cmd */
817 /* cmd not handled by vcom and vppcom */
819 rv = libc_vioctl (vsock->fd, __cmd, __ap);
822 /* cmd handled by vcom socket resource */
824 rv = libc_vioctl (vsock->fd, __cmd, __ap);
827 /* cmd handled by vppcom */
829 rv = vcom_session_ioctl_va (vsock->sid, __cmd, __ap);
841 vcom_socket_fds_2_sid_fds (
844 fd_set * __restrict vcom_rd_sid_fds,
845 fd_set * __restrict vcom_wr_sid_fds,
846 fd_set * __restrict vcom_ex_sid_fds,
849 fd_set * __restrict vcom_readfds,
850 fd_set * __restrict vcom_writefds,
851 fd_set * __restrict vcom_exceptfds)
856 /* invalid max_sid is -1 */
861 * set sid in sid sets corresponding to fd's in fd sets
862 * compute nsid and vcom_nsid_fds from sid sets
865 for (fd = 0; fd < vcom_nfds; fd++)
872 if ((F) && (S) && FD_ISSET (fd, (F))) \
874 sid = vcom_socket_get_sid (fd); \
875 if (sid != INVALID_SESSION_ID) \
892 _(vcom_rd_sid_fds, vcom_readfds);
893 _(vcom_wr_sid_fds, vcom_writefds);
894 _(vcom_ex_sid_fds, vcom_exceptfds);
898 *vcom_nsid_fds = max_sid != -1 ? max_sid + 1 : 0;
906 * PRE: 00. sid sets were derived from fd sets
907 * 01. sid sets were updated with sids that actually changed
909 * 02. fd sets still has watched fds
911 * This function will modify in place fd sets to indicate which fd's
912 * actually changed status(inferred from sid sets)
915 vcom_socket_sid_fds_2_fds (
919 fd_set * __restrict vcom_readfds,
920 fd_set * __restrict vcom_writefds,
921 fd_set * __restrict vcom_exceptfds,
924 fd_set * __restrict vcom_rd_sid_fds,
925 fd_set * __restrict vcom_wr_sid_fds,
926 fd_set * __restrict vcom_ex_sid_fds)
931 /* invalid max_fd is -1 */
937 * modify in place fd sets to indicate which fd's
938 * actually changed status(inferred from sid sets)
940 for (fd = 0; fd < vcom_nfds; fd++)
947 if ((F) && (S) && FD_ISSET (fd, (F))) \
949 sid = vcom_socket_get_sid (fd); \
950 if (sid != INVALID_SESSION_ID) \
952 if (!FD_ISSET (sid, (S))) \
965 _(vcom_rd_sid_fds, vcom_readfds);
966 _(vcom_wr_sid_fds, vcom_writefds);
967 _(vcom_ex_sid_fds, vcom_exceptfds);
972 * compute nfd and new_vcom_nfds from fd sets
974 for (fd = 0; fd < vcom_nfds; fd++)
978 if ((F) && FD_ISSET (fd, (F))) \
995 *new_vcom_nfds = max_fd != -1 ? max_fd + 1 : 0;
1004 * vom_socket_select is always called with
1005 * timeout->tv_sec and timeout->tv_usec set to zero.
1006 * hence vppcom_select return immediately.
1009 * TBD: do{body;} while(timeout conditional); timeout loop
1012 vcom_socket_select (int vcom_nfds, fd_set * __restrict vcom_readfds,
1013 fd_set * __restrict vcom_writefds,
1014 fd_set * __restrict vcom_exceptfds,
1015 struct timeval *__restrict timeout)
1017 static unsigned long vcom_nsid_fds = 0;
1018 vcom_socket_main_t *vsm = &vcom_socket_main;
1022 int new_vcom_nfds = 0;
1023 int new_vcom_nfd = 0;
1026 fd_set vcom_rd_sid_fds;
1027 fd_set vcom_wr_sid_fds;
1028 fd_set vcom_ex_sid_fds;
1030 /* in seconds eg. 3.123456789 seconds */
1031 double time_to_wait = (double) 0;
1033 /* validate inputs */
1039 /* convert timeval timeout to double time_to_wait */
1042 if (timeout->tv_sec == 0 && timeout->tv_usec == 0)
1044 /* polling: vppcom_select returns immediately */
1045 time_to_wait = (double) 0;
1049 /*TBD: use timeval api */
1050 time_to_wait = (double) timeout->tv_sec +
1051 (double) timeout->tv_usec / (double) 1000000 +
1052 (double) (timeout->tv_usec % 1000000) / (double) 1000000;
1058 * no timeout: vppcom_select can block indefinitely
1059 * waiting for a file descriptor to become ready
1061 /* set to a phantom value */
1065 /* zero the sid_sets */
1077 _(&vcom_rd_sid_fds, vcom_readfds);
1078 _(&vcom_wr_sid_fds, vcom_writefds);
1079 _(&vcom_ex_sid_fds, vcom_exceptfds);
1084 if (time_to_wait > 0)
1088 "[%d] vcom_socket_select called to "
1089 "emulate delay_ns()!\n", vsm->my_pid);
1090 rv = vppcom_select (0, NULL, NULL, NULL, time_to_wait);
1094 fprintf (stderr, "[%d] vcom_socket_select called vcom_nfds = 0 "
1095 "and invalid time_to_wait (%f)!\n",
1096 vsm->my_pid, time_to_wait);
1101 /* populate read, write and except sid_sets */
1102 vcom_nsid = vcom_socket_fds_2_sid_fds (
1104 vcom_readfds || vcom_writefds
1105 || vcom_exceptfds ? (int *)
1106 &vcom_nsid_fds : NULL,
1107 vcom_readfds ? &vcom_rd_sid_fds :
1109 vcom_writefds ? &vcom_wr_sid_fds :
1111 vcom_exceptfds ? &vcom_ex_sid_fds :
1116 vcom_writefds, vcom_exceptfds);
1122 rv = vppcom_select (vcom_nsid_fds,
1123 vcom_readfds ? (unsigned long *) &vcom_rd_sid_fds :
1125 vcom_writefds ? (unsigned long *) &vcom_wr_sid_fds :
1127 vcom_exceptfds ? (unsigned long *) &vcom_ex_sid_fds :
1128 NULL, time_to_wait);
1130 fprintf (stderr, "[%d] called vppcom_select(): "
1131 "'%04d'='%04d'\n", vsm->my_pid, rv, (int) vcom_nsid_fds);
1133 /* check if any file descriptors changed status */
1137 * on exit, sets are modified in place to indicate which
1138 * file descriptors actually changed status
1142 * comply with pre-condition
1143 * do not clear vcom fd sets befor calling
1144 * vcom_socket_sid_fds_2_fds
1146 new_vcom_nfd = vcom_socket_sid_fds_2_fds (
1156 &vcom_rd_sid_fds : NULL,
1158 &vcom_wr_sid_fds : NULL,
1160 &vcom_ex_sid_fds : NULL);
1161 if (new_vcom_nfd < 0)
1163 return new_vcom_nfd;
1165 if (new_vcom_nfds < 0)
1176 vcom_socket_socket (int __domain, int __type, int __protocol)
1179 vcom_socket_main_t *vsm = &vcom_socket_main;
1180 vcom_socket_t *vsock;
1185 u8 is_nonblocking = __type & SOCK_NONBLOCK ? 1 : 0;
1186 int type = __type & ~(SOCK_NONBLOCK | SOCK_CLOEXEC);
1188 fd = vcom_socket_open_socket (__domain, __type, __protocol);
1195 sid = vppcom_session_create (VPPCOM_VRF_DEFAULT,
1196 (type == SOCK_DGRAM) ?
1197 VPPCOM_PROTO_UDP : VPPCOM_PROTO_TCP,
1202 goto out_close_socket;
1205 pool_get (vsm->vsockets, vsock);
1206 vsocket_init (vsock);
1208 sockidx = vsock - vsm->vsockets;
1209 hash_set (vsm->sockidx_by_fd, fd, sockidx);
1211 vsocket_set (vsock, fd, sid, SOCKET_TYPE_VPPCOM_BOUND);
1215 vcom_socket_close_socket (fd);
1221 vcom_socket_socketpair (int __domain, int __type, int __protocol,
1229 vcom_socket_bind (int __fd, __CONST_SOCKADDR_ARG __addr, socklen_t __len)
1232 vcom_socket_main_t *vsm = &vcom_socket_main;
1234 vcom_socket_t *vsock;
1238 p = hash_get (vsm->sockidx_by_fd, __fd);
1242 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1246 if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
1254 ep.vrf = VPPCOM_VRF_DEFAULT;
1255 switch (__addr->sa_family)
1258 if (__len != sizeof (struct sockaddr_in))
1262 ep.is_ip4 = VPPCOM_IS_IP4;
1263 ep.ip = (u8 *) & ((const struct sockaddr_in *) __addr)->sin_addr;
1264 ep.port = (u16) ((const struct sockaddr_in *) __addr)->sin_port;
1268 if (__len != sizeof (struct sockaddr_in6))
1272 ep.is_ip4 = VPPCOM_IS_IP6;
1273 ep.ip = (u8 *) & ((const struct sockaddr_in6 *) __addr)->sin6_addr;
1274 ep.port = (u16) ((const struct sockaddr_in6 *) __addr)->sin6_port;
1282 rv = vppcom_session_bind (vsock->sid, &ep);
1287 vcom_session_getsockname (int sid, vppcom_endpt_t * ep)
1290 uint32_t size = sizeof (*ep);
1292 rv = vppcom_session_attr (sid, VPPCOM_ATTR_GET_LCL_ADDR, ep, &size);
1297 vcom_socket_getsockname (int __fd, __SOCKADDR_ARG __addr,
1298 socklen_t * __restrict __len)
1301 vcom_socket_main_t *vsm = &vcom_socket_main;
1303 vcom_socket_t *vsock;
1306 p = hash_get (vsm->sockidx_by_fd, __fd);
1310 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1314 if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
1317 if (!__addr || !__len)
1321 ep.ip = (u8 *) & ((const struct sockaddr_in *) __addr)->sin_addr;
1322 rv = vcom_session_getsockname (vsock->sid, &ep);
1325 if (ep.vrf == VPPCOM_VRF_DEFAULT)
1327 __addr->sa_family = ep.is_ip4 == VPPCOM_IS_IP4 ? AF_INET : AF_INET6;
1328 switch (__addr->sa_family)
1331 ((struct sockaddr_in *) __addr)->sin_port = ep.port;
1332 *__len = sizeof (struct sockaddr_in);
1336 ((struct sockaddr_in6 *) __addr)->sin6_port = ep.port;
1337 *__len = sizeof (struct sockaddr_in6);
1350 vcom_socket_connect (int __fd, __CONST_SOCKADDR_ARG __addr, socklen_t __len)
1353 vcom_socket_main_t *vsm = &vcom_socket_main;
1355 vcom_socket_t *vsock;
1359 p = hash_get (vsm->sockidx_by_fd, __fd);
1362 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1364 ep.vrf = VPPCOM_VRF_DEFAULT;
1365 switch (__addr->sa_family)
1368 ep.is_ip4 = VPPCOM_IS_IP4;
1370 (uint8_t *) & ((const struct sockaddr_in *) __addr)->sin_addr;
1372 (uint16_t) ((const struct sockaddr_in *) __addr)->sin_port;
1376 ep.is_ip4 = VPPCOM_IS_IP6;
1378 (uint8_t *) & ((const struct sockaddr_in6 *) __addr)->sin6_addr;
1380 (uint16_t) ((const struct sockaddr_in6 *) __addr)->sin6_port;
1388 rv = vppcom_session_connect (vsock->sid, &ep);
1394 vcom_session_getpeername (int sid, vppcom_endpt_t * ep)
1397 uint32_t size = sizeof (*ep);
1399 rv = vppcom_session_attr (sid, VPPCOM_ATTR_GET_PEER_ADDR, ep, &size);
1404 vcom_socket_getpeername (int __fd, __SOCKADDR_ARG __addr,
1405 socklen_t * __restrict __len)
1408 vcom_socket_main_t *vsm = &vcom_socket_main;
1410 vcom_socket_t *vsock;
1413 p = hash_get (vsm->sockidx_by_fd, __fd);
1417 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1421 if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
1424 if (!__addr || !__len)
1428 ep.ip = (u8 *) & ((const struct sockaddr_in *) __addr)->sin_addr;
1429 rv = vcom_session_getpeername (vsock->sid, &ep);
1432 if (ep.vrf == VPPCOM_VRF_DEFAULT)
1434 __addr->sa_family = ep.is_ip4 == VPPCOM_IS_IP4 ? AF_INET : AF_INET6;
1435 switch (__addr->sa_family)
1438 ((struct sockaddr_in *) __addr)->sin_port = ep.port;
1439 *__len = sizeof (struct sockaddr_in);
1443 ((struct sockaddr_in6 *) __addr)->sin6_port = ep.port;
1444 *__len = sizeof (struct sockaddr_in6);
1457 vcom_socket_send (int __fd, const void *__buf, size_t __n, int __flags)
1459 return vcom_socket_sendto (__fd, __buf, __n, __flags, NULL, 0);
1463 vcom_socket_recv (int __fd, void *__buf, size_t __n, int __flags)
1466 rv = vcom_socket_recvfrom (__fd, __buf, __n, __flags, NULL, 0);
1471 * RETURN 1 if __fd is (SOCK_STREAM, SOCK_SEQPACKET),
1475 vcom_socket_is_connection_mode_socket (int __fd)
1478 /* TBD define new vppcom api */
1479 vcom_socket_main_t *vsm = &vcom_socket_main;
1481 vcom_socket_t *vsock;
1486 p = hash_get (vsm->sockidx_by_fd, __fd);
1490 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1491 if (vsock && vsock->type == SOCKET_TYPE_VPPCOM_BOUND)
1493 optlen = sizeof (type);
1494 rv = libc_getsockopt (__fd, SOL_SOCKET, SO_TYPE, &type, &optlen);
1499 /* get socket type */
1500 switch (type & ~(SOCK_CLOEXEC | SOCK_NONBLOCK))
1503 case SOCK_SEQPACKET:
1516 static inline ssize_t
1517 vcom_session_sendto (int __sid, void *__buf, size_t __n,
1518 int __flags, __CONST_SOCKADDR_ARG __addr,
1519 socklen_t __addr_len)
1521 vppcom_endpt_t *ep = 0;
1527 ep->vrf = VPPCOM_VRF_DEFAULT;
1528 switch (__addr->sa_family)
1531 ep->is_ip4 = VPPCOM_IS_IP4;
1533 (uint8_t *) & ((const struct sockaddr_in *) __addr)->sin_addr;
1535 (uint16_t) ((const struct sockaddr_in *) __addr)->sin_port;
1539 ep->is_ip4 = VPPCOM_IS_IP6;
1541 (uint8_t *) & ((const struct sockaddr_in6 *) __addr)->sin6_addr;
1543 (uint16_t) ((const struct sockaddr_in6 *) __addr)->sin6_port;
1547 return -EAFNOSUPPORT;
1551 return vppcom_session_sendto (__sid, __buf, __n, __flags, ep);;
1555 vcom_socket_sendto (int __fd, const void *__buf, size_t __n,
1556 int __flags, __CONST_SOCKADDR_ARG __addr,
1557 socklen_t __addr_len)
1559 vcom_socket_main_t *vsm = &vcom_socket_main;
1561 vcom_socket_t *vsock;
1568 p = hash_get (vsm->sockidx_by_fd, __fd);
1572 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1576 if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
1581 if (vcom_socket_is_connection_mode_socket (__fd))
1583 /* ignore __addr and _addr_len */
1584 /* and EISCONN may be returned when they are not NULL and 0 */
1585 if ((__addr != NULL) || (__addr_len != 0))
1594 return -EDESTADDRREQ;
1596 /* not a vppcom supported address family */
1597 if (!((__addr->sa_family == AF_INET) ||
1598 (__addr->sa_family == AF_INET6)))
1604 return vcom_session_sendto (vsock->sid, (void *) __buf, (int) __n,
1605 __flags, __addr, __addr_len);
1608 static inline ssize_t
1609 vcom_session_recvfrom (int __sid, void *__restrict __buf, size_t __n,
1610 int __flags, __SOCKADDR_ARG __addr,
1611 socklen_t * __restrict __addr_len)
1615 u8 src_addr[sizeof (struct sockaddr_in6)];
1620 rv = vppcom_session_recvfrom (__sid, __buf, __n, __flags, &ep);
1624 if (ep.vrf == VPPCOM_VRF_DEFAULT)
1627 ep.is_ip4 == VPPCOM_IS_IP4 ? AF_INET : AF_INET6;
1628 switch (__addr->sa_family)
1631 ((struct sockaddr_in *) __addr)->sin_port = ep.port;
1632 memcpy (&((struct sockaddr_in *) __addr)->sin_addr,
1633 src_addr, sizeof (struct in_addr));
1635 *__addr_len = sizeof (struct sockaddr_in);
1639 ((struct sockaddr_in6 *) __addr)->sin6_port = ep.port;
1640 memcpy (((struct sockaddr_in6 *) __addr)->sin6_addr.
1641 __in6_u.__u6_addr8, src_addr,
1642 sizeof (struct in6_addr));
1643 *__addr_len = sizeof (struct sockaddr_in6);
1656 rv = vppcom_session_recvfrom (__sid, __buf, __n, __flags, NULL);
1662 vcom_socket_recvfrom (int __fd, void *__restrict __buf, size_t __n,
1663 int __flags, __SOCKADDR_ARG __addr,
1664 socklen_t * __restrict __addr_len)
1667 vcom_socket_main_t *vsm = &vcom_socket_main;
1669 vcom_socket_t *vsock;
1671 if (__addr && !__addr_len)
1674 p = hash_get (vsm->sockidx_by_fd, __fd);
1678 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1682 if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
1687 rv = vcom_session_recvfrom (vsock->sid, __buf, __n,
1688 __flags, __addr, __addr_len);
1692 /* TBD: move it to vppcom */
1693 static inline ssize_t
1694 vcom_session_sendmsg (int __sid, const struct msghdr *__message, int __flags)
1697 /* rv = vppcom_session_write (__sid, (void *) __message->__buf,
1703 vcom_socket_sendmsg (int __fd, const struct msghdr * __message, int __flags)
1706 vcom_socket_main_t *vsm = &vcom_socket_main;
1708 vcom_socket_t *vsock;
1710 p = hash_get (vsm->sockidx_by_fd, __fd);
1714 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1718 if (vcom_socket_is_connection_mode_socket (__fd))
1720 /* ignore __addr and _addr_len */
1721 /* and EISCONN may be returned when they are not NULL and 0 */
1722 if ((__message->msg_name != NULL) || (__message->msg_namelen != 0))
1729 /* TBD: validate __message->msg_name and __message->msg_namelen
1730 * and return -EINVAL on validation error
1735 rv = vcom_session_sendmsg (vsock->sid, __message, __flags);
1742 vcom_socket_sendmmsg (int __fd, struct mmsghdr *__vmessages,
1743 unsigned int __vlen, int __flags)
1746 /* TBD: define a new vppcom api */
1751 /* TBD: move it to vppcom */
1752 static inline ssize_t
1753 vcom_session_recvmsg (int __sid, struct msghdr *__message, int __flags)
1756 /* rv = vppcom_session_read (__sid, (void *) __message->__buf,
1763 vcom_socket_recvmsg (int __fd, struct msghdr * __message, int __flags)
1766 vcom_socket_main_t *vsm = &vcom_socket_main;
1768 vcom_socket_t *vsock;
1770 p = hash_get (vsm->sockidx_by_fd, __fd);
1774 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1778 if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
1786 /* validate __flags */
1788 rv = vcom_session_recvmsg (vsock->sid, __message, __flags);
1794 vcom_socket_recvmmsg (int __fd, struct mmsghdr *__vmessages,
1795 unsigned int __vlen, int __flags,
1796 struct timespec *__tmo)
1798 /* TBD: define a new vppcom api */
1803 /* TBD: move it to vppcom */
1805 vcom_session_get_sockopt (int __sid, int __level, int __optname,
1806 void *__restrict __optval,
1807 socklen_t * __restrict __optlen)
1811 /* 1. for socket level options that are NOT socket attributes
1812 * and that has corresponding vpp options get from vppcom */
1819 *(int *) __optval = 0;
1827 /* 2. unhandled options */
1832 vcom_socket_getsockopt (int __fd, int __level, int __optname,
1833 void *__restrict __optval,
1834 socklen_t * __restrict __optlen)
1837 vcom_socket_main_t *vsm = &vcom_socket_main;
1839 vcom_socket_t *vsock;
1841 if (!__optval || !__optlen)
1844 p = hash_get (vsm->sockidx_by_fd, __fd);
1848 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1852 if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
1861 * 1. for socket level options that are socket attributes,
1862 * get from libc_getsockopt.
1863 * 2. for socket level options that are NOT socket
1864 * attributes and that has corresponding vpp options
1866 * 3. for socket level options unimplemented
1867 * return -ENOPROTOOPT */
1885 case SO_TIMESTAMPNS:
1886 case SO_TIMESTAMPING:
1899 case SO_WIFI_STATUS:
1902 case SO_BINDTODEVICE:
1904 case SO_LOCK_FILTER:
1905 case SO_BPF_EXTENSIONS:
1906 case SO_SELECT_ERR_QUEUE:
1907 #ifdef CONFIG_NET_RX_BUSY_POLL
1910 case SO_MAX_PACING_RATE:
1911 #ifdef SO_INCOMING_CPU
1912 case SO_INCOMING_CPU:
1914 rv = libc_getsockopt (__fd, __level, __optname, __optval, __optlen);
1923 rv = vcom_session_get_sockopt (vsock->sid, __level, __optname,
1924 __optval, __optlen);
1928 /* We implement the SO_SNDLOWAT etc to not be settable
1931 return -ENOPROTOOPT;
1937 /* 1. handle options that are NOT socket level options,
1938 * but have corresponding vpp otions. */
1939 rv = vcom_session_get_sockopt (vsock->sid, __level, __optname,
1940 __optval, __optlen);
1947 /* TBD: move it to vppcom */
1949 vcom_session_setsockopt (int __sid, int __level, int __optname,
1950 const void *__optval, socklen_t __optlen)
1952 int rv = -EOPNOTSUPP;
1961 vppcom_session_attr (__sid, VPPCOM_ATTR_SET_TCP_KEEPIDLE, 0, 0);
1965 vppcom_session_attr (__sid, VPPCOM_ATTR_SET_TCP_KEEPINTVL, 0, 0);
1975 rv = vppcom_session_attr (__sid, VPPCOM_ATTR_SET_V6ONLY, 0, 0);
1985 rv = vppcom_session_attr (__sid, VPPCOM_ATTR_SET_KEEPALIVE, 0, 0);
1988 rv = vppcom_session_attr (__sid, VPPCOM_ATTR_SET_REUSEADDR, 0, 0);
1991 rv = vppcom_session_attr (__sid, VPPCOM_ATTR_SET_BROADCAST, 0, 0);
2005 vcom_socket_setsockopt (int __fd, int __level, int __optname,
2006 const void *__optval, socklen_t __optlen)
2009 vcom_socket_main_t *vsm = &vcom_socket_main;
2011 vcom_socket_t *vsock;
2013 p = hash_get (vsm->sockidx_by_fd, __fd);
2017 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
2021 if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
2025 * Options without arguments
2028 if (__optname == SO_BINDTODEVICE)
2030 rv = libc_setsockopt (__fd, __level, __optname, __optval, __optlen);
2041 if (__optlen < sizeof (int))
2050 rv = vcom_session_setsockopt (vsock->sid, __level, __optname,
2051 __optval, __optlen);
2064 rv = vcom_session_setsockopt (vsock->sid, __level, __optname,
2065 __optval, __optlen);
2071 /* handle options at socket level */
2078 rv = vcom_session_setsockopt (vsock->sid, __level, __optname,
2079 __optval, __optlen);
2083 * 1. for socket level options that are socket attributes,
2084 * set it from libc_getsockopt
2085 * 2. for socket level options that are NOT socket
2086 * attributes and that has corresponding vpp options
2087 * set it from vppcom
2088 * 3. for socket level options unimplemented
2089 * return -ENOPROTOOPT */
2105 case SO_TIMESTAMPNS:
2106 case SO_TIMESTAMPING:
2119 case SO_WIFI_STATUS:
2123 * SO_BINDTODEVICE already handled as
2124 * "Options without arguments" */
2125 /* case SO_BINDTODEVICE: */
2127 case SO_LOCK_FILTER:
2128 case SO_BPF_EXTENSIONS:
2129 case SO_SELECT_ERR_QUEUE:
2130 #ifdef CONFIG_NET_RX_BUSY_POLL
2133 case SO_MAX_PACING_RATE:
2134 #ifdef SO_INCOMING_CPU
2135 case SO_INCOMING_CPU:
2137 rv = libc_setsockopt (__fd, __level, __optname, __optval, __optlen);
2146 /* We implement the SO_SNDLOWAT etc to not be settable
2149 return -ENOPROTOOPT;
2155 return -ENOPROTOOPT;
2162 vcom_socket_listen (int __fd, int __n)
2165 vcom_socket_main_t *vsm = &vcom_socket_main;
2167 vcom_socket_t *vsock;
2169 p = hash_get (vsm->sockidx_by_fd, __fd);
2172 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
2174 /* TBD vppcom to accept __n parameter */
2175 rv = vppcom_session_listen (vsock->sid, __n);
2182 vcom_socket_connected_socket (int __fd, int __sid,
2184 int *__type, int *__protocol, int flags)
2187 vcom_socket_main_t *vsm = &vcom_socket_main;
2188 vcom_socket_t *vsock;
2195 optlen = sizeof (*__domain);
2196 rv = libc_getsockopt (__fd, SOL_SOCKET, SO_DOMAIN, __domain, &optlen);
2203 optlen = sizeof (*__type);
2204 rv = libc_getsockopt (__fd, SOL_SOCKET, SO_TYPE, __type, &optlen);
2211 optlen = sizeof (*__protocol);
2212 rv = libc_getsockopt (__fd, SOL_SOCKET, SO_PROTOCOL, __protocol, &optlen);
2219 fd = vcom_socket_open_socket (*__domain, *__type | flags, *__protocol);
2226 pool_get (vsm->vsockets, vsock);
2227 vsocket_init (vsock);
2229 sockidx = vsock - vsm->vsockets;
2230 hash_set (vsm->sockidx_by_fd, fd, sockidx);
2232 vsocket_set (vsock, fd, __sid, SOCKET_TYPE_VPPCOM_BOUND);
2239 /* If flag is 0, then accept4() is the same as accept().
2240 * SOCK_NONBLOCK and SOCK_CLOEXEC can be bitwise ORed in flags
2243 vcom_socket_accept_flags (int __fd, __SOCKADDR_ARG __addr,
2244 socklen_t * __restrict __addr_len, int flags)
2247 vcom_socket_main_t *vsm = &vcom_socket_main;
2249 vcom_socket_t *vsock;
2257 uint8_t addr8[sizeof (struct in6_addr)];
2262 /* validate flags */
2269 * case SOCK_NONBLOCK:
2270 * case SOCK_CLOEXEC:
2271 * case SOCK_NONBLOCK | SOCK_CLOEXEC:
2278 /* flags can be 0 or can be bitwise OR
2279 * of any of SOCK_NONBLOCK and SOCK_CLOEXEC */
2281 if (!(!flags || (flags & (SOCK_NONBLOCK | SOCK_CLOEXEC))))
2283 /* TBD: return proper error code */
2287 /* TBD: return proper error code */
2289 if (!vcom_socket_is_connection_mode_socket (__fd))
2294 p = hash_get (vsm->sockidx_by_fd, __fd);
2297 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
2300 rv = vcom_fcntl (vsock->fd, F_GETFL, 0);
2307 if (!(rv & O_NONBLOCK))
2309 /* socket is not marked as nonblocking
2310 * and no pending connections are present
2311 * on the queue, accept () blocks the caller
2312 * until a connection is present.
2314 rv = vppcom_session_accept (vsock->sid, &ep,
2315 -1.0 /* wait forever */ );
2319 /* The file descriptor refers to a socket and has been
2320 * marked nonblocking(O_NONBLOCK) and the accept would
2323 /* is non blocking */
2324 rv = vppcom_session_accept (vsock->sid, &ep, 0);
2325 /* If the socket is marked nonblocking and
2326 * no pending connections are present on the
2327 * queue, accept fails with the error
2328 * EAGAIN or EWOULDBLOCK
2330 if (rv == VPPCOM_ETIMEDOUT)
2342 /* create a new connected socket resource and set flags
2343 * on the new file descriptor.
2344 * update vsockets and sockidx_by_fd table
2346 fd = vcom_socket_connected_socket (__fd, sid,
2347 &domain, &type, &protocol, flags);
2355 /* TBD populate __addr and __addr_len */
2356 /* TBD: The returned address is truncated if the buffer
2357 * provided is too small, in this case, __addr_len will
2358 * return a value greater than was supplied to the call.*/
2363 /* TBD populate __addr and __addr_len */
2367 ((struct sockaddr_in *) __addr)->sin_family = AF_INET;
2368 ((struct sockaddr_in *) __addr)->sin_port = ep.port;
2369 memcpy (&((struct sockaddr_in *) __addr)->sin_addr,
2370 addr8, sizeof (struct in_addr));
2371 /* TBD: populate __addr_len */
2374 *__addr_len = sizeof (struct sockaddr_in);
2379 ((struct sockaddr_in6 *) __addr)->sin6_family = AF_INET6;
2380 ((struct sockaddr_in6 *) __addr)->sin6_port = ep.port;
2381 memcpy (((struct sockaddr_in6 *) __addr)->sin6_addr.
2382 __in6_u.__u6_addr8, addr8,
2383 sizeof (struct in6_addr));
2384 /* TBD: populate __addr_len */
2387 *__addr_len = sizeof (struct sockaddr_in6);
2392 return -EAFNOSUPPORT;
2400 ((struct sockaddr_in *) __addr)->sin_family = AF_INET;
2401 ((struct sockaddr_in *) __addr)->sin_port = ep.port;
2402 memcpy (&((struct sockaddr_in *) __addr)->sin_addr,
2403 addr8, sizeof (struct in_addr));
2404 /* TBD: populate __addr_len */
2407 *__addr_len = sizeof (struct sockaddr_in);
2412 ((struct sockaddr_in6 *) __addr)->sin6_family = AF_INET6;
2413 ((struct sockaddr_in6 *) __addr)->sin6_port = ep.port;
2414 memcpy (((struct sockaddr_in6 *) __addr)->sin6_addr.
2415 __in6_u.__u6_addr8, addr8,
2416 sizeof (struct in6_addr));
2417 /* TBD: populate __addr_len */
2420 *__addr_len = sizeof (struct sockaddr_in6);
2425 return -EAFNOSUPPORT;
2431 /* when __addr is NULL, nothing is filled in,
2432 * in this case, __addr_len is not used,
2433 * and should also be null
2437 /* TBD: return proper error code */
2447 vcom_socket_accept (int __fd, __SOCKADDR_ARG __addr,
2448 socklen_t * __restrict __addr_len)
2450 /* set flags to 0 for accept() */
2451 return vcom_socket_accept_flags (__fd, __addr, __addr_len, 0);
2456 vcom_socket_accept4 (int __fd, __SOCKADDR_ARG __addr,
2457 socklen_t * __restrict __addr_len, int __flags)
2459 /* SOCK_NONBLOCK and SOCK_CLOEXEC can be bitwise ORed in flags */
2460 return vcom_socket_accept_flags (__fd, __addr, __addr_len, __flags);
2464 /* TBD: move it to vppcom */
2466 vcom_session_shutdown (int __fd, int __how)
2472 vcom_socket_shutdown (int __fd, int __how)
2475 vcom_socket_main_t *vsm = &vcom_socket_main;
2477 vcom_socket_t *vsock;
2479 p = hash_get (vsm->sockidx_by_fd, __fd);
2482 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
2488 rv = vcom_session_shutdown (vsock->sid, __how);
2502 vcom_socket_epoll_create1 (int __flags)
2505 vcom_socket_main_t *vsm = &vcom_socket_main;
2506 vcom_epoll_t *vepoll;
2512 epfd = vcom_socket_open_epoll (__flags);
2519 vep_idx = vppcom_epoll_create ();
2523 goto out_close_epoll;
2526 pool_get (vsm->vepolls, vepoll);
2527 vepoll_init (vepoll);
2529 epollidx = vepoll - vsm->vepolls;
2530 hash_set (vsm->epollidx_by_epfd, epfd, epollidx);
2532 vepoll_set (vepoll, epfd, vep_idx, EPOLL_TYPE_VPPCOM_BOUND, __flags, 0, 0);
2537 vcom_socket_close_epoll (epfd);
2543 * PRE: vppcom_epoll_ctl() is successful
2544 * free_vepitem_on_del : 0 - no_pool_put, 1 - pool_put
2547 vcom_socket_ctl_vepitem (int __epfd, int __op, int __fd,
2548 struct epoll_event *__event,
2549 i32 vep_idx, vcom_epoll_t * vepoll,
2550 i32 vfd_id, void *vfd, vcom_fd_type_t type,
2551 int free_vepitem_on_del)
2554 vcom_socket_main_t *vsm = &vcom_socket_main;
2555 vcom_epitem_t *vepitem;
2557 vcom_epitem_key_t epfdfd = {.epfd = __epfd,.fd = __fd };
2561 i32 *vepitemidxs = 0;
2563 struct epoll_event revent = {.events = 0,.data.fd = INVALID_FD };
2567 /* perform control operations on the epoll instance */
2572 * supplied file descriptor is already
2573 * registered with this epoll instance
2575 /* vepitem exists */
2576 p = hash_get (vsm->epitemidx_by_epfdfd, epfdfd.key);
2583 /* add a new vepitem */
2584 pool_get (vsm->vepitems, vepitem);
2585 vepitem_init (vepitem);
2587 vepitemidx = vepitem - vsm->vepitems;
2588 hash_set (vsm->epitemidx_by_epfdfd, epfdfd.key, vepitemidx);
2589 vepitem_set (vepitem, __epfd, __fd, __fd, __fd, type, *__event, revent);
2591 /* update epitemidxs */
2593 p = hash_get (vsm->epitemidxs_by_epfd, __epfd);
2594 if (!p) /* not exist */
2597 vec_add1 (vepitemidxs, vepitemidx);
2598 hash_set (vsm->epitemidxs_by_epfd, __epfd, vepitemidxs);
2602 vepitemidxs = *(i32 **) p;
2603 vec_add1 (vepitemidxs, vepitemidx);
2604 hash_set3 (vsm->epitemidxs_by_epfd, __epfd, vepitemidxs, 0);
2606 /* update epitemidxs */
2608 p = hash_get (vsm->epitemidxs_by_fd, __fd);
2609 if (!p) /* not exist */
2612 vec_add1 (vepitemidxs, vepitemidx);
2613 hash_set (vsm->epitemidxs_by_fd, __fd, vepitemidxs);
2617 vepitemidxs = *(i32 **) p;
2618 vec_add1 (vepitemidxs, vepitemidx);
2619 hash_set3 (vsm->epitemidxs_by_fd, __fd, vepitemidxs, 0);
2622 /* increment vepoll fd count by 1 */
2631 * supplied file descriptor is not
2632 * registered with this epoll instance
2634 /* vepitem not exist */
2635 p = hash_get (vsm->epitemidx_by_epfdfd, epfdfd.key);
2641 vepitem = pool_elt_at_index (vsm->vepitems, p[0]);
2644 vepitem->event = *__event;
2645 vepitem->revent = revent;
2654 * supplied file descriptor is not
2655 * registered with this epoll instance
2657 /* vepitem not exist */
2658 p = hash_get (vsm->epitemidx_by_epfdfd, epfdfd.key);
2664 vepitemidx = *(i32 *) p;
2665 hash_unset (vsm->epitemidx_by_epfdfd, epfdfd.key);
2667 /* update epitemidxs */
2669 p = hash_get (vsm->epitemidxs_by_epfd, __epfd);
2670 if (!p) /* not exist */
2677 vepitemidxs = *(i32 **) p;
2678 vec_idx = vec_search (vepitemidxs, vepitemidx);
2681 vec_del1 (vepitemidxs, vec_idx);
2682 if (!vec_len (vepitemidxs))
2684 vec_free (vepitemidxs);
2685 hash_unset (vsm->epitemidxs_by_epfd, __epfd);
2690 /* update epitemidxs */
2692 p = hash_get (vsm->epitemidxs_by_fd, __fd);
2693 if (!p) /* not exist */
2700 vepitemidxs = *(i32 **) p;
2701 vec_idx = vec_search (vepitemidxs, vepitemidx);
2704 vec_del1 (vepitemidxs, vec_idx);
2705 if (!vec_len (vepitemidxs))
2707 vec_free (vepitemidxs);
2708 hash_unset (vsm->epitemidxs_by_fd, __fd);
2713 /* pool put vepitem */
2714 vepitem = pool_elt_at_index (vsm->vepitems, vepitemidx);
2715 if (free_vepitem_on_del)
2722 vepitem_init (vepitem);
2723 pool_put (vsm->vepitems, vepitem);
2729 vepitem_init (vepitem);
2733 /* decrement vepoll fd count by 1 */
2751 * PRE: 00. null pointer check on __event
2752 * 01. all other parameters are validated
2756 vcom_socket_epoll_ctl_internal (int __epfd, int __op, int __fd,
2757 struct epoll_event *__event,
2758 int free_vepitem_on_del)
2760 vcom_socket_main_t *vsm = &vcom_socket_main;
2763 vcom_epoll_t *vepoll;
2764 vcom_socket_t *vfd_vsock;
2768 /* get vep_idx and vepoll */
2769 vep_idx = vcom_socket_get_vep_idx_and_vepoll (__epfd, &vepoll);
2770 if (vep_idx == INVALID_VEP_IDX)
2775 /* get vcom fd type, vfd_id and vfd */
2776 sid = vcom_socket_get_sid_and_vsock (__fd, &vfd_vsock);
2777 if ((sid != INVALID_SESSION_ID) &&
2778 vcom_socket_type_is_vppcom_bound (vfd_vsock->type))
2780 rv = vppcom_epoll_ctl (vep_idx, __op, sid, __event);
2781 if (rv == VPPCOM_OK)
2783 cnt = ((__op == EPOLL_CTL_ADD) ? 1 :
2784 (__op == EPOLL_CTL_DEL) ? -1 : 0);
2785 vepoll->count += cnt;
2786 vepoll->vcl_cnt += cnt;
2790 "[%d] vcom_socket_epoll_ctl_i: vppcom_epoll_ctl() "
2791 "returned %d\n\tepfd %d, vep_idx %d, fd %d sid %d op %d"
2792 "\n\tcount %d, vcl_cnt %d, libc_cnt %d\n",
2793 vsm->my_pid, rv, __epfd, vep_idx, __fd, sid, __op,
2794 vepoll->count, vepoll->vcl_cnt, vepoll->libc_cnt);
2798 rv = libc_epoll_ctl (__epfd, __op, __fd, __event);
2801 cnt = ((__op == EPOLL_CTL_ADD) ? 1 :
2802 (__op == EPOLL_CTL_DEL) ? -1 : 0);
2803 vepoll->count += cnt;
2804 vepoll->libc_cnt += cnt;
2808 "[%d] vcom_socket_epoll_ctl_i: libc_epoll_ctl() "
2809 "returned %d\n\tepfd %d, vep_idx %d, fd %d sid %d op %d"
2810 "\n\tcount %d, vcl_cnt %d, libc_cnt %d\n",
2811 vsm->my_pid, rv, __epfd, vep_idx, __fd, sid, __op,
2812 vepoll->count, vepoll->vcl_cnt, vepoll->libc_cnt);
2819 vcom_socket_epoll_ctl (int __epfd, int __op, int __fd,
2820 struct epoll_event *__event)
2824 rv = vcom_socket_epoll_ctl_internal (__epfd, __op, __fd, __event, 1);
2829 vcom_socket_epoll_ctl1 (int __epfd, int __op, int __fd,
2830 struct epoll_event *__event)
2834 rv = vcom_socket_epoll_ctl_internal (__epfd, __op, __fd, __event, 0);
2839 vcom_socket_epoll_pwait (int __epfd, struct epoll_event *__events,
2840 int __maxevents, int __timeout,
2841 const __sigset_t * __ss)
2843 vcom_socket_main_t *vsm = &vcom_socket_main;
2846 double time_to_wait = (double) 0;
2848 vcom_epoll_t *vepoll;
2850 static struct epoll_event *libc_ev = 0;
2852 /* validate __event */
2853 if (!__events || (__timeout < -1))
2855 fprintf (stderr, "[%d] ERROR: vcom_socket_epoll_pwait: "
2856 "Bad args __events %p, __timeout %d\n", vsm->my_pid,
2857 __events, __timeout);
2862 time_to_wait = ((__timeout > 0) ?
2863 (double) __timeout / (double) 1000 : (double) __timeout);
2865 vep_idx = vcom_socket_get_vep_idx_and_vepoll (__epfd, &vepoll);
2866 if (vep_idx == INVALID_VEP_IDX)
2868 fprintf (stderr, "[%d] ERROR: vcom_socket_epoll_pwait: "
2869 "Bad epoll fd %d\n", vsm->my_pid, __epfd);
2873 if (vepoll->count <= 0)
2875 fprintf (stderr, "[%d] ERROR: vcom_socket_epoll_pwait: No events"
2876 " in epfd!\n\tcount %d, vcl_cnt %d, libc_cnt %d\n",
2877 vsm->my_pid, vepoll->count, vepoll->vcl_cnt, vepoll->libc_cnt);
2882 if (vepoll->libc_cnt == 0)
2884 rv = vppcom_epoll_wait (vep_idx, __events, __maxevents, time_to_wait);
2886 else if (vepoll->vcl_cnt == 0)
2888 rv = libc_epoll_pwait (__epfd, __events, __maxevents, __timeout, __ss);
2892 vec_validate (libc_ev, __maxevents);
2893 timeout = clib_time_now (&vsm->clib_time) + time_to_wait;
2896 rv = vppcom_epoll_wait (vep_idx, __events, __maxevents, 0);
2897 rv2 = libc_epoll_pwait (__epfd, libc_ev, __maxevents, 1, __ss);
2898 if ((rv > 0) || (rv2 > 0))
2900 int n = __maxevents - rv;
2901 n = rv2 <= n ? rv2 : n;
2902 rv = (rv > 0) ? rv : 0;
2904 clib_memcpy (&__events[rv], libc_ev, n * sizeof (*libc_ev));
2908 else if ((rv < 0) || (rv2 < 0))
2912 "[%d] ERROR: vppcom_epoll_wait() returned %d\n",
2917 "[%d] ERROR: libc_epoll_wait() failed, errno %d\n",
2918 vsm->my_pid, errno);
2919 rv = (rv < 0) ? rv : -errno;
2924 while ((__timeout == -1)
2925 || (clib_time_now (&vsm->clib_time) < timeout));
2929 vec_reset_length (libc_ev);
2934 vcom_pollfds_2_selectfds (
2936 struct pollfd *__fds, nfds_t __nfds,
2939 fd_set * __restrict vcom_readfds,
2940 fd_set * __restrict vcom_writefds,
2941 fd_set * __restrict vcom_exceptfds)
2945 for (fds_idx = 0; fds_idx < __nfds; fds_idx++)
2947 /* ignore negative fds */
2948 if (__fds[fds_idx].fd < 0)
2953 /* for POLLRDHUP, POLLERR, POLLHUP and POLLNVAL */
2954 FD_SET (__fds[fds_idx].fd, vcom_exceptfds);
2956 /* requested events */
2957 if (__fds[fds_idx].events)
2959 if (__fds[fds_idx].events & POLLIN)
2961 FD_SET (__fds[fds_idx].fd, vcom_readfds);
2963 if (__fds[fds_idx].events & POLLPRI)
2965 FD_SET (__fds[fds_idx].fd, vcom_readfds);
2967 if (__fds[fds_idx].events & POLLOUT)
2969 FD_SET (__fds[fds_idx].fd, vcom_writefds);
2971 #if defined __USE_XOPEN || defined __USE_XOPEN2K8
2972 if (__fds[fds_idx].events & POLLRDNORM)
2974 FD_SET (__fds[fds_idx].fd, vcom_readfds);
2976 if (__fds[fds_idx].events & POLLRDBAND)
2978 FD_SET (__fds[fds_idx].fd, vcom_readfds);
2980 if (__fds[fds_idx].events & POLLWRNORM)
2982 FD_SET (__fds[fds_idx].fd, vcom_writefds);
2984 if (__fds[fds_idx].events & POLLWRBAND)
2986 FD_SET (__fds[fds_idx].fd, vcom_writefds);
2990 } /* for (fds_idx = 0; fds_idx < __nfds; fds_idx++) */
2994 vcom_selectfds_2_pollfds (
2996 struct pollfd *__fds, nfds_t __nfds, int *nfd,
2999 fd_set * __restrict vcom_readfds,
3000 fd_set * __restrict vcom_writefds,
3001 fd_set * __restrict vcom_exceptfds)
3006 for (fds_idx = 0; fds_idx < __nfds; fds_idx++)
3008 /* ignore negative fds */
3009 if (__fds[fds_idx].fd < 0)
3011 __fds[fds_idx].revents = 0;
3014 /* for POLLRDHUP, POLLERR, POLLHUP and POLLNVAL */
3015 if (FD_ISSET (__fds[fds_idx].fd, vcom_exceptfds))
3018 * TBD: for now any select exception
3019 * is flagged as POLLERR
3021 __fds[fds_idx].revents |= POLLERR;
3024 /* requested events */
3025 if (__fds[fds_idx].events & POLLIN)
3027 if (FD_ISSET (__fds[fds_idx].fd, vcom_readfds))
3029 __fds[fds_idx].revents |= POLLIN;
3032 if (__fds[fds_idx].events & POLLPRI)
3034 if (FD_ISSET (__fds[fds_idx].fd, vcom_readfds))
3036 __fds[fds_idx].revents |= POLLIN;
3039 if (__fds[fds_idx].events & POLLOUT)
3041 if (FD_ISSET (__fds[fds_idx].fd, vcom_writefds))
3043 __fds[fds_idx].revents |= POLLOUT;
3046 #if defined __USE_XOPEN || defined __USE_XOPEN2K8
3047 if (__fds[fds_idx].events & POLLRDNORM)
3049 if (FD_ISSET (__fds[fds_idx].fd, vcom_readfds))
3051 __fds[fds_idx].revents |= POLLRDNORM;
3054 if (__fds[fds_idx].events & POLLRDBAND)
3056 if (FD_ISSET (__fds[fds_idx].fd, vcom_readfds))
3058 __fds[fds_idx].revents |= POLLRDBAND;
3061 if (__fds[fds_idx].events & POLLWRNORM)
3063 if (FD_ISSET (__fds[fds_idx].fd, vcom_writefds))
3065 __fds[fds_idx].revents |= POLLWRNORM;
3068 if (__fds[fds_idx].events & POLLWRBAND)
3070 if (FD_ISSET (__fds[fds_idx].fd, vcom_writefds))
3072 __fds[fds_idx].revents |= POLLWRBAND;
3076 } /* for (fds_idx = 0; fds_idx < __nfds; fds_idx++) */
3080 * the number of structures which have nonzero revents fields
3081 * (in other words, those descriptors with events or
3085 for (fds_idx = 0; fds_idx < __nfds; fds_idx++)
3087 /* ignore negative fds */
3088 if (__fds[fds_idx].fd < 0)
3093 if (__fds[fds_idx].revents)
3101 * PRE: parameters are validated,
3102 * vcom_socket_poll is always called with __timeout set to zero
3103 * hence returns immediately
3105 * ACTION: handle non negative validated vcom fds and ignore rest
3109 * implements vcom_socket_poll () interface
3111 * internally uses vcom_socket_select ()
3112 * to realize the behavior
3115 vcom_socket_poll_select_impl (struct pollfd *__fds, nfds_t __nfds,
3119 vcom_socket_main_t *vsm = &vcom_socket_main;
3126 fd_set vcom_readfds;
3127 fd_set vcom_writefds;
3128 fd_set vcom_exceptfds;
3130 /* invalid max_vcom_fd is -1 */
3131 int max_vcom_fd = -1;
3133 /* __timeout is zero to get ready events and return immediately */
3134 struct timeval tv = {.tv_sec = 0,.tv_usec = 0 };
3136 /* validate __nfds from select perspective */
3137 if (__nfds > FD_SETSIZE)
3143 /* zero vcom fd sets */
3159 for (fds_idx = 0; fds_idx < __nfds; fds_idx++)
3161 /* ignore negative fds */
3162 if (__fds[fds_idx].fd < 0)
3167 /* non negative validated vcom fds */
3168 if (__fds[fds_idx].fd > FD_SETSIZE)
3174 /* max_vcom_fd and vcom_nfd */
3175 if (__fds[fds_idx].fd > max_vcom_fd)
3177 /* requested events */
3178 if (__fds[fds_idx].events)
3180 max_vcom_fd = __fds[fds_idx].fd;
3186 vcom_nfds = max_vcom_fd != -1 ? max_vcom_fd + 1 : 0;
3194 vcom_pollfds_2_selectfds (
3199 &vcom_readfds, &vcom_writefds, &vcom_exceptfds);
3201 /* select on vcom fds */
3202 vcom_nfd = vcom_socket_select (vcom_nfds,
3204 &vcom_writefds, &vcom_exceptfds, &tv);
3207 "[%d] vcom_socket_select: "
3208 "'%04d'='%04d'\n", vsm->my_pid, vcom_nfd, vcom_nfds);
3216 vcom_selectfds_2_pollfds (
3218 __fds, __nfds, &nfd,
3221 &vcom_readfds, &vcom_writefds, &vcom_exceptfds);
3230 * TBD: remove this static function once vppcom
3231 * has an implementation in place
3236 vppcom_poll (struct pollfd *__fds, nfds_t __nfds, double time_to_wait)
3242 vcom_socket_poll_vppcom_impl (struct pollfd *__fds, nfds_t __nfds,
3247 /* in seconds eg. 3.123456789 seconds */
3248 double time_to_wait = (double) 0;
3253 /* replace vcom fd with session idx */
3254 for (fds_idx = 0; fds_idx < __nfds; fds_idx++)
3256 /* ignore negative fds */
3257 if (__fds[fds_idx].fd < 0)
3262 /* non negative validated vcom fds */
3263 sid = vcom_socket_get_sid (__fds[fds_idx].fd);
3264 if (sid != INVALID_SESSION_ID)
3266 __fds[fds_idx].fd = sid;
3271 vep_idx = vcom_socket_get_vep_idx (__fds[fds_idx].fd);
3272 if (vep_idx != INVALID_VEP_IDX)
3274 __fds[fds_idx].fd = vep_idx;
3283 /* validate __timeout */
3286 time_to_wait = (double) __timeout / (double) 1000;
3288 else if (__timeout == 0)
3290 time_to_wait = (double) 0;
3297 return vppcom_poll (__fds, __nfds, time_to_wait);
3301 vcom_socket_poll (struct pollfd *__fds, nfds_t __nfds, int __timeout)
3303 /* select an implementation */
3305 /* return vcom_socket_poll_vppcom_impl (__fds, __nfds, __timeout); */
3306 return vcom_socket_poll_select_impl (__fds, __nfds, __timeout);
3311 vcom_socket_ppoll (struct pollfd *__fds, nfds_t __nfds,
3312 const struct timespec *__timeout, const __sigset_t * __ss)
3319 vcom_socket_main_init (void)
3321 vcom_socket_main_t *vsm = &vcom_socket_main;
3324 printf ("vcom_socket_main_init\n");
3328 /* TBD: define FD_MAXSIZE and use it here */
3329 pool_alloc (vsm->vsockets, FD_SETSIZE);
3330 vsm->sockidx_by_fd = hash_create (0, sizeof (i32));
3332 pool_alloc (vsm->vepolls, FD_SETSIZE);
3333 vsm->epollidx_by_epfd = hash_create (0, sizeof (i32));
3335 pool_alloc (vsm->vepitems, FD_SETSIZE);
3336 vsm->epitemidx_by_epfdfd = hash_create (0, sizeof (i32));
3338 vsm->epitemidxs_by_epfd = hash_create (0, sizeof (i32 *));
3339 vsm->epitemidxs_by_fd = hash_create (0, sizeof (i32 *));
3341 clib_time_init (&vsm->clib_time);
3342 vsm->my_pid = getpid ();
3352 vcom_socket_main_show (void)
3354 vcom_socket_main_t *vsm = &vcom_socket_main;
3355 vcom_socket_t *vsock;
3357 vcom_epoll_t *vepoll;
3359 vcom_epitem_t *vepitem;
3363 i32 *vepitemidxs, *vepitemidxs_var;
3367 /* from active list of vsockets show vsock */
3370 pool_foreach (vsock, vsm->vsockets,
3373 "fd='%04d', sid='%08x',type='%-30s'\n",
3374 vsock->fd, vsock->sid,
3375 vcom_socket_type_str (vsock->type));
3379 /* from active list of vepolls, show vepoll */
3382 pool_foreach (vepoll, vsm->vepolls,
3385 "epfd='%04d', vep_idx='%08x', "
3387 "flags='%d', count='%d', close='%d'\n",
3388 vepoll->epfd, vepoll->vep_idx,
3389 vcom_socket_epoll_type_str (vepoll->type),
3390 vepoll->flags, vepoll->count, vepoll->close);
3394 /* from active list of vepitems, show vepitem */
3397 pool_foreach (vepitem, vsm->vepitems,
3400 "epfd='%04d', fd='%04d', "
3401 "next_fd='%04d', prev_fd='%04d', "
3403 "events='%04x', revents='%04x'\n",
3404 vepitem->epfd, vepitem->fd,
3405 vepitem->next_fd, vepitem->prev_fd,
3406 vcom_socket_vcom_fd_type_str (vepitem->type),
3407 vepitem->event.events, vepitem->revent.events);
3412 /* show epitemidxs for epfd */
3414 hash_foreach (epfd, vepitemidxs,
3415 vsm->epitemidxs_by_epfd,
3417 printf("\n[ '%04d': ", epfd);
3418 vec_foreach (vepitemidxs_var,vepitemidxs)
3420 printf("'%04d' ", (int)vepitemidxs_var[0]);
3426 /* show epitemidxs for fd */
3428 hash_foreach (fd, vepitemidxs,
3429 vsm->epitemidxs_by_fd,
3431 printf("\n{ '%04d': ", fd);
3432 vec_foreach (vepitemidxs_var,vepitemidxs)
3434 printf("'%04d' ", (int)vepitemidxs_var[0]);
3444 vcom_socket_main_destroy (void)
3446 vcom_socket_main_t *vsm = &vcom_socket_main;
3447 vcom_socket_t *vsock;
3449 vcom_epoll_t *vepoll;
3451 vcom_epitem_t *vepitem;
3459 printf ("vcom_socket_main_destroy\n");
3465 * from active list of vepitems,
3466 * remove all "vepitem" elements from the pool in a safe way
3470 pool_flush (vepitem, vsm->vepitems,
3472 if ((vepitem->type == FD_TYPE_EPOLL) ||
3473 (vepitem->type == FD_TYPE_VCOM_SOCKET))
3475 vcom_socket_epoll_ctl1 (vepitem->epfd, EPOLL_CTL_DEL,
3477 vepitem_init (vepitem);
3482 pool_free (vsm->vepitems);
3483 hash_free (vsm->epitemidx_by_epfdfd);
3485 /* free vepitemidxs for each epfd */
3487 hash_foreach (epfd, vepitemidxs,
3488 vsm->epitemidxs_by_epfd,
3490 vec_free (vepitemidxs);
3493 hash_free (vsm->epitemidxs_by_epfd);
3495 /* free vepitemidxs for each fd */
3497 hash_foreach (fd, vepitemidxs,
3498 vsm->epitemidxs_by_fd,
3500 vec_free (vepitemidxs);
3503 hash_free (vsm->epitemidxs_by_fd);
3507 * from active list of vsockets,
3508 * close socket and vppcom session
3512 pool_foreach (vsock, vsm->vsockets,
3514 if (vsock->type == SOCKET_TYPE_VPPCOM_BOUND)
3516 vppcom_session_close (vsock->sid);
3517 vcom_socket_close_socket (vsock->fd);
3518 vsocket_init (vsock);
3524 * return vsocket element to the pool
3528 pool_flush (vsock, vsm->vsockets,
3530 // vsocket_init(vsock);
3535 pool_free (vsm->vsockets);
3536 hash_free (vsm->sockidx_by_fd);
3539 * from active list of vepolls,
3540 * close epoll and vppcom_epoll
3544 pool_foreach (vepoll, vsm->vepolls,
3546 if (vepoll->type == EPOLL_TYPE_VPPCOM_BOUND)
3548 vppcom_session_close (vepoll->vep_idx);
3549 vcom_socket_close_epoll (vepoll->epfd); /* TBD: */
3550 vepoll_init (vepoll);
3556 * return vepoll element to the pool
3560 pool_flush (vepoll, vsm->vepolls,
3562 // vepoll_init(vepoll);
3567 pool_free (vsm->vepolls);
3568 hash_free (vsm->epollidx_by_epfd);
3576 * fd.io coding-style-patch-verification: ON
3579 * eval: (c-set-style "gnu")