lib/socket-util.c

   1 /*
   2  * Copyright (c) 2008, 2009 Nicira Networks.
   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 #include <config.h>
  18 #include "socket-util.h"
  19 #include <arpa/inet.h>
  20 #include <errno.h>
  21 #include <fcntl.h>
  22 #include <netdb.h>
  23 #include <poll.h>
  24 #include <stddef.h>
  25 #include <stdio.h>
  26 #include <stdlib.h>
  27 #include <string.h>
  28 #include <sys/resource.h>
  29 #include <sys/un.h>
  30 #include <unistd.h>
  31 #include "fatal-signal.h"
  32 #include "util.h"
  33
  34 #include "vlog.h"
  35 #define THIS_MODULE VLM_socket_util
  36
  37 /* Sets 'fd' to non-blocking mode.  Returns 0 if successful, otherwise a
  38  * positive errno value. */
  39 int
  40 set_nonblocking(int fd)
  41 {
  42     int flags = fcntl(fd, F_GETFL, 0);
  43     if (flags != -1) {
  44         if (fcntl(fd, F_SETFL, flags | O_NONBLOCK) != -1) {
  45             return 0;
  46         } else {
  47             VLOG_ERR("fcntl(F_SETFL) failed: %s", strerror(errno));
  48             return errno;
  49         }
  50     } else {
  51         VLOG_ERR("fcntl(F_GETFL) failed: %s", strerror(errno));
  52         return errno;
  53     }
  54 }
  55
  56 /* Returns the maximum valid FD value, plus 1. */
  57 int
  58 get_max_fds(void)
  59 {
  60     static int max_fds = -1;
  61     if (max_fds < 0) {
  62         struct rlimit r;
  63         if (!getrlimit(RLIMIT_NOFILE, &r)
  64             && r.rlim_cur != RLIM_INFINITY
  65             && r.rlim_cur != RLIM_SAVED_MAX
  66             && r.rlim_cur != RLIM_SAVED_CUR) {
  67             max_fds = r.rlim_cur;
  68         } else {
  69             VLOG_WARN("failed to obtain fd limit, defaulting to 1024");
  70             max_fds = 1024;
  71         }
  72     }
  73     return max_fds;
  74 }
  75
  76 /* Translates 'host_name', which must be a string representation of an IP
  77  * address, into a numeric IP address in '*addr'.  Returns 0 if successful,
  78  * otherwise a positive errno value. */
  79 int
  80 lookup_ip(const char *host_name, struct in_addr *addr)
  81 {
  82     if (!inet_aton(host_name, addr)) {
  83         struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
  84         VLOG_ERR_RL(&rl, "\"%s\" is not a valid IP address", host_name);
  85         return ENOENT;
  86     }
  87     return 0;
  88 }
  89
  90 /* Returns the error condition associated with socket 'fd' and resets the
  91  * socket's error status. */
  92 int
  93 get_socket_error(int fd)
  94 {
  95     int error;
  96     socklen_t len = sizeof(error);
  97     if (getsockopt(fd, SOL_SOCKET, SO_ERROR, &error, &len) < 0) {
  98         struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 10);
  99         error = errno;
 100         VLOG_ERR_RL(&rl, "getsockopt(SO_ERROR): %s", strerror(error));
 101     }
 102     return error;
 103 }
 104
 105 int
 106 check_connection_completion(int fd)
 107 {
 108     struct pollfd pfd;
 109     int retval;
 110
 111     pfd.fd = fd;
 112     pfd.events = POLLOUT;
 113     do {
 114         retval = poll(&pfd, 1, 0);
 115     } while (retval < 0 && errno == EINTR);
 116     if (retval == 1) {
 117         return get_socket_error(fd);
 118     } else if (retval < 0) {
 119         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 10);
 120         VLOG_ERR_RL(&rl, "poll: %s", strerror(errno));
 121         return errno;
 122     } else {
 123         return EAGAIN;
 124     }
 125 }
 126
 127 /* Drain all the data currently in the receive queue of a datagram socket (and
 128  * possibly additional data).  There is no way to know how many packets are in
 129  * the receive queue, but we do know that the total number of bytes queued does
 130  * not exceed the receive buffer size, so we pull packets until none are left
 131  * or we've read that many bytes. */
 132 int
 133 drain_rcvbuf(int fd)
 134 {
 135     socklen_t rcvbuf_len;
 136     size_t rcvbuf;
 137
 138     rcvbuf_len = sizeof rcvbuf;
 139     if (getsockopt(fd, SOL_SOCKET, SO_RCVBUF, &rcvbuf, &rcvbuf_len) < 0) {
 140         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 10);
 141         VLOG_ERR_RL(&rl, "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 /* Reads and discards up to 'n' datagrams from 'fd', stopping as soon as no
 170  * more data can be immediately read.  ('fd' should therefore be in
 171  * non-blocking mode.)*/
 172 void
 173 drain_fd(int fd, size_t n_packets)
 174 {
 175     for (; n_packets > 0; n_packets--) {
 176         /* 'buffer' only needs to be 1 byte long in most circumstances.  This
 177          * size is defensive against the possibility that we someday want to
 178          * use a Linux tap device without TUN_NO_PI, in which case a buffer
 179          * smaller than sizeof(struct tun_pi) will give EINVAL on read. */
 180         char buffer[128];
 181         if (read(fd, buffer, sizeof buffer) <= 0) {
 182             break;
 183         }
 184     }
 185 }
 186
 187 /* Stores in '*un' a sockaddr_un that refers to file 'name'.  Stores in
 188  * '*un_len' the size of the sockaddr_un. */
 189 static void
 190 make_sockaddr_un(const char *name, struct sockaddr_un* un, socklen_t *un_len)
 191 {
 192     un->sun_family = AF_UNIX;
 193     strncpy(un->sun_path, name, sizeof un->sun_path);
 194     un->sun_path[sizeof un->sun_path - 1] = '\0';
 195     *un_len = (offsetof(struct sockaddr_un, sun_path)
 196                 + strlen (un->sun_path) + 1);
 197 }
 198
 199 /* Creates a Unix domain socket in the given 'style' (either SOCK_DGRAM or
 200  * SOCK_STREAM) that is bound to '*bind_path' (if 'bind_path' is non-null) and
 201  * connected to '*connect_path' (if 'connect_path' is non-null).  If 'nonblock'
 202  * is true, the socket is made non-blocking.  If 'passcred' is true, the socket
 203  * is configured to receive SCM_CREDENTIALS control messages.
 204  *
 205  * Returns the socket's fd if successful, otherwise a negative errno value. */
 206 int
 207 make_unix_socket(int style, bool nonblock, bool passcred UNUSED,
 208                  const char *bind_path, const char *connect_path)
 209 {
 210     int error;
 211     int fd;
 212
 213     fd = socket(PF_UNIX, style, 0);
 214     if (fd < 0) {
 215         return -errno;
 216     }
 217
 218     /* Set nonblocking mode right away, if we want it.  This prevents blocking
 219      * in connect(), if connect_path != NULL.  (In turn, that's a corner case:
 220      * it will only happen if style is SOCK_STREAM or SOCK_SEQPACKET, and only
 221      * if a backlog of un-accepted connections has built up in the kernel.)  */
 222     if (nonblock) {
 223         int flags = fcntl(fd, F_GETFL, 0);
 224         if (flags == -1) {
 225             goto error;
 226         }
 227         if (fcntl(fd, F_SETFL, flags | O_NONBLOCK) == -1) {
 228             goto error;
 229         }
 230     }
 231
 232     if (bind_path) {
 233         struct sockaddr_un un;
 234         socklen_t un_len;
 235         make_sockaddr_un(bind_path, &un, &un_len);
 236         if (unlink(un.sun_path) && errno != ENOENT) {
 237             VLOG_WARN("unlinking \"%s\": %s\n", un.sun_path, strerror(errno));
 238         }
 239         fatal_signal_add_file_to_unlink(bind_path);
 240         if (bind(fd, (struct sockaddr*) &un, un_len)
 241             || fchmod(fd, S_IRWXU)) {
 242             goto error;
 243         }
 244     }
 245
 246     if (connect_path) {
 247         struct sockaddr_un un;
 248         socklen_t un_len;
 249         make_sockaddr_un(connect_path, &un, &un_len);
 250         if (connect(fd, (struct sockaddr*) &un, un_len)
 251             && errno != EINPROGRESS) {
 252             goto error;
 253         }
 254     }
 255
 256 #ifdef SCM_CREDENTIALS
 257     if (passcred) {
 258         int enable = 1;
 259         if (setsockopt(fd, SOL_SOCKET, SO_PASSCRED, &enable, sizeof(enable))) {
 260             goto error;
 261         }
 262     }
 263 #endif
 264
 265     return fd;
 266
 267 error:
 268     if (bind_path) {
 269         fatal_signal_remove_file_to_unlink(bind_path);
 270     }
 271     error = errno;
 272     close(fd);
 273     return -error;
 274 }
 275
 276 int
 277 get_unix_name_len(socklen_t sun_len)
 278 {
 279     return (sun_len >= offsetof(struct sockaddr_un, sun_path)
 280             ? sun_len - offsetof(struct sockaddr_un, sun_path)
 281             : 0);
 282 }
 283
 284 uint32_t
 285 guess_netmask(uint32_t ip)
 286 {
 287     ip = ntohl(ip);
 288     return ((ip >> 31) == 0 ? htonl(0xff000000)   /* Class A */
 289             : (ip >> 30) == 2 ? htonl(0xffff0000) /* Class B */
 290             : (ip >> 29) == 6 ? htonl(0xffffff00) /* Class C */
 291             : htonl(0));                          /* ??? */
 292 }
 293
 294 /* Opens a non-blocking TCP socket and connects to 'target', which should be a
 295  * string in the format "<host>[:<port>]", where <host> is required and <port>
 296  * is optional, with 'default_port' assumed if <port> is omitted.
 297  *
 298  * On success, returns 0 (indicating connection complete) or EAGAIN (indicating
 299  * connection in progress), in which case the new file descriptor is stored
 300  * into '*fdp'.  On failure, returns a positive errno value other than EAGAIN
 301  * and stores -1 into '*fdp'.
 302  *
 303  * If 'sinp' is non-null, then on success the target address is stored into
 304  * '*sinp'. */
 305 int
 306 tcp_open_active(const char *target_, uint16_t default_port,
 307                 struct sockaddr_in *sinp, int *fdp)
 308 {
 309     char *target = xstrdup(target_);
 310     char *save_ptr = NULL;
 311     const char *host_name;
 312     const char *port_string;
 313     struct sockaddr_in sin;
 314     int fd = -1;
 315     int error;
 316
 317     /* Defaults. */
 318     memset(&sin, 0, sizeof sin);
 319     sin.sin_family = AF_INET;
 320     sin.sin_port = htons(default_port);
 321
 322     /* Tokenize. */
 323     host_name = strtok_r(target, ":", &save_ptr);
 324     port_string = strtok_r(NULL, ":", &save_ptr);
 325     if (!host_name) {
 326         ovs_error(0, "%s: bad peer name format", target_);
 327         error = EAFNOSUPPORT;
 328         goto exit;
 329     }
 330
 331     /* Look up IP, port. */
 332     error = lookup_ip(host_name, &sin.sin_addr);
 333     if (error) {
 334         goto exit;
 335     }
 336     if (port_string && atoi(port_string)) {
 337         sin.sin_port = htons(atoi(port_string));
 338     }
 339
 340     /* Create non-blocking socket. */
 341     fd = socket(AF_INET, SOCK_STREAM, 0);
 342     if (fd < 0) {
 343         VLOG_ERR("%s: socket: %s", target_, strerror(errno));
 344         error = errno;
 345         goto exit;
 346     }
 347     error = set_nonblocking(fd);
 348     if (error) {
 349         goto exit_close;
 350     }
 351
 352     /* Connect. */
 353     error = connect(fd, (struct sockaddr *) &sin, sizeof sin) == 0 ? 0 : errno;
 354     if (error == EINPROGRESS) {
 355         error = EAGAIN;
 356     } else if (error && error != EAGAIN) {
 357         goto exit_close;
 358     }
 359
 360     /* Success: error is 0 or EAGAIN. */
 361     goto exit;
 362
 363 exit_close:
 364     close(fd);
 365 exit:
 366     if (!error || error == EAGAIN) {
 367         if (sinp) {
 368             *sinp = sin;
 369         }
 370         *fdp = fd;
 371     } else {
 372         *fdp = -1;
 373     }
 374     free(target);
 375     return error;
 376 }
 377
 378 /* Opens a non-blocking TCP socket, binds to 'target', and listens for incoming
 379  * connections.  'target' should be a string in the format "[<port>][:<ip>]",
 380  * where both <port> and <ip> are optional.  If <port> is omitted, it defaults
 381  * to 'default_port'; if <ip> is omitted it defaults to the wildcard IP
 382  * address.
 383  *
 384  * The socket will have SO_REUSEADDR turned on.
 385  *
 386  * On success, returns a non-negative file descriptor.  On failure, returns a
 387  * negative errno value. */
 388 int
 389 tcp_open_passive(const char *target_, uint16_t default_port)
 390 {
 391     char *target = xstrdup(target_);
 392     char *string_ptr = target;
 393     struct sockaddr_in sin;
 394     const char *host_name;
 395     const char *port_string;
 396     int fd, error;
 397     unsigned int yes  = 1;
 398
 399     /* Address defaults. */
 400     memset(&sin, 0, sizeof sin);
 401     sin.sin_family = AF_INET;
 402     sin.sin_addr.s_addr = htonl(INADDR_ANY);
 403     sin.sin_port = htons(default_port);
 404
 405     /* Parse optional port number. */
 406     port_string = strsep(&string_ptr, ":");
 407     if (port_string && atoi(port_string)) {
 408         sin.sin_port = htons(atoi(port_string));
 409     }
 410
 411     /* Parse optional bind IP. */
 412     host_name = strsep(&string_ptr, ":");
 413     if (host_name && host_name[0]) {
 414         error = lookup_ip(host_name, &sin.sin_addr);
 415         if (error) {
 416             goto exit;
 417         }
 418     }
 419
 420     /* Create non-blocking socket, set SO_REUSEADDR. */
 421     fd = socket(AF_INET, SOCK_STREAM, 0);
 422     if (fd < 0) {
 423         error = errno;
 424         VLOG_ERR("%s: socket: %s", target_, strerror(error));
 425         goto exit;
 426     }
 427     error = set_nonblocking(fd);
 428     if (error) {
 429         goto exit_close;
 430     }
 431     if (setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &yes, sizeof yes) < 0) {
 432         error = errno;
 433         VLOG_ERR("%s: setsockopt(SO_REUSEADDR): %s", target_, strerror(error));
 434         goto exit_close;
 435     }
 436
 437     /* Bind. */
 438     if (bind(fd, (struct sockaddr *) &sin, sizeof sin) < 0) {
 439         error = errno;
 440         VLOG_ERR("%s: bind: %s", target_, strerror(error));
 441         goto exit_close;
 442     }
 443
 444     /* Listen. */
 445     if (listen(fd, 10) < 0) {
 446         error = errno;
 447         VLOG_ERR("%s: listen: %s", target_, strerror(error));
 448         goto exit_close;
 449     }
 450     error = 0;
 451     goto exit;
 452
 453 exit_close:
 454     close(fd);
 455 exit:
 456     free(target);
 457     return error ? -error : fd;
 458 }
 459
 460 /* Returns a readable and writable fd for /dev/null, if successful, otherwise
 461  * a negative errno value.  The caller must not close the returned fd (because
 462  * the same fd will be handed out to subsequent callers). */
 463 int
 464 get_null_fd(void)
 465 {
 466     static int null_fd = -1;
 467     if (null_fd < 0) {
 468         null_fd = open("/dev/null", O_RDWR);
 469         if (null_fd < 0) {
 470             int error = errno;
 471             VLOG_ERR("could not open /dev/null: %s", strerror(error));
 472             return -error;
 473         }
 474     }
 475     return null_fd;
 476 }
 477
 478 int
 479 read_fully(int fd, void *p_, size_t size, size_t *bytes_read)
 480 {
 481     uint8_t *p = p_;
 482
 483     *bytes_read = 0;
 484     while (size > 0) {
 485         ssize_t retval = read(fd, p, size);
 486         if (retval > 0) {
 487             *bytes_read += retval;
 488             size -= retval;
 489             p += retval;
 490         } else if (retval == 0) {
 491             return EOF;
 492         } else if (errno != EINTR) {
 493             return errno;
 494         }
 495     }
 496     return 0;
 497 }
 498
 499 int
 500 write_fully(int fd, const void *p_, size_t size, size_t *bytes_written)
 501 {
 502     const uint8_t *p = p_;
 503
 504     *bytes_written = 0;
 505     while (size > 0) {
 506         ssize_t retval = write(fd, p, size);
 507         if (retval > 0) {
 508             *bytes_written += retval;
 509             size -= retval;
 510             p += retval;
 511         } else if (retval == 0) {
 512             VLOG_WARN("write returned 0");
 513             return EPROTO;
 514         } else if (errno != EINTR) {
 515             return errno;
 516         }
 517     }
 518     return 0;
 519 }