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