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