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