lib/socket-util.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 Nicira, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef SOCKET_UTIL_H
  18 #define SOCKET_UTIL_H 1
  19
  20 #include <errno.h>
  21 #include <sys/types.h>
  22 #include <sys/socket.h>
  23 #include <sys/time.h>
  24 #include <sys/un.h>
  25 #include <netinet/in.h>
  26 #include <stdbool.h>
  27 #include "openvswitch/types.h"
  28 #include <netinet/in_systm.h>
  29 #include <netinet/ip.h>
  30
  31 struct ds;
  32
  33 int set_nonblocking(int fd);
  34 void xset_nonblocking(int fd);
  35 void setsockopt_tcp_nodelay(int fd);
  36 int set_dscp(int fd, int family, uint8_t dscp);
  37
  38 bool addr_is_ipv6(const char *host_name);
  39 int lookup_ip(const char *host_name, struct in_addr *address);
  40 int lookup_ipv6(const char *host_name, struct in6_addr *address);
  41
  42 int lookup_hostname(const char *host_name, struct in_addr *);
  43
  44 int get_socket_rcvbuf(int sock);
  45 int check_connection_completion(int fd);
  46 void drain_fd(int fd, size_t n_packets);
  47 ovs_be32 guess_netmask(ovs_be32 ip);
  48
  49 void inet_parse_host_port_tokens(char *s, char **hostp, char **portp);
  50 void inet_parse_port_host_tokens(char *s, char **portp, char **hostp);
  51 bool inet_parse_active(const char *target, int default_port,
  52                        struct sockaddr_storage *ssp);
  53 int inet_open_active(int style, const char *target, int default_port,
  54                      struct sockaddr_storage *ssp, int *fdp, uint8_t dscp);
  55
  56 bool inet_parse_passive(const char *target, int default_port,
  57                         struct sockaddr_storage *ssp);
  58 int inet_open_passive(int style, const char *target, int default_port,
  59                       struct sockaddr_storage *ssp, uint8_t dscp,
  60                       bool kernel_print_port);
  61
  62 bool inet_parse_address(const char *target, struct sockaddr_storage *);
  63
  64 int read_fully(int fd, void *, size_t, size_t *bytes_read);
  65 int write_fully(int fd, const void *, size_t, size_t *bytes_written);
  66
  67 int fsync_parent_dir(const char *file_name);
  68 int get_mtime(const char *file_name, struct timespec *mtime);
  69
  70 char *describe_fd(int fd);
  71
  72 /* Default value of dscp bits for connection between controller and manager.
  73  * Value of IPTOS_PREC_INTERNETCONTROL = 0xc0 which is defined
  74  * in <netinet/ip.h> is used. */
  75 #define DSCP_DEFAULT (IPTOS_PREC_INTERNETCONTROL >> 2)
  76
  77 /* Functions for working with sockaddr that might contain an IPv4 or
  78  * IPv6 address. */
  79 bool sa_is_ip(const struct sockaddr *);
  80 uint16_t sa_get_port(const struct sockaddr *);
  81 struct in6_addr sa_get_address(const struct sockaddr *);
  82 void sa_format_address(const struct sockaddr *, struct ds *);
  83 void sa_format_address_nobracks(const struct sockaddr *, struct ds *);
  84 size_t sa_length(const struct sockaddr *);
  85
  86 /* Functions for working with sockaddr_storage that might contain an IPv4 or
  87  * IPv6 address. */
  88 bool ss_is_ip(const struct sockaddr_storage *);
  89 uint16_t ss_get_port(const struct sockaddr_storage *);
  90 struct in6_addr ss_get_address(const struct sockaddr_storage *);
  91 void ss_format_address(const struct sockaddr_storage *, struct ds *);
  92 void ss_format_address_nobracks(const struct sockaddr_storage *, struct ds *);
  93 size_t ss_length(const struct sockaddr_storage *);
  94
  95 const char *sock_strerror(int error);
  96
  97 #ifndef _WIN32
  98 void xpipe(int fds[2]);
  99 void xpipe_nonblocking(int fds[2]);
 100
 101 int drain_rcvbuf(int fd);
 102
 103 int make_unix_socket(int style, bool nonblock,
 104                      const char *bind_path, const char *connect_path);
 105 int get_unix_name_len(const struct sockaddr_un *sun, socklen_t sun_len);
 106
 107 /* Universal sendmmsg support.
 108  *
 109  * Some platforms, such as new enough Linux and FreeBSD, support sendmmsg, but
 110  * other platforms (or older ones) do not.  We add the following infrastructure
 111  * to allow all code to use sendmmsg, regardless of platform support:
 112  *
 113  *   - For platforms that lack sendmmsg entirely, we emulate it.
 114  *
 115  *   - Some platforms have sendmmsg() in the C library but not in the kernel.
 116  *     For example, this is true if a Linux system has a newer glibc with an
 117  *     old kernel.  To compensate, even if sendmmsg() appears to be available,
 118  *     we still wrap it with a handler that uses our emulation if sendmmsg()
 119  *     returns ENOSYS.
 120  */
 121 #ifndef HAVE_STRUCT_MMSGHDR_MSG_LEN
 122 struct mmsghdr {
 123     struct msghdr msg_hdr;
 124     unsigned int msg_len;
 125 };
 126 #endif
 127 #ifndef HAVE_SENDMMSG
 128 int sendmmsg(int, struct mmsghdr *, unsigned int, unsigned int);
 129 #else
 130 #define sendmmsg wrap_sendmmsg
 131 int wrap_sendmmsg(int, struct mmsghdr *, unsigned int, unsigned int);
 132 #endif
 133
 134 /* Helpers for calling ioctl() on an AF_INET socket. */
 135 struct ifreq;
 136 int af_inet_ioctl(unsigned long int command, const void *arg);
 137 int af_inet_ifreq_ioctl(const char *name, struct ifreq *,
 138                         unsigned long int cmd, const char *cmd_name);
 139
 140 #define closesocket close
 141 #endif
 142
 143 #ifdef _WIN32
 144 static inline int make_unix_socket(int style, bool nonblock,
 145                                    const char *bind_path,
 146                                    const char *connect_path)
 147 {
 148     return -EINVAL;
 149 }
 150
 151 /* Windows defines the 'optval' argument as char * instead of void *. */
 152 #define setsockopt(sock, level, optname, optval, optlen) \
 153     rpl_setsockopt(sock, level, optname, optval, optlen)
 154 static inline int rpl_setsockopt(int sock, int level, int optname,
 155                                  const void *optval, socklen_t optlen)
 156 {
 157     return (setsockopt)(sock, level, optname, (const char *)optval, optlen);
 158 }
 159
 160 #define getsockopt(sock, level, optname, optval, optlen) \
 161     rpl_getsockopt(sock, level, optname, optval, optlen)
 162 static inline int rpl_getsockopt(int sock, int level, int optname,
 163                                  void *optval, socklen_t *optlen)
 164 {
 165     return (getsockopt)(sock, level, optname, (char *)optval, optlen);
 166 }
 167 #endif
 168
 169 /* In Windows platform, errno is not set for socket calls.
 170  * The last error has to be gotten from WSAGetLastError(). */
 171 static inline int sock_errno(void)
 172 {
 173 #ifdef _WIN32
 174     return WSAGetLastError();
 175 #else
 176     return errno;
 177 #endif
 178 }
 179
 180 #endif /* socket-util.h */