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 may be a DNS name or an IP address, into a
  77  * numeric IP address in '*addr'.  Returns 0 if successful, otherwise a
  78  * 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 hostent *he = gethostbyname(host_name);
  84         if (he == NULL) {
  85             struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
  86             VLOG_ERR_RL(&rl, "gethostbyname(%s): %s", host_name,
  87                         (h_errno == HOST_NOT_FOUND ? "host not found"
  88                          : h_errno == TRY_AGAIN ? "try again"
  89                          : h_errno == NO_RECOVERY ? "non-recoverable error"
  90                          : h_errno == NO_ADDRESS ? "no address"
  91                          : "unknown error"));
  92             return ENOENT;
  93         }
  94         addr->s_addr = *(uint32_t *) he->h_addr;
  95     }
  96     return 0;
  97 }
  98
  99 /* Returns the error condition associated with socket 'fd' and resets the
 100  * socket's error status. */
 101 int
 102 get_socket_error(int fd)
 103 {
 104     int error;
 105     socklen_t len = sizeof(error);
 106     if (getsockopt(fd, SOL_SOCKET, SO_ERROR, &error, &len) < 0) {
 107         struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 10);
 108         error = errno;
 109         VLOG_ERR_RL(&rl, "getsockopt(SO_ERROR): %s", strerror(error));
 110     }
 111     return error;
 112 }
 113
 114 int
 115 check_connection_completion(int fd)
 116 {
 117     struct pollfd pfd;
 118     int retval;
 119
 120     pfd.fd = fd;
 121     pfd.events = POLLOUT;
 122     do {
 123         retval = poll(&pfd, 1, 0);
 124     } while (retval < 0 && errno == EINTR);
 125     if (retval == 1) {
 126         return get_socket_error(fd);
 127     } else if (retval < 0) {
 128         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 10);
 129         VLOG_ERR_RL(&rl, "poll: %s", strerror(errno));
 130         return errno;
 131     } else {
 132         return EAGAIN;
 133     }
 134 }
 135
 136 /* Drain all the data currently in the receive queue of a datagram socket (and
 137  * possibly additional data).  There is no way to know how many packets are in
 138  * the receive queue, but we do know that the total number of bytes queued does
 139  * not exceed the receive buffer size, so we pull packets until none are left
 140  * or we've read that many bytes. */
 141 int
 142 drain_rcvbuf(int fd)
 143 {
 144     socklen_t rcvbuf_len;
 145     size_t rcvbuf;
 146
 147     rcvbuf_len = sizeof rcvbuf;
 148     if (getsockopt(fd, SOL_SOCKET, SO_RCVBUF, &rcvbuf, &rcvbuf_len) < 0) {
 149         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 10);
 150         VLOG_ERR_RL(&rl, "getsockopt(SO_RCVBUF) failed: %s", strerror(errno));
 151         return errno;
 152     }
 153     while (rcvbuf > 0) {
 154         /* In Linux, specifying MSG_TRUNC in the flags argument causes the
 155          * datagram length to be returned, even if that is longer than the
 156          * buffer provided.  Thus, we can use a 1-byte buffer to discard the
 157          * incoming datagram and still be able to account how many bytes were
 158          * removed from the receive buffer.
 159          *
 160          * On other Unix-like OSes, MSG_TRUNC has no effect in the flags
 161          * argument. */
 162 #ifdef __linux__
 163 #define BUFFER_SIZE 1
 164 #else
 165 #define BUFFER_SIZE 2048
 166 #endif
 167         char buffer[BUFFER_SIZE];
 168         ssize_t n_bytes = recv(fd, buffer, sizeof buffer,
 169                                MSG_TRUNC | MSG_DONTWAIT);
 170         if (n_bytes <= 0 || n_bytes >= rcvbuf) {
 171             break;
 172         }
 173         rcvbuf -= n_bytes;
 174     }
 175     return 0;
 176 }
 177
 178 /* Reads and discards up to 'n' datagrams from 'fd', stopping as soon as no
 179  * more data can be immediately read.  ('fd' should therefore be in
 180  * non-blocking mode.)*/
 181 void
 182 drain_fd(int fd, size_t n_packets)
 183 {
 184     for (; n_packets > 0; n_packets--) {
 185         /* 'buffer' only needs to be 1 byte long in most circumstances.  This
 186          * size is defensive against the possibility that we someday want to
 187          * use a Linux tap device without TUN_NO_PI, in which case a buffer
 188          * smaller than sizeof(struct tun_pi) will give EINVAL on read. */
 189         char buffer[128];
 190         if (read(fd, buffer, sizeof buffer) <= 0) {
 191             break;
 192         }
 193     }
 194 }
 195
 196 /* Stores in '*un' a sockaddr_un that refers to file 'name'.  Stores in
 197  * '*un_len' the size of the sockaddr_un. */
 198 static void
 199 make_sockaddr_un(const char *name, struct sockaddr_un* un, socklen_t *un_len)
 200 {
 201     un->sun_family = AF_UNIX;
 202     strncpy(un->sun_path, name, sizeof un->sun_path);
 203     un->sun_path[sizeof un->sun_path - 1] = '\0';
 204     *un_len = (offsetof(struct sockaddr_un, sun_path)
 205                 + strlen (un->sun_path) + 1);
 206 }
 207
 208 /* Creates a Unix domain socket in the given 'style' (either SOCK_DGRAM or
 209  * SOCK_STREAM) that is bound to '*bind_path' (if 'bind_path' is non-null) and
 210  * connected to '*connect_path' (if 'connect_path' is non-null).  If 'nonblock'
 211  * is true, the socket is made non-blocking.  If 'passcred' is true, the socket
 212  * is configured to receive SCM_CREDENTIALS control messages.
 213  *
 214  * Returns the socket's fd if successful, otherwise a negative errno value. */
 215 int
 216 make_unix_socket(int style, bool nonblock, bool passcred UNUSED,
 217                  const char *bind_path, const char *connect_path)
 218 {
 219     int error;
 220     int fd;
 221
 222     fd = socket(PF_UNIX, style, 0);
 223     if (fd < 0) {
 224         return -errno;
 225     }
 226
 227     /* Set nonblocking mode right away, if we want it.  This prevents blocking
 228      * in connect(), if connect_path != NULL.  (In turn, that's a corner case:
 229      * it will only happen if style is SOCK_STREAM or SOCK_SEQPACKET, and only
 230      * if a backlog of un-accepted connections has built up in the kernel.)  */
 231     if (nonblock) {
 232         int flags = fcntl(fd, F_GETFL, 0);
 233         if (flags == -1) {
 234             goto error;
 235         }
 236         if (fcntl(fd, F_SETFL, flags | O_NONBLOCK) == -1) {
 237             goto error;
 238         }
 239     }
 240
 241     if (bind_path) {
 242         struct sockaddr_un un;
 243         socklen_t un_len;
 244         make_sockaddr_un(bind_path, &un, &un_len);
 245         if (unlink(un.sun_path) && errno != ENOENT) {
 246             VLOG_WARN("unlinking \"%s\": %s\n", un.sun_path, strerror(errno));
 247         }
 248         fatal_signal_add_file_to_unlink(bind_path);
 249         if (bind(fd, (struct sockaddr*) &un, un_len)
 250             || fchmod(fd, S_IRWXU)) {
 251             goto error;
 252         }
 253     }
 254
 255     if (connect_path) {
 256         struct sockaddr_un un;
 257         socklen_t un_len;
 258         make_sockaddr_un(connect_path, &un, &un_len);
 259         if (connect(fd, (struct sockaddr*) &un, un_len)
 260             && errno != EINPROGRESS) {
 261             goto error;
 262         }
 263     }
 264
 265 #ifdef SCM_CREDENTIALS
 266     if (passcred) {
 267         int enable = 1;
 268         if (setsockopt(fd, SOL_SOCKET, SO_PASSCRED, &enable, sizeof(enable))) {
 269             goto error;
 270         }
 271     }
 272 #endif
 273
 274     return fd;
 275
 276 error:
 277     if (bind_path) {
 278         fatal_signal_remove_file_to_unlink(bind_path);
 279     }
 280     error = errno;
 281     close(fd);
 282     return -error;
 283 }
 284
 285 int
 286 get_unix_name_len(socklen_t sun_len)
 287 {
 288     return (sun_len >= offsetof(struct sockaddr_un, sun_path)
 289             ? sun_len - offsetof(struct sockaddr_un, sun_path)
 290             : 0);
 291 }
 292
 293 uint32_t
 294 guess_netmask(uint32_t ip)
 295 {
 296     ip = ntohl(ip);
 297     return ((ip >> 31) == 0 ? htonl(0xff000000)   /* Class A */
 298             : (ip >> 30) == 2 ? htonl(0xffff0000) /* Class B */
 299             : (ip >> 29) == 6 ? htonl(0xffffff00) /* Class C */
 300             : htonl(0));                          /* ??? */
 301 }
 302
 303 /* Opens a non-blocking TCP socket and connects to 'target', which should be a
 304  * string in the format "<host>[:<port>]", where <host> is required and <port>
 305  * is optional, with 'default_port' assumed if <port> is omitted.
 306  *
 307  * On success, returns 0 (indicating connection complete) or EAGAIN (indicating
 308  * connection in progress), in which case the new file descriptor is stored
 309  * into '*fdp'.  On failure, returns a positive errno value other than EAGAIN
 310  * and stores -1 into '*fdp'.
 311  *
 312  * If 'sinp' is non-null, then on success the target address is stored into
 313  * '*sinp'. */
 314 int
 315 tcp_open_active(const char *target_, uint16_t default_port,
 316                 struct sockaddr_in *sinp, int *fdp)
 317 {
 318     char *target = xstrdup(target_);
 319     char *save_ptr = NULL;
 320     const char *host_name;
 321     const char *port_string;
 322     struct sockaddr_in sin;
 323     int fd = -1;
 324     int error;
 325
 326     /* Defaults. */
 327     memset(&sin, 0, sizeof sin);
 328     sin.sin_family = AF_INET;
 329     sin.sin_port = htons(default_port);
 330
 331     /* Tokenize. */
 332     host_name = strtok_r(target, ":", &save_ptr);
 333     port_string = strtok_r(NULL, ":", &save_ptr);
 334     if (!host_name) {
 335         ovs_error(0, "%s: bad peer name format", target_);
 336         error = EAFNOSUPPORT;
 337         goto exit;
 338     }
 339
 340     /* Look up IP, port. */
 341     error = lookup_ip(host_name, &sin.sin_addr);
 342     if (error) {
 343         goto exit;
 344     }
 345     if (port_string && atoi(port_string)) {
 346         sin.sin_port = htons(atoi(port_string));
 347     }
 348
 349     /* Create non-blocking socket. */
 350     fd = socket(AF_INET, SOCK_STREAM, 0);
 351     if (fd < 0) {
 352         VLOG_ERR("%s: socket: %s", target_, strerror(errno));
 353         error = errno;
 354         goto exit;
 355     }
 356     error = set_nonblocking(fd);
 357     if (error) {
 358         goto exit_close;
 359     }
 360
 361     /* Connect. */
 362     error = connect(fd, (struct sockaddr *) &sin, sizeof sin) == 0 ? 0 : errno;
 363     if (error == EINPROGRESS) {
 364         error = EAGAIN;
 365     } else if (error && error != EAGAIN) {
 366         goto exit_close;
 367     }
 368
 369     /* Success: error is 0 or EAGAIN. */
 370     goto exit;
 371
 372 exit_close:
 373     close(fd);
 374 exit:
 375     if (!error || error == EAGAIN) {
 376         if (sinp) {
 377             *sinp = sin;
 378         }
 379         *fdp = fd;
 380     } else {
 381         *fdp = -1;
 382     }
 383     free(target);
 384     return error;
 385 }
 386
 387 /* Opens a non-blocking TCP socket, binds to 'target', and listens for incoming
 388  * connections.  'target' should be a string in the format "[<port>][:<ip>]",
 389  * where both <port> and <ip> are optional.  If <port> is omitted, it defaults
 390  * to 'default_port'; if <ip> is omitted it defaults to the wildcard IP
 391  * address.
 392  *
 393  * The socket will have SO_REUSEADDR turned on.
 394  *
 395  * On success, returns a non-negative file descriptor.  On failure, returns a
 396  * negative errno value. */
 397 int
 398 tcp_open_passive(const char *target_, uint16_t default_port)
 399 {
 400     char *target = xstrdup(target_);
 401     char *string_ptr = target;
 402     struct sockaddr_in sin;
 403     const char *host_name;
 404     const char *port_string;
 405     int fd, error;
 406     unsigned int yes  = 1;
 407
 408     /* Address defaults. */
 409     memset(&sin, 0, sizeof sin);
 410     sin.sin_family = AF_INET;
 411     sin.sin_addr.s_addr = htonl(INADDR_ANY);
 412     sin.sin_port = htons(default_port);
 413
 414     /* Parse optional port number. */
 415     port_string = strsep(&string_ptr, ":");
 416     if (port_string && atoi(port_string)) {
 417         sin.sin_port = htons(atoi(port_string));
 418     }
 419
 420     /* Parse optional bind IP. */
 421     host_name = strsep(&string_ptr, ":");
 422     if (host_name && host_name[0]) {
 423         error = lookup_ip(host_name, &sin.sin_addr);
 424         if (error) {
 425             goto exit;
 426         }
 427     }
 428
 429     /* Create non-blocking socket, set SO_REUSEADDR. */
 430     fd = socket(AF_INET, SOCK_STREAM, 0);
 431     if (fd < 0) {
 432         error = errno;
 433         VLOG_ERR("%s: socket: %s", target_, strerror(error));
 434         goto exit;
 435     }
 436     error = set_nonblocking(fd);
 437     if (error) {
 438         goto exit_close;
 439     }
 440     if (setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &yes, sizeof yes) < 0) {
 441         error = errno;
 442         VLOG_ERR("%s: setsockopt(SO_REUSEADDR): %s", target_, strerror(error));
 443         goto exit_close;
 444     }
 445
 446     /* Bind. */
 447     if (bind(fd, (struct sockaddr *) &sin, sizeof sin) < 0) {
 448         error = errno;
 449         VLOG_ERR("%s: bind: %s", target_, strerror(error));
 450         goto exit_close;
 451     }
 452
 453     /* Listen. */
 454     if (listen(fd, 10) < 0) {
 455         error = errno;
 456         VLOG_ERR("%s: listen: %s", target_, strerror(error));
 457         goto exit_close;
 458     }
 459     error = 0;
 460     goto exit;
 461
 462 exit_close:
 463     close(fd);
 464 exit:
 465     free(target);
 466     return error ? -error : fd;
 467 }
 468
 469 int
 470 read_fully(int fd, void *p_, size_t size, size_t *bytes_read)
 471 {
 472     uint8_t *p = p_;
 473
 474     *bytes_read = 0;
 475     while (size > 0) {
 476         ssize_t retval = read(fd, p, size);
 477         if (retval > 0) {
 478             *bytes_read += retval;
 479             size -= retval;
 480             p += retval;
 481         } else if (retval == 0) {
 482             return EOF;
 483         } else if (errno != EINTR) {
 484             return errno;
 485         }
 486     }
 487     return 0;
 488 }
 489
 490 int
 491 write_fully(int fd, const void *p_, size_t size, size_t *bytes_written)
 492 {
 493     const uint8_t *p = p_;
 494
 495     *bytes_written = 0;
 496     while (size > 0) {
 497         ssize_t retval = write(fd, p, size);
 498         if (retval > 0) {
 499             *bytes_written += retval;
 500             size -= retval;
 501             p += retval;
 502         } else if (retval == 0) {
 503             VLOG_WARN("write returned 0");
 504             return EPROTO;
 505         } else if (errno != EINTR) {
 506             return errno;
 507         }
 508     }
 509     return 0;
 510 }