Fixed a bunch of "warn_unused_result" compiler warnings.
[rsync/rsync.git] / socket.c
index c6341ce..0ad766d 100644 (file)
--- a/socket.c
+++ b/socket.c
@@ -1,40 +1,43 @@
-/* -*- c-file-style: "linux" -*-
-
-   rsync -- fast file replication program
-
-   Copyright (C) 1992-2001 by Andrew Tridgell <tridge@samba.org>
-   Copyright (C) 2001, 2002 by Martin Pool <mbp@samba.org>
-
-   This program is free software; you can redistribute it and/or modify
-   it under the terms of the GNU General Public License as published by
-   the Free Software Foundation; either version 2 of the License, or
-   (at your option) any later version.
-
-   This program is distributed in the hope that it will be useful,
-   but WITHOUT ANY WARRANTY; without even the implied warranty of
-   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-   GNU General Public License for more details.
-
-   You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software
-   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-*/
-
-/**
- * @file socket.c
- *
+/*
  * Socket functions used in rsync.
  *
- * This file is now converted to use the new-style getaddrinfo()
+ * Copyright (C) 1992-2001 Andrew Tridgell <tridge@samba.org>
+ * Copyright (C) 2001, 2002 Martin Pool <mbp@samba.org>
+ * Copyright (C) 2003-2008 Wayne Davison
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, visit the http://fsf.org website.
+ */
+
+/* This file is now converted to use the new-style getaddrinfo()
  * interface, which supports IPv6 but is also supported on recent
  * IPv4-only machines.  On systems that don't have that interface, we
- * emulate it using the KAME implementation.
- **/
+ * emulate it using the KAME implementation. */
 
 #include "rsync.h"
+#include "itypes.h"
+#include <netinet/in_systm.h>
+#include <netinet/ip.h>
+#include <netinet/tcp.h>
 
 extern char *bind_address;
+extern char *sockopts;
 extern int default_af_hint;
+extern int connect_timeout;
+
+#ifdef HAVE_SIGACTION
+static struct sigaction sigact;
+#endif
 
 /**
  * Establish a proxy connection on an open socket to a web proxy by
@@ -54,13 +57,13 @@ static int establish_proxy_connection(int fd, char *host, int port,
                         proxy_user, ":", proxy_pass, NULL);
                len = strlen(buffer);
 
-               if ((len*8 + 5) / 6 >= (int)sizeof authbuf) {
+               if ((len*8 + 5) / 6 >= (int)sizeof authbuf - 3) {
                        rprintf(FERROR,
                                "authentication information is too long\n");
                        return -1;
                }
 
-               base64_encode(buffer, len, authbuf);
+               base64_encode(buffer, len, authbuf, 1);
                authhdr = "\r\nProxy-Authorization: Basic ";
        } else {
                *authbuf = '\0';
@@ -94,7 +97,7 @@ static int establish_proxy_connection(int fd, char *host, int port,
                        buffer);
                return -1;
        }
-       for (cp = &buffer[5]; isdigit(*(uchar*)cp) || *cp == '.'; cp++) {}
+       for (cp = &buffer[5]; isDigit(cp) || *cp == '.'; cp++) {}
        while (*cp == ' ')
                cp++;
        if (*cp != '2') {
@@ -127,7 +130,7 @@ static int establish_proxy_connection(int fd, char *host, int port,
  * if this fails.
  **/
 int try_bind_local(int s, int ai_family, int ai_socktype,
-                  const char *bind_address)
+                  const char *bind_addr)
 {
        int error;
        struct addrinfo bhints, *bres_all, *r;
@@ -136,9 +139,9 @@ int try_bind_local(int s, int ai_family, int ai_socktype,
        bhints.ai_family = ai_family;
        bhints.ai_socktype = ai_socktype;
        bhints.ai_flags = AI_PASSIVE;
-       if ((error = getaddrinfo(bind_address, NULL, &bhints, &bres_all))) {
+       if ((error = getaddrinfo(bind_addr, NULL, &bhints, &bres_all))) {
                rprintf(FERROR, RSYNC_NAME ": getaddrinfo %s: %s\n",
-                       bind_address, gai_strerror(error));
+                       bind_addr, gai_strerror(error));
                return -1;
        }
 
@@ -156,6 +159,11 @@ int try_bind_local(int s, int ai_family, int ai_socktype,
        return -1;
 }
 
+/* connect() timeout handler based on alarm() */
+static RETSIGTYPE contimeout_handler(UNUSED(int val))
+{
+       connect_timeout = -1;
+}
 
 /**
  * Open a socket to a tcp remote host with the specified port .
@@ -172,12 +180,12 @@ int try_bind_local(int s, int ai_family, int ai_socktype,
  * reachable, perhaps because we can't e.g. route ipv6 to that network
  * but we can get ip4 packets through.
  *
- * @param bind_address Local address to use.  Normally NULL to bind
+ * @param bind_addr Local address to use.  Normally NULL to bind
  * the wildcard address.
  *
  * @param af_hint Address family, e.g. AF_INET or AF_INET6.
  **/
-int open_socket_out(char *host, int port, const char *bind_address,
+int open_socket_out(char *host, int port, const char *bind_addr,
                    int af_hint)
 {
        int type = SOCK_STREAM;
@@ -224,7 +232,7 @@ int open_socket_out(char *host, int port, const char *bind_address,
                }
                *cp++ = '\0';
                strlcpy(portbuf, cp, sizeof portbuf);
-               if (verbose >= 2) {
+               if (DEBUG_GTE(CONNECT, 1)) {
                        rprintf(FINFO, "connection via http proxy %s port %s\n",
                                h, portbuf);
                }
@@ -253,18 +261,35 @@ int open_socket_out(char *host, int port, const char *bind_address,
                if (s < 0)
                        continue;
 
-               if (bind_address
+               if (bind_addr
                 && try_bind_local(s, res->ai_family, type,
-                                  bind_address) == -1) {
+                                  bind_addr) == -1) {
                        close(s);
                        s = -1;
                        continue;
                }
-               if (connect(s, res->ai_addr, res->ai_addrlen) < 0) {
+               if (connect_timeout > 0) {
+                       SIGACTION(SIGALRM, contimeout_handler);
+                       alarm(connect_timeout);
+               }
+
+               set_socket_options(s, sockopts);
+               while (connect(s, res->ai_addr, res->ai_addrlen) < 0) {
+                       if (connect_timeout < 0)
+                               exit_cleanup(RERR_CONTIMEOUT);
+                       if (errno == EINTR)
+                               continue;
                        close(s);
                        s = -1;
-                       continue;
+                       break;
                }
+
+               if (connect_timeout > 0)
+                       alarm(0);
+
+               if (s < 0)
+                       continue;
+
                if (proxied
                 && establish_proxy_connection(s, host, port,
                                               proxy_user, proxy_pass) != 0) {
@@ -293,21 +318,57 @@ int open_socket_out(char *host, int port, const char *bind_address,
  *
  * This is based on the Samba LIBSMB_PROG feature.
  *
- * @param bind_address Local address to use.  Normally NULL to get the stack default.
+ * @param bind_addr Local address to use.  Normally NULL to get the stack default.
  **/
-int open_socket_out_wrapped(char *host, int port, const char *bind_address,
+int open_socket_out_wrapped(char *host, int port, const char *bind_addr,
                            int af_hint)
 {
        char *prog = getenv("RSYNC_CONNECT_PROG");
 
-       if (verbose >= 2) {
+       if (prog && strchr(prog, '%')) {
+               int hlen = strlen(host);
+               int len = strlen(prog) + 1;
+               char *f, *t;
+               for (f = prog; *f; f++) {
+                       if (*f != '%')
+                               continue;
+                       /* Compute more than enough room. */
+                       if (f[1] == '%')
+                               f++;
+                       else
+                               len += hlen;
+               }
+               f = prog;
+               if (!(prog = new_array(char, len)))
+                       out_of_memory("open_socket_out_wrapped");
+               for (t = prog; *f; f++) {
+                       if (*f == '%') {
+                               switch (*++f) {
+                               case '%':
+                                       /* Just skips the extra '%'. */
+                                       break;
+                               case 'H':
+                                       memcpy(t, host, hlen);
+                                       t += hlen;
+                                       continue;
+                               default:
+                                       f--; /* pass % through */
+                                       break;
+                               }
+                       }
+                       *t++ = *f;
+               }
+               *t = '\0';
+       }
+
+       if (DEBUG_GTE(CONNECT, 1)) {
                rprintf(FINFO, "%sopening tcp connection to %s port %d\n",
                        prog ? "Using RSYNC_CONNECT_PROG instead of " : "",
                        host, port);
        }
        if (prog)
                return sock_exec(prog);
-       return open_socket_out(host, port, bind_address, af_hint);
+       return open_socket_out(host, port, bind_addr, af_hint);
 }
 
 
@@ -322,16 +383,16 @@ int open_socket_out_wrapped(char *host, int port, const char *bind_address,
  * We return an array of file-descriptors to the sockets, with a trailing
  * -1 value to indicate the end of the list.
  *
- * @param bind_address Local address to bind, or NULL to allow it to
+ * @param bind_addr Local address to bind, or NULL to allow it to
  * default.
  **/
-static int *open_socket_in(int type, int port, const char *bind_address,
+static int *open_socket_in(int type, int port, const char *bind_addr,
                           int af_hint)
 {
        int one = 1;
-       int s, *socks, maxs, i;
+       int s, *socks, maxs, i, ecnt;
        struct addrinfo hints, *all_ai, *resp;
-       char portbuf[10];
+       char portbuf[10], **errmsgs;
        int error;
 
        memset(&hints, 0, sizeof hints);
@@ -339,33 +400,45 @@ static int *open_socket_in(int type, int port, const char *bind_address,
        hints.ai_socktype = type;
        hints.ai_flags = AI_PASSIVE;
        snprintf(portbuf, sizeof portbuf, "%d", port);
-       error = getaddrinfo(bind_address, portbuf, &hints, &all_ai);
+       error = getaddrinfo(bind_addr, portbuf, &hints, &all_ai);
        if (error) {
                rprintf(FERROR, RSYNC_NAME ": getaddrinfo: bind address %s: %s\n",
-                       bind_address, gai_strerror(error));
+                       bind_addr, gai_strerror(error));
                return NULL;
        }
 
        /* Count max number of sockets we might open. */
        for (maxs = 0, resp = all_ai; resp; resp = resp->ai_next, maxs++) {}
 
-       if (!(socks = new_array(int, maxs + 1)))
+       socks = new_array(int, maxs + 1);
+       errmsgs = new_array(char *, maxs);
+       if (!socks || !errmsgs)
                out_of_memory("open_socket_in");
 
        /* We may not be able to create the socket, if for example the
         * machine knows about IPv6 in the C library, but not in the
         * kernel. */
-       for (resp = all_ai, i = 0; resp; resp = resp->ai_next) {
+       for (resp = all_ai, i = ecnt = 0; resp; resp = resp->ai_next) {
                s = socket(resp->ai_family, resp->ai_socktype,
                           resp->ai_protocol);
 
                if (s == -1) {
+                       int r = asprintf(&errmsgs[ecnt++],
+                               "socket(%d,%d,%d) failed: %s\n",
+                               (int)resp->ai_family, (int)resp->ai_socktype,
+                               (int)resp->ai_protocol, strerror(errno));
+                       if (r < 0)
+                               out_of_memory("open_socket_in");
                        /* See if there's another address that will work... */
                        continue;
                }
 
                setsockopt(s, SOL_SOCKET, SO_REUSEADDR,
                           (char *)&one, sizeof one);
+               if (sockopts)
+                       set_socket_options(s, sockopts);
+               else
+                       set_socket_options(s, lp_socket_options());
 
 #ifdef IPV6_V6ONLY
                if (resp->ai_family == AF_INET6) {
@@ -381,6 +454,11 @@ static int *open_socket_in(int type, int port, const char *bind_address,
                /* Now we've got a socket - we need to bind it. */
                if (bind(s, resp->ai_addr, resp->ai_addrlen) < 0) {
                        /* Nope, try another */
+                       int r = asprintf(&errmsgs[ecnt++],
+                               "bind() failed: %s (address-family %d)\n",
+                               strerror(errno), (int)resp->ai_family);
+                       if (r < 0)
+                               out_of_memory("open_socket_in");
                        close(s);
                        continue;
                }
@@ -392,6 +470,15 @@ static int *open_socket_in(int type, int port, const char *bind_address,
        if (all_ai)
                freeaddrinfo(all_ai);
 
+       /* Only output the socket()/bind() messages if we were totally
+        * unsuccessful, or if the daemon is being run with -vv. */
+       for (s = 0; s < ecnt; s++) {
+               if (!i || DEBUG_GTE(BIND, 1))
+                       rwrite(FLOG, errmsgs[s], strlen(errmsgs[s]), 0);
+               free(errmsgs[s]);
+       }
+       free(errmsgs);
+
        if (!i) {
                rprintf(FERROR,
                        "unable to bind any inbound sockets on port %d\n",
@@ -433,7 +520,9 @@ static RETSIGTYPE sigchld_handler(UNUSED(int val))
 #ifdef WNOHANG
        while (waitpid(-1, NULL, WNOHANG) > 0) {}
 #endif
+#ifndef HAVE_SIGACTION
        signal(SIGCHLD, sigchld_handler);
+#endif
 }
 
 
@@ -442,6 +531,10 @@ void start_accept_loop(int port, int (*fn)(int, int))
        fd_set deffds;
        int *sp, maxfd, i;
 
+#ifdef HAVE_SIGACTION
+       sigact.sa_flags = SA_NOCLDSTOP;
+#endif
+
        /* open an incoming socket */
        sp = open_socket_in(SOCK_STREAM, port, bind_address, default_af_hint);
        if (sp == NULL)
@@ -465,7 +558,6 @@ void start_accept_loop(int port, int (*fn)(int, int))
                        maxfd = sp[i];
        }
 
-
        /* now accept incoming connections - forking a new process
         * for each incoming connection */
        while (1) {
@@ -478,7 +570,7 @@ void start_accept_loop(int port, int (*fn)(int, int))
                /* close log file before the potentially very long select so
                 * file can be trimmed by another process instead of growing
                 * forever */
-               log_close();
+               logfile_close();
 
 #ifdef FD_COPY
                FD_COPY(&deffds, &fds);
@@ -500,15 +592,15 @@ void start_accept_loop(int port, int (*fn)(int, int))
                if (fd < 0)
                        continue;
 
-               signal(SIGCHLD, sigchld_handler);
+               SIGACTION(SIGCHLD, sigchld_handler);
 
                if ((pid = fork()) == 0) {
                        int ret;
                        for (i = 0; sp[i] >= 0; i++)
                                close(sp[i]);
                        /* Re-open log file in child before possibly giving
-                        * up privileges (see log_close() above). */
-                       log_open();
+                        * up privileges (see logfile_close() above). */
+                       logfile_reopen();
                        ret = fn(fd, fd);
                        close_all();
                        _exit(ret);
@@ -639,35 +731,6 @@ void set_socket_options(int fd, char *options)
        free(options);
 }
 
-/**
- * Become a daemon, discarding the controlling terminal
- **/
-void become_daemon(void)
-{
-       int i;
-
-       if (fork()) {
-               _exit(0);
-       }
-
-       /* detach from the terminal */
-#ifdef HAVE_SETSID
-       setsid();
-#elif defined TIOCNOTTY
-       i = open("/dev/tty", O_RDWR);
-       if (i >= 0) {
-               ioctl(i, (int)TIOCNOTTY, (char *)0);
-               close(i);
-       }
-#endif
-       /* make sure that stdin, stdout an stderr don't stuff things
-        * up (library functions, for example) */
-       for (i = 0; i < 3; i++) {
-               close(i);
-               open("/dev/null", O_RDWR);
-       }
-}
-
 
 /**
  * This is like socketpair but uses tcp. It is used by the Samba
@@ -760,22 +823,32 @@ static int socketpair_tcp(int fd[2])
  **/
 int sock_exec(const char *prog)
 {
+       pid_t pid;
        int fd[2];
 
        if (socketpair_tcp(fd) != 0) {
                rsyserr(FERROR, errno, "socketpair_tcp failed");
                return -1;
        }
-       if (verbose >= 2)
+       if (DEBUG_GTE(CMD, 1))
                rprintf(FINFO, "Running socket program: \"%s\"\n", prog);
-       if (fork() == 0) {
+
+       pid = fork();
+       if (pid < 0) {
+               rsyserr(FERROR, errno, "fork");
+               exit_cleanup(RERR_IPC);
+       }
+
+       if (pid == 0) {
                close(fd[0]);
-               close(0);
-               close(1);
-               dup(fd[1]);
-               dup(fd[1]);
+               if (dup2(fd[1], STDIN_FILENO) < 0
+                || dup2(fd[1], STDOUT_FILENO) < 0) {
+                       fprintf(stderr, "Failed to run \"%s\"\n", prog);
+                       exit(1);
+               }
                exit(system(prog));
        }
+
        close(fd[1]);
        return fd[0];
 }