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 inc_recurse;
49 extern int read_batch;
50 extern int protect_args;
51 extern int checksum_seed;
52 extern int protocol_version;
53 extern int remove_source_files;
54 extern int preserve_hard_links;
55 extern struct stats stats;
56 extern struct file_list *cur_flist;
58 extern int filesfrom_convert;
59 extern iconv_t ic_send, ic_recv;
62 int csum_length = SHORT_SUM_LENGTH; /* initial value */
64 int ignore_timeout = 0;
68 /* Ignore an EOF error if non-zero. See whine_about_eof(). */
69 int kluge_around_eof = 0;
76 static int iobuf_f_in = -1;
77 static char *iobuf_in;
78 static size_t iobuf_in_siz;
79 static size_t iobuf_in_ndx;
80 static size_t iobuf_in_remaining;
82 static int iobuf_f_out = -1;
83 static char *iobuf_out;
84 static int iobuf_out_cnt;
86 int flist_forward_from = -1;
88 static int io_multiplexing_out;
89 static int io_multiplexing_in;
90 static time_t last_io_in;
91 static time_t last_io_out;
94 static int write_batch_monitor_in = -1;
95 static int write_batch_monitor_out = -1;
97 static int io_filesfrom_f_in = -1;
98 static int io_filesfrom_f_out = -1;
99 static xbuf ff_buf = EMPTY_XBUF;
100 static char ff_lastchar;
102 static xbuf iconv_buf = EMPTY_XBUF;
104 static int defer_forwarding_messages = 0, keep_defer_forwarding = 0;
105 static int select_timeout = SELECT_TIMEOUT;
106 static int active_filecnt = 0;
107 static OFF_T active_bytecnt = 0;
108 static int first_message = 1;
110 static char int_byte_extra[64] = {
111 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* (00 - 3F)/4 */
112 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* (40 - 7F)/4 */
113 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /* (80 - BF)/4 */
114 2, 2, 2, 2, 2, 2, 2, 2, 3, 3, 3, 3, 4, 4, 5, 6, /* (C0 - FF)/4 */
117 #define REMOTE_OPTION_ERROR "rsync: on remote machine: -"
118 #define REMOTE_OPTION_ERROR2 ": unknown option"
120 enum festatus { FES_SUCCESS, FES_REDO, FES_NO_SEND };
122 static void readfd(int fd, char *buffer, size_t N);
123 static void writefd(int fd, const char *buf, size_t len);
124 static void writefd_unbuffered(int fd, const char *buf, size_t len);
125 static void mplex_write(int fd, enum msgcode code, const char *buf, size_t len, int convert);
127 static flist_ndx_list redo_list, hlink_list;
129 struct msg_list_item {
130 struct msg_list_item *next;
136 struct msg_list_item *head, *tail;
139 static struct msg_list msg_queue;
141 static void got_flist_entry_status(enum festatus status, const char *buf)
143 int ndx = IVAL(buf, 0);
144 struct file_list *flist = flist_for_ndx(ndx, "got_flist_entry_status");
146 if (remove_source_files) {
148 active_bytecnt -= F_LENGTH(flist->files[ndx - flist->ndx_start]);
152 flist->in_progress--;
156 if (remove_source_files)
157 send_msg(MSG_SUCCESS, buf, 4, 0);
158 if (preserve_hard_links) {
159 struct file_struct *file = flist->files[ndx - flist->ndx_start];
160 if (F_IS_HLINKED(file)) {
161 flist_ndx_push(&hlink_list, ndx);
162 flist->in_progress++;
169 flist->in_progress++;
174 flist_ndx_push(&redo_list, ndx);
181 static void check_timeout(void)
185 if (!io_timeout || ignore_timeout)
189 last_io_in = time(NULL);
195 if (t - last_io_in >= io_timeout) {
196 if (!am_server && !am_daemon) {
197 rprintf(FERROR, "io timeout after %d seconds -- exiting\n",
198 (int)(t-last_io_in));
200 exit_cleanup(RERR_TIMEOUT);
204 /* Note the fds used for the main socket (which might really be a pipe
205 * for a local transfer, but we can ignore that). */
206 void io_set_sock_fds(int f_in, int f_out)
212 void set_io_timeout(int secs)
216 if (!io_timeout || io_timeout > SELECT_TIMEOUT)
217 select_timeout = SELECT_TIMEOUT;
219 select_timeout = io_timeout;
221 allowed_lull = read_batch ? 0 : (io_timeout + 1) / 2;
224 /* Setup the fd used to receive MSG_* messages. Only needed during the
225 * early stages of being a local sender (up through the sending of the
226 * file list) or when we're the generator (to fetch the messages from
228 void set_msg_fd_in(int fd)
233 /* Setup the fd used to send our MSG_* messages. Only needed when
234 * we're the receiver (to send our messages to the generator). */
235 void set_msg_fd_out(int fd)
238 set_nonblocking(msg_fd_out);
241 /* Add a message to the pending MSG_* list. */
242 static void msg_list_add(struct msg_list *lst, int code, const char *buf, int len, int convert)
244 struct msg_list_item *m;
245 int sz = len + 4 + sizeof m[0] - 1;
247 if (!(m = (struct msg_list_item *)new_array(char, sz)))
248 out_of_memory("msg_list_add");
250 m->convert = convert;
251 SIVAL(m->buf, 0, ((code+MPLEX_BASE)<<24) | len);
252 memcpy(m->buf + 4, buf, len);
260 static inline int flush_a_msg(int fd)
262 struct msg_list_item *m = msg_queue.head;
263 int len = IVAL(m->buf, 0) & 0xFFFFFF;
264 int tag = *((uchar*)m->buf+3) - MPLEX_BASE;
266 if (!(msg_queue.head = m->next))
267 msg_queue.tail = NULL;
269 defer_forwarding_messages++;
270 mplex_write(fd, tag, m->buf + 4, len, m->convert);
271 defer_forwarding_messages--;
278 static void msg_flush(void)
281 while (msg_queue.head && io_multiplexing_out)
282 stats.total_written += flush_a_msg(sock_f_out) + 4;
284 while (msg_queue.head)
285 (void)flush_a_msg(msg_fd_out);
289 static void check_for_d_option_error(const char *msg)
291 static char rsync263_opts[] = "BCDHIKLPRSTWabceghlnopqrtuvxz";
296 || strncmp(msg, REMOTE_OPTION_ERROR, sizeof REMOTE_OPTION_ERROR - 1) != 0)
299 msg += sizeof REMOTE_OPTION_ERROR - 1;
300 if (*msg == '-' || (colon = strchr(msg, ':')) == NULL
301 || strncmp(colon, REMOTE_OPTION_ERROR2, sizeof REMOTE_OPTION_ERROR2 - 1) != 0)
304 for ( ; *msg != ':'; msg++) {
307 else if (*msg == 'e')
309 else if (strchr(rsync263_opts, *msg) == NULL)
315 "*** Try using \"--old-d\" if remote rsync is <= 2.6.3 ***\n");
319 /* Read a message from the MSG_* fd and handle it. This is called either
320 * during the early stages of being a local sender (up through the sending
321 * of the file list) or when we're the generator (to fetch the messages
322 * from the receiver). */
323 static void read_msg_fd(void)
327 struct file_list *flist;
331 /* Temporarily disable msg_fd_in. This is needed to avoid looping back
332 * to this routine from writefd_unbuffered(). */
335 defer_forwarding_messages++;
340 len = tag & 0xFFFFFF;
341 tag = (tag >> 24) - MPLEX_BASE;
345 if (len < 0 || len > 1 || !am_generator) {
347 rprintf(FERROR, "invalid message %d:%d [%s%s]\n",
348 tag, len, who_am_i(),
349 inc_recurse ? "/inc" : "");
350 exit_cleanup(RERR_STREAMIO);
353 readfd(fd, buf, len);
354 stats.total_read = read_varlong(fd, 3);
359 if (len != 4 || !am_generator)
362 got_flist_entry_status(FES_REDO, buf);
365 if (len != 4 || !am_generator || !inc_recurse)
368 /* Read extra file list from receiver. */
369 assert(iobuf_in != NULL);
370 assert(iobuf_f_in == fd);
371 if (DEBUG_GTE(FLIST, 2)) {
372 rprintf(FINFO, "[%s] receiving flist for dir %d\n",
373 who_am_i(), IVAL(buf,0));
375 flist = recv_file_list(fd);
376 flist->parent_ndx = IVAL(buf,0);
377 #ifdef SUPPORT_HARD_LINKS
378 if (preserve_hard_links)
379 match_hard_links(flist);
383 if (len != 0 || !am_generator || !inc_recurse)
390 readfd(fd, buf, len);
391 io_error |= IVAL(buf, 0);
394 if (len >= (int)sizeof buf || !am_generator)
396 readfd(fd, buf, len);
397 send_msg(MSG_DELETED, buf, len, 1);
400 if (len != 4 || !am_generator)
403 got_flist_entry_status(FES_SUCCESS, buf);
406 if (len != 4 || !am_generator)
409 got_flist_entry_status(FES_NO_SEND, buf);
411 case MSG_ERROR_SOCKET:
416 if (tag == MSG_ERROR_SOCKET)
417 io_end_multiplex_out();
429 rwrite((enum logcode)tag, buf, n, !am_generator);
434 rprintf(FERROR, "unknown message %d:%d [%s]\n",
435 tag, len, who_am_i());
436 exit_cleanup(RERR_STREAMIO);
441 if (!--defer_forwarding_messages && !no_flush)
445 /* This is used by the generator to limit how many file transfers can
446 * be active at once when --remove-source-files is specified. Without
447 * this, sender-side deletions were mostly happening at the end. */
448 void increment_active_files(int ndx, int itemizing, enum logcode code)
451 /* TODO: tune these limits? */
452 int limit = active_bytecnt >= 128*1024 ? 10 : 50;
453 if (active_filecnt < limit)
455 check_for_finished_files(itemizing, code, 0);
456 if (active_filecnt < limit)
459 io_flush(NORMAL_FLUSH);
465 active_bytecnt += F_LENGTH(cur_flist->files[ndx - cur_flist->ndx_start]);
468 /* Write an message to a multiplexed stream. If this fails, rsync exits. */
469 static void mplex_write(int fd, enum msgcode code, const char *buf, size_t len, int convert)
471 char buffer[BIGPATHBUFLEN]; /* Oversized for use by iconv code. */
475 /* We need to convert buf before doing anything else so that we
476 * can include the (converted) byte length in the message header. */
477 if (convert && ic_send != (iconv_t)-1) {
480 INIT_XBUF(outbuf, buffer + 4, 0, sizeof buffer - 4);
481 INIT_XBUF(inbuf, (char*)buf, len, (size_t)-1);
483 iconvbufs(ic_send, &inbuf, &outbuf,
484 ICB_INCLUDE_BAD | ICB_INCLUDE_INCOMPLETE);
486 rprintf(FERROR, "overflowed conversion buffer in mplex_write");
487 exit_cleanup(RERR_UNSUPPORTED);
490 n = len = outbuf.len;
493 if (n > 1024 - 4) /* BIGPATHBUFLEN can handle 1024 bytes */
494 n = 0; /* We'd rather do 2 writes than too much memcpy(). */
496 memcpy(buffer + 4, buf, n);
498 SIVAL(buffer, 0, ((MPLEX_BASE + (int)code)<<24) + len);
500 keep_defer_forwarding++; /* defer_forwarding_messages++ on return */
501 writefd_unbuffered(fd, buffer, n+4);
502 keep_defer_forwarding--;
505 writefd_unbuffered(fd, buf+n, len-n);
507 if (!--defer_forwarding_messages && !no_flush)
511 int send_msg(enum msgcode code, const char *buf, int len, int convert)
513 if (msg_fd_out < 0) {
514 if (!defer_forwarding_messages)
515 return io_multiplex_write(code, buf, len, convert);
516 if (!io_multiplexing_out)
518 msg_list_add(&msg_queue, code, buf, len, convert);
521 if (flist_forward_from >= 0)
522 msg_list_add(&msg_queue, code, buf, len, convert);
524 mplex_write(msg_fd_out, code, buf, len, convert);
528 void send_msg_int(enum msgcode code, int num)
531 SIVAL(numbuf, 0, num);
532 send_msg(code, numbuf, 4, 0);
535 void wait_for_receiver(void)
537 if (io_flush(FULL_FLUSH))
542 int get_redo_num(void)
544 return flist_ndx_pop(&redo_list);
547 int get_hlink_num(void)
549 return flist_ndx_pop(&hlink_list);
553 * When we're the receiver and we have a local --files-from list of names
554 * that needs to be sent over the socket to the sender, we have to do two
555 * things at the same time: send the sender a list of what files we're
556 * processing and read the incoming file+info list from the sender. We do
557 * this by augmenting the read_timeout() function to copy this data. It
558 * uses ff_buf to read a block of data from f_in (when it is ready, since
559 * it might be a pipe) and then blast it out f_out (when it is ready to
560 * receive more data).
562 void io_set_filesfrom_fds(int f_in, int f_out)
564 io_filesfrom_f_in = f_in;
565 io_filesfrom_f_out = f_out;
566 alloc_xbuf(&ff_buf, 2048);
569 alloc_xbuf(&iconv_buf, 1024);
573 /* It's almost always an error to get an EOF when we're trying to read from the
574 * network, because the protocol is (for the most part) self-terminating.
576 * There is one case for the receiver when it is at the end of the transfer
577 * (hanging around reading any keep-alive packets that might come its way): if
578 * the sender dies before the generator's kill-signal comes through, we can end
579 * up here needing to loop until the kill-signal arrives. In this situation,
580 * kluge_around_eof will be < 0.
582 * There is another case for older protocol versions (< 24) where the module
583 * listing was not terminated, so we must ignore an EOF error in that case and
584 * exit. In this situation, kluge_around_eof will be > 0. */
585 static void whine_about_eof(int fd)
587 if (kluge_around_eof && fd == sock_f_in) {
589 if (kluge_around_eof > 0)
591 /* If we're still here after 10 seconds, exit with an error. */
592 for (i = 10*1000/20; i--; )
596 rprintf(FERROR, RSYNC_NAME ": connection unexpectedly closed "
597 "(%s bytes received so far) [%s]\n",
598 big_num(stats.total_read), who_am_i());
600 exit_cleanup(RERR_STREAMIO);
604 * Read from a socket with I/O timeout. return the number of bytes
605 * read. If no bytes can be read then exit, never return a number <= 0.
607 * TODO: If the remote shell connection fails, then current versions
608 * actually report an "unexpected EOF" error here. Since it's a
609 * fairly common mistake to try to use rsh when ssh is required, we
610 * should trap that: if we fail to read any data at all, we should
611 * give a better explanation. We can tell whether the connection has
612 * started by looking e.g. at whether the remote version is known yet.
614 static int read_timeout(int fd, char *buf, size_t len)
618 io_flush(FULL_FLUSH);
621 /* until we manage to read *something* */
630 if (io_filesfrom_f_out >= 0) {
632 if (ff_buf.len == 0) {
633 if (io_filesfrom_f_in >= 0) {
634 FD_SET(io_filesfrom_f_in, &r_fds);
635 new_fd = io_filesfrom_f_in;
637 io_filesfrom_f_out = -1;
641 FD_SET(io_filesfrom_f_out, &w_fds);
642 new_fd = io_filesfrom_f_out;
648 tv.tv_sec = select_timeout;
653 count = select(maxfd + 1, &r_fds, &w_fds, NULL, &tv);
656 if (errno == EBADF) {
657 defer_forwarding_messages = 0;
658 exit_cleanup(RERR_SOCKETIO);
664 if (io_filesfrom_f_out >= 0) {
666 if (FD_ISSET(io_filesfrom_f_out, &w_fds)) {
667 int l = write(io_filesfrom_f_out,
668 ff_buf.buf + ff_buf.pos,
671 if (!(ff_buf.len -= l))
675 } else if (errno != EINTR) {
676 /* XXX should we complain? */
677 io_filesfrom_f_out = -1;
680 } else if (io_filesfrom_f_in >= 0) {
681 if (FD_ISSET(io_filesfrom_f_in, &r_fds)) {
683 xbuf *ibuf = filesfrom_convert ? &iconv_buf : &ff_buf;
685 xbuf *ibuf = &ff_buf;
687 int l = read(io_filesfrom_f_in, ibuf->buf, ibuf->size);
689 if (l == 0 || errno != EINTR) {
690 /* Send end-of-file marker */
691 memcpy(ff_buf.buf, "\0\0", 2);
692 ff_buf.len = ff_lastchar? 2 : 1;
694 io_filesfrom_f_in = -1;
698 if (filesfrom_convert) {
701 iconvbufs(ic_send, &iconv_buf, &ff_buf,
702 ICB_EXPAND_OUT|ICB_INCLUDE_BAD|ICB_INCLUDE_INCOMPLETE);
707 char *s = ff_buf.buf + l;
708 /* Transform CR and/or LF into '\0' */
709 while (s-- > ff_buf.buf) {
710 if (*s == '\n' || *s == '\r')
715 /* Last buf ended with a '\0', so don't
716 * let this buf start with one. */
717 while (l && ff_buf.buf[ff_buf.pos] == '\0')
723 char *f = ff_buf.buf + ff_buf.pos;
726 /* Eliminate any multi-'\0' runs. */
728 if (!(*t++ = *f++)) {
729 while (f != eob && !*f)
741 if (!FD_ISSET(fd, &r_fds))
744 n = read(fd, buf, len);
748 whine_about_eof(fd); /* Doesn't return. */
749 if (errno == EINTR || errno == EWOULDBLOCK
753 /* Don't write errors on a dead socket. */
754 if (fd == sock_f_in) {
755 io_end_multiplex_out();
756 rsyserr(FERROR_SOCKET, errno, "read error");
758 rsyserr(FERROR, errno, "read error");
759 exit_cleanup(RERR_STREAMIO);
766 if (fd == sock_f_in && io_timeout)
767 last_io_in = time(NULL);
773 /* Read a line into the "buf" buffer. */
774 int read_line(int fd, char *buf, size_t bufsiz, int flags)
780 if (flags & RL_CONVERT && iconv_buf.size < bufsiz)
781 realloc_xbuf(&iconv_buf, bufsiz + 1024);
786 s = flags & RL_CONVERT ? iconv_buf.buf : buf;
790 eob = s + bufsiz - 1;
792 cnt = read(fd, &ch, 1);
793 if (cnt < 0 && (errno == EWOULDBLOCK
794 || errno == EINTR || errno == EAGAIN)) {
801 tv.tv_sec = select_timeout;
803 if (!select(fd+1, &r_fds, NULL, &e_fds, &tv))
805 /*if (FD_ISSET(fd, &e_fds))
806 rprintf(FINFO, "select exception on fd %d\n", fd); */
811 if (flags & RL_EOL_NULLS ? ch == '\0' : (ch == '\r' || ch == '\n')) {
812 /* Skip empty lines if dumping comments. */
813 if (flags & RL_DUMP_COMMENTS && s == buf)
822 if (flags & RL_DUMP_COMMENTS && (*buf == '#' || *buf == ';'))
826 if (flags & RL_CONVERT) {
828 INIT_XBUF(outbuf, buf, 0, bufsiz);
830 iconv_buf.len = s - iconv_buf.buf;
831 iconvbufs(ic_recv, &iconv_buf, &outbuf,
832 ICB_INCLUDE_BAD | ICB_INCLUDE_INCOMPLETE);
833 outbuf.buf[outbuf.len] = '\0';
841 void read_args(int f_in, char *mod_name, char *buf, size_t bufsiz, int rl_nulls,
842 char ***argv_p, int *argc_p, char **request_p)
844 int maxargs = MAX_ARGS;
848 int rl_flags = (rl_nulls ? RL_EOL_NULLS : 0);
851 rl_flags |= (protect_args && ic_recv != (iconv_t)-1 ? RL_CONVERT : 0);
854 if (!(argv = new_array(char *, maxargs)))
855 out_of_memory("read_args");
856 if (mod_name && !protect_args)
857 argv[argc++] = "rsyncd";
860 if (read_line(f_in, buf, bufsiz, rl_flags) == 0)
863 if (argc == maxargs-1) {
865 if (!(argv = realloc_array(argv, char *, maxargs)))
866 out_of_memory("read_args");
871 *request_p = strdup(buf);
875 glob_expand_module(mod_name, buf, &argv, &argc, &maxargs);
877 glob_expand(buf, &argv, &argc, &maxargs);
879 if (!(p = strdup(buf)))
880 out_of_memory("read_args");
882 if (*p == '.' && p[1] == '\0')
888 glob_expand(NULL, NULL, NULL, NULL);
894 int io_start_buffering_out(int f_out)
897 assert(f_out == iobuf_f_out);
900 if (!(iobuf_out = new_array(char, IO_BUFFER_SIZE)))
901 out_of_memory("io_start_buffering_out");
907 int io_start_buffering_in(int f_in)
910 assert(f_in == iobuf_f_in);
913 iobuf_in_siz = 2 * IO_BUFFER_SIZE;
914 if (!(iobuf_in = new_array(char, iobuf_in_siz)))
915 out_of_memory("io_start_buffering_in");
920 void io_end_buffering_in(void)
927 iobuf_in_remaining = 0;
931 void io_end_buffering_out(void)
935 io_flush(FULL_FLUSH);
941 void maybe_flush_socket(int important)
943 if (iobuf_out && iobuf_out_cnt
944 && (important || time(NULL) - last_io_out >= 5))
945 io_flush(NORMAL_FLUSH);
948 void maybe_send_keepalive(void)
950 if (time(NULL) - last_io_out >= allowed_lull) {
951 if (!iobuf_out || !iobuf_out_cnt) {
952 if (protocol_version < 29)
953 return; /* there's nothing we can do */
954 if (protocol_version >= 30)
955 send_msg(MSG_NOOP, "", 0, 0);
957 write_int(sock_f_out, cur_flist->used);
958 write_shortint(sock_f_out, ITEM_IS_NEW);
962 io_flush(NORMAL_FLUSH);
966 void start_flist_forward(int f_in)
968 assert(iobuf_out != NULL);
969 assert(iobuf_f_out == msg_fd_out);
970 flist_forward_from = f_in;
973 void stop_flist_forward()
975 flist_forward_from = -1;
976 io_flush(FULL_FLUSH);
980 * Continue trying to read len bytes - don't return until len has been
983 static void read_loop(int fd, char *buf, size_t len)
986 int n = read_timeout(fd, buf, len);
994 * Read from the file descriptor handling multiplexing - return number
997 * Never returns <= 0.
999 static int readfd_unbuffered(int fd, char *buf, size_t len)
1003 char line[BIGPATHBUFLEN];
1005 if (!iobuf_in || fd != iobuf_f_in)
1006 return read_timeout(fd, buf, len);
1008 if (!io_multiplexing_in && iobuf_in_remaining == 0) {
1009 iobuf_in_remaining = read_timeout(fd, iobuf_in, iobuf_in_siz);
1014 if (iobuf_in_remaining) {
1015 len = MIN(len, iobuf_in_remaining);
1016 memcpy(buf, iobuf_in + iobuf_in_ndx, len);
1017 iobuf_in_ndx += len;
1018 iobuf_in_remaining -= len;
1023 read_loop(fd, line, 4);
1024 tag = IVAL(line, 0);
1026 msg_bytes = tag & 0xFFFFFF;
1027 tag = (tag >> 24) - MPLEX_BASE;
1031 if (msg_bytes > iobuf_in_siz) {
1032 if (!(iobuf_in = realloc_array(iobuf_in, char,
1034 out_of_memory("readfd_unbuffered");
1035 iobuf_in_siz = msg_bytes;
1037 read_loop(fd, iobuf_in, msg_bytes);
1038 iobuf_in_remaining = msg_bytes;
1043 maybe_send_keepalive();
1048 read_loop(fd, line, msg_bytes);
1049 send_msg_int(MSG_IO_ERROR, IVAL(line, 0));
1050 io_error |= IVAL(line, 0);
1056 if (am_sender && am_server)
1057 write_del_stats(sock_f_out);
1060 if (msg_bytes >= sizeof line)
1063 if (ic_recv != (iconv_t)-1) {
1068 INIT_CONST_XBUF(outbuf, line);
1069 INIT_XBUF(inbuf, ibuf, 0, (size_t)-1);
1072 inbuf.len = msg_bytes > sizeof ibuf
1073 ? sizeof ibuf : msg_bytes;
1074 read_loop(fd, inbuf.buf, inbuf.len);
1075 if (!(msg_bytes -= inbuf.len)
1076 && !ibuf[inbuf.len-1])
1077 inbuf.len--, add_null = 1;
1078 if (iconvbufs(ic_send, &inbuf, &outbuf,
1079 ICB_INCLUDE_BAD | ICB_INCLUDE_INCOMPLETE) < 0)
1083 if (outbuf.len == outbuf.size)
1085 outbuf.buf[outbuf.len++] = '\0';
1087 msg_bytes = outbuf.len;
1090 read_loop(fd, line, msg_bytes);
1091 /* A directory name was sent with the trailing null */
1092 if (msg_bytes > 0 && !line[msg_bytes-1])
1093 log_delete(line, S_IFDIR);
1095 line[msg_bytes] = '\0';
1096 log_delete(line, S_IFREG);
1100 if (msg_bytes != 4) {
1102 rprintf(FERROR, "invalid multi-message %d:%ld [%s]\n",
1103 tag, (long)msg_bytes, who_am_i());
1104 exit_cleanup(RERR_STREAMIO);
1106 read_loop(fd, line, msg_bytes);
1107 successful_send(IVAL(line, 0));
1112 read_loop(fd, line, msg_bytes);
1113 send_msg_int(MSG_NO_SEND, IVAL(line, 0));
1117 case MSG_ERROR_XFER:
1119 if (msg_bytes >= sizeof line) {
1122 "multiplexing overflow %d:%ld [%s]\n",
1123 tag, (long)msg_bytes, who_am_i());
1124 exit_cleanup(RERR_STREAMIO);
1126 read_loop(fd, line, msg_bytes);
1127 rwrite((enum logcode)tag, line, msg_bytes, 1);
1128 if (first_message) {
1129 if (list_only && !am_sender && tag == 1) {
1130 line[msg_bytes] = '\0';
1131 check_for_d_option_error(line);
1137 rprintf(FERROR, "unexpected tag %d [%s]\n",
1139 exit_cleanup(RERR_STREAMIO);
1143 if (iobuf_in_remaining == 0)
1144 io_flush(NORMAL_FLUSH);
1149 /* Do a buffered read from fd. Don't return until all N bytes have
1150 * been read. If all N can't be read then exit with an error. */
1151 static void readfd(int fd, char *buffer, size_t N)
1157 cnt = readfd_unbuffered(fd, buffer + total, N-total);
1161 if (fd == write_batch_monitor_in) {
1162 if ((size_t)write(batch_fd, buffer, total) != total)
1163 exit_cleanup(RERR_FILEIO);
1166 if (fd == flist_forward_from)
1167 writefd(iobuf_f_out, buffer, total);
1169 if (fd == sock_f_in)
1170 stats.total_read += total;
1173 unsigned short read_shortint(int f)
1177 return (UVAL(b, 1) << 8) + UVAL(b, 0);
1180 int32 read_int(int f)
1187 #if SIZEOF_INT32 > 4
1188 if (num & (int32)0x80000000)
1189 num |= ~(int32)0xffffffff;
1194 int32 read_varint(int f)
1204 readfd(f, (char*)&ch, 1);
1205 extra = int_byte_extra[ch / 4];
1207 uchar bit = ((uchar)1<<(8-extra));
1208 if (extra >= (int)sizeof u.b) {
1209 rprintf(FERROR, "Overflow in read_varint()\n");
1210 exit_cleanup(RERR_STREAMIO);
1212 readfd(f, u.b, extra);
1213 u.b[extra] = ch & (bit-1);
1216 #if CAREFUL_ALIGNMENT
1219 #if SIZEOF_INT32 > 4
1220 if (u.x & (int32)0x80000000)
1221 u.x |= ~(int32)0xffffffff;
1226 int64 read_varlong(int f, uchar min_bytes)
1235 #if SIZEOF_INT64 < 8
1240 readfd(f, b2, min_bytes);
1241 memcpy(u.b, b2+1, min_bytes-1);
1242 extra = int_byte_extra[CVAL(b2, 0) / 4];
1244 uchar bit = ((uchar)1<<(8-extra));
1245 if (min_bytes + extra > (int)sizeof u.b) {
1246 rprintf(FERROR, "Overflow in read_varlong()\n");
1247 exit_cleanup(RERR_STREAMIO);
1249 readfd(f, u.b + min_bytes - 1, extra);
1250 u.b[min_bytes + extra - 1] = CVAL(b2, 0) & (bit-1);
1251 #if SIZEOF_INT64 < 8
1252 if (min_bytes + extra > 5 || u.b[4] || CVAL(u.b,3) & 0x80) {
1253 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1254 exit_cleanup(RERR_UNSUPPORTED);
1258 u.b[min_bytes + extra - 1] = CVAL(b2, 0);
1259 #if SIZEOF_INT64 < 8
1261 #elif CAREFUL_ALIGNMENT
1262 u.x = IVAL(u.b,0) | (((int64)IVAL(u.b,4))<<32);
1267 int64 read_longint(int f)
1269 #if SIZEOF_INT64 >= 8
1272 int32 num = read_int(f);
1274 if (num != (int32)0xffffffff)
1277 #if SIZEOF_INT64 < 8
1278 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1279 exit_cleanup(RERR_UNSUPPORTED);
1282 return IVAL(b,0) | (((int64)IVAL(b,4))<<32);
1286 void read_buf(int f, char *buf, size_t len)
1291 void read_sbuf(int f, char *buf, size_t len)
1293 readfd(f, buf, len);
1297 uchar read_byte(int f)
1300 readfd(f, (char *)&c, 1);
1304 int read_vstring(int f, char *buf, int bufsize)
1306 int len = read_byte(f);
1309 len = (len & ~0x80) * 0x100 + read_byte(f);
1311 if (len >= bufsize) {
1312 rprintf(FERROR, "over-long vstring received (%d > %d)\n",
1318 readfd(f, buf, len);
1323 /* Populate a sum_struct with values from the socket. This is
1324 * called by both the sender and the receiver. */
1325 void read_sum_head(int f, struct sum_struct *sum)
1327 int32 max_blength = protocol_version < 30 ? OLD_MAX_BLOCK_SIZE : MAX_BLOCK_SIZE;
1328 sum->count = read_int(f);
1329 if (sum->count < 0) {
1330 rprintf(FERROR, "Invalid checksum count %ld [%s]\n",
1331 (long)sum->count, who_am_i());
1332 exit_cleanup(RERR_PROTOCOL);
1334 sum->blength = read_int(f);
1335 if (sum->blength < 0 || sum->blength > max_blength) {
1336 rprintf(FERROR, "Invalid block length %ld [%s]\n",
1337 (long)sum->blength, who_am_i());
1338 exit_cleanup(RERR_PROTOCOL);
1340 sum->s2length = protocol_version < 27 ? csum_length : (int)read_int(f);
1341 if (sum->s2length < 0 || sum->s2length > MAX_DIGEST_LEN) {
1342 rprintf(FERROR, "Invalid checksum length %d [%s]\n",
1343 sum->s2length, who_am_i());
1344 exit_cleanup(RERR_PROTOCOL);
1346 sum->remainder = read_int(f);
1347 if (sum->remainder < 0 || sum->remainder > sum->blength) {
1348 rprintf(FERROR, "Invalid remainder length %ld [%s]\n",
1349 (long)sum->remainder, who_am_i());
1350 exit_cleanup(RERR_PROTOCOL);
1354 /* Send the values from a sum_struct over the socket. Set sum to
1355 * NULL if there are no checksums to send. This is called by both
1356 * the generator and the sender. */
1357 void write_sum_head(int f, struct sum_struct *sum)
1359 static struct sum_struct null_sum;
1364 write_int(f, sum->count);
1365 write_int(f, sum->blength);
1366 if (protocol_version >= 27)
1367 write_int(f, sum->s2length);
1368 write_int(f, sum->remainder);
1372 * Sleep after writing to limit I/O bandwidth usage.
1374 * @todo Rather than sleeping after each write, it might be better to
1375 * use some kind of averaging. The current algorithm seems to always
1376 * use a bit less bandwidth than specified, because it doesn't make up
1377 * for slow periods. But arguably this is a feature. In addition, we
1378 * ought to take the time used to write the data into account.
1380 * During some phases of big transfers (file FOO is uptodate) this is
1381 * called with a small bytes_written every time. As the kernel has to
1382 * round small waits up to guarantee that we actually wait at least the
1383 * requested number of microseconds, this can become grossly inaccurate.
1384 * We therefore keep track of the bytes we've written over time and only
1385 * sleep when the accumulated delay is at least 1 tenth of a second.
1387 static void sleep_for_bwlimit(int bytes_written)
1389 static struct timeval prior_tv;
1390 static long total_written = 0;
1391 struct timeval tv, start_tv;
1392 long elapsed_usec, sleep_usec;
1394 #define ONE_SEC 1000000L /* # of microseconds in a second */
1396 if (!bwlimit_writemax)
1399 total_written += bytes_written;
1401 gettimeofday(&start_tv, NULL);
1402 if (prior_tv.tv_sec) {
1403 elapsed_usec = (start_tv.tv_sec - prior_tv.tv_sec) * ONE_SEC
1404 + (start_tv.tv_usec - prior_tv.tv_usec);
1405 total_written -= elapsed_usec * bwlimit / (ONE_SEC/1024);
1406 if (total_written < 0)
1410 sleep_usec = total_written * (ONE_SEC/1024) / bwlimit;
1411 if (sleep_usec < ONE_SEC / 10) {
1412 prior_tv = start_tv;
1416 tv.tv_sec = sleep_usec / ONE_SEC;
1417 tv.tv_usec = sleep_usec % ONE_SEC;
1418 select(0, NULL, NULL, NULL, &tv);
1420 gettimeofday(&prior_tv, NULL);
1421 elapsed_usec = (prior_tv.tv_sec - start_tv.tv_sec) * ONE_SEC
1422 + (prior_tv.tv_usec - start_tv.tv_usec);
1423 total_written = (sleep_usec - elapsed_usec) * bwlimit / (ONE_SEC/1024);
1426 static const char *what_fd_is(int fd)
1428 static char buf[20];
1430 if (fd == sock_f_out)
1432 else if (fd == msg_fd_out)
1433 return "message fd";
1434 else if (fd == batch_fd)
1435 return "batch file";
1437 snprintf(buf, sizeof buf, "fd %d", fd);
1442 /* Write len bytes to the file descriptor fd, looping as necessary to get
1443 * the job done and also (in certain circumstances) reading any data on
1444 * msg_fd_in to avoid deadlock.
1446 * This function underlies the multiplexing system. The body of the
1447 * application never calls this function directly. */
1448 static void writefd_unbuffered(int fd, const char *buf, size_t len)
1450 size_t n, total = 0;
1451 fd_set w_fds, r_fds, e_fds;
1452 int maxfd, count, cnt, using_r_fds;
1457 defer_forwarding_messages++, defer_inc++;
1459 while (total < len) {
1466 if (msg_fd_in >= 0) {
1468 FD_SET(msg_fd_in, &r_fds);
1469 if (msg_fd_in > maxfd)
1475 tv.tv_sec = select_timeout;
1479 count = select(maxfd + 1, using_r_fds ? &r_fds : NULL,
1480 &w_fds, &e_fds, &tv);
1483 if (count < 0 && errno == EBADF)
1484 exit_cleanup(RERR_SOCKETIO);
1489 /*if (FD_ISSET(fd, &e_fds))
1490 rprintf(FINFO, "select exception on fd %d\n", fd); */
1492 if (using_r_fds && FD_ISSET(msg_fd_in, &r_fds))
1495 if (!FD_ISSET(fd, &w_fds))
1499 if (bwlimit_writemax && n > bwlimit_writemax)
1500 n = bwlimit_writemax;
1501 cnt = write(fd, buf + total, n);
1507 if (errno == EWOULDBLOCK || errno == EAGAIN) {
1513 /* Don't try to write errors back across the stream. */
1514 if (fd == sock_f_out)
1515 io_end_multiplex_out();
1516 /* Don't try to write errors down a failing msg pipe. */
1517 if (am_server && fd == msg_fd_out)
1518 exit_cleanup(RERR_STREAMIO);
1519 rsyserr(FERROR, errno,
1520 "writefd_unbuffered failed to write %ld bytes to %s [%s]",
1521 (long)len, what_fd_is(fd), who_am_i());
1522 /* If the other side is sending us error messages, try
1523 * to grab any messages they sent before they died. */
1524 while (!am_server && fd == sock_f_out && io_multiplexing_in) {
1528 readfd_unbuffered(sock_f_in, buf, sizeof buf);
1530 exit_cleanup(RERR_STREAMIO);
1534 defer_forwarding_messages++, defer_inc++;
1536 if (fd == sock_f_out) {
1537 if (io_timeout || am_generator)
1538 last_io_out = time(NULL);
1539 sleep_for_bwlimit(cnt);
1544 if (keep_defer_forwarding)
1546 if (!(defer_forwarding_messages -= defer_inc) && !no_flush)
1550 int io_flush(int flush_it_all)
1552 int flushed_something = 0;
1557 if (iobuf_out_cnt) {
1558 if (io_multiplexing_out)
1559 mplex_write(sock_f_out, MSG_DATA, iobuf_out, iobuf_out_cnt, 0);
1561 writefd_unbuffered(iobuf_f_out, iobuf_out, iobuf_out_cnt);
1563 flushed_something = 1;
1566 if (flush_it_all && !defer_forwarding_messages && msg_queue.head) {
1568 flushed_something = 1;
1571 return flushed_something;
1574 static void writefd(int fd, const char *buf, size_t len)
1576 if (fd == sock_f_out)
1577 stats.total_written += len;
1579 if (fd == write_batch_monitor_out)
1580 writefd_unbuffered(batch_fd, buf, len);
1582 if (!iobuf_out || fd != iobuf_f_out) {
1583 writefd_unbuffered(fd, buf, len);
1588 int n = MIN((int)len, IO_BUFFER_SIZE - iobuf_out_cnt);
1590 memcpy(iobuf_out+iobuf_out_cnt, buf, n);
1596 if (iobuf_out_cnt == IO_BUFFER_SIZE)
1597 io_flush(NORMAL_FLUSH);
1601 void write_shortint(int f, unsigned short x)
1605 b[1] = (char)(x >> 8);
1609 void write_int(int f, int32 x)
1616 void write_varint(int f, int32 x)
1624 while (cnt > 1 && b[cnt] == 0)
1626 bit = ((uchar)1<<(7-cnt+1));
1627 if (CVAL(b, cnt) >= bit) {
1631 *b = b[cnt] | ~(bit*2-1);
1638 void write_varlong(int f, int64 x, uchar min_bytes)
1645 #if SIZEOF_INT64 >= 8
1646 SIVAL(b, 5, x >> 32);
1648 if (x <= 0x7FFFFFFF && x >= 0)
1649 memset(b + 5, 0, 4);
1651 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1652 exit_cleanup(RERR_UNSUPPORTED);
1656 while (cnt > min_bytes && b[cnt] == 0)
1658 bit = ((uchar)1<<(7-cnt+min_bytes));
1659 if (CVAL(b, cnt) >= bit) {
1662 } else if (cnt > min_bytes)
1663 *b = b[cnt] | ~(bit*2-1);
1671 * Note: int64 may actually be a 32-bit type if ./configure couldn't find any
1672 * 64-bit types on this platform.
1674 void write_longint(int f, int64 x)
1676 char b[12], * const s = b+4;
1679 if (x <= 0x7FFFFFFF && x >= 0) {
1684 #if SIZEOF_INT64 < 8
1685 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1686 exit_cleanup(RERR_UNSUPPORTED);
1689 SIVAL(s, 4, x >> 32);
1694 void write_buf(int f, const char *buf, size_t len)
1699 /** Write a string to the connection */
1700 void write_sbuf(int f, const char *buf)
1702 writefd(f, buf, strlen(buf));
1705 void write_byte(int f, uchar c)
1707 writefd(f, (char *)&c, 1);
1710 void write_vstring(int f, const char *str, int len)
1712 uchar lenbuf[3], *lb = lenbuf;
1717 "attempting to send over-long vstring (%d > %d)\n",
1719 exit_cleanup(RERR_PROTOCOL);
1721 *lb++ = len / 0x100 + 0x80;
1725 writefd(f, (char*)lenbuf, lb - lenbuf + 1);
1727 writefd(f, str, len);
1730 /* Send a file-list index using a byte-reduction method. */
1731 void write_ndx(int f, int32 ndx)
1733 static int32 prev_positive = -1, prev_negative = 1;
1734 int32 diff, cnt = 0;
1737 if (protocol_version < 30 || read_batch) {
1742 /* Send NDX_DONE as a single-byte 0 with no side effects. Send
1743 * negative nums as a positive after sending a leading 0xFF. */
1745 diff = ndx - prev_positive;
1746 prev_positive = ndx;
1747 } else if (ndx == NDX_DONE) {
1752 b[cnt++] = (char)0xFF;
1754 diff = ndx - prev_negative;
1755 prev_negative = ndx;
1758 /* A diff of 1 - 253 is sent as a one-byte diff; a diff of 254 - 32767
1759 * or 0 is sent as a 0xFE + a two-byte diff; otherwise we send 0xFE
1760 * & all 4 bytes of the (non-negative) num with the high-bit set. */
1761 if (diff < 0xFE && diff > 0)
1762 b[cnt++] = (char)diff;
1763 else if (diff < 0 || diff > 0x7FFF) {
1764 b[cnt++] = (char)0xFE;
1765 b[cnt++] = (char)((ndx >> 24) | 0x80);
1766 b[cnt++] = (char)ndx;
1767 b[cnt++] = (char)(ndx >> 8);
1768 b[cnt++] = (char)(ndx >> 16);
1770 b[cnt++] = (char)0xFE;
1771 b[cnt++] = (char)(diff >> 8);
1772 b[cnt++] = (char)diff;
1777 /* Receive a file-list index using a byte-reduction method. */
1778 int32 read_ndx(int f)
1780 static int32 prev_positive = -1, prev_negative = 1;
1781 int32 *prev_ptr, num;
1784 if (protocol_version < 30)
1788 if (CVAL(b, 0) == 0xFF) {
1790 prev_ptr = &prev_negative;
1791 } else if (CVAL(b, 0) == 0)
1794 prev_ptr = &prev_positive;
1795 if (CVAL(b, 0) == 0xFE) {
1797 if (CVAL(b, 0) & 0x80) {
1798 b[3] = CVAL(b, 0) & ~0x80;
1803 num = (UVAL(b,0)<<8) + UVAL(b,1) + *prev_ptr;
1805 num = UVAL(b, 0) + *prev_ptr;
1807 if (prev_ptr == &prev_negative)
1812 /* Read a line of up to bufsiz-1 characters into buf. Strips
1813 * the (required) trailing newline and all carriage returns.
1814 * Returns 1 for success; 0 for I/O error or truncation. */
1815 int read_line_old(int f, char *buf, size_t bufsiz)
1817 bufsiz--; /* leave room for the null */
1818 while (bufsiz > 0) {
1820 read_buf(f, buf, 1);
1825 if (buf[0] != '\r') {
1834 void io_printf(int fd, const char *format, ...)
1837 char buf[BIGPATHBUFLEN];
1840 va_start(ap, format);
1841 len = vsnprintf(buf, sizeof buf, format, ap);
1845 exit_cleanup(RERR_STREAMIO);
1847 if (len > (int)sizeof buf) {
1848 rprintf(FERROR, "io_printf() was too long for the buffer.\n");
1849 exit_cleanup(RERR_STREAMIO);
1852 write_sbuf(fd, buf);
1855 /** Setup for multiplexing a MSG_* stream with the data stream. */
1856 void io_start_multiplex_out(void)
1858 io_flush(NORMAL_FLUSH);
1859 io_start_buffering_out(sock_f_out);
1860 io_multiplexing_out = 1;
1863 /** Setup for multiplexing a MSG_* stream with the data stream. */
1864 void io_start_multiplex_in(void)
1866 io_flush(NORMAL_FLUSH);
1867 io_start_buffering_in(sock_f_in);
1868 io_multiplexing_in = 1;
1871 /** Write an message to the multiplexed data stream. */
1872 int io_multiplex_write(enum msgcode code, const char *buf, size_t len, int convert)
1874 if (!io_multiplexing_out)
1876 io_flush(NORMAL_FLUSH);
1877 stats.total_written += (len+4);
1878 mplex_write(sock_f_out, code, buf, len, convert);
1882 void io_end_multiplex_in(void)
1884 io_multiplexing_in = 0;
1885 io_end_buffering_in();
1888 /** Stop output multiplexing. */
1889 void io_end_multiplex_out(void)
1891 io_multiplexing_out = 0;
1892 io_end_buffering_out();
1895 void start_write_batch(int fd)
1897 /* Some communication has already taken place, but we don't
1898 * enable batch writing until here so that we can write a
1899 * canonical record of the communication even though the
1900 * actual communication so far depends on whether a daemon
1902 write_int(batch_fd, protocol_version);
1903 if (protocol_version >= 30)
1904 write_byte(batch_fd, inc_recurse);
1905 write_int(batch_fd, checksum_seed);
1908 write_batch_monitor_out = fd;
1910 write_batch_monitor_in = fd;
1913 void stop_write_batch(void)
1915 write_batch_monitor_out = -1;
1916 write_batch_monitor_in = -1;