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