lib/socket-util.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010 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/socket.h>
  30 #include <sys/stat.h>
  31 #include <sys/un.h>
  32 #include <unistd.h>
  33 #include "fatal-signal.h"
  34 #include "util.h"
  35 #include "vlog.h"
  36
  37 VLOG_DEFINE_THIS_MODULE(socket_util)
  38
  39 /* Sets 'fd' to non-blocking mode.  Returns 0 if successful, otherwise a
  40  * positive errno value. */
  41 int
  42 set_nonblocking(int fd)
  43 {
  44     int flags = fcntl(fd, F_GETFL, 0);
  45     if (flags != -1) {
  46         if (fcntl(fd, F_SETFL, flags | O_NONBLOCK) != -1) {
  47             return 0;
  48         } else {
  49             VLOG_ERR("fcntl(F_SETFL) failed: %s", strerror(errno));
  50             return errno;
  51         }
  52     } else {
  53         VLOG_ERR("fcntl(F_GETFL) failed: %s", strerror(errno));
  54         return errno;
  55     }
  56 }
  57
  58 static bool
  59 rlim_is_finite(rlim_t limit)
  60 {
  61     if (limit == RLIM_INFINITY) {
  62         return false;
  63     }
  64
  65 #ifdef RLIM_SAVED_CUR           /* FreeBSD 8.0 lacks RLIM_SAVED_CUR. */
  66     if (limit == RLIM_SAVED_CUR) {
  67         return false;
  68     }
  69 #endif
  70
  71 #ifdef RLIM_SAVED_MAX           /* FreeBSD 8.0 lacks RLIM_SAVED_MAX. */
  72     if (limit == RLIM_SAVED_MAX) {
  73         return false;
  74     }
  75 #endif
  76
  77     return true;
  78 }
  79
  80 /* Returns the maximum valid FD value, plus 1. */
  81 int
  82 get_max_fds(void)
  83 {
  84     static int max_fds = -1;
  85     if (max_fds < 0) {
  86         struct rlimit r;
  87         if (!getrlimit(RLIMIT_NOFILE, &r) && rlim_is_finite(r.rlim_cur)) {
  88             max_fds = r.rlim_cur;
  89         } else {
  90             VLOG_WARN("failed to obtain fd limit, defaulting to 1024");
  91             max_fds = 1024;
  92         }
  93     }
  94     return max_fds;
  95 }
  96
  97 /* Translates 'host_name', which must be a string representation of an IP
  98  * address, into a numeric IP address in '*addr'.  Returns 0 if successful,
  99  * otherwise a positive errno value. */
 100 int
 101 lookup_ip(const char *host_name, struct in_addr *addr)
 102 {
 103     if (!inet_aton(host_name, addr)) {
 104         struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
 105         VLOG_ERR_RL(&rl, "\"%s\" is not a valid IP address", host_name);
 106         return ENOENT;
 107     }
 108     return 0;
 109 }
 110
 111 /* Returns the error condition associated with socket 'fd' and resets the
 112  * socket's error status. */
 113 int
 114 get_socket_error(int fd)
 115 {
 116     int error;
 117     socklen_t len = sizeof(error);
 118     if (getsockopt(fd, SOL_SOCKET, SO_ERROR, &error, &len) < 0) {
 119         struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 10);
 120         error = errno;
 121         VLOG_ERR_RL(&rl, "getsockopt(SO_ERROR): %s", strerror(error));
 122     }
 123     return error;
 124 }
 125
 126 int
 127 check_connection_completion(int fd)
 128 {
 129     struct pollfd pfd;
 130     int retval;
 131
 132     pfd.fd = fd;
 133     pfd.events = POLLOUT;
 134     do {
 135         retval = poll(&pfd, 1, 0);
 136     } while (retval < 0 && errno == EINTR);
 137     if (retval == 1) {
 138         return get_socket_error(fd);
 139     } else if (retval < 0) {
 140         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 10);
 141         VLOG_ERR_RL(&rl, "poll: %s", strerror(errno));
 142         return errno;
 143     } else {
 144         return EAGAIN;
 145     }
 146 }
 147
 148 /* Drain all the data currently in the receive queue of a datagram socket (and
 149  * possibly additional data).  There is no way to know how many packets are in
 150  * the receive queue, but we do know that the total number of bytes queued does
 151  * not exceed the receive buffer size, so we pull packets until none are left
 152  * or we've read that many bytes. */
 153 int
 154 drain_rcvbuf(int fd)
 155 {
 156     socklen_t rcvbuf_len;
 157     size_t rcvbuf;
 158
 159     rcvbuf_len = sizeof rcvbuf;
 160     if (getsockopt(fd, SOL_SOCKET, SO_RCVBUF, &rcvbuf, &rcvbuf_len) < 0) {
 161         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 10);
 162         VLOG_ERR_RL(&rl, "getsockopt(SO_RCVBUF) failed: %s", strerror(errno));
 163         return errno;
 164     }
 165     while (rcvbuf > 0) {
 166         /* In Linux, specifying MSG_TRUNC in the flags argument causes the
 167          * datagram length to be returned, even if that is longer than the
 168          * buffer provided.  Thus, we can use a 1-byte buffer to discard the
 169          * incoming datagram and still be able to account how many bytes were
 170          * removed from the receive buffer.
 171          *
 172          * On other Unix-like OSes, MSG_TRUNC has no effect in the flags
 173          * argument. */
 174 #ifdef __linux__
 175 #define BUFFER_SIZE 1
 176 #else
 177 #define BUFFER_SIZE 2048
 178 #endif
 179         char buffer[BUFFER_SIZE];
 180         ssize_t n_bytes = recv(fd, buffer, sizeof buffer,
 181                                MSG_TRUNC | MSG_DONTWAIT);
 182         if (n_bytes <= 0 || n_bytes >= rcvbuf) {
 183             break;
 184         }
 185         rcvbuf -= n_bytes;
 186     }
 187     return 0;
 188 }
 189
 190 /* Reads and discards up to 'n' datagrams from 'fd', stopping as soon as no
 191  * more data can be immediately read.  ('fd' should therefore be in
 192  * non-blocking mode.)*/
 193 void
 194 drain_fd(int fd, size_t n_packets)
 195 {
 196     for (; n_packets > 0; n_packets--) {
 197         /* 'buffer' only needs to be 1 byte long in most circumstances.  This
 198          * size is defensive against the possibility that we someday want to
 199          * use a Linux tap device without TUN_NO_PI, in which case a buffer
 200          * smaller than sizeof(struct tun_pi) will give EINVAL on read. */
 201         char buffer[128];
 202         if (read(fd, buffer, sizeof buffer) <= 0) {
 203             break;
 204         }
 205     }
 206 }
 207
 208 /* Stores in '*un' a sockaddr_un that refers to file 'name'.  Stores in
 209  * '*un_len' the size of the sockaddr_un. */
 210 static void
 211 make_sockaddr_un(const char *name, struct sockaddr_un* un, socklen_t *un_len)
 212 {
 213     un->sun_family = AF_UNIX;
 214     strncpy(un->sun_path, name, sizeof un->sun_path);
 215     un->sun_path[sizeof un->sun_path - 1] = '\0';
 216     *un_len = (offsetof(struct sockaddr_un, sun_path)
 217                 + strlen (un->sun_path) + 1);
 218 }
 219
 220 /* Creates a Unix domain socket in the given 'style' (either SOCK_DGRAM or
 221  * SOCK_STREAM) that is bound to '*bind_path' (if 'bind_path' is non-null) and
 222  * connected to '*connect_path' (if 'connect_path' is non-null).  If 'nonblock'
 223  * is true, the socket is made non-blocking.  If 'passcred' is true, the socket
 224  * is configured to receive SCM_CREDENTIALS control messages.
 225  *
 226  * Returns the socket's fd if successful, otherwise a negative errno value. */
 227 int
 228 make_unix_socket(int style, bool nonblock, bool passcred OVS_UNUSED,
 229                  const char *bind_path, const char *connect_path)
 230 {
 231     int error;
 232     int fd;
 233
 234     fd = socket(PF_UNIX, style, 0);
 235     if (fd < 0) {
 236         return -errno;
 237     }
 238
 239     /* Set nonblocking mode right away, if we want it.  This prevents blocking
 240      * in connect(), if connect_path != NULL.  (In turn, that's a corner case:
 241      * it will only happen if style is SOCK_STREAM or SOCK_SEQPACKET, and only
 242      * if a backlog of un-accepted connections has built up in the kernel.)  */
 243     if (nonblock) {
 244         int flags = fcntl(fd, F_GETFL, 0);
 245         if (flags == -1) {
 246             goto error;
 247         }
 248         if (fcntl(fd, F_SETFL, flags | O_NONBLOCK) == -1) {
 249             goto error;
 250         }
 251     }
 252
 253     if (bind_path) {
 254         struct sockaddr_un un;
 255         socklen_t un_len;
 256         make_sockaddr_un(bind_path, &un, &un_len);
 257         if (unlink(un.sun_path) && errno != ENOENT) {
 258             VLOG_WARN("unlinking \"%s\": %s\n", un.sun_path, strerror(errno));
 259         }
 260         fatal_signal_add_file_to_unlink(bind_path);
 261         if (bind(fd, (struct sockaddr*) &un, un_len)
 262             || fchmod(fd, S_IRWXU)) {
 263             goto error;
 264         }
 265     }
 266
 267     if (connect_path) {
 268         struct sockaddr_un un;
 269         socklen_t un_len;
 270         make_sockaddr_un(connect_path, &un, &un_len);
 271         if (connect(fd, (struct sockaddr*) &un, un_len)
 272             && errno != EINPROGRESS) {
 273             goto error;
 274         }
 275     }
 276
 277 #ifdef SCM_CREDENTIALS
 278     if (passcred) {
 279         int enable = 1;
 280         if (setsockopt(fd, SOL_SOCKET, SO_PASSCRED, &enable, sizeof(enable))) {
 281             goto error;
 282         }
 283     }
 284 #endif
 285
 286     return fd;
 287
 288 error:
 289     error = errno == EAGAIN ? EPROTO : errno;
 290     if (bind_path) {
 291         fatal_signal_remove_file_to_unlink(bind_path);
 292     }
 293     close(fd);
 294     return -error;
 295 }
 296
 297 int
 298 get_unix_name_len(socklen_t sun_len)
 299 {
 300     return (sun_len >= offsetof(struct sockaddr_un, sun_path)
 301             ? sun_len - offsetof(struct sockaddr_un, sun_path)
 302             : 0);
 303 }
 304
 305 uint32_t
 306 guess_netmask(uint32_t ip)
 307 {
 308     ip = ntohl(ip);
 309     return ((ip >> 31) == 0 ? htonl(0xff000000)   /* Class A */
 310             : (ip >> 30) == 2 ? htonl(0xffff0000) /* Class B */
 311             : (ip >> 29) == 6 ? htonl(0xffffff00) /* Class C */
 312             : htonl(0));                          /* ??? */
 313 }
 314
 315 /* Parses 'target', which should be a string in the format "<host>[:<port>]".
 316  * <host> is required.  If 'default_port' is nonzero then <port> is optional
 317  * and defaults to 'default_port'.
 318  *
 319  * On success, returns true and stores the parsed remote address into '*sinp'.
 320  * On failure, logs an error, stores zeros into '*sinp', and returns false. */
 321 bool
 322 inet_parse_active(const char *target_, uint16_t default_port,
 323                   struct sockaddr_in *sinp)
 324 {
 325     char *target = xstrdup(target_);
 326     char *save_ptr = NULL;
 327     const char *host_name;
 328     const char *port_string;
 329     bool ok = false;
 330
 331     /* Defaults. */
 332     sinp->sin_family = AF_INET;
 333     sinp->sin_port = htons(default_port);
 334
 335     /* Tokenize. */
 336     host_name = strtok_r(target, ":", &save_ptr);
 337     port_string = strtok_r(NULL, ":", &save_ptr);
 338     if (!host_name) {
 339         VLOG_ERR("%s: bad peer name format", target_);
 340         goto exit;
 341     }
 342
 343     /* Look up IP, port. */
 344     if (lookup_ip(host_name, &sinp->sin_addr)) {
 345         goto exit;
 346     }
 347     if (port_string && atoi(port_string)) {
 348         sinp->sin_port = htons(atoi(port_string));
 349     } else if (!default_port) {
 350         VLOG_ERR("%s: port number must be specified", target_);
 351         goto exit;
 352     }
 353
 354     ok = true;
 355
 356 exit:
 357     if (!ok) {
 358         memset(sinp, 0, sizeof *sinp);
 359     }
 360     free(target);
 361     return ok;
 362 }
 363
 364 /* Opens a non-blocking IPv4 socket of the specified 'style' and connects to
 365  * 'target', which should be a string in the format "<host>[:<port>]".  <host>
 366  * is required.  If 'default_port' is nonzero then <port> is optional and
 367  * defaults to 'default_port'.
 368  *
 369  * 'style' should be SOCK_STREAM (for TCP) or SOCK_DGRAM (for UDP).
 370  *
 371  * On success, returns 0 (indicating connection complete) or EAGAIN (indicating
 372  * connection in progress), in which case the new file descriptor is stored
 373  * into '*fdp'.  On failure, returns a positive errno value other than EAGAIN
 374  * and stores -1 into '*fdp'.
 375  *
 376  * If 'sinp' is non-null, then on success the target address is stored into
 377  * '*sinp'. */
 378 int
 379 inet_open_active(int style, const char *target, uint16_t default_port,
 380                  struct sockaddr_in *sinp, int *fdp)
 381 {
 382     struct sockaddr_in sin;
 383     int fd = -1;
 384     int error;
 385
 386     /* Parse. */
 387     if (!inet_parse_active(target, default_port, &sin)) {
 388         error = EAFNOSUPPORT;
 389         goto exit;
 390     }
 391
 392     /* Create non-blocking socket. */
 393     fd = socket(AF_INET, style, 0);
 394     if (fd < 0) {
 395         VLOG_ERR("%s: socket: %s", target, strerror(errno));
 396         error = errno;
 397         goto exit;
 398     }
 399     error = set_nonblocking(fd);
 400     if (error) {
 401         goto exit_close;
 402     }
 403
 404     /* Connect. */
 405     error = connect(fd, (struct sockaddr *) &sin, sizeof sin) == 0 ? 0 : errno;
 406     if (error == EINPROGRESS) {
 407         error = EAGAIN;
 408     } else if (error && error != EAGAIN) {
 409         goto exit_close;
 410     }
 411
 412     /* Success: error is 0 or EAGAIN. */
 413     goto exit;
 414
 415 exit_close:
 416     close(fd);
 417 exit:
 418     if (!error || error == EAGAIN) {
 419         if (sinp) {
 420             *sinp = sin;
 421         }
 422         *fdp = fd;
 423     } else {
 424         *fdp = -1;
 425     }
 426     return error;
 427 }
 428
 429 /* Opens a non-blocking IPv4 socket of the specified 'style', binds to
 430  * 'target', and listens for incoming connections.  'target' should be a string
 431  * in the format "[<port>][:<ip>]":
 432  *
 433  *      - If 'default_port' is -1, then <port> is required.  Otherwise, if
 434  *        <port> is omitted, then 'default_port' is used instead.
 435  *
 436  *      - If <port> (or 'default_port', if used) is 0, then no port is bound
 437  *        and the TCP/IP stack will select a port.
 438  *
 439  *      - If <ip> is omitted then the IP address is wildcarded.
 440  *
 441  * 'style' should be SOCK_STREAM (for TCP) or SOCK_DGRAM (for UDP).
 442  *
 443  * For TCP, the socket will have SO_REUSEADDR turned on.
 444  *
 445  * On success, returns a non-negative file descriptor.  On failure, returns a
 446  * negative errno value.
 447  *
 448  * If 'sinp' is non-null, then on success the bound address is stored into
 449  * '*sinp'. */
 450 int
 451 inet_open_passive(int style, const char *target_, int default_port,
 452                   struct sockaddr_in *sinp)
 453 {
 454     char *target = xstrdup(target_);
 455     char *string_ptr = target;
 456     struct sockaddr_in sin;
 457     const char *host_name;
 458     const char *port_string;
 459     int fd = 0, error, port;
 460     unsigned int yes  = 1;
 461
 462     /* Address defaults. */
 463     memset(&sin, 0, sizeof sin);
 464     sin.sin_family = AF_INET;
 465     sin.sin_addr.s_addr = htonl(INADDR_ANY);
 466     sin.sin_port = htons(default_port);
 467
 468     /* Parse optional port number. */
 469     port_string = strsep(&string_ptr, ":");
 470     if (port_string && str_to_int(port_string, 10, &port)) {
 471         sin.sin_port = htons(port);
 472     } else if (default_port < 0) {
 473         VLOG_ERR("%s: port number must be specified", target_);
 474         error = EAFNOSUPPORT;
 475         goto exit;
 476     }
 477
 478     /* Parse optional bind IP. */
 479     host_name = strsep(&string_ptr, ":");
 480     if (host_name && host_name[0]) {
 481         error = lookup_ip(host_name, &sin.sin_addr);
 482         if (error) {
 483             goto exit;
 484         }
 485     }
 486
 487     /* Create non-blocking socket, set SO_REUSEADDR. */
 488     fd = socket(AF_INET, style, 0);
 489     if (fd < 0) {
 490         error = errno;
 491         VLOG_ERR("%s: socket: %s", target_, strerror(error));
 492         goto exit;
 493     }
 494     error = set_nonblocking(fd);
 495     if (error) {
 496         goto exit_close;
 497     }
 498     if (style == SOCK_STREAM
 499         && setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &yes, sizeof yes) < 0) {
 500         error = errno;
 501         VLOG_ERR("%s: setsockopt(SO_REUSEADDR): %s", target_, strerror(error));
 502         goto exit_close;
 503     }
 504
 505     /* Bind. */
 506     if (bind(fd, (struct sockaddr *) &sin, sizeof sin) < 0) {
 507         error = errno;
 508         VLOG_ERR("%s: bind: %s", target_, strerror(error));
 509         goto exit_close;
 510     }
 511
 512     /* Listen. */
 513     if (listen(fd, 10) < 0) {
 514         error = errno;
 515         VLOG_ERR("%s: listen: %s", target_, strerror(error));
 516         goto exit_close;
 517     }
 518
 519     if (sinp) {
 520         socklen_t sin_len = sizeof sin;
 521         if (getsockname(fd, (struct sockaddr *) &sin, &sin_len) < 0){
 522             error = errno;
 523             VLOG_ERR("%s: getsockname: %s", target_, strerror(error));
 524             goto exit_close;
 525         }
 526         if (sin.sin_family != AF_INET || sin_len != sizeof sin) {
 527             VLOG_ERR("%s: getsockname: invalid socket name", target_);
 528             goto exit_close;
 529         }
 530         *sinp = sin;
 531     }
 532
 533     error = 0;
 534     goto exit;
 535
 536 exit_close:
 537     close(fd);
 538 exit:
 539     free(target);
 540     return error ? -error : fd;
 541 }
 542
 543 /* Returns a readable and writable fd for /dev/null, if successful, otherwise
 544  * a negative errno value.  The caller must not close the returned fd (because
 545  * the same fd will be handed out to subsequent callers). */
 546 int
 547 get_null_fd(void)
 548 {
 549     static int null_fd = -1;
 550     if (null_fd < 0) {
 551         null_fd = open("/dev/null", O_RDWR);
 552         if (null_fd < 0) {
 553             int error = errno;
 554             VLOG_ERR("could not open /dev/null: %s", strerror(error));
 555             return -error;
 556         }
 557     }
 558     return null_fd;
 559 }
 560
 561 int
 562 read_fully(int fd, void *p_, size_t size, size_t *bytes_read)
 563 {
 564     uint8_t *p = p_;
 565
 566     *bytes_read = 0;
 567     while (size > 0) {
 568         ssize_t retval = read(fd, p, size);
 569         if (retval > 0) {
 570             *bytes_read += retval;
 571             size -= retval;
 572             p += retval;
 573         } else if (retval == 0) {
 574             return EOF;
 575         } else if (errno != EINTR) {
 576             return errno;
 577         }
 578     }
 579     return 0;
 580 }
 581
 582 int
 583 write_fully(int fd, const void *p_, size_t size, size_t *bytes_written)
 584 {
 585     const uint8_t *p = p_;
 586
 587     *bytes_written = 0;
 588     while (size > 0) {
 589         ssize_t retval = write(fd, p, size);
 590         if (retval > 0) {
 591             *bytes_written += retval;
 592             size -= retval;
 593             p += retval;
 594         } else if (retval == 0) {
 595             VLOG_WARN("write returned 0");
 596             return EPROTO;
 597         } else if (errno != EINTR) {
 598             return errno;
 599         }
 600     }
 601     return 0;
 602 }
 603
 604 /* Given file name 'file_name', fsyncs the directory in which it is contained.
 605  * Returns 0 if successful, otherwise a positive errno value. */
 606 int
 607 fsync_parent_dir(const char *file_name)
 608 {
 609     int error = 0;
 610     char *dir;
 611     int fd;
 612
 613     dir = dir_name(file_name);
 614     fd = open(dir, O_RDONLY);
 615     if (fd >= 0) {
 616         if (fsync(fd)) {
 617             if (errno == EINVAL || errno == EROFS) {
 618                 /* This directory does not support synchronization.  Not
 619                  * really an error. */
 620             } else {
 621                 error = errno;
 622                 VLOG_ERR("%s: fsync failed (%s)", dir, strerror(error));
 623             }
 624         }
 625         close(fd);
 626     } else {
 627         error = errno;
 628         VLOG_ERR("%s: open failed (%s)", dir, strerror(error));
 629     }
 630     free(dir);
 631
 632     return error;
 633 }
 634
 635 /* Obtains the modification time of the file named 'file_name' to the greatest
 636  * supported precision.  If successful, stores the mtime in '*mtime' and
 637  * returns 0.  On error, returns a positive errno value and stores zeros in
 638  * '*mtime'. */
 639 int
 640 get_mtime(const char *file_name, struct timespec *mtime)
 641 {
 642     struct stat s;
 643
 644     if (!stat(file_name, &s)) {
 645         mtime->tv_sec = s.st_mtime;
 646
 647 #if HAVE_STRUCT_STAT_ST_MTIM_TV_NSEC
 648         mtime->tv_nsec = s.st_mtim.tv_nsec;
 649 #elif HAVE_STRUCT_STAT_ST_MTIMENSEC
 650         mtime->tv_nsec = s.st_mtimensec;
 651 #else
 652         mtime->tv_nsec = 0;
 653 #endif
 654
 655         return 0;
 656     } else {
 657         mtime->tv_sec = mtime->tv_nsec = 0;
 658         return errno;
 659     }
 660 }
 661