Make some RERR_* choices better, and another noop_io_until_death() tweak.
[rsync/rsync.git] / io.c
diff --git a/io.c b/io.c
index 1e2f218..4a6b95f 100644 (file)
--- a/io.c
+++ b/io.c
@@ -136,6 +136,7 @@ enum festatus { FES_SUCCESS, FES_REDO, FES_NO_SEND };
 
 static flist_ndx_list redo_list, hlink_list;
 
+static void drain_multiplex_messages(void);
 static void sleep_for_bwlimit(int bytes_written);
 
 static void check_timeout(void)
@@ -173,9 +174,9 @@ static void check_timeout(void)
  * There is another case for older protocol versions (< 24) where the module
  * listing was not terminated, so we must ignore an EOF error in that case and
  * exit.  In this situation, kluge_around_eof will be > 0. */
-static NORETURN void whine_about_eof(int fd)
+static NORETURN void whine_about_eof(BOOL allow_kluge)
 {
-       if (kluge_around_eof && fd == sock_f_in) {
+       if (kluge_around_eof && allow_kluge) {
                int i;
                if (kluge_around_eof > 0)
                        exit_cleanup(0);
@@ -541,8 +542,8 @@ static char *perform_io(size_t needed, int flags)
                if (DEBUG_GTE(IO, 3)) {
                        rprintf(FINFO, "[%s] perform_io(%ld, outroom) needs to flush %ld\n",
                                who_am_i(), (long)needed,
-                               iobuf.out.len > iobuf.out.size - needed
-                               ? (long)iobuf.out.len - (iobuf.out.size - needed) : 0L);
+                               iobuf.out.len + needed > iobuf.out.size
+                               ? (long)(iobuf.out.len + needed - iobuf.out.size) : 0L);
                }
                break;
 
@@ -557,8 +558,8 @@ static char *perform_io(size_t needed, int flags)
                if (DEBUG_GTE(IO, 3)) {
                        rprintf(FINFO, "[%s] perform_io(%ld, msgroom) needs to flush %ld\n",
                                who_am_i(), (long)needed,
-                               iobuf.out.len > iobuf.msg.size - needed
-                               ? (long)iobuf.out.len - (iobuf.msg.size - needed) : 0L);
+                               iobuf.msg.len + needed > iobuf.msg.size
+                               ? (long)(iobuf.msg.len + needed - iobuf.msg.size) : 0L);
                }
                break;
 
@@ -578,11 +579,13 @@ static char *perform_io(size_t needed, int flags)
                                goto double_break;
                        break;
                case PIO_NEED_OUTROOM:
-                       if (iobuf.out.len <= iobuf.out.size - needed)
+                       /* Note that iobuf.out_empty_len doesn't factor into this check
+                        * because iobuf.out.len already holds any needed header len. */
+                       if (iobuf.out.len + needed <= iobuf.out.size)
                                goto double_break;
                        break;
                case PIO_NEED_MSGROOM:
-                       if (iobuf.msg.len <= iobuf.msg.size - needed)
+                       if (iobuf.msg.len + needed <= iobuf.msg.size)
                                goto double_break;
                        break;
                }
@@ -612,21 +615,20 @@ static char *perform_io(size_t needed, int flags)
                        if (iobuf.raw_flushing_ends_before
                         || (!iobuf.msg.len && iobuf.out.len > iobuf.out_empty_len && !(flags & PIO_NEED_MSGROOM))) {
                                if (OUT_MULTIPLEXED && !iobuf.raw_flushing_ends_before) {
-                                       size_t val;
-
                                        /* The iobuf.raw_flushing_ends_before value can point off the end
                                         * of the iobuf.out buffer for a while, for easier subtracting. */
                                        iobuf.raw_flushing_ends_before = iobuf.out.pos + iobuf.out.len;
 
                                        SIVAL(iobuf.out.buf + iobuf.raw_data_header_pos, 0,
                                              ((MPLEX_BASE + (int)MSG_DATA)<<24) + iobuf.out.len - 4);
-                                       if ((val = iobuf.out.size - iobuf.raw_data_header_pos) < 4) {
+                                       if (iobuf.raw_data_header_pos + 4 > iobuf.out.size) {
+                                               int siz = (int)(iobuf.raw_data_header_pos + 4 - iobuf.out.size);
                                                /* We used some of the overflow bytes, so move them. */
                                                if (DEBUG_GTE(IO, 4)) {
                                                        rprintf(FINFO, "[%s] wrap-bytes moved: %d (perform_io)\n",
-                                                               who_am_i(), (int)val);
+                                                               who_am_i(), siz);
                                                }
-                                               memcpy(iobuf.out.buf, iobuf.out.buf + iobuf.out.size, 4 - val);
+                                               memcpy(iobuf.out.buf, iobuf.out.buf + iobuf.out.size, siz);
                                        }
 
                                        if (DEBUG_GTE(IO, 1)) {
@@ -638,6 +640,7 @@ static char *perform_io(size_t needed, int flags)
                                        iobuf.raw_data_header_pos = iobuf.raw_flushing_ends_before;
                                        if (iobuf.raw_data_header_pos >= iobuf.out.size)
                                                iobuf.raw_data_header_pos -= iobuf.out.size;
+                                       /* Yes, it is possible for this to make len > size for a while. */
                                        iobuf.out.len += 4;
                                }
 
@@ -659,11 +662,19 @@ static char *perform_io(size_t needed, int flags)
                if (max_fd < 0) {
                        switch (flags & PIO_NEED_FLAGS) {
                        case PIO_NEED_INPUT:
+                               iobuf.in.len = 0;
+                               if (kluge_around_eof == 2)
+                                       exit_cleanup(0);
+                               if (iobuf.in_fd == -2)
+                                       whine_about_eof(True);
                                rprintf(FERROR, "error in perform_io: no fd for input.\n");
                                exit_cleanup(RERR_PROTOCOL);
                        case PIO_NEED_OUTROOM:
                        case PIO_NEED_MSGROOM:
                                msgs2stderr = 1;
+                               drain_multiplex_messages();
+                               if (iobuf.out_fd == -2)
+                                       whine_about_eof(True);
                                rprintf(FERROR, "error in perform_io: no fd for output.\n");
                                exit_cleanup(RERR_PROTOCOL);
                        default:
@@ -674,8 +685,7 @@ static char *perform_io(size_t needed, int flags)
                }
 
                if (extra_flist_sending_enabled) {
-                       if (file_total - file_old_total < MAX_FILECNT_LOOKAHEAD
-                        && file_total - file_old_total >= MIN_FILECNT_LOOKAHEAD)
+                       if (file_total - file_old_total < MAX_FILECNT_LOOKAHEAD)
                                tv.tv_sec = 0;
                        else {
                                extra_flist_sending_enabled = False;
@@ -708,8 +718,9 @@ static char *perform_io(size_t needed, int flags)
                        int n;
                        if ((n = read(iobuf.in_fd, iobuf.in.buf + pos, len)) <= 0) {
                                if (n == 0) {
+                                       /* Signal that input has become invalid. */
                                        if (!read_batch || batch_fd < 0 || am_generator)
-                                               whine_about_eof(iobuf.in_fd); /* Doesn't return. */
+                                               iobuf.in_fd = -2;
                                        batch_fd = -1;
                                        continue;
                                }
@@ -723,7 +734,7 @@ static char *perform_io(size_t needed, int flags)
                                                rsyserr(FERROR_SOCKET, errno, "read error");
                                        } else
                                                rsyserr(FERROR, errno, "read error");
-                                       exit_cleanup(RERR_STREAMIO);
+                                       exit_cleanup(RERR_SOCKETIO);
                                }
                        }
                        if (msgs2stderr && DEBUG_GTE(IO, 2))
@@ -751,9 +762,11 @@ static char *perform_io(size_t needed, int flags)
                                else {
                                        /* Don't write errors on a dead socket. */
                                        msgs2stderr = 1;
-                                       out->len = iobuf.raw_flushing_ends_before = out->pos = 0;
+                                       iobuf.out_fd = -2;
+                                       iobuf.out.len = iobuf.msg.len = iobuf.raw_flushing_ends_before = 0;
                                        rsyserr(FERROR_SOCKET, errno, "[%s] write error", who_am_i());
-                                       exit_cleanup(RERR_STREAMIO);
+                                       drain_multiplex_messages();
+                                       exit_cleanup(RERR_SOCKETIO);
                                }
                        }
                        if (msgs2stderr && DEBUG_GTE(IO, 2)) {
@@ -772,8 +785,7 @@ static char *perform_io(size_t needed, int flags)
                                if (iobuf.raw_flushing_ends_before)
                                        iobuf.raw_flushing_ends_before -= out->size;
                                out->pos = 0;
-                       }
-                       if (out->pos == iobuf.raw_flushing_ends_before)
+                       } else if (out->pos == iobuf.raw_flushing_ends_before)
                                iobuf.raw_flushing_ends_before = 0;
                        if ((out->len -= n) == empty_buf_len) {
                                out->pos = 0;
@@ -806,7 +818,11 @@ void noop_io_until_death(void)
 {
        char buf[1024];
 
-       kluge_around_eof = 1;
+       kluge_around_eof = 2;
+       /* Setting an I/O timeout ensures that if something inexplicably weird
+        * happens, we won't hang around forever. */
+       if (!io_timeout)
+               set_io_timeout(60);
 
        while (1)
                read_buf(iobuf.in_fd, buf, sizeof buf);
@@ -829,7 +845,7 @@ int send_msg(enum msgcode code, const char *buf, size_t len, int convert)
        if (convert > 0 && ic_send == (iconv_t)-1)
                convert = 0;
        if (convert > 0) {
-               /* Ensuring double-size room leaves space for a potential conversion. */
+               /* Ensuring double-size room leaves space for maximal conversion expansion. */
                if (iobuf.msg.len + len*2 + 4 > iobuf.msg.size)
                        perform_io(len*2 + 4, PIO_NEED_MSGROOM);
        } else
@@ -842,7 +858,7 @@ int send_msg(enum msgcode code, const char *buf, size_t len, int convert)
                pos -= iobuf.msg.size;
        hdr = iobuf.msg.buf + pos;
 
-       iobuf.msg.len += 4; /* Leave room for the coming header bytes. */
+       iobuf.msg.len += 4; /* Allocate room for the coming header bytes. */
 
 #ifdef ICONV_OPTION
        if (convert > 0) {
@@ -879,10 +895,10 @@ int send_msg(enum msgcode code, const char *buf, size_t len, int convert)
        SIVAL(hdr, 0, ((MPLEX_BASE + (int)code)<<24) + len);
        /* If the header used any overflow bytes, move them to the start. */
        if ((pos = hdr+4 - iobuf.msg.buf) > iobuf.msg.size) {
-               size_t siz = pos - iobuf.msg.size;
+               int siz = (int)(pos - iobuf.msg.size);
                if (DEBUG_GTE(IO, 4))
-                       rprintf(FINFO, "[%s] wrap-bytes moved: %d (send_msg)\n", who_am_i(), (int)siz);
-               memcpy(iobuf.msg.buf, hdr+4 - siz, siz);
+                       rprintf(FINFO, "[%s] wrap-bytes moved: %d (send_msg)\n", who_am_i(), siz);
+               memcpy(iobuf.msg.buf, iobuf.msg.buf + iobuf.msg.size, siz);
        }
 
        if (want_debug && convert > 0)
@@ -1163,7 +1179,8 @@ BOOL io_start_buffering_out(int f_out)
        if (iobuf.out.buf) {
                if (iobuf.out_fd == -1)
                        iobuf.out_fd = f_out;
-               assert(f_out == iobuf.out_fd);
+               else
+                       assert(f_out == iobuf.out_fd);
                return False;
        }
 
@@ -1185,7 +1202,8 @@ BOOL io_start_buffering_in(int f_in)
        if (iobuf.in.buf) {
                if (iobuf.in_fd == -1)
                        iobuf.in_fd = f_in;
-               assert(f_in == iobuf.in_fd);
+               else
+                       assert(f_in == iobuf.in_fd);
                return False;
        }
 
@@ -1312,9 +1330,10 @@ static void read_a_msg(void)
                if (msg_bytes != 4 || am_sender)
                        goto invalid_msg;
                data = perform_io(4, PIO_INPUT_AND_CONSUME);
-               io_error |= IVAL(data, 0);
+               val = IVAL(data, 0);
+               io_error |= val;
                if (!am_generator)
-                       send_msg(MSG_IO_ERROR, data, 4, 0);
+                       send_msg_int(MSG_IO_ERROR, val);
                break;
        case MSG_IO_TIMEOUT:
                if (msg_bytes != 4 || am_server || am_generator)
@@ -1324,7 +1343,7 @@ static void read_a_msg(void)
                if (!io_timeout || io_timeout > val) {
                        if (INFO_GTE(MISC, 2))
                                rprintf(FINFO, "Setting --timeout=%d to match server\n", val);
-                       io_timeout = val;
+                       set_io_timeout(val);
                }
                break;
        case MSG_NOOP:
@@ -1391,19 +1410,21 @@ static void read_a_msg(void)
                        exit_cleanup(RERR_STREAMIO);
                }
                data = perform_io(4, PIO_INPUT_AND_CONSUME);
+               val = IVAL(data, 0);
                if (am_generator)
-                       got_flist_entry_status(FES_SUCCESS, IVAL(data, 0));
+                       got_flist_entry_status(FES_SUCCESS, val);
                else
-                       successful_send(IVAL(data, 0));
+                       successful_send(val);
                break;
        case MSG_NO_SEND:
                if (msg_bytes != 4)
                        goto invalid_msg;
                data = perform_io(4, PIO_INPUT_AND_CONSUME);
+               val = IVAL(data, 0);
                if (am_generator)
-                       got_flist_entry_status(FES_NO_SEND, IVAL(data, 0));
+                       got_flist_entry_status(FES_NO_SEND, val);
                else
-                       send_msg(MSG_NO_SEND, data, 4, 0);
+                       send_msg_int(MSG_NO_SEND, val);
                break;
        case MSG_ERROR_SOCKET:
        case MSG_ERROR_UTF8:
@@ -1437,15 +1458,26 @@ static void read_a_msg(void)
                }
                break;
        case MSG_ERROR_EXIT:
-               if (msg_bytes != 4)
+               if (msg_bytes == 0) {
+                       if (!am_sender && !am_generator) {
+                               send_msg(MSG_ERROR_EXIT, "", 0, 0);
+                               io_flush(FULL_FLUSH);
+                       }
+                       val = 0;
+               } else if (msg_bytes == 4) {
+                       data = perform_io(4, PIO_INPUT_AND_CONSUME);
+                       val = IVAL(data, 0);
+                       if (protocol_version >= 31) {
+                               if (am_generator)
+                                       send_msg_int(MSG_ERROR_EXIT, val);
+                               else
+                                       send_msg(MSG_ERROR_EXIT, "", 0, 0);
+                       }
+               } else
                        goto invalid_msg;
-               data = perform_io(4, PIO_INPUT_AND_CONSUME);
-               val = IVAL(data, 0);
-               if (am_generator && protocol_version >= 31)
-                       send_msg_int(MSG_ERROR_EXIT, val);
-               if (am_generator)
-                       val = RERR_RCVR_ERROR; /* avoids duplicate errors */
-               exit_cleanup(val);
+               /* Send a negative linenum so that we don't end up
+                * with a duplicate exit message. */
+               _exit_cleanup(val, __FILE__, 0 - __LINE__);
        default:
                rprintf(FERROR, "unexpected tag %d [%s%s]\n",
                        tag, who_am_i(), inc_recurse ? "/inc" : "");
@@ -1453,6 +1485,23 @@ static void read_a_msg(void)
        }
 }
 
+static void drain_multiplex_messages(void)
+{
+       while (IN_MULTIPLEXED && iobuf.in.len) {
+               if (iobuf.raw_input_ends_before) {
+                       size_t raw_len = iobuf.raw_input_ends_before - iobuf.in.pos;
+                       iobuf.raw_input_ends_before = 0;
+                       if (raw_len >= iobuf.in.len) {
+                               iobuf.in.len = 0;
+                               break;
+                       }
+                       iobuf.in.pos += raw_len;
+                       iobuf.in.len -= raw_len;
+               }
+               read_a_msg();
+       }
+}
+
 void wait_for_receiver(void)
 {
        if (!iobuf.raw_input_ends_before)
@@ -1606,7 +1655,7 @@ void read_buf(int f, char *buf, size_t len)
 {
        if (f != iobuf.in_fd) {
                if (safe_read(f, buf, len) != len)
-                       whine_about_eof(f); /* Doesn't return. */
+                       whine_about_eof(False); /* Doesn't return. */
                goto batch_copy;
        }
 
@@ -1894,7 +1943,7 @@ void write_buf(int f, const char *buf, size_t len)
                goto batch_copy;
        }
 
-       if (iobuf.out.size - iobuf.out.len < len)
+       if (iobuf.out.len + len > iobuf.out.size)
                perform_io(len, PIO_NEED_OUTROOM);
 
        pos = iobuf.out.pos + iobuf.out.len; /* Must be set after any flushing. */
@@ -2063,11 +2112,11 @@ void io_printf(int fd, const char *format, ...)
        va_end(ap);
 
        if (len < 0)
-               exit_cleanup(RERR_STREAMIO);
+               exit_cleanup(RERR_PROTOCOL);
 
        if (len > (int)sizeof buf) {
                rprintf(FERROR, "io_printf() was too long for the buffer.\n");
-               exit_cleanup(RERR_STREAMIO);
+               exit_cleanup(RERR_PROTOCOL);
        }
 
        write_sbuf(fd, buf);