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;
79 int64 total_data_read = 0;
80 int64 total_data_written = 0;
85 int out_fd; /* Both "out" and "msg" go to this fd. */
87 unsigned out_empty_len;
88 size_t raw_data_header_pos; /* in the out xbuf */
89 size_t raw_flushing_ends_before; /* in the out xbuf */
90 size_t raw_input_ends_before; /* in the in xbuf */
91 } iobuf = { .in_fd = -1, .out_fd = -1 };
93 static time_t last_io_in;
94 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 ff_forward_fd = -1;
100 static int ff_reenable_multiplex = -1;
101 static char ff_lastchar = '\0';
102 static xbuf ff_xb = EMPTY_XBUF;
104 static xbuf iconv_buf = EMPTY_XBUF;
106 static int select_timeout = SELECT_TIMEOUT;
107 static int active_filecnt = 0;
108 static OFF_T active_bytecnt = 0;
109 static int first_message = 1;
111 static char int_byte_extra[64] = {
112 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* (00 - 3F)/4 */
113 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* (40 - 7F)/4 */
114 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /* (80 - BF)/4 */
115 2, 2, 2, 2, 2, 2, 2, 2, 3, 3, 3, 3, 4, 4, 5, 6, /* (C0 - FF)/4 */
118 #define IN_MULTIPLEXED (iobuf.in_multiplexed)
119 #define OUT_MULTIPLEXED (iobuf.out_empty_len != 0)
121 #define PIO_NEED_INPUT (1<<0) /* The *_NEED_* flags are mutually exclusive. */
122 #define PIO_NEED_OUTROOM (1<<1)
123 #define PIO_NEED_MSGROOM (1<<2)
125 #define PIO_CONSUME_INPUT (1<<4) /* Must becombined with PIO_NEED_INPUT. */
127 #define PIO_INPUT_AND_CONSUME (PIO_NEED_INPUT | PIO_CONSUME_INPUT)
128 #define PIO_NEED_FLAGS (PIO_NEED_INPUT | PIO_NEED_OUTROOM | PIO_NEED_MSGROOM)
130 #define REMOTE_OPTION_ERROR "rsync: on remote machine: -"
131 #define REMOTE_OPTION_ERROR2 ": unknown option"
133 #define FILESFROM_BUFLEN 2048
135 enum festatus { FES_SUCCESS, FES_REDO, FES_NO_SEND };
137 static flist_ndx_list redo_list, hlink_list;
139 static void sleep_for_bwlimit(int bytes_written);
141 static void check_timeout(void)
145 if (!io_timeout || ignore_timeout)
149 last_io_in = time(NULL);
155 if (t - last_io_in >= io_timeout) {
156 if (!am_server && !am_daemon) {
157 rprintf(FERROR, "io timeout after %d seconds -- exiting\n",
158 (int)(t-last_io_in));
160 exit_cleanup(RERR_TIMEOUT);
164 /* It's almost always an error to get an EOF when we're trying to read from the
165 * network, because the protocol is (for the most part) self-terminating.
167 * There is one case for the receiver when it is at the end of the transfer
168 * (hanging around reading any keep-alive packets that might come its way): if
169 * the sender dies before the generator's kill-signal comes through, we can end
170 * up here needing to loop until the kill-signal arrives. In this situation,
171 * kluge_around_eof will be < 0.
173 * There is another case for older protocol versions (< 24) where the module
174 * listing was not terminated, so we must ignore an EOF error in that case and
175 * exit. In this situation, kluge_around_eof will be > 0. */
176 static NORETURN void whine_about_eof(int fd)
178 if (kluge_around_eof && fd == sock_f_in) {
180 if (kluge_around_eof > 0)
182 /* If we're still here after 10 seconds, exit with an error. */
183 for (i = 10*1000/20; i--; )
187 rprintf(FERROR, RSYNC_NAME ": connection unexpectedly closed "
188 "(%s bytes received so far) [%s]\n",
189 big_num(stats.total_read), who_am_i());
191 exit_cleanup(RERR_STREAMIO);
194 /* Do a safe read, handling any needed looping and error handling.
195 * Returns the count of the bytes read, which will only be different
196 * from "len" if we encountered an EOF. This routine is not used on
197 * the socket except very early in the transfer. */
198 static size_t safe_read(int fd, char *buf, size_t len)
203 assert(fd != iobuf.in_fd);
205 n = read(fd, buf, len);
206 if ((size_t)n == len || n == 0) {
207 if (DEBUG_GTE(IO, 2))
208 rprintf(FINFO, "[%s] safe_read(%d)=%ld\n", who_am_i(), fd, (long)n);
212 if (errno != EINTR && errno != EWOULDBLOCK && errno != EAGAIN) {
214 rsyserr(FERROR, errno, "safe_read failed to read %ld bytes [%s]",
215 (long)len, who_am_i());
216 exit_cleanup(RERR_STREAMIO);
231 tv.tv_sec = select_timeout;
234 cnt = select(fd+1, &r_fds, NULL, &e_fds, &tv);
236 if (cnt < 0 && errno == EBADF) {
237 rsyserr(FERROR, errno, "safe_read select failed [%s]",
239 exit_cleanup(RERR_FILEIO);
245 /*if (FD_ISSET(fd, &e_fds))
246 rprintf(FINFO, "select exception on fd %d\n", fd); */
248 if (FD_ISSET(fd, &r_fds)) {
249 n = read(fd, buf + got, len - got);
250 if (DEBUG_GTE(IO, 2))
251 rprintf(FINFO, "[%s] safe_read(%d)=%ld\n", who_am_i(), fd, (long)n);
259 if ((got += (size_t)n) == len)
267 static const char *what_fd_is(int fd)
271 if (fd == sock_f_out)
273 else if (fd == iobuf.out_fd)
275 else if (fd == batch_fd)
278 snprintf(buf, sizeof buf, "fd %d", fd);
283 /* Do a safe write, handling any needed looping and error handling.
284 * Returns only if everything was successfully written. This routine
285 * is not used on the socket except very early in the transfer. */
286 static void safe_write(int fd, const char *buf, size_t len)
290 assert(fd != iobuf.out_fd);
292 n = write(fd, buf, len);
293 if ((size_t)n == len)
296 if (errno != EINTR && errno != EWOULDBLOCK && errno != EAGAIN) {
298 rsyserr(FERROR, errno,
299 "safe_write failed to write %ld bytes to %s [%s]",
300 (long)len, what_fd_is(fd), who_am_i());
301 exit_cleanup(RERR_STREAMIO);
315 tv.tv_sec = select_timeout;
318 cnt = select(fd + 1, NULL, &w_fds, NULL, &tv);
320 if (cnt < 0 && errno == EBADF) {
321 rsyserr(FERROR, errno, "safe_write select failed on %s [%s]",
322 what_fd_is(fd), who_am_i());
323 exit_cleanup(RERR_FILEIO);
329 if (FD_ISSET(fd, &w_fds)) {
330 n = write(fd, buf, len);
342 /* This is only called when files-from data is known to be available. We read
343 * a chunk of data and put it into the output buffer. */
344 static void forward_filesfrom_data(void)
348 len = read(ff_forward_fd, ff_xb.buf + ff_xb.len, ff_xb.size - ff_xb.len);
350 if (len == 0 || errno != EINTR) {
351 /* Send end-of-file marker */
353 write_buf(iobuf.out_fd, "\0\0", ff_lastchar ? 2 : 1);
355 if (ff_reenable_multiplex >= 0)
356 io_start_multiplex_out(ff_reenable_multiplex);
361 if (DEBUG_GTE(IO, 2))
362 rprintf(FINFO, "[%s] files-from read=%ld\n", who_am_i(), (long)len);
369 char *s = ff_xb.buf + len;
370 /* Transform CR and/or LF into '\0' */
371 while (s-- > ff_xb.buf) {
372 if (*s == '\n' || *s == '\r')
381 /* Last buf ended with a '\0', so don't let this buf start with one. */
382 while (len && *s == '\0')
384 ff_xb.pos = s - ff_xb.buf;
388 if (filesfrom_convert && len) {
389 char *sob = ff_xb.buf + ff_xb.pos, *s = sob;
390 char *eob = sob + len;
391 int flags = ICB_INCLUDE_BAD | ICB_INCLUDE_INCOMPLETE | ICB_CIRCULAR_OUT;
392 if (ff_lastchar == '\0')
394 /* Convert/send each null-terminated string separately, skipping empties. */
397 ff_xb.len = s - sob - 1;
398 if (iconvbufs(ic_send, &ff_xb, &iobuf.out, flags) < 0)
399 exit_cleanup(RERR_PROTOCOL); /* impossible? */
400 write_buf(iobuf.out_fd, s-1, 1); /* Send the '\0'. */
401 while (s != eob && *s == '\0')
404 ff_xb.pos = sob - ff_xb.buf;
409 if ((ff_xb.len = s - sob) == 0)
412 /* Handle a partial string specially, saving any incomplete chars. */
413 flags &= ~ICB_INCLUDE_INCOMPLETE;
414 if (iconvbufs(ic_send, &ff_xb, &iobuf.out, flags) < 0) {
416 exit_cleanup(RERR_PROTOCOL); /* impossible? */
418 memmove(ff_xb.buf, ff_xb.buf + ff_xb.pos, ff_xb.len);
420 ff_lastchar = 'x'; /* Anything non-zero. */
426 char *f = ff_xb.buf + ff_xb.pos;
429 /* Eliminate any multi-'\0' runs. */
431 if (!(*t++ = *f++)) {
432 while (f != eob && *f == '\0')
437 if ((len = t - ff_xb.buf) != 0) {
438 /* This will not circle back to perform_io() because we only get
439 * called when there is plenty of room in the output buffer. */
440 write_buf(iobuf.out_fd, ff_xb.buf, len);
445 /* Perform buffered input and output until specified conditions are met. When
446 * given a "needed" read requirement, we'll return without doing any I/O if the
447 * iobuf.in bytes are already available. When reading, we'll read as many
448 * bytes as we can into the buffer, and return as soon as we meet the minimum
449 * read requirement. When given a "needed" write requirement, we'll return
450 * without doing any I/O if that many bytes will fit in the output buffer (we
451 * check either iobuf.out or iobuf.msg, depending on the flags). When writing,
452 * we write out as much as we can, and return as soon as the given free-space
453 * requirement is available.
455 * The iobuf.out and iobuf.msg buffers are circular, so some writes into them
456 * will need to be split when the data needs to wrap around to the start. In
457 * order to help make this easier for some operations (such as the use of
458 * SIVAL() into the buffer) the buffers MUST have 4 bytes of overflow space at
459 * the end that is not not counted in the "size". The iobuf.in buffer is not
460 * (currently) circular. To facilitate the handling of MSG_DATA bytes as they
461 * are read-from/written-into the buffers, see the three raw_* iobuf vars.
463 * When writing, we flush data in the following priority order:
465 * 1. Finish writing any in-progress MSG_DATA sequence from iobuf.out.
467 * 2. Write out all the messages from the message buf (if iobuf.msg is active).
468 * Yes, this means that a PIO_NEED_OUTROOM call will completely flush any
469 * messages before getting to the iobuf.out flushing (except for rule 1).
471 * 3. Write out the raw data from iobuf.out, possibly filling in the multiplexed
472 * MSG_DATA header that was pre-allocated (when output is multiplexed).
474 * TODO: items for possible future work:
476 * - Make this routine able to read the generator-to-receiver batch flow?
478 * - Make the input buffer circular?
480 * Unlike the old routines that this replaces, it is OK to read ahead as far as
481 * we can because the read_a_msg() routine now reads its bytes out of the input
482 * buffer. In the old days, only raw data was in the input buffer, and any
483 * unused raw data in the buf would prevent the reading of socket data. */
484 static char *perform_io(size_t needed, int flags)
486 fd_set r_fds, e_fds, w_fds;
489 size_t empty_buf_len = 0;
493 if (iobuf.in.len == 0 && iobuf.in.pos != 0) {
494 if (iobuf.raw_input_ends_before)
495 iobuf.raw_input_ends_before -= iobuf.in.pos;
499 switch (flags & PIO_NEED_FLAGS) {
501 if (DEBUG_GTE(IO, 3)) {
502 rprintf(FINFO, "[%s] perform_io(%ld, %sinput)\n",
503 who_am_i(), (long)needed, flags & PIO_CONSUME_INPUT ? "consume&" : "");
506 /* Make sure the input buffer is big enough to hold "needed" bytes.
507 * Also make sure it will fit in the free space at the end, or
508 * else we need to shift some bytes. */
509 if (needed && iobuf.in.size < needed) {
510 if (!(iobuf.in.buf = realloc_array(iobuf.in.buf, char, needed)))
511 out_of_memory("perform_io");
512 if (DEBUG_GTE(IO, 4)) {
513 rprintf(FINFO, "[%s] resized input buffer from %ld to %ld bytes.\n",
514 who_am_i(), (long)iobuf.in.size, (long)needed);
516 iobuf.in.size = needed;
518 if (iobuf.in.size - iobuf.in.pos < needed
519 || (iobuf.in.len < needed && iobuf.in.len < 1024
520 && iobuf.in.size - (iobuf.in.pos + iobuf.in.len) < 1024)) {
521 memmove(iobuf.in.buf, iobuf.in.buf + iobuf.in.pos, iobuf.in.len);
522 if (DEBUG_GTE(IO, 4)) {
524 "[%s] moved %ld bytes from %ld to 0 in the input buffer (size=%ld, needed=%ld).\n",
525 who_am_i(), (long)iobuf.in.len, (long)iobuf.in.pos, (long)iobuf.in.size, (long)needed);
527 if (iobuf.raw_input_ends_before)
528 iobuf.raw_input_ends_before -= iobuf.in.pos;
533 case PIO_NEED_OUTROOM:
534 /* We never resize the circular output buffer. */
535 if (iobuf.out.size - iobuf.out_empty_len < needed) {
536 fprintf(stderr, "need to write %ld bytes, iobuf.out.buf is only %ld bytes.\n",
537 (long)needed, (long)(iobuf.out.size - iobuf.out_empty_len));
538 exit_cleanup(RERR_PROTOCOL);
541 if (DEBUG_GTE(IO, 3)) {
542 rprintf(FINFO, "[%s] perform_io(%ld, outroom) needs to flush %ld\n",
543 who_am_i(), (long)needed,
544 iobuf.out.len > iobuf.out.size - needed
545 ? (long)iobuf.out.len - (iobuf.out.size - needed) : 0L);
549 case PIO_NEED_MSGROOM:
550 /* We never resize the circular message buffer. */
551 if (iobuf.msg.size < needed) {
552 fprintf(stderr, "need to write %ld bytes, iobuf.msg.buf is only %ld bytes.\n",
553 (long)needed, (long)iobuf.msg.size);
554 exit_cleanup(RERR_PROTOCOL);
557 if (DEBUG_GTE(IO, 3)) {
558 rprintf(FINFO, "[%s] perform_io(%ld, msgroom) needs to flush %ld\n",
559 who_am_i(), (long)needed,
560 iobuf.out.len > iobuf.msg.size - needed
561 ? (long)iobuf.out.len - (iobuf.msg.size - needed) : 0L);
566 if (DEBUG_GTE(IO, 3))
567 rprintf(FINFO, "[%s] perform_io(%ld, %d)\n", who_am_i(), (long)needed, flags);
571 exit_cleanup(RERR_UNSUPPORTED);
575 switch (flags & PIO_NEED_FLAGS) {
577 if (iobuf.in.len >= needed)
580 case PIO_NEED_OUTROOM:
581 if (iobuf.out.len <= iobuf.out.size - needed)
584 case PIO_NEED_MSGROOM:
585 if (iobuf.msg.len <= iobuf.msg.size - needed)
594 if (iobuf.in_fd >= 0 && iobuf.in.size - (iobuf.in.pos + iobuf.in.len)) {
595 if (!read_batch || batch_fd >= 0) {
596 FD_SET(iobuf.in_fd, &r_fds);
597 FD_SET(iobuf.in_fd, &e_fds);
599 if (iobuf.in_fd > max_fd)
600 max_fd = iobuf.in_fd;
603 /* Only do more filesfrom processing if there is enough room in the out buffer. */
604 if (ff_forward_fd >= 0 && iobuf.out.size - iobuf.out.len > FILESFROM_BUFLEN*2) {
605 FD_SET(ff_forward_fd, &r_fds);
606 if (ff_forward_fd > max_fd)
607 max_fd = ff_forward_fd;
611 if (iobuf.out_fd >= 0) {
612 if (iobuf.raw_flushing_ends_before
613 || (!iobuf.msg.len && iobuf.out.len > iobuf.out_empty_len && !(flags & PIO_NEED_MSGROOM))) {
614 if (OUT_MULTIPLEXED && !iobuf.raw_flushing_ends_before) {
617 /* The iobuf.raw_flushing_ends_before value can point off the end
618 * of the iobuf.out buffer for a while, for easier subtracting. */
619 iobuf.raw_flushing_ends_before = iobuf.out.pos + iobuf.out.len;
621 SIVAL(iobuf.out.buf + iobuf.raw_data_header_pos, 0,
622 ((MPLEX_BASE + (int)MSG_DATA)<<24) + iobuf.out.len - 4);
623 if ((val = iobuf.out.size - iobuf.raw_data_header_pos) < 4) {
624 /* We used some of the overflow bytes, so move them. */
625 if (DEBUG_GTE(IO, 4)) {
626 rprintf(FINFO, "[%s] wrap-bytes moved: %d (perform_io)\n",
627 who_am_i(), (int)val);
629 memcpy(iobuf.out.buf, iobuf.out.buf + iobuf.out.size, 4 - val);
632 if (DEBUG_GTE(IO, 1)) {
633 rprintf(FINFO, "[%s] send_msg(%d, %ld)\n",
634 who_am_i(), (int)MSG_DATA, (long)iobuf.out.len - 4);
637 /* reserve room for the next MSG_DATA header */
638 iobuf.raw_data_header_pos = iobuf.raw_flushing_ends_before;
639 if (iobuf.raw_data_header_pos >= iobuf.out.size)
640 iobuf.raw_data_header_pos -= iobuf.out.size;
644 empty_buf_len = iobuf.out_empty_len;
646 } else if (iobuf.msg.len) {
652 FD_SET(iobuf.out_fd, &w_fds);
653 if (iobuf.out_fd > max_fd)
654 max_fd = iobuf.out_fd;
660 switch (flags & PIO_NEED_FLAGS) {
662 rprintf(FERROR, "error in perform_io: no fd for input.\n");
663 exit_cleanup(RERR_PROTOCOL);
664 case PIO_NEED_OUTROOM:
665 case PIO_NEED_MSGROOM:
667 rprintf(FERROR, "error in perform_io: no fd for output.\n");
668 exit_cleanup(RERR_PROTOCOL);
670 /* No stated needs, so I guess this is OK. */
676 if (extra_flist_sending_enabled) {
677 if (file_total - file_old_total < MAX_FILECNT_LOOKAHEAD
678 && file_total - file_old_total >= MIN_FILECNT_LOOKAHEAD)
681 extra_flist_sending_enabled = False;
682 tv.tv_sec = select_timeout;
685 tv.tv_sec = select_timeout;
688 cnt = select(max_fd + 1, &r_fds, &w_fds, &e_fds, &tv);
691 if (cnt < 0 && errno == EBADF) {
693 exit_cleanup(RERR_SOCKETIO);
695 if (extra_flist_sending_enabled) {
696 extra_flist_sending_enabled = False;
697 send_extra_file_list(sock_f_out, -1);
698 extra_flist_sending_enabled = !flist_eof;
701 FD_ZERO(&r_fds); /* Just in case... */
705 if (iobuf.in_fd >= 0 && FD_ISSET(iobuf.in_fd, &r_fds)) {
706 size_t pos = iobuf.in.pos + iobuf.in.len;
707 size_t len = iobuf.in.size - pos;
709 if ((n = read(iobuf.in_fd, iobuf.in.buf + pos, len)) <= 0) {
711 if (!read_batch || batch_fd < 0 || am_generator)
712 whine_about_eof(iobuf.in_fd); /* Doesn't return. */
716 if (errno == EINTR || errno == EWOULDBLOCK || errno == EAGAIN)
719 /* Don't write errors on a dead socket. */
720 if (iobuf.in_fd == sock_f_in) {
723 rsyserr(FERROR_SOCKET, errno, "read error");
725 rsyserr(FERROR, errno, "read error");
726 exit_cleanup(RERR_STREAMIO);
729 if (msgs2stderr && DEBUG_GTE(IO, 2))
730 rprintf(FINFO, "[%s] recv=%ld\n", who_am_i(), (long)n);
733 last_io_in = time(NULL);
734 stats.total_read += n;
739 if (iobuf.out_fd >= 0 && FD_ISSET(iobuf.out_fd, &w_fds)) {
740 size_t len = iobuf.raw_flushing_ends_before ? iobuf.raw_flushing_ends_before - out->pos : out->len;
743 if (bwlimit_writemax && len > bwlimit_writemax)
744 len = bwlimit_writemax;
746 if (out->pos + len > out->size)
747 len = out->size - out->pos;
748 if ((n = write(iobuf.out_fd, out->buf + out->pos, len)) <= 0) {
749 if (errno == EINTR || errno == EWOULDBLOCK || errno == EAGAIN)
752 /* Don't write errors on a dead socket. */
754 out->len = iobuf.raw_flushing_ends_before = out->pos = 0;
755 rsyserr(FERROR_SOCKET, errno, "[%s] write error", who_am_i());
756 exit_cleanup(RERR_STREAMIO);
759 if (msgs2stderr && DEBUG_GTE(IO, 2)) {
760 rprintf(FINFO, "[%s] %s sent=%ld\n",
761 who_am_i(), out == &iobuf.out ? "out" : "msg", (long)n);
765 last_io_out = time(NULL);
766 stats.total_written += n;
768 if (bwlimit_writemax)
769 sleep_for_bwlimit(n);
771 if ((out->pos += n) == out->size) {
772 if (iobuf.raw_flushing_ends_before)
773 iobuf.raw_flushing_ends_before -= out->size;
776 if (out->pos == iobuf.raw_flushing_ends_before)
777 iobuf.raw_flushing_ends_before = 0;
778 if ((out->len -= n) == empty_buf_len) {
781 iobuf.raw_data_header_pos = 0;
785 if (ff_forward_fd >= 0 && FD_ISSET(ff_forward_fd, &r_fds)) {
786 /* This can potentially flush all output and enable
787 * multiplexed output, so keep this last in the loop
788 * and be sure to not cache anything that would break
790 forward_filesfrom_data();
795 data = iobuf.in.buf + iobuf.in.pos;
797 if (flags & PIO_CONSUME_INPUT) {
798 iobuf.in.len -= needed;
799 iobuf.in.pos += needed;
805 void noop_io_until_death(void)
809 kluge_around_eof = 1;
810 set_io_timeout(protocol_version >= 31 ? 10 : 1);
813 read_buf(iobuf.in_fd, buf, sizeof buf);
816 /* Buffer a message for the multiplexed output stream. Is never used for MSG_DATA. */
817 int send_msg(enum msgcode code, const char *buf, size_t len, int convert)
821 BOOL want_debug = DEBUG_GTE(IO, 1) && convert >= 0 && (msgs2stderr || code != MSG_INFO);
823 if (!OUT_MULTIPLEXED)
827 rprintf(FINFO, "[%s] send_msg(%d, %ld)\n", who_am_i(), (int)code, (long)len);
830 if (convert > 0 && ic_send == (iconv_t)-1)
833 /* Ensuring double-size room leaves space for a potential conversion. */
834 if (iobuf.msg.len + len*2 + 4 > iobuf.msg.size)
835 perform_io(len*2 + 4, PIO_NEED_MSGROOM);
838 if (iobuf.msg.len + len + 4 > iobuf.msg.size)
839 perform_io(len + 4, PIO_NEED_MSGROOM);
841 pos = iobuf.msg.pos + iobuf.msg.len; /* Must be set after any flushing. */
842 if (pos >= iobuf.msg.size)
843 pos -= iobuf.msg.size;
844 hdr = iobuf.msg.buf + pos;
846 iobuf.msg.len += 4; /* Leave room for the coming header bytes. */
852 INIT_XBUF(inbuf, (char*)buf, len, (size_t)-1);
855 iconvbufs(ic_send, &inbuf, &iobuf.msg,
856 ICB_INCLUDE_BAD | ICB_INCLUDE_INCOMPLETE | ICB_CIRCULAR_OUT | ICB_INIT);
858 rprintf(FERROR, "overflowed iobuf.msg buffer in send_msg");
859 exit_cleanup(RERR_UNSUPPORTED);
861 len = iobuf.msg.len - len;
867 if ((pos += 4) >= iobuf.msg.size)
868 pos -= iobuf.msg.size;
870 /* Handle a split copy if we wrap around the end of the circular buffer. */
871 if (pos >= iobuf.msg.pos && (siz = iobuf.msg.size - pos) < len) {
872 memcpy(iobuf.msg.buf + pos, buf, siz);
873 memcpy(iobuf.msg.buf, buf + siz, len - siz);
875 memcpy(iobuf.msg.buf + pos, buf, len);
877 iobuf.msg.len += len;
880 SIVAL(hdr, 0, ((MPLEX_BASE + (int)code)<<24) + len);
881 /* If the header used any overflow bytes, move them to the start. */
882 if ((pos = hdr+4 - iobuf.msg.buf) > iobuf.msg.size) {
883 size_t siz = pos - iobuf.msg.size;
884 if (DEBUG_GTE(IO, 4))
885 rprintf(FINFO, "[%s] wrap-bytes moved: %d (send_msg)\n", who_am_i(), (int)siz);
886 memcpy(iobuf.msg.buf, hdr+4 - siz, siz);
889 if (want_debug && convert > 0)
890 rprintf(FINFO, "[%s] converted msg len=%ld\n", who_am_i(), (long)len);
895 void send_msg_int(enum msgcode code, int num)
899 if (DEBUG_GTE(IO, 1))
900 rprintf(FINFO, "[%s] send_msg_int(%d, %d)\n", who_am_i(), (int)code, num);
902 SIVAL(numbuf, 0, num);
903 send_msg(code, numbuf, 4, -1);
906 static void got_flist_entry_status(enum festatus status, int ndx)
908 struct file_list *flist = flist_for_ndx(ndx, "got_flist_entry_status");
910 if (remove_source_files) {
912 active_bytecnt -= F_LENGTH(flist->files[ndx - flist->ndx_start]);
916 flist->in_progress--;
920 if (remove_source_files)
921 send_msg_int(MSG_SUCCESS, ndx);
922 if (preserve_hard_links) {
923 struct file_struct *file = flist->files[ndx - flist->ndx_start];
924 if (F_IS_HLINKED(file)) {
925 flist_ndx_push(&hlink_list, ndx);
926 flist->in_progress++;
933 flist->in_progress++;
938 flist_ndx_push(&redo_list, ndx);
945 /* Note the fds used for the main socket (which might really be a pipe
946 * for a local transfer, but we can ignore that). */
947 void io_set_sock_fds(int f_in, int f_out)
953 void set_io_timeout(int secs)
957 if (!io_timeout || io_timeout > SELECT_TIMEOUT)
958 select_timeout = SELECT_TIMEOUT;
960 select_timeout = io_timeout;
962 allowed_lull = read_batch ? 0 : (io_timeout + 1) / 2;
965 static void check_for_d_option_error(const char *msg)
967 static char rsync263_opts[] = "BCDHIKLPRSTWabceghlnopqrtuvxz";
972 || strncmp(msg, REMOTE_OPTION_ERROR, sizeof REMOTE_OPTION_ERROR - 1) != 0)
975 msg += sizeof REMOTE_OPTION_ERROR - 1;
976 if (*msg == '-' || (colon = strchr(msg, ':')) == NULL
977 || strncmp(colon, REMOTE_OPTION_ERROR2, sizeof REMOTE_OPTION_ERROR2 - 1) != 0)
980 for ( ; *msg != ':'; msg++) {
983 else if (*msg == 'e')
985 else if (strchr(rsync263_opts, *msg) == NULL)
991 "*** Try using \"--old-d\" if remote rsync is <= 2.6.3 ***\n");
995 /* This is used by the generator to limit how many file transfers can
996 * be active at once when --remove-source-files is specified. Without
997 * this, sender-side deletions were mostly happening at the end. */
998 void increment_active_files(int ndx, int itemizing, enum logcode code)
1001 /* TODO: tune these limits? */
1002 int limit = active_bytecnt >= 128*1024 ? 10 : 50;
1003 if (active_filecnt < limit)
1005 check_for_finished_files(itemizing, code, 0);
1006 if (active_filecnt < limit)
1008 wait_for_receiver();
1012 active_bytecnt += F_LENGTH(cur_flist->files[ndx - cur_flist->ndx_start]);
1015 int get_redo_num(void)
1017 return flist_ndx_pop(&redo_list);
1020 int get_hlink_num(void)
1022 return flist_ndx_pop(&hlink_list);
1025 /* When we're the receiver and we have a local --files-from list of names
1026 * that needs to be sent over the socket to the sender, we have to do two
1027 * things at the same time: send the sender a list of what files we're
1028 * processing and read the incoming file+info list from the sender. We do
1029 * this by making recv_file_list() call forward_filesfrom_data(), which
1030 * will ensure that we forward data to the sender until we get some data
1031 * for recv_file_list() to use. */
1032 void start_filesfrom_forwarding(int fd)
1034 if (protocol_version < 31 && OUT_MULTIPLEXED) {
1035 /* Older protocols send the files-from data w/o packaging
1036 * it in multiplexed I/O packets, so temporarily switch
1037 * to buffered I/O to match this behavior. */
1038 iobuf.msg.pos = iobuf.msg.len = 0; /* Be extra sure no messages go out. */
1039 ff_reenable_multiplex = io_end_multiplex_out(MPLX_TO_BUFFERED);
1043 alloc_xbuf(&ff_xb, FILESFROM_BUFLEN);
1046 /* Read a line into the "buf" buffer. */
1047 int read_line(int fd, char *buf, size_t bufsiz, int flags)
1052 if (flags & RL_CONVERT && iconv_buf.size < bufsiz)
1053 realloc_xbuf(&iconv_buf, bufsiz + 1024);
1058 s = flags & RL_CONVERT ? iconv_buf.buf : buf;
1062 eob = s + bufsiz - 1;
1064 /* We avoid read_byte() for files because files can return an EOF. */
1065 if (fd == iobuf.in_fd)
1067 else if (safe_read(fd, &ch, 1) == 0)
1069 if (flags & RL_EOL_NULLS ? ch == '\0' : (ch == '\r' || ch == '\n')) {
1070 /* Skip empty lines if dumping comments. */
1071 if (flags & RL_DUMP_COMMENTS && s == buf)
1080 if (flags & RL_DUMP_COMMENTS && (*buf == '#' || *buf == ';'))
1084 if (flags & RL_CONVERT) {
1086 INIT_XBUF(outbuf, buf, 0, bufsiz);
1088 iconv_buf.len = s - iconv_buf.buf;
1089 iconvbufs(ic_recv, &iconv_buf, &outbuf,
1090 ICB_INCLUDE_BAD | ICB_INCLUDE_INCOMPLETE | ICB_INIT);
1091 outbuf.buf[outbuf.len] = '\0';
1099 void read_args(int f_in, char *mod_name, char *buf, size_t bufsiz, int rl_nulls,
1100 char ***argv_p, int *argc_p, char **request_p)
1102 int maxargs = MAX_ARGS;
1106 int rl_flags = (rl_nulls ? RL_EOL_NULLS : 0);
1109 rl_flags |= (protect_args && ic_recv != (iconv_t)-1 ? RL_CONVERT : 0);
1112 if (!(argv = new_array(char *, maxargs)))
1113 out_of_memory("read_args");
1114 if (mod_name && !protect_args)
1115 argv[argc++] = "rsyncd";
1118 if (read_line(f_in, buf, bufsiz, rl_flags) == 0)
1121 if (argc == maxargs-1) {
1122 maxargs += MAX_ARGS;
1123 if (!(argv = realloc_array(argv, char *, maxargs)))
1124 out_of_memory("read_args");
1129 *request_p = strdup(buf);
1133 glob_expand_module(mod_name, buf, &argv, &argc, &maxargs);
1135 glob_expand(buf, &argv, &argc, &maxargs);
1137 if (!(p = strdup(buf)))
1138 out_of_memory("read_args");
1140 if (*p == '.' && p[1] == '\0')
1146 glob_expand(NULL, NULL, NULL, NULL);
1152 BOOL io_start_buffering_out(int f_out)
1154 if (msgs2stderr && DEBUG_GTE(IO, 2))
1155 rprintf(FINFO, "[%s] io_start_buffering_out(%d)\n", who_am_i(), f_out);
1157 if (OUT_MULTIPLEXED && !iobuf.msg.buf) {
1158 iobuf.msg.size = IO_BUFFER_SIZE - 4;
1159 if (!(iobuf.msg.buf = new_array(char, iobuf.msg.size + 4)))
1160 out_of_memory("io_start_buffering_out");
1161 iobuf.msg.pos = iobuf.msg.len = 0;
1164 if (iobuf.out.buf) {
1165 if (iobuf.out_fd == -1)
1166 iobuf.out_fd = f_out;
1167 assert(f_out == iobuf.out_fd);
1171 iobuf.out.size = IO_BUFFER_SIZE * 2 - 4;
1172 /* The 4 overflow bytes makes some circular-buffer wrapping operations easier. */
1173 if (!(iobuf.out.buf = new_array(char, iobuf.out.size + 4)))
1174 out_of_memory("io_start_buffering_out");
1175 iobuf.out.pos = iobuf.out.len = 0;
1176 iobuf.out_fd = f_out;
1181 BOOL io_start_buffering_in(int f_in)
1183 if (msgs2stderr && DEBUG_GTE(IO, 2))
1184 rprintf(FINFO, "[%s] io_start_buffering_in(%d)\n", who_am_i(), f_in);
1187 if (iobuf.in_fd == -1)
1189 assert(f_in == iobuf.in_fd);
1193 iobuf.in.size = IO_BUFFER_SIZE;
1194 if (!(iobuf.in.buf = new_array(char, iobuf.in.size)))
1195 out_of_memory("io_start_buffering_in");
1197 iobuf.in.pos = iobuf.in.len = 0;
1204 void io_end_buffering_in(BOOL free_buffers)
1206 if (msgs2stderr && DEBUG_GTE(IO, 2)) {
1207 rprintf(FINFO, "[%s] io_end_buffering_in(IOBUF_%s_BUFS)\n",
1208 who_am_i(), free_buffers ? "FREE" : "KEEP");
1212 free_xbuf(&iobuf.in);
1214 iobuf.in.pos = iobuf.in.len = 0;
1219 void io_end_buffering_out(BOOL free_buffers)
1221 if (msgs2stderr && DEBUG_GTE(IO, 2)) {
1222 rprintf(FINFO, "[%s] io_end_buffering_out(IOBUF_%s_BUFS)\n",
1223 who_am_i(), free_buffers ? "FREE" : "KEEP");
1226 io_flush(FULL_FLUSH);
1229 free_xbuf(&iobuf.out);
1230 free_xbuf(&iobuf.msg);
1236 void maybe_flush_socket(int important)
1238 if (flist_eof && iobuf.out.buf && iobuf.out.len > iobuf.out_empty_len
1239 && (important || time(NULL) - last_io_out >= 5))
1240 io_flush(NORMAL_FLUSH);
1243 void maybe_send_keepalive(void)
1245 if (time(NULL) - last_io_out >= allowed_lull) {
1246 if (!iobuf.msg.len && iobuf.out.len == iobuf.out_empty_len) {
1247 if (protocol_version < 29)
1248 return; /* there's nothing we can do */
1249 if (protocol_version >= 30)
1250 send_msg(MSG_NOOP, "", 0, 0);
1252 write_int(iobuf.out_fd, cur_flist->used);
1253 write_shortint(iobuf.out_fd, ITEM_IS_NEW);
1257 perform_io(iobuf.msg.size - iobuf.msg.len + 1, PIO_NEED_MSGROOM);
1258 else if (iobuf.out.len > iobuf.out_empty_len)
1259 io_flush(NORMAL_FLUSH);
1263 void start_flist_forward(int ndx)
1265 write_int(iobuf.out_fd, ndx);
1266 forward_flist_data = 1;
1269 void stop_flist_forward(void)
1271 forward_flist_data = 0;
1274 /* Read a message from a multiplexed source. */
1275 static void read_a_msg(void)
1277 char *data, line[BIGPATHBUFLEN];
1281 data = perform_io(4, PIO_INPUT_AND_CONSUME);
1282 tag = IVAL(data, 0);
1284 msg_bytes = tag & 0xFFFFFF;
1285 tag = (tag >> 24) - MPLEX_BASE;
1287 if (DEBUG_GTE(IO, 1) && (msgs2stderr || tag != MSG_INFO))
1288 rprintf(FINFO, "[%s] got msg=%d, len=%ld\n", who_am_i(), (int)tag, (long)msg_bytes);
1292 assert(iobuf.raw_input_ends_before == 0);
1293 /* Though this does not yet read the data, we do mark where in
1294 * the buffer the msg data will end once it is read. It is
1295 * possible that this points off the end of the buffer, in
1296 * which case the gradual reading of the input stream will
1297 * cause this value to decrease and eventually become real. */
1298 iobuf.raw_input_ends_before = iobuf.in.pos + msg_bytes;
1301 if (msg_bytes != sizeof stats.total_read || !am_generator)
1303 data = perform_io(sizeof stats.total_read, PIO_INPUT_AND_CONSUME);
1304 memcpy((char*)&stats.total_read, data, sizeof stats.total_read);
1307 if (msg_bytes != 4 || !am_generator)
1309 data = perform_io(4, PIO_INPUT_AND_CONSUME);
1310 got_flist_entry_status(FES_REDO, IVAL(data, 0));
1313 if (msg_bytes != 4 || am_sender)
1315 data = perform_io(4, PIO_INPUT_AND_CONSUME);
1316 io_error |= IVAL(data, 0);
1318 send_msg(MSG_IO_ERROR, data, 4, 0);
1320 case MSG_IO_TIMEOUT:
1321 if (msg_bytes != 4 || am_server || am_generator)
1323 data = perform_io(4, PIO_INPUT_AND_CONSUME);
1324 val = IVAL(data, 0);
1325 if (!io_timeout || io_timeout > val) {
1326 if (INFO_GTE(MISC, 2))
1327 rprintf(FINFO, "Setting --timeout=%d to match server\n", val);
1328 set_io_timeout(val);
1333 maybe_send_keepalive();
1336 if (msg_bytes >= sizeof line)
1339 memcpy(line, perform_io(msg_bytes, PIO_INPUT_AND_CONSUME), msg_bytes);
1340 send_msg(MSG_DELETED, line, msg_bytes, 1);
1344 if (ic_recv != (iconv_t)-1) {
1348 int flags = ICB_INCLUDE_BAD | ICB_INIT;
1350 INIT_CONST_XBUF(outbuf, line);
1351 INIT_XBUF(inbuf, ibuf, 0, (size_t)-1);
1354 size_t len = msg_bytes > sizeof ibuf - inbuf.len ? sizeof ibuf - inbuf.len : msg_bytes;
1355 memcpy(ibuf + inbuf.len, perform_io(len, PIO_INPUT_AND_CONSUME), len);
1358 if (!(msg_bytes -= len) && !ibuf[inbuf.len-1])
1359 inbuf.len--, add_null = 1;
1360 if (iconvbufs(ic_send, &inbuf, &outbuf, flags) < 0) {
1363 /* Buffer ended with an incomplete char, so move the
1364 * bytes to the start of the buffer and continue. */
1365 memmove(ibuf, ibuf + inbuf.pos, inbuf.len);
1370 if (outbuf.len == outbuf.size)
1372 outbuf.buf[outbuf.len++] = '\0';
1374 msg_bytes = outbuf.len;
1377 memcpy(line, perform_io(msg_bytes, PIO_INPUT_AND_CONSUME), msg_bytes);
1378 /* A directory name was sent with the trailing null */
1379 if (msg_bytes > 0 && !line[msg_bytes-1])
1380 log_delete(line, S_IFDIR);
1382 line[msg_bytes] = '\0';
1383 log_delete(line, S_IFREG);
1387 if (msg_bytes != 4) {
1389 rprintf(FERROR, "invalid multi-message %d:%lu [%s%s]\n",
1390 tag, (unsigned long)msg_bytes, who_am_i(),
1391 inc_recurse ? "/inc" : "");
1392 exit_cleanup(RERR_STREAMIO);
1394 data = perform_io(4, PIO_INPUT_AND_CONSUME);
1396 got_flist_entry_status(FES_SUCCESS, IVAL(data, 0));
1398 successful_send(IVAL(data, 0));
1403 data = perform_io(4, PIO_INPUT_AND_CONSUME);
1405 got_flist_entry_status(FES_NO_SEND, IVAL(data, 0));
1407 send_msg(MSG_NO_SEND, data, 4, 0);
1409 case MSG_ERROR_SOCKET:
1410 case MSG_ERROR_UTF8:
1415 if (tag == MSG_ERROR_SOCKET)
1420 case MSG_ERROR_XFER:
1422 if (msg_bytes >= sizeof line) {
1425 "multiplexing overflow %d:%lu [%s%s]\n",
1426 tag, (unsigned long)msg_bytes, who_am_i(),
1427 inc_recurse ? "/inc" : "");
1428 exit_cleanup(RERR_STREAMIO);
1430 memcpy(line, perform_io(msg_bytes, PIO_INPUT_AND_CONSUME), msg_bytes);
1431 rwrite((enum logcode)tag, line, msg_bytes, !am_generator);
1432 if (first_message) {
1433 if (list_only && !am_sender && tag == 1 && msg_bytes < sizeof line) {
1434 line[msg_bytes] = '\0';
1435 check_for_d_option_error(line);
1440 case MSG_ERROR_EXIT:
1441 if (msg_bytes == 0) {
1442 if (!am_sender && !am_generator) {
1443 send_msg(MSG_ERROR_EXIT, "", 0, 0);
1444 io_flush(FULL_FLUSH);
1447 } else if (msg_bytes == 4) {
1448 data = perform_io(4, PIO_INPUT_AND_CONSUME);
1449 val = IVAL(data, 0);
1450 if (protocol_version >= 31) {
1452 send_msg_int(MSG_ERROR_EXIT, val);
1454 send_msg(MSG_ERROR_EXIT, "", 0, 0);
1458 /* Send a negative linenum so that we don't end up
1459 * with a duplicate exit message. */
1460 _exit_cleanup(val, __FILE__, 0 - __LINE__);
1462 rprintf(FERROR, "unexpected tag %d [%s%s]\n",
1463 tag, who_am_i(), inc_recurse ? "/inc" : "");
1464 exit_cleanup(RERR_STREAMIO);
1468 void wait_for_receiver(void)
1470 if (!iobuf.raw_input_ends_before)
1473 if (iobuf.raw_input_ends_before) {
1474 int ndx = read_int(iobuf.in_fd);
1479 if (DEBUG_GTE(FLIST, 3))
1480 rprintf(FINFO, "[%s] flist_eof=1\n", who_am_i());
1486 exit_cleanup(RERR_STREAMIO);
1489 struct file_list *flist;
1490 if (DEBUG_GTE(FLIST, 2)) {
1491 rprintf(FINFO, "[%s] receiving flist for dir %d\n",
1494 flist = recv_file_list(iobuf.in_fd);
1495 flist->parent_ndx = ndx;
1496 #ifdef SUPPORT_HARD_LINKS
1497 if (preserve_hard_links)
1498 match_hard_links(flist);
1504 unsigned short read_shortint(int f)
1508 return (UVAL(b, 1) << 8) + UVAL(b, 0);
1511 int32 read_int(int f)
1518 #if SIZEOF_INT32 > 4
1519 if (num & (int32)0x80000000)
1520 num |= ~(int32)0xffffffff;
1525 int32 read_varint(int f)
1536 extra = int_byte_extra[ch / 4];
1538 uchar bit = ((uchar)1<<(8-extra));
1539 if (extra >= (int)sizeof u.b) {
1540 rprintf(FERROR, "Overflow in read_varint()\n");
1541 exit_cleanup(RERR_STREAMIO);
1543 read_buf(f, u.b, extra);
1544 u.b[extra] = ch & (bit-1);
1547 #if CAREFUL_ALIGNMENT
1550 #if SIZEOF_INT32 > 4
1551 if (u.x & (int32)0x80000000)
1552 u.x |= ~(int32)0xffffffff;
1557 int64 read_varlong(int f, uchar min_bytes)
1566 #if SIZEOF_INT64 < 8
1571 read_buf(f, b2, min_bytes);
1572 memcpy(u.b, b2+1, min_bytes-1);
1573 extra = int_byte_extra[CVAL(b2, 0) / 4];
1575 uchar bit = ((uchar)1<<(8-extra));
1576 if (min_bytes + extra > (int)sizeof u.b) {
1577 rprintf(FERROR, "Overflow in read_varlong()\n");
1578 exit_cleanup(RERR_STREAMIO);
1580 read_buf(f, u.b + min_bytes - 1, extra);
1581 u.b[min_bytes + extra - 1] = CVAL(b2, 0) & (bit-1);
1582 #if SIZEOF_INT64 < 8
1583 if (min_bytes + extra > 5 || u.b[4] || CVAL(u.b,3) & 0x80) {
1584 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1585 exit_cleanup(RERR_UNSUPPORTED);
1589 u.b[min_bytes + extra - 1] = CVAL(b2, 0);
1590 #if SIZEOF_INT64 < 8
1592 #elif CAREFUL_ALIGNMENT
1593 u.x = IVAL(u.b,0) | (((int64)IVAL(u.b,4))<<32);
1598 int64 read_longint(int f)
1600 #if SIZEOF_INT64 >= 8
1603 int32 num = read_int(f);
1605 if (num != (int32)0xffffffff)
1608 #if SIZEOF_INT64 < 8
1609 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1610 exit_cleanup(RERR_UNSUPPORTED);
1613 return IVAL(b,0) | (((int64)IVAL(b,4))<<32);
1617 void read_buf(int f, char *buf, size_t len)
1619 if (f != iobuf.in_fd) {
1620 if (safe_read(f, buf, len) != len)
1621 whine_about_eof(f); /* Doesn't return. */
1625 if (!IN_MULTIPLEXED) {
1626 memcpy(buf, perform_io(len, PIO_INPUT_AND_CONSUME), len);
1627 total_data_read += len;
1628 if (forward_flist_data)
1629 write_buf(iobuf.out_fd, buf, len);
1631 if (f == write_batch_monitor_in)
1632 safe_write(batch_fd, buf, len);
1640 while (!iobuf.raw_input_ends_before)
1643 siz = MIN(len, iobuf.raw_input_ends_before - iobuf.in.pos);
1644 data = perform_io(siz, PIO_INPUT_AND_CONSUME);
1645 if (iobuf.in.pos == iobuf.raw_input_ends_before)
1646 iobuf.raw_input_ends_before = 0;
1648 /* The bytes at the "data" pointer will survive long
1649 * enough to make a copy, but not past future I/O. */
1650 memcpy(buf, data, siz);
1651 total_data_read += siz;
1653 if (forward_flist_data)
1654 write_buf(iobuf.out_fd, buf, siz);
1656 if (f == write_batch_monitor_in)
1657 safe_write(batch_fd, buf, siz);
1659 if ((len -= siz) == 0)
1665 void read_sbuf(int f, char *buf, size_t len)
1667 read_buf(f, buf, len);
1671 uchar read_byte(int f)
1674 read_buf(f, (char*)&c, 1);
1678 int read_vstring(int f, char *buf, int bufsize)
1680 int len = read_byte(f);
1683 len = (len & ~0x80) * 0x100 + read_byte(f);
1685 if (len >= bufsize) {
1686 rprintf(FERROR, "over-long vstring received (%d > %d)\n",
1692 read_buf(f, buf, len);
1697 /* Populate a sum_struct with values from the socket. This is
1698 * called by both the sender and the receiver. */
1699 void read_sum_head(int f, struct sum_struct *sum)
1701 int32 max_blength = protocol_version < 30 ? OLD_MAX_BLOCK_SIZE : MAX_BLOCK_SIZE;
1702 sum->count = read_int(f);
1703 if (sum->count < 0) {
1704 rprintf(FERROR, "Invalid checksum count %ld [%s]\n",
1705 (long)sum->count, who_am_i());
1706 exit_cleanup(RERR_PROTOCOL);
1708 sum->blength = read_int(f);
1709 if (sum->blength < 0 || sum->blength > max_blength) {
1710 rprintf(FERROR, "Invalid block length %ld [%s]\n",
1711 (long)sum->blength, who_am_i());
1712 exit_cleanup(RERR_PROTOCOL);
1714 sum->s2length = protocol_version < 27 ? csum_length : (int)read_int(f);
1715 if (sum->s2length < 0 || sum->s2length > MAX_DIGEST_LEN) {
1716 rprintf(FERROR, "Invalid checksum length %d [%s]\n",
1717 sum->s2length, who_am_i());
1718 exit_cleanup(RERR_PROTOCOL);
1720 sum->remainder = read_int(f);
1721 if (sum->remainder < 0 || sum->remainder > sum->blength) {
1722 rprintf(FERROR, "Invalid remainder length %ld [%s]\n",
1723 (long)sum->remainder, who_am_i());
1724 exit_cleanup(RERR_PROTOCOL);
1728 /* Send the values from a sum_struct over the socket. Set sum to
1729 * NULL if there are no checksums to send. This is called by both
1730 * the generator and the sender. */
1731 void write_sum_head(int f, struct sum_struct *sum)
1733 static struct sum_struct null_sum;
1738 write_int(f, sum->count);
1739 write_int(f, sum->blength);
1740 if (protocol_version >= 27)
1741 write_int(f, sum->s2length);
1742 write_int(f, sum->remainder);
1745 /* Sleep after writing to limit I/O bandwidth usage.
1747 * @todo Rather than sleeping after each write, it might be better to
1748 * use some kind of averaging. The current algorithm seems to always
1749 * use a bit less bandwidth than specified, because it doesn't make up
1750 * for slow periods. But arguably this is a feature. In addition, we
1751 * ought to take the time used to write the data into account.
1753 * During some phases of big transfers (file FOO is uptodate) this is
1754 * called with a small bytes_written every time. As the kernel has to
1755 * round small waits up to guarantee that we actually wait at least the
1756 * requested number of microseconds, this can become grossly inaccurate.
1757 * We therefore keep track of the bytes we've written over time and only
1758 * sleep when the accumulated delay is at least 1 tenth of a second. */
1759 static void sleep_for_bwlimit(int bytes_written)
1761 static struct timeval prior_tv;
1762 static long total_written = 0;
1763 struct timeval tv, start_tv;
1764 long elapsed_usec, sleep_usec;
1766 #define ONE_SEC 1000000L /* # of microseconds in a second */
1768 total_written += bytes_written;
1770 gettimeofday(&start_tv, NULL);
1771 if (prior_tv.tv_sec) {
1772 elapsed_usec = (start_tv.tv_sec - prior_tv.tv_sec) * ONE_SEC
1773 + (start_tv.tv_usec - prior_tv.tv_usec);
1774 total_written -= elapsed_usec * bwlimit / (ONE_SEC/1024);
1775 if (total_written < 0)
1779 sleep_usec = total_written * (ONE_SEC/1024) / bwlimit;
1780 if (sleep_usec < ONE_SEC / 10) {
1781 prior_tv = start_tv;
1785 tv.tv_sec = sleep_usec / ONE_SEC;
1786 tv.tv_usec = sleep_usec % ONE_SEC;
1787 select(0, NULL, NULL, NULL, &tv);
1789 gettimeofday(&prior_tv, NULL);
1790 elapsed_usec = (prior_tv.tv_sec - start_tv.tv_sec) * ONE_SEC
1791 + (prior_tv.tv_usec - start_tv.tv_usec);
1792 total_written = (sleep_usec - elapsed_usec) * bwlimit / (ONE_SEC/1024);
1795 void io_flush(int flush_it_all)
1797 if (iobuf.out.len > iobuf.out_empty_len) {
1798 if (flush_it_all) /* FULL_FLUSH: flush everything in the output buffers */
1799 perform_io(iobuf.out.size - iobuf.out_empty_len, PIO_NEED_OUTROOM);
1800 else /* NORMAL_FLUSH: flush at least 1 byte */
1801 perform_io(iobuf.out.size - iobuf.out.len + 1, PIO_NEED_OUTROOM);
1804 perform_io(iobuf.msg.size, PIO_NEED_MSGROOM);
1807 void write_shortint(int f, unsigned short x)
1811 b[1] = (char)(x >> 8);
1815 void write_int(int f, int32 x)
1822 void write_varint(int f, int32 x)
1830 while (cnt > 1 && b[cnt] == 0)
1832 bit = ((uchar)1<<(7-cnt+1));
1833 if (CVAL(b, cnt) >= bit) {
1837 *b = b[cnt] | ~(bit*2-1);
1841 write_buf(f, b, cnt);
1844 void write_varlong(int f, int64 x, uchar min_bytes)
1851 #if SIZEOF_INT64 >= 8
1852 SIVAL(b, 5, x >> 32);
1854 if (x <= 0x7FFFFFFF && x >= 0)
1855 memset(b + 5, 0, 4);
1857 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1858 exit_cleanup(RERR_UNSUPPORTED);
1862 while (cnt > min_bytes && b[cnt] == 0)
1864 bit = ((uchar)1<<(7-cnt+min_bytes));
1865 if (CVAL(b, cnt) >= bit) {
1868 } else if (cnt > min_bytes)
1869 *b = b[cnt] | ~(bit*2-1);
1873 write_buf(f, b, cnt);
1877 * Note: int64 may actually be a 32-bit type if ./configure couldn't find any
1878 * 64-bit types on this platform.
1880 void write_longint(int f, int64 x)
1882 char b[12], * const s = b+4;
1885 if (x <= 0x7FFFFFFF && x >= 0) {
1890 #if SIZEOF_INT64 < 8
1891 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1892 exit_cleanup(RERR_UNSUPPORTED);
1895 SIVAL(s, 4, x >> 32);
1896 write_buf(f, b, 12);
1900 void write_buf(int f, const char *buf, size_t len)
1904 if (f != iobuf.out_fd) {
1905 safe_write(f, buf, len);
1909 if (iobuf.out.size - iobuf.out.len < len)
1910 perform_io(len, PIO_NEED_OUTROOM);
1912 pos = iobuf.out.pos + iobuf.out.len; /* Must be set after any flushing. */
1913 if (pos >= iobuf.out.size)
1914 pos -= iobuf.out.size;
1916 /* Handle a split copy if we wrap around the end of the circular buffer. */
1917 if (pos >= iobuf.out.pos && (siz = iobuf.out.size - pos) < len) {
1918 memcpy(iobuf.out.buf + pos, buf, siz);
1919 memcpy(iobuf.out.buf, buf + siz, len - siz);
1921 memcpy(iobuf.out.buf + pos, buf, len);
1923 iobuf.out.len += len;
1924 total_data_written += len;
1927 if (f == write_batch_monitor_out)
1928 safe_write(batch_fd, buf, len);
1931 /* Write a string to the connection */
1932 void write_sbuf(int f, const char *buf)
1934 write_buf(f, buf, strlen(buf));
1937 void write_byte(int f, uchar c)
1939 write_buf(f, (char *)&c, 1);
1942 void write_vstring(int f, const char *str, int len)
1944 uchar lenbuf[3], *lb = lenbuf;
1949 "attempting to send over-long vstring (%d > %d)\n",
1951 exit_cleanup(RERR_PROTOCOL);
1953 *lb++ = len / 0x100 + 0x80;
1957 write_buf(f, (char*)lenbuf, lb - lenbuf + 1);
1959 write_buf(f, str, len);
1962 /* Send a file-list index using a byte-reduction method. */
1963 void write_ndx(int f, int32 ndx)
1965 static int32 prev_positive = -1, prev_negative = 1;
1966 int32 diff, cnt = 0;
1969 if (protocol_version < 30 || read_batch) {
1974 /* Send NDX_DONE as a single-byte 0 with no side effects. Send
1975 * negative nums as a positive after sending a leading 0xFF. */
1977 diff = ndx - prev_positive;
1978 prev_positive = ndx;
1979 } else if (ndx == NDX_DONE) {
1984 b[cnt++] = (char)0xFF;
1986 diff = ndx - prev_negative;
1987 prev_negative = ndx;
1990 /* A diff of 1 - 253 is sent as a one-byte diff; a diff of 254 - 32767
1991 * or 0 is sent as a 0xFE + a two-byte diff; otherwise we send 0xFE
1992 * & all 4 bytes of the (non-negative) num with the high-bit set. */
1993 if (diff < 0xFE && diff > 0)
1994 b[cnt++] = (char)diff;
1995 else if (diff < 0 || diff > 0x7FFF) {
1996 b[cnt++] = (char)0xFE;
1997 b[cnt++] = (char)((ndx >> 24) | 0x80);
1998 b[cnt++] = (char)ndx;
1999 b[cnt++] = (char)(ndx >> 8);
2000 b[cnt++] = (char)(ndx >> 16);
2002 b[cnt++] = (char)0xFE;
2003 b[cnt++] = (char)(diff >> 8);
2004 b[cnt++] = (char)diff;
2006 write_buf(f, b, cnt);
2009 /* Receive a file-list index using a byte-reduction method. */
2010 int32 read_ndx(int f)
2012 static int32 prev_positive = -1, prev_negative = 1;
2013 int32 *prev_ptr, num;
2016 if (protocol_version < 30)
2020 if (CVAL(b, 0) == 0xFF) {
2022 prev_ptr = &prev_negative;
2023 } else if (CVAL(b, 0) == 0)
2026 prev_ptr = &prev_positive;
2027 if (CVAL(b, 0) == 0xFE) {
2029 if (CVAL(b, 0) & 0x80) {
2030 b[3] = CVAL(b, 0) & ~0x80;
2032 read_buf(f, b+1, 2);
2035 num = (UVAL(b,0)<<8) + UVAL(b,1) + *prev_ptr;
2037 num = UVAL(b, 0) + *prev_ptr;
2039 if (prev_ptr == &prev_negative)
2044 /* Read a line of up to bufsiz-1 characters into buf. Strips
2045 * the (required) trailing newline and all carriage returns.
2046 * Returns 1 for success; 0 for I/O error or truncation. */
2047 int read_line_old(int fd, char *buf, size_t bufsiz)
2049 bufsiz--; /* leave room for the null */
2050 while (bufsiz > 0) {
2051 assert(fd != iobuf.in_fd);
2052 if (safe_read(fd, buf, 1) == 0)
2067 void io_printf(int fd, const char *format, ...)
2070 char buf[BIGPATHBUFLEN];
2073 va_start(ap, format);
2074 len = vsnprintf(buf, sizeof buf, format, ap);
2078 exit_cleanup(RERR_STREAMIO);
2080 if (len > (int)sizeof buf) {
2081 rprintf(FERROR, "io_printf() was too long for the buffer.\n");
2082 exit_cleanup(RERR_STREAMIO);
2085 write_sbuf(fd, buf);
2088 /* Setup for multiplexing a MSG_* stream with the data stream. */
2089 void io_start_multiplex_out(int fd)
2091 io_flush(FULL_FLUSH);
2093 if (msgs2stderr && DEBUG_GTE(IO, 2))
2094 rprintf(FINFO, "[%s] io_start_multiplex_out(%d)\n", who_am_i(), fd);
2096 iobuf.out_empty_len = 4; /* See also OUT_MULTIPLEXED */
2097 io_start_buffering_out(fd);
2099 iobuf.raw_data_header_pos = iobuf.out.pos + iobuf.out.len;
2103 /* Setup for multiplexing a MSG_* stream with the data stream. */
2104 void io_start_multiplex_in(int fd)
2106 if (msgs2stderr && DEBUG_GTE(IO, 2))
2107 rprintf(FINFO, "[%s] io_start_multiplex_in(%d)\n", who_am_i(), fd);
2109 iobuf.in_multiplexed = True; /* See also IN_MULTIPLEXED */
2110 io_start_buffering_in(fd);
2113 int io_end_multiplex_in(int mode)
2115 int ret = iobuf.in_multiplexed ? iobuf.in_fd : -1;
2117 if (msgs2stderr && DEBUG_GTE(IO, 2))
2118 rprintf(FINFO, "[%s] io_end_multiplex_in(mode=%d)\n", who_am_i(), mode);
2120 iobuf.in_multiplexed = False;
2121 if (mode == MPLX_SWITCHING)
2122 iobuf.raw_input_ends_before = 0;
2124 assert(iobuf.raw_input_ends_before == 0);
2125 if (mode != MPLX_TO_BUFFERED)
2126 io_end_buffering_in(mode);
2131 int io_end_multiplex_out(int mode)
2133 int ret = iobuf.out_empty_len ? iobuf.out_fd : -1;
2135 if (msgs2stderr && DEBUG_GTE(IO, 2))
2136 rprintf(FINFO, "[%s] io_end_multiplex_out(mode=%d)\n", who_am_i(), mode);
2138 if (mode != MPLX_TO_BUFFERED)
2139 io_end_buffering_out(mode);
2141 io_flush(FULL_FLUSH);
2144 iobuf.out_empty_len = 0;
2149 void start_write_batch(int fd)
2151 /* Some communication has already taken place, but we don't
2152 * enable batch writing until here so that we can write a
2153 * canonical record of the communication even though the
2154 * actual communication so far depends on whether a daemon
2156 write_int(batch_fd, protocol_version);
2157 if (protocol_version >= 30)
2158 write_byte(batch_fd, inc_recurse);
2159 write_int(batch_fd, checksum_seed);
2162 write_batch_monitor_out = fd;
2164 write_batch_monitor_in = fd;
2167 void stop_write_batch(void)
2169 write_batch_monitor_out = -1;
2170 write_batch_monitor_in = -1;