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 I/O 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
43 extern size_t bwlimit_writemax;
44 extern int io_timeout;
45 extern int allowed_lull;
49 extern int am_generator;
51 extern int read_batch;
52 extern int csum_length;
53 extern int checksum_seed;
54 extern int protocol_version;
55 extern int remove_sent_files;
56 extern int preserve_hard_links;
57 extern char *filesfrom_host;
58 extern struct stats stats;
59 extern struct file_list *the_file_list;
61 const char phase_unknown[] = "unknown";
62 int ignore_timeout = 0;
64 int batch_gen_fd = -1;
67 * The connection might be dropped at some point; perhaps because the
68 * remote instance crashed. Just giving the offset on the stream is
69 * not very helpful. So instead we try to make io_phase_name point to
72 * For buffered/multiplexed I/O these names will be somewhat
73 * approximate; perhaps for ease of support we would rather make the
74 * buffer always flush when a single application-level I/O finishes.
76 * @todo Perhaps we want some simple stack functionality, but there's
77 * no need to overdo it.
79 const char *io_write_phase = phase_unknown;
80 const char *io_read_phase = phase_unknown;
82 /* Ignore an EOF error if non-zero. See whine_about_eof(). */
83 int kluge_around_eof = 0;
90 static int io_multiplexing_out;
91 static int io_multiplexing_in;
92 static time_t last_io_in;
93 static time_t last_io_out;
96 static int write_batch_monitor_in = -1;
97 static int write_batch_monitor_out = -1;
99 static int io_filesfrom_f_in = -1;
100 static int io_filesfrom_f_out = -1;
101 static char io_filesfrom_buf[2048];
102 static char *io_filesfrom_bp;
103 static char io_filesfrom_lastchar;
104 static int io_filesfrom_buflen;
105 static int defer_forwarding_messages = 0;
106 static int select_timeout = SELECT_TIMEOUT;
107 static int active_filecnt = 0;
108 static OFF_T active_bytecnt = 0;
110 static void read_loop(int fd, char *buf, size_t len);
112 struct flist_ndx_item {
113 struct flist_ndx_item *next;
117 struct flist_ndx_list {
118 struct flist_ndx_item *head, *tail;
121 static struct flist_ndx_list redo_list, hlink_list;
123 struct msg_list_item {
124 struct msg_list_item *next;
130 struct msg_list_item *head, *tail;
133 static struct msg_list msg2genr, msg2sndr;
135 static void flist_ndx_push(struct flist_ndx_list *lp, int ndx)
137 struct flist_ndx_item *item;
139 if (!(item = new(struct flist_ndx_item)))
140 out_of_memory("flist_ndx_push");
144 lp->tail->next = item;
150 static int flist_ndx_pop(struct flist_ndx_list *lp)
152 struct flist_ndx_item *next;
159 next = lp->head->next;
168 static void check_timeout(void)
172 if (!io_timeout || ignore_timeout)
176 last_io_in = time(NULL);
182 if (t - last_io_in >= io_timeout) {
183 if (!am_server && !am_daemon) {
184 rprintf(FERROR, "io timeout after %d seconds -- exiting\n",
185 (int)(t-last_io_in));
187 exit_cleanup(RERR_TIMEOUT);
191 /* Note the fds used for the main socket (which might really be a pipe
192 * for a local transfer, but we can ignore that). */
193 void io_set_sock_fds(int f_in, int f_out)
199 void set_io_timeout(int secs)
203 if (!io_timeout || io_timeout > SELECT_TIMEOUT)
204 select_timeout = SELECT_TIMEOUT;
206 select_timeout = io_timeout;
208 allowed_lull = read_batch ? 0 : (io_timeout + 1) / 2;
211 /* Setup the fd used to receive MSG_* messages. Only needed during the
212 * early stages of being a local sender (up through the sending of the
213 * file list) or when we're the generator (to fetch the messages from
215 void set_msg_fd_in(int fd)
220 /* Setup the fd used to send our MSG_* messages. Only needed when
221 * we're the receiver (to send our messages to the generator). */
222 void set_msg_fd_out(int fd)
225 set_nonblocking(msg_fd_out);
228 /* Add a message to the pending MSG_* list. */
229 static void msg_list_add(struct msg_list *lst, int code, char *buf, int len)
231 struct msg_list_item *m;
232 int sz = len + 4 + sizeof m[0] - 1;
234 if (!(m = (struct msg_list_item *)new_array(char, sz)))
235 out_of_memory("msg_list_add");
238 SIVAL(m->buf, 0, ((code+MPLEX_BASE)<<24) | len);
239 memcpy(m->buf + 4, buf, len);
247 /* Read a message from the MSG_* fd and handle it. This is called either
248 * during the early stages of being a local sender (up through the sending
249 * of the file list) or when we're the generator (to fetch the messages
250 * from the receiver). */
251 static void read_msg_fd(void)
258 /* Temporarily disable msg_fd_in. This is needed to avoid looping back
259 * to this routine from writefd_unbuffered(). */
262 read_loop(fd, buf, 4);
265 len = tag & 0xFFFFFF;
266 tag = (tag >> 24) - MPLEX_BASE;
270 if (len != 0 || !am_generator) {
271 rprintf(FERROR, "invalid message %d:%d\n", tag, len);
272 exit_cleanup(RERR_STREAMIO);
274 flist_ndx_push(&redo_list, -1);
277 if (len != 4 || !am_generator) {
278 rprintf(FERROR, "invalid message %d:%d\n", tag, len);
279 exit_cleanup(RERR_STREAMIO);
281 read_loop(fd, buf, 4);
282 if (remove_sent_files)
283 decrement_active_files(IVAL(buf,0));
284 flist_ndx_push(&redo_list, IVAL(buf,0));
287 if (len >= (int)sizeof buf || !am_generator) {
288 rprintf(FERROR, "invalid message %d:%d\n", tag, len);
289 exit_cleanup(RERR_STREAMIO);
291 read_loop(fd, buf, len);
292 if (defer_forwarding_messages)
293 msg_list_add(&msg2sndr, MSG_DELETED, buf, len);
295 io_multiplex_write(MSG_DELETED, buf, len);
298 if (len != 4 || !am_generator) {
299 rprintf(FERROR, "invalid message %d:%d\n", tag, len);
300 exit_cleanup(RERR_STREAMIO);
302 read_loop(fd, buf, len);
303 if (remove_sent_files) {
304 decrement_active_files(IVAL(buf,0));
305 if (defer_forwarding_messages)
306 msg_list_add(&msg2sndr, MSG_SUCCESS, buf, len);
308 io_multiplex_write(MSG_SUCCESS, buf, len);
310 if (preserve_hard_links)
311 flist_ndx_push(&hlink_list, IVAL(buf,0));
315 rprintf(FERROR, "invalid message %d:%d\n", tag, len);
316 exit_cleanup(RERR_STREAMIO);
318 close_multiplexing_out();
327 read_loop(fd, buf, n);
328 if (am_generator && am_server && defer_forwarding_messages)
329 msg_list_add(&msg2sndr, tag, buf, n);
331 rwrite((enum logcode)tag, buf, n);
336 rprintf(FERROR, "unknown message %d:%d [%s]\n",
337 tag, len, who_am_i());
338 exit_cleanup(RERR_STREAMIO);
344 /* This is used by the generator to limit how many file transfers can
345 * be active at once when --remove-sent-files is specified. Without
346 * this, sender-side deletions were mostly happening at the end. */
347 void increment_active_files(int ndx, int itemizing, enum logcode code)
349 /* TODO: tune these limits? */
350 while (active_filecnt >= (active_bytecnt >= 128*1024 ? 10 : 50)) {
352 check_for_finished_hlinks(itemizing, code);
357 active_bytecnt += the_file_list->files[ndx]->length;
360 void decrement_active_files(int ndx)
363 active_bytecnt -= the_file_list->files[ndx]->length;
366 /* Try to push messages off the list onto the wire. If we leave with more
367 * to do, return 0. On error, return -1. If everything flushed, return 1.
368 * This is only active in the receiver. */
369 static int msg2genr_flush(int flush_it_all)
371 static int written = 0;
378 while (msg2genr.head) {
379 struct msg_list_item *m = msg2genr.head;
380 int n = write(msg_fd_out, m->buf + written, m->len - written);
384 if (errno != EWOULDBLOCK && errno != EAGAIN)
389 FD_SET(msg_fd_out, &fds);
390 tv.tv_sec = select_timeout;
392 if (!select(msg_fd_out+1, NULL, &fds, NULL, &tv))
394 } else if ((written += n) == m->len) {
395 msg2genr.head = m->next;
397 msg2genr.tail = NULL;
405 void send_msg(enum msgcode code, char *buf, int len)
407 if (msg_fd_out < 0) {
408 io_multiplex_write(code, buf, len);
411 msg_list_add(&msg2genr, code, buf, len);
412 msg2genr_flush(NORMAL_FLUSH);
415 int get_redo_num(int itemizing, enum logcode code)
419 check_for_finished_hlinks(itemizing, code);
425 return flist_ndx_pop(&redo_list);
428 int get_hlink_num(void)
430 return flist_ndx_pop(&hlink_list);
434 * When we're the receiver and we have a local --files-from list of names
435 * that needs to be sent over the socket to the sender, we have to do two
436 * things at the same time: send the sender a list of what files we're
437 * processing and read the incoming file+info list from the sender. We do
438 * this by augmenting the read_timeout() function to copy this data. It
439 * uses the io_filesfrom_buf to read a block of data from f_in (when it is
440 * ready, since it might be a pipe) and then blast it out f_out (when it
441 * is ready to receive more data).
443 void io_set_filesfrom_fds(int f_in, int f_out)
445 io_filesfrom_f_in = f_in;
446 io_filesfrom_f_out = f_out;
447 io_filesfrom_bp = io_filesfrom_buf;
448 io_filesfrom_lastchar = '\0';
449 io_filesfrom_buflen = 0;
452 /* It's almost always an error to get an EOF when we're trying to read from the
453 * network, because the protocol is (for the most part) self-terminating.
455 * There is one case for the receiver when it is at the end of the transfer
456 * (hanging around reading any keep-alive packets that might come its way): if
457 * the sender dies before the generator's kill-signal comes through, we can end
458 * up here needing to loop until the kill-signal arrives. In this situation,
459 * kluge_around_eof will be < 0.
461 * There is another case for older protocol versions (< 24) where the module
462 * listing was not terminated, so we must ignore an EOF error in that case and
463 * exit. In this situation, kluge_around_eof will be > 0. */
464 static void whine_about_eof(int fd)
466 if (kluge_around_eof && fd == sock_f_in) {
468 if (kluge_around_eof > 0)
470 /* If we're still here after 10 seconds, exit with an error. */
471 for (i = 10*1000/20; i--; )
475 rprintf(FERROR, RSYNC_NAME ": connection unexpectedly closed "
476 "(%.0f bytes received so far) [%s]\n",
477 (double)stats.total_read, who_am_i());
479 exit_cleanup(RERR_STREAMIO);
483 * Read from a socket with I/O timeout. return the number of bytes
484 * read. If no bytes can be read then exit, never return a number <= 0.
486 * TODO: If the remote shell connection fails, then current versions
487 * actually report an "unexpected EOF" error here. Since it's a
488 * fairly common mistake to try to use rsh when ssh is required, we
489 * should trap that: if we fail to read any data at all, we should
490 * give a better explanation. We can tell whether the connection has
491 * started by looking e.g. at whether the remote version is known yet.
493 static int read_timeout(int fd, char *buf, size_t len)
497 io_flush(NORMAL_FLUSH);
500 /* until we manage to read *something* */
510 FD_SET(msg_fd_out, &w_fds);
511 if (msg_fd_out > maxfd)
514 if (io_filesfrom_f_out >= 0) {
516 if (io_filesfrom_buflen == 0) {
517 if (io_filesfrom_f_in >= 0) {
518 FD_SET(io_filesfrom_f_in, &r_fds);
519 new_fd = io_filesfrom_f_in;
521 io_filesfrom_f_out = -1;
525 FD_SET(io_filesfrom_f_out, &w_fds);
526 new_fd = io_filesfrom_f_out;
532 tv.tv_sec = select_timeout;
537 count = select(maxfd + 1, &r_fds, &w_fds, NULL, &tv);
541 exit_cleanup(RERR_SOCKETIO);
546 if (msg2genr.head && FD_ISSET(msg_fd_out, &w_fds))
547 msg2genr_flush(NORMAL_FLUSH);
549 if (io_filesfrom_f_out >= 0) {
550 if (io_filesfrom_buflen) {
551 if (FD_ISSET(io_filesfrom_f_out, &w_fds)) {
552 int l = write(io_filesfrom_f_out,
554 io_filesfrom_buflen);
556 if (!(io_filesfrom_buflen -= l))
557 io_filesfrom_bp = io_filesfrom_buf;
559 io_filesfrom_bp += l;
561 /* XXX should we complain? */
562 io_filesfrom_f_out = -1;
565 } else if (io_filesfrom_f_in >= 0) {
566 if (FD_ISSET(io_filesfrom_f_in, &r_fds)) {
567 int l = read(io_filesfrom_f_in,
569 sizeof io_filesfrom_buf);
571 /* Send end-of-file marker */
572 io_filesfrom_buf[0] = '\0';
573 io_filesfrom_buf[1] = '\0';
574 io_filesfrom_buflen = io_filesfrom_lastchar? 2 : 1;
575 io_filesfrom_f_in = -1;
578 char *s = io_filesfrom_buf + l;
579 /* Transform CR and/or LF into '\0' */
580 while (s-- > io_filesfrom_buf) {
581 if (*s == '\n' || *s == '\r')
585 if (!io_filesfrom_lastchar) {
586 /* Last buf ended with a '\0', so don't
587 * let this buf start with one. */
588 while (l && !*io_filesfrom_bp)
589 io_filesfrom_bp++, l--;
592 io_filesfrom_bp = io_filesfrom_buf;
594 char *f = io_filesfrom_bp;
597 /* Eliminate any multi-'\0' runs. */
599 if (!(*t++ = *f++)) {
600 while (f != eob && !*f)
604 io_filesfrom_lastchar = f[-1];
606 io_filesfrom_buflen = l;
612 if (!FD_ISSET(fd, &r_fds))
615 n = read(fd, buf, len);
619 whine_about_eof(fd); /* Doesn't return. */
620 if (errno == EINTR || errno == EWOULDBLOCK
624 /* Don't write errors on a dead socket. */
625 if (fd == sock_f_in) {
626 close_multiplexing_out();
627 rsyserr(FSOCKERR, errno, "read error");
629 rsyserr(FERROR, errno, "read error");
630 exit_cleanup(RERR_STREAMIO);
637 if (fd == sock_f_in && io_timeout)
638 last_io_in = time(NULL);
645 * Read a line into the "fname" buffer (which must be at least MAXPATHLEN
648 int read_filesfrom_line(int fd, char *fname)
650 char ch, *s, *eob = fname + MAXPATHLEN - 1;
652 int reading_remotely = filesfrom_host != NULL;
653 int nulls = eol_nulls || reading_remotely;
658 cnt = read(fd, &ch, 1);
659 if (cnt < 0 && (errno == EWOULDBLOCK
660 || errno == EINTR || errno == EAGAIN)) {
665 tv.tv_sec = select_timeout;
667 if (!select(fd+1, &fds, NULL, NULL, &tv))
673 if (nulls? !ch : (ch == '\r' || ch == '\n')) {
674 /* Skip empty lines if reading locally. */
675 if (!reading_remotely && s == fname)
685 if (*fname == '#' || *fname == ';')
691 static char *iobuf_out;
692 static int iobuf_out_cnt;
694 void io_start_buffering_out(void)
698 if (!(iobuf_out = new_array(char, IO_BUFFER_SIZE)))
699 out_of_memory("io_start_buffering_out");
703 static char *iobuf_in;
704 static size_t iobuf_in_siz;
706 void io_start_buffering_in(void)
710 iobuf_in_siz = 2 * IO_BUFFER_SIZE;
711 if (!(iobuf_in = new_array(char, iobuf_in_siz)))
712 out_of_memory("io_start_buffering_in");
715 void io_end_buffering(void)
717 io_flush(NORMAL_FLUSH);
718 if (!io_multiplexing_out) {
724 void maybe_flush_socket(void)
726 if (iobuf_out && iobuf_out_cnt && time(NULL) - last_io_out >= 5)
727 io_flush(NORMAL_FLUSH);
730 void maybe_send_keepalive(void)
732 if (time(NULL) - last_io_out >= allowed_lull) {
733 if (!iobuf_out || !iobuf_out_cnt) {
734 if (protocol_version < 29)
735 return; /* there's nothing we can do */
736 write_int(sock_f_out, the_file_list->count);
737 write_shortint(sock_f_out, ITEM_IS_NEW);
740 io_flush(NORMAL_FLUSH);
745 * Continue trying to read len bytes - don't return until len has been
748 static void read_loop(int fd, char *buf, size_t len)
751 int n = read_timeout(fd, buf, len);
759 * Read from the file descriptor handling multiplexing - return number
762 * Never returns <= 0.
764 static int readfd_unbuffered(int fd, char *buf, size_t len)
766 static size_t remaining;
767 static size_t iobuf_in_ndx;
770 char line[BIGPATHBUFLEN];
772 if (!iobuf_in || fd != sock_f_in)
773 return read_timeout(fd, buf, len);
775 if (!io_multiplexing_in && remaining == 0) {
776 remaining = read_timeout(fd, iobuf_in, iobuf_in_siz);
782 len = MIN(len, remaining);
783 memcpy(buf, iobuf_in + iobuf_in_ndx, len);
790 read_loop(fd, line, 4);
793 msg_bytes = tag & 0xFFFFFF;
794 tag = (tag >> 24) - MPLEX_BASE;
798 if (msg_bytes > iobuf_in_siz) {
799 if (!(iobuf_in = realloc_array(iobuf_in, char,
801 out_of_memory("readfd_unbuffered");
802 iobuf_in_siz = msg_bytes;
804 read_loop(fd, iobuf_in, msg_bytes);
805 remaining = msg_bytes;
809 if (msg_bytes >= sizeof line)
811 read_loop(fd, line, msg_bytes);
812 /* A directory name was sent with the trailing null */
813 if (msg_bytes > 0 && !line[msg_bytes-1])
814 log_delete(line, S_IFDIR);
816 line[msg_bytes] = '\0';
817 log_delete(line, S_IFREG);
821 if (msg_bytes != 4) {
822 rprintf(FERROR, "invalid multi-message %d:%ld [%s]\n",
823 tag, (long)msg_bytes, who_am_i());
824 exit_cleanup(RERR_STREAMIO);
826 read_loop(fd, line, msg_bytes);
827 successful_send(IVAL(line, 0));
831 if (msg_bytes >= sizeof line) {
834 "multiplexing overflow %d:%ld [%s]\n",
835 tag, (long)msg_bytes, who_am_i());
836 exit_cleanup(RERR_STREAMIO);
838 read_loop(fd, line, msg_bytes);
839 rwrite((enum logcode)tag, line, msg_bytes);
842 rprintf(FERROR, "unexpected tag %d [%s]\n",
844 exit_cleanup(RERR_STREAMIO);
849 io_flush(NORMAL_FLUSH);
855 * Do a buffered read from @p fd. Don't return until all @p n bytes
856 * have been read. If all @p n can't be read then exit with an
859 static void readfd(int fd, char *buffer, size_t N)
865 cnt = readfd_unbuffered(fd, buffer + total, N-total);
869 if (fd == write_batch_monitor_in) {
870 if ((size_t)write(batch_fd, buffer, total) != total)
871 exit_cleanup(RERR_FILEIO);
875 stats.total_read += total;
878 int read_shortint(int f)
881 readfd(f, (char *)b, 2);
882 return (b[1] << 8) + b[0];
885 int32 read_int(int f)
892 if (num == (int32)0xffffffff)
897 int64 read_longint(int f)
903 if ((int32)num != (int32)0xffffffff)
907 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
908 exit_cleanup(RERR_UNSUPPORTED);
911 num = IVAL(b,0) | (((int64)IVAL(b,4))<<32);
917 void read_buf(int f,char *buf,size_t len)
922 void read_sbuf(int f,char *buf,size_t len)
928 uchar read_byte(int f)
931 readfd(f, (char *)&c, 1);
935 int read_vstring(int f, char *buf, int bufsize)
937 int len = read_byte(f);
940 len = (len & ~0x80) * 0x100 + read_byte(f);
942 if (len >= bufsize) {
943 rprintf(FERROR, "over-long vstring received (%d > %d)\n",
954 /* Populate a sum_struct with values from the socket. This is
955 * called by both the sender and the receiver. */
956 void read_sum_head(int f, struct sum_struct *sum)
958 sum->count = read_int(f);
959 if (sum->count < 0) {
960 rprintf(FERROR, "Invalid checksum count %ld [%s]\n",
961 (long)sum->count, who_am_i());
962 exit_cleanup(RERR_PROTOCOL);
964 sum->blength = read_int(f);
965 if (sum->blength < 0 || sum->blength > MAX_BLOCK_SIZE) {
966 rprintf(FERROR, "Invalid block length %ld [%s]\n",
967 (long)sum->blength, who_am_i());
968 exit_cleanup(RERR_PROTOCOL);
970 sum->s2length = protocol_version < 27 ? csum_length : (int)read_int(f);
971 if (sum->s2length < 0 || sum->s2length > MD4_SUM_LENGTH) {
972 rprintf(FERROR, "Invalid checksum length %d [%s]\n",
973 sum->s2length, who_am_i());
974 exit_cleanup(RERR_PROTOCOL);
976 sum->remainder = read_int(f);
977 if (sum->remainder < 0 || sum->remainder > sum->blength) {
978 rprintf(FERROR, "Invalid remainder length %ld [%s]\n",
979 (long)sum->remainder, who_am_i());
980 exit_cleanup(RERR_PROTOCOL);
984 /* Send the values from a sum_struct over the socket. Set sum to
985 * NULL if there are no checksums to send. This is called by both
986 * the generator and the sender. */
987 void write_sum_head(int f, struct sum_struct *sum)
989 static struct sum_struct null_sum;
994 write_int(f, sum->count);
995 write_int(f, sum->blength);
996 if (protocol_version >= 27)
997 write_int(f, sum->s2length);
998 write_int(f, sum->remainder);
1002 * Sleep after writing to limit I/O bandwidth usage.
1004 * @todo Rather than sleeping after each write, it might be better to
1005 * use some kind of averaging. The current algorithm seems to always
1006 * use a bit less bandwidth than specified, because it doesn't make up
1007 * for slow periods. But arguably this is a feature. In addition, we
1008 * ought to take the time used to write the data into account.
1010 * During some phases of big transfers (file FOO is uptodate) this is
1011 * called with a small bytes_written every time. As the kernel has to
1012 * round small waits up to guarantee that we actually wait at least the
1013 * requested number of microseconds, this can become grossly inaccurate.
1014 * We therefore keep track of the bytes we've written over time and only
1015 * sleep when the accumulated delay is at least 1 tenth of a second.
1017 static void sleep_for_bwlimit(int bytes_written)
1019 static struct timeval prior_tv;
1020 static long total_written = 0;
1021 struct timeval tv, start_tv;
1022 long elapsed_usec, sleep_usec;
1024 #define ONE_SEC 1000000L /* # of microseconds in a second */
1026 if (!bwlimit_writemax)
1029 total_written += bytes_written;
1031 gettimeofday(&start_tv, NULL);
1032 if (prior_tv.tv_sec) {
1033 elapsed_usec = (start_tv.tv_sec - prior_tv.tv_sec) * ONE_SEC
1034 + (start_tv.tv_usec - prior_tv.tv_usec);
1035 total_written -= elapsed_usec * bwlimit / (ONE_SEC/1024);
1036 if (total_written < 0)
1040 sleep_usec = total_written * (ONE_SEC/1024) / bwlimit;
1041 if (sleep_usec < ONE_SEC / 10) {
1042 prior_tv = start_tv;
1046 tv.tv_sec = sleep_usec / ONE_SEC;
1047 tv.tv_usec = sleep_usec % ONE_SEC;
1048 select(0, NULL, NULL, NULL, &tv);
1050 gettimeofday(&prior_tv, NULL);
1051 elapsed_usec = (prior_tv.tv_sec - start_tv.tv_sec) * ONE_SEC
1052 + (prior_tv.tv_usec - start_tv.tv_usec);
1053 total_written = (sleep_usec - elapsed_usec) * bwlimit / (ONE_SEC/1024);
1056 /* Write len bytes to the file descriptor fd, looping as necessary to get
1057 * the job done and also (in certain circumstances) reading any data on
1058 * msg_fd_in to avoid deadlock.
1060 * This function underlies the multiplexing system. The body of the
1061 * application never calls this function directly. */
1062 static void writefd_unbuffered(int fd,char *buf,size_t len)
1064 size_t n, total = 0;
1065 fd_set w_fds, r_fds;
1066 int maxfd, count, cnt, using_r_fds;
1067 int defer_save = defer_forwarding_messages;
1072 while (total < len) {
1077 if (msg_fd_in >= 0) {
1079 FD_SET(msg_fd_in,&r_fds);
1080 if (msg_fd_in > maxfd)
1086 tv.tv_sec = select_timeout;
1090 count = select(maxfd + 1, using_r_fds ? &r_fds : NULL,
1094 if (count < 0 && errno == EBADF)
1095 exit_cleanup(RERR_SOCKETIO);
1100 if (using_r_fds && FD_ISSET(msg_fd_in, &r_fds))
1103 if (!FD_ISSET(fd, &w_fds))
1107 if (bwlimit_writemax && n > bwlimit_writemax)
1108 n = bwlimit_writemax;
1109 cnt = write(fd, buf + total, n);
1115 if (errno == EWOULDBLOCK || errno == EAGAIN) {
1121 /* Don't try to write errors back across the stream. */
1122 if (fd == sock_f_out)
1123 close_multiplexing_out();
1124 rsyserr(FERROR, errno,
1125 "writefd_unbuffered failed to write %ld bytes: phase \"%s\" [%s]",
1126 (long)len, io_write_phase, who_am_i());
1127 /* If the other side is sending us error messages, try
1128 * to grab any messages they sent before they died. */
1129 while (fd == sock_f_out && io_multiplexing_in) {
1132 readfd_unbuffered(sock_f_in, io_filesfrom_buf,
1133 sizeof io_filesfrom_buf);
1135 exit_cleanup(RERR_STREAMIO);
1139 defer_forwarding_messages = 1;
1141 if (fd == sock_f_out) {
1142 if (io_timeout || am_generator)
1143 last_io_out = time(NULL);
1144 sleep_for_bwlimit(cnt);
1148 defer_forwarding_messages = defer_save;
1152 static void msg2sndr_flush(void)
1154 if (defer_forwarding_messages)
1157 while (msg2sndr.head && io_multiplexing_out) {
1158 struct msg_list_item *m = msg2sndr.head;
1159 if (!(msg2sndr.head = m->next))
1160 msg2sndr.tail = NULL;
1161 stats.total_written += m->len;
1162 defer_forwarding_messages = 1;
1163 writefd_unbuffered(sock_f_out, m->buf, m->len);
1164 defer_forwarding_messages = 0;
1170 * Write an message to a multiplexed stream. If this fails then rsync
1173 static void mplex_write(enum msgcode code, char *buf, size_t len)
1178 SIVAL(buffer, 0, ((MPLEX_BASE + (int)code)<<24) + len);
1180 if (n > sizeof buffer - 4)
1183 memcpy(buffer + 4, buf, n);
1185 writefd_unbuffered(sock_f_out, buffer, n+4);
1191 defer_forwarding_messages = 1;
1192 writefd_unbuffered(sock_f_out, buf, len);
1193 defer_forwarding_messages = 0;
1198 void io_flush(int flush_it_all)
1200 msg2genr_flush(flush_it_all);
1203 if (!iobuf_out_cnt || no_flush)
1206 if (io_multiplexing_out)
1207 mplex_write(MSG_DATA, iobuf_out, iobuf_out_cnt);
1209 writefd_unbuffered(sock_f_out, iobuf_out, iobuf_out_cnt);
1213 static void writefd(int fd,char *buf,size_t len)
1215 if (fd == msg_fd_out) {
1216 rprintf(FERROR, "Internal error: wrong write used in receiver.\n");
1217 exit_cleanup(RERR_PROTOCOL);
1220 if (fd == sock_f_out)
1221 stats.total_written += len;
1223 if (fd == write_batch_monitor_out) {
1224 if ((size_t)write(batch_fd, buf, len) != len)
1225 exit_cleanup(RERR_FILEIO);
1228 if (!iobuf_out || fd != sock_f_out) {
1229 writefd_unbuffered(fd, buf, len);
1234 int n = MIN((int)len, IO_BUFFER_SIZE - iobuf_out_cnt);
1236 memcpy(iobuf_out+iobuf_out_cnt, buf, n);
1242 if (iobuf_out_cnt == IO_BUFFER_SIZE)
1243 io_flush(NORMAL_FLUSH);
1247 void write_shortint(int f, int x)
1252 writefd(f, (char *)b, 2);
1255 void write_int(int f,int32 x)
1262 void write_int_named(int f, int32 x, const char *phase)
1264 io_write_phase = phase;
1266 io_write_phase = phase_unknown;
1270 * Note: int64 may actually be a 32-bit type if ./configure couldn't find any
1271 * 64-bit types on this platform.
1273 void write_longint(int f, int64 x)
1277 if (x <= 0x7FFFFFFF) {
1278 write_int(f, (int)x);
1282 #if SIZEOF_INT64 < 8
1283 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1284 exit_cleanup(RERR_UNSUPPORTED);
1286 write_int(f, (int32)0xFFFFFFFF);
1287 SIVAL(b,0,(x&0xFFFFFFFF));
1288 SIVAL(b,4,((x>>32)&0xFFFFFFFF));
1294 void write_buf(int f,char *buf,size_t len)
1299 /** Write a string to the connection */
1300 void write_sbuf(int f, char *buf)
1302 writefd(f, buf, strlen(buf));
1305 void write_byte(int f, uchar c)
1307 writefd(f, (char *)&c, 1);
1310 void write_vstring(int f, char *str, int len)
1312 uchar lenbuf[3], *lb = lenbuf;
1317 "attempting to send over-long vstring (%d > %d)\n",
1319 exit_cleanup(RERR_PROTOCOL);
1321 *lb++ = len / 0x100 + 0x80;
1325 writefd(f, (char*)lenbuf, lb - lenbuf + 1);
1327 writefd(f, str, len);
1331 * Read a line of up to @p maxlen characters into @p buf (not counting
1332 * the trailing null). Strips the (required) trailing newline and all
1335 * @return 1 for success; 0 for I/O error or truncation.
1337 int read_line(int f, char *buf, size_t maxlen)
1341 read_buf(f, buf, 1);
1346 if (buf[0] != '\r') {
1355 void io_printf(int fd, const char *format, ...)
1358 char buf[BIGPATHBUFLEN];
1361 va_start(ap, format);
1362 len = vsnprintf(buf, sizeof buf, format, ap);
1366 exit_cleanup(RERR_STREAMIO);
1368 if (len > (int)sizeof buf) {
1369 rprintf(FERROR, "io_printf() was too long for the buffer.\n");
1370 exit_cleanup(RERR_STREAMIO);
1373 write_sbuf(fd, buf);
1376 /** Setup for multiplexing a MSG_* stream with the data stream. */
1377 void io_start_multiplex_out(void)
1379 io_flush(NORMAL_FLUSH);
1380 io_start_buffering_out();
1381 io_multiplexing_out = 1;
1384 /** Setup for multiplexing a MSG_* stream with the data stream. */
1385 void io_start_multiplex_in(void)
1387 io_flush(NORMAL_FLUSH);
1388 io_start_buffering_in();
1389 io_multiplexing_in = 1;
1392 /** Write an message to the multiplexed data stream. */
1393 int io_multiplex_write(enum msgcode code, char *buf, size_t len)
1395 if (!io_multiplexing_out)
1398 io_flush(NORMAL_FLUSH);
1399 stats.total_written += (len+4);
1400 mplex_write(code, buf, len);
1404 void close_multiplexing_in(void)
1406 io_multiplexing_in = 0;
1409 /** Stop output multiplexing. */
1410 void close_multiplexing_out(void)
1412 io_multiplexing_out = 0;
1415 void start_write_batch(int fd)
1417 write_stream_flags(batch_fd);
1419 /* Some communication has already taken place, but we don't
1420 * enable batch writing until here so that we can write a
1421 * canonical record of the communication even though the
1422 * actual communication so far depends on whether a daemon
1424 write_int(batch_fd, protocol_version);
1425 write_int(batch_fd, checksum_seed);
1428 write_batch_monitor_out = fd;
1430 write_batch_monitor_in = fd;
1433 void stop_write_batch(void)
1435 write_batch_monitor_out = -1;
1436 write_batch_monitor_in = -1;