@RSYNC EXIT / @RSYNC EOF

Martin Pool mbp at valinux.com
Wed Aug 22 14:20:13 EST 2001


tridge and Wayne in particular:

I checked in this patch, which is meant to consolidate the ones from
both of you for handling EOF in a modules list.  The idea is that we
need to handle servers that just close the socket rather than sending
a nice ending token, but we want to keep EOF detection on in general.
(The IO code is such a mess!)

-- 
Martin



Index: clientserver.c
===================================================================
RCS file: /data/cvs/rsync/clientserver.c,v
retrieving revision 1.69
diff -u -p -r1.69 clientserver.c
--- clientserver.c	15 Aug 2001 06:44:44 -0000	1.69
+++ clientserver.c	22 Aug 2001 04:15:12 -0000
@@ -44,7 +44,8 @@ int start_socket_client(char *host, char
 	extern int am_sender;
 	extern struct in_addr socket_address;
 	extern char *shell_cmd;
-
+	extern int kludge_around_eof;
+	
 	if (argc == 0 && !am_sender) {
 		extern int list_only;
 		list_only = 1;
@@ -107,6 +108,10 @@ int start_socket_client(char *host, char
 	if (p) *p = '/';
 
 	while (1) {
+		/* Old servers may just drop the connection here,
+		   rather than sending a proper EXIT command.  Yuck. */
+		kludge_around_eof= True;
+
 		if (!read_line(fd, line, sizeof(line)-1)) {
 			return -1;
 		}
@@ -122,6 +127,7 @@ int start_socket_client(char *host, char
 
 		rprintf(FINFO,"%s\n", line);
 	}
+	kludge_around_eof = False;
 
 	for (i=0;i<sargc;i++) {
 		io_printf(fd,"%s\n", sargs[i]);
Index: io.c
===================================================================
RCS file: /data/cvs/rsync/io.c,v
retrieving revision 1.85
diff -u -p -r1.85 io.c
--- io.c	7 May 2001 06:59:37 -0000	1.85
+++ io.c	22 Aug 2001 04:15:12 -0000
@@ -2,6 +2,7 @@
    
    Copyright (C) 1996-2001 by Andrew Tridgell 
    Copyright (C) Paul Mackerras 1996
+   Copyright (C) 2001 by Martin Pool <mbp at 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
@@ -28,18 +29,24 @@
 /* if no timeout is specified then use a 60 second select timeout */
 #define SELECT_TIMEOUT 60
 
-extern int bwlimit;
-
 static int io_multiplexing_out;
 static int io_multiplexing_in;
 static int multiplex_in_fd;
 static int multiplex_out_fd;
 static time_t last_io;
-static int eof_error=1;
+static int no_flush;
+
+extern int bwlimit;
 extern int verbose;
 extern int io_timeout;
 extern struct stats stats;
 
+
+/** Ignore EOF errors while reading a module listing if the remote
+    version is 24 or less. */
+int kludge_around_eof = False;
+
+
 static int io_error_fd = -1;
 
 static void read_loop(int fd, char *buf, int len);
@@ -106,9 +113,46 @@ static void read_error_fd(void)
 }
 
 
-static int no_flush;
+static void whine_about_eof (void)
+{
+	/**
+	   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.
+	   
+	   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.
+	*/
+
+	if (kludge_around_eof)
+		exit_cleanup (0);
+	else {
+		rprintf (FERROR,
+			 "%s: connection unexpectedly closed "
+			 "(%.0f bytes read so far)\n",
+			 RSYNC_NAME, (double)stats.total_read);
+	
+		exit_cleanup (RERR_STREAMIO);
+	}
+}
 
-/*
+
+static void die_from_readerr (int err)
+{
+	/* this prevents us trying to write errors on a dead socket */
+	io_multiplexing_close();
+				
+	rprintf(FERROR, "%s: read error: %s\n",
+		RSYNC_NAME, strerror (err));
+	exit_cleanup(RERR_STREAMIO);
+}
+
+
+/*!
  * Read from a socket with IO timeout. return the number of bytes
  * read. If no bytes can be read then exit, never return a number <= 0.
  *
@@ -119,13 +163,14 @@ static int no_flush;
  * give a better explanation.  We can tell whether the connection has
  * started by looking e.g. at whether the remote version is known yet.
  */
-static int read_timeout(int fd, char *buf, int len)
+static int read_timeout (int fd, char *buf, int len)
 {
 	int n, ret=0;
 
 	io_flush();
 
 	while (ret == 0) {
+		/* until we manage to read *something* */
 		fd_set fds;
 		struct timeval tv;
 		int fd_count = fd+1;
@@ -165,41 +210,27 @@ static int read_timeout(int fd, char *bu
 			if (io_timeout)
 				last_io = time(NULL);
 			continue;
+		} else if (n == 0) {
+			whine_about_eof ();
+			return -1; /* doesn't return */
+		} else if (n == -1) {
+			if (errno == EINTR || errno == EWOULDBLOCK ||
+			    errno == EAGAIN) 
+				continue;
+			else
+				die_from_readerr (errno);
 		}
-
-		if (n == -1 && errno == EINTR) {
-			continue;
-		}
-
-		if (n == -1 && 
-		    (errno == EWOULDBLOCK || errno == EAGAIN)) {
-			continue;
-		}
-
-
-		if (n == 0) {
-			if (eof_error) {
-				rprintf(FERROR,
-                                        "%s: connection to server unexpectedly closed"
-                                        " (%.0f bytes read so far)\n",
-                                        RSYNC_NAME, (double)stats.total_read);
-			}
-			exit_cleanup(RERR_STREAMIO);
-		}
-
-		/* this prevents us trying to write errors on a dead socket */
-		io_multiplexing_close();
-
-		rprintf(FERROR,"read error: %s\n", strerror(errno));
-		exit_cleanup(RERR_STREAMIO);
 	}
 
 	return ret;
 }
 
-/* continue trying to read len bytes - don't return until len
-   has been read */
-static void read_loop(int fd, char *buf, int len)
+
+
+
+/*! Continue trying to read len bytes - don't return until len has
+  been read.   */
+static void read_loop (int fd, char *buf, int len)
 {
 	while (len) {
 		int n = read_timeout(fd, buf, len);
@@ -209,16 +240,20 @@ static void read_loop(int fd, char *buf,
 	}
 }
 
-/* read from the file descriptor handling multiplexing - 
-   return number of bytes read
-   never return <= 0 */
+
+/**
+ * Read from the file descriptor handling multiplexing - return number
+ * of bytes read.
+ * 
+ * Never returns <= 0. 
+ */
 static int read_unbuffered(int fd, char *buf, int len)
 {
 	static int remaining;
 	int tag, ret=0;
 	char line[1024];
 
-	if (!io_multiplexing_in || fd != multiplex_in_fd) 
+	if (!io_multiplexing_in || fd != multiplex_in_fd)
 		return read_timeout(fd, buf, len);
 
 	while (ret == 0) {
@@ -230,7 +265,7 @@ static int read_unbuffered(int fd, char 
 			continue;
 		}
 
-		read_loop(fd, line, 4);
+		read_loop (fd, line, 4);
 		tag = IVAL(line, 0);
 
 		remaining = tag & 0xFFFFFF;
@@ -264,7 +299,7 @@ static int read_unbuffered(int fd, char 
 
 /* do a buffered read from fd. don't return until all N bytes
    have been read. If all N can't be read then exit with an error */
-static void readfd(int fd,char *buffer,int N)
+static void readfd (int fd, char *buffer, int N)
 {
 	int  ret;
 	int total=0;  
@@ -272,7 +307,7 @@ static void readfd(int fd,char *buffer,i
 	while (total < N) {
 		io_flush();
 
-		ret = read_unbuffered(fd,buffer + total,N-total);
+		ret = read_unbuffered (fd, buffer + total, N-total);
 		total += ret;
 	}
 
@@ -322,14 +357,14 @@ void read_buf(int f,char *buf,int len)
 
 void read_sbuf(int f,char *buf,int len)
 {
-	read_buf(f,buf,len);
+	read_buf (f,buf,len);
 	buf[len] = 0;
 }
 
 unsigned char read_byte(int f)
 {
 	unsigned char c;
-	read_buf(f,(char *)&c,1);
+	read_buf (f, (char *)&c, 1);
 	return c;
 }
 
@@ -560,10 +595,10 @@ void write_byte(int f,unsigned char c)
 	write_buf(f,(char *)&c,1);
 }
 
+
+
 int read_line(int f, char *buf, int maxlen)
 {
-	eof_error = 0;
-
 	while (maxlen) {
 		buf[0] = 0;
 		read_buf(f, buf, 1);
@@ -581,8 +616,6 @@ int read_line(int f, char *buf, int maxl
 		*buf = 0;
 		return 0;
 	}
-
-	eof_error = 1;
 
 	return 1;
 }
Index: proto.h
===================================================================
RCS file: /data/cvs/rsync/proto.h,v
retrieving revision 1.128
diff -u -p -r1.128 proto.h
--- proto.h	14 Aug 2001 02:04:49 -0000	1.128
+++ proto.h	22 Aug 2001 04:15:12 -0000
@@ -3,6 +3,7 @@
 int allow_access(char *addr, char *host, char *allow_list, char *deny_list);
 char *auth_server(int fd, int module, char *addr, char *leader);
 void auth_client(int fd, char *user, char *challenge);
+int make_backup(char *fname);
 void create_batch_file_ext();
 void set_batch_file_ext(char *ext);
 void write_batch_flist_file(char *buff, int bytes_to_write);
@@ -23,7 +24,6 @@ void close_batch_delta_file();
 int read_batch_delta_file(char *buff, int len);
 void show_flist(int index, struct file_struct **fptr);
 void show_argvs(int argc, char *argv[]);
-int make_backup(char *fname);
 uint32 get_checksum1(char *buf1,int len);
 void get_checksum2(char *buf,int len,char *sum);
 void file_checksum(char *fname,char *sum,OFF_T size);




More information about the rsync mailing list