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 EOF errors while reading a module listing if the remote
80 version is 24 or less. */
81 int kludge_around_eof = False;
86 static int io_multiplexing_out;
87 static int io_multiplexing_in;
88 static int sock_f_in = -1;
89 static int sock_f_out = -1;
90 static time_t last_io;
93 static int write_batch_monitor_in = -1;
94 static int write_batch_monitor_out = -1;
96 static int io_filesfrom_f_in = -1;
97 static int io_filesfrom_f_out = -1;
98 static char io_filesfrom_buf[2048];
99 static char *io_filesfrom_bp;
100 static char io_filesfrom_lastchar;
101 static int io_filesfrom_buflen;
103 static void read_loop(int fd, char *buf, size_t len);
106 struct redo_list *next;
110 static struct redo_list *redo_list_head;
111 static struct redo_list *redo_list_tail;
114 struct msg_list *next;
119 static struct msg_list *msg_list_head;
120 static struct msg_list *msg_list_tail;
122 static void redo_list_add(int num)
124 struct redo_list *rl;
126 if (!(rl = new(struct redo_list)))
127 exit_cleanup(RERR_MALLOC);
131 redo_list_tail->next = rl;
137 static void check_timeout(void)
141 if (!io_timeout || ignore_timeout)
145 last_io = time(NULL);
151 if (t - last_io >= io_timeout) {
152 if (!am_server && !am_daemon) {
153 rprintf(FERROR, "io timeout after %d seconds -- exiting\n",
156 exit_cleanup(RERR_TIMEOUT);
160 /* Note the fds used for the main socket (which might really be a pipe
161 * for a local transfer, but we can ignore that). */
162 void io_set_sock_fds(int f_in, int f_out)
168 /* Setup the fd used to receive MSG_* messages. Only needed during the
169 * early stages of being a local sender (up through the sending of the
170 * file list) or when we're the generator (to fetch the messages from
172 void set_msg_fd_in(int fd)
177 /* Setup the fd used to send our MSG_* messages. Only needed when
178 * we're the receiver (to send our messages to the generator). */
179 void set_msg_fd_out(int fd)
182 set_nonblocking(msg_fd_out);
185 /* Add a message to the pending MSG_* list. */
186 static void msg_list_add(int code, char *buf, int len)
190 if (!(ml = new(struct msg_list)))
191 exit_cleanup(RERR_MALLOC);
193 if (!(ml->buf = new_array(char, len+4)))
194 exit_cleanup(RERR_MALLOC);
195 SIVAL(ml->buf, 0, ((code+MPLEX_BASE)<<24) | len);
196 memcpy(ml->buf+4, buf, len);
199 msg_list_tail->next = ml;
205 void send_msg(enum msgcode code, char *buf, int len)
207 if (msg_fd_out < 0) {
208 io_multiplex_write(code, buf, len);
211 msg_list_add(code, buf, len);
212 msg_list_push(NORMAL_FLUSH);
215 /* Read a message from the MSG_* fd and handle it. This is called either
216 * during the early stages of being a local sender (up through the sending
217 * of the file list) or when we're the generator (to fetch the messages
218 * from the receiver). */
219 static void read_msg_fd(void)
226 /* Temporarily disable msg_fd_in. This is needed to avoid looping back
227 * to this routine from read_timeout() and writefd_unbuffered(). */
230 read_loop(fd, buf, 4);
233 len = tag & 0xFFFFFF;
234 tag = (tag >> 24) - MPLEX_BASE;
238 if (len != 0 || !am_generator) {
239 rprintf(FERROR, "invalid message %d:%d\n", tag, len);
240 exit_cleanup(RERR_STREAMIO);
245 if (len != 4 || !am_generator) {
246 rprintf(FERROR, "invalid message %d:%d\n", tag, len);
247 exit_cleanup(RERR_STREAMIO);
249 read_loop(fd, buf, 4);
250 redo_list_add(IVAL(buf,0));
253 if (len >= (int)sizeof buf || !am_generator) {
254 rprintf(FERROR, "invalid message %d:%d\n", tag, len);
255 exit_cleanup(RERR_STREAMIO);
257 read_loop(fd, buf, len);
258 io_multiplex_write(MSG_DELETED, buf, len);
261 if (len != 4 || !am_generator) {
262 rprintf(FERROR, "invalid message %d:%d\n", tag, len);
263 exit_cleanup(RERR_STREAMIO);
265 read_loop(fd, buf, len);
266 io_multiplex_write(MSG_SUCCESS, buf, len);
275 read_loop(fd, buf, n);
276 rwrite((enum logcode)tag, buf, n);
281 rprintf(FERROR, "unknown message %d:%d\n", tag, len);
282 exit_cleanup(RERR_STREAMIO);
288 /* Try to push messages off the list onto the wire. If we leave with more
289 * to do, return 0. On error, return -1. If everything flushed, return 1.
290 * This is only active in the receiver. */
291 int msg_list_push(int flush_it_all)
293 static int written = 0;
300 while (msg_list_head) {
301 struct msg_list *ml = msg_list_head;
302 int n = write(msg_fd_out, ml->buf + written, ml->len - written);
306 if (errno != EWOULDBLOCK && errno != EAGAIN)
311 FD_SET(msg_fd_out, &fds);
312 tv.tv_sec = select_timeout;
314 if (!select(msg_fd_out+1, NULL, &fds, NULL, &tv))
316 } else if ((written += n) == ml->len) {
318 msg_list_head = ml->next;
320 msg_list_tail = NULL;
328 int get_redo_num(void)
330 struct redo_list *next;
333 while (!redo_list_head)
336 num = redo_list_head->num;
337 next = redo_list_head->next;
338 free(redo_list_head);
339 redo_list_head = next;
341 redo_list_tail = NULL;
347 * When we're the receiver and we have a local --files-from list of names
348 * that needs to be sent over the socket to the sender, we have to do two
349 * things at the same time: send the sender a list of what files we're
350 * processing and read the incoming file+info list from the sender. We do
351 * this by augmenting the read_timeout() function to copy this data. It
352 * uses the io_filesfrom_buf to read a block of data from f_in (when it is
353 * ready, since it might be a pipe) and then blast it out f_out (when it
354 * is ready to receive more data).
356 void io_set_filesfrom_fds(int f_in, int f_out)
358 io_filesfrom_f_in = f_in;
359 io_filesfrom_f_out = f_out;
360 io_filesfrom_bp = io_filesfrom_buf;
361 io_filesfrom_lastchar = '\0';
362 io_filesfrom_buflen = 0;
366 * It's almost always an error to get an EOF when we're trying to read
367 * from the network, because the protocol is self-terminating.
369 * However, there is one unfortunate cases where it is not, which is
370 * rsync <2.4.6 sending a list of modules on a server, since the list
371 * is terminated by closing the socket. So, for the section of the
372 * program where that is a problem (start_socket_client),
373 * kludge_around_eof is True and we just exit.
375 static void whine_about_eof(int fd)
377 if (kludge_around_eof && fd == sock_f_in)
380 rprintf(FERROR, RSYNC_NAME ": connection unexpectedly closed "
381 "(%.0f bytes received so far) [%s]\n",
382 (double)stats.total_read, who_am_i());
384 exit_cleanup(RERR_STREAMIO);
389 * Read from a socket with I/O timeout. return the number of bytes
390 * read. If no bytes can be read then exit, never return a number <= 0.
392 * TODO: If the remote shell connection fails, then current versions
393 * actually report an "unexpected EOF" error here. Since it's a
394 * fairly common mistake to try to use rsh when ssh is required, we
395 * should trap that: if we fail to read any data at all, we should
396 * give a better explanation. We can tell whether the connection has
397 * started by looking e.g. at whether the remote version is known yet.
399 static int read_timeout(int fd, char *buf, size_t len)
403 io_flush(NORMAL_FLUSH);
406 /* until we manage to read *something* */
415 if (msg_fd_in >= 0) {
416 FD_SET(msg_fd_in, &r_fds);
417 if (msg_fd_in > maxfd)
419 } else if (msg_list_head) {
420 FD_SET(msg_fd_out, &w_fds);
421 if (msg_fd_out > maxfd)
424 if (io_filesfrom_f_out >= 0) {
426 if (io_filesfrom_buflen == 0) {
427 if (io_filesfrom_f_in >= 0) {
428 FD_SET(io_filesfrom_f_in, &r_fds);
429 new_fd = io_filesfrom_f_in;
431 io_filesfrom_f_out = -1;
435 FD_SET(io_filesfrom_f_out, &w_fds);
436 new_fd = io_filesfrom_f_out;
442 tv.tv_sec = select_timeout;
447 count = select(maxfd + 1, &r_fds, &w_fds, NULL, &tv);
451 exit_cleanup(RERR_SOCKETIO);
456 if (msg_fd_in >= 0 && FD_ISSET(msg_fd_in, &r_fds))
458 else if (msg_list_head && FD_ISSET(msg_fd_out, &w_fds))
459 msg_list_push(NORMAL_FLUSH);
461 if (io_filesfrom_f_out >= 0) {
462 if (io_filesfrom_buflen) {
463 if (FD_ISSET(io_filesfrom_f_out, &w_fds)) {
464 int l = write(io_filesfrom_f_out,
466 io_filesfrom_buflen);
468 if (!(io_filesfrom_buflen -= l))
469 io_filesfrom_bp = io_filesfrom_buf;
471 io_filesfrom_bp += l;
473 /* XXX should we complain? */
474 io_filesfrom_f_out = -1;
477 } else if (io_filesfrom_f_in >= 0) {
478 if (FD_ISSET(io_filesfrom_f_in, &r_fds)) {
479 int l = read(io_filesfrom_f_in,
481 sizeof io_filesfrom_buf);
483 /* Send end-of-file marker */
484 io_filesfrom_buf[0] = '\0';
485 io_filesfrom_buf[1] = '\0';
486 io_filesfrom_buflen = io_filesfrom_lastchar? 2 : 1;
487 io_filesfrom_f_in = -1;
490 char *s = io_filesfrom_buf + l;
491 /* Transform CR and/or LF into '\0' */
492 while (s-- > io_filesfrom_buf) {
493 if (*s == '\n' || *s == '\r')
497 if (!io_filesfrom_lastchar) {
498 /* Last buf ended with a '\0', so don't
499 * let this buf start with one. */
500 while (l && !*io_filesfrom_bp)
501 io_filesfrom_bp++, l--;
504 io_filesfrom_bp = io_filesfrom_buf;
506 char *f = io_filesfrom_bp;
509 /* Eliminate any multi-'\0' runs. */
511 if (!(*t++ = *f++)) {
512 while (f != eob && !*f)
516 io_filesfrom_lastchar = f[-1];
518 io_filesfrom_buflen = l;
524 if (!FD_ISSET(fd, &r_fds))
527 n = read(fd, buf, len);
531 whine_about_eof(fd); /* Doesn't return. */
532 if (errno == EINTR || errno == EWOULDBLOCK
536 /* Don't write errors on a dead socket. */
538 close_multiplexing_out();
539 rsyserr(FERROR, errno, "read error");
540 exit_cleanup(RERR_STREAMIO);
547 if (io_timeout && fd == sock_f_in)
548 last_io = time(NULL);
555 * Read a line into the "fname" buffer (which must be at least MAXPATHLEN
558 int read_filesfrom_line(int fd, char *fname)
560 char ch, *s, *eob = fname + MAXPATHLEN - 1;
562 int reading_remotely = remote_filesfrom_file != NULL;
563 int nulls = eol_nulls || reading_remotely;
568 cnt = read(fd, &ch, 1);
569 if (cnt < 0 && (errno == EWOULDBLOCK
570 || errno == EINTR || errno == EAGAIN)) {
575 tv.tv_sec = select_timeout;
577 if (!select(fd+1, &fds, NULL, NULL, &tv))
583 if (nulls? !ch : (ch == '\r' || ch == '\n')) {
584 /* Skip empty lines if reading locally. */
585 if (!reading_remotely && s == fname)
595 if (*fname == '#' || *fname == ';')
602 static char *iobuf_out;
603 static int iobuf_out_cnt;
605 void io_start_buffering_out(void)
609 if (!(iobuf_out = new_array(char, IO_BUFFER_SIZE)))
610 out_of_memory("io_start_buffering_out");
615 static char *iobuf_in;
616 static size_t iobuf_in_siz;
618 void io_start_buffering_in(void)
622 iobuf_in_siz = 2 * IO_BUFFER_SIZE;
623 if (!(iobuf_in = new_array(char, iobuf_in_siz)))
624 out_of_memory("io_start_buffering_in");
628 void io_end_buffering(void)
630 io_flush(NORMAL_FLUSH);
631 if (!io_multiplexing_out) {
638 void maybe_send_keepalive(int allowed_lull, int ndx)
640 if (time(NULL) - last_io >= allowed_lull) {
641 if (!iobuf_out || !iobuf_out_cnt) {
642 if (protocol_version < 29)
643 return; /* there's nothing we can do */
644 write_int(sock_f_out, ndx);
645 write_shortint(sock_f_out, ITEM_IS_NEW);
648 io_flush(NORMAL_FLUSH);
654 * Continue trying to read len bytes - don't return until len has been
657 static void read_loop(int fd, char *buf, size_t len)
660 int n = read_timeout(fd, buf, len);
669 * Read from the file descriptor handling multiplexing - return number
672 * Never returns <= 0.
674 static int readfd_unbuffered(int fd, char *buf, size_t len)
676 static size_t remaining;
677 static size_t iobuf_in_ndx;
679 char line[MAXPATHLEN+1];
681 if (!iobuf_in || fd != sock_f_in)
682 return read_timeout(fd, buf, len);
684 if (!io_multiplexing_in && remaining == 0) {
685 remaining = read_timeout(fd, iobuf_in, iobuf_in_siz);
691 len = MIN(len, remaining);
692 memcpy(buf, iobuf_in + iobuf_in_ndx, len);
699 read_loop(fd, line, 4);
702 remaining = tag & 0xFFFFFF;
703 tag = (tag >> 24) - MPLEX_BASE;
707 if (remaining > iobuf_in_siz) {
708 if (!(iobuf_in = realloc_array(iobuf_in, char,
710 out_of_memory("readfd_unbuffered");
711 iobuf_in_siz = remaining;
713 read_loop(fd, iobuf_in, remaining);
717 if (remaining >= sizeof line) {
718 rprintf(FERROR, "invalid multi-message %d:%ld\n",
719 tag, (long)remaining);
720 exit_cleanup(RERR_STREAMIO);
722 read_loop(fd, line, remaining);
723 line[remaining] = '\0';
724 /* A directory name was sent with the trailing null */
725 if (remaining > 0 && !line[remaining-1])
726 log_delete(line, S_IFDIR);
728 log_delete(line, S_IFREG);
732 if (remaining != 4) {
733 rprintf(FERROR, "invalid multi-message %d:%ld\n",
734 tag, (long)remaining);
735 exit_cleanup(RERR_STREAMIO);
737 read_loop(fd, line, remaining);
738 successful_send(IVAL(line, 0));
743 if (remaining >= sizeof line) {
745 "[%s] multiplexing overflow %d:%ld\n\n",
746 who_am_i(), tag, (long)remaining);
747 exit_cleanup(RERR_STREAMIO);
749 read_loop(fd, line, remaining);
750 rwrite((enum logcode)tag, line, remaining);
754 rprintf(FERROR, "[%s] unexpected tag %d\n",
756 exit_cleanup(RERR_STREAMIO);
761 io_flush(NORMAL_FLUSH);
769 * Do a buffered read from @p fd. Don't return until all @p n bytes
770 * have been read. If all @p n can't be read then exit with an
773 static void readfd(int fd, char *buffer, size_t N)
779 ret = readfd_unbuffered(fd, buffer + total, N-total);
783 if (fd == write_batch_monitor_in) {
784 if ((size_t)write(batch_fd, buffer, total) != total)
785 exit_cleanup(RERR_FILEIO);
789 stats.total_read += total;
793 int read_shortint(int f)
796 readfd(f, (char *)b, 2);
797 return (b[1] << 8) + b[0];
801 int32 read_int(int f)
808 if (ret == (int32)0xffffffff)
813 int64 read_longint(int f)
819 if ((int32)ret != (int32)0xffffffff)
823 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
824 exit_cleanup(RERR_UNSUPPORTED);
827 ret = IVAL(b,0) | (((int64)IVAL(b,4))<<32);
833 void read_buf(int f,char *buf,size_t len)
838 void read_sbuf(int f,char *buf,size_t len)
844 uchar read_byte(int f)
847 readfd(f, (char *)&c, 1);
851 /* Populate a sum_struct with values from the socket. This is
852 * called by both the sender and the receiver. */
853 void read_sum_head(int f, struct sum_struct *sum)
855 sum->count = read_int(f);
856 sum->blength = read_int(f);
857 if (sum->blength < 0 || sum->blength > MAX_BLOCK_SIZE) {
858 rprintf(FERROR, "[%s] Invalid block length %ld\n",
859 who_am_i(), (long)sum->blength);
860 exit_cleanup(RERR_PROTOCOL);
862 sum->s2length = protocol_version < 27 ? csum_length : (int)read_int(f);
863 if (sum->s2length < 0 || sum->s2length > MD4_SUM_LENGTH) {
864 rprintf(FERROR, "[%s] Invalid checksum length %d\n",
865 who_am_i(), sum->s2length);
866 exit_cleanup(RERR_PROTOCOL);
868 sum->remainder = read_int(f);
869 if (sum->remainder < 0 || sum->remainder > sum->blength) {
870 rprintf(FERROR, "[%s] Invalid remainder length %ld\n",
871 who_am_i(), (long)sum->remainder);
872 exit_cleanup(RERR_PROTOCOL);
876 /* Send the values from a sum_struct over the socket. Set sum to
877 * NULL if there are no checksums to send. This is called by both
878 * the generator and the sender. */
879 void write_sum_head(int f, struct sum_struct *sum)
881 static struct sum_struct null_sum;
886 write_int(f, sum->count);
887 write_int(f, sum->blength);
888 if (protocol_version >= 27)
889 write_int(f, sum->s2length);
890 write_int(f, sum->remainder);
895 * Sleep after writing to limit I/O bandwidth usage.
897 * @todo Rather than sleeping after each write, it might be better to
898 * use some kind of averaging. The current algorithm seems to always
899 * use a bit less bandwidth than specified, because it doesn't make up
900 * for slow periods. But arguably this is a feature. In addition, we
901 * ought to take the time used to write the data into account.
903 * During some phases of big transfers (file FOO is uptodate) this is
904 * called with a small bytes_written every time. As the kernel has to
905 * round small waits up to guarantee that we actually wait at least the
906 * requested number of microseconds, this can become grossly inaccurate.
907 * We therefore keep track of the bytes we've written over time and only
908 * sleep when the accumulated delay is at least 1 tenth of a second.
910 static void sleep_for_bwlimit(int bytes_written)
912 static struct timeval prior_tv;
913 static long total_written = 0;
914 struct timeval tv, start_tv;
915 long elapsed_usec, sleep_usec;
917 #define ONE_SEC 1000000L /* # of microseconds in a second */
922 total_written += bytes_written;
924 gettimeofday(&start_tv, NULL);
925 if (prior_tv.tv_sec) {
926 elapsed_usec = (start_tv.tv_sec - prior_tv.tv_sec) * ONE_SEC
927 + (start_tv.tv_usec - prior_tv.tv_usec);
928 total_written -= elapsed_usec * bwlimit / (ONE_SEC/1024);
929 if (total_written < 0)
933 sleep_usec = total_written * (ONE_SEC/1024) / bwlimit;
934 if (sleep_usec < ONE_SEC / 10) {
939 tv.tv_sec = sleep_usec / ONE_SEC;
940 tv.tv_usec = sleep_usec % ONE_SEC;
941 select(0, NULL, NULL, NULL, &tv);
943 gettimeofday(&prior_tv, NULL);
944 elapsed_usec = (prior_tv.tv_sec - start_tv.tv_sec) * ONE_SEC
945 + (prior_tv.tv_usec - start_tv.tv_usec);
946 total_written = (sleep_usec - elapsed_usec) * bwlimit / (ONE_SEC/1024);
950 /* Write len bytes to the file descriptor fd, looping as necessary to get
951 * the job done and also (in the generator) reading any data on msg_fd_in
952 * (to avoid deadlock).
954 * This function underlies the multiplexing system. The body of the
955 * application never calls this function directly. */
956 static void writefd_unbuffered(int fd,char *buf,size_t len)
960 int maxfd, count, ret;
965 while (total < len) {
970 if (msg_fd_in >= 0) {
972 FD_SET(msg_fd_in,&r_fds);
973 if (msg_fd_in > maxfd)
976 if (fd != sock_f_out && iobuf_out_cnt && no_flush == 1) {
977 FD_SET(sock_f_out, &w_fds);
978 if (sock_f_out > maxfd)
982 tv.tv_sec = select_timeout;
986 count = select(maxfd + 1, msg_fd_in >= 0 ? &r_fds : NULL,
990 if (count < 0 && errno == EBADF)
991 exit_cleanup(RERR_SOCKETIO);
996 if (msg_fd_in >= 0 && FD_ISSET(msg_fd_in, &r_fds))
999 if (!FD_ISSET(fd, &w_fds)) {
1000 if (fd != sock_f_out && iobuf_out_cnt) {
1002 io_flush(NORMAL_FLUSH);
1009 if (bwlimit && n > bwlimit_writemax)
1010 n = bwlimit_writemax;
1011 ret = write(fd, buf + total, n);
1017 if (errno == EWOULDBLOCK || errno == EAGAIN) {
1023 /* Don't try to write errors back across the stream. */
1024 if (fd == sock_f_out)
1025 close_multiplexing_out();
1026 rsyserr(FERROR, errno,
1027 "writefd_unbuffered failed to write %ld bytes: phase \"%s\" [%s]",
1028 (long)len, io_write_phase, who_am_i());
1029 /* If the other side is sending us error messages, try
1030 * to grab any messages they sent before they died. */
1031 while (fd == sock_f_out && io_multiplexing_in) {
1032 io_timeout = select_timeout = 30;
1034 readfd_unbuffered(sock_f_in, io_filesfrom_buf,
1035 sizeof io_filesfrom_buf);
1037 exit_cleanup(RERR_STREAMIO);
1042 if (fd == sock_f_out) {
1044 last_io = time(NULL);
1045 sleep_for_bwlimit(ret);
1054 * Write an message to a multiplexed stream. If this fails then rsync
1057 static void mplex_write(enum msgcode code, char *buf, size_t len)
1062 SIVAL(buffer, 0, ((MPLEX_BASE + (int)code)<<24) + len);
1064 if (n > sizeof buffer - 4)
1065 n = sizeof buffer - 4;
1067 memcpy(&buffer[4], buf, n);
1068 writefd_unbuffered(sock_f_out, buffer, n+4);
1074 writefd_unbuffered(sock_f_out, buf, len);
1078 void io_flush(int flush_it_all)
1080 msg_list_push(flush_it_all);
1082 if (!iobuf_out_cnt || no_flush)
1085 if (io_multiplexing_out)
1086 mplex_write(MSG_DATA, iobuf_out, iobuf_out_cnt);
1088 writefd_unbuffered(sock_f_out, iobuf_out, iobuf_out_cnt);
1093 static void writefd(int fd,char *buf,size_t len)
1095 if (fd == msg_fd_out) {
1096 rprintf(FERROR, "Internal error: wrong write used in receiver.\n");
1097 exit_cleanup(RERR_PROTOCOL);
1100 if (fd == sock_f_out)
1101 stats.total_written += len;
1103 if (fd == write_batch_monitor_out) {
1104 if ((size_t)write(batch_fd, buf, len) != len)
1105 exit_cleanup(RERR_FILEIO);
1108 if (!iobuf_out || fd != sock_f_out) {
1109 writefd_unbuffered(fd, buf, len);
1114 int n = MIN((int)len, IO_BUFFER_SIZE - iobuf_out_cnt);
1116 memcpy(iobuf_out+iobuf_out_cnt, buf, n);
1122 if (iobuf_out_cnt == IO_BUFFER_SIZE)
1123 io_flush(NORMAL_FLUSH);
1128 void write_shortint(int f, int x)
1133 writefd(f, (char *)b, 2);
1137 void write_int(int f,int32 x)
1145 void write_int_named(int f, int32 x, const char *phase)
1147 io_write_phase = phase;
1149 io_write_phase = phase_unknown;
1154 * Note: int64 may actually be a 32-bit type if ./configure couldn't find any
1155 * 64-bit types on this platform.
1157 void write_longint(int f, int64 x)
1161 if (x <= 0x7FFFFFFF) {
1162 write_int(f, (int)x);
1166 #if SIZEOF_INT64 < 8
1167 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1168 exit_cleanup(RERR_UNSUPPORTED);
1170 write_int(f, (int32)0xFFFFFFFF);
1171 SIVAL(b,0,(x&0xFFFFFFFF));
1172 SIVAL(b,4,((x>>32)&0xFFFFFFFF));
1178 void write_buf(int f,char *buf,size_t len)
1184 /** Write a string to the connection */
1185 void write_sbuf(int f, char *buf)
1187 writefd(f, buf, strlen(buf));
1191 void write_byte(int f, uchar c)
1193 writefd(f, (char *)&c, 1);
1198 * Read a line of up to @p maxlen characters into @p buf (not counting
1199 * the trailing null). Strips the (required) trailing newline and all
1202 * @return 1 for success; 0 for I/O error or truncation.
1204 int read_line(int f, char *buf, size_t maxlen)
1208 read_buf(f, buf, 1);
1213 if (buf[0] != '\r') {
1223 void io_printf(int fd, const char *format, ...)
1229 va_start(ap, format);
1230 len = vsnprintf(buf, sizeof buf, format, ap);
1234 exit_cleanup(RERR_STREAMIO);
1236 write_sbuf(fd, buf);
1240 /** Setup for multiplexing a MSG_* stream with the data stream. */
1241 void io_start_multiplex_out(void)
1243 io_flush(NORMAL_FLUSH);
1244 io_start_buffering_out();
1245 io_multiplexing_out = 1;
1248 /** Setup for multiplexing a MSG_* stream with the data stream. */
1249 void io_start_multiplex_in(void)
1251 io_flush(NORMAL_FLUSH);
1252 io_start_buffering_in();
1253 io_multiplexing_in = 1;
1256 /** Write an message to the multiplexed data stream. */
1257 int io_multiplex_write(enum msgcode code, char *buf, size_t len)
1259 if (!io_multiplexing_out)
1262 io_flush(NORMAL_FLUSH);
1263 stats.total_written += (len+4);
1264 mplex_write(code, buf, len);
1268 void close_multiplexing_in(void)
1270 io_multiplexing_in = 0;
1273 /** Stop output multiplexing. */
1274 void close_multiplexing_out(void)
1276 io_multiplexing_out = 0;
1279 void start_write_batch(int fd)
1281 write_stream_flags(batch_fd);
1283 /* Some communication has already taken place, but we don't
1284 * enable batch writing until here so that we can write a
1285 * canonical record of the communication even though the
1286 * actual communication so far depends on whether a daemon
1288 write_int(batch_fd, protocol_version);
1289 write_int(batch_fd, checksum_seed);
1292 write_batch_monitor_out = fd;
1294 write_batch_monitor_in = fd;
1297 void stop_write_batch(void)
1299 write_batch_monitor_out = -1;
1300 write_batch_monitor_in = -1;