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