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