- Got rid of some useless calls to msg_list_push().
[rsync.git] / io.c
1 /* -*- c-file-style: "linux" -*-
2  *
3  * Copyright (C) 1996-2001 by Andrew Tridgell
4  * Copyright (C) Paul Mackerras 1996
5  * Copyright (C) 2001, 2002 by Martin Pool <mbp@samba.org>
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20  */
21
22 /**
23  * @file io.c
24  *
25  * Socket and pipe I/O utilities used in rsync.
26  *
27  * rsync provides its own multiplexing system, which is used to send
28  * stderr and stdout over a single socket.  We need this because
29  * stdout normally carries the binary data stream, and stderr all our
30  * error messages.
31  *
32  * For historical reasons this is off during the start of the
33  * connection, but it's switched on quite early using
34  * io_start_multiplex_out() and io_start_multiplex_in().
35  **/
36
37 #include "rsync.h"
38
39 /** If no timeout is specified then use a 60 second select timeout */
40 #define SELECT_TIMEOUT 60
41
42 static int io_multiplexing_out;
43 static int io_multiplexing_in;
44 static int multiplex_in_fd = -1;
45 static int multiplex_out_fd = -1;
46 static time_t last_io;
47 static int no_flush;
48
49 extern int bwlimit;
50 extern size_t bwlimit_writemax;
51 extern int verbose;
52 extern int io_timeout;
53 extern int am_server;
54 extern int am_daemon;
55 extern int am_sender;
56 extern int eol_nulls;
57 extern char *remote_filesfrom_file;
58 extern struct stats stats;
59
60 const char phase_unknown[] = "unknown";
61 int select_timeout = SELECT_TIMEOUT;
62
63 /**
64  * The connection might be dropped at some point; perhaps because the
65  * remote instance crashed.  Just giving the offset on the stream is
66  * not very helpful.  So instead we try to make io_phase_name point to
67  * something useful.
68  *
69  * For buffered/multiplexed I/O these names will be somewhat
70  * approximate; perhaps for ease of support we would rather make the
71  * buffer always flush when a single application-level I/O finishes.
72  *
73  * @todo Perhaps we want some simple stack functionality, but there's
74  * no need to overdo it.
75  **/
76 const char *io_write_phase = phase_unknown;
77 const char *io_read_phase = phase_unknown;
78
79 /** Ignore EOF errors while reading a module listing if the remote
80     version is 24 or less. */
81 int kludge_around_eof = False;
82
83 int msg_fd_in = -1;
84 int msg_fd_out = -1;
85
86 static int io_filesfrom_f_in = -1;
87 static int io_filesfrom_f_out = -1;
88 static char io_filesfrom_buf[2048];
89 static char *io_filesfrom_bp;
90 static char io_filesfrom_lastchar;
91 static int io_filesfrom_buflen;
92
93 static void read_loop(int fd, char *buf, size_t len);
94
95 struct redo_list {
96         struct redo_list *next;
97         int num;
98 };
99
100 static struct redo_list *redo_list_head;
101 static struct redo_list *redo_list_tail;
102
103 struct msg_list {
104         struct msg_list *next;
105         char *buf;
106         int len;
107 };
108
109 static struct msg_list *msg_list_head;
110 static struct msg_list *msg_list_tail;
111
112 static void redo_list_add(int num)
113 {
114         struct redo_list *rl;
115
116         if (!(rl = new(struct redo_list)))
117                 exit_cleanup(RERR_MALLOC);
118         rl->next = NULL;
119         rl->num = num;
120         if (redo_list_tail)
121                 redo_list_tail->next = rl;
122         else
123                 redo_list_head = rl;
124         redo_list_tail = rl;
125 }
126
127 static void check_timeout(void)
128 {
129         time_t t;
130
131         if (!io_timeout)
132                 return;
133
134         if (!last_io) {
135                 last_io = time(NULL);
136                 return;
137         }
138
139         t = time(NULL);
140
141         if (last_io && io_timeout && (t-last_io) >= io_timeout) {
142                 if (!am_server && !am_daemon) {
143                         rprintf(FERROR, "io timeout after %d seconds - exiting\n",
144                                 (int)(t-last_io));
145                 }
146                 exit_cleanup(RERR_TIMEOUT);
147         }
148 }
149
150 /** Setup the fd used to receive MSG_* messages.  Only needed when
151  * we're the generator because the sender and receiver both use the
152  * multiplexed I/O setup. */
153 void set_msg_fd_in(int fd)
154 {
155         msg_fd_in = fd;
156 }
157
158 /** Setup the fd used to send our MSG_* messages.  Only needed when
159  * we're the receiver because the generator and the sender both use
160  * the multiplexed I/O setup. */
161 void set_msg_fd_out(int fd)
162 {
163         msg_fd_out = fd;
164         set_nonblocking(msg_fd_out);
165 }
166
167 /* Add a message to the pending MSG_* list. */
168 static void msg_list_add(int code, char *buf, int len)
169 {
170         struct msg_list *ml;
171
172         if (!(ml = new(struct msg_list)))
173                 exit_cleanup(RERR_MALLOC);
174         ml->next = NULL;
175         if (!(ml->buf = new_array(char, len+4)))
176                 exit_cleanup(RERR_MALLOC);
177         SIVAL(ml->buf, 0, ((code+MPLEX_BASE)<<24) | len);
178         memcpy(ml->buf+4, buf, len);
179         ml->len = len+4;
180         if (msg_list_tail)
181                 msg_list_tail->next = ml;
182         else
183                 msg_list_head = ml;
184         msg_list_tail = ml;
185 }
186
187 void send_msg(enum msgcode code, char *buf, int len)
188 {
189         msg_list_add(code, buf, len);
190         msg_list_push(NORMAL_FLUSH);
191 }
192
193 /** Read a message from the MSG_* fd and dispatch it.  This is only
194  * called by the generator. */
195 static void read_msg_fd(void)
196 {
197         char buf[200];
198         size_t n;
199         int fd = msg_fd_in;
200         int tag, len;
201
202         /* Temporarily disable msg_fd_in.  This is needed because we
203          * may call a write routine that could try to call us back. */
204         msg_fd_in = -1;
205
206         read_loop(fd, buf, 4);
207         tag = IVAL(buf, 0);
208
209         len = tag & 0xFFFFFF;
210         tag = (tag >> 24) - MPLEX_BASE;
211
212         switch (tag) {
213         case MSG_DONE:
214                 if (len != 0) {
215                         rprintf(FERROR, "invalid message %d:%d\n", tag, len);
216                         exit_cleanup(RERR_STREAMIO);
217                 }
218                 redo_list_add(-1);
219                 break;
220         case MSG_REDO:
221                 if (len != 4) {
222                         rprintf(FERROR, "invalid message %d:%d\n", tag, len);
223                         exit_cleanup(RERR_STREAMIO);
224                 }
225                 read_loop(fd, buf, 4);
226                 redo_list_add(IVAL(buf,0));
227                 break;
228         case MSG_INFO:
229         case MSG_ERROR:
230         case MSG_LOG:
231                 while (len) {
232                         n = len;
233                         if (n >= sizeof buf)
234                                 n = sizeof buf - 1;
235                         read_loop(fd, buf, n);
236                         rwrite((enum logcode)tag, buf, n);
237                         len -= n;
238                 }
239                 break;
240         default:
241                 rprintf(FERROR, "unknown message %d:%d\n", tag, len);
242                 exit_cleanup(RERR_STREAMIO);
243         }
244
245         msg_fd_in = fd;
246 }
247
248 /* Try to push messages off the list onto the wire.  If we leave with more
249  * to do, return 0.  On error, return -1.  If everything flushed, return 1.
250  * This is only called by the receiver. */
251 int msg_list_push(int flush_it_all)
252 {
253         static int written = 0;
254         struct timeval tv;
255         fd_set fds;
256
257         if (msg_fd_out < 0)
258                 return -1;
259
260         while (msg_list_head) {
261                 struct msg_list *ml = msg_list_head;
262                 int n = write(msg_fd_out, ml->buf + written, ml->len - written);
263                 if (n < 0) {
264                         if (errno == EINTR)
265                                 continue;
266                         if (errno != EWOULDBLOCK && errno != EAGAIN)
267                                 return -1;
268                         if (!flush_it_all)
269                                 return 0;
270                         FD_ZERO(&fds);
271                         FD_SET(msg_fd_out, &fds);
272                         tv.tv_sec = select_timeout;
273                         tv.tv_usec = 0;
274                         if (!select(msg_fd_out+1, NULL, &fds, NULL, &tv))
275                                 check_timeout();
276                 } else if ((written += n) == ml->len) {
277                         free(ml->buf);
278                         msg_list_head = ml->next;
279                         if (!msg_list_head)
280                                 msg_list_tail = NULL;
281                         free(ml);
282                         written = 0;
283                 }
284         }
285         return 1;
286 }
287
288 int get_redo_num(void)
289 {
290         struct redo_list *next;
291         int num;
292
293         while (!redo_list_head)
294                 read_msg_fd();
295
296         num = redo_list_head->num;
297         next = redo_list_head->next;
298         free(redo_list_head);
299         redo_list_head = next;
300         if (!next)
301                 redo_list_tail = NULL;
302
303         return num;
304 }
305
306 /**
307  * When we're the receiver and we have a local --files-from list of names
308  * that needs to be sent over the socket to the sender, we have to do two
309  * things at the same time: send the sender a list of what files we're
310  * processing and read the incoming file+info list from the sender.  We do
311  * this by augmenting the read_timeout() function to copy this data.  It
312  * uses the io_filesfrom_buf to read a block of data from f_in (when it is
313  * ready, since it might be a pipe) and then blast it out f_out (when it
314  * is ready to receive more data).
315  */
316 void io_set_filesfrom_fds(int f_in, int f_out)
317 {
318         io_filesfrom_f_in = f_in;
319         io_filesfrom_f_out = f_out;
320         io_filesfrom_bp = io_filesfrom_buf;
321         io_filesfrom_lastchar = '\0';
322         io_filesfrom_buflen = 0;
323 }
324
325 /**
326  * It's almost always an error to get an EOF when we're trying to read
327  * from the network, because the protocol is self-terminating.
328  *
329  * However, there is one unfortunate cases where it is not, which is
330  * rsync <2.4.6 sending a list of modules on a server, since the list
331  * is terminated by closing the socket. So, for the section of the
332  * program where that is a problem (start_socket_client),
333  * kludge_around_eof is True and we just exit.
334  */
335 static void whine_about_eof(void)
336 {
337         if (kludge_around_eof)
338                 exit_cleanup(0);
339         else {
340                 rprintf(FERROR, RSYNC_NAME ": connection unexpectedly closed "
341                         "(%.0f bytes read so far)\n",
342                         (double)stats.total_read);
343
344                 exit_cleanup(RERR_STREAMIO);
345         }
346 }
347
348
349 static void die_from_readerr(int err)
350 {
351         /* this prevents us trying to write errors on a dead socket */
352         io_multiplexing_close();
353
354         rsyserr(FERROR, err, "read error");
355         exit_cleanup(RERR_STREAMIO);
356 }
357
358
359 /**
360  * Read from a socket with I/O timeout. return the number of bytes
361  * read. If no bytes can be read then exit, never return a number <= 0.
362  *
363  * TODO: If the remote shell connection fails, then current versions
364  * actually report an "unexpected EOF" error here.  Since it's a
365  * fairly common mistake to try to use rsh when ssh is required, we
366  * should trap that: if we fail to read any data at all, we should
367  * give a better explanation.  We can tell whether the connection has
368  * started by looking e.g. at whether the remote version is known yet.
369  */
370 static int read_timeout(int fd, char *buf, size_t len)
371 {
372         int n, ret = 0;
373
374         io_flush(NORMAL_FLUSH);
375
376         while (ret == 0) {
377                 /* until we manage to read *something* */
378                 fd_set r_fds, w_fds;
379                 struct timeval tv;
380                 int fd_count = fd+1;
381                 int count;
382
383                 FD_ZERO(&r_fds);
384                 FD_SET(fd, &r_fds);
385                 if (msg_fd_in >= 0) {
386                         FD_SET(msg_fd_in, &r_fds);
387                         if (msg_fd_in >= fd_count)
388                                 fd_count = msg_fd_in+1;
389                 } else if (msg_list_head) {
390                         FD_SET(msg_fd_out, &w_fds);
391                         if (msg_fd_out >= fd_count)
392                                 fd_count = msg_fd_out+1;
393                 }
394                 if (io_filesfrom_f_out >= 0) {
395                         int new_fd;
396                         if (io_filesfrom_buflen == 0) {
397                                 if (io_filesfrom_f_in >= 0) {
398                                         FD_SET(io_filesfrom_f_in, &r_fds);
399                                         new_fd = io_filesfrom_f_in;
400                                 } else {
401                                         io_filesfrom_f_out = -1;
402                                         new_fd = -1;
403                                 }
404                         } else {
405                                 FD_ZERO(&w_fds);
406                                 FD_SET(io_filesfrom_f_out, &w_fds);
407                                 new_fd = io_filesfrom_f_out;
408                         }
409                         if (new_fd >= fd_count)
410                                 fd_count = new_fd+1;
411                 }
412
413                 tv.tv_sec = select_timeout;
414                 tv.tv_usec = 0;
415
416                 errno = 0;
417
418                 count = select(fd_count, &r_fds,
419                                io_filesfrom_buflen? &w_fds : NULL,
420                                NULL, &tv);
421
422                 if (count <= 0) {
423                         check_timeout();
424                         if (errno == EBADF)
425                                 exit_cleanup(RERR_SOCKETIO);
426                         continue;
427                 }
428
429                 if (msg_fd_in >= 0 && FD_ISSET(msg_fd_in, &r_fds))
430                         read_msg_fd();
431                 else if (msg_list_head && FD_ISSET(msg_fd_out, &w_fds))
432                         msg_list_push(NORMAL_FLUSH);
433
434                 if (io_filesfrom_f_out >= 0) {
435                         if (io_filesfrom_buflen) {
436                                 if (FD_ISSET(io_filesfrom_f_out, &w_fds)) {
437                                         int l = write(io_filesfrom_f_out,
438                                                       io_filesfrom_bp,
439                                                       io_filesfrom_buflen);
440                                         if (l > 0) {
441                                                 if (!(io_filesfrom_buflen -= l))
442                                                         io_filesfrom_bp = io_filesfrom_buf;
443                                                 else
444                                                         io_filesfrom_bp += l;
445                                         } else {
446                                                 /* XXX should we complain? */
447                                                 io_filesfrom_f_out = -1;
448                                         }
449                                 }
450                         } else if (io_filesfrom_f_in >= 0) {
451                                 if (FD_ISSET(io_filesfrom_f_in, &r_fds)) {
452                                         int l = read(io_filesfrom_f_in,
453                                                      io_filesfrom_buf,
454                                                      sizeof io_filesfrom_buf);
455                                         if (l <= 0) {
456                                                 /* Send end-of-file marker */
457                                                 io_filesfrom_buf[0] = '\0';
458                                                 io_filesfrom_buf[1] = '\0';
459                                                 io_filesfrom_buflen = io_filesfrom_lastchar? 2 : 1;
460                                                 io_filesfrom_f_in = -1;
461                                         } else {
462                                                 if (!eol_nulls) {
463                                                         char *s = io_filesfrom_buf + l;
464                                                         /* Transform CR and/or LF into '\0' */
465                                                         while (s-- > io_filesfrom_buf) {
466                                                                 if (*s == '\n' || *s == '\r')
467                                                                         *s = '\0';
468                                                         }
469                                                 }
470                                                 if (!io_filesfrom_lastchar) {
471                                                         /* Last buf ended with a '\0', so don't
472                                                          * let this buf start with one. */
473                                                         while (l && !*io_filesfrom_bp)
474                                                                 io_filesfrom_bp++, l--;
475                                                 }
476                                                 if (!l)
477                                                         io_filesfrom_bp = io_filesfrom_buf;
478                                                 else {
479                                                         char *f = io_filesfrom_bp;
480                                                         char *t = f;
481                                                         char *eob = f + l;
482                                                         /* Eliminate any multi-'\0' runs. */
483                                                         while (f != eob) {
484                                                                 if (!(*t++ = *f++)) {
485                                                                         while (f != eob && !*f)
486                                                                                 f++, l--;
487                                                                 }
488                                                         }
489                                                         io_filesfrom_lastchar = f[-1];
490                                                 }
491                                                 io_filesfrom_buflen = l;
492                                         }
493                                 }
494                         }
495                 }
496
497                 if (!FD_ISSET(fd, &r_fds))
498                         continue;
499
500                 n = read(fd, buf, len);
501
502                 if (n > 0) {
503                         buf += n;
504                         len -= n;
505                         ret += n;
506                         if (io_timeout)
507                                 last_io = time(NULL);
508                         continue;
509                 } else if (n == 0) {
510                         whine_about_eof();
511                         return -1; /* doesn't return */
512                 } else if (n < 0) {
513                         if (errno == EINTR || errno == EWOULDBLOCK
514                             || errno == EAGAIN)
515                                 continue;
516                         die_from_readerr(errno);
517                 }
518         }
519
520         return ret;
521 }
522
523 /**
524  * Read a line into the "fname" buffer (which must be at least MAXPATHLEN
525  * characters long).
526  */
527 int read_filesfrom_line(int fd, char *fname)
528 {
529         char ch, *s, *eob = fname + MAXPATHLEN - 1;
530         int cnt;
531         int reading_remotely = remote_filesfrom_file != NULL;
532         int nulls = eol_nulls || reading_remotely;
533
534   start:
535         s = fname;
536         while (1) {
537                 cnt = read(fd, &ch, 1);
538                 if (cnt < 0 && (errno == EWOULDBLOCK
539                   || errno == EINTR || errno == EAGAIN)) {
540                         struct timeval tv;
541                         fd_set fds;
542                         FD_ZERO(&fds);
543                         FD_SET(fd, &fds);
544                         tv.tv_sec = select_timeout;
545                         tv.tv_usec = 0;
546                         if (!select(fd+1, &fds, NULL, NULL, &tv))
547                                 check_timeout();
548                         continue;
549                 }
550                 if (cnt != 1)
551                         break;
552                 if (nulls? !ch : (ch == '\r' || ch == '\n')) {
553                         /* Skip empty lines if reading locally. */
554                         if (!reading_remotely && s == fname)
555                                 continue;
556                         break;
557                 }
558                 if (s < eob)
559                         *s++ = ch;
560         }
561         *s = '\0';
562
563         /* Dump comments. */
564         if (*fname == '#' || *fname == ';')
565                 goto start;
566
567         return s - fname;
568 }
569
570
571 /**
572  * Continue trying to read len bytes - don't return until len has been
573  * read.
574  **/
575 static void read_loop(int fd, char *buf, size_t len)
576 {
577         while (len) {
578                 int n = read_timeout(fd, buf, len);
579
580                 buf += n;
581                 len -= n;
582         }
583 }
584
585
586 /**
587  * Read from the file descriptor handling multiplexing - return number
588  * of bytes read.
589  *
590  * Never returns <= 0.
591  */
592 static int read_unbuffered(int fd, char *buf, size_t len)
593 {
594         static size_t remaining;
595         int tag, ret = 0;
596         char line[1024];
597         static char *buffer;
598         static size_t bufferIdx = 0;
599         static size_t bufferSz;
600
601         if (fd != multiplex_in_fd)
602                 return read_timeout(fd, buf, len);
603
604         if (!io_multiplexing_in && remaining == 0) {
605                 if (!buffer) {
606                         bufferSz = 2 * IO_BUFFER_SIZE;
607                         buffer   = new_array(char, bufferSz);
608                         if (!buffer)
609                                 out_of_memory("read_unbuffered");
610                 }
611                 remaining = read_timeout(fd, buffer, bufferSz);
612                 bufferIdx = 0;
613         }
614
615         while (ret == 0) {
616                 if (remaining) {
617                         len = MIN(len, remaining);
618                         memcpy(buf, buffer + bufferIdx, len);
619                         bufferIdx += len;
620                         remaining -= len;
621                         ret = len;
622                         break;
623                 }
624
625                 read_loop(fd, line, 4);
626                 tag = IVAL(line, 0);
627
628                 remaining = tag & 0xFFFFFF;
629                 tag = (tag >> 24) - MPLEX_BASE;
630
631                 switch (tag) {
632                 case MSG_DATA:
633                         if (!buffer || remaining > bufferSz) {
634                                 buffer = realloc_array(buffer, char, remaining);
635                                 if (!buffer)
636                                         out_of_memory("read_unbuffered");
637                                 bufferSz = remaining;
638                         }
639                         read_loop(fd, buffer, remaining);
640                         bufferIdx = 0;
641                         break;
642                 case MSG_INFO:
643                 case MSG_ERROR:
644                         if (remaining >= sizeof line) {
645                                 rprintf(FERROR, "multiplexing overflow %d:%ld\n\n",
646                                         tag, (long)remaining);
647                                 exit_cleanup(RERR_STREAMIO);
648                         }
649                         read_loop(fd, line, remaining);
650                         rwrite((enum logcode)tag, line, remaining);
651                         remaining = 0;
652                         break;
653                 default:
654                         rprintf(FERROR, "unexpected tag %d\n", tag);
655                         exit_cleanup(RERR_STREAMIO);
656                 }
657         }
658
659         if (remaining == 0)
660                 io_flush(NORMAL_FLUSH);
661
662         return ret;
663 }
664
665
666
667 /**
668  * Do a buffered read from @p fd.  Don't return until all @p n bytes
669  * have been read.  If all @p n can't be read then exit with an
670  * error.
671  **/
672 static void readfd(int fd, char *buffer, size_t N)
673 {
674         int  ret;
675         size_t total = 0;
676
677         while (total < N) {
678                 ret = read_unbuffered(fd, buffer + total, N-total);
679                 total += ret;
680         }
681
682         stats.total_read += total;
683 }
684
685
686 int32 read_int(int f)
687 {
688         char b[4];
689         int32 ret;
690
691         readfd(f,b,4);
692         ret = IVAL(b,0);
693         if (ret == (int32)0xffffffff)
694                 return -1;
695         return ret;
696 }
697
698 int64 read_longint(int f)
699 {
700         int64 ret;
701         char b[8];
702         ret = read_int(f);
703
704         if ((int32)ret != (int32)0xffffffff)
705                 return ret;
706
707 #ifdef NO_INT64
708         rprintf(FERROR,"Integer overflow - attempted 64 bit offset\n");
709         exit_cleanup(RERR_UNSUPPORTED);
710 #else
711         readfd(f,b,8);
712         ret = IVAL(b,0) | (((int64)IVAL(b,4))<<32);
713 #endif
714
715         return ret;
716 }
717
718 void read_buf(int f,char *buf,size_t len)
719 {
720         readfd(f,buf,len);
721 }
722
723 void read_sbuf(int f,char *buf,size_t len)
724 {
725         read_buf(f,buf,len);
726         buf[len] = 0;
727 }
728
729 unsigned char read_byte(int f)
730 {
731         unsigned char c;
732         read_buf(f, (char *)&c, 1);
733         return c;
734 }
735
736
737 /**
738  * Sleep after writing to limit I/O bandwidth usage.
739  *
740  * @todo Rather than sleeping after each write, it might be better to
741  * use some kind of averaging.  The current algorithm seems to always
742  * use a bit less bandwidth than specified, because it doesn't make up
743  * for slow periods.  But arguably this is a feature.  In addition, we
744  * ought to take the time used to write the data into account.
745  *
746  * During some phases of big transfers (file FOO is uptodate) this is
747  * called with a small bytes_written every time.  As the kernel has to
748  * round small waits up to guarantee that we actually wait at least the
749  * requested number of microseconds, this can become grossly inaccurate.
750  * We therefore keep track of the bytes we've written over time and only
751  * sleep when the accumulated delay is at least 1 tenth of a second.
752  **/
753 static void sleep_for_bwlimit(int bytes_written)
754 {
755         static struct timeval prior_tv;
756         static long total_written = 0; 
757         struct timeval tv, start_tv;
758         long elapsed_usec, sleep_usec;
759
760 #define ONE_SEC 1000000L /* # of microseconds in a second */
761
762         if (!bwlimit)
763                 return;
764
765         total_written += bytes_written; 
766
767         gettimeofday(&start_tv, NULL);
768         if (prior_tv.tv_sec) {
769                 elapsed_usec = (start_tv.tv_sec - prior_tv.tv_sec) * ONE_SEC
770                              + (start_tv.tv_usec - prior_tv.tv_usec);
771                 total_written -= elapsed_usec * bwlimit / (ONE_SEC/1024);
772                 if (total_written < 0)
773                         total_written = 0;
774         }
775
776         sleep_usec = total_written * (ONE_SEC/1024) / bwlimit;
777         if (sleep_usec < ONE_SEC / 10) {
778                 prior_tv = start_tv;
779                 return;
780         }
781
782         tv.tv_sec  = sleep_usec / ONE_SEC;
783         tv.tv_usec = sleep_usec % ONE_SEC;
784         select(0, NULL, NULL, NULL, &tv);
785
786         gettimeofday(&prior_tv, NULL);
787         elapsed_usec = (prior_tv.tv_sec - start_tv.tv_sec) * ONE_SEC
788                      + (prior_tv.tv_usec - start_tv.tv_usec);
789         total_written = (sleep_usec - elapsed_usec) * bwlimit / (ONE_SEC/1024);
790 }
791
792
793 /**
794  * Write len bytes to the file descriptor @p fd.
795  *
796  * This function underlies the multiplexing system.  The body of the
797  * application never calls this function directly.
798  **/
799 static void writefd_unbuffered(int fd,char *buf,size_t len)
800 {
801         size_t total = 0;
802         fd_set w_fds, r_fds;
803         int fd_count, count;
804         struct timeval tv;
805
806         if (fd == msg_fd_out) {
807                 rprintf(FERROR, "Internal error: wrong write used in receiver.\n");
808                 exit_cleanup(RERR_PROTOCOL);
809         }
810
811         no_flush++;
812
813         while (total < len) {
814                 FD_ZERO(&w_fds);
815                 FD_SET(fd,&w_fds);
816                 fd_count = fd;
817
818                 if (msg_fd_in >= 0) {
819                         FD_ZERO(&r_fds);
820                         FD_SET(msg_fd_in,&r_fds);
821                         if (msg_fd_in > fd_count)
822                                 fd_count = msg_fd_in;
823                 }
824
825                 tv.tv_sec = select_timeout;
826                 tv.tv_usec = 0;
827
828                 errno = 0;
829                 count = select(fd_count+1, msg_fd_in >= 0 ? &r_fds : NULL,
830                                &w_fds, NULL, &tv);
831
832                 if (count <= 0) {
833                         check_timeout();
834                         if (errno == EBADF)
835                                 exit_cleanup(RERR_SOCKETIO);
836                         continue;
837                 }
838
839                 if (msg_fd_in >= 0 && FD_ISSET(msg_fd_in, &r_fds))
840                         read_msg_fd();
841
842                 if (FD_ISSET(fd, &w_fds)) {
843                         int ret;
844                         size_t n = len-total;
845                         if (bwlimit && n > bwlimit_writemax)
846                                 n = bwlimit_writemax;
847                         ret = write(fd,buf+total,n);
848
849                         if (ret < 0) {
850                                 if (errno == EINTR)
851                                         continue;
852                                 if (errno == EWOULDBLOCK || errno == EAGAIN) {
853                                         msleep(1);
854                                         continue;
855                                 }
856                         }
857
858                         if (ret <= 0) {
859                                 /* Don't try to write errors back
860                                  * across the stream */
861                                 io_multiplexing_close();
862                                 rsyserr(FERROR, errno,
863                                         "writefd_unbuffered failed to write %ld bytes: phase \"%s\"",
864                                         (long)len, io_write_phase);
865                                 exit_cleanup(RERR_STREAMIO);
866                         }
867
868                         sleep_for_bwlimit(ret);
869
870                         total += ret;
871
872                         if (io_timeout)
873                                 last_io = time(NULL);
874                 }
875         }
876
877         no_flush--;
878 }
879
880
881 static char *io_buffer;
882 static int io_buffer_count;
883
884 void io_start_buffering_out(int fd)
885 {
886         if (io_buffer)
887                 return;
888         multiplex_out_fd = fd;
889         io_buffer = new_array(char, IO_BUFFER_SIZE);
890         if (!io_buffer)
891                 out_of_memory("writefd");
892         io_buffer_count = 0;
893 }
894
895 void io_start_buffering_in(int fd)
896 {
897         multiplex_in_fd = fd;
898 }
899
900 /**
901  * Write an message to a multiplexed stream. If this fails then rsync
902  * exits.
903  **/
904 static void mplex_write(int fd, enum msgcode code, char *buf, size_t len)
905 {
906         char buffer[4096];
907         size_t n = len;
908
909         SIVAL(buffer, 0, ((MPLEX_BASE + (int)code)<<24) + len);
910
911         if (n > (sizeof buffer - 4)) {
912                 n = sizeof buffer - 4;
913         }
914
915         memcpy(&buffer[4], buf, n);
916         writefd_unbuffered(fd, buffer, n+4);
917
918         len -= n;
919         buf += n;
920
921         if (len) {
922                 writefd_unbuffered(fd, buf, len);
923         }
924 }
925
926
927 void io_flush(int flush_it_all)
928 {
929         int fd = multiplex_out_fd;
930
931         msg_list_push(flush_it_all);
932
933         if (!io_buffer_count || no_flush)
934                 return;
935
936         if (io_multiplexing_out)
937                 mplex_write(fd, MSG_DATA, io_buffer, io_buffer_count);
938         else
939                 writefd_unbuffered(fd, io_buffer, io_buffer_count);
940         io_buffer_count = 0;
941 }
942
943
944 void io_end_buffering(void)
945 {
946         io_flush(NORMAL_FLUSH);
947         if (!io_multiplexing_out) {
948                 free(io_buffer);
949                 io_buffer = NULL;
950         }
951 }
952
953 static void writefd(int fd,char *buf,size_t len)
954 {
955         stats.total_written += len;
956
957         if (fd == msg_fd_out) {
958                 rprintf(FERROR, "Internal error: wrong write used in receiver.\n");
959                 exit_cleanup(RERR_PROTOCOL);
960         }
961
962         if (!io_buffer || fd != multiplex_out_fd) {
963                 writefd_unbuffered(fd, buf, len);
964                 return;
965         }
966
967         while (len) {
968                 int n = MIN((int)len, IO_BUFFER_SIZE-io_buffer_count);
969                 if (n > 0) {
970                         memcpy(io_buffer+io_buffer_count, buf, n);
971                         buf += n;
972                         len -= n;
973                         io_buffer_count += n;
974                 }
975
976                 if (io_buffer_count == IO_BUFFER_SIZE)
977                         io_flush(NORMAL_FLUSH);
978         }
979 }
980
981
982 void write_int(int f,int32 x)
983 {
984         char b[4];
985         SIVAL(b,0,x);
986         writefd(f,b,4);
987 }
988
989
990 void write_int_named(int f, int32 x, const char *phase)
991 {
992         io_write_phase = phase;
993         write_int(f, x);
994         io_write_phase = phase_unknown;
995 }
996
997
998 /*
999  * Note: int64 may actually be a 32-bit type if ./configure couldn't find any
1000  * 64-bit types on this platform.
1001  */
1002 void write_longint(int f, int64 x)
1003 {
1004         char b[8];
1005
1006         if (x <= 0x7FFFFFFF) {
1007                 write_int(f, (int)x);
1008                 return;
1009         }
1010
1011 #ifdef NO_INT64
1012         rprintf(FERROR,"Integer overflow - attempted 64 bit offset\n");
1013         exit_cleanup(RERR_UNSUPPORTED);
1014 #else
1015         write_int(f, (int32)0xFFFFFFFF);
1016         SIVAL(b,0,(x&0xFFFFFFFF));
1017         SIVAL(b,4,((x>>32)&0xFFFFFFFF));
1018
1019         writefd(f,b,8);
1020 #endif
1021 }
1022
1023 void write_buf(int f,char *buf,size_t len)
1024 {
1025         writefd(f,buf,len);
1026 }
1027
1028 /** Write a string to the connection */
1029 static void write_sbuf(int f,char *buf)
1030 {
1031         write_buf(f, buf, strlen(buf));
1032 }
1033
1034
1035 void write_byte(int f,unsigned char c)
1036 {
1037         write_buf(f,(char *)&c,1);
1038 }
1039
1040
1041
1042 /**
1043  * Read a line of up to @p maxlen characters into @p buf (not counting
1044  * the trailing null).  Strips the (required) trailing newline and all
1045  * carriage returns.
1046  *
1047  * @return 1 for success; 0 for I/O error or truncation.
1048  **/
1049 int read_line(int f, char *buf, size_t maxlen)
1050 {
1051         while (maxlen) {
1052                 buf[0] = 0;
1053                 read_buf(f, buf, 1);
1054                 if (buf[0] == 0)
1055                         return 0;
1056                 if (buf[0] == '\n')
1057                         break;
1058                 if (buf[0] != '\r') {
1059                         buf++;
1060                         maxlen--;
1061                 }
1062         }
1063         *buf = '\0';
1064         return maxlen > 0;
1065 }
1066
1067
1068 void io_printf(int fd, const char *format, ...)
1069 {
1070         va_list ap;
1071         char buf[1024];
1072         int len;
1073
1074         va_start(ap, format);
1075         len = vsnprintf(buf, sizeof buf, format, ap);
1076         va_end(ap);
1077
1078         if (len < 0)
1079                 exit_cleanup(RERR_STREAMIO);
1080
1081         write_sbuf(fd, buf);
1082 }
1083
1084
1085 /** Setup for multiplexing a MSG_* stream with the data stream. */
1086 void io_start_multiplex_out(int fd)
1087 {
1088         multiplex_out_fd = fd;
1089         io_flush(NORMAL_FLUSH);
1090         io_start_buffering_out(fd);
1091         io_multiplexing_out = 1;
1092 }
1093
1094 /** Setup for multiplexing a MSG_* stream with the data stream. */
1095 void io_start_multiplex_in(int fd)
1096 {
1097         multiplex_in_fd = fd;
1098         io_flush(NORMAL_FLUSH);
1099         io_multiplexing_in = 1;
1100 }
1101
1102 /** Write an message to the multiplexed data stream. */
1103 int io_multiplex_write(enum msgcode code, char *buf, size_t len)
1104 {
1105         if (!io_multiplexing_out)
1106                 return 0;
1107
1108         io_flush(NORMAL_FLUSH);
1109         stats.total_written += (len+4);
1110         mplex_write(multiplex_out_fd, code, buf, len);
1111         return 1;
1112 }
1113
1114 /** Stop output multiplexing. */
1115 void io_multiplexing_close(void)
1116 {
1117         io_multiplexing_out = 0;
1118 }
1119