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 <libvcl-ldpreload/vcom_socket.h>
28 #include <libvcl-ldpreload/vcom_socket_wrapper.h>
29 #include <libvcl-ldpreload/vcom.h>
31 #include <uri/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)
449 if (!__buf || __nbytes < 0)
454 rv = vcom_fcntl (__fd, F_GETFL, 0);
462 if (!(rv & O_NONBLOCK))
466 rv = vppcom_session_read (vsock->sid, __buf, __nbytes);
468 while (rv == -EAGAIN || rv == -EWOULDBLOCK);
471 /* The file descriptor refers to a socket and has been
472 * marked nonblocking(O_NONBLOCK) and the read would
475 /* is non blocking */
476 rv = vppcom_session_read (vsock->sid, __buf, __nbytes);
481 vcom_socket_readv (int __fd, const struct iovec * __iov, int __iovcnt)
484 vcom_socket_main_t *vsm = &vcom_socket_main;
486 vcom_socket_t *vsock;
487 ssize_t total = 0, len = 0;
489 p = hash_get (vsm->sockidx_by_fd, __fd);
493 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
497 if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
500 if (__iov == 0 || __iovcnt == 0 || __iovcnt > IOV_MAX)
504 for (int i = 0; i < __iovcnt; ++i)
506 if (SSIZE_MAX - len < __iov[i].iov_len)
508 len += __iov[i].iov_len;
511 rv = vcom_fcntl (__fd, F_GETFL, 0);
518 if (!(rv & O_NONBLOCK))
522 for (int i = 0; i < __iovcnt; ++i)
524 rv = vppcom_session_read (vsock->sid, __iov[i].iov_base,
531 if (rv < __iov[i].iov_len)
532 /* Read less than buffer provided, no point to continue */
537 while ((rv == -EAGAIN || rv == -EWOULDBLOCK) && total == 0);
541 /* is non blocking */
542 for (int i = 0; i < __iovcnt; ++i)
544 rv = vppcom_session_read (vsock->sid, __iov[i].iov_base,
559 if (rv < __iov[i].iov_len)
560 /* Read less than buffer provided, no point to continue */
568 vcom_socket_write (int __fd, const void *__buf, size_t __n)
571 vcom_socket_main_t *vsm = &vcom_socket_main;
573 vcom_socket_t *vsock;
575 p = hash_get (vsm->sockidx_by_fd, __fd);
579 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
583 if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
586 if (!__buf || __n < 0)
591 rv = vppcom_session_write (vsock->sid, (void *) __buf, __n);
596 vcom_socket_writev (int __fd, const struct iovec * __iov, int __iovcnt)
600 vcom_socket_main_t *vsm = &vcom_socket_main;
602 vcom_socket_t *vsock;
604 p = hash_get (vsm->sockidx_by_fd, __fd);
608 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
612 if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
615 if (__iov == 0 || __iovcnt == 0 || __iovcnt > IOV_MAX)
618 for (int i = 0; i < __iovcnt; ++i)
620 rv = vppcom_session_write (vsock->sid, __iov[i].iov_base,
636 * RETURN: 0 - invalid cmd
637 * 1 - cmd not handled by vcom and vppcom
638 * 2 - cmd handled by vcom socket resource
639 * 3 - cmd handled by vppcom
641 /* TBD: incomplete list of cmd */
643 vcom_socket_check_fcntl_cmd (int __cmd)
647 /*cmd not handled by vcom and vppcom */
650 case F_DUPFD_CLOEXEC:
653 /* cmd handled by vcom socket resource */
664 /* cmd handled by vcom and vppcom */
669 /* cmd not handled by vcom and vppcom */
677 vcom_session_fcntl_va (int __sid, int __cmd, va_list __ap)
679 int flags = va_arg (__ap, int);
680 int rv = -EOPNOTSUPP;
683 size = sizeof (flags);
684 if (__cmd == F_SETFL)
686 rv = vppcom_session_attr (__sid, VPPCOM_ATTR_SET_FLAGS, &flags, &size);
688 else if (__cmd == F_GETFL)
690 rv = vppcom_session_attr (__sid, VPPCOM_ATTR_GET_FLAGS, &flags, &size);
699 vcom_socket_fcntl_va (int __fd, int __cmd, va_list __ap)
702 vcom_socket_main_t *vsm = &vcom_socket_main;
704 vcom_socket_t *vsock;
706 p = hash_get (vsm->sockidx_by_fd, __fd);
710 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
714 if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
717 switch (vcom_socket_check_fcntl_cmd (__cmd))
723 /*cmd not handled by vcom and vppcom */
725 rv = libc_vfcntl (vsock->fd, __cmd, __ap);
727 /* cmd handled by vcom socket resource */
729 rv = libc_vfcntl (vsock->fd, __cmd, __ap);
731 /* cmd handled by vppcom */
733 rv = vcom_session_fcntl_va (vsock->sid, __cmd, __ap);
745 * RETURN: 0 - invalid cmd
746 * 1 - cmd not handled by vcom and vppcom
747 * 2 - cmd handled by vcom socket resource
748 * 3 - cmd handled by vppcom
751 vcom_socket_check_ioctl_cmd (unsigned long int __cmd)
757 /* cmd handled by vppcom */
762 /* cmd not handled by vcom and vppcom */
771 vcom_session_ioctl_va (int __sid, int __cmd, va_list __ap)
775 if (__cmd == FIONREAD)
776 rv = vppcom_session_attr (__sid, VPPCOM_ATTR_GET_NREAD, 0, 0);
783 vcom_socket_ioctl_va (int __fd, unsigned long int __cmd, va_list __ap)
786 vcom_socket_main_t *vsm = &vcom_socket_main;
788 vcom_socket_t *vsock;
790 p = hash_get (vsm->sockidx_by_fd, __fd);
794 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
798 if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
801 switch (vcom_socket_check_ioctl_cmd (__cmd))
803 /* Not supported cmd */
808 /* cmd not handled by vcom and vppcom */
810 rv = libc_vioctl (vsock->fd, __cmd, __ap);
813 /* cmd handled by vcom socket resource */
815 rv = libc_vioctl (vsock->fd, __cmd, __ap);
818 /* cmd handled by vppcom */
820 rv = vcom_session_ioctl_va (vsock->sid, __cmd, __ap);
832 vcom_socket_fds_2_sid_fds (
835 fd_set * __restrict vcom_rd_sid_fds,
836 fd_set * __restrict vcom_wr_sid_fds,
837 fd_set * __restrict vcom_ex_sid_fds,
840 fd_set * __restrict vcom_readfds,
841 fd_set * __restrict vcom_writefds,
842 fd_set * __restrict vcom_exceptfds)
847 /* invalid max_sid is -1 */
852 * set sid in sid sets corresponding to fd's in fd sets
853 * compute nsid and vcom_nsid_fds from sid sets
856 for (fd = 0; fd < vcom_nfds; fd++)
863 if ((F) && (S) && FD_ISSET (fd, (F))) \
865 sid = vcom_socket_get_sid (fd); \
866 if (sid != INVALID_SESSION_ID) \
883 _(vcom_rd_sid_fds, vcom_readfds);
884 _(vcom_wr_sid_fds, vcom_writefds);
885 _(vcom_ex_sid_fds, vcom_exceptfds);
889 *vcom_nsid_fds = max_sid != -1 ? max_sid + 1 : 0;
897 * PRE: 00. sid sets were derived from fd sets
898 * 01. sid sets were updated with sids that actually changed
900 * 02. fd sets still has watched fds
902 * This function will modify in place fd sets to indicate which fd's
903 * actually changed status(inferred from sid sets)
906 vcom_socket_sid_fds_2_fds (
910 fd_set * __restrict vcom_readfds,
911 fd_set * __restrict vcom_writefds,
912 fd_set * __restrict vcom_exceptfds,
915 fd_set * __restrict vcom_rd_sid_fds,
916 fd_set * __restrict vcom_wr_sid_fds,
917 fd_set * __restrict vcom_ex_sid_fds)
922 /* invalid max_fd is -1 */
928 * modify in place fd sets to indicate which fd's
929 * actually changed status(inferred from sid sets)
931 for (fd = 0; fd < vcom_nfds; fd++)
938 if ((F) && (S) && FD_ISSET (fd, (F))) \
940 sid = vcom_socket_get_sid (fd); \
941 if (sid != INVALID_SESSION_ID) \
943 if (!FD_ISSET (sid, (S))) \
956 _(vcom_rd_sid_fds, vcom_readfds);
957 _(vcom_wr_sid_fds, vcom_writefds);
958 _(vcom_ex_sid_fds, vcom_exceptfds);
963 * compute nfd and new_vcom_nfds from fd sets
965 for (fd = 0; fd < vcom_nfds; fd++)
969 if ((F) && FD_ISSET (fd, (F))) \
986 *new_vcom_nfds = max_fd != -1 ? max_fd + 1 : 0;
995 * vom_socket_select is always called with
996 * timeout->tv_sec and timeout->tv_usec set to zero.
997 * hence vppcom_select return immediately.
1000 * TBD: do{body;} while(timeout conditional); timeout loop
1003 vcom_socket_select (int vcom_nfds, fd_set * __restrict vcom_readfds,
1004 fd_set * __restrict vcom_writefds,
1005 fd_set * __restrict vcom_exceptfds,
1006 struct timeval *__restrict timeout)
1008 static unsigned long vcom_nsid_fds = 0;
1011 pid_t pid = getpid ();
1013 int new_vcom_nfds = 0;
1014 int new_vcom_nfd = 0;
1017 fd_set vcom_rd_sid_fds;
1018 fd_set vcom_wr_sid_fds;
1019 fd_set vcom_ex_sid_fds;
1021 /* in seconds eg. 3.123456789 seconds */
1022 double time_to_wait = (double) 0;
1024 /* validate inputs */
1030 /* convert timeval timeout to double time_to_wait */
1033 if (timeout->tv_sec == 0 && timeout->tv_usec == 0)
1035 /* polling: vppcom_select returns immediately */
1036 time_to_wait = (double) 0;
1040 /*TBD: use timeval api */
1041 time_to_wait = (double) timeout->tv_sec +
1042 (double) timeout->tv_usec / (double) 1000000 +
1043 (double) (timeout->tv_usec % 1000000) / (double) 1000000;
1049 * no timeout: vppcom_select can block indefinitely
1050 * waiting for a file descriptor to become ready
1052 /* set to a phantom value */
1056 /* zero the sid_sets */
1068 _(&vcom_rd_sid_fds, vcom_readfds);
1069 _(&vcom_wr_sid_fds, vcom_writefds);
1070 _(&vcom_ex_sid_fds, vcom_exceptfds);
1075 if (time_to_wait > 0)
1079 "[%d] vcom_socket_select called to "
1080 "emulate delay_ns()!\n", pid);
1081 rv = vppcom_select (0, NULL, NULL, NULL, time_to_wait);
1085 fprintf (stderr, "[%d] vcom_socket_select called vcom_nfds = 0 "
1086 "and invalid time_to_wait (%f)!\n", pid, time_to_wait);
1091 /* populate read, write and except sid_sets */
1092 vcom_nsid = vcom_socket_fds_2_sid_fds (
1094 vcom_readfds || vcom_writefds
1095 || vcom_exceptfds ? (int *)
1096 &vcom_nsid_fds : NULL,
1097 vcom_readfds ? &vcom_rd_sid_fds :
1099 vcom_writefds ? &vcom_wr_sid_fds :
1101 vcom_exceptfds ? &vcom_ex_sid_fds :
1106 vcom_writefds, vcom_exceptfds);
1111 if (vcom_nsid_fds < 0)
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)
1320 ep.ip = (u8 *) & ((const struct sockaddr_in *) __addr)->sin_addr;
1321 rv = vcom_session_getsockname (vsock->sid, &ep);
1324 if (ep.vrf == VPPCOM_VRF_DEFAULT)
1326 __addr->sa_family = ep.is_ip4 == VPPCOM_IS_IP4 ? AF_INET : AF_INET6;
1327 switch (__addr->sa_family)
1330 ((struct sockaddr_in *) __addr)->sin_port = ep.port;
1331 *__len = sizeof (struct sockaddr_in);
1335 ((struct sockaddr_in6 *) __addr)->sin6_port = ep.port;
1336 *__len = sizeof (struct sockaddr_in6);
1349 vcom_socket_connect (int __fd, __CONST_SOCKADDR_ARG __addr, socklen_t __len)
1352 vcom_socket_main_t *vsm = &vcom_socket_main;
1354 vcom_socket_t *vsock;
1358 p = hash_get (vsm->sockidx_by_fd, __fd);
1361 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1363 ep.vrf = VPPCOM_VRF_DEFAULT;
1364 switch (__addr->sa_family)
1367 ep.is_ip4 = VPPCOM_IS_IP4;
1369 (uint8_t *) & ((const struct sockaddr_in *) __addr)->sin_addr;
1371 (uint16_t) ((const struct sockaddr_in *) __addr)->sin_port;
1375 ep.is_ip4 = VPPCOM_IS_IP6;
1377 (uint8_t *) & ((const struct sockaddr_in6 *) __addr)->sin6_addr;
1379 (uint16_t) ((const struct sockaddr_in6 *) __addr)->sin6_port;
1387 rv = vppcom_session_connect (vsock->sid, &ep);
1393 vcom_session_getpeername (int sid, vppcom_endpt_t * ep)
1396 uint32_t size = sizeof (*ep);
1398 rv = vppcom_session_attr (sid, VPPCOM_ATTR_GET_PEER_ADDR, ep, &size);
1403 vcom_socket_getpeername (int __fd, __SOCKADDR_ARG __addr,
1404 socklen_t * __restrict __len)
1407 vcom_socket_main_t *vsm = &vcom_socket_main;
1409 vcom_socket_t *vsock;
1412 p = hash_get (vsm->sockidx_by_fd, __fd);
1416 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1420 if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
1423 if (!__addr || !__len)
1432 ep.ip = (u8 *) & ((const struct sockaddr_in *) __addr)->sin_addr;
1433 rv = vcom_session_getpeername (vsock->sid, &ep);
1436 if (ep.vrf == VPPCOM_VRF_DEFAULT)
1438 __addr->sa_family = ep.is_ip4 == VPPCOM_IS_IP4 ? AF_INET : AF_INET6;
1439 switch (__addr->sa_family)
1442 ((struct sockaddr_in *) __addr)->sin_port = ep.port;
1443 *__len = sizeof (struct sockaddr_in);
1447 ((struct sockaddr_in6 *) __addr)->sin6_port = ep.port;
1448 *__len = sizeof (struct sockaddr_in6);
1461 vcom_socket_send (int __fd, const void *__buf, size_t __n, int __flags)
1463 return vcom_socket_sendto (__fd, __buf, __n, __flags, NULL, 0);
1467 vcom_socket_recv (int __fd, void *__buf, size_t __n, int __flags)
1470 rv = vcom_socket_recvfrom (__fd, __buf, __n, __flags, NULL, 0);
1475 * RETURN 1 if __fd is (SOCK_STREAM, SOCK_SEQPACKET),
1479 vcom_socket_is_connection_mode_socket (int __fd)
1482 /* TBD define new vppcom api */
1483 vcom_socket_main_t *vsm = &vcom_socket_main;
1485 vcom_socket_t *vsock;
1490 p = hash_get (vsm->sockidx_by_fd, __fd);
1494 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1495 if (vsock && vsock->type == SOCKET_TYPE_VPPCOM_BOUND)
1497 optlen = sizeof (type);
1498 rv = libc_getsockopt (__fd, SOL_SOCKET, SO_TYPE, &type, &optlen);
1503 /* get socket type */
1504 switch (type & ~(SOCK_CLOEXEC | SOCK_NONBLOCK))
1507 case SOCK_SEQPACKET:
1520 static inline ssize_t
1521 vcom_session_sendto (int __sid, void *__buf, size_t __n,
1522 int __flags, __CONST_SOCKADDR_ARG __addr,
1523 socklen_t __addr_len)
1526 /* TBD add new vpp api */
1527 /* TBD add flags parameter */
1528 rv = vppcom_session_write (__sid, (void *) __buf, (int) __n);
1533 vcom_socket_sendto (int __fd, const void *__buf, size_t __n,
1534 int __flags, __CONST_SOCKADDR_ARG __addr,
1535 socklen_t __addr_len)
1538 vcom_socket_main_t *vsm = &vcom_socket_main;
1540 vcom_socket_t *vsock;
1542 p = hash_get (vsm->sockidx_by_fd, __fd);
1546 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1550 if ((vsock->type != SOCKET_TYPE_VPPCOM_BOUND) || !__buf || __n < 0)
1555 if (vcom_socket_is_connection_mode_socket (__fd))
1557 /* ignore __addr and _addr_len */
1558 /* and EISCONN may be returned when they are not NULL and 0 */
1559 if ((__addr != NULL) || (__addr_len != 0))
1566 if (!__addr || __addr_len < 0)
1568 return -EDESTADDRREQ;
1570 /* not a vppcom supported address family */
1571 if ((__addr->sa_family != AF_INET) || (__addr->sa_family != AF_INET6))
1577 rv = vcom_session_sendto (vsock->sid, (void *) __buf, (int) __n,
1578 __flags, __addr, __addr_len);
1582 static inline ssize_t
1583 vcom_session_recvfrom (int __sid, void *__restrict __buf, size_t __n,
1584 int __flags, __SOCKADDR_ARG __addr,
1585 socklen_t * __restrict __addr_len)
1589 /* TBD add flags parameter */
1590 rv = vppcom_session_read (__sid, __buf, __n);
1595 vcom_socket_recvfrom (int __fd, void *__restrict __buf, size_t __n,
1596 int __flags, __SOCKADDR_ARG __addr,
1597 socklen_t * __restrict __addr_len)
1600 vcom_socket_main_t *vsm = &vcom_socket_main;
1602 vcom_socket_t *vsock;
1604 p = hash_get (vsm->sockidx_by_fd, __fd);
1608 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1612 if ((vsock->type != SOCKET_TYPE_VPPCOM_BOUND) ||
1613 !__buf || __n < 0 || !__addr || !__addr_len || (__addr_len < 0))
1618 rv = vcom_session_recvfrom (vsock->sid, __buf, __n,
1619 __flags, __addr, __addr_len);
1623 /* TBD: move it to vppcom */
1624 static inline ssize_t
1625 vcom_session_sendmsg (int __sid, const struct msghdr *__message, int __flags)
1628 /* rv = vppcom_session_write (__sid, (void *) __message->__buf,
1634 vcom_socket_sendmsg (int __fd, const struct msghdr * __message, int __flags)
1637 vcom_socket_main_t *vsm = &vcom_socket_main;
1639 vcom_socket_t *vsock;
1641 p = hash_get (vsm->sockidx_by_fd, __fd);
1645 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1649 if (vcom_socket_is_connection_mode_socket (__fd))
1651 /* ignore __addr and _addr_len */
1652 /* and EISCONN may be returned when they are not NULL and 0 */
1653 if ((__message->msg_name != NULL) || (__message->msg_namelen != 0))
1660 /* TBD: validate __message->msg_name and __message->msg_namelen
1661 * and return -EINVAL on validation error
1666 rv = vcom_session_sendmsg (vsock->sid, __message, __flags);
1673 vcom_socket_sendmmsg (int __fd, struct mmsghdr *__vmessages,
1674 unsigned int __vlen, int __flags)
1677 /* TBD: define a new vppcom api */
1682 /* TBD: move it to vppcom */
1683 static inline ssize_t
1684 vcom_session_recvmsg (int __sid, struct msghdr *__message, int __flags)
1687 /* rv = vppcom_session_read (__sid, (void *) __message->__buf,
1694 vcom_socket_recvmsg (int __fd, struct msghdr * __message, int __flags)
1697 vcom_socket_main_t *vsm = &vcom_socket_main;
1699 vcom_socket_t *vsock;
1701 p = hash_get (vsm->sockidx_by_fd, __fd);
1705 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1709 if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
1717 /* validate __flags */
1719 rv = vcom_session_recvmsg (vsock->sid, __message, __flags);
1725 vcom_socket_recvmmsg (int __fd, struct mmsghdr *__vmessages,
1726 unsigned int __vlen, int __flags,
1727 struct timespec *__tmo)
1729 /* TBD: define a new vppcom api */
1734 /* TBD: move it to vppcom */
1736 vcom_session_get_sockopt (int __sid, int __level, int __optname,
1737 void *__restrict __optval,
1738 socklen_t * __restrict __optlen)
1740 /* 1. for socket level options that are NOT socket attributes
1741 * and that has corresponding vpp options get from vppcom */
1746 vcom_socket_getsockopt (int __fd, int __level, int __optname,
1747 void *__restrict __optval,
1748 socklen_t * __restrict __optlen)
1751 vcom_socket_main_t *vsm = &vcom_socket_main;
1753 vcom_socket_t *vsock;
1755 p = hash_get (vsm->sockidx_by_fd, __fd);
1759 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1763 if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
1766 if (!__optval && !__optlen)
1776 /* handle options at socket level */
1781 * 1. for socket level options that are socket attributes,
1782 * get from libc_getsockopt.
1783 * 2. for socket level options that are NOT socket
1784 * attributes and that has corresponding vpp options
1786 * 3. for socket level options unimplemented
1787 * return -ENOPROTOOPT */
1806 case SO_TIMESTAMPNS:
1807 case SO_TIMESTAMPING:
1820 case SO_WIFI_STATUS:
1823 case SO_BINDTODEVICE:
1825 case SO_LOCK_FILTER:
1826 case SO_BPF_EXTENSIONS:
1827 case SO_SELECT_ERR_QUEUE:
1828 #ifdef CONFIG_NET_RX_BUSY_POLL
1831 case SO_MAX_PACING_RATE:
1832 case SO_INCOMING_CPU:
1833 rv = libc_getsockopt (__fd, __level, __optname, __optval, __optlen);
1842 /* We implement the SO_SNDLOWAT etc to not be settable
1845 return -ENOPROTOOPT;
1851 /* 1. handle options that are NOT socket level options,
1852 * but have corresponding vpp otions. */
1853 rv = vcom_session_get_sockopt (vsock->sid, __level, __optname,
1854 __optval, __optlen);
1861 /* TBD: move it to vppcom */
1863 vcom_session_setsockopt (int __sid, int __level, int __optname,
1864 const void *__optval, socklen_t __optlen)
1866 int rv = -EOPNOTSUPP;
1875 vppcom_session_attr (__sid, VPPCOM_ATTR_SET_TCP_KEEPIDLE, 0, 0);
1879 vppcom_session_attr (__sid, VPPCOM_ATTR_SET_TCP_KEEPINTVL, 0, 0);
1889 rv = vppcom_session_attr (__sid, VPPCOM_ATTR_SET_V6ONLY, 0, 0);
1899 rv = vppcom_session_attr (__sid, VPPCOM_ATTR_SET_KEEPALIVE, 0, 0);
1902 rv = vppcom_session_attr (__sid, VPPCOM_ATTR_SET_REUSEADDR, 0, 0);
1905 rv = vppcom_session_attr (__sid, VPPCOM_ATTR_SET_BROADCAST, 0, 0);
1919 vcom_socket_setsockopt (int __fd, int __level, int __optname,
1920 const void *__optval, socklen_t __optlen)
1923 vcom_socket_main_t *vsm = &vcom_socket_main;
1925 vcom_socket_t *vsock;
1927 p = hash_get (vsm->sockidx_by_fd, __fd);
1931 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1935 if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
1939 * Options without arguments
1942 if (__optname == SO_BINDTODEVICE)
1944 rv = libc_setsockopt (__fd, __level, __optname, __optval, __optlen);
1955 if ((__optlen < 0) || (__optlen < sizeof (int)))
1964 rv = vcom_session_setsockopt (vsock->sid, __level, __optname,
1965 __optval, __optlen);
1978 rv = vcom_session_setsockopt (vsock->sid, __level, __optname,
1979 __optval, __optlen);
1985 /* handle options at socket level */
1992 rv = vcom_session_setsockopt (vsock->sid, __level, __optname,
1993 __optval, __optlen);
1997 * 1. for socket level options that are socket attributes,
1998 * set it from libc_getsockopt
1999 * 2. for socket level options that are NOT socket
2000 * attributes and that has corresponding vpp options
2001 * set it from vppcom
2002 * 3. for socket level options unimplemented
2003 * return -ENOPROTOOPT */
2019 case SO_TIMESTAMPNS:
2020 case SO_TIMESTAMPING:
2033 case SO_WIFI_STATUS:
2037 * SO_BINDTODEVICE already handled as
2038 * "Options without arguments" */
2039 /* case SO_BINDTODEVICE: */
2041 case SO_LOCK_FILTER:
2042 case SO_BPF_EXTENSIONS:
2043 case SO_SELECT_ERR_QUEUE:
2044 #ifdef CONFIG_NET_RX_BUSY_POLL
2047 case SO_MAX_PACING_RATE:
2048 case SO_INCOMING_CPU:
2049 rv = libc_setsockopt (__fd, __level, __optname, __optval, __optlen);
2058 /* We implement the SO_SNDLOWAT etc to not be settable
2061 return -ENOPROTOOPT;
2067 return -ENOPROTOOPT;
2074 vcom_socket_listen (int __fd, int __n)
2077 vcom_socket_main_t *vsm = &vcom_socket_main;
2079 vcom_socket_t *vsock;
2081 p = hash_get (vsm->sockidx_by_fd, __fd);
2084 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
2086 /* TBD vppcom to accept __n parameter */
2087 rv = vppcom_session_listen (vsock->sid, __n);
2094 vcom_socket_connected_socket (int __fd, int __sid,
2096 int *__type, int *__protocol, int flags)
2099 vcom_socket_main_t *vsm = &vcom_socket_main;
2100 vcom_socket_t *vsock;
2107 optlen = sizeof (*__domain);
2108 rv = libc_getsockopt (__fd, SOL_SOCKET, SO_DOMAIN, __domain, &optlen);
2115 optlen = sizeof (*__type);
2116 rv = libc_getsockopt (__fd, SOL_SOCKET, SO_TYPE, __type, &optlen);
2123 optlen = sizeof (*__protocol);
2124 rv = libc_getsockopt (__fd, SOL_SOCKET, SO_PROTOCOL, __protocol, &optlen);
2131 fd = vcom_socket_open_socket (*__domain, *__type | flags, *__protocol);
2138 pool_get (vsm->vsockets, vsock);
2139 vsocket_init (vsock);
2141 sockidx = vsock - vsm->vsockets;
2142 hash_set (vsm->sockidx_by_fd, fd, sockidx);
2144 vsocket_set (vsock, fd, __sid, SOCKET_TYPE_VPPCOM_BOUND);
2151 /* If flag is 0, then accept4() is the same as accept().
2152 * SOCK_NONBLOCK and SOCK_CLOEXEC can be bitwise ORed in flags
2155 vcom_socket_accept_flags (int __fd, __SOCKADDR_ARG __addr,
2156 socklen_t * __restrict __addr_len, int flags)
2159 vcom_socket_main_t *vsm = &vcom_socket_main;
2161 vcom_socket_t *vsock;
2169 uint8_t addr8[sizeof (struct in6_addr)];
2174 /* validate flags */
2181 * case SOCK_NONBLOCK:
2182 * case SOCK_CLOEXEC:
2183 * case SOCK_NONBLOCK | SOCK_CLOEXEC:
2190 /* flags can be 0 or can be bitwise OR
2191 * of any of SOCK_NONBLOCK and SOCK_CLOEXEC */
2193 if (!(!flags || (flags & (SOCK_NONBLOCK | SOCK_CLOEXEC))))
2195 /* TBD: return proper error code */
2199 /* TBD: return proper error code */
2201 if (!vcom_socket_is_connection_mode_socket (__fd))
2206 p = hash_get (vsm->sockidx_by_fd, __fd);
2209 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
2212 rv = vcom_fcntl (vsock->fd, F_GETFL, 0);
2219 if (!(rv & O_NONBLOCK))
2221 /* socket is not marked as nonblocking
2222 * and no pending connections are present
2223 * on the queue, accept () blocks the caller
2224 * until a connection is present.
2226 rv = vppcom_session_accept (vsock->sid, &ep,
2227 -1.0 /* wait forever */ );
2231 /* The file descriptor refers to a socket and has been
2232 * marked nonblocking(O_NONBLOCK) and the accept would
2235 /* is non blocking */
2236 rv = vppcom_session_accept (vsock->sid, &ep, 0);
2237 /* If the socket is marked nonblocking and
2238 * no pending connections are present on the
2239 * queue, accept fails with the error
2240 * EAGAIN or EWOULDBLOCK
2242 if (rv == VPPCOM_ETIMEDOUT)
2254 /* create a new connected socket resource and set flags
2255 * on the new file descriptor.
2256 * update vsockets and sockidx_by_fd table
2258 fd = vcom_socket_connected_socket (__fd, sid,
2259 &domain, &type, &protocol, flags);
2267 /* TBD populate __addr and __addr_len */
2268 /* TBD: The returned address is truncated if the buffer
2269 * provided is too small, in this case, __addr_len will
2270 * return a value greater than was supplied to the call.*/
2275 /* TBD populate __addr and __addr_len */
2279 ((struct sockaddr_in *) __addr)->sin_family = AF_INET;
2280 ((struct sockaddr_in *) __addr)->sin_port = ep.port;
2281 memcpy (&((struct sockaddr_in *) __addr)->sin_addr,
2282 addr8, sizeof (struct in_addr));
2283 /* TBD: populate __addr_len */
2286 *__addr_len = sizeof (struct sockaddr_in);
2291 ((struct sockaddr_in6 *) __addr)->sin6_family = AF_INET6;
2292 ((struct sockaddr_in6 *) __addr)->sin6_port = ep.port;
2293 memcpy (((struct sockaddr_in6 *) __addr)->sin6_addr.
2294 __in6_u.__u6_addr8, addr8,
2295 sizeof (struct in6_addr));
2296 /* TBD: populate __addr_len */
2299 *__addr_len = sizeof (struct sockaddr_in6);
2304 return -EAFNOSUPPORT;
2312 ((struct sockaddr_in *) __addr)->sin_family = AF_INET;
2313 ((struct sockaddr_in *) __addr)->sin_port = ep.port;
2314 memcpy (&((struct sockaddr_in *) __addr)->sin_addr,
2315 addr8, sizeof (struct in_addr));
2316 /* TBD: populate __addr_len */
2319 *__addr_len = sizeof (struct sockaddr_in);
2324 ((struct sockaddr_in6 *) __addr)->sin6_family = AF_INET6;
2325 ((struct sockaddr_in6 *) __addr)->sin6_port = ep.port;
2326 memcpy (((struct sockaddr_in6 *) __addr)->sin6_addr.
2327 __in6_u.__u6_addr8, addr8,
2328 sizeof (struct in6_addr));
2329 /* TBD: populate __addr_len */
2332 *__addr_len = sizeof (struct sockaddr_in6);
2337 return -EAFNOSUPPORT;
2343 /* when __addr is NULL, nothing is filled in,
2344 * in this case, __addr_len is not used,
2345 * and should also be null
2349 /* TBD: return proper error code */
2359 vcom_socket_accept (int __fd, __SOCKADDR_ARG __addr,
2360 socklen_t * __restrict __addr_len)
2362 /* set flags to 0 for accept() */
2363 return vcom_socket_accept_flags (__fd, __addr, __addr_len, 0);
2368 vcom_socket_accept4 (int __fd, __SOCKADDR_ARG __addr,
2369 socklen_t * __restrict __addr_len, int __flags)
2371 /* SOCK_NONBLOCK and SOCK_CLOEXEC can be bitwise ORed in flags */
2372 return vcom_socket_accept_flags (__fd, __addr, __addr_len, __flags);
2376 /* TBD: move it to vppcom */
2378 vcom_session_shutdown (int __fd, int __how)
2384 vcom_socket_shutdown (int __fd, int __how)
2387 vcom_socket_main_t *vsm = &vcom_socket_main;
2389 vcom_socket_t *vsock;
2391 p = hash_get (vsm->sockidx_by_fd, __fd);
2394 vsock = pool_elt_at_index (vsm->vsockets, p[0]);
2400 rv = vcom_session_shutdown (vsock->sid, __how);
2414 vcom_socket_epoll_create1 (int __flags)
2417 vcom_socket_main_t *vsm = &vcom_socket_main;
2418 vcom_epoll_t *vepoll;
2424 epfd = vcom_socket_open_epoll (__flags);
2431 vep_idx = vppcom_epoll_create ();
2435 goto out_close_epoll;
2438 pool_get (vsm->vepolls, vepoll);
2439 vepoll_init (vepoll);
2441 epollidx = vepoll - vsm->vepolls;
2442 hash_set (vsm->epollidx_by_epfd, epfd, epollidx);
2444 vepoll_set (vepoll, epfd, vep_idx, EPOLL_TYPE_VPPCOM_BOUND, __flags, 0, 0);
2449 vcom_socket_close_epoll (epfd);
2455 * PRE: vppcom_epoll_ctl() is successful
2456 * free_vepitem_on_del : 0 - no_pool_put, 1 - pool_put
2459 vcom_socket_ctl_vepitem (int __epfd, int __op, int __fd,
2460 struct epoll_event *__event,
2461 i32 vep_idx, vcom_epoll_t * vepoll,
2462 i32 vfd_id, void *vfd, vcom_fd_type_t type,
2463 int free_vepitem_on_del)
2466 vcom_socket_main_t *vsm = &vcom_socket_main;
2467 vcom_epitem_t *vepitem;
2469 vcom_epitem_key_t epfdfd = {.epfd = __epfd,.fd = __fd };
2473 i32 *vepitemidxs = 0;
2475 struct epoll_event revent = {.events = 0,.data.fd = INVALID_FD };
2479 /* perform control operations on the epoll instance */
2484 * supplied file descriptor is already
2485 * registered with this epoll instance
2487 /* vepitem exists */
2488 p = hash_get (vsm->epitemidx_by_epfdfd, epfdfd.key);
2495 /* add a new vepitem */
2496 pool_get (vsm->vepitems, vepitem);
2497 vepitem_init (vepitem);
2499 vepitemidx = vepitem - vsm->vepitems;
2500 hash_set (vsm->epitemidx_by_epfdfd, epfdfd.key, vepitemidx);
2501 vepitem_set (vepitem, __epfd, __fd, __fd, __fd, type, *__event, revent);
2503 /* update epitemidxs */
2505 p = hash_get (vsm->epitemidxs_by_epfd, __epfd);
2506 if (!p) /* not exist */
2509 vec_add1 (vepitemidxs, vepitemidx);
2510 hash_set (vsm->epitemidxs_by_epfd, __epfd, vepitemidxs);
2514 vepitemidxs = *(i32 **) p;
2515 vec_add1 (vepitemidxs, vepitemidx);
2516 hash_set3 (vsm->epitemidxs_by_epfd, __epfd, vepitemidxs, 0);
2518 /* update epitemidxs */
2520 p = hash_get (vsm->epitemidxs_by_fd, __fd);
2521 if (!p) /* not exist */
2524 vec_add1 (vepitemidxs, vepitemidx);
2525 hash_set (vsm->epitemidxs_by_fd, __fd, vepitemidxs);
2529 vepitemidxs = *(i32 **) p;
2530 vec_add1 (vepitemidxs, vepitemidx);
2531 hash_set3 (vsm->epitemidxs_by_fd, __fd, vepitemidxs, 0);
2534 /* increment vepoll fd count by 1 */
2543 * supplied file descriptor is not
2544 * registered with this epoll instance
2546 /* vepitem not exist */
2547 p = hash_get (vsm->epitemidx_by_epfdfd, epfdfd.key);
2553 vepitem = pool_elt_at_index (vsm->vepitems, p[0]);
2556 vepitem->event = *__event;
2557 vepitem->revent = revent;
2566 * supplied file descriptor is not
2567 * registered with this epoll instance
2569 /* vepitem not exist */
2570 p = hash_get (vsm->epitemidx_by_epfdfd, epfdfd.key);
2576 vepitemidx = *(i32 *) p;
2577 hash_unset (vsm->epitemidx_by_epfdfd, epfdfd.key);
2579 /* update epitemidxs */
2581 p = hash_get (vsm->epitemidxs_by_epfd, __epfd);
2582 if (!p) /* not exist */
2589 vepitemidxs = *(i32 **) p;
2590 vec_idx = vec_search (vepitemidxs, vepitemidx);
2593 vec_del1 (vepitemidxs, vec_idx);
2594 if (!vec_len (vepitemidxs))
2596 vec_free (vepitemidxs);
2597 hash_unset (vsm->epitemidxs_by_epfd, __epfd);
2602 /* update epitemidxs */
2604 p = hash_get (vsm->epitemidxs_by_fd, __fd);
2605 if (!p) /* not exist */
2612 vepitemidxs = *(i32 **) p;
2613 vec_idx = vec_search (vepitemidxs, vepitemidx);
2616 vec_del1 (vepitemidxs, vec_idx);
2617 if (!vec_len (vepitemidxs))
2619 vec_free (vepitemidxs);
2620 hash_unset (vsm->epitemidxs_by_fd, __fd);
2625 /* pool put vepitem */
2626 vepitem = pool_elt_at_index (vsm->vepitems, vepitemidx);
2627 if (free_vepitem_on_del)
2634 vepitem_init (vepitem);
2635 pool_put (vsm->vepitems, vepitem);
2641 vepitem_init (vepitem);
2645 /* decrement vepoll fd count by 1 */
2663 * PRE: 00. null pointer check on __event
2664 * 01. all other parameters are validated
2668 vcom_socket_epoll_ctl_internal (int __epfd, int __op, int __fd,
2669 struct epoll_event *__event,
2670 int free_vepitem_on_del)
2674 /* vcom_socket_main_t *vsm = &vcom_socket_main; */
2675 vcom_epoll_t *vepoll;
2677 /*__fd could could be vcom socket or vcom epoll or kernel fd */
2679 vcom_epoll_t *vfd_vepoll;
2680 vcom_socket_t *vfd_vsock;
2685 vcom_fd_type_t type = FD_TYPE_INVALID;
2687 /* validate __event */
2689 /* get vep_idx and vepoll */
2690 vep_idx = vcom_socket_get_vep_idx_and_vepoll (__epfd, &vepoll);
2691 if (vep_idx == INVALID_VEP_IDX)
2696 /* get vcom fd type, vfd_id and vfd */
2697 vfd_id = vcom_socket_get_sid_and_vsock (__fd, &vfd_vsock);
2698 if (vfd_id != INVALID_SESSION_ID)
2700 type = FD_TYPE_VCOM_SOCKET;
2703 else if ((vfd_id = vcom_socket_get_vep_idx_and_vepoll (__fd, &vfd_vepoll))
2706 type = FD_TYPE_EPOLL;
2711 /* FD_TYPE_KERNEL not supported by epoll instance */
2712 type = FD_TYPE_INVALID;
2717 /* vepoll and vsock are now valid */
2718 rv = vppcom_epoll_ctl (vep_idx, __op, vfd_id, __event);
2724 rv = vcom_socket_ctl_vepitem (__epfd, __op, __fd,
2727 vfd_id, vfd, type, free_vepitem_on_del);
2732 vcom_socket_epoll_ctl (int __epfd, int __op, int __fd,
2733 struct epoll_event *__event)
2737 rv = vcom_socket_epoll_ctl_internal (__epfd, __op, __fd, __event, 1);
2742 vcom_socket_epoll_ctl1 (int __epfd, int __op, int __fd,
2743 struct epoll_event *__event)
2747 rv = vcom_socket_epoll_ctl_internal (__epfd, __op, __fd, __event, 0);
2752 vcom_socket_epoll_pwait (int __epfd, struct epoll_event *__events,
2753 int __maxevents, int __timeout,
2754 const __sigset_t * __ss)
2758 /* in seconds eg. 3.123456789 seconds */
2759 double time_to_wait = (double) 0;
2763 /* validate __event */
2770 /* validate __timeout */
2773 time_to_wait = (double) __timeout / (double) 1000;
2775 else if (__timeout == 0)
2777 time_to_wait = (double) 0;
2779 else if (__timeout == -1)
2790 vep_idx = vcom_socket_get_vep_idx (__epfd);
2791 if (vep_idx != INVALID_VEP_IDX)
2793 rv = vppcom_epoll_wait (vep_idx, __events, __maxevents, time_to_wait);
2800 vcom_pollfds_2_selectfds (
2802 struct pollfd *__fds, nfds_t __nfds,
2805 fd_set * __restrict vcom_readfds,
2806 fd_set * __restrict vcom_writefds,
2807 fd_set * __restrict vcom_exceptfds)
2811 for (fds_idx = 0; fds_idx < __nfds; fds_idx++)
2813 /* ignore negative fds */
2814 if (__fds[fds_idx].fd < 0)
2819 /* for POLLRDHUP, POLLERR, POLLHUP and POLLNVAL */
2820 FD_SET (__fds[fds_idx].fd, vcom_exceptfds);
2822 /* requested events */
2823 if (__fds[fds_idx].events)
2825 if (__fds[fds_idx].events & POLLIN)
2827 FD_SET (__fds[fds_idx].fd, vcom_readfds);
2829 if (__fds[fds_idx].events & POLLPRI)
2831 FD_SET (__fds[fds_idx].fd, vcom_readfds);
2833 if (__fds[fds_idx].events & POLLOUT)
2835 FD_SET (__fds[fds_idx].fd, vcom_writefds);
2837 #if defined __USE_XOPEN || defined __USE_XOPEN2K8
2838 if (__fds[fds_idx].events & POLLRDNORM)
2840 FD_SET (__fds[fds_idx].fd, vcom_readfds);
2842 if (__fds[fds_idx].events & POLLRDBAND)
2844 FD_SET (__fds[fds_idx].fd, vcom_readfds);
2846 if (__fds[fds_idx].events & POLLWRNORM)
2848 FD_SET (__fds[fds_idx].fd, vcom_writefds);
2850 if (__fds[fds_idx].events & POLLWRBAND)
2852 FD_SET (__fds[fds_idx].fd, vcom_writefds);
2856 } /* for (fds_idx = 0; fds_idx < __nfds; fds_idx++) */
2860 vcom_selectfds_2_pollfds (
2862 struct pollfd *__fds, nfds_t __nfds, int *nfd,
2865 fd_set * __restrict vcom_readfds,
2866 fd_set * __restrict vcom_writefds,
2867 fd_set * __restrict vcom_exceptfds)
2872 for (fds_idx = 0; fds_idx < __nfds; fds_idx++)
2874 /* ignore negative fds */
2875 if (__fds[fds_idx].fd < 0)
2877 __fds[fds_idx].revents = 0;
2880 /* for POLLRDHUP, POLLERR, POLLHUP and POLLNVAL */
2881 if (FD_ISSET (__fds[fds_idx].fd, vcom_exceptfds))
2884 * TBD: for now any select exception
2885 * is flagged as POLLERR
2887 __fds[fds_idx].revents |= POLLERR;
2890 /* requested events */
2891 if (__fds[fds_idx].events & POLLIN)
2893 if (FD_ISSET (__fds[fds_idx].fd, vcom_readfds))
2895 __fds[fds_idx].revents |= POLLIN;
2898 if (__fds[fds_idx].events & POLLPRI)
2900 if (FD_ISSET (__fds[fds_idx].fd, vcom_readfds))
2902 __fds[fds_idx].revents |= POLLIN;
2905 if (__fds[fds_idx].events & POLLOUT)
2907 if (FD_ISSET (__fds[fds_idx].fd, vcom_writefds))
2909 __fds[fds_idx].revents |= POLLOUT;
2912 #if defined __USE_XOPEN || defined __USE_XOPEN2K8
2913 if (__fds[fds_idx].events & POLLRDNORM)
2915 if (FD_ISSET (__fds[fds_idx].fd, vcom_readfds))
2917 __fds[fds_idx].revents |= POLLRDNORM;
2920 if (__fds[fds_idx].events & POLLRDBAND)
2922 if (FD_ISSET (__fds[fds_idx].fd, vcom_readfds))
2924 __fds[fds_idx].revents |= POLLRDBAND;
2927 if (__fds[fds_idx].events & POLLWRNORM)
2929 if (FD_ISSET (__fds[fds_idx].fd, vcom_writefds))
2931 __fds[fds_idx].revents |= POLLWRNORM;
2934 if (__fds[fds_idx].events & POLLWRBAND)
2936 if (FD_ISSET (__fds[fds_idx].fd, vcom_writefds))
2938 __fds[fds_idx].revents |= POLLWRBAND;
2942 } /* for (fds_idx = 0; fds_idx < __nfds; fds_idx++) */
2946 * the number of structures which have nonzero revents fields
2947 * (in other words, those descriptors with events or
2951 for (fds_idx = 0; fds_idx < __nfds; fds_idx++)
2953 /* ignore negative fds */
2954 if (__fds[fds_idx].fd < 0)
2959 if (__fds[fds_idx].revents)
2967 * PRE: parameters are validated,
2968 * vcom_socket_poll is always called with __timeout set to zero
2969 * hence returns immediately
2971 * ACTION: handle non negative validated vcom fds and ignore rest
2975 * implements vcom_socket_poll () interface
2977 * internally uses vcom_socket_select ()
2978 * to realize the behavior
2981 vcom_socket_poll_select_impl (struct pollfd *__fds, nfds_t __nfds,
2985 pid_t pid = getpid ();
2992 fd_set vcom_readfds;
2993 fd_set vcom_writefds;
2994 fd_set vcom_exceptfds;
2996 /* invalid max_vcom_fd is -1 */
2997 int max_vcom_fd = -1;
2999 /* __timeout is zero to get ready events and return immediately */
3000 struct timeval tv = {.tv_sec = 0,.tv_usec = 0 };
3002 /* validate __nfds from select perspective */
3003 if (__nfds < 0 || __nfds > FD_SETSIZE)
3009 /* zero vcom fd sets */
3025 for (fds_idx = 0; fds_idx < __nfds; fds_idx++)
3027 /* ignore negative fds */
3028 if (__fds[fds_idx].fd < 0)
3033 /* non negative validated vcom fds */
3034 if (__fds[fds_idx].fd > FD_SETSIZE)
3040 /* max_vcom_fd and vcom_nfd */
3041 if (__fds[fds_idx].fd > max_vcom_fd)
3043 /* requested events */
3044 if (__fds[fds_idx].events)
3046 max_vcom_fd = __fds[fds_idx].fd;
3052 vcom_nfds = max_vcom_fd != -1 ? max_vcom_fd + 1 : 0;
3060 vcom_pollfds_2_selectfds (
3065 &vcom_readfds, &vcom_writefds, &vcom_exceptfds);
3067 /* select on vcom fds */
3068 vcom_nfd = vcom_socket_select (vcom_nfds,
3070 &vcom_writefds, &vcom_exceptfds, &tv);
3073 "[%d] vcom_socket_select: "
3074 "'%04d'='%04d'\n", pid, vcom_nfd, vcom_nfds);
3082 vcom_selectfds_2_pollfds (
3084 __fds, __nfds, &nfd,
3087 &vcom_readfds, &vcom_writefds, &vcom_exceptfds);
3096 * TBD: remove this static function once vppcom
3097 * has an implementation in place
3102 vppcom_poll (struct pollfd *__fds, nfds_t __nfds, double time_to_wait)
3108 vcom_socket_poll_vppcom_impl (struct pollfd *__fds, nfds_t __nfds,
3113 /* in seconds eg. 3.123456789 seconds */
3114 double time_to_wait = (double) 0;
3119 /* replace vcom fd with session idx */
3120 for (fds_idx = 0; fds_idx < __nfds; fds_idx++)
3122 /* ignore negative fds */
3123 if (__fds[fds_idx].fd < 0)
3128 /* non negative validated vcom fds */
3129 sid = vcom_socket_get_sid (__fds[fds_idx].fd);
3130 if (sid != INVALID_SESSION_ID)
3132 __fds[fds_idx].fd = sid;
3137 vep_idx = vcom_socket_get_vep_idx (__fds[fds_idx].fd);
3138 if (vep_idx != INVALID_VEP_IDX)
3140 __fds[fds_idx].fd = vep_idx;
3149 /* validate __timeout */
3152 time_to_wait = (double) __timeout / (double) 1000;
3154 else if (__timeout == 0)
3156 time_to_wait = (double) 0;
3158 else if (__timeout < 0)
3167 return vppcom_poll (__fds, __nfds, time_to_wait);
3171 vcom_socket_poll (struct pollfd *__fds, nfds_t __nfds, int __timeout)
3173 /* select an implementation */
3175 /* return vcom_socket_poll_vppcom_impl (__fds, __nfds, __timeout); */
3176 return vcom_socket_poll_select_impl (__fds, __nfds, __timeout);
3181 vcom_socket_ppoll (struct pollfd *__fds, nfds_t __nfds,
3182 const struct timespec *__timeout, const __sigset_t * __ss)
3189 vcom_socket_main_init (void)
3191 vcom_socket_main_t *vsm = &vcom_socket_main;
3194 printf ("vcom_socket_main_init\n");
3198 /* TBD: define FD_MAXSIZE and use it here */
3199 pool_alloc (vsm->vsockets, FD_SETSIZE);
3200 vsm->sockidx_by_fd = hash_create (0, sizeof (i32));
3202 pool_alloc (vsm->vepolls, FD_SETSIZE);
3203 vsm->epollidx_by_epfd = hash_create (0, sizeof (i32));
3205 pool_alloc (vsm->vepitems, FD_SETSIZE);
3206 vsm->epitemidx_by_epfdfd = hash_create (0, sizeof (i32));
3208 vsm->epitemidxs_by_epfd = hash_create (0, sizeof (i32 *));
3209 vsm->epitemidxs_by_fd = hash_create (0, sizeof (i32 *));
3219 vcom_socket_main_show (void)
3221 vcom_socket_main_t *vsm = &vcom_socket_main;
3222 vcom_socket_t *vsock;
3224 vcom_epoll_t *vepoll;
3226 vcom_epitem_t *vepitem;
3230 i32 *vepitemidxs, *vepitemidxs_var;
3234 /* from active list of vsockets show vsock */
3237 pool_foreach (vsock, vsm->vsockets,
3240 "fd='%04d', sid='%08x',type='%-30s'\n",
3241 vsock->fd, vsock->sid,
3242 vcom_socket_type_str (vsock->type));
3246 /* from active list of vepolls, show vepoll */
3249 pool_foreach (vepoll, vsm->vepolls,
3252 "epfd='%04d', vep_idx='%08x', "
3254 "flags='%d', count='%d', close='%d'\n",
3255 vepoll->epfd, vepoll->vep_idx,
3256 vcom_socket_epoll_type_str (vepoll->type),
3257 vepoll->flags, vepoll->count, vepoll->close);
3261 /* from active list of vepitems, show vepitem */
3264 pool_foreach (vepitem, vsm->vepitems,
3267 "epfd='%04d', fd='%04d', "
3268 "next_fd='%04d', prev_fd='%04d', "
3270 "events='%04x', revents='%04x'\n",
3271 vepitem->epfd, vepitem->fd,
3272 vepitem->next_fd, vepitem->prev_fd,
3273 vcom_socket_vcom_fd_type_str (vepitem->type),
3274 vepitem->event.events, vepitem->revent.events);
3279 /* show epitemidxs for epfd */
3281 hash_foreach (epfd, vepitemidxs,
3282 vsm->epitemidxs_by_epfd,
3284 printf("\n[ '%04d': ", epfd);
3285 vec_foreach (vepitemidxs_var,vepitemidxs)
3287 printf("'%04d' ", (int)vepitemidxs_var[0]);
3293 /* show epitemidxs for fd */
3295 hash_foreach (fd, vepitemidxs,
3296 vsm->epitemidxs_by_fd,
3298 printf("\n{ '%04d': ", fd);
3299 vec_foreach (vepitemidxs_var,vepitemidxs)
3301 printf("'%04d' ", (int)vepitemidxs_var[0]);
3311 vcom_socket_main_destroy (void)
3313 vcom_socket_main_t *vsm = &vcom_socket_main;
3314 vcom_socket_t *vsock;
3316 vcom_epoll_t *vepoll;
3318 vcom_epitem_t *vepitem;
3326 printf ("vcom_socket_main_destroy\n");
3332 * from active list of vepitems,
3333 * remove all "vepitem" elements from the pool in a safe way
3337 pool_flush (vepitem, vsm->vepitems,
3339 if (vepitem->type == FD_TYPE_EPOLL || FD_TYPE_VCOM_SOCKET)
3341 vcom_socket_epoll_ctl1 (vepitem->epfd, EPOLL_CTL_DEL,
3343 vepitem_init (vepitem);
3348 pool_free (vsm->vepitems);
3349 hash_free (vsm->epitemidx_by_epfdfd);
3351 /* free vepitemidxs for each epfd */
3353 hash_foreach (epfd, vepitemidxs,
3354 vsm->epitemidxs_by_epfd,
3356 vec_free (vepitemidxs);
3359 hash_free (vsm->epitemidxs_by_epfd);
3361 /* free vepitemidxs for each fd */
3363 hash_foreach (fd, vepitemidxs,
3364 vsm->epitemidxs_by_fd,
3366 vec_free (vepitemidxs);
3369 hash_free (vsm->epitemidxs_by_fd);
3373 * from active list of vsockets,
3374 * close socket and vppcom session
3378 pool_foreach (vsock, vsm->vsockets,
3380 if (vsock->type == SOCKET_TYPE_VPPCOM_BOUND)
3382 vppcom_session_close (vsock->sid);
3383 vcom_socket_close_socket (vsock->fd);
3384 vsocket_init (vsock);
3390 * return vsocket element to the pool
3394 pool_flush (vsock, vsm->vsockets,
3396 // vsocket_init(vsock);
3401 pool_free (vsm->vsockets);
3402 hash_free (vsm->sockidx_by_fd);
3405 * from active list of vepolls,
3406 * close epoll and vppcom_epoll
3410 pool_foreach (vepoll, vsm->vepolls,
3412 if (vepoll->type == EPOLL_TYPE_VPPCOM_BOUND)
3414 vppcom_session_close (vepoll->vep_idx);
3415 vcom_socket_close_epoll (vepoll->epfd); /* TBD: */
3416 vepoll_init (vepoll);
3422 * return vepoll element to the pool
3426 pool_flush (vepoll, vsm->vepolls,
3428 // vepoll_init(vepoll);
3433 pool_free (vsm->vepolls);
3434 hash_free (vsm->epollidx_by_epfd);
3442 * fd.io coding-style-patch-verification: ON
3445 * eval: (c-set-style "gnu")