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