1 /* -*- c-file-style: "linux" -*-
3 * Copyright (C) 1996-2001 by Andrew Tridgell
4 * Copyright (C) Paul Mackerras 1996
5 * Copyright (C) 2001, 2002 by Martin Pool <mbp@samba.org>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 * Socket and pipe I/O utilities used in rsync.
27 * rsync provides its own multiplexing system, which is used to send
28 * stderr and stdout over a single socket. We need this because
29 * stdout normally carries the binary data stream, and stderr all our
32 * For historical reasons this is off during the start of the
33 * connection, but it's switched on quite early using
34 * io_start_multiplex_out() and io_start_multiplex_in().
39 /** If no timeout is specified then use a 60 second select timeout */
40 #define SELECT_TIMEOUT 60
43 extern size_t bwlimit_writemax;
45 extern int io_timeout;
49 extern int am_generator;
51 extern int csum_length;
52 extern int checksum_seed;
53 extern int protocol_version;
54 extern char *remote_filesfrom_file;
55 extern struct stats stats;
57 const char phase_unknown[] = "unknown";
58 int select_timeout = SELECT_TIMEOUT;
59 int ignore_timeout = 0;
61 int batch_gen_fd = -1;
64 * The connection might be dropped at some point; perhaps because the
65 * remote instance crashed. Just giving the offset on the stream is
66 * not very helpful. So instead we try to make io_phase_name point to
69 * For buffered/multiplexed I/O these names will be somewhat
70 * approximate; perhaps for ease of support we would rather make the
71 * buffer always flush when a single application-level I/O finishes.
73 * @todo Perhaps we want some simple stack functionality, but there's
74 * no need to overdo it.
76 const char *io_write_phase = phase_unknown;
77 const char *io_read_phase = phase_unknown;
79 /* Ignore an EOF error if non-zero. We exit if the value is 1 (used while
80 * reading a module listing if the remote version is 24 or less) or go into a
81 * sleep loop if the value is 2 (used by the receiver when it is reading a
82 * potential end-of-transfer keep-alive message that may never come). */
83 int kluge_around_eof = 0;
88 static int io_multiplexing_out;
89 static int io_multiplexing_in;
90 static int sock_f_in = -1;
91 static int sock_f_out = -1;
92 static time_t last_io;
95 static int write_batch_monitor_in = -1;
96 static int write_batch_monitor_out = -1;
98 static int io_filesfrom_f_in = -1;
99 static int io_filesfrom_f_out = -1;
100 static char io_filesfrom_buf[2048];
101 static char *io_filesfrom_bp;
102 static char io_filesfrom_lastchar;
103 static int io_filesfrom_buflen;
105 static void read_loop(int fd, char *buf, size_t len);
108 struct redo_list *next;
112 static struct redo_list *redo_list_head;
113 static struct redo_list *redo_list_tail;
116 struct msg_list *next;
121 static struct msg_list *msg_list_head;
122 static struct msg_list *msg_list_tail;
124 static void redo_list_add(int num)
126 struct redo_list *rl;
128 if (!(rl = new(struct redo_list)))
129 exit_cleanup(RERR_MALLOC);
133 redo_list_tail->next = rl;
139 static void check_timeout(void)
143 if (!io_timeout || ignore_timeout)
147 last_io = time(NULL);
153 if (t - last_io >= io_timeout) {
154 if (!am_server && !am_daemon) {
155 rprintf(FERROR, "io timeout after %d seconds -- exiting\n",
158 exit_cleanup(RERR_TIMEOUT);
162 /* Note the fds used for the main socket (which might really be a pipe
163 * for a local transfer, but we can ignore that). */
164 void io_set_sock_fds(int f_in, int f_out)
170 /* Setup the fd used to receive MSG_* messages. Only needed during the
171 * early stages of being a local sender (up through the sending of the
172 * file list) or when we're the generator (to fetch the messages from
174 void set_msg_fd_in(int fd)
179 /* Setup the fd used to send our MSG_* messages. Only needed when
180 * we're the receiver (to send our messages to the generator). */
181 void set_msg_fd_out(int fd)
184 set_nonblocking(msg_fd_out);
187 /* Add a message to the pending MSG_* list. */
188 static void msg_list_add(int code, char *buf, int len)
192 if (!(ml = new(struct msg_list)))
193 exit_cleanup(RERR_MALLOC);
195 if (!(ml->buf = new_array(char, len+4)))
196 exit_cleanup(RERR_MALLOC);
197 SIVAL(ml->buf, 0, ((code+MPLEX_BASE)<<24) | len);
198 memcpy(ml->buf+4, buf, len);
201 msg_list_tail->next = ml;
207 void send_msg(enum msgcode code, char *buf, int len)
209 if (msg_fd_out < 0) {
210 io_multiplex_write(code, buf, len);
213 msg_list_add(code, buf, len);
214 msg_list_push(NORMAL_FLUSH);
217 /* Read a message from the MSG_* fd and handle it. This is called either
218 * during the early stages of being a local sender (up through the sending
219 * of the file list) or when we're the generator (to fetch the messages
220 * from the receiver). */
221 static void read_msg_fd(void)
228 /* Temporarily disable msg_fd_in. This is needed to avoid looping back
229 * to this routine from read_timeout() and writefd_unbuffered(). */
232 read_loop(fd, buf, 4);
235 len = tag & 0xFFFFFF;
236 tag = (tag >> 24) - MPLEX_BASE;
240 if (len != 0 || !am_generator) {
241 rprintf(FERROR, "invalid message %d:%d\n", tag, len);
242 exit_cleanup(RERR_STREAMIO);
247 if (len != 4 || !am_generator) {
248 rprintf(FERROR, "invalid message %d:%d\n", tag, len);
249 exit_cleanup(RERR_STREAMIO);
251 read_loop(fd, buf, 4);
252 redo_list_add(IVAL(buf,0));
255 if (len >= (int)sizeof buf || !am_generator) {
256 rprintf(FERROR, "invalid message %d:%d\n", tag, len);
257 exit_cleanup(RERR_STREAMIO);
259 read_loop(fd, buf, len);
260 io_multiplex_write(MSG_DELETED, buf, len);
263 if (len != 4 || !am_generator) {
264 rprintf(FERROR, "invalid message %d:%d\n", tag, len);
265 exit_cleanup(RERR_STREAMIO);
267 read_loop(fd, buf, len);
268 io_multiplex_write(MSG_SUCCESS, buf, len);
277 read_loop(fd, buf, n);
278 rwrite((enum logcode)tag, buf, n);
283 rprintf(FERROR, "unknown message %d:%d\n", tag, len);
284 exit_cleanup(RERR_STREAMIO);
290 /* Try to push messages off the list onto the wire. If we leave with more
291 * to do, return 0. On error, return -1. If everything flushed, return 1.
292 * This is only active in the receiver. */
293 int msg_list_push(int flush_it_all)
295 static int written = 0;
302 while (msg_list_head) {
303 struct msg_list *ml = msg_list_head;
304 int n = write(msg_fd_out, ml->buf + written, ml->len - written);
308 if (errno != EWOULDBLOCK && errno != EAGAIN)
313 FD_SET(msg_fd_out, &fds);
314 tv.tv_sec = select_timeout;
316 if (!select(msg_fd_out+1, NULL, &fds, NULL, &tv))
318 } else if ((written += n) == ml->len) {
320 msg_list_head = ml->next;
322 msg_list_tail = NULL;
330 int get_redo_num(void)
332 struct redo_list *next;
335 while (!redo_list_head)
338 num = redo_list_head->num;
339 next = redo_list_head->next;
340 free(redo_list_head);
341 redo_list_head = next;
343 redo_list_tail = NULL;
349 * When we're the receiver and we have a local --files-from list of names
350 * that needs to be sent over the socket to the sender, we have to do two
351 * things at the same time: send the sender a list of what files we're
352 * processing and read the incoming file+info list from the sender. We do
353 * this by augmenting the read_timeout() function to copy this data. It
354 * uses the io_filesfrom_buf to read a block of data from f_in (when it is
355 * ready, since it might be a pipe) and then blast it out f_out (when it
356 * is ready to receive more data).
358 void io_set_filesfrom_fds(int f_in, int f_out)
360 io_filesfrom_f_in = f_in;
361 io_filesfrom_f_out = f_out;
362 io_filesfrom_bp = io_filesfrom_buf;
363 io_filesfrom_lastchar = '\0';
364 io_filesfrom_buflen = 0;
368 * It's almost always an error to get an EOF when we're trying to read
369 * from the network, because the protocol is self-terminating.
371 * However, there is one unfortunate cases where it is not, which is
372 * rsync <2.4.6 sending a list of modules on a server, since the list
373 * is terminated by closing the socket. So, for the section of the
374 * program where that is a problem (start_socket_client),
375 * kluge_around_eof is True and we just exit.
377 static void whine_about_eof(int fd)
379 if (kluge_around_eof && fd == sock_f_in) {
380 if (kluge_around_eof > 0)
386 rprintf(FERROR, RSYNC_NAME ": connection unexpectedly closed "
387 "(%.0f bytes received so far) [%s]\n",
388 (double)stats.total_read, who_am_i());
390 exit_cleanup(RERR_STREAMIO);
395 * Read from a socket with I/O timeout. return the number of bytes
396 * read. If no bytes can be read then exit, never return a number <= 0.
398 * TODO: If the remote shell connection fails, then current versions
399 * actually report an "unexpected EOF" error here. Since it's a
400 * fairly common mistake to try to use rsh when ssh is required, we
401 * should trap that: if we fail to read any data at all, we should
402 * give a better explanation. We can tell whether the connection has
403 * started by looking e.g. at whether the remote version is known yet.
405 static int read_timeout(int fd, char *buf, size_t len)
409 io_flush(NORMAL_FLUSH);
412 /* until we manage to read *something* */
421 if (msg_fd_in >= 0) {
422 FD_SET(msg_fd_in, &r_fds);
423 if (msg_fd_in > maxfd)
425 } else if (msg_list_head) {
426 FD_SET(msg_fd_out, &w_fds);
427 if (msg_fd_out > maxfd)
430 if (io_filesfrom_f_out >= 0) {
432 if (io_filesfrom_buflen == 0) {
433 if (io_filesfrom_f_in >= 0) {
434 FD_SET(io_filesfrom_f_in, &r_fds);
435 new_fd = io_filesfrom_f_in;
437 io_filesfrom_f_out = -1;
441 FD_SET(io_filesfrom_f_out, &w_fds);
442 new_fd = io_filesfrom_f_out;
448 tv.tv_sec = select_timeout;
453 count = select(maxfd + 1, &r_fds, &w_fds, NULL, &tv);
457 exit_cleanup(RERR_SOCKETIO);
462 if (msg_fd_in >= 0 && FD_ISSET(msg_fd_in, &r_fds))
464 else if (msg_list_head && FD_ISSET(msg_fd_out, &w_fds))
465 msg_list_push(NORMAL_FLUSH);
467 if (io_filesfrom_f_out >= 0) {
468 if (io_filesfrom_buflen) {
469 if (FD_ISSET(io_filesfrom_f_out, &w_fds)) {
470 int l = write(io_filesfrom_f_out,
472 io_filesfrom_buflen);
474 if (!(io_filesfrom_buflen -= l))
475 io_filesfrom_bp = io_filesfrom_buf;
477 io_filesfrom_bp += l;
479 /* XXX should we complain? */
480 io_filesfrom_f_out = -1;
483 } else if (io_filesfrom_f_in >= 0) {
484 if (FD_ISSET(io_filesfrom_f_in, &r_fds)) {
485 int l = read(io_filesfrom_f_in,
487 sizeof io_filesfrom_buf);
489 /* Send end-of-file marker */
490 io_filesfrom_buf[0] = '\0';
491 io_filesfrom_buf[1] = '\0';
492 io_filesfrom_buflen = io_filesfrom_lastchar? 2 : 1;
493 io_filesfrom_f_in = -1;
496 char *s = io_filesfrom_buf + l;
497 /* Transform CR and/or LF into '\0' */
498 while (s-- > io_filesfrom_buf) {
499 if (*s == '\n' || *s == '\r')
503 if (!io_filesfrom_lastchar) {
504 /* Last buf ended with a '\0', so don't
505 * let this buf start with one. */
506 while (l && !*io_filesfrom_bp)
507 io_filesfrom_bp++, l--;
510 io_filesfrom_bp = io_filesfrom_buf;
512 char *f = io_filesfrom_bp;
515 /* Eliminate any multi-'\0' runs. */
517 if (!(*t++ = *f++)) {
518 while (f != eob && !*f)
522 io_filesfrom_lastchar = f[-1];
524 io_filesfrom_buflen = l;
530 if (!FD_ISSET(fd, &r_fds))
533 n = read(fd, buf, len);
537 whine_about_eof(fd); /* Doesn't return. */
538 if (errno == EINTR || errno == EWOULDBLOCK
542 /* Don't write errors on a dead socket. */
544 close_multiplexing_out();
545 rsyserr(FERROR, errno, "read error");
546 exit_cleanup(RERR_STREAMIO);
553 if (io_timeout && fd == sock_f_in)
554 last_io = time(NULL);
561 * Read a line into the "fname" buffer (which must be at least MAXPATHLEN
564 int read_filesfrom_line(int fd, char *fname)
566 char ch, *s, *eob = fname + MAXPATHLEN - 1;
568 int reading_remotely = remote_filesfrom_file != NULL;
569 int nulls = eol_nulls || reading_remotely;
574 cnt = read(fd, &ch, 1);
575 if (cnt < 0 && (errno == EWOULDBLOCK
576 || errno == EINTR || errno == EAGAIN)) {
581 tv.tv_sec = select_timeout;
583 if (!select(fd+1, &fds, NULL, NULL, &tv))
589 if (nulls? !ch : (ch == '\r' || ch == '\n')) {
590 /* Skip empty lines if reading locally. */
591 if (!reading_remotely && s == fname)
601 if (*fname == '#' || *fname == ';')
608 static char *iobuf_out;
609 static int iobuf_out_cnt;
611 void io_start_buffering_out(void)
615 if (!(iobuf_out = new_array(char, IO_BUFFER_SIZE)))
616 out_of_memory("io_start_buffering_out");
621 static char *iobuf_in;
622 static size_t iobuf_in_siz;
624 void io_start_buffering_in(void)
628 iobuf_in_siz = 2 * IO_BUFFER_SIZE;
629 if (!(iobuf_in = new_array(char, iobuf_in_siz)))
630 out_of_memory("io_start_buffering_in");
634 void io_end_buffering(void)
636 io_flush(NORMAL_FLUSH);
637 if (!io_multiplexing_out) {
644 void maybe_send_keepalive(int allowed_lull, int ndx)
646 if (time(NULL) - last_io >= allowed_lull) {
647 if (!iobuf_out || !iobuf_out_cnt) {
648 if (protocol_version < 29)
649 return; /* there's nothing we can do */
650 write_int(sock_f_out, ndx);
651 write_shortint(sock_f_out, ITEM_IS_NEW);
654 io_flush(NORMAL_FLUSH);
660 * Continue trying to read len bytes - don't return until len has been
663 static void read_loop(int fd, char *buf, size_t len)
666 int n = read_timeout(fd, buf, len);
675 * Read from the file descriptor handling multiplexing - return number
678 * Never returns <= 0.
680 static int readfd_unbuffered(int fd, char *buf, size_t len)
682 static size_t remaining;
683 static size_t iobuf_in_ndx;
685 char line[MAXPATHLEN+1];
687 if (!iobuf_in || fd != sock_f_in)
688 return read_timeout(fd, buf, len);
690 if (!io_multiplexing_in && remaining == 0) {
691 remaining = read_timeout(fd, iobuf_in, iobuf_in_siz);
697 len = MIN(len, remaining);
698 memcpy(buf, iobuf_in + iobuf_in_ndx, len);
705 read_loop(fd, line, 4);
708 remaining = tag & 0xFFFFFF;
709 tag = (tag >> 24) - MPLEX_BASE;
713 if (remaining > iobuf_in_siz) {
714 if (!(iobuf_in = realloc_array(iobuf_in, char,
716 out_of_memory("readfd_unbuffered");
717 iobuf_in_siz = remaining;
719 read_loop(fd, iobuf_in, remaining);
723 if (remaining >= sizeof line) {
724 rprintf(FERROR, "invalid multi-message %d:%ld\n",
725 tag, (long)remaining);
726 exit_cleanup(RERR_STREAMIO);
728 read_loop(fd, line, remaining);
729 line[remaining] = '\0';
730 /* A directory name was sent with the trailing null */
731 if (remaining > 0 && !line[remaining-1])
732 log_delete(line, S_IFDIR);
734 log_delete(line, S_IFREG);
738 if (remaining != 4) {
739 rprintf(FERROR, "invalid multi-message %d:%ld\n",
740 tag, (long)remaining);
741 exit_cleanup(RERR_STREAMIO);
743 read_loop(fd, line, remaining);
744 successful_send(IVAL(line, 0));
749 if (remaining >= sizeof line) {
751 "[%s] multiplexing overflow %d:%ld\n\n",
752 who_am_i(), tag, (long)remaining);
753 exit_cleanup(RERR_STREAMIO);
755 read_loop(fd, line, remaining);
756 rwrite((enum logcode)tag, line, remaining);
760 rprintf(FERROR, "[%s] unexpected tag %d\n",
762 exit_cleanup(RERR_STREAMIO);
767 io_flush(NORMAL_FLUSH);
775 * Do a buffered read from @p fd. Don't return until all @p n bytes
776 * have been read. If all @p n can't be read then exit with an
779 static void readfd(int fd, char *buffer, size_t N)
785 ret = readfd_unbuffered(fd, buffer + total, N-total);
789 if (fd == write_batch_monitor_in) {
790 if ((size_t)write(batch_fd, buffer, total) != total)
791 exit_cleanup(RERR_FILEIO);
795 stats.total_read += total;
799 int read_shortint(int f)
802 readfd(f, (char *)b, 2);
803 return (b[1] << 8) + b[0];
807 int32 read_int(int f)
814 if (ret == (int32)0xffffffff)
819 int64 read_longint(int f)
825 if ((int32)ret != (int32)0xffffffff)
829 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
830 exit_cleanup(RERR_UNSUPPORTED);
833 ret = IVAL(b,0) | (((int64)IVAL(b,4))<<32);
839 void read_buf(int f,char *buf,size_t len)
844 void read_sbuf(int f,char *buf,size_t len)
850 uchar read_byte(int f)
853 readfd(f, (char *)&c, 1);
857 /* Populate a sum_struct with values from the socket. This is
858 * called by both the sender and the receiver. */
859 void read_sum_head(int f, struct sum_struct *sum)
861 sum->count = read_int(f);
862 sum->blength = read_int(f);
863 if (sum->blength < 0 || sum->blength > MAX_BLOCK_SIZE) {
864 rprintf(FERROR, "[%s] Invalid block length %ld\n",
865 who_am_i(), (long)sum->blength);
866 exit_cleanup(RERR_PROTOCOL);
868 sum->s2length = protocol_version < 27 ? csum_length : (int)read_int(f);
869 if (sum->s2length < 0 || sum->s2length > MD4_SUM_LENGTH) {
870 rprintf(FERROR, "[%s] Invalid checksum length %d\n",
871 who_am_i(), sum->s2length);
872 exit_cleanup(RERR_PROTOCOL);
874 sum->remainder = read_int(f);
875 if (sum->remainder < 0 || sum->remainder > sum->blength) {
876 rprintf(FERROR, "[%s] Invalid remainder length %ld\n",
877 who_am_i(), (long)sum->remainder);
878 exit_cleanup(RERR_PROTOCOL);
882 /* Send the values from a sum_struct over the socket. Set sum to
883 * NULL if there are no checksums to send. This is called by both
884 * the generator and the sender. */
885 void write_sum_head(int f, struct sum_struct *sum)
887 static struct sum_struct null_sum;
892 write_int(f, sum->count);
893 write_int(f, sum->blength);
894 if (protocol_version >= 27)
895 write_int(f, sum->s2length);
896 write_int(f, sum->remainder);
901 * Sleep after writing to limit I/O bandwidth usage.
903 * @todo Rather than sleeping after each write, it might be better to
904 * use some kind of averaging. The current algorithm seems to always
905 * use a bit less bandwidth than specified, because it doesn't make up
906 * for slow periods. But arguably this is a feature. In addition, we
907 * ought to take the time used to write the data into account.
909 * During some phases of big transfers (file FOO is uptodate) this is
910 * called with a small bytes_written every time. As the kernel has to
911 * round small waits up to guarantee that we actually wait at least the
912 * requested number of microseconds, this can become grossly inaccurate.
913 * We therefore keep track of the bytes we've written over time and only
914 * sleep when the accumulated delay is at least 1 tenth of a second.
916 static void sleep_for_bwlimit(int bytes_written)
918 static struct timeval prior_tv;
919 static long total_written = 0;
920 struct timeval tv, start_tv;
921 long elapsed_usec, sleep_usec;
923 #define ONE_SEC 1000000L /* # of microseconds in a second */
928 total_written += bytes_written;
930 gettimeofday(&start_tv, NULL);
931 if (prior_tv.tv_sec) {
932 elapsed_usec = (start_tv.tv_sec - prior_tv.tv_sec) * ONE_SEC
933 + (start_tv.tv_usec - prior_tv.tv_usec);
934 total_written -= elapsed_usec * bwlimit / (ONE_SEC/1024);
935 if (total_written < 0)
939 sleep_usec = total_written * (ONE_SEC/1024) / bwlimit;
940 if (sleep_usec < ONE_SEC / 10) {
945 tv.tv_sec = sleep_usec / ONE_SEC;
946 tv.tv_usec = sleep_usec % ONE_SEC;
947 select(0, NULL, NULL, NULL, &tv);
949 gettimeofday(&prior_tv, NULL);
950 elapsed_usec = (prior_tv.tv_sec - start_tv.tv_sec) * ONE_SEC
951 + (prior_tv.tv_usec - start_tv.tv_usec);
952 total_written = (sleep_usec - elapsed_usec) * bwlimit / (ONE_SEC/1024);
956 /* Write len bytes to the file descriptor fd, looping as necessary to get
957 * the job done and also (in the generator) reading any data on msg_fd_in
958 * (to avoid deadlock).
960 * This function underlies the multiplexing system. The body of the
961 * application never calls this function directly. */
962 static void writefd_unbuffered(int fd,char *buf,size_t len)
966 int maxfd, count, ret;
971 while (total < len) {
976 if (msg_fd_in >= 0) {
978 FD_SET(msg_fd_in,&r_fds);
979 if (msg_fd_in > maxfd)
982 if (fd != sock_f_out && iobuf_out_cnt && no_flush == 1) {
983 FD_SET(sock_f_out, &w_fds);
984 if (sock_f_out > maxfd)
988 tv.tv_sec = select_timeout;
992 count = select(maxfd + 1, msg_fd_in >= 0 ? &r_fds : NULL,
996 if (count < 0 && errno == EBADF)
997 exit_cleanup(RERR_SOCKETIO);
1002 if (msg_fd_in >= 0 && FD_ISSET(msg_fd_in, &r_fds))
1005 if (!FD_ISSET(fd, &w_fds)) {
1006 if (fd != sock_f_out && iobuf_out_cnt) {
1008 io_flush(NORMAL_FLUSH);
1015 if (bwlimit && n > bwlimit_writemax)
1016 n = bwlimit_writemax;
1017 ret = write(fd, buf + total, n);
1023 if (errno == EWOULDBLOCK || errno == EAGAIN) {
1029 /* Don't try to write errors back across the stream. */
1030 if (fd == sock_f_out)
1031 close_multiplexing_out();
1032 rsyserr(FERROR, errno,
1033 "writefd_unbuffered failed to write %ld bytes: phase \"%s\" [%s]",
1034 (long)len, io_write_phase, who_am_i());
1035 /* If the other side is sending us error messages, try
1036 * to grab any messages they sent before they died. */
1037 while (fd == sock_f_out && io_multiplexing_in) {
1038 io_timeout = select_timeout = 30;
1040 readfd_unbuffered(sock_f_in, io_filesfrom_buf,
1041 sizeof io_filesfrom_buf);
1043 exit_cleanup(RERR_STREAMIO);
1048 if (fd == sock_f_out) {
1050 last_io = time(NULL);
1051 sleep_for_bwlimit(ret);
1060 * Write an message to a multiplexed stream. If this fails then rsync
1063 static void mplex_write(enum msgcode code, char *buf, size_t len)
1068 SIVAL(buffer, 0, ((MPLEX_BASE + (int)code)<<24) + len);
1070 if (n > sizeof buffer - 4)
1071 n = sizeof buffer - 4;
1073 memcpy(&buffer[4], buf, n);
1074 writefd_unbuffered(sock_f_out, buffer, n+4);
1080 writefd_unbuffered(sock_f_out, buf, len);
1084 void io_flush(int flush_it_all)
1086 msg_list_push(flush_it_all);
1088 if (!iobuf_out_cnt || no_flush)
1091 if (io_multiplexing_out)
1092 mplex_write(MSG_DATA, iobuf_out, iobuf_out_cnt);
1094 writefd_unbuffered(sock_f_out, iobuf_out, iobuf_out_cnt);
1099 static void writefd(int fd,char *buf,size_t len)
1101 if (fd == msg_fd_out) {
1102 rprintf(FERROR, "Internal error: wrong write used in receiver.\n");
1103 exit_cleanup(RERR_PROTOCOL);
1106 if (fd == sock_f_out)
1107 stats.total_written += len;
1109 if (fd == write_batch_monitor_out) {
1110 if ((size_t)write(batch_fd, buf, len) != len)
1111 exit_cleanup(RERR_FILEIO);
1114 if (!iobuf_out || fd != sock_f_out) {
1115 writefd_unbuffered(fd, buf, len);
1120 int n = MIN((int)len, IO_BUFFER_SIZE - iobuf_out_cnt);
1122 memcpy(iobuf_out+iobuf_out_cnt, buf, n);
1128 if (iobuf_out_cnt == IO_BUFFER_SIZE)
1129 io_flush(NORMAL_FLUSH);
1134 void write_shortint(int f, int x)
1139 writefd(f, (char *)b, 2);
1143 void write_int(int f,int32 x)
1151 void write_int_named(int f, int32 x, const char *phase)
1153 io_write_phase = phase;
1155 io_write_phase = phase_unknown;
1160 * Note: int64 may actually be a 32-bit type if ./configure couldn't find any
1161 * 64-bit types on this platform.
1163 void write_longint(int f, int64 x)
1167 if (x <= 0x7FFFFFFF) {
1168 write_int(f, (int)x);
1172 #if SIZEOF_INT64 < 8
1173 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1174 exit_cleanup(RERR_UNSUPPORTED);
1176 write_int(f, (int32)0xFFFFFFFF);
1177 SIVAL(b,0,(x&0xFFFFFFFF));
1178 SIVAL(b,4,((x>>32)&0xFFFFFFFF));
1184 void write_buf(int f,char *buf,size_t len)
1190 /** Write a string to the connection */
1191 void write_sbuf(int f, char *buf)
1193 writefd(f, buf, strlen(buf));
1197 void write_byte(int f, uchar c)
1199 writefd(f, (char *)&c, 1);
1204 * Read a line of up to @p maxlen characters into @p buf (not counting
1205 * the trailing null). Strips the (required) trailing newline and all
1208 * @return 1 for success; 0 for I/O error or truncation.
1210 int read_line(int f, char *buf, size_t maxlen)
1214 read_buf(f, buf, 1);
1219 if (buf[0] != '\r') {
1229 void io_printf(int fd, const char *format, ...)
1235 va_start(ap, format);
1236 len = vsnprintf(buf, sizeof buf, format, ap);
1240 exit_cleanup(RERR_STREAMIO);
1242 write_sbuf(fd, buf);
1246 /** Setup for multiplexing a MSG_* stream with the data stream. */
1247 void io_start_multiplex_out(void)
1249 io_flush(NORMAL_FLUSH);
1250 io_start_buffering_out();
1251 io_multiplexing_out = 1;
1254 /** Setup for multiplexing a MSG_* stream with the data stream. */
1255 void io_start_multiplex_in(void)
1257 io_flush(NORMAL_FLUSH);
1258 io_start_buffering_in();
1259 io_multiplexing_in = 1;
1262 /** Write an message to the multiplexed data stream. */
1263 int io_multiplex_write(enum msgcode code, char *buf, size_t len)
1265 if (!io_multiplexing_out)
1268 io_flush(NORMAL_FLUSH);
1269 stats.total_written += (len+4);
1270 mplex_write(code, buf, len);
1274 void close_multiplexing_in(void)
1276 io_multiplexing_in = 0;
1279 /** Stop output multiplexing. */
1280 void close_multiplexing_out(void)
1282 io_multiplexing_out = 0;
1285 void start_write_batch(int fd)
1287 write_stream_flags(batch_fd);
1289 /* Some communication has already taken place, but we don't
1290 * enable batch writing until here so that we can write a
1291 * canonical record of the communication even though the
1292 * actual communication so far depends on whether a daemon
1294 write_int(batch_fd, protocol_version);
1295 write_int(batch_fd, checksum_seed);
1298 write_batch_monitor_out = fd;
1300 write_batch_monitor_in = fd;
1303 void stop_write_batch(void)
1305 write_batch_monitor_out = -1;
1306 write_batch_monitor_in = -1;