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