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