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;
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;
71 /* Ignore an EOF error if non-zero. See whine_about_eof(). */
72 int kluge_around_eof = 0;
79 static int iobuf_f_in = -1;
80 static char *iobuf_in;
81 static size_t iobuf_in_siz;
82 static size_t iobuf_in_ndx;
83 static size_t iobuf_in_remaining;
85 static int iobuf_f_out = -1;
86 static char *iobuf_out;
87 static int iobuf_out_cnt;
89 int flist_forward_from = -1;
91 static int io_multiplexing_out;
92 static int io_multiplexing_in;
93 static time_t last_io_in;
94 static time_t last_io_out;
97 static int write_batch_monitor_in = -1;
98 static int write_batch_monitor_out = -1;
100 static int io_filesfrom_f_in = -1;
101 static int io_filesfrom_f_out = -1;
102 static xbuf ff_buf = EMPTY_XBUF;
103 static char ff_lastchar;
105 static xbuf iconv_buf = EMPTY_XBUF;
107 static int defer_forwarding_messages = 0, keep_defer_forwarding = 0;
108 static int select_timeout = SELECT_TIMEOUT;
109 static int active_filecnt = 0;
110 static OFF_T active_bytecnt = 0;
111 static int first_message = 1;
113 static char int_byte_extra[64] = {
114 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* (00 - 3F)/4 */
115 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* (40 - 7F)/4 */
116 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /* (80 - BF)/4 */
117 2, 2, 2, 2, 2, 2, 2, 2, 3, 3, 3, 3, 4, 4, 5, 6, /* (C0 - FF)/4 */
120 #define REMOTE_OPTION_ERROR "rsync: on remote machine: -"
121 #define REMOTE_OPTION_ERROR2 ": unknown option"
123 enum festatus { FES_SUCCESS, FES_REDO, FES_NO_SEND };
125 static void readfd(int fd, char *buffer, size_t N);
126 static void writefd(int fd, const char *buf, size_t len);
127 static void writefd_unbuffered(int fd, const char *buf, size_t len);
128 static void mplex_write(int fd, enum msgcode code, const char *buf, size_t len, int convert);
129 static void read_a_msg(int fd);
131 static flist_ndx_list redo_list, hlink_list;
133 struct msg_list_item {
134 struct msg_list_item *next;
140 struct msg_list_item *head, *tail;
143 static struct msg_list msg_queue;
145 static void got_flist_entry_status(enum festatus status, const char *buf)
147 int ndx = IVAL(buf, 0);
148 struct file_list *flist = flist_for_ndx(ndx, "got_flist_entry_status");
150 if (remove_source_files) {
152 active_bytecnt -= F_LENGTH(flist->files[ndx - flist->ndx_start]);
156 flist->in_progress--;
160 if (remove_source_files)
161 send_msg(MSG_SUCCESS, buf, 4, 0);
162 if (preserve_hard_links) {
163 struct file_struct *file = flist->files[ndx - flist->ndx_start];
164 if (F_IS_HLINKED(file)) {
165 flist_ndx_push(&hlink_list, ndx);
166 flist->in_progress++;
173 flist->in_progress++;
178 flist_ndx_push(&redo_list, ndx);
185 static void check_timeout(void)
189 if (!io_timeout || ignore_timeout)
193 last_io_in = time(NULL);
199 if (t - last_io_in >= io_timeout) {
200 if (!am_server && !am_daemon) {
201 rprintf(FERROR, "io timeout after %d seconds -- exiting\n",
202 (int)(t-last_io_in));
204 exit_cleanup(RERR_TIMEOUT);
208 /* Note the fds used for the main socket (which might really be a pipe
209 * for a local transfer, but we can ignore that). */
210 void io_set_sock_fds(int f_in, int f_out)
216 void set_io_timeout(int secs)
220 if (!io_timeout || io_timeout > SELECT_TIMEOUT)
221 select_timeout = SELECT_TIMEOUT;
223 select_timeout = io_timeout;
225 allowed_lull = read_batch ? 0 : (io_timeout + 1) / 2;
228 /* Setup the fd used to receive MSG_* messages. Only needed during the
229 * early stages of being a local sender (up through the sending of the
230 * file list) or when we're the generator (to fetch the messages from
232 void set_msg_fd_in(int fd)
237 /* Setup the fd used to send our MSG_* messages. Only needed when
238 * we're the receiver (to send our messages to the generator). */
239 void set_msg_fd_out(int fd)
242 set_nonblocking(msg_fd_out);
245 /* Add a message to the pending MSG_* list. */
246 static void msg_list_add(struct msg_list *lst, int code, const char *buf, int len, int convert)
248 struct msg_list_item *m;
249 int sz = len + 4 + sizeof m[0] - 1;
251 if (!(m = (struct msg_list_item *)new_array(char, sz)))
252 out_of_memory("msg_list_add");
254 m->convert = convert;
255 SIVAL(m->buf, 0, ((code+MPLEX_BASE)<<24) | len);
256 memcpy(m->buf + 4, buf, len);
264 static inline int flush_a_msg(int fd)
266 struct msg_list_item *m = msg_queue.head;
267 int len = IVAL(m->buf, 0) & 0xFFFFFF;
268 int tag = *((uchar*)m->buf+3) - MPLEX_BASE;
270 if (!(msg_queue.head = m->next))
271 msg_queue.tail = NULL;
273 defer_forwarding_messages++;
274 mplex_write(fd, tag, m->buf + 4, len, m->convert);
275 defer_forwarding_messages--;
282 static void msg_flush(void)
285 while (msg_queue.head && io_multiplexing_out)
286 stats.total_written += flush_a_msg(sock_f_out) + 4;
288 while (msg_queue.head)
289 (void)flush_a_msg(msg_fd_out);
293 static void check_for_d_option_error(const char *msg)
295 static char rsync263_opts[] = "BCDHIKLPRSTWabceghlnopqrtuvxz";
300 || strncmp(msg, REMOTE_OPTION_ERROR, sizeof REMOTE_OPTION_ERROR - 1) != 0)
303 msg += sizeof REMOTE_OPTION_ERROR - 1;
304 if (*msg == '-' || (colon = strchr(msg, ':')) == NULL
305 || strncmp(colon, REMOTE_OPTION_ERROR2, sizeof REMOTE_OPTION_ERROR2 - 1) != 0)
308 for ( ; *msg != ':'; msg++) {
311 else if (*msg == 'e')
313 else if (strchr(rsync263_opts, *msg) == NULL)
319 "*** Try using \"--old-d\" if remote rsync is <= 2.6.3 ***\n");
323 /* This is used by the generator to limit how many file transfers can
324 * be active at once when --remove-source-files is specified. Without
325 * this, sender-side deletions were mostly happening at the end. */
326 void increment_active_files(int ndx, int itemizing, enum logcode code)
329 /* TODO: tune these limits? */
330 int limit = active_bytecnt >= 128*1024 ? 10 : 50;
331 if (active_filecnt < limit)
333 check_for_finished_files(itemizing, code, 0);
334 if (active_filecnt < limit)
337 io_flush(NORMAL_FLUSH);
339 read_a_msg(msg_fd_in);
343 active_bytecnt += F_LENGTH(cur_flist->files[ndx - cur_flist->ndx_start]);
346 /* Write an message to a multiplexed stream. If this fails, rsync exits. */
347 static void mplex_write(int fd, enum msgcode code, const char *buf, size_t len, int convert)
349 char buffer[BIGPATHBUFLEN]; /* Oversized for use by iconv code. */
353 /* We need to convert buf before doing anything else so that we
354 * can include the (converted) byte length in the message header. */
355 if (convert && ic_send != (iconv_t)-1) {
358 INIT_XBUF(outbuf, buffer + 4, 0, sizeof buffer - 4);
359 INIT_XBUF(inbuf, (char*)buf, len, (size_t)-1);
361 iconvbufs(ic_send, &inbuf, &outbuf,
362 ICB_INCLUDE_BAD | ICB_INCLUDE_INCOMPLETE);
364 rprintf(FERROR, "overflowed conversion buffer in mplex_write");
365 exit_cleanup(RERR_UNSUPPORTED);
368 n = len = outbuf.len;
371 if (n > 1024 - 4) /* BIGPATHBUFLEN can handle 1024 bytes */
372 n = 0; /* We'd rather do 2 writes than too much memcpy(). */
374 memcpy(buffer + 4, buf, n);
376 SIVAL(buffer, 0, ((MPLEX_BASE + (int)code)<<24) + len);
378 keep_defer_forwarding++; /* defer_forwarding_messages++ on return */
379 writefd_unbuffered(fd, buffer, n+4);
380 keep_defer_forwarding--;
383 writefd_unbuffered(fd, buf+n, len-n);
385 if (!--defer_forwarding_messages && !no_flush)
389 int send_msg(enum msgcode code, const char *buf, int len, int convert)
391 if (msg_fd_out < 0) {
392 if (!defer_forwarding_messages)
393 return io_multiplex_write(code, buf, len, convert);
394 if (!io_multiplexing_out)
396 msg_list_add(&msg_queue, code, buf, len, convert);
399 if (defer_forwarding_messages)
400 msg_list_add(&msg_queue, code, buf, len, convert);
402 mplex_write(msg_fd_out, code, buf, len, convert);
406 void send_msg_int(enum msgcode code, int num)
409 SIVAL(numbuf, 0, num);
410 send_msg(code, numbuf, 4, 0);
413 void wait_for_receiver(void)
415 if (io_flush(FULL_FLUSH))
417 read_a_msg(msg_fd_in);
420 int get_redo_num(void)
422 return flist_ndx_pop(&redo_list);
425 int get_hlink_num(void)
427 return flist_ndx_pop(&hlink_list);
431 * When we're the receiver and we have a local --files-from list of names
432 * that needs to be sent over the socket to the sender, we have to do two
433 * things at the same time: send the sender a list of what files we're
434 * processing and read the incoming file+info list from the sender. We do
435 * this by augmenting the read_timeout() function to copy this data. It
436 * uses ff_buf to read a block of data from f_in (when it is ready, since
437 * it might be a pipe) and then blast it out f_out (when it is ready to
438 * receive more data).
440 void io_set_filesfrom_fds(int f_in, int f_out)
442 io_filesfrom_f_in = f_in;
443 io_filesfrom_f_out = f_out;
444 alloc_xbuf(&ff_buf, 2048);
447 alloc_xbuf(&iconv_buf, 1024);
451 /* It's almost always an error to get an EOF when we're trying to read from the
452 * network, because the protocol is (for the most part) self-terminating.
454 * There is one case for the receiver when it is at the end of the transfer
455 * (hanging around reading any keep-alive packets that might come its way): if
456 * the sender dies before the generator's kill-signal comes through, we can end
457 * up here needing to loop until the kill-signal arrives. In this situation,
458 * kluge_around_eof will be < 0.
460 * There is another case for older protocol versions (< 24) where the module
461 * listing was not terminated, so we must ignore an EOF error in that case and
462 * exit. In this situation, kluge_around_eof will be > 0. */
463 static void whine_about_eof(int fd)
465 if (kluge_around_eof && fd == sock_f_in) {
467 if (kluge_around_eof > 0)
469 /* If we're still here after 10 seconds, exit with an error. */
470 for (i = 10*1000/20; i--; )
474 rprintf(FERROR, RSYNC_NAME ": connection unexpectedly closed "
475 "(%s bytes received so far) [%s]\n",
476 big_num(stats.total_read), who_am_i());
478 exit_cleanup(RERR_STREAMIO);
481 /* Read from a socket with I/O timeout. return the number of bytes
482 * read. If no bytes can be read then exit, never return a number <= 0.
484 * TODO: If the remote shell connection fails, then current versions
485 * actually report an "unexpected EOF" error here. Since it's a
486 * fairly common mistake to try to use rsh when ssh is required, we
487 * should trap that: if we fail to read any data at all, we should
488 * give a better explanation. We can tell whether the connection has
489 * started by looking e.g. at whether the remote version is known yet. */
490 static int read_timeout(int fd, char *buf, size_t len)
494 io_flush(FULL_FLUSH);
497 /* until we manage to read *something* */
506 if (io_filesfrom_f_out >= 0) {
508 if (ff_buf.len == 0) {
509 if (io_filesfrom_f_in >= 0) {
510 FD_SET(io_filesfrom_f_in, &r_fds);
511 new_fd = io_filesfrom_f_in;
513 io_filesfrom_f_out = -1;
517 FD_SET(io_filesfrom_f_out, &w_fds);
518 new_fd = io_filesfrom_f_out;
524 if (extra_flist_sending_enabled && !defer_forwarding_messages) {
525 if (file_total - file_old_total < MAX_FILECNT_LOOKAHEAD
526 && file_total - file_old_total >= MIN_FILECNT_LOOKAHEAD)
529 extra_flist_sending_enabled = False;
530 tv.tv_sec = select_timeout;
533 tv.tv_sec = select_timeout;
538 count = select(maxfd + 1, &r_fds, &w_fds, NULL, &tv);
541 if (errno == EBADF) {
542 defer_forwarding_messages = 0;
543 exit_cleanup(RERR_SOCKETIO);
545 if (extra_flist_sending_enabled && !defer_forwarding_messages) {
546 extra_flist_sending_enabled = False;
547 send_extra_file_list(sock_f_out, -1);
548 extra_flist_sending_enabled = !flist_eof;
554 if (io_filesfrom_f_out >= 0) {
556 if (FD_ISSET(io_filesfrom_f_out, &w_fds)) {
557 int l = write(io_filesfrom_f_out,
558 ff_buf.buf + ff_buf.pos,
561 if (!(ff_buf.len -= l))
565 } else if (errno != EINTR) {
566 /* XXX should we complain? */
567 io_filesfrom_f_out = -1;
570 } else if (io_filesfrom_f_in >= 0) {
571 if (FD_ISSET(io_filesfrom_f_in, &r_fds)) {
573 xbuf *ibuf = filesfrom_convert ? &iconv_buf : &ff_buf;
575 xbuf *ibuf = &ff_buf;
577 int l = read(io_filesfrom_f_in, ibuf->buf, ibuf->size);
579 if (l == 0 || errno != EINTR) {
580 /* Send end-of-file marker */
581 memcpy(ff_buf.buf, "\0\0", 2);
582 ff_buf.len = ff_lastchar? 2 : 1;
584 io_filesfrom_f_in = -1;
588 if (filesfrom_convert) {
591 iconvbufs(ic_send, &iconv_buf, &ff_buf,
592 ICB_EXPAND_OUT|ICB_INCLUDE_BAD|ICB_INCLUDE_INCOMPLETE);
597 char *s = ff_buf.buf + l;
598 /* Transform CR and/or LF into '\0' */
599 while (s-- > ff_buf.buf) {
600 if (*s == '\n' || *s == '\r')
605 /* Last buf ended with a '\0', so don't
606 * let this buf start with one. */
607 while (l && ff_buf.buf[ff_buf.pos] == '\0')
613 char *f = ff_buf.buf + ff_buf.pos;
616 /* Eliminate any multi-'\0' runs. */
618 if (!(*t++ = *f++)) {
619 while (f != eob && !*f)
631 if (!FD_ISSET(fd, &r_fds))
634 n = read(fd, buf, len);
638 whine_about_eof(fd); /* Doesn't return. */
639 if (errno == EINTR || errno == EWOULDBLOCK || errno == EAGAIN)
642 /* Don't write errors on a dead socket. */
643 if (fd == sock_f_in) {
645 io_multiplexing_out = 0;
646 rsyserr(FERROR_SOCKET, errno, "read error");
648 rsyserr(FERROR, errno, "read error");
649 exit_cleanup(RERR_STREAMIO);
656 if (fd == sock_f_in && io_timeout)
657 last_io_in = time(NULL);
663 /* Read a line into the "buf" buffer. */
664 int read_line(int fd, char *buf, size_t bufsiz, int flags)
670 if (flags & RL_CONVERT && iconv_buf.size < bufsiz)
671 realloc_xbuf(&iconv_buf, bufsiz + 1024);
676 s = flags & RL_CONVERT ? iconv_buf.buf : buf;
680 eob = s + bufsiz - 1;
682 cnt = read(fd, &ch, 1);
683 if (cnt < 0 && (errno == EWOULDBLOCK
684 || errno == EINTR || errno == EAGAIN)) {
691 tv.tv_sec = select_timeout;
693 if (!select(fd+1, &r_fds, NULL, &e_fds, &tv))
695 /*if (FD_ISSET(fd, &e_fds))
696 rprintf(FINFO, "select exception on fd %d\n", fd); */
701 if (flags & RL_EOL_NULLS ? ch == '\0' : (ch == '\r' || ch == '\n')) {
702 /* Skip empty lines if dumping comments. */
703 if (flags & RL_DUMP_COMMENTS && s == buf)
712 if (flags & RL_DUMP_COMMENTS && (*buf == '#' || *buf == ';'))
716 if (flags & RL_CONVERT) {
718 INIT_XBUF(outbuf, buf, 0, bufsiz);
720 iconv_buf.len = s - iconv_buf.buf;
721 iconvbufs(ic_recv, &iconv_buf, &outbuf,
722 ICB_INCLUDE_BAD | ICB_INCLUDE_INCOMPLETE);
723 outbuf.buf[outbuf.len] = '\0';
731 void read_args(int f_in, char *mod_name, char *buf, size_t bufsiz, int rl_nulls,
732 char ***argv_p, int *argc_p, char **request_p)
734 int maxargs = MAX_ARGS;
738 int rl_flags = (rl_nulls ? RL_EOL_NULLS : 0);
741 rl_flags |= (protect_args && ic_recv != (iconv_t)-1 ? RL_CONVERT : 0);
744 if (!(argv = new_array(char *, maxargs)))
745 out_of_memory("read_args");
746 if (mod_name && !protect_args)
747 argv[argc++] = "rsyncd";
750 if (read_line(f_in, buf, bufsiz, rl_flags) == 0)
753 if (argc == maxargs-1) {
755 if (!(argv = realloc_array(argv, char *, maxargs)))
756 out_of_memory("read_args");
761 *request_p = strdup(buf);
765 glob_expand_module(mod_name, buf, &argv, &argc, &maxargs);
767 glob_expand(buf, &argv, &argc, &maxargs);
769 if (!(p = strdup(buf)))
770 out_of_memory("read_args");
772 if (*p == '.' && p[1] == '\0')
778 glob_expand(NULL, NULL, NULL, NULL);
784 int io_start_buffering_out(int f_out)
787 assert(f_out == iobuf_f_out);
790 if (!(iobuf_out = new_array(char, IO_BUFFER_SIZE)))
791 out_of_memory("io_start_buffering_out");
797 int io_start_buffering_in(int f_in)
800 assert(f_in == iobuf_f_in);
803 iobuf_in_siz = 2 * IO_BUFFER_SIZE;
804 if (!(iobuf_in = new_array(char, iobuf_in_siz)))
805 out_of_memory("io_start_buffering_in");
810 void io_end_buffering_in(void)
817 iobuf_in_remaining = 0;
821 void io_end_buffering_out(void)
825 io_flush(FULL_FLUSH);
831 void maybe_flush_socket(int important)
833 if (iobuf_out && iobuf_out_cnt
834 && (important || time(NULL) - last_io_out >= 5))
835 io_flush(NORMAL_FLUSH);
838 void maybe_send_keepalive(void)
840 if (time(NULL) - last_io_out >= allowed_lull) {
841 if (!iobuf_out || !iobuf_out_cnt) {
842 if (protocol_version < 29)
843 return; /* there's nothing we can do */
844 if (protocol_version >= 30)
845 send_msg(MSG_NOOP, "", 0, 0);
847 write_int(sock_f_out, cur_flist->used);
848 write_shortint(sock_f_out, ITEM_IS_NEW);
852 io_flush(NORMAL_FLUSH);
856 void start_flist_forward(int f_in)
858 assert(iobuf_out != NULL);
859 assert(iobuf_f_out == msg_fd_out);
860 flist_forward_from = f_in;
863 void stop_flist_forward()
865 flist_forward_from = -1;
866 io_flush(FULL_FLUSH);
869 /* Continue trying to read len bytes until all have been read.
870 * Used to read raw bytes from a multiplexed source. */
871 static void read_loop(int fd, char *buf, size_t len)
874 int n = read_timeout(fd, buf, len);
881 /* Read a message from a multiplexed source. */
882 static void read_a_msg(int fd)
884 char line[BIGPATHBUFLEN];
886 int tag, flist_parent = -1, save_msg_fd_in = msg_fd_in;
888 /* Temporarily disable msg_fd_in. This is needed to avoid looping back
889 * to this routine from writefd_unbuffered(). */
892 read_loop(fd, line, 4);
895 msg_bytes = tag & 0xFFFFFF;
896 tag = (tag >> 24) - MPLEX_BASE;
902 if (msg_bytes > iobuf_in_siz) {
903 if (!(iobuf_in = realloc_array(iobuf_in, char, msg_bytes)))
904 out_of_memory("read_a_msg");
905 iobuf_in_siz = msg_bytes;
907 read_loop(fd, iobuf_in, msg_bytes);
908 iobuf_in_remaining = msg_bytes;
912 if (msg_bytes > 1 || !am_generator)
915 read_loop(fd, line, 1);
916 stats.total_read = read_varlong(fd, 3);
921 if (msg_bytes != 4 || !am_generator)
923 read_loop(fd, line, 4);
924 got_flist_entry_status(FES_REDO, line);
927 if (msg_bytes != 4 || !am_generator || !inc_recurse)
929 read_loop(fd, line, 4);
930 /* Read extra file list from receiver. */
931 if (DEBUG_GTE(FLIST, 2)) {
932 rprintf(FINFO, "[%s] receiving flist for dir %d\n",
933 who_am_i(), IVAL(line, 0));
935 flist_parent = IVAL(line, 0);
938 if (msg_bytes != 0 || !am_generator || !inc_recurse)
943 if (msg_bytes != 4 || am_sender)
945 read_loop(fd, line, 4);
946 io_error |= IVAL(line, 0);
948 send_msg_int(MSG_IO_ERROR, IVAL(line, 0));
952 maybe_send_keepalive();
958 if (am_sender && am_server)
959 write_del_stats(sock_f_out);
962 if (msg_bytes >= sizeof line)
965 read_loop(fd, line, msg_bytes);
966 send_msg(MSG_DELETED, line, msg_bytes, 1);
970 if (ic_recv != (iconv_t)-1) {
975 INIT_CONST_XBUF(outbuf, line);
976 INIT_XBUF(inbuf, ibuf, 0, (size_t)-1);
979 inbuf.len = msg_bytes > sizeof ibuf
980 ? sizeof ibuf : msg_bytes;
981 read_loop(fd, inbuf.buf, inbuf.len);
982 if (!(msg_bytes -= inbuf.len)
983 && !ibuf[inbuf.len-1])
984 inbuf.len--, add_null = 1;
985 if (iconvbufs(ic_send, &inbuf, &outbuf,
986 ICB_INCLUDE_BAD | ICB_INCLUDE_INCOMPLETE) < 0)
990 if (outbuf.len == outbuf.size)
992 outbuf.buf[outbuf.len++] = '\0';
994 msg_bytes = outbuf.len;
997 read_loop(fd, line, msg_bytes);
998 /* A directory name was sent with the trailing null */
999 if (msg_bytes > 0 && !line[msg_bytes-1])
1000 log_delete(line, S_IFDIR);
1002 line[msg_bytes] = '\0';
1003 log_delete(line, S_IFREG);
1007 if (msg_bytes != 4) {
1009 rprintf(FERROR, "invalid multi-message %d:%lu [%s%s]\n",
1010 tag, (unsigned long)msg_bytes, who_am_i(),
1011 inc_recurse ? "/inc" : "");
1012 exit_cleanup(RERR_STREAMIO);
1014 read_loop(fd, line, 4);
1016 got_flist_entry_status(FES_SUCCESS, line);
1018 successful_send(IVAL(line, 0));
1023 read_loop(fd, line, 4);
1025 got_flist_entry_status(FES_NO_SEND, line);
1027 send_msg_int(MSG_NO_SEND, IVAL(line, 0));
1029 case MSG_ERROR_SOCKET:
1030 case MSG_ERROR_UTF8:
1035 if (tag == MSG_ERROR_SOCKET)
1036 io_multiplexing_out = 0;
1040 case MSG_ERROR_XFER:
1042 if (msg_bytes >= sizeof line) {
1045 "multiplexing overflow %d:%lu [%s%s]\n",
1046 tag, (unsigned long)msg_bytes, who_am_i(),
1047 inc_recurse ? "/inc" : "");
1048 exit_cleanup(RERR_STREAMIO);
1050 read_loop(fd, line, msg_bytes);
1051 rwrite((enum logcode)tag, line, msg_bytes, !am_generator);
1052 if (first_message) {
1053 if (list_only && !am_sender && tag == 1) {
1054 line[msg_bytes] = '\0';
1055 check_for_d_option_error(line);
1061 rprintf(FERROR, "unexpected tag %d [%s%s]\n",
1062 tag, who_am_i(), inc_recurse ? "/inc" : "");
1063 exit_cleanup(RERR_STREAMIO);
1066 msg_fd_in = save_msg_fd_in;
1069 if (flist_parent >= 0) {
1070 struct file_list *flist = recv_file_list(fd);
1071 flist->parent_ndx = flist_parent;
1072 #ifdef SUPPORT_HARD_LINKS
1073 if (preserve_hard_links)
1074 match_hard_links(flist);
1079 /* Read from the file descriptor handling multiplexing and return the
1080 * number of bytes read. Never returns <= 0. */
1081 static int readfd_unbuffered(int fd, char *buf, size_t len)
1085 if (!iobuf_in || fd != iobuf_f_in)
1086 return read_timeout(fd, buf, len);
1088 if (!io_multiplexing_in && iobuf_in_remaining == 0) {
1089 iobuf_in_remaining = read_timeout(fd, iobuf_in, iobuf_in_siz);
1094 if (iobuf_in_remaining) {
1095 len = MIN(len, iobuf_in_remaining);
1096 memcpy(buf, iobuf_in + iobuf_in_ndx, len);
1097 iobuf_in_ndx += len;
1098 iobuf_in_remaining -= len;
1105 if (iobuf_in_remaining == 0)
1106 io_flush(NORMAL_FLUSH);
1111 /* Do a buffered read from fd. Don't return until all N bytes have
1112 * been read. If all N can't be read then exit with an error. */
1113 static void readfd(int fd, char *buffer, size_t N)
1119 cnt = readfd_unbuffered(fd, buffer + total, N-total);
1123 if (fd == write_batch_monitor_in) {
1124 if ((size_t)write(batch_fd, buffer, total) != total)
1125 exit_cleanup(RERR_FILEIO);
1128 if (fd == flist_forward_from)
1129 writefd(iobuf_f_out, buffer, total);
1131 if (fd == sock_f_in)
1132 stats.total_read += total;
1135 unsigned short read_shortint(int f)
1139 return (UVAL(b, 1) << 8) + UVAL(b, 0);
1142 int32 read_int(int f)
1149 #if SIZEOF_INT32 > 4
1150 if (num & (int32)0x80000000)
1151 num |= ~(int32)0xffffffff;
1156 int32 read_varint(int f)
1166 readfd(f, (char*)&ch, 1);
1167 extra = int_byte_extra[ch / 4];
1169 uchar bit = ((uchar)1<<(8-extra));
1170 if (extra >= (int)sizeof u.b) {
1171 rprintf(FERROR, "Overflow in read_varint()\n");
1172 exit_cleanup(RERR_STREAMIO);
1174 readfd(f, u.b, extra);
1175 u.b[extra] = ch & (bit-1);
1178 #if CAREFUL_ALIGNMENT
1181 #if SIZEOF_INT32 > 4
1182 if (u.x & (int32)0x80000000)
1183 u.x |= ~(int32)0xffffffff;
1188 int64 read_varlong(int f, uchar min_bytes)
1197 #if SIZEOF_INT64 < 8
1202 readfd(f, b2, min_bytes);
1203 memcpy(u.b, b2+1, min_bytes-1);
1204 extra = int_byte_extra[CVAL(b2, 0) / 4];
1206 uchar bit = ((uchar)1<<(8-extra));
1207 if (min_bytes + extra > (int)sizeof u.b) {
1208 rprintf(FERROR, "Overflow in read_varlong()\n");
1209 exit_cleanup(RERR_STREAMIO);
1211 readfd(f, u.b + min_bytes - 1, extra);
1212 u.b[min_bytes + extra - 1] = CVAL(b2, 0) & (bit-1);
1213 #if SIZEOF_INT64 < 8
1214 if (min_bytes + extra > 5 || u.b[4] || CVAL(u.b,3) & 0x80) {
1215 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1216 exit_cleanup(RERR_UNSUPPORTED);
1220 u.b[min_bytes + extra - 1] = CVAL(b2, 0);
1221 #if SIZEOF_INT64 < 8
1223 #elif CAREFUL_ALIGNMENT
1224 u.x = IVAL(u.b,0) | (((int64)IVAL(u.b,4))<<32);
1229 int64 read_longint(int f)
1231 #if SIZEOF_INT64 >= 8
1234 int32 num = read_int(f);
1236 if (num != (int32)0xffffffff)
1239 #if SIZEOF_INT64 < 8
1240 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1241 exit_cleanup(RERR_UNSUPPORTED);
1244 return IVAL(b,0) | (((int64)IVAL(b,4))<<32);
1248 void read_buf(int f, char *buf, size_t len)
1253 void read_sbuf(int f, char *buf, size_t len)
1255 readfd(f, buf, len);
1259 uchar read_byte(int f)
1262 readfd(f, (char *)&c, 1);
1266 int read_vstring(int f, char *buf, int bufsize)
1268 int len = read_byte(f);
1271 len = (len & ~0x80) * 0x100 + read_byte(f);
1273 if (len >= bufsize) {
1274 rprintf(FERROR, "over-long vstring received (%d > %d)\n",
1280 readfd(f, buf, len);
1285 /* Populate a sum_struct with values from the socket. This is
1286 * called by both the sender and the receiver. */
1287 void read_sum_head(int f, struct sum_struct *sum)
1289 int32 max_blength = protocol_version < 30 ? OLD_MAX_BLOCK_SIZE : MAX_BLOCK_SIZE;
1290 sum->count = read_int(f);
1291 if (sum->count < 0) {
1292 rprintf(FERROR, "Invalid checksum count %ld [%s]\n",
1293 (long)sum->count, who_am_i());
1294 exit_cleanup(RERR_PROTOCOL);
1296 sum->blength = read_int(f);
1297 if (sum->blength < 0 || sum->blength > max_blength) {
1298 rprintf(FERROR, "Invalid block length %ld [%s]\n",
1299 (long)sum->blength, who_am_i());
1300 exit_cleanup(RERR_PROTOCOL);
1302 sum->s2length = protocol_version < 27 ? csum_length : (int)read_int(f);
1303 if (sum->s2length < 0 || sum->s2length > MAX_DIGEST_LEN) {
1304 rprintf(FERROR, "Invalid checksum length %d [%s]\n",
1305 sum->s2length, who_am_i());
1306 exit_cleanup(RERR_PROTOCOL);
1308 sum->remainder = read_int(f);
1309 if (sum->remainder < 0 || sum->remainder > sum->blength) {
1310 rprintf(FERROR, "Invalid remainder length %ld [%s]\n",
1311 (long)sum->remainder, who_am_i());
1312 exit_cleanup(RERR_PROTOCOL);
1316 /* Send the values from a sum_struct over the socket. Set sum to
1317 * NULL if there are no checksums to send. This is called by both
1318 * the generator and the sender. */
1319 void write_sum_head(int f, struct sum_struct *sum)
1321 static struct sum_struct null_sum;
1326 write_int(f, sum->count);
1327 write_int(f, sum->blength);
1328 if (protocol_version >= 27)
1329 write_int(f, sum->s2length);
1330 write_int(f, sum->remainder);
1334 * Sleep after writing to limit I/O bandwidth usage.
1336 * @todo Rather than sleeping after each write, it might be better to
1337 * use some kind of averaging. The current algorithm seems to always
1338 * use a bit less bandwidth than specified, because it doesn't make up
1339 * for slow periods. But arguably this is a feature. In addition, we
1340 * ought to take the time used to write the data into account.
1342 * During some phases of big transfers (file FOO is uptodate) this is
1343 * called with a small bytes_written every time. As the kernel has to
1344 * round small waits up to guarantee that we actually wait at least the
1345 * requested number of microseconds, this can become grossly inaccurate.
1346 * We therefore keep track of the bytes we've written over time and only
1347 * sleep when the accumulated delay is at least 1 tenth of a second.
1349 static void sleep_for_bwlimit(int bytes_written)
1351 static struct timeval prior_tv;
1352 static long total_written = 0;
1353 struct timeval tv, start_tv;
1354 long elapsed_usec, sleep_usec;
1356 #define ONE_SEC 1000000L /* # of microseconds in a second */
1358 if (!bwlimit_writemax)
1361 total_written += bytes_written;
1363 gettimeofday(&start_tv, NULL);
1364 if (prior_tv.tv_sec) {
1365 elapsed_usec = (start_tv.tv_sec - prior_tv.tv_sec) * ONE_SEC
1366 + (start_tv.tv_usec - prior_tv.tv_usec);
1367 total_written -= elapsed_usec * bwlimit / (ONE_SEC/1024);
1368 if (total_written < 0)
1372 sleep_usec = total_written * (ONE_SEC/1024) / bwlimit;
1373 if (sleep_usec < ONE_SEC / 10) {
1374 prior_tv = start_tv;
1378 tv.tv_sec = sleep_usec / ONE_SEC;
1379 tv.tv_usec = sleep_usec % ONE_SEC;
1380 select(0, NULL, NULL, NULL, &tv);
1382 gettimeofday(&prior_tv, NULL);
1383 elapsed_usec = (prior_tv.tv_sec - start_tv.tv_sec) * ONE_SEC
1384 + (prior_tv.tv_usec - start_tv.tv_usec);
1385 total_written = (sleep_usec - elapsed_usec) * bwlimit / (ONE_SEC/1024);
1388 static const char *what_fd_is(int fd)
1390 static char buf[20];
1392 if (fd == sock_f_out)
1394 else if (fd == msg_fd_out)
1395 return "message fd";
1396 else if (fd == batch_fd)
1397 return "batch file";
1399 snprintf(buf, sizeof buf, "fd %d", fd);
1404 /* Write len bytes to the file descriptor fd, looping as necessary to get
1405 * the job done and also (in certain circumstances) reading any data on
1406 * msg_fd_in to avoid deadlock.
1408 * This function underlies the multiplexing system. The body of the
1409 * application never calls this function directly. */
1410 static void writefd_unbuffered(int fd, const char *buf, size_t len)
1412 size_t n, total = 0;
1413 fd_set w_fds, r_fds, e_fds;
1414 int maxfd, count, cnt, using_r_fds;
1419 defer_forwarding_messages++, defer_inc++;
1421 while (total < len) {
1428 if (msg_fd_in >= 0 && iobuf_in_remaining == 0) {
1430 FD_SET(msg_fd_in, &r_fds);
1431 if (msg_fd_in > maxfd)
1437 tv.tv_sec = select_timeout;
1441 count = select(maxfd + 1, using_r_fds ? &r_fds : NULL,
1442 &w_fds, &e_fds, &tv);
1445 if (count < 0 && errno == EBADF)
1446 exit_cleanup(RERR_SOCKETIO);
1451 /*if (FD_ISSET(fd, &e_fds))
1452 rprintf(FINFO, "select exception on fd %d\n", fd); */
1454 if (using_r_fds && FD_ISSET(msg_fd_in, &r_fds))
1455 read_a_msg(msg_fd_in);
1457 if (!FD_ISSET(fd, &w_fds))
1461 if (bwlimit_writemax && n > bwlimit_writemax)
1462 n = bwlimit_writemax;
1463 cnt = write(fd, buf + total, n);
1469 if (errno == EWOULDBLOCK || errno == EAGAIN) {
1475 /* Don't try to write errors back across the stream. */
1476 if (fd == sock_f_out)
1477 io_multiplexing_out = 0;
1478 /* Don't try to write errors down a failing msg pipe. */
1479 if (am_server && fd == msg_fd_out)
1480 exit_cleanup(RERR_STREAMIO);
1481 rsyserr(FERROR, errno,
1482 "writefd_unbuffered failed to write %ld bytes to %s [%s]",
1483 (long)len, what_fd_is(fd), who_am_i());
1484 /* If the other side is sending us error messages, try
1485 * to grab any messages they sent before they died. */
1486 while (!am_server && fd == sock_f_out && io_multiplexing_in) {
1490 readfd_unbuffered(iobuf_f_in, buf, sizeof buf);
1492 exit_cleanup(RERR_STREAMIO);
1496 defer_forwarding_messages++, defer_inc++;
1498 if (fd == sock_f_out) {
1499 if (io_timeout || am_generator)
1500 last_io_out = time(NULL);
1501 sleep_for_bwlimit(cnt);
1506 if (keep_defer_forwarding)
1508 if (!(defer_forwarding_messages -= defer_inc) && !no_flush)
1512 int io_flush(int flush_it_all)
1514 int flushed_something = 0;
1519 if (iobuf_out_cnt) {
1520 if (io_multiplexing_out)
1521 mplex_write(iobuf_f_out, MSG_DATA, iobuf_out, iobuf_out_cnt, 0);
1523 writefd_unbuffered(iobuf_f_out, iobuf_out, iobuf_out_cnt);
1525 flushed_something = 1;
1528 if (flush_it_all && !defer_forwarding_messages && msg_queue.head) {
1530 flushed_something = 1;
1533 return flushed_something;
1536 static void writefd(int fd, const char *buf, size_t len)
1538 if (fd == sock_f_out)
1539 stats.total_written += len;
1541 if (fd == write_batch_monitor_out)
1542 writefd_unbuffered(batch_fd, buf, len);
1544 if (!iobuf_out || fd != iobuf_f_out) {
1545 writefd_unbuffered(fd, buf, len);
1550 int n = MIN((int)len, IO_BUFFER_SIZE - iobuf_out_cnt);
1552 memcpy(iobuf_out+iobuf_out_cnt, buf, n);
1558 if (iobuf_out_cnt == IO_BUFFER_SIZE)
1559 io_flush(NORMAL_FLUSH);
1563 void write_shortint(int f, unsigned short x)
1567 b[1] = (char)(x >> 8);
1571 void write_int(int f, int32 x)
1578 void write_varint(int f, int32 x)
1586 while (cnt > 1 && b[cnt] == 0)
1588 bit = ((uchar)1<<(7-cnt+1));
1589 if (CVAL(b, cnt) >= bit) {
1593 *b = b[cnt] | ~(bit*2-1);
1600 void write_varlong(int f, int64 x, uchar min_bytes)
1607 #if SIZEOF_INT64 >= 8
1608 SIVAL(b, 5, x >> 32);
1610 if (x <= 0x7FFFFFFF && x >= 0)
1611 memset(b + 5, 0, 4);
1613 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1614 exit_cleanup(RERR_UNSUPPORTED);
1618 while (cnt > min_bytes && b[cnt] == 0)
1620 bit = ((uchar)1<<(7-cnt+min_bytes));
1621 if (CVAL(b, cnt) >= bit) {
1624 } else if (cnt > min_bytes)
1625 *b = b[cnt] | ~(bit*2-1);
1633 * Note: int64 may actually be a 32-bit type if ./configure couldn't find any
1634 * 64-bit types on this platform.
1636 void write_longint(int f, int64 x)
1638 char b[12], * const s = b+4;
1641 if (x <= 0x7FFFFFFF && x >= 0) {
1646 #if SIZEOF_INT64 < 8
1647 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1648 exit_cleanup(RERR_UNSUPPORTED);
1651 SIVAL(s, 4, x >> 32);
1656 void write_buf(int f, const char *buf, size_t len)
1661 /** Write a string to the connection */
1662 void write_sbuf(int f, const char *buf)
1664 writefd(f, buf, strlen(buf));
1667 void write_byte(int f, uchar c)
1669 writefd(f, (char *)&c, 1);
1672 void write_vstring(int f, const char *str, int len)
1674 uchar lenbuf[3], *lb = lenbuf;
1679 "attempting to send over-long vstring (%d > %d)\n",
1681 exit_cleanup(RERR_PROTOCOL);
1683 *lb++ = len / 0x100 + 0x80;
1687 writefd(f, (char*)lenbuf, lb - lenbuf + 1);
1689 writefd(f, str, len);
1692 /* Send a file-list index using a byte-reduction method. */
1693 void write_ndx(int f, int32 ndx)
1695 static int32 prev_positive = -1, prev_negative = 1;
1696 int32 diff, cnt = 0;
1699 if (protocol_version < 30 || read_batch) {
1704 /* Send NDX_DONE as a single-byte 0 with no side effects. Send
1705 * negative nums as a positive after sending a leading 0xFF. */
1707 diff = ndx - prev_positive;
1708 prev_positive = ndx;
1709 } else if (ndx == NDX_DONE) {
1714 b[cnt++] = (char)0xFF;
1716 diff = ndx - prev_negative;
1717 prev_negative = ndx;
1720 /* A diff of 1 - 253 is sent as a one-byte diff; a diff of 254 - 32767
1721 * or 0 is sent as a 0xFE + a two-byte diff; otherwise we send 0xFE
1722 * & all 4 bytes of the (non-negative) num with the high-bit set. */
1723 if (diff < 0xFE && diff > 0)
1724 b[cnt++] = (char)diff;
1725 else if (diff < 0 || diff > 0x7FFF) {
1726 b[cnt++] = (char)0xFE;
1727 b[cnt++] = (char)((ndx >> 24) | 0x80);
1728 b[cnt++] = (char)ndx;
1729 b[cnt++] = (char)(ndx >> 8);
1730 b[cnt++] = (char)(ndx >> 16);
1732 b[cnt++] = (char)0xFE;
1733 b[cnt++] = (char)(diff >> 8);
1734 b[cnt++] = (char)diff;
1739 /* Receive a file-list index using a byte-reduction method. */
1740 int32 read_ndx(int f)
1742 static int32 prev_positive = -1, prev_negative = 1;
1743 int32 *prev_ptr, num;
1746 if (protocol_version < 30)
1750 if (CVAL(b, 0) == 0xFF) {
1752 prev_ptr = &prev_negative;
1753 } else if (CVAL(b, 0) == 0)
1756 prev_ptr = &prev_positive;
1757 if (CVAL(b, 0) == 0xFE) {
1759 if (CVAL(b, 0) & 0x80) {
1760 b[3] = CVAL(b, 0) & ~0x80;
1765 num = (UVAL(b,0)<<8) + UVAL(b,1) + *prev_ptr;
1767 num = UVAL(b, 0) + *prev_ptr;
1769 if (prev_ptr == &prev_negative)
1774 /* Read a line of up to bufsiz-1 characters into buf. Strips
1775 * the (required) trailing newline and all carriage returns.
1776 * Returns 1 for success; 0 for I/O error or truncation. */
1777 int read_line_old(int f, char *buf, size_t bufsiz)
1779 bufsiz--; /* leave room for the null */
1780 while (bufsiz > 0) {
1782 read_buf(f, buf, 1);
1787 if (buf[0] != '\r') {
1796 void io_printf(int fd, const char *format, ...)
1799 char buf[BIGPATHBUFLEN];
1802 va_start(ap, format);
1803 len = vsnprintf(buf, sizeof buf, format, ap);
1807 exit_cleanup(RERR_STREAMIO);
1809 if (len > (int)sizeof buf) {
1810 rprintf(FERROR, "io_printf() was too long for the buffer.\n");
1811 exit_cleanup(RERR_STREAMIO);
1814 write_sbuf(fd, buf);
1817 /** Setup for multiplexing a MSG_* stream with the data stream. */
1818 void io_start_multiplex_out(int f)
1820 io_flush(NORMAL_FLUSH);
1821 io_start_buffering_out(f);
1822 io_multiplexing_out = 1;
1825 /** Setup for multiplexing a MSG_* stream with the data stream. */
1826 void io_start_multiplex_in(int f)
1828 io_flush(NORMAL_FLUSH);
1829 io_start_buffering_in(f);
1830 io_multiplexing_in = 1;
1833 /** Write an message to the multiplexed data stream. */
1834 int io_multiplex_write(enum msgcode code, const char *buf, size_t len, int convert)
1836 if (!io_multiplexing_out)
1838 io_flush(NORMAL_FLUSH);
1839 stats.total_written += (len+4);
1840 mplex_write(iobuf_f_out, code, buf, len, convert);
1844 void io_end_multiplex_in(void)
1846 io_multiplexing_in = 0;
1847 io_end_buffering_in();
1850 /** Stop output multiplexing. */
1851 void io_end_multiplex_out(void)
1853 io_multiplexing_out = 0;
1854 io_end_buffering_out();
1857 void start_write_batch(int fd)
1859 /* Some communication has already taken place, but we don't
1860 * enable batch writing until here so that we can write a
1861 * canonical record of the communication even though the
1862 * actual communication so far depends on whether a daemon
1864 write_int(batch_fd, protocol_version);
1865 if (protocol_version >= 30)
1866 write_byte(batch_fd, inc_recurse);
1867 write_int(batch_fd, checksum_seed);
1870 write_batch_monitor_out = fd;
1872 write_batch_monitor_in = fd;
1875 void stop_write_batch(void)
1877 write_batch_monitor_out = -1;
1878 write_batch_monitor_in = -1;