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;
60 int batch_gen_fd = -1;
63 * The connection might be dropped at some point; perhaps because the
64 * remote instance crashed. Just giving the offset on the stream is
65 * not very helpful. So instead we try to make io_phase_name point to
68 * For buffered/multiplexed I/O these names will be somewhat
69 * approximate; perhaps for ease of support we would rather make the
70 * buffer always flush when a single application-level I/O finishes.
72 * @todo Perhaps we want some simple stack functionality, but there's
73 * no need to overdo it.
75 const char *io_write_phase = phase_unknown;
76 const char *io_read_phase = phase_unknown;
78 /** Ignore EOF errors while reading a module listing if the remote
79 version is 24 or less. */
80 int kludge_around_eof = False;
85 static int io_multiplexing_out;
86 static int io_multiplexing_in;
87 static int sock_f_in = -1;
88 static int sock_f_out = -1;
89 static time_t last_io;
92 static int write_batch_monitor_in = -1;
93 static int write_batch_monitor_out = -1;
95 static int io_filesfrom_f_in = -1;
96 static int io_filesfrom_f_out = -1;
97 static char io_filesfrom_buf[2048];
98 static char *io_filesfrom_bp;
99 static char io_filesfrom_lastchar;
100 static int io_filesfrom_buflen;
102 static void read_loop(int fd, char *buf, size_t len);
105 struct redo_list *next;
109 static struct redo_list *redo_list_head;
110 static struct redo_list *redo_list_tail;
113 struct msg_list *next;
118 static struct msg_list *msg_list_head;
119 static struct msg_list *msg_list_tail;
121 static void redo_list_add(int num)
123 struct redo_list *rl;
125 if (!(rl = new(struct redo_list)))
126 exit_cleanup(RERR_MALLOC);
130 redo_list_tail->next = rl;
136 static void check_timeout(void)
144 last_io = time(NULL);
150 if (t - last_io >= io_timeout) {
151 if (!am_server && !am_daemon) {
152 rprintf(FERROR, "io timeout after %d seconds -- exiting\n",
155 exit_cleanup(RERR_TIMEOUT);
159 /* Note the fds used for the main socket (which might really be a pipe
160 * for a local transfer, but we can ignore that). */
161 void io_set_sock_fds(int f_in, int f_out)
167 /* Setup the fd used to receive MSG_* messages. Only needed during the
168 * early stages of being a local sender (up through the sending of the
169 * file list) or when we're the generator (to fetch the messages from
171 void set_msg_fd_in(int fd)
176 /* Setup the fd used to send our MSG_* messages. Only needed when
177 * we're the receiver (to send our messages to the generator). */
178 void set_msg_fd_out(int fd)
181 set_nonblocking(msg_fd_out);
184 /* Add a message to the pending MSG_* list. */
185 static void msg_list_add(int code, char *buf, int len)
189 if (!(ml = new(struct msg_list)))
190 exit_cleanup(RERR_MALLOC);
192 if (!(ml->buf = new_array(char, len+4)))
193 exit_cleanup(RERR_MALLOC);
194 SIVAL(ml->buf, 0, ((code+MPLEX_BASE)<<24) | len);
195 memcpy(ml->buf+4, buf, len);
198 msg_list_tail->next = ml;
204 void send_msg(enum msgcode code, char *buf, int len)
206 if (msg_fd_out < 0) {
207 io_multiplex_write(code, buf, len);
210 msg_list_add(code, buf, len);
211 msg_list_push(NORMAL_FLUSH);
214 /* Read a message from the MSG_* fd and handle it. This is called either
215 * during the early stages of being a local sender (up through the sending
216 * of the file list) or when we're the generator (to fetch the messages
217 * from the receiver). */
218 static void read_msg_fd(void)
225 /* Temporarily disable msg_fd_in. This is needed to avoid looping back
226 * to this routine from read_timeout() and writefd_unbuffered(). */
229 read_loop(fd, buf, 4);
232 len = tag & 0xFFFFFF;
233 tag = (tag >> 24) - MPLEX_BASE;
237 if (len != 0 || !am_generator) {
238 rprintf(FERROR, "invalid message %d:%d\n", tag, len);
239 exit_cleanup(RERR_STREAMIO);
244 if (len != 4 || !am_generator) {
245 rprintf(FERROR, "invalid message %d:%d\n", tag, len);
246 exit_cleanup(RERR_STREAMIO);
248 read_loop(fd, buf, 4);
249 redo_list_add(IVAL(buf,0));
252 if (len >= (int)sizeof buf || !am_generator) {
253 rprintf(FERROR, "invalid message %d:%d\n", tag, len);
254 exit_cleanup(RERR_STREAMIO);
256 read_loop(fd, buf, len);
257 io_multiplex_write(MSG_DELETED, buf, len);
266 read_loop(fd, buf, n);
267 rwrite((enum logcode)tag, buf, n);
272 rprintf(FERROR, "unknown message %d:%d\n", tag, len);
273 exit_cleanup(RERR_STREAMIO);
279 /* Try to push messages off the list onto the wire. If we leave with more
280 * to do, return 0. On error, return -1. If everything flushed, return 1.
281 * This is only active in the receiver. */
282 int msg_list_push(int flush_it_all)
284 static int written = 0;
291 while (msg_list_head) {
292 struct msg_list *ml = msg_list_head;
293 int n = write(msg_fd_out, ml->buf + written, ml->len - written);
297 if (errno != EWOULDBLOCK && errno != EAGAIN)
302 FD_SET(msg_fd_out, &fds);
303 tv.tv_sec = select_timeout;
305 if (!select(msg_fd_out+1, NULL, &fds, NULL, &tv))
307 } else if ((written += n) == ml->len) {
309 msg_list_head = ml->next;
311 msg_list_tail = NULL;
319 int get_redo_num(void)
321 struct redo_list *next;
324 while (!redo_list_head)
327 num = redo_list_head->num;
328 next = redo_list_head->next;
329 free(redo_list_head);
330 redo_list_head = next;
332 redo_list_tail = NULL;
338 * When we're the receiver and we have a local --files-from list of names
339 * that needs to be sent over the socket to the sender, we have to do two
340 * things at the same time: send the sender a list of what files we're
341 * processing and read the incoming file+info list from the sender. We do
342 * this by augmenting the read_timeout() function to copy this data. It
343 * uses the io_filesfrom_buf to read a block of data from f_in (when it is
344 * ready, since it might be a pipe) and then blast it out f_out (when it
345 * is ready to receive more data).
347 void io_set_filesfrom_fds(int f_in, int f_out)
349 io_filesfrom_f_in = f_in;
350 io_filesfrom_f_out = f_out;
351 io_filesfrom_bp = io_filesfrom_buf;
352 io_filesfrom_lastchar = '\0';
353 io_filesfrom_buflen = 0;
357 * It's almost always an error to get an EOF when we're trying to read
358 * from the network, because the protocol is self-terminating.
360 * However, there is one unfortunate cases where it is not, which is
361 * rsync <2.4.6 sending a list of modules on a server, since the list
362 * is terminated by closing the socket. So, for the section of the
363 * program where that is a problem (start_socket_client),
364 * kludge_around_eof is True and we just exit.
366 static void whine_about_eof(int fd)
368 if (kludge_around_eof && fd == sock_f_in)
371 rprintf(FERROR, RSYNC_NAME ": connection unexpectedly closed "
372 "(%.0f bytes received so far) [%s]\n",
373 (double)stats.total_read, who_am_i());
375 exit_cleanup(RERR_STREAMIO);
380 * Read from a socket with I/O timeout. return the number of bytes
381 * read. If no bytes can be read then exit, never return a number <= 0.
383 * TODO: If the remote shell connection fails, then current versions
384 * actually report an "unexpected EOF" error here. Since it's a
385 * fairly common mistake to try to use rsh when ssh is required, we
386 * should trap that: if we fail to read any data at all, we should
387 * give a better explanation. We can tell whether the connection has
388 * started by looking e.g. at whether the remote version is known yet.
390 static int read_timeout(int fd, char *buf, size_t len)
394 io_flush(NORMAL_FLUSH);
397 /* until we manage to read *something* */
406 if (msg_fd_in >= 0) {
407 FD_SET(msg_fd_in, &r_fds);
408 if (msg_fd_in > maxfd)
410 } else if (msg_list_head) {
411 FD_SET(msg_fd_out, &w_fds);
412 if (msg_fd_out > maxfd)
415 if (io_filesfrom_f_out >= 0) {
417 if (io_filesfrom_buflen == 0) {
418 if (io_filesfrom_f_in >= 0) {
419 FD_SET(io_filesfrom_f_in, &r_fds);
420 new_fd = io_filesfrom_f_in;
422 io_filesfrom_f_out = -1;
426 FD_SET(io_filesfrom_f_out, &w_fds);
427 new_fd = io_filesfrom_f_out;
433 tv.tv_sec = select_timeout;
438 count = select(maxfd + 1, &r_fds, &w_fds, NULL, &tv);
442 exit_cleanup(RERR_SOCKETIO);
447 if (msg_fd_in >= 0 && FD_ISSET(msg_fd_in, &r_fds))
449 else if (msg_list_head && FD_ISSET(msg_fd_out, &w_fds))
450 msg_list_push(NORMAL_FLUSH);
452 if (io_filesfrom_f_out >= 0) {
453 if (io_filesfrom_buflen) {
454 if (FD_ISSET(io_filesfrom_f_out, &w_fds)) {
455 int l = write(io_filesfrom_f_out,
457 io_filesfrom_buflen);
459 if (!(io_filesfrom_buflen -= l))
460 io_filesfrom_bp = io_filesfrom_buf;
462 io_filesfrom_bp += l;
464 /* XXX should we complain? */
465 io_filesfrom_f_out = -1;
468 } else if (io_filesfrom_f_in >= 0) {
469 if (FD_ISSET(io_filesfrom_f_in, &r_fds)) {
470 int l = read(io_filesfrom_f_in,
472 sizeof io_filesfrom_buf);
474 /* Send end-of-file marker */
475 io_filesfrom_buf[0] = '\0';
476 io_filesfrom_buf[1] = '\0';
477 io_filesfrom_buflen = io_filesfrom_lastchar? 2 : 1;
478 io_filesfrom_f_in = -1;
481 char *s = io_filesfrom_buf + l;
482 /* Transform CR and/or LF into '\0' */
483 while (s-- > io_filesfrom_buf) {
484 if (*s == '\n' || *s == '\r')
488 if (!io_filesfrom_lastchar) {
489 /* Last buf ended with a '\0', so don't
490 * let this buf start with one. */
491 while (l && !*io_filesfrom_bp)
492 io_filesfrom_bp++, l--;
495 io_filesfrom_bp = io_filesfrom_buf;
497 char *f = io_filesfrom_bp;
500 /* Eliminate any multi-'\0' runs. */
502 if (!(*t++ = *f++)) {
503 while (f != eob && !*f)
507 io_filesfrom_lastchar = f[-1];
509 io_filesfrom_buflen = l;
515 if (!FD_ISSET(fd, &r_fds))
518 n = read(fd, buf, len);
522 whine_about_eof(fd); /* Doesn't return. */
523 if (errno == EINTR || errno == EWOULDBLOCK
527 /* Don't write errors on a dead socket. */
529 close_multiplexing_out();
530 rsyserr(FERROR, errno, "read error");
531 exit_cleanup(RERR_STREAMIO);
538 if (io_timeout && fd == sock_f_in)
539 last_io = time(NULL);
546 * Read a line into the "fname" buffer (which must be at least MAXPATHLEN
549 int read_filesfrom_line(int fd, char *fname)
551 char ch, *s, *eob = fname + MAXPATHLEN - 1;
553 int reading_remotely = remote_filesfrom_file != NULL;
554 int nulls = eol_nulls || reading_remotely;
559 cnt = read(fd, &ch, 1);
560 if (cnt < 0 && (errno == EWOULDBLOCK
561 || errno == EINTR || errno == EAGAIN)) {
566 tv.tv_sec = select_timeout;
568 if (!select(fd+1, &fds, NULL, NULL, &tv))
574 if (nulls? !ch : (ch == '\r' || ch == '\n')) {
575 /* Skip empty lines if reading locally. */
576 if (!reading_remotely && s == fname)
586 if (*fname == '#' || *fname == ';')
593 static char *iobuf_out;
594 static int iobuf_out_cnt;
596 void io_start_buffering_out(void)
600 if (!(iobuf_out = new_array(char, IO_BUFFER_SIZE)))
601 out_of_memory("io_start_buffering_out");
606 static char *iobuf_in;
607 static size_t iobuf_in_siz;
609 void io_start_buffering_in(void)
613 iobuf_in_siz = 2 * IO_BUFFER_SIZE;
614 if (!(iobuf_in = new_array(char, iobuf_in_siz)))
615 out_of_memory("io_start_buffering_in");
619 void io_end_buffering(void)
621 io_flush(NORMAL_FLUSH);
622 if (!io_multiplexing_out) {
630 * Continue trying to read len bytes - don't return until len has been
633 static void read_loop(int fd, char *buf, size_t len)
636 int n = read_timeout(fd, buf, len);
645 * Read from the file descriptor handling multiplexing - return number
648 * Never returns <= 0.
650 static int readfd_unbuffered(int fd, char *buf, size_t len)
652 static size_t remaining;
653 static size_t iobuf_in_ndx;
655 char line[MAXPATHLEN+1];
657 if (!iobuf_in || fd != sock_f_in)
658 return read_timeout(fd, buf, len);
660 if (!io_multiplexing_in && remaining == 0) {
661 remaining = read_timeout(fd, iobuf_in, iobuf_in_siz);
667 len = MIN(len, remaining);
668 memcpy(buf, iobuf_in + iobuf_in_ndx, len);
675 read_loop(fd, line, 4);
678 remaining = tag & 0xFFFFFF;
679 tag = (tag >> 24) - MPLEX_BASE;
683 if (remaining > iobuf_in_siz) {
684 if (!(iobuf_in = realloc_array(iobuf_in, char,
686 out_of_memory("readfd_unbuffered");
687 iobuf_in_siz = remaining;
689 read_loop(fd, iobuf_in, remaining);
693 if (remaining >= sizeof line) {
694 rprintf(FERROR, "invalid multi-message %d:%ld\n",
695 tag, (long)remaining);
696 exit_cleanup(RERR_STREAMIO);
698 read_loop(fd, line, remaining);
699 line[remaining] = '\0';
700 /* A directory name was sent with the trailing null */
701 if (remaining > 0 && !line[remaining-1])
702 log_delete(line, S_IFDIR);
704 log_delete(line, S_IFREG);
709 if (remaining >= sizeof line) {
711 "[%s] multiplexing overflow %d:%ld\n\n",
712 who_am_i(), tag, (long)remaining);
713 exit_cleanup(RERR_STREAMIO);
715 read_loop(fd, line, remaining);
716 rwrite((enum logcode)tag, line, remaining);
720 rprintf(FERROR, "[%s] unexpected tag %d\n",
722 exit_cleanup(RERR_STREAMIO);
727 io_flush(NORMAL_FLUSH);
735 * Do a buffered read from @p fd. Don't return until all @p n bytes
736 * have been read. If all @p n can't be read then exit with an
739 static void readfd(int fd, char *buffer, size_t N)
745 ret = readfd_unbuffered(fd, buffer + total, N-total);
749 if (fd == write_batch_monitor_in) {
750 if ((size_t)write(batch_fd, buffer, total) != total)
751 exit_cleanup(RERR_FILEIO);
755 stats.total_read += total;
759 int read_shortint(int f)
762 readfd(f, (char *)b, 2);
763 return (b[1] << 8) + b[0];
767 int32 read_int(int f)
774 if (ret == (int32)0xffffffff)
779 int64 read_longint(int f)
785 if ((int32)ret != (int32)0xffffffff)
789 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
790 exit_cleanup(RERR_UNSUPPORTED);
793 ret = IVAL(b,0) | (((int64)IVAL(b,4))<<32);
799 void read_buf(int f,char *buf,size_t len)
804 void read_sbuf(int f,char *buf,size_t len)
810 uchar read_byte(int f)
813 readfd(f, (char *)&c, 1);
817 /* Populate a sum_struct with values from the socket. This is
818 * called by both the sender and the receiver. */
819 void read_sum_head(int f, struct sum_struct *sum)
821 sum->count = read_int(f);
822 sum->blength = read_int(f);
823 if (sum->blength < 0 || sum->blength > MAX_BLOCK_SIZE) {
824 rprintf(FERROR, "[%s] Invalid block length %ld\n",
825 who_am_i(), (long)sum->blength);
826 exit_cleanup(RERR_PROTOCOL);
828 sum->s2length = protocol_version < 27 ? csum_length : (int)read_int(f);
829 if (sum->s2length < 0 || sum->s2length > MD4_SUM_LENGTH) {
830 rprintf(FERROR, "[%s] Invalid checksum length %d\n",
831 who_am_i(), sum->s2length);
832 exit_cleanup(RERR_PROTOCOL);
834 sum->remainder = read_int(f);
835 if (sum->remainder < 0 || sum->remainder > sum->blength) {
836 rprintf(FERROR, "[%s] Invalid remainder length %ld\n",
837 who_am_i(), (long)sum->remainder);
838 exit_cleanup(RERR_PROTOCOL);
842 /* Send the values from a sum_struct over the socket. Set sum to
843 * NULL if there are no checksums to send. This is called by both
844 * the generator and the sender. */
845 void write_sum_head(int f, struct sum_struct *sum)
847 static struct sum_struct null_sum;
852 write_int(f, sum->count);
853 write_int(f, sum->blength);
854 if (protocol_version >= 27)
855 write_int(f, sum->s2length);
856 write_int(f, sum->remainder);
861 * Sleep after writing to limit I/O bandwidth usage.
863 * @todo Rather than sleeping after each write, it might be better to
864 * use some kind of averaging. The current algorithm seems to always
865 * use a bit less bandwidth than specified, because it doesn't make up
866 * for slow periods. But arguably this is a feature. In addition, we
867 * ought to take the time used to write the data into account.
869 * During some phases of big transfers (file FOO is uptodate) this is
870 * called with a small bytes_written every time. As the kernel has to
871 * round small waits up to guarantee that we actually wait at least the
872 * requested number of microseconds, this can become grossly inaccurate.
873 * We therefore keep track of the bytes we've written over time and only
874 * sleep when the accumulated delay is at least 1 tenth of a second.
876 static void sleep_for_bwlimit(int bytes_written)
878 static struct timeval prior_tv;
879 static long total_written = 0;
880 struct timeval tv, start_tv;
881 long elapsed_usec, sleep_usec;
883 #define ONE_SEC 1000000L /* # of microseconds in a second */
888 total_written += bytes_written;
890 gettimeofday(&start_tv, NULL);
891 if (prior_tv.tv_sec) {
892 elapsed_usec = (start_tv.tv_sec - prior_tv.tv_sec) * ONE_SEC
893 + (start_tv.tv_usec - prior_tv.tv_usec);
894 total_written -= elapsed_usec * bwlimit / (ONE_SEC/1024);
895 if (total_written < 0)
899 sleep_usec = total_written * (ONE_SEC/1024) / bwlimit;
900 if (sleep_usec < ONE_SEC / 10) {
905 tv.tv_sec = sleep_usec / ONE_SEC;
906 tv.tv_usec = sleep_usec % ONE_SEC;
907 select(0, NULL, NULL, NULL, &tv);
909 gettimeofday(&prior_tv, NULL);
910 elapsed_usec = (prior_tv.tv_sec - start_tv.tv_sec) * ONE_SEC
911 + (prior_tv.tv_usec - start_tv.tv_usec);
912 total_written = (sleep_usec - elapsed_usec) * bwlimit / (ONE_SEC/1024);
916 /* Write len bytes to the file descriptor fd, looping as necessary to get
917 * the job done and also (in the generator) reading any data on msg_fd_in
918 * (to avoid deadlock).
920 * This function underlies the multiplexing system. The body of the
921 * application never calls this function directly. */
922 static void writefd_unbuffered(int fd,char *buf,size_t len)
926 int maxfd, count, ret;
931 while (total < len) {
936 if (msg_fd_in >= 0) {
938 FD_SET(msg_fd_in,&r_fds);
939 if (msg_fd_in > maxfd)
942 if (fd != sock_f_out && iobuf_out_cnt && no_flush == 1) {
943 FD_SET(sock_f_out, &w_fds);
944 if (sock_f_out > maxfd)
948 tv.tv_sec = select_timeout;
952 count = select(maxfd + 1, msg_fd_in >= 0 ? &r_fds : NULL,
956 if (count < 0 && errno == EBADF)
957 exit_cleanup(RERR_SOCKETIO);
962 if (msg_fd_in >= 0 && FD_ISSET(msg_fd_in, &r_fds))
965 if (!FD_ISSET(fd, &w_fds)) {
966 if (fd != sock_f_out && iobuf_out_cnt) {
968 io_flush(NORMAL_FLUSH);
975 if (bwlimit && n > bwlimit_writemax)
976 n = bwlimit_writemax;
977 ret = write(fd, buf + total, n);
983 if (errno == EWOULDBLOCK || errno == EAGAIN) {
989 /* Don't try to write errors back across the stream. */
990 if (fd == sock_f_out)
991 close_multiplexing_out();
992 rsyserr(FERROR, errno,
993 "writefd_unbuffered failed to write %ld bytes: phase \"%s\" [%s]",
994 (long)len, io_write_phase, who_am_i());
995 /* If the other side is sending us error messages, try
996 * to grab any messages they sent before they died. */
997 while (fd == sock_f_out && io_multiplexing_in) {
998 io_timeout = select_timeout = 30;
999 readfd_unbuffered(sock_f_in, io_filesfrom_buf,
1000 sizeof io_filesfrom_buf);
1002 exit_cleanup(RERR_STREAMIO);
1007 if (fd == sock_f_out) {
1009 last_io = time(NULL);
1010 sleep_for_bwlimit(ret);
1019 * Write an message to a multiplexed stream. If this fails then rsync
1022 static void mplex_write(enum msgcode code, char *buf, size_t len)
1027 SIVAL(buffer, 0, ((MPLEX_BASE + (int)code)<<24) + len);
1029 if (n > sizeof buffer - 4)
1030 n = sizeof buffer - 4;
1032 memcpy(&buffer[4], buf, n);
1033 writefd_unbuffered(sock_f_out, buffer, n+4);
1039 writefd_unbuffered(sock_f_out, buf, len);
1043 void io_flush(int flush_it_all)
1045 msg_list_push(flush_it_all);
1047 if (!iobuf_out_cnt || no_flush)
1050 if (io_multiplexing_out)
1051 mplex_write(MSG_DATA, iobuf_out, iobuf_out_cnt);
1053 writefd_unbuffered(sock_f_out, iobuf_out, iobuf_out_cnt);
1058 static void writefd(int fd,char *buf,size_t len)
1060 if (fd == msg_fd_out) {
1061 rprintf(FERROR, "Internal error: wrong write used in receiver.\n");
1062 exit_cleanup(RERR_PROTOCOL);
1065 if (fd == sock_f_out)
1066 stats.total_written += len;
1068 if (fd == write_batch_monitor_out) {
1069 if ((size_t)write(batch_fd, buf, len) != len)
1070 exit_cleanup(RERR_FILEIO);
1073 if (!iobuf_out || fd != sock_f_out) {
1074 writefd_unbuffered(fd, buf, len);
1079 int n = MIN((int)len, IO_BUFFER_SIZE - iobuf_out_cnt);
1081 memcpy(iobuf_out+iobuf_out_cnt, buf, n);
1087 if (iobuf_out_cnt == IO_BUFFER_SIZE)
1088 io_flush(NORMAL_FLUSH);
1093 void write_shortint(int f, int x)
1098 writefd(f, (char *)b, 2);
1102 void write_int(int f,int32 x)
1110 void write_int_named(int f, int32 x, const char *phase)
1112 io_write_phase = phase;
1114 io_write_phase = phase_unknown;
1119 * Note: int64 may actually be a 32-bit type if ./configure couldn't find any
1120 * 64-bit types on this platform.
1122 void write_longint(int f, int64 x)
1126 if (x <= 0x7FFFFFFF) {
1127 write_int(f, (int)x);
1131 #if SIZEOF_INT64 < 8
1132 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1133 exit_cleanup(RERR_UNSUPPORTED);
1135 write_int(f, (int32)0xFFFFFFFF);
1136 SIVAL(b,0,(x&0xFFFFFFFF));
1137 SIVAL(b,4,((x>>32)&0xFFFFFFFF));
1143 void write_buf(int f,char *buf,size_t len)
1149 /** Write a string to the connection */
1150 void write_sbuf(int f, char *buf)
1152 writefd(f, buf, strlen(buf));
1156 void write_byte(int f, uchar c)
1158 writefd(f, (char *)&c, 1);
1163 * Read a line of up to @p maxlen characters into @p buf (not counting
1164 * the trailing null). Strips the (required) trailing newline and all
1167 * @return 1 for success; 0 for I/O error or truncation.
1169 int read_line(int f, char *buf, size_t maxlen)
1173 read_buf(f, buf, 1);
1178 if (buf[0] != '\r') {
1188 void io_printf(int fd, const char *format, ...)
1194 va_start(ap, format);
1195 len = vsnprintf(buf, sizeof buf, format, ap);
1199 exit_cleanup(RERR_STREAMIO);
1201 write_sbuf(fd, buf);
1205 /** Setup for multiplexing a MSG_* stream with the data stream. */
1206 void io_start_multiplex_out(void)
1208 io_flush(NORMAL_FLUSH);
1209 io_start_buffering_out();
1210 io_multiplexing_out = 1;
1213 /** Setup for multiplexing a MSG_* stream with the data stream. */
1214 void io_start_multiplex_in(void)
1216 io_flush(NORMAL_FLUSH);
1217 io_start_buffering_in();
1218 io_multiplexing_in = 1;
1221 /** Write an message to the multiplexed data stream. */
1222 int io_multiplex_write(enum msgcode code, char *buf, size_t len)
1224 if (!io_multiplexing_out)
1227 io_flush(NORMAL_FLUSH);
1228 stats.total_written += (len+4);
1229 mplex_write(code, buf, len);
1233 void close_multiplexing_in(void)
1235 io_multiplexing_in = 0;
1238 /** Stop output multiplexing. */
1239 void close_multiplexing_out(void)
1241 io_multiplexing_out = 0;
1244 void start_write_batch(int fd)
1246 write_stream_flags(batch_fd);
1248 /* Some communication has already taken place, but we don't
1249 * enable batch writing until here so that we can write a
1250 * canonical record of the communication even though the
1251 * actual communication so far depends on whether a daemon
1253 write_int(batch_fd, protocol_version);
1254 write_int(batch_fd, checksum_seed);
1257 write_batch_monitor_out = fd;
1259 write_batch_monitor_in = fd;
1262 void stop_write_batch(void)
1264 write_batch_monitor_out = -1;
1265 write_batch_monitor_in = -1;