- Got rid of the checking of msg_fd_in in read_timeout() -- it was
[rsync/rsync.git] / io.c
diff --git a/io.c b/io.c
index 029f74b..a53b347 100644 (file)
--- a/io.c
+++ b/io.c
@@ -46,14 +46,17 @@ extern int io_timeout;
 extern int am_server;
 extern int am_daemon;
 extern int am_sender;
+extern int am_generator;
 extern int eol_nulls;
+extern int csum_length;
 extern int checksum_seed;
 extern int protocol_version;
-extern char *remote_filesfrom_file;
+extern char *filesfrom_host;
 extern struct stats stats;
 
 const char phase_unknown[] = "unknown";
 int select_timeout = SELECT_TIMEOUT;
+int ignore_timeout = 0;
 int batch_fd = -1;
 int batch_gen_fd = -1;
 
@@ -73,9 +76,8 @@ int batch_gen_fd = -1;
 const char *io_write_phase = phase_unknown;
 const char *io_read_phase = phase_unknown;
 
-/** Ignore EOF errors while reading a module listing if the remote
-    version is 24 or less. */
-int kludge_around_eof = False;
+/* Ignore an EOF error if non-zero. See whine_about_eof(). */
+int kluge_around_eof = 0;
 
 int msg_fd_in = -1;
 int msg_fd_out = -1;
@@ -96,6 +98,7 @@ static char io_filesfrom_buf[2048];
 static char *io_filesfrom_bp;
 static char io_filesfrom_lastchar;
 static int io_filesfrom_buflen;
+static size_t contiguous_write_len = 0;
 
 static void read_loop(int fd, char *buf, size_t len);
 
@@ -135,7 +138,7 @@ static void check_timeout(void)
 {
        time_t t;
 
-       if (!io_timeout)
+       if (!io_timeout || ignore_timeout)
                return;
 
        if (!last_io) {
@@ -147,7 +150,7 @@ static void check_timeout(void)
 
        if (t - last_io >= io_timeout) {
                if (!am_server && !am_daemon) {
-                       rprintf(FERROR, "io timeout after %d seconds - exiting\n",
+                       rprintf(FERROR, "io timeout after %d seconds -- exiting\n",
                                (int)(t-last_io));
                }
                exit_cleanup(RERR_TIMEOUT);
@@ -162,17 +165,17 @@ void io_set_sock_fds(int f_in, int f_out)
        sock_f_out = f_out;
 }
 
-/** Setup the fd used to receive MSG_* messages.  Only needed when
- * we're the generator because the sender and receiver both use the
- * multiplexed I/O setup. */
+/* Setup the fd used to receive MSG_* messages.  Only needed during the
+ * early stages of being a local sender (up through the sending of the
+ * file list) or when we're the generator (to fetch the messages from
+ * the receiver). */
 void set_msg_fd_in(int fd)
 {
        msg_fd_in = fd;
 }
 
-/** Setup the fd used to send our MSG_* messages.  Only needed when
- * we're the receiver because the generator and the sender both use
- * the multiplexed I/O setup. */
+/* Setup the fd used to send our MSG_* messages.  Only needed when
+ * we're the receiver (to send our messages to the generator). */
 void set_msg_fd_out(int fd)
 {
        msg_fd_out = fd;
@@ -201,12 +204,18 @@ static void msg_list_add(int code, char *buf, int len)
 
 void send_msg(enum msgcode code, char *buf, int len)
 {
+       if (msg_fd_out < 0) {
+               io_multiplex_write(code, buf, len);
+               return;
+       }
        msg_list_add(code, buf, len);
        msg_list_push(NORMAL_FLUSH);
 }
 
-/** Read a message from the MSG_* fd and dispatch it.  This is only
- * called by the generator. */
+/* Read a message from the MSG_* fd and handle it.  This is called either
+ * during the early stages of being a local sender (up through the sending
+ * of the file list) or when we're the generator (to fetch the messages
+ * from the receiver). */
 static void read_msg_fd(void)
 {
        char buf[2048];
@@ -215,7 +224,7 @@ static void read_msg_fd(void)
        int tag, len;
 
        /* Temporarily disable msg_fd_in.  This is needed to avoid looping back
-        * to this routine from read_timeout() and writefd_unbuffered(). */
+        * to this routine from writefd_unbuffered(). */
        msg_fd_in = -1;
 
        read_loop(fd, buf, 4);
@@ -226,20 +235,36 @@ static void read_msg_fd(void)
 
        switch (tag) {
        case MSG_DONE:
-               if (len != 0) {
+               if (len != 0 || !am_generator) {
                        rprintf(FERROR, "invalid message %d:%d\n", tag, len);
                        exit_cleanup(RERR_STREAMIO);
                }
                redo_list_add(-1);
                break;
        case MSG_REDO:
-               if (len != 4) {
+               if (len != 4 || !am_generator) {
                        rprintf(FERROR, "invalid message %d:%d\n", tag, len);
                        exit_cleanup(RERR_STREAMIO);
                }
                read_loop(fd, buf, 4);
                redo_list_add(IVAL(buf,0));
                break;
+       case MSG_DELETED:
+               if (len >= (int)sizeof buf || !am_generator) {
+                       rprintf(FERROR, "invalid message %d:%d\n", tag, len);
+                       exit_cleanup(RERR_STREAMIO);
+               }
+               read_loop(fd, buf, len);
+               io_multiplex_write(MSG_DELETED, buf, len);
+               break;
+       case MSG_SUCCESS:
+               if (len != 4 || !am_generator) {
+                       rprintf(FERROR, "invalid message %d:%d\n", tag, len);
+                       exit_cleanup(RERR_STREAMIO);
+               }
+               read_loop(fd, buf, len);
+               io_multiplex_write(MSG_SUCCESS, buf, len);
+               break;
        case MSG_INFO:
        case MSG_ERROR:
        case MSG_LOG:
@@ -337,20 +362,28 @@ void io_set_filesfrom_fds(int f_in, int f_out)
        io_filesfrom_buflen = 0;
 }
 
-/**
- * It's almost always an error to get an EOF when we're trying to read
- * from the network, because the protocol is self-terminating.
+/* It's almost always an error to get an EOF when we're trying to read from the
+ * network, because the protocol is (for the most part) self-terminating.
  *
- * However, there is one unfortunate cases where it is not, which is
- * rsync <2.4.6 sending a list of modules on a server, since the list
- * is terminated by closing the socket. So, for the section of the
- * program where that is a problem (start_socket_client),
- * kludge_around_eof is True and we just exit.
- */
+ * There is one case for the receiver when it is at the end of the transfer
+ * (hanging around reading any keep-alive packets that might come its way): if
+ * the sender dies before the generator's kill-signal comes through, we can end
+ * up here needing to loop until the kill-signal arrives.  In this situation,
+ * kluge_around_eof will be < 0.
+ *
+ * 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 void whine_about_eof(int fd)
 {
-       if (kludge_around_eof && fd == sock_f_in)
-               exit_cleanup(0);
+       if (kluge_around_eof && fd == sock_f_in) {
+               int i;
+               if (kluge_around_eof > 0)
+                       exit_cleanup(0);
+               /* If we're still here after 10 seconds, exit with an error. */
+               for (i = 10*1000/20; i--; )
+                       msleep(20);
+       }
 
        rprintf(FERROR, RSYNC_NAME ": connection unexpectedly closed "
                "(%.0f bytes received so far) [%s]\n",
@@ -387,11 +420,7 @@ static int read_timeout(int fd, char *buf, size_t len)
                FD_ZERO(&r_fds);
                FD_ZERO(&w_fds);
                FD_SET(fd, &r_fds);
-               if (msg_fd_in >= 0) {
-                       FD_SET(msg_fd_in, &r_fds);
-                       if (msg_fd_in > maxfd)
-                               maxfd = msg_fd_in;
-               } else if (msg_list_head) {
+               if (msg_list_head) {
                        FD_SET(msg_fd_out, &w_fds);
                        if (msg_fd_out > maxfd)
                                maxfd = msg_fd_out;
@@ -428,9 +457,7 @@ static int read_timeout(int fd, char *buf, size_t len)
                        continue;
                }
 
-               if (msg_fd_in >= 0 && FD_ISSET(msg_fd_in, &r_fds))
-                       read_msg_fd();
-               else if (msg_list_head && FD_ISSET(msg_fd_out, &w_fds))
+               if (msg_list_head && FD_ISSET(msg_fd_out, &w_fds))
                        msg_list_push(NORMAL_FLUSH);
 
                if (io_filesfrom_f_out >= 0) {
@@ -534,7 +561,7 @@ int read_filesfrom_line(int fd, char *fname)
 {
        char ch, *s, *eob = fname + MAXPATHLEN - 1;
        int cnt;
-       int reading_remotely = remote_filesfrom_file != NULL;
+       int reading_remotely = filesfrom_host != NULL;
        int nulls = eol_nulls || reading_remotely;
 
   start:
@@ -610,6 +637,21 @@ void io_end_buffering(void)
 }
 
 
+void maybe_send_keepalive(int allowed_lull, int ndx)
+{
+       if (time(NULL) - last_io >= allowed_lull) {
+               if (!iobuf_out || !iobuf_out_cnt) {
+                       if (protocol_version < 29)
+                               return; /* there's nothing we can do */
+                       write_int(sock_f_out, ndx);
+                       write_shortint(sock_f_out, ITEM_IS_NEW);
+               }
+               if (iobuf_out)
+                       io_flush(NORMAL_FLUSH);
+       }
+}
+
+
 /**
  * Continue trying to read len bytes - don't return until len has been
  * read.
@@ -636,7 +678,7 @@ static int readfd_unbuffered(int fd, char *buf, size_t len)
        static size_t remaining;
        static size_t iobuf_in_ndx;
        int tag, ret = 0;
-       char line[1024];
+       char line[MAXPATHLEN+1];
 
        if (!iobuf_in || fd != sock_f_in)
                return read_timeout(fd, buf, len);
@@ -673,11 +715,37 @@ static int readfd_unbuffered(int fd, char *buf, size_t len)
                        read_loop(fd, iobuf_in, remaining);
                        iobuf_in_ndx = 0;
                        break;
+               case MSG_DELETED:
+                       if (remaining >= sizeof line) {
+                               rprintf(FERROR, "invalid multi-message %d:%ld\n",
+                                       tag, (long)remaining);
+                               exit_cleanup(RERR_STREAMIO);
+                       }
+                       read_loop(fd, line, remaining);
+                       line[remaining] = '\0';
+                       /* A directory name was sent with the trailing null */
+                       if (remaining > 0 && !line[remaining-1])
+                               log_delete(line, S_IFDIR);
+                       else
+                               log_delete(line, S_IFREG);
+                       remaining = 0;
+                       break;
+               case MSG_SUCCESS:
+                       if (remaining != 4) {
+                               rprintf(FERROR, "invalid multi-message %d:%ld\n",
+                                       tag, (long)remaining);
+                               exit_cleanup(RERR_STREAMIO);
+                       }
+                       read_loop(fd, line, remaining);
+                       successful_send(IVAL(line, 0));
+                       remaining = 0;
+                       break;
                case MSG_INFO:
                case MSG_ERROR:
                        if (remaining >= sizeof line) {
-                               rprintf(FERROR, "multiplexing overflow %d:%ld\n\n",
-                                       tag, (long)remaining);
+                               rprintf(FERROR,
+                                       "[%s] multiplexing overflow %d:%ld\n\n",
+                                       who_am_i(), tag, (long)remaining);
                                exit_cleanup(RERR_STREAMIO);
                        }
                        read_loop(fd, line, remaining);
@@ -685,7 +753,8 @@ static int readfd_unbuffered(int fd, char *buf, size_t len)
                        remaining = 0;
                        break;
                default:
-                       rprintf(FERROR, "unexpected tag %d\n", tag);
+                       rprintf(FERROR, "[%s] unexpected tag %d\n",
+                               who_am_i(), tag);
                        exit_cleanup(RERR_STREAMIO);
                }
        }
@@ -723,6 +792,14 @@ static void readfd(int fd, char *buffer, size_t N)
 }
 
 
+int read_shortint(int f)
+{
+       uchar b[2];
+       readfd(f, (char *)b, 2);
+       return (b[1] << 8) + b[0];
+}
+
+
 int32 read_int(int f)
 {
        char b[4];
@@ -744,14 +821,13 @@ int64 read_longint(int f)
        if ((int32)ret != (int32)0xffffffff)
                return ret;
 
-#ifdef INT64_IS_OFF_T
-       if (sizeof (int64) < 8) {
-               rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
-               exit_cleanup(RERR_UNSUPPORTED);
-       }
-#endif
+#if SIZEOF_INT64 < 8
+       rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
+       exit_cleanup(RERR_UNSUPPORTED);
+#else
        readfd(f,b,8);
        ret = IVAL(b,0) | (((int64)IVAL(b,4))<<32);
+#endif
 
        return ret;
 }
@@ -764,16 +840,58 @@ void read_buf(int f,char *buf,size_t len)
 void read_sbuf(int f,char *buf,size_t len)
 {
        readfd(f, buf, len);
-       buf[len] = 0;
+       buf[len] = '\0';
 }
 
-unsigned char read_byte(int f)
+uchar read_byte(int f)
 {
-       unsigned char c;
+       uchar c;
        readfd(f, (char *)&c, 1);
        return c;
 }
 
+/* Populate a sum_struct with values from the socket.  This is
+ * called by both the sender and the receiver. */
+void read_sum_head(int f, struct sum_struct *sum)
+{
+       sum->count = read_int(f);
+       sum->blength = read_int(f);
+       if (sum->blength < 0 || sum->blength > MAX_BLOCK_SIZE) {
+               rprintf(FERROR, "[%s] Invalid block length %ld\n",
+                       who_am_i(), (long)sum->blength);
+               exit_cleanup(RERR_PROTOCOL);
+       }
+       sum->s2length = protocol_version < 27 ? csum_length : (int)read_int(f);
+       if (sum->s2length < 0 || sum->s2length > MD4_SUM_LENGTH) {
+               rprintf(FERROR, "[%s] Invalid checksum length %d\n",
+                       who_am_i(), sum->s2length);
+               exit_cleanup(RERR_PROTOCOL);
+       }
+       sum->remainder = read_int(f);
+       if (sum->remainder < 0 || sum->remainder > sum->blength) {
+               rprintf(FERROR, "[%s] Invalid remainder length %ld\n",
+                       who_am_i(), (long)sum->remainder);
+               exit_cleanup(RERR_PROTOCOL);
+       }
+}
+
+/* Send the values from a sum_struct over the socket.  Set sum to
+ * NULL if there are no checksums to send.  This is called by both
+ * the generator and the sender. */
+void write_sum_head(int f, struct sum_struct *sum)
+{
+       static struct sum_struct null_sum;
+
+       if (sum == NULL)
+               sum = &null_sum;
+
+       write_int(f, sum->count);
+       write_int(f, sum->blength);
+       if (protocol_version >= 27)
+               write_int(f, sum->s2length);
+       write_int(f, sum->remainder);
+}
+
 
 /**
  * Sleep after writing to limit I/O bandwidth usage.
@@ -832,8 +950,8 @@ static void sleep_for_bwlimit(int bytes_written)
 
 
 /* Write len bytes to the file descriptor fd, looping as necessary to get
- * the job done and also (in the generator) reading any data on msg_fd_in
- * (to avoid deadlock).
+ * the job done and also (in certain circumstnces) reading any data on
+ * msg_fd_in to avoid deadlock.
  *
  * This function underlies the multiplexing system.  The body of the
  * application never calls this function directly. */
@@ -851,12 +969,17 @@ static void writefd_unbuffered(int fd,char *buf,size_t len)
                FD_SET(fd,&w_fds);
                maxfd = fd;
 
-               if (msg_fd_in >= 0) {
+               if (msg_fd_in >= 0 && len-total >= contiguous_write_len) {
                        FD_ZERO(&r_fds);
                        FD_SET(msg_fd_in,&r_fds);
                        if (msg_fd_in > maxfd)
                                maxfd = msg_fd_in;
                }
+               if (fd != sock_f_out && iobuf_out_cnt && no_flush == 1) {
+                       FD_SET(sock_f_out, &w_fds);
+                       if (sock_f_out > maxfd)
+                               maxfd = sock_f_out;
+               }
 
                tv.tv_sec = select_timeout;
                tv.tv_usec = 0;
@@ -875,8 +998,14 @@ static void writefd_unbuffered(int fd,char *buf,size_t len)
                if (msg_fd_in >= 0 && FD_ISSET(msg_fd_in, &r_fds))
                        read_msg_fd();
 
-               if (!FD_ISSET(fd, &w_fds))
+               if (!FD_ISSET(fd, &w_fds)) {
+                       if (fd != sock_f_out && iobuf_out_cnt) {
+                               no_flush--;
+                               io_flush(NORMAL_FLUSH);
+                               no_flush++;
+                       }
                        continue;
+               }
 
                n = len - total;
                if (bwlimit && n > bwlimit_writemax)
@@ -902,7 +1031,8 @@ static void writefd_unbuffered(int fd,char *buf,size_t len)
                        /* If the other side is sending us error messages, try
                         * to grab any messages they sent before they died. */
                        while (fd == sock_f_out && io_multiplexing_in) {
-                               io_timeout = 30;
+                               io_timeout = select_timeout = 30;
+                               ignore_timeout = 0;
                                readfd_unbuffered(sock_f_in, io_filesfrom_buf,
                                                  sizeof io_filesfrom_buf);
                        }
@@ -933,6 +1063,13 @@ static void mplex_write(enum msgcode code, char *buf, size_t len)
 
        SIVAL(buffer, 0, ((MPLEX_BASE + (int)code)<<24) + len);
 
+       /* When the generator reads messages from the msg_fd_in pipe, it can
+        * cause output to occur down the socket.  Setting contiguous_write_len
+        * prevents the reading of msg_fd_in once we actually start to write
+        * this sequence of data (though we might read it before the start). */
+       if (am_generator && msg_fd_in >= 0)
+               contiguous_write_len = len + 4;
+
        if (n > sizeof buffer - 4)
                n = sizeof buffer - 4;
 
@@ -944,6 +1081,9 @@ static void mplex_write(enum msgcode code, char *buf, size_t len)
 
        if (len)
                writefd_unbuffered(sock_f_out, buf, len);
+
+       if (am_generator && msg_fd_in >= 0)
+               contiguous_write_len = 0;
 }
 
 
@@ -997,6 +1137,15 @@ static void writefd(int fd,char *buf,size_t len)
 }
 
 
+void write_shortint(int f, int x)
+{
+       uchar b[2];
+       b[0] = x;
+       b[1] = x >> 8;
+       writefd(f, (char *)b, 2);
+}
+
+
 void write_int(int f,int32 x)
 {
        char b[4];
@@ -1026,18 +1175,16 @@ void write_longint(int f, int64 x)
                return;
        }
 
-#ifdef INT64_IS_OFF_T
-       if (sizeof (int64) < 8) {
-               rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
-               exit_cleanup(RERR_UNSUPPORTED);
-       }
-#endif
-
+#if SIZEOF_INT64 < 8
+       rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
+       exit_cleanup(RERR_UNSUPPORTED);
+#else
        write_int(f, (int32)0xFFFFFFFF);
        SIVAL(b,0,(x&0xFFFFFFFF));
        SIVAL(b,4,((x>>32)&0xFFFFFFFF));
 
        writefd(f,b,8);
+#endif
 }
 
 void write_buf(int f,char *buf,size_t len)
@@ -1051,13 +1198,12 @@ void write_sbuf(int f, char *buf)
        writefd(f, buf, strlen(buf));
 }
 
-void write_byte(int f,unsigned char c)
+void write_byte(int f, uchar c)
 {
        writefd(f, (char *)&c, 1);
 }
 
 
-
 /**
  * Read a line of up to @p maxlen characters into @p buf (not counting
  * the trailing null).  Strips the (required) trailing newline and all