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