Improve the timeout messages.
[rsync/rsync.git] / io.c
CommitLineData
0f78b815
WD
1/*
2 * Socket and pipe I/O utilities used in rsync.
d62bcc17 3 *
0f78b815
WD
4 * Copyright (C) 1996-2001 Andrew Tridgell
5 * Copyright (C) 1996 Paul Mackerras
6 * Copyright (C) 2001, 2002 Martin Pool <mbp@samba.org>
b3bf9b9d 7 * Copyright (C) 2003-2009 Wayne Davison
d62bcc17 8 *
880da007 9 * This program is free software; you can redistribute it and/or modify
8e41b68e
WD
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 3 of the License, or
12 * (at your option) any later version.
d62bcc17 13 *
880da007
MP
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.
d62bcc17 18 *
e7c67065 19 * You should have received a copy of the GNU General Public License along
4fd842f9 20 * with this program; if not, visit the http://fsf.org website.
880da007 21 */
720b47f2 22
0f78b815
WD
23/* Rsync provides its own multiplexing system, which is used to send
24 * stderr and stdout over a single socket.
87ee2481
MP
25 *
26 * For historical reasons this is off during the start of the
27 * connection, but it's switched on quite early using
0f78b815 28 * io_start_multiplex_out() and io_start_multiplex_in(). */
720b47f2 29
720b47f2 30#include "rsync.h"
1b42f628 31#include "ifuncs.h"
5dd14f0c 32#include "inums.h"
720b47f2 33
880da007 34/** If no timeout is specified then use a 60 second select timeout */
8cd9fd4e
AT
35#define SELECT_TIMEOUT 60
36
7a55d06e 37extern int bwlimit;
71e58630 38extern size_t bwlimit_writemax;
6ba9279f 39extern int io_timeout;
d17e1dd2 40extern int am_server;
d17e1dd2 41extern int am_sender;
98f8c9a5 42extern int am_generator;
20caffd2 43extern int msgs2stderr;
3ea6e0e7 44extern int inc_recurse;
8ef246e0 45extern int io_error;
e626b29e 46extern int eol_nulls;
8ef246e0 47extern int flist_eof;
ce827c3e
WD
48extern int file_total;
49extern int file_old_total;
7f9bf6b7 50extern int list_only;
3b0a30eb 51extern int read_batch;
ba525f77 52extern int protect_args;
b9f592fb
WD
53extern int checksum_seed;
54extern int protocol_version;
47c11975 55extern int remove_source_files;
cdf236aa 56extern int preserve_hard_links;
7a7810aa 57extern BOOL extra_flist_sending_enabled;
a800434a 58extern struct stats stats;
19531e1f 59extern struct file_list *cur_flist;
332cf6df 60#ifdef ICONV_OPTION
ba525f77 61extern int filesfrom_convert;
332cf6df
WD
62extern iconv_t ic_send, ic_recv;
63#endif
720b47f2 64
93465f51
WD
65int csum_length = SHORT_SUM_LENGTH; /* initial value */
66int allowed_lull = 0;
9e2409ab 67int ignore_timeout = 0;
b9f592fb 68int batch_fd = -1;
04c722d5 69int msgdone_cnt = 0;
20caffd2 70int forward_flist_data = 0;
2885270b 71BOOL flist_receiving_enabled = False;
805edf9d 72
cb2e1f18 73/* Ignore an EOF error if non-zero. See whine_about_eof(). */
574c2500 74int kluge_around_eof = 0;
7a55d06e 75
cdf236aa
WD
76int sock_f_in = -1;
77int sock_f_out = -1;
7a55d06e 78
4dde3347
WD
79int64 total_data_read = 0;
80int64 total_data_written = 0;
81
20caffd2
WD
82static struct {
83 xbuf in, out, msg;
84 int in_fd;
85 int out_fd; /* Both "out" and "msg" go to this fd. */
ac32cdd7 86 int in_multiplexed;
20caffd2
WD
87 unsigned out_empty_len;
88 size_t raw_data_header_pos; /* in the out xbuf */
89 size_t raw_flushing_ends_before; /* in the out xbuf */
90 size_t raw_input_ends_before; /* in the in xbuf */
91} iobuf = { .in_fd = -1, .out_fd = -1 };
8ef246e0 92
3b0a30eb
WD
93static time_t last_io_in;
94static time_t last_io_out;
1f75bb10 95
b9f592fb
WD
96static int write_batch_monitor_in = -1;
97static int write_batch_monitor_out = -1;
98
20caffd2 99static int ff_forward_fd = -1;
8e6b4ddb
WD
100static int ff_reenable_multiplex = -1;
101static char ff_lastchar = '\0';
cbc63a09 102static xbuf ff_xb = EMPTY_XBUF;
332cf6df 103#ifdef ICONV_OPTION
ba525f77 104static xbuf iconv_buf = EMPTY_XBUF;
332cf6df 105#endif
3b0a30eb 106static int select_timeout = SELECT_TIMEOUT;
d6081c82
WD
107static int active_filecnt = 0;
108static OFF_T active_bytecnt = 0;
7f9bf6b7 109static int first_message = 1;
720b47f2 110
351e23ad
WD
111static char int_byte_extra[64] = {
112 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* (00 - 3F)/4 */
113 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* (40 - 7F)/4 */
114 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /* (80 - BF)/4 */
115 2, 2, 2, 2, 2, 2, 2, 2, 3, 3, 3, 3, 4, 4, 5, 6, /* (C0 - FF)/4 */
482f48cc
WD
116};
117
907e6a32
WD
118/* Our I/O buffers are sized with no bits on in the lowest byte of the "size"
119 * (indeed, our rounding of sizes in 1024-byte units assures more than this).
120 * This allows the code that is storing bytes near the physical end of a
121 * circular buffer to temporarily reduce the buffer's size (in order to make
122 * some storing idioms easier), while also making it simple to restore the
123 * buffer's actual size when the buffer's "pos" wraps around to the start (we
124 * just round the buffer's size up again). */
125
126#define IOBUF_WAS_REDUCED(siz) ((siz) & 0xFF)
127#define IOBUF_RESTORE_SIZE(siz) (((siz) | 0xFF) + 1)
128
ac32cdd7
WD
129#define IN_MULTIPLEXED (iobuf.in_multiplexed != 0)
130#define IN_MULTIPLEXED_AND_READY (iobuf.in_multiplexed > 0)
20caffd2 131#define OUT_MULTIPLEXED (iobuf.out_empty_len != 0)
29349024 132
20caffd2
WD
133#define PIO_NEED_INPUT (1<<0) /* The *_NEED_* flags are mutually exclusive. */
134#define PIO_NEED_OUTROOM (1<<1)
135#define PIO_NEED_MSGROOM (1<<2)
ff41a59f 136
20caffd2 137#define PIO_CONSUME_INPUT (1<<4) /* Must becombined with PIO_NEED_INPUT. */
d17e1dd2 138
20caffd2
WD
139#define PIO_INPUT_AND_CONSUME (PIO_NEED_INPUT | PIO_CONSUME_INPUT)
140#define PIO_NEED_FLAGS (PIO_NEED_INPUT | PIO_NEED_OUTROOM | PIO_NEED_MSGROOM)
d17e1dd2 141
20caffd2
WD
142#define REMOTE_OPTION_ERROR "rsync: on remote machine: -"
143#define REMOTE_OPTION_ERROR2 ": unknown option"
08c88178 144
20caffd2 145#define FILESFROM_BUFLEN 2048
d17e1dd2 146
20caffd2 147enum festatus { FES_SUCCESS, FES_REDO, FES_NO_SEND };
29349024 148
20caffd2 149static flist_ndx_list redo_list, hlink_list;
29349024 150
2885270b 151static void read_a_msg(void);
ae598f38 152static void drain_multiplex_messages(void);
20caffd2 153static void sleep_for_bwlimit(int bytes_written);
29349024 154
8d9dc9f9
AT
155static void check_timeout(void)
156{
157 time_t t;
90ba34e2 158
9e2409ab 159 if (!io_timeout || ignore_timeout)
d17e1dd2 160 return;
8d9dc9f9 161
3b0a30eb
WD
162 if (!last_io_in) {
163 last_io_in = time(NULL);
8d9dc9f9
AT
164 return;
165 }
166
167 t = time(NULL);
168
3b0a30eb 169 if (t - last_io_in >= io_timeout) {
c5130bc1
WD
170 if (am_server)
171 msgs2stderr = 1;
172 rprintf(FERROR, "[%s] io timeout after %d seconds -- exiting\n",
173 who_am_i(), (int)(t-last_io_in));
65417579 174 exit_cleanup(RERR_TIMEOUT);
8d9dc9f9
AT
175 }
176}
177
20caffd2
WD
178/* It's almost always an error to get an EOF when we're trying to read from the
179 * network, because the protocol is (for the most part) self-terminating.
180 *
181 * There is one case for the receiver when it is at the end of the transfer
182 * (hanging around reading any keep-alive packets that might come its way): if
183 * the sender dies before the generator's kill-signal comes through, we can end
184 * up here needing to loop until the kill-signal arrives. In this situation,
185 * kluge_around_eof will be < 0.
186 *
187 * There is another case for older protocol versions (< 24) where the module
188 * listing was not terminated, so we must ignore an EOF error in that case and
189 * exit. In this situation, kluge_around_eof will be > 0. */
ae598f38 190static NORETURN void whine_about_eof(BOOL allow_kluge)
d17e1dd2 191{
ae598f38 192 if (kluge_around_eof && allow_kluge) {
20caffd2
WD
193 int i;
194 if (kluge_around_eof > 0)
195 exit_cleanup(0);
196 /* If we're still here after 10 seconds, exit with an error. */
197 for (i = 10*1000/20; i--; )
198 msleep(20);
199 }
d17e1dd2 200
20caffd2
WD
201 rprintf(FERROR, RSYNC_NAME ": connection unexpectedly closed "
202 "(%s bytes received so far) [%s]\n",
203 big_num(stats.total_read), who_am_i());
d17e1dd2 204
20caffd2 205 exit_cleanup(RERR_STREAMIO);
554e0a8d
AT
206}
207
20caffd2
WD
208/* Do a safe read, handling any needed looping and error handling.
209 * Returns the count of the bytes read, which will only be different
210 * from "len" if we encountered an EOF. This routine is not used on
211 * the socket except very early in the transfer. */
212static size_t safe_read(int fd, char *buf, size_t len)
0b789446 213{
20caffd2
WD
214 size_t got;
215 int n;
0b789446 216
20caffd2 217 assert(fd != iobuf.in_fd);
0b789446 218
20caffd2
WD
219 n = read(fd, buf, len);
220 if ((size_t)n == len || n == 0) {
221 if (DEBUG_GTE(IO, 2))
222 rprintf(FINFO, "[%s] safe_read(%d)=%ld\n", who_am_i(), fd, (long)n);
223 return n;
3be97bf9 224 }
20caffd2
WD
225 if (n < 0) {
226 if (errno != EINTR && errno != EWOULDBLOCK && errno != EAGAIN) {
227 read_failed:
228 rsyserr(FERROR, errno, "safe_read failed to read %ld bytes [%s]",
229 (long)len, who_am_i());
230 exit_cleanup(RERR_STREAMIO);
231 }
232 got = 0;
233 } else
234 got = n;
3be97bf9 235
20caffd2
WD
236 while (1) {
237 struct timeval tv;
238 fd_set r_fds, e_fds;
239 int cnt;
7f9bf6b7 240
20caffd2
WD
241 FD_ZERO(&r_fds);
242 FD_SET(fd, &r_fds);
243 FD_ZERO(&e_fds);
244 FD_SET(fd, &e_fds);
245 tv.tv_sec = select_timeout;
246 tv.tv_usec = 0;
7f9bf6b7 247
20caffd2
WD
248 cnt = select(fd+1, &r_fds, NULL, &e_fds, &tv);
249 if (cnt <= 0) {
250 if (cnt < 0 && errno == EBADF) {
251 rsyserr(FERROR, errno, "safe_read select failed [%s]",
252 who_am_i());
253 exit_cleanup(RERR_FILEIO);
254 }
255 check_timeout();
256 continue;
257 }
7f9bf6b7 258
20caffd2
WD
259 /*if (FD_ISSET(fd, &e_fds))
260 rprintf(FINFO, "select exception on fd %d\n", fd); */
7f9bf6b7 261
20caffd2
WD
262 if (FD_ISSET(fd, &r_fds)) {
263 n = read(fd, buf + got, len - got);
264 if (DEBUG_GTE(IO, 2))
265 rprintf(FINFO, "[%s] safe_read(%d)=%ld\n", who_am_i(), fd, (long)n);
266 if (n == 0)
267 break;
268 if (n < 0) {
269 if (errno == EINTR)
270 continue;
271 goto read_failed;
272 }
273 if ((got += (size_t)n) == len)
274 break;
275 }
7f9bf6b7 276 }
20caffd2
WD
277
278 return got;
7f9bf6b7
WD
279}
280
20caffd2 281static const char *what_fd_is(int fd)
d6081c82 282{
20caffd2 283 static char buf[20];
d6081c82 284
20caffd2
WD
285 if (fd == sock_f_out)
286 return "socket";
287 else if (fd == iobuf.out_fd)
288 return "message fd";
289 else if (fd == batch_fd)
290 return "batch file";
291 else {
292 snprintf(buf, sizeof buf, "fd %d", fd);
293 return buf;
294 }
d6081c82
WD
295}
296
20caffd2
WD
297/* Do a safe write, handling any needed looping and error handling.
298 * Returns only if everything was successfully written. This routine
299 * is not used on the socket except very early in the transfer. */
300static void safe_write(int fd, const char *buf, size_t len)
d17e1dd2 301{
20caffd2 302 int n;
ee6e80c7 303
20caffd2 304 assert(fd != iobuf.out_fd);
332cf6df 305
20caffd2
WD
306 n = write(fd, buf, len);
307 if ((size_t)n == len)
308 return;
309 if (n < 0) {
310 if (errno != EINTR && errno != EWOULDBLOCK && errno != EAGAIN) {
311 write_failed:
312 rsyserr(FERROR, errno,
313 "safe_write failed to write %ld bytes to %s [%s]",
314 (long)len, what_fd_is(fd), who_am_i());
315 exit_cleanup(RERR_STREAMIO);
ee6e80c7 316 }
20caffd2
WD
317 } else {
318 buf += n;
319 len -= n;
320 }
ee6e80c7 321
20caffd2
WD
322 while (len) {
323 struct timeval tv;
324 fd_set w_fds;
325 int cnt;
3be97bf9 326
20caffd2
WD
327 FD_ZERO(&w_fds);
328 FD_SET(fd, &w_fds);
329 tv.tv_sec = select_timeout;
330 tv.tv_usec = 0;
17a4977b 331
20caffd2
WD
332 cnt = select(fd + 1, NULL, &w_fds, NULL, &tv);
333 if (cnt <= 0) {
334 if (cnt < 0 && errno == EBADF) {
335 rsyserr(FERROR, errno, "safe_write select failed on %s [%s]",
336 what_fd_is(fd), who_am_i());
337 exit_cleanup(RERR_FILEIO);
338 }
339 check_timeout();
340 continue;
341 }
d17e1dd2 342
20caffd2
WD
343 if (FD_ISSET(fd, &w_fds)) {
344 n = write(fd, buf, len);
345 if (n < 0) {
346 if (errno == EINTR)
347 continue;
348 goto write_failed;
349 }
350 buf += n;
351 len -= n;
352 }
37f35d89 353 }
37f35d89
WD
354}
355
20caffd2
WD
356/* This is only called when files-from data is known to be available. We read
357 * a chunk of data and put it into the output buffer. */
358static void forward_filesfrom_data(void)
155d9206 359{
20caffd2 360 int len;
20caffd2 361
cbc63a09 362 len = read(ff_forward_fd, ff_xb.buf + ff_xb.len, ff_xb.size - ff_xb.len);
20caffd2
WD
363 if (len <= 0) {
364 if (len == 0 || errno != EINTR) {
365 /* Send end-of-file marker */
20caffd2 366 ff_forward_fd = -1;
cbc63a09
WD
367 write_buf(iobuf.out_fd, "\0\0", ff_lastchar ? 2 : 1);
368 free_xbuf(&ff_xb);
8e6b4ddb
WD
369 if (ff_reenable_multiplex >= 0)
370 io_start_multiplex_out(ff_reenable_multiplex);
20caffd2 371 }
0b789446 372 return;
20caffd2 373 }
554e0a8d 374
20caffd2
WD
375 if (DEBUG_GTE(IO, 2))
376 rprintf(FINFO, "[%s] files-from read=%ld\n", who_am_i(), (long)len);
554e0a8d 377
cbc63a09
WD
378#ifdef ICONV_OPTION
379 len += ff_xb.len;
380#endif
381
20caffd2 382 if (!eol_nulls) {
cbc63a09 383 char *s = ff_xb.buf + len;
20caffd2 384 /* Transform CR and/or LF into '\0' */
cbc63a09 385 while (s-- > ff_xb.buf) {
20caffd2
WD
386 if (*s == '\n' || *s == '\r')
387 *s = '\0';
388 }
389 }
cbc63a09 390
20caffd2 391 if (ff_lastchar)
cbc63a09 392 ff_xb.pos = 0;
20caffd2 393 else {
cbc63a09 394 char *s = ff_xb.buf;
20caffd2
WD
395 /* Last buf ended with a '\0', so don't let this buf start with one. */
396 while (len && *s == '\0')
397 s++, len--;
cbc63a09 398 ff_xb.pos = s - ff_xb.buf;
20caffd2 399 }
cbc63a09
WD
400
401#ifdef ICONV_OPTION
402 if (filesfrom_convert && len) {
403 char *sob = ff_xb.buf + ff_xb.pos, *s = sob;
404 char *eob = sob + len;
405 int flags = ICB_INCLUDE_BAD | ICB_INCLUDE_INCOMPLETE | ICB_CIRCULAR_OUT;
406 if (ff_lastchar == '\0')
407 flags |= ICB_INIT;
408 /* Convert/send each null-terminated string separately, skipping empties. */
409 while (s != eob) {
410 if (*s++ == '\0') {
411 ff_xb.len = s - sob - 1;
412 if (iconvbufs(ic_send, &ff_xb, &iobuf.out, flags) < 0)
413 exit_cleanup(RERR_PROTOCOL); /* impossible? */
414 write_buf(iobuf.out_fd, s-1, 1); /* Send the '\0'. */
415 while (s != eob && *s == '\0')
416 s++;
417 sob = s;
418 ff_xb.pos = sob - ff_xb.buf;
419 flags |= ICB_INIT;
420 }
421 }
422
423 if ((ff_xb.len = s - sob) == 0)
424 ff_lastchar = '\0';
425 else {
426 /* Handle a partial string specially, saving any incomplete chars. */
427 flags &= ~ICB_INCLUDE_INCOMPLETE;
428 if (iconvbufs(ic_send, &ff_xb, &iobuf.out, flags) < 0) {
429 if (errno == E2BIG)
430 exit_cleanup(RERR_PROTOCOL); /* impossible? */
431 if (ff_xb.pos)
432 memmove(ff_xb.buf, ff_xb.buf + ff_xb.pos, ff_xb.len);
433 }
434 ff_lastchar = 'x'; /* Anything non-zero. */
435 }
436 } else
437#endif
438
20caffd2 439 if (len) {
cbc63a09
WD
440 char *f = ff_xb.buf + ff_xb.pos;
441 char *t = ff_xb.buf;
20caffd2
WD
442 char *eob = f + len;
443 /* Eliminate any multi-'\0' runs. */
444 while (f != eob) {
445 if (!(*t++ = *f++)) {
cbc63a09
WD
446 while (f != eob && *f == '\0')
447 f++;
20caffd2
WD
448 }
449 }
450 ff_lastchar = f[-1];
cbc63a09
WD
451 if ((len = t - ff_xb.buf) != 0) {
452 /* This will not circle back to perform_io() because we only get
453 * called when there is plenty of room in the output buffer. */
454 write_buf(iobuf.out_fd, ff_xb.buf, len);
455 }
20caffd2 456 }
56014c8c 457}
720b47f2 458
907e6a32
WD
459void reduce_iobuf_size(xbuf *out, size_t new_size)
460{
461 if (new_size < out->size) {
462 if (DEBUG_GTE(IO, 4)) {
463 const char *name = out == &iobuf.out ? "iobuf.out"
464 : out == &iobuf.msg ? "iobuf.msg"
465 : NULL;
466 if (name) {
467 rprintf(FINFO, "[%s] reduced size of %s (-%d)\n",
468 who_am_i(), name, (int)(out->size - new_size));
469 }
470 }
471 out->size = new_size;
472 }
473}
474
475void restore_iobuf_size(xbuf *out)
476{
477 if (IOBUF_WAS_REDUCED(out->size)) {
478 size_t new_size = IOBUF_RESTORE_SIZE(out->size);
479 if (DEBUG_GTE(IO, 4)) {
480 const char *name = out == &iobuf.out ? "iobuf.out"
481 : out == &iobuf.msg ? "iobuf.msg"
482 : NULL;
483 if (name) {
484 rprintf(FINFO, "[%s] restored size of %s (+%d)\n",
485 who_am_i(), name, (int)(new_size - out->size));
486 }
487 }
488 out->size = new_size;
489 }
490}
491
20caffd2
WD
492/* Perform buffered input and output until specified conditions are met. When
493 * given a "needed" read requirement, we'll return without doing any I/O if the
494 * iobuf.in bytes are already available. When reading, we'll read as many
495 * bytes as we can into the buffer, and return as soon as we meet the minimum
496 * read requirement. When given a "needed" write requirement, we'll return
497 * without doing any I/O if that many bytes will fit in the output buffer (we
498 * check either iobuf.out or iobuf.msg, depending on the flags). When writing,
499 * we write out as much as we can, and return as soon as the given free-space
500 * requirement is available.
880da007 501 *
20caffd2
WD
502 * The iobuf.out and iobuf.msg buffers are circular, so some writes into them
503 * will need to be split when the data needs to wrap around to the start. In
504 * order to help make this easier for some operations (such as the use of
763880ba
WD
505 * SIVAL() into the buffer) a buffer may be temporarily shortened, but the
506 * original size will be automatically restored. The iobuf.in buffer is also
507 * circular, so callers may need to split their reading of the data if it spans
508 * the end. See also the 3 raw_* iobuf vars that are used in the handling of
509 * MSG_DATA bytes as they are read-from/written-into the buffers.
cb2e1f18 510 *
20caffd2
WD
511 * When writing, we flush data in the following priority order:
512 *
513 * 1. Finish writing any in-progress MSG_DATA sequence from iobuf.out.
514 *
515 * 2. Write out all the messages from the message buf (if iobuf.msg is active).
516 * Yes, this means that a PIO_NEED_OUTROOM call will completely flush any
517 * messages before getting to the iobuf.out flushing (except for rule 1).
518 *
519 * 3. Write out the raw data from iobuf.out, possibly filling in the multiplexed
520 * MSG_DATA header that was pre-allocated (when output is multiplexed).
521 *
522 * TODO: items for possible future work:
523 *
524 * - Make this routine able to read the generator-to-receiver batch flow?
525 *
20caffd2
WD
526 * Unlike the old routines that this replaces, it is OK to read ahead as far as
527 * we can because the read_a_msg() routine now reads its bytes out of the input
528 * buffer. In the old days, only raw data was in the input buffer, and any
529 * unused raw data in the buf would prevent the reading of socket data. */
530static char *perform_io(size_t needed, int flags)
7a55d06e 531{
20caffd2
WD
532 fd_set r_fds, e_fds, w_fds;
533 struct timeval tv;
534 int cnt, max_fd;
535 size_t empty_buf_len = 0;
536 xbuf *out;
537 char *data;
538
539 if (iobuf.in.len == 0 && iobuf.in.pos != 0) {
540 if (iobuf.raw_input_ends_before)
541 iobuf.raw_input_ends_before -= iobuf.in.pos;
542 iobuf.in.pos = 0;
574c2500 543 }
3151cbae 544
20caffd2
WD
545 switch (flags & PIO_NEED_FLAGS) {
546 case PIO_NEED_INPUT:
763880ba
WD
547 /* We never resize the circular input buffer. */
548 if (iobuf.in.size < needed) {
549 rprintf(FERROR, "need to read %ld bytes, iobuf.in.buf is only %ld bytes.\n",
550 (long)needed, (long)iobuf.in.size);
551 exit_cleanup(RERR_PROTOCOL);
552 }
553
20caffd2
WD
554 if (DEBUG_GTE(IO, 3)) {
555 rprintf(FINFO, "[%s] perform_io(%ld, %sinput)\n",
556 who_am_i(), (long)needed, flags & PIO_CONSUME_INPUT ? "consume&" : "");
557 }
20caffd2 558 break;
720b47f2 559
20caffd2
WD
560 case PIO_NEED_OUTROOM:
561 /* We never resize the circular output buffer. */
562 if (iobuf.out.size - iobuf.out_empty_len < needed) {
563 fprintf(stderr, "need to write %ld bytes, iobuf.out.buf is only %ld bytes.\n",
564 (long)needed, (long)(iobuf.out.size - iobuf.out_empty_len));
565 exit_cleanup(RERR_PROTOCOL);
566 }
4c36ddbe 567
20caffd2
WD
568 if (DEBUG_GTE(IO, 3)) {
569 rprintf(FINFO, "[%s] perform_io(%ld, outroom) needs to flush %ld\n",
570 who_am_i(), (long)needed,
b82d8c9d
WD
571 iobuf.out.len + needed > iobuf.out.size
572 ? (long)(iobuf.out.len + needed - iobuf.out.size) : 0L);
20caffd2
WD
573 }
574 break;
ea2111d1 575
20caffd2
WD
576 case PIO_NEED_MSGROOM:
577 /* We never resize the circular message buffer. */
578 if (iobuf.msg.size < needed) {
579 fprintf(stderr, "need to write %ld bytes, iobuf.msg.buf is only %ld bytes.\n",
580 (long)needed, (long)iobuf.msg.size);
581 exit_cleanup(RERR_PROTOCOL);
582 }
583
584 if (DEBUG_GTE(IO, 3)) {
585 rprintf(FINFO, "[%s] perform_io(%ld, msgroom) needs to flush %ld\n",
586 who_am_i(), (long)needed,
b82d8c9d
WD
587 iobuf.msg.len + needed > iobuf.msg.size
588 ? (long)(iobuf.msg.len + needed - iobuf.msg.size) : 0L);
20caffd2
WD
589 }
590 break;
591
592 case 0:
593 if (DEBUG_GTE(IO, 3))
594 rprintf(FINFO, "[%s] perform_io(%ld, %d)\n", who_am_i(), (long)needed, flags);
595 break;
596
597 default:
598 exit_cleanup(RERR_UNSUPPORTED);
599 }
600
601 while (1) {
602 switch (flags & PIO_NEED_FLAGS) {
603 case PIO_NEED_INPUT:
604 if (iobuf.in.len >= needed)
605 goto double_break;
606 break;
607 case PIO_NEED_OUTROOM:
b82d8c9d
WD
608 /* Note that iobuf.out_empty_len doesn't factor into this check
609 * because iobuf.out.len already holds any needed header len. */
610 if (iobuf.out.len + needed <= iobuf.out.size)
20caffd2
WD
611 goto double_break;
612 break;
613 case PIO_NEED_MSGROOM:
b82d8c9d 614 if (iobuf.msg.len + needed <= iobuf.msg.size)
20caffd2
WD
615 goto double_break;
616 break;
617 }
618
619 max_fd = -1;
4c36ddbe 620
56014c8c 621 FD_ZERO(&r_fds);
20caffd2 622 FD_ZERO(&e_fds);
763880ba 623 if (iobuf.in_fd >= 0 && iobuf.in.size - iobuf.in.len) {
20caffd2
WD
624 if (!read_batch || batch_fd >= 0) {
625 FD_SET(iobuf.in_fd, &r_fds);
626 FD_SET(iobuf.in_fd, &e_fds);
627 }
628 if (iobuf.in_fd > max_fd)
629 max_fd = iobuf.in_fd;
630 }
631
632 /* Only do more filesfrom processing if there is enough room in the out buffer. */
633 if (ff_forward_fd >= 0 && iobuf.out.size - iobuf.out.len > FILESFROM_BUFLEN*2) {
634 FD_SET(ff_forward_fd, &r_fds);
635 if (ff_forward_fd > max_fd)
636 max_fd = ff_forward_fd;
637 }
638
a7026ba9 639 FD_ZERO(&w_fds);
20caffd2
WD
640 if (iobuf.out_fd >= 0) {
641 if (iobuf.raw_flushing_ends_before
642 || (!iobuf.msg.len && iobuf.out.len > iobuf.out_empty_len && !(flags & PIO_NEED_MSGROOM))) {
643 if (OUT_MULTIPLEXED && !iobuf.raw_flushing_ends_before) {
20caffd2
WD
644 /* The iobuf.raw_flushing_ends_before value can point off the end
645 * of the iobuf.out buffer for a while, for easier subtracting. */
646 iobuf.raw_flushing_ends_before = iobuf.out.pos + iobuf.out.len;
647
648 SIVAL(iobuf.out.buf + iobuf.raw_data_header_pos, 0,
649 ((MPLEX_BASE + (int)MSG_DATA)<<24) + iobuf.out.len - 4);
20caffd2
WD
650
651 if (DEBUG_GTE(IO, 1)) {
652 rprintf(FINFO, "[%s] send_msg(%d, %ld)\n",
653 who_am_i(), (int)MSG_DATA, (long)iobuf.out.len - 4);
654 }
655
656 /* reserve room for the next MSG_DATA header */
657 iobuf.raw_data_header_pos = iobuf.raw_flushing_ends_before;
658 if (iobuf.raw_data_header_pos >= iobuf.out.size)
659 iobuf.raw_data_header_pos -= iobuf.out.size;
907e6a32
WD
660 else if (iobuf.raw_data_header_pos + 4 > iobuf.out.size) {
661 /* The 4-byte header won't fit at the end of the buffer,
662 * so we'll temporarily reduce the output buffer's size
663 * and put the header at the start of the buffer. */
664 reduce_iobuf_size(&iobuf.out, iobuf.raw_data_header_pos);
665 iobuf.raw_data_header_pos = 0;
666 }
75ea8459 667 /* Yes, it is possible for this to make len > size for a while. */
20caffd2 668 iobuf.out.len += 4;
56014c8c 669 }
20caffd2
WD
670
671 empty_buf_len = iobuf.out_empty_len;
672 out = &iobuf.out;
673 } else if (iobuf.msg.len) {
674 empty_buf_len = 0;
675 out = &iobuf.msg;
676 } else
677 out = NULL;
678 if (out) {
679 FD_SET(iobuf.out_fd, &w_fds);
680 if (iobuf.out_fd > max_fd)
681 max_fd = iobuf.out_fd;
682 }
683 } else
684 out = NULL;
685
686 if (max_fd < 0) {
687 switch (flags & PIO_NEED_FLAGS) {
688 case PIO_NEED_INPUT:
ae598f38
WD
689 iobuf.in.len = 0;
690 if (kluge_around_eof == 2)
691 exit_cleanup(0);
692 if (iobuf.in_fd == -2)
693 whine_about_eof(True);
20caffd2
WD
694 rprintf(FERROR, "error in perform_io: no fd for input.\n");
695 exit_cleanup(RERR_PROTOCOL);
696 case PIO_NEED_OUTROOM:
697 case PIO_NEED_MSGROOM:
698 msgs2stderr = 1;
ae598f38
WD
699 drain_multiplex_messages();
700 if (iobuf.out_fd == -2)
701 whine_about_eof(True);
20caffd2
WD
702 rprintf(FERROR, "error in perform_io: no fd for output.\n");
703 exit_cleanup(RERR_PROTOCOL);
704 default:
705 /* No stated needs, so I guess this is OK. */
706 break;
56014c8c 707 }
20caffd2 708 break;
554e0a8d
AT
709 }
710
20caffd2 711 if (extra_flist_sending_enabled) {
56926577 712 if (file_total - file_old_total < MAX_FILECNT_LOOKAHEAD)
7a7810aa
WD
713 tv.tv_sec = 0;
714 else {
715 extra_flist_sending_enabled = False;
716 tv.tv_sec = select_timeout;
717 }
718 } else
ce827c3e 719 tv.tv_sec = select_timeout;
4c36ddbe
AT
720 tv.tv_usec = 0;
721
20caffd2 722 cnt = select(max_fd + 1, &r_fds, &w_fds, &e_fds, &tv);
554e0a8d 723
20caffd2
WD
724 if (cnt <= 0) {
725 if (cnt < 0 && errno == EBADF) {
726 msgs2stderr = 1;
554e0a8d 727 exit_cleanup(RERR_SOCKETIO);
2a5df862 728 }
20caffd2 729 if (extra_flist_sending_enabled) {
7a7810aa 730 extra_flist_sending_enabled = False;
ce827c3e 731 send_extra_file_list(sock_f_out, -1);
7a7810aa
WD
732 extra_flist_sending_enabled = !flist_eof;
733 } else
ce827c3e 734 check_timeout();
20caffd2
WD
735 FD_ZERO(&r_fds); /* Just in case... */
736 FD_ZERO(&w_fds);
4c36ddbe
AT
737 }
738
20caffd2 739 if (iobuf.in_fd >= 0 && FD_ISSET(iobuf.in_fd, &r_fds)) {
763880ba 740 size_t len, pos = iobuf.in.pos + iobuf.in.len;
20caffd2 741 int n;
763880ba
WD
742 if (pos >= iobuf.in.size) {
743 pos -= iobuf.in.size;
744 len = iobuf.in.size - iobuf.in.len;
745 } else
746 len = iobuf.in.size - pos;
20caffd2
WD
747 if ((n = read(iobuf.in_fd, iobuf.in.buf + pos, len)) <= 0) {
748 if (n == 0) {
ae598f38 749 /* Signal that input has become invalid. */
20caffd2 750 if (!read_batch || batch_fd < 0 || am_generator)
ae598f38 751 iobuf.in_fd = -2;
20caffd2
WD
752 batch_fd = -1;
753 continue;
754 }
755 if (errno == EINTR || errno == EWOULDBLOCK || errno == EAGAIN)
756 n = 0;
757 else {
758 /* Don't write errors on a dead socket. */
759 if (iobuf.in_fd == sock_f_in) {
760 if (am_sender)
761 msgs2stderr = 1;
762 rsyserr(FERROR_SOCKET, errno, "read error");
763 } else
764 rsyserr(FERROR, errno, "read error");
e4c598c8 765 exit_cleanup(RERR_SOCKETIO);
56014c8c 766 }
20caffd2
WD
767 }
768 if (msgs2stderr && DEBUG_GTE(IO, 2))
769 rprintf(FINFO, "[%s] recv=%ld\n", who_am_i(), (long)n);
770
771 if (io_timeout)
772 last_io_in = time(NULL);
773 stats.total_read += n;
774
775 iobuf.in.len += n;
776 }
777
dc2a0923 778 if (out && FD_ISSET(iobuf.out_fd, &w_fds)) {
20caffd2
WD
779 size_t len = iobuf.raw_flushing_ends_before ? iobuf.raw_flushing_ends_before - out->pos : out->len;
780 int n;
781
782 if (bwlimit_writemax && len > bwlimit_writemax)
783 len = bwlimit_writemax;
784
785 if (out->pos + len > out->size)
786 len = out->size - out->pos;
787 if ((n = write(iobuf.out_fd, out->buf + out->pos, len)) <= 0) {
788 if (errno == EINTR || errno == EWOULDBLOCK || errno == EAGAIN)
789 n = 0;
790 else {
791 /* Don't write errors on a dead socket. */
792 msgs2stderr = 1;
ae598f38
WD
793 iobuf.out_fd = -2;
794 iobuf.out.len = iobuf.msg.len = iobuf.raw_flushing_ends_before = 0;
f9185203 795 rsyserr(FERROR_SOCKET, errno, "[%s] write error", who_am_i());
ae598f38 796 drain_multiplex_messages();
e4c598c8 797 exit_cleanup(RERR_SOCKETIO);
20caffd2
WD
798 }
799 }
800 if (msgs2stderr && DEBUG_GTE(IO, 2)) {
801 rprintf(FINFO, "[%s] %s sent=%ld\n",
802 who_am_i(), out == &iobuf.out ? "out" : "msg", (long)n);
803 }
804
805 if (io_timeout)
806 last_io_out = time(NULL);
807 stats.total_written += n;
808
809 if (bwlimit_writemax)
810 sleep_for_bwlimit(n);
811
812 if ((out->pos += n) == out->size) {
813 if (iobuf.raw_flushing_ends_before)
814 iobuf.raw_flushing_ends_before -= out->size;
815 out->pos = 0;
907e6a32 816 restore_iobuf_size(out);
d620b907 817 } else if (out->pos == iobuf.raw_flushing_ends_before)
20caffd2
WD
818 iobuf.raw_flushing_ends_before = 0;
819 if ((out->len -= n) == empty_buf_len) {
820 out->pos = 0;
907e6a32 821 restore_iobuf_size(out);
20caffd2
WD
822 if (empty_buf_len)
823 iobuf.raw_data_header_pos = 0;
824 }
825 }
826
2885270b
WD
827 /* We need to help prevent deadlock by doing what reading
828 * we can whenever we are here trying to write. */
ac32cdd7 829 if (IN_MULTIPLEXED_AND_READY && !(flags & PIO_NEED_INPUT)) {
2885270b
WD
830 while (!iobuf.raw_input_ends_before && iobuf.in.len > 512)
831 read_a_msg();
832 if (flist_receiving_enabled && iobuf.in.len > 512)
833 wait_for_receiver(); /* generator only */
834 }
835
20caffd2
WD
836 if (ff_forward_fd >= 0 && FD_ISSET(ff_forward_fd, &r_fds)) {
837 /* This can potentially flush all output and enable
838 * multiplexed output, so keep this last in the loop
839 * and be sure to not cache anything that would break
840 * such a change. */
841 forward_filesfrom_data();
842 }
843 }
844 double_break:
845
846 data = iobuf.in.buf + iobuf.in.pos;
847
848 if (flags & PIO_CONSUME_INPUT) {
849 iobuf.in.len -= needed;
850 iobuf.in.pos += needed;
763880ba
WD
851 if (iobuf.in.pos == iobuf.raw_input_ends_before)
852 iobuf.raw_input_ends_before = 0;
853 if (iobuf.in.pos >= iobuf.in.size) {
854 iobuf.in.pos -= iobuf.in.size;
855 if (iobuf.raw_input_ends_before)
856 iobuf.raw_input_ends_before -= iobuf.in.size;
857 }
20caffd2
WD
858 }
859
860 return data;
861}
862
763880ba
WD
863static void raw_read_buf(char *buf, size_t len)
864{
865 size_t pos = iobuf.in.pos;
866 char *data = perform_io(len, PIO_INPUT_AND_CONSUME);
867 if (iobuf.in.pos <= pos && len) {
868 size_t siz = len - iobuf.in.pos;
869 memcpy(buf, data, siz);
870 memcpy(buf + siz, iobuf.in.buf, iobuf.in.pos);
871 } else
872 memcpy(buf, data, len);
873}
874
875static int32 raw_read_int(void)
876{
877 char *data, buf[4];
878 if (iobuf.in.size - iobuf.in.pos >= 4)
879 data = perform_io(4, PIO_INPUT_AND_CONSUME);
880 else
881 raw_read_buf(data = buf, 4);
882 return IVAL(data, 0);
883}
884
f9185203
WD
885void noop_io_until_death(void)
886{
887 char buf[1024];
888
ae598f38 889 kluge_around_eof = 2;
e4c598c8
WD
890 /* Setting an I/O timeout ensures that if something inexplicably weird
891 * happens, we won't hang around forever. */
892 if (!io_timeout)
893 set_io_timeout(60);
f9185203
WD
894
895 while (1)
896 read_buf(iobuf.in_fd, buf, sizeof buf);
897}
898
20caffd2
WD
899/* Buffer a message for the multiplexed output stream. Is never used for MSG_DATA. */
900int send_msg(enum msgcode code, const char *buf, size_t len, int convert)
901{
902 char *hdr;
907e6a32 903 size_t needed, pos;
20caffd2
WD
904 BOOL want_debug = DEBUG_GTE(IO, 1) && convert >= 0 && (msgs2stderr || code != MSG_INFO);
905
906 if (!OUT_MULTIPLEXED)
907 return 0;
908
909 if (want_debug)
910 rprintf(FINFO, "[%s] send_msg(%d, %ld)\n", who_am_i(), (int)code, (long)len);
911
907e6a32
WD
912 /* When checking for enough free space for this message, we need to
913 * make sure that there is space for the 4-byte header, plus we'll
914 * assume that we may waste up to 3 bytes (if the header doesn't fit
915 * at the physical end of the buffer). */
22955408 916#ifdef ICONV_OPTION
20caffd2
WD
917 if (convert > 0 && ic_send == (iconv_t)-1)
918 convert = 0;
919 if (convert > 0) {
d620b907 920 /* Ensuring double-size room leaves space for maximal conversion expansion. */
907e6a32 921 needed = len*2 + 4 + 3;
20caffd2 922 } else
22955408 923#endif
907e6a32
WD
924 needed = len + 4 + 3;
925 if (iobuf.msg.len + needed > iobuf.msg.size)
926 perform_io(needed, PIO_NEED_MSGROOM);
20caffd2
WD
927
928 pos = iobuf.msg.pos + iobuf.msg.len; /* Must be set after any flushing. */
929 if (pos >= iobuf.msg.size)
930 pos -= iobuf.msg.size;
907e6a32
WD
931 else if (pos + 4 > iobuf.msg.size) {
932 /* The 4-byte header won't fit at the end of the buffer,
933 * so we'll temporarily reduce the message buffer's size
934 * and put the header at the start of the buffer. */
935 reduce_iobuf_size(&iobuf.msg, pos);
936 pos = 0;
937 }
20caffd2
WD
938 hdr = iobuf.msg.buf + pos;
939
d620b907 940 iobuf.msg.len += 4; /* Allocate room for the coming header bytes. */
20caffd2 941
22955408 942#ifdef ICONV_OPTION
20caffd2
WD
943 if (convert > 0) {
944 xbuf inbuf;
945
946 INIT_XBUF(inbuf, (char*)buf, len, (size_t)-1);
947
948 len = iobuf.msg.len;
949 iconvbufs(ic_send, &inbuf, &iobuf.msg,
d8a7290f 950 ICB_INCLUDE_BAD | ICB_INCLUDE_INCOMPLETE | ICB_CIRCULAR_OUT | ICB_INIT);
20caffd2
WD
951 if (inbuf.len > 0) {
952 rprintf(FERROR, "overflowed iobuf.msg buffer in send_msg");
953 exit_cleanup(RERR_UNSUPPORTED);
954 }
955 len = iobuf.msg.len - len;
956 } else
22955408 957#endif
20caffd2
WD
958 {
959 size_t siz;
960
961 if ((pos += 4) >= iobuf.msg.size)
962 pos -= iobuf.msg.size;
963
964 /* Handle a split copy if we wrap around the end of the circular buffer. */
965 if (pos >= iobuf.msg.pos && (siz = iobuf.msg.size - pos) < len) {
966 memcpy(iobuf.msg.buf + pos, buf, siz);
967 memcpy(iobuf.msg.buf, buf + siz, len - siz);
968 } else
969 memcpy(iobuf.msg.buf + pos, buf, len);
970
971 iobuf.msg.len += len;
972 }
973
974 SIVAL(hdr, 0, ((MPLEX_BASE + (int)code)<<24) + len);
20caffd2
WD
975
976 if (want_debug && convert > 0)
977 rprintf(FINFO, "[%s] converted msg len=%ld\n", who_am_i(), (long)len);
978
979 return 1;
980}
981
982void send_msg_int(enum msgcode code, int num)
983{
984 char numbuf[4];
985
986 if (DEBUG_GTE(IO, 1))
987 rprintf(FINFO, "[%s] send_msg_int(%d, %d)\n", who_am_i(), (int)code, num);
988
989 SIVAL(numbuf, 0, num);
990 send_msg(code, numbuf, 4, -1);
991}
992
993static void got_flist_entry_status(enum festatus status, int ndx)
994{
995 struct file_list *flist = flist_for_ndx(ndx, "got_flist_entry_status");
996
997 if (remove_source_files) {
998 active_filecnt--;
999 active_bytecnt -= F_LENGTH(flist->files[ndx - flist->ndx_start]);
1000 }
1001
1002 if (inc_recurse)
1003 flist->in_progress--;
1004
1005 switch (status) {
1006 case FES_SUCCESS:
1007 if (remove_source_files)
1008 send_msg_int(MSG_SUCCESS, ndx);
1009 if (preserve_hard_links) {
1010 struct file_struct *file = flist->files[ndx - flist->ndx_start];
1011 if (F_IS_HLINKED(file)) {
1012 flist_ndx_push(&hlink_list, ndx);
1013 flist->in_progress++;
56014c8c
WD
1014 }
1015 }
20caffd2
WD
1016 break;
1017 case FES_REDO:
1018 if (read_batch) {
1019 if (inc_recurse)
1020 flist->in_progress++;
1021 break;
1022 }
1023 if (inc_recurse)
1024 flist->to_redo++;
1025 flist_ndx_push(&redo_list, ndx);
1026 break;
1027 case FES_NO_SEND:
1028 break;
1029 }
1030}
1031
1032/* Note the fds used for the main socket (which might really be a pipe
1033 * for a local transfer, but we can ignore that). */
1034void io_set_sock_fds(int f_in, int f_out)
1035{
1036 sock_f_in = f_in;
1037 sock_f_out = f_out;
1038}
1039
1040void set_io_timeout(int secs)
1041{
1042 io_timeout = secs;
1043
1044 if (!io_timeout || io_timeout > SELECT_TIMEOUT)
1045 select_timeout = SELECT_TIMEOUT;
1046 else
1047 select_timeout = io_timeout;
1048
1049 allowed_lull = read_batch ? 0 : (io_timeout + 1) / 2;
1050}
1051
1052static void check_for_d_option_error(const char *msg)
1053{
1054 static char rsync263_opts[] = "BCDHIKLPRSTWabceghlnopqrtuvxz";
1055 char *colon;
1056 int saw_d = 0;
1057
1058 if (*msg != 'r'
1059 || strncmp(msg, REMOTE_OPTION_ERROR, sizeof REMOTE_OPTION_ERROR - 1) != 0)
1060 return;
56014c8c 1061
20caffd2
WD
1062 msg += sizeof REMOTE_OPTION_ERROR - 1;
1063 if (*msg == '-' || (colon = strchr(msg, ':')) == NULL
1064 || strncmp(colon, REMOTE_OPTION_ERROR2, sizeof REMOTE_OPTION_ERROR2 - 1) != 0)
1065 return;
554e0a8d 1066
20caffd2
WD
1067 for ( ; *msg != ':'; msg++) {
1068 if (*msg == 'd')
1069 saw_d = 1;
1070 else if (*msg == 'e')
1071 break;
1072 else if (strchr(rsync263_opts, *msg) == NULL)
1073 return;
1074 }
4c36ddbe 1075
20caffd2
WD
1076 if (saw_d) {
1077 rprintf(FWARNING,
1078 "*** Try using \"--old-d\" if remote rsync is <= 2.6.3 ***\n");
1079 }
1080}
1f75bb10 1081
20caffd2
WD
1082/* This is used by the generator to limit how many file transfers can
1083 * be active at once when --remove-source-files is specified. Without
1084 * this, sender-side deletions were mostly happening at the end. */
1085void increment_active_files(int ndx, int itemizing, enum logcode code)
1086{
1087 while (1) {
1088 /* TODO: tune these limits? */
1089 int limit = active_bytecnt >= 128*1024 ? 10 : 50;
1090 if (active_filecnt < limit)
1091 break;
1092 check_for_finished_files(itemizing, code, 0);
1093 if (active_filecnt < limit)
1094 break;
1095 wait_for_receiver();
1096 }
00bdf899 1097
20caffd2
WD
1098 active_filecnt++;
1099 active_bytecnt += F_LENGTH(cur_flist->files[ndx - cur_flist->ndx_start]);
1100}
1f75bb10 1101
20caffd2
WD
1102int get_redo_num(void)
1103{
1104 return flist_ndx_pop(&redo_list);
1105}
1106
1107int get_hlink_num(void)
1108{
1109 return flist_ndx_pop(&hlink_list);
1110}
8d9dc9f9 1111
20caffd2
WD
1112/* When we're the receiver and we have a local --files-from list of names
1113 * that needs to be sent over the socket to the sender, we have to do two
1114 * things at the same time: send the sender a list of what files we're
1115 * processing and read the incoming file+info list from the sender. We do
1116 * this by making recv_file_list() call forward_filesfrom_data(), which
1117 * will ensure that we forward data to the sender until we get some data
1118 * for recv_file_list() to use. */
1119void start_filesfrom_forwarding(int fd)
1120{
8e6b4ddb
WD
1121 if (protocol_version < 31 && OUT_MULTIPLEXED) {
1122 /* Older protocols send the files-from data w/o packaging
1123 * it in multiplexed I/O packets, so temporarily switch
705132bc
WD
1124 * to buffered I/O to match this behavior. */
1125 iobuf.msg.pos = iobuf.msg.len = 0; /* Be extra sure no messages go out. */
8e6b4ddb 1126 ff_reenable_multiplex = io_end_multiplex_out(MPLX_TO_BUFFERED);
20caffd2 1127 }
705132bc 1128 ff_forward_fd = fd;
cbc63a09
WD
1129
1130 alloc_xbuf(&ff_xb, FILESFROM_BUFLEN);
4c36ddbe 1131}
8d9dc9f9 1132
67b8f3df 1133/* Read a line into the "buf" buffer. */
ba525f77 1134int read_line(int fd, char *buf, size_t bufsiz, int flags)
56014c8c 1135{
ba525f77 1136 char ch, *s, *eob;
56014c8c 1137
ba525f77
WD
1138#ifdef ICONV_OPTION
1139 if (flags & RL_CONVERT && iconv_buf.size < bufsiz)
1140 realloc_xbuf(&iconv_buf, bufsiz + 1024);
1141#endif
1142
56014c8c 1143 start:
22955408 1144#ifdef ICONV_OPTION
ba525f77 1145 s = flags & RL_CONVERT ? iconv_buf.buf : buf;
22955408
WD
1146#else
1147 s = buf;
1148#endif
ba525f77 1149 eob = s + bufsiz - 1;
56014c8c 1150 while (1) {
20caffd2
WD
1151 /* We avoid read_byte() for files because files can return an EOF. */
1152 if (fd == iobuf.in_fd)
1153 ch = read_byte(fd);
1154 else if (safe_read(fd, &ch, 1) == 0)
56014c8c 1155 break;
ba525f77 1156 if (flags & RL_EOL_NULLS ? ch == '\0' : (ch == '\r' || ch == '\n')) {
67b8f3df 1157 /* Skip empty lines if dumping comments. */
ba525f77 1158 if (flags & RL_DUMP_COMMENTS && s == buf)
56014c8c
WD
1159 continue;
1160 break;
1161 }
1162 if (s < eob)
1163 *s++ = ch;
1164 }
1165 *s = '\0';
7a55d06e 1166
ba525f77 1167 if (flags & RL_DUMP_COMMENTS && (*buf == '#' || *buf == ';'))
56014c8c
WD
1168 goto start;
1169
ba525f77
WD
1170#ifdef ICONV_OPTION
1171 if (flags & RL_CONVERT) {
1172 xbuf outbuf;
1173 INIT_XBUF(outbuf, buf, 0, bufsiz);
1174 iconv_buf.pos = 0;
1175 iconv_buf.len = s - iconv_buf.buf;
1176 iconvbufs(ic_recv, &iconv_buf, &outbuf,
d8a7290f 1177 ICB_INCLUDE_BAD | ICB_INCLUDE_INCOMPLETE | ICB_INIT);
ba525f77
WD
1178 outbuf.buf[outbuf.len] = '\0';
1179 return outbuf.len;
1180 }
1181#endif
1182
67b8f3df
WD
1183 return s - buf;
1184}
1185
53936ef9
WD
1186void read_args(int f_in, char *mod_name, char *buf, size_t bufsiz, int rl_nulls,
1187 char ***argv_p, int *argc_p, char **request_p)
67b8f3df
WD
1188{
1189 int maxargs = MAX_ARGS;
1190 int dot_pos = 0;
1191 int argc = 0;
1192 char **argv, *p;
22955408
WD
1193 int rl_flags = (rl_nulls ? RL_EOL_NULLS : 0);
1194
1195#ifdef ICONV_OPTION
1196 rl_flags |= (protect_args && ic_recv != (iconv_t)-1 ? RL_CONVERT : 0);
1197#endif
67b8f3df
WD
1198
1199 if (!(argv = new_array(char *, maxargs)))
1200 out_of_memory("read_args");
53936ef9 1201 if (mod_name && !protect_args)
67b8f3df
WD
1202 argv[argc++] = "rsyncd";
1203
1204 while (1) {
ba525f77 1205 if (read_line(f_in, buf, bufsiz, rl_flags) == 0)
67b8f3df
WD
1206 break;
1207
53936ef9 1208 if (argc == maxargs-1) {
67b8f3df
WD
1209 maxargs += MAX_ARGS;
1210 if (!(argv = realloc_array(argv, char *, maxargs)))
1211 out_of_memory("read_args");
1212 }
1213
1214 if (dot_pos) {
1215 if (request_p) {
1216 *request_p = strdup(buf);
1217 request_p = NULL;
1218 }
1219 if (mod_name)
1220 glob_expand_module(mod_name, buf, &argv, &argc, &maxargs);
1221 else
1222 glob_expand(buf, &argv, &argc, &maxargs);
1223 } else {
1224 if (!(p = strdup(buf)))
1225 out_of_memory("read_args");
1226 argv[argc++] = p;
1227 if (*p == '.' && p[1] == '\0')
1228 dot_pos = argc;
1229 }
1230 }
53936ef9 1231 argv[argc] = NULL;
67b8f3df 1232
987a5467
WD
1233 glob_expand(NULL, NULL, NULL, NULL);
1234
67b8f3df
WD
1235 *argc_p = argc;
1236 *argv_p = argv;
56014c8c 1237}
7a55d06e 1238
8e6b4ddb 1239BOOL io_start_buffering_out(int f_out)
1f75bb10 1240{
20caffd2
WD
1241 if (msgs2stderr && DEBUG_GTE(IO, 2))
1242 rprintf(FINFO, "[%s] io_start_buffering_out(%d)\n", who_am_i(), f_out);
1243
20caffd2
WD
1244 if (iobuf.out.buf) {
1245 if (iobuf.out_fd == -1)
1246 iobuf.out_fd = f_out;
d620b907
WD
1247 else
1248 assert(f_out == iobuf.out_fd);
8e6b4ddb 1249 return False;
8ef246e0 1250 }
20caffd2 1251
907e6a32 1252 alloc_xbuf(&iobuf.out, ROUND_UP_1024(IO_BUFFER_SIZE * 2));
20caffd2
WD
1253 iobuf.out_fd = f_out;
1254
8e6b4ddb 1255 return True;
1f75bb10
WD
1256}
1257
8e6b4ddb 1258BOOL io_start_buffering_in(int f_in)
1f75bb10 1259{
20caffd2
WD
1260 if (msgs2stderr && DEBUG_GTE(IO, 2))
1261 rprintf(FINFO, "[%s] io_start_buffering_in(%d)\n", who_am_i(), f_in);
1262
1263 if (iobuf.in.buf) {
1264 if (iobuf.in_fd == -1)
1265 iobuf.in_fd = f_in;
d620b907
WD
1266 else
1267 assert(f_in == iobuf.in_fd);
8e6b4ddb 1268 return False;
8ef246e0 1269 }
20caffd2 1270
907e6a32 1271 alloc_xbuf(&iobuf.in, ROUND_UP_1024(IO_BUFFER_SIZE));
20caffd2
WD
1272 iobuf.in_fd = f_in;
1273
8e6b4ddb 1274 return True;
1f75bb10
WD
1275}
1276
20caffd2 1277void io_end_buffering_in(BOOL free_buffers)
8ef246e0 1278{
705132bc
WD
1279 if (msgs2stderr && DEBUG_GTE(IO, 2)) {
1280 rprintf(FINFO, "[%s] io_end_buffering_in(IOBUF_%s_BUFS)\n",
1281 who_am_i(), free_buffers ? "FREE" : "KEEP");
20caffd2
WD
1282 }
1283
1284 if (free_buffers)
1285 free_xbuf(&iobuf.in);
1286 else
1287 iobuf.in.pos = iobuf.in.len = 0;
1288
1289 iobuf.in_fd = -1;
1290}
1291
1292void io_end_buffering_out(BOOL free_buffers)
1293{
705132bc
WD
1294 if (msgs2stderr && DEBUG_GTE(IO, 2)) {
1295 rprintf(FINFO, "[%s] io_end_buffering_out(IOBUF_%s_BUFS)\n",
1296 who_am_i(), free_buffers ? "FREE" : "KEEP");
20caffd2
WD
1297 }
1298
8ef246e0 1299 io_flush(FULL_FLUSH);
20caffd2
WD
1300
1301 if (free_buffers) {
1302 free_xbuf(&iobuf.out);
1303 free_xbuf(&iobuf.msg);
20caffd2
WD
1304 }
1305
1306 iobuf.out_fd = -1;
1f75bb10
WD
1307}
1308
be91bd81 1309void maybe_flush_socket(int important)
626bec8e 1310{
1ec57e4d
WD
1311 if (flist_eof && iobuf.out.buf && iobuf.out.len > iobuf.out_empty_len
1312 && (important || time(NULL) - last_io_out >= 5))
626bec8e
WD
1313 io_flush(NORMAL_FLUSH);
1314}
1315
cdf236aa 1316void maybe_send_keepalive(void)
9e2409ab 1317{
3b0a30eb 1318 if (time(NULL) - last_io_out >= allowed_lull) {
20caffd2 1319 if (!iobuf.msg.len && iobuf.out.len == iobuf.out_empty_len) {
3221f451
WD
1320 if (protocol_version < 29)
1321 return; /* there's nothing we can do */
8ef246e0 1322 if (protocol_version >= 30)
332cf6df 1323 send_msg(MSG_NOOP, "", 0, 0);
8ef246e0 1324 else {
20caffd2
WD
1325 write_int(iobuf.out_fd, cur_flist->used);
1326 write_shortint(iobuf.out_fd, ITEM_IS_NEW);
8ef246e0 1327 }
9e2409ab 1328 }
20caffd2
WD
1329 if (iobuf.msg.len)
1330 perform_io(iobuf.msg.size - iobuf.msg.len + 1, PIO_NEED_MSGROOM);
1331 else if (iobuf.out.len > iobuf.out_empty_len)
9e2409ab
WD
1332 io_flush(NORMAL_FLUSH);
1333 }
1334}
1335
20caffd2 1336void start_flist_forward(int ndx)
8ef246e0 1337{
20caffd2
WD
1338 write_int(iobuf.out_fd, ndx);
1339 forward_flist_data = 1;
8ef246e0
WD
1340}
1341
20caffd2 1342void stop_flist_forward(void)
4c36ddbe 1343{
20caffd2 1344 forward_flist_data = 0;
8d9dc9f9
AT
1345}
1346
d8587b46 1347/* Read a message from a multiplexed source. */
20caffd2 1348static void read_a_msg(void)
8d9dc9f9 1349{
6d952fdb 1350 char data[BIGPATHBUFLEN];
a0f1ed55 1351 int tag, val;
d8587b46 1352 size_t msg_bytes;
d8587b46 1353
ac32cdd7
WD
1354 /* This ensures that perform_io() does not try to do any message reading
1355 * until we've read all of the data for this message. We should also
1356 * try to avoid calling things that will cause data to be written via
1357 * perform_io() prior to this being reset to 1. */
1358 iobuf.in_multiplexed = -1;
1359
763880ba 1360 tag = raw_read_int();
d8587b46
WD
1361
1362 msg_bytes = tag & 0xFFFFFF;
1363 tag = (tag >> 24) - MPLEX_BASE;
1364
ac32cdd7 1365 if (DEBUG_GTE(IO, 1) && msgs2stderr)
20caffd2 1366 rprintf(FINFO, "[%s] got msg=%d, len=%ld\n", who_am_i(), (int)tag, (long)msg_bytes);
d8587b46
WD
1367
1368 switch (tag) {
1369 case MSG_DATA:
20caffd2
WD
1370 assert(iobuf.raw_input_ends_before == 0);
1371 /* Though this does not yet read the data, we do mark where in
1372 * the buffer the msg data will end once it is read. It is
1373 * possible that this points off the end of the buffer, in
1374 * which case the gradual reading of the input stream will
1375 * cause this value to decrease and eventually become real. */
1376 iobuf.raw_input_ends_before = iobuf.in.pos + msg_bytes;
ac32cdd7 1377 iobuf.in_multiplexed = 1;
d8587b46 1378 break;
20caffd2
WD
1379 case MSG_STATS:
1380 if (msg_bytes != sizeof stats.total_read || !am_generator)
d8587b46 1381 goto invalid_msg;
763880ba 1382 raw_read_buf((char*)&stats.total_read, sizeof stats.total_read);
ac32cdd7 1383 iobuf.in_multiplexed = 1;
d8587b46
WD
1384 break;
1385 case MSG_REDO:
1386 if (msg_bytes != 4 || !am_generator)
1387 goto invalid_msg;
ac32cdd7
WD
1388 val = raw_read_int();
1389 iobuf.in_multiplexed = 1;
1390 got_flist_entry_status(FES_REDO, val);
d8587b46
WD
1391 break;
1392 case MSG_IO_ERROR:
1393 if (msg_bytes != 4 || am_sender)
1394 goto invalid_msg;
763880ba 1395 val = raw_read_int();
ac32cdd7 1396 iobuf.in_multiplexed = 1;
4e2a7e59 1397 io_error |= val;
d8587b46 1398 if (!am_generator)
4e2a7e59 1399 send_msg_int(MSG_IO_ERROR, val);
d8587b46 1400 break;
a0f1ed55 1401 case MSG_IO_TIMEOUT:
84c11e85 1402 if (msg_bytes != 4 || am_server || am_generator)
a0f1ed55 1403 goto invalid_msg;
763880ba 1404 val = raw_read_int();
ac32cdd7 1405 iobuf.in_multiplexed = 1;
a0f1ed55
WD
1406 if (!io_timeout || io_timeout > val) {
1407 if (INFO_GTE(MISC, 2))
1408 rprintf(FINFO, "Setting --timeout=%d to match server\n", val);
4655dcf2 1409 set_io_timeout(val);
a0f1ed55
WD
1410 }
1411 break;
d8587b46
WD
1412 case MSG_NOOP:
1413 if (am_sender)
1414 maybe_send_keepalive();
ac32cdd7 1415 iobuf.in_multiplexed = 1;
d8587b46 1416 break;
d8587b46 1417 case MSG_DELETED:
6d952fdb 1418 if (msg_bytes >= sizeof data)
d8587b46
WD
1419 goto overflow;
1420 if (am_generator) {
6d952fdb 1421 raw_read_buf(data, msg_bytes);
ac32cdd7 1422 iobuf.in_multiplexed = 1;
6d952fdb 1423 send_msg(MSG_DELETED, data, msg_bytes, 1);
d8587b46
WD
1424 break;
1425 }
1426#ifdef ICONV_OPTION
1427 if (ic_recv != (iconv_t)-1) {
1428 xbuf outbuf, inbuf;
1429 char ibuf[512];
1430 int add_null = 0;
cbc63a09 1431 int flags = ICB_INCLUDE_BAD | ICB_INIT;
d8587b46 1432
6d952fdb 1433 INIT_CONST_XBUF(outbuf, data);
d8587b46
WD
1434 INIT_XBUF(inbuf, ibuf, 0, (size_t)-1);
1435
1436 while (msg_bytes) {
cbc63a09 1437 size_t len = msg_bytes > sizeof ibuf - inbuf.len ? sizeof ibuf - inbuf.len : msg_bytes;
763880ba 1438 raw_read_buf(ibuf + inbuf.len, len);
d8a7290f 1439 inbuf.pos = 0;
cbc63a09
WD
1440 inbuf.len += len;
1441 if (!(msg_bytes -= len) && !ibuf[inbuf.len-1])
d8587b46 1442 inbuf.len--, add_null = 1;
cbc63a09
WD
1443 if (iconvbufs(ic_send, &inbuf, &outbuf, flags) < 0) {
1444 if (errno == E2BIG)
1445 goto overflow;
1446 /* Buffer ended with an incomplete char, so move the
1447 * bytes to the start of the buffer and continue. */
1448 memmove(ibuf, ibuf + inbuf.pos, inbuf.len);
1449 }
1450 flags &= ~ICB_INIT;
d8587b46
WD
1451 }
1452 if (add_null) {
1453 if (outbuf.len == outbuf.size)
1454 goto overflow;
1455 outbuf.buf[outbuf.len++] = '\0';
1456 }
1457 msg_bytes = outbuf.len;
1458 } else
1459#endif
6d952fdb 1460 raw_read_buf(data, msg_bytes);
ac32cdd7 1461 iobuf.in_multiplexed = 1;
d8587b46 1462 /* A directory name was sent with the trailing null */
6d952fdb
WD
1463 if (msg_bytes > 0 && !data[msg_bytes-1])
1464 log_delete(data, S_IFDIR);
d8587b46 1465 else {
6d952fdb
WD
1466 data[msg_bytes] = '\0';
1467 log_delete(data, S_IFREG);
d8587b46
WD
1468 }
1469 break;
1470 case MSG_SUCCESS:
1471 if (msg_bytes != 4) {
1472 invalid_msg:
1473 rprintf(FERROR, "invalid multi-message %d:%lu [%s%s]\n",
1474 tag, (unsigned long)msg_bytes, who_am_i(),
1475 inc_recurse ? "/inc" : "");
1476 exit_cleanup(RERR_STREAMIO);
1477 }
763880ba 1478 val = raw_read_int();
ac32cdd7 1479 iobuf.in_multiplexed = 1;
d8587b46 1480 if (am_generator)
4e2a7e59 1481 got_flist_entry_status(FES_SUCCESS, val);
d8587b46 1482 else
4e2a7e59 1483 successful_send(val);
d8587b46
WD
1484 break;
1485 case MSG_NO_SEND:
1486 if (msg_bytes != 4)
1487 goto invalid_msg;
763880ba 1488 val = raw_read_int();
ac32cdd7 1489 iobuf.in_multiplexed = 1;
d8587b46 1490 if (am_generator)
4e2a7e59 1491 got_flist_entry_status(FES_NO_SEND, val);
d8587b46 1492 else
4e2a7e59 1493 send_msg_int(MSG_NO_SEND, val);
d8587b46
WD
1494 break;
1495 case MSG_ERROR_SOCKET:
1496 case MSG_ERROR_UTF8:
1497 case MSG_CLIENT:
1498 case MSG_LOG:
1499 if (!am_generator)
1500 goto invalid_msg;
1501 if (tag == MSG_ERROR_SOCKET)
20caffd2 1502 msgs2stderr = 1;
d8587b46
WD
1503 /* FALL THROUGH */
1504 case MSG_INFO:
1505 case MSG_ERROR:
1506 case MSG_ERROR_XFER:
1507 case MSG_WARNING:
6d952fdb 1508 if (msg_bytes >= sizeof data) {
d8587b46
WD
1509 overflow:
1510 rprintf(FERROR,
1511 "multiplexing overflow %d:%lu [%s%s]\n",
1512 tag, (unsigned long)msg_bytes, who_am_i(),
1513 inc_recurse ? "/inc" : "");
1514 exit_cleanup(RERR_STREAMIO);
1515 }
6d952fdb 1516 raw_read_buf(data, msg_bytes);
ac32cdd7 1517 iobuf.in_multiplexed = 1;
6d952fdb 1518 rwrite((enum logcode)tag, data, msg_bytes, !am_generator);
d8587b46 1519 if (first_message) {
6d952fdb
WD
1520 if (list_only && !am_sender && tag == 1 && msg_bytes < sizeof data) {
1521 data[msg_bytes] = '\0';
1522 check_for_d_option_error(data);
d8587b46
WD
1523 }
1524 first_message = 0;
1525 }
1526 break;
f9185203 1527 case MSG_ERROR_EXIT:
ac32cdd7
WD
1528 if (msg_bytes == 4)
1529 val = raw_read_int();
1530 else if (msg_bytes == 0)
1531 val = 0;
1532 else
1533 goto invalid_msg;
1534 iobuf.in_multiplexed = 1;
0c2e8f93 1535 if (DEBUG_GTE(EXIT, 3))
b9107ee6 1536 rprintf(FINFO, "[%s] got MSG_ERROR_EXIT with %ld bytes\n", who_am_i(), (long)msg_bytes);
304d7b58
WD
1537 if (msg_bytes == 0) {
1538 if (!am_sender && !am_generator) {
0c2e8f93
WD
1539 if (DEBUG_GTE(EXIT, 3)) {
1540 rprintf(FINFO, "[%s] sending MSG_ERROR_EXIT (len 0)\n",
1541 who_am_i());
1542 }
304d7b58
WD
1543 send_msg(MSG_ERROR_EXIT, "", 0, 0);
1544 io_flush(FULL_FLUSH);
1545 }
1546 val = 0;
ac32cdd7 1547 } else {
763880ba 1548 val = raw_read_int();
304d7b58 1549 if (protocol_version >= 31) {
0c2e8f93
WD
1550 if (am_generator) {
1551 if (DEBUG_GTE(EXIT, 3)) {
1552 rprintf(FINFO, "[%s] sending MSG_ERROR_EXIT with exit_code %d\n",
1553 who_am_i(), val);
1554 }
304d7b58 1555 send_msg_int(MSG_ERROR_EXIT, val);
0c2e8f93
WD
1556 } else {
1557 if (DEBUG_GTE(EXIT, 3)) {
1558 rprintf(FINFO, "[%s] sending MSG_ERROR_EXIT (len 0)\n",
1559 who_am_i());
1560 }
304d7b58 1561 send_msg(MSG_ERROR_EXIT, "", 0, 0);
0c2e8f93 1562 }
304d7b58 1563 }
ac32cdd7 1564 }
304d7b58
WD
1565 /* Send a negative linenum so that we don't end up
1566 * with a duplicate exit message. */
1567 _exit_cleanup(val, __FILE__, 0 - __LINE__);
d8587b46
WD
1568 default:
1569 rprintf(FERROR, "unexpected tag %d [%s%s]\n",
1570 tag, who_am_i(), inc_recurse ? "/inc" : "");
1571 exit_cleanup(RERR_STREAMIO);
1572 }
ac32cdd7
WD
1573
1574 assert(iobuf.in_multiplexed > 0);
d8587b46
WD
1575}
1576
ae598f38
WD
1577static void drain_multiplex_messages(void)
1578{
ac32cdd7 1579 while (IN_MULTIPLEXED_AND_READY && iobuf.in.len) {
ae598f38
WD
1580 if (iobuf.raw_input_ends_before) {
1581 size_t raw_len = iobuf.raw_input_ends_before - iobuf.in.pos;
1582 iobuf.raw_input_ends_before = 0;
1583 if (raw_len >= iobuf.in.len) {
1584 iobuf.in.len = 0;
1585 break;
1586 }
ae598f38 1587 iobuf.in.len -= raw_len;
763880ba
WD
1588 if ((iobuf.in.pos += raw_len) >= iobuf.in.size)
1589 iobuf.in.pos -= iobuf.in.size;
ae598f38
WD
1590 }
1591 read_a_msg();
1592 }
1593}
1594
20caffd2 1595void wait_for_receiver(void)
d8587b46 1596{
20caffd2
WD
1597 if (!iobuf.raw_input_ends_before)
1598 read_a_msg();
1599
1600 if (iobuf.raw_input_ends_before) {
1601 int ndx = read_int(iobuf.in_fd);
1602 if (ndx < 0) {
1603 switch (ndx) {
1604 case NDX_FLIST_EOF:
1605 flist_eof = 1;
1606 if (DEBUG_GTE(FLIST, 3))
1607 rprintf(FINFO, "[%s] flist_eof=1\n", who_am_i());
1608 break;
1609 case NDX_DONE:
1610 msgdone_cnt++;
1611 break;
1612 default:
1613 exit_cleanup(RERR_STREAMIO);
1614 }
1615 } else {
1616 struct file_list *flist;
2885270b 1617 flist_receiving_enabled = False;
20caffd2
WD
1618 if (DEBUG_GTE(FLIST, 2)) {
1619 rprintf(FINFO, "[%s] receiving flist for dir %d\n",
1620 who_am_i(), ndx);
1621 }
1622 flist = recv_file_list(iobuf.in_fd);
1623 flist->parent_ndx = ndx;
1624#ifdef SUPPORT_HARD_LINKS
1625 if (preserve_hard_links)
1626 match_hard_links(flist);
1627#endif
2885270b 1628 flist_receiving_enabled = True;
8d9dc9f9 1629 }
b9f592fb 1630 }
720b47f2
AT
1631}
1632
3a993aa4 1633unsigned short read_shortint(int f)
9361f839 1634{
482f48cc 1635 char b[2];
20caffd2 1636 read_buf(f, b, 2);
482f48cc 1637 return (UVAL(b, 1) << 8) + UVAL(b, 0);
9361f839
WD
1638}
1639
b7922338 1640int32 read_int(int f)
720b47f2 1641{
4c36ddbe 1642 char b[4];
d8aeda1e 1643 int32 num;
d730b113 1644
20caffd2 1645 read_buf(f, b, 4);
482f48cc
WD
1646 num = IVAL(b, 0);
1647#if SIZEOF_INT32 > 4
1648 if (num & (int32)0x80000000)
1649 num |= ~(int32)0xffffffff;
1650#endif
d8aeda1e 1651 return num;
720b47f2
AT
1652}
1653
351e23ad 1654int32 read_varint(int f)
3a6a366f 1655{
351e23ad 1656 union {
20caffd2
WD
1657 char b[5];
1658 int32 x;
351e23ad
WD
1659 } u;
1660 uchar ch;
1661 int extra;
1662
1663 u.x = 0;
20caffd2 1664 ch = read_byte(f);
351e23ad
WD
1665 extra = int_byte_extra[ch / 4];
1666 if (extra) {
1667 uchar bit = ((uchar)1<<(8-extra));
1668 if (extra >= (int)sizeof u.b) {
1669 rprintf(FERROR, "Overflow in read_varint()\n");
1670 exit_cleanup(RERR_STREAMIO);
1671 }
20caffd2 1672 read_buf(f, u.b, extra);
351e23ad
WD
1673 u.b[extra] = ch & (bit-1);
1674 } else
1675 u.b[0] = ch;
1676#if CAREFUL_ALIGNMENT
1677 u.x = IVAL(u.b,0);
1678#endif
1679#if SIZEOF_INT32 > 4
1680 if (u.x & (int32)0x80000000)
1681 u.x |= ~(int32)0xffffffff;
1682#endif
1683 return u.x;
1684}
71c46176 1685
351e23ad
WD
1686int64 read_varlong(int f, uchar min_bytes)
1687{
1688 union {
20caffd2
WD
1689 char b[9];
1690 int64 x;
351e23ad
WD
1691 } u;
1692 char b2[8];
1693 int extra;
71c46176 1694
031fa9ad 1695#if SIZEOF_INT64 < 8
351e23ad 1696 memset(u.b, 0, 8);
031fa9ad 1697#else
351e23ad 1698 u.x = 0;
031fa9ad 1699#endif
20caffd2 1700 read_buf(f, b2, min_bytes);
351e23ad
WD
1701 memcpy(u.b, b2+1, min_bytes-1);
1702 extra = int_byte_extra[CVAL(b2, 0) / 4];
1703 if (extra) {
1704 uchar bit = ((uchar)1<<(8-extra));
1705 if (min_bytes + extra > (int)sizeof u.b) {
1706 rprintf(FERROR, "Overflow in read_varlong()\n");
1707 exit_cleanup(RERR_STREAMIO);
1708 }
20caffd2 1709 read_buf(f, u.b + min_bytes - 1, extra);
351e23ad 1710 u.b[min_bytes + extra - 1] = CVAL(b2, 0) & (bit-1);
4ea4acf1 1711#if SIZEOF_INT64 < 8
351e23ad 1712 if (min_bytes + extra > 5 || u.b[4] || CVAL(u.b,3) & 0x80) {
4ea4acf1
WD
1713 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1714 exit_cleanup(RERR_UNSUPPORTED);
1715 }
1716#endif
351e23ad
WD
1717 } else
1718 u.b[min_bytes + extra - 1] = CVAL(b2, 0);
1719#if SIZEOF_INT64 < 8
1720 u.x = IVAL(u.b,0);
1721#elif CAREFUL_ALIGNMENT
1722 u.x = IVAL(u.b,0) | (((int64)IVAL(u.b,4))<<32);
1723#endif
1724 return u.x;
1725}
1726
1727int64 read_longint(int f)
1728{
4ea4acf1 1729#if SIZEOF_INT64 >= 8
351e23ad 1730 char b[9];
4ea4acf1 1731#endif
351e23ad 1732 int32 num = read_int(f);
71c46176 1733
351e23ad
WD
1734 if (num != (int32)0xffffffff)
1735 return num;
1736
1737#if SIZEOF_INT64 < 8
1738 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1739 exit_cleanup(RERR_UNSUPPORTED);
1740#else
20caffd2 1741 read_buf(f, b, 8);
351e23ad
WD
1742 return IVAL(b,0) | (((int64)IVAL(b,4))<<32);
1743#endif
3a6a366f
AT
1744}
1745
4a19c3b2 1746void read_buf(int f, char *buf, size_t len)
720b47f2 1747{
20caffd2
WD
1748 if (f != iobuf.in_fd) {
1749 if (safe_read(f, buf, len) != len)
ae598f38 1750 whine_about_eof(False); /* Doesn't return. */
20caffd2
WD
1751 goto batch_copy;
1752 }
1753
1754 if (!IN_MULTIPLEXED) {
763880ba 1755 raw_read_buf(buf, len);
4dde3347 1756 total_data_read += len;
20caffd2
WD
1757 if (forward_flist_data)
1758 write_buf(iobuf.out_fd, buf, len);
1759 batch_copy:
1760 if (f == write_batch_monitor_in)
1761 safe_write(batch_fd, buf, len);
1762 return;
1763 }
1764
1765 while (1) {
20caffd2
WD
1766 size_t siz;
1767
1768 while (!iobuf.raw_input_ends_before)
1769 read_a_msg();
1770
1771 siz = MIN(len, iobuf.raw_input_ends_before - iobuf.in.pos);
763880ba
WD
1772 if (siz >= iobuf.in.size)
1773 siz = iobuf.in.size;
1774 raw_read_buf(buf, siz);
4dde3347 1775 total_data_read += siz;
20caffd2
WD
1776
1777 if (forward_flist_data)
1778 write_buf(iobuf.out_fd, buf, siz);
1779
1780 if (f == write_batch_monitor_in)
1781 safe_write(batch_fd, buf, siz);
1782
1783 if ((len -= siz) == 0)
1784 break;
1785 buf += siz;
1786 }
720b47f2
AT
1787}
1788
4a19c3b2 1789void read_sbuf(int f, char *buf, size_t len)
575f2fca 1790{
20caffd2 1791 read_buf(f, buf, len);
af436313 1792 buf[len] = '\0';
575f2fca
AT
1793}
1794
9361f839 1795uchar read_byte(int f)
182dca5c 1796{
9361f839 1797 uchar c;
20caffd2 1798 read_buf(f, (char*)&c, 1);
4c36ddbe 1799 return c;
182dca5c 1800}
720b47f2 1801
46e99b09
WD
1802int read_vstring(int f, char *buf, int bufsize)
1803{
1804 int len = read_byte(f);
1805
1806 if (len & 0x80)
1807 len = (len & ~0x80) * 0x100 + read_byte(f);
1808
1809 if (len >= bufsize) {
1810 rprintf(FERROR, "over-long vstring received (%d > %d)\n",
1811 len, bufsize - 1);
9a6ed83f 1812 return -1;
46e99b09
WD
1813 }
1814
1815 if (len)
20caffd2 1816 read_buf(f, buf, len);
46e99b09
WD
1817 buf[len] = '\0';
1818 return len;
1819}
1820
188fed95
WD
1821/* Populate a sum_struct with values from the socket. This is
1822 * called by both the sender and the receiver. */
1823void read_sum_head(int f, struct sum_struct *sum)
1824{
8bd77e70 1825 int32 max_blength = protocol_version < 30 ? OLD_MAX_BLOCK_SIZE : MAX_BLOCK_SIZE;
188fed95 1826 sum->count = read_int(f);
c638caa6
WD
1827 if (sum->count < 0) {
1828 rprintf(FERROR, "Invalid checksum count %ld [%s]\n",
1829 (long)sum->count, who_am_i());
1830 exit_cleanup(RERR_PROTOCOL);
1831 }
188fed95 1832 sum->blength = read_int(f);
8bd77e70 1833 if (sum->blength < 0 || sum->blength > max_blength) {
cdf236aa
WD
1834 rprintf(FERROR, "Invalid block length %ld [%s]\n",
1835 (long)sum->blength, who_am_i());
188fed95
WD
1836 exit_cleanup(RERR_PROTOCOL);
1837 }
1838 sum->s2length = protocol_version < 27 ? csum_length : (int)read_int(f);
a0456b9c 1839 if (sum->s2length < 0 || sum->s2length > MAX_DIGEST_LEN) {
cdf236aa
WD
1840 rprintf(FERROR, "Invalid checksum length %d [%s]\n",
1841 sum->s2length, who_am_i());
188fed95
WD
1842 exit_cleanup(RERR_PROTOCOL);
1843 }
1844 sum->remainder = read_int(f);
1845 if (sum->remainder < 0 || sum->remainder > sum->blength) {
cdf236aa
WD
1846 rprintf(FERROR, "Invalid remainder length %ld [%s]\n",
1847 (long)sum->remainder, who_am_i());
188fed95
WD
1848 exit_cleanup(RERR_PROTOCOL);
1849 }
1850}
1851
c207d7ec
WD
1852/* Send the values from a sum_struct over the socket. Set sum to
1853 * NULL if there are no checksums to send. This is called by both
1854 * the generator and the sender. */
1855void write_sum_head(int f, struct sum_struct *sum)
1856{
1857 static struct sum_struct null_sum;
1858
1859 if (sum == NULL)
1860 sum = &null_sum;
1861
1862 write_int(f, sum->count);
1863 write_int(f, sum->blength);
1864 if (protocol_version >= 27)
1865 write_int(f, sum->s2length);
1866 write_int(f, sum->remainder);
1867}
1868
20caffd2 1869/* Sleep after writing to limit I/O bandwidth usage.
08571358
MP
1870 *
1871 * @todo Rather than sleeping after each write, it might be better to
1872 * use some kind of averaging. The current algorithm seems to always
1873 * use a bit less bandwidth than specified, because it doesn't make up
1874 * for slow periods. But arguably this is a feature. In addition, we
1875 * ought to take the time used to write the data into account.
71e58630
WD
1876 *
1877 * During some phases of big transfers (file FOO is uptodate) this is
1878 * called with a small bytes_written every time. As the kernel has to
1879 * round small waits up to guarantee that we actually wait at least the
1880 * requested number of microseconds, this can become grossly inaccurate.
1881 * We therefore keep track of the bytes we've written over time and only
20caffd2 1882 * sleep when the accumulated delay is at least 1 tenth of a second. */
08571358
MP
1883static void sleep_for_bwlimit(int bytes_written)
1884{
71e58630 1885 static struct timeval prior_tv;
0f78b815 1886 static long total_written = 0;
71e58630
WD
1887 struct timeval tv, start_tv;
1888 long elapsed_usec, sleep_usec;
1889
1890#define ONE_SEC 1000000L /* # of microseconds in a second */
08571358 1891
0f78b815 1892 total_written += bytes_written;
71e58630
WD
1893
1894 gettimeofday(&start_tv, NULL);
1895 if (prior_tv.tv_sec) {
1896 elapsed_usec = (start_tv.tv_sec - prior_tv.tv_sec) * ONE_SEC
1897 + (start_tv.tv_usec - prior_tv.tv_usec);
1898 total_written -= elapsed_usec * bwlimit / (ONE_SEC/1024);
1899 if (total_written < 0)
1900 total_written = 0;
1901 }
3151cbae 1902
71e58630
WD
1903 sleep_usec = total_written * (ONE_SEC/1024) / bwlimit;
1904 if (sleep_usec < ONE_SEC / 10) {
1905 prior_tv = start_tv;
1906 return;
1907 }
08571358 1908
71e58630
WD
1909 tv.tv_sec = sleep_usec / ONE_SEC;
1910 tv.tv_usec = sleep_usec % ONE_SEC;
98b332ed 1911 select(0, NULL, NULL, NULL, &tv);
71e58630
WD
1912
1913 gettimeofday(&prior_tv, NULL);
1914 elapsed_usec = (prior_tv.tv_sec - start_tv.tv_sec) * ONE_SEC
1915 + (prior_tv.tv_usec - start_tv.tv_usec);
1916 total_written = (sleep_usec - elapsed_usec) * bwlimit / (ONE_SEC/1024);
08571358
MP
1917}
1918
20caffd2 1919void io_flush(int flush_it_all)
d6dead6b 1920{
20caffd2
WD
1921 if (iobuf.out.len > iobuf.out_empty_len) {
1922 if (flush_it_all) /* FULL_FLUSH: flush everything in the output buffers */
1923 perform_io(iobuf.out.size - iobuf.out_empty_len, PIO_NEED_OUTROOM);
1924 else /* NORMAL_FLUSH: flush at least 1 byte */
1925 perform_io(iobuf.out.size - iobuf.out.len + 1, PIO_NEED_OUTROOM);
d6dead6b 1926 }
20caffd2
WD
1927 if (iobuf.msg.len)
1928 perform_io(iobuf.msg.size, PIO_NEED_MSGROOM);
d6dead6b 1929}
720b47f2 1930
3a993aa4 1931void write_shortint(int f, unsigned short x)
9361f839 1932{
3a993aa4
WD
1933 char b[2];
1934 b[0] = (char)x;
1935 b[1] = (char)(x >> 8);
20caffd2 1936 write_buf(f, b, 2);
9361f839
WD
1937}
1938
351e23ad
WD
1939void write_int(int f, int32 x)
1940{
1941 char b[4];
1942 SIVAL(b, 0, x);
20caffd2 1943 write_buf(f, b, 4);
351e23ad
WD
1944}
1945
f31514ad 1946void write_varint(int f, int32 x)
1c3344a1
WD
1947{
1948 char b[5];
351e23ad
WD
1949 uchar bit;
1950 int cnt = 4;
1951
1952 SIVAL(b, 1, x);
1953
1954 while (cnt > 1 && b[cnt] == 0)
1955 cnt--;
1956 bit = ((uchar)1<<(7-cnt+1));
1957 if (CVAL(b, cnt) >= bit) {
1958 cnt++;
1959 *b = ~(bit-1);
1960 } else if (cnt > 1)
1961 *b = b[cnt] | ~(bit*2-1);
1962 else
1963 *b = b[cnt];
1964
20caffd2 1965 write_buf(f, b, cnt);
1c3344a1
WD
1966}
1967
351e23ad 1968void write_varlong(int f, int64 x, uchar min_bytes)
720b47f2 1969{
351e23ad
WD
1970 char b[9];
1971 uchar bit;
1972 int cnt = 8;
1973
1974 SIVAL(b, 1, x);
1975#if SIZEOF_INT64 >= 8
1976 SIVAL(b, 5, x >> 32);
1977#else
1978 if (x <= 0x7FFFFFFF && x >= 0)
1979 memset(b + 5, 0, 4);
1980 else {
1981 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1982 exit_cleanup(RERR_UNSUPPORTED);
1983 }
1984#endif
1985
1986 while (cnt > min_bytes && b[cnt] == 0)
1987 cnt--;
1988 bit = ((uchar)1<<(7-cnt+min_bytes));
1989 if (CVAL(b, cnt) >= bit) {
1990 cnt++;
1991 *b = ~(bit-1);
1992 } else if (cnt > min_bytes)
1993 *b = b[cnt] | ~(bit*2-1);
1994 else
1995 *b = b[cnt];
1996
20caffd2 1997 write_buf(f, b, cnt);
720b47f2
AT
1998}
1999
7a24c346
MP
2000/*
2001 * Note: int64 may actually be a 32-bit type if ./configure couldn't find any
2002 * 64-bit types on this platform.
2003 */
71c46176 2004void write_longint(int f, int64 x)
3a6a366f 2005{
351e23ad 2006 char b[12], * const s = b+4;
3a6a366f 2007
351e23ad
WD
2008 SIVAL(s, 0, x);
2009 if (x <= 0x7FFFFFFF && x >= 0) {
20caffd2 2010 write_buf(f, s, 4);
351e23ad
WD
2011 return;
2012 }
3a6a366f 2013
4ea4acf1 2014#if SIZEOF_INT64 < 8
351e23ad
WD
2015 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
2016 exit_cleanup(RERR_UNSUPPORTED);
4ea4acf1 2017#else
351e23ad
WD
2018 memset(b, 0xFF, 4);
2019 SIVAL(s, 4, x >> 32);
20caffd2 2020 write_buf(f, b, 12);
4ea4acf1 2021#endif
3a6a366f
AT
2022}
2023
4a19c3b2 2024void write_buf(int f, const char *buf, size_t len)
720b47f2 2025{
20caffd2
WD
2026 size_t pos, siz;
2027
2028 if (f != iobuf.out_fd) {
2029 safe_write(f, buf, len);
2030 goto batch_copy;
2031 }
2032
75ea8459 2033 if (iobuf.out.len + len > iobuf.out.size)
20caffd2
WD
2034 perform_io(len, PIO_NEED_OUTROOM);
2035
2036 pos = iobuf.out.pos + iobuf.out.len; /* Must be set after any flushing. */
2037 if (pos >= iobuf.out.size)
2038 pos -= iobuf.out.size;
2039
2040 /* Handle a split copy if we wrap around the end of the circular buffer. */
2041 if (pos >= iobuf.out.pos && (siz = iobuf.out.size - pos) < len) {
2042 memcpy(iobuf.out.buf + pos, buf, siz);
2043 memcpy(iobuf.out.buf, buf + siz, len - siz);
2044 } else
2045 memcpy(iobuf.out.buf + pos, buf, len);
2046
2047 iobuf.out.len += len;
4dde3347 2048 total_data_written += len;
20caffd2
WD
2049
2050 batch_copy:
2051 if (f == write_batch_monitor_out)
2052 safe_write(batch_fd, buf, len);
720b47f2
AT
2053}
2054
20caffd2 2055/* Write a string to the connection */
4a19c3b2 2056void write_sbuf(int f, const char *buf)
f0fca04e 2057{
20caffd2 2058 write_buf(f, buf, strlen(buf));
f0fca04e
AT
2059}
2060
9361f839 2061void write_byte(int f, uchar c)
182dca5c 2062{
20caffd2 2063 write_buf(f, (char *)&c, 1);
182dca5c
AT
2064}
2065
4a19c3b2 2066void write_vstring(int f, const char *str, int len)
46e99b09
WD
2067{
2068 uchar lenbuf[3], *lb = lenbuf;
2069
2070 if (len > 0x7F) {
2071 if (len > 0x7FFF) {
2072 rprintf(FERROR,
2073 "attempting to send over-long vstring (%d > %d)\n",
2074 len, 0x7FFF);
2075 exit_cleanup(RERR_PROTOCOL);
2076 }
2077 *lb++ = len / 0x100 + 0x80;
2078 }
2079 *lb = len;
2080
20caffd2 2081 write_buf(f, (char*)lenbuf, lb - lenbuf + 1);
46e99b09 2082 if (len)
20caffd2 2083 write_buf(f, str, len);
46e99b09
WD
2084}
2085
8a65e0ce
WD
2086/* Send a file-list index using a byte-reduction method. */
2087void write_ndx(int f, int32 ndx)
2088{
2089 static int32 prev_positive = -1, prev_negative = 1;
2090 int32 diff, cnt = 0;
2091 char b[6];
2092
2093 if (protocol_version < 30 || read_batch) {
2094 write_int(f, ndx);
2095 return;
2096 }
2097
2098 /* Send NDX_DONE as a single-byte 0 with no side effects. Send
2099 * negative nums as a positive after sending a leading 0xFF. */
2100 if (ndx >= 0) {
2101 diff = ndx - prev_positive;
2102 prev_positive = ndx;
2103 } else if (ndx == NDX_DONE) {
2104 *b = 0;
20caffd2 2105 write_buf(f, b, 1);
8a65e0ce
WD
2106 return;
2107 } else {
2108 b[cnt++] = (char)0xFF;
2109 ndx = -ndx;
2110 diff = ndx - prev_negative;
2111 prev_negative = ndx;
2112 }
2113
2114 /* A diff of 1 - 253 is sent as a one-byte diff; a diff of 254 - 32767
2115 * or 0 is sent as a 0xFE + a two-byte diff; otherwise we send 0xFE
2116 * & all 4 bytes of the (non-negative) num with the high-bit set. */
2117 if (diff < 0xFE && diff > 0)
2118 b[cnt++] = (char)diff;
2119 else if (diff < 0 || diff > 0x7FFF) {
2120 b[cnt++] = (char)0xFE;
2121 b[cnt++] = (char)((ndx >> 24) | 0x80);
8a65e0ce 2122 b[cnt++] = (char)ndx;
351e23ad
WD
2123 b[cnt++] = (char)(ndx >> 8);
2124 b[cnt++] = (char)(ndx >> 16);
8a65e0ce
WD
2125 } else {
2126 b[cnt++] = (char)0xFE;
2127 b[cnt++] = (char)(diff >> 8);
2128 b[cnt++] = (char)diff;
2129 }
20caffd2 2130 write_buf(f, b, cnt);
8a65e0ce
WD
2131}
2132
2133/* Receive a file-list index using a byte-reduction method. */
2134int32 read_ndx(int f)
2135{
2136 static int32 prev_positive = -1, prev_negative = 1;
2137 int32 *prev_ptr, num;
2138 char b[4];
2139
2140 if (protocol_version < 30)
2141 return read_int(f);
2142
20caffd2 2143 read_buf(f, b, 1);
8a65e0ce 2144 if (CVAL(b, 0) == 0xFF) {
20caffd2 2145 read_buf(f, b, 1);
8a65e0ce
WD
2146 prev_ptr = &prev_negative;
2147 } else if (CVAL(b, 0) == 0)
2148 return NDX_DONE;
2149 else
2150 prev_ptr = &prev_positive;
2151 if (CVAL(b, 0) == 0xFE) {
20caffd2 2152 read_buf(f, b, 2);
8a65e0ce 2153 if (CVAL(b, 0) & 0x80) {
351e23ad
WD
2154 b[3] = CVAL(b, 0) & ~0x80;
2155 b[0] = b[1];
20caffd2 2156 read_buf(f, b+1, 2);
351e23ad 2157 num = IVAL(b, 0);
8a65e0ce 2158 } else
351e23ad 2159 num = (UVAL(b,0)<<8) + UVAL(b,1) + *prev_ptr;
8a65e0ce 2160 } else
351e23ad 2161 num = UVAL(b, 0) + *prev_ptr;
8a65e0ce
WD
2162 *prev_ptr = num;
2163 if (prev_ptr == &prev_negative)
2164 num = -num;
2165 return num;
2166}
2167
67b8f3df
WD
2168/* Read a line of up to bufsiz-1 characters into buf. Strips
2169 * the (required) trailing newline and all carriage returns.
2170 * Returns 1 for success; 0 for I/O error or truncation. */
20caffd2 2171int read_line_old(int fd, char *buf, size_t bufsiz)
f0fca04e 2172{
67b8f3df
WD
2173 bufsiz--; /* leave room for the null */
2174 while (bufsiz > 0) {
20caffd2
WD
2175 assert(fd != iobuf.in_fd);
2176 if (safe_read(fd, buf, 1) == 0)
2177 return 0;
2178 if (*buf == '\0')
914cc65c 2179 return 0;
20caffd2 2180 if (*buf == '\n')
f0fca04e 2181 break;
20caffd2 2182 if (*buf != '\r') {
f0fca04e 2183 buf++;
67b8f3df 2184 bufsiz--;
f0fca04e
AT
2185 }
2186 }
6ed6d7f5 2187 *buf = '\0';
67b8f3df 2188 return bufsiz > 0;
f0fca04e
AT
2189}
2190
f0fca04e
AT
2191void io_printf(int fd, const char *format, ...)
2192{
d62bcc17 2193 va_list ap;
33544bf4 2194 char buf[BIGPATHBUFLEN];
f0fca04e 2195 int len;
3151cbae 2196
f0fca04e 2197 va_start(ap, format);
3151cbae 2198 len = vsnprintf(buf, sizeof buf, format, ap);
f0fca04e
AT
2199 va_end(ap);
2200
f89b9368 2201 if (len < 0)
e4c598c8 2202 exit_cleanup(RERR_PROTOCOL);
f0fca04e 2203
33544bf4
WD
2204 if (len > (int)sizeof buf) {
2205 rprintf(FERROR, "io_printf() was too long for the buffer.\n");
e4c598c8 2206 exit_cleanup(RERR_PROTOCOL);
33544bf4
WD
2207 }
2208
f0fca04e
AT
2209 write_sbuf(fd, buf);
2210}
8d9dc9f9 2211
20caffd2
WD
2212/* Setup for multiplexing a MSG_* stream with the data stream. */
2213void io_start_multiplex_out(int fd)
8d9dc9f9 2214{
705132bc
WD
2215 io_flush(FULL_FLUSH);
2216
20caffd2
WD
2217 if (msgs2stderr && DEBUG_GTE(IO, 2))
2218 rprintf(FINFO, "[%s] io_start_multiplex_out(%d)\n", who_am_i(), fd);
8d9dc9f9 2219
907e6a32
WD
2220 if (!iobuf.msg.buf)
2221 alloc_xbuf(&iobuf.msg, ROUND_UP_1024(IO_BUFFER_SIZE));
2222
20caffd2
WD
2223 iobuf.out_empty_len = 4; /* See also OUT_MULTIPLEXED */
2224 io_start_buffering_out(fd);
2225
2226 iobuf.raw_data_header_pos = iobuf.out.pos + iobuf.out.len;
2227 iobuf.out.len += 4;
8d9dc9f9
AT
2228}
2229
20caffd2
WD
2230/* Setup for multiplexing a MSG_* stream with the data stream. */
2231void io_start_multiplex_in(int fd)
8d9dc9f9 2232{
20caffd2
WD
2233 if (msgs2stderr && DEBUG_GTE(IO, 2))
2234 rprintf(FINFO, "[%s] io_start_multiplex_in(%d)\n", who_am_i(), fd);
2235
ac32cdd7 2236 iobuf.in_multiplexed = 1; /* See also IN_MULTIPLEXED */
20caffd2 2237 io_start_buffering_in(fd);
8d9dc9f9
AT
2238}
2239
8e6b4ddb 2240int io_end_multiplex_in(int mode)
7f459268 2241{
8e6b4ddb
WD
2242 int ret = iobuf.in_multiplexed ? iobuf.in_fd : -1;
2243
705132bc
WD
2244 if (msgs2stderr && DEBUG_GTE(IO, 2))
2245 rprintf(FINFO, "[%s] io_end_multiplex_in(mode=%d)\n", who_am_i(), mode);
20caffd2 2246
ac32cdd7 2247 iobuf.in_multiplexed = 0;
705132bc
WD
2248 if (mode == MPLX_SWITCHING)
2249 iobuf.raw_input_ends_before = 0;
2250 else
2251 assert(iobuf.raw_input_ends_before == 0);
2252 if (mode != MPLX_TO_BUFFERED)
2253 io_end_buffering_in(mode);
8e6b4ddb
WD
2254
2255 return ret;
7f459268
WD
2256}
2257
8e6b4ddb 2258int io_end_multiplex_out(int mode)
554e0a8d 2259{
8e6b4ddb
WD
2260 int ret = iobuf.out_empty_len ? iobuf.out_fd : -1;
2261
705132bc
WD
2262 if (msgs2stderr && DEBUG_GTE(IO, 2))
2263 rprintf(FINFO, "[%s] io_end_multiplex_out(mode=%d)\n", who_am_i(), mode);
2264
2265 if (mode != MPLX_TO_BUFFERED)
2266 io_end_buffering_out(mode);
2267 else
2268 io_flush(FULL_FLUSH);
20caffd2 2269
705132bc 2270 iobuf.out.len = 0;
20caffd2 2271 iobuf.out_empty_len = 0;
8e6b4ddb
WD
2272
2273 return ret;
554e0a8d
AT
2274}
2275
b9f592fb
WD
2276void start_write_batch(int fd)
2277{
2278 /* Some communication has already taken place, but we don't
2279 * enable batch writing until here so that we can write a
2280 * canonical record of the communication even though the
2281 * actual communication so far depends on whether a daemon
2282 * is involved. */
2283 write_int(batch_fd, protocol_version);
71456d30
WD
2284 if (protocol_version >= 30)
2285 write_byte(batch_fd, inc_recurse);
b9f592fb 2286 write_int(batch_fd, checksum_seed);
b9f592fb
WD
2287
2288 if (am_sender)
2289 write_batch_monitor_out = fd;
2290 else
2291 write_batch_monitor_in = fd;
2292}
2293
2294void stop_write_batch(void)
2295{
2296 write_batch_monitor_out = -1;
2297 write_batch_monitor_in = -1;
2298}