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(). */
33 /** If no timeout is specified then use a 60 second select timeout */
34 #define SELECT_TIMEOUT 60
37 extern size_t bwlimit_writemax;
38 extern int io_timeout;
42 extern int am_generator;
43 extern int inc_recurse;
48 extern int read_batch;
49 extern int compat_flags;
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 check_timeout(void)
126 if (!io_timeout || ignore_timeout)
134 chk = MAX(last_io_out, last_io_in);
135 if (t - chk >= io_timeout) {
136 if (am_server || am_daemon)
137 exit_cleanup(RERR_TIMEOUT);
138 rprintf(FERROR, "[%s] io timeout after %d seconds -- exiting\n",
139 who_am_i(), (int)(t-chk));
140 exit_cleanup(RERR_TIMEOUT);
144 static void readfd(int fd, char *buffer, size_t N);
145 static void writefd(int fd, const char *buf, size_t len);
146 static void writefd_unbuffered(int fd, const char *buf, size_t len);
147 static void mplex_write(int fd, enum msgcode code, const char *buf, size_t len, int convert);
149 static flist_ndx_list redo_list, hlink_list;
151 struct msg_list_item {
152 struct msg_list_item *next;
158 struct msg_list_item *head, *tail;
161 static struct msg_list msg_queue;
163 static void got_flist_entry_status(enum festatus status, const char *buf)
165 int ndx = IVAL(buf, 0);
166 struct file_list *flist = flist_for_ndx(ndx, "got_flist_entry_status");
168 if (remove_source_files) {
170 active_bytecnt -= F_LENGTH(flist->files[ndx - flist->ndx_start]);
174 flist->in_progress--;
178 if (remove_source_files)
179 send_msg(MSG_SUCCESS, buf, 4, 0);
182 #ifdef SUPPORT_HARD_LINKS
183 if (preserve_hard_links) {
184 struct file_struct *file = flist->files[ndx - flist->ndx_start];
185 if (F_IS_HLINKED(file)) {
186 if (status == FES_NO_SEND)
187 flist_ndx_push(&hlink_list, -2); /* indicates a failure follows */
188 flist_ndx_push(&hlink_list, ndx);
189 flist->in_progress++;
197 flist->in_progress++;
202 flist_ndx_push(&redo_list, ndx);
207 /* Note the fds used for the main socket (which might really be a pipe
208 * for a local transfer, but we can ignore that). */
209 void io_set_sock_fds(int f_in, int f_out)
215 void set_io_timeout(int secs)
218 allowed_lull = (io_timeout + 1) / 2;
220 if (!io_timeout || allowed_lull > SELECT_TIMEOUT)
221 select_timeout = SELECT_TIMEOUT;
223 select_timeout = allowed_lull;
229 /* Setup the fd used to receive MSG_* messages. Only needed during the
230 * early stages of being a local sender (up through the sending of the
231 * file list) or when we're the generator (to fetch the messages from
233 void set_msg_fd_in(int fd)
238 /* Setup the fd used to send our MSG_* messages. Only needed when
239 * we're the receiver (to send our messages to the generator). */
240 void set_msg_fd_out(int fd)
243 set_nonblocking(msg_fd_out);
246 /* Add a message to the pending MSG_* list. */
247 static void msg_list_add(struct msg_list *lst, int code, const char *buf, int len, int convert)
249 struct msg_list_item *m;
250 int sz = len + 4 + sizeof m[0] - 1;
252 if (!(m = (struct msg_list_item *)new_array(char, sz)))
253 out_of_memory("msg_list_add");
255 m->convert = convert;
256 SIVAL(m->buf, 0, ((code+MPLEX_BASE)<<24) | len);
257 memcpy(m->buf + 4, buf, len);
265 static inline int flush_a_msg(int fd)
267 struct msg_list_item *m = msg_queue.head;
268 int len = IVAL(m->buf, 0) & 0xFFFFFF;
269 int tag = *((uchar*)m->buf+3) - MPLEX_BASE;
271 if (!(msg_queue.head = m->next))
272 msg_queue.tail = NULL;
274 defer_forwarding_messages++;
275 mplex_write(fd, tag, m->buf + 4, len, m->convert);
276 defer_forwarding_messages--;
283 static void msg_flush(void)
286 while (msg_queue.head && io_multiplexing_out)
287 stats.total_written += flush_a_msg(sock_f_out) + 4;
289 while (msg_queue.head)
290 (void)flush_a_msg(msg_fd_out);
294 static void check_for_d_option_error(const char *msg)
296 static char rsync263_opts[] = "BCDHIKLPRSTWabceghlnopqrtuvxz";
301 || strncmp(msg, REMOTE_OPTION_ERROR, sizeof REMOTE_OPTION_ERROR - 1) != 0)
304 msg += sizeof REMOTE_OPTION_ERROR - 1;
305 if (*msg == '-' || (colon = strchr(msg, ':')) == NULL
306 || strncmp(colon, REMOTE_OPTION_ERROR2, sizeof REMOTE_OPTION_ERROR2 - 1) != 0)
309 for ( ; *msg != ':'; msg++) {
312 else if (*msg == 'e')
314 else if (strchr(rsync263_opts, *msg) == NULL)
320 "*** Try using \"--old-d\" if remote rsync is <= 2.6.3 ***\n");
324 /* Read a message from the MSG_* fd and handle it. This is called either
325 * during the early stages of being a local sender (up through the sending
326 * of the file list) or when we're the generator (to fetch the messages
327 * from the receiver). */
328 static void read_msg_fd(void)
332 struct file_list *flist;
336 /* Temporarily disable msg_fd_in. This is needed to avoid looping back
337 * to this routine from writefd_unbuffered(). */
340 defer_forwarding_messages++;
345 len = tag & 0xFFFFFF;
346 tag = (tag >> 24) - MPLEX_BASE;
350 if (len < 0 || len > 1 || !am_generator) {
352 rprintf(FERROR, "invalid message %d:%d [%s%s]\n",
353 tag, len, who_am_i(),
354 inc_recurse ? "/inc" : "");
355 exit_cleanup(RERR_STREAMIO);
358 readfd(fd, buf, len);
359 stats.total_read = read_varlong(fd, 3);
364 if (len != 4 || !am_generator)
367 got_flist_entry_status(FES_REDO, buf);
370 if (len != 4 || !am_generator || !inc_recurse)
373 /* Read extra file list from receiver. */
374 assert(iobuf_in != NULL);
375 assert(iobuf_f_in == fd);
377 rprintf(FINFO, "[%s] receiving flist for dir %d\n",
378 who_am_i(), IVAL(buf,0));
380 flist = recv_file_list(fd);
381 flist->parent_ndx = IVAL(buf,0);
382 #ifdef SUPPORT_HARD_LINKS
383 if (preserve_hard_links)
384 match_hard_links(flist);
388 if (len != 0 || !am_generator || !inc_recurse)
395 readfd(fd, buf, len);
396 io_error |= IVAL(buf, 0);
399 if (len >= (int)sizeof buf || !am_generator)
401 readfd(fd, buf, len);
402 send_msg(MSG_DELETED, buf, len, 1);
405 if (len != 4 || !am_generator)
408 got_flist_entry_status(FES_SUCCESS, buf);
411 if (len != 4 || !am_generator)
414 got_flist_entry_status(FES_NO_SEND, buf);
416 case MSG_ERROR_SOCKET:
421 if (tag == MSG_ERROR_SOCKET)
422 io_end_multiplex_out();
434 rwrite((enum logcode)tag, buf, n, !am_generator);
439 rprintf(FERROR, "unknown message %d:%d [%s]\n",
440 tag, len, who_am_i());
441 exit_cleanup(RERR_STREAMIO);
446 if (!--defer_forwarding_messages && !no_flush)
450 /* This is used by the generator to limit how many file transfers can
451 * be active at once when --remove-source-files is specified. Without
452 * this, sender-side deletions were mostly happening at the end. */
453 void increment_active_files(int ndx, int itemizing, enum logcode code)
456 /* TODO: tune these limits? */
457 int limit = active_bytecnt >= 128*1024 ? 10 : 50;
458 if (active_filecnt < limit)
460 check_for_finished_files(itemizing, code, 0);
461 if (active_filecnt < limit)
464 io_flush(NORMAL_FLUSH);
470 active_bytecnt += F_LENGTH(cur_flist->files[ndx - cur_flist->ndx_start]);
473 /* Write an message to a multiplexed stream. If this fails, rsync exits. */
474 static void mplex_write(int fd, enum msgcode code, const char *buf, size_t len, int convert)
476 char buffer[BIGPATHBUFLEN]; /* Oversized for use by iconv code. */
480 /* We need to convert buf before doing anything else so that we
481 * can include the (converted) byte length in the message header. */
482 if (convert && ic_send != (iconv_t)-1) {
485 INIT_XBUF(outbuf, buffer + 4, 0, sizeof buffer - 4);
486 INIT_XBUF(inbuf, (char*)buf, len, -1);
488 iconvbufs(ic_send, &inbuf, &outbuf,
489 ICB_INCLUDE_BAD | ICB_INCLUDE_INCOMPLETE);
491 rprintf(FERROR, "overflowed conversion buffer in mplex_write");
492 exit_cleanup(RERR_UNSUPPORTED);
495 n = len = outbuf.len;
498 if (n > 1024 - 4) /* BIGPATHBUFLEN can handle 1024 bytes */
499 n = 0; /* We'd rather do 2 writes than too much memcpy(). */
501 memcpy(buffer + 4, buf, n);
503 SIVAL(buffer, 0, ((MPLEX_BASE + (int)code)<<24) + len);
505 keep_defer_forwarding++; /* defer_forwarding_messages++ on return */
506 writefd_unbuffered(fd, buffer, n+4);
507 keep_defer_forwarding--;
510 writefd_unbuffered(fd, buf+n, len-n);
512 if (!--defer_forwarding_messages && !no_flush)
516 int send_msg(enum msgcode code, const char *buf, int len, int convert)
518 if (msg_fd_out < 0) {
519 if (!defer_forwarding_messages)
520 return io_multiplex_write(code, buf, len, convert);
521 if (!io_multiplexing_out)
523 msg_list_add(&msg_queue, code, buf, len, convert);
526 if (flist_forward_from >= 0)
527 msg_list_add(&msg_queue, code, buf, len, convert);
529 mplex_write(msg_fd_out, code, buf, len, convert);
533 void send_msg_int(enum msgcode code, int num)
536 SIVAL(numbuf, 0, num);
537 send_msg(code, numbuf, 4, 0);
540 void wait_for_receiver(void)
542 if (io_flush(NORMAL_FLUSH))
547 int get_redo_num(void)
549 return flist_ndx_pop(&redo_list);
552 int get_hlink_num(void)
554 return flist_ndx_pop(&hlink_list);
558 * When we're the receiver and we have a local --files-from list of names
559 * that needs to be sent over the socket to the sender, we have to do two
560 * things at the same time: send the sender a list of what files we're
561 * processing and read the incoming file+info list from the sender. We do
562 * this by augmenting the read_timeout() function to copy this data. It
563 * uses ff_buf to read a block of data from f_in (when it is ready, since
564 * it might be a pipe) and then blast it out f_out (when it is ready to
565 * receive more data).
567 void io_set_filesfrom_fds(int f_in, int f_out)
569 io_filesfrom_f_in = f_in;
570 io_filesfrom_f_out = f_out;
571 alloc_xbuf(&ff_buf, 2048);
574 alloc_xbuf(&iconv_buf, 1024);
578 /* It's almost always an error to get an EOF when we're trying to read from the
579 * network, because the protocol is (for the most part) self-terminating.
581 * There is one case for the receiver when it is at the end of the transfer
582 * (hanging around reading any keep-alive packets that might come its way): if
583 * the sender dies before the generator's kill-signal comes through, we can end
584 * up here needing to loop until the kill-signal arrives. In this situation,
585 * kluge_around_eof will be < 0.
587 * There is another case for older protocol versions (< 24) where the module
588 * listing was not terminated, so we must ignore an EOF error in that case and
589 * exit. In this situation, kluge_around_eof will be > 0. */
590 static void whine_about_eof(int fd)
592 if (kluge_around_eof && fd == sock_f_in) {
594 if (kluge_around_eof > 0)
596 /* If we're still here after 10 seconds, exit with an error. */
597 for (i = 10*1000/20; i--; )
601 rprintf(FERROR, RSYNC_NAME ": connection unexpectedly closed "
602 "(%.0f bytes received so far) [%s]\n",
603 (double)stats.total_read, who_am_i());
605 exit_cleanup(RERR_STREAMIO);
609 * Read from a socket with I/O timeout. return the number of bytes
610 * read. If no bytes can be read then exit, never return a number <= 0.
612 * TODO: If the remote shell connection fails, then current versions
613 * actually report an "unexpected EOF" error here. Since it's a
614 * fairly common mistake to try to use rsh when ssh is required, we
615 * should trap that: if we fail to read any data at all, we should
616 * give a better explanation. We can tell whether the connection has
617 * started by looking e.g. at whether the remote version is known yet.
619 static int read_timeout(int fd, char *buf, size_t len)
623 io_flush(FULL_FLUSH);
626 /* until we manage to read *something* */
635 if (io_filesfrom_f_out >= 0) {
637 if (ff_buf.len == 0) {
638 if (io_filesfrom_f_in >= 0) {
639 FD_SET(io_filesfrom_f_in, &r_fds);
640 new_fd = io_filesfrom_f_in;
642 io_filesfrom_f_out = -1;
646 FD_SET(io_filesfrom_f_out, &w_fds);
647 new_fd = io_filesfrom_f_out;
653 tv.tv_sec = select_timeout;
658 count = select(maxfd + 1, &r_fds, &w_fds, NULL, &tv);
661 if (errno == EBADF) {
662 defer_forwarding_messages = 0;
663 exit_cleanup(RERR_SOCKETIO);
669 if (io_filesfrom_f_out >= 0) {
671 if (FD_ISSET(io_filesfrom_f_out, &w_fds)) {
672 int l = write(io_filesfrom_f_out,
673 ff_buf.buf + ff_buf.pos,
676 if (!(ff_buf.len -= l))
680 } else if (errno != EINTR) {
681 /* XXX should we complain? */
682 io_filesfrom_f_out = -1;
685 } else if (io_filesfrom_f_in >= 0) {
686 if (FD_ISSET(io_filesfrom_f_in, &r_fds)) {
688 xbuf *ibuf = filesfrom_convert ? &iconv_buf : &ff_buf;
690 xbuf *ibuf = &ff_buf;
692 int l = read(io_filesfrom_f_in, ibuf->buf, ibuf->size);
694 if (l == 0 || errno != EINTR) {
695 /* Send end-of-file marker */
696 memcpy(ff_buf.buf, "\0\0", 2);
697 ff_buf.len = ff_lastchar? 2 : 1;
699 io_filesfrom_f_in = -1;
703 if (filesfrom_convert) {
706 iconvbufs(ic_send, &iconv_buf, &ff_buf,
707 ICB_EXPAND_OUT|ICB_INCLUDE_BAD|ICB_INCLUDE_INCOMPLETE);
712 char *s = ff_buf.buf + l;
713 /* Transform CR and/or LF into '\0' */
714 while (s-- > ff_buf.buf) {
715 if (*s == '\n' || *s == '\r')
720 /* Last buf ended with a '\0', so don't
721 * let this buf start with one. */
722 while (l && ff_buf.buf[ff_buf.pos] == '\0')
728 char *f = ff_buf.buf + ff_buf.pos;
731 /* Eliminate any multi-'\0' runs. */
733 if (!(*t++ = *f++)) {
734 while (f != eob && !*f)
746 if (!FD_ISSET(fd, &r_fds))
749 n = read(fd, buf, len);
753 whine_about_eof(fd); /* Doesn't return. */
754 if (errno == EINTR || errno == EWOULDBLOCK
758 /* Don't write errors on a dead socket. */
759 if (fd == sock_f_in) {
760 io_end_multiplex_out();
761 rsyserr(FERROR_SOCKET, errno, "read error");
763 rsyserr(FERROR, errno, "read error");
764 exit_cleanup(RERR_STREAMIO);
771 if (fd == sock_f_in && io_timeout)
772 last_io_in = time(NULL);
778 /* Read a line into the "buf" buffer. */
779 int read_line(int fd, char *buf, size_t bufsiz, int flags)
785 if (flags & RL_CONVERT && iconv_buf.size < bufsiz)
786 realloc_xbuf(&iconv_buf, bufsiz + 1024);
791 s = flags & RL_CONVERT ? iconv_buf.buf : buf;
795 eob = s + bufsiz - 1;
797 cnt = read(fd, &ch, 1);
798 if (cnt < 0 && (errno == EWOULDBLOCK
799 || errno == EINTR || errno == EAGAIN)) {
806 tv.tv_sec = select_timeout;
808 if (!select(fd+1, &r_fds, NULL, &e_fds, &tv))
810 /*if (FD_ISSET(fd, &e_fds))
811 rprintf(FINFO, "select exception on fd %d\n", fd); */
816 if (flags & RL_EOL_NULLS ? ch == '\0' : (ch == '\r' || ch == '\n')) {
817 /* Skip empty lines if dumping comments. */
818 if (flags & RL_DUMP_COMMENTS && s == buf)
827 if (flags & RL_DUMP_COMMENTS && (*buf == '#' || *buf == ';'))
831 if (flags & RL_CONVERT) {
833 INIT_XBUF(outbuf, buf, 0, bufsiz);
835 iconv_buf.len = s - iconv_buf.buf;
836 iconvbufs(ic_recv, &iconv_buf, &outbuf,
837 ICB_INCLUDE_BAD | ICB_INCLUDE_INCOMPLETE);
838 outbuf.buf[outbuf.len] = '\0';
846 void read_args(int f_in, char *mod_name, char *buf, size_t bufsiz, int rl_nulls,
847 char ***argv_p, int *argc_p, char **request_p)
849 int maxargs = MAX_ARGS;
853 int rl_flags = (rl_nulls ? RL_EOL_NULLS : 0);
856 rl_flags |= (protect_args && ic_recv != (iconv_t)-1 ? RL_CONVERT : 0);
859 if (!(argv = new_array(char *, maxargs)))
860 out_of_memory("read_args");
861 if (mod_name && !protect_args)
862 argv[argc++] = "rsyncd";
865 if (read_line(f_in, buf, bufsiz, rl_flags) == 0)
868 if (argc == maxargs-1) {
870 if (!(argv = realloc_array(argv, char *, maxargs)))
871 out_of_memory("read_args");
876 *request_p = strdup(buf);
880 glob_expand_module(mod_name, buf, &argv, &argc, &maxargs);
882 glob_expand(buf, &argv, &argc, &maxargs);
884 if (!(p = strdup(buf)))
885 out_of_memory("read_args");
887 if (*p == '.' && p[1] == '\0')
893 glob_expand(NULL, NULL, NULL, NULL);
899 int io_start_buffering_out(int f_out)
902 assert(f_out == iobuf_f_out);
905 if (!(iobuf_out = new_array(char, IO_BUFFER_SIZE)))
906 out_of_memory("io_start_buffering_out");
912 int io_start_buffering_in(int f_in)
915 assert(f_in == iobuf_f_in);
918 iobuf_in_siz = 2 * IO_BUFFER_SIZE;
919 if (!(iobuf_in = new_array(char, iobuf_in_siz)))
920 out_of_memory("io_start_buffering_in");
925 void io_end_buffering_in(void)
932 iobuf_in_remaining = 0;
936 void io_end_buffering_out(void)
940 io_flush(FULL_FLUSH);
946 void maybe_flush_socket(int important)
948 if (iobuf_out && iobuf_out_cnt
949 && (important || time(NULL) - last_io_out >= 5))
950 io_flush(NORMAL_FLUSH);
953 void maybe_send_keepalive(void)
955 if (time(NULL) - last_io_out >= allowed_lull) {
956 if (!iobuf_out || !iobuf_out_cnt) {
957 if (protocol_version < 29)
958 send_msg(MSG_DATA, "", 0, 0);
959 else if (protocol_version >= 30)
960 send_msg(MSG_NOOP, "", 0, 0);
962 write_int(sock_f_out, cur_flist->used);
963 write_shortint(sock_f_out, ITEM_IS_NEW);
967 io_flush(NORMAL_FLUSH);
971 void start_flist_forward(int f_in)
973 assert(iobuf_out != NULL);
974 assert(iobuf_f_out == msg_fd_out);
975 flist_forward_from = f_in;
976 defer_forwarding_messages++;
979 void stop_flist_forward(void)
981 flist_forward_from = -1;
982 defer_forwarding_messages--;
983 io_flush(FULL_FLUSH);
987 * Continue trying to read len bytes - don't return until len has been
990 static void read_loop(int fd, char *buf, size_t len)
993 int n = read_timeout(fd, buf, len);
1001 * Read from the file descriptor handling multiplexing - return number
1004 * Never returns <= 0.
1006 static int readfd_unbuffered(int fd, char *buf, size_t len)
1010 char line[BIGPATHBUFLEN];
1012 if (!iobuf_in || fd != iobuf_f_in)
1013 return read_timeout(fd, buf, len);
1015 if (!io_multiplexing_in && iobuf_in_remaining == 0) {
1016 iobuf_in_remaining = read_timeout(fd, iobuf_in, iobuf_in_siz);
1021 if (iobuf_in_remaining) {
1022 len = MIN(len, iobuf_in_remaining);
1023 memcpy(buf, iobuf_in + iobuf_in_ndx, len);
1024 iobuf_in_ndx += len;
1025 iobuf_in_remaining -= len;
1030 read_loop(fd, line, 4);
1031 tag = IVAL(line, 0);
1033 msg_bytes = tag & 0xFFFFFF;
1034 tag = (tag >> 24) - MPLEX_BASE;
1038 if (msg_bytes > iobuf_in_siz) {
1039 if (!(iobuf_in = realloc_array(iobuf_in, char,
1041 out_of_memory("readfd_unbuffered");
1042 iobuf_in_siz = msg_bytes;
1044 read_loop(fd, iobuf_in, msg_bytes);
1045 iobuf_in_remaining = msg_bytes;
1052 maybe_send_keepalive();
1057 read_loop(fd, line, msg_bytes);
1058 send_msg_int(MSG_IO_ERROR, IVAL(line, 0));
1059 io_error |= IVAL(line, 0);
1062 if (msg_bytes >= sizeof line)
1065 if (ic_recv != (iconv_t)-1) {
1071 INIT_CONST_XBUF(outbuf, line);
1072 INIT_XBUF(inbuf, ibuf, 0, -1);
1075 inbuf.len = msg_bytes > sizeof ibuf
1076 ? sizeof ibuf : msg_bytes;
1077 read_loop(fd, inbuf.buf, inbuf.len);
1078 if (!(msg_bytes -= inbuf.len)
1079 && !ibuf[inbuf.len-1])
1080 inbuf.len--, add_null = 1;
1081 if (iconvbufs(ic_send, &inbuf, &outbuf,
1082 ICB_INCLUDE_BAD | ICB_INCLUDE_INCOMPLETE) < 0)
1087 if (outbuf.len == outbuf.size)
1089 outbuf.buf[outbuf.len++] = '\0';
1091 msg_bytes = outbuf.len;
1094 read_loop(fd, line, msg_bytes);
1095 /* A directory name was sent with the trailing null */
1096 if (msg_bytes > 0 && !line[msg_bytes-1])
1097 log_delete(line, S_IFDIR);
1099 line[msg_bytes] = '\0';
1100 log_delete(line, S_IFREG);
1104 if (msg_bytes != 4) {
1106 rprintf(FERROR, "invalid multi-message %d:%ld [%s]\n",
1107 tag, (long)msg_bytes, who_am_i());
1108 exit_cleanup(RERR_STREAMIO);
1110 read_loop(fd, line, msg_bytes);
1111 successful_send(IVAL(line, 0));
1116 read_loop(fd, line, msg_bytes);
1117 send_msg_int(MSG_NO_SEND, IVAL(line, 0));
1121 case MSG_ERROR_XFER:
1123 if (msg_bytes >= sizeof line) {
1126 "multiplexing overflow %d:%ld [%s]\n",
1127 tag, (long)msg_bytes, who_am_i());
1128 exit_cleanup(RERR_STREAMIO);
1130 read_loop(fd, line, msg_bytes);
1131 rwrite((enum logcode)tag, line, msg_bytes, 1);
1132 if (first_message) {
1133 if (list_only && !am_sender && tag == 1) {
1134 line[msg_bytes] = '\0';
1135 check_for_d_option_error(line);
1141 rprintf(FERROR, "unexpected tag %d [%s]\n",
1143 exit_cleanup(RERR_STREAMIO);
1147 if (iobuf_in_remaining == 0)
1148 io_flush(NORMAL_FLUSH);
1153 /* Do a buffered read from fd. Don't return until all N bytes have
1154 * been read. If all N can't be read then exit with an error. */
1155 static void readfd(int fd, char *buffer, size_t N)
1161 cnt = readfd_unbuffered(fd, buffer + total, N-total);
1165 if (fd == write_batch_monitor_in) {
1166 if ((size_t)write(batch_fd, buffer, total) != total)
1167 exit_cleanup(RERR_FILEIO);
1170 if (fd == flist_forward_from)
1171 writefd(iobuf_f_out, buffer, total);
1173 if (fd == sock_f_in)
1174 stats.total_read += total;
1177 unsigned short read_shortint(int f)
1181 return (UVAL(b, 1) << 8) + UVAL(b, 0);
1184 int32 read_int(int f)
1191 #if SIZEOF_INT32 > 4
1192 if (num & (int32)0x80000000)
1193 num |= ~(int32)0xffffffff;
1198 int32 read_varint(int f)
1208 readfd(f, (char*)&ch, 1);
1209 extra = int_byte_extra[ch / 4];
1211 uchar bit = ((uchar)1<<(8-extra));
1212 if (extra >= (int)sizeof u.b) {
1213 rprintf(FERROR, "Overflow in read_varint()\n");
1214 exit_cleanup(RERR_STREAMIO);
1216 readfd(f, u.b, extra);
1217 u.b[extra] = ch & (bit-1);
1220 #if CAREFUL_ALIGNMENT
1223 #if SIZEOF_INT32 > 4
1224 if (u.x & (int32)0x80000000)
1225 u.x |= ~(int32)0xffffffff;
1230 int64 read_varlong(int f, uchar min_bytes)
1239 #if SIZEOF_INT64 < 8
1244 readfd(f, b2, min_bytes);
1245 memcpy(u.b, b2+1, min_bytes-1);
1246 extra = int_byte_extra[CVAL(b2, 0) / 4];
1248 uchar bit = ((uchar)1<<(8-extra));
1249 if (min_bytes + extra > (int)sizeof u.b) {
1250 rprintf(FERROR, "Overflow in read_varlong()\n");
1251 exit_cleanup(RERR_STREAMIO);
1253 readfd(f, u.b + min_bytes - 1, extra);
1254 u.b[min_bytes + extra - 1] = CVAL(b2, 0) & (bit-1);
1255 #if SIZEOF_INT64 < 8
1256 if (min_bytes + extra > 5 || u.b[4] || CVAL(u.b,3) & 0x80) {
1257 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1258 exit_cleanup(RERR_UNSUPPORTED);
1262 u.b[min_bytes + extra - 1] = CVAL(b2, 0);
1263 #if SIZEOF_INT64 < 8
1265 #elif CAREFUL_ALIGNMENT
1266 u.x = IVAL(u.b,0) | (((int64)IVAL(u.b,4))<<32);
1271 int64 read_longint(int f)
1273 #if SIZEOF_INT64 >= 8
1276 int32 num = read_int(f);
1278 if (num != (int32)0xffffffff)
1281 #if SIZEOF_INT64 < 8
1282 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1283 exit_cleanup(RERR_UNSUPPORTED);
1286 return IVAL(b,0) | (((int64)IVAL(b,4))<<32);
1290 void read_buf(int f, char *buf, size_t len)
1295 void read_sbuf(int f, char *buf, size_t len)
1297 readfd(f, buf, len);
1301 uchar read_byte(int f)
1304 readfd(f, (char *)&c, 1);
1308 int read_vstring(int f, char *buf, int bufsize)
1310 int len = read_byte(f);
1313 len = (len & ~0x80) * 0x100 + read_byte(f);
1315 if (len >= bufsize) {
1316 rprintf(FERROR, "over-long vstring received (%d > %d)\n",
1322 readfd(f, buf, len);
1327 /* Populate a sum_struct with values from the socket. This is
1328 * called by both the sender and the receiver. */
1329 void read_sum_head(int f, struct sum_struct *sum)
1331 int32 max_blength = protocol_version < 30 ? OLD_MAX_BLOCK_SIZE : MAX_BLOCK_SIZE;
1332 sum->count = read_int(f);
1333 if (sum->count < 0) {
1334 rprintf(FERROR, "Invalid checksum count %ld [%s]\n",
1335 (long)sum->count, who_am_i());
1336 exit_cleanup(RERR_PROTOCOL);
1338 sum->blength = read_int(f);
1339 if (sum->blength < 0 || sum->blength > max_blength) {
1340 rprintf(FERROR, "Invalid block length %ld [%s]\n",
1341 (long)sum->blength, who_am_i());
1342 exit_cleanup(RERR_PROTOCOL);
1344 sum->s2length = protocol_version < 27 ? csum_length : (int)read_int(f);
1345 if (sum->s2length < 0 || sum->s2length > MAX_DIGEST_LEN) {
1346 rprintf(FERROR, "Invalid checksum length %d [%s]\n",
1347 sum->s2length, who_am_i());
1348 exit_cleanup(RERR_PROTOCOL);
1350 sum->remainder = read_int(f);
1351 if (sum->remainder < 0 || sum->remainder > sum->blength) {
1352 rprintf(FERROR, "Invalid remainder length %ld [%s]\n",
1353 (long)sum->remainder, who_am_i());
1354 exit_cleanup(RERR_PROTOCOL);
1358 /* Send the values from a sum_struct over the socket. Set sum to
1359 * NULL if there are no checksums to send. This is called by both
1360 * the generator and the sender. */
1361 void write_sum_head(int f, struct sum_struct *sum)
1363 static struct sum_struct null_sum;
1368 write_int(f, sum->count);
1369 write_int(f, sum->blength);
1370 if (protocol_version >= 27)
1371 write_int(f, sum->s2length);
1372 write_int(f, sum->remainder);
1376 * Sleep after writing to limit I/O bandwidth usage.
1378 * @todo Rather than sleeping after each write, it might be better to
1379 * use some kind of averaging. The current algorithm seems to always
1380 * use a bit less bandwidth than specified, because it doesn't make up
1381 * for slow periods. But arguably this is a feature. In addition, we
1382 * ought to take the time used to write the data into account.
1384 * During some phases of big transfers (file FOO is uptodate) this is
1385 * called with a small bytes_written every time. As the kernel has to
1386 * round small waits up to guarantee that we actually wait at least the
1387 * requested number of microseconds, this can become grossly inaccurate.
1388 * We therefore keep track of the bytes we've written over time and only
1389 * sleep when the accumulated delay is at least 1 tenth of a second.
1391 static void sleep_for_bwlimit(int bytes_written)
1393 static struct timeval prior_tv;
1394 static long total_written = 0;
1395 struct timeval tv, start_tv;
1396 long elapsed_usec, sleep_usec;
1398 #define ONE_SEC 1000000L /* # of microseconds in a second */
1400 if (!bwlimit_writemax)
1403 total_written += bytes_written;
1405 gettimeofday(&start_tv, NULL);
1406 if (prior_tv.tv_sec) {
1407 elapsed_usec = (start_tv.tv_sec - prior_tv.tv_sec) * ONE_SEC
1408 + (start_tv.tv_usec - prior_tv.tv_usec);
1409 total_written -= (int64)elapsed_usec * bwlimit / (ONE_SEC/1024);
1410 if (total_written < 0)
1414 sleep_usec = total_written * (ONE_SEC/1024) / bwlimit;
1415 if (sleep_usec < ONE_SEC / 10) {
1416 prior_tv = start_tv;
1420 tv.tv_sec = sleep_usec / ONE_SEC;
1421 tv.tv_usec = sleep_usec % ONE_SEC;
1422 select(0, NULL, NULL, NULL, &tv);
1424 gettimeofday(&prior_tv, NULL);
1425 elapsed_usec = (prior_tv.tv_sec - start_tv.tv_sec) * ONE_SEC
1426 + (prior_tv.tv_usec - start_tv.tv_usec);
1427 total_written = (sleep_usec - elapsed_usec) * bwlimit / (ONE_SEC/1024);
1430 static const char *what_fd_is(int fd)
1432 static char buf[20];
1434 if (fd == sock_f_out)
1436 else if (fd == msg_fd_out)
1437 return "message fd";
1438 else if (fd == batch_fd)
1439 return "batch file";
1441 snprintf(buf, sizeof buf, "fd %d", fd);
1446 /* Write len bytes to the file descriptor fd, looping as necessary to get
1447 * the job done and also (in certain circumstances) reading any data on
1448 * msg_fd_in to avoid deadlock.
1450 * This function underlies the multiplexing system. The body of the
1451 * application never calls this function directly. */
1452 static void writefd_unbuffered(int fd, const char *buf, size_t len)
1454 size_t n, total = 0;
1455 fd_set w_fds, r_fds, e_fds;
1456 int maxfd, count, cnt, using_r_fds;
1461 defer_forwarding_messages++, defer_inc++;
1463 while (total < len) {
1470 if (msg_fd_in >= 0) {
1472 FD_SET(msg_fd_in, &r_fds);
1473 if (msg_fd_in > maxfd)
1479 tv.tv_sec = select_timeout;
1483 count = select(maxfd + 1, using_r_fds ? &r_fds : NULL,
1484 &w_fds, &e_fds, &tv);
1487 if (count < 0 && errno == EBADF)
1488 exit_cleanup(RERR_SOCKETIO);
1493 /*if (FD_ISSET(fd, &e_fds))
1494 rprintf(FINFO, "select exception on fd %d\n", fd); */
1496 if (using_r_fds && FD_ISSET(msg_fd_in, &r_fds))
1499 if (!FD_ISSET(fd, &w_fds))
1503 if (bwlimit_writemax && n > bwlimit_writemax)
1504 n = bwlimit_writemax;
1505 cnt = write(fd, buf + total, n);
1511 if (errno == EWOULDBLOCK || errno == EAGAIN) {
1517 /* Don't try to write errors back across the stream. */
1518 if (fd == sock_f_out)
1519 io_end_multiplex_out();
1520 /* Don't try to write errors down a failing msg pipe. */
1521 if (am_server && fd == msg_fd_out)
1522 exit_cleanup(RERR_STREAMIO);
1523 rsyserr(FERROR, errno,
1524 "writefd_unbuffered failed to write %ld bytes to %s [%s]",
1525 (long)len, what_fd_is(fd), who_am_i());
1526 /* If the other side is sending us error messages, try
1527 * to grab any messages they sent before they died. */
1528 while (!am_server && fd == sock_f_out && io_multiplexing_in) {
1532 readfd_unbuffered(sock_f_in, buf, sizeof buf);
1534 exit_cleanup(RERR_STREAMIO);
1538 defer_forwarding_messages++, defer_inc++;
1540 if (fd == sock_f_out) {
1541 if (io_timeout || am_generator)
1542 last_io_out = time(NULL);
1543 sleep_for_bwlimit(cnt);
1548 if (keep_defer_forwarding)
1550 if (!(defer_forwarding_messages -= defer_inc) && !no_flush)
1554 int io_flush(int flush_it_all)
1556 int flushed_something = 0;
1561 if (iobuf_out_cnt) {
1562 if (io_multiplexing_out)
1563 mplex_write(sock_f_out, MSG_DATA, iobuf_out, iobuf_out_cnt, 0);
1565 writefd_unbuffered(iobuf_f_out, iobuf_out, iobuf_out_cnt);
1567 flushed_something = 1;
1570 if (flush_it_all && !defer_forwarding_messages && msg_queue.head) {
1572 flushed_something = 1;
1575 return flushed_something;
1578 static void writefd(int fd, const char *buf, size_t len)
1580 if (fd == sock_f_out)
1581 stats.total_written += len;
1583 if (fd == write_batch_monitor_out)
1584 writefd_unbuffered(batch_fd, buf, len);
1586 if (!iobuf_out || fd != iobuf_f_out) {
1587 writefd_unbuffered(fd, buf, len);
1592 int n = MIN((int)len, IO_BUFFER_SIZE - iobuf_out_cnt);
1594 memcpy(iobuf_out+iobuf_out_cnt, buf, n);
1600 if (iobuf_out_cnt == IO_BUFFER_SIZE)
1601 io_flush(NORMAL_FLUSH);
1605 void write_shortint(int f, unsigned short x)
1609 b[1] = (char)(x >> 8);
1613 void write_int(int f, int32 x)
1620 void write_varint(int f, int32 x)
1628 while (cnt > 1 && b[cnt] == 0)
1630 bit = ((uchar)1<<(7-cnt+1));
1631 if (CVAL(b, cnt) >= bit) {
1635 *b = b[cnt] | ~(bit*2-1);
1642 void write_varlong(int f, int64 x, uchar min_bytes)
1649 #if SIZEOF_INT64 >= 8
1650 SIVAL(b, 5, x >> 32);
1652 if (x <= 0x7FFFFFFF && x >= 0)
1653 memset(b + 5, 0, 4);
1655 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1656 exit_cleanup(RERR_UNSUPPORTED);
1660 while (cnt > min_bytes && b[cnt] == 0)
1662 bit = ((uchar)1<<(7-cnt+min_bytes));
1663 if (CVAL(b, cnt) >= bit) {
1666 } else if (cnt > min_bytes)
1667 *b = b[cnt] | ~(bit*2-1);
1675 * Note: int64 may actually be a 32-bit type if ./configure couldn't find any
1676 * 64-bit types on this platform.
1678 void write_longint(int f, int64 x)
1680 char b[12], * const s = b+4;
1683 if (x <= 0x7FFFFFFF && x >= 0) {
1688 #if SIZEOF_INT64 < 8
1689 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1690 exit_cleanup(RERR_UNSUPPORTED);
1693 SIVAL(s, 4, x >> 32);
1698 void write_buf(int f, const char *buf, size_t len)
1703 /** Write a string to the connection */
1704 void write_sbuf(int f, const char *buf)
1706 writefd(f, buf, strlen(buf));
1709 void write_byte(int f, uchar c)
1711 writefd(f, (char *)&c, 1);
1714 void write_vstring(int f, const char *str, int len)
1716 uchar lenbuf[3], *lb = lenbuf;
1721 "attempting to send over-long vstring (%d > %d)\n",
1723 exit_cleanup(RERR_PROTOCOL);
1725 *lb++ = len / 0x100 + 0x80;
1729 writefd(f, (char*)lenbuf, lb - lenbuf + 1);
1731 writefd(f, str, len);
1734 /* Send a file-list index using a byte-reduction method. */
1735 void write_ndx(int f, int32 ndx)
1737 static int32 prev_positive = -1, prev_negative = 1;
1738 int32 diff, cnt = 0;
1741 if (protocol_version < 30 || read_batch) {
1746 /* Send NDX_DONE as a single-byte 0 with no side effects. Send
1747 * negative nums as a positive after sending a leading 0xFF. */
1749 diff = ndx - prev_positive;
1750 prev_positive = ndx;
1751 } else if (ndx == NDX_DONE) {
1756 b[cnt++] = (char)0xFF;
1758 diff = ndx - prev_negative;
1759 prev_negative = ndx;
1762 /* A diff of 1 - 253 is sent as a one-byte diff; a diff of 254 - 32767
1763 * or 0 is sent as a 0xFE + a two-byte diff; otherwise we send 0xFE
1764 * & all 4 bytes of the (non-negative) num with the high-bit set. */
1765 if (diff < 0xFE && diff > 0)
1766 b[cnt++] = (char)diff;
1767 else if (diff < 0 || diff > 0x7FFF) {
1768 b[cnt++] = (char)0xFE;
1769 b[cnt++] = (char)((ndx >> 24) | 0x80);
1770 b[cnt++] = (char)ndx;
1771 b[cnt++] = (char)(ndx >> 8);
1772 b[cnt++] = (char)(ndx >> 16);
1774 b[cnt++] = (char)0xFE;
1775 b[cnt++] = (char)(diff >> 8);
1776 b[cnt++] = (char)diff;
1781 /* Receive a file-list index using a byte-reduction method. */
1782 int32 read_ndx(int f)
1784 static int32 prev_positive = -1, prev_negative = 1;
1785 int32 *prev_ptr, num;
1788 if (protocol_version < 30)
1792 if (CVAL(b, 0) == 0xFF) {
1794 prev_ptr = &prev_negative;
1795 } else if (CVAL(b, 0) == 0)
1798 prev_ptr = &prev_positive;
1799 if (CVAL(b, 0) == 0xFE) {
1801 if (CVAL(b, 0) & 0x80) {
1802 b[3] = CVAL(b, 0) & ~0x80;
1807 num = (UVAL(b,0)<<8) + UVAL(b,1) + *prev_ptr;
1809 num = UVAL(b, 0) + *prev_ptr;
1811 if (prev_ptr == &prev_negative)
1816 /* Read a line of up to bufsiz-1 characters into buf. Strips
1817 * the (required) trailing newline and all carriage returns.
1818 * Returns 1 for success; 0 for I/O error or truncation. */
1819 int read_line_old(int f, char *buf, size_t bufsiz)
1821 bufsiz--; /* leave room for the null */
1822 while (bufsiz > 0) {
1824 read_buf(f, buf, 1);
1829 if (buf[0] != '\r') {
1838 void io_printf(int fd, const char *format, ...)
1841 char buf[BIGPATHBUFLEN];
1844 va_start(ap, format);
1845 len = vsnprintf(buf, sizeof buf, format, ap);
1849 exit_cleanup(RERR_STREAMIO);
1851 if (len > (int)sizeof buf) {
1852 rprintf(FERROR, "io_printf() was too long for the buffer.\n");
1853 exit_cleanup(RERR_STREAMIO);
1856 write_sbuf(fd, buf);
1859 /** Setup for multiplexing a MSG_* stream with the data stream. */
1860 void io_start_multiplex_out(void)
1862 io_flush(NORMAL_FLUSH);
1863 io_start_buffering_out(sock_f_out);
1864 io_multiplexing_out = 1;
1867 /** Setup for multiplexing a MSG_* stream with the data stream. */
1868 void io_start_multiplex_in(void)
1870 io_flush(NORMAL_FLUSH);
1871 io_start_buffering_in(sock_f_in);
1872 io_multiplexing_in = 1;
1875 /** Write an message to the multiplexed data stream. */
1876 int io_multiplex_write(enum msgcode code, const char *buf, size_t len, int convert)
1878 if (!io_multiplexing_out)
1880 io_flush(NORMAL_FLUSH);
1881 stats.total_written += (len+4);
1882 mplex_write(sock_f_out, code, buf, len, convert);
1886 void io_end_multiplex_in(void)
1888 io_multiplexing_in = 0;
1889 io_end_buffering_in();
1892 /** Stop output multiplexing. */
1893 void io_end_multiplex_out(void)
1895 io_multiplexing_out = 0;
1896 io_end_buffering_out();
1899 void start_write_batch(int fd)
1901 /* Some communication has already taken place, but we don't
1902 * enable batch writing until here so that we can write a
1903 * canonical record of the communication even though the
1904 * actual communication so far depends on whether a daemon
1906 write_int(batch_fd, protocol_version);
1907 if (protocol_version >= 30)
1908 write_byte(batch_fd, compat_flags);
1909 write_int(batch_fd, checksum_seed);
1912 write_batch_monitor_out = fd;
1914 write_batch_monitor_in = fd;
1917 void stop_write_batch(void)
1919 write_batch_monitor_out = -1;
1920 write_batch_monitor_in = -1;