lib/socket-util.h

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