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