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