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/hash.h>
25 #include <vppinfra/pool.h>
27 #include <vcl/vcom_socket.h>
28 #include <vcl/vcom_socket_wrapper.h>
31 #include <vcl/vppcom.h>
35 * VCOM_SOCKET Private definitions and functions.
38 typedef struct vcom_socket_main_t_
42 /* vcom_socket pool */
43 vcom_socket_t *vsockets;
45 /* Hash table for socketidx to fd mapping */
49 vcom_epoll_t *vepolls;
51 /* Hash table for epollidx to epfd mapping */
52 uword *epollidx_by_epfd;
55 /* common epitem poll for all epfd */
56 /* TBD: epitem poll per epfd */
57 /* vcom_epitem pool */
58 vcom_epitem_t *vepitems;
60 /* Hash table for epitemidx to epfdfd mapping */
61 uword *epitemidx_by_epfdfd;
63 /* Hash table - key:epfd, value:vec of epitemidx */
64 uword *epitemidxs_by_epfd;
65 /* Hash table - key:fd, value:vec of epitemidx */
66 uword *epitemidxs_by_fd;
70 vcom_socket_main_t vcom_socket_main;
74 vcom_socket_open_socket (int domain, int type, int protocol)
78 /* handle domains implemented by vpp */
83 /* get socket type and
84 * handle the socket types supported by vpp */
85 switch (type & ~(SOCK_CLOEXEC | SOCK_NONBLOCK))
89 /* the type argument serves a second purpose,
90 * in addition to specifying a socket type,
91 * it may include the bitwise OR of any of
92 * SOCK_NONBLOCK and SOCK_CLOEXEC, to modify
93 * the behavior of socket. */
94 rv = libc_socket (domain, type, protocol);
113 vcom_socket_open_epoll (int flags)
121 if (flags && (flags & ~EPOLL_CLOEXEC))
126 /* flags can be either zero or EPOLL_CLOEXEC */
127 rv = libc_epoll_create1 (flags);
135 vcom_socket_close_socket (int fd)
139 rv = libc_close (fd);
147 vcom_socket_close_epoll (int epfd)
151 rv = libc_close (epfd);
159 * Public API functions
164 vcom_socket_is_vcom_fd (int fd)
166 vcom_socket_main_t *vsm = &vcom_socket_main;
168 vcom_socket_t *vsock;
170 p = hash_get (vsm->sockidx_by_fd, fd);
174 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
175 if (vsock && vsock->type == SOCKET_TYPE_VPPCOM_BOUND)
182 vcom_socket_is_vcom_epfd (int epfd)
184 vcom_socket_main_t *vsm = &vcom_socket_main;
186 vcom_epoll_t *vepoll;
188 p = hash_get (vsm->epollidx_by_epfd, epfd);
192 vepoll = pool_elt_at_index (vsm->vepolls, p[0]);
193 if (vepoll && vepoll->type == EPOLL_TYPE_VPPCOM_BOUND)
200 vcom_socket_get_sid (int fd)
202 vcom_socket_main_t *vsm = &vcom_socket_main;
204 vcom_socket_t *vsock;
206 p = hash_get (vsm->sockidx_by_fd, fd);
210 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
211 if (vsock && vsock->type == SOCKET_TYPE_VPPCOM_BOUND)
214 return INVALID_SESSION_ID;
218 vcom_socket_get_vep_idx (int epfd)
220 vcom_socket_main_t *vsm = &vcom_socket_main;
222 vcom_epoll_t *vepoll;
224 p = hash_get (vsm->epollidx_by_epfd, epfd);
228 vepoll = pool_elt_at_index (vsm->vepolls, p[0]);
229 if (vepoll && vepoll->type == EPOLL_TYPE_VPPCOM_BOUND)
230 return vepoll->vep_idx;
232 return INVALID_VEP_IDX;
236 vcom_socket_get_sid_and_vsock (int fd, vcom_socket_t ** vsockp)
238 vcom_socket_main_t *vsm = &vcom_socket_main;
240 vcom_socket_t *vsock;
242 p = hash_get (vsm->sockidx_by_fd, fd);
246 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
247 if (vsock && vsock->type == SOCKET_TYPE_VPPCOM_BOUND)
253 return INVALID_SESSION_ID;
257 vcom_socket_get_vep_idx_and_vepoll (int epfd, vcom_epoll_t ** vepollp)
259 vcom_socket_main_t *vsm = &vcom_socket_main;
261 vcom_epoll_t *vepoll;
263 p = hash_get (vsm->epollidx_by_epfd, epfd);
267 vepoll = pool_elt_at_index (vsm->vepolls, p[0]);
268 if (vepoll && vepoll->type == EPOLL_TYPE_VPPCOM_BOUND)
271 return vepoll->vep_idx;
274 return INVALID_VEP_IDX;
279 vcom_socket_close_vepoll (int epfd)
282 vcom_socket_main_t *vsm = &vcom_socket_main;
284 vcom_epoll_t *vepoll;
286 p = hash_get (vsm->epollidx_by_epfd, epfd);
290 vepoll = pool_elt_at_index (vsm->vepolls, p[0]);
294 if (vepoll->type != EPOLL_TYPE_VPPCOM_BOUND)
311 rv = vppcom_session_close (vepoll->vep_idx);
312 rv = vcom_socket_close_epoll (vepoll->epfd);
314 vepoll_init (vepoll);
315 hash_unset (vsm->epollidx_by_epfd, epfd);
316 pool_put (vsm->vepolls, vepoll);
322 vcom_socket_close_vsock (int fd)
325 vcom_socket_main_t *vsm = &vcom_socket_main;
327 vcom_socket_t *vsock;
329 vcom_epitem_t *vepitem;
331 i32 *vepitemidxs = 0;
332 i32 *vepitemidxs_var = 0;
334 p = hash_get (vsm->sockidx_by_fd, fd);
338 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
342 if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
345 rv = vppcom_session_close (vsock->sid);
346 rv = vcom_socket_close_socket (vsock->fd);
348 vsocket_init (vsock);
349 hash_unset (vsm->sockidx_by_fd, fd);
350 pool_put (vsm->vsockets, vsock);
354 * Before calling close(), user should remove
355 * this fd from the epoll-set of all epoll instances,
356 * otherwise resource(epitems) leaks ensues.
360 * 00. close all epoll instances that are marked as "close"
361 * of which this fd is the "last" remaining member.
362 * 01. epitems associated with this fd are intentionally
363 * not removed, see NOTE: above.
366 /* does this fd participate in epoll */
367 p = hash_get (vsm->epitemidxs_by_fd, fd);
370 vepitemidxs = *(i32 **) p;
371 vec_foreach (vepitemidxs_var, vepitemidxs)
373 vepitem = pool_elt_at_index (vsm->vepitems, vepitemidxs_var[0]);
374 if (vepitem && vepitem->fd == fd &&
375 vepitem->type == FD_TYPE_VCOM_SOCKET)
378 vcom_epoll_t *vepoll;
380 vcom_socket_get_vep_idx_and_vepoll (vepitem->epfd,
386 if (vepoll->count == 1)
389 * force count to zero and
390 * close this epoll instance
393 vcom_socket_close_vepoll (vepoll->epfd);
410 vcom_socket_close (int __fd)
414 if (vcom_socket_is_vcom_fd (__fd))
416 rv = vcom_socket_close_vsock (__fd);
418 else if (vcom_socket_is_vcom_epfd (__fd))
420 rv = vcom_socket_close_vepoll (__fd);
431 vcom_socket_read (int __fd, void *__buf, size_t __nbytes)
434 vcom_socket_main_t *vsm = &vcom_socket_main;
436 vcom_socket_t *vsock;
438 p = hash_get (vsm->sockidx_by_fd, __fd);
442 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
446 if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
454 rv = vcom_fcntl (__fd, F_GETFL, 0);
462 if (!(rv & O_NONBLOCK))
466 rv = vppcom_session_read (vsock->sid, __buf, __nbytes);
468 /* coverity[CONSTANT_EXPRESSION_RESULT] */
469 while (rv == -EAGAIN || rv == -EWOULDBLOCK);
472 /* The file descriptor refers to a socket and has been
473 * marked nonblocking(O_NONBLOCK) and the read would
476 /* is non blocking */
477 rv = vppcom_session_read (vsock->sid, __buf, __nbytes);
482 vcom_socket_readv (int __fd, const struct iovec * __iov, int __iovcnt)
485 vcom_socket_main_t *vsm = &vcom_socket_main;
487 vcom_socket_t *vsock;
488 ssize_t total = 0, len = 0;
491 p = hash_get (vsm->sockidx_by_fd, __fd);
495 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
499 if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
502 if (__iov == 0 || __iovcnt == 0 || __iovcnt > IOV_MAX)
506 for (i = 0; i < __iovcnt; ++i)
508 if (SSIZE_MAX - len < __iov[i].iov_len)
510 len += __iov[i].iov_len;
513 rv = vcom_fcntl (__fd, F_GETFL, 0);
520 if (!(rv & O_NONBLOCK))
524 for (i = 0; i < __iovcnt; ++i)
526 rv = vppcom_session_read (vsock->sid, __iov[i].iov_base,
533 if (rv < __iov[i].iov_len)
534 /* Read less than buffer provided, no point to continue */
539 /* coverity[CONSTANT_EXPRESSION_RESULT] */
540 while ((rv == -EAGAIN || rv == -EWOULDBLOCK) && total == 0);
544 /* is non blocking */
545 for (i = 0; i < __iovcnt; ++i)
547 rv = vppcom_session_read (vsock->sid, __iov[i].iov_base,
562 if (rv < __iov[i].iov_len)
563 /* Read less than buffer provided, no point to continue */
571 vcom_socket_write (int __fd, const void *__buf, size_t __n)
574 vcom_socket_main_t *vsm = &vcom_socket_main;
576 vcom_socket_t *vsock;
583 p = hash_get (vsm->sockidx_by_fd, __fd);
587 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
591 if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
594 rv = vppcom_session_write (vsock->sid, (void *) __buf, __n);
599 vcom_socket_writev (int __fd, const struct iovec * __iov, int __iovcnt)
603 vcom_socket_main_t *vsm = &vcom_socket_main;
605 vcom_socket_t *vsock;
608 p = hash_get (vsm->sockidx_by_fd, __fd);
612 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
616 if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
619 if (__iov == 0 || __iovcnt == 0 || __iovcnt > IOV_MAX)
622 for (i = 0; i < __iovcnt; ++i)
624 rv = vppcom_session_write (vsock->sid, __iov[i].iov_base,
640 * RETURN: 0 - invalid cmd
641 * 1 - cmd not handled by vcom and vppcom
642 * 2 - cmd handled by vcom socket resource
643 * 3 - cmd handled by vppcom
645 /* TBD: incomplete list of cmd */
647 vcom_socket_check_fcntl_cmd (int __cmd)
651 /*cmd not handled by vcom and vppcom */
654 case F_DUPFD_CLOEXEC:
657 /* cmd handled by vcom socket resource */
668 /* cmd handled by vcom and vppcom */
673 /* cmd not handled by vcom and vppcom */
681 vcom_session_fcntl_va (int __sid, int __cmd, va_list __ap)
683 int flags = va_arg (__ap, int);
684 int rv = -EOPNOTSUPP;
687 size = sizeof (flags);
688 if (__cmd == F_SETFL)
690 rv = vppcom_session_attr (__sid, VPPCOM_ATTR_SET_FLAGS, &flags, &size);
692 else if (__cmd == F_GETFL)
694 rv = vppcom_session_attr (__sid, VPPCOM_ATTR_GET_FLAGS, &flags, &size);
703 vcom_socket_fcntl_va (int __fd, int __cmd, va_list __ap)
706 vcom_socket_main_t *vsm = &vcom_socket_main;
708 vcom_socket_t *vsock;
710 p = hash_get (vsm->sockidx_by_fd, __fd);
714 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
718 if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
721 switch (vcom_socket_check_fcntl_cmd (__cmd))
727 /*cmd not handled by vcom and vppcom */
729 rv = libc_vfcntl (vsock->fd, __cmd, __ap);
731 /* cmd handled by vcom socket resource */
733 rv = libc_vfcntl (vsock->fd, __cmd, __ap);
735 /* cmd handled by vppcom */
737 rv = vcom_session_fcntl_va (vsock->sid, __cmd, __ap);
749 * RETURN: 0 - invalid cmd
750 * 1 - cmd not handled by vcom and vppcom
751 * 2 - cmd handled by vcom socket resource
752 * 3 - cmd handled by vppcom
755 vcom_socket_check_ioctl_cmd (unsigned long int __cmd)
761 /* cmd handled by vppcom */
766 /* cmd not handled by vcom and vppcom */
775 vcom_session_ioctl_va (int __sid, int __cmd, va_list __ap)
779 if (__cmd == FIONREAD)
780 rv = vppcom_session_attr (__sid, VPPCOM_ATTR_GET_NREAD, 0, 0);
787 vcom_socket_ioctl_va (int __fd, unsigned long int __cmd, va_list __ap)
790 vcom_socket_main_t *vsm = &vcom_socket_main;
792 vcom_socket_t *vsock;
794 p = hash_get (vsm->sockidx_by_fd, __fd);
798 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
802 if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
805 switch (vcom_socket_check_ioctl_cmd (__cmd))
807 /* Not supported cmd */
812 /* cmd not handled by vcom and vppcom */
814 rv = libc_vioctl (vsock->fd, __cmd, __ap);
817 /* cmd handled by vcom socket resource */
819 rv = libc_vioctl (vsock->fd, __cmd, __ap);
822 /* cmd handled by vppcom */
824 rv = vcom_session_ioctl_va (vsock->sid, __cmd, __ap);
836 vcom_socket_fds_2_sid_fds (
839 fd_set * __restrict vcom_rd_sid_fds,
840 fd_set * __restrict vcom_wr_sid_fds,
841 fd_set * __restrict vcom_ex_sid_fds,
844 fd_set * __restrict vcom_readfds,
845 fd_set * __restrict vcom_writefds,
846 fd_set * __restrict vcom_exceptfds)
851 /* invalid max_sid is -1 */
856 * set sid in sid sets corresponding to fd's in fd sets
857 * compute nsid and vcom_nsid_fds from sid sets
860 for (fd = 0; fd < vcom_nfds; fd++)
867 if ((F) && (S) && FD_ISSET (fd, (F))) \
869 sid = vcom_socket_get_sid (fd); \
870 if (sid != INVALID_SESSION_ID) \
887 _(vcom_rd_sid_fds, vcom_readfds);
888 _(vcom_wr_sid_fds, vcom_writefds);
889 _(vcom_ex_sid_fds, vcom_exceptfds);
893 *vcom_nsid_fds = max_sid != -1 ? max_sid + 1 : 0;
901 * PRE: 00. sid sets were derived from fd sets
902 * 01. sid sets were updated with sids that actually changed
904 * 02. fd sets still has watched fds
906 * This function will modify in place fd sets to indicate which fd's
907 * actually changed status(inferred from sid sets)
910 vcom_socket_sid_fds_2_fds (
914 fd_set * __restrict vcom_readfds,
915 fd_set * __restrict vcom_writefds,
916 fd_set * __restrict vcom_exceptfds,
919 fd_set * __restrict vcom_rd_sid_fds,
920 fd_set * __restrict vcom_wr_sid_fds,
921 fd_set * __restrict vcom_ex_sid_fds)
926 /* invalid max_fd is -1 */
932 * modify in place fd sets to indicate which fd's
933 * actually changed status(inferred from sid sets)
935 for (fd = 0; fd < vcom_nfds; fd++)
942 if ((F) && (S) && FD_ISSET (fd, (F))) \
944 sid = vcom_socket_get_sid (fd); \
945 if (sid != INVALID_SESSION_ID) \
947 if (!FD_ISSET (sid, (S))) \
960 _(vcom_rd_sid_fds, vcom_readfds);
961 _(vcom_wr_sid_fds, vcom_writefds);
962 _(vcom_ex_sid_fds, vcom_exceptfds);
967 * compute nfd and new_vcom_nfds from fd sets
969 for (fd = 0; fd < vcom_nfds; fd++)
973 if ((F) && FD_ISSET (fd, (F))) \
990 *new_vcom_nfds = max_fd != -1 ? max_fd + 1 : 0;
999 * vom_socket_select is always called with
1000 * timeout->tv_sec and timeout->tv_usec set to zero.
1001 * hence vppcom_select return immediately.
1004 * TBD: do{body;} while(timeout conditional); timeout loop
1007 vcom_socket_select (int vcom_nfds, fd_set * __restrict vcom_readfds,
1008 fd_set * __restrict vcom_writefds,
1009 fd_set * __restrict vcom_exceptfds,
1010 struct timeval *__restrict timeout)
1012 static unsigned long vcom_nsid_fds = 0;
1015 pid_t pid = getpid ();
1017 int new_vcom_nfds = 0;
1018 int new_vcom_nfd = 0;
1021 fd_set vcom_rd_sid_fds;
1022 fd_set vcom_wr_sid_fds;
1023 fd_set vcom_ex_sid_fds;
1025 /* in seconds eg. 3.123456789 seconds */
1026 double time_to_wait = (double) 0;
1028 /* validate inputs */
1034 /* convert timeval timeout to double time_to_wait */
1037 if (timeout->tv_sec == 0 && timeout->tv_usec == 0)
1039 /* polling: vppcom_select returns immediately */
1040 time_to_wait = (double) 0;
1044 /*TBD: use timeval api */
1045 time_to_wait = (double) timeout->tv_sec +
1046 (double) timeout->tv_usec / (double) 1000000 +
1047 (double) (timeout->tv_usec % 1000000) / (double) 1000000;
1053 * no timeout: vppcom_select can block indefinitely
1054 * waiting for a file descriptor to become ready
1056 /* set to a phantom value */
1060 /* zero the sid_sets */
1072 _(&vcom_rd_sid_fds, vcom_readfds);
1073 _(&vcom_wr_sid_fds, vcom_writefds);
1074 _(&vcom_ex_sid_fds, vcom_exceptfds);
1079 if (time_to_wait > 0)
1083 "[%d] vcom_socket_select called to "
1084 "emulate delay_ns()!\n", pid);
1085 rv = vppcom_select (0, NULL, NULL, NULL, time_to_wait);
1089 fprintf (stderr, "[%d] vcom_socket_select called vcom_nfds = 0 "
1090 "and invalid time_to_wait (%f)!\n", pid, time_to_wait);
1095 /* populate read, write and except sid_sets */
1096 vcom_nsid = vcom_socket_fds_2_sid_fds (
1098 vcom_readfds || vcom_writefds
1099 || vcom_exceptfds ? (int *)
1100 &vcom_nsid_fds : NULL,
1101 vcom_readfds ? &vcom_rd_sid_fds :
1103 vcom_writefds ? &vcom_wr_sid_fds :
1105 vcom_exceptfds ? &vcom_ex_sid_fds :
1110 vcom_writefds, vcom_exceptfds);
1116 rv = vppcom_select (vcom_nsid_fds,
1117 vcom_readfds ? (unsigned long *) &vcom_rd_sid_fds :
1119 vcom_writefds ? (unsigned long *) &vcom_wr_sid_fds :
1121 vcom_exceptfds ? (unsigned long *) &vcom_ex_sid_fds :
1122 NULL, time_to_wait);
1124 fprintf (stderr, "[%d] called vppcom_select(): "
1125 "'%04d'='%04d'\n", pid, rv, (int) vcom_nsid_fds);
1127 /* check if any file descriptors changed status */
1131 * on exit, sets are modified in place to indicate which
1132 * file descriptors actually changed status
1136 * comply with pre-condition
1137 * do not clear vcom fd sets befor calling
1138 * vcom_socket_sid_fds_2_fds
1140 new_vcom_nfd = vcom_socket_sid_fds_2_fds (
1150 &vcom_rd_sid_fds : NULL,
1152 &vcom_wr_sid_fds : NULL,
1154 &vcom_ex_sid_fds : NULL);
1155 if (new_vcom_nfd < 0)
1157 return new_vcom_nfd;
1159 if (new_vcom_nfds < 0)
1170 vcom_socket_socket (int __domain, int __type, int __protocol)
1173 vcom_socket_main_t *vsm = &vcom_socket_main;
1174 vcom_socket_t *vsock;
1179 u8 is_nonblocking = __type & SOCK_NONBLOCK ? 1 : 0;
1180 int type = __type & ~(SOCK_NONBLOCK | SOCK_CLOEXEC);
1182 fd = vcom_socket_open_socket (__domain, __type, __protocol);
1189 sid = vppcom_session_create (VPPCOM_VRF_DEFAULT,
1190 (type == SOCK_DGRAM) ?
1191 VPPCOM_PROTO_UDP : VPPCOM_PROTO_TCP,
1196 goto out_close_socket;
1199 pool_get (vsm->vsockets, vsock);
1200 vsocket_init (vsock);
1202 sockidx = vsock - vsm->vsockets;
1203 hash_set (vsm->sockidx_by_fd, fd, sockidx);
1205 vsocket_set (vsock, fd, sid, SOCKET_TYPE_VPPCOM_BOUND);
1209 vcom_socket_close_socket (fd);
1215 vcom_socket_socketpair (int __domain, int __type, int __protocol,
1223 vcom_socket_bind (int __fd, __CONST_SOCKADDR_ARG __addr, socklen_t __len)
1226 vcom_socket_main_t *vsm = &vcom_socket_main;
1228 vcom_socket_t *vsock;
1232 p = hash_get (vsm->sockidx_by_fd, __fd);
1236 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1240 if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
1248 ep.vrf = VPPCOM_VRF_DEFAULT;
1249 switch (__addr->sa_family)
1252 if (__len != sizeof (struct sockaddr_in))
1256 ep.is_ip4 = VPPCOM_IS_IP4;
1257 ep.ip = (u8 *) & ((const struct sockaddr_in *) __addr)->sin_addr;
1258 ep.port = (u16) ((const struct sockaddr_in *) __addr)->sin_port;
1262 if (__len != sizeof (struct sockaddr_in6))
1266 ep.is_ip4 = VPPCOM_IS_IP6;
1267 ep.ip = (u8 *) & ((const struct sockaddr_in6 *) __addr)->sin6_addr;
1268 ep.port = (u16) ((const struct sockaddr_in6 *) __addr)->sin6_port;
1276 rv = vppcom_session_bind (vsock->sid, &ep);
1281 vcom_session_getsockname (int sid, vppcom_endpt_t * ep)
1284 uint32_t size = sizeof (*ep);
1286 rv = vppcom_session_attr (sid, VPPCOM_ATTR_GET_LCL_ADDR, ep, &size);
1291 vcom_socket_getsockname (int __fd, __SOCKADDR_ARG __addr,
1292 socklen_t * __restrict __len)
1295 vcom_socket_main_t *vsm = &vcom_socket_main;
1297 vcom_socket_t *vsock;
1300 p = hash_get (vsm->sockidx_by_fd, __fd);
1304 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1308 if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
1311 if (!__addr || !__len)
1315 ep.ip = (u8 *) & ((const struct sockaddr_in *) __addr)->sin_addr;
1316 rv = vcom_session_getsockname (vsock->sid, &ep);
1319 if (ep.vrf == VPPCOM_VRF_DEFAULT)
1321 __addr->sa_family = ep.is_ip4 == VPPCOM_IS_IP4 ? AF_INET : AF_INET6;
1322 switch (__addr->sa_family)
1325 ((struct sockaddr_in *) __addr)->sin_port = ep.port;
1326 *__len = sizeof (struct sockaddr_in);
1330 ((struct sockaddr_in6 *) __addr)->sin6_port = ep.port;
1331 *__len = sizeof (struct sockaddr_in6);
1344 vcom_socket_connect (int __fd, __CONST_SOCKADDR_ARG __addr, socklen_t __len)
1347 vcom_socket_main_t *vsm = &vcom_socket_main;
1349 vcom_socket_t *vsock;
1353 p = hash_get (vsm->sockidx_by_fd, __fd);
1356 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1358 ep.vrf = VPPCOM_VRF_DEFAULT;
1359 switch (__addr->sa_family)
1362 ep.is_ip4 = VPPCOM_IS_IP4;
1364 (uint8_t *) & ((const struct sockaddr_in *) __addr)->sin_addr;
1366 (uint16_t) ((const struct sockaddr_in *) __addr)->sin_port;
1370 ep.is_ip4 = VPPCOM_IS_IP6;
1372 (uint8_t *) & ((const struct sockaddr_in6 *) __addr)->sin6_addr;
1374 (uint16_t) ((const struct sockaddr_in6 *) __addr)->sin6_port;
1382 rv = vppcom_session_connect (vsock->sid, &ep);
1388 vcom_session_getpeername (int sid, vppcom_endpt_t * ep)
1391 uint32_t size = sizeof (*ep);
1393 rv = vppcom_session_attr (sid, VPPCOM_ATTR_GET_PEER_ADDR, ep, &size);
1398 vcom_socket_getpeername (int __fd, __SOCKADDR_ARG __addr,
1399 socklen_t * __restrict __len)
1402 vcom_socket_main_t *vsm = &vcom_socket_main;
1404 vcom_socket_t *vsock;
1407 p = hash_get (vsm->sockidx_by_fd, __fd);
1411 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1415 if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
1418 if (!__addr || !__len)
1422 ep.ip = (u8 *) & ((const struct sockaddr_in *) __addr)->sin_addr;
1423 rv = vcom_session_getpeername (vsock->sid, &ep);
1426 if (ep.vrf == VPPCOM_VRF_DEFAULT)
1428 __addr->sa_family = ep.is_ip4 == VPPCOM_IS_IP4 ? AF_INET : AF_INET6;
1429 switch (__addr->sa_family)
1432 ((struct sockaddr_in *) __addr)->sin_port = ep.port;
1433 *__len = sizeof (struct sockaddr_in);
1437 ((struct sockaddr_in6 *) __addr)->sin6_port = ep.port;
1438 *__len = sizeof (struct sockaddr_in6);
1451 vcom_socket_send (int __fd, const void *__buf, size_t __n, int __flags)
1453 return vcom_socket_sendto (__fd, __buf, __n, __flags, NULL, 0);
1457 vcom_socket_recv (int __fd, void *__buf, size_t __n, int __flags)
1460 rv = vcom_socket_recvfrom (__fd, __buf, __n, __flags, NULL, 0);
1465 * RETURN 1 if __fd is (SOCK_STREAM, SOCK_SEQPACKET),
1469 vcom_socket_is_connection_mode_socket (int __fd)
1472 /* TBD define new vppcom api */
1473 vcom_socket_main_t *vsm = &vcom_socket_main;
1475 vcom_socket_t *vsock;
1480 p = hash_get (vsm->sockidx_by_fd, __fd);
1484 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1485 if (vsock && vsock->type == SOCKET_TYPE_VPPCOM_BOUND)
1487 optlen = sizeof (type);
1488 rv = libc_getsockopt (__fd, SOL_SOCKET, SO_TYPE, &type, &optlen);
1493 /* get socket type */
1494 switch (type & ~(SOCK_CLOEXEC | SOCK_NONBLOCK))
1497 case SOCK_SEQPACKET:
1510 static inline ssize_t
1511 vcom_session_sendto (int __sid, void *__buf, size_t __n,
1512 int __flags, __CONST_SOCKADDR_ARG __addr,
1513 socklen_t __addr_len)
1518 ep.vrf = VPPCOM_VRF_DEFAULT;
1519 switch (__addr->sa_family)
1522 ep.is_ip4 = VPPCOM_IS_IP4;
1523 ep.ip = (uint8_t *) & ((const struct sockaddr_in *) __addr)->sin_addr;
1524 ep.port = (uint16_t) ((const struct sockaddr_in *) __addr)->sin_port;
1528 ep.is_ip4 = VPPCOM_IS_IP6;
1529 ep.ip = (uint8_t *) & ((const struct sockaddr_in6 *) __addr)->sin6_addr;
1530 ep.port = (uint16_t) ((const struct sockaddr_in6 *) __addr)->sin6_port;
1537 rv = vppcom_session_sendto (__sid, __buf, __n, __flags, &ep);
1543 vcom_socket_sendto (int __fd, const void *__buf, size_t __n,
1544 int __flags, __CONST_SOCKADDR_ARG __addr,
1545 socklen_t __addr_len)
1548 vcom_socket_main_t *vsm = &vcom_socket_main;
1550 vcom_socket_t *vsock;
1557 p = hash_get (vsm->sockidx_by_fd, __fd);
1561 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1565 if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
1570 if (vcom_socket_is_connection_mode_socket (__fd))
1572 /* ignore __addr and _addr_len */
1573 /* and EISCONN may be returned when they are not NULL and 0 */
1574 if ((__addr != NULL) || (__addr_len != 0))
1583 return -EDESTADDRREQ;
1585 /* not a vppcom supported address family */
1586 if (!((__addr->sa_family == AF_INET) ||
1587 (__addr->sa_family == AF_INET6)))
1593 rv = vcom_session_sendto (vsock->sid, (void *) __buf, (int) __n,
1594 __flags, __addr, __addr_len);
1598 static inline ssize_t
1599 vcom_session_recvfrom (int __sid, void *__restrict __buf, size_t __n,
1600 int __flags, __SOCKADDR_ARG __addr,
1601 socklen_t * __restrict __addr_len)
1608 ep.ip = (u8 *) & ((const struct sockaddr_in *) __addr)->sin_addr;
1609 rv = vppcom_session_recvfrom (__sid, __buf, __n, __flags, &ep);
1613 if (ep.vrf == VPPCOM_VRF_DEFAULT)
1616 ep.is_ip4 == VPPCOM_IS_IP4 ? AF_INET : AF_INET6;
1617 switch (__addr->sa_family)
1620 ((struct sockaddr_in *) __addr)->sin_port = ep.port;
1621 *__addr_len = sizeof (struct sockaddr_in);
1625 ((struct sockaddr_in6 *) __addr)->sin6_port = ep.port;
1626 *__addr_len = sizeof (struct sockaddr_in6);
1639 rv = vppcom_session_recvfrom (__sid, __buf, __n, __flags, NULL);
1645 vcom_socket_recvfrom (int __fd, void *__restrict __buf, size_t __n,
1646 int __flags, __SOCKADDR_ARG __addr,
1647 socklen_t * __restrict __addr_len)
1650 vcom_socket_main_t *vsm = &vcom_socket_main;
1652 vcom_socket_t *vsock;
1654 if (__addr && !__addr_len)
1657 p = hash_get (vsm->sockidx_by_fd, __fd);
1661 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1665 if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
1670 rv = vcom_session_recvfrom (vsock->sid, __buf, __n,
1671 __flags, __addr, __addr_len);
1675 /* TBD: move it to vppcom */
1676 static inline ssize_t
1677 vcom_session_sendmsg (int __sid, const struct msghdr *__message, int __flags)
1680 /* rv = vppcom_session_write (__sid, (void *) __message->__buf,
1686 vcom_socket_sendmsg (int __fd, const struct msghdr * __message, int __flags)
1689 vcom_socket_main_t *vsm = &vcom_socket_main;
1691 vcom_socket_t *vsock;
1693 p = hash_get (vsm->sockidx_by_fd, __fd);
1697 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1701 if (vcom_socket_is_connection_mode_socket (__fd))
1703 /* ignore __addr and _addr_len */
1704 /* and EISCONN may be returned when they are not NULL and 0 */
1705 if ((__message->msg_name != NULL) || (__message->msg_namelen != 0))
1712 /* TBD: validate __message->msg_name and __message->msg_namelen
1713 * and return -EINVAL on validation error
1718 rv = vcom_session_sendmsg (vsock->sid, __message, __flags);
1725 vcom_socket_sendmmsg (int __fd, struct mmsghdr *__vmessages,
1726 unsigned int __vlen, int __flags)
1729 /* TBD: define a new vppcom api */
1734 /* TBD: move it to vppcom */
1735 static inline ssize_t
1736 vcom_session_recvmsg (int __sid, struct msghdr *__message, int __flags)
1739 /* rv = vppcom_session_read (__sid, (void *) __message->__buf,
1746 vcom_socket_recvmsg (int __fd, struct msghdr * __message, int __flags)
1749 vcom_socket_main_t *vsm = &vcom_socket_main;
1751 vcom_socket_t *vsock;
1753 p = hash_get (vsm->sockidx_by_fd, __fd);
1757 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1761 if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
1769 /* validate __flags */
1771 rv = vcom_session_recvmsg (vsock->sid, __message, __flags);
1777 vcom_socket_recvmmsg (int __fd, struct mmsghdr *__vmessages,
1778 unsigned int __vlen, int __flags,
1779 struct timespec *__tmo)
1781 /* TBD: define a new vppcom api */
1786 /* TBD: move it to vppcom */
1788 vcom_session_get_sockopt (int __sid, int __level, int __optname,
1789 void *__restrict __optval,
1790 socklen_t * __restrict __optlen)
1794 /* 1. for socket level options that are NOT socket attributes
1795 * and that has corresponding vpp options get from vppcom */
1802 *(int *) __optval = 0;
1810 /* 2. unhandled options */
1815 vcom_socket_getsockopt (int __fd, int __level, int __optname,
1816 void *__restrict __optval,
1817 socklen_t * __restrict __optlen)
1820 vcom_socket_main_t *vsm = &vcom_socket_main;
1822 vcom_socket_t *vsock;
1824 p = hash_get (vsm->sockidx_by_fd, __fd);
1828 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1832 if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
1835 if (!__optval && !__optlen)
1844 * 1. for socket level options that are socket attributes,
1845 * get from libc_getsockopt.
1846 * 2. for socket level options that are NOT socket
1847 * attributes and that has corresponding vpp options
1849 * 3. for socket level options unimplemented
1850 * return -ENOPROTOOPT */
1868 case SO_TIMESTAMPNS:
1869 case SO_TIMESTAMPING:
1882 case SO_WIFI_STATUS:
1885 case SO_BINDTODEVICE:
1887 case SO_LOCK_FILTER:
1888 case SO_BPF_EXTENSIONS:
1889 case SO_SELECT_ERR_QUEUE:
1890 #ifdef CONFIG_NET_RX_BUSY_POLL
1893 case SO_MAX_PACING_RATE:
1894 #ifdef SO_INCOMING_CPU
1895 case SO_INCOMING_CPU:
1897 rv = libc_getsockopt (__fd, __level, __optname, __optval, __optlen);
1906 rv = vcom_session_get_sockopt (vsock->sid, __level, __optname,
1907 __optval, __optlen);
1911 /* We implement the SO_SNDLOWAT etc to not be settable
1914 return -ENOPROTOOPT;
1920 /* 1. handle options that are NOT socket level options,
1921 * but have corresponding vpp otions. */
1922 rv = vcom_session_get_sockopt (vsock->sid, __level, __optname,
1923 __optval, __optlen);
1930 /* TBD: move it to vppcom */
1932 vcom_session_setsockopt (int __sid, int __level, int __optname,
1933 const void *__optval, socklen_t __optlen)
1935 int rv = -EOPNOTSUPP;
1944 vppcom_session_attr (__sid, VPPCOM_ATTR_SET_TCP_KEEPIDLE, 0, 0);
1948 vppcom_session_attr (__sid, VPPCOM_ATTR_SET_TCP_KEEPINTVL, 0, 0);
1958 rv = vppcom_session_attr (__sid, VPPCOM_ATTR_SET_V6ONLY, 0, 0);
1968 rv = vppcom_session_attr (__sid, VPPCOM_ATTR_SET_KEEPALIVE, 0, 0);
1971 rv = vppcom_session_attr (__sid, VPPCOM_ATTR_SET_REUSEADDR, 0, 0);
1974 rv = vppcom_session_attr (__sid, VPPCOM_ATTR_SET_BROADCAST, 0, 0);
1988 vcom_socket_setsockopt (int __fd, int __level, int __optname,
1989 const void *__optval, socklen_t __optlen)
1992 vcom_socket_main_t *vsm = &vcom_socket_main;
1994 vcom_socket_t *vsock;
1996 p = hash_get (vsm->sockidx_by_fd, __fd);
2000 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
2004 if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
2008 * Options without arguments
2011 if (__optname == SO_BINDTODEVICE)
2013 rv = libc_setsockopt (__fd, __level, __optname, __optval, __optlen);
2024 if (__optlen < sizeof (int))
2033 rv = vcom_session_setsockopt (vsock->sid, __level, __optname,
2034 __optval, __optlen);
2047 rv = vcom_session_setsockopt (vsock->sid, __level, __optname,
2048 __optval, __optlen);
2054 /* handle options at socket level */
2061 rv = vcom_session_setsockopt (vsock->sid, __level, __optname,
2062 __optval, __optlen);
2066 * 1. for socket level options that are socket attributes,
2067 * set it from libc_getsockopt
2068 * 2. for socket level options that are NOT socket
2069 * attributes and that has corresponding vpp options
2070 * set it from vppcom
2071 * 3. for socket level options unimplemented
2072 * return -ENOPROTOOPT */
2088 case SO_TIMESTAMPNS:
2089 case SO_TIMESTAMPING:
2102 case SO_WIFI_STATUS:
2106 * SO_BINDTODEVICE already handled as
2107 * "Options without arguments" */
2108 /* case SO_BINDTODEVICE: */
2110 case SO_LOCK_FILTER:
2111 case SO_BPF_EXTENSIONS:
2112 case SO_SELECT_ERR_QUEUE:
2113 #ifdef CONFIG_NET_RX_BUSY_POLL
2116 case SO_MAX_PACING_RATE:
2117 #ifdef SO_INCOMING_CPU
2118 case SO_INCOMING_CPU:
2120 rv = libc_setsockopt (__fd, __level, __optname, __optval, __optlen);
2129 /* We implement the SO_SNDLOWAT etc to not be settable
2132 return -ENOPROTOOPT;
2138 return -ENOPROTOOPT;
2145 vcom_socket_listen (int __fd, int __n)
2148 vcom_socket_main_t *vsm = &vcom_socket_main;
2150 vcom_socket_t *vsock;
2152 p = hash_get (vsm->sockidx_by_fd, __fd);
2155 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
2157 /* TBD vppcom to accept __n parameter */
2158 rv = vppcom_session_listen (vsock->sid, __n);
2165 vcom_socket_connected_socket (int __fd, int __sid,
2167 int *__type, int *__protocol, int flags)
2170 vcom_socket_main_t *vsm = &vcom_socket_main;
2171 vcom_socket_t *vsock;
2178 optlen = sizeof (*__domain);
2179 rv = libc_getsockopt (__fd, SOL_SOCKET, SO_DOMAIN, __domain, &optlen);
2186 optlen = sizeof (*__type);
2187 rv = libc_getsockopt (__fd, SOL_SOCKET, SO_TYPE, __type, &optlen);
2194 optlen = sizeof (*__protocol);
2195 rv = libc_getsockopt (__fd, SOL_SOCKET, SO_PROTOCOL, __protocol, &optlen);
2202 fd = vcom_socket_open_socket (*__domain, *__type | flags, *__protocol);
2209 pool_get (vsm->vsockets, vsock);
2210 vsocket_init (vsock);
2212 sockidx = vsock - vsm->vsockets;
2213 hash_set (vsm->sockidx_by_fd, fd, sockidx);
2215 vsocket_set (vsock, fd, __sid, SOCKET_TYPE_VPPCOM_BOUND);
2222 /* If flag is 0, then accept4() is the same as accept().
2223 * SOCK_NONBLOCK and SOCK_CLOEXEC can be bitwise ORed in flags
2226 vcom_socket_accept_flags (int __fd, __SOCKADDR_ARG __addr,
2227 socklen_t * __restrict __addr_len, int flags)
2230 vcom_socket_main_t *vsm = &vcom_socket_main;
2232 vcom_socket_t *vsock;
2240 uint8_t addr8[sizeof (struct in6_addr)];
2245 /* validate flags */
2252 * case SOCK_NONBLOCK:
2253 * case SOCK_CLOEXEC:
2254 * case SOCK_NONBLOCK | SOCK_CLOEXEC:
2261 /* flags can be 0 or can be bitwise OR
2262 * of any of SOCK_NONBLOCK and SOCK_CLOEXEC */
2264 if (!(!flags || (flags & (SOCK_NONBLOCK | SOCK_CLOEXEC))))
2266 /* TBD: return proper error code */
2270 /* TBD: return proper error code */
2272 if (!vcom_socket_is_connection_mode_socket (__fd))
2277 p = hash_get (vsm->sockidx_by_fd, __fd);
2280 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
2283 rv = vcom_fcntl (vsock->fd, F_GETFL, 0);
2290 if (!(rv & O_NONBLOCK))
2292 /* socket is not marked as nonblocking
2293 * and no pending connections are present
2294 * on the queue, accept () blocks the caller
2295 * until a connection is present.
2297 rv = vppcom_session_accept (vsock->sid, &ep,
2298 -1.0 /* wait forever */ );
2302 /* The file descriptor refers to a socket and has been
2303 * marked nonblocking(O_NONBLOCK) and the accept would
2306 /* is non blocking */
2307 rv = vppcom_session_accept (vsock->sid, &ep, 0);
2308 /* If the socket is marked nonblocking and
2309 * no pending connections are present on the
2310 * queue, accept fails with the error
2311 * EAGAIN or EWOULDBLOCK
2313 if (rv == VPPCOM_ETIMEDOUT)
2325 /* create a new connected socket resource and set flags
2326 * on the new file descriptor.
2327 * update vsockets and sockidx_by_fd table
2329 fd = vcom_socket_connected_socket (__fd, sid,
2330 &domain, &type, &protocol, flags);
2338 /* TBD populate __addr and __addr_len */
2339 /* TBD: The returned address is truncated if the buffer
2340 * provided is too small, in this case, __addr_len will
2341 * return a value greater than was supplied to the call.*/
2346 /* TBD populate __addr and __addr_len */
2350 ((struct sockaddr_in *) __addr)->sin_family = AF_INET;
2351 ((struct sockaddr_in *) __addr)->sin_port = ep.port;
2352 memcpy (&((struct sockaddr_in *) __addr)->sin_addr,
2353 addr8, sizeof (struct in_addr));
2354 /* TBD: populate __addr_len */
2357 *__addr_len = sizeof (struct sockaddr_in);
2362 ((struct sockaddr_in6 *) __addr)->sin6_family = AF_INET6;
2363 ((struct sockaddr_in6 *) __addr)->sin6_port = ep.port;
2364 memcpy (((struct sockaddr_in6 *) __addr)->sin6_addr.
2365 __in6_u.__u6_addr8, addr8,
2366 sizeof (struct in6_addr));
2367 /* TBD: populate __addr_len */
2370 *__addr_len = sizeof (struct sockaddr_in6);
2375 return -EAFNOSUPPORT;
2383 ((struct sockaddr_in *) __addr)->sin_family = AF_INET;
2384 ((struct sockaddr_in *) __addr)->sin_port = ep.port;
2385 memcpy (&((struct sockaddr_in *) __addr)->sin_addr,
2386 addr8, sizeof (struct in_addr));
2387 /* TBD: populate __addr_len */
2390 *__addr_len = sizeof (struct sockaddr_in);
2395 ((struct sockaddr_in6 *) __addr)->sin6_family = AF_INET6;
2396 ((struct sockaddr_in6 *) __addr)->sin6_port = ep.port;
2397 memcpy (((struct sockaddr_in6 *) __addr)->sin6_addr.
2398 __in6_u.__u6_addr8, addr8,
2399 sizeof (struct in6_addr));
2400 /* TBD: populate __addr_len */
2403 *__addr_len = sizeof (struct sockaddr_in6);
2408 return -EAFNOSUPPORT;
2414 /* when __addr is NULL, nothing is filled in,
2415 * in this case, __addr_len is not used,
2416 * and should also be null
2420 /* TBD: return proper error code */
2430 vcom_socket_accept (int __fd, __SOCKADDR_ARG __addr,
2431 socklen_t * __restrict __addr_len)
2433 /* set flags to 0 for accept() */
2434 return vcom_socket_accept_flags (__fd, __addr, __addr_len, 0);
2439 vcom_socket_accept4 (int __fd, __SOCKADDR_ARG __addr,
2440 socklen_t * __restrict __addr_len, int __flags)
2442 /* SOCK_NONBLOCK and SOCK_CLOEXEC can be bitwise ORed in flags */
2443 return vcom_socket_accept_flags (__fd, __addr, __addr_len, __flags);
2447 /* TBD: move it to vppcom */
2449 vcom_session_shutdown (int __fd, int __how)
2455 vcom_socket_shutdown (int __fd, int __how)
2458 vcom_socket_main_t *vsm = &vcom_socket_main;
2460 vcom_socket_t *vsock;
2462 p = hash_get (vsm->sockidx_by_fd, __fd);
2465 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
2471 rv = vcom_session_shutdown (vsock->sid, __how);
2485 vcom_socket_epoll_create1 (int __flags)
2488 vcom_socket_main_t *vsm = &vcom_socket_main;
2489 vcom_epoll_t *vepoll;
2495 epfd = vcom_socket_open_epoll (__flags);
2502 vep_idx = vppcom_epoll_create ();
2506 goto out_close_epoll;
2509 pool_get (vsm->vepolls, vepoll);
2510 vepoll_init (vepoll);
2512 epollidx = vepoll - vsm->vepolls;
2513 hash_set (vsm->epollidx_by_epfd, epfd, epollidx);
2515 vepoll_set (vepoll, epfd, vep_idx, EPOLL_TYPE_VPPCOM_BOUND, __flags, 0, 0);
2520 vcom_socket_close_epoll (epfd);
2526 * PRE: vppcom_epoll_ctl() is successful
2527 * free_vepitem_on_del : 0 - no_pool_put, 1 - pool_put
2530 vcom_socket_ctl_vepitem (int __epfd, int __op, int __fd,
2531 struct epoll_event *__event,
2532 i32 vep_idx, vcom_epoll_t * vepoll,
2533 i32 vfd_id, void *vfd, vcom_fd_type_t type,
2534 int free_vepitem_on_del)
2537 vcom_socket_main_t *vsm = &vcom_socket_main;
2538 vcom_epitem_t *vepitem;
2540 vcom_epitem_key_t epfdfd = {.epfd = __epfd,.fd = __fd };
2544 i32 *vepitemidxs = 0;
2546 struct epoll_event revent = {.events = 0,.data.fd = INVALID_FD };
2550 /* perform control operations on the epoll instance */
2555 * supplied file descriptor is already
2556 * registered with this epoll instance
2558 /* vepitem exists */
2559 p = hash_get (vsm->epitemidx_by_epfdfd, epfdfd.key);
2566 /* add a new vepitem */
2567 pool_get (vsm->vepitems, vepitem);
2568 vepitem_init (vepitem);
2570 vepitemidx = vepitem - vsm->vepitems;
2571 hash_set (vsm->epitemidx_by_epfdfd, epfdfd.key, vepitemidx);
2572 vepitem_set (vepitem, __epfd, __fd, __fd, __fd, type, *__event, revent);
2574 /* update epitemidxs */
2576 p = hash_get (vsm->epitemidxs_by_epfd, __epfd);
2577 if (!p) /* not exist */
2580 vec_add1 (vepitemidxs, vepitemidx);
2581 hash_set (vsm->epitemidxs_by_epfd, __epfd, vepitemidxs);
2585 vepitemidxs = *(i32 **) p;
2586 vec_add1 (vepitemidxs, vepitemidx);
2587 hash_set3 (vsm->epitemidxs_by_epfd, __epfd, vepitemidxs, 0);
2589 /* update epitemidxs */
2591 p = hash_get (vsm->epitemidxs_by_fd, __fd);
2592 if (!p) /* not exist */
2595 vec_add1 (vepitemidxs, vepitemidx);
2596 hash_set (vsm->epitemidxs_by_fd, __fd, vepitemidxs);
2600 vepitemidxs = *(i32 **) p;
2601 vec_add1 (vepitemidxs, vepitemidx);
2602 hash_set3 (vsm->epitemidxs_by_fd, __fd, vepitemidxs, 0);
2605 /* increment vepoll fd count by 1 */
2614 * supplied file descriptor is not
2615 * registered with this epoll instance
2617 /* vepitem not exist */
2618 p = hash_get (vsm->epitemidx_by_epfdfd, epfdfd.key);
2624 vepitem = pool_elt_at_index (vsm->vepitems, p[0]);
2627 vepitem->event = *__event;
2628 vepitem->revent = revent;
2637 * supplied file descriptor is not
2638 * registered with this epoll instance
2640 /* vepitem not exist */
2641 p = hash_get (vsm->epitemidx_by_epfdfd, epfdfd.key);
2647 vepitemidx = *(i32 *) p;
2648 hash_unset (vsm->epitemidx_by_epfdfd, epfdfd.key);
2650 /* update epitemidxs */
2652 p = hash_get (vsm->epitemidxs_by_epfd, __epfd);
2653 if (!p) /* not exist */
2660 vepitemidxs = *(i32 **) p;
2661 vec_idx = vec_search (vepitemidxs, vepitemidx);
2664 vec_del1 (vepitemidxs, vec_idx);
2665 if (!vec_len (vepitemidxs))
2667 vec_free (vepitemidxs);
2668 hash_unset (vsm->epitemidxs_by_epfd, __epfd);
2673 /* update epitemidxs */
2675 p = hash_get (vsm->epitemidxs_by_fd, __fd);
2676 if (!p) /* not exist */
2683 vepitemidxs = *(i32 **) p;
2684 vec_idx = vec_search (vepitemidxs, vepitemidx);
2687 vec_del1 (vepitemidxs, vec_idx);
2688 if (!vec_len (vepitemidxs))
2690 vec_free (vepitemidxs);
2691 hash_unset (vsm->epitemidxs_by_fd, __fd);
2696 /* pool put vepitem */
2697 vepitem = pool_elt_at_index (vsm->vepitems, vepitemidx);
2698 if (free_vepitem_on_del)
2705 vepitem_init (vepitem);
2706 pool_put (vsm->vepitems, vepitem);
2712 vepitem_init (vepitem);
2716 /* decrement vepoll fd count by 1 */
2734 * PRE: 00. null pointer check on __event
2735 * 01. all other parameters are validated
2739 vcom_socket_epoll_ctl_internal (int __epfd, int __op, int __fd,
2740 struct epoll_event *__event,
2741 int free_vepitem_on_del)
2745 /* vcom_socket_main_t *vsm = &vcom_socket_main; */
2746 vcom_epoll_t *vepoll;
2748 /*__fd could could be vcom socket or vcom epoll or kernel fd */
2750 vcom_epoll_t *vfd_vepoll;
2751 vcom_socket_t *vfd_vsock;
2756 vcom_fd_type_t type = FD_TYPE_INVALID;
2758 /* validate __event */
2760 /* get vep_idx and vepoll */
2761 vep_idx = vcom_socket_get_vep_idx_and_vepoll (__epfd, &vepoll);
2762 if (vep_idx == INVALID_VEP_IDX)
2767 /* get vcom fd type, vfd_id and vfd */
2768 vfd_id = vcom_socket_get_sid_and_vsock (__fd, &vfd_vsock);
2769 if (vfd_id != INVALID_SESSION_ID)
2771 type = FD_TYPE_VCOM_SOCKET;
2774 else if ((vfd_id = vcom_socket_get_vep_idx_and_vepoll (__fd, &vfd_vepoll))
2777 type = FD_TYPE_EPOLL;
2782 /* FD_TYPE_KERNEL not supported by epoll instance */
2783 type = FD_TYPE_INVALID;
2788 /* vepoll and vsock are now valid */
2789 rv = vppcom_epoll_ctl (vep_idx, __op, vfd_id, __event);
2795 rv = vcom_socket_ctl_vepitem (__epfd, __op, __fd,
2798 vfd_id, vfd, type, free_vepitem_on_del);
2803 vcom_socket_epoll_ctl (int __epfd, int __op, int __fd,
2804 struct epoll_event *__event)
2808 rv = vcom_socket_epoll_ctl_internal (__epfd, __op, __fd, __event, 1);
2813 vcom_socket_epoll_ctl1 (int __epfd, int __op, int __fd,
2814 struct epoll_event *__event)
2818 rv = vcom_socket_epoll_ctl_internal (__epfd, __op, __fd, __event, 0);
2823 vcom_socket_epoll_pwait (int __epfd, struct epoll_event *__events,
2824 int __maxevents, int __timeout,
2825 const __sigset_t * __ss)
2829 /* in seconds eg. 3.123456789 seconds */
2830 double time_to_wait = (double) 0;
2834 /* validate __event */
2841 /* validate __timeout */
2844 time_to_wait = (double) __timeout / (double) 1000;
2846 else if (__timeout == 0)
2848 time_to_wait = (double) 0;
2850 else if (__timeout == -1)
2861 vep_idx = vcom_socket_get_vep_idx (__epfd);
2862 if (vep_idx != INVALID_VEP_IDX)
2864 rv = vppcom_epoll_wait (vep_idx, __events, __maxevents, time_to_wait);
2871 vcom_pollfds_2_selectfds (
2873 struct pollfd *__fds, nfds_t __nfds,
2876 fd_set * __restrict vcom_readfds,
2877 fd_set * __restrict vcom_writefds,
2878 fd_set * __restrict vcom_exceptfds)
2882 for (fds_idx = 0; fds_idx < __nfds; fds_idx++)
2884 /* ignore negative fds */
2885 if (__fds[fds_idx].fd < 0)
2890 /* for POLLRDHUP, POLLERR, POLLHUP and POLLNVAL */
2891 FD_SET (__fds[fds_idx].fd, vcom_exceptfds);
2893 /* requested events */
2894 if (__fds[fds_idx].events)
2896 if (__fds[fds_idx].events & POLLIN)
2898 FD_SET (__fds[fds_idx].fd, vcom_readfds);
2900 if (__fds[fds_idx].events & POLLPRI)
2902 FD_SET (__fds[fds_idx].fd, vcom_readfds);
2904 if (__fds[fds_idx].events & POLLOUT)
2906 FD_SET (__fds[fds_idx].fd, vcom_writefds);
2908 #if defined __USE_XOPEN || defined __USE_XOPEN2K8
2909 if (__fds[fds_idx].events & POLLRDNORM)
2911 FD_SET (__fds[fds_idx].fd, vcom_readfds);
2913 if (__fds[fds_idx].events & POLLRDBAND)
2915 FD_SET (__fds[fds_idx].fd, vcom_readfds);
2917 if (__fds[fds_idx].events & POLLWRNORM)
2919 FD_SET (__fds[fds_idx].fd, vcom_writefds);
2921 if (__fds[fds_idx].events & POLLWRBAND)
2923 FD_SET (__fds[fds_idx].fd, vcom_writefds);
2927 } /* for (fds_idx = 0; fds_idx < __nfds; fds_idx++) */
2931 vcom_selectfds_2_pollfds (
2933 struct pollfd *__fds, nfds_t __nfds, int *nfd,
2936 fd_set * __restrict vcom_readfds,
2937 fd_set * __restrict vcom_writefds,
2938 fd_set * __restrict vcom_exceptfds)
2943 for (fds_idx = 0; fds_idx < __nfds; fds_idx++)
2945 /* ignore negative fds */
2946 if (__fds[fds_idx].fd < 0)
2948 __fds[fds_idx].revents = 0;
2951 /* for POLLRDHUP, POLLERR, POLLHUP and POLLNVAL */
2952 if (FD_ISSET (__fds[fds_idx].fd, vcom_exceptfds))
2955 * TBD: for now any select exception
2956 * is flagged as POLLERR
2958 __fds[fds_idx].revents |= POLLERR;
2961 /* requested events */
2962 if (__fds[fds_idx].events & POLLIN)
2964 if (FD_ISSET (__fds[fds_idx].fd, vcom_readfds))
2966 __fds[fds_idx].revents |= POLLIN;
2969 if (__fds[fds_idx].events & POLLPRI)
2971 if (FD_ISSET (__fds[fds_idx].fd, vcom_readfds))
2973 __fds[fds_idx].revents |= POLLIN;
2976 if (__fds[fds_idx].events & POLLOUT)
2978 if (FD_ISSET (__fds[fds_idx].fd, vcom_writefds))
2980 __fds[fds_idx].revents |= POLLOUT;
2983 #if defined __USE_XOPEN || defined __USE_XOPEN2K8
2984 if (__fds[fds_idx].events & POLLRDNORM)
2986 if (FD_ISSET (__fds[fds_idx].fd, vcom_readfds))
2988 __fds[fds_idx].revents |= POLLRDNORM;
2991 if (__fds[fds_idx].events & POLLRDBAND)
2993 if (FD_ISSET (__fds[fds_idx].fd, vcom_readfds))
2995 __fds[fds_idx].revents |= POLLRDBAND;
2998 if (__fds[fds_idx].events & POLLWRNORM)
3000 if (FD_ISSET (__fds[fds_idx].fd, vcom_writefds))
3002 __fds[fds_idx].revents |= POLLWRNORM;
3005 if (__fds[fds_idx].events & POLLWRBAND)
3007 if (FD_ISSET (__fds[fds_idx].fd, vcom_writefds))
3009 __fds[fds_idx].revents |= POLLWRBAND;
3013 } /* for (fds_idx = 0; fds_idx < __nfds; fds_idx++) */
3017 * the number of structures which have nonzero revents fields
3018 * (in other words, those descriptors with events or
3022 for (fds_idx = 0; fds_idx < __nfds; fds_idx++)
3024 /* ignore negative fds */
3025 if (__fds[fds_idx].fd < 0)
3030 if (__fds[fds_idx].revents)
3038 * PRE: parameters are validated,
3039 * vcom_socket_poll is always called with __timeout set to zero
3040 * hence returns immediately
3042 * ACTION: handle non negative validated vcom fds and ignore rest
3046 * implements vcom_socket_poll () interface
3048 * internally uses vcom_socket_select ()
3049 * to realize the behavior
3052 vcom_socket_poll_select_impl (struct pollfd *__fds, nfds_t __nfds,
3056 pid_t pid = getpid ();
3063 fd_set vcom_readfds;
3064 fd_set vcom_writefds;
3065 fd_set vcom_exceptfds;
3067 /* invalid max_vcom_fd is -1 */
3068 int max_vcom_fd = -1;
3070 /* __timeout is zero to get ready events and return immediately */
3071 struct timeval tv = {.tv_sec = 0,.tv_usec = 0 };
3073 /* validate __nfds from select perspective */
3074 if (__nfds > FD_SETSIZE)
3080 /* zero vcom fd sets */
3096 for (fds_idx = 0; fds_idx < __nfds; fds_idx++)
3098 /* ignore negative fds */
3099 if (__fds[fds_idx].fd < 0)
3104 /* non negative validated vcom fds */
3105 if (__fds[fds_idx].fd > FD_SETSIZE)
3111 /* max_vcom_fd and vcom_nfd */
3112 if (__fds[fds_idx].fd > max_vcom_fd)
3114 /* requested events */
3115 if (__fds[fds_idx].events)
3117 max_vcom_fd = __fds[fds_idx].fd;
3123 vcom_nfds = max_vcom_fd != -1 ? max_vcom_fd + 1 : 0;
3131 vcom_pollfds_2_selectfds (
3136 &vcom_readfds, &vcom_writefds, &vcom_exceptfds);
3138 /* select on vcom fds */
3139 vcom_nfd = vcom_socket_select (vcom_nfds,
3141 &vcom_writefds, &vcom_exceptfds, &tv);
3144 "[%d] vcom_socket_select: "
3145 "'%04d'='%04d'\n", pid, vcom_nfd, vcom_nfds);
3153 vcom_selectfds_2_pollfds (
3155 __fds, __nfds, &nfd,
3158 &vcom_readfds, &vcom_writefds, &vcom_exceptfds);
3167 * TBD: remove this static function once vppcom
3168 * has an implementation in place
3173 vppcom_poll (struct pollfd *__fds, nfds_t __nfds, double time_to_wait)
3179 vcom_socket_poll_vppcom_impl (struct pollfd *__fds, nfds_t __nfds,
3184 /* in seconds eg. 3.123456789 seconds */
3185 double time_to_wait = (double) 0;
3190 /* replace vcom fd with session idx */
3191 for (fds_idx = 0; fds_idx < __nfds; fds_idx++)
3193 /* ignore negative fds */
3194 if (__fds[fds_idx].fd < 0)
3199 /* non negative validated vcom fds */
3200 sid = vcom_socket_get_sid (__fds[fds_idx].fd);
3201 if (sid != INVALID_SESSION_ID)
3203 __fds[fds_idx].fd = sid;
3208 vep_idx = vcom_socket_get_vep_idx (__fds[fds_idx].fd);
3209 if (vep_idx != INVALID_VEP_IDX)
3211 __fds[fds_idx].fd = vep_idx;
3220 /* validate __timeout */
3223 time_to_wait = (double) __timeout / (double) 1000;
3225 else if (__timeout == 0)
3227 time_to_wait = (double) 0;
3234 return vppcom_poll (__fds, __nfds, time_to_wait);
3238 vcom_socket_poll (struct pollfd *__fds, nfds_t __nfds, int __timeout)
3240 /* select an implementation */
3242 /* return vcom_socket_poll_vppcom_impl (__fds, __nfds, __timeout); */
3243 return vcom_socket_poll_select_impl (__fds, __nfds, __timeout);
3248 vcom_socket_ppoll (struct pollfd *__fds, nfds_t __nfds,
3249 const struct timespec *__timeout, const __sigset_t * __ss)
3256 vcom_socket_main_init (void)
3258 vcom_socket_main_t *vsm = &vcom_socket_main;
3261 printf ("vcom_socket_main_init\n");
3265 /* TBD: define FD_MAXSIZE and use it here */
3266 pool_alloc (vsm->vsockets, FD_SETSIZE);
3267 vsm->sockidx_by_fd = hash_create (0, sizeof (i32));
3269 pool_alloc (vsm->vepolls, FD_SETSIZE);
3270 vsm->epollidx_by_epfd = hash_create (0, sizeof (i32));
3272 pool_alloc (vsm->vepitems, FD_SETSIZE);
3273 vsm->epitemidx_by_epfdfd = hash_create (0, sizeof (i32));
3275 vsm->epitemidxs_by_epfd = hash_create (0, sizeof (i32 *));
3276 vsm->epitemidxs_by_fd = hash_create (0, sizeof (i32 *));
3286 vcom_socket_main_show (void)
3288 vcom_socket_main_t *vsm = &vcom_socket_main;
3289 vcom_socket_t *vsock;
3291 vcom_epoll_t *vepoll;
3293 vcom_epitem_t *vepitem;
3297 i32 *vepitemidxs, *vepitemidxs_var;
3301 /* from active list of vsockets show vsock */
3304 pool_foreach (vsock, vsm->vsockets,
3307 "fd='%04d', sid='%08x',type='%-30s'\n",
3308 vsock->fd, vsock->sid,
3309 vcom_socket_type_str (vsock->type));
3313 /* from active list of vepolls, show vepoll */
3316 pool_foreach (vepoll, vsm->vepolls,
3319 "epfd='%04d', vep_idx='%08x', "
3321 "flags='%d', count='%d', close='%d'\n",
3322 vepoll->epfd, vepoll->vep_idx,
3323 vcom_socket_epoll_type_str (vepoll->type),
3324 vepoll->flags, vepoll->count, vepoll->close);
3328 /* from active list of vepitems, show vepitem */
3331 pool_foreach (vepitem, vsm->vepitems,
3334 "epfd='%04d', fd='%04d', "
3335 "next_fd='%04d', prev_fd='%04d', "
3337 "events='%04x', revents='%04x'\n",
3338 vepitem->epfd, vepitem->fd,
3339 vepitem->next_fd, vepitem->prev_fd,
3340 vcom_socket_vcom_fd_type_str (vepitem->type),
3341 vepitem->event.events, vepitem->revent.events);
3346 /* show epitemidxs for epfd */
3348 hash_foreach (epfd, vepitemidxs,
3349 vsm->epitemidxs_by_epfd,
3351 printf("\n[ '%04d': ", epfd);
3352 vec_foreach (vepitemidxs_var,vepitemidxs)
3354 printf("'%04d' ", (int)vepitemidxs_var[0]);
3360 /* show epitemidxs for fd */
3362 hash_foreach (fd, vepitemidxs,
3363 vsm->epitemidxs_by_fd,
3365 printf("\n{ '%04d': ", fd);
3366 vec_foreach (vepitemidxs_var,vepitemidxs)
3368 printf("'%04d' ", (int)vepitemidxs_var[0]);
3378 vcom_socket_main_destroy (void)
3380 vcom_socket_main_t *vsm = &vcom_socket_main;
3381 vcom_socket_t *vsock;
3383 vcom_epoll_t *vepoll;
3385 vcom_epitem_t *vepitem;
3393 printf ("vcom_socket_main_destroy\n");
3399 * from active list of vepitems,
3400 * remove all "vepitem" elements from the pool in a safe way
3404 pool_flush (vepitem, vsm->vepitems,
3406 if ((vepitem->type == FD_TYPE_EPOLL) ||
3407 (vepitem->type == FD_TYPE_VCOM_SOCKET))
3409 vcom_socket_epoll_ctl1 (vepitem->epfd, EPOLL_CTL_DEL,
3411 vepitem_init (vepitem);
3416 pool_free (vsm->vepitems);
3417 hash_free (vsm->epitemidx_by_epfdfd);
3419 /* free vepitemidxs for each epfd */
3421 hash_foreach (epfd, vepitemidxs,
3422 vsm->epitemidxs_by_epfd,
3424 vec_free (vepitemidxs);
3427 hash_free (vsm->epitemidxs_by_epfd);
3429 /* free vepitemidxs for each fd */
3431 hash_foreach (fd, vepitemidxs,
3432 vsm->epitemidxs_by_fd,
3434 vec_free (vepitemidxs);
3437 hash_free (vsm->epitemidxs_by_fd);
3441 * from active list of vsockets,
3442 * close socket and vppcom session
3446 pool_foreach (vsock, vsm->vsockets,
3448 if (vsock->type == SOCKET_TYPE_VPPCOM_BOUND)
3450 vppcom_session_close (vsock->sid);
3451 vcom_socket_close_socket (vsock->fd);
3452 vsocket_init (vsock);
3458 * return vsocket element to the pool
3462 pool_flush (vsock, vsm->vsockets,
3464 // vsocket_init(vsock);
3469 pool_free (vsm->vsockets);
3470 hash_free (vsm->sockidx_by_fd);
3473 * from active list of vepolls,
3474 * close epoll and vppcom_epoll
3478 pool_foreach (vepoll, vsm->vepolls,
3480 if (vepoll->type == EPOLL_TYPE_VPPCOM_BOUND)
3482 vppcom_session_close (vepoll->vep_idx);
3483 vcom_socket_close_epoll (vepoll->epfd); /* TBD: */
3484 vepoll_init (vepoll);
3490 * return vepoll element to the pool
3494 pool_flush (vepoll, vsm->vepolls,
3496 // vepoll_init(vepoll);
3501 pool_free (vsm->vepolls);
3502 hash_free (vsm->epollidx_by_epfd);
3510 * fd.io coding-style-patch-verification: ON
3513 * eval: (c-set-style "gnu")