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-2007 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;
39 extern int allowed_lull;
43 extern int am_generator;
44 extern int inc_recurse;
48 extern int read_batch;
49 extern int csum_length;
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 const char phase_unknown[] = "unknown";
63 int ignore_timeout = 0;
67 /* Ignore an EOF error if non-zero. See whine_about_eof(). */
68 int kluge_around_eof = 0;
75 static int iobuf_f_in = -1;
76 static char *iobuf_in;
77 static size_t iobuf_in_siz;
78 static size_t iobuf_in_ndx;
79 static size_t iobuf_in_remaining;
81 static int iobuf_f_out = -1;
82 static char *iobuf_out;
83 static int iobuf_out_cnt;
85 int flist_forward_from = -1;
87 static int io_multiplexing_out;
88 static int io_multiplexing_in;
89 static time_t last_io_in;
90 static time_t last_io_out;
93 static int write_batch_monitor_in = -1;
94 static int write_batch_monitor_out = -1;
96 static int io_filesfrom_f_in = -1;
97 static int io_filesfrom_f_out = -1;
98 static xbuf ff_buf = EMPTY_XBUF;
99 static char ff_lastchar;
101 static xbuf iconv_buf = EMPTY_XBUF;
103 static int defer_forwarding_messages = 0;
104 static int select_timeout = SELECT_TIMEOUT;
105 static int active_filecnt = 0;
106 static OFF_T active_bytecnt = 0;
108 static char int_byte_extra[64] = {
109 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* (00 - 3F)/4 */
110 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* (40 - 7F)/4 */
111 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /* (80 - BF)/4 */
112 2, 2, 2, 2, 2, 2, 2, 2, 3, 3, 3, 3, 4, 4, 5, 6, /* (C0 - FF)/4 */
115 enum festatus { FES_SUCCESS, FES_REDO, FES_NO_SEND };
117 static void readfd(int fd, char *buffer, size_t N);
118 static void writefd(int fd, const char *buf, size_t len);
119 static void writefd_unbuffered(int fd, const char *buf, size_t len);
120 static void mplex_write(int fd, enum msgcode code, const char *buf, size_t len, int convert);
122 struct flist_ndx_item {
123 struct flist_ndx_item *next;
127 struct flist_ndx_list {
128 struct flist_ndx_item *head, *tail;
131 static struct 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 flist_ndx_push(struct flist_ndx_list *lp, int ndx)
147 struct flist_ndx_item *item;
149 if (!(item = new(struct flist_ndx_item)))
150 out_of_memory("flist_ndx_push");
154 lp->tail->next = item;
160 static int flist_ndx_pop(struct flist_ndx_list *lp)
162 struct flist_ndx_item *next;
169 next = lp->head->next;
178 static void got_flist_entry_status(enum festatus status, const char *buf)
180 int ndx = IVAL(buf, 0);
181 struct file_list *flist = flist_for_ndx(ndx);
183 assert(flist != NULL);
184 assert(ndx >= flist->ndx_start);
186 if (remove_source_files) {
188 active_bytecnt -= F_LENGTH(flist->files[ndx - flist->ndx_start]);
192 flist->in_progress--;
196 if (remove_source_files)
197 send_msg(MSG_SUCCESS, buf, 4, 0);
198 if (preserve_hard_links) {
199 struct file_struct *file = flist->files[ndx - flist->ndx_start];
200 if (F_IS_HLINKED(file))
201 flist_ndx_push(&hlink_list, ndx);
207 flist_ndx_push(&redo_list, ndx);
214 static void check_timeout(void)
218 if (!io_timeout || ignore_timeout)
222 last_io_in = time(NULL);
228 if (t - last_io_in >= io_timeout) {
229 if (!am_server && !am_daemon) {
230 rprintf(FERROR, "io timeout after %d seconds -- exiting\n",
231 (int)(t-last_io_in));
233 exit_cleanup(RERR_TIMEOUT);
237 /* Note the fds used for the main socket (which might really be a pipe
238 * for a local transfer, but we can ignore that). */
239 void io_set_sock_fds(int f_in, int f_out)
245 void set_io_timeout(int secs)
249 if (!io_timeout || io_timeout > SELECT_TIMEOUT)
250 select_timeout = SELECT_TIMEOUT;
252 select_timeout = io_timeout;
254 allowed_lull = read_batch ? 0 : (io_timeout + 1) / 2;
257 /* Setup the fd used to receive MSG_* messages. Only needed during the
258 * early stages of being a local sender (up through the sending of the
259 * file list) or when we're the generator (to fetch the messages from
261 void set_msg_fd_in(int fd)
266 /* Setup the fd used to send our MSG_* messages. Only needed when
267 * we're the receiver (to send our messages to the generator). */
268 void set_msg_fd_out(int fd)
271 set_nonblocking(msg_fd_out);
274 /* Add a message to the pending MSG_* list. */
275 static void msg_list_add(struct msg_list *lst, int code, const char *buf, int len, int convert)
277 struct msg_list_item *m;
278 int sz = len + 4 + sizeof m[0] - 1;
280 if (!(m = (struct msg_list_item *)new_array(char, sz)))
281 out_of_memory("msg_list_add");
283 m->convert = convert;
284 SIVAL(m->buf, 0, ((code+MPLEX_BASE)<<24) | len);
285 memcpy(m->buf + 4, buf, len);
293 static void msg_flush(void)
296 while (msg_queue.head && io_multiplexing_out) {
297 struct msg_list_item *m = msg_queue.head;
298 int len = IVAL(m->buf, 0) & 0xFFFFFF;
299 int tag = *((uchar*)m->buf+3) - MPLEX_BASE;
300 if (!(msg_queue.head = m->next))
301 msg_queue.tail = NULL;
302 stats.total_written += len + 4;
303 defer_forwarding_messages++;
304 mplex_write(sock_f_out, tag, m->buf + 4, len, m->convert);
305 defer_forwarding_messages--;
309 while (msg_queue.head) {
310 struct msg_list_item *m = msg_queue.head;
311 int len = IVAL(m->buf, 0) & 0xFFFFFF;
312 int tag = *((uchar*)m->buf+3) - MPLEX_BASE;
313 if (!(msg_queue.head = m->next))
314 msg_queue.tail = NULL;
315 defer_forwarding_messages++;
316 mplex_write(msg_fd_out, tag, m->buf + 4, len, m->convert);
317 defer_forwarding_messages--;
323 /* Read a message from the MSG_* fd and handle it. This is called either
324 * during the early stages of being a local sender (up through the sending
325 * of the file list) or when we're the generator (to fetch the messages
326 * from the receiver). */
327 static void read_msg_fd(void)
331 struct file_list *flist;
335 /* Temporarily disable msg_fd_in. This is needed to avoid looping back
336 * to this routine from writefd_unbuffered(). */
339 defer_forwarding_messages++;
344 len = tag & 0xFFFFFF;
345 tag = (tag >> 24) - MPLEX_BASE;
349 if (len < 0 || len > 1 || !am_generator) {
351 rprintf(FERROR, "invalid message %d:%d [%s%s]\n",
352 tag, len, who_am_i(),
353 inc_recurse ? "/inc" : "");
354 exit_cleanup(RERR_STREAMIO);
357 readfd(fd, buf, len);
358 stats.total_read = read_varlong(fd, 3);
363 if (len != 4 || !am_generator)
366 got_flist_entry_status(FES_REDO, buf);
369 if (len != 4 || !am_generator || !inc_recurse)
372 /* Read extra file list from receiver. */
373 assert(iobuf_in != NULL);
374 assert(iobuf_f_in == fd);
376 rprintf(FINFO, "[%s] receiving flist for dir %d\n",
377 who_am_i(), IVAL(buf,0));
379 flist = recv_file_list(fd);
380 flist->parent_ndx = IVAL(buf,0);
381 #ifdef SUPPORT_HARD_LINKS
382 if (preserve_hard_links)
383 match_hard_links(flist);
387 if (len != 0 || !am_generator || !inc_recurse)
394 readfd(fd, buf, len);
395 io_error |= IVAL(buf, 0);
398 if (len >= (int)sizeof buf || !am_generator)
400 readfd(fd, buf, len);
401 send_msg(MSG_DELETED, buf, len, 1);
404 if (len != 4 || !am_generator)
407 got_flist_entry_status(FES_SUCCESS, buf);
410 if (len != 4 || !am_generator)
413 got_flist_entry_status(FES_NO_SEND, buf);
419 if (tag == MSG_SOCKERR)
420 io_end_multiplex_out();
430 rwrite((enum logcode)tag, buf, n, !am_generator);
435 rprintf(FERROR, "unknown message %d:%d [%s]\n",
436 tag, len, who_am_i());
437 exit_cleanup(RERR_STREAMIO);
442 if (!--defer_forwarding_messages)
446 /* This is used by the generator to limit how many file transfers can
447 * be active at once when --remove-source-files is specified. Without
448 * this, sender-side deletions were mostly happening at the end. */
449 void increment_active_files(int ndx, int itemizing, enum logcode code)
451 /* TODO: tune these limits? */
452 while (active_filecnt >= (active_bytecnt >= 128*1024 ? 10 : 50)) {
453 check_for_finished_files(itemizing, code, 0);
455 io_flush(NORMAL_FLUSH);
461 active_bytecnt += F_LENGTH(cur_flist->files[ndx - cur_flist->ndx_start]);
464 /* Write an message to a multiplexed stream. If this fails, rsync exits. */
465 static void mplex_write(int fd, enum msgcode code, const char *buf, size_t len, int convert)
467 char buffer[BIGPATHBUFLEN]; /* Oversized for use by iconv code. */
470 SIVAL(buffer, 0, ((MPLEX_BASE + (int)code)<<24) + len);
473 if (convert && ic_send == (iconv_t)-1)
477 if (convert || n > 1024 - 4) /* BIGPATHBUFLEN can handle 1024 bytes */
480 memcpy(buffer + 4, buf, n);
482 writefd_unbuffered(fd, buffer, n+4);
491 INIT_CONST_XBUF(outbuf, buffer);
492 INIT_XBUF(inbuf, (char*)buf, len, -1);
494 defer_forwarding_messages++;
496 iconvbufs(ic_send, &inbuf, &outbuf,
497 ICB_INCLUDE_BAD | ICB_INCLUDE_INCOMPLETE);
498 writefd_unbuffered(fd, outbuf.buf, outbuf.len);
500 if (!--defer_forwarding_messages)
505 defer_forwarding_messages++;
506 writefd_unbuffered(fd, buf, len);
507 if (!--defer_forwarding_messages)
512 int send_msg(enum msgcode code, const char *buf, int len, int convert)
514 if (msg_fd_out < 0) {
515 if (!defer_forwarding_messages)
516 return io_multiplex_write(code, buf, len, convert);
517 if (!io_multiplexing_out)
519 msg_list_add(&msg_queue, code, buf, len, convert);
522 if (flist_forward_from >= 0)
523 msg_list_add(&msg_queue, code, buf, len, convert);
525 mplex_write(msg_fd_out, code, buf, len, convert);
529 void send_msg_int(enum msgcode code, int num)
532 SIVAL(numbuf, 0, num);
533 send_msg(code, numbuf, 4, 0);
536 void wait_for_receiver(void)
539 io_flush(NORMAL_FLUSH);
544 int get_redo_num(void)
546 return flist_ndx_pop(&redo_list);
549 int get_hlink_num(void)
551 return flist_ndx_pop(&hlink_list);
555 * When we're the receiver and we have a local --files-from list of names
556 * that needs to be sent over the socket to the sender, we have to do two
557 * things at the same time: send the sender a list of what files we're
558 * processing and read the incoming file+info list from the sender. We do
559 * this by augmenting the read_timeout() function to copy this data. It
560 * uses ff_buf to read a block of data from f_in (when it is ready, since
561 * it might be a pipe) and then blast it out f_out (when it is ready to
562 * receive more data).
564 void io_set_filesfrom_fds(int f_in, int f_out)
566 io_filesfrom_f_in = f_in;
567 io_filesfrom_f_out = f_out;
568 alloc_xbuf(&ff_buf, 2048);
571 alloc_xbuf(&iconv_buf, 1024);
575 /* It's almost always an error to get an EOF when we're trying to read from the
576 * network, because the protocol is (for the most part) self-terminating.
578 * There is one case for the receiver when it is at the end of the transfer
579 * (hanging around reading any keep-alive packets that might come its way): if
580 * the sender dies before the generator's kill-signal comes through, we can end
581 * up here needing to loop until the kill-signal arrives. In this situation,
582 * kluge_around_eof will be < 0.
584 * There is another case for older protocol versions (< 24) where the module
585 * listing was not terminated, so we must ignore an EOF error in that case and
586 * exit. In this situation, kluge_around_eof will be > 0. */
587 static void whine_about_eof(int fd)
589 if (kluge_around_eof && fd == sock_f_in) {
591 if (kluge_around_eof > 0)
593 /* If we're still here after 10 seconds, exit with an error. */
594 for (i = 10*1000/20; i--; )
598 rprintf(FERROR, RSYNC_NAME ": connection unexpectedly closed "
599 "(%.0f bytes received so far) [%s]\n",
600 (double)stats.total_read, who_am_i());
602 exit_cleanup(RERR_STREAMIO);
606 * Read from a socket with I/O timeout. return the number of bytes
607 * read. If no bytes can be read then exit, never return a number <= 0.
609 * TODO: If the remote shell connection fails, then current versions
610 * actually report an "unexpected EOF" error here. Since it's a
611 * fairly common mistake to try to use rsh when ssh is required, we
612 * should trap that: if we fail to read any data at all, we should
613 * give a better explanation. We can tell whether the connection has
614 * started by looking e.g. at whether the remote version is known yet.
616 static int read_timeout(int fd, char *buf, size_t len)
620 io_flush(FULL_FLUSH);
623 /* until we manage to read *something* */
632 if (io_filesfrom_f_out >= 0) {
634 if (ff_buf.len == 0) {
635 if (io_filesfrom_f_in >= 0) {
636 FD_SET(io_filesfrom_f_in, &r_fds);
637 new_fd = io_filesfrom_f_in;
639 io_filesfrom_f_out = -1;
643 FD_SET(io_filesfrom_f_out, &w_fds);
644 new_fd = io_filesfrom_f_out;
650 tv.tv_sec = select_timeout;
655 count = select(maxfd + 1, &r_fds, &w_fds, NULL, &tv);
658 if (errno == EBADF) {
659 defer_forwarding_messages = 0;
660 exit_cleanup(RERR_SOCKETIO);
666 if (io_filesfrom_f_out >= 0) {
668 if (FD_ISSET(io_filesfrom_f_out, &w_fds)) {
669 int l = write(io_filesfrom_f_out,
670 ff_buf.buf + ff_buf.pos,
673 if (!(ff_buf.len -= l))
677 } else if (errno != EINTR) {
678 /* XXX should we complain? */
679 io_filesfrom_f_out = -1;
682 } else if (io_filesfrom_f_in >= 0) {
683 if (FD_ISSET(io_filesfrom_f_in, &r_fds)) {
685 xbuf *ibuf = filesfrom_convert ? &iconv_buf : &ff_buf;
687 xbuf *ibuf = &ff_buf;
689 int l = read(io_filesfrom_f_in, ibuf->buf, ibuf->size);
691 if (l == 0 || errno != EINTR) {
692 /* Send end-of-file marker */
693 memcpy(ff_buf.buf, "\0\0", 2);
694 ff_buf.len = ff_lastchar? 2 : 1;
696 io_filesfrom_f_in = -1;
700 if (filesfrom_convert) {
703 iconvbufs(ic_send, &iconv_buf, &ff_buf,
704 ICB_EXPAND_OUT|ICB_INCLUDE_BAD|ICB_INCLUDE_INCOMPLETE);
709 char *s = ff_buf.buf + l;
710 /* Transform CR and/or LF into '\0' */
711 while (s-- > ff_buf.buf) {
712 if (*s == '\n' || *s == '\r')
717 /* Last buf ended with a '\0', so don't
718 * let this buf start with one. */
719 while (l && ff_buf.buf[ff_buf.pos] == '\0')
725 char *f = ff_buf.buf + ff_buf.pos;
728 /* Eliminate any multi-'\0' runs. */
730 if (!(*t++ = *f++)) {
731 while (f != eob && !*f)
743 if (!FD_ISSET(fd, &r_fds))
746 n = read(fd, buf, len);
750 whine_about_eof(fd); /* Doesn't return. */
751 if (errno == EINTR || errno == EWOULDBLOCK
755 /* Don't write errors on a dead socket. */
756 if (fd == sock_f_in) {
757 io_end_multiplex_out();
758 rsyserr(FSOCKERR, errno, "read error");
760 rsyserr(FERROR, errno, "read error");
761 exit_cleanup(RERR_STREAMIO);
768 if (fd == sock_f_in && io_timeout)
769 last_io_in = time(NULL);
775 /* Read a line into the "buf" buffer. */
776 int read_line(int fd, char *buf, size_t bufsiz, int flags)
782 if (flags & RL_CONVERT && iconv_buf.size < bufsiz)
783 realloc_xbuf(&iconv_buf, bufsiz + 1024);
788 s = flags & RL_CONVERT ? iconv_buf.buf : buf;
792 eob = s + bufsiz - 1;
794 cnt = read(fd, &ch, 1);
795 if (cnt < 0 && (errno == EWOULDBLOCK
796 || errno == EINTR || errno == EAGAIN)) {
803 tv.tv_sec = select_timeout;
805 if (!select(fd+1, &r_fds, NULL, &e_fds, &tv))
807 /*if (FD_ISSET(fd, &e_fds))
808 rprintf(FINFO, "select exception on fd %d\n", fd); */
813 if (flags & RL_EOL_NULLS ? ch == '\0' : (ch == '\r' || ch == '\n')) {
814 /* Skip empty lines if dumping comments. */
815 if (flags & RL_DUMP_COMMENTS && s == buf)
824 if (flags & RL_DUMP_COMMENTS && (*buf == '#' || *buf == ';'))
828 if (flags & RL_CONVERT) {
830 INIT_XBUF(outbuf, buf, 0, bufsiz);
832 iconv_buf.len = s - iconv_buf.buf;
833 iconvbufs(ic_recv, &iconv_buf, &outbuf,
834 ICB_INCLUDE_BAD | ICB_INCLUDE_INCOMPLETE);
835 outbuf.buf[outbuf.len] = '\0';
843 int read_args(int f_in, char *mod_name, char *buf, size_t bufsiz, int rl_nulls,
844 char ***argv_p, int *argc_p, char **request_p)
846 int maxargs = MAX_ARGS;
850 int rl_flags = (rl_nulls ? RL_EOL_NULLS : 0);
853 rl_flags |= (protect_args && ic_recv != (iconv_t)-1 ? RL_CONVERT : 0);
856 if (!(argv = new_array(char *, maxargs)))
857 out_of_memory("read_args");
859 argv[argc++] = "rsyncd";
862 if (read_line(f_in, buf, bufsiz, rl_flags) == 0)
865 if (argc == maxargs) {
867 if (!(argv = realloc_array(argv, char *, maxargs)))
868 out_of_memory("read_args");
873 *request_p = strdup(buf);
877 glob_expand_module(mod_name, buf, &argv, &argc, &maxargs);
879 glob_expand(buf, &argv, &argc, &maxargs);
881 if (!(p = strdup(buf)))
882 out_of_memory("read_args");
884 if (*p == '.' && p[1] == '\0')
892 return dot_pos ? dot_pos : argc;
895 int io_start_buffering_out(int f_out)
898 assert(f_out == iobuf_f_out);
901 if (!(iobuf_out = new_array(char, IO_BUFFER_SIZE)))
902 out_of_memory("io_start_buffering_out");
908 int io_start_buffering_in(int f_in)
911 assert(f_in == iobuf_f_in);
914 iobuf_in_siz = 2 * IO_BUFFER_SIZE;
915 if (!(iobuf_in = new_array(char, iobuf_in_siz)))
916 out_of_memory("io_start_buffering_in");
921 void io_end_buffering_in(void)
928 iobuf_in_remaining = 0;
932 void io_end_buffering_out(void)
936 io_flush(FULL_FLUSH);
942 void maybe_flush_socket(int important)
944 if (iobuf_out && iobuf_out_cnt
945 && (important || time(NULL) - last_io_out >= 5))
946 io_flush(NORMAL_FLUSH);
949 void maybe_send_keepalive(void)
951 if (time(NULL) - last_io_out >= allowed_lull) {
952 if (!iobuf_out || !iobuf_out_cnt) {
953 if (protocol_version < 29)
954 return; /* there's nothing we can do */
955 if (protocol_version >= 30)
956 send_msg(MSG_NOOP, "", 0, 0);
958 write_int(sock_f_out, cur_flist->used);
959 write_shortint(sock_f_out, ITEM_IS_NEW);
963 io_flush(NORMAL_FLUSH);
967 void start_flist_forward(int f_in)
969 assert(iobuf_out != NULL);
970 assert(iobuf_f_out == msg_fd_out);
971 flist_forward_from = f_in;
974 void stop_flist_forward()
976 flist_forward_from = -1;
977 io_flush(FULL_FLUSH);
981 * Continue trying to read len bytes - don't return until len has been
984 static void read_loop(int fd, char *buf, size_t len)
987 int n = read_timeout(fd, buf, len);
995 * Read from the file descriptor handling multiplexing - return number
998 * Never returns <= 0.
1000 static int readfd_unbuffered(int fd, char *buf, size_t len)
1004 char line[BIGPATHBUFLEN];
1006 if (!iobuf_in || fd != iobuf_f_in)
1007 return read_timeout(fd, buf, len);
1009 if (!io_multiplexing_in && iobuf_in_remaining == 0) {
1010 iobuf_in_remaining = read_timeout(fd, iobuf_in, iobuf_in_siz);
1015 if (iobuf_in_remaining) {
1016 len = MIN(len, iobuf_in_remaining);
1017 memcpy(buf, iobuf_in + iobuf_in_ndx, len);
1018 iobuf_in_ndx += len;
1019 iobuf_in_remaining -= len;
1024 read_loop(fd, line, 4);
1025 tag = IVAL(line, 0);
1027 msg_bytes = tag & 0xFFFFFF;
1028 tag = (tag >> 24) - MPLEX_BASE;
1032 if (msg_bytes > iobuf_in_siz) {
1033 if (!(iobuf_in = realloc_array(iobuf_in, char,
1035 out_of_memory("readfd_unbuffered");
1036 iobuf_in_siz = msg_bytes;
1038 read_loop(fd, iobuf_in, msg_bytes);
1039 iobuf_in_remaining = msg_bytes;
1044 maybe_send_keepalive();
1049 read_loop(fd, line, msg_bytes);
1050 send_msg_int(MSG_IO_ERROR, IVAL(line, 0));
1051 io_error |= IVAL(line, 0);
1054 if (msg_bytes >= sizeof line)
1057 if (ic_recv != (iconv_t)-1) {
1063 INIT_CONST_XBUF(outbuf, line);
1067 inbuf.len = msg_bytes > sizeof ibuf
1068 ? sizeof ibuf : msg_bytes;
1069 read_loop(fd, inbuf.buf, inbuf.len);
1070 if (!(msg_bytes -= inbuf.len)
1071 && !ibuf[inbuf.len-1])
1072 inbuf.len--, add_null = 1;
1073 if (iconvbufs(ic_send, &inbuf, &outbuf,
1074 ICB_INCLUDE_BAD | ICB_INCLUDE_INCOMPLETE) < 0)
1079 if (outbuf.len == outbuf.size)
1081 outbuf.buf[outbuf.len++] = '\0';
1083 msg_bytes = outbuf.len;
1086 read_loop(fd, line, msg_bytes);
1087 /* A directory name was sent with the trailing null */
1088 if (msg_bytes > 0 && !line[msg_bytes-1])
1089 log_delete(line, S_IFDIR);
1091 line[msg_bytes] = '\0';
1092 log_delete(line, S_IFREG);
1096 if (msg_bytes != 4) {
1098 rprintf(FERROR, "invalid multi-message %d:%ld [%s]\n",
1099 tag, (long)msg_bytes, who_am_i());
1100 exit_cleanup(RERR_STREAMIO);
1102 read_loop(fd, line, msg_bytes);
1103 successful_send(IVAL(line, 0));
1108 read_loop(fd, line, msg_bytes);
1109 send_msg_int(MSG_NO_SEND, IVAL(line, 0));
1113 if (msg_bytes >= sizeof line) {
1116 "multiplexing overflow %d:%ld [%s]\n",
1117 tag, (long)msg_bytes, who_am_i());
1118 exit_cleanup(RERR_STREAMIO);
1120 read_loop(fd, line, msg_bytes);
1121 rwrite((enum logcode)tag, line, msg_bytes, 1);
1124 rprintf(FERROR, "unexpected tag %d [%s]\n",
1126 exit_cleanup(RERR_STREAMIO);
1130 if (iobuf_in_remaining == 0)
1131 io_flush(NORMAL_FLUSH);
1136 /* Do a buffered read from fd. Don't return until all N bytes have
1137 * been read. If all N can't be read then exit with an error. */
1138 static void readfd(int fd, char *buffer, size_t N)
1144 cnt = readfd_unbuffered(fd, buffer + total, N-total);
1148 if (fd == write_batch_monitor_in) {
1149 if ((size_t)write(batch_fd, buffer, total) != total)
1150 exit_cleanup(RERR_FILEIO);
1153 if (fd == flist_forward_from)
1154 writefd(iobuf_f_out, buffer, total);
1156 if (fd == sock_f_in)
1157 stats.total_read += total;
1160 unsigned short read_shortint(int f)
1164 return (UVAL(b, 1) << 8) + UVAL(b, 0);
1167 int32 read_int(int f)
1174 #if SIZEOF_INT32 > 4
1175 if (num & (int32)0x80000000)
1176 num |= ~(int32)0xffffffff;
1181 int32 read_varint(int f)
1191 readfd(f, (char*)&ch, 1);
1192 extra = int_byte_extra[ch / 4];
1194 uchar bit = ((uchar)1<<(8-extra));
1195 if (extra >= (int)sizeof u.b) {
1196 rprintf(FERROR, "Overflow in read_varint()\n");
1197 exit_cleanup(RERR_STREAMIO);
1199 readfd(f, u.b, extra);
1200 u.b[extra] = ch & (bit-1);
1203 #if CAREFUL_ALIGNMENT
1206 #if SIZEOF_INT32 > 4
1207 if (u.x & (int32)0x80000000)
1208 u.x |= ~(int32)0xffffffff;
1213 int64 read_varlong(int f, uchar min_bytes)
1222 #if SIZEOF_INT64 < 8
1227 readfd(f, b2, min_bytes);
1228 memcpy(u.b, b2+1, min_bytes-1);
1229 extra = int_byte_extra[CVAL(b2, 0) / 4];
1231 uchar bit = ((uchar)1<<(8-extra));
1232 if (min_bytes + extra > (int)sizeof u.b) {
1233 rprintf(FERROR, "Overflow in read_varlong()\n");
1234 exit_cleanup(RERR_STREAMIO);
1236 readfd(f, u.b + min_bytes - 1, extra);
1237 u.b[min_bytes + extra - 1] = CVAL(b2, 0) & (bit-1);
1238 #if SIZEOF_INT64 < 8
1239 if (min_bytes + extra > 5 || u.b[4] || CVAL(u.b,3) & 0x80) {
1240 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1241 exit_cleanup(RERR_UNSUPPORTED);
1245 u.b[min_bytes + extra - 1] = CVAL(b2, 0);
1246 #if SIZEOF_INT64 < 8
1248 #elif CAREFUL_ALIGNMENT
1249 u.x = IVAL(u.b,0) | (((int64)IVAL(u.b,4))<<32);
1254 int64 read_longint(int f)
1256 #if SIZEOF_INT64 >= 8
1259 int32 num = read_int(f);
1261 if (num != (int32)0xffffffff)
1264 #if SIZEOF_INT64 < 8
1265 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1266 exit_cleanup(RERR_UNSUPPORTED);
1269 return IVAL(b,0) | (((int64)IVAL(b,4))<<32);
1273 void read_buf(int f, char *buf, size_t len)
1278 void read_sbuf(int f, char *buf, size_t len)
1280 readfd(f, buf, len);
1284 uchar read_byte(int f)
1287 readfd(f, (char *)&c, 1);
1291 int read_vstring(int f, char *buf, int bufsize)
1293 int len = read_byte(f);
1296 len = (len & ~0x80) * 0x100 + read_byte(f);
1298 if (len >= bufsize) {
1299 rprintf(FERROR, "over-long vstring received (%d > %d)\n",
1305 readfd(f, buf, len);
1310 /* Populate a sum_struct with values from the socket. This is
1311 * called by both the sender and the receiver. */
1312 void read_sum_head(int f, struct sum_struct *sum)
1314 sum->count = read_int(f);
1315 if (sum->count < 0) {
1316 rprintf(FERROR, "Invalid checksum count %ld [%s]\n",
1317 (long)sum->count, who_am_i());
1318 exit_cleanup(RERR_PROTOCOL);
1320 sum->blength = read_int(f);
1321 if (sum->blength < 0 || sum->blength > MAX_BLOCK_SIZE) {
1322 rprintf(FERROR, "Invalid block length %ld [%s]\n",
1323 (long)sum->blength, who_am_i());
1324 exit_cleanup(RERR_PROTOCOL);
1326 sum->s2length = protocol_version < 27 ? csum_length : (int)read_int(f);
1327 if (sum->s2length < 0 || sum->s2length > MAX_DIGEST_LEN) {
1328 rprintf(FERROR, "Invalid checksum length %d [%s]\n",
1329 sum->s2length, who_am_i());
1330 exit_cleanup(RERR_PROTOCOL);
1332 sum->remainder = read_int(f);
1333 if (sum->remainder < 0 || sum->remainder > sum->blength) {
1334 rprintf(FERROR, "Invalid remainder length %ld [%s]\n",
1335 (long)sum->remainder, who_am_i());
1336 exit_cleanup(RERR_PROTOCOL);
1340 /* Send the values from a sum_struct over the socket. Set sum to
1341 * NULL if there are no checksums to send. This is called by both
1342 * the generator and the sender. */
1343 void write_sum_head(int f, struct sum_struct *sum)
1345 static struct sum_struct null_sum;
1350 write_int(f, sum->count);
1351 write_int(f, sum->blength);
1352 if (protocol_version >= 27)
1353 write_int(f, sum->s2length);
1354 write_int(f, sum->remainder);
1358 * Sleep after writing to limit I/O bandwidth usage.
1360 * @todo Rather than sleeping after each write, it might be better to
1361 * use some kind of averaging. The current algorithm seems to always
1362 * use a bit less bandwidth than specified, because it doesn't make up
1363 * for slow periods. But arguably this is a feature. In addition, we
1364 * ought to take the time used to write the data into account.
1366 * During some phases of big transfers (file FOO is uptodate) this is
1367 * called with a small bytes_written every time. As the kernel has to
1368 * round small waits up to guarantee that we actually wait at least the
1369 * requested number of microseconds, this can become grossly inaccurate.
1370 * We therefore keep track of the bytes we've written over time and only
1371 * sleep when the accumulated delay is at least 1 tenth of a second.
1373 static void sleep_for_bwlimit(int bytes_written)
1375 static struct timeval prior_tv;
1376 static long total_written = 0;
1377 struct timeval tv, start_tv;
1378 long elapsed_usec, sleep_usec;
1380 #define ONE_SEC 1000000L /* # of microseconds in a second */
1382 if (!bwlimit_writemax)
1385 total_written += bytes_written;
1387 gettimeofday(&start_tv, NULL);
1388 if (prior_tv.tv_sec) {
1389 elapsed_usec = (start_tv.tv_sec - prior_tv.tv_sec) * ONE_SEC
1390 + (start_tv.tv_usec - prior_tv.tv_usec);
1391 total_written -= elapsed_usec * bwlimit / (ONE_SEC/1024);
1392 if (total_written < 0)
1396 sleep_usec = total_written * (ONE_SEC/1024) / bwlimit;
1397 if (sleep_usec < ONE_SEC / 10) {
1398 prior_tv = start_tv;
1402 tv.tv_sec = sleep_usec / ONE_SEC;
1403 tv.tv_usec = sleep_usec % ONE_SEC;
1404 select(0, NULL, NULL, NULL, &tv);
1406 gettimeofday(&prior_tv, NULL);
1407 elapsed_usec = (prior_tv.tv_sec - start_tv.tv_sec) * ONE_SEC
1408 + (prior_tv.tv_usec - start_tv.tv_usec);
1409 total_written = (sleep_usec - elapsed_usec) * bwlimit / (ONE_SEC/1024);
1412 /* Write len bytes to the file descriptor fd, looping as necessary to get
1413 * the job done and also (in certain circumstances) reading any data on
1414 * msg_fd_in to avoid deadlock.
1416 * This function underlies the multiplexing system. The body of the
1417 * application never calls this function directly. */
1418 static void writefd_unbuffered(int fd, const char *buf, size_t len)
1420 size_t n, total = 0;
1421 fd_set w_fds, r_fds, e_fds;
1422 int maxfd, count, cnt, using_r_fds;
1427 defer_forwarding_messages++, defer_inc++;
1429 while (total < len) {
1436 if (msg_fd_in >= 0) {
1438 FD_SET(msg_fd_in, &r_fds);
1439 if (msg_fd_in > maxfd)
1445 tv.tv_sec = select_timeout;
1449 count = select(maxfd + 1, using_r_fds ? &r_fds : NULL,
1450 &w_fds, &e_fds, &tv);
1453 if (count < 0 && errno == EBADF)
1454 exit_cleanup(RERR_SOCKETIO);
1459 /*if (FD_ISSET(fd, &e_fds))
1460 rprintf(FINFO, "select exception on fd %d\n", fd); */
1462 if (using_r_fds && FD_ISSET(msg_fd_in, &r_fds))
1465 if (!FD_ISSET(fd, &w_fds))
1469 if (bwlimit_writemax && n > bwlimit_writemax)
1470 n = bwlimit_writemax;
1471 cnt = write(fd, buf + total, n);
1477 if (errno == EWOULDBLOCK || errno == EAGAIN) {
1483 /* Don't try to write errors back across the stream. */
1484 if (fd == sock_f_out)
1485 io_end_multiplex_out();
1486 /* Don't try to write errors down a failing msg pipe. */
1487 if (am_server && fd == msg_fd_out)
1488 exit_cleanup(RERR_STREAMIO);
1489 rsyserr(FERROR, errno,
1490 "writefd_unbuffered failed to write %ld bytes [%s]",
1491 (long)len, who_am_i());
1492 /* If the other side is sending us error messages, try
1493 * to grab any messages they sent before they died. */
1494 while (!am_server && fd == sock_f_out && io_multiplexing_in) {
1498 readfd_unbuffered(sock_f_in, buf, sizeof buf);
1500 exit_cleanup(RERR_STREAMIO);
1504 defer_forwarding_messages++, defer_inc++;
1506 if (fd == sock_f_out) {
1507 if (io_timeout || am_generator)
1508 last_io_out = time(NULL);
1509 sleep_for_bwlimit(cnt);
1514 if (!(defer_forwarding_messages -= defer_inc))
1518 void io_flush(int flush_it_all)
1520 if (!iobuf_out_cnt || no_flush)
1523 if (io_multiplexing_out)
1524 mplex_write(sock_f_out, MSG_DATA, iobuf_out, iobuf_out_cnt, 0);
1526 writefd_unbuffered(iobuf_f_out, iobuf_out, iobuf_out_cnt);
1529 if (flush_it_all && !defer_forwarding_messages)
1533 static void writefd(int fd, const char *buf, size_t len)
1535 if (fd == sock_f_out)
1536 stats.total_written += len;
1538 if (fd == write_batch_monitor_out) {
1539 if ((size_t)write(batch_fd, buf, len) != len)
1540 exit_cleanup(RERR_FILEIO);
1543 if (!iobuf_out || fd != iobuf_f_out) {
1544 writefd_unbuffered(fd, buf, len);
1549 int n = MIN((int)len, IO_BUFFER_SIZE - iobuf_out_cnt);
1551 memcpy(iobuf_out+iobuf_out_cnt, buf, n);
1557 if (iobuf_out_cnt == IO_BUFFER_SIZE)
1558 io_flush(NORMAL_FLUSH);
1562 void write_shortint(int f, unsigned short x)
1566 b[1] = (char)(x >> 8);
1570 void write_int(int f, int32 x)
1577 void write_varint(int f, int32 x)
1585 while (cnt > 1 && b[cnt] == 0)
1587 bit = ((uchar)1<<(7-cnt+1));
1588 if (CVAL(b, cnt) >= bit) {
1592 *b = b[cnt] | ~(bit*2-1);
1599 void write_varlong(int f, int64 x, uchar min_bytes)
1606 #if SIZEOF_INT64 >= 8
1607 SIVAL(b, 5, x >> 32);
1609 if (x <= 0x7FFFFFFF && x >= 0)
1610 memset(b + 5, 0, 4);
1612 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1613 exit_cleanup(RERR_UNSUPPORTED);
1617 while (cnt > min_bytes && b[cnt] == 0)
1619 bit = ((uchar)1<<(7-cnt+min_bytes));
1620 if (CVAL(b, cnt) >= bit) {
1623 } else if (cnt > min_bytes)
1624 *b = b[cnt] | ~(bit*2-1);
1632 * Note: int64 may actually be a 32-bit type if ./configure couldn't find any
1633 * 64-bit types on this platform.
1635 void write_longint(int f, int64 x)
1637 char b[12], * const s = b+4;
1640 if (x <= 0x7FFFFFFF && x >= 0) {
1645 #if SIZEOF_INT64 < 8
1646 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1647 exit_cleanup(RERR_UNSUPPORTED);
1650 SIVAL(s, 4, x >> 32);
1655 void write_buf(int f, const char *buf, size_t len)
1660 /** Write a string to the connection */
1661 void write_sbuf(int f, const char *buf)
1663 writefd(f, buf, strlen(buf));
1666 void write_byte(int f, uchar c)
1668 writefd(f, (char *)&c, 1);
1671 void write_vstring(int f, const char *str, int len)
1673 uchar lenbuf[3], *lb = lenbuf;
1678 "attempting to send over-long vstring (%d > %d)\n",
1680 exit_cleanup(RERR_PROTOCOL);
1682 *lb++ = len / 0x100 + 0x80;
1686 writefd(f, (char*)lenbuf, lb - lenbuf + 1);
1688 writefd(f, str, len);
1691 /* Send a file-list index using a byte-reduction method. */
1692 void write_ndx(int f, int32 ndx)
1694 static int32 prev_positive = -1, prev_negative = 1;
1695 int32 diff, cnt = 0;
1698 if (protocol_version < 30 || read_batch) {
1703 /* Send NDX_DONE as a single-byte 0 with no side effects. Send
1704 * negative nums as a positive after sending a leading 0xFF. */
1706 diff = ndx - prev_positive;
1707 prev_positive = ndx;
1708 } else if (ndx == NDX_DONE) {
1713 b[cnt++] = (char)0xFF;
1715 diff = ndx - prev_negative;
1716 prev_negative = ndx;
1719 /* A diff of 1 - 253 is sent as a one-byte diff; a diff of 254 - 32767
1720 * or 0 is sent as a 0xFE + a two-byte diff; otherwise we send 0xFE
1721 * & all 4 bytes of the (non-negative) num with the high-bit set. */
1722 if (diff < 0xFE && diff > 0)
1723 b[cnt++] = (char)diff;
1724 else if (diff < 0 || diff > 0x7FFF) {
1725 b[cnt++] = (char)0xFE;
1726 b[cnt++] = (char)((ndx >> 24) | 0x80);
1727 b[cnt++] = (char)ndx;
1728 b[cnt++] = (char)(ndx >> 8);
1729 b[cnt++] = (char)(ndx >> 16);
1731 b[cnt++] = (char)0xFE;
1732 b[cnt++] = (char)(diff >> 8);
1733 b[cnt++] = (char)diff;
1738 /* Receive a file-list index using a byte-reduction method. */
1739 int32 read_ndx(int f)
1741 static int32 prev_positive = -1, prev_negative = 1;
1742 int32 *prev_ptr, num;
1745 if (protocol_version < 30)
1749 if (CVAL(b, 0) == 0xFF) {
1751 prev_ptr = &prev_negative;
1752 } else if (CVAL(b, 0) == 0)
1755 prev_ptr = &prev_positive;
1756 if (CVAL(b, 0) == 0xFE) {
1758 if (CVAL(b, 0) & 0x80) {
1759 b[3] = CVAL(b, 0) & ~0x80;
1764 num = (UVAL(b,0)<<8) + UVAL(b,1) + *prev_ptr;
1766 num = UVAL(b, 0) + *prev_ptr;
1768 if (prev_ptr == &prev_negative)
1773 /* Read a line of up to bufsiz-1 characters into buf. Strips
1774 * the (required) trailing newline and all carriage returns.
1775 * Returns 1 for success; 0 for I/O error or truncation. */
1776 int read_line_old(int f, char *buf, size_t bufsiz)
1778 bufsiz--; /* leave room for the null */
1779 while (bufsiz > 0) {
1781 read_buf(f, buf, 1);
1786 if (buf[0] != '\r') {
1795 void io_printf(int fd, const char *format, ...)
1798 char buf[BIGPATHBUFLEN];
1801 va_start(ap, format);
1802 len = vsnprintf(buf, sizeof buf, format, ap);
1806 exit_cleanup(RERR_STREAMIO);
1808 if (len > (int)sizeof buf) {
1809 rprintf(FERROR, "io_printf() was too long for the buffer.\n");
1810 exit_cleanup(RERR_STREAMIO);
1813 write_sbuf(fd, buf);
1816 /** Setup for multiplexing a MSG_* stream with the data stream. */
1817 void io_start_multiplex_out(void)
1819 io_flush(NORMAL_FLUSH);
1820 io_start_buffering_out(sock_f_out);
1821 io_multiplexing_out = 1;
1824 /** Setup for multiplexing a MSG_* stream with the data stream. */
1825 void io_start_multiplex_in(void)
1827 io_flush(NORMAL_FLUSH);
1828 io_start_buffering_in(sock_f_in);
1829 io_multiplexing_in = 1;
1832 /** Write an message to the multiplexed data stream. */
1833 int io_multiplex_write(enum msgcode code, const char *buf, size_t len, int convert)
1835 if (!io_multiplexing_out)
1837 io_flush(NORMAL_FLUSH);
1838 stats.total_written += (len+4);
1839 mplex_write(sock_f_out, code, buf, len, convert);
1843 void io_end_multiplex_in(void)
1845 io_multiplexing_in = 0;
1846 io_end_buffering_in();
1849 /** Stop output multiplexing. */
1850 void io_end_multiplex_out(void)
1852 io_multiplexing_out = 0;
1853 io_end_buffering_out();
1856 void start_write_batch(int fd)
1858 /* Some communication has already taken place, but we don't
1859 * enable batch writing until here so that we can write a
1860 * canonical record of the communication even though the
1861 * actual communication so far depends on whether a daemon
1863 write_int(batch_fd, protocol_version);
1864 write_int(batch_fd, checksum_seed);
1867 write_batch_monitor_out = fd;
1869 write_batch_monitor_in = fd;
1872 void stop_write_batch(void)
1874 write_batch_monitor_out = -1;
1875 write_batch_monitor_in = -1;