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;
42 extern int am_generator;
43 extern int msgs2stderr;
44 extern int inc_recurse;
48 extern int file_total;
49 extern int file_old_total;
51 extern int read_batch;
52 extern int protect_args;
53 extern int checksum_seed;
54 extern int protocol_version;
55 extern int remove_source_files;
56 extern int preserve_hard_links;
57 extern BOOL extra_flist_sending_enabled;
58 extern struct stats stats;
59 extern struct file_list *cur_flist;
61 extern int filesfrom_convert;
62 extern iconv_t ic_send, ic_recv;
65 int csum_length = SHORT_SUM_LENGTH; /* initial value */
67 int ignore_timeout = 0;
70 int forward_flist_data = 0;
71 BOOL flist_receiving_enabled = False;
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 /* Our I/O buffers are sized with no bits on in the lowest byte of the "size"
119 * (indeed, our rounding of sizes in 1024-byte units assures more than this).
120 * This allows the code that is storing bytes near the physical end of a
121 * circular buffer to temporarily reduce the buffer's size (in order to make
122 * some storing idioms easier), while also making it simple to restore the
123 * buffer's actual size when the buffer's "pos" wraps around to the start (we
124 * just round the buffer's size up again). */
126 #define IOBUF_WAS_REDUCED(siz) ((siz) & 0xFF)
127 #define IOBUF_RESTORE_SIZE(siz) (((siz) | 0xFF) + 1)
129 #define IN_MULTIPLEXED (iobuf.in_multiplexed != 0)
130 #define IN_MULTIPLEXED_AND_READY (iobuf.in_multiplexed > 0)
131 #define OUT_MULTIPLEXED (iobuf.out_empty_len != 0)
133 #define PIO_NEED_INPUT (1<<0) /* The *_NEED_* flags are mutually exclusive. */
134 #define PIO_NEED_OUTROOM (1<<1)
135 #define PIO_NEED_MSGROOM (1<<2)
137 #define PIO_CONSUME_INPUT (1<<4) /* Must becombined with PIO_NEED_INPUT. */
139 #define PIO_INPUT_AND_CONSUME (PIO_NEED_INPUT | PIO_CONSUME_INPUT)
140 #define PIO_NEED_FLAGS (PIO_NEED_INPUT | PIO_NEED_OUTROOM | PIO_NEED_MSGROOM)
142 #define REMOTE_OPTION_ERROR "rsync: on remote machine: -"
143 #define REMOTE_OPTION_ERROR2 ": unknown option"
145 #define FILESFROM_BUFLEN 2048
147 enum festatus { FES_SUCCESS, FES_REDO, FES_NO_SEND };
149 static flist_ndx_list redo_list, hlink_list;
151 static void read_a_msg(void);
152 static void drain_multiplex_messages(void);
153 static void sleep_for_bwlimit(int bytes_written);
155 static void check_timeout(void)
159 if (!io_timeout || ignore_timeout)
163 last_io_in = time(NULL);
169 if (t - last_io_in >= io_timeout) {
172 rprintf(FERROR, "[%s] io timeout after %d seconds -- exiting\n",
173 who_am_i(), (int)(t-last_io_in));
174 exit_cleanup(RERR_TIMEOUT);
178 /* It's almost always an error to get an EOF when we're trying to read from the
179 * network, because the protocol is (for the most part) self-terminating.
181 * There is one case for the receiver when it is at the end of the transfer
182 * (hanging around reading any keep-alive packets that might come its way): if
183 * the sender dies before the generator's kill-signal comes through, we can end
184 * up here needing to loop until the kill-signal arrives. In this situation,
185 * kluge_around_eof will be < 0.
187 * There is another case for older protocol versions (< 24) where the module
188 * listing was not terminated, so we must ignore an EOF error in that case and
189 * exit. In this situation, kluge_around_eof will be > 0. */
190 static NORETURN void whine_about_eof(BOOL allow_kluge)
192 if (kluge_around_eof && allow_kluge) {
194 if (kluge_around_eof > 0)
196 /* If we're still here after 10 seconds, exit with an error. */
197 for (i = 10*1000/20; i--; )
201 rprintf(FERROR, RSYNC_NAME ": connection unexpectedly closed "
202 "(%s bytes received so far) [%s]\n",
203 big_num(stats.total_read), who_am_i());
205 exit_cleanup(RERR_STREAMIO);
208 /* Do a safe read, handling any needed looping and error handling.
209 * Returns the count of the bytes read, which will only be different
210 * from "len" if we encountered an EOF. This routine is not used on
211 * the socket except very early in the transfer. */
212 static size_t safe_read(int fd, char *buf, size_t len)
217 assert(fd != iobuf.in_fd);
219 n = read(fd, buf, len);
220 if ((size_t)n == len || n == 0) {
221 if (DEBUG_GTE(IO, 2))
222 rprintf(FINFO, "[%s] safe_read(%d)=%ld\n", who_am_i(), fd, (long)n);
226 if (errno != EINTR && errno != EWOULDBLOCK && errno != EAGAIN) {
228 rsyserr(FERROR, errno, "safe_read failed to read %ld bytes [%s]",
229 (long)len, who_am_i());
230 exit_cleanup(RERR_STREAMIO);
245 tv.tv_sec = select_timeout;
248 cnt = select(fd+1, &r_fds, NULL, &e_fds, &tv);
250 if (cnt < 0 && errno == EBADF) {
251 rsyserr(FERROR, errno, "safe_read select failed [%s]",
253 exit_cleanup(RERR_FILEIO);
259 /*if (FD_ISSET(fd, &e_fds))
260 rprintf(FINFO, "select exception on fd %d\n", fd); */
262 if (FD_ISSET(fd, &r_fds)) {
263 n = read(fd, buf + got, len - got);
264 if (DEBUG_GTE(IO, 2))
265 rprintf(FINFO, "[%s] safe_read(%d)=%ld\n", who_am_i(), fd, (long)n);
273 if ((got += (size_t)n) == len)
281 static const char *what_fd_is(int fd)
285 if (fd == sock_f_out)
287 else if (fd == iobuf.out_fd)
289 else if (fd == batch_fd)
292 snprintf(buf, sizeof buf, "fd %d", fd);
297 /* Do a safe write, handling any needed looping and error handling.
298 * Returns only if everything was successfully written. This routine
299 * is not used on the socket except very early in the transfer. */
300 static void safe_write(int fd, const char *buf, size_t len)
304 assert(fd != iobuf.out_fd);
306 n = write(fd, buf, len);
307 if ((size_t)n == len)
310 if (errno != EINTR && errno != EWOULDBLOCK && errno != EAGAIN) {
312 rsyserr(FERROR, errno,
313 "safe_write failed to write %ld bytes to %s [%s]",
314 (long)len, what_fd_is(fd), who_am_i());
315 exit_cleanup(RERR_STREAMIO);
329 tv.tv_sec = select_timeout;
332 cnt = select(fd + 1, NULL, &w_fds, NULL, &tv);
334 if (cnt < 0 && errno == EBADF) {
335 rsyserr(FERROR, errno, "safe_write select failed on %s [%s]",
336 what_fd_is(fd), who_am_i());
337 exit_cleanup(RERR_FILEIO);
343 if (FD_ISSET(fd, &w_fds)) {
344 n = write(fd, buf, len);
356 /* This is only called when files-from data is known to be available. We read
357 * a chunk of data and put it into the output buffer. */
358 static void forward_filesfrom_data(void)
362 len = read(ff_forward_fd, ff_xb.buf + ff_xb.len, ff_xb.size - ff_xb.len);
364 if (len == 0 || errno != EINTR) {
365 /* Send end-of-file marker */
367 write_buf(iobuf.out_fd, "\0\0", ff_lastchar ? 2 : 1);
369 if (ff_reenable_multiplex >= 0)
370 io_start_multiplex_out(ff_reenable_multiplex);
375 if (DEBUG_GTE(IO, 2))
376 rprintf(FINFO, "[%s] files-from read=%ld\n", who_am_i(), (long)len);
383 char *s = ff_xb.buf + len;
384 /* Transform CR and/or LF into '\0' */
385 while (s-- > ff_xb.buf) {
386 if (*s == '\n' || *s == '\r')
395 /* Last buf ended with a '\0', so don't let this buf start with one. */
396 while (len && *s == '\0')
398 ff_xb.pos = s - ff_xb.buf;
402 if (filesfrom_convert && len) {
403 char *sob = ff_xb.buf + ff_xb.pos, *s = sob;
404 char *eob = sob + len;
405 int flags = ICB_INCLUDE_BAD | ICB_INCLUDE_INCOMPLETE | ICB_CIRCULAR_OUT;
406 if (ff_lastchar == '\0')
408 /* Convert/send each null-terminated string separately, skipping empties. */
411 ff_xb.len = s - sob - 1;
412 if (iconvbufs(ic_send, &ff_xb, &iobuf.out, flags) < 0)
413 exit_cleanup(RERR_PROTOCOL); /* impossible? */
414 write_buf(iobuf.out_fd, s-1, 1); /* Send the '\0'. */
415 while (s != eob && *s == '\0')
418 ff_xb.pos = sob - ff_xb.buf;
423 if ((ff_xb.len = s - sob) == 0)
426 /* Handle a partial string specially, saving any incomplete chars. */
427 flags &= ~ICB_INCLUDE_INCOMPLETE;
428 if (iconvbufs(ic_send, &ff_xb, &iobuf.out, flags) < 0) {
430 exit_cleanup(RERR_PROTOCOL); /* impossible? */
432 memmove(ff_xb.buf, ff_xb.buf + ff_xb.pos, ff_xb.len);
434 ff_lastchar = 'x'; /* Anything non-zero. */
440 char *f = ff_xb.buf + ff_xb.pos;
443 /* Eliminate any multi-'\0' runs. */
445 if (!(*t++ = *f++)) {
446 while (f != eob && *f == '\0')
451 if ((len = t - ff_xb.buf) != 0) {
452 /* This will not circle back to perform_io() because we only get
453 * called when there is plenty of room in the output buffer. */
454 write_buf(iobuf.out_fd, ff_xb.buf, len);
459 void reduce_iobuf_size(xbuf *out, size_t new_size)
461 if (new_size < out->size) {
462 if (DEBUG_GTE(IO, 4)) {
463 const char *name = out == &iobuf.out ? "iobuf.out"
464 : out == &iobuf.msg ? "iobuf.msg"
467 rprintf(FINFO, "[%s] reduced size of %s (-%d)\n",
468 who_am_i(), name, (int)(out->size - new_size));
471 out->size = new_size;
475 void restore_iobuf_size(xbuf *out)
477 if (IOBUF_WAS_REDUCED(out->size)) {
478 size_t new_size = IOBUF_RESTORE_SIZE(out->size);
479 if (DEBUG_GTE(IO, 4)) {
480 const char *name = out == &iobuf.out ? "iobuf.out"
481 : out == &iobuf.msg ? "iobuf.msg"
484 rprintf(FINFO, "[%s] restored size of %s (+%d)\n",
485 who_am_i(), name, (int)(new_size - out->size));
488 out->size = new_size;
492 /* Perform buffered input and/or output until specified conditions are met.
493 * When given a "needed" read or write request, this returns without doing any
494 * I/O if the needed input bytes or write space is already available. Once I/O
495 * is needed, this will try to do whatever reading and/or writing is currently
496 * possible, up to the maximum buffer allowances, no matter if this is a read
497 * or write request. However, the I/O stops as soon as the required input
498 * bytes or output space is available. If this is not a read request, the
499 * routine may also do some advantageous reading of messages from a multiplexed
500 * input source (which ensures that we don't jam up with everyone in their
501 * "need to write" code and nobody reading the accumulated data that would make
504 * The iobuf.in, .out and .msg buffers are all circular. Callers need to be
505 * aware that some data copies will need to be split when the bytes wrap around
506 * from the end to the start. In order to help make writing into the output
507 * buffers easier for some operations (such as the use of SIVAL() into the
508 * buffer) a buffer may be temporarily shortened by a small amount, but the
509 * original size will be automatically restored when the .pos wraps to the
510 * start. See also the 3 raw_* iobuf vars that are used in the handling of
511 * MSG_DATA bytes as they are read-from/written-into the buffers.
513 * When writing, we flush data in the following priority order:
515 * 1. Finish writing any in-progress MSG_DATA sequence from iobuf.out.
517 * 2. Write out all the messages from the message buf (if iobuf.msg is active).
518 * Yes, this means that a PIO_NEED_OUTROOM call will completely flush any
519 * messages before getting to the iobuf.out flushing (except for rule 1).
521 * 3. Write out the raw data from iobuf.out, possibly filling in the multiplexed
522 * MSG_DATA header that was pre-allocated (when output is multiplexed).
524 * TODO: items for possible future work:
526 * - Make this routine able to read the generator-to-receiver batch flow?
528 * Unlike the old routines that this replaces, it is OK to read ahead as far as
529 * we can because the read_a_msg() routine now reads its bytes out of the input
530 * buffer. In the old days, only raw data was in the input buffer, and any
531 * unused raw data in the buf would prevent the reading of socket data. */
532 static char *perform_io(size_t needed, int flags)
534 fd_set r_fds, e_fds, w_fds;
537 size_t empty_buf_len = 0;
541 if (iobuf.in.len == 0 && iobuf.in.pos != 0) {
542 if (iobuf.raw_input_ends_before)
543 iobuf.raw_input_ends_before -= iobuf.in.pos;
547 switch (flags & PIO_NEED_FLAGS) {
549 /* We never resize the circular input buffer. */
550 if (iobuf.in.size < needed) {
551 rprintf(FERROR, "need to read %ld bytes, iobuf.in.buf is only %ld bytes.\n",
552 (long)needed, (long)iobuf.in.size);
553 exit_cleanup(RERR_PROTOCOL);
556 if (DEBUG_GTE(IO, 3)) {
557 rprintf(FINFO, "[%s] perform_io(%ld, %sinput)\n",
558 who_am_i(), (long)needed, flags & PIO_CONSUME_INPUT ? "consume&" : "");
562 case PIO_NEED_OUTROOM:
563 /* We never resize the circular output buffer. */
564 if (iobuf.out.size - iobuf.out_empty_len < needed) {
565 fprintf(stderr, "need to write %ld bytes, iobuf.out.buf is only %ld bytes.\n",
566 (long)needed, (long)(iobuf.out.size - iobuf.out_empty_len));
567 exit_cleanup(RERR_PROTOCOL);
570 if (DEBUG_GTE(IO, 3)) {
571 rprintf(FINFO, "[%s] perform_io(%ld, outroom) needs to flush %ld\n",
572 who_am_i(), (long)needed,
573 iobuf.out.len + needed > iobuf.out.size
574 ? (long)(iobuf.out.len + needed - iobuf.out.size) : 0L);
578 case PIO_NEED_MSGROOM:
579 /* We never resize the circular message buffer. */
580 if (iobuf.msg.size < needed) {
581 fprintf(stderr, "need to write %ld bytes, iobuf.msg.buf is only %ld bytes.\n",
582 (long)needed, (long)iobuf.msg.size);
583 exit_cleanup(RERR_PROTOCOL);
586 if (DEBUG_GTE(IO, 3)) {
587 rprintf(FINFO, "[%s] perform_io(%ld, msgroom) needs to flush %ld\n",
588 who_am_i(), (long)needed,
589 iobuf.msg.len + needed > iobuf.msg.size
590 ? (long)(iobuf.msg.len + needed - iobuf.msg.size) : 0L);
595 if (DEBUG_GTE(IO, 3))
596 rprintf(FINFO, "[%s] perform_io(%ld, %d)\n", who_am_i(), (long)needed, flags);
600 exit_cleanup(RERR_UNSUPPORTED);
604 switch (flags & PIO_NEED_FLAGS) {
606 if (iobuf.in.len >= needed)
609 case PIO_NEED_OUTROOM:
610 /* Note that iobuf.out_empty_len doesn't factor into this check
611 * because iobuf.out.len already holds any needed header len. */
612 if (iobuf.out.len + needed <= iobuf.out.size)
615 case PIO_NEED_MSGROOM:
616 if (iobuf.msg.len + needed <= iobuf.msg.size)
625 if (iobuf.in_fd >= 0 && iobuf.in.size - iobuf.in.len) {
626 if (!read_batch || batch_fd >= 0) {
627 FD_SET(iobuf.in_fd, &r_fds);
628 FD_SET(iobuf.in_fd, &e_fds);
630 if (iobuf.in_fd > max_fd)
631 max_fd = iobuf.in_fd;
634 /* Only do more filesfrom processing if there is enough room in the out buffer. */
635 if (ff_forward_fd >= 0 && iobuf.out.size - iobuf.out.len > FILESFROM_BUFLEN*2) {
636 FD_SET(ff_forward_fd, &r_fds);
637 if (ff_forward_fd > max_fd)
638 max_fd = ff_forward_fd;
642 if (iobuf.out_fd >= 0) {
643 if (iobuf.raw_flushing_ends_before
644 || (!iobuf.msg.len && iobuf.out.len > iobuf.out_empty_len && !(flags & PIO_NEED_MSGROOM))) {
645 if (OUT_MULTIPLEXED && !iobuf.raw_flushing_ends_before) {
646 /* The iobuf.raw_flushing_ends_before value can point off the end
647 * of the iobuf.out buffer for a while, for easier subtracting. */
648 iobuf.raw_flushing_ends_before = iobuf.out.pos + iobuf.out.len;
650 SIVAL(iobuf.out.buf + iobuf.raw_data_header_pos, 0,
651 ((MPLEX_BASE + (int)MSG_DATA)<<24) + iobuf.out.len - 4);
653 if (DEBUG_GTE(IO, 1)) {
654 rprintf(FINFO, "[%s] send_msg(%d, %ld)\n",
655 who_am_i(), (int)MSG_DATA, (long)iobuf.out.len - 4);
658 /* reserve room for the next MSG_DATA header */
659 iobuf.raw_data_header_pos = iobuf.raw_flushing_ends_before;
660 if (iobuf.raw_data_header_pos >= iobuf.out.size)
661 iobuf.raw_data_header_pos -= iobuf.out.size;
662 else if (iobuf.raw_data_header_pos + 4 > iobuf.out.size) {
663 /* The 4-byte header won't fit at the end of the buffer,
664 * so we'll temporarily reduce the output buffer's size
665 * and put the header at the start of the buffer. */
666 reduce_iobuf_size(&iobuf.out, iobuf.raw_data_header_pos);
667 iobuf.raw_data_header_pos = 0;
669 /* Yes, it is possible for this to make len > size for a while. */
673 empty_buf_len = iobuf.out_empty_len;
675 } else if (iobuf.msg.len) {
681 FD_SET(iobuf.out_fd, &w_fds);
682 if (iobuf.out_fd > max_fd)
683 max_fd = iobuf.out_fd;
689 switch (flags & PIO_NEED_FLAGS) {
692 if (kluge_around_eof == 2)
694 if (iobuf.in_fd == -2)
695 whine_about_eof(True);
696 rprintf(FERROR, "error in perform_io: no fd for input.\n");
697 exit_cleanup(RERR_PROTOCOL);
698 case PIO_NEED_OUTROOM:
699 case PIO_NEED_MSGROOM:
701 drain_multiplex_messages();
702 if (iobuf.out_fd == -2)
703 whine_about_eof(True);
704 rprintf(FERROR, "error in perform_io: no fd for output.\n");
705 exit_cleanup(RERR_PROTOCOL);
707 /* No stated needs, so I guess this is OK. */
713 if (extra_flist_sending_enabled) {
714 if (file_total - file_old_total < MAX_FILECNT_LOOKAHEAD)
717 extra_flist_sending_enabled = False;
718 tv.tv_sec = select_timeout;
721 tv.tv_sec = select_timeout;
724 cnt = select(max_fd + 1, &r_fds, &w_fds, &e_fds, &tv);
727 if (cnt < 0 && errno == EBADF) {
729 exit_cleanup(RERR_SOCKETIO);
731 if (extra_flist_sending_enabled) {
732 extra_flist_sending_enabled = False;
733 send_extra_file_list(sock_f_out, -1);
734 extra_flist_sending_enabled = !flist_eof;
737 FD_ZERO(&r_fds); /* Just in case... */
741 if (iobuf.in_fd >= 0 && FD_ISSET(iobuf.in_fd, &r_fds)) {
742 size_t len, pos = iobuf.in.pos + iobuf.in.len;
744 if (pos >= iobuf.in.size) {
745 pos -= iobuf.in.size;
746 len = iobuf.in.size - iobuf.in.len;
748 len = iobuf.in.size - pos;
749 if ((n = read(iobuf.in_fd, iobuf.in.buf + pos, len)) <= 0) {
751 /* Signal that input has become invalid. */
752 if (!read_batch || batch_fd < 0 || am_generator)
757 if (errno == EINTR || errno == EWOULDBLOCK || errno == EAGAIN)
760 /* Don't write errors on a dead socket. */
761 if (iobuf.in_fd == sock_f_in) {
764 rsyserr(FERROR_SOCKET, errno, "read error");
766 rsyserr(FERROR, errno, "read error");
767 exit_cleanup(RERR_SOCKETIO);
770 if (msgs2stderr && DEBUG_GTE(IO, 2))
771 rprintf(FINFO, "[%s] recv=%ld\n", who_am_i(), (long)n);
774 last_io_in = time(NULL);
775 stats.total_read += n;
780 if (out && FD_ISSET(iobuf.out_fd, &w_fds)) {
781 size_t len = iobuf.raw_flushing_ends_before ? iobuf.raw_flushing_ends_before - out->pos : out->len;
784 if (bwlimit_writemax && len > bwlimit_writemax)
785 len = bwlimit_writemax;
787 if (out->pos + len > out->size)
788 len = out->size - out->pos;
789 if ((n = write(iobuf.out_fd, out->buf + out->pos, len)) <= 0) {
790 if (errno == EINTR || errno == EWOULDBLOCK || errno == EAGAIN)
793 /* Don't write errors on a dead socket. */
796 iobuf.out.len = iobuf.msg.len = iobuf.raw_flushing_ends_before = 0;
797 rsyserr(FERROR_SOCKET, errno, "[%s] write error", who_am_i());
798 drain_multiplex_messages();
799 exit_cleanup(RERR_SOCKETIO);
802 if (msgs2stderr && DEBUG_GTE(IO, 2)) {
803 rprintf(FINFO, "[%s] %s sent=%ld\n",
804 who_am_i(), out == &iobuf.out ? "out" : "msg", (long)n);
808 last_io_out = time(NULL);
809 stats.total_written += n;
811 if (bwlimit_writemax)
812 sleep_for_bwlimit(n);
814 if ((out->pos += n) == out->size) {
815 if (iobuf.raw_flushing_ends_before)
816 iobuf.raw_flushing_ends_before -= out->size;
818 restore_iobuf_size(out);
819 } else if (out->pos == iobuf.raw_flushing_ends_before)
820 iobuf.raw_flushing_ends_before = 0;
821 if ((out->len -= n) == empty_buf_len) {
823 restore_iobuf_size(out);
825 iobuf.raw_data_header_pos = 0;
829 /* We need to help prevent deadlock by doing what reading
830 * we can whenever we are here trying to write. */
831 if (IN_MULTIPLEXED_AND_READY && !(flags & PIO_NEED_INPUT)) {
832 while (!iobuf.raw_input_ends_before && iobuf.in.len > 512)
834 if (flist_receiving_enabled && iobuf.in.len > 512)
835 wait_for_receiver(); /* generator only */
838 if (ff_forward_fd >= 0 && FD_ISSET(ff_forward_fd, &r_fds)) {
839 /* This can potentially flush all output and enable
840 * multiplexed output, so keep this last in the loop
841 * and be sure to not cache anything that would break
843 forward_filesfrom_data();
848 data = iobuf.in.buf + iobuf.in.pos;
850 if (flags & PIO_CONSUME_INPUT) {
851 iobuf.in.len -= needed;
852 iobuf.in.pos += needed;
853 if (iobuf.in.pos == iobuf.raw_input_ends_before)
854 iobuf.raw_input_ends_before = 0;
855 if (iobuf.in.pos >= iobuf.in.size) {
856 iobuf.in.pos -= iobuf.in.size;
857 if (iobuf.raw_input_ends_before)
858 iobuf.raw_input_ends_before -= iobuf.in.size;
865 static void raw_read_buf(char *buf, size_t len)
867 size_t pos = iobuf.in.pos;
868 char *data = perform_io(len, PIO_INPUT_AND_CONSUME);
869 if (iobuf.in.pos <= pos && len) {
870 size_t siz = len - iobuf.in.pos;
871 memcpy(buf, data, siz);
872 memcpy(buf + siz, iobuf.in.buf, iobuf.in.pos);
874 memcpy(buf, data, len);
877 static int32 raw_read_int(void)
880 if (iobuf.in.size - iobuf.in.pos >= 4)
881 data = perform_io(4, PIO_INPUT_AND_CONSUME);
883 raw_read_buf(data = buf, 4);
884 return IVAL(data, 0);
887 void noop_io_until_death(void)
891 kluge_around_eof = 2;
892 /* Setting an I/O timeout ensures that if something inexplicably weird
893 * happens, we won't hang around forever. */
898 read_buf(iobuf.in_fd, buf, sizeof buf);
901 /* Buffer a message for the multiplexed output stream. Is not used for (normal) MSG_DATA. */
902 int send_msg(enum msgcode code, const char *buf, size_t len, int convert)
906 BOOL want_debug = DEBUG_GTE(IO, 1) && convert >= 0 && (msgs2stderr || code != MSG_INFO);
908 if (!OUT_MULTIPLEXED)
912 rprintf(FINFO, "[%s] send_msg(%d, %ld)\n", who_am_i(), (int)code, (long)len);
914 /* When checking for enough free space for this message, we need to
915 * make sure that there is space for the 4-byte header, plus we'll
916 * assume that we may waste up to 3 bytes (if the header doesn't fit
917 * at the physical end of the buffer). */
919 if (convert > 0 && ic_send == (iconv_t)-1)
922 /* Ensuring double-size room leaves space for maximal conversion expansion. */
923 needed = len*2 + 4 + 3;
926 needed = len + 4 + 3;
927 if (iobuf.msg.len + needed > iobuf.msg.size)
928 perform_io(needed, PIO_NEED_MSGROOM);
930 pos = iobuf.msg.pos + iobuf.msg.len; /* Must be set after any flushing. */
931 if (pos >= iobuf.msg.size)
932 pos -= iobuf.msg.size;
933 else if (pos + 4 > iobuf.msg.size) {
934 /* The 4-byte header won't fit at the end of the buffer,
935 * so we'll temporarily reduce the message buffer's size
936 * and put the header at the start of the buffer. */
937 reduce_iobuf_size(&iobuf.msg, pos);
940 hdr = iobuf.msg.buf + pos;
942 iobuf.msg.len += 4; /* Allocate room for the coming header bytes. */
948 INIT_XBUF(inbuf, (char*)buf, len, (size_t)-1);
951 iconvbufs(ic_send, &inbuf, &iobuf.msg,
952 ICB_INCLUDE_BAD | ICB_INCLUDE_INCOMPLETE | ICB_CIRCULAR_OUT | ICB_INIT);
954 rprintf(FERROR, "overflowed iobuf.msg buffer in send_msg");
955 exit_cleanup(RERR_UNSUPPORTED);
957 len = iobuf.msg.len - len;
963 if ((pos += 4) == iobuf.msg.size)
966 /* Handle a split copy if we wrap around the end of the circular buffer. */
967 if (pos >= iobuf.msg.pos && (siz = iobuf.msg.size - pos) < len) {
968 memcpy(iobuf.msg.buf + pos, buf, siz);
969 memcpy(iobuf.msg.buf, buf + siz, len - siz);
971 memcpy(iobuf.msg.buf + pos, buf, len);
973 iobuf.msg.len += len;
976 SIVAL(hdr, 0, ((MPLEX_BASE + (int)code)<<24) + len);
978 if (want_debug && convert > 0)
979 rprintf(FINFO, "[%s] converted msg len=%ld\n", who_am_i(), (long)len);
984 void send_msg_int(enum msgcode code, int num)
988 if (DEBUG_GTE(IO, 1))
989 rprintf(FINFO, "[%s] send_msg_int(%d, %d)\n", who_am_i(), (int)code, num);
991 SIVAL(numbuf, 0, num);
992 send_msg(code, numbuf, 4, -1);
995 static void got_flist_entry_status(enum festatus status, int ndx)
997 struct file_list *flist = flist_for_ndx(ndx, "got_flist_entry_status");
999 if (remove_source_files) {
1001 active_bytecnt -= F_LENGTH(flist->files[ndx - flist->ndx_start]);
1005 flist->in_progress--;
1009 if (remove_source_files)
1010 send_msg_int(MSG_SUCCESS, ndx);
1011 if (preserve_hard_links) {
1012 struct file_struct *file = flist->files[ndx - flist->ndx_start];
1013 if (F_IS_HLINKED(file)) {
1014 flist_ndx_push(&hlink_list, ndx);
1015 flist->in_progress++;
1022 flist->in_progress++;
1027 flist_ndx_push(&redo_list, ndx);
1034 /* Note the fds used for the main socket (which might really be a pipe
1035 * for a local transfer, but we can ignore that). */
1036 void io_set_sock_fds(int f_in, int f_out)
1042 void set_io_timeout(int secs)
1046 if (!io_timeout || io_timeout > SELECT_TIMEOUT)
1047 select_timeout = SELECT_TIMEOUT;
1049 select_timeout = io_timeout;
1051 allowed_lull = read_batch ? 0 : (io_timeout + 1) / 2;
1054 static void check_for_d_option_error(const char *msg)
1056 static char rsync263_opts[] = "BCDHIKLPRSTWabceghlnopqrtuvxz";
1061 || strncmp(msg, REMOTE_OPTION_ERROR, sizeof REMOTE_OPTION_ERROR - 1) != 0)
1064 msg += sizeof REMOTE_OPTION_ERROR - 1;
1065 if (*msg == '-' || (colon = strchr(msg, ':')) == NULL
1066 || strncmp(colon, REMOTE_OPTION_ERROR2, sizeof REMOTE_OPTION_ERROR2 - 1) != 0)
1069 for ( ; *msg != ':'; msg++) {
1072 else if (*msg == 'e')
1074 else if (strchr(rsync263_opts, *msg) == NULL)
1080 "*** Try using \"--old-d\" if remote rsync is <= 2.6.3 ***\n");
1084 /* This is used by the generator to limit how many file transfers can
1085 * be active at once when --remove-source-files is specified. Without
1086 * this, sender-side deletions were mostly happening at the end. */
1087 void increment_active_files(int ndx, int itemizing, enum logcode code)
1090 /* TODO: tune these limits? */
1091 int limit = active_bytecnt >= 128*1024 ? 10 : 50;
1092 if (active_filecnt < limit)
1094 check_for_finished_files(itemizing, code, 0);
1095 if (active_filecnt < limit)
1097 wait_for_receiver();
1101 active_bytecnt += F_LENGTH(cur_flist->files[ndx - cur_flist->ndx_start]);
1104 int get_redo_num(void)
1106 return flist_ndx_pop(&redo_list);
1109 int get_hlink_num(void)
1111 return flist_ndx_pop(&hlink_list);
1114 /* When we're the receiver and we have a local --files-from list of names
1115 * that needs to be sent over the socket to the sender, we have to do two
1116 * things at the same time: send the sender a list of what files we're
1117 * processing and read the incoming file+info list from the sender. We do
1118 * this by making recv_file_list() call forward_filesfrom_data(), which
1119 * will ensure that we forward data to the sender until we get some data
1120 * for recv_file_list() to use. */
1121 void start_filesfrom_forwarding(int fd)
1123 if (protocol_version < 31 && OUT_MULTIPLEXED) {
1124 /* Older protocols send the files-from data w/o packaging
1125 * it in multiplexed I/O packets, so temporarily switch
1126 * to buffered I/O to match this behavior. */
1127 iobuf.msg.pos = iobuf.msg.len = 0; /* Be extra sure no messages go out. */
1128 ff_reenable_multiplex = io_end_multiplex_out(MPLX_TO_BUFFERED);
1132 alloc_xbuf(&ff_xb, FILESFROM_BUFLEN);
1135 /* Read a line into the "buf" buffer. */
1136 int read_line(int fd, char *buf, size_t bufsiz, int flags)
1141 if (flags & RL_CONVERT && iconv_buf.size < bufsiz)
1142 realloc_xbuf(&iconv_buf, bufsiz + 1024);
1147 s = flags & RL_CONVERT ? iconv_buf.buf : buf;
1151 eob = s + bufsiz - 1;
1153 /* We avoid read_byte() for files because files can return an EOF. */
1154 if (fd == iobuf.in_fd)
1156 else if (safe_read(fd, &ch, 1) == 0)
1158 if (flags & RL_EOL_NULLS ? ch == '\0' : (ch == '\r' || ch == '\n')) {
1159 /* Skip empty lines if dumping comments. */
1160 if (flags & RL_DUMP_COMMENTS && s == buf)
1169 if (flags & RL_DUMP_COMMENTS && (*buf == '#' || *buf == ';'))
1173 if (flags & RL_CONVERT) {
1175 INIT_XBUF(outbuf, buf, 0, bufsiz);
1177 iconv_buf.len = s - iconv_buf.buf;
1178 iconvbufs(ic_recv, &iconv_buf, &outbuf,
1179 ICB_INCLUDE_BAD | ICB_INCLUDE_INCOMPLETE | ICB_INIT);
1180 outbuf.buf[outbuf.len] = '\0';
1188 void read_args(int f_in, char *mod_name, char *buf, size_t bufsiz, int rl_nulls,
1189 char ***argv_p, int *argc_p, char **request_p)
1191 int maxargs = MAX_ARGS;
1195 int rl_flags = (rl_nulls ? RL_EOL_NULLS : 0);
1198 rl_flags |= (protect_args && ic_recv != (iconv_t)-1 ? RL_CONVERT : 0);
1201 if (!(argv = new_array(char *, maxargs)))
1202 out_of_memory("read_args");
1203 if (mod_name && !protect_args)
1204 argv[argc++] = "rsyncd";
1207 if (read_line(f_in, buf, bufsiz, rl_flags) == 0)
1210 if (argc == maxargs-1) {
1211 maxargs += MAX_ARGS;
1212 if (!(argv = realloc_array(argv, char *, maxargs)))
1213 out_of_memory("read_args");
1218 *request_p = strdup(buf);
1222 glob_expand_module(mod_name, buf, &argv, &argc, &maxargs);
1224 glob_expand(buf, &argv, &argc, &maxargs);
1226 if (!(p = strdup(buf)))
1227 out_of_memory("read_args");
1229 if (*p == '.' && p[1] == '\0')
1235 glob_expand(NULL, NULL, NULL, NULL);
1241 BOOL io_start_buffering_out(int f_out)
1243 if (msgs2stderr && DEBUG_GTE(IO, 2))
1244 rprintf(FINFO, "[%s] io_start_buffering_out(%d)\n", who_am_i(), f_out);
1246 if (iobuf.out.buf) {
1247 if (iobuf.out_fd == -1)
1248 iobuf.out_fd = f_out;
1250 assert(f_out == iobuf.out_fd);
1254 alloc_xbuf(&iobuf.out, ROUND_UP_1024(IO_BUFFER_SIZE * 2));
1255 iobuf.out_fd = f_out;
1260 BOOL io_start_buffering_in(int f_in)
1262 if (msgs2stderr && DEBUG_GTE(IO, 2))
1263 rprintf(FINFO, "[%s] io_start_buffering_in(%d)\n", who_am_i(), f_in);
1266 if (iobuf.in_fd == -1)
1269 assert(f_in == iobuf.in_fd);
1273 alloc_xbuf(&iobuf.in, ROUND_UP_1024(IO_BUFFER_SIZE));
1279 void io_end_buffering_in(BOOL free_buffers)
1281 if (msgs2stderr && DEBUG_GTE(IO, 2)) {
1282 rprintf(FINFO, "[%s] io_end_buffering_in(IOBUF_%s_BUFS)\n",
1283 who_am_i(), free_buffers ? "FREE" : "KEEP");
1287 free_xbuf(&iobuf.in);
1289 iobuf.in.pos = iobuf.in.len = 0;
1294 void io_end_buffering_out(BOOL free_buffers)
1296 if (msgs2stderr && DEBUG_GTE(IO, 2)) {
1297 rprintf(FINFO, "[%s] io_end_buffering_out(IOBUF_%s_BUFS)\n",
1298 who_am_i(), free_buffers ? "FREE" : "KEEP");
1301 io_flush(FULL_FLUSH);
1304 free_xbuf(&iobuf.out);
1305 free_xbuf(&iobuf.msg);
1311 void maybe_flush_socket(int important)
1313 if (flist_eof && iobuf.out.buf && iobuf.out.len > iobuf.out_empty_len
1314 && (important || time(NULL) - last_io_out >= 5))
1315 io_flush(NORMAL_FLUSH);
1318 /* This never adds new non-msg-buffer data, since we don't know the state
1319 * of the raw-data buffer. */
1320 void maybe_send_keepalive(void)
1322 if (time(NULL) - last_io_out >= allowed_lull) {
1323 if (!iobuf.msg.len && iobuf.out.len == iobuf.out_empty_len) {
1324 if (protocol_version >= 30)
1325 send_msg(MSG_NOOP, "", 0, 0);
1327 send_msg(MSG_DATA, "", 0, 0);
1330 perform_io(iobuf.msg.size - iobuf.msg.len + 1, PIO_NEED_MSGROOM);
1331 else if (iobuf.out.len > iobuf.out_empty_len)
1332 io_flush(NORMAL_FLUSH);
1336 void start_flist_forward(int ndx)
1338 write_int(iobuf.out_fd, ndx);
1339 forward_flist_data = 1;
1342 void stop_flist_forward(void)
1344 forward_flist_data = 0;
1347 /* Read a message from a multiplexed source. */
1348 static void read_a_msg(void)
1350 char data[BIGPATHBUFLEN];
1354 /* This ensures that perform_io() does not try to do any message reading
1355 * until we've read all of the data for this message. We should also
1356 * try to avoid calling things that will cause data to be written via
1357 * perform_io() prior to this being reset to 1. */
1358 iobuf.in_multiplexed = -1;
1360 tag = raw_read_int();
1362 msg_bytes = tag & 0xFFFFFF;
1363 tag = (tag >> 24) - MPLEX_BASE;
1365 if (DEBUG_GTE(IO, 1) && msgs2stderr)
1366 rprintf(FINFO, "[%s] got msg=%d, len=%ld\n", who_am_i(), (int)tag, (long)msg_bytes);
1370 assert(iobuf.raw_input_ends_before == 0);
1371 /* Though this does not yet read the data, we do mark where in
1372 * the buffer the msg data will end once it is read. It is
1373 * possible that this points off the end of the buffer, in
1374 * which case the gradual reading of the input stream will
1375 * cause this value to wrap around and eventually become real. */
1377 iobuf.raw_input_ends_before = iobuf.in.pos + msg_bytes;
1378 iobuf.in_multiplexed = 1;
1381 if (msg_bytes != sizeof stats.total_read || !am_generator)
1383 raw_read_buf((char*)&stats.total_read, sizeof stats.total_read);
1384 iobuf.in_multiplexed = 1;
1387 if (msg_bytes != 4 || !am_generator)
1389 val = raw_read_int();
1390 iobuf.in_multiplexed = 1;
1391 got_flist_entry_status(FES_REDO, val);
1394 if (msg_bytes != 4 || am_sender)
1396 val = raw_read_int();
1397 iobuf.in_multiplexed = 1;
1400 send_msg_int(MSG_IO_ERROR, val);
1402 case MSG_IO_TIMEOUT:
1403 if (msg_bytes != 4 || am_server || am_generator)
1405 val = raw_read_int();
1406 iobuf.in_multiplexed = 1;
1407 if (!io_timeout || io_timeout > val) {
1408 if (INFO_GTE(MISC, 2))
1409 rprintf(FINFO, "Setting --timeout=%d to match server\n", val);
1410 set_io_timeout(val);
1416 iobuf.in_multiplexed = 1;
1418 maybe_send_keepalive();
1421 if (msg_bytes >= sizeof data)
1424 raw_read_buf(data, msg_bytes);
1425 iobuf.in_multiplexed = 1;
1426 send_msg(MSG_DELETED, data, msg_bytes, 1);
1430 if (ic_recv != (iconv_t)-1) {
1434 int flags = ICB_INCLUDE_BAD | ICB_INIT;
1436 INIT_CONST_XBUF(outbuf, data);
1437 INIT_XBUF(inbuf, ibuf, 0, (size_t)-1);
1440 size_t len = msg_bytes > sizeof ibuf - inbuf.len ? sizeof ibuf - inbuf.len : msg_bytes;
1441 raw_read_buf(ibuf + inbuf.len, len);
1444 if (!(msg_bytes -= len) && !ibuf[inbuf.len-1])
1445 inbuf.len--, add_null = 1;
1446 if (iconvbufs(ic_send, &inbuf, &outbuf, flags) < 0) {
1449 /* Buffer ended with an incomplete char, so move the
1450 * bytes to the start of the buffer and continue. */
1451 memmove(ibuf, ibuf + inbuf.pos, inbuf.len);
1456 if (outbuf.len == outbuf.size)
1458 outbuf.buf[outbuf.len++] = '\0';
1460 msg_bytes = outbuf.len;
1463 raw_read_buf(data, msg_bytes);
1464 iobuf.in_multiplexed = 1;
1465 /* A directory name was sent with the trailing null */
1466 if (msg_bytes > 0 && !data[msg_bytes-1])
1467 log_delete(data, S_IFDIR);
1469 data[msg_bytes] = '\0';
1470 log_delete(data, S_IFREG);
1474 if (msg_bytes != 4) {
1476 rprintf(FERROR, "invalid multi-message %d:%lu [%s%s]\n",
1477 tag, (unsigned long)msg_bytes, who_am_i(),
1478 inc_recurse ? "/inc" : "");
1479 exit_cleanup(RERR_STREAMIO);
1481 val = raw_read_int();
1482 iobuf.in_multiplexed = 1;
1484 got_flist_entry_status(FES_SUCCESS, val);
1486 successful_send(val);
1491 val = raw_read_int();
1492 iobuf.in_multiplexed = 1;
1494 got_flist_entry_status(FES_NO_SEND, val);
1496 send_msg_int(MSG_NO_SEND, val);
1498 case MSG_ERROR_SOCKET:
1499 case MSG_ERROR_UTF8:
1504 if (tag == MSG_ERROR_SOCKET)
1509 case MSG_ERROR_XFER:
1511 if (msg_bytes >= sizeof data) {
1514 "multiplexing overflow %d:%lu [%s%s]\n",
1515 tag, (unsigned long)msg_bytes, who_am_i(),
1516 inc_recurse ? "/inc" : "");
1517 exit_cleanup(RERR_STREAMIO);
1519 raw_read_buf(data, msg_bytes);
1520 iobuf.in_multiplexed = 1;
1521 rwrite((enum logcode)tag, data, msg_bytes, !am_generator);
1522 if (first_message) {
1523 if (list_only && !am_sender && tag == 1 && msg_bytes < sizeof data) {
1524 data[msg_bytes] = '\0';
1525 check_for_d_option_error(data);
1530 case MSG_ERROR_EXIT:
1532 val = raw_read_int();
1533 else if (msg_bytes == 0)
1537 iobuf.in_multiplexed = 1;
1538 if (DEBUG_GTE(EXIT, 3))
1539 rprintf(FINFO, "[%s] got MSG_ERROR_EXIT with %ld bytes\n", who_am_i(), (long)msg_bytes);
1540 if (msg_bytes == 0) {
1541 if (!am_sender && !am_generator) {
1542 if (DEBUG_GTE(EXIT, 3)) {
1543 rprintf(FINFO, "[%s] sending MSG_ERROR_EXIT (len 0)\n",
1546 send_msg(MSG_ERROR_EXIT, "", 0, 0);
1547 io_flush(FULL_FLUSH);
1549 } else if (protocol_version >= 31) {
1551 if (DEBUG_GTE(EXIT, 3)) {
1552 rprintf(FINFO, "[%s] sending MSG_ERROR_EXIT with exit_code %d\n",
1555 send_msg_int(MSG_ERROR_EXIT, val);
1557 if (DEBUG_GTE(EXIT, 3)) {
1558 rprintf(FINFO, "[%s] sending MSG_ERROR_EXIT (len 0)\n",
1561 send_msg(MSG_ERROR_EXIT, "", 0, 0);
1564 /* Send a negative linenum so that we don't end up
1565 * with a duplicate exit message. */
1566 _exit_cleanup(val, __FILE__, 0 - __LINE__);
1568 rprintf(FERROR, "unexpected tag %d [%s%s]\n",
1569 tag, who_am_i(), inc_recurse ? "/inc" : "");
1570 exit_cleanup(RERR_STREAMIO);
1573 assert(iobuf.in_multiplexed > 0);
1576 static void drain_multiplex_messages(void)
1578 while (IN_MULTIPLEXED_AND_READY && iobuf.in.len) {
1579 if (iobuf.raw_input_ends_before) {
1580 size_t raw_len = iobuf.raw_input_ends_before - iobuf.in.pos;
1581 iobuf.raw_input_ends_before = 0;
1582 if (raw_len >= iobuf.in.len) {
1586 iobuf.in.len -= raw_len;
1587 if ((iobuf.in.pos += raw_len) >= iobuf.in.size)
1588 iobuf.in.pos -= iobuf.in.size;
1594 void wait_for_receiver(void)
1596 if (!iobuf.raw_input_ends_before)
1599 if (iobuf.raw_input_ends_before) {
1600 int ndx = read_int(iobuf.in_fd);
1605 if (DEBUG_GTE(FLIST, 3))
1606 rprintf(FINFO, "[%s] flist_eof=1\n", who_am_i());
1612 exit_cleanup(RERR_STREAMIO);
1615 struct file_list *flist;
1616 flist_receiving_enabled = False;
1617 if (DEBUG_GTE(FLIST, 2)) {
1618 rprintf(FINFO, "[%s] receiving flist for dir %d\n",
1621 flist = recv_file_list(iobuf.in_fd);
1622 flist->parent_ndx = ndx;
1623 #ifdef SUPPORT_HARD_LINKS
1624 if (preserve_hard_links)
1625 match_hard_links(flist);
1627 flist_receiving_enabled = True;
1632 unsigned short read_shortint(int f)
1636 return (UVAL(b, 1) << 8) + UVAL(b, 0);
1639 int32 read_int(int f)
1646 #if SIZEOF_INT32 > 4
1647 if (num & (int32)0x80000000)
1648 num |= ~(int32)0xffffffff;
1653 int32 read_varint(int f)
1664 extra = int_byte_extra[ch / 4];
1666 uchar bit = ((uchar)1<<(8-extra));
1667 if (extra >= (int)sizeof u.b) {
1668 rprintf(FERROR, "Overflow in read_varint()\n");
1669 exit_cleanup(RERR_STREAMIO);
1671 read_buf(f, u.b, extra);
1672 u.b[extra] = ch & (bit-1);
1675 #if CAREFUL_ALIGNMENT
1678 #if SIZEOF_INT32 > 4
1679 if (u.x & (int32)0x80000000)
1680 u.x |= ~(int32)0xffffffff;
1685 int64 read_varlong(int f, uchar min_bytes)
1694 #if SIZEOF_INT64 < 8
1699 read_buf(f, b2, min_bytes);
1700 memcpy(u.b, b2+1, min_bytes-1);
1701 extra = int_byte_extra[CVAL(b2, 0) / 4];
1703 uchar bit = ((uchar)1<<(8-extra));
1704 if (min_bytes + extra > (int)sizeof u.b) {
1705 rprintf(FERROR, "Overflow in read_varlong()\n");
1706 exit_cleanup(RERR_STREAMIO);
1708 read_buf(f, u.b + min_bytes - 1, extra);
1709 u.b[min_bytes + extra - 1] = CVAL(b2, 0) & (bit-1);
1710 #if SIZEOF_INT64 < 8
1711 if (min_bytes + extra > 5 || u.b[4] || CVAL(u.b,3) & 0x80) {
1712 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1713 exit_cleanup(RERR_UNSUPPORTED);
1717 u.b[min_bytes + extra - 1] = CVAL(b2, 0);
1718 #if SIZEOF_INT64 < 8
1720 #elif CAREFUL_ALIGNMENT
1721 u.x = IVAL(u.b,0) | (((int64)IVAL(u.b,4))<<32);
1726 int64 read_longint(int f)
1728 #if SIZEOF_INT64 >= 8
1731 int32 num = read_int(f);
1733 if (num != (int32)0xffffffff)
1736 #if SIZEOF_INT64 < 8
1737 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1738 exit_cleanup(RERR_UNSUPPORTED);
1741 return IVAL(b,0) | (((int64)IVAL(b,4))<<32);
1745 void read_buf(int f, char *buf, size_t len)
1747 if (f != iobuf.in_fd) {
1748 if (safe_read(f, buf, len) != len)
1749 whine_about_eof(False); /* Doesn't return. */
1753 if (!IN_MULTIPLEXED) {
1754 raw_read_buf(buf, len);
1755 total_data_read += len;
1756 if (forward_flist_data)
1757 write_buf(iobuf.out_fd, buf, len);
1759 if (f == write_batch_monitor_in)
1760 safe_write(batch_fd, buf, len);
1767 while (!iobuf.raw_input_ends_before)
1770 siz = MIN(len, iobuf.raw_input_ends_before - iobuf.in.pos);
1771 if (siz >= iobuf.in.size)
1772 siz = iobuf.in.size;
1773 raw_read_buf(buf, siz);
1774 total_data_read += siz;
1776 if (forward_flist_data)
1777 write_buf(iobuf.out_fd, buf, siz);
1779 if (f == write_batch_monitor_in)
1780 safe_write(batch_fd, buf, siz);
1782 if ((len -= siz) == 0)
1788 void read_sbuf(int f, char *buf, size_t len)
1790 read_buf(f, buf, len);
1794 uchar read_byte(int f)
1797 read_buf(f, (char*)&c, 1);
1801 int read_vstring(int f, char *buf, int bufsize)
1803 int len = read_byte(f);
1806 len = (len & ~0x80) * 0x100 + read_byte(f);
1808 if (len >= bufsize) {
1809 rprintf(FERROR, "over-long vstring received (%d > %d)\n",
1815 read_buf(f, buf, len);
1820 /* Populate a sum_struct with values from the socket. This is
1821 * called by both the sender and the receiver. */
1822 void read_sum_head(int f, struct sum_struct *sum)
1824 int32 max_blength = protocol_version < 30 ? OLD_MAX_BLOCK_SIZE : MAX_BLOCK_SIZE;
1825 sum->count = read_int(f);
1826 if (sum->count < 0) {
1827 rprintf(FERROR, "Invalid checksum count %ld [%s]\n",
1828 (long)sum->count, who_am_i());
1829 exit_cleanup(RERR_PROTOCOL);
1831 sum->blength = read_int(f);
1832 if (sum->blength < 0 || sum->blength > max_blength) {
1833 rprintf(FERROR, "Invalid block length %ld [%s]\n",
1834 (long)sum->blength, who_am_i());
1835 exit_cleanup(RERR_PROTOCOL);
1837 sum->s2length = protocol_version < 27 ? csum_length : (int)read_int(f);
1838 if (sum->s2length < 0 || sum->s2length > MAX_DIGEST_LEN) {
1839 rprintf(FERROR, "Invalid checksum length %d [%s]\n",
1840 sum->s2length, who_am_i());
1841 exit_cleanup(RERR_PROTOCOL);
1843 sum->remainder = read_int(f);
1844 if (sum->remainder < 0 || sum->remainder > sum->blength) {
1845 rprintf(FERROR, "Invalid remainder length %ld [%s]\n",
1846 (long)sum->remainder, who_am_i());
1847 exit_cleanup(RERR_PROTOCOL);
1851 /* Send the values from a sum_struct over the socket. Set sum to
1852 * NULL if there are no checksums to send. This is called by both
1853 * the generator and the sender. */
1854 void write_sum_head(int f, struct sum_struct *sum)
1856 static struct sum_struct null_sum;
1861 write_int(f, sum->count);
1862 write_int(f, sum->blength);
1863 if (protocol_version >= 27)
1864 write_int(f, sum->s2length);
1865 write_int(f, sum->remainder);
1868 /* Sleep after writing to limit I/O bandwidth usage.
1870 * @todo Rather than sleeping after each write, it might be better to
1871 * use some kind of averaging. The current algorithm seems to always
1872 * use a bit less bandwidth than specified, because it doesn't make up
1873 * for slow periods. But arguably this is a feature. In addition, we
1874 * ought to take the time used to write the data into account.
1876 * During some phases of big transfers (file FOO is uptodate) this is
1877 * called with a small bytes_written every time. As the kernel has to
1878 * round small waits up to guarantee that we actually wait at least the
1879 * requested number of microseconds, this can become grossly inaccurate.
1880 * We therefore keep track of the bytes we've written over time and only
1881 * sleep when the accumulated delay is at least 1 tenth of a second. */
1882 static void sleep_for_bwlimit(int bytes_written)
1884 static struct timeval prior_tv;
1885 static long total_written = 0;
1886 struct timeval tv, start_tv;
1887 long elapsed_usec, sleep_usec;
1889 #define ONE_SEC 1000000L /* # of microseconds in a second */
1891 total_written += bytes_written;
1893 gettimeofday(&start_tv, NULL);
1894 if (prior_tv.tv_sec) {
1895 elapsed_usec = (start_tv.tv_sec - prior_tv.tv_sec) * ONE_SEC
1896 + (start_tv.tv_usec - prior_tv.tv_usec);
1897 total_written -= elapsed_usec * bwlimit / (ONE_SEC/1024);
1898 if (total_written < 0)
1902 sleep_usec = total_written * (ONE_SEC/1024) / bwlimit;
1903 if (sleep_usec < ONE_SEC / 10) {
1904 prior_tv = start_tv;
1908 tv.tv_sec = sleep_usec / ONE_SEC;
1909 tv.tv_usec = sleep_usec % ONE_SEC;
1910 select(0, NULL, NULL, NULL, &tv);
1912 gettimeofday(&prior_tv, NULL);
1913 elapsed_usec = (prior_tv.tv_sec - start_tv.tv_sec) * ONE_SEC
1914 + (prior_tv.tv_usec - start_tv.tv_usec);
1915 total_written = (sleep_usec - elapsed_usec) * bwlimit / (ONE_SEC/1024);
1918 void io_flush(int flush_it_all)
1920 if (iobuf.out.len > iobuf.out_empty_len) {
1921 if (flush_it_all) /* FULL_FLUSH: flush everything in the output buffers */
1922 perform_io(iobuf.out.size - iobuf.out_empty_len, PIO_NEED_OUTROOM);
1923 else /* NORMAL_FLUSH: flush at least 1 byte */
1924 perform_io(iobuf.out.size - iobuf.out.len + 1, PIO_NEED_OUTROOM);
1927 perform_io(iobuf.msg.size, PIO_NEED_MSGROOM);
1930 void write_shortint(int f, unsigned short x)
1934 b[1] = (char)(x >> 8);
1938 void write_int(int f, int32 x)
1945 void write_varint(int f, int32 x)
1953 while (cnt > 1 && b[cnt] == 0)
1955 bit = ((uchar)1<<(7-cnt+1));
1956 if (CVAL(b, cnt) >= bit) {
1960 *b = b[cnt] | ~(bit*2-1);
1964 write_buf(f, b, cnt);
1967 void write_varlong(int f, int64 x, uchar min_bytes)
1974 #if SIZEOF_INT64 >= 8
1975 SIVAL(b, 5, x >> 32);
1977 if (x <= 0x7FFFFFFF && x >= 0)
1978 memset(b + 5, 0, 4);
1980 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1981 exit_cleanup(RERR_UNSUPPORTED);
1985 while (cnt > min_bytes && b[cnt] == 0)
1987 bit = ((uchar)1<<(7-cnt+min_bytes));
1988 if (CVAL(b, cnt) >= bit) {
1991 } else if (cnt > min_bytes)
1992 *b = b[cnt] | ~(bit*2-1);
1996 write_buf(f, b, cnt);
2000 * Note: int64 may actually be a 32-bit type if ./configure couldn't find any
2001 * 64-bit types on this platform.
2003 void write_longint(int f, int64 x)
2005 char b[12], * const s = b+4;
2008 if (x <= 0x7FFFFFFF && x >= 0) {
2013 #if SIZEOF_INT64 < 8
2014 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
2015 exit_cleanup(RERR_UNSUPPORTED);
2018 SIVAL(s, 4, x >> 32);
2019 write_buf(f, b, 12);
2023 void write_buf(int f, const char *buf, size_t len)
2027 if (f != iobuf.out_fd) {
2028 safe_write(f, buf, len);
2032 if (iobuf.out.len + len > iobuf.out.size)
2033 perform_io(len, PIO_NEED_OUTROOM);
2035 pos = iobuf.out.pos + iobuf.out.len; /* Must be set after any flushing. */
2036 if (pos >= iobuf.out.size)
2037 pos -= iobuf.out.size;
2039 /* Handle a split copy if we wrap around the end of the circular buffer. */
2040 if (pos >= iobuf.out.pos && (siz = iobuf.out.size - pos) < len) {
2041 memcpy(iobuf.out.buf + pos, buf, siz);
2042 memcpy(iobuf.out.buf, buf + siz, len - siz);
2044 memcpy(iobuf.out.buf + pos, buf, len);
2046 iobuf.out.len += len;
2047 total_data_written += len;
2050 if (f == write_batch_monitor_out)
2051 safe_write(batch_fd, buf, len);
2054 /* Write a string to the connection */
2055 void write_sbuf(int f, const char *buf)
2057 write_buf(f, buf, strlen(buf));
2060 void write_byte(int f, uchar c)
2062 write_buf(f, (char *)&c, 1);
2065 void write_vstring(int f, const char *str, int len)
2067 uchar lenbuf[3], *lb = lenbuf;
2072 "attempting to send over-long vstring (%d > %d)\n",
2074 exit_cleanup(RERR_PROTOCOL);
2076 *lb++ = len / 0x100 + 0x80;
2080 write_buf(f, (char*)lenbuf, lb - lenbuf + 1);
2082 write_buf(f, str, len);
2085 /* Send a file-list index using a byte-reduction method. */
2086 void write_ndx(int f, int32 ndx)
2088 static int32 prev_positive = -1, prev_negative = 1;
2089 int32 diff, cnt = 0;
2092 if (protocol_version < 30 || read_batch) {
2097 /* Send NDX_DONE as a single-byte 0 with no side effects. Send
2098 * negative nums as a positive after sending a leading 0xFF. */
2100 diff = ndx - prev_positive;
2101 prev_positive = ndx;
2102 } else if (ndx == NDX_DONE) {
2107 b[cnt++] = (char)0xFF;
2109 diff = ndx - prev_negative;
2110 prev_negative = ndx;
2113 /* A diff of 1 - 253 is sent as a one-byte diff; a diff of 254 - 32767
2114 * or 0 is sent as a 0xFE + a two-byte diff; otherwise we send 0xFE
2115 * & all 4 bytes of the (non-negative) num with the high-bit set. */
2116 if (diff < 0xFE && diff > 0)
2117 b[cnt++] = (char)diff;
2118 else if (diff < 0 || diff > 0x7FFF) {
2119 b[cnt++] = (char)0xFE;
2120 b[cnt++] = (char)((ndx >> 24) | 0x80);
2121 b[cnt++] = (char)ndx;
2122 b[cnt++] = (char)(ndx >> 8);
2123 b[cnt++] = (char)(ndx >> 16);
2125 b[cnt++] = (char)0xFE;
2126 b[cnt++] = (char)(diff >> 8);
2127 b[cnt++] = (char)diff;
2129 write_buf(f, b, cnt);
2132 /* Receive a file-list index using a byte-reduction method. */
2133 int32 read_ndx(int f)
2135 static int32 prev_positive = -1, prev_negative = 1;
2136 int32 *prev_ptr, num;
2139 if (protocol_version < 30)
2143 if (CVAL(b, 0) == 0xFF) {
2145 prev_ptr = &prev_negative;
2146 } else if (CVAL(b, 0) == 0)
2149 prev_ptr = &prev_positive;
2150 if (CVAL(b, 0) == 0xFE) {
2152 if (CVAL(b, 0) & 0x80) {
2153 b[3] = CVAL(b, 0) & ~0x80;
2155 read_buf(f, b+1, 2);
2158 num = (UVAL(b,0)<<8) + UVAL(b,1) + *prev_ptr;
2160 num = UVAL(b, 0) + *prev_ptr;
2162 if (prev_ptr == &prev_negative)
2167 /* Read a line of up to bufsiz-1 characters into buf. Strips
2168 * the (required) trailing newline and all carriage returns.
2169 * Returns 1 for success; 0 for I/O error or truncation. */
2170 int read_line_old(int fd, char *buf, size_t bufsiz)
2172 bufsiz--; /* leave room for the null */
2173 while (bufsiz > 0) {
2174 assert(fd != iobuf.in_fd);
2175 if (safe_read(fd, buf, 1) == 0)
2190 void io_printf(int fd, const char *format, ...)
2193 char buf[BIGPATHBUFLEN];
2196 va_start(ap, format);
2197 len = vsnprintf(buf, sizeof buf, format, ap);
2201 exit_cleanup(RERR_PROTOCOL);
2203 if (len > (int)sizeof buf) {
2204 rprintf(FERROR, "io_printf() was too long for the buffer.\n");
2205 exit_cleanup(RERR_PROTOCOL);
2208 write_sbuf(fd, buf);
2211 /* Setup for multiplexing a MSG_* stream with the data stream. */
2212 void io_start_multiplex_out(int fd)
2214 io_flush(FULL_FLUSH);
2216 if (msgs2stderr && DEBUG_GTE(IO, 2))
2217 rprintf(FINFO, "[%s] io_start_multiplex_out(%d)\n", who_am_i(), fd);
2220 alloc_xbuf(&iobuf.msg, ROUND_UP_1024(IO_BUFFER_SIZE));
2222 iobuf.out_empty_len = 4; /* See also OUT_MULTIPLEXED */
2223 io_start_buffering_out(fd);
2225 iobuf.raw_data_header_pos = iobuf.out.pos + iobuf.out.len;
2229 /* Setup for multiplexing a MSG_* stream with the data stream. */
2230 void io_start_multiplex_in(int fd)
2232 if (msgs2stderr && DEBUG_GTE(IO, 2))
2233 rprintf(FINFO, "[%s] io_start_multiplex_in(%d)\n", who_am_i(), fd);
2235 iobuf.in_multiplexed = 1; /* See also IN_MULTIPLEXED */
2236 io_start_buffering_in(fd);
2239 int io_end_multiplex_in(int mode)
2241 int ret = iobuf.in_multiplexed ? iobuf.in_fd : -1;
2243 if (msgs2stderr && DEBUG_GTE(IO, 2))
2244 rprintf(FINFO, "[%s] io_end_multiplex_in(mode=%d)\n", who_am_i(), mode);
2246 iobuf.in_multiplexed = 0;
2247 if (mode == MPLX_SWITCHING)
2248 iobuf.raw_input_ends_before = 0;
2250 assert(iobuf.raw_input_ends_before == 0);
2251 if (mode != MPLX_TO_BUFFERED)
2252 io_end_buffering_in(mode);
2257 int io_end_multiplex_out(int mode)
2259 int ret = iobuf.out_empty_len ? iobuf.out_fd : -1;
2261 if (msgs2stderr && DEBUG_GTE(IO, 2))
2262 rprintf(FINFO, "[%s] io_end_multiplex_out(mode=%d)\n", who_am_i(), mode);
2264 if (mode != MPLX_TO_BUFFERED)
2265 io_end_buffering_out(mode);
2267 io_flush(FULL_FLUSH);
2270 iobuf.out_empty_len = 0;
2275 void start_write_batch(int fd)
2277 /* Some communication has already taken place, but we don't
2278 * enable batch writing until here so that we can write a
2279 * canonical record of the communication even though the
2280 * actual communication so far depends on whether a daemon
2282 write_int(batch_fd, protocol_version);
2283 if (protocol_version >= 30)
2284 write_byte(batch_fd, inc_recurse);
2285 write_int(batch_fd, checksum_seed);
2288 write_batch_monitor_out = fd;
2290 write_batch_monitor_in = fd;
2293 void stop_write_batch(void)
2295 write_batch_monitor_out = -1;
2296 write_batch_monitor_in = -1;