lib/socket-util.c

   1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
   2  * Junior University
   3  *
   4  * We are making the OpenFlow specification and associated documentation
   5  * (Software) available for public use and benefit with the expectation
   6  * that others will use, modify and enhance the Software and contribute
   7  * those enhancements back to the community. However, since we would
   8  * like to make the Software available for broadest use, with as few
   9  * restrictions as possible permission is hereby granted, free of
  10  * charge, to any person obtaining a copy of this Software to deal in
  11  * the Software under the copyrights without restriction, including
  12  * without limitation the rights to use, copy, modify, merge, publish,
  13  * distribute, sublicense, and/or sell copies of the Software, and to
  14  * permit persons to whom the Software is furnished to do so, subject to
  15  * the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be
  18  * included in all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  24  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  25  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  26  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  *
  29  * The name and trademarks of copyright holder(s) may NOT be used in
  30  * advertising or publicity pertaining to the Software or any
  31  * derivatives without specific, written prior permission.
  32  */
  33
  34 #include <config.h>
  35 #include "socket-util.h"
  36 #include <arpa/inet.h>
  37 #include <errno.h>
  38 #include <fcntl.h>
  39 #include <netdb.h>
  40 #include <poll.h>
  41 #include <stddef.h>
  42 #include <stdio.h>
  43 #include <string.h>
  44 #include <sys/un.h>
  45 #include <unistd.h>
  46 #include "fatal-signal.h"
  47 #include "util.h"
  48
  49 #include "vlog.h"
  50 #define THIS_MODULE VLM_socket_util
  51
  52 /* Sets 'fd' to non-blocking mode.  Returns 0 if successful, otherwise a
  53  * positive errno value. */
  54 int
  55 set_nonblocking(int fd)
  56 {
  57     int flags = fcntl(fd, F_GETFL, 0);
  58     if (flags != -1) {
  59         if (fcntl(fd, F_SETFL, flags | O_NONBLOCK) != -1) {
  60             return 0;
  61         } else {
  62             VLOG_ERR("fcntl(F_SETFL) failed: %s", strerror(errno));
  63             return errno;
  64         }
  65     } else {
  66         VLOG_ERR("fcntl(F_GETFL) failed: %s", strerror(errno));
  67         return errno;
  68     }
  69 }
  70
  71 /* Translates 'host_name', which may be a DNS name or an IP address, into a
  72  * numeric IP address in '*addr'.  Returns 0 if successful, otherwise a
  73  * positive errno value. */
  74 int
  75 lookup_ip(const char *host_name, struct in_addr *addr)
  76 {
  77     if (!inet_aton(host_name, addr)) {
  78         struct hostent *he = gethostbyname(host_name);
  79         if (he == NULL) {
  80             struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
  81             VLOG_ERR_RL(&rl, "gethostbyname(%s): %s", host_name,
  82                         (h_errno == HOST_NOT_FOUND ? "host not found"
  83                          : h_errno == TRY_AGAIN ? "try again"
  84                          : h_errno == NO_RECOVERY ? "non-recoverable error"
  85                          : h_errno == NO_ADDRESS ? "no address"
  86                          : "unknown error"));
  87             return ENOENT;
  88         }
  89         addr->s_addr = *(uint32_t *) he->h_addr;
  90     }
  91     return 0;
  92 }
  93
  94 /* Returns the error condition associated with socket 'fd' and resets the
  95  * socket's error status. */
  96 int
  97 get_socket_error(int fd)
  98 {
  99     int error;
 100     socklen_t len = sizeof(error);
 101     if (getsockopt(fd, SOL_SOCKET, SO_ERROR, &error, &len) < 0) {
 102         struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 10);
 103         error = errno;
 104         VLOG_ERR_RL(&rl, "getsockopt(SO_ERROR): %s", strerror(error));
 105     }
 106     return error;
 107 }
 108
 109 int
 110 check_connection_completion(int fd)
 111 {
 112     struct pollfd pfd;
 113     int retval;
 114
 115     pfd.fd = fd;
 116     pfd.events = POLLOUT;
 117     do {
 118         retval = poll(&pfd, 1, 0);
 119     } while (retval < 0 && errno == EINTR);
 120     if (retval == 1) {
 121         return get_socket_error(fd);
 122     } else if (retval < 0) {
 123         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 10);
 124         VLOG_ERR_RL(&rl, "poll: %s", strerror(errno));
 125         return errno;
 126     } else {
 127         return EAGAIN;
 128     }
 129 }
 130
 131 /* Drain all the data currently in the receive queue of a datagram socket (and
 132  * possibly additional data).  There is no way to know how many packets are in
 133  * the receive queue, but we do know that the total number of bytes queued does
 134  * not exceed the receive buffer size, so we pull packets until none are left
 135  * or we've read that many bytes. */
 136 int
 137 drain_rcvbuf(int fd)
 138 {
 139     socklen_t rcvbuf_len;
 140     size_t rcvbuf;
 141
 142     rcvbuf_len = sizeof rcvbuf;
 143     if (getsockopt(fd, SOL_SOCKET, SO_RCVBUF, &rcvbuf, &rcvbuf_len) < 0) {
 144         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 10);
 145         VLOG_ERR_RL(&rl, "getsockopt(SO_RCVBUF) failed: %s", strerror(errno));
 146         return errno;
 147     }
 148     while (rcvbuf > 0) {
 149         /* In Linux, specifying MSG_TRUNC in the flags argument causes the
 150          * datagram length to be returned, even if that is longer than the
 151          * buffer provided.  Thus, we can use a 1-byte buffer to discard the
 152          * incoming datagram and still be able to account how many bytes were
 153          * removed from the receive buffer.
 154          *
 155          * On other Unix-like OSes, MSG_TRUNC has no effect in the flags
 156          * argument. */
 157 #ifdef __linux__
 158 #define BUFFER_SIZE 1
 159 #else
 160 #define BUFFER_SIZE 2048
 161 #endif
 162         char buffer[BUFFER_SIZE];
 163         ssize_t n_bytes = recv(fd, buffer, sizeof buffer,
 164                                MSG_TRUNC | MSG_DONTWAIT);
 165         if (n_bytes <= 0 || n_bytes >= rcvbuf) {
 166             break;
 167         }
 168         rcvbuf -= n_bytes;
 169     }
 170     return 0;
 171 }
 172
 173 /* Reads and discards up to 'n' datagrams from 'fd', stopping as soon as no
 174  * more data can be immediately read.  ('fd' should therefore be in
 175  * non-blocking mode.)*/
 176 void
 177 drain_fd(int fd, size_t n_packets)
 178 {
 179     for (; n_packets > 0; n_packets--) {
 180         /* 'buffer' only needs to be 1 byte long in most circumstances.  This
 181          * size is defensive against the possibility that we someday want to
 182          * use a Linux tap device without TUN_NO_PI, in which case a buffer
 183          * smaller than sizeof(struct tun_pi) will give EINVAL on read. */
 184         char buffer[128];
 185         if (read(fd, buffer, sizeof buffer) <= 0) {
 186             break;
 187         }
 188     }
 189 }
 190
 191 /* Stores in '*un' a sockaddr_un that refers to file 'name'.  Stores in
 192  * '*un_len' the size of the sockaddr_un. */
 193 static void
 194 make_sockaddr_un(const char *name, struct sockaddr_un* un, socklen_t *un_len)
 195 {
 196     un->sun_family = AF_UNIX;
 197     strncpy(un->sun_path, name, sizeof un->sun_path);
 198     un->sun_path[sizeof un->sun_path - 1] = '\0';
 199     *un_len = (offsetof(struct sockaddr_un, sun_path)
 200                 + strlen (un->sun_path) + 1);
 201 }
 202
 203 /* Creates a Unix domain socket in the given 'style' (either SOCK_DGRAM or
 204  * SOCK_STREAM) that is bound to '*bind_path' (if 'bind_path' is non-null) and
 205  * connected to '*connect_path' (if 'connect_path' is non-null).  If 'nonblock'
 206  * is true, the socket is made non-blocking.  If 'passcred' is true, the socket
 207  * is configured to receive SCM_CREDENTIALS control messages.
 208  *
 209  * Returns the socket's fd if successful, otherwise a negative errno value. */
 210 int
 211 make_unix_socket(int style, bool nonblock, bool passcred UNUSED,
 212                  const char *bind_path, const char *connect_path)
 213 {
 214     int error;
 215     int fd;
 216
 217     fd = socket(PF_UNIX, style, 0);
 218     if (fd < 0) {
 219         return -errno;
 220     }
 221
 222     /* Set nonblocking mode right away, if we want it.  This prevents blocking
 223      * in connect(), if connect_path != NULL.  (In turn, that's a corner case:
 224      * it will only happen if style is SOCK_STREAM or SOCK_SEQPACKET, and only
 225      * if a backlog of un-accepted connections has built up in the kernel.)  */
 226     if (nonblock) {
 227         int flags = fcntl(fd, F_GETFL, 0);
 228         if (flags == -1) {
 229             goto error;
 230         }
 231         if (fcntl(fd, F_SETFL, flags | O_NONBLOCK) == -1) {
 232             goto error;
 233         }
 234     }
 235
 236     if (bind_path) {
 237         struct sockaddr_un un;
 238         socklen_t un_len;
 239         make_sockaddr_un(bind_path, &un, &un_len);
 240         if (unlink(un.sun_path) && errno != ENOENT) {
 241             VLOG_WARN("unlinking \"%s\": %s\n", un.sun_path, strerror(errno));
 242         }
 243         fatal_signal_add_file_to_unlink(bind_path);
 244         if (bind(fd, (struct sockaddr*) &un, un_len)
 245             || fchmod(fd, S_IRWXU)) {
 246             goto error;
 247         }
 248     }
 249
 250     if (connect_path) {
 251         struct sockaddr_un un;
 252         socklen_t un_len;
 253         make_sockaddr_un(connect_path, &un, &un_len);
 254         if (connect(fd, (struct sockaddr*) &un, un_len)
 255             && errno != EINPROGRESS) {
 256             goto error;
 257         }
 258     }
 259
 260 #ifdef SCM_CREDENTIALS
 261     if (passcred) {
 262         int enable = 1;
 263         if (setsockopt(fd, SOL_SOCKET, SO_PASSCRED, &enable, sizeof(enable))) {
 264             goto error;
 265         }
 266     }
 267 #endif
 268
 269     return fd;
 270
 271 error:
 272     if (bind_path) {
 273         fatal_signal_remove_file_to_unlink(bind_path);
 274     }
 275     error = errno;
 276     close(fd);
 277     return -error;
 278 }
 279
 280 int
 281 get_unix_name_len(socklen_t sun_len)
 282 {
 283     return (sun_len >= offsetof(struct sockaddr_un, sun_path)
 284             ? sun_len - offsetof(struct sockaddr_un, sun_path)
 285             : 0);
 286 }