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             VLOG_ERR("gethostbyname(%s): %s", host_name,
  81                      (h_errno == HOST_NOT_FOUND ? "host not found"
  82                       : h_errno == TRY_AGAIN ? "try again"
  83                       : h_errno == NO_RECOVERY ? "non-recoverable error"
  84                       : h_errno == NO_ADDRESS ? "no address"
  85                       : "unknown error"));
  86             return ENOENT;
  87         }
  88         addr->s_addr = *(uint32_t *) he->h_addr;
  89     }
  90     return 0;
  91 }
  92
  93 /* Returns the error condition associated with socket 'fd' and resets the
  94  * socket's error status. */
  95 int
  96 get_socket_error(int fd)
  97 {
  98     int error;
  99     socklen_t len = sizeof(error);
 100     if (getsockopt(fd, SOL_SOCKET, SO_ERROR, &error, &len) < 0) {
 101         error = errno;
 102         VLOG_ERR("getsockopt(SO_ERROR): %s", strerror(error));
 103     }
 104     return error;
 105 }
 106
 107 int
 108 check_connection_completion(int fd)
 109 {
 110     struct pollfd pfd;
 111     int retval;
 112
 113     pfd.fd = fd;
 114     pfd.events = POLLOUT;
 115     do {
 116         retval = poll(&pfd, 1, 0);
 117     } while (retval < 0 && errno == EINTR);
 118     if (retval == 1) {
 119         return get_socket_error(fd);
 120     } else if (retval < 0) {
 121         VLOG_ERR("poll: %s", strerror(errno));
 122         return errno;
 123     } else {
 124         return EAGAIN;
 125     }
 126 }
 127
 128 /* Drain all the data currently in the receive queue of a datagram socket (and
 129  * possibly additional data).  There is no way to know how many packets are in
 130  * the receive queue, but we do know that the total number of bytes queued does
 131  * not exceed the receive buffer size, so we pull packets until none are left
 132  * or we've read that many bytes. */
 133 int
 134 drain_rcvbuf(int fd)
 135 {
 136     socklen_t rcvbuf_len;
 137     size_t rcvbuf;
 138
 139     rcvbuf_len = sizeof rcvbuf;
 140     if (getsockopt(fd, SOL_SOCKET, SO_RCVBUF, &rcvbuf, &rcvbuf_len) < 0) {
 141         VLOG_ERR("getsockopt(SO_RCVBUF) failed: %s", strerror(errno));
 142         return errno;
 143     }
 144     while (rcvbuf > 0) {
 145         /* In Linux, specifying MSG_TRUNC in the flags argument causes the
 146          * datagram length to be returned, even if that is longer than the
 147          * buffer provided.  Thus, we can use a 1-byte buffer to discard the
 148          * incoming datagram and still be able to account how many bytes were
 149          * removed from the receive buffer.
 150          *
 151          * On other Unix-like OSes, MSG_TRUNC has no effect in the flags
 152          * argument. */
 153 #ifdef __linux__
 154 #define BUFFER_SIZE 1
 155 #else
 156 #define BUFFER_SIZE 2048
 157 #endif
 158         char buffer[BUFFER_SIZE];
 159         ssize_t n_bytes = recv(fd, buffer, sizeof buffer,
 160                                MSG_TRUNC | MSG_DONTWAIT);
 161         if (n_bytes <= 0 || n_bytes >= rcvbuf) {
 162             break;
 163         }
 164         rcvbuf -= n_bytes;
 165     }
 166     return 0;
 167 }
 168
 169 /* Stores in '*un' a sockaddr_un that refers to file 'name'.  Stores in
 170  * '*un_len' the size of the sockaddr_un. */
 171 static void
 172 make_sockaddr_un(const char *name, struct sockaddr_un* un, socklen_t *un_len)
 173 {
 174     un->sun_family = AF_UNIX;
 175     strncpy(un->sun_path, name, sizeof un->sun_path);
 176     un->sun_path[sizeof un->sun_path - 1] = '\0';
 177     *un_len = (offsetof(struct sockaddr_un, sun_path)
 178                 + strlen (un->sun_path) + 1);
 179 }
 180
 181 /* Creates a Unix domain socket in the given 'style' (either SOCK_DGRAM or
 182  * SOCK_STREAM) that is bound to '*bind_path' (if 'bind_path' is non-null) and
 183  * connected to '*connect_path' (if 'connect_path' is non-null).  If 'nonblock'
 184  * is true, the socket is made non-blocking.  If 'passcred' is true, the socket
 185  * is configured to receive SCM_CREDENTIALS control messages.
 186  *
 187  * Returns the socket's fd if successful, otherwise a negative errno value. */
 188 int
 189 make_unix_socket(int style, bool nonblock, bool passcred UNUSED,
 190                  const char *bind_path, const char *connect_path)
 191 {
 192     int error;
 193     int fd;
 194
 195     fd = socket(PF_UNIX, style, 0);
 196     if (fd < 0) {
 197         return -errno;
 198     }
 199
 200     if (nonblock) {
 201         int flags = fcntl(fd, F_GETFL, 0);
 202         if (flags == -1) {
 203             goto error;
 204         }
 205         if (fcntl(fd, F_SETFL, flags | O_NONBLOCK) == -1) {
 206             goto error;
 207         }
 208     }
 209
 210     if (bind_path) {
 211         struct sockaddr_un un;
 212         socklen_t un_len;
 213         make_sockaddr_un(bind_path, &un, &un_len);
 214         if (unlink(un.sun_path) && errno != ENOENT) {
 215             VLOG_WARN("unlinking \"%s\": %s\n", un.sun_path, strerror(errno));
 216         }
 217         fatal_signal_add_file_to_unlink(bind_path);
 218         if (bind(fd, (struct sockaddr*) &un, un_len)
 219             || fchmod(fd, S_IRWXU)) {
 220             goto error;
 221         }
 222     }
 223
 224     if (connect_path) {
 225         struct sockaddr_un un;
 226         socklen_t un_len;
 227         make_sockaddr_un(connect_path, &un, &un_len);
 228         if (connect(fd, (struct sockaddr*) &un, un_len)
 229             && errno != EINPROGRESS) {
 230             goto error;
 231         }
 232     }
 233
 234 #ifdef SCM_CREDENTIALS
 235     if (passcred) {
 236         int enable = 1;
 237         if (setsockopt(fd, SOL_SOCKET, SO_PASSCRED, &enable, sizeof(enable))) {
 238             goto error;
 239         }
 240     }
 241 #endif
 242
 243     return fd;
 244
 245 error:
 246     if (bind_path) {
 247         fatal_signal_remove_file_to_unlink(bind_path);
 248     }
 249     error = errno;
 250     close(fd);
 251     return -error;
 252 }