2 * Socket and pipe I/O utilities used in rsync.
4 * Copyright (C) 1996-2001 Andrew Tridgell
5 * Copyright (C) 1996 Paul Mackerras
6 * Copyright (C) 2001, 2002 Martin Pool <mbp@samba.org>
7 * Copyright (C) 2003-2009 Wayne Davison
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, visit the http://fsf.org website.
23 /* Rsync provides its own multiplexing system, which is used to send
24 * stderr and stdout over a single socket.
26 * For historical reasons this is off during the start of the
27 * connection, but it's switched on quite early using
28 * io_start_multiplex_out() and io_start_multiplex_in(). */
34 /** If no timeout is specified then use a 60 second select timeout */
35 #define SELECT_TIMEOUT 60
38 extern size_t bwlimit_writemax;
39 extern int io_timeout;
43 extern int am_generator;
44 extern int msgs2stderr;
45 extern int inc_recurse;
49 extern int file_total;
50 extern int file_old_total;
52 extern int read_batch;
53 extern int protect_args;
54 extern int checksum_seed;
55 extern int protocol_version;
56 extern int remove_source_files;
57 extern int preserve_hard_links;
58 extern BOOL extra_flist_sending_enabled;
59 extern struct stats stats;
60 extern struct file_list *cur_flist;
62 extern int filesfrom_convert;
63 extern iconv_t ic_send, ic_recv;
66 int csum_length = SHORT_SUM_LENGTH; /* initial value */
68 int ignore_timeout = 0;
71 int forward_flist_data = 0;
73 /* Ignore an EOF error if non-zero. See whine_about_eof(). */
74 int kluge_around_eof = 0;
82 int out_fd; /* Both "out" and "msg" go to this fd. */
84 unsigned out_empty_len;
85 size_t raw_data_header_pos; /* in the out xbuf */
86 size_t raw_flushing_ends_before; /* in the out xbuf */
87 size_t raw_input_ends_before; /* in the in xbuf */
88 } iobuf = { .in_fd = -1, .out_fd = -1 };
90 static time_t last_io_in;
91 static time_t last_io_out;
93 static int write_batch_monitor_in = -1;
94 static int write_batch_monitor_out = -1;
96 static int ff_forward_fd = -1;
97 static int ff_reenable_multiplex = -1;
98 static char ff_lastchar = '\0';
99 static xbuf ff_xb = EMPTY_XBUF;
101 static xbuf iconv_buf = EMPTY_XBUF;
103 static int select_timeout = SELECT_TIMEOUT;
104 static int active_filecnt = 0;
105 static OFF_T active_bytecnt = 0;
106 static int first_message = 1;
108 static char int_byte_extra[64] = {
109 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* (00 - 3F)/4 */
110 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* (40 - 7F)/4 */
111 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /* (80 - BF)/4 */
112 2, 2, 2, 2, 2, 2, 2, 2, 3, 3, 3, 3, 4, 4, 5, 6, /* (C0 - FF)/4 */
115 #define IN_MULTIPLEXED (iobuf.in_multiplexed)
116 #define OUT_MULTIPLEXED (iobuf.out_empty_len != 0)
118 #define PIO_NEED_INPUT (1<<0) /* The *_NEED_* flags are mutually exclusive. */
119 #define PIO_NEED_OUTROOM (1<<1)
120 #define PIO_NEED_MSGROOM (1<<2)
122 #define PIO_CONSUME_INPUT (1<<4) /* Must becombined with PIO_NEED_INPUT. */
124 #define PIO_INPUT_AND_CONSUME (PIO_NEED_INPUT | PIO_CONSUME_INPUT)
125 #define PIO_NEED_FLAGS (PIO_NEED_INPUT | PIO_NEED_OUTROOM | PIO_NEED_MSGROOM)
127 #define REMOTE_OPTION_ERROR "rsync: on remote machine: -"
128 #define REMOTE_OPTION_ERROR2 ": unknown option"
130 #define FILESFROM_BUFLEN 2048
132 enum festatus { FES_SUCCESS, FES_REDO, FES_NO_SEND };
134 static flist_ndx_list redo_list, hlink_list;
136 static void sleep_for_bwlimit(int bytes_written);
138 static void check_timeout(void)
142 if (!io_timeout || ignore_timeout)
146 last_io_in = time(NULL);
152 if (t - last_io_in >= io_timeout) {
153 if (!am_server && !am_daemon) {
154 rprintf(FERROR, "io timeout after %d seconds -- exiting\n",
155 (int)(t-last_io_in));
157 exit_cleanup(RERR_TIMEOUT);
161 /* It's almost always an error to get an EOF when we're trying to read from the
162 * network, because the protocol is (for the most part) self-terminating.
164 * There is one case for the receiver when it is at the end of the transfer
165 * (hanging around reading any keep-alive packets that might come its way): if
166 * the sender dies before the generator's kill-signal comes through, we can end
167 * up here needing to loop until the kill-signal arrives. In this situation,
168 * kluge_around_eof will be < 0.
170 * There is another case for older protocol versions (< 24) where the module
171 * listing was not terminated, so we must ignore an EOF error in that case and
172 * exit. In this situation, kluge_around_eof will be > 0. */
173 static NORETURN void whine_about_eof(int fd)
175 if (kluge_around_eof && fd == sock_f_in) {
177 if (kluge_around_eof > 0)
179 /* If we're still here after 10 seconds, exit with an error. */
180 for (i = 10*1000/20; i--; )
184 rprintf(FERROR, RSYNC_NAME ": connection unexpectedly closed "
185 "(%s bytes received so far) [%s]\n",
186 big_num(stats.total_read), who_am_i());
188 exit_cleanup(RERR_STREAMIO);
191 /* Do a safe read, handling any needed looping and error handling.
192 * Returns the count of the bytes read, which will only be different
193 * from "len" if we encountered an EOF. This routine is not used on
194 * the socket except very early in the transfer. */
195 static size_t safe_read(int fd, char *buf, size_t len)
200 assert(fd != iobuf.in_fd);
202 n = read(fd, buf, len);
203 if ((size_t)n == len || n == 0) {
204 if (DEBUG_GTE(IO, 2))
205 rprintf(FINFO, "[%s] safe_read(%d)=%ld\n", who_am_i(), fd, (long)n);
209 if (errno != EINTR && errno != EWOULDBLOCK && errno != EAGAIN) {
211 rsyserr(FERROR, errno, "safe_read failed to read %ld bytes [%s]",
212 (long)len, who_am_i());
213 exit_cleanup(RERR_STREAMIO);
228 tv.tv_sec = select_timeout;
231 cnt = select(fd+1, &r_fds, NULL, &e_fds, &tv);
233 if (cnt < 0 && errno == EBADF) {
234 rsyserr(FERROR, errno, "safe_read select failed [%s]",
236 exit_cleanup(RERR_FILEIO);
242 /*if (FD_ISSET(fd, &e_fds))
243 rprintf(FINFO, "select exception on fd %d\n", fd); */
245 if (FD_ISSET(fd, &r_fds)) {
246 n = read(fd, buf + got, len - got);
247 if (DEBUG_GTE(IO, 2))
248 rprintf(FINFO, "[%s] safe_read(%d)=%ld\n", who_am_i(), fd, (long)n);
256 if ((got += (size_t)n) == len)
264 static const char *what_fd_is(int fd)
268 if (fd == sock_f_out)
270 else if (fd == iobuf.out_fd)
272 else if (fd == batch_fd)
275 snprintf(buf, sizeof buf, "fd %d", fd);
280 /* Do a safe write, handling any needed looping and error handling.
281 * Returns only if everything was successfully written. This routine
282 * is not used on the socket except very early in the transfer. */
283 static void safe_write(int fd, const char *buf, size_t len)
287 assert(fd != iobuf.out_fd);
289 n = write(fd, buf, len);
290 if ((size_t)n == len)
293 if (errno != EINTR && errno != EWOULDBLOCK && errno != EAGAIN) {
295 rsyserr(FERROR, errno,
296 "safe_write failed to write %ld bytes to %s [%s]",
297 (long)len, what_fd_is(fd), who_am_i());
298 exit_cleanup(RERR_STREAMIO);
312 tv.tv_sec = select_timeout;
315 cnt = select(fd + 1, NULL, &w_fds, NULL, &tv);
317 if (cnt < 0 && errno == EBADF) {
318 rsyserr(FERROR, errno, "safe_write select failed on %s [%s]",
319 what_fd_is(fd), who_am_i());
320 exit_cleanup(RERR_FILEIO);
326 if (FD_ISSET(fd, &w_fds)) {
327 n = write(fd, buf, len);
339 /* This is only called when files-from data is known to be available. We read
340 * a chunk of data and put it into the output buffer. */
341 static void forward_filesfrom_data(void)
345 len = read(ff_forward_fd, ff_xb.buf + ff_xb.len, ff_xb.size - ff_xb.len);
347 if (len == 0 || errno != EINTR) {
348 /* Send end-of-file marker */
350 write_buf(iobuf.out_fd, "\0\0", ff_lastchar ? 2 : 1);
352 if (ff_reenable_multiplex >= 0)
353 io_start_multiplex_out(ff_reenable_multiplex);
358 if (DEBUG_GTE(IO, 2))
359 rprintf(FINFO, "[%s] files-from read=%ld\n", who_am_i(), (long)len);
366 char *s = ff_xb.buf + len;
367 /* Transform CR and/or LF into '\0' */
368 while (s-- > ff_xb.buf) {
369 if (*s == '\n' || *s == '\r')
378 /* Last buf ended with a '\0', so don't let this buf start with one. */
379 while (len && *s == '\0')
381 ff_xb.pos = s - ff_xb.buf;
385 if (filesfrom_convert && len) {
386 char *sob = ff_xb.buf + ff_xb.pos, *s = sob;
387 char *eob = sob + len;
388 int flags = ICB_INCLUDE_BAD | ICB_INCLUDE_INCOMPLETE | ICB_CIRCULAR_OUT;
389 if (ff_lastchar == '\0')
391 /* Convert/send each null-terminated string separately, skipping empties. */
394 ff_xb.len = s - sob - 1;
395 if (iconvbufs(ic_send, &ff_xb, &iobuf.out, flags) < 0)
396 exit_cleanup(RERR_PROTOCOL); /* impossible? */
397 write_buf(iobuf.out_fd, s-1, 1); /* Send the '\0'. */
398 while (s != eob && *s == '\0')
401 ff_xb.pos = sob - ff_xb.buf;
406 if ((ff_xb.len = s - sob) == 0)
409 /* Handle a partial string specially, saving any incomplete chars. */
410 flags &= ~ICB_INCLUDE_INCOMPLETE;
411 if (iconvbufs(ic_send, &ff_xb, &iobuf.out, flags) < 0) {
413 exit_cleanup(RERR_PROTOCOL); /* impossible? */
415 memmove(ff_xb.buf, ff_xb.buf + ff_xb.pos, ff_xb.len);
417 ff_lastchar = 'x'; /* Anything non-zero. */
423 char *f = ff_xb.buf + ff_xb.pos;
426 /* Eliminate any multi-'\0' runs. */
428 if (!(*t++ = *f++)) {
429 while (f != eob && *f == '\0')
434 if ((len = t - ff_xb.buf) != 0) {
435 /* This will not circle back to perform_io() because we only get
436 * called when there is plenty of room in the output buffer. */
437 write_buf(iobuf.out_fd, ff_xb.buf, len);
442 /* Perform buffered input and output until specified conditions are met. When
443 * given a "needed" read requirement, we'll return without doing any I/O if the
444 * iobuf.in bytes are already available. When reading, we'll read as many
445 * bytes as we can into the buffer, and return as soon as we meet the minimum
446 * read requirement. When given a "needed" write requirement, we'll return
447 * without doing any I/O if that many bytes will fit in the output buffer (we
448 * check either iobuf.out or iobuf.msg, depending on the flags). When writing,
449 * we write out as much as we can, and return as soon as the given free-space
450 * requirement is available.
452 * The iobuf.out and iobuf.msg buffers are circular, so some writes into them
453 * will need to be split when the data needs to wrap around to the start. In
454 * order to help make this easier for some operations (such as the use of
455 * SIVAL() into the buffer) the buffers MUST have 4 bytes of overflow space at
456 * the end that is not not counted in the "size". The iobuf.in buffer is not
457 * (currently) circular. To facilitate the handling of MSG_DATA bytes as they
458 * are read-from/written-into the buffers, see the three raw_* iobuf vars.
460 * When writing, we flush data in the following priority order:
462 * 1. Finish writing any in-progress MSG_DATA sequence from iobuf.out.
464 * 2. Write out all the messages from the message buf (if iobuf.msg is active).
465 * Yes, this means that a PIO_NEED_OUTROOM call will completely flush any
466 * messages before getting to the iobuf.out flushing (except for rule 1).
468 * 3. Write out the raw data from iobuf.out, possibly filling in the multiplexed
469 * MSG_DATA header that was pre-allocated (when output is multiplexed).
471 * TODO: items for possible future work:
473 * - Make this routine able to read the generator-to-receiver batch flow?
475 * - Make the input buffer circular?
477 * Unlike the old routines that this replaces, it is OK to read ahead as far as
478 * we can because the read_a_msg() routine now reads its bytes out of the input
479 * buffer. In the old days, only raw data was in the input buffer, and any
480 * unused raw data in the buf would prevent the reading of socket data. */
481 static char *perform_io(size_t needed, int flags)
483 fd_set r_fds, e_fds, w_fds;
486 size_t empty_buf_len = 0;
490 if (iobuf.in.len == 0 && iobuf.in.pos != 0) {
491 if (iobuf.raw_input_ends_before)
492 iobuf.raw_input_ends_before -= iobuf.in.pos;
496 switch (flags & PIO_NEED_FLAGS) {
498 if (DEBUG_GTE(IO, 3)) {
499 rprintf(FINFO, "[%s] perform_io(%ld, %sinput)\n",
500 who_am_i(), (long)needed, flags & PIO_CONSUME_INPUT ? "consume&" : "");
503 /* Make sure the input buffer is big enough to hold "needed" bytes.
504 * Also make sure it will fit in the free space at the end, or
505 * else we need to shift some bytes. */
506 if (needed && iobuf.in.size < needed) {
507 if (!(iobuf.in.buf = realloc_array(iobuf.in.buf, char, needed)))
508 out_of_memory("perform_io");
509 if (DEBUG_GTE(IO, 4)) {
510 rprintf(FINFO, "[%s] resized input buffer from %ld to %ld bytes.\n",
511 who_am_i(), (long)iobuf.in.size, (long)needed);
513 iobuf.in.size = needed;
515 if (iobuf.in.size - iobuf.in.pos < needed
516 || (iobuf.in.len < needed && iobuf.in.len < 1024
517 && iobuf.in.size - (iobuf.in.pos + iobuf.in.len) < 1024)) {
518 memmove(iobuf.in.buf, iobuf.in.buf + iobuf.in.pos, iobuf.in.len);
519 if (DEBUG_GTE(IO, 4)) {
521 "[%s] moved %ld bytes from %ld to 0 in the input buffer (size=%ld, needed=%ld).\n",
522 who_am_i(), (long)iobuf.in.len, (long)iobuf.in.pos, (long)iobuf.in.size, (long)needed);
524 if (iobuf.raw_input_ends_before)
525 iobuf.raw_input_ends_before -= iobuf.in.pos;
530 case PIO_NEED_OUTROOM:
531 /* We never resize the circular output buffer. */
532 if (iobuf.out.size - iobuf.out_empty_len < needed) {
533 fprintf(stderr, "need to write %ld bytes, iobuf.out.buf is only %ld bytes.\n",
534 (long)needed, (long)(iobuf.out.size - iobuf.out_empty_len));
535 exit_cleanup(RERR_PROTOCOL);
538 if (DEBUG_GTE(IO, 3)) {
539 rprintf(FINFO, "[%s] perform_io(%ld, outroom) needs to flush %ld\n",
540 who_am_i(), (long)needed,
541 iobuf.out.len > iobuf.out.size - needed
542 ? (long)iobuf.out.len - (iobuf.out.size - needed) : 0L);
546 case PIO_NEED_MSGROOM:
547 /* We never resize the circular message buffer. */
548 if (iobuf.msg.size < needed) {
549 fprintf(stderr, "need to write %ld bytes, iobuf.msg.buf is only %ld bytes.\n",
550 (long)needed, (long)iobuf.msg.size);
551 exit_cleanup(RERR_PROTOCOL);
554 if (DEBUG_GTE(IO, 3)) {
555 rprintf(FINFO, "[%s] perform_io(%ld, msgroom) needs to flush %ld\n",
556 who_am_i(), (long)needed,
557 iobuf.out.len > iobuf.msg.size - needed
558 ? (long)iobuf.out.len - (iobuf.msg.size - needed) : 0L);
563 if (DEBUG_GTE(IO, 3))
564 rprintf(FINFO, "[%s] perform_io(%ld, %d)\n", who_am_i(), (long)needed, flags);
568 exit_cleanup(RERR_UNSUPPORTED);
572 switch (flags & PIO_NEED_FLAGS) {
574 if (iobuf.in.len >= needed)
577 case PIO_NEED_OUTROOM:
578 if (iobuf.out.len <= iobuf.out.size - needed)
581 case PIO_NEED_MSGROOM:
582 if (iobuf.msg.len <= iobuf.msg.size - needed)
591 if (iobuf.in_fd >= 0 && iobuf.in.size - (iobuf.in.pos + iobuf.in.len)) {
592 if (!read_batch || batch_fd >= 0) {
593 FD_SET(iobuf.in_fd, &r_fds);
594 FD_SET(iobuf.in_fd, &e_fds);
596 if (iobuf.in_fd > max_fd)
597 max_fd = iobuf.in_fd;
600 /* Only do more filesfrom processing if there is enough room in the out buffer. */
601 if (ff_forward_fd >= 0 && iobuf.out.size - iobuf.out.len > FILESFROM_BUFLEN*2) {
602 FD_SET(ff_forward_fd, &r_fds);
603 if (ff_forward_fd > max_fd)
604 max_fd = ff_forward_fd;
608 if (iobuf.out_fd >= 0) {
609 if (iobuf.raw_flushing_ends_before
610 || (!iobuf.msg.len && iobuf.out.len > iobuf.out_empty_len && !(flags & PIO_NEED_MSGROOM))) {
611 if (OUT_MULTIPLEXED && !iobuf.raw_flushing_ends_before) {
614 /* The iobuf.raw_flushing_ends_before value can point off the end
615 * of the iobuf.out buffer for a while, for easier subtracting. */
616 iobuf.raw_flushing_ends_before = iobuf.out.pos + iobuf.out.len;
618 SIVAL(iobuf.out.buf + iobuf.raw_data_header_pos, 0,
619 ((MPLEX_BASE + (int)MSG_DATA)<<24) + iobuf.out.len - 4);
620 if ((val = iobuf.out.size - iobuf.raw_data_header_pos) < 4) {
621 /* We used some of the overflow bytes, so move them. */
622 if (DEBUG_GTE(IO, 4)) {
623 rprintf(FINFO, "[%s] wrap-bytes moved: %d (perform_io)\n",
624 who_am_i(), (int)val);
626 memcpy(iobuf.out.buf, iobuf.out.buf + iobuf.out.size, 4 - val);
629 if (DEBUG_GTE(IO, 1)) {
630 rprintf(FINFO, "[%s] send_msg(%d, %ld)\n",
631 who_am_i(), (int)MSG_DATA, (long)iobuf.out.len - 4);
634 /* reserve room for the next MSG_DATA header */
635 iobuf.raw_data_header_pos = iobuf.raw_flushing_ends_before;
636 if (iobuf.raw_data_header_pos >= iobuf.out.size)
637 iobuf.raw_data_header_pos -= iobuf.out.size;
641 empty_buf_len = iobuf.out_empty_len;
643 } else if (iobuf.msg.len) {
649 FD_SET(iobuf.out_fd, &w_fds);
650 if (iobuf.out_fd > max_fd)
651 max_fd = iobuf.out_fd;
657 switch (flags & PIO_NEED_FLAGS) {
659 rprintf(FERROR, "error in perform_io: no fd for input.\n");
660 exit_cleanup(RERR_PROTOCOL);
661 case PIO_NEED_OUTROOM:
662 case PIO_NEED_MSGROOM:
664 rprintf(FERROR, "error in perform_io: no fd for output.\n");
665 exit_cleanup(RERR_PROTOCOL);
667 /* No stated needs, so I guess this is OK. */
673 if (extra_flist_sending_enabled) {
674 if (file_total - file_old_total < MAX_FILECNT_LOOKAHEAD
675 && file_total - file_old_total >= MIN_FILECNT_LOOKAHEAD)
678 extra_flist_sending_enabled = False;
679 tv.tv_sec = select_timeout;
682 tv.tv_sec = select_timeout;
685 cnt = select(max_fd + 1, &r_fds, &w_fds, &e_fds, &tv);
688 if (cnt < 0 && errno == EBADF) {
690 exit_cleanup(RERR_SOCKETIO);
692 if (extra_flist_sending_enabled) {
693 extra_flist_sending_enabled = False;
694 send_extra_file_list(sock_f_out, -1);
695 extra_flist_sending_enabled = !flist_eof;
698 FD_ZERO(&r_fds); /* Just in case... */
702 if (iobuf.in_fd >= 0 && FD_ISSET(iobuf.in_fd, &r_fds)) {
703 size_t pos = iobuf.in.pos + iobuf.in.len;
704 size_t len = iobuf.in.size - pos;
706 if ((n = read(iobuf.in_fd, iobuf.in.buf + pos, len)) <= 0) {
708 if (!read_batch || batch_fd < 0 || am_generator)
709 whine_about_eof(iobuf.in_fd); /* Doesn't return. */
713 if (errno == EINTR || errno == EWOULDBLOCK || errno == EAGAIN)
716 /* Don't write errors on a dead socket. */
717 if (iobuf.in_fd == sock_f_in) {
720 rsyserr(FERROR_SOCKET, errno, "read error");
722 rsyserr(FERROR, errno, "read error");
723 exit_cleanup(RERR_STREAMIO);
726 if (msgs2stderr && DEBUG_GTE(IO, 2))
727 rprintf(FINFO, "[%s] recv=%ld\n", who_am_i(), (long)n);
730 last_io_in = time(NULL);
731 stats.total_read += n;
736 if (iobuf.out_fd >= 0 && FD_ISSET(iobuf.out_fd, &w_fds)) {
737 size_t len = iobuf.raw_flushing_ends_before ? iobuf.raw_flushing_ends_before - out->pos : out->len;
740 if (bwlimit_writemax && len > bwlimit_writemax)
741 len = bwlimit_writemax;
743 if (out->pos + len > out->size)
744 len = out->size - out->pos;
745 if ((n = write(iobuf.out_fd, out->buf + out->pos, len)) <= 0) {
746 if (errno == EINTR || errno == EWOULDBLOCK || errno == EAGAIN)
749 /* Don't write errors on a dead socket. */
751 out->len = iobuf.raw_flushing_ends_before = out->pos = 0;
752 rsyserr(FERROR_SOCKET, errno, "write error");
753 exit_cleanup(RERR_STREAMIO);
756 if (msgs2stderr && DEBUG_GTE(IO, 2)) {
757 rprintf(FINFO, "[%s] %s sent=%ld\n",
758 who_am_i(), out == &iobuf.out ? "out" : "msg", (long)n);
762 last_io_out = time(NULL);
763 stats.total_written += n;
765 if (bwlimit_writemax)
766 sleep_for_bwlimit(n);
768 if ((out->pos += n) == out->size) {
769 if (iobuf.raw_flushing_ends_before)
770 iobuf.raw_flushing_ends_before -= out->size;
773 if (out->pos == iobuf.raw_flushing_ends_before)
774 iobuf.raw_flushing_ends_before = 0;
775 if ((out->len -= n) == empty_buf_len) {
778 iobuf.raw_data_header_pos = 0;
782 if (ff_forward_fd >= 0 && FD_ISSET(ff_forward_fd, &r_fds)) {
783 /* This can potentially flush all output and enable
784 * multiplexed output, so keep this last in the loop
785 * and be sure to not cache anything that would break
787 forward_filesfrom_data();
792 data = iobuf.in.buf + iobuf.in.pos;
794 if (flags & PIO_CONSUME_INPUT) {
795 iobuf.in.len -= needed;
796 iobuf.in.pos += needed;
802 /* Buffer a message for the multiplexed output stream. Is never used for MSG_DATA. */
803 int send_msg(enum msgcode code, const char *buf, size_t len, int convert)
807 BOOL want_debug = DEBUG_GTE(IO, 1) && convert >= 0 && (msgs2stderr || code != MSG_INFO);
809 if (!OUT_MULTIPLEXED)
813 rprintf(FINFO, "[%s] send_msg(%d, %ld)\n", who_am_i(), (int)code, (long)len);
816 if (convert > 0 && ic_send == (iconv_t)-1)
819 /* Ensuring double-size room leaves space for a potential conversion. */
820 if (iobuf.msg.len + len*2 + 4 > iobuf.msg.size)
821 perform_io(len*2 + 4, PIO_NEED_MSGROOM);
824 if (iobuf.msg.len + len + 4 > iobuf.msg.size)
825 perform_io(len + 4, PIO_NEED_MSGROOM);
827 pos = iobuf.msg.pos + iobuf.msg.len; /* Must be set after any flushing. */
828 if (pos >= iobuf.msg.size)
829 pos -= iobuf.msg.size;
830 hdr = iobuf.msg.buf + pos;
832 iobuf.msg.len += 4; /* Leave room for the coming header bytes. */
838 INIT_XBUF(inbuf, (char*)buf, len, (size_t)-1);
841 iconvbufs(ic_send, &inbuf, &iobuf.msg,
842 ICB_INCLUDE_BAD | ICB_INCLUDE_INCOMPLETE | ICB_CIRCULAR_OUT | ICB_INIT);
844 rprintf(FERROR, "overflowed iobuf.msg buffer in send_msg");
845 exit_cleanup(RERR_UNSUPPORTED);
847 len = iobuf.msg.len - len;
853 if ((pos += 4) >= iobuf.msg.size)
854 pos -= iobuf.msg.size;
856 /* Handle a split copy if we wrap around the end of the circular buffer. */
857 if (pos >= iobuf.msg.pos && (siz = iobuf.msg.size - pos) < len) {
858 memcpy(iobuf.msg.buf + pos, buf, siz);
859 memcpy(iobuf.msg.buf, buf + siz, len - siz);
861 memcpy(iobuf.msg.buf + pos, buf, len);
863 iobuf.msg.len += len;
866 SIVAL(hdr, 0, ((MPLEX_BASE + (int)code)<<24) + len);
867 /* If the header used any overflow bytes, move them to the start. */
868 if ((pos = hdr+4 - iobuf.msg.buf) > iobuf.msg.size) {
869 size_t siz = pos - iobuf.msg.size;
870 if (DEBUG_GTE(IO, 4))
871 rprintf(FINFO, "[%s] wrap-bytes moved: %d (send_msg)\n", who_am_i(), (int)siz);
872 memcpy(iobuf.msg.buf, hdr+4 - siz, siz);
875 if (want_debug && convert > 0)
876 rprintf(FINFO, "[%s] converted msg len=%ld\n", who_am_i(), (long)len);
881 void send_msg_int(enum msgcode code, int num)
885 if (DEBUG_GTE(IO, 1))
886 rprintf(FINFO, "[%s] send_msg_int(%d, %d)\n", who_am_i(), (int)code, num);
888 SIVAL(numbuf, 0, num);
889 send_msg(code, numbuf, 4, -1);
892 static void got_flist_entry_status(enum festatus status, int ndx)
894 struct file_list *flist = flist_for_ndx(ndx, "got_flist_entry_status");
896 if (remove_source_files) {
898 active_bytecnt -= F_LENGTH(flist->files[ndx - flist->ndx_start]);
902 flist->in_progress--;
906 if (remove_source_files)
907 send_msg_int(MSG_SUCCESS, ndx);
908 if (preserve_hard_links) {
909 struct file_struct *file = flist->files[ndx - flist->ndx_start];
910 if (F_IS_HLINKED(file)) {
911 flist_ndx_push(&hlink_list, ndx);
912 flist->in_progress++;
919 flist->in_progress++;
924 flist_ndx_push(&redo_list, ndx);
931 /* Note the fds used for the main socket (which might really be a pipe
932 * for a local transfer, but we can ignore that). */
933 void io_set_sock_fds(int f_in, int f_out)
939 void set_io_timeout(int secs)
943 if (!io_timeout || io_timeout > SELECT_TIMEOUT)
944 select_timeout = SELECT_TIMEOUT;
946 select_timeout = io_timeout;
948 allowed_lull = read_batch ? 0 : (io_timeout + 1) / 2;
951 static void check_for_d_option_error(const char *msg)
953 static char rsync263_opts[] = "BCDHIKLPRSTWabceghlnopqrtuvxz";
958 || strncmp(msg, REMOTE_OPTION_ERROR, sizeof REMOTE_OPTION_ERROR - 1) != 0)
961 msg += sizeof REMOTE_OPTION_ERROR - 1;
962 if (*msg == '-' || (colon = strchr(msg, ':')) == NULL
963 || strncmp(colon, REMOTE_OPTION_ERROR2, sizeof REMOTE_OPTION_ERROR2 - 1) != 0)
966 for ( ; *msg != ':'; msg++) {
969 else if (*msg == 'e')
971 else if (strchr(rsync263_opts, *msg) == NULL)
977 "*** Try using \"--old-d\" if remote rsync is <= 2.6.3 ***\n");
981 /* This is used by the generator to limit how many file transfers can
982 * be active at once when --remove-source-files is specified. Without
983 * this, sender-side deletions were mostly happening at the end. */
984 void increment_active_files(int ndx, int itemizing, enum logcode code)
987 /* TODO: tune these limits? */
988 int limit = active_bytecnt >= 128*1024 ? 10 : 50;
989 if (active_filecnt < limit)
991 check_for_finished_files(itemizing, code, 0);
992 if (active_filecnt < limit)
998 active_bytecnt += F_LENGTH(cur_flist->files[ndx - cur_flist->ndx_start]);
1001 int get_redo_num(void)
1003 return flist_ndx_pop(&redo_list);
1006 int get_hlink_num(void)
1008 return flist_ndx_pop(&hlink_list);
1011 /* When we're the receiver and we have a local --files-from list of names
1012 * that needs to be sent over the socket to the sender, we have to do two
1013 * things at the same time: send the sender a list of what files we're
1014 * processing and read the incoming file+info list from the sender. We do
1015 * this by making recv_file_list() call forward_filesfrom_data(), which
1016 * will ensure that we forward data to the sender until we get some data
1017 * for recv_file_list() to use. */
1018 void start_filesfrom_forwarding(int fd)
1020 if (protocol_version < 31 && OUT_MULTIPLEXED) {
1021 /* Older protocols send the files-from data w/o packaging
1022 * it in multiplexed I/O packets, so temporarily switch
1023 * to buffered I/O to match this behavior. */
1024 iobuf.msg.pos = iobuf.msg.len = 0; /* Be extra sure no messages go out. */
1025 ff_reenable_multiplex = io_end_multiplex_out(MPLX_TO_BUFFERED);
1029 alloc_xbuf(&ff_xb, FILESFROM_BUFLEN);
1032 /* Read a line into the "buf" buffer. */
1033 int read_line(int fd, char *buf, size_t bufsiz, int flags)
1038 if (flags & RL_CONVERT && iconv_buf.size < bufsiz)
1039 realloc_xbuf(&iconv_buf, bufsiz + 1024);
1044 s = flags & RL_CONVERT ? iconv_buf.buf : buf;
1048 eob = s + bufsiz - 1;
1050 /* We avoid read_byte() for files because files can return an EOF. */
1051 if (fd == iobuf.in_fd)
1053 else if (safe_read(fd, &ch, 1) == 0)
1055 if (flags & RL_EOL_NULLS ? ch == '\0' : (ch == '\r' || ch == '\n')) {
1056 /* Skip empty lines if dumping comments. */
1057 if (flags & RL_DUMP_COMMENTS && s == buf)
1066 if (flags & RL_DUMP_COMMENTS && (*buf == '#' || *buf == ';'))
1070 if (flags & RL_CONVERT) {
1072 INIT_XBUF(outbuf, buf, 0, bufsiz);
1074 iconv_buf.len = s - iconv_buf.buf;
1075 iconvbufs(ic_recv, &iconv_buf, &outbuf,
1076 ICB_INCLUDE_BAD | ICB_INCLUDE_INCOMPLETE | ICB_INIT);
1077 outbuf.buf[outbuf.len] = '\0';
1085 void read_args(int f_in, char *mod_name, char *buf, size_t bufsiz, int rl_nulls,
1086 char ***argv_p, int *argc_p, char **request_p)
1088 int maxargs = MAX_ARGS;
1092 int rl_flags = (rl_nulls ? RL_EOL_NULLS : 0);
1095 rl_flags |= (protect_args && ic_recv != (iconv_t)-1 ? RL_CONVERT : 0);
1098 if (!(argv = new_array(char *, maxargs)))
1099 out_of_memory("read_args");
1100 if (mod_name && !protect_args)
1101 argv[argc++] = "rsyncd";
1104 if (read_line(f_in, buf, bufsiz, rl_flags) == 0)
1107 if (argc == maxargs-1) {
1108 maxargs += MAX_ARGS;
1109 if (!(argv = realloc_array(argv, char *, maxargs)))
1110 out_of_memory("read_args");
1115 *request_p = strdup(buf);
1119 glob_expand_module(mod_name, buf, &argv, &argc, &maxargs);
1121 glob_expand(buf, &argv, &argc, &maxargs);
1123 if (!(p = strdup(buf)))
1124 out_of_memory("read_args");
1126 if (*p == '.' && p[1] == '\0')
1132 glob_expand(NULL, NULL, NULL, NULL);
1138 BOOL io_start_buffering_out(int f_out)
1140 if (msgs2stderr && DEBUG_GTE(IO, 2))
1141 rprintf(FINFO, "[%s] io_start_buffering_out(%d)\n", who_am_i(), f_out);
1143 if (OUT_MULTIPLEXED && !iobuf.msg.buf) {
1144 iobuf.msg.size = IO_BUFFER_SIZE - 4;
1145 if (!(iobuf.msg.buf = new_array(char, iobuf.msg.size + 4)))
1146 out_of_memory("io_start_buffering_out");
1147 iobuf.msg.pos = iobuf.msg.len = 0;
1150 if (iobuf.out.buf) {
1151 if (iobuf.out_fd == -1)
1152 iobuf.out_fd = f_out;
1153 assert(f_out == iobuf.out_fd);
1157 iobuf.out.size = IO_BUFFER_SIZE * 2 - 4;
1158 /* The 4 overflow bytes makes some circular-buffer wrapping operations easier. */
1159 if (!(iobuf.out.buf = new_array(char, iobuf.out.size + 4)))
1160 out_of_memory("io_start_buffering_out");
1161 iobuf.out.pos = iobuf.out.len = 0;
1162 iobuf.out_fd = f_out;
1167 BOOL io_start_buffering_in(int f_in)
1169 if (msgs2stderr && DEBUG_GTE(IO, 2))
1170 rprintf(FINFO, "[%s] io_start_buffering_in(%d)\n", who_am_i(), f_in);
1173 if (iobuf.in_fd == -1)
1175 assert(f_in == iobuf.in_fd);
1179 iobuf.in.size = IO_BUFFER_SIZE;
1180 if (!(iobuf.in.buf = new_array(char, iobuf.in.size)))
1181 out_of_memory("io_start_buffering_in");
1183 iobuf.in.pos = iobuf.in.len = 0;
1190 void io_end_buffering_in(BOOL free_buffers)
1192 if (msgs2stderr && DEBUG_GTE(IO, 2)) {
1193 rprintf(FINFO, "[%s] io_end_buffering_in(IOBUF_%s_BUFS)\n",
1194 who_am_i(), free_buffers ? "FREE" : "KEEP");
1198 free_xbuf(&iobuf.in);
1200 iobuf.in.pos = iobuf.in.len = 0;
1205 void io_end_buffering_out(BOOL free_buffers)
1207 if (msgs2stderr && DEBUG_GTE(IO, 2)) {
1208 rprintf(FINFO, "[%s] io_end_buffering_out(IOBUF_%s_BUFS)\n",
1209 who_am_i(), free_buffers ? "FREE" : "KEEP");
1212 io_flush(FULL_FLUSH);
1215 free_xbuf(&iobuf.out);
1216 free_xbuf(&iobuf.msg);
1222 void maybe_flush_socket(int important)
1224 if (flist_eof && iobuf.out.buf && iobuf.out.len > iobuf.out_empty_len
1225 && (important || time(NULL) - last_io_out >= 5))
1226 io_flush(NORMAL_FLUSH);
1229 void maybe_send_keepalive(void)
1231 if (time(NULL) - last_io_out >= allowed_lull) {
1232 if (!iobuf.msg.len && iobuf.out.len == iobuf.out_empty_len) {
1233 if (protocol_version < 29)
1234 return; /* there's nothing we can do */
1235 if (protocol_version >= 30)
1236 send_msg(MSG_NOOP, "", 0, 0);
1238 write_int(iobuf.out_fd, cur_flist->used);
1239 write_shortint(iobuf.out_fd, ITEM_IS_NEW);
1243 perform_io(iobuf.msg.size - iobuf.msg.len + 1, PIO_NEED_MSGROOM);
1244 else if (iobuf.out.len > iobuf.out_empty_len)
1245 io_flush(NORMAL_FLUSH);
1249 void start_flist_forward(int ndx)
1251 write_int(iobuf.out_fd, ndx);
1252 forward_flist_data = 1;
1255 void stop_flist_forward(void)
1257 forward_flist_data = 0;
1260 /* Read a message from a multiplexed source. */
1261 static void read_a_msg(void)
1263 char *data, line[BIGPATHBUFLEN];
1267 data = perform_io(4, PIO_INPUT_AND_CONSUME);
1268 tag = IVAL(data, 0);
1270 msg_bytes = tag & 0xFFFFFF;
1271 tag = (tag >> 24) - MPLEX_BASE;
1273 if (DEBUG_GTE(IO, 1) && (msgs2stderr || tag != MSG_INFO))
1274 rprintf(FINFO, "[%s] got msg=%d, len=%ld\n", who_am_i(), (int)tag, (long)msg_bytes);
1278 assert(iobuf.raw_input_ends_before == 0);
1279 /* Though this does not yet read the data, we do mark where in
1280 * the buffer the msg data will end once it is read. It is
1281 * possible that this points off the end of the buffer, in
1282 * which case the gradual reading of the input stream will
1283 * cause this value to decrease and eventually become real. */
1284 iobuf.raw_input_ends_before = iobuf.in.pos + msg_bytes;
1287 if (msg_bytes != sizeof stats.total_read || !am_generator)
1289 data = perform_io(sizeof stats.total_read, PIO_INPUT_AND_CONSUME);
1290 memcpy((char*)&stats.total_read, data, sizeof stats.total_read);
1293 if (msg_bytes != 4 || !am_generator)
1295 data = perform_io(4, PIO_INPUT_AND_CONSUME);
1296 got_flist_entry_status(FES_REDO, IVAL(data, 0));
1299 if (msg_bytes != 4 || am_sender)
1301 data = perform_io(4, PIO_INPUT_AND_CONSUME);
1302 io_error |= IVAL(data, 0);
1304 send_msg(MSG_IO_ERROR, data, 4, 0);
1308 maybe_send_keepalive();
1311 if (msg_bytes >= sizeof line)
1314 memcpy(line, perform_io(msg_bytes, PIO_INPUT_AND_CONSUME), msg_bytes);
1315 send_msg(MSG_DELETED, line, msg_bytes, 1);
1319 if (ic_recv != (iconv_t)-1) {
1323 int flags = ICB_INCLUDE_BAD | ICB_INIT;
1325 INIT_CONST_XBUF(outbuf, line);
1326 INIT_XBUF(inbuf, ibuf, 0, (size_t)-1);
1329 size_t len = msg_bytes > sizeof ibuf - inbuf.len ? sizeof ibuf - inbuf.len : msg_bytes;
1330 memcpy(ibuf + inbuf.len, perform_io(len, PIO_INPUT_AND_CONSUME), len);
1333 if (!(msg_bytes -= len) && !ibuf[inbuf.len-1])
1334 inbuf.len--, add_null = 1;
1335 if (iconvbufs(ic_send, &inbuf, &outbuf, flags) < 0) {
1338 /* Buffer ended with an incomplete char, so move the
1339 * bytes to the start of the buffer and continue. */
1340 memmove(ibuf, ibuf + inbuf.pos, inbuf.len);
1345 if (outbuf.len == outbuf.size)
1347 outbuf.buf[outbuf.len++] = '\0';
1349 msg_bytes = outbuf.len;
1352 memcpy(line, perform_io(msg_bytes, PIO_INPUT_AND_CONSUME), msg_bytes);
1353 /* A directory name was sent with the trailing null */
1354 if (msg_bytes > 0 && !line[msg_bytes-1])
1355 log_delete(line, S_IFDIR);
1357 line[msg_bytes] = '\0';
1358 log_delete(line, S_IFREG);
1362 if (msg_bytes != 4) {
1364 rprintf(FERROR, "invalid multi-message %d:%lu [%s%s]\n",
1365 tag, (unsigned long)msg_bytes, who_am_i(),
1366 inc_recurse ? "/inc" : "");
1367 exit_cleanup(RERR_STREAMIO);
1369 data = perform_io(4, PIO_INPUT_AND_CONSUME);
1371 got_flist_entry_status(FES_SUCCESS, IVAL(data, 0));
1373 successful_send(IVAL(data, 0));
1378 data = perform_io(4, PIO_INPUT_AND_CONSUME);
1380 got_flist_entry_status(FES_NO_SEND, IVAL(data, 0));
1382 send_msg(MSG_NO_SEND, data, 4, 0);
1384 case MSG_ERROR_SOCKET:
1385 case MSG_ERROR_UTF8:
1390 if (tag == MSG_ERROR_SOCKET)
1395 case MSG_ERROR_XFER:
1397 if (msg_bytes >= sizeof line) {
1400 "multiplexing overflow %d:%lu [%s%s]\n",
1401 tag, (unsigned long)msg_bytes, who_am_i(),
1402 inc_recurse ? "/inc" : "");
1403 exit_cleanup(RERR_STREAMIO);
1405 memcpy(line, perform_io(msg_bytes, PIO_INPUT_AND_CONSUME), msg_bytes);
1406 rwrite((enum logcode)tag, line, msg_bytes, !am_generator);
1407 if (first_message) {
1408 if (list_only && !am_sender && tag == 1 && msg_bytes < sizeof line) {
1409 line[msg_bytes] = '\0';
1410 check_for_d_option_error(line);
1416 rprintf(FERROR, "unexpected tag %d [%s%s]\n",
1417 tag, who_am_i(), inc_recurse ? "/inc" : "");
1418 exit_cleanup(RERR_STREAMIO);
1422 void wait_for_receiver(void)
1424 if (!iobuf.raw_input_ends_before)
1427 if (iobuf.raw_input_ends_before) {
1428 int ndx = read_int(iobuf.in_fd);
1433 if (DEBUG_GTE(FLIST, 3))
1434 rprintf(FINFO, "[%s] flist_eof=1\n", who_am_i());
1440 exit_cleanup(RERR_STREAMIO);
1443 struct file_list *flist;
1444 if (DEBUG_GTE(FLIST, 2)) {
1445 rprintf(FINFO, "[%s] receiving flist for dir %d\n",
1448 flist = recv_file_list(iobuf.in_fd);
1449 flist->parent_ndx = ndx;
1450 #ifdef SUPPORT_HARD_LINKS
1451 if (preserve_hard_links)
1452 match_hard_links(flist);
1458 unsigned short read_shortint(int f)
1462 return (UVAL(b, 1) << 8) + UVAL(b, 0);
1465 int32 read_int(int f)
1472 #if SIZEOF_INT32 > 4
1473 if (num & (int32)0x80000000)
1474 num |= ~(int32)0xffffffff;
1479 int32 read_varint(int f)
1490 extra = int_byte_extra[ch / 4];
1492 uchar bit = ((uchar)1<<(8-extra));
1493 if (extra >= (int)sizeof u.b) {
1494 rprintf(FERROR, "Overflow in read_varint()\n");
1495 exit_cleanup(RERR_STREAMIO);
1497 read_buf(f, u.b, extra);
1498 u.b[extra] = ch & (bit-1);
1501 #if CAREFUL_ALIGNMENT
1504 #if SIZEOF_INT32 > 4
1505 if (u.x & (int32)0x80000000)
1506 u.x |= ~(int32)0xffffffff;
1511 int64 read_varlong(int f, uchar min_bytes)
1520 #if SIZEOF_INT64 < 8
1525 read_buf(f, b2, min_bytes);
1526 memcpy(u.b, b2+1, min_bytes-1);
1527 extra = int_byte_extra[CVAL(b2, 0) / 4];
1529 uchar bit = ((uchar)1<<(8-extra));
1530 if (min_bytes + extra > (int)sizeof u.b) {
1531 rprintf(FERROR, "Overflow in read_varlong()\n");
1532 exit_cleanup(RERR_STREAMIO);
1534 read_buf(f, u.b + min_bytes - 1, extra);
1535 u.b[min_bytes + extra - 1] = CVAL(b2, 0) & (bit-1);
1536 #if SIZEOF_INT64 < 8
1537 if (min_bytes + extra > 5 || u.b[4] || CVAL(u.b,3) & 0x80) {
1538 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1539 exit_cleanup(RERR_UNSUPPORTED);
1543 u.b[min_bytes + extra - 1] = CVAL(b2, 0);
1544 #if SIZEOF_INT64 < 8
1546 #elif CAREFUL_ALIGNMENT
1547 u.x = IVAL(u.b,0) | (((int64)IVAL(u.b,4))<<32);
1552 int64 read_longint(int f)
1554 #if SIZEOF_INT64 >= 8
1557 int32 num = read_int(f);
1559 if (num != (int32)0xffffffff)
1562 #if SIZEOF_INT64 < 8
1563 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1564 exit_cleanup(RERR_UNSUPPORTED);
1567 return IVAL(b,0) | (((int64)IVAL(b,4))<<32);
1571 void read_buf(int f, char *buf, size_t len)
1573 if (f != iobuf.in_fd) {
1574 if (safe_read(f, buf, len) != len)
1575 whine_about_eof(f); /* Doesn't return. */
1579 if (!IN_MULTIPLEXED) {
1580 memcpy(buf, perform_io(len, PIO_INPUT_AND_CONSUME), len);
1581 if (forward_flist_data)
1582 write_buf(iobuf.out_fd, buf, len);
1584 if (f == write_batch_monitor_in)
1585 safe_write(batch_fd, buf, len);
1593 while (!iobuf.raw_input_ends_before)
1596 siz = MIN(len, iobuf.raw_input_ends_before - iobuf.in.pos);
1597 data = perform_io(siz, PIO_INPUT_AND_CONSUME);
1598 if (iobuf.in.pos == iobuf.raw_input_ends_before)
1599 iobuf.raw_input_ends_before = 0;
1601 /* The bytes at the "data" pointer will survive long
1602 * enough to make a copy, but not past future I/O. */
1603 memcpy(buf, data, siz);
1605 if (forward_flist_data)
1606 write_buf(iobuf.out_fd, buf, siz);
1608 if (f == write_batch_monitor_in)
1609 safe_write(batch_fd, buf, siz);
1611 if ((len -= siz) == 0)
1617 void read_sbuf(int f, char *buf, size_t len)
1619 read_buf(f, buf, len);
1623 uchar read_byte(int f)
1626 read_buf(f, (char*)&c, 1);
1630 int read_vstring(int f, char *buf, int bufsize)
1632 int len = read_byte(f);
1635 len = (len & ~0x80) * 0x100 + read_byte(f);
1637 if (len >= bufsize) {
1638 rprintf(FERROR, "over-long vstring received (%d > %d)\n",
1644 read_buf(f, buf, len);
1649 /* Populate a sum_struct with values from the socket. This is
1650 * called by both the sender and the receiver. */
1651 void read_sum_head(int f, struct sum_struct *sum)
1653 int32 max_blength = protocol_version < 30 ? OLD_MAX_BLOCK_SIZE : MAX_BLOCK_SIZE;
1654 sum->count = read_int(f);
1655 if (sum->count < 0) {
1656 rprintf(FERROR, "Invalid checksum count %ld [%s]\n",
1657 (long)sum->count, who_am_i());
1658 exit_cleanup(RERR_PROTOCOL);
1660 sum->blength = read_int(f);
1661 if (sum->blength < 0 || sum->blength > max_blength) {
1662 rprintf(FERROR, "Invalid block length %ld [%s]\n",
1663 (long)sum->blength, who_am_i());
1664 exit_cleanup(RERR_PROTOCOL);
1666 sum->s2length = protocol_version < 27 ? csum_length : (int)read_int(f);
1667 if (sum->s2length < 0 || sum->s2length > MAX_DIGEST_LEN) {
1668 rprintf(FERROR, "Invalid checksum length %d [%s]\n",
1669 sum->s2length, who_am_i());
1670 exit_cleanup(RERR_PROTOCOL);
1672 sum->remainder = read_int(f);
1673 if (sum->remainder < 0 || sum->remainder > sum->blength) {
1674 rprintf(FERROR, "Invalid remainder length %ld [%s]\n",
1675 (long)sum->remainder, who_am_i());
1676 exit_cleanup(RERR_PROTOCOL);
1680 /* Send the values from a sum_struct over the socket. Set sum to
1681 * NULL if there are no checksums to send. This is called by both
1682 * the generator and the sender. */
1683 void write_sum_head(int f, struct sum_struct *sum)
1685 static struct sum_struct null_sum;
1690 write_int(f, sum->count);
1691 write_int(f, sum->blength);
1692 if (protocol_version >= 27)
1693 write_int(f, sum->s2length);
1694 write_int(f, sum->remainder);
1697 /* Sleep after writing to limit I/O bandwidth usage.
1699 * @todo Rather than sleeping after each write, it might be better to
1700 * use some kind of averaging. The current algorithm seems to always
1701 * use a bit less bandwidth than specified, because it doesn't make up
1702 * for slow periods. But arguably this is a feature. In addition, we
1703 * ought to take the time used to write the data into account.
1705 * During some phases of big transfers (file FOO is uptodate) this is
1706 * called with a small bytes_written every time. As the kernel has to
1707 * round small waits up to guarantee that we actually wait at least the
1708 * requested number of microseconds, this can become grossly inaccurate.
1709 * We therefore keep track of the bytes we've written over time and only
1710 * sleep when the accumulated delay is at least 1 tenth of a second. */
1711 static void sleep_for_bwlimit(int bytes_written)
1713 static struct timeval prior_tv;
1714 static long total_written = 0;
1715 struct timeval tv, start_tv;
1716 long elapsed_usec, sleep_usec;
1718 #define ONE_SEC 1000000L /* # of microseconds in a second */
1720 total_written += bytes_written;
1722 gettimeofday(&start_tv, NULL);
1723 if (prior_tv.tv_sec) {
1724 elapsed_usec = (start_tv.tv_sec - prior_tv.tv_sec) * ONE_SEC
1725 + (start_tv.tv_usec - prior_tv.tv_usec);
1726 total_written -= elapsed_usec * bwlimit / (ONE_SEC/1024);
1727 if (total_written < 0)
1731 sleep_usec = total_written * (ONE_SEC/1024) / bwlimit;
1732 if (sleep_usec < ONE_SEC / 10) {
1733 prior_tv = start_tv;
1737 tv.tv_sec = sleep_usec / ONE_SEC;
1738 tv.tv_usec = sleep_usec % ONE_SEC;
1739 select(0, NULL, NULL, NULL, &tv);
1741 gettimeofday(&prior_tv, NULL);
1742 elapsed_usec = (prior_tv.tv_sec - start_tv.tv_sec) * ONE_SEC
1743 + (prior_tv.tv_usec - start_tv.tv_usec);
1744 total_written = (sleep_usec - elapsed_usec) * bwlimit / (ONE_SEC/1024);
1747 void io_flush(int flush_it_all)
1749 if (iobuf.out.len > iobuf.out_empty_len) {
1750 if (flush_it_all) /* FULL_FLUSH: flush everything in the output buffers */
1751 perform_io(iobuf.out.size - iobuf.out_empty_len, PIO_NEED_OUTROOM);
1752 else /* NORMAL_FLUSH: flush at least 1 byte */
1753 perform_io(iobuf.out.size - iobuf.out.len + 1, PIO_NEED_OUTROOM);
1756 perform_io(iobuf.msg.size, PIO_NEED_MSGROOM);
1759 void write_shortint(int f, unsigned short x)
1763 b[1] = (char)(x >> 8);
1767 void write_int(int f, int32 x)
1774 void write_varint(int f, int32 x)
1782 while (cnt > 1 && b[cnt] == 0)
1784 bit = ((uchar)1<<(7-cnt+1));
1785 if (CVAL(b, cnt) >= bit) {
1789 *b = b[cnt] | ~(bit*2-1);
1793 write_buf(f, b, cnt);
1796 void write_varlong(int f, int64 x, uchar min_bytes)
1803 #if SIZEOF_INT64 >= 8
1804 SIVAL(b, 5, x >> 32);
1806 if (x <= 0x7FFFFFFF && x >= 0)
1807 memset(b + 5, 0, 4);
1809 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1810 exit_cleanup(RERR_UNSUPPORTED);
1814 while (cnt > min_bytes && b[cnt] == 0)
1816 bit = ((uchar)1<<(7-cnt+min_bytes));
1817 if (CVAL(b, cnt) >= bit) {
1820 } else if (cnt > min_bytes)
1821 *b = b[cnt] | ~(bit*2-1);
1825 write_buf(f, b, cnt);
1829 * Note: int64 may actually be a 32-bit type if ./configure couldn't find any
1830 * 64-bit types on this platform.
1832 void write_longint(int f, int64 x)
1834 char b[12], * const s = b+4;
1837 if (x <= 0x7FFFFFFF && x >= 0) {
1842 #if SIZEOF_INT64 < 8
1843 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1844 exit_cleanup(RERR_UNSUPPORTED);
1847 SIVAL(s, 4, x >> 32);
1848 write_buf(f, b, 12);
1852 void write_buf(int f, const char *buf, size_t len)
1856 if (f != iobuf.out_fd) {
1857 safe_write(f, buf, len);
1861 if (iobuf.out.size - iobuf.out.len < len)
1862 perform_io(len, PIO_NEED_OUTROOM);
1864 pos = iobuf.out.pos + iobuf.out.len; /* Must be set after any flushing. */
1865 if (pos >= iobuf.out.size)
1866 pos -= iobuf.out.size;
1868 /* Handle a split copy if we wrap around the end of the circular buffer. */
1869 if (pos >= iobuf.out.pos && (siz = iobuf.out.size - pos) < len) {
1870 memcpy(iobuf.out.buf + pos, buf, siz);
1871 memcpy(iobuf.out.buf, buf + siz, len - siz);
1873 memcpy(iobuf.out.buf + pos, buf, len);
1875 iobuf.out.len += len;
1878 if (f == write_batch_monitor_out)
1879 safe_write(batch_fd, buf, len);
1882 /* Write a string to the connection */
1883 void write_sbuf(int f, const char *buf)
1885 write_buf(f, buf, strlen(buf));
1888 void write_byte(int f, uchar c)
1890 write_buf(f, (char *)&c, 1);
1893 void write_vstring(int f, const char *str, int len)
1895 uchar lenbuf[3], *lb = lenbuf;
1900 "attempting to send over-long vstring (%d > %d)\n",
1902 exit_cleanup(RERR_PROTOCOL);
1904 *lb++ = len / 0x100 + 0x80;
1908 write_buf(f, (char*)lenbuf, lb - lenbuf + 1);
1910 write_buf(f, str, len);
1913 /* Send a file-list index using a byte-reduction method. */
1914 void write_ndx(int f, int32 ndx)
1916 static int32 prev_positive = -1, prev_negative = 1;
1917 int32 diff, cnt = 0;
1920 if (protocol_version < 30 || read_batch) {
1925 /* Send NDX_DONE as a single-byte 0 with no side effects. Send
1926 * negative nums as a positive after sending a leading 0xFF. */
1928 diff = ndx - prev_positive;
1929 prev_positive = ndx;
1930 } else if (ndx == NDX_DONE) {
1935 b[cnt++] = (char)0xFF;
1937 diff = ndx - prev_negative;
1938 prev_negative = ndx;
1941 /* A diff of 1 - 253 is sent as a one-byte diff; a diff of 254 - 32767
1942 * or 0 is sent as a 0xFE + a two-byte diff; otherwise we send 0xFE
1943 * & all 4 bytes of the (non-negative) num with the high-bit set. */
1944 if (diff < 0xFE && diff > 0)
1945 b[cnt++] = (char)diff;
1946 else if (diff < 0 || diff > 0x7FFF) {
1947 b[cnt++] = (char)0xFE;
1948 b[cnt++] = (char)((ndx >> 24) | 0x80);
1949 b[cnt++] = (char)ndx;
1950 b[cnt++] = (char)(ndx >> 8);
1951 b[cnt++] = (char)(ndx >> 16);
1953 b[cnt++] = (char)0xFE;
1954 b[cnt++] = (char)(diff >> 8);
1955 b[cnt++] = (char)diff;
1957 write_buf(f, b, cnt);
1960 /* Receive a file-list index using a byte-reduction method. */
1961 int32 read_ndx(int f)
1963 static int32 prev_positive = -1, prev_negative = 1;
1964 int32 *prev_ptr, num;
1967 if (protocol_version < 30)
1971 if (CVAL(b, 0) == 0xFF) {
1973 prev_ptr = &prev_negative;
1974 } else if (CVAL(b, 0) == 0)
1977 prev_ptr = &prev_positive;
1978 if (CVAL(b, 0) == 0xFE) {
1980 if (CVAL(b, 0) & 0x80) {
1981 b[3] = CVAL(b, 0) & ~0x80;
1983 read_buf(f, b+1, 2);
1986 num = (UVAL(b,0)<<8) + UVAL(b,1) + *prev_ptr;
1988 num = UVAL(b, 0) + *prev_ptr;
1990 if (prev_ptr == &prev_negative)
1995 /* Read a line of up to bufsiz-1 characters into buf. Strips
1996 * the (required) trailing newline and all carriage returns.
1997 * Returns 1 for success; 0 for I/O error or truncation. */
1998 int read_line_old(int fd, char *buf, size_t bufsiz)
2000 bufsiz--; /* leave room for the null */
2001 while (bufsiz > 0) {
2002 assert(fd != iobuf.in_fd);
2003 if (safe_read(fd, buf, 1) == 0)
2018 void io_printf(int fd, const char *format, ...)
2021 char buf[BIGPATHBUFLEN];
2024 va_start(ap, format);
2025 len = vsnprintf(buf, sizeof buf, format, ap);
2029 exit_cleanup(RERR_STREAMIO);
2031 if (len > (int)sizeof buf) {
2032 rprintf(FERROR, "io_printf() was too long for the buffer.\n");
2033 exit_cleanup(RERR_STREAMIO);
2036 write_sbuf(fd, buf);
2039 /* Setup for multiplexing a MSG_* stream with the data stream. */
2040 void io_start_multiplex_out(int fd)
2042 io_flush(FULL_FLUSH);
2044 if (msgs2stderr && DEBUG_GTE(IO, 2))
2045 rprintf(FINFO, "[%s] io_start_multiplex_out(%d)\n", who_am_i(), fd);
2047 iobuf.out_empty_len = 4; /* See also OUT_MULTIPLEXED */
2048 io_start_buffering_out(fd);
2050 iobuf.raw_data_header_pos = iobuf.out.pos + iobuf.out.len;
2054 /* Setup for multiplexing a MSG_* stream with the data stream. */
2055 void io_start_multiplex_in(int fd)
2057 if (msgs2stderr && DEBUG_GTE(IO, 2))
2058 rprintf(FINFO, "[%s] io_start_multiplex_in(%d)\n", who_am_i(), fd);
2060 iobuf.in_multiplexed = True; /* See also IN_MULTIPLEXED */
2061 io_start_buffering_in(fd);
2064 int io_end_multiplex_in(int mode)
2066 int ret = iobuf.in_multiplexed ? iobuf.in_fd : -1;
2068 if (msgs2stderr && DEBUG_GTE(IO, 2))
2069 rprintf(FINFO, "[%s] io_end_multiplex_in(mode=%d)\n", who_am_i(), mode);
2071 iobuf.in_multiplexed = False;
2072 if (mode == MPLX_SWITCHING)
2073 iobuf.raw_input_ends_before = 0;
2075 assert(iobuf.raw_input_ends_before == 0);
2076 if (mode != MPLX_TO_BUFFERED)
2077 io_end_buffering_in(mode);
2082 int io_end_multiplex_out(int mode)
2084 int ret = iobuf.out_empty_len ? iobuf.out_fd : -1;
2086 if (msgs2stderr && DEBUG_GTE(IO, 2))
2087 rprintf(FINFO, "[%s] io_end_multiplex_out(mode=%d)\n", who_am_i(), mode);
2089 if (mode != MPLX_TO_BUFFERED)
2090 io_end_buffering_out(mode);
2092 io_flush(FULL_FLUSH);
2095 iobuf.out_empty_len = 0;
2100 void start_write_batch(int fd)
2102 /* Some communication has already taken place, but we don't
2103 * enable batch writing until here so that we can write a
2104 * canonical record of the communication even though the
2105 * actual communication so far depends on whether a daemon
2107 write_int(batch_fd, protocol_version);
2108 if (protocol_version >= 30)
2109 write_byte(batch_fd, inc_recurse);
2110 write_int(batch_fd, checksum_seed);
2113 write_batch_monitor_out = fd;
2115 write_batch_monitor_in = fd;
2118 void stop_write_batch(void)
2120 write_batch_monitor_out = -1;
2121 write_batch_monitor_in = -1;