Added logic to the receiving side to ensure that the --delete-during
[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>
d3d07a5e 7 * Copyright (C) 2003-2008 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"
720b47f2 32
880da007 33/** If no timeout is specified then use a 60 second select timeout */
8cd9fd4e
AT
34#define SELECT_TIMEOUT 60
35
7a55d06e 36extern int bwlimit;
71e58630 37extern size_t bwlimit_writemax;
6ba9279f 38extern int io_timeout;
cdf236aa 39extern int allowed_lull;
d17e1dd2
WD
40extern int am_server;
41extern int am_daemon;
42extern int am_sender;
98f8c9a5 43extern int am_generator;
3ea6e0e7 44extern int inc_recurse;
8ef246e0 45extern int io_error;
e626b29e 46extern int eol_nulls;
8ef246e0 47extern int flist_eof;
7f9bf6b7 48extern int list_only;
3b0a30eb 49extern int read_batch;
188fed95 50extern int csum_length;
ba525f77 51extern int protect_args;
b9f592fb
WD
52extern int checksum_seed;
53extern int protocol_version;
47c11975 54extern int remove_source_files;
cdf236aa 55extern int preserve_hard_links;
a800434a 56extern struct stats stats;
19531e1f 57extern struct file_list *cur_flist;
332cf6df 58#ifdef ICONV_OPTION
ba525f77 59extern int filesfrom_convert;
332cf6df
WD
60extern iconv_t ic_send, ic_recv;
61#endif
720b47f2 62
a86179f4 63const char phase_unknown[] = "unknown";
9e2409ab 64int ignore_timeout = 0;
b9f592fb 65int batch_fd = -1;
04c722d5 66int msgdone_cnt = 0;
7790ee36 67int check_for_io_err = 0;
805edf9d 68
cb2e1f18 69/* Ignore an EOF error if non-zero. See whine_about_eof(). */
574c2500 70int kluge_around_eof = 0;
7a55d06e 71
d17e1dd2
WD
72int msg_fd_in = -1;
73int msg_fd_out = -1;
cdf236aa
WD
74int sock_f_in = -1;
75int sock_f_out = -1;
7a55d06e 76
8ef246e0
WD
77static int iobuf_f_in = -1;
78static char *iobuf_in;
79static size_t iobuf_in_siz;
80static size_t iobuf_in_ndx;
81static size_t iobuf_in_remaining;
82
83static int iobuf_f_out = -1;
84static char *iobuf_out;
85static int iobuf_out_cnt;
86
87int flist_forward_from = -1;
88
1f75bb10
WD
89static int io_multiplexing_out;
90static int io_multiplexing_in;
3b0a30eb
WD
91static time_t last_io_in;
92static time_t last_io_out;
1f75bb10
WD
93static int no_flush;
94
b9f592fb
WD
95static int write_batch_monitor_in = -1;
96static int write_batch_monitor_out = -1;
97
56014c8c
WD
98static int io_filesfrom_f_in = -1;
99static int io_filesfrom_f_out = -1;
ba525f77
WD
100static xbuf ff_buf = EMPTY_XBUF;
101static char ff_lastchar;
332cf6df 102#ifdef ICONV_OPTION
ba525f77 103static xbuf iconv_buf = EMPTY_XBUF;
332cf6df 104#endif
17a4977b 105static int defer_forwarding_messages = 0, defer_forwarding_keep = 0;
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
7f9bf6b7
WD
118#define REMOTE_OPTION_ERROR "rsync: on remote machine: -"
119#define REMOTE_OPTION_ERROR2 ": unknown option"
120
29349024
WD
121enum festatus { FES_SUCCESS, FES_REDO, FES_NO_SEND };
122
dde5b772 123static void readfd(int fd, char *buffer, size_t N);
8ef246e0
WD
124static void writefd(int fd, const char *buf, size_t len);
125static void writefd_unbuffered(int fd, const char *buf, size_t len);
332cf6df 126static void mplex_write(int fd, enum msgcode code, const char *buf, size_t len, int convert);
ff41a59f 127
c6816b94
WD
128struct flist_ndx_item {
129 struct flist_ndx_item *next;
130 int ndx;
d17e1dd2
WD
131};
132
c6816b94
WD
133struct flist_ndx_list {
134 struct flist_ndx_item *head, *tail;
135};
136
cdf236aa 137static struct flist_ndx_list redo_list, hlink_list;
d17e1dd2 138
08c88178
WD
139struct msg_list_item {
140 struct msg_list_item *next;
332cf6df 141 char convert;
954bbed8 142 char buf[1];
d17e1dd2
WD
143};
144
08c88178
WD
145struct msg_list {
146 struct msg_list_item *head, *tail;
147};
148
e4c877cf 149static struct msg_list msg_queue;
d17e1dd2 150
c6816b94 151static void flist_ndx_push(struct flist_ndx_list *lp, int ndx)
d17e1dd2 152{
c6816b94
WD
153 struct flist_ndx_item *item;
154
155 if (!(item = new(struct flist_ndx_item)))
156 out_of_memory("flist_ndx_push");
157 item->next = NULL;
158 item->ndx = ndx;
159 if (lp->tail)
160 lp->tail->next = item;
d17e1dd2 161 else
c6816b94
WD
162 lp->head = item;
163 lp->tail = item;
164}
165
166static int flist_ndx_pop(struct flist_ndx_list *lp)
167{
168 struct flist_ndx_item *next;
169 int ndx;
170
171 if (!lp->head)
172 return -1;
173
174 ndx = lp->head->ndx;
175 next = lp->head->next;
176 free(lp->head);
177 lp->head = next;
178 if (!next)
179 lp->tail = NULL;
180
181 return ndx;
d17e1dd2
WD
182}
183
29349024
WD
184static void got_flist_entry_status(enum festatus status, const char *buf)
185{
186 int ndx = IVAL(buf, 0);
187 struct file_list *flist = flist_for_ndx(ndx);
188
189 assert(flist != NULL);
29349024
WD
190
191 if (remove_source_files) {
192 active_filecnt--;
193 active_bytecnt -= F_LENGTH(flist->files[ndx - flist->ndx_start]);
194 }
195
196 if (inc_recurse)
197 flist->in_progress--;
198
199 switch (status) {
200 case FES_SUCCESS:
201 if (remove_source_files)
202 send_msg(MSG_SUCCESS, buf, 4, 0);
203 if (preserve_hard_links) {
204 struct file_struct *file = flist->files[ndx - flist->ndx_start];
37ce1679 205 if (F_IS_HLINKED(file)) {
29349024 206 flist_ndx_push(&hlink_list, ndx);
37ce1679
WD
207 flist->in_progress++;
208 }
29349024
WD
209 }
210 break;
211 case FES_REDO:
212 if (inc_recurse)
213 flist->to_redo++;
214 flist_ndx_push(&redo_list, ndx);
215 break;
216 case FES_NO_SEND:
217 break;
218 }
219}
220
8d9dc9f9
AT
221static void check_timeout(void)
222{
223 time_t t;
90ba34e2 224
9e2409ab 225 if (!io_timeout || ignore_timeout)
d17e1dd2 226 return;
8d9dc9f9 227
3b0a30eb
WD
228 if (!last_io_in) {
229 last_io_in = time(NULL);
8d9dc9f9
AT
230 return;
231 }
232
233 t = time(NULL);
234
3b0a30eb 235 if (t - last_io_in >= io_timeout) {
0adb99b9 236 if (!am_server && !am_daemon) {
4ccfd96c 237 rprintf(FERROR, "io timeout after %d seconds -- exiting\n",
3b0a30eb 238 (int)(t-last_io_in));
0adb99b9 239 }
65417579 240 exit_cleanup(RERR_TIMEOUT);
8d9dc9f9
AT
241 }
242}
243
1f75bb10
WD
244/* Note the fds used for the main socket (which might really be a pipe
245 * for a local transfer, but we can ignore that). */
246void io_set_sock_fds(int f_in, int f_out)
247{
248 sock_f_in = f_in;
249 sock_f_out = f_out;
250}
251
3b0a30eb
WD
252void set_io_timeout(int secs)
253{
254 io_timeout = secs;
255
256 if (!io_timeout || io_timeout > SELECT_TIMEOUT)
257 select_timeout = SELECT_TIMEOUT;
258 else
259 select_timeout = io_timeout;
260
261 allowed_lull = read_batch ? 0 : (io_timeout + 1) / 2;
262}
263
98f8c9a5
WD
264/* Setup the fd used to receive MSG_* messages. Only needed during the
265 * early stages of being a local sender (up through the sending of the
266 * file list) or when we're the generator (to fetch the messages from
267 * the receiver). */
d17e1dd2
WD
268void set_msg_fd_in(int fd)
269{
270 msg_fd_in = fd;
271}
272
98f8c9a5
WD
273/* Setup the fd used to send our MSG_* messages. Only needed when
274 * we're the receiver (to send our messages to the generator). */
d17e1dd2
WD
275void set_msg_fd_out(int fd)
276{
277 msg_fd_out = fd;
278 set_nonblocking(msg_fd_out);
279}
280
281/* Add a message to the pending MSG_* list. */
332cf6df 282static void msg_list_add(struct msg_list *lst, int code, const char *buf, int len, int convert)
554e0a8d 283{
954bbed8
WD
284 struct msg_list_item *m;
285 int sz = len + 4 + sizeof m[0] - 1;
d17e1dd2 286
954bbed8 287 if (!(m = (struct msg_list_item *)new_array(char, sz)))
c6816b94 288 out_of_memory("msg_list_add");
954bbed8 289 m->next = NULL;
332cf6df 290 m->convert = convert;
954bbed8
WD
291 SIVAL(m->buf, 0, ((code+MPLEX_BASE)<<24) | len);
292 memcpy(m->buf + 4, buf, len);
293 if (lst->tail)
294 lst->tail->next = m;
d17e1dd2 295 else
954bbed8
WD
296 lst->head = m;
297 lst->tail = m;
554e0a8d
AT
298}
299
e4c877cf 300static void msg_flush(void)
3be97bf9 301{
e4c877cf
WD
302 if (am_generator) {
303 while (msg_queue.head && io_multiplexing_out) {
304 struct msg_list_item *m = msg_queue.head;
332cf6df
WD
305 int len = IVAL(m->buf, 0) & 0xFFFFFF;
306 int tag = *((uchar*)m->buf+3) - MPLEX_BASE;
e4c877cf
WD
307 if (!(msg_queue.head = m->next))
308 msg_queue.tail = NULL;
332cf6df 309 stats.total_written += len + 4;
e4c877cf 310 defer_forwarding_messages++;
332cf6df 311 mplex_write(sock_f_out, tag, m->buf + 4, len, m->convert);
e4c877cf
WD
312 defer_forwarding_messages--;
313 free(m);
314 }
315 } else {
316 while (msg_queue.head) {
317 struct msg_list_item *m = msg_queue.head;
332cf6df
WD
318 int len = IVAL(m->buf, 0) & 0xFFFFFF;
319 int tag = *((uchar*)m->buf+3) - MPLEX_BASE;
e4c877cf
WD
320 if (!(msg_queue.head = m->next))
321 msg_queue.tail = NULL;
322 defer_forwarding_messages++;
332cf6df 323 mplex_write(msg_fd_out, tag, m->buf + 4, len, m->convert);
e4c877cf
WD
324 defer_forwarding_messages--;
325 free(m);
326 }
3be97bf9
WD
327 }
328}
329
7f9bf6b7
WD
330static void check_for_d_option_error(const char *msg)
331{
332 static char rsync263_opts[] = "BCDHIKLPRSTWabceghlnopqrtuvxz";
333 char *colon;
334 int saw_d = 0;
335
336 if (*msg != 'r'
337 || strncmp(msg, REMOTE_OPTION_ERROR, sizeof REMOTE_OPTION_ERROR - 1) != 0)
338 return;
339
340 msg += sizeof REMOTE_OPTION_ERROR - 1;
341 if (*msg == '-' || (colon = strchr(msg, ':')) == NULL
342 || strncmp(colon, REMOTE_OPTION_ERROR2, sizeof REMOTE_OPTION_ERROR2 - 1) != 0)
343 return;
344
345 for ( ; *msg != ':'; msg++) {
346 if (*msg == 'd')
347 saw_d = 1;
348 else if (*msg == 'e')
349 break;
350 else if (strchr(rsync263_opts, *msg) == NULL)
351 return;
352 }
353
354 if (saw_d) {
355 rprintf(FWARNING,
73cb6738 356 "*** Try using \"--old-d\" if remote rsync is <= 2.6.3 ***\n");
7f9bf6b7
WD
357 }
358}
359
98f8c9a5
WD
360/* Read a message from the MSG_* fd and handle it. This is called either
361 * during the early stages of being a local sender (up through the sending
362 * of the file list) or when we're the generator (to fetch the messages
363 * from the receiver). */
d17e1dd2 364static void read_msg_fd(void)
554e0a8d 365{
f9c6b3e7 366 char buf[2048];
06ce139f 367 size_t n;
8ef246e0 368 struct file_list *flist;
d17e1dd2 369 int fd = msg_fd_in;
ff41a59f
AT
370 int tag, len;
371
00bdf899 372 /* Temporarily disable msg_fd_in. This is needed to avoid looping back
af436313 373 * to this routine from writefd_unbuffered(). */
3be97bf9 374 no_flush++;
d17e1dd2 375 msg_fd_in = -1;
be21e29c 376 defer_forwarding_messages++;
554e0a8d 377
dde5b772 378 readfd(fd, buf, 4);
ff41a59f
AT
379 tag = IVAL(buf, 0);
380
381 len = tag & 0xFFFFFF;
d17e1dd2 382 tag = (tag >> 24) - MPLEX_BASE;
ff41a59f 383
7790ee36
WD
384 check_for_io_err = 0;
385
d17e1dd2
WD
386 switch (tag) {
387 case MSG_DONE:
cc7b86bf 388 if (len < 0 || len > 1 || !am_generator) {
8ef246e0
WD
389 invalid_msg:
390 rprintf(FERROR, "invalid message %d:%d [%s%s]\n",
391 tag, len, who_am_i(),
3ea6e0e7 392 inc_recurse ? "/inc" : "");
d17e1dd2 393 exit_cleanup(RERR_STREAMIO);
13c7bcbb 394 }
cc7b86bf
WD
395 if (len) {
396 readfd(fd, buf, len);
351e23ad 397 stats.total_read = read_varlong(fd, 3);
cc7b86bf 398 }
04c722d5 399 msgdone_cnt++;
d17e1dd2
WD
400 break;
401 case MSG_REDO:
8ef246e0
WD
402 if (len != 4 || !am_generator)
403 goto invalid_msg;
dde5b772 404 readfd(fd, buf, 4);
29349024 405 got_flist_entry_status(FES_REDO, buf);
8ef246e0
WD
406 break;
407 case MSG_FLIST:
3ea6e0e7 408 if (len != 4 || !am_generator || !inc_recurse)
8ef246e0 409 goto invalid_msg;
dde5b772 410 readfd(fd, buf, 4);
8ef246e0
WD
411 /* Read extra file list from receiver. */
412 assert(iobuf_in != NULL);
413 assert(iobuf_f_in == fd);
1faa1a6d
WD
414 if (verbose > 3) {
415 rprintf(FINFO, "[%s] receiving flist for dir %d\n",
416 who_am_i(), IVAL(buf,0));
417 }
8ef246e0
WD
418 flist = recv_file_list(fd);
419 flist->parent_ndx = IVAL(buf,0);
7790ee36
WD
420 /* If the sender is going to send us an MSG_IO_ERROR value, it
421 * will always be the very next message following MSG_FLIST. */
422 check_for_io_err = 1;
da131912
WD
423#ifdef SUPPORT_HARD_LINKS
424 if (preserve_hard_links)
425 match_hard_links(flist);
426#endif
8ef246e0
WD
427 break;
428 case MSG_FLIST_EOF:
3ea6e0e7 429 if (len != 0 || !am_generator || !inc_recurse)
8ef246e0
WD
430 goto invalid_msg;
431 flist_eof = 1;
d17e1dd2 432 break;
e5f35681
WD
433 case MSG_IO_ERROR:
434 if (len != 4)
435 goto invalid_msg;
436 readfd(fd, buf, len);
437 io_error |= IVAL(buf, 0);
438 break;
0d67e00a 439 case MSG_DELETED:
8ef246e0
WD
440 if (len >= (int)sizeof buf || !am_generator)
441 goto invalid_msg;
dde5b772 442 readfd(fd, buf, len);
332cf6df 443 send_msg(MSG_DELETED, buf, len, 1);
0d67e00a 444 break;
9981c27e 445 case MSG_SUCCESS:
8ef246e0
WD
446 if (len != 4 || !am_generator)
447 goto invalid_msg;
29349024
WD
448 readfd(fd, buf, 4);
449 got_flist_entry_status(FES_SUCCESS, buf);
8ef246e0
WD
450 break;
451 case MSG_NO_SEND:
452 if (len != 4 || !am_generator)
453 goto invalid_msg;
29349024
WD
454 readfd(fd, buf, 4);
455 got_flist_entry_status(FES_NO_SEND, buf);
9981c27e 456 break;
3f0211b6 457 case MSG_ERROR_SOCKET:
64119c79 458 case MSG_CLIENT:
8ef246e0
WD
459 if (!am_generator)
460 goto invalid_msg;
3f0211b6 461 if (tag == MSG_ERROR_SOCKET)
8ef246e0 462 io_end_multiplex_out();
72f2d1b3 463 /* FALL THROUGH */
d17e1dd2
WD
464 case MSG_INFO:
465 case MSG_ERROR:
3f0211b6
WD
466 case MSG_ERROR_XFER:
467 case MSG_WARNING:
d17e1dd2
WD
468 case MSG_LOG:
469 while (len) {
470 n = len;
471 if (n >= sizeof buf)
472 n = sizeof buf - 1;
dde5b772 473 readfd(fd, buf, n);
332cf6df 474 rwrite((enum logcode)tag, buf, n, !am_generator);
d17e1dd2
WD
475 len -= n;
476 }
477 break;
478 default:
f8b9da1a
WD
479 rprintf(FERROR, "unknown message %d:%d [%s]\n",
480 tag, len, who_am_i());
d17e1dd2
WD
481 exit_cleanup(RERR_STREAMIO);
482 }
483
3be97bf9 484 no_flush--;
d17e1dd2 485 msg_fd_in = fd;
17a4977b 486 if (!--defer_forwarding_messages && !no_flush)
e4c877cf 487 msg_flush();
d17e1dd2
WD
488}
489
d6081c82 490/* This is used by the generator to limit how many file transfers can
47c11975 491 * be active at once when --remove-source-files is specified. Without
d6081c82
WD
492 * this, sender-side deletions were mostly happening at the end. */
493void increment_active_files(int ndx, int itemizing, enum logcode code)
494{
495 /* TODO: tune these limits? */
5b986297 496 while (active_filecnt >= (active_bytecnt >= 128*1024 ? 10 : 50)) {
04c722d5
WD
497 check_for_finished_files(itemizing, code, 0);
498 if (iobuf_out_cnt)
499 io_flush(NORMAL_FLUSH);
500 else
501 read_msg_fd();
d6081c82
WD
502 }
503
504 active_filecnt++;
121bfb2b 505 active_bytecnt += F_LENGTH(cur_flist->files[ndx - cur_flist->ndx_start]);
d6081c82
WD
506}
507
3be97bf9 508/* Write an message to a multiplexed stream. If this fails, rsync exits. */
332cf6df 509static void mplex_write(int fd, enum msgcode code, const char *buf, size_t len, int convert)
d17e1dd2 510{
332cf6df 511 char buffer[BIGPATHBUFLEN]; /* Oversized for use by iconv code. */
3be97bf9 512 size_t n = len;
d17e1dd2 513
332cf6df 514#ifdef ICONV_OPTION
ee6e80c7
WD
515 /* We need to convert buf before doing anything else so that we
516 * can include the (converted) byte length in the message header. */
517 if (convert && ic_send != (iconv_t)-1) {
518 xbuf outbuf, inbuf;
519
520 INIT_XBUF(outbuf, buffer + 4, 0, sizeof buffer - 4);
521 INIT_XBUF(inbuf, (char*)buf, len, -1);
332cf6df 522
ee6e80c7
WD
523 iconvbufs(ic_send, &inbuf, &outbuf,
524 ICB_INCLUDE_BAD | ICB_INCLUDE_INCOMPLETE);
525 if (inbuf.len > 0) {
526 rprintf(FERROR, "overflowed conversion buffer in mplex_write");
527 exit_cleanup(RERR_UNSUPPORTED);
528 }
529
530 n = len = outbuf.len;
531 } else
532#endif
533 if (n > 1024 - 4) /* BIGPATHBUFLEN can handle 1024 bytes */
534 n = 0; /* We'd rather do 2 writes than too much memcpy(). */
3be97bf9
WD
535 else
536 memcpy(buffer + 4, buf, n);
537
ee6e80c7
WD
538 SIVAL(buffer, 0, ((MPLEX_BASE + (int)code)<<24) + len);
539
17a4977b 540 defer_forwarding_keep = 1; /* defer_forwarding_messages++ on return */
3be97bf9 541 writefd_unbuffered(fd, buffer, n+4);
17a4977b 542 defer_forwarding_keep = 0;
3be97bf9 543
ee6e80c7
WD
544 if (len > n)
545 writefd_unbuffered(fd, buf+n, len-n);
17a4977b
WD
546
547 if (!--defer_forwarding_messages && !no_flush)
548 msg_flush();
d17e1dd2
WD
549}
550
332cf6df 551int send_msg(enum msgcode code, const char *buf, int len, int convert)
37f35d89
WD
552{
553 if (msg_fd_out < 0) {
12ccc73a 554 if (!defer_forwarding_messages)
332cf6df 555 return io_multiplex_write(code, buf, len, convert);
12ccc73a
WD
556 if (!io_multiplexing_out)
557 return 0;
332cf6df 558 msg_list_add(&msg_queue, code, buf, len, convert);
12ccc73a 559 return 1;
37f35d89 560 }
e4c877cf 561 if (flist_forward_from >= 0)
332cf6df 562 msg_list_add(&msg_queue, code, buf, len, convert);
e4c877cf 563 else
332cf6df 564 mplex_write(msg_fd_out, code, buf, len, convert);
12ccc73a 565 return 1;
37f35d89
WD
566}
567
155d9206
WD
568void send_msg_int(enum msgcode code, int num)
569{
570 char numbuf[4];
571 SIVAL(numbuf, 0, num);
332cf6df 572 send_msg(code, numbuf, 4, 0);
155d9206
WD
573}
574
8ef246e0 575void wait_for_receiver(void)
d17e1dd2 576{
2a5df862
WD
577 if (iobuf_out_cnt)
578 io_flush(NORMAL_FLUSH);
579 else
580 read_msg_fd();
8ef246e0 581}
554e0a8d 582
8ef246e0
WD
583int get_redo_num(void)
584{
c6816b94 585 return flist_ndx_pop(&redo_list);
554e0a8d
AT
586}
587
cdf236aa
WD
588int get_hlink_num(void)
589{
590 return flist_ndx_pop(&hlink_list);
591}
592
56014c8c
WD
593/**
594 * When we're the receiver and we have a local --files-from list of names
595 * that needs to be sent over the socket to the sender, we have to do two
596 * things at the same time: send the sender a list of what files we're
597 * processing and read the incoming file+info list from the sender. We do
598 * this by augmenting the read_timeout() function to copy this data. It
ba525f77
WD
599 * uses ff_buf to read a block of data from f_in (when it is ready, since
600 * it might be a pipe) and then blast it out f_out (when it is ready to
601 * receive more data).
56014c8c
WD
602 */
603void io_set_filesfrom_fds(int f_in, int f_out)
604{
605 io_filesfrom_f_in = f_in;
606 io_filesfrom_f_out = f_out;
ba525f77
WD
607 alloc_xbuf(&ff_buf, 2048);
608#ifdef ICONV_OPTION
609 if (protect_args)
610 alloc_xbuf(&iconv_buf, 1024);
611#endif
56014c8c 612}
720b47f2 613
cb2e1f18
WD
614/* It's almost always an error to get an EOF when we're trying to read from the
615 * network, because the protocol is (for the most part) self-terminating.
880da007 616 *
cb2e1f18
WD
617 * There is one case for the receiver when it is at the end of the transfer
618 * (hanging around reading any keep-alive packets that might come its way): if
619 * the sender dies before the generator's kill-signal comes through, we can end
620 * up here needing to loop until the kill-signal arrives. In this situation,
621 * kluge_around_eof will be < 0.
622 *
623 * There is another case for older protocol versions (< 24) where the module
624 * listing was not terminated, so we must ignore an EOF error in that case and
625 * exit. In this situation, kluge_around_eof will be > 0. */
1f75bb10 626static void whine_about_eof(int fd)
7a55d06e 627{
574c2500 628 if (kluge_around_eof && fd == sock_f_in) {
55bb7fff 629 int i;
574c2500
WD
630 if (kluge_around_eof > 0)
631 exit_cleanup(0);
55bb7fff
WD
632 /* If we're still here after 10 seconds, exit with an error. */
633 for (i = 10*1000/20; i--; )
574c2500
WD
634 msleep(20);
635 }
3151cbae 636
00bdf899 637 rprintf(FERROR, RSYNC_NAME ": connection unexpectedly closed "
dca68b0a
WD
638 "(%.0f bytes received so far) [%s]\n",
639 (double)stats.total_read, who_am_i());
00bdf899
WD
640
641 exit_cleanup(RERR_STREAMIO);
7a55d06e 642}
720b47f2 643
880da007 644/**
6ed6d7f5 645 * Read from a socket with I/O timeout. return the number of bytes
c3563c46
MP
646 * read. If no bytes can be read then exit, never return a number <= 0.
647 *
8886f8d0
MP
648 * TODO: If the remote shell connection fails, then current versions
649 * actually report an "unexpected EOF" error here. Since it's a
650 * fairly common mistake to try to use rsh when ssh is required, we
651 * should trap that: if we fail to read any data at all, we should
652 * give a better explanation. We can tell whether the connection has
653 * started by looking e.g. at whether the remote version is known yet.
c3563c46 654 */
3151cbae 655static int read_timeout(int fd, char *buf, size_t len)
8d9dc9f9 656{
d8aeda1e 657 int n, cnt = 0;
4c36ddbe 658
dde5b772 659 io_flush(FULL_FLUSH);
ea2111d1 660
d8aeda1e 661 while (cnt == 0) {
7a55d06e 662 /* until we manage to read *something* */
56014c8c 663 fd_set r_fds, w_fds;
4c36ddbe 664 struct timeval tv;
1ea087a7 665 int maxfd = fd;
a57873b7 666 int count;
4c36ddbe 667
56014c8c 668 FD_ZERO(&r_fds);
a7026ba9 669 FD_ZERO(&w_fds);
56014c8c 670 FD_SET(fd, &r_fds);
3309507d 671 if (io_filesfrom_f_out >= 0) {
56014c8c 672 int new_fd;
ba525f77 673 if (ff_buf.len == 0) {
3309507d 674 if (io_filesfrom_f_in >= 0) {
56014c8c
WD
675 FD_SET(io_filesfrom_f_in, &r_fds);
676 new_fd = io_filesfrom_f_in;
677 } else {
678 io_filesfrom_f_out = -1;
679 new_fd = -1;
680 }
681 } else {
56014c8c
WD
682 FD_SET(io_filesfrom_f_out, &w_fds);
683 new_fd = io_filesfrom_f_out;
684 }
1ea087a7
WD
685 if (new_fd > maxfd)
686 maxfd = new_fd;
554e0a8d
AT
687 }
688
e626b29e 689 tv.tv_sec = select_timeout;
4c36ddbe
AT
690 tv.tv_usec = 0;
691
554e0a8d
AT
692 errno = 0;
693
a7026ba9 694 count = select(maxfd + 1, &r_fds, &w_fds, NULL, &tv);
a57873b7 695
a57873b7 696 if (count <= 0) {
2a5df862
WD
697 if (errno == EBADF) {
698 defer_forwarding_messages = 0;
554e0a8d 699 exit_cleanup(RERR_SOCKETIO);
2a5df862 700 }
bd717af8 701 check_timeout();
4c36ddbe
AT
702 continue;
703 }
704
3309507d 705 if (io_filesfrom_f_out >= 0) {
ba525f77 706 if (ff_buf.len) {
56014c8c
WD
707 if (FD_ISSET(io_filesfrom_f_out, &w_fds)) {
708 int l = write(io_filesfrom_f_out,
ba525f77
WD
709 ff_buf.buf + ff_buf.pos,
710 ff_buf.len);
56014c8c 711 if (l > 0) {
ba525f77
WD
712 if (!(ff_buf.len -= l))
713 ff_buf.pos = 0;
56014c8c 714 else
ba525f77 715 ff_buf.pos += l;
47cffb77 716 } else if (errno != EINTR) {
56014c8c
WD
717 /* XXX should we complain? */
718 io_filesfrom_f_out = -1;
719 }
720 }
3309507d 721 } else if (io_filesfrom_f_in >= 0) {
56014c8c 722 if (FD_ISSET(io_filesfrom_f_in, &r_fds)) {
22955408 723#ifdef ICONV_OPTION
ba525f77 724 xbuf *ibuf = filesfrom_convert ? &iconv_buf : &ff_buf;
22955408
WD
725#else
726 xbuf *ibuf = &ff_buf;
727#endif
ba525f77 728 int l = read(io_filesfrom_f_in, ibuf->buf, ibuf->size);
56014c8c 729 if (l <= 0) {
47cffb77
WD
730 if (l == 0 || errno != EINTR) {
731 /* Send end-of-file marker */
ba525f77
WD
732 memcpy(ff_buf.buf, "\0\0", 2);
733 ff_buf.len = ff_lastchar? 2 : 1;
734 ff_buf.pos = 0;
47cffb77
WD
735 io_filesfrom_f_in = -1;
736 }
56014c8c 737 } else {
22955408 738#ifdef ICONV_OPTION
ba525f77
WD
739 if (filesfrom_convert) {
740 iconv_buf.pos = 0;
741 iconv_buf.len = l;
742 iconvbufs(ic_send, &iconv_buf, &ff_buf,
743 ICB_EXPAND_OUT|ICB_INCLUDE_BAD|ICB_INCLUDE_INCOMPLETE);
744 l = ff_buf.len;
745 }
22955408 746#endif
56014c8c 747 if (!eol_nulls) {
ba525f77 748 char *s = ff_buf.buf + l;
56014c8c 749 /* Transform CR and/or LF into '\0' */
ba525f77 750 while (s-- > ff_buf.buf) {
56014c8c
WD
751 if (*s == '\n' || *s == '\r')
752 *s = '\0';
753 }
754 }
ba525f77 755 if (!ff_lastchar) {
56014c8c
WD
756 /* Last buf ended with a '\0', so don't
757 * let this buf start with one. */
ba525f77
WD
758 while (l && ff_buf.buf[ff_buf.pos] == '\0')
759 ff_buf.pos++, l--;
56014c8c
WD
760 }
761 if (!l)
ba525f77 762 ff_buf.pos = 0;
56014c8c 763 else {
ba525f77 764 char *f = ff_buf.buf + ff_buf.pos;
56014c8c
WD
765 char *t = f;
766 char *eob = f + l;
767 /* Eliminate any multi-'\0' runs. */
768 while (f != eob) {
769 if (!(*t++ = *f++)) {
770 while (f != eob && !*f)
771 f++, l--;
772 }
773 }
ba525f77 774 ff_lastchar = f[-1];
56014c8c 775 }
ba525f77 776 ff_buf.len = l;
56014c8c
WD
777 }
778 }
779 }
780 }
781
f89b9368
WD
782 if (!FD_ISSET(fd, &r_fds))
783 continue;
554e0a8d 784
4c36ddbe
AT
785 n = read(fd, buf, len);
786
1ea087a7
WD
787 if (n <= 0) {
788 if (n == 0)
1f75bb10 789 whine_about_eof(fd); /* Doesn't return. */
d62bcc17
WD
790 if (errno == EINTR || errno == EWOULDBLOCK
791 || errno == EAGAIN)
7a55d06e 792 continue;
1f75bb10
WD
793
794 /* Don't write errors on a dead socket. */
72f2d1b3 795 if (fd == sock_f_in) {
8ef246e0 796 io_end_multiplex_out();
3f0211b6 797 rsyserr(FERROR_SOCKET, errno, "read error");
72f2d1b3
WD
798 } else
799 rsyserr(FERROR, errno, "read error");
1f75bb10 800 exit_cleanup(RERR_STREAMIO);
8d9dc9f9 801 }
00bdf899
WD
802
803 buf += n;
804 len -= n;
d8aeda1e 805 cnt += n;
1f75bb10 806
3b0a30eb
WD
807 if (fd == sock_f_in && io_timeout)
808 last_io_in = time(NULL);
4c36ddbe 809 }
8d9dc9f9 810
d8aeda1e 811 return cnt;
4c36ddbe 812}
8d9dc9f9 813
67b8f3df 814/* Read a line into the "buf" buffer. */
ba525f77 815int read_line(int fd, char *buf, size_t bufsiz, int flags)
56014c8c 816{
ba525f77 817 char ch, *s, *eob;
56014c8c 818 int cnt;
56014c8c 819
ba525f77
WD
820#ifdef ICONV_OPTION
821 if (flags & RL_CONVERT && iconv_buf.size < bufsiz)
822 realloc_xbuf(&iconv_buf, bufsiz + 1024);
823#endif
824
56014c8c 825 start:
22955408 826#ifdef ICONV_OPTION
ba525f77 827 s = flags & RL_CONVERT ? iconv_buf.buf : buf;
22955408
WD
828#else
829 s = buf;
830#endif
ba525f77 831 eob = s + bufsiz - 1;
56014c8c
WD
832 while (1) {
833 cnt = read(fd, &ch, 1);
834 if (cnt < 0 && (errno == EWOULDBLOCK
835 || errno == EINTR || errno == EAGAIN)) {
836 struct timeval tv;
6c850772
WD
837 fd_set r_fds, e_fds;
838 FD_ZERO(&r_fds);
839 FD_SET(fd, &r_fds);
840 FD_ZERO(&e_fds);
841 FD_SET(fd, &e_fds);
e626b29e 842 tv.tv_sec = select_timeout;
56014c8c 843 tv.tv_usec = 0;
6c850772 844 if (!select(fd+1, &r_fds, NULL, &e_fds, &tv))
56014c8c 845 check_timeout();
35c8fd76
WD
846 /*if (FD_ISSET(fd, &e_fds))
847 rprintf(FINFO, "select exception on fd %d\n", fd); */
56014c8c
WD
848 continue;
849 }
850 if (cnt != 1)
851 break;
ba525f77 852 if (flags & RL_EOL_NULLS ? ch == '\0' : (ch == '\r' || ch == '\n')) {
67b8f3df 853 /* Skip empty lines if dumping comments. */
ba525f77 854 if (flags & RL_DUMP_COMMENTS && s == buf)
56014c8c
WD
855 continue;
856 break;
857 }
858 if (s < eob)
859 *s++ = ch;
860 }
861 *s = '\0';
7a55d06e 862
ba525f77 863 if (flags & RL_DUMP_COMMENTS && (*buf == '#' || *buf == ';'))
56014c8c
WD
864 goto start;
865
ba525f77
WD
866#ifdef ICONV_OPTION
867 if (flags & RL_CONVERT) {
868 xbuf outbuf;
869 INIT_XBUF(outbuf, buf, 0, bufsiz);
870 iconv_buf.pos = 0;
871 iconv_buf.len = s - iconv_buf.buf;
872 iconvbufs(ic_recv, &iconv_buf, &outbuf,
873 ICB_INCLUDE_BAD | ICB_INCLUDE_INCOMPLETE);
874 outbuf.buf[outbuf.len] = '\0';
875 return outbuf.len;
876 }
877#endif
878
67b8f3df
WD
879 return s - buf;
880}
881
53936ef9
WD
882void read_args(int f_in, char *mod_name, char *buf, size_t bufsiz, int rl_nulls,
883 char ***argv_p, int *argc_p, char **request_p)
67b8f3df
WD
884{
885 int maxargs = MAX_ARGS;
886 int dot_pos = 0;
887 int argc = 0;
888 char **argv, *p;
22955408
WD
889 int rl_flags = (rl_nulls ? RL_EOL_NULLS : 0);
890
891#ifdef ICONV_OPTION
892 rl_flags |= (protect_args && ic_recv != (iconv_t)-1 ? RL_CONVERT : 0);
893#endif
67b8f3df
WD
894
895 if (!(argv = new_array(char *, maxargs)))
896 out_of_memory("read_args");
53936ef9 897 if (mod_name && !protect_args)
67b8f3df
WD
898 argv[argc++] = "rsyncd";
899
900 while (1) {
ba525f77 901 if (read_line(f_in, buf, bufsiz, rl_flags) == 0)
67b8f3df
WD
902 break;
903
53936ef9 904 if (argc == maxargs-1) {
67b8f3df
WD
905 maxargs += MAX_ARGS;
906 if (!(argv = realloc_array(argv, char *, maxargs)))
907 out_of_memory("read_args");
908 }
909
910 if (dot_pos) {
911 if (request_p) {
912 *request_p = strdup(buf);
913 request_p = NULL;
914 }
915 if (mod_name)
916 glob_expand_module(mod_name, buf, &argv, &argc, &maxargs);
917 else
918 glob_expand(buf, &argv, &argc, &maxargs);
919 } else {
920 if (!(p = strdup(buf)))
921 out_of_memory("read_args");
922 argv[argc++] = p;
923 if (*p == '.' && p[1] == '\0')
924 dot_pos = argc;
925 }
926 }
53936ef9 927 argv[argc] = NULL;
67b8f3df 928
987a5467
WD
929 glob_expand(NULL, NULL, NULL, NULL);
930
67b8f3df
WD
931 *argc_p = argc;
932 *argv_p = argv;
56014c8c 933}
7a55d06e 934
8ef246e0 935int io_start_buffering_out(int f_out)
1f75bb10 936{
8ef246e0
WD
937 if (iobuf_out) {
938 assert(f_out == iobuf_f_out);
939 return 0;
940 }
1f75bb10
WD
941 if (!(iobuf_out = new_array(char, IO_BUFFER_SIZE)))
942 out_of_memory("io_start_buffering_out");
943 iobuf_out_cnt = 0;
8ef246e0
WD
944 iobuf_f_out = f_out;
945 return 1;
1f75bb10
WD
946}
947
8ef246e0 948int io_start_buffering_in(int f_in)
1f75bb10 949{
8ef246e0
WD
950 if (iobuf_in) {
951 assert(f_in == iobuf_f_in);
952 return 0;
953 }
1f75bb10
WD
954 iobuf_in_siz = 2 * IO_BUFFER_SIZE;
955 if (!(iobuf_in = new_array(char, iobuf_in_siz)))
956 out_of_memory("io_start_buffering_in");
8ef246e0
WD
957 iobuf_f_in = f_in;
958 return 1;
1f75bb10
WD
959}
960
8ef246e0 961void io_end_buffering_in(void)
1f75bb10 962{
8ef246e0
WD
963 if (!iobuf_in)
964 return;
965 free(iobuf_in);
966 iobuf_in = NULL;
967 iobuf_in_ndx = 0;
968 iobuf_in_remaining = 0;
969 iobuf_f_in = -1;
970}
971
972void io_end_buffering_out(void)
973{
974 if (!iobuf_out)
975 return;
976 io_flush(FULL_FLUSH);
977 free(iobuf_out);
978 iobuf_out = NULL;
979 iobuf_f_out = -1;
1f75bb10
WD
980}
981
be91bd81 982void maybe_flush_socket(int important)
626bec8e 983{
be91bd81
WD
984 if (iobuf_out && iobuf_out_cnt
985 && (important || time(NULL) - last_io_out >= 5))
626bec8e
WD
986 io_flush(NORMAL_FLUSH);
987}
988
cdf236aa 989void maybe_send_keepalive(void)
9e2409ab 990{
3b0a30eb 991 if (time(NULL) - last_io_out >= allowed_lull) {
9e2409ab 992 if (!iobuf_out || !iobuf_out_cnt) {
3221f451
WD
993 if (protocol_version < 29)
994 return; /* there's nothing we can do */
8ef246e0 995 if (protocol_version >= 30)
332cf6df 996 send_msg(MSG_NOOP, "", 0, 0);
8ef246e0 997 else {
9decb4d2 998 write_int(sock_f_out, cur_flist->used);
8ef246e0
WD
999 write_shortint(sock_f_out, ITEM_IS_NEW);
1000 }
9e2409ab
WD
1001 }
1002 if (iobuf_out)
1003 io_flush(NORMAL_FLUSH);
1004 }
1005}
1006
8ef246e0
WD
1007void start_flist_forward(int f_in)
1008{
1009 assert(iobuf_out != NULL);
1010 assert(iobuf_f_out == msg_fd_out);
1011 flist_forward_from = f_in;
1012}
1013
1014void stop_flist_forward()
1015{
8ef246e0 1016 flist_forward_from = -1;
dde5b772 1017 io_flush(FULL_FLUSH);
8ef246e0
WD
1018}
1019
880da007
MP
1020/**
1021 * Continue trying to read len bytes - don't return until len has been
1022 * read.
1023 **/
3151cbae 1024static void read_loop(int fd, char *buf, size_t len)
4c36ddbe
AT
1025{
1026 while (len) {
1027 int n = read_timeout(fd, buf, len);
1028
1029 buf += n;
1030 len -= n;
8d9dc9f9
AT
1031 }
1032}
1033
7a55d06e
MP
1034/**
1035 * Read from the file descriptor handling multiplexing - return number
1036 * of bytes read.
d62bcc17
WD
1037 *
1038 * Never returns <= 0.
7a55d06e 1039 */
c399d22a 1040static int readfd_unbuffered(int fd, char *buf, size_t len)
8d9dc9f9 1041{
f2a4853c 1042 size_t msg_bytes;
d8aeda1e 1043 int tag, cnt = 0;
33544bf4 1044 char line[BIGPATHBUFLEN];
8d9dc9f9 1045
8ef246e0 1046 if (!iobuf_in || fd != iobuf_f_in)
4c36ddbe 1047 return read_timeout(fd, buf, len);
8d9dc9f9 1048
8ef246e0
WD
1049 if (!io_multiplexing_in && iobuf_in_remaining == 0) {
1050 iobuf_in_remaining = read_timeout(fd, iobuf_in, iobuf_in_siz);
1f75bb10 1051 iobuf_in_ndx = 0;
76c21947
WD
1052 }
1053
d8aeda1e 1054 while (cnt == 0) {
8ef246e0
WD
1055 if (iobuf_in_remaining) {
1056 len = MIN(len, iobuf_in_remaining);
1f75bb10
WD
1057 memcpy(buf, iobuf_in + iobuf_in_ndx, len);
1058 iobuf_in_ndx += len;
8ef246e0 1059 iobuf_in_remaining -= len;
d8aeda1e 1060 cnt = len;
76c21947 1061 break;
8d9dc9f9
AT
1062 }
1063
909ce14f 1064 read_loop(fd, line, 4);
ff41a59f 1065 tag = IVAL(line, 0);
679e7657 1066
f2a4853c 1067 msg_bytes = tag & 0xFFFFFF;
d17e1dd2 1068 tag = (tag >> 24) - MPLEX_BASE;
8d9dc9f9 1069
7790ee36
WD
1070 check_for_io_err = 0;
1071
d17e1dd2
WD
1072 switch (tag) {
1073 case MSG_DATA:
f2a4853c 1074 if (msg_bytes > iobuf_in_siz) {
1f75bb10 1075 if (!(iobuf_in = realloc_array(iobuf_in, char,
f2a4853c 1076 msg_bytes)))
c399d22a 1077 out_of_memory("readfd_unbuffered");
f2a4853c 1078 iobuf_in_siz = msg_bytes;
76c21947 1079 }
f2a4853c 1080 read_loop(fd, iobuf_in, msg_bytes);
8ef246e0 1081 iobuf_in_remaining = msg_bytes;
1f75bb10 1082 iobuf_in_ndx = 0;
d17e1dd2 1083 break;
8ef246e0
WD
1084 case MSG_NOOP:
1085 if (am_sender)
1086 maybe_send_keepalive();
1087 break;
1088 case MSG_IO_ERROR:
1089 if (msg_bytes != 4)
1090 goto invalid_msg;
1091 read_loop(fd, line, msg_bytes);
e5f35681 1092 send_msg_int(MSG_IO_ERROR, IVAL(line, 0));
8ef246e0
WD
1093 io_error |= IVAL(line, 0);
1094 break;
0d67e00a 1095 case MSG_DELETED:
f2a4853c
WD
1096 if (msg_bytes >= sizeof line)
1097 goto overflow;
332cf6df
WD
1098#ifdef ICONV_OPTION
1099 if (ic_recv != (iconv_t)-1) {
ba525f77
WD
1100 xbuf outbuf, inbuf;
1101 char ibuf[512];
332cf6df 1102 int add_null = 0;
ba525f77
WD
1103 int pos = 0;
1104
1105 INIT_CONST_XBUF(outbuf, line);
ee6e80c7 1106 INIT_XBUF(inbuf, ibuf, 0, -1);
ba525f77 1107
332cf6df 1108 while (msg_bytes) {
ba525f77
WD
1109 inbuf.len = msg_bytes > sizeof ibuf
1110 ? sizeof ibuf : msg_bytes;
1111 read_loop(fd, inbuf.buf, inbuf.len);
1112 if (!(msg_bytes -= inbuf.len)
1113 && !ibuf[inbuf.len-1])
1114 inbuf.len--, add_null = 1;
1115 if (iconvbufs(ic_send, &inbuf, &outbuf,
1116 ICB_INCLUDE_BAD | ICB_INCLUDE_INCOMPLETE) < 0)
1117 goto overflow;
1118 pos = -1;
1119 }
1120 if (add_null) {
1121 if (outbuf.len == outbuf.size)
1122 goto overflow;
1123 outbuf.buf[outbuf.len++] = '\0';
332cf6df 1124 }
ba525f77 1125 msg_bytes = outbuf.len;
332cf6df
WD
1126 } else
1127#endif
1128 read_loop(fd, line, msg_bytes);
0d67e00a 1129 /* A directory name was sent with the trailing null */
f2a4853c 1130 if (msg_bytes > 0 && !line[msg_bytes-1])
0d67e00a 1131 log_delete(line, S_IFDIR);
12bda6f7
WD
1132 else {
1133 line[msg_bytes] = '\0';
0d67e00a 1134 log_delete(line, S_IFREG);
12bda6f7 1135 }
0d67e00a 1136 break;
9981c27e 1137 case MSG_SUCCESS:
f2a4853c 1138 if (msg_bytes != 4) {
8ef246e0 1139 invalid_msg:
cdf236aa 1140 rprintf(FERROR, "invalid multi-message %d:%ld [%s]\n",
f2a4853c 1141 tag, (long)msg_bytes, who_am_i());
9981c27e
WD
1142 exit_cleanup(RERR_STREAMIO);
1143 }
f2a4853c 1144 read_loop(fd, line, msg_bytes);
9981c27e 1145 successful_send(IVAL(line, 0));
9981c27e 1146 break;
8ef246e0
WD
1147 case MSG_NO_SEND:
1148 if (msg_bytes != 4)
1149 goto invalid_msg;
1150 read_loop(fd, line, msg_bytes);
1151 send_msg_int(MSG_NO_SEND, IVAL(line, 0));
1152 break;
d17e1dd2
WD
1153 case MSG_INFO:
1154 case MSG_ERROR:
3f0211b6
WD
1155 case MSG_ERROR_XFER:
1156 case MSG_WARNING:
f2a4853c
WD
1157 if (msg_bytes >= sizeof line) {
1158 overflow:
bd9fca47 1159 rprintf(FERROR,
cdf236aa 1160 "multiplexing overflow %d:%ld [%s]\n",
f2a4853c 1161 tag, (long)msg_bytes, who_am_i());
d17e1dd2
WD
1162 exit_cleanup(RERR_STREAMIO);
1163 }
f2a4853c 1164 read_loop(fd, line, msg_bytes);
332cf6df 1165 rwrite((enum logcode)tag, line, msg_bytes, 1);
7f9bf6b7
WD
1166 if (first_message) {
1167 if (list_only && !am_sender && tag == 1) {
1168 line[msg_bytes] = '\0';
1169 check_for_d_option_error(line);
1170 }
1171 first_message = 0;
1172 }
d17e1dd2
WD
1173 break;
1174 default:
cdf236aa
WD
1175 rprintf(FERROR, "unexpected tag %d [%s]\n",
1176 tag, who_am_i());
65417579 1177 exit_cleanup(RERR_STREAMIO);
8d9dc9f9 1178 }
8d9dc9f9
AT
1179 }
1180
8ef246e0 1181 if (iobuf_in_remaining == 0)
d17e1dd2 1182 io_flush(NORMAL_FLUSH);
76c21947 1183
d8aeda1e 1184 return cnt;
8d9dc9f9
AT
1185}
1186
dde5b772
WD
1187/* Do a buffered read from fd. Don't return until all N bytes have
1188 * been read. If all N can't be read then exit with an error. */
3151cbae 1189static void readfd(int fd, char *buffer, size_t N)
720b47f2 1190{
d8aeda1e 1191 int cnt;
d62bcc17 1192 size_t total = 0;
3151cbae 1193
6ba9279f 1194 while (total < N) {
d8aeda1e
WD
1195 cnt = readfd_unbuffered(fd, buffer + total, N-total);
1196 total += cnt;
7f28dbee 1197 }
1b7c47cb 1198
b9f592fb
WD
1199 if (fd == write_batch_monitor_in) {
1200 if ((size_t)write(batch_fd, buffer, total) != total)
1201 exit_cleanup(RERR_FILEIO);
1202 }
1f75bb10 1203
8ef246e0
WD
1204 if (fd == flist_forward_from)
1205 writefd(iobuf_f_out, buffer, total);
1206
1f75bb10
WD
1207 if (fd == sock_f_in)
1208 stats.total_read += total;
720b47f2
AT
1209}
1210
3a993aa4 1211unsigned short read_shortint(int f)
9361f839 1212{
482f48cc
WD
1213 char b[2];
1214 readfd(f, b, 2);
1215 return (UVAL(b, 1) << 8) + UVAL(b, 0);
9361f839
WD
1216}
1217
b7922338 1218int32 read_int(int f)
720b47f2 1219{
4c36ddbe 1220 char b[4];
d8aeda1e 1221 int32 num;
d730b113 1222
482f48cc
WD
1223 readfd(f, b, 4);
1224 num = IVAL(b, 0);
1225#if SIZEOF_INT32 > 4
1226 if (num & (int32)0x80000000)
1227 num |= ~(int32)0xffffffff;
1228#endif
d8aeda1e 1229 return num;
720b47f2
AT
1230}
1231
351e23ad 1232int32 read_varint(int f)
3a6a366f 1233{
351e23ad
WD
1234 union {
1235 char b[5];
1236 int32 x;
1237 } u;
1238 uchar ch;
1239 int extra;
1240
1241 u.x = 0;
1242 readfd(f, (char*)&ch, 1);
1243 extra = int_byte_extra[ch / 4];
1244 if (extra) {
1245 uchar bit = ((uchar)1<<(8-extra));
1246 if (extra >= (int)sizeof u.b) {
1247 rprintf(FERROR, "Overflow in read_varint()\n");
1248 exit_cleanup(RERR_STREAMIO);
1249 }
1250 readfd(f, u.b, extra);
1251 u.b[extra] = ch & (bit-1);
1252 } else
1253 u.b[0] = ch;
1254#if CAREFUL_ALIGNMENT
1255 u.x = IVAL(u.b,0);
1256#endif
1257#if SIZEOF_INT32 > 4
1258 if (u.x & (int32)0x80000000)
1259 u.x |= ~(int32)0xffffffff;
1260#endif
1261 return u.x;
1262}
71c46176 1263
351e23ad
WD
1264int64 read_varlong(int f, uchar min_bytes)
1265{
1266 union {
1267 char b[9];
1268 int64 x;
1269 } u;
1270 char b2[8];
1271 int extra;
71c46176 1272
031fa9ad 1273#if SIZEOF_INT64 < 8
351e23ad 1274 memset(u.b, 0, 8);
031fa9ad 1275#else
351e23ad 1276 u.x = 0;
031fa9ad 1277#endif
351e23ad
WD
1278 readfd(f, b2, min_bytes);
1279 memcpy(u.b, b2+1, min_bytes-1);
1280 extra = int_byte_extra[CVAL(b2, 0) / 4];
1281 if (extra) {
1282 uchar bit = ((uchar)1<<(8-extra));
1283 if (min_bytes + extra > (int)sizeof u.b) {
1284 rprintf(FERROR, "Overflow in read_varlong()\n");
1285 exit_cleanup(RERR_STREAMIO);
1286 }
1287 readfd(f, u.b + min_bytes - 1, extra);
1288 u.b[min_bytes + extra - 1] = CVAL(b2, 0) & (bit-1);
4ea4acf1 1289#if SIZEOF_INT64 < 8
351e23ad 1290 if (min_bytes + extra > 5 || u.b[4] || CVAL(u.b,3) & 0x80) {
4ea4acf1
WD
1291 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1292 exit_cleanup(RERR_UNSUPPORTED);
1293 }
1294#endif
351e23ad
WD
1295 } else
1296 u.b[min_bytes + extra - 1] = CVAL(b2, 0);
1297#if SIZEOF_INT64 < 8
1298 u.x = IVAL(u.b,0);
1299#elif CAREFUL_ALIGNMENT
1300 u.x = IVAL(u.b,0) | (((int64)IVAL(u.b,4))<<32);
1301#endif
1302 return u.x;
1303}
1304
1305int64 read_longint(int f)
1306{
4ea4acf1 1307#if SIZEOF_INT64 >= 8
351e23ad 1308 char b[9];
4ea4acf1 1309#endif
351e23ad 1310 int32 num = read_int(f);
71c46176 1311
351e23ad
WD
1312 if (num != (int32)0xffffffff)
1313 return num;
1314
1315#if SIZEOF_INT64 < 8
1316 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1317 exit_cleanup(RERR_UNSUPPORTED);
1318#else
1319 readfd(f, b, 8);
1320 return IVAL(b,0) | (((int64)IVAL(b,4))<<32);
1321#endif
3a6a366f
AT
1322}
1323
4a19c3b2 1324void read_buf(int f, char *buf, size_t len)
720b47f2 1325{
4c36ddbe 1326 readfd(f,buf,len);
720b47f2
AT
1327}
1328
4a19c3b2 1329void read_sbuf(int f, char *buf, size_t len)
575f2fca 1330{
93095cbe 1331 readfd(f, buf, len);
af436313 1332 buf[len] = '\0';
575f2fca
AT
1333}
1334
9361f839 1335uchar read_byte(int f)
182dca5c 1336{
9361f839 1337 uchar c;
93095cbe 1338 readfd(f, (char *)&c, 1);
4c36ddbe 1339 return c;
182dca5c 1340}
720b47f2 1341
46e99b09
WD
1342int read_vstring(int f, char *buf, int bufsize)
1343{
1344 int len = read_byte(f);
1345
1346 if (len & 0x80)
1347 len = (len & ~0x80) * 0x100 + read_byte(f);
1348
1349 if (len >= bufsize) {
1350 rprintf(FERROR, "over-long vstring received (%d > %d)\n",
1351 len, bufsize - 1);
9a6ed83f 1352 return -1;
46e99b09
WD
1353 }
1354
1355 if (len)
1356 readfd(f, buf, len);
1357 buf[len] = '\0';
1358 return len;
1359}
1360
188fed95
WD
1361/* Populate a sum_struct with values from the socket. This is
1362 * called by both the sender and the receiver. */
1363void read_sum_head(int f, struct sum_struct *sum)
1364{
8bd77e70 1365 int32 max_blength = protocol_version < 30 ? OLD_MAX_BLOCK_SIZE : MAX_BLOCK_SIZE;
188fed95 1366 sum->count = read_int(f);
c638caa6
WD
1367 if (sum->count < 0) {
1368 rprintf(FERROR, "Invalid checksum count %ld [%s]\n",
1369 (long)sum->count, who_am_i());
1370 exit_cleanup(RERR_PROTOCOL);
1371 }
188fed95 1372 sum->blength = read_int(f);
8bd77e70 1373 if (sum->blength < 0 || sum->blength > max_blength) {
cdf236aa
WD
1374 rprintf(FERROR, "Invalid block length %ld [%s]\n",
1375 (long)sum->blength, who_am_i());
188fed95
WD
1376 exit_cleanup(RERR_PROTOCOL);
1377 }
1378 sum->s2length = protocol_version < 27 ? csum_length : (int)read_int(f);
a0456b9c 1379 if (sum->s2length < 0 || sum->s2length > MAX_DIGEST_LEN) {
cdf236aa
WD
1380 rprintf(FERROR, "Invalid checksum length %d [%s]\n",
1381 sum->s2length, who_am_i());
188fed95
WD
1382 exit_cleanup(RERR_PROTOCOL);
1383 }
1384 sum->remainder = read_int(f);
1385 if (sum->remainder < 0 || sum->remainder > sum->blength) {
cdf236aa
WD
1386 rprintf(FERROR, "Invalid remainder length %ld [%s]\n",
1387 (long)sum->remainder, who_am_i());
188fed95
WD
1388 exit_cleanup(RERR_PROTOCOL);
1389 }
1390}
1391
c207d7ec
WD
1392/* Send the values from a sum_struct over the socket. Set sum to
1393 * NULL if there are no checksums to send. This is called by both
1394 * the generator and the sender. */
1395void write_sum_head(int f, struct sum_struct *sum)
1396{
1397 static struct sum_struct null_sum;
1398
1399 if (sum == NULL)
1400 sum = &null_sum;
1401
1402 write_int(f, sum->count);
1403 write_int(f, sum->blength);
1404 if (protocol_version >= 27)
1405 write_int(f, sum->s2length);
1406 write_int(f, sum->remainder);
1407}
1408
08571358
MP
1409/**
1410 * Sleep after writing to limit I/O bandwidth usage.
1411 *
1412 * @todo Rather than sleeping after each write, it might be better to
1413 * use some kind of averaging. The current algorithm seems to always
1414 * use a bit less bandwidth than specified, because it doesn't make up
1415 * for slow periods. But arguably this is a feature. In addition, we
1416 * ought to take the time used to write the data into account.
71e58630
WD
1417 *
1418 * During some phases of big transfers (file FOO is uptodate) this is
1419 * called with a small bytes_written every time. As the kernel has to
1420 * round small waits up to guarantee that we actually wait at least the
1421 * requested number of microseconds, this can become grossly inaccurate.
1422 * We therefore keep track of the bytes we've written over time and only
1423 * sleep when the accumulated delay is at least 1 tenth of a second.
08571358
MP
1424 **/
1425static void sleep_for_bwlimit(int bytes_written)
1426{
71e58630 1427 static struct timeval prior_tv;
0f78b815 1428 static long total_written = 0;
71e58630
WD
1429 struct timeval tv, start_tv;
1430 long elapsed_usec, sleep_usec;
1431
1432#define ONE_SEC 1000000L /* # of microseconds in a second */
08571358 1433
9a0cfff5 1434 if (!bwlimit_writemax)
08571358 1435 return;
e681e820 1436
0f78b815 1437 total_written += bytes_written;
71e58630
WD
1438
1439 gettimeofday(&start_tv, NULL);
1440 if (prior_tv.tv_sec) {
1441 elapsed_usec = (start_tv.tv_sec - prior_tv.tv_sec) * ONE_SEC
1442 + (start_tv.tv_usec - prior_tv.tv_usec);
1443 total_written -= elapsed_usec * bwlimit / (ONE_SEC/1024);
1444 if (total_written < 0)
1445 total_written = 0;
1446 }
3151cbae 1447
71e58630
WD
1448 sleep_usec = total_written * (ONE_SEC/1024) / bwlimit;
1449 if (sleep_usec < ONE_SEC / 10) {
1450 prior_tv = start_tv;
1451 return;
1452 }
08571358 1453
71e58630
WD
1454 tv.tv_sec = sleep_usec / ONE_SEC;
1455 tv.tv_usec = sleep_usec % ONE_SEC;
98b332ed 1456 select(0, NULL, NULL, NULL, &tv);
71e58630
WD
1457
1458 gettimeofday(&prior_tv, NULL);
1459 elapsed_usec = (prior_tv.tv_sec - start_tv.tv_sec) * ONE_SEC
1460 + (prior_tv.tv_usec - start_tv.tv_usec);
1461 total_written = (sleep_usec - elapsed_usec) * bwlimit / (ONE_SEC/1024);
08571358
MP
1462}
1463
1f75bb10 1464/* Write len bytes to the file descriptor fd, looping as necessary to get
0fb2fc4a 1465 * the job done and also (in certain circumstances) reading any data on
af436313 1466 * msg_fd_in to avoid deadlock.
880da007
MP
1467 *
1468 * This function underlies the multiplexing system. The body of the
1f75bb10 1469 * application never calls this function directly. */
4a19c3b2 1470static void writefd_unbuffered(int fd, const char *buf, size_t len)
720b47f2 1471{
1ea087a7 1472 size_t n, total = 0;
6c850772 1473 fd_set w_fds, r_fds, e_fds;
d8aeda1e 1474 int maxfd, count, cnt, using_r_fds;
e4c877cf 1475 int defer_inc = 0;
8d9dc9f9 1476 struct timeval tv;
720b47f2 1477
3be97bf9 1478 if (no_flush++)
e4c877cf 1479 defer_forwarding_messages++, defer_inc++;
e44f9a12 1480
4c36ddbe 1481 while (total < len) {
8d9dc9f9 1482 FD_ZERO(&w_fds);
6c850772
WD
1483 FD_SET(fd, &w_fds);
1484 FD_ZERO(&e_fds);
1485 FD_SET(fd, &e_fds);
1ea087a7 1486 maxfd = fd;
4c36ddbe 1487
954bbed8 1488 if (msg_fd_in >= 0) {
56014c8c 1489 FD_ZERO(&r_fds);
6c850772 1490 FD_SET(msg_fd_in, &r_fds);
1ea087a7
WD
1491 if (msg_fd_in > maxfd)
1492 maxfd = msg_fd_in;
3eeac9bc
WD
1493 using_r_fds = 1;
1494 } else
1495 using_r_fds = 0;
8d9dc9f9 1496
e626b29e 1497 tv.tv_sec = select_timeout;
8d9dc9f9 1498 tv.tv_usec = 0;
4c36ddbe 1499
554e0a8d 1500 errno = 0;
3eeac9bc 1501 count = select(maxfd + 1, using_r_fds ? &r_fds : NULL,
6c850772 1502 &w_fds, &e_fds, &tv);
4c36ddbe
AT
1503
1504 if (count <= 0) {
1ea087a7 1505 if (count < 0 && errno == EBADF)
554e0a8d 1506 exit_cleanup(RERR_SOCKETIO);
bd717af8 1507 check_timeout();
8d9dc9f9
AT
1508 continue;
1509 }
4c36ddbe 1510
35c8fd76
WD
1511 /*if (FD_ISSET(fd, &e_fds))
1512 rprintf(FINFO, "select exception on fd %d\n", fd); */
6c850772 1513
3eeac9bc 1514 if (using_r_fds && FD_ISSET(msg_fd_in, &r_fds))
d17e1dd2 1515 read_msg_fd();
554e0a8d 1516
9a6ed83f 1517 if (!FD_ISSET(fd, &w_fds))
1ea087a7 1518 continue;
4c36ddbe 1519
1ea087a7 1520 n = len - total;
9a0cfff5 1521 if (bwlimit_writemax && n > bwlimit_writemax)
1ea087a7 1522 n = bwlimit_writemax;
d8aeda1e 1523 cnt = write(fd, buf + total, n);
1ea087a7 1524
d8aeda1e
WD
1525 if (cnt <= 0) {
1526 if (cnt < 0) {
3309507d
WD
1527 if (errno == EINTR)
1528 continue;
1529 if (errno == EWOULDBLOCK || errno == EAGAIN) {
1530 msleep(1);
1531 continue;
1532 }
f0359dd0
AT
1533 }
1534
1ea087a7 1535 /* Don't try to write errors back across the stream. */
1f75bb10 1536 if (fd == sock_f_out)
8ef246e0 1537 io_end_multiplex_out();
2a5df862
WD
1538 /* Don't try to write errors down a failing msg pipe. */
1539 if (am_server && fd == msg_fd_out)
1540 exit_cleanup(RERR_STREAMIO);
1ea087a7 1541 rsyserr(FERROR, errno,
b88c2e8f
WD
1542 "writefd_unbuffered failed to write %ld bytes [%s]",
1543 (long)len, who_am_i());
d1b31da7
WD
1544 /* If the other side is sending us error messages, try
1545 * to grab any messages they sent before they died. */
f2179fd3 1546 while (!am_server && fd == sock_f_out && io_multiplexing_in) {
ba525f77 1547 char buf[1024];
3b0a30eb 1548 set_io_timeout(30);
9e2409ab 1549 ignore_timeout = 0;
ba525f77 1550 readfd_unbuffered(sock_f_in, buf, sizeof buf);
d1b31da7 1551 }
1ea087a7
WD
1552 exit_cleanup(RERR_STREAMIO);
1553 }
4c36ddbe 1554
d8aeda1e 1555 total += cnt;
e4c877cf 1556 defer_forwarding_messages++, defer_inc++;
a800434a 1557
1f75bb10 1558 if (fd == sock_f_out) {
626bec8e 1559 if (io_timeout || am_generator)
3b0a30eb 1560 last_io_out = time(NULL);
d8aeda1e 1561 sleep_for_bwlimit(cnt);
1f75bb10 1562 }
4c36ddbe 1563 }
e44f9a12
AT
1564
1565 no_flush--;
17a4977b
WD
1566 defer_inc -= defer_forwarding_keep;
1567 if (!(defer_forwarding_messages -= defer_inc) && !no_flush)
e4c877cf 1568 msg_flush();
d6dead6b
AT
1569}
1570
dde5b772 1571void io_flush(int flush_it_all)
d6dead6b 1572{
1f75bb10 1573 if (!iobuf_out_cnt || no_flush)
d17e1dd2 1574 return;
8d9dc9f9 1575
d17e1dd2 1576 if (io_multiplexing_out)
332cf6df 1577 mplex_write(sock_f_out, MSG_DATA, iobuf_out, iobuf_out_cnt, 0);
d17e1dd2 1578 else
8ef246e0 1579 writefd_unbuffered(iobuf_f_out, iobuf_out, iobuf_out_cnt);
1f75bb10 1580 iobuf_out_cnt = 0;
e4c877cf
WD
1581
1582 if (flush_it_all && !defer_forwarding_messages)
1583 msg_flush();
8d9dc9f9
AT
1584}
1585
4a19c3b2 1586static void writefd(int fd, const char *buf, size_t len)
d6dead6b 1587{
1f75bb10
WD
1588 if (fd == sock_f_out)
1589 stats.total_written += len;
1590
b9f592fb
WD
1591 if (fd == write_batch_monitor_out) {
1592 if ((size_t)write(batch_fd, buf, len) != len)
1593 exit_cleanup(RERR_FILEIO);
1594 }
1595
8ef246e0 1596 if (!iobuf_out || fd != iobuf_f_out) {
4c36ddbe
AT
1597 writefd_unbuffered(fd, buf, len);
1598 return;
1599 }
d6dead6b
AT
1600
1601 while (len) {
1f75bb10 1602 int n = MIN((int)len, IO_BUFFER_SIZE - iobuf_out_cnt);
d6dead6b 1603 if (n > 0) {
1f75bb10 1604 memcpy(iobuf_out+iobuf_out_cnt, buf, n);
d6dead6b
AT
1605 buf += n;
1606 len -= n;
1f75bb10 1607 iobuf_out_cnt += n;
d6dead6b 1608 }
3151cbae 1609
1f75bb10 1610 if (iobuf_out_cnt == IO_BUFFER_SIZE)
d17e1dd2 1611 io_flush(NORMAL_FLUSH);
d6dead6b 1612 }
d6dead6b 1613}
720b47f2 1614
3a993aa4 1615void write_shortint(int f, unsigned short x)
9361f839 1616{
3a993aa4
WD
1617 char b[2];
1618 b[0] = (char)x;
1619 b[1] = (char)(x >> 8);
1620 writefd(f, b, 2);
9361f839
WD
1621}
1622
351e23ad
WD
1623void write_int(int f, int32 x)
1624{
1625 char b[4];
1626 SIVAL(b, 0, x);
1627 writefd(f, b, 4);
1628}
1629
f31514ad 1630void write_varint(int f, int32 x)
1c3344a1
WD
1631{
1632 char b[5];
351e23ad
WD
1633 uchar bit;
1634 int cnt = 4;
1635
1636 SIVAL(b, 1, x);
1637
1638 while (cnt > 1 && b[cnt] == 0)
1639 cnt--;
1640 bit = ((uchar)1<<(7-cnt+1));
1641 if (CVAL(b, cnt) >= bit) {
1642 cnt++;
1643 *b = ~(bit-1);
1644 } else if (cnt > 1)
1645 *b = b[cnt] | ~(bit*2-1);
1646 else
1647 *b = b[cnt];
1648
1649 writefd(f, b, cnt);
1c3344a1
WD
1650}
1651
351e23ad 1652void write_varlong(int f, int64 x, uchar min_bytes)
720b47f2 1653{
351e23ad
WD
1654 char b[9];
1655 uchar bit;
1656 int cnt = 8;
1657
1658 SIVAL(b, 1, x);
1659#if SIZEOF_INT64 >= 8
1660 SIVAL(b, 5, x >> 32);
1661#else
1662 if (x <= 0x7FFFFFFF && x >= 0)
1663 memset(b + 5, 0, 4);
1664 else {
1665 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1666 exit_cleanup(RERR_UNSUPPORTED);
1667 }
1668#endif
1669
1670 while (cnt > min_bytes && b[cnt] == 0)
1671 cnt--;
1672 bit = ((uchar)1<<(7-cnt+min_bytes));
1673 if (CVAL(b, cnt) >= bit) {
1674 cnt++;
1675 *b = ~(bit-1);
1676 } else if (cnt > min_bytes)
1677 *b = b[cnt] | ~(bit*2-1);
1678 else
1679 *b = b[cnt];
1680
1681 writefd(f, b, cnt);
720b47f2
AT
1682}
1683
7a24c346
MP
1684/*
1685 * Note: int64 may actually be a 32-bit type if ./configure couldn't find any
1686 * 64-bit types on this platform.
1687 */
71c46176 1688void write_longint(int f, int64 x)
3a6a366f 1689{
351e23ad 1690 char b[12], * const s = b+4;
3a6a366f 1691
351e23ad
WD
1692 SIVAL(s, 0, x);
1693 if (x <= 0x7FFFFFFF && x >= 0) {
482f48cc 1694 writefd(f, s, 4);
351e23ad
WD
1695 return;
1696 }
3a6a366f 1697
4ea4acf1 1698#if SIZEOF_INT64 < 8
351e23ad
WD
1699 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1700 exit_cleanup(RERR_UNSUPPORTED);
4ea4acf1 1701#else
351e23ad
WD
1702 memset(b, 0xFF, 4);
1703 SIVAL(s, 4, x >> 32);
1704 writefd(f, b, 12);
4ea4acf1 1705#endif
3a6a366f
AT
1706}
1707
4a19c3b2 1708void write_buf(int f, const char *buf, size_t len)
720b47f2 1709{
4c36ddbe 1710 writefd(f,buf,len);
720b47f2
AT
1711}
1712
880da007 1713/** Write a string to the connection */
4a19c3b2 1714void write_sbuf(int f, const char *buf)
f0fca04e 1715{
93095cbe 1716 writefd(f, buf, strlen(buf));
f0fca04e
AT
1717}
1718
9361f839 1719void write_byte(int f, uchar c)
182dca5c 1720{
93095cbe 1721 writefd(f, (char *)&c, 1);
182dca5c
AT
1722}
1723
4a19c3b2 1724void write_vstring(int f, const char *str, int len)
46e99b09
WD
1725{
1726 uchar lenbuf[3], *lb = lenbuf;
1727
1728 if (len > 0x7F) {
1729 if (len > 0x7FFF) {
1730 rprintf(FERROR,
1731 "attempting to send over-long vstring (%d > %d)\n",
1732 len, 0x7FFF);
1733 exit_cleanup(RERR_PROTOCOL);
1734 }
1735 *lb++ = len / 0x100 + 0x80;
1736 }
1737 *lb = len;
1738
1739 writefd(f, (char*)lenbuf, lb - lenbuf + 1);
1740 if (len)
1741 writefd(f, str, len);
1742}
1743
8a65e0ce
WD
1744/* Send a file-list index using a byte-reduction method. */
1745void write_ndx(int f, int32 ndx)
1746{
1747 static int32 prev_positive = -1, prev_negative = 1;
1748 int32 diff, cnt = 0;
1749 char b[6];
1750
1751 if (protocol_version < 30 || read_batch) {
1752 write_int(f, ndx);
1753 return;
1754 }
1755
1756 /* Send NDX_DONE as a single-byte 0 with no side effects. Send
1757 * negative nums as a positive after sending a leading 0xFF. */
1758 if (ndx >= 0) {
1759 diff = ndx - prev_positive;
1760 prev_positive = ndx;
1761 } else if (ndx == NDX_DONE) {
1762 *b = 0;
1763 writefd(f, b, 1);
1764 return;
1765 } else {
1766 b[cnt++] = (char)0xFF;
1767 ndx = -ndx;
1768 diff = ndx - prev_negative;
1769 prev_negative = ndx;
1770 }
1771
1772 /* A diff of 1 - 253 is sent as a one-byte diff; a diff of 254 - 32767
1773 * or 0 is sent as a 0xFE + a two-byte diff; otherwise we send 0xFE
1774 * & all 4 bytes of the (non-negative) num with the high-bit set. */
1775 if (diff < 0xFE && diff > 0)
1776 b[cnt++] = (char)diff;
1777 else if (diff < 0 || diff > 0x7FFF) {
1778 b[cnt++] = (char)0xFE;
1779 b[cnt++] = (char)((ndx >> 24) | 0x80);
8a65e0ce 1780 b[cnt++] = (char)ndx;
351e23ad
WD
1781 b[cnt++] = (char)(ndx >> 8);
1782 b[cnt++] = (char)(ndx >> 16);
8a65e0ce
WD
1783 } else {
1784 b[cnt++] = (char)0xFE;
1785 b[cnt++] = (char)(diff >> 8);
1786 b[cnt++] = (char)diff;
1787 }
1788 writefd(f, b, cnt);
1789}
1790
1791/* Receive a file-list index using a byte-reduction method. */
1792int32 read_ndx(int f)
1793{
1794 static int32 prev_positive = -1, prev_negative = 1;
1795 int32 *prev_ptr, num;
1796 char b[4];
1797
1798 if (protocol_version < 30)
1799 return read_int(f);
1800
1801 readfd(f, b, 1);
1802 if (CVAL(b, 0) == 0xFF) {
1803 readfd(f, b, 1);
1804 prev_ptr = &prev_negative;
1805 } else if (CVAL(b, 0) == 0)
1806 return NDX_DONE;
1807 else
1808 prev_ptr = &prev_positive;
1809 if (CVAL(b, 0) == 0xFE) {
1810 readfd(f, b, 2);
1811 if (CVAL(b, 0) & 0x80) {
351e23ad
WD
1812 b[3] = CVAL(b, 0) & ~0x80;
1813 b[0] = b[1];
1814 readfd(f, b+1, 2);
1815 num = IVAL(b, 0);
8a65e0ce 1816 } else
351e23ad 1817 num = (UVAL(b,0)<<8) + UVAL(b,1) + *prev_ptr;
8a65e0ce 1818 } else
351e23ad 1819 num = UVAL(b, 0) + *prev_ptr;
8a65e0ce
WD
1820 *prev_ptr = num;
1821 if (prev_ptr == &prev_negative)
1822 num = -num;
1823 return num;
1824}
1825
67b8f3df
WD
1826/* Read a line of up to bufsiz-1 characters into buf. Strips
1827 * the (required) trailing newline and all carriage returns.
1828 * Returns 1 for success; 0 for I/O error or truncation. */
1829int read_line_old(int f, char *buf, size_t bufsiz)
f0fca04e 1830{
67b8f3df
WD
1831 bufsiz--; /* leave room for the null */
1832 while (bufsiz > 0) {
528bfcd7 1833 buf[0] = 0;
f0fca04e 1834 read_buf(f, buf, 1);
914cc65c
MP
1835 if (buf[0] == 0)
1836 return 0;
6ed6d7f5 1837 if (buf[0] == '\n')
f0fca04e 1838 break;
f0fca04e
AT
1839 if (buf[0] != '\r') {
1840 buf++;
67b8f3df 1841 bufsiz--;
f0fca04e
AT
1842 }
1843 }
6ed6d7f5 1844 *buf = '\0';
67b8f3df 1845 return bufsiz > 0;
f0fca04e
AT
1846}
1847
f0fca04e
AT
1848void io_printf(int fd, const char *format, ...)
1849{
d62bcc17 1850 va_list ap;
33544bf4 1851 char buf[BIGPATHBUFLEN];
f0fca04e 1852 int len;
3151cbae 1853
f0fca04e 1854 va_start(ap, format);
3151cbae 1855 len = vsnprintf(buf, sizeof buf, format, ap);
f0fca04e
AT
1856 va_end(ap);
1857
f89b9368
WD
1858 if (len < 0)
1859 exit_cleanup(RERR_STREAMIO);
f0fca04e 1860
33544bf4
WD
1861 if (len > (int)sizeof buf) {
1862 rprintf(FERROR, "io_printf() was too long for the buffer.\n");
1863 exit_cleanup(RERR_STREAMIO);
1864 }
1865
f0fca04e
AT
1866 write_sbuf(fd, buf);
1867}
8d9dc9f9 1868
d17e1dd2 1869/** Setup for multiplexing a MSG_* stream with the data stream. */
1f75bb10 1870void io_start_multiplex_out(void)
8d9dc9f9 1871{
d17e1dd2 1872 io_flush(NORMAL_FLUSH);
8ef246e0 1873 io_start_buffering_out(sock_f_out);
8d9dc9f9
AT
1874 io_multiplexing_out = 1;
1875}
1876
d17e1dd2 1877/** Setup for multiplexing a MSG_* stream with the data stream. */
1f75bb10 1878void io_start_multiplex_in(void)
8d9dc9f9 1879{
d17e1dd2 1880 io_flush(NORMAL_FLUSH);
8ef246e0 1881 io_start_buffering_in(sock_f_in);
8d9dc9f9
AT
1882 io_multiplexing_in = 1;
1883}
1884
d17e1dd2 1885/** Write an message to the multiplexed data stream. */
332cf6df 1886int io_multiplex_write(enum msgcode code, const char *buf, size_t len, int convert)
8d9dc9f9 1887{
f89b9368
WD
1888 if (!io_multiplexing_out)
1889 return 0;
d17e1dd2 1890 io_flush(NORMAL_FLUSH);
1b7c47cb 1891 stats.total_written += (len+4);
332cf6df 1892 mplex_write(sock_f_out, code, buf, len, convert);
8d9dc9f9
AT
1893 return 1;
1894}
1895
8ef246e0 1896void io_end_multiplex_in(void)
7f459268
WD
1897{
1898 io_multiplexing_in = 0;
8ef246e0 1899 io_end_buffering_in();
7f459268
WD
1900}
1901
d17e1dd2 1902/** Stop output multiplexing. */
8ef246e0 1903void io_end_multiplex_out(void)
554e0a8d
AT
1904{
1905 io_multiplexing_out = 0;
8ef246e0 1906 io_end_buffering_out();
554e0a8d
AT
1907}
1908
b9f592fb
WD
1909void start_write_batch(int fd)
1910{
1911 /* Some communication has already taken place, but we don't
1912 * enable batch writing until here so that we can write a
1913 * canonical record of the communication even though the
1914 * actual communication so far depends on whether a daemon
1915 * is involved. */
1916 write_int(batch_fd, protocol_version);
71456d30
WD
1917 if (protocol_version >= 30)
1918 write_byte(batch_fd, inc_recurse);
b9f592fb 1919 write_int(batch_fd, checksum_seed);
b9f592fb
WD
1920
1921 if (am_sender)
1922 write_batch_monitor_out = fd;
1923 else
1924 write_batch_monitor_in = fd;
1925}
1926
1927void stop_write_batch(void)
1928{
1929 write_batch_monitor_out = -1;
1930 write_batch_monitor_in = -1;
1931}