src/vcl/vcom.h

   1 /*
   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:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   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.
  14  */
  15
  16 #ifndef included_vcom_h
  17 #define included_vcom_h
  18
  19 #if (CLIB_DEBUG > 0)
  20 /* Set VCOM_DEBUG 2 for connection debug, 3 for read/write debug output */
  21 #define VCOM_DEBUG 1
  22 #else
  23 #define VCOM_DEBUG 0
  24 #endif
  25
  26 #include <vcl/vcom_glibc_socket.h>
  27
  28 #define MAX_VCOM_APP_NAME  256
  29
  30 /* Returns 0 on success or -1 on error. */
  31 extern int vcom_set_app_name (char *__app_name);
  32
  33 /*
  34  *
  35  * File descriptor based APIs
  36  *
  37  */
  38
  39 /*
  40  * vpp implementation of glibc APIs from <unistd.h>
  41  */
  42 extern int vcom_close (int __fd);
  43
  44 extern ssize_t __wur vcom_read (int __fd, void *__buf, size_t __nbytes);
  45
  46 extern ssize_t __wur vcom_write (int __fd, const void *__buf, size_t __n);
  47
  48 extern ssize_t __wur vcom_readv (int __fd, const struct iovec *__iov,
  49                                  int __iovcnt);
  50
  51 extern ssize_t __wur vcom_writev (int __fd, const struct iovec *__iov,
  52                                   int __iovcnt);
  53
  54 /*
  55  * vpp implementation of glibc APIs from <fcntl.h>
  56  */
  57 extern int vcom_fcntl (int __fd, int __cmd, ...);
  58
  59 /*
  60  * VPP implementation of glibc APIs ioctl
  61  */
  62 extern int vcom_ioctl (int __fd, unsigned long int __cmd, ...);
  63
  64 /*
  65  * vpp implementation of glibc APIs from <sys/select.h>
  66  */
  67 extern int
  68 vcom_select (int __nfds, fd_set * __restrict __readfds,
  69              fd_set * __restrict __writefds,
  70              fd_set * __restrict __exceptfds,
  71              struct timeval *__restrict __timeout);
  72
  73 #ifdef __USE_XOPEN2K
  74 extern int
  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);
  80 #endif
  81
  82 /*
  83  * vpp implementation of glibc APIs from <sys/socket.h>
  84  */
  85 extern int __THROW vcom_socket (int __domain, int __type, int __protocol);
  86
  87 /* On Linux, the only supported domain for this call is AF_UNIX
  88 * (or synonymously, AF_LOCAL). Most implementations have the
  89 * same restriction.
  90 * vpp does not implement AF_UNIX domain in this release.
  91 * */
  92 extern int __THROW
  93 vcom_socketpair (int __domain, int __type, int __protocol, int __fds[2]);
  94
  95 extern int __THROW
  96 vcom_bind (int __fd, __CONST_SOCKADDR_ARG __addr, socklen_t __len);
  97
  98 extern int __THROW
  99 vcom_getsockname (int __fd, __SOCKADDR_ARG __addr,
 100                   socklen_t * __restrict __len);
 101
 102 extern int
 103 vcom_connect (int __fd, __CONST_SOCKADDR_ARG __addr, socklen_t __len);
 104
 105 extern int __THROW
 106 vcom_getpeername (int __fd, __SOCKADDR_ARG __addr,
 107                   socklen_t * __restrict __len);
 108
 109 extern ssize_t
 110 vcom_send (int __fd, const void *__buf, size_t __n, int __flags);
 111
 112 extern ssize_t vcom_recv (int __fd, void *__buf, size_t __n, int __flags);
 113
 114 extern ssize_t
 115 vcom_sendto (int __fd, const void *__buf, size_t __n,
 116              int __flags, __CONST_SOCKADDR_ARG __addr, socklen_t __addr_len);
 117
 118 extern ssize_t
 119 vcom_recvfrom (int __fd, void *__restrict __buf,
 120                size_t __n, int __flags,
 121                __SOCKADDR_ARG __addr, socklen_t * __restrict __addr_len);
 122
 123 extern ssize_t
 124 vcom_sendmsg (int __fd, const struct msghdr *__message, int __flags);
 125
 126 #ifdef __USE_GNU
 127 extern int
 128 sendmmsg (int __fd, struct mmsghdr *__vmessages,
 129           unsigned int __vlen, int __flags);
 130 #endif
 131
 132 extern ssize_t vcom_recvmsg (int __fd, struct msghdr *__message, int __flags);
 133
 134 #ifdef __USE_GNU
 135 extern int
 136 vcom_recvmmsg (int __fd, struct mmsghdr *__vmessages,
 137                unsigned int __vlen, int __flags, struct timespec *__tmo);
 138 #endif
 139
 140 extern int __THROW
 141 vcom_getsockopt (int __fd, int __level, int __optname,
 142                  void *__restrict __optval, socklen_t * __restrict __optlen);
 143
 144 extern int __THROW
 145 vcom_setsockopt (int __fd, int __level, int __optname,
 146                  const void *__optval, socklen_t __optlen);
 147
 148 extern int __THROW vcom_listen (int __fd, int __n);
 149
 150 extern int
 151 vcom_accept (int __fd, __SOCKADDR_ARG __addr,
 152              socklen_t * __restrict __addr_len);
 153
 154 #ifdef __USE_GNU
 155 /*
 156  * Similar to 'accept' but takes an additional parameter to specify
 157  * flags.
 158  * */
 159 /* TBD: implemented later */
 160 extern int
 161 vcom_accept4 (int __fd, __SOCKADDR_ARG __addr,
 162               socklen_t * __restrict __addr_len, int __flags);
 163 #endif
 164
 165 extern int __THROW vcom_shutdown (int __fd, int __how);
 166
 167 extern int __THROW vcom_epoll_create (int __size);
 168
 169 extern int __THROW vcom_epoll_create1 (int __flags);
 170
 171 extern int __THROW
 172 vcom_epoll_ctl (int __epfd, int __op, int __fd, struct epoll_event *__event);
 173
 174 extern int
 175 vcom_epoll_wait (int __epfd, struct epoll_event *__events,
 176                  int __maxevents, int __timeout);
 177
 178 extern int
 179 vcom_epoll_pwait (int __epfd, struct epoll_event *__events,
 180                   int __maxevents, int __timeout, const __sigset_t * __ss);
 181
 182 /*
 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.
 186  * */
 187 #define MAX_POLL_NFDS_DEFAULT   1024
 188 extern int vcom_poll (struct pollfd *__fds, nfds_t __nfds, int __timeout);
 189
 190 #ifdef __USE_GNU
 191 extern int
 192 vcom_ppoll (struct pollfd *__fds, nfds_t __nfds,
 193             const struct timespec *__timeout, const __sigset_t * __ss);
 194 #endif
 195
 196
 197 #endif /* included_vcom_h */
 198
 199 /*
 200  * fd.io coding-style-patch-verification: ON
 201  *
 202  * Local Variables:
 203  * eval: (c-set-style "gnu")
 204  * End:
 205  */