Change some size_t vars to ints.
[rsync.git] / io.c
blobe8d228cafa5768ba02144687fd4a9bc65251d9fa
1 /*
2 * Socket and pipe I/O utilities used in rsync.
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-2008 Wayne Davison
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.
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.
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.
23 /* Rsync provides its own multiplexing system, which is used to send
24 * stderr and stdout over a single socket.
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(). */
30 #include "rsync.h"
31 #include "ifuncs.h"
33 /** If no timeout is specified then use a 60 second select timeout */
34 #define SELECT_TIMEOUT 60
36 extern int bwlimit;
37 extern size_t bwlimit_writemax;
38 extern int io_timeout;
39 extern int allowed_lull;
40 extern int am_server;
41 extern int am_daemon;
42 extern int am_sender;
43 extern int am_generator;
44 extern int inc_recurse;
45 extern int io_error;
46 extern int eol_nulls;
47 extern int flist_eof;
48 extern int list_only;
49 extern int read_batch;
50 extern int csum_length;
51 extern int protect_args;
52 extern int checksum_seed;
53 extern int protocol_version;
54 extern int remove_source_files;
55 extern int preserve_hard_links;
56 extern struct stats stats;
57 extern struct file_list *cur_flist;
58 #ifdef ICONV_OPTION
59 extern int filesfrom_convert;
60 extern iconv_t ic_send, ic_recv;
61 #endif
63 const char phase_unknown[] = "unknown";
64 int ignore_timeout = 0;
65 int batch_fd = -1;
66 int msgdone_cnt = 0;
68 /* Ignore an EOF error if non-zero. See whine_about_eof(). */
69 int kluge_around_eof = 0;
71 int msg_fd_in = -1;
72 int msg_fd_out = -1;
73 int sock_f_in = -1;
74 int sock_f_out = -1;
76 static int iobuf_f_in = -1;
77 static char *iobuf_in;
78 static size_t iobuf_in_siz;
79 static size_t iobuf_in_ndx;
80 static size_t iobuf_in_remaining;
82 static int iobuf_f_out = -1;
83 static char *iobuf_out;
84 static int iobuf_out_cnt;
86 int flist_forward_from = -1;
88 static int io_multiplexing_out;
89 static int io_multiplexing_in;
90 static time_t last_io_in;
91 static time_t last_io_out;
92 static int no_flush;
94 static int write_batch_monitor_in = -1;
95 static int write_batch_monitor_out = -1;
97 static int io_filesfrom_f_in = -1;
98 static int io_filesfrom_f_out = -1;
99 static xbuf ff_buf = EMPTY_XBUF;
100 static char ff_lastchar;
101 #ifdef ICONV_OPTION
102 static xbuf iconv_buf = EMPTY_XBUF;
103 #endif
104 static int defer_forwarding_messages = 0, keep_defer_forwarding = 0;
105 static int select_timeout = SELECT_TIMEOUT;
106 static int active_filecnt = 0;
107 static OFF_T active_bytecnt = 0;
108 static int first_message = 1;
110 static char int_byte_extra[64] = {
111 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* (00 - 3F)/4 */
112 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* (40 - 7F)/4 */
113 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /* (80 - BF)/4 */
114 2, 2, 2, 2, 2, 2, 2, 2, 3, 3, 3, 3, 4, 4, 5, 6, /* (C0 - FF)/4 */
117 #define REMOTE_OPTION_ERROR "rsync: on remote machine: -"
118 #define REMOTE_OPTION_ERROR2 ": unknown option"
120 enum festatus { FES_SUCCESS, FES_REDO, FES_NO_SEND };
122 static void readfd(int fd, char *buffer, size_t N);
123 static void writefd(int fd, const char *buf, size_t len);
124 static void writefd_unbuffered(int fd, const char *buf, size_t len);
125 static void mplex_write(int fd, enum msgcode code, const char *buf, size_t len, int convert);
127 static flist_ndx_list redo_list, hlink_list;
129 struct msg_list_item {
130 struct msg_list_item *next;
131 char convert;
132 char buf[1];
135 struct msg_list {
136 struct msg_list_item *head, *tail;
139 static struct msg_list msg_queue;
141 static void got_flist_entry_status(enum festatus status, const char *buf)
143 int ndx = IVAL(buf, 0);
144 struct file_list *flist = flist_for_ndx(ndx, "got_flist_entry_status");
146 if (remove_source_files) {
147 active_filecnt--;
148 active_bytecnt -= F_LENGTH(flist->files[ndx - flist->ndx_start]);
151 if (inc_recurse)
152 flist->in_progress--;
154 switch (status) {
155 case FES_SUCCESS:
156 if (remove_source_files)
157 send_msg(MSG_SUCCESS, buf, 4, 0);
158 if (preserve_hard_links) {
159 struct file_struct *file = flist->files[ndx - flist->ndx_start];
160 if (F_IS_HLINKED(file)) {
161 flist_ndx_push(&hlink_list, ndx);
162 flist->in_progress++;
165 break;
166 case FES_REDO:
167 if (read_batch) {
168 if (inc_recurse)
169 flist->in_progress++;
170 break;
172 if (inc_recurse)
173 flist->to_redo++;
174 flist_ndx_push(&redo_list, ndx);
175 break;
176 case FES_NO_SEND:
177 break;
181 static void check_timeout(void)
183 time_t t;
185 if (!io_timeout || ignore_timeout)
186 return;
188 if (!last_io_in) {
189 last_io_in = time(NULL);
190 return;
193 t = time(NULL);
195 if (t - last_io_in >= io_timeout) {
196 if (!am_server && !am_daemon) {
197 rprintf(FERROR, "io timeout after %d seconds -- exiting\n",
198 (int)(t-last_io_in));
200 exit_cleanup(RERR_TIMEOUT);
204 /* Note the fds used for the main socket (which might really be a pipe
205 * for a local transfer, but we can ignore that). */
206 void io_set_sock_fds(int f_in, int f_out)
208 sock_f_in = f_in;
209 sock_f_out = f_out;
212 void set_io_timeout(int secs)
214 io_timeout = secs;
216 if (!io_timeout || io_timeout > SELECT_TIMEOUT)
217 select_timeout = SELECT_TIMEOUT;
218 else
219 select_timeout = io_timeout;
221 allowed_lull = read_batch ? 0 : (io_timeout + 1) / 2;
224 /* Setup the fd used to receive MSG_* messages. Only needed during the
225 * early stages of being a local sender (up through the sending of the
226 * file list) or when we're the generator (to fetch the messages from
227 * the receiver). */
228 void set_msg_fd_in(int fd)
230 msg_fd_in = fd;
233 /* Setup the fd used to send our MSG_* messages. Only needed when
234 * we're the receiver (to send our messages to the generator). */
235 void set_msg_fd_out(int fd)
237 msg_fd_out = fd;
238 set_nonblocking(msg_fd_out);
241 /* Add a message to the pending MSG_* list. */
242 static void msg_list_add(struct msg_list *lst, int code, const char *buf, int len, int convert)
244 struct msg_list_item *m;
245 int sz = len + 4 + sizeof m[0] - 1;
247 if (!(m = (struct msg_list_item *)new_array(char, sz)))
248 out_of_memory("msg_list_add");
249 m->next = NULL;
250 m->convert = convert;
251 SIVAL(m->buf, 0, ((code+MPLEX_BASE)<<24) | len);
252 memcpy(m->buf + 4, buf, len);
253 if (lst->tail)
254 lst->tail->next = m;
255 else
256 lst->head = m;
257 lst->tail = m;
260 static inline int flush_a_msg(int fd)
262 struct msg_list_item *m = msg_queue.head;
263 int len = IVAL(m->buf, 0) & 0xFFFFFF;
264 int tag = *((uchar*)m->buf+3) - MPLEX_BASE;
266 if (!(msg_queue.head = m->next))
267 msg_queue.tail = NULL;
269 defer_forwarding_messages++;
270 mplex_write(fd, tag, m->buf + 4, len, m->convert);
271 defer_forwarding_messages--;
273 free(m);
275 return len;
278 static void msg_flush(void)
280 if (am_generator) {
281 while (msg_queue.head && io_multiplexing_out)
282 stats.total_written += flush_a_msg(sock_f_out) + 4;
283 } else {
284 while (msg_queue.head)
285 (void)flush_a_msg(msg_fd_out);
289 static void check_for_d_option_error(const char *msg)
291 static char rsync263_opts[] = "BCDHIKLPRSTWabceghlnopqrtuvxz";
292 char *colon;
293 int saw_d = 0;
295 if (*msg != 'r'
296 || strncmp(msg, REMOTE_OPTION_ERROR, sizeof REMOTE_OPTION_ERROR - 1) != 0)
297 return;
299 msg += sizeof REMOTE_OPTION_ERROR - 1;
300 if (*msg == '-' || (colon = strchr(msg, ':')) == NULL
301 || strncmp(colon, REMOTE_OPTION_ERROR2, sizeof REMOTE_OPTION_ERROR2 - 1) != 0)
302 return;
304 for ( ; *msg != ':'; msg++) {
305 if (*msg == 'd')
306 saw_d = 1;
307 else if (*msg == 'e')
308 break;
309 else if (strchr(rsync263_opts, *msg) == NULL)
310 return;
313 if (saw_d) {
314 rprintf(FWARNING,
315 "*** Try using \"--old-d\" if remote rsync is <= 2.6.3 ***\n");
319 /* Read a message from the MSG_* fd and handle it. This is called either
320 * during the early stages of being a local sender (up through the sending
321 * of the file list) or when we're the generator (to fetch the messages
322 * from the receiver). */
323 static void read_msg_fd(void)
325 char buf[2048];
326 size_t n;
327 struct file_list *flist;
328 int fd = msg_fd_in;
329 int tag, len;
331 /* Temporarily disable msg_fd_in. This is needed to avoid looping back
332 * to this routine from writefd_unbuffered(). */
333 no_flush++;
334 msg_fd_in = -1;
335 defer_forwarding_messages++;
337 readfd(fd, buf, 4);
338 tag = IVAL(buf, 0);
340 len = tag & 0xFFFFFF;
341 tag = (tag >> 24) - MPLEX_BASE;
343 switch (tag) {
344 case MSG_DONE:
345 if (len < 0 || len > 1 || !am_generator) {
346 invalid_msg:
347 rprintf(FERROR, "invalid message %d:%d [%s%s]\n",
348 tag, len, who_am_i(),
349 inc_recurse ? "/inc" : "");
350 exit_cleanup(RERR_STREAMIO);
352 if (len) {
353 readfd(fd, buf, len);
354 stats.total_read = read_varlong(fd, 3);
356 msgdone_cnt++;
357 break;
358 case MSG_REDO:
359 if (len != 4 || !am_generator)
360 goto invalid_msg;
361 readfd(fd, buf, 4);
362 got_flist_entry_status(FES_REDO, buf);
363 break;
364 case MSG_FLIST:
365 if (len != 4 || !am_generator || !inc_recurse)
366 goto invalid_msg;
367 readfd(fd, buf, 4);
368 /* Read extra file list from receiver. */
369 assert(iobuf_in != NULL);
370 assert(iobuf_f_in == fd);
371 if (verbose > 3) {
372 rprintf(FINFO, "[%s] receiving flist for dir %d\n",
373 who_am_i(), IVAL(buf,0));
375 flist = recv_file_list(fd);
376 flist->parent_ndx = IVAL(buf,0);
377 #ifdef SUPPORT_HARD_LINKS
378 if (preserve_hard_links)
379 match_hard_links(flist);
380 #endif
381 break;
382 case MSG_FLIST_EOF:
383 if (len != 0 || !am_generator || !inc_recurse)
384 goto invalid_msg;
385 flist_eof = 1;
386 break;
387 case MSG_IO_ERROR:
388 if (len != 4)
389 goto invalid_msg;
390 readfd(fd, buf, len);
391 io_error |= IVAL(buf, 0);
392 break;
393 case MSG_DELETED:
394 if (len >= (int)sizeof buf || !am_generator)
395 goto invalid_msg;
396 readfd(fd, buf, len);
397 send_msg(MSG_DELETED, buf, len, 1);
398 break;
399 case MSG_SUCCESS:
400 if (len != 4 || !am_generator)
401 goto invalid_msg;
402 readfd(fd, buf, 4);
403 got_flist_entry_status(FES_SUCCESS, buf);
404 break;
405 case MSG_NO_SEND:
406 if (len != 4 || !am_generator)
407 goto invalid_msg;
408 readfd(fd, buf, 4);
409 got_flist_entry_status(FES_NO_SEND, buf);
410 break;
411 case MSG_ERROR_SOCKET:
412 case MSG_ERROR_UTF8:
413 case MSG_CLIENT:
414 if (!am_generator)
415 goto invalid_msg;
416 if (tag == MSG_ERROR_SOCKET)
417 io_end_multiplex_out();
418 /* FALL THROUGH */
419 case MSG_INFO:
420 case MSG_ERROR:
421 case MSG_ERROR_XFER:
422 case MSG_WARNING:
423 case MSG_LOG:
424 while (len) {
425 n = len;
426 if (n >= sizeof buf)
427 n = sizeof buf - 1;
428 readfd(fd, buf, n);
429 rwrite((enum logcode)tag, buf, n, !am_generator);
430 len -= n;
432 break;
433 default:
434 rprintf(FERROR, "unknown message %d:%d [%s]\n",
435 tag, len, who_am_i());
436 exit_cleanup(RERR_STREAMIO);
439 no_flush--;
440 msg_fd_in = fd;
441 if (!--defer_forwarding_messages && !no_flush)
442 msg_flush();
445 /* This is used by the generator to limit how many file transfers can
446 * be active at once when --remove-source-files is specified. Without
447 * this, sender-side deletions were mostly happening at the end. */
448 void increment_active_files(int ndx, int itemizing, enum logcode code)
450 while (1) {
451 /* TODO: tune these limits? */
452 int limit = active_bytecnt >= 128*1024 ? 10 : 50;
453 if (active_filecnt < limit)
454 break;
455 check_for_finished_files(itemizing, code, 0);
456 if (active_filecnt < limit)
457 break;
458 if (iobuf_out_cnt)
459 io_flush(NORMAL_FLUSH);
460 else
461 read_msg_fd();
464 active_filecnt++;
465 active_bytecnt += F_LENGTH(cur_flist->files[ndx - cur_flist->ndx_start]);
468 /* Write an message to a multiplexed stream. If this fails, rsync exits. */
469 static void mplex_write(int fd, enum msgcode code, const char *buf, size_t len, int convert)
471 char buffer[BIGPATHBUFLEN]; /* Oversized for use by iconv code. */
472 size_t n = len;
474 #ifdef ICONV_OPTION
475 /* We need to convert buf before doing anything else so that we
476 * can include the (converted) byte length in the message header. */
477 if (convert && ic_send != (iconv_t)-1) {
478 xbuf outbuf, inbuf;
480 INIT_XBUF(outbuf, buffer + 4, 0, sizeof buffer - 4);
481 INIT_XBUF(inbuf, (char*)buf, len, -1);
483 iconvbufs(ic_send, &inbuf, &outbuf,
484 ICB_INCLUDE_BAD | ICB_INCLUDE_INCOMPLETE);
485 if (inbuf.len > 0) {
486 rprintf(FERROR, "overflowed conversion buffer in mplex_write");
487 exit_cleanup(RERR_UNSUPPORTED);
490 n = len = outbuf.len;
491 } else
492 #endif
493 if (n > 1024 - 4) /* BIGPATHBUFLEN can handle 1024 bytes */
494 n = 0; /* We'd rather do 2 writes than too much memcpy(). */
495 else
496 memcpy(buffer + 4, buf, n);
498 SIVAL(buffer, 0, ((MPLEX_BASE + (int)code)<<24) + len);
500 keep_defer_forwarding++; /* defer_forwarding_messages++ on return */
501 writefd_unbuffered(fd, buffer, n+4);
502 keep_defer_forwarding--;
504 if (len > n)
505 writefd_unbuffered(fd, buf+n, len-n);
507 if (!--defer_forwarding_messages && !no_flush)
508 msg_flush();
511 int send_msg(enum msgcode code, const char *buf, int len, int convert)
513 if (msg_fd_out < 0) {
514 if (!defer_forwarding_messages)
515 return io_multiplex_write(code, buf, len, convert);
516 if (!io_multiplexing_out)
517 return 0;
518 msg_list_add(&msg_queue, code, buf, len, convert);
519 return 1;
521 if (flist_forward_from >= 0)
522 msg_list_add(&msg_queue, code, buf, len, convert);
523 else
524 mplex_write(msg_fd_out, code, buf, len, convert);
525 return 1;
528 void send_msg_int(enum msgcode code, int num)
530 char numbuf[4];
531 SIVAL(numbuf, 0, num);
532 send_msg(code, numbuf, 4, 0);
535 void wait_for_receiver(void)
537 if (io_flush(NORMAL_FLUSH))
538 return;
539 read_msg_fd();
542 int get_redo_num(void)
544 return flist_ndx_pop(&redo_list);
547 int get_hlink_num(void)
549 return flist_ndx_pop(&hlink_list);
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).
562 void io_set_filesfrom_fds(int f_in, int f_out)
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
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.
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.
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. */
585 static void whine_about_eof(int fd)
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);
596 rprintf(FERROR, RSYNC_NAME ": connection unexpectedly closed "
597 "(%.0f bytes received so far) [%s]\n",
598 (double)stats.total_read, who_am_i());
600 exit_cleanup(RERR_STREAMIO);
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.
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.
614 static int read_timeout(int fd, char *buf, size_t len)
616 int n, cnt = 0;
618 io_flush(FULL_FLUSH);
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;
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;
640 } else {
641 FD_SET(io_filesfrom_f_out, &w_fds);
642 new_fd = io_filesfrom_f_out;
644 if (new_fd > maxfd)
645 maxfd = new_fd;
648 tv.tv_sec = select_timeout;
649 tv.tv_usec = 0;
651 errno = 0;
653 count = select(maxfd + 1, &r_fds, &w_fds, NULL, &tv);
655 if (count <= 0) {
656 if (errno == EBADF) {
657 defer_forwarding_messages = 0;
658 exit_cleanup(RERR_SOCKETIO);
660 check_timeout();
661 continue;
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;
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;
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;
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';
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--;
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--;
733 ff_lastchar = f[-1];
735 ff_buf.len = l;
741 if (!FD_ISSET(fd, &r_fds))
742 continue;
744 n = read(fd, buf, len);
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;
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);
762 buf += n;
763 len -= n;
764 cnt += n;
766 if (fd == sock_f_in && io_timeout)
767 last_io_in = time(NULL);
770 return cnt;
773 /* Read a line into the "buf" buffer. */
774 int read_line(int fd, char *buf, size_t bufsiz, int flags)
776 char ch, *s, *eob;
777 int cnt;
779 #ifdef ICONV_OPTION
780 if (flags & RL_CONVERT && iconv_buf.size < bufsiz)
781 realloc_xbuf(&iconv_buf, bufsiz + 1024);
782 #endif
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;
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;
817 if (s < eob)
818 *s++ = ch;
820 *s = '\0';
822 if (flags & RL_DUMP_COMMENTS && (*buf == '#' || *buf == ';'))
823 goto start;
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;
836 #endif
838 return s - buf;
841 void 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)
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);
850 #ifdef ICONV_OPTION
851 rl_flags |= (protect_args && ic_recv != (iconv_t)-1 ? RL_CONVERT : 0);
852 #endif
854 if (!(argv = new_array(char *, maxargs)))
855 out_of_memory("read_args");
856 if (mod_name && !protect_args)
857 argv[argc++] = "rsyncd";
859 while (1) {
860 if (read_line(f_in, buf, bufsiz, rl_flags) == 0)
861 break;
863 if (argc == maxargs-1) {
864 maxargs += MAX_ARGS;
865 if (!(argv = realloc_array(argv, char *, maxargs)))
866 out_of_memory("read_args");
869 if (dot_pos) {
870 if (request_p) {
871 *request_p = strdup(buf);
872 request_p = NULL;
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;
886 argv[argc] = NULL;
888 glob_expand(NULL, NULL, NULL, NULL);
890 *argc_p = argc;
891 *argv_p = argv;
894 int io_start_buffering_out(int f_out)
896 if (iobuf_out) {
897 assert(f_out == iobuf_f_out);
898 return 0;
900 if (!(iobuf_out = new_array(char, IO_BUFFER_SIZE)))
901 out_of_memory("io_start_buffering_out");
902 iobuf_out_cnt = 0;
903 iobuf_f_out = f_out;
904 return 1;
907 int io_start_buffering_in(int f_in)
909 if (iobuf_in) {
910 assert(f_in == iobuf_f_in);
911 return 0;
913 iobuf_in_siz = 2 * IO_BUFFER_SIZE;
914 if (!(iobuf_in = new_array(char, iobuf_in_siz)))
915 out_of_memory("io_start_buffering_in");
916 iobuf_f_in = f_in;
917 return 1;
920 void io_end_buffering_in(void)
922 if (!iobuf_in)
923 return;
924 free(iobuf_in);
925 iobuf_in = NULL;
926 iobuf_in_ndx = 0;
927 iobuf_in_remaining = 0;
928 iobuf_f_in = -1;
931 void io_end_buffering_out(void)
933 if (!iobuf_out)
934 return;
935 io_flush(FULL_FLUSH);
936 free(iobuf_out);
937 iobuf_out = NULL;
938 iobuf_f_out = -1;
941 void maybe_flush_socket(int important)
943 if (iobuf_out && iobuf_out_cnt
944 && (important || time(NULL) - last_io_out >= 5))
945 io_flush(NORMAL_FLUSH);
948 void maybe_send_keepalive(void)
950 if (time(NULL) - last_io_out >= allowed_lull) {
951 if (!iobuf_out || !iobuf_out_cnt) {
952 if (protocol_version < 29)
953 return; /* there's nothing we can do */
954 if (protocol_version >= 30)
955 send_msg(MSG_NOOP, "", 0, 0);
956 else {
957 write_int(sock_f_out, cur_flist->used);
958 write_shortint(sock_f_out, ITEM_IS_NEW);
961 if (iobuf_out)
962 io_flush(NORMAL_FLUSH);
966 void start_flist_forward(int f_in)
968 assert(iobuf_out != NULL);
969 assert(iobuf_f_out == msg_fd_out);
970 flist_forward_from = f_in;
973 void stop_flist_forward()
975 flist_forward_from = -1;
976 io_flush(FULL_FLUSH);
980 * Continue trying to read len bytes - don't return until len has been
981 * read.
983 static void read_loop(int fd, char *buf, size_t len)
985 while (len) {
986 int n = read_timeout(fd, buf, len);
988 buf += n;
989 len -= n;
994 * Read from the file descriptor handling multiplexing - return number
995 * of bytes read.
997 * Never returns <= 0.
999 static int readfd_unbuffered(int fd, char *buf, size_t len)
1001 size_t msg_bytes;
1002 int tag, cnt = 0;
1003 char line[BIGPATHBUFLEN];
1005 if (!iobuf_in || fd != iobuf_f_in)
1006 return read_timeout(fd, buf, len);
1008 if (!io_multiplexing_in && iobuf_in_remaining == 0) {
1009 iobuf_in_remaining = read_timeout(fd, iobuf_in, iobuf_in_siz);
1010 iobuf_in_ndx = 0;
1013 while (cnt == 0) {
1014 if (iobuf_in_remaining) {
1015 len = MIN(len, iobuf_in_remaining);
1016 memcpy(buf, iobuf_in + iobuf_in_ndx, len);
1017 iobuf_in_ndx += len;
1018 iobuf_in_remaining -= len;
1019 cnt = len;
1020 break;
1023 read_loop(fd, line, 4);
1024 tag = IVAL(line, 0);
1026 msg_bytes = tag & 0xFFFFFF;
1027 tag = (tag >> 24) - MPLEX_BASE;
1029 switch (tag) {
1030 case MSG_DATA:
1031 if (msg_bytes > iobuf_in_siz) {
1032 if (!(iobuf_in = realloc_array(iobuf_in, char,
1033 msg_bytes)))
1034 out_of_memory("readfd_unbuffered");
1035 iobuf_in_siz = msg_bytes;
1037 read_loop(fd, iobuf_in, msg_bytes);
1038 iobuf_in_remaining = msg_bytes;
1039 iobuf_in_ndx = 0;
1040 break;
1041 case MSG_NOOP:
1042 if (am_sender)
1043 maybe_send_keepalive();
1044 break;
1045 case MSG_IO_ERROR:
1046 if (msg_bytes != 4)
1047 goto invalid_msg;
1048 read_loop(fd, line, msg_bytes);
1049 send_msg_int(MSG_IO_ERROR, IVAL(line, 0));
1050 io_error |= IVAL(line, 0);
1051 break;
1052 case MSG_DELETED:
1053 if (msg_bytes >= sizeof line)
1054 goto overflow;
1055 #ifdef ICONV_OPTION
1056 if (ic_recv != (iconv_t)-1) {
1057 xbuf outbuf, inbuf;
1058 char ibuf[512];
1059 int add_null = 0;
1060 int pos = 0;
1062 INIT_CONST_XBUF(outbuf, line);
1063 INIT_XBUF(inbuf, ibuf, 0, -1);
1065 while (msg_bytes) {
1066 inbuf.len = msg_bytes > sizeof ibuf
1067 ? sizeof ibuf : msg_bytes;
1068 read_loop(fd, inbuf.buf, inbuf.len);
1069 if (!(msg_bytes -= inbuf.len)
1070 && !ibuf[inbuf.len-1])
1071 inbuf.len--, add_null = 1;
1072 if (iconvbufs(ic_send, &inbuf, &outbuf,
1073 ICB_INCLUDE_BAD | ICB_INCLUDE_INCOMPLETE) < 0)
1074 goto overflow;
1075 pos = -1;
1077 if (add_null) {
1078 if (outbuf.len == outbuf.size)
1079 goto overflow;
1080 outbuf.buf[outbuf.len++] = '\0';
1082 msg_bytes = outbuf.len;
1083 } else
1084 #endif
1085 read_loop(fd, line, msg_bytes);
1086 /* A directory name was sent with the trailing null */
1087 if (msg_bytes > 0 && !line[msg_bytes-1])
1088 log_delete(line, S_IFDIR);
1089 else {
1090 line[msg_bytes] = '\0';
1091 log_delete(line, S_IFREG);
1093 break;
1094 case MSG_SUCCESS:
1095 if (msg_bytes != 4) {
1096 invalid_msg:
1097 rprintf(FERROR, "invalid multi-message %d:%ld [%s]\n",
1098 tag, (long)msg_bytes, who_am_i());
1099 exit_cleanup(RERR_STREAMIO);
1101 read_loop(fd, line, msg_bytes);
1102 successful_send(IVAL(line, 0));
1103 break;
1104 case MSG_NO_SEND:
1105 if (msg_bytes != 4)
1106 goto invalid_msg;
1107 read_loop(fd, line, msg_bytes);
1108 send_msg_int(MSG_NO_SEND, IVAL(line, 0));
1109 break;
1110 case MSG_INFO:
1111 case MSG_ERROR:
1112 case MSG_ERROR_XFER:
1113 case MSG_WARNING:
1114 if (msg_bytes >= sizeof line) {
1115 overflow:
1116 rprintf(FERROR,
1117 "multiplexing overflow %d:%ld [%s]\n",
1118 tag, (long)msg_bytes, who_am_i());
1119 exit_cleanup(RERR_STREAMIO);
1121 read_loop(fd, line, msg_bytes);
1122 rwrite((enum logcode)tag, line, msg_bytes, 1);
1123 if (first_message) {
1124 if (list_only && !am_sender && tag == 1) {
1125 line[msg_bytes] = '\0';
1126 check_for_d_option_error(line);
1128 first_message = 0;
1130 break;
1131 default:
1132 rprintf(FERROR, "unexpected tag %d [%s]\n",
1133 tag, who_am_i());
1134 exit_cleanup(RERR_STREAMIO);
1138 if (iobuf_in_remaining == 0)
1139 io_flush(NORMAL_FLUSH);
1141 return cnt;
1144 /* Do a buffered read from fd. Don't return until all N bytes have
1145 * been read. If all N can't be read then exit with an error. */
1146 static void readfd(int fd, char *buffer, size_t N)
1148 int cnt;
1149 size_t total = 0;
1151 while (total < N) {
1152 cnt = readfd_unbuffered(fd, buffer + total, N-total);
1153 total += cnt;
1156 if (fd == write_batch_monitor_in) {
1157 if ((size_t)write(batch_fd, buffer, total) != total)
1158 exit_cleanup(RERR_FILEIO);
1161 if (fd == flist_forward_from)
1162 writefd(iobuf_f_out, buffer, total);
1164 if (fd == sock_f_in)
1165 stats.total_read += total;
1168 unsigned short read_shortint(int f)
1170 char b[2];
1171 readfd(f, b, 2);
1172 return (UVAL(b, 1) << 8) + UVAL(b, 0);
1175 int32 read_int(int f)
1177 char b[4];
1178 int32 num;
1180 readfd(f, b, 4);
1181 num = IVAL(b, 0);
1182 #if SIZEOF_INT32 > 4
1183 if (num & (int32)0x80000000)
1184 num |= ~(int32)0xffffffff;
1185 #endif
1186 return num;
1189 int32 read_varint(int f)
1191 union {
1192 char b[5];
1193 int32 x;
1194 } u;
1195 uchar ch;
1196 int extra;
1198 u.x = 0;
1199 readfd(f, (char*)&ch, 1);
1200 extra = int_byte_extra[ch / 4];
1201 if (extra) {
1202 uchar bit = ((uchar)1<<(8-extra));
1203 if (extra >= (int)sizeof u.b) {
1204 rprintf(FERROR, "Overflow in read_varint()\n");
1205 exit_cleanup(RERR_STREAMIO);
1207 readfd(f, u.b, extra);
1208 u.b[extra] = ch & (bit-1);
1209 } else
1210 u.b[0] = ch;
1211 #if CAREFUL_ALIGNMENT
1212 u.x = IVAL(u.b,0);
1213 #endif
1214 #if SIZEOF_INT32 > 4
1215 if (u.x & (int32)0x80000000)
1216 u.x |= ~(int32)0xffffffff;
1217 #endif
1218 return u.x;
1221 int64 read_varlong(int f, uchar min_bytes)
1223 union {
1224 char b[9];
1225 int64 x;
1226 } u;
1227 char b2[8];
1228 int extra;
1230 #if SIZEOF_INT64 < 8
1231 memset(u.b, 0, 8);
1232 #else
1233 u.x = 0;
1234 #endif
1235 readfd(f, b2, min_bytes);
1236 memcpy(u.b, b2+1, min_bytes-1);
1237 extra = int_byte_extra[CVAL(b2, 0) / 4];
1238 if (extra) {
1239 uchar bit = ((uchar)1<<(8-extra));
1240 if (min_bytes + extra > (int)sizeof u.b) {
1241 rprintf(FERROR, "Overflow in read_varlong()\n");
1242 exit_cleanup(RERR_STREAMIO);
1244 readfd(f, u.b + min_bytes - 1, extra);
1245 u.b[min_bytes + extra - 1] = CVAL(b2, 0) & (bit-1);
1246 #if SIZEOF_INT64 < 8
1247 if (min_bytes + extra > 5 || u.b[4] || CVAL(u.b,3) & 0x80) {
1248 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1249 exit_cleanup(RERR_UNSUPPORTED);
1251 #endif
1252 } else
1253 u.b[min_bytes + extra - 1] = CVAL(b2, 0);
1254 #if SIZEOF_INT64 < 8
1255 u.x = IVAL(u.b,0);
1256 #elif CAREFUL_ALIGNMENT
1257 u.x = IVAL(u.b,0) | (((int64)IVAL(u.b,4))<<32);
1258 #endif
1259 return u.x;
1262 int64 read_longint(int f)
1264 #if SIZEOF_INT64 >= 8
1265 char b[9];
1266 #endif
1267 int32 num = read_int(f);
1269 if (num != (int32)0xffffffff)
1270 return num;
1272 #if SIZEOF_INT64 < 8
1273 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1274 exit_cleanup(RERR_UNSUPPORTED);
1275 #else
1276 readfd(f, b, 8);
1277 return IVAL(b,0) | (((int64)IVAL(b,4))<<32);
1278 #endif
1281 void read_buf(int f, char *buf, size_t len)
1283 readfd(f,buf,len);
1286 void read_sbuf(int f, char *buf, size_t len)
1288 readfd(f, buf, len);
1289 buf[len] = '\0';
1292 uchar read_byte(int f)
1294 uchar c;
1295 readfd(f, (char *)&c, 1);
1296 return c;
1299 int read_vstring(int f, char *buf, int bufsize)
1301 int len = read_byte(f);
1303 if (len & 0x80)
1304 len = (len & ~0x80) * 0x100 + read_byte(f);
1306 if (len >= bufsize) {
1307 rprintf(FERROR, "over-long vstring received (%d > %d)\n",
1308 len, bufsize - 1);
1309 return -1;
1312 if (len)
1313 readfd(f, buf, len);
1314 buf[len] = '\0';
1315 return len;
1318 /* Populate a sum_struct with values from the socket. This is
1319 * called by both the sender and the receiver. */
1320 void read_sum_head(int f, struct sum_struct *sum)
1322 int32 max_blength = protocol_version < 30 ? OLD_MAX_BLOCK_SIZE : MAX_BLOCK_SIZE;
1323 sum->count = read_int(f);
1324 if (sum->count < 0) {
1325 rprintf(FERROR, "Invalid checksum count %ld [%s]\n",
1326 (long)sum->count, who_am_i());
1327 exit_cleanup(RERR_PROTOCOL);
1329 sum->blength = read_int(f);
1330 if (sum->blength < 0 || sum->blength > max_blength) {
1331 rprintf(FERROR, "Invalid block length %ld [%s]\n",
1332 (long)sum->blength, who_am_i());
1333 exit_cleanup(RERR_PROTOCOL);
1335 sum->s2length = protocol_version < 27 ? csum_length : (int)read_int(f);
1336 if (sum->s2length < 0 || sum->s2length > MAX_DIGEST_LEN) {
1337 rprintf(FERROR, "Invalid checksum length %d [%s]\n",
1338 sum->s2length, who_am_i());
1339 exit_cleanup(RERR_PROTOCOL);
1341 sum->remainder = read_int(f);
1342 if (sum->remainder < 0 || sum->remainder > sum->blength) {
1343 rprintf(FERROR, "Invalid remainder length %ld [%s]\n",
1344 (long)sum->remainder, who_am_i());
1345 exit_cleanup(RERR_PROTOCOL);
1349 /* Send the values from a sum_struct over the socket. Set sum to
1350 * NULL if there are no checksums to send. This is called by both
1351 * the generator and the sender. */
1352 void write_sum_head(int f, struct sum_struct *sum)
1354 static struct sum_struct null_sum;
1356 if (sum == NULL)
1357 sum = &null_sum;
1359 write_int(f, sum->count);
1360 write_int(f, sum->blength);
1361 if (protocol_version >= 27)
1362 write_int(f, sum->s2length);
1363 write_int(f, sum->remainder);
1367 * Sleep after writing to limit I/O bandwidth usage.
1369 * @todo Rather than sleeping after each write, it might be better to
1370 * use some kind of averaging. The current algorithm seems to always
1371 * use a bit less bandwidth than specified, because it doesn't make up
1372 * for slow periods. But arguably this is a feature. In addition, we
1373 * ought to take the time used to write the data into account.
1375 * During some phases of big transfers (file FOO is uptodate) this is
1376 * called with a small bytes_written every time. As the kernel has to
1377 * round small waits up to guarantee that we actually wait at least the
1378 * requested number of microseconds, this can become grossly inaccurate.
1379 * We therefore keep track of the bytes we've written over time and only
1380 * sleep when the accumulated delay is at least 1 tenth of a second.
1382 static void sleep_for_bwlimit(int bytes_written)
1384 static struct timeval prior_tv;
1385 static long total_written = 0;
1386 struct timeval tv, start_tv;
1387 long elapsed_usec, sleep_usec;
1389 #define ONE_SEC 1000000L /* # of microseconds in a second */
1391 if (!bwlimit_writemax)
1392 return;
1394 total_written += bytes_written;
1396 gettimeofday(&start_tv, NULL);
1397 if (prior_tv.tv_sec) {
1398 elapsed_usec = (start_tv.tv_sec - prior_tv.tv_sec) * ONE_SEC
1399 + (start_tv.tv_usec - prior_tv.tv_usec);
1400 total_written -= elapsed_usec * bwlimit / (ONE_SEC/1024);
1401 if (total_written < 0)
1402 total_written = 0;
1405 sleep_usec = total_written * (ONE_SEC/1024) / bwlimit;
1406 if (sleep_usec < ONE_SEC / 10) {
1407 prior_tv = start_tv;
1408 return;
1411 tv.tv_sec = sleep_usec / ONE_SEC;
1412 tv.tv_usec = sleep_usec % ONE_SEC;
1413 select(0, NULL, NULL, NULL, &tv);
1415 gettimeofday(&prior_tv, NULL);
1416 elapsed_usec = (prior_tv.tv_sec - start_tv.tv_sec) * ONE_SEC
1417 + (prior_tv.tv_usec - start_tv.tv_usec);
1418 total_written = (sleep_usec - elapsed_usec) * bwlimit / (ONE_SEC/1024);
1421 /* Write len bytes to the file descriptor fd, looping as necessary to get
1422 * the job done and also (in certain circumstances) reading any data on
1423 * msg_fd_in to avoid deadlock.
1425 * This function underlies the multiplexing system. The body of the
1426 * application never calls this function directly. */
1427 static void writefd_unbuffered(int fd, const char *buf, size_t len)
1429 size_t n, total = 0;
1430 fd_set w_fds, r_fds, e_fds;
1431 int maxfd, count, cnt, using_r_fds;
1432 int defer_inc = 0;
1433 struct timeval tv;
1435 if (no_flush++)
1436 defer_forwarding_messages++, defer_inc++;
1438 while (total < len) {
1439 FD_ZERO(&w_fds);
1440 FD_SET(fd, &w_fds);
1441 FD_ZERO(&e_fds);
1442 FD_SET(fd, &e_fds);
1443 maxfd = fd;
1445 if (msg_fd_in >= 0) {
1446 FD_ZERO(&r_fds);
1447 FD_SET(msg_fd_in, &r_fds);
1448 if (msg_fd_in > maxfd)
1449 maxfd = msg_fd_in;
1450 using_r_fds = 1;
1451 } else
1452 using_r_fds = 0;
1454 tv.tv_sec = select_timeout;
1455 tv.tv_usec = 0;
1457 errno = 0;
1458 count = select(maxfd + 1, using_r_fds ? &r_fds : NULL,
1459 &w_fds, &e_fds, &tv);
1461 if (count <= 0) {
1462 if (count < 0 && errno == EBADF)
1463 exit_cleanup(RERR_SOCKETIO);
1464 check_timeout();
1465 continue;
1468 /*if (FD_ISSET(fd, &e_fds))
1469 rprintf(FINFO, "select exception on fd %d\n", fd); */
1471 if (using_r_fds && FD_ISSET(msg_fd_in, &r_fds))
1472 read_msg_fd();
1474 if (!FD_ISSET(fd, &w_fds))
1475 continue;
1477 n = len - total;
1478 if (bwlimit_writemax && n > bwlimit_writemax)
1479 n = bwlimit_writemax;
1480 cnt = write(fd, buf + total, n);
1482 if (cnt <= 0) {
1483 if (cnt < 0) {
1484 if (errno == EINTR)
1485 continue;
1486 if (errno == EWOULDBLOCK || errno == EAGAIN) {
1487 msleep(1);
1488 continue;
1492 /* Don't try to write errors back across the stream. */
1493 if (fd == sock_f_out)
1494 io_end_multiplex_out();
1495 /* Don't try to write errors down a failing msg pipe. */
1496 if (am_server && fd == msg_fd_out)
1497 exit_cleanup(RERR_STREAMIO);
1498 rsyserr(FERROR, errno,
1499 "writefd_unbuffered failed to write %ld bytes [%s]",
1500 (long)len, who_am_i());
1501 /* If the other side is sending us error messages, try
1502 * to grab any messages they sent before they died. */
1503 while (!am_server && fd == sock_f_out && io_multiplexing_in) {
1504 char buf[1024];
1505 set_io_timeout(30);
1506 ignore_timeout = 0;
1507 readfd_unbuffered(sock_f_in, buf, sizeof buf);
1509 exit_cleanup(RERR_STREAMIO);
1512 total += cnt;
1513 defer_forwarding_messages++, defer_inc++;
1515 if (fd == sock_f_out) {
1516 if (io_timeout || am_generator)
1517 last_io_out = time(NULL);
1518 sleep_for_bwlimit(cnt);
1522 no_flush--;
1523 if (keep_defer_forwarding)
1524 defer_inc--;
1525 if (!(defer_forwarding_messages -= defer_inc) && !no_flush)
1526 msg_flush();
1529 int io_flush(int flush_it_all)
1531 int flushed_something = 0;
1533 if (no_flush)
1534 return 0;
1536 if (iobuf_out_cnt) {
1537 if (io_multiplexing_out)
1538 mplex_write(sock_f_out, MSG_DATA, iobuf_out, iobuf_out_cnt, 0);
1539 else
1540 writefd_unbuffered(iobuf_f_out, iobuf_out, iobuf_out_cnt);
1541 iobuf_out_cnt = 0;
1542 flushed_something = 1;
1545 if (flush_it_all && !defer_forwarding_messages && msg_queue.head) {
1546 msg_flush();
1547 flushed_something = 1;
1550 return flushed_something;
1553 static void writefd(int fd, const char *buf, size_t len)
1555 if (fd == sock_f_out)
1556 stats.total_written += len;
1558 if (fd == write_batch_monitor_out) {
1559 if ((size_t)write(batch_fd, buf, len) != len)
1560 exit_cleanup(RERR_FILEIO);
1563 if (!iobuf_out || fd != iobuf_f_out) {
1564 writefd_unbuffered(fd, buf, len);
1565 return;
1568 while (len) {
1569 int n = MIN((int)len, IO_BUFFER_SIZE - iobuf_out_cnt);
1570 if (n > 0) {
1571 memcpy(iobuf_out+iobuf_out_cnt, buf, n);
1572 buf += n;
1573 len -= n;
1574 iobuf_out_cnt += n;
1577 if (iobuf_out_cnt == IO_BUFFER_SIZE)
1578 io_flush(NORMAL_FLUSH);
1582 void write_shortint(int f, unsigned short x)
1584 char b[2];
1585 b[0] = (char)x;
1586 b[1] = (char)(x >> 8);
1587 writefd(f, b, 2);
1590 void write_int(int f, int32 x)
1592 char b[4];
1593 SIVAL(b, 0, x);
1594 writefd(f, b, 4);
1597 void write_varint(int f, int32 x)
1599 char b[5];
1600 uchar bit;
1601 int cnt = 4;
1603 SIVAL(b, 1, x);
1605 while (cnt > 1 && b[cnt] == 0)
1606 cnt--;
1607 bit = ((uchar)1<<(7-cnt+1));
1608 if (CVAL(b, cnt) >= bit) {
1609 cnt++;
1610 *b = ~(bit-1);
1611 } else if (cnt > 1)
1612 *b = b[cnt] | ~(bit*2-1);
1613 else
1614 *b = b[cnt];
1616 writefd(f, b, cnt);
1619 void write_varlong(int f, int64 x, uchar min_bytes)
1621 char b[9];
1622 uchar bit;
1623 int cnt = 8;
1625 SIVAL(b, 1, x);
1626 #if SIZEOF_INT64 >= 8
1627 SIVAL(b, 5, x >> 32);
1628 #else
1629 if (x <= 0x7FFFFFFF && x >= 0)
1630 memset(b + 5, 0, 4);
1631 else {
1632 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1633 exit_cleanup(RERR_UNSUPPORTED);
1635 #endif
1637 while (cnt > min_bytes && b[cnt] == 0)
1638 cnt--;
1639 bit = ((uchar)1<<(7-cnt+min_bytes));
1640 if (CVAL(b, cnt) >= bit) {
1641 cnt++;
1642 *b = ~(bit-1);
1643 } else if (cnt > min_bytes)
1644 *b = b[cnt] | ~(bit*2-1);
1645 else
1646 *b = b[cnt];
1648 writefd(f, b, cnt);
1652 * Note: int64 may actually be a 32-bit type if ./configure couldn't find any
1653 * 64-bit types on this platform.
1655 void write_longint(int f, int64 x)
1657 char b[12], * const s = b+4;
1659 SIVAL(s, 0, x);
1660 if (x <= 0x7FFFFFFF && x >= 0) {
1661 writefd(f, s, 4);
1662 return;
1665 #if SIZEOF_INT64 < 8
1666 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1667 exit_cleanup(RERR_UNSUPPORTED);
1668 #else
1669 memset(b, 0xFF, 4);
1670 SIVAL(s, 4, x >> 32);
1671 writefd(f, b, 12);
1672 #endif
1675 void write_buf(int f, const char *buf, size_t len)
1677 writefd(f,buf,len);
1680 /** Write a string to the connection */
1681 void write_sbuf(int f, const char *buf)
1683 writefd(f, buf, strlen(buf));
1686 void write_byte(int f, uchar c)
1688 writefd(f, (char *)&c, 1);
1691 void write_vstring(int f, const char *str, int len)
1693 uchar lenbuf[3], *lb = lenbuf;
1695 if (len > 0x7F) {
1696 if (len > 0x7FFF) {
1697 rprintf(FERROR,
1698 "attempting to send over-long vstring (%d > %d)\n",
1699 len, 0x7FFF);
1700 exit_cleanup(RERR_PROTOCOL);
1702 *lb++ = len / 0x100 + 0x80;
1704 *lb = len;
1706 writefd(f, (char*)lenbuf, lb - lenbuf + 1);
1707 if (len)
1708 writefd(f, str, len);
1711 /* Send a file-list index using a byte-reduction method. */
1712 void write_ndx(int f, int32 ndx)
1714 static int32 prev_positive = -1, prev_negative = 1;
1715 int32 diff, cnt = 0;
1716 char b[6];
1718 if (protocol_version < 30 || read_batch) {
1719 write_int(f, ndx);
1720 return;
1723 /* Send NDX_DONE as a single-byte 0 with no side effects. Send
1724 * negative nums as a positive after sending a leading 0xFF. */
1725 if (ndx >= 0) {
1726 diff = ndx - prev_positive;
1727 prev_positive = ndx;
1728 } else if (ndx == NDX_DONE) {
1729 *b = 0;
1730 writefd(f, b, 1);
1731 return;
1732 } else {
1733 b[cnt++] = (char)0xFF;
1734 ndx = -ndx;
1735 diff = ndx - prev_negative;
1736 prev_negative = ndx;
1739 /* A diff of 1 - 253 is sent as a one-byte diff; a diff of 254 - 32767
1740 * or 0 is sent as a 0xFE + a two-byte diff; otherwise we send 0xFE
1741 * & all 4 bytes of the (non-negative) num with the high-bit set. */
1742 if (diff < 0xFE && diff > 0)
1743 b[cnt++] = (char)diff;
1744 else if (diff < 0 || diff > 0x7FFF) {
1745 b[cnt++] = (char)0xFE;
1746 b[cnt++] = (char)((ndx >> 24) | 0x80);
1747 b[cnt++] = (char)ndx;
1748 b[cnt++] = (char)(ndx >> 8);
1749 b[cnt++] = (char)(ndx >> 16);
1750 } else {
1751 b[cnt++] = (char)0xFE;
1752 b[cnt++] = (char)(diff >> 8);
1753 b[cnt++] = (char)diff;
1755 writefd(f, b, cnt);
1758 /* Receive a file-list index using a byte-reduction method. */
1759 int32 read_ndx(int f)
1761 static int32 prev_positive = -1, prev_negative = 1;
1762 int32 *prev_ptr, num;
1763 char b[4];
1765 if (protocol_version < 30)
1766 return read_int(f);
1768 readfd(f, b, 1);
1769 if (CVAL(b, 0) == 0xFF) {
1770 readfd(f, b, 1);
1771 prev_ptr = &prev_negative;
1772 } else if (CVAL(b, 0) == 0)
1773 return NDX_DONE;
1774 else
1775 prev_ptr = &prev_positive;
1776 if (CVAL(b, 0) == 0xFE) {
1777 readfd(f, b, 2);
1778 if (CVAL(b, 0) & 0x80) {
1779 b[3] = CVAL(b, 0) & ~0x80;
1780 b[0] = b[1];
1781 readfd(f, b+1, 2);
1782 num = IVAL(b, 0);
1783 } else
1784 num = (UVAL(b,0)<<8) + UVAL(b,1) + *prev_ptr;
1785 } else
1786 num = UVAL(b, 0) + *prev_ptr;
1787 *prev_ptr = num;
1788 if (prev_ptr == &prev_negative)
1789 num = -num;
1790 return num;
1793 /* Read a line of up to bufsiz-1 characters into buf. Strips
1794 * the (required) trailing newline and all carriage returns.
1795 * Returns 1 for success; 0 for I/O error or truncation. */
1796 int read_line_old(int f, char *buf, size_t bufsiz)
1798 bufsiz--; /* leave room for the null */
1799 while (bufsiz > 0) {
1800 buf[0] = 0;
1801 read_buf(f, buf, 1);
1802 if (buf[0] == 0)
1803 return 0;
1804 if (buf[0] == '\n')
1805 break;
1806 if (buf[0] != '\r') {
1807 buf++;
1808 bufsiz--;
1811 *buf = '\0';
1812 return bufsiz > 0;
1815 void io_printf(int fd, const char *format, ...)
1817 va_list ap;
1818 char buf[BIGPATHBUFLEN];
1819 int len;
1821 va_start(ap, format);
1822 len = vsnprintf(buf, sizeof buf, format, ap);
1823 va_end(ap);
1825 if (len < 0)
1826 exit_cleanup(RERR_STREAMIO);
1828 if (len > (int)sizeof buf) {
1829 rprintf(FERROR, "io_printf() was too long for the buffer.\n");
1830 exit_cleanup(RERR_STREAMIO);
1833 write_sbuf(fd, buf);
1836 /** Setup for multiplexing a MSG_* stream with the data stream. */
1837 void io_start_multiplex_out(void)
1839 io_flush(NORMAL_FLUSH);
1840 io_start_buffering_out(sock_f_out);
1841 io_multiplexing_out = 1;
1844 /** Setup for multiplexing a MSG_* stream with the data stream. */
1845 void io_start_multiplex_in(void)
1847 io_flush(NORMAL_FLUSH);
1848 io_start_buffering_in(sock_f_in);
1849 io_multiplexing_in = 1;
1852 /** Write an message to the multiplexed data stream. */
1853 int io_multiplex_write(enum msgcode code, const char *buf, size_t len, int convert)
1855 if (!io_multiplexing_out)
1856 return 0;
1857 io_flush(NORMAL_FLUSH);
1858 stats.total_written += (len+4);
1859 mplex_write(sock_f_out, code, buf, len, convert);
1860 return 1;
1863 void io_end_multiplex_in(void)
1865 io_multiplexing_in = 0;
1866 io_end_buffering_in();
1869 /** Stop output multiplexing. */
1870 void io_end_multiplex_out(void)
1872 io_multiplexing_out = 0;
1873 io_end_buffering_out();
1876 void start_write_batch(int fd)
1878 /* Some communication has already taken place, but we don't
1879 * enable batch writing until here so that we can write a
1880 * canonical record of the communication even though the
1881 * actual communication so far depends on whether a daemon
1882 * is involved. */
1883 write_int(batch_fd, protocol_version);
1884 if (protocol_version >= 30)
1885 write_byte(batch_fd, inc_recurse);
1886 write_int(batch_fd, checksum_seed);
1888 if (am_sender)
1889 write_batch_monitor_out = fd;
1890 else
1891 write_batch_monitor_in = fd;
1894 void stop_write_batch(void)
1896 write_batch_monitor_out = -1;
1897 write_batch_monitor_in = -1;