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
  36 #include "vlog.h"
  37 #define THIS_MODULE VLM_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             printf("connect failed with %s\n", strerror(errno));
 274             goto error;
 275         }
 276     }
 277
 278 #ifdef SCM_CREDENTIALS
 279     if (passcred) {
 280         int enable = 1;
 281         if (setsockopt(fd, SOL_SOCKET, SO_PASSCRED, &enable, sizeof(enable))) {
 282             goto error;
 283         }
 284     }
 285 #endif
 286
 287     return fd;
 288
 289 error:
 290     error = errno == EAGAIN ? EPROTO : errno;
 291     if (bind_path) {
 292         fatal_signal_remove_file_to_unlink(bind_path);
 293     }
 294     close(fd);
 295     return -error;
 296 }
 297
 298 int
 299 get_unix_name_len(socklen_t sun_len)
 300 {
 301     return (sun_len >= offsetof(struct sockaddr_un, sun_path)
 302             ? sun_len - offsetof(struct sockaddr_un, sun_path)
 303             : 0);
 304 }
 305
 306 uint32_t
 307 guess_netmask(uint32_t ip)
 308 {
 309     ip = ntohl(ip);
 310     return ((ip >> 31) == 0 ? htonl(0xff000000)   /* Class A */
 311             : (ip >> 30) == 2 ? htonl(0xffff0000) /* Class B */
 312             : (ip >> 29) == 6 ? htonl(0xffffff00) /* Class C */
 313             : htonl(0));                          /* ??? */
 314 }
 315
 316 /* Parses 'target', which should be a string in the format "<host>[:<port>]".
 317  * <host> is required.  If 'default_port' is nonzero then <port> is optional
 318  * and defaults to 'default_port'.
 319  *
 320  * On success, returns true and stores the parsed remote address into '*sinp'.
 321  * On failure, logs an error, stores zeros into '*sinp', and returns false. */
 322 bool
 323 inet_parse_active(const char *target_, uint16_t default_port,
 324                   struct sockaddr_in *sinp)
 325 {
 326     char *target = xstrdup(target_);
 327     char *save_ptr = NULL;
 328     const char *host_name;
 329     const char *port_string;
 330     bool ok = false;
 331
 332     /* Defaults. */
 333     sinp->sin_family = AF_INET;
 334     sinp->sin_port = htons(default_port);
 335
 336     /* Tokenize. */
 337     host_name = strtok_r(target, ":", &save_ptr);
 338     port_string = strtok_r(NULL, ":", &save_ptr);
 339     if (!host_name) {
 340         VLOG_ERR("%s: bad peer name format", target_);
 341         goto exit;
 342     }
 343
 344     /* Look up IP, port. */
 345     if (lookup_ip(host_name, &sinp->sin_addr)) {
 346         goto exit;
 347     }
 348     if (port_string && atoi(port_string)) {
 349         sinp->sin_port = htons(atoi(port_string));
 350     } else if (!default_port) {
 351         VLOG_ERR("%s: port number must be specified", target_);
 352         goto exit;
 353     }
 354
 355     ok = true;
 356
 357 exit:
 358     if (!ok) {
 359         memset(sinp, 0, sizeof *sinp);
 360     }
 361     free(target);
 362     return ok;
 363 }
 364
 365 /* Opens a non-blocking IPv4 socket of the specified 'style' and connects to
 366  * 'target', which should be a string in the format "<host>[:<port>]".  <host>
 367  * is required.  If 'default_port' is nonzero then <port> is optional and
 368  * defaults to 'default_port'.
 369  *
 370  * 'style' should be SOCK_STREAM (for TCP) or SOCK_DGRAM (for UDP).
 371  *
 372  * On success, returns 0 (indicating connection complete) or EAGAIN (indicating
 373  * connection in progress), in which case the new file descriptor is stored
 374  * into '*fdp'.  On failure, returns a positive errno value other than EAGAIN
 375  * and stores -1 into '*fdp'.
 376  *
 377  * If 'sinp' is non-null, then on success the target address is stored into
 378  * '*sinp'. */
 379 int
 380 inet_open_active(int style, const char *target, uint16_t default_port,
 381                  struct sockaddr_in *sinp, int *fdp)
 382 {
 383     struct sockaddr_in sin;
 384     int fd = -1;
 385     int error;
 386
 387     /* Parse. */
 388     if (!inet_parse_active(target, default_port, &sin)) {
 389         error = EAFNOSUPPORT;
 390         goto exit;
 391     }
 392
 393     /* Create non-blocking socket. */
 394     fd = socket(AF_INET, style, 0);
 395     if (fd < 0) {
 396         VLOG_ERR("%s: socket: %s", target, strerror(errno));
 397         error = errno;
 398         goto exit;
 399     }
 400     error = set_nonblocking(fd);
 401     if (error) {
 402         goto exit_close;
 403     }
 404
 405     /* Connect. */
 406     error = connect(fd, (struct sockaddr *) &sin, sizeof sin) == 0 ? 0 : errno;
 407     if (error == EINPROGRESS) {
 408         error = EAGAIN;
 409     } else if (error && error != EAGAIN) {
 410         goto exit_close;
 411     }
 412
 413     /* Success: error is 0 or EAGAIN. */
 414     goto exit;
 415
 416 exit_close:
 417     close(fd);
 418 exit:
 419     if (!error || error == EAGAIN) {
 420         if (sinp) {
 421             *sinp = sin;
 422         }
 423         *fdp = fd;
 424     } else {
 425         *fdp = -1;
 426     }
 427     return error;
 428 }
 429
 430 /* Opens a non-blocking IPv4 socket of the specified 'style', binds to
 431  * 'target', and listens for incoming connections.  'target' should be a string
 432  * in the format "[<port>][:<ip>]":
 433  *
 434  *      - If 'default_port' is -1, then <port> is required.  Otherwise, if
 435  *        <port> is omitted, then 'default_port' is used instead.
 436  *
 437  *      - If <port> (or 'default_port', if used) is 0, then no port is bound
 438  *        and the TCP/IP stack will select a port.
 439  *
 440  *      - If <ip> is omitted then the IP address is wildcarded.
 441  *
 442  * 'style' should be SOCK_STREAM (for TCP) or SOCK_DGRAM (for UDP).
 443  *
 444  * For TCP, the socket will have SO_REUSEADDR turned on.
 445  *
 446  * On success, returns a non-negative file descriptor.  On failure, returns a
 447  * negative errno value.
 448  *
 449  * If 'sinp' is non-null, then on success the bound address is stored into
 450  * '*sinp'. */
 451 int
 452 inet_open_passive(int style, const char *target_, int default_port,
 453                   struct sockaddr_in *sinp)
 454 {
 455     char *target = xstrdup(target_);
 456     char *string_ptr = target;
 457     struct sockaddr_in sin;
 458     const char *host_name;
 459     const char *port_string;
 460     int fd, error, port;
 461     unsigned int yes  = 1;
 462
 463     /* Address defaults. */
 464     memset(&sin, 0, sizeof sin);
 465     sin.sin_family = AF_INET;
 466     sin.sin_addr.s_addr = htonl(INADDR_ANY);
 467     sin.sin_port = htons(default_port);
 468
 469     /* Parse optional port number. */
 470     port_string = strsep(&string_ptr, ":");
 471     if (port_string && str_to_int(port_string, 10, &port)) {
 472         sin.sin_port = htons(port);
 473     } else if (default_port < 0) {
 474         VLOG_ERR("%s: port number must be specified", target_);
 475         error = EAFNOSUPPORT;
 476         goto exit;
 477     }
 478
 479     /* Parse optional bind IP. */
 480     host_name = strsep(&string_ptr, ":");
 481     if (host_name && host_name[0]) {
 482         error = lookup_ip(host_name, &sin.sin_addr);
 483         if (error) {
 484             goto exit;
 485         }
 486     }
 487
 488     /* Create non-blocking socket, set SO_REUSEADDR. */
 489     fd = socket(AF_INET, style, 0);
 490     if (fd < 0) {
 491         error = errno;
 492         VLOG_ERR("%s: socket: %s", target_, strerror(error));
 493         goto exit;
 494     }
 495     error = set_nonblocking(fd);
 496     if (error) {
 497         goto exit_close;
 498     }
 499     if (style == SOCK_STREAM
 500         && setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &yes, sizeof yes) < 0) {
 501         error = errno;
 502         VLOG_ERR("%s: setsockopt(SO_REUSEADDR): %s", target_, strerror(error));
 503         goto exit_close;
 504     }
 505
 506     /* Bind. */
 507     if (bind(fd, (struct sockaddr *) &sin, sizeof sin) < 0) {
 508         error = errno;
 509         VLOG_ERR("%s: bind: %s", target_, strerror(error));
 510         goto exit_close;
 511     }
 512
 513     /* Listen. */
 514     if (listen(fd, 10) < 0) {
 515         error = errno;
 516         VLOG_ERR("%s: listen: %s", target_, strerror(error));
 517         goto exit_close;
 518     }
 519
 520     if (sinp) {
 521         socklen_t sin_len = sizeof sin;
 522         if (getsockname(fd, (struct sockaddr *) &sin, &sin_len) < 0){
 523             error = errno;
 524             VLOG_ERR("%s: getsockname: %s", target_, strerror(error));
 525             goto exit_close;
 526         }
 527         if (sin.sin_family != AF_INET || sin_len != sizeof sin) {
 528             VLOG_ERR("%s: getsockname: invalid socket name", target_);
 529             goto exit_close;
 530         }
 531         *sinp = sin;
 532     }
 533
 534     error = 0;
 535     goto exit;
 536
 537 exit_close:
 538     close(fd);
 539 exit:
 540     free(target);
 541     return error ? -error : fd;
 542 }
 543
 544 /* Returns a readable and writable fd for /dev/null, if successful, otherwise
 545  * a negative errno value.  The caller must not close the returned fd (because
 546  * the same fd will be handed out to subsequent callers). */
 547 int
 548 get_null_fd(void)
 549 {
 550     static int null_fd = -1;
 551     if (null_fd < 0) {
 552         null_fd = open("/dev/null", O_RDWR);
 553         if (null_fd < 0) {
 554             int error = errno;
 555             VLOG_ERR("could not open /dev/null: %s", strerror(error));
 556             return -error;
 557         }
 558     }
 559     return null_fd;
 560 }
 561
 562 int
 563 read_fully(int fd, void *p_, size_t size, size_t *bytes_read)
 564 {
 565     uint8_t *p = p_;
 566
 567     *bytes_read = 0;
 568     while (size > 0) {
 569         ssize_t retval = read(fd, p, size);
 570         if (retval > 0) {
 571             *bytes_read += retval;
 572             size -= retval;
 573             p += retval;
 574         } else if (retval == 0) {
 575             return EOF;
 576         } else if (errno != EINTR) {
 577             return errno;
 578         }
 579     }
 580     return 0;
 581 }
 582
 583 int
 584 write_fully(int fd, const void *p_, size_t size, size_t *bytes_written)
 585 {
 586     const uint8_t *p = p_;
 587
 588     *bytes_written = 0;
 589     while (size > 0) {
 590         ssize_t retval = write(fd, p, size);
 591         if (retval > 0) {
 592             *bytes_written += retval;
 593             size -= retval;
 594             p += retval;
 595         } else if (retval == 0) {
 596             VLOG_WARN("write returned 0");
 597             return EPROTO;
 598         } else if (errno != EINTR) {
 599             return errno;
 600         }
 601     }
 602     return 0;
 603 }
 604
 605 /* Given file name 'file_name', fsyncs the directory in which it is contained.
 606  * Returns 0 if successful, otherwise a positive errno value. */
 607 int
 608 fsync_parent_dir(const char *file_name)
 609 {
 610     int error = 0;
 611     char *dir;
 612     int fd;
 613
 614     dir = dir_name(file_name);
 615     fd = open(dir, O_RDONLY);
 616     if (fd >= 0) {
 617         if (fsync(fd)) {
 618             if (errno == EINVAL || errno == EROFS) {
 619                 /* This directory does not support synchronization.  Not
 620                  * really an error. */
 621             } else {
 622                 error = errno;
 623                 VLOG_ERR("%s: fsync failed (%s)", dir, strerror(error));
 624             }
 625         }
 626         close(fd);
 627     } else {
 628         error = errno;
 629         VLOG_ERR("%s: open failed (%s)", dir, strerror(error));
 630     }
 631     free(dir);
 632
 633     return error;
 634 }
 635
 636 /* Obtains the modification time of the file named 'file_name' to the greatest
 637  * supported precision.  If successful, stores the mtime in '*mtime' and
 638  * returns 0.  On error, returns a positive errno value and stores zeros in
 639  * '*mtime'. */
 640 int
 641 get_mtime(const char *file_name, struct timespec *mtime)
 642 {
 643     struct stat s;
 644
 645     if (!stat(file_name, &s)) {
 646         mtime->tv_sec = s.st_mtime;
 647
 648 #if HAVE_STRUCT_STAT_ST_MTIM_TV_NSEC
 649         mtime->tv_nsec = s.st_mtim.tv_nsec;
 650 #elif HAVE_STRUCT_STAT_ST_MTIMENSEC
 651         mtime->tv_nsec = s.st_mtimensec;
 652 #else
 653         mtime->tv_nsec = 0;
 654 #endif
 655
 656         return 0;
 657     } else {
 658         mtime->tv_sec = mtime->tv_nsec = 0;
 659         return errno;
 660     }
 661 }
 662