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(). */
32 /** If no timeout is specified then use a 60 second select timeout */
33 #define SELECT_TIMEOUT 60
36 extern size_t bwlimit_writemax;
37 extern int io_timeout;
38 extern int allowed_lull;
42 extern int am_generator;
43 extern int inc_recurse;
47 extern int read_batch;
48 extern int csum_length;
49 extern int checksum_seed;
50 extern int protocol_version;
51 extern int remove_source_files;
52 extern int preserve_hard_links;
53 extern struct stats stats;
54 extern struct file_list *cur_flist, *first_flist;
56 extern iconv_t ic_send, ic_recv;
59 const char phase_unknown[] = "unknown";
60 int ignore_timeout = 0;
64 /* Ignore an EOF error if non-zero. See whine_about_eof(). */
65 int kluge_around_eof = 0;
72 static int iobuf_f_in = -1;
73 static char *iobuf_in;
74 static size_t iobuf_in_siz;
75 static size_t iobuf_in_ndx;
76 static size_t iobuf_in_remaining;
78 static int iobuf_f_out = -1;
79 static char *iobuf_out;
80 static int iobuf_out_cnt;
82 int flist_forward_from = -1;
84 static int io_multiplexing_out;
85 static int io_multiplexing_in;
86 static time_t last_io_in;
87 static time_t last_io_out;
90 static int write_batch_monitor_in = -1;
91 static int write_batch_monitor_out = -1;
93 static int io_filesfrom_f_in = -1;
94 static int io_filesfrom_f_out = -1;
95 static char io_filesfrom_buf[2048];
97 static char iconv_buf[sizeof io_filesfrom_buf / 2];
99 static char *io_filesfrom_bp;
100 static char io_filesfrom_lastchar;
101 static int io_filesfrom_buflen;
102 static int defer_forwarding_messages = 0;
103 static int select_timeout = SELECT_TIMEOUT;
104 static int active_filecnt = 0;
105 static OFF_T active_bytecnt = 0;
107 static char int_byte_extra[64] = {
108 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* (00 - 3F)/4 */
109 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* (40 - 7F)/4 */
110 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /* (80 - BF)/4 */
111 2, 2, 2, 2, 2, 2, 2, 2, 3, 3, 3, 3, 4, 4, 5, 6, /* (C0 - FF)/4 */
114 enum festatus { FES_SUCCESS, FES_REDO, FES_NO_SEND };
116 static void readfd(int fd, char *buffer, size_t N);
117 static void writefd(int fd, const char *buf, size_t len);
118 static void writefd_unbuffered(int fd, const char *buf, size_t len);
119 static void mplex_write(int fd, enum msgcode code, const char *buf, size_t len, int convert);
121 struct flist_ndx_item {
122 struct flist_ndx_item *next;
126 struct flist_ndx_list {
127 struct flist_ndx_item *head, *tail;
130 static struct flist_ndx_list redo_list, hlink_list;
132 struct msg_list_item {
133 struct msg_list_item *next;
139 struct msg_list_item *head, *tail;
142 static struct msg_list msg_queue;
144 static void flist_ndx_push(struct flist_ndx_list *lp, int ndx)
146 struct flist_ndx_item *item;
148 if (!(item = new(struct flist_ndx_item)))
149 out_of_memory("flist_ndx_push");
153 lp->tail->next = item;
159 static int flist_ndx_pop(struct flist_ndx_list *lp)
161 struct flist_ndx_item *next;
168 next = lp->head->next;
177 static void got_flist_entry_status(enum festatus status, const char *buf)
179 int ndx = IVAL(buf, 0);
180 struct file_list *flist = flist_for_ndx(ndx);
182 assert(flist != NULL);
183 assert(ndx >= flist->ndx_start);
185 if (remove_source_files) {
187 active_bytecnt -= F_LENGTH(flist->files[ndx - flist->ndx_start]);
191 flist->in_progress--;
195 if (remove_source_files)
196 send_msg(MSG_SUCCESS, buf, 4, 0);
197 if (preserve_hard_links) {
198 struct file_struct *file = flist->files[ndx - flist->ndx_start];
199 if (F_IS_HLINKED(file))
200 flist_ndx_push(&hlink_list, ndx);
206 flist_ndx_push(&redo_list, ndx);
213 static void check_timeout(void)
217 if (!io_timeout || ignore_timeout)
221 last_io_in = time(NULL);
227 if (t - last_io_in >= io_timeout) {
228 if (!am_server && !am_daemon) {
229 rprintf(FERROR, "io timeout after %d seconds -- exiting\n",
230 (int)(t-last_io_in));
232 exit_cleanup(RERR_TIMEOUT);
236 /* Note the fds used for the main socket (which might really be a pipe
237 * for a local transfer, but we can ignore that). */
238 void io_set_sock_fds(int f_in, int f_out)
244 void set_io_timeout(int secs)
248 if (!io_timeout || io_timeout > SELECT_TIMEOUT)
249 select_timeout = SELECT_TIMEOUT;
251 select_timeout = io_timeout;
253 allowed_lull = read_batch ? 0 : (io_timeout + 1) / 2;
256 /* Setup the fd used to receive MSG_* messages. Only needed during the
257 * early stages of being a local sender (up through the sending of the
258 * file list) or when we're the generator (to fetch the messages from
260 void set_msg_fd_in(int fd)
265 /* Setup the fd used to send our MSG_* messages. Only needed when
266 * we're the receiver (to send our messages to the generator). */
267 void set_msg_fd_out(int fd)
270 set_nonblocking(msg_fd_out);
273 /* Add a message to the pending MSG_* list. */
274 static void msg_list_add(struct msg_list *lst, int code, const char *buf, int len, int convert)
276 struct msg_list_item *m;
277 int sz = len + 4 + sizeof m[0] - 1;
279 if (!(m = (struct msg_list_item *)new_array(char, sz)))
280 out_of_memory("msg_list_add");
282 m->convert = convert;
283 SIVAL(m->buf, 0, ((code+MPLEX_BASE)<<24) | len);
284 memcpy(m->buf + 4, buf, len);
292 static void msg_flush(void)
295 while (msg_queue.head && io_multiplexing_out) {
296 struct msg_list_item *m = msg_queue.head;
297 int len = IVAL(m->buf, 0) & 0xFFFFFF;
298 int tag = *((uchar*)m->buf+3) - MPLEX_BASE;
299 if (!(msg_queue.head = m->next))
300 msg_queue.tail = NULL;
301 stats.total_written += len + 4;
302 defer_forwarding_messages++;
303 mplex_write(sock_f_out, tag, m->buf + 4, len, m->convert);
304 defer_forwarding_messages--;
308 while (msg_queue.head) {
309 struct msg_list_item *m = msg_queue.head;
310 int len = IVAL(m->buf, 0) & 0xFFFFFF;
311 int tag = *((uchar*)m->buf+3) - MPLEX_BASE;
312 if (!(msg_queue.head = m->next))
313 msg_queue.tail = NULL;
314 defer_forwarding_messages++;
315 mplex_write(msg_fd_out, tag, m->buf + 4, len, m->convert);
316 defer_forwarding_messages--;
322 /* Read a message from the MSG_* fd and handle it. This is called either
323 * during the early stages of being a local sender (up through the sending
324 * of the file list) or when we're the generator (to fetch the messages
325 * from the receiver). */
326 static void read_msg_fd(void)
330 struct file_list *flist;
334 /* Temporarily disable msg_fd_in. This is needed to avoid looping back
335 * to this routine from writefd_unbuffered(). */
338 defer_forwarding_messages++;
343 len = tag & 0xFFFFFF;
344 tag = (tag >> 24) - MPLEX_BASE;
348 if (len < 0 || len > 1 || !am_generator) {
350 rprintf(FERROR, "invalid message %d:%d [%s%s]\n",
351 tag, len, who_am_i(),
352 inc_recurse ? "/inc" : "");
353 exit_cleanup(RERR_STREAMIO);
356 readfd(fd, buf, len);
357 stats.total_read = read_varlong(fd, 3);
362 if (len != 4 || !am_generator)
365 got_flist_entry_status(FES_REDO, buf);
368 if (len != 4 || !am_generator || !inc_recurse)
371 /* Read extra file list from receiver. */
372 assert(iobuf_in != NULL);
373 assert(iobuf_f_in == fd);
375 rprintf(FINFO, "[%s] receiving flist for dir %d\n",
376 who_am_i(), IVAL(buf,0));
378 flist = recv_file_list(fd);
379 flist->parent_ndx = IVAL(buf,0);
382 if (len != 0 || !am_generator || !inc_recurse)
387 if (len >= (int)sizeof buf || !am_generator)
389 readfd(fd, buf, len);
390 send_msg(MSG_DELETED, buf, len, 1);
393 if (len != 4 || !am_generator)
396 got_flist_entry_status(FES_SUCCESS, buf);
399 if (len != 4 || !am_generator)
402 got_flist_entry_status(FES_NO_SEND, buf);
408 if (tag == MSG_SOCKERR)
409 io_end_multiplex_out();
419 rwrite((enum logcode)tag, buf, n, !am_generator);
424 rprintf(FERROR, "unknown message %d:%d [%s]\n",
425 tag, len, who_am_i());
426 exit_cleanup(RERR_STREAMIO);
431 if (!--defer_forwarding_messages)
435 /* This is used by the generator to limit how many file transfers can
436 * be active at once when --remove-source-files is specified. Without
437 * this, sender-side deletions were mostly happening at the end. */
438 void increment_active_files(int ndx, int itemizing, enum logcode code)
440 /* TODO: tune these limits? */
441 while (active_filecnt >= (active_bytecnt >= 128*1024 ? 10 : 50)) {
442 check_for_finished_files(itemizing, code, 0);
444 io_flush(NORMAL_FLUSH);
450 active_bytecnt += F_LENGTH(cur_flist->files[ndx - cur_flist->ndx_start]);
453 /* Write an message to a multiplexed stream. If this fails, rsync exits. */
454 static void mplex_write(int fd, enum msgcode code, const char *buf, size_t len, int convert)
456 char buffer[BIGPATHBUFLEN]; /* Oversized for use by iconv code. */
459 SIVAL(buffer, 0, ((MPLEX_BASE + (int)code)<<24) + len);
462 if (convert && ic_send == (iconv_t)-1)
466 if (convert || n > 1024 - 4) /* BIGPATHBUFLEN can handle 1024 bytes */
469 memcpy(buffer + 4, buf, n);
471 writefd_unbuffered(fd, buffer, n+4);
478 iconv(ic_send, NULL, 0, NULL, 0);
479 defer_forwarding_messages++;
481 ICONV_CONST char *ibuf = (ICONV_CONST char *)buf;
483 size_t ocnt = sizeof buffer;
484 while (len && iconv(ic_send, &ibuf,&len,
485 &obuf,&ocnt) == (size_t)-1) {
486 if (errno == E2BIG || !ocnt)
492 writefd_unbuffered(fd, buffer, n);
494 if (!--defer_forwarding_messages)
499 defer_forwarding_messages++;
500 writefd_unbuffered(fd, buf, len);
501 if (!--defer_forwarding_messages)
506 int send_msg(enum msgcode code, const char *buf, int len, int convert)
508 if (msg_fd_out < 0) {
509 if (!defer_forwarding_messages)
510 return io_multiplex_write(code, buf, len, convert);
511 if (!io_multiplexing_out)
513 msg_list_add(&msg_queue, code, buf, len, convert);
516 if (flist_forward_from >= 0)
517 msg_list_add(&msg_queue, code, buf, len, convert);
519 mplex_write(msg_fd_out, code, buf, len, convert);
523 void send_msg_int(enum msgcode code, int num)
526 SIVAL(numbuf, 0, num);
527 send_msg(code, numbuf, 4, 0);
530 void wait_for_receiver(void)
533 io_flush(NORMAL_FLUSH);
538 int get_redo_num(void)
540 return flist_ndx_pop(&redo_list);
543 int get_hlink_num(void)
545 return flist_ndx_pop(&hlink_list);
549 * When we're the receiver and we have a local --files-from list of names
550 * that needs to be sent over the socket to the sender, we have to do two
551 * things at the same time: send the sender a list of what files we're
552 * processing and read the incoming file+info list from the sender. We do
553 * this by augmenting the read_timeout() function to copy this data. It
554 * uses the io_filesfrom_buf to read a block of data from f_in (when it is
555 * ready, since it might be a pipe) and then blast it out f_out (when it
556 * is ready to receive more data).
558 void io_set_filesfrom_fds(int f_in, int f_out)
560 io_filesfrom_f_in = f_in;
561 io_filesfrom_f_out = f_out;
562 io_filesfrom_bp = io_filesfrom_buf;
563 io_filesfrom_lastchar = '\0';
564 io_filesfrom_buflen = 0;
567 /* It's almost always an error to get an EOF when we're trying to read from the
568 * network, because the protocol is (for the most part) self-terminating.
570 * There is one case for the receiver when it is at the end of the transfer
571 * (hanging around reading any keep-alive packets that might come its way): if
572 * the sender dies before the generator's kill-signal comes through, we can end
573 * up here needing to loop until the kill-signal arrives. In this situation,
574 * kluge_around_eof will be < 0.
576 * There is another case for older protocol versions (< 24) where the module
577 * listing was not terminated, so we must ignore an EOF error in that case and
578 * exit. In this situation, kluge_around_eof will be > 0. */
579 static void whine_about_eof(int fd)
581 if (kluge_around_eof && fd == sock_f_in) {
583 if (kluge_around_eof > 0)
585 /* If we're still here after 10 seconds, exit with an error. */
586 for (i = 10*1000/20; i--; )
590 rprintf(FERROR, RSYNC_NAME ": connection unexpectedly closed "
591 "(%.0f bytes received so far) [%s]\n",
592 (double)stats.total_read, who_am_i());
594 exit_cleanup(RERR_STREAMIO);
598 * Read from a socket with I/O timeout. return the number of bytes
599 * read. If no bytes can be read then exit, never return a number <= 0.
601 * TODO: If the remote shell connection fails, then current versions
602 * actually report an "unexpected EOF" error here. Since it's a
603 * fairly common mistake to try to use rsh when ssh is required, we
604 * should trap that: if we fail to read any data at all, we should
605 * give a better explanation. We can tell whether the connection has
606 * started by looking e.g. at whether the remote version is known yet.
608 static int read_timeout(int fd, char *buf, size_t len)
612 io_flush(FULL_FLUSH);
615 /* until we manage to read *something* */
624 if (io_filesfrom_f_out >= 0) {
626 if (io_filesfrom_buflen == 0) {
627 if (io_filesfrom_f_in >= 0) {
628 FD_SET(io_filesfrom_f_in, &r_fds);
629 new_fd = io_filesfrom_f_in;
631 io_filesfrom_f_out = -1;
635 FD_SET(io_filesfrom_f_out, &w_fds);
636 new_fd = io_filesfrom_f_out;
642 tv.tv_sec = select_timeout;
647 count = select(maxfd + 1, &r_fds, &w_fds, NULL, &tv);
650 if (errno == EBADF) {
651 defer_forwarding_messages = 0;
652 exit_cleanup(RERR_SOCKETIO);
658 if (io_filesfrom_f_out >= 0) {
659 if (io_filesfrom_buflen) {
660 if (FD_ISSET(io_filesfrom_f_out, &w_fds)) {
661 int l = write(io_filesfrom_f_out,
663 io_filesfrom_buflen);
665 if (!(io_filesfrom_buflen -= l))
666 io_filesfrom_bp = io_filesfrom_buf;
668 io_filesfrom_bp += l;
669 } else if (errno != EINTR) {
670 /* XXX should we complain? */
671 io_filesfrom_f_out = -1;
674 } else if (io_filesfrom_f_in >= 0) {
675 if (FD_ISSET(io_filesfrom_f_in, &r_fds)) {
676 int l = read(io_filesfrom_f_in,
678 sizeof io_filesfrom_buf);
680 if (l == 0 || errno != EINTR) {
681 /* Send end-of-file marker */
682 io_filesfrom_buf[0] = '\0';
683 io_filesfrom_buf[1] = '\0';
684 io_filesfrom_buflen = io_filesfrom_lastchar? 2 : 1;
685 io_filesfrom_f_in = -1;
689 char *s = io_filesfrom_buf + l;
690 /* Transform CR and/or LF into '\0' */
691 while (s-- > io_filesfrom_buf) {
692 if (*s == '\n' || *s == '\r')
696 if (!io_filesfrom_lastchar) {
697 /* Last buf ended with a '\0', so don't
698 * let this buf start with one. */
699 while (l && !*io_filesfrom_bp)
700 io_filesfrom_bp++, l--;
703 io_filesfrom_bp = io_filesfrom_buf;
705 char *f = io_filesfrom_bp;
708 /* Eliminate any multi-'\0' runs. */
710 if (!(*t++ = *f++)) {
711 while (f != eob && !*f)
715 io_filesfrom_lastchar = f[-1];
717 io_filesfrom_buflen = l;
723 if (!FD_ISSET(fd, &r_fds))
726 n = read(fd, buf, len);
730 whine_about_eof(fd); /* Doesn't return. */
731 if (errno == EINTR || errno == EWOULDBLOCK
735 /* Don't write errors on a dead socket. */
736 if (fd == sock_f_in) {
737 io_end_multiplex_out();
738 rsyserr(FSOCKERR, errno, "read error");
740 rsyserr(FERROR, errno, "read error");
741 exit_cleanup(RERR_STREAMIO);
748 if (fd == sock_f_in && io_timeout)
749 last_io_in = time(NULL);
755 /* Read a line into the "buf" buffer. */
756 int read_line(int fd, char *buf, size_t bufsiz, int dump_comments, int rl_nulls)
758 char ch, *s, *eob = buf + bufsiz - 1;
764 cnt = read(fd, &ch, 1);
765 if (cnt < 0 && (errno == EWOULDBLOCK
766 || errno == EINTR || errno == EAGAIN)) {
773 tv.tv_sec = select_timeout;
775 if (!select(fd+1, &r_fds, NULL, &e_fds, &tv))
777 /*if (FD_ISSET(fd, &e_fds))
778 rprintf(FINFO, "select exception on fd %d\n", fd); */
783 if (rl_nulls ? ch == '\0' : (ch == '\r' || ch == '\n')) {
784 /* Skip empty lines if dumping comments. */
785 if (dump_comments && s == buf)
794 if (dump_comments && (*buf == '#' || *buf == ';'))
800 int read_args(int f_in, char *mod_name, char *buf, size_t bufsiz, int rl_nulls,
801 char ***argv_p, int *argc_p, char **request_p)
803 int maxargs = MAX_ARGS;
808 if (!(argv = new_array(char *, maxargs)))
809 out_of_memory("read_args");
811 argv[argc++] = "rsyncd";
814 if (read_line(f_in, buf, bufsiz, 0, rl_nulls) == 0)
817 if (argc == maxargs) {
819 if (!(argv = realloc_array(argv, char *, maxargs)))
820 out_of_memory("read_args");
825 *request_p = strdup(buf);
829 glob_expand_module(mod_name, buf, &argv, &argc, &maxargs);
831 glob_expand(buf, &argv, &argc, &maxargs);
833 if (!(p = strdup(buf)))
834 out_of_memory("read_args");
836 if (*p == '.' && p[1] == '\0')
844 return dot_pos ? dot_pos : argc;
847 int io_start_buffering_out(int f_out)
850 assert(f_out == iobuf_f_out);
853 if (!(iobuf_out = new_array(char, IO_BUFFER_SIZE)))
854 out_of_memory("io_start_buffering_out");
860 int io_start_buffering_in(int f_in)
863 assert(f_in == iobuf_f_in);
866 iobuf_in_siz = 2 * IO_BUFFER_SIZE;
867 if (!(iobuf_in = new_array(char, iobuf_in_siz)))
868 out_of_memory("io_start_buffering_in");
873 void io_end_buffering_in(void)
880 iobuf_in_remaining = 0;
884 void io_end_buffering_out(void)
888 io_flush(FULL_FLUSH);
894 void maybe_flush_socket(int important)
896 if (iobuf_out && iobuf_out_cnt
897 && (important || time(NULL) - last_io_out >= 5))
898 io_flush(NORMAL_FLUSH);
901 void maybe_send_keepalive(void)
903 if (time(NULL) - last_io_out >= allowed_lull) {
904 if (!iobuf_out || !iobuf_out_cnt) {
905 if (protocol_version < 29)
906 return; /* there's nothing we can do */
907 if (protocol_version >= 30)
908 send_msg(MSG_NOOP, "", 0, 0);
910 write_int(sock_f_out, cur_flist->used);
911 write_shortint(sock_f_out, ITEM_IS_NEW);
915 io_flush(NORMAL_FLUSH);
919 void start_flist_forward(int f_in)
921 assert(iobuf_out != NULL);
922 assert(iobuf_f_out == msg_fd_out);
923 flist_forward_from = f_in;
926 void stop_flist_forward()
928 flist_forward_from = -1;
929 io_flush(FULL_FLUSH);
933 * Continue trying to read len bytes - don't return until len has been
936 static void read_loop(int fd, char *buf, size_t len)
939 int n = read_timeout(fd, buf, len);
947 * Read from the file descriptor handling multiplexing - return number
950 * Never returns <= 0.
952 static int readfd_unbuffered(int fd, char *buf, size_t len)
956 char line[BIGPATHBUFLEN];
958 if (!iobuf_in || fd != iobuf_f_in)
959 return read_timeout(fd, buf, len);
961 if (!io_multiplexing_in && iobuf_in_remaining == 0) {
962 iobuf_in_remaining = read_timeout(fd, iobuf_in, iobuf_in_siz);
967 if (iobuf_in_remaining) {
968 len = MIN(len, iobuf_in_remaining);
969 memcpy(buf, iobuf_in + iobuf_in_ndx, len);
971 iobuf_in_remaining -= len;
976 read_loop(fd, line, 4);
979 msg_bytes = tag & 0xFFFFFF;
980 tag = (tag >> 24) - MPLEX_BASE;
984 if (msg_bytes > iobuf_in_siz) {
985 if (!(iobuf_in = realloc_array(iobuf_in, char,
987 out_of_memory("readfd_unbuffered");
988 iobuf_in_siz = msg_bytes;
990 read_loop(fd, iobuf_in, msg_bytes);
991 iobuf_in_remaining = msg_bytes;
996 maybe_send_keepalive();
1001 read_loop(fd, line, msg_bytes);
1002 io_error |= IVAL(line, 0);
1005 if (msg_bytes >= sizeof line)
1008 if (ic_recv != (iconv_t)-1) {
1009 ICONV_CONST char *ibuf;
1011 size_t icnt, ocnt = sizeof line - 1;
1013 iconv(ic_send, NULL, 0, NULL, 0);
1015 icnt = msg_bytes > sizeof iconv_buf
1016 ? sizeof iconv_buf : msg_bytes;
1017 read_loop(fd, iconv_buf, icnt);
1018 if (!(msg_bytes -= icnt) && !iconv_buf[icnt-1])
1019 icnt--, add_null = 1;
1020 ibuf = (ICONV_CONST char *)iconv_buf;
1021 if (iconv(ic_send, &ibuf,&icnt,
1022 &obuf,&ocnt) == (size_t)-1)
1023 goto overflow; // XXX
1027 msg_bytes = obuf - line;
1030 read_loop(fd, line, msg_bytes);
1031 /* A directory name was sent with the trailing null */
1032 if (msg_bytes > 0 && !line[msg_bytes-1])
1033 log_delete(line, S_IFDIR);
1035 line[msg_bytes] = '\0';
1036 log_delete(line, S_IFREG);
1040 if (msg_bytes != 4) {
1042 rprintf(FERROR, "invalid multi-message %d:%ld [%s]\n",
1043 tag, (long)msg_bytes, who_am_i());
1044 exit_cleanup(RERR_STREAMIO);
1046 read_loop(fd, line, msg_bytes);
1047 successful_send(IVAL(line, 0));
1052 read_loop(fd, line, msg_bytes);
1053 send_msg_int(MSG_NO_SEND, IVAL(line, 0));
1057 if (msg_bytes >= sizeof line) {
1060 "multiplexing overflow %d:%ld [%s]\n",
1061 tag, (long)msg_bytes, who_am_i());
1062 exit_cleanup(RERR_STREAMIO);
1064 read_loop(fd, line, msg_bytes);
1065 rwrite((enum logcode)tag, line, msg_bytes, 1);
1068 rprintf(FERROR, "unexpected tag %d [%s]\n",
1070 exit_cleanup(RERR_STREAMIO);
1074 if (iobuf_in_remaining == 0)
1075 io_flush(NORMAL_FLUSH);
1080 /* Do a buffered read from fd. Don't return until all N bytes have
1081 * been read. If all N can't be read then exit with an error. */
1082 static void readfd(int fd, char *buffer, size_t N)
1088 cnt = readfd_unbuffered(fd, buffer + total, N-total);
1092 if (fd == write_batch_monitor_in) {
1093 if ((size_t)write(batch_fd, buffer, total) != total)
1094 exit_cleanup(RERR_FILEIO);
1097 if (fd == flist_forward_from)
1098 writefd(iobuf_f_out, buffer, total);
1100 if (fd == sock_f_in)
1101 stats.total_read += total;
1104 unsigned short read_shortint(int f)
1108 return (UVAL(b, 1) << 8) + UVAL(b, 0);
1111 int32 read_int(int f)
1118 #if SIZEOF_INT32 > 4
1119 if (num & (int32)0x80000000)
1120 num |= ~(int32)0xffffffff;
1125 int32 read_varint(int f)
1135 readfd(f, (char*)&ch, 1);
1136 extra = int_byte_extra[ch / 4];
1138 uchar bit = ((uchar)1<<(8-extra));
1139 if (extra >= (int)sizeof u.b) {
1140 rprintf(FERROR, "Overflow in read_varint()\n");
1141 exit_cleanup(RERR_STREAMIO);
1143 readfd(f, u.b, extra);
1144 u.b[extra] = ch & (bit-1);
1147 #if CAREFUL_ALIGNMENT
1150 #if SIZEOF_INT32 > 4
1151 if (u.x & (int32)0x80000000)
1152 u.x |= ~(int32)0xffffffff;
1157 int64 read_varlong(int f, uchar min_bytes)
1166 #if SIZEOF_INT64 < 8
1171 readfd(f, b2, min_bytes);
1172 memcpy(u.b, b2+1, min_bytes-1);
1173 extra = int_byte_extra[CVAL(b2, 0) / 4];
1175 uchar bit = ((uchar)1<<(8-extra));
1176 if (min_bytes + extra > (int)sizeof u.b) {
1177 rprintf(FERROR, "Overflow in read_varlong()\n");
1178 exit_cleanup(RERR_STREAMIO);
1180 readfd(f, u.b + min_bytes - 1, extra);
1181 u.b[min_bytes + extra - 1] = CVAL(b2, 0) & (bit-1);
1182 #if SIZEOF_INT64 < 8
1183 if (min_bytes + extra > 5 || u.b[4] || CVAL(u.b,3) & 0x80) {
1184 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1185 exit_cleanup(RERR_UNSUPPORTED);
1189 u.b[min_bytes + extra - 1] = CVAL(b2, 0);
1190 #if SIZEOF_INT64 < 8
1192 #elif CAREFUL_ALIGNMENT
1193 u.x = IVAL(u.b,0) | (((int64)IVAL(u.b,4))<<32);
1198 int64 read_longint(int f)
1200 #if SIZEOF_INT64 >= 8
1203 int32 num = read_int(f);
1205 if (num != (int32)0xffffffff)
1208 #if SIZEOF_INT64 < 8
1209 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1210 exit_cleanup(RERR_UNSUPPORTED);
1213 return IVAL(b,0) | (((int64)IVAL(b,4))<<32);
1217 void read_buf(int f, char *buf, size_t len)
1222 void read_sbuf(int f, char *buf, size_t len)
1224 readfd(f, buf, len);
1228 uchar read_byte(int f)
1231 readfd(f, (char *)&c, 1);
1235 int read_vstring(int f, char *buf, int bufsize)
1237 int len = read_byte(f);
1240 len = (len & ~0x80) * 0x100 + read_byte(f);
1242 if (len >= bufsize) {
1243 rprintf(FERROR, "over-long vstring received (%d > %d)\n",
1249 readfd(f, buf, len);
1254 /* Populate a sum_struct with values from the socket. This is
1255 * called by both the sender and the receiver. */
1256 void read_sum_head(int f, struct sum_struct *sum)
1258 sum->count = read_int(f);
1259 if (sum->count < 0) {
1260 rprintf(FERROR, "Invalid checksum count %ld [%s]\n",
1261 (long)sum->count, who_am_i());
1262 exit_cleanup(RERR_PROTOCOL);
1264 sum->blength = read_int(f);
1265 if (sum->blength < 0 || sum->blength > MAX_BLOCK_SIZE) {
1266 rprintf(FERROR, "Invalid block length %ld [%s]\n",
1267 (long)sum->blength, who_am_i());
1268 exit_cleanup(RERR_PROTOCOL);
1270 sum->s2length = protocol_version < 27 ? csum_length : (int)read_int(f);
1271 if (sum->s2length < 0 || sum->s2length > MAX_DIGEST_LEN) {
1272 rprintf(FERROR, "Invalid checksum length %d [%s]\n",
1273 sum->s2length, who_am_i());
1274 exit_cleanup(RERR_PROTOCOL);
1276 sum->remainder = read_int(f);
1277 if (sum->remainder < 0 || sum->remainder > sum->blength) {
1278 rprintf(FERROR, "Invalid remainder length %ld [%s]\n",
1279 (long)sum->remainder, who_am_i());
1280 exit_cleanup(RERR_PROTOCOL);
1284 /* Send the values from a sum_struct over the socket. Set sum to
1285 * NULL if there are no checksums to send. This is called by both
1286 * the generator and the sender. */
1287 void write_sum_head(int f, struct sum_struct *sum)
1289 static struct sum_struct null_sum;
1294 write_int(f, sum->count);
1295 write_int(f, sum->blength);
1296 if (protocol_version >= 27)
1297 write_int(f, sum->s2length);
1298 write_int(f, sum->remainder);
1302 * Sleep after writing to limit I/O bandwidth usage.
1304 * @todo Rather than sleeping after each write, it might be better to
1305 * use some kind of averaging. The current algorithm seems to always
1306 * use a bit less bandwidth than specified, because it doesn't make up
1307 * for slow periods. But arguably this is a feature. In addition, we
1308 * ought to take the time used to write the data into account.
1310 * During some phases of big transfers (file FOO is uptodate) this is
1311 * called with a small bytes_written every time. As the kernel has to
1312 * round small waits up to guarantee that we actually wait at least the
1313 * requested number of microseconds, this can become grossly inaccurate.
1314 * We therefore keep track of the bytes we've written over time and only
1315 * sleep when the accumulated delay is at least 1 tenth of a second.
1317 static void sleep_for_bwlimit(int bytes_written)
1319 static struct timeval prior_tv;
1320 static long total_written = 0;
1321 struct timeval tv, start_tv;
1322 long elapsed_usec, sleep_usec;
1324 #define ONE_SEC 1000000L /* # of microseconds in a second */
1326 if (!bwlimit_writemax)
1329 total_written += bytes_written;
1331 gettimeofday(&start_tv, NULL);
1332 if (prior_tv.tv_sec) {
1333 elapsed_usec = (start_tv.tv_sec - prior_tv.tv_sec) * ONE_SEC
1334 + (start_tv.tv_usec - prior_tv.tv_usec);
1335 total_written -= elapsed_usec * bwlimit / (ONE_SEC/1024);
1336 if (total_written < 0)
1340 sleep_usec = total_written * (ONE_SEC/1024) / bwlimit;
1341 if (sleep_usec < ONE_SEC / 10) {
1342 prior_tv = start_tv;
1346 tv.tv_sec = sleep_usec / ONE_SEC;
1347 tv.tv_usec = sleep_usec % ONE_SEC;
1348 select(0, NULL, NULL, NULL, &tv);
1350 gettimeofday(&prior_tv, NULL);
1351 elapsed_usec = (prior_tv.tv_sec - start_tv.tv_sec) * ONE_SEC
1352 + (prior_tv.tv_usec - start_tv.tv_usec);
1353 total_written = (sleep_usec - elapsed_usec) * bwlimit / (ONE_SEC/1024);
1356 /* Write len bytes to the file descriptor fd, looping as necessary to get
1357 * the job done and also (in certain circumstances) reading any data on
1358 * msg_fd_in to avoid deadlock.
1360 * This function underlies the multiplexing system. The body of the
1361 * application never calls this function directly. */
1362 static void writefd_unbuffered(int fd, const char *buf, size_t len)
1364 size_t n, total = 0;
1365 fd_set w_fds, r_fds, e_fds;
1366 int maxfd, count, cnt, using_r_fds;
1371 defer_forwarding_messages++, defer_inc++;
1373 while (total < len) {
1380 if (msg_fd_in >= 0) {
1382 FD_SET(msg_fd_in, &r_fds);
1383 if (msg_fd_in > maxfd)
1389 tv.tv_sec = select_timeout;
1393 count = select(maxfd + 1, using_r_fds ? &r_fds : NULL,
1394 &w_fds, &e_fds, &tv);
1397 if (count < 0 && errno == EBADF)
1398 exit_cleanup(RERR_SOCKETIO);
1403 /*if (FD_ISSET(fd, &e_fds))
1404 rprintf(FINFO, "select exception on fd %d\n", fd); */
1406 if (using_r_fds && FD_ISSET(msg_fd_in, &r_fds))
1409 if (!FD_ISSET(fd, &w_fds))
1413 if (bwlimit_writemax && n > bwlimit_writemax)
1414 n = bwlimit_writemax;
1415 cnt = write(fd, buf + total, n);
1421 if (errno == EWOULDBLOCK || errno == EAGAIN) {
1427 /* Don't try to write errors back across the stream. */
1428 if (fd == sock_f_out)
1429 io_end_multiplex_out();
1430 /* Don't try to write errors down a failing msg pipe. */
1431 if (am_server && fd == msg_fd_out)
1432 exit_cleanup(RERR_STREAMIO);
1433 rsyserr(FERROR, errno,
1434 "writefd_unbuffered failed to write %ld bytes [%s]",
1435 (long)len, who_am_i());
1436 /* If the other side is sending us error messages, try
1437 * to grab any messages they sent before they died. */
1438 while (fd == sock_f_out && io_multiplexing_in) {
1441 readfd_unbuffered(sock_f_in, io_filesfrom_buf,
1442 sizeof io_filesfrom_buf);
1444 exit_cleanup(RERR_STREAMIO);
1448 defer_forwarding_messages++, defer_inc++;
1450 if (fd == sock_f_out) {
1451 if (io_timeout || am_generator)
1452 last_io_out = time(NULL);
1453 sleep_for_bwlimit(cnt);
1458 if (!(defer_forwarding_messages -= defer_inc))
1462 void io_flush(int flush_it_all)
1464 if (!iobuf_out_cnt || no_flush)
1467 if (io_multiplexing_out)
1468 mplex_write(sock_f_out, MSG_DATA, iobuf_out, iobuf_out_cnt, 0);
1470 writefd_unbuffered(iobuf_f_out, iobuf_out, iobuf_out_cnt);
1473 if (flush_it_all && !defer_forwarding_messages)
1477 static void writefd(int fd, const char *buf, size_t len)
1479 if (fd == sock_f_out)
1480 stats.total_written += len;
1482 if (fd == write_batch_monitor_out) {
1483 if ((size_t)write(batch_fd, buf, len) != len)
1484 exit_cleanup(RERR_FILEIO);
1487 if (!iobuf_out || fd != iobuf_f_out) {
1488 writefd_unbuffered(fd, buf, len);
1493 int n = MIN((int)len, IO_BUFFER_SIZE - iobuf_out_cnt);
1495 memcpy(iobuf_out+iobuf_out_cnt, buf, n);
1501 if (iobuf_out_cnt == IO_BUFFER_SIZE)
1502 io_flush(NORMAL_FLUSH);
1506 void write_shortint(int f, unsigned short x)
1510 b[1] = (char)(x >> 8);
1514 void write_int(int f, int32 x)
1521 void write_varint(int f, int32 x)
1529 while (cnt > 1 && b[cnt] == 0)
1531 bit = ((uchar)1<<(7-cnt+1));
1532 if (CVAL(b, cnt) >= bit) {
1536 *b = b[cnt] | ~(bit*2-1);
1543 void write_varlong(int f, int64 x, uchar min_bytes)
1550 #if SIZEOF_INT64 >= 8
1551 SIVAL(b, 5, x >> 32);
1553 if (x <= 0x7FFFFFFF && x >= 0)
1554 memset(b + 5, 0, 4);
1556 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1557 exit_cleanup(RERR_UNSUPPORTED);
1561 while (cnt > min_bytes && b[cnt] == 0)
1563 bit = ((uchar)1<<(7-cnt+min_bytes));
1564 if (CVAL(b, cnt) >= bit) {
1567 } else if (cnt > min_bytes)
1568 *b = b[cnt] | ~(bit*2-1);
1576 * Note: int64 may actually be a 32-bit type if ./configure couldn't find any
1577 * 64-bit types on this platform.
1579 void write_longint(int f, int64 x)
1581 char b[12], * const s = b+4;
1584 if (x <= 0x7FFFFFFF && x >= 0) {
1589 #if SIZEOF_INT64 < 8
1590 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1591 exit_cleanup(RERR_UNSUPPORTED);
1594 SIVAL(s, 4, x >> 32);
1599 void write_buf(int f, const char *buf, size_t len)
1604 /** Write a string to the connection */
1605 void write_sbuf(int f, const char *buf)
1607 writefd(f, buf, strlen(buf));
1610 void write_byte(int f, uchar c)
1612 writefd(f, (char *)&c, 1);
1615 void write_vstring(int f, const char *str, int len)
1617 uchar lenbuf[3], *lb = lenbuf;
1622 "attempting to send over-long vstring (%d > %d)\n",
1624 exit_cleanup(RERR_PROTOCOL);
1626 *lb++ = len / 0x100 + 0x80;
1630 writefd(f, (char*)lenbuf, lb - lenbuf + 1);
1632 writefd(f, str, len);
1635 /* Send a file-list index using a byte-reduction method. */
1636 void write_ndx(int f, int32 ndx)
1638 static int32 prev_positive = -1, prev_negative = 1;
1639 int32 diff, cnt = 0;
1642 if (protocol_version < 30 || read_batch) {
1647 /* Send NDX_DONE as a single-byte 0 with no side effects. Send
1648 * negative nums as a positive after sending a leading 0xFF. */
1650 diff = ndx - prev_positive;
1651 prev_positive = ndx;
1652 } else if (ndx == NDX_DONE) {
1657 b[cnt++] = (char)0xFF;
1659 diff = ndx - prev_negative;
1660 prev_negative = ndx;
1663 /* A diff of 1 - 253 is sent as a one-byte diff; a diff of 254 - 32767
1664 * or 0 is sent as a 0xFE + a two-byte diff; otherwise we send 0xFE
1665 * & all 4 bytes of the (non-negative) num with the high-bit set. */
1666 if (diff < 0xFE && diff > 0)
1667 b[cnt++] = (char)diff;
1668 else if (diff < 0 || diff > 0x7FFF) {
1669 b[cnt++] = (char)0xFE;
1670 b[cnt++] = (char)((ndx >> 24) | 0x80);
1671 b[cnt++] = (char)ndx;
1672 b[cnt++] = (char)(ndx >> 8);
1673 b[cnt++] = (char)(ndx >> 16);
1675 b[cnt++] = (char)0xFE;
1676 b[cnt++] = (char)(diff >> 8);
1677 b[cnt++] = (char)diff;
1682 /* Receive a file-list index using a byte-reduction method. */
1683 int32 read_ndx(int f)
1685 static int32 prev_positive = -1, prev_negative = 1;
1686 int32 *prev_ptr, num;
1689 if (protocol_version < 30)
1693 if (CVAL(b, 0) == 0xFF) {
1695 prev_ptr = &prev_negative;
1696 } else if (CVAL(b, 0) == 0)
1699 prev_ptr = &prev_positive;
1700 if (CVAL(b, 0) == 0xFE) {
1702 if (CVAL(b, 0) & 0x80) {
1703 b[3] = CVAL(b, 0) & ~0x80;
1708 num = (UVAL(b,0)<<8) + UVAL(b,1) + *prev_ptr;
1710 num = UVAL(b, 0) + *prev_ptr;
1712 if (prev_ptr == &prev_negative)
1717 /* Read a line of up to bufsiz-1 characters into buf. Strips
1718 * the (required) trailing newline and all carriage returns.
1719 * Returns 1 for success; 0 for I/O error or truncation. */
1720 int read_line_old(int f, char *buf, size_t bufsiz)
1722 bufsiz--; /* leave room for the null */
1723 while (bufsiz > 0) {
1725 read_buf(f, buf, 1);
1730 if (buf[0] != '\r') {
1739 void io_printf(int fd, const char *format, ...)
1742 char buf[BIGPATHBUFLEN];
1745 va_start(ap, format);
1746 len = vsnprintf(buf, sizeof buf, format, ap);
1750 exit_cleanup(RERR_STREAMIO);
1752 if (len > (int)sizeof buf) {
1753 rprintf(FERROR, "io_printf() was too long for the buffer.\n");
1754 exit_cleanup(RERR_STREAMIO);
1757 write_sbuf(fd, buf);
1760 /** Setup for multiplexing a MSG_* stream with the data stream. */
1761 void io_start_multiplex_out(void)
1763 io_flush(NORMAL_FLUSH);
1764 io_start_buffering_out(sock_f_out);
1765 io_multiplexing_out = 1;
1768 /** Setup for multiplexing a MSG_* stream with the data stream. */
1769 void io_start_multiplex_in(void)
1771 io_flush(NORMAL_FLUSH);
1772 io_start_buffering_in(sock_f_in);
1773 io_multiplexing_in = 1;
1776 /** Write an message to the multiplexed data stream. */
1777 int io_multiplex_write(enum msgcode code, const char *buf, size_t len, int convert)
1779 if (!io_multiplexing_out)
1781 io_flush(NORMAL_FLUSH);
1782 stats.total_written += (len+4);
1783 mplex_write(sock_f_out, code, buf, len, convert);
1787 void io_end_multiplex_in(void)
1789 io_multiplexing_in = 0;
1790 io_end_buffering_in();
1793 /** Stop output multiplexing. */
1794 void io_end_multiplex_out(void)
1796 io_multiplexing_out = 0;
1797 io_end_buffering_out();
1800 void start_write_batch(int fd)
1802 /* Some communication has already taken place, but we don't
1803 * enable batch writing until here so that we can write a
1804 * canonical record of the communication even though the
1805 * actual communication so far depends on whether a daemon
1807 write_int(batch_fd, protocol_version);
1808 write_int(batch_fd, checksum_seed);
1811 write_batch_monitor_out = fd;
1813 write_batch_monitor_in = fd;
1816 void stop_write_batch(void)
1818 write_batch_monitor_out = -1;
1819 write_batch_monitor_in = -1;