lib/socket-util.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015 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 <netinet/in.h>
  25 #include <stdbool.h>
  26 #include "openvswitch/types.h"
  27 #include <netinet/in_systm.h>
  28 #include <netinet/ip.h>
  29
  30 int set_nonblocking(int fd);
  31 void xset_nonblocking(int fd);
  32 void setsockopt_tcp_nodelay(int fd);
  33 int set_dscp(int fd, int family, uint8_t dscp);
  34
  35 bool addr_is_ipv6(const char *host_name);
  36 int lookup_ip(const char *host_name, struct in_addr *address);
  37 int lookup_ipv6(const char *host_name, struct in6_addr *address);
  38
  39 int lookup_hostname(const char *host_name, struct in_addr *);
  40
  41 int get_socket_rcvbuf(int sock);
  42 int check_connection_completion(int fd);
  43 void drain_fd(int fd, size_t n_packets);
  44 ovs_be32 guess_netmask(ovs_be32 ip);
  45
  46 bool inet_parse_active(const char *target, uint16_t default_port,
  47                        struct sockaddr_storage *ssp);
  48 int inet_open_active(int style, const char *target, uint16_t default_port,
  49                      struct sockaddr_storage *ssp, int *fdp, uint8_t dscp);
  50
  51 bool inet_parse_passive(const char *target, int default_port,
  52                         struct sockaddr_storage *ssp);
  53 int inet_open_passive(int style, const char *target, int default_port,
  54                       struct sockaddr_storage *ssp, uint8_t dscp,
  55                       bool kernel_print_port);
  56
  57 int read_fully(int fd, void *, size_t, size_t *bytes_read);
  58 int write_fully(int fd, const void *, size_t, size_t *bytes_written);
  59
  60 int fsync_parent_dir(const char *file_name);
  61 int get_mtime(const char *file_name, struct timespec *mtime);
  62
  63 char *describe_fd(int fd);
  64
  65 /* Default value of dscp bits for connection between controller and manager.
  66  * Value of IPTOS_PREC_INTERNETCONTROL = 0xc0 which is defined
  67  * in <netinet/ip.h> is used. */
  68 #define DSCP_DEFAULT (IPTOS_PREC_INTERNETCONTROL >> 2)
  69
  70 /* Functions for working with sockaddr_storage that might contain an IPv4 or
  71  * IPv6 address. */
  72 uint16_t ss_get_port(const struct sockaddr_storage *);
  73 #define SS_NTOP_BUFSIZE (1 + INET6_ADDRSTRLEN + 1)
  74 char *ss_format_address(const struct sockaddr_storage *,
  75                         char *buf, size_t bufsize);
  76 size_t ss_length(const struct sockaddr_storage *);
  77 const char *sock_strerror(int error);
  78
  79 #ifndef _WIN32
  80 void xpipe(int fds[2]);
  81 void xpipe_nonblocking(int fds[2]);
  82
  83 int drain_rcvbuf(int fd);
  84
  85 int make_unix_socket(int style, bool nonblock,
  86                      const char *bind_path, const char *connect_path);
  87 int get_unix_name_len(socklen_t sun_len);
  88
  89 /* Helpers for calling ioctl() on an AF_INET socket. */
  90 struct ifreq;
  91 int af_inet_ioctl(unsigned long int command, const void *arg);
  92 int af_inet_ifreq_ioctl(const char *name, struct ifreq *,
  93                         unsigned long int cmd, const char *cmd_name);
  94
  95 #define closesocket close
  96 #endif
  97
  98 #ifdef _WIN32
  99 static inline int make_unix_socket(int style, bool nonblock,
 100                                    const char *bind_path,
 101                                    const char *connect_path)
 102 {
 103     return -EINVAL;
 104 }
 105
 106 /* Windows defines the 'optval' argument as char * instead of void *. */
 107 #define setsockopt(sock, level, optname, optval, optlen) \
 108     rpl_setsockopt(sock, level, optname, optval, optlen)
 109 static inline int rpl_setsockopt(int sock, int level, int optname,
 110                                  const void *optval, socklen_t optlen)
 111 {
 112     return (setsockopt)(sock, level, optname, optval, optlen);
 113 }
 114
 115 #define getsockopt(sock, level, optname, optval, optlen) \
 116     rpl_getsockopt(sock, level, optname, optval, optlen)
 117 static inline int rpl_getsockopt(int sock, int level, int optname,
 118                                  void *optval, socklen_t *optlen)
 119 {
 120     return (getsockopt)(sock, level, optname, optval, optlen);
 121 }
 122 #endif
 123
 124 /* In Windows platform, errno is not set for socket calls.
 125  * The last error has to be gotten from WSAGetLastError(). */
 126 static inline int sock_errno(void)
 127 {
 128 #ifdef _WIN32
 129     return WSAGetLastError();
 130 #else
 131     return errno;
 132 #endif
 133 }
 134
 135 #endif /* socket-util.h */