lib/socket-util.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
   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 <net/if.h>
  23 #include <netdb.h>
  24 #include <netinet/tcp.h>
  25 #include <poll.h>
  26 #include <stddef.h>
  27 #include <stdio.h>
  28 #include <stdlib.h>
  29 #include <string.h>
  30 #include <sys/socket.h>
  31 #include <sys/stat.h>
  32 #include <sys/uio.h>
  33 #include <sys/un.h>
  34 #include <unistd.h>
  35 #include "dynamic-string.h"
  36 #include "ovs-thread.h"
  37 #include "packets.h"
  38 #include "poll-loop.h"
  39 #include "util.h"
  40 #include "openvswitch/vlog.h"
  41 #ifdef __linux__
  42 #include <linux/if_packet.h>
  43 #endif
  44 #ifdef HAVE_NETLINK
  45 #include "netlink-protocol.h"
  46 #include "netlink-socket.h"
  47 #endif
  48
  49 VLOG_DEFINE_THIS_MODULE(socket_util);
  50
  51 static int getsockopt_int(int fd, int level, int option, const char *optname,
  52                           int *valuep);
  53
  54 /* Sets 'fd' to non-blocking mode.  Returns 0 if successful, otherwise a
  55  * positive errno value. */
  56 int
  57 set_nonblocking(int fd)
  58 {
  59 #ifndef _WIN32
  60     int flags = fcntl(fd, F_GETFL, 0);
  61     if (flags != -1) {
  62         if (fcntl(fd, F_SETFL, flags | O_NONBLOCK) != -1) {
  63             return 0;
  64         } else {
  65             VLOG_ERR("fcntl(F_SETFL) failed: %s", ovs_strerror(errno));
  66             return errno;
  67         }
  68     } else {
  69         VLOG_ERR("fcntl(F_GETFL) failed: %s", ovs_strerror(errno));
  70         return errno;
  71     }
  72 #else
  73     unsigned long arg = 1;
  74     if (ioctlsocket(fd, FIONBIO, &arg)) {
  75         int error = sock_errno();
  76         VLOG_ERR("set_nonblocking failed: %s", sock_strerror(error));
  77         return error;
  78     }
  79     return 0;
  80 #endif
  81 }
  82
  83 void
  84 xset_nonblocking(int fd)
  85 {
  86     if (set_nonblocking(fd)) {
  87         exit(EXIT_FAILURE);
  88     }
  89 }
  90
  91 void
  92 setsockopt_tcp_nodelay(int fd)
  93 {
  94     int on = 1;
  95     int retval;
  96
  97     retval = setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &on, sizeof on);
  98     if (retval) {
  99         retval = sock_errno();
 100         VLOG_ERR("setsockopt(TCP_NODELAY): %s", sock_strerror(retval));
 101     }
 102 }
 103
 104 int
 105 set_dscp(int fd, uint8_t dscp)
 106 {
 107     int val;
 108     bool success;
 109
 110 #ifdef _WIN32
 111     /* XXX: Consider using QoS2 APIs for Windows to set dscp. */
 112     return 0;
 113 #endif
 114
 115     if (dscp > 63) {
 116         return EINVAL;
 117     }
 118
 119     /* Note: this function is used for both of IPv4 and IPv6 sockets */
 120     success = false;
 121     val = dscp << 2;
 122     if (setsockopt(fd, IPPROTO_IP, IP_TOS, &val, sizeof val)) {
 123         if (sock_errno() != ENOPROTOOPT) {
 124             return sock_errno();
 125         }
 126     } else {
 127         success = true;
 128     }
 129     if (setsockopt(fd, IPPROTO_IPV6, IPV6_TCLASS, &val, sizeof val)) {
 130         if (sock_errno() != ENOPROTOOPT) {
 131             return sock_errno();
 132         }
 133     } else {
 134         success = true;
 135     }
 136     if (!success) {
 137         return ENOPROTOOPT;
 138     }
 139
 140     return 0;
 141 }
 142
 143 /* Translates 'host_name', which must be a string representation of an IP
 144  * address, into a numeric IP address in '*addr'.  Returns 0 if successful,
 145  * otherwise a positive errno value. */
 146 int
 147 lookup_ip(const char *host_name, struct in_addr *addr)
 148 {
 149     if (!inet_pton(AF_INET, host_name, addr)) {
 150         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
 151         VLOG_ERR_RL(&rl, "\"%s\" is not a valid IP address", host_name);
 152         return ENOENT;
 153     }
 154     return 0;
 155 }
 156
 157 /* Translates 'host_name', which must be a string representation of an IPv6
 158  * address, into a numeric IPv6 address in '*addr'.  Returns 0 if successful,
 159  * otherwise a positive errno value. */
 160 int
 161 lookup_ipv6(const char *host_name, struct in6_addr *addr)
 162 {
 163     if (inet_pton(AF_INET6, host_name, addr) != 1) {
 164         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
 165         VLOG_ERR_RL(&rl, "\"%s\" is not a valid IPv6 address", host_name);
 166         return ENOENT;
 167     }
 168     return 0;
 169 }
 170
 171 /* Translates 'host_name', which must be a host name or a string representation
 172  * of an IP address, into a numeric IP address in '*addr'.  Returns 0 if
 173  * successful, otherwise a positive errno value.
 174  *
 175  * Most Open vSwitch code should not use this because it causes deadlocks:
 176  * getaddrinfo() sends out a DNS request but that starts a new flow for which
 177  * OVS must set up a flow, but it can't because it's waiting for a DNS reply.
 178  * The synchronous lookup also delays other activity.  (Of course we can solve
 179  * this but it doesn't seem worthwhile quite yet.)  */
 180 int
 181 lookup_hostname(const char *host_name, struct in_addr *addr)
 182 {
 183     struct addrinfo *result;
 184     struct addrinfo hints;
 185
 186     if (inet_pton(AF_INET, host_name, addr)) {
 187         return 0;
 188     }
 189
 190     memset(&hints, 0, sizeof hints);
 191     hints.ai_family = AF_INET;
 192
 193     switch (getaddrinfo(host_name, NULL, &hints, &result)) {
 194     case 0:
 195         *addr = ALIGNED_CAST(struct sockaddr_in *,
 196                              result->ai_addr)->sin_addr;
 197         freeaddrinfo(result);
 198         return 0;
 199
 200 #ifdef EAI_ADDRFAMILY
 201     case EAI_ADDRFAMILY:
 202 #endif
 203     case EAI_NONAME:
 204     case EAI_SERVICE:
 205         return ENOENT;
 206
 207     case EAI_AGAIN:
 208         return EAGAIN;
 209
 210     case EAI_BADFLAGS:
 211     case EAI_FAMILY:
 212     case EAI_SOCKTYPE:
 213         return EINVAL;
 214
 215     case EAI_FAIL:
 216         return EIO;
 217
 218     case EAI_MEMORY:
 219         return ENOMEM;
 220
 221 #if defined (EAI_NODATA) && EAI_NODATA != EAI_NONAME
 222     case EAI_NODATA:
 223         return ENXIO;
 224 #endif
 225
 226 #ifdef EAI_SYSTEM
 227     case EAI_SYSTEM:
 228         return sock_errno();
 229 #endif
 230
 231     default:
 232         return EPROTO;
 233     }
 234 }
 235
 236 int
 237 check_connection_completion(int fd)
 238 {
 239     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 10);
 240     struct pollfd pfd;
 241     int retval;
 242
 243     pfd.fd = fd;
 244     pfd.events = POLLOUT;
 245
 246 #ifndef _WIN32
 247     do {
 248         retval = poll(&pfd, 1, 0);
 249     } while (retval < 0 && errno == EINTR);
 250 #else
 251     retval = WSAPoll(&pfd, 1, 0);
 252 #endif
 253     if (retval == 1) {
 254         if (pfd.revents & POLLERR) {
 255             ssize_t n = send(fd, "", 1, 0);
 256             if (n < 0) {
 257                 return sock_errno();
 258             } else {
 259                 VLOG_ERR_RL(&rl, "poll return POLLERR but send succeeded");
 260                 return EPROTO;
 261             }
 262         }
 263         return 0;
 264     } else if (retval < 0) {
 265         VLOG_ERR_RL(&rl, "poll: %s", sock_strerror(sock_errno()));
 266         return errno;
 267     } else {
 268         return EAGAIN;
 269     }
 270 }
 271
 272 /* Returns the size of socket 'sock''s receive buffer (SO_RCVBUF), or a
 273  * negative errno value if an error occurs. */
 274 int
 275 get_socket_rcvbuf(int sock)
 276 {
 277     int rcvbuf;
 278     int error;
 279
 280     error = getsockopt_int(sock, SOL_SOCKET, SO_RCVBUF, "SO_RCVBUF", &rcvbuf);
 281     return error ? -error : rcvbuf;
 282 }
 283
 284 /* Reads and discards up to 'n' datagrams from 'fd', stopping as soon as no
 285  * more data can be immediately read.  ('fd' should therefore be in
 286  * non-blocking mode.)*/
 287 void
 288 drain_fd(int fd, size_t n_packets)
 289 {
 290     for (; n_packets > 0; n_packets--) {
 291         /* 'buffer' only needs to be 1 byte long in most circumstances.  This
 292          * size is defensive against the possibility that we someday want to
 293          * use a Linux tap device without TUN_NO_PI, in which case a buffer
 294          * smaller than sizeof(struct tun_pi) will give EINVAL on read. */
 295         char buffer[128];
 296         if (read(fd, buffer, sizeof buffer) <= 0) {
 297             break;
 298         }
 299     }
 300 }
 301
 302 ovs_be32
 303 guess_netmask(ovs_be32 ip_)
 304 {
 305     uint32_t ip = ntohl(ip_);
 306     return ((ip >> 31) == 0 ? htonl(0xff000000)   /* Class A */
 307             : (ip >> 30) == 2 ? htonl(0xffff0000) /* Class B */
 308             : (ip >> 29) == 6 ? htonl(0xffffff00) /* Class C */
 309             : htonl(0));                          /* ??? */
 310 }
 311
 312 /* This is like strsep() except:
 313  *
 314  *    - The separator string is ":".
 315  *
 316  *    - Square brackets [] quote ":" separators and are removed from the
 317  *      tokens. */
 318 static char *
 319 parse_bracketed_token(char **pp)
 320 {
 321     char *p = *pp;
 322
 323     if (p == NULL) {
 324         return NULL;
 325     } else if (*p == '\0') {
 326         *pp = NULL;
 327         return p;
 328     } else if (*p == '[') {
 329         char *start = p + 1;
 330         char *end = start + strcspn(start, "]");
 331         *pp = (*end == '\0' ? NULL
 332                : end[1] == ':' ? end + 2
 333                : end + 1);
 334         *end = '\0';
 335         return start;
 336     } else {
 337         char *start = p;
 338         char *end = start + strcspn(start, ":");
 339         *pp = *end == '\0' ? NULL : end + 1;
 340         *end = '\0';
 341         return start;
 342     }
 343 }
 344
 345 static bool
 346 parse_sockaddr_components(struct sockaddr_storage *ss,
 347                           const char *host_s,
 348                           const char *port_s, uint16_t default_port,
 349                           const char *s)
 350 {
 351     struct sockaddr_in *sin = ALIGNED_CAST(struct sockaddr_in *, ss);
 352     int port;
 353
 354     if (port_s && port_s[0]) {
 355         if (!str_to_int(port_s, 10, &port) || port < 0 || port > 65535) {
 356             VLOG_ERR("%s: bad port number \"%s\"", s, port_s);
 357         }
 358     } else {
 359         port = default_port;
 360     }
 361
 362     memset(ss, 0, sizeof *ss);
 363     if (strchr(host_s, ':')) {
 364         struct sockaddr_in6 *sin6
 365             = ALIGNED_CAST(struct sockaddr_in6 *, ss);
 366
 367         sin6->sin6_family = AF_INET6;
 368         sin6->sin6_port = htons(port);
 369         if (!inet_pton(AF_INET6, host_s, sin6->sin6_addr.s6_addr)) {
 370             VLOG_ERR("%s: bad IPv6 address \"%s\"", s, host_s);
 371             goto exit;
 372         }
 373     } else {
 374         sin->sin_family = AF_INET;
 375         sin->sin_port = htons(port);
 376         if (!inet_pton(AF_INET, host_s, &sin->sin_addr.s_addr)) {
 377             VLOG_ERR("%s: bad IPv4 address \"%s\"", s, host_s);
 378             goto exit;
 379         }
 380     }
 381
 382     return true;
 383
 384 exit:
 385     memset(ss, 0, sizeof *ss);
 386     return false;
 387 }
 388
 389 /* Parses 'target', which should be a string in the format "<host>[:<port>]".
 390  * <host>, which is required, may be an IPv4 address or an IPv6 address
 391  * enclosed in square brackets.  If 'default_port' is nonzero then <port> is
 392  * optional and defaults to 'default_port'.
 393  *
 394  * On success, returns true and stores the parsed remote address into '*ss'.
 395  * On failure, logs an error, stores zeros into '*ss', and returns false. */
 396 bool
 397 inet_parse_active(const char *target_, uint16_t default_port,
 398                   struct sockaddr_storage *ss)
 399 {
 400     char *target = xstrdup(target_);
 401     const char *port;
 402     const char *host;
 403     char *p;
 404     bool ok;
 405
 406     p = target;
 407     host = parse_bracketed_token(&p);
 408     port = parse_bracketed_token(&p);
 409     if (!host) {
 410         VLOG_ERR("%s: host must be specified", target_);
 411         ok = false;
 412     } else if (!port && !default_port) {
 413         VLOG_ERR("%s: port must be specified", target_);
 414         ok = false;
 415     } else {
 416         ok = parse_sockaddr_components(ss, host, port, default_port, target_);
 417     }
 418     if (!ok) {
 419         memset(ss, 0, sizeof *ss);
 420     }
 421     free(target);
 422     return ok;
 423 }
 424
 425
 426 /* Opens a non-blocking IPv4 or IPv6 socket of the specified 'style' and
 427  * connects to 'target', which should be a string in the format
 428  * "<host>[:<port>]".  <host>, which is required, may be an IPv4 address or an
 429  * IPv6 address enclosed in square brackets.  If 'default_port' is nonzero then
 430  * <port> is optional and defaults to 'default_port'.
 431  *
 432  * 'style' should be SOCK_STREAM (for TCP) or SOCK_DGRAM (for UDP).
 433  *
 434  * On success, returns 0 (indicating connection complete) or EAGAIN (indicating
 435  * connection in progress), in which case the new file descriptor is stored
 436  * into '*fdp'.  On failure, returns a positive errno value other than EAGAIN
 437  * and stores -1 into '*fdp'.
 438  *
 439  * If 'ss' is non-null, then on success stores the target address into '*ss'.
 440  *
 441  * 'dscp' becomes the DSCP bits in the IP headers for the new connection.  It
 442  * should be in the range [0, 63] and will automatically be shifted to the
 443  * appropriately place in the IP tos field. */
 444 int
 445 inet_open_active(int style, const char *target, uint16_t default_port,
 446                  struct sockaddr_storage *ssp, int *fdp, uint8_t dscp)
 447 {
 448     struct sockaddr_storage ss;
 449     int fd = -1;
 450     int error;
 451
 452     /* Parse. */
 453     if (!inet_parse_active(target, default_port, &ss)) {
 454         error = EAFNOSUPPORT;
 455         goto exit;
 456     }
 457
 458     /* Create non-blocking socket. */
 459     fd = socket(ss.ss_family, style, 0);
 460     if (fd < 0) {
 461         error = sock_errno();
 462         VLOG_ERR("%s: socket: %s", target, sock_strerror(error));
 463         goto exit;
 464     }
 465     error = set_nonblocking(fd);
 466     if (error) {
 467         goto exit;
 468     }
 469
 470     /* The dscp bits must be configured before connect() to ensure that the
 471      * TOS field is set during the connection establishment.  If set after
 472      * connect(), the handshake SYN frames will be sent with a TOS of 0. */
 473     error = set_dscp(fd, dscp);
 474     if (error) {
 475         VLOG_ERR("%s: set_dscp: %s", target, sock_strerror(error));
 476         goto exit;
 477     }
 478
 479     /* Connect. */
 480     error = connect(fd, (struct sockaddr *) &ss, ss_length(&ss)) == 0
 481                     ? 0
 482                     : sock_errno();
 483     if (error == EINPROGRESS
 484 #ifdef _WIN32
 485         || error == WSAEALREADY || error == WSAEWOULDBLOCK
 486 #endif
 487         ) {
 488         error = EAGAIN;
 489     }
 490
 491 exit:
 492     if (error && error != EAGAIN) {
 493         if (ssp) {
 494             memset(ssp, 0, sizeof *ssp);
 495         }
 496         if (fd >= 0) {
 497             closesocket(fd);
 498             fd = -1;
 499         }
 500     } else {
 501         if (ssp) {
 502             *ssp = ss;
 503         }
 504     }
 505     *fdp = fd;
 506     return error;
 507 }
 508
 509 /* Parses 'target', which should be a string in the format "[<port>][:<host>]":
 510  *
 511  *      - If 'default_port' is -1, then <port> is required.  Otherwise, if
 512  *        <port> is omitted, then 'default_port' is used instead.
 513  *
 514  *      - If <port> (or 'default_port', if used) is 0, then no port is bound
 515  *        and the TCP/IP stack will select a port.
 516  *
 517  *      - <host> is optional.  If supplied, it may be an IPv4 address or an
 518  *        IPv6 address enclosed in square brackets.  If omitted, the IP address
 519  *        is wildcarded.
 520  *
 521  * If successful, stores the address into '*ss' and returns true; otherwise
 522  * zeros '*ss' and returns false. */
 523 bool
 524 inet_parse_passive(const char *target_, int default_port,
 525                    struct sockaddr_storage *ss)
 526 {
 527     char *target = xstrdup(target_);
 528     const char *port;
 529     const char *host;
 530     char *p;
 531     bool ok;
 532
 533     p = target;
 534     port = parse_bracketed_token(&p);
 535     host = parse_bracketed_token(&p);
 536     if (!port && default_port < 0) {
 537         VLOG_ERR("%s: port must be specified", target_);
 538         ok = false;
 539     } else {
 540         ok = parse_sockaddr_components(ss, host ? host : "0.0.0.0",
 541                                        port, default_port, target_);
 542     }
 543     if (!ok) {
 544         memset(ss, 0, sizeof *ss);
 545     }
 546     free(target);
 547     return ok;
 548 }
 549
 550
 551 /* Opens a non-blocking IPv4 or IPv6 socket of the specified 'style', binds to
 552  * 'target', and listens for incoming connections.  Parses 'target' in the same
 553  * way was inet_parse_passive().
 554  *
 555  * 'style' should be SOCK_STREAM (for TCP) or SOCK_DGRAM (for UDP).
 556  *
 557  * For TCP, the socket will have SO_REUSEADDR turned on.
 558  *
 559  * On success, returns a non-negative file descriptor.  On failure, returns a
 560  * negative errno value.
 561  *
 562  * If 'ss' is non-null, then on success stores the bound address into '*ss'.
 563  *
 564  * 'dscp' becomes the DSCP bits in the IP headers for the new connection.  It
 565  * should be in the range [0, 63] and will automatically be shifted to the
 566  * appropriately place in the IP tos field.
 567  *
 568  * If 'kernel_print_port' is true and the port is dynamically assigned by
 569  * the kernel, print the chosen port. */
 570 int
 571 inet_open_passive(int style, const char *target, int default_port,
 572                   struct sockaddr_storage *ssp, uint8_t dscp,
 573                   bool kernel_print_port)
 574 {
 575     bool kernel_chooses_port;
 576     struct sockaddr_storage ss;
 577     int fd = 0, error;
 578     unsigned int yes = 1;
 579
 580     if (!inet_parse_passive(target, default_port, &ss)) {
 581         return -EAFNOSUPPORT;
 582     }
 583     kernel_chooses_port = ss_get_port(&ss) == 0;
 584
 585     /* Create non-blocking socket, set SO_REUSEADDR. */
 586     fd = socket(ss.ss_family, style, 0);
 587     if (fd < 0) {
 588         error = sock_errno();
 589         VLOG_ERR("%s: socket: %s", target, sock_strerror(error));
 590         return -error;
 591     }
 592     error = set_nonblocking(fd);
 593     if (error) {
 594         goto error;
 595     }
 596     if (style == SOCK_STREAM
 597         && setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &yes, sizeof yes) < 0) {
 598         error = sock_errno();
 599         VLOG_ERR("%s: setsockopt(SO_REUSEADDR): %s",
 600                  target, sock_strerror(error));
 601         goto error;
 602     }
 603
 604     /* Bind. */
 605     if (bind(fd, (struct sockaddr *) &ss, ss_length(&ss)) < 0) {
 606         error = sock_errno();
 607         VLOG_ERR("%s: bind: %s", target, sock_strerror(error));
 608         goto error;
 609     }
 610
 611     /* The dscp bits must be configured before connect() to ensure that the TOS
 612      * field is set during the connection establishment.  If set after
 613      * connect(), the handshake SYN frames will be sent with a TOS of 0. */
 614     error = set_dscp(fd, dscp);
 615     if (error) {
 616         VLOG_ERR("%s: set_dscp: %s", target, sock_strerror(error));
 617         goto error;
 618     }
 619
 620     /* Listen. */
 621     if (style == SOCK_STREAM && listen(fd, 10) < 0) {
 622         error = sock_errno();
 623         VLOG_ERR("%s: listen: %s", target, sock_strerror(error));
 624         goto error;
 625     }
 626
 627     if (ssp || kernel_chooses_port) {
 628         socklen_t ss_len = sizeof ss;
 629         if (getsockname(fd, (struct sockaddr *) &ss, &ss_len) < 0) {
 630             error = sock_errno();
 631             VLOG_ERR("%s: getsockname: %s", target, sock_strerror(error));
 632             goto error;
 633         }
 634         if (kernel_chooses_port && kernel_print_port) {
 635             VLOG_INFO("%s: listening on port %"PRIu16,
 636                       target, ss_get_port(&ss));
 637         }
 638         if (ssp) {
 639             *ssp = ss;
 640         }
 641     }
 642
 643     return fd;
 644
 645 error:
 646     if (ssp) {
 647         memset(ssp, 0, sizeof *ssp);
 648     }
 649     closesocket(fd);
 650     return -error;
 651 }
 652
 653 int
 654 read_fully(int fd, void *p_, size_t size, size_t *bytes_read)
 655 {
 656     uint8_t *p = p_;
 657
 658     *bytes_read = 0;
 659     while (size > 0) {
 660         ssize_t retval = read(fd, p, size);
 661         if (retval > 0) {
 662             *bytes_read += retval;
 663             size -= retval;
 664             p += retval;
 665         } else if (retval == 0) {
 666             return EOF;
 667         } else if (errno != EINTR) {
 668             return errno;
 669         }
 670     }
 671     return 0;
 672 }
 673
 674 int
 675 write_fully(int fd, const void *p_, size_t size, size_t *bytes_written)
 676 {
 677     const uint8_t *p = p_;
 678
 679     *bytes_written = 0;
 680     while (size > 0) {
 681         ssize_t retval = write(fd, p, size);
 682         if (retval > 0) {
 683             *bytes_written += retval;
 684             size -= retval;
 685             p += retval;
 686         } else if (retval == 0) {
 687             VLOG_WARN("write returned 0");
 688             return EPROTO;
 689         } else if (errno != EINTR) {
 690             return errno;
 691         }
 692     }
 693     return 0;
 694 }
 695
 696 /* Given file name 'file_name', fsyncs the directory in which it is contained.
 697  * Returns 0 if successful, otherwise a positive errno value. */
 698 int
 699 fsync_parent_dir(const char *file_name)
 700 {
 701     int error = 0;
 702 #ifndef _WIN32
 703     char *dir;
 704     int fd;
 705
 706     dir = dir_name(file_name);
 707     fd = open(dir, O_RDONLY);
 708     if (fd >= 0) {
 709         if (fsync(fd)) {
 710             if (errno == EINVAL || errno == EROFS) {
 711                 /* This directory does not support synchronization.  Not
 712                  * really an error. */
 713             } else {
 714                 error = errno;
 715                 VLOG_ERR("%s: fsync failed (%s)", dir, ovs_strerror(error));
 716             }
 717         }
 718         close(fd);
 719     } else {
 720         error = errno;
 721         VLOG_ERR("%s: open failed (%s)", dir, ovs_strerror(error));
 722     }
 723     free(dir);
 724 #endif
 725
 726     return error;
 727 }
 728
 729 /* Obtains the modification time of the file named 'file_name' to the greatest
 730  * supported precision.  If successful, stores the mtime in '*mtime' and
 731  * returns 0.  On error, returns a positive errno value and stores zeros in
 732  * '*mtime'. */
 733 int
 734 get_mtime(const char *file_name, struct timespec *mtime)
 735 {
 736     struct stat s;
 737
 738     if (!stat(file_name, &s)) {
 739         mtime->tv_sec = s.st_mtime;
 740
 741 #if HAVE_STRUCT_STAT_ST_MTIM_TV_NSEC
 742         mtime->tv_nsec = s.st_mtim.tv_nsec;
 743 #elif HAVE_STRUCT_STAT_ST_MTIMENSEC
 744         mtime->tv_nsec = s.st_mtimensec;
 745 #else
 746         mtime->tv_nsec = 0;
 747 #endif
 748
 749         return 0;
 750     } else {
 751         mtime->tv_sec = mtime->tv_nsec = 0;
 752         return errno;
 753     }
 754 }
 755
 756 static int
 757 getsockopt_int(int fd, int level, int option, const char *optname, int *valuep)
 758 {
 759     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 10);
 760     socklen_t len;
 761     int value;
 762     int error;
 763
 764     len = sizeof value;
 765     if (getsockopt(fd, level, option, &value, &len)) {
 766         error = sock_errno();
 767         VLOG_ERR_RL(&rl, "getsockopt(%s): %s", optname, sock_strerror(error));
 768     } else if (len != sizeof value) {
 769         error = EINVAL;
 770         VLOG_ERR_RL(&rl, "getsockopt(%s): value is %u bytes (expected %"PRIuSIZE")",
 771                     optname, (unsigned int) len, sizeof value);
 772     } else {
 773         error = 0;
 774     }
 775
 776     *valuep = error ? 0 : value;
 777     return error;
 778 }
 779
 780 static void
 781 describe_sockaddr(struct ds *string, int fd,
 782                   int (*getaddr)(int, struct sockaddr *, socklen_t *))
 783 {
 784     struct sockaddr_storage ss;
 785     socklen_t len = sizeof ss;
 786
 787     if (!getaddr(fd, (struct sockaddr *) &ss, &len)) {
 788         if (ss.ss_family == AF_INET || ss.ss_family == AF_INET6) {
 789             char addrbuf[SS_NTOP_BUFSIZE];
 790
 791             ds_put_format(string, "%s:%"PRIu16,
 792                           ss_format_address(&ss, addrbuf, sizeof addrbuf),
 793                           ss_get_port(&ss));
 794 #ifndef _WIN32
 795         } else if (ss.ss_family == AF_UNIX) {
 796             struct sockaddr_un sun;
 797             const char *null;
 798             size_t maxlen;
 799
 800             memcpy(&sun, &ss, sizeof sun);
 801             maxlen = len - offsetof(struct sockaddr_un, sun_path);
 802             null = memchr(sun.sun_path, '\0', maxlen);
 803             ds_put_buffer(string, sun.sun_path,
 804                           null ? null - sun.sun_path : maxlen);
 805 #endif
 806         }
 807 #ifdef HAVE_NETLINK
 808         else if (ss.ss_family == AF_NETLINK) {
 809             int protocol;
 810
 811 /* SO_PROTOCOL was introduced in 2.6.32.  Support it regardless of the version
 812  * of the Linux kernel headers in use at build time. */
 813 #ifndef SO_PROTOCOL
 814 #define SO_PROTOCOL 38
 815 #endif
 816
 817             if (!getsockopt_int(fd, SOL_SOCKET, SO_PROTOCOL, "SO_PROTOCOL",
 818                                 &protocol)) {
 819                 switch (protocol) {
 820                 case NETLINK_ROUTE:
 821                     ds_put_cstr(string, "NETLINK_ROUTE");
 822                     break;
 823
 824                 case NETLINK_GENERIC:
 825                     ds_put_cstr(string, "NETLINK_GENERIC");
 826                     break;
 827
 828                 default:
 829                     ds_put_format(string, "AF_NETLINK family %d", protocol);
 830                     break;
 831                 }
 832             } else {
 833                 ds_put_cstr(string, "AF_NETLINK");
 834             }
 835         }
 836 #endif
 837 #if __linux__
 838         else if (ss.ss_family == AF_PACKET) {
 839             struct sockaddr_ll sll;
 840
 841             memcpy(&sll, &ss, sizeof sll);
 842             ds_put_cstr(string, "AF_PACKET");
 843             if (sll.sll_ifindex) {
 844                 char name[IFNAMSIZ];
 845
 846                 if (if_indextoname(sll.sll_ifindex, name)) {
 847                     ds_put_format(string, "(%s)", name);
 848                 } else {
 849                     ds_put_format(string, "(ifindex=%d)", sll.sll_ifindex);
 850                 }
 851             }
 852             if (sll.sll_protocol) {
 853                 ds_put_format(string, "(protocol=0x%"PRIu16")",
 854                               ntohs(sll.sll_protocol));
 855             }
 856         }
 857 #endif
 858         else if (ss.ss_family == AF_UNSPEC) {
 859             ds_put_cstr(string, "AF_UNSPEC");
 860         } else {
 861             ds_put_format(string, "AF_%d", (int) ss.ss_family);
 862         }
 863     }
 864 }
 865
 866
 867 #ifdef __linux__
 868 static void
 869 put_fd_filename(struct ds *string, int fd)
 870 {
 871     char buf[1024];
 872     char *linkname;
 873     int n;
 874
 875     linkname = xasprintf("/proc/self/fd/%d", fd);
 876     n = readlink(linkname, buf, sizeof buf);
 877     if (n > 0) {
 878         ds_put_char(string, ' ');
 879         ds_put_buffer(string, buf, n);
 880         if (n > sizeof buf) {
 881             ds_put_cstr(string, "...");
 882         }
 883     }
 884     free(linkname);
 885 }
 886 #endif
 887
 888 /* Returns a malloc()'d string describing 'fd', for use in logging. */
 889 char *
 890 describe_fd(int fd)
 891 {
 892     struct ds string;
 893     struct stat s;
 894
 895     ds_init(&string);
 896 #ifndef _WIN32
 897     if (fstat(fd, &s)) {
 898         ds_put_format(&string, "fstat failed (%s)", ovs_strerror(errno));
 899     } else if (S_ISSOCK(s.st_mode)) {
 900         describe_sockaddr(&string, fd, getsockname);
 901         ds_put_cstr(&string, "<->");
 902         describe_sockaddr(&string, fd, getpeername);
 903     } else {
 904         ds_put_cstr(&string, (isatty(fd) ? "tty"
 905                               : S_ISDIR(s.st_mode) ? "directory"
 906                               : S_ISCHR(s.st_mode) ? "character device"
 907                               : S_ISBLK(s.st_mode) ? "block device"
 908                               : S_ISREG(s.st_mode) ? "file"
 909                               : S_ISFIFO(s.st_mode) ? "FIFO"
 910                               : S_ISLNK(s.st_mode) ? "symbolic link"
 911                               : "unknown"));
 912 #ifdef __linux__
 913         put_fd_filename(&string, fd);
 914 #endif
 915     }
 916 #else
 917     ds_put_format(&string,"file descriptor");
 918 #endif /* _WIN32 */
 919     return ds_steal_cstr(&string);
 920 }
 921
 922 \f
 923 /* sockaddr_storage helpers. */
 924
 925 /* Returns the IPv4 or IPv6 port in 'ss'. */
 926 uint16_t
 927 ss_get_port(const struct sockaddr_storage *ss)
 928 {
 929     if (ss->ss_family == AF_INET) {
 930         const struct sockaddr_in *sin
 931             = ALIGNED_CAST(const struct sockaddr_in *, ss);
 932         return ntohs(sin->sin_port);
 933     } else if (ss->ss_family == AF_INET6) {
 934         const struct sockaddr_in6 *sin6
 935             = ALIGNED_CAST(const struct sockaddr_in6 *, ss);
 936         return ntohs(sin6->sin6_port);
 937     } else {
 938         OVS_NOT_REACHED();
 939     }
 940 }
 941
 942 /* Formats the IPv4 or IPv6 address in 'ss' into the 'bufsize' bytes in 'buf'.
 943  * If 'ss' is an IPv6 address, puts square brackets around the address.
 944  * 'bufsize' should be at least SS_NTOP_BUFSIZE.
 945  *
 946  * Returns 'buf'. */
 947 char *
 948 ss_format_address(const struct sockaddr_storage *ss,
 949                   char *buf, size_t bufsize)
 950 {
 951     ovs_assert(bufsize >= SS_NTOP_BUFSIZE);
 952     if (ss->ss_family == AF_INET) {
 953         const struct sockaddr_in *sin
 954             = ALIGNED_CAST(const struct sockaddr_in *, ss);
 955
 956         snprintf(buf, bufsize, IP_FMT, IP_ARGS(sin->sin_addr.s_addr));
 957     } else if (ss->ss_family == AF_INET6) {
 958         const struct sockaddr_in6 *sin6
 959             = ALIGNED_CAST(const struct sockaddr_in6 *, ss);
 960
 961         buf[0] = '[';
 962         inet_ntop(AF_INET6, sin6->sin6_addr.s6_addr, buf + 1, bufsize - 1);
 963         strcpy(strchr(buf, '\0'), "]");
 964     } else {
 965         OVS_NOT_REACHED();
 966     }
 967
 968     return buf;
 969 }
 970
 971 size_t
 972 ss_length(const struct sockaddr_storage *ss)
 973 {
 974     switch (ss->ss_family) {
 975     case AF_INET:
 976         return sizeof(struct sockaddr_in);
 977
 978     case AF_INET6:
 979         return sizeof(struct sockaddr_in6);
 980
 981     default:
 982         OVS_NOT_REACHED();
 983     }
 984 }
 985
 986 /* For Windows socket calls, 'errno' is not set.  One has to call
 987  * WSAGetLastError() to get the error number and then pass it to
 988  * this function to get the correct error string.
 989  *
 990  * ovs_strerror() calls strerror_r() and would not get the correct error
 991  * string for Windows sockets, but is good for POSIX. */
 992 const char *
 993 sock_strerror(int error)
 994 {
 995 #ifdef _WIN32
 996     return ovs_format_message(error);
 997 #else
 998     return ovs_strerror(error);
 999 #endif
1000 }