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