1 /* -*- c-file-style: "linux" -*-
3 * Copyright (C) 1996-2001 by Andrew Tridgell
4 * Copyright (C) Paul Mackerras 1996
5 * Copyright (C) 2001, 2002 by Martin Pool <mbp@samba.org>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 * Socket and pipe IO utilities used in rsync.
27 * rsync provides its own multiplexing system, which is used to send
28 * stderr and stdout over a single socket. We need this because
29 * stdout normally carries the binary data stream, and stderr all our
32 * For historical reasons this is off during the start of the
33 * connection, but it's switched on quite early using
34 * io_start_multiplex_out() and io_start_multiplex_in().
39 /** If no timeout is specified then use a 60 second select timeout */
40 #define SELECT_TIMEOUT 60
42 static int io_multiplexing_out;
43 static int io_multiplexing_in;
44 static int multiplex_in_fd = -1;
45 static int multiplex_out_fd = -1;
46 static time_t last_io;
51 extern int io_timeout;
52 extern struct stats stats;
55 const char phase_unknown[] = "unknown";
58 * The connection might be dropped at some point; perhaps because the
59 * remote instance crashed. Just giving the offset on the stream is
60 * not very helpful. So instead we try to make io_phase_name point to
63 * For buffered/multiplexed IO these names will be somewhat
64 * approximate; perhaps for ease of support we would rather make the
65 * buffer always flush when a single application-level IO finishes.
67 * @todo Perhaps we want some simple stack functionality, but there's
68 * no need to overdo it.
70 const char *io_write_phase = phase_unknown;
71 const char *io_read_phase = phase_unknown;
73 /** Ignore EOF errors while reading a module listing if the remote
74 version is 24 or less. */
75 int kludge_around_eof = False;
78 static int io_error_fd = -1;
79 static int io_filesfrom_f_in = -1;
80 static int io_filesfrom_f_out = -1;
81 static char io_filesfrom_buf[2048];
82 static char *io_filesfrom_bp;
83 static char io_filesfrom_lastchar;
84 static int io_filesfrom_buflen;
86 static void read_loop(int fd, char *buf, size_t len);
88 static void check_timeout(void)
90 extern int am_server, am_daemon;
95 if (!io_timeout) return;
104 if (last_io && io_timeout && (t-last_io) >= io_timeout) {
105 if (!am_server && !am_daemon) {
106 rprintf(FERROR,"io timeout after %d seconds - exiting\n",
109 exit_cleanup(RERR_TIMEOUT);
113 /** Setup the fd used to propagate errors */
114 void io_set_error_fd(int fd)
119 /** Read some data from the error fd and write it to the write log code */
120 static void read_error_fd(void)
124 int fd = io_error_fd;
127 /* io_error_fd is temporarily disabled -- is this meant to
128 * prevent indefinite recursion? */
131 read_loop(fd, buf, 4);
134 len = tag & 0xFFFFFF;
140 if (n > (sizeof buf - 1))
142 read_loop(fd, buf, n);
143 rwrite((enum logcode)tag, buf, n);
151 * When we're the receiver and we have a local --files-from list of names
152 * that needs to be sent over the socket to the sender, we have to do two
153 * things at the same time: send the sender a list of what files we're
154 * processing and read the incoming file+info list from the sender. We do
155 * this by augmenting the read_timeout() function to copy this data. It
156 * uses the io_filesfrom_buf to read a block of data from f_in (when it is
157 * ready, since it might be a pipe) and then blast it out f_out (when it
158 * is ready to receive more data).
160 void io_set_filesfrom_fds(int f_in, int f_out)
162 io_filesfrom_f_in = f_in;
163 io_filesfrom_f_out = f_out;
164 io_filesfrom_bp = io_filesfrom_buf;
165 io_filesfrom_lastchar = '\0';
166 io_filesfrom_buflen = 0;
170 * It's almost always an error to get an EOF when we're trying to read
171 * from the network, because the protocol is self-terminating.
173 * However, there is one unfortunate cases where it is not, which is
174 * rsync <2.4.6 sending a list of modules on a server, since the list
175 * is terminated by closing the socket. So, for the section of the
176 * program where that is a problem (start_socket_client),
177 * kludge_around_eof is True and we just exit.
179 static void whine_about_eof(void)
181 if (kludge_around_eof)
185 "%s: connection unexpectedly closed "
186 "(%.0f bytes read so far)\n",
187 RSYNC_NAME, (double)stats.total_read);
189 exit_cleanup(RERR_STREAMIO);
194 static void die_from_readerr(int err)
196 /* this prevents us trying to write errors on a dead socket */
197 io_multiplexing_close();
199 rprintf(FERROR, "%s: read error: %s\n",
200 RSYNC_NAME, strerror(err));
201 exit_cleanup(RERR_STREAMIO);
206 * Read from a socket with IO timeout. return the number of bytes
207 * read. If no bytes can be read then exit, never return a number <= 0.
209 * TODO: If the remote shell connection fails, then current versions
210 * actually report an "unexpected EOF" error here. Since it's a
211 * fairly common mistake to try to use rsh when ssh is required, we
212 * should trap that: if we fail to read any data at all, we should
213 * give a better explanation. We can tell whether the connection has
214 * started by looking e.g. at whether the remote version is known yet.
216 static int read_timeout(int fd, char *buf, size_t len)
223 /* until we manage to read *something* */
231 if (io_error_fd >= 0) {
232 FD_SET(io_error_fd, &r_fds);
233 if (io_error_fd >= fd_count) fd_count = io_error_fd+1;
235 if (io_filesfrom_f_out >= 0) {
237 if (io_filesfrom_buflen == 0) {
238 if (io_filesfrom_f_in >= 0) {
239 FD_SET(io_filesfrom_f_in, &r_fds);
240 new_fd = io_filesfrom_f_in;
242 io_filesfrom_f_out = -1;
247 FD_SET(io_filesfrom_f_out, &w_fds);
248 new_fd = io_filesfrom_f_out;
250 if (new_fd >= fd_count) fd_count = new_fd+1;
253 tv.tv_sec = io_timeout?io_timeout:SELECT_TIMEOUT;
258 count = select(fd_count, &r_fds,
259 io_filesfrom_buflen? &w_fds : NULL,
267 if (errno == EBADF) {
268 exit_cleanup(RERR_SOCKETIO);
273 if (io_error_fd >= 0 && FD_ISSET(io_error_fd, &r_fds)) {
277 if (io_filesfrom_f_out >= 0) {
278 if (io_filesfrom_buflen) {
279 if (FD_ISSET(io_filesfrom_f_out, &w_fds)) {
280 int l = write(io_filesfrom_f_out,
282 io_filesfrom_buflen);
284 if (!(io_filesfrom_buflen -= l))
285 io_filesfrom_bp = io_filesfrom_buf;
287 io_filesfrom_bp += l;
289 /* XXX should we complain? */
290 io_filesfrom_f_out = -1;
293 } else if (io_filesfrom_f_in >= 0) {
294 if (FD_ISSET(io_filesfrom_f_in, &r_fds)) {
295 int l = read(io_filesfrom_f_in,
297 sizeof io_filesfrom_buf);
299 /* Send end-of-file marker */
300 io_filesfrom_buf[0] = '\0';
301 io_filesfrom_buf[1] = '\0';
302 io_filesfrom_buflen = io_filesfrom_lastchar? 2 : 1;
303 io_filesfrom_f_in = -1;
305 extern int eol_nulls;
307 char *s = io_filesfrom_buf + l;
308 /* Transform CR and/or LF into '\0' */
309 while (s-- > io_filesfrom_buf) {
310 if (*s == '\n' || *s == '\r')
314 if (!io_filesfrom_lastchar) {
315 /* Last buf ended with a '\0', so don't
316 * let this buf start with one. */
317 while (l && !*io_filesfrom_bp)
318 io_filesfrom_bp++, l--;
321 io_filesfrom_bp = io_filesfrom_buf;
323 char *f = io_filesfrom_bp;
326 /* Eliminate any multi-'\0' runs. */
328 if (!(*t++ = *f++)) {
329 while (f != eob && !*f)
333 io_filesfrom_lastchar = f[-1];
335 io_filesfrom_buflen = l;
341 if (!FD_ISSET(fd, &r_fds)) continue;
343 n = read(fd, buf, len);
350 last_io = time(NULL);
354 return -1; /* doesn't return */
356 if (errno == EINTR || errno == EWOULDBLOCK ||
359 die_from_readerr(errno);
367 * Read a line into the "fname" buffer (which must be at least MAXPATHLEN
370 int read_filesfrom_line(int fd, char *fname)
372 char ch, *s, *eob = fname + MAXPATHLEN - 1;
374 extern int io_timeout;
375 extern int eol_nulls;
376 extern char *remote_filesfrom_file;
377 int reading_remotely = remote_filesfrom_file != NULL;
378 int nulls = eol_nulls || reading_remotely;
383 cnt = read(fd, &ch, 1);
384 if (cnt < 0 && (errno == EWOULDBLOCK
385 || errno == EINTR || errno == EAGAIN)) {
390 tv.tv_sec = io_timeout? io_timeout : SELECT_TIMEOUT;
392 if (!select(fd+1, &fds, NULL, NULL, &tv))
398 if (nulls? !ch : (ch == '\r' || ch == '\n')) {
399 /* Skip empty lines if reading locally. */
400 if (!reading_remotely && s == fname)
410 if (*fname == '#' || *fname == ';')
418 * Continue trying to read len bytes - don't return until len has been
421 static void read_loop(int fd, char *buf, size_t len)
424 int n = read_timeout(fd, buf, len);
433 * Read from the file descriptor handling multiplexing - return number
436 * Never returns <= 0.
438 static int read_unbuffered(int fd, char *buf, size_t len)
440 static size_t remaining;
444 static size_t bufferIdx = 0;
445 static size_t bufferSz;
447 if (fd != multiplex_in_fd)
448 return read_timeout(fd, buf, len);
450 if (!io_multiplexing_in && remaining == 0) {
452 bufferSz = 2 * IO_BUFFER_SIZE;
453 buffer = new_array(char, bufferSz);
454 if (!buffer) out_of_memory("read_unbuffered");
456 remaining = read_timeout(fd, buffer, bufferSz);
462 len = MIN(len, remaining);
463 memcpy(buf, buffer + bufferIdx, len);
470 read_loop(fd, line, 4);
473 remaining = tag & 0xFFFFFF;
476 if (tag == MPLEX_BASE) {
477 if (!buffer || remaining > bufferSz) {
478 buffer = realloc_array(buffer, char, remaining);
479 if (!buffer) out_of_memory("read_unbuffered");
480 bufferSz = remaining;
482 read_loop(fd, buffer, remaining);
489 if (tag != FERROR && tag != FINFO) {
490 rprintf(FERROR, "unexpected tag %d\n", tag);
491 exit_cleanup(RERR_STREAMIO);
494 if (remaining > sizeof line - 1) {
495 rprintf(FERROR, "multiplexing overflow %ld\n\n",
497 exit_cleanup(RERR_STREAMIO);
500 read_loop(fd, line, remaining);
503 rprintf((enum logcode) tag, "%s", line);
516 * Do a buffered read from @p fd. Don't return until all @p n bytes
517 * have been read. If all @p n can't be read then exit with an
520 static void readfd(int fd, char *buffer, size_t N)
526 ret = read_unbuffered(fd, buffer + total, N-total);
530 stats.total_read += total;
534 int32 read_int(int f)
541 if (ret == (int32)0xffffffff) return -1;
545 int64 read_longint(int f)
551 if ((int32)ret != (int32)0xffffffff) {
556 rprintf(FERROR,"Integer overflow - attempted 64 bit offset\n");
557 exit_cleanup(RERR_UNSUPPORTED);
560 ret = IVAL(b,0) | (((int64)IVAL(b,4))<<32);
566 void read_buf(int f,char *buf,size_t len)
571 void read_sbuf(int f,char *buf,size_t len)
577 unsigned char read_byte(int f)
580 read_buf(f, (char *)&c, 1);
586 * Sleep after writing to limit I/O bandwidth usage.
588 * @todo Rather than sleeping after each write, it might be better to
589 * use some kind of averaging. The current algorithm seems to always
590 * use a bit less bandwidth than specified, because it doesn't make up
591 * for slow periods. But arguably this is a feature. In addition, we
592 * ought to take the time used to write the data into account.
594 static void sleep_for_bwlimit(int bytes_written)
601 assert(bytes_written > 0);
604 tv.tv_usec = bytes_written * 1000 / bwlimit;
605 tv.tv_sec = tv.tv_usec / 1000000;
606 tv.tv_usec = tv.tv_usec % 1000000;
608 select(0, NULL, NULL, NULL, &tv);
613 * Write len bytes to the file descriptor @p fd.
615 * This function underlies the multiplexing system. The body of the
616 * application never calls this function directly.
618 static void writefd_unbuffered(int fd,char *buf,size_t len)
629 while (total < len) {
634 if (io_error_fd >= 0) {
636 FD_SET(io_error_fd,&r_fds);
637 if (io_error_fd > fd_count)
638 fd_count = io_error_fd;
641 tv.tv_sec = io_timeout?io_timeout:SELECT_TIMEOUT;
646 count = select(fd_count+1,
647 io_error_fd >= 0?&r_fds:NULL,
656 if (errno == EBADF) {
657 exit_cleanup(RERR_SOCKETIO);
662 if (io_error_fd >= 0 && FD_ISSET(io_error_fd, &r_fds)) {
666 if (FD_ISSET(fd, &w_fds)) {
668 size_t n = len-total;
669 ret = write(fd,buf+total,n);
674 if (errno == EWOULDBLOCK || errno == EAGAIN) {
681 /* Don't try to write errors back
682 * across the stream */
683 io_multiplexing_close();
684 rprintf(FERROR, RSYNC_NAME
685 ": writefd_unbuffered failed to write %ld bytes: phase \"%s\": %s\n",
686 (long) len, io_write_phase,
688 exit_cleanup(RERR_STREAMIO);
691 sleep_for_bwlimit(ret);
696 last_io = time(NULL);
704 static char *io_buffer;
705 static int io_buffer_count;
707 void io_start_buffering_out(int fd)
709 if (io_buffer) return;
710 multiplex_out_fd = fd;
711 io_buffer = new_array(char, IO_BUFFER_SIZE);
712 if (!io_buffer) out_of_memory("writefd");
716 void io_start_buffering_in(int fd)
718 multiplex_in_fd = fd;
722 * Write an message to a multiplexed stream. If this fails then rsync
725 static void mplex_write(int fd, enum logcode code, char *buf, size_t len)
730 SIVAL(buffer, 0, ((MPLEX_BASE + (int)code)<<24) + len);
732 if (n > (sizeof buffer - 4)) {
733 n = sizeof buffer - 4;
736 memcpy(&buffer[4], buf, n);
737 writefd_unbuffered(fd, buffer, n+4);
743 writefd_unbuffered(fd, buf, len);
750 int fd = multiplex_out_fd;
754 if (!io_buffer_count || no_flush) return;
756 if (io_multiplexing_out) {
757 mplex_write(fd, FNONE, io_buffer, io_buffer_count);
759 writefd_unbuffered(fd, io_buffer, io_buffer_count);
765 void io_end_buffering(void)
768 if (!io_multiplexing_out) {
774 static void writefd(int fd,char *buf,size_t len)
776 stats.total_written += len;
780 if (!io_buffer || fd != multiplex_out_fd) {
781 writefd_unbuffered(fd, buf, len);
786 int n = MIN((int) len, IO_BUFFER_SIZE-io_buffer_count);
788 memcpy(io_buffer+io_buffer_count, buf, n);
791 io_buffer_count += n;
794 if (io_buffer_count == IO_BUFFER_SIZE) io_flush();
799 void write_int(int f,int32 x)
807 void write_int_named(int f, int32 x, const char *phase)
809 io_write_phase = phase;
811 io_write_phase = phase_unknown;
816 * Note: int64 may actually be a 32-bit type if ./configure couldn't find any
817 * 64-bit types on this platform.
819 void write_longint(int f, int64 x)
823 if (x <= 0x7FFFFFFF) {
824 write_int(f, (int)x);
829 rprintf(FERROR,"Integer overflow - attempted 64 bit offset\n");
830 exit_cleanup(RERR_UNSUPPORTED);
832 write_int(f, (int32)0xFFFFFFFF);
833 SIVAL(b,0,(x&0xFFFFFFFF));
834 SIVAL(b,4,((x>>32)&0xFFFFFFFF));
840 void write_buf(int f,char *buf,size_t len)
845 /** Write a string to the connection */
846 static void write_sbuf(int f,char *buf)
848 write_buf(f, buf, strlen(buf));
852 void write_byte(int f,unsigned char c)
854 write_buf(f,(char *)&c,1);
860 * Read a line of up to @p maxlen characters into @p buf. Does not
861 * contain a trailing newline or carriage return.
863 * @return 1 for success; 0 for io error or truncation.
865 int read_line(int f, char *buf, size_t maxlen)
872 if (buf[0] == '\n') {
876 if (buf[0] != '\r') {
890 void io_printf(int fd, const char *format, ...)
896 va_start(ap, format);
897 len = vsnprintf(buf, sizeof buf, format, ap);
900 if (len < 0) exit_cleanup(RERR_STREAMIO);
906 /** Setup for multiplexing an error stream with the data stream */
907 void io_start_multiplex_out(int fd)
909 multiplex_out_fd = fd;
911 io_start_buffering_out(fd);
912 io_multiplexing_out = 1;
915 /** Setup for multiplexing an error stream with the data stream */
916 void io_start_multiplex_in(int fd)
918 multiplex_in_fd = fd;
920 io_multiplexing_in = 1;
923 /** Write an message to the multiplexed error stream */
924 int io_multiplex_write(enum logcode code, char *buf, size_t len)
926 if (!io_multiplexing_out) return 0;
929 stats.total_written += (len+4);
930 mplex_write(multiplex_out_fd, code, buf, len);
934 /** Stop output multiplexing */
935 void io_multiplexing_close(void)
937 io_multiplexing_out = 0;