Change args to file_checksum() to prepare for future changes.
[rsync.git] / io.c
diff --git a/io.c b/io.c
index 6c2b220fb886f8a4e3d026032d15b6796dea4598..b9a9bd0827376d78fd3631d14f6c691d25a29efc 100644 (file)
--- a/io.c
+++ b/io.c
@@ -4,7 +4,7 @@
  * Copyright (C) 1996-2001 Andrew Tridgell
  * Copyright (C) 1996 Paul Mackerras
  * Copyright (C) 2001, 2002 Martin Pool <mbp@samba.org>
- * Copyright (C) 2003-2009 Wayne Davison
+ * Copyright (C) 2003-2014 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
@@ -50,12 +50,14 @@ extern int file_total;
 extern int file_old_total;
 extern int list_only;
 extern int read_batch;
+extern int compat_flags;
 extern int protect_args;
 extern int checksum_seed;
 extern int protocol_version;
 extern int remove_source_files;
 extern int preserve_hard_links;
 extern BOOL extra_flist_sending_enabled;
+extern BOOL flush_ok_after_signal;
 extern struct stats stats;
 extern struct file_list *cur_flist;
 #ifdef ICONV_OPTION
@@ -69,10 +71,10 @@ int batch_fd = -1;
 int msgdone_cnt = 0;
 int forward_flist_data = 0;
 BOOL flist_receiving_enabled = False;
-BOOL we_send_keepalive_messages = False;
 
 /* Ignore an EOF error if non-zero. See whine_about_eof(). */
 int kluge_around_eof = 0;
+int got_kill_signal = -1; /* is set to 0 only after multiplexed I/O starts */
 
 int sock_f_in = -1;
 int sock_f_out = -1;
@@ -153,28 +155,36 @@ static void read_a_msg(void);
 static void drain_multiplex_messages(void);
 static void sleep_for_bwlimit(int bytes_written);
 
-static void check_timeout(BOOL allow_keepalive)
+static void check_timeout(BOOL allow_keepalive, int keepalive_flags)
 {
        time_t t, chk;
 
-       /* On the receiving side, the generator is now handling timeouts, so
-        * the receiver ignores them.  Note that the am_receiver flag is not
-        * set until the receiver forks from the generator, so timeouts will be
-        * based on receiving data on the receiving side until that event. */
-       if (!io_timeout || am_receiver)
+       /* On the receiving side, the generator is now the one that decides
+        * when a timeout has occurred.  When it is sifting through a lot of
+        * files looking for work, it will be sending keep-alive messages to
+        * the sender, and even though the receiver won't be sending/receiving
+        * anything (not even keep-alive messages), the successful writes to
+        * the sender will keep things going.  If the receiver is actively
+        * receiving data, it will ensure that the generator knows that it is
+        * not idle by sending the generator keep-alive messages (since the
+        * generator might be blocked trying to send checksums, it needs to
+        * know that the receiver is active).  Thus, as long as one or the
+        * other is successfully doing work, the generator will not timeout. */
+       if (!io_timeout)
                return;
 
        t = time(NULL);
 
-       if (allow_keepalive && we_send_keepalive_messages) {
+       if (allow_keepalive) {
                /* This may put data into iobuf.msg w/o flushing. */
-               maybe_send_keepalive(t, False);
+               maybe_send_keepalive(t, keepalive_flags);
        }
 
        if (!last_io_in)
                last_io_in = t;
-       if (!last_io_out)
-               last_io_out = t;
+
+       if (am_receiver)
+               return;
 
        chk = MAX(last_io_out, last_io_in);
        if (t - chk >= io_timeout) {
@@ -222,28 +232,10 @@ static NORETURN void whine_about_eof(BOOL allow_kluge)
  * the socket except very early in the transfer. */
 static size_t safe_read(int fd, char *buf, size_t len)
 {
-       size_t got;
-       int n;
+       size_t got = 0;
 
        assert(fd != iobuf.in_fd);
 
-       n = read(fd, buf, len);
-       if ((size_t)n == len || n == 0) {
-               if (DEBUG_GTE(IO, 2))
-                       rprintf(FINFO, "[%s] safe_read(%d)=%ld\n", who_am_i(), fd, (long)n);
-               return n;
-       }
-       if (n < 0) {
-               if (errno != EINTR && errno != EWOULDBLOCK && errno != EAGAIN) {
-                 read_failed:
-                       rsyserr(FERROR, errno, "safe_read failed to read %ld bytes [%s]",
-                               (long)len, who_am_i());
-                       exit_cleanup(RERR_STREAMIO);
-               }
-               got = 0;
-       } else
-               got = n;
-
        while (1) {
                struct timeval tv;
                fd_set r_fds, e_fds;
@@ -263,8 +255,7 @@ static size_t safe_read(int fd, char *buf, size_t len)
                                        who_am_i());
                                exit_cleanup(RERR_FILEIO);
                        }
-                       if (we_send_keepalive_messages)
-                               maybe_send_keepalive(time(NULL), True);
+                       check_timeout(1, MSK_ALLOW_FLUSH);
                        continue;
                }
 
@@ -272,7 +263,7 @@ static size_t safe_read(int fd, char *buf, size_t len)
                        rprintf(FINFO, "select exception on fd %d\n", fd); */
 
                if (FD_ISSET(fd, &r_fds)) {
-                       n = read(fd, buf + got, len - got);
+                       int n = read(fd, buf + got, len - got);
                        if (DEBUG_GTE(IO, 2))
                                rprintf(FINFO, "[%s] safe_read(%d)=%ld\n", who_am_i(), fd, (long)n);
                        if (n == 0)
@@ -280,7 +271,9 @@ static size_t safe_read(int fd, char *buf, size_t len)
                        if (n < 0) {
                                if (errno == EINTR)
                                        continue;
-                               goto read_failed;
+                               rsyserr(FERROR, errno, "safe_read failed to read %ld bytes [%s]",
+                                       (long)len, who_am_i());
+                               exit_cleanup(RERR_STREAMIO);
                        }
                        if ((got += (size_t)n) == len)
                                break;
@@ -348,8 +341,8 @@ static void safe_write(int fd, const char *buf, size_t len)
                                        what_fd_is(fd), who_am_i());
                                exit_cleanup(RERR_FILEIO);
                        }
-                       if (we_send_keepalive_messages)
-                               maybe_send_keepalive(time(NULL), True);
+                       if (io_timeout)
+                               maybe_send_keepalive(time(NULL), MSK_ALLOW_FLUSH);
                        continue;
                }
 
@@ -472,7 +465,8 @@ static void forward_filesfrom_data(void)
 void reduce_iobuf_size(xbuf *out, size_t new_size)
 {
        if (new_size < out->size) {
-               if (DEBUG_GTE(IO, 4)) {
+               /* Avoid weird buffer interactions by only outputting this to stderr. */
+               if (msgs2stderr && DEBUG_GTE(IO, 4)) {
                        const char *name = out == &iobuf.out ? "iobuf.out"
                                         : out == &iobuf.msg ? "iobuf.msg"
                                         : NULL;
@@ -489,7 +483,8 @@ void restore_iobuf_size(xbuf *out)
 {
        if (IOBUF_WAS_REDUCED(out->size)) {
                size_t new_size = IOBUF_RESTORE_SIZE(out->size);
-               if (DEBUG_GTE(IO, 4)) {
+               /* Avoid weird buffer interactions by only outputting this to stderr. */
+               if (msgs2stderr && DEBUG_GTE(IO, 4)) {
                        const char *name = out == &iobuf.out ? "iobuf.out"
                                         : out == &iobuf.msg ? "iobuf.msg"
                                         : NULL;
@@ -502,6 +497,13 @@ void restore_iobuf_size(xbuf *out)
        }
 }
 
+static void handle_kill_signal(BOOL flush_ok)
+{
+       got_kill_signal = -1;
+       flush_ok_after_signal = flush_ok;
+       exit_cleanup(RERR_SIGNAL);
+}
+
 /* Perform buffered input and/or output until specified conditions are met.
  * When given a "needed" read or write request, this returns without doing any
  * I/O if the needed input bytes or write space is already available.  Once I/O
@@ -566,7 +568,7 @@ static char *perform_io(size_t needed, int flags)
                        exit_cleanup(RERR_PROTOCOL);
                }
 
-               if (DEBUG_GTE(IO, 3)) {
+               if (msgs2stderr && DEBUG_GTE(IO, 3)) {
                        rprintf(FINFO, "[%s] perform_io(%ld, %sinput)\n",
                                who_am_i(), (long)needed, flags & PIO_CONSUME_INPUT ? "consume&" : "");
                }
@@ -580,7 +582,7 @@ static char *perform_io(size_t needed, int flags)
                        exit_cleanup(RERR_PROTOCOL);
                }
 
-               if (DEBUG_GTE(IO, 3)) {
+               if (msgs2stderr && DEBUG_GTE(IO, 3)) {
                        rprintf(FINFO, "[%s] perform_io(%ld, outroom) needs to flush %ld\n",
                                who_am_i(), (long)needed,
                                iobuf.out.len + needed > iobuf.out.size
@@ -596,7 +598,7 @@ static char *perform_io(size_t needed, int flags)
                        exit_cleanup(RERR_PROTOCOL);
                }
 
-               if (DEBUG_GTE(IO, 3)) {
+               if (msgs2stderr && DEBUG_GTE(IO, 3)) {
                        rprintf(FINFO, "[%s] perform_io(%ld, msgroom) needs to flush %ld\n",
                                who_am_i(), (long)needed,
                                iobuf.msg.len + needed > iobuf.msg.size
@@ -605,7 +607,7 @@ static char *perform_io(size_t needed, int flags)
                break;
 
        case 0:
-               if (DEBUG_GTE(IO, 3))
+               if (msgs2stderr && DEBUG_GTE(IO, 3))
                        rprintf(FINFO, "[%s] perform_io(%ld, %d)\n", who_am_i(), (long)needed, flags);
                break;
 
@@ -663,7 +665,7 @@ static char *perform_io(size_t needed, int flags)
                                        SIVAL(iobuf.out.buf + iobuf.raw_data_header_pos, 0,
                                              ((MPLEX_BASE + (int)MSG_DATA)<<24) + iobuf.out.len - 4);
 
-                                       if (DEBUG_GTE(IO, 1)) {
+                                       if (msgs2stderr && DEBUG_GTE(IO, 1)) {
                                                rprintf(FINFO, "[%s] send_msg(%d, %ld)\n",
                                                        who_am_i(), (int)MSG_DATA, (long)iobuf.out.len - 4);
                                        }
@@ -723,8 +725,11 @@ static char *perform_io(size_t needed, int flags)
                        break;
                }
 
+               if (got_kill_signal > 0)
+                       handle_kill_signal(True);
+
                if (extra_flist_sending_enabled) {
-                       if (file_total - file_old_total < MAX_FILECNT_LOOKAHEAD)
+                       if (file_total - file_old_total < MAX_FILECNT_LOOKAHEAD && IN_MULTIPLEXED_AND_READY)
                                tv.tv_sec = 0;
                        else {
                                extra_flist_sending_enabled = False;
@@ -746,7 +751,7 @@ static char *perform_io(size_t needed, int flags)
                                send_extra_file_list(sock_f_out, -1);
                                extra_flist_sending_enabled = !flist_eof;
                        } else
-                               check_timeout((flags & PIO_NEED_INPUT) != 0);
+                               check_timeout((flags & PIO_NEED_INPUT) != 0, 0);
                        FD_ZERO(&r_fds); /* Just in case... */
                        FD_ZERO(&w_fds);
                }
@@ -783,8 +788,11 @@ static char *perform_io(size_t needed, int flags)
                        if (msgs2stderr && DEBUG_GTE(IO, 2))
                                rprintf(FINFO, "[%s] recv=%ld\n", who_am_i(), (long)n);
 
-                       if (io_timeout)
+                       if (io_timeout) {
                                last_io_in = time(NULL);
+                               if (flags & PIO_NEED_INPUT)
+                                       maybe_send_keepalive(last_io_in, 0);
+                       }
                        stats.total_read += n;
 
                        iobuf.in.len += n;
@@ -839,6 +847,9 @@ static char *perform_io(size_t needed, int flags)
                        }
                }
 
+               if (got_kill_signal > 0)
+                       handle_kill_signal(True);
+
                /* We need to help prevent deadlock by doing what reading
                 * we can whenever we are here trying to write. */
                if (IN_MULTIPLEXED_AND_READY && !(flags & PIO_NEED_INPUT)) {
@@ -858,6 +869,9 @@ static char *perform_io(size_t needed, int flags)
        }
   double_break:
 
+       if (got_kill_signal > 0)
+               handle_kill_signal(True);
+
        data = iobuf.in.buf + iobuf.in.pos;
 
        if (flags & PIO_CONSUME_INPUT) {
@@ -901,6 +915,9 @@ void noop_io_until_death(void)
 {
        char buf[1024];
 
+       if (!iobuf.in.buf || !iobuf.out.buf || iobuf.in_fd < 0 || iobuf.out_fd < 0 || kluge_around_eof)
+               return;
+
        kluge_around_eof = 2;
        /* Setting an I/O timeout ensures that if something inexplicably weird
         * happens, we won't hang around forever. */
@@ -1021,13 +1038,20 @@ static void got_flist_entry_status(enum festatus status, int ndx)
        case FES_SUCCESS:
                if (remove_source_files)
                        send_msg_int(MSG_SUCCESS, ndx);
+               /* FALL THROUGH */
+       case FES_NO_SEND:
+#ifdef SUPPORT_HARD_LINKS
                if (preserve_hard_links) {
                        struct file_struct *file = flist->files[ndx - flist->ndx_start];
                        if (F_IS_HLINKED(file)) {
+                               if (status == FES_NO_SEND)
+                                       flist_ndx_push(&hlink_list, -2); /* indicates a failure follows */
                                flist_ndx_push(&hlink_list, ndx);
-                               flist->in_progress++;
+                               if (inc_recurse)
+                                       flist->in_progress++;
                        }
                }
+#endif
                break;
        case FES_REDO:
                if (read_batch) {
@@ -1039,8 +1063,6 @@ static void got_flist_entry_status(enum festatus status, int ndx)
                        flist->to_redo++;
                flist_ndx_push(&redo_list, ndx);
                break;
-       case FES_NO_SEND:
-               break;
        }
 }
 
@@ -1055,13 +1077,15 @@ void io_set_sock_fds(int f_in, int f_out)
 void set_io_timeout(int secs)
 {
        io_timeout = secs;
+       allowed_lull = (io_timeout + 1) / 2;
 
-       if (!io_timeout || io_timeout > SELECT_TIMEOUT)
+       if (!io_timeout || allowed_lull > SELECT_TIMEOUT)
                select_timeout = SELECT_TIMEOUT;
        else
-               select_timeout = io_timeout;
+               select_timeout = allowed_lull;
 
-       allowed_lull = read_batch ? 0 : (io_timeout + 1) / 2;
+       if (read_batch)
+               allowed_lull = 0;
 }
 
 static void check_for_d_option_error(const char *msg)
@@ -1202,8 +1226,7 @@ void read_args(int f_in, char *mod_name, char *buf, size_t bufsiz, int rl_nulls,
               char ***argv_p, int *argc_p, char **request_p)
 {
        int maxargs = MAX_ARGS;
-       int dot_pos = 0;
-       int argc = 0;
+       int dot_pos = 0, argc = 0, request_len = 0;
        char **argv, *p;
        int rl_flags = (rl_nulls ? RL_EOL_NULLS : 0);
 
@@ -1216,6 +1239,9 @@ void read_args(int f_in, char *mod_name, char *buf, size_t bufsiz, int rl_nulls,
        if (mod_name && !protect_args)
                argv[argc++] = "rsyncd";
 
+       if (request_p)
+               *request_p = NULL;
+
        while (1) {
                if (read_line(f_in, buf, bufsiz, rl_flags) == 0)
                        break;
@@ -1227,9 +1253,14 @@ void read_args(int f_in, char *mod_name, char *buf, size_t bufsiz, int rl_nulls,
                }
 
                if (dot_pos) {
-                       if (request_p) {
-                               *request_p = strdup(buf);
-                               request_p = NULL;
+                       if (request_p && request_len < 1024) {
+                               int len = strlen(buf);
+                               if (request_len)
+                                       request_p[0][request_len++] = ' ';
+                               if (!(*request_p = realloc_array(*request_p, char, request_len + len + 1)))
+                                       out_of_memory("read_args");
+                               memcpy(*request_p + request_len, buf, len + 1);
+                               request_len += len;
                        }
                        if (mod_name)
                                glob_expand_module(mod_name, buf, &argv, &argc, &maxargs);
@@ -1335,12 +1366,28 @@ void maybe_flush_socket(int important)
  * rsync versions.  This avoids any message forwarding, and leaves the raw-data
  * stream alone (since we can never be quite sure if that stream is in the
  * right state for a keep-alive message). */
-void maybe_send_keepalive(time_t now, BOOL allow_flush)
+void maybe_send_keepalive(time_t now, int flags)
 {
+       if (flags & MSK_ACTIVE_RECEIVER)
+               last_io_in = now; /* Fudge things when we're working hard on the files. */
+
+       /* Early in the transfer (before the receiver forks) the receiving side doesn't
+        * care if it hasn't sent data in a while as long as it is receiving data (in
+        * fact, a pre-3.1.0 rsync would die if we tried to send it a keep alive during
+        * this time).  So, if we're an early-receiving proc, just return and let the
+        * incoming data determine if we timeout. */
+       if (!am_sender && !am_receiver && !am_generator)
+               return;
+
        if (now - last_io_out >= allowed_lull) {
+               /* The receiver is special:  it only sends keep-alive messages if it is
+                * actively receiving data.  Otherwise, it lets the generator timeout. */
+               if (am_receiver && now - last_io_in >= io_timeout)
+                       return;
+
                if (!iobuf.msg.len && iobuf.out.len == iobuf.out_empty_len)
                        send_msg(MSG_DATA, "", 0, 0);
-               if (!allow_flush) {
+               if (!(flags & MSK_ALLOW_FLUSH)) {
                        /* Let the caller worry about writing out the data. */
                } else if (iobuf.msg.len)
                        perform_io(iobuf.msg.size - iobuf.msg.len + 1, PIO_NEED_MSGROOM);
@@ -1407,12 +1454,12 @@ static void read_a_msg(void)
                got_flist_entry_status(FES_REDO, val);
                break;
        case MSG_IO_ERROR:
-               if (msg_bytes != 4 || am_sender)
+               if (msg_bytes != 4)
                        goto invalid_msg;
                val = raw_read_int();
                iobuf.in_multiplexed = 1;
                io_error |= val;
-               if (!am_generator)
+               if (am_receiver)
                        send_msg_int(MSG_IO_ERROR, val);
                break;
        case MSG_IO_TIMEOUT:
@@ -1432,7 +1479,7 @@ static void read_a_msg(void)
                        goto invalid_msg;
                iobuf.in_multiplexed = 1;
                if (am_sender)
-                       maybe_send_keepalive(time(NULL), True);
+                       maybe_send_keepalive(time(NULL), MSK_ALLOW_FLUSH);
                break;
        case MSG_DELETED:
                if (msg_bytes >= sizeof data)
@@ -1534,8 +1581,11 @@ static void read_a_msg(void)
                        exit_cleanup(RERR_STREAMIO);
                }
                raw_read_buf(data, msg_bytes);
-               iobuf.in_multiplexed = 1;
+               /* We don't set in_multiplexed value back to 1 before writing this message
+                * because the write might loop back and read yet another message, over and
+                * over again, while waiting for room to put the message in the msg buffer. */
                rwrite((enum logcode)tag, data, msg_bytes, !am_generator);
+               iobuf.in_multiplexed = 1;
                if (first_message) {
                        if (list_only && !am_sender && tag == 1 && msg_bytes < sizeof data) {
                                data[msg_bytes] = '\0';
@@ -1564,7 +1614,7 @@ static void read_a_msg(void)
                                io_flush(FULL_FLUSH);
                        }
                } else if (protocol_version >= 31) {
-                       if (am_generator) {
+                       if (am_generator || am_receiver) {
                                if (DEBUG_GTE(EXIT, 3)) {
                                        rprintf(FINFO, "[%s] sending MSG_ERROR_EXIT with exit_code %d\n",
                                                who_am_i(), val);
@@ -1735,7 +1785,7 @@ int64 read_varlong(int f, uchar min_bytes)
 #if SIZEOF_INT64 < 8
        u.x = IVAL(u.b,0);
 #elif CAREFUL_ALIGNMENT
-       u.x = IVAL(u.b,0) | (((int64)IVAL(u.b,4))<<32);
+       u.x = IVAL64(u.b,0);
 #endif
        return u.x;
 }
@@ -1911,7 +1961,7 @@ static void sleep_for_bwlimit(int bytes_written)
        if (prior_tv.tv_sec) {
                elapsed_usec = (start_tv.tv_sec - prior_tv.tv_sec) * ONE_SEC
                             + (start_tv.tv_usec - prior_tv.tv_usec);
-               total_written -= elapsed_usec * bwlimit / (ONE_SEC/1024);
+               total_written -= (int64)elapsed_usec * bwlimit / (ONE_SEC/1024);
                if (total_written < 0)
                        total_written = 0;
        }
@@ -1987,10 +2037,10 @@ void write_varlong(int f, int64 x, uchar min_bytes)
        uchar bit;
        int cnt = 8;
 
-       SIVAL(b, 1, x);
 #if SIZEOF_INT64 >= 8
-       SIVAL(b, 5, x >> 32);
+       SIVAL64(b, 1, x);
 #else
+       SIVAL(b, 1, x);
        if (x <= 0x7FFFFFFF && x >= 0)
                memset(b + 5, 0, 4);
        else {
@@ -2037,6 +2087,19 @@ void write_longint(int f, int64 x)
 #endif
 }
 
+void write_bigbuf(int f, const char *buf, size_t len)
+{
+       size_t half_max = (iobuf.out.size - iobuf.out_empty_len) / 2;
+
+       while (len > half_max + 1024) {
+               write_buf(f, buf, half_max);
+               buf += half_max;
+               len -= half_max;
+       }
+
+       write_buf(f, buf, len);
+}
+
 void write_buf(int f, const char *buf, size_t len)
 {
        size_t pos, siz;
@@ -2184,13 +2247,16 @@ int32 read_ndx(int f)
 /* Read a line of up to bufsiz-1 characters into buf.  Strips
  * the (required) trailing newline and all carriage returns.
  * Returns 1 for success; 0 for I/O error or truncation. */
-int read_line_old(int fd, char *buf, size_t bufsiz)
+int read_line_old(int fd, char *buf, size_t bufsiz, int eof_ok)
 {
+       assert(fd != iobuf.in_fd);
        bufsiz--; /* leave room for the null */
        while (bufsiz > 0) {
-               assert(fd != iobuf.in_fd);
-               if (safe_read(fd, buf, 1) == 0)
+               if (safe_read(fd, buf, 1) == 0) {
+                       if (eof_ok)
+                               break;
                        return 0;
+               }
                if (*buf == '\0')
                        return 0;
                if (*buf == '\n')
@@ -2238,6 +2304,7 @@ void io_start_multiplex_out(int fd)
 
        iobuf.out_empty_len = 4; /* See also OUT_MULTIPLEXED */
        io_start_buffering_out(fd);
+       got_kill_signal = 0;
 
        iobuf.raw_data_header_pos = iobuf.out.pos + iobuf.out.len;
        iobuf.out.len += 4;
@@ -2285,6 +2352,9 @@ int io_end_multiplex_out(int mode)
 
        iobuf.out.len = 0;
        iobuf.out_empty_len = 0;
+       if (got_kill_signal > 0) /* Just in case... */
+               handle_kill_signal(False);
+       got_kill_signal = -1;
 
        return ret;
 }
@@ -2298,7 +2368,7 @@ void start_write_batch(int fd)
         * is involved. */
        write_int(batch_fd, protocol_version);
        if (protocol_version >= 30)
-               write_byte(batch_fd, inc_recurse);
+               write_byte(batch_fd, compat_flags);
        write_int(batch_fd, checksum_seed);
 
        if (am_sender)