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, 2004, 2005, 2006, 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 2 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, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
24 /* Rsync provides its own multiplexing system, which is used to send
25 * stderr and stdout over a single socket.
27 * For historical reasons this is off during the start of the
28 * connection, but it's switched on quite early using
29 * 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 checksum_seed;
51 extern int protocol_version;
52 extern int remove_source_files;
53 extern int preserve_hard_links;
54 extern char *filesfrom_host;
55 extern struct stats stats;
56 extern struct file_list *cur_flist, *first_flist;
58 const char phase_unknown[] = "unknown";
59 int ignore_timeout = 0;
63 /* Ignore an EOF error if non-zero. See whine_about_eof(). */
64 int kluge_around_eof = 0;
71 static int iobuf_f_in = -1;
72 static char *iobuf_in;
73 static size_t iobuf_in_siz;
74 static size_t iobuf_in_ndx;
75 static size_t iobuf_in_remaining;
77 static int iobuf_f_out = -1;
78 static char *iobuf_out;
79 static int iobuf_out_cnt;
81 int flist_forward_from = -1;
83 static int io_multiplexing_out;
84 static int io_multiplexing_in;
85 static time_t last_io_in;
86 static time_t last_io_out;
89 static int write_batch_monitor_in = -1;
90 static int write_batch_monitor_out = -1;
92 static int io_filesfrom_f_in = -1;
93 static int io_filesfrom_f_out = -1;
94 static char io_filesfrom_buf[2048];
95 static char *io_filesfrom_bp;
96 static char io_filesfrom_lastchar;
97 static int io_filesfrom_buflen;
98 static int defer_forwarding_messages = 0;
99 static int select_timeout = SELECT_TIMEOUT;
100 static int active_filecnt = 0;
101 static OFF_T active_bytecnt = 0;
103 static char int_byte_cnt[64] = {
104 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, /* (00 - 3F)/4 */
105 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, /* (40 - 7F)/4 */
106 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, /* (80 - BF)/4 */
107 5, 5, 5, 5, 5, 5, 5, 5, 6, 6, 6, 6, 7, 7, 8, 9, /* (C0 - FF)/4 */
110 static void readfd(int fd, char *buffer, size_t N);
111 static void writefd(int fd, const char *buf, size_t len);
112 static void writefd_unbuffered(int fd, const char *buf, size_t len);
113 static void decrement_active_files(int ndx);
114 static void decrement_flist_in_progress(int ndx, int redo);
116 struct flist_ndx_item {
117 struct flist_ndx_item *next;
121 struct flist_ndx_list {
122 struct flist_ndx_item *head, *tail;
125 static struct flist_ndx_list redo_list, hlink_list;
127 struct msg_list_item {
128 struct msg_list_item *next;
134 struct msg_list_item *head, *tail;
137 static struct msg_list msg2sndr;
139 static void flist_ndx_push(struct flist_ndx_list *lp, int ndx)
141 struct flist_ndx_item *item;
143 if (!(item = new(struct flist_ndx_item)))
144 out_of_memory("flist_ndx_push");
148 lp->tail->next = item;
154 static int flist_ndx_pop(struct flist_ndx_list *lp)
156 struct flist_ndx_item *next;
163 next = lp->head->next;
172 static void check_timeout(void)
176 if (!io_timeout || ignore_timeout)
180 last_io_in = time(NULL);
186 if (t - last_io_in >= io_timeout) {
187 if (!am_server && !am_daemon) {
188 rprintf(FERROR, "io timeout after %d seconds -- exiting\n",
189 (int)(t-last_io_in));
191 exit_cleanup(RERR_TIMEOUT);
195 /* Note the fds used for the main socket (which might really be a pipe
196 * for a local transfer, but we can ignore that). */
197 void io_set_sock_fds(int f_in, int f_out)
203 void set_io_timeout(int secs)
207 if (!io_timeout || io_timeout > SELECT_TIMEOUT)
208 select_timeout = SELECT_TIMEOUT;
210 select_timeout = io_timeout;
212 allowed_lull = read_batch ? 0 : (io_timeout + 1) / 2;
215 /* Setup the fd used to receive MSG_* messages. Only needed during the
216 * early stages of being a local sender (up through the sending of the
217 * file list) or when we're the generator (to fetch the messages from
219 void set_msg_fd_in(int fd)
224 /* Setup the fd used to send our MSG_* messages. Only needed when
225 * we're the receiver (to send our messages to the generator). */
226 void set_msg_fd_out(int fd)
229 set_nonblocking(msg_fd_out);
232 /* Add a message to the pending MSG_* list. */
233 static void msg_list_add(struct msg_list *lst, int code, const char *buf, int len)
235 struct msg_list_item *m;
236 int sz = len + 4 + sizeof m[0] - 1;
238 if (!(m = (struct msg_list_item *)new_array(char, sz)))
239 out_of_memory("msg_list_add");
242 SIVAL(m->buf, 0, ((code+MPLEX_BASE)<<24) | len);
243 memcpy(m->buf + 4, buf, len);
251 static void msg2sndr_flush(void)
253 while (msg2sndr.head && io_multiplexing_out) {
254 struct msg_list_item *m = msg2sndr.head;
255 if (!(msg2sndr.head = m->next))
256 msg2sndr.tail = NULL;
257 stats.total_written += m->len;
258 defer_forwarding_messages = 1;
259 writefd_unbuffered(sock_f_out, m->buf, m->len);
260 defer_forwarding_messages = 0;
265 /* Read a message from the MSG_* fd and handle it. This is called either
266 * during the early stages of being a local sender (up through the sending
267 * of the file list) or when we're the generator (to fetch the messages
268 * from the receiver). */
269 static void read_msg_fd(void)
273 struct file_list *flist;
277 /* Temporarily disable msg_fd_in. This is needed to avoid looping back
278 * to this routine from writefd_unbuffered(). */
281 defer_forwarding_messages++;
286 len = tag & 0xFFFFFF;
287 tag = (tag >> 24) - MPLEX_BASE;
291 if (len < 0 || len > 1 || !am_generator) {
293 rprintf(FERROR, "invalid message %d:%d [%s%s]\n",
294 tag, len, who_am_i(),
295 inc_recurse ? "/inc" : "");
296 exit_cleanup(RERR_STREAMIO);
299 readfd(fd, buf, len);
300 stats.total_read = read_longint(fd);
305 if (len != 4 || !am_generator)
308 if (remove_source_files)
309 decrement_active_files(IVAL(buf,0));
310 flist_ndx_push(&redo_list, IVAL(buf,0));
312 decrement_flist_in_progress(IVAL(buf,0), 1);
315 if (len != 4 || !am_generator || !inc_recurse)
318 /* Read extra file list from receiver. */
319 assert(iobuf_in != NULL);
320 assert(iobuf_f_in == fd);
321 flist = recv_file_list(fd);
322 flist->parent_ndx = IVAL(buf,0);
325 if (len != 0 || !am_generator || !inc_recurse)
330 if (len >= (int)sizeof buf || !am_generator)
332 readfd(fd, buf, len);
333 send_msg(MSG_DELETED, buf, len);
336 if (len != 4 || !am_generator)
338 readfd(fd, buf, len);
339 if (remove_source_files) {
340 decrement_active_files(IVAL(buf,0));
341 send_msg(MSG_SUCCESS, buf, len);
343 if (preserve_hard_links)
344 flist_ndx_push(&hlink_list, IVAL(buf,0));
346 decrement_flist_in_progress(IVAL(buf,0), 0);
349 if (len != 4 || !am_generator)
351 readfd(fd, buf, len);
353 decrement_flist_in_progress(IVAL(buf,0), 0);
359 if (tag == MSG_SOCKERR)
360 io_end_multiplex_out();
370 rwrite((enum logcode)tag, buf, n);
375 rprintf(FERROR, "unknown message %d:%d [%s]\n",
376 tag, len, who_am_i());
377 exit_cleanup(RERR_STREAMIO);
382 if (!--defer_forwarding_messages)
386 /* This is used by the generator to limit how many file transfers can
387 * be active at once when --remove-source-files is specified. Without
388 * this, sender-side deletions were mostly happening at the end. */
389 void increment_active_files(int ndx, int itemizing, enum logcode code)
391 /* TODO: tune these limits? */
392 while (active_filecnt >= (active_bytecnt >= 128*1024 ? 10 : 50)) {
393 check_for_finished_files(itemizing, code, 0);
395 io_flush(NORMAL_FLUSH);
401 active_bytecnt += F_LENGTH(cur_flist->files[ndx]);
404 static void decrement_active_files(int ndx)
406 struct file_list *flist = flist_for_ndx(ndx);
407 assert(flist != NULL);
409 active_bytecnt -= F_LENGTH(flist->files[ndx - flist->ndx_start]);
412 static void decrement_flist_in_progress(int ndx, int redo)
414 struct file_list *flist = cur_flist ? cur_flist : first_flist;
416 while (ndx < flist->ndx_start) {
417 if (flist == first_flist) {
420 "Invalid file index: %d (%d - %d) [%s]\n",
421 ndx, first_flist->ndx_start,
422 first_flist->prev->ndx_start + first_flist->prev->count - 1,
424 exit_cleanup(RERR_PROTOCOL);
428 while (ndx >= flist->ndx_start + flist->count) {
429 if (!(flist = flist->next))
433 flist->in_progress--;
438 /* Write an message to a multiplexed stream. If this fails, rsync exits. */
439 static void mplex_write(int fd, enum msgcode code, const char *buf, size_t len)
444 SIVAL(buffer, 0, ((MPLEX_BASE + (int)code)<<24) + len);
446 if (n > sizeof buffer - 4)
449 memcpy(buffer + 4, buf, n);
451 writefd_unbuffered(fd, buffer, n+4);
457 defer_forwarding_messages++;
458 writefd_unbuffered(fd, buf, len);
459 if (!--defer_forwarding_messages)
464 int send_msg(enum msgcode code, const char *buf, int len)
466 if (msg_fd_out < 0) {
467 if (!defer_forwarding_messages)
468 return io_multiplex_write(code, buf, len);
469 if (!io_multiplexing_out)
471 msg_list_add(&msg2sndr, code, buf, len);
474 mplex_write(msg_fd_out, code, buf, len);
478 void send_msg_int(enum msgcode code, int num)
481 SIVAL(numbuf, 0, num);
482 send_msg(code, numbuf, 4);
485 void wait_for_receiver(void)
488 io_flush(NORMAL_FLUSH);
493 int get_redo_num(void)
495 return flist_ndx_pop(&redo_list);
498 int get_hlink_num(void)
500 return flist_ndx_pop(&hlink_list);
504 * When we're the receiver and we have a local --files-from list of names
505 * that needs to be sent over the socket to the sender, we have to do two
506 * things at the same time: send the sender a list of what files we're
507 * processing and read the incoming file+info list from the sender. We do
508 * this by augmenting the read_timeout() function to copy this data. It
509 * uses the io_filesfrom_buf to read a block of data from f_in (when it is
510 * ready, since it might be a pipe) and then blast it out f_out (when it
511 * is ready to receive more data).
513 void io_set_filesfrom_fds(int f_in, int f_out)
515 io_filesfrom_f_in = f_in;
516 io_filesfrom_f_out = f_out;
517 io_filesfrom_bp = io_filesfrom_buf;
518 io_filesfrom_lastchar = '\0';
519 io_filesfrom_buflen = 0;
522 /* It's almost always an error to get an EOF when we're trying to read from the
523 * network, because the protocol is (for the most part) self-terminating.
525 * There is one case for the receiver when it is at the end of the transfer
526 * (hanging around reading any keep-alive packets that might come its way): if
527 * the sender dies before the generator's kill-signal comes through, we can end
528 * up here needing to loop until the kill-signal arrives. In this situation,
529 * kluge_around_eof will be < 0.
531 * There is another case for older protocol versions (< 24) where the module
532 * listing was not terminated, so we must ignore an EOF error in that case and
533 * exit. In this situation, kluge_around_eof will be > 0. */
534 static void whine_about_eof(int fd)
536 if (kluge_around_eof && fd == sock_f_in) {
538 if (kluge_around_eof > 0)
540 /* If we're still here after 10 seconds, exit with an error. */
541 for (i = 10*1000/20; i--; )
545 rprintf(FERROR, RSYNC_NAME ": connection unexpectedly closed "
546 "(%.0f bytes received so far) [%s]\n",
547 (double)stats.total_read, who_am_i());
549 exit_cleanup(RERR_STREAMIO);
553 * Read from a socket with I/O timeout. return the number of bytes
554 * read. If no bytes can be read then exit, never return a number <= 0.
556 * TODO: If the remote shell connection fails, then current versions
557 * actually report an "unexpected EOF" error here. Since it's a
558 * fairly common mistake to try to use rsh when ssh is required, we
559 * should trap that: if we fail to read any data at all, we should
560 * give a better explanation. We can tell whether the connection has
561 * started by looking e.g. at whether the remote version is known yet.
563 static int read_timeout(int fd, char *buf, size_t len)
567 io_flush(FULL_FLUSH);
570 /* until we manage to read *something* */
579 if (io_filesfrom_f_out >= 0) {
581 if (io_filesfrom_buflen == 0) {
582 if (io_filesfrom_f_in >= 0) {
583 FD_SET(io_filesfrom_f_in, &r_fds);
584 new_fd = io_filesfrom_f_in;
586 io_filesfrom_f_out = -1;
590 FD_SET(io_filesfrom_f_out, &w_fds);
591 new_fd = io_filesfrom_f_out;
597 tv.tv_sec = select_timeout;
602 count = select(maxfd + 1, &r_fds, &w_fds, NULL, &tv);
605 if (errno == EBADF) {
606 defer_forwarding_messages = 0;
607 exit_cleanup(RERR_SOCKETIO);
613 if (io_filesfrom_f_out >= 0) {
614 if (io_filesfrom_buflen) {
615 if (FD_ISSET(io_filesfrom_f_out, &w_fds)) {
616 int l = write(io_filesfrom_f_out,
618 io_filesfrom_buflen);
620 if (!(io_filesfrom_buflen -= l))
621 io_filesfrom_bp = io_filesfrom_buf;
623 io_filesfrom_bp += l;
625 /* XXX should we complain? */
626 io_filesfrom_f_out = -1;
629 } else if (io_filesfrom_f_in >= 0) {
630 if (FD_ISSET(io_filesfrom_f_in, &r_fds)) {
631 int l = read(io_filesfrom_f_in,
633 sizeof io_filesfrom_buf);
635 /* Send end-of-file marker */
636 io_filesfrom_buf[0] = '\0';
637 io_filesfrom_buf[1] = '\0';
638 io_filesfrom_buflen = io_filesfrom_lastchar? 2 : 1;
639 io_filesfrom_f_in = -1;
642 char *s = io_filesfrom_buf + l;
643 /* Transform CR and/or LF into '\0' */
644 while (s-- > io_filesfrom_buf) {
645 if (*s == '\n' || *s == '\r')
649 if (!io_filesfrom_lastchar) {
650 /* Last buf ended with a '\0', so don't
651 * let this buf start with one. */
652 while (l && !*io_filesfrom_bp)
653 io_filesfrom_bp++, l--;
656 io_filesfrom_bp = io_filesfrom_buf;
658 char *f = io_filesfrom_bp;
661 /* Eliminate any multi-'\0' runs. */
663 if (!(*t++ = *f++)) {
664 while (f != eob && !*f)
668 io_filesfrom_lastchar = f[-1];
670 io_filesfrom_buflen = l;
676 if (!FD_ISSET(fd, &r_fds))
679 n = read(fd, buf, len);
683 whine_about_eof(fd); /* Doesn't return. */
684 if (errno == EINTR || errno == EWOULDBLOCK
688 /* Don't write errors on a dead socket. */
689 if (fd == sock_f_in) {
690 io_end_multiplex_out();
691 rsyserr(FSOCKERR, errno, "read error");
693 rsyserr(FERROR, errno, "read error");
694 exit_cleanup(RERR_STREAMIO);
701 if (fd == sock_f_in && io_timeout)
702 last_io_in = time(NULL);
709 * Read a line into the "fname" buffer (which must be at least MAXPATHLEN
712 int read_filesfrom_line(int fd, char *fname)
714 char ch, *s, *eob = fname + MAXPATHLEN - 1;
716 int reading_remotely = filesfrom_host != NULL;
717 int nulls = eol_nulls || reading_remotely;
722 cnt = read(fd, &ch, 1);
723 if (cnt < 0 && (errno == EWOULDBLOCK
724 || errno == EINTR || errno == EAGAIN)) {
731 tv.tv_sec = select_timeout;
733 if (!select(fd+1, &r_fds, NULL, &e_fds, &tv))
735 if (FD_ISSET(fd, &e_fds)) {
736 rsyserr(FINFO, errno,
737 "select exception on fd %d", fd);
743 if (nulls? !ch : (ch == '\r' || ch == '\n')) {
744 /* Skip empty lines if reading locally. */
745 if (!reading_remotely && s == fname)
755 if (*fname == '#' || *fname == ';')
761 int io_start_buffering_out(int f_out)
764 assert(f_out == iobuf_f_out);
767 if (!(iobuf_out = new_array(char, IO_BUFFER_SIZE)))
768 out_of_memory("io_start_buffering_out");
774 int io_start_buffering_in(int f_in)
777 assert(f_in == iobuf_f_in);
780 iobuf_in_siz = 2 * IO_BUFFER_SIZE;
781 if (!(iobuf_in = new_array(char, iobuf_in_siz)))
782 out_of_memory("io_start_buffering_in");
787 void io_end_buffering_in(void)
794 iobuf_in_remaining = 0;
798 void io_end_buffering_out(void)
802 io_flush(FULL_FLUSH);
808 void maybe_flush_socket(void)
810 if (iobuf_out && iobuf_out_cnt && time(NULL) - last_io_out >= 5)
811 io_flush(NORMAL_FLUSH);
814 void maybe_send_keepalive(void)
816 if (time(NULL) - last_io_out >= allowed_lull) {
817 if (!iobuf_out || !iobuf_out_cnt) {
818 if (protocol_version < 29)
819 return; /* there's nothing we can do */
820 if (protocol_version >= 30)
821 send_msg(MSG_NOOP, "", 0);
823 write_int(sock_f_out, cur_flist->count);
824 write_shortint(sock_f_out, ITEM_IS_NEW);
828 io_flush(NORMAL_FLUSH);
832 void start_flist_forward(int f_in)
834 assert(iobuf_out != NULL);
835 assert(iobuf_f_out == msg_fd_out);
836 flist_forward_from = f_in;
839 void stop_flist_forward()
841 flist_forward_from = -1;
842 io_flush(FULL_FLUSH);
846 * Continue trying to read len bytes - don't return until len has been
849 static void read_loop(int fd, char *buf, size_t len)
852 int n = read_timeout(fd, buf, len);
860 * Read from the file descriptor handling multiplexing - return number
863 * Never returns <= 0.
865 static int readfd_unbuffered(int fd, char *buf, size_t len)
869 char line[BIGPATHBUFLEN];
871 if (!iobuf_in || fd != iobuf_f_in)
872 return read_timeout(fd, buf, len);
874 if (!io_multiplexing_in && iobuf_in_remaining == 0) {
875 iobuf_in_remaining = read_timeout(fd, iobuf_in, iobuf_in_siz);
880 if (iobuf_in_remaining) {
881 len = MIN(len, iobuf_in_remaining);
882 memcpy(buf, iobuf_in + iobuf_in_ndx, len);
884 iobuf_in_remaining -= len;
889 read_loop(fd, line, 4);
892 msg_bytes = tag & 0xFFFFFF;
893 tag = (tag >> 24) - MPLEX_BASE;
897 if (msg_bytes > iobuf_in_siz) {
898 if (!(iobuf_in = realloc_array(iobuf_in, char,
900 out_of_memory("readfd_unbuffered");
901 iobuf_in_siz = msg_bytes;
903 read_loop(fd, iobuf_in, msg_bytes);
904 iobuf_in_remaining = msg_bytes;
909 maybe_send_keepalive();
914 read_loop(fd, line, msg_bytes);
915 io_error |= IVAL(line, 0);
918 if (msg_bytes >= sizeof line)
920 read_loop(fd, line, msg_bytes);
921 /* A directory name was sent with the trailing null */
922 if (msg_bytes > 0 && !line[msg_bytes-1])
923 log_delete(line, S_IFDIR);
925 line[msg_bytes] = '\0';
926 log_delete(line, S_IFREG);
930 if (msg_bytes != 4) {
932 rprintf(FERROR, "invalid multi-message %d:%ld [%s]\n",
933 tag, (long)msg_bytes, who_am_i());
934 exit_cleanup(RERR_STREAMIO);
936 read_loop(fd, line, msg_bytes);
937 successful_send(IVAL(line, 0));
942 read_loop(fd, line, msg_bytes);
943 send_msg_int(MSG_NO_SEND, IVAL(line, 0));
947 if (msg_bytes >= sizeof line) {
950 "multiplexing overflow %d:%ld [%s]\n",
951 tag, (long)msg_bytes, who_am_i());
952 exit_cleanup(RERR_STREAMIO);
954 read_loop(fd, line, msg_bytes);
955 rwrite((enum logcode)tag, line, msg_bytes);
958 rprintf(FERROR, "unexpected tag %d [%s]\n",
960 exit_cleanup(RERR_STREAMIO);
964 if (iobuf_in_remaining == 0)
965 io_flush(NORMAL_FLUSH);
970 /* Do a buffered read from fd. Don't return until all N bytes have
971 * been read. If all N can't be read then exit with an error. */
972 static void readfd(int fd, char *buffer, size_t N)
978 cnt = readfd_unbuffered(fd, buffer + total, N-total);
982 if (fd == write_batch_monitor_in) {
983 if ((size_t)write(batch_fd, buffer, total) != total)
984 exit_cleanup(RERR_FILEIO);
987 if (fd == flist_forward_from)
988 writefd(iobuf_f_out, buffer, total);
991 stats.total_read += total;
994 unsigned short read_shortint(int f)
998 return (UVAL(b, 1) << 8) + UVAL(b, 0);
1001 int32 read_int(int f)
1008 #if SIZEOF_INT32 > 4
1009 if (num & (int32)0x80000000)
1010 num |= ~(int32)0xffffffff;
1015 int64 read_longint(int f)
1020 if (protocol_version < 30) {
1023 if ((int32)num != (int32)0xffffffff)
1026 #if SIZEOF_INT64 < 8
1027 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1028 exit_cleanup(RERR_UNSUPPORTED);
1031 num = IVAL(b,0) | (((int64)IVAL(b,4))<<32);
1036 cnt = int_byte_cnt[CVAL(b, 0) / 4];
1037 #if SIZEOF_INT64 < 8
1038 if (cnt > 5 || (cnt == 5 && (CVAL(b,0)&0x3F || CVAL(b,1)&0x80))) {
1039 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1040 exit_cleanup(RERR_UNSUPPORTED);
1044 readfd(f, b + 3, cnt - 3);
1050 num = NVAL4(b, 0x80);
1053 num = NVAL5(b, 0xC0);
1055 #if SIZEOF_INT64 >= 8
1057 num = NVAL6(b, 0xE0);
1060 num = NVAL7(b, 0xF0);
1063 num = NVAL8(b, 0xF8);
1066 num = NVAL8(b+1, 0);
1070 exit_cleanup(RERR_PROTOCOL); /* impossible... */
1077 void read_buf(int f, char *buf, size_t len)
1082 void read_sbuf(int f, char *buf, size_t len)
1084 readfd(f, buf, len);
1088 uchar read_byte(int f)
1091 readfd(f, (char *)&c, 1);
1095 int read_vstring(int f, char *buf, int bufsize)
1097 int len = read_byte(f);
1100 len = (len & ~0x80) * 0x100 + read_byte(f);
1102 if (len >= bufsize) {
1103 rprintf(FERROR, "over-long vstring received (%d > %d)\n",
1109 readfd(f, buf, len);
1114 /* Populate a sum_struct with values from the socket. This is
1115 * called by both the sender and the receiver. */
1116 void read_sum_head(int f, struct sum_struct *sum)
1118 sum->count = read_int(f);
1119 if (sum->count < 0) {
1120 rprintf(FERROR, "Invalid checksum count %ld [%s]\n",
1121 (long)sum->count, who_am_i());
1122 exit_cleanup(RERR_PROTOCOL);
1124 sum->blength = read_int(f);
1125 if (sum->blength < 0 || sum->blength > MAX_BLOCK_SIZE) {
1126 rprintf(FERROR, "Invalid block length %ld [%s]\n",
1127 (long)sum->blength, who_am_i());
1128 exit_cleanup(RERR_PROTOCOL);
1130 sum->s2length = protocol_version < 27 ? csum_length : (int)read_int(f);
1131 if (sum->s2length < 0 || sum->s2length > MD4_SUM_LENGTH) {
1132 rprintf(FERROR, "Invalid checksum length %d [%s]\n",
1133 sum->s2length, who_am_i());
1134 exit_cleanup(RERR_PROTOCOL);
1136 sum->remainder = read_int(f);
1137 if (sum->remainder < 0 || sum->remainder > sum->blength) {
1138 rprintf(FERROR, "Invalid remainder length %ld [%s]\n",
1139 (long)sum->remainder, who_am_i());
1140 exit_cleanup(RERR_PROTOCOL);
1144 /* Send the values from a sum_struct over the socket. Set sum to
1145 * NULL if there are no checksums to send. This is called by both
1146 * the generator and the sender. */
1147 void write_sum_head(int f, struct sum_struct *sum)
1149 static struct sum_struct null_sum;
1154 write_int(f, sum->count);
1155 write_int(f, sum->blength);
1156 if (protocol_version >= 27)
1157 write_int(f, sum->s2length);
1158 write_int(f, sum->remainder);
1162 * Sleep after writing to limit I/O bandwidth usage.
1164 * @todo Rather than sleeping after each write, it might be better to
1165 * use some kind of averaging. The current algorithm seems to always
1166 * use a bit less bandwidth than specified, because it doesn't make up
1167 * for slow periods. But arguably this is a feature. In addition, we
1168 * ought to take the time used to write the data into account.
1170 * During some phases of big transfers (file FOO is uptodate) this is
1171 * called with a small bytes_written every time. As the kernel has to
1172 * round small waits up to guarantee that we actually wait at least the
1173 * requested number of microseconds, this can become grossly inaccurate.
1174 * We therefore keep track of the bytes we've written over time and only
1175 * sleep when the accumulated delay is at least 1 tenth of a second.
1177 static void sleep_for_bwlimit(int bytes_written)
1179 static struct timeval prior_tv;
1180 static long total_written = 0;
1181 struct timeval tv, start_tv;
1182 long elapsed_usec, sleep_usec;
1184 #define ONE_SEC 1000000L /* # of microseconds in a second */
1186 if (!bwlimit_writemax)
1189 total_written += bytes_written;
1191 gettimeofday(&start_tv, NULL);
1192 if (prior_tv.tv_sec) {
1193 elapsed_usec = (start_tv.tv_sec - prior_tv.tv_sec) * ONE_SEC
1194 + (start_tv.tv_usec - prior_tv.tv_usec);
1195 total_written -= elapsed_usec * bwlimit / (ONE_SEC/1024);
1196 if (total_written < 0)
1200 sleep_usec = total_written * (ONE_SEC/1024) / bwlimit;
1201 if (sleep_usec < ONE_SEC / 10) {
1202 prior_tv = start_tv;
1206 tv.tv_sec = sleep_usec / ONE_SEC;
1207 tv.tv_usec = sleep_usec % ONE_SEC;
1208 select(0, NULL, NULL, NULL, &tv);
1210 gettimeofday(&prior_tv, NULL);
1211 elapsed_usec = (prior_tv.tv_sec - start_tv.tv_sec) * ONE_SEC
1212 + (prior_tv.tv_usec - start_tv.tv_usec);
1213 total_written = (sleep_usec - elapsed_usec) * bwlimit / (ONE_SEC/1024);
1216 /* Write len bytes to the file descriptor fd, looping as necessary to get
1217 * the job done and also (in certain circumstances) reading any data on
1218 * msg_fd_in to avoid deadlock.
1220 * This function underlies the multiplexing system. The body of the
1221 * application never calls this function directly. */
1222 static void writefd_unbuffered(int fd, const char *buf, size_t len)
1224 size_t n, total = 0;
1225 fd_set w_fds, r_fds, e_fds;
1226 int maxfd, count, cnt, using_r_fds;
1227 int defer_save = defer_forwarding_messages;
1231 defer_forwarding_messages = 1;
1233 while (total < len) {
1240 if (msg_fd_in >= 0) {
1242 FD_SET(msg_fd_in, &r_fds);
1243 if (msg_fd_in > maxfd)
1249 tv.tv_sec = select_timeout;
1253 count = select(maxfd + 1, using_r_fds ? &r_fds : NULL,
1254 &w_fds, &e_fds, &tv);
1257 if (count < 0 && errno == EBADF)
1258 exit_cleanup(RERR_SOCKETIO);
1263 if (FD_ISSET(fd, &e_fds)) {
1264 rsyserr(FINFO, errno,
1265 "select exception on fd %d", fd);
1268 if (using_r_fds && FD_ISSET(msg_fd_in, &r_fds))
1271 if (!FD_ISSET(fd, &w_fds))
1275 if (bwlimit_writemax && n > bwlimit_writemax)
1276 n = bwlimit_writemax;
1277 cnt = write(fd, buf + total, n);
1283 if (errno == EWOULDBLOCK || errno == EAGAIN) {
1289 /* Don't try to write errors back across the stream. */
1290 if (fd == sock_f_out)
1291 io_end_multiplex_out();
1292 /* Don't try to write errors down a failing msg pipe. */
1293 if (am_server && fd == msg_fd_out)
1294 exit_cleanup(RERR_STREAMIO);
1295 rsyserr(FERROR, errno,
1296 "writefd_unbuffered failed to write %ld bytes [%s]",
1297 (long)len, who_am_i());
1298 /* If the other side is sending us error messages, try
1299 * to grab any messages they sent before they died. */
1300 while (fd == sock_f_out && io_multiplexing_in) {
1303 readfd_unbuffered(sock_f_in, io_filesfrom_buf,
1304 sizeof io_filesfrom_buf);
1306 exit_cleanup(RERR_STREAMIO);
1310 defer_forwarding_messages = 1;
1312 if (fd == sock_f_out) {
1313 if (io_timeout || am_generator)
1314 last_io_out = time(NULL);
1315 sleep_for_bwlimit(cnt);
1320 if (!(defer_forwarding_messages = defer_save))
1324 void io_flush(int flush_it_all)
1326 if (flush_it_all && !defer_forwarding_messages)
1329 if (!iobuf_out_cnt || no_flush)
1332 if (io_multiplexing_out)
1333 mplex_write(sock_f_out, MSG_DATA, iobuf_out, iobuf_out_cnt);
1335 writefd_unbuffered(iobuf_f_out, iobuf_out, iobuf_out_cnt);
1339 static void writefd(int fd, const char *buf, size_t len)
1341 if (fd == sock_f_out)
1342 stats.total_written += len;
1344 if (fd == write_batch_monitor_out) {
1345 if ((size_t)write(batch_fd, buf, len) != len)
1346 exit_cleanup(RERR_FILEIO);
1349 if (!iobuf_out || fd != iobuf_f_out) {
1350 writefd_unbuffered(fd, buf, len);
1355 int n = MIN((int)len, IO_BUFFER_SIZE - iobuf_out_cnt);
1357 memcpy(iobuf_out+iobuf_out_cnt, buf, n);
1363 if (iobuf_out_cnt == IO_BUFFER_SIZE)
1364 io_flush(NORMAL_FLUSH);
1368 void write_shortint(int f, unsigned short x)
1372 b[1] = (char)(x >> 8);
1376 void write_int(int f, int32 x)
1384 * Note: int64 may actually be a 32-bit type if ./configure couldn't find any
1385 * 64-bit types on this platform.
1387 void write_longint(int f, int64 x)
1391 #if SIZEOF_INT64 < 8
1392 if (x < 0 || x > 0x7FFFFFFF) {
1393 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1394 exit_cleanup(RERR_UNSUPPORTED);
1398 if (protocol_version < 30) {
1399 char * const s = b+4;
1401 #if SIZEOF_INT64 < 8
1404 if (x <= 0x7FFFFFFF && x >= 0) {
1410 SIVAL(s, 4, x >> 32);
1415 } else if (x < ((int32)1<<(3*8-1))) {
1416 b[0] = (char)(x >> 16);
1417 b[1] = (char)(x >> 8);
1420 } else if (x < ((int64)1<<(4*8-2))) {
1421 b[0] = (char)((x >> 24) | 0x80);
1422 b[1] = (char)(x >> 16);
1423 b[2] = (char)(x >> 8);
1426 #if SIZEOF_INT64 < 8
1429 b[1] = (char)(x >> 24);
1430 b[2] = (char)(x >> 16);
1431 b[3] = (char)(x >> 8);
1436 } else if (x < ((int64)1<<(5*8-3))) {
1437 b[0] = (char)((x >> 32) | 0xC0);
1438 b[1] = (char)(x >> 24);
1439 b[2] = (char)(x >> 16);
1440 b[3] = (char)(x >> 8);
1443 } else if (x < ((int64)1<<(6*8-4))) {
1444 b[0] = (char)((x >> 40) | 0xE0);
1445 b[1] = (char)(x >> 32);
1446 b[2] = (char)(x >> 24);
1447 b[3] = (char)(x >> 16);
1448 b[4] = (char)(x >> 8);
1451 } else if (x < ((int64)1<<(7*8-5))) {
1452 b[0] = (char)((x >> 48) | 0xF0);
1453 b[1] = (char)(x >> 40);
1454 b[2] = (char)(x >> 32);
1455 b[3] = (char)(x >> 24);
1456 b[4] = (char)(x >> 16);
1457 b[5] = (char)(x >> 8);
1460 } else if (x < ((int64)1<<(8*8-6))) {
1461 b[0] = (char)((x >> 56) | 0xF8);
1462 b[1] = (char)(x >> 48);
1463 b[2] = (char)(x >> 40);
1464 b[3] = (char)(x >> 32);
1465 b[4] = (char)(x >> 24);
1466 b[5] = (char)(x >> 16);
1467 b[6] = (char)(x >> 8);
1473 b[1] = (char)(x >> 56);
1474 b[2] = (char)(x >> 48);
1475 b[3] = (char)(x >> 40);
1476 b[4] = (char)(x >> 32);
1477 b[5] = (char)(x >> 24);
1478 b[6] = (char)(x >> 16);
1479 b[7] = (char)(x >> 8);
1486 void write_buf(int f, const char *buf, size_t len)
1491 /** Write a string to the connection */
1492 void write_sbuf(int f, const char *buf)
1494 writefd(f, buf, strlen(buf));
1497 void write_byte(int f, uchar c)
1499 writefd(f, (char *)&c, 1);
1502 void write_vstring(int f, const char *str, int len)
1504 uchar lenbuf[3], *lb = lenbuf;
1509 "attempting to send over-long vstring (%d > %d)\n",
1511 exit_cleanup(RERR_PROTOCOL);
1513 *lb++ = len / 0x100 + 0x80;
1517 writefd(f, (char*)lenbuf, lb - lenbuf + 1);
1519 writefd(f, str, len);
1522 /* Send a file-list index using a byte-reduction method. */
1523 void write_ndx(int f, int32 ndx)
1525 static int32 prev_positive = -1, prev_negative = 1;
1526 int32 diff, cnt = 0;
1529 if (protocol_version < 30 || read_batch) {
1534 /* Send NDX_DONE as a single-byte 0 with no side effects. Send
1535 * negative nums as a positive after sending a leading 0xFF. */
1537 diff = ndx - prev_positive;
1538 prev_positive = ndx;
1539 } else if (ndx == NDX_DONE) {
1544 b[cnt++] = (char)0xFF;
1546 diff = ndx - prev_negative;
1547 prev_negative = ndx;
1550 /* A diff of 1 - 253 is sent as a one-byte diff; a diff of 254 - 32767
1551 * or 0 is sent as a 0xFE + a two-byte diff; otherwise we send 0xFE
1552 * & all 4 bytes of the (non-negative) num with the high-bit set. */
1553 if (diff < 0xFE && diff > 0)
1554 b[cnt++] = (char)diff;
1555 else if (diff < 0 || diff > 0x7FFF) {
1556 b[cnt++] = (char)0xFE;
1557 b[cnt++] = (char)((ndx >> 24) | 0x80);
1558 b[cnt++] = (char)(ndx >> 16);
1559 b[cnt++] = (char)(ndx >> 8);
1560 b[cnt++] = (char)ndx;
1562 b[cnt++] = (char)0xFE;
1563 b[cnt++] = (char)(diff >> 8);
1564 b[cnt++] = (char)diff;
1569 /* Receive a file-list index using a byte-reduction method. */
1570 int32 read_ndx(int f)
1572 static int32 prev_positive = -1, prev_negative = 1;
1573 int32 *prev_ptr, num;
1576 if (protocol_version < 30)
1580 if (CVAL(b, 0) == 0xFF) {
1582 prev_ptr = &prev_negative;
1583 } else if (CVAL(b, 0) == 0)
1586 prev_ptr = &prev_positive;
1587 if (CVAL(b, 0) == 0xFE) {
1589 if (CVAL(b, 0) & 0x80) {
1591 num = NVAL4(b, 0x80);
1593 num = NVAL2(b, 0) + *prev_ptr;
1595 num = CVAL(b, 0) + *prev_ptr;
1597 if (prev_ptr == &prev_negative)
1603 * Read a line of up to @p maxlen characters into @p buf (not counting
1604 * the trailing null). Strips the (required) trailing newline and all
1607 * @return 1 for success; 0 for I/O error or truncation.
1609 int read_line(int f, char *buf, size_t maxlen)
1613 read_buf(f, buf, 1);
1618 if (buf[0] != '\r') {
1627 void io_printf(int fd, const char *format, ...)
1630 char buf[BIGPATHBUFLEN];
1633 va_start(ap, format);
1634 len = vsnprintf(buf, sizeof buf, format, ap);
1638 exit_cleanup(RERR_STREAMIO);
1640 if (len > (int)sizeof buf) {
1641 rprintf(FERROR, "io_printf() was too long for the buffer.\n");
1642 exit_cleanup(RERR_STREAMIO);
1645 write_sbuf(fd, buf);
1648 /** Setup for multiplexing a MSG_* stream with the data stream. */
1649 void io_start_multiplex_out(void)
1651 io_flush(NORMAL_FLUSH);
1652 io_start_buffering_out(sock_f_out);
1653 io_multiplexing_out = 1;
1656 /** Setup for multiplexing a MSG_* stream with the data stream. */
1657 void io_start_multiplex_in(void)
1659 io_flush(NORMAL_FLUSH);
1660 io_start_buffering_in(sock_f_in);
1661 io_multiplexing_in = 1;
1664 /** Write an message to the multiplexed data stream. */
1665 int io_multiplex_write(enum msgcode code, const char *buf, size_t len)
1667 if (!io_multiplexing_out)
1669 io_flush(NORMAL_FLUSH);
1670 stats.total_written += (len+4);
1671 mplex_write(sock_f_out, code, buf, len);
1675 void io_end_multiplex_in(void)
1677 io_multiplexing_in = 0;
1678 io_end_buffering_in();
1681 /** Stop output multiplexing. */
1682 void io_end_multiplex_out(void)
1684 io_multiplexing_out = 0;
1685 io_end_buffering_out();
1688 void start_write_batch(int fd)
1690 /* Some communication has already taken place, but we don't
1691 * enable batch writing until here so that we can write a
1692 * canonical record of the communication even though the
1693 * actual communication so far depends on whether a daemon
1695 write_int(batch_fd, protocol_version);
1696 write_int(batch_fd, checksum_seed);
1699 write_batch_monitor_out = fd;
1701 write_batch_monitor_in = fd;
1704 void stop_write_batch(void)
1706 write_batch_monitor_out = -1;
1707 write_batch_monitor_in = -1;