2 * Copyright (c) 2017 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.
16 #ifndef included_vcom_h
17 #define included_vcom_h
20 /* Set VCOM_DEBUG 2 for connection debug, 3 for read/write debug output */
26 #include <vcl/vcom_glibc_socket.h>
28 #define MAX_VCOM_APP_NAME 256
30 /* Returns 0 on success or -1 on error. */
31 extern int vcom_set_app_name (char *__app_name);
35 * File descriptor based APIs
40 * vpp implementation of glibc APIs from <unistd.h>
42 extern int vcom_close (int __fd);
44 extern ssize_t __wur vcom_read (int __fd, void *__buf, size_t __nbytes);
46 extern ssize_t __wur vcom_write (int __fd, const void *__buf, size_t __n);
48 extern ssize_t __wur vcom_readv (int __fd, const struct iovec *__iov,
51 extern ssize_t __wur vcom_writev (int __fd, const struct iovec *__iov,
55 * vpp implementation of glibc APIs from <fcntl.h>
57 extern int vcom_fcntl (int __fd, int __cmd, ...);
60 * VPP implementation of glibc APIs ioctl
62 extern int vcom_ioctl (int __fd, unsigned long int __cmd, ...);
65 * vpp implementation of glibc APIs from <sys/select.h>
68 vcom_select (int __nfds, fd_set * __restrict __readfds,
69 fd_set * __restrict __writefds,
70 fd_set * __restrict __exceptfds,
71 struct timeval *__restrict __timeout);
75 vcom_pselect (int __nfds, fd_set * __restrict __readfds,
76 fd_set * __restrict __writefds,
77 fd_set * __restrict __exceptfds,
78 const struct timespec *__restrict __timeout,
79 const __sigset_t * __restrict __sigmask);
83 * vpp implementation of glibc APIs from <sys/socket.h>
85 extern int __THROW vcom_socket (int __domain, int __type, int __protocol);
87 /* On Linux, the only supported domain for this call is AF_UNIX
88 * (or synonymously, AF_LOCAL). Most implementations have the
90 * vpp does not implement AF_UNIX domain in this release.
93 vcom_socketpair (int __domain, int __type, int __protocol, int __fds[2]);
96 vcom_bind (int __fd, __CONST_SOCKADDR_ARG __addr, socklen_t __len);
99 vcom_getsockname (int __fd, __SOCKADDR_ARG __addr,
100 socklen_t * __restrict __len);
103 vcom_connect (int __fd, __CONST_SOCKADDR_ARG __addr, socklen_t __len);
106 vcom_getpeername (int __fd, __SOCKADDR_ARG __addr,
107 socklen_t * __restrict __len);
110 vcom_send (int __fd, const void *__buf, size_t __n, int __flags);
112 extern ssize_t vcom_recv (int __fd, void *__buf, size_t __n, int __flags);
115 vcom_sendto (int __fd, const void *__buf, size_t __n,
116 int __flags, __CONST_SOCKADDR_ARG __addr, socklen_t __addr_len);
119 vcom_recvfrom (int __fd, void *__restrict __buf,
120 size_t __n, int __flags,
121 __SOCKADDR_ARG __addr, socklen_t * __restrict __addr_len);
124 vcom_sendmsg (int __fd, const struct msghdr *__message, int __flags);
128 sendmmsg (int __fd, struct mmsghdr *__vmessages,
129 unsigned int __vlen, int __flags);
132 extern ssize_t vcom_recvmsg (int __fd, struct msghdr *__message, int __flags);
136 vcom_recvmmsg (int __fd, struct mmsghdr *__vmessages,
137 unsigned int __vlen, int __flags, struct timespec *__tmo);
141 vcom_getsockopt (int __fd, int __level, int __optname,
142 void *__restrict __optval, socklen_t * __restrict __optlen);
145 vcom_setsockopt (int __fd, int __level, int __optname,
146 const void *__optval, socklen_t __optlen);
148 extern int __THROW vcom_listen (int __fd, int __n);
151 vcom_accept (int __fd, __SOCKADDR_ARG __addr,
152 socklen_t * __restrict __addr_len);
156 * Similar to 'accept' but takes an additional parameter to specify
159 /* TBD: implemented later */
161 vcom_accept4 (int __fd, __SOCKADDR_ARG __addr,
162 socklen_t * __restrict __addr_len, int __flags);
165 extern int __THROW vcom_shutdown (int __fd, int __how);
167 extern int __THROW vcom_epoll_create (int __size);
169 extern int __THROW vcom_epoll_create1 (int __flags);
172 vcom_epoll_ctl (int __epfd, int __op, int __fd, struct epoll_event *__event);
175 vcom_epoll_wait (int __epfd, struct epoll_event *__events,
176 int __maxevents, int __timeout);
179 vcom_epoll_pwait (int __epfd, struct epoll_event *__events,
180 int __maxevents, int __timeout, const __sigset_t * __ss);
183 * NOTE: observed __nfds is less than 128 from kubecon strace files
184 * for the POC, it's fair to assume that nfds is less than 1024.
185 * TBD: make it thread safe and design to scale.
187 #define MAX_POLL_NFDS_DEFAULT 1024
188 extern int vcom_poll (struct pollfd *__fds, nfds_t __nfds, int __timeout);
192 vcom_ppoll (struct pollfd *__fds, nfds_t __nfds,
193 const struct timespec *__timeout, const __sigset_t * __ss);
197 #endif /* included_vcom_h */
200 * fd.io coding-style-patch-verification: ON
203 * eval: (c-set-style "gnu")