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                 }
 390                 if (io_filesfrom_f_out >= 0) {
 391                         int new_fd;
 392                         if (io_filesfrom_buflen == 0) {
 393                                 if (io_filesfrom_f_in >= 0) {
 394                                         FD_SET(io_filesfrom_f_in, &r_fds);
 395                                         new_fd = io_filesfrom_f_in;
 396                                 } else {
 397                                         io_filesfrom_f_out = -1;
 398                                         new_fd = -1;
 399                                 }
 400                         } else {
 401                                 FD_ZERO(&w_fds);
 402                                 FD_SET(io_filesfrom_f_out, &w_fds);
 403                                 new_fd = io_filesfrom_f_out;
 404                         }
 405                         if (new_fd >= fd_count)
 406                                 fd_count = new_fd+1;
 407                 }
 408
 409                 tv.tv_sec = select_timeout;
 410                 tv.tv_usec = 0;
 411
 412                 errno = 0;
 413
 414                 count = select(fd_count, &r_fds,
 415                                io_filesfrom_buflen? &w_fds : NULL,
 416                                NULL, &tv);
 417
 418                 if (count == 0) {
 419                         msg_list_push(NORMAL_FLUSH);
 420                         check_timeout();
 421                 }
 422
 423                 if (count <= 0) {
 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
 432                 if (io_filesfrom_f_out >= 0) {
 433                         if (io_filesfrom_buflen) {
 434                                 if (FD_ISSET(io_filesfrom_f_out, &w_fds)) {
 435                                         int l = write(io_filesfrom_f_out,
 436                                                       io_filesfrom_bp,
 437                                                       io_filesfrom_buflen);
 438                                         if (l > 0) {
 439                                                 if (!(io_filesfrom_buflen -= l))
 440                                                         io_filesfrom_bp = io_filesfrom_buf;
 441                                                 else
 442                                                         io_filesfrom_bp += l;
 443                                         } else {
 444                                                 /* XXX should we complain? */
 445                                                 io_filesfrom_f_out = -1;
 446                                         }
 447                                 }
 448                         } else if (io_filesfrom_f_in >= 0) {
 449                                 if (FD_ISSET(io_filesfrom_f_in, &r_fds)) {
 450                                         int l = read(io_filesfrom_f_in,
 451                                                      io_filesfrom_buf,
 452                                                      sizeof io_filesfrom_buf);
 453                                         if (l <= 0) {
 454                                                 /* Send end-of-file marker */
 455                                                 io_filesfrom_buf[0] = '\0';
 456                                                 io_filesfrom_buf[1] = '\0';
 457                                                 io_filesfrom_buflen = io_filesfrom_lastchar? 2 : 1;
 458                                                 io_filesfrom_f_in = -1;
 459                                         } else {
 460                                                 if (!eol_nulls) {
 461                                                         char *s = io_filesfrom_buf + l;
 462                                                         /* Transform CR and/or LF into '\0' */
 463                                                         while (s-- > io_filesfrom_buf) {
 464                                                                 if (*s == '\n' || *s == '\r')
 465                                                                         *s = '\0';
 466                                                         }
 467                                                 }
 468                                                 if (!io_filesfrom_lastchar) {
 469                                                         /* Last buf ended with a '\0', so don't
 470                                                          * let this buf start with one. */
 471                                                         while (l && !*io_filesfrom_bp)
 472                                                                 io_filesfrom_bp++, l--;
 473                                                 }
 474                                                 if (!l)
 475                                                         io_filesfrom_bp = io_filesfrom_buf;
 476                                                 else {
 477                                                         char *f = io_filesfrom_bp;
 478                                                         char *t = f;
 479                                                         char *eob = f + l;
 480                                                         /* Eliminate any multi-'\0' runs. */
 481                                                         while (f != eob) {
 482                                                                 if (!(*t++ = *f++)) {
 483                                                                         while (f != eob && !*f)
 484                                                                                 f++, l--;
 485                                                                 }
 486                                                         }
 487                                                         io_filesfrom_lastchar = f[-1];
 488                                                 }
 489                                                 io_filesfrom_buflen = l;
 490                                         }
 491                                 }
 492                         }
 493                 }
 494
 495                 if (!FD_ISSET(fd, &r_fds))
 496                         continue;
 497
 498                 n = read(fd, buf, len);
 499
 500                 if (n > 0) {
 501                         buf += n;
 502                         len -= n;
 503                         ret += n;
 504                         if (io_timeout)
 505                                 last_io = time(NULL);
 506                         continue;
 507                 } else if (n == 0) {
 508                         whine_about_eof();
 509                         return -1; /* doesn't return */
 510                 } else if (n < 0) {
 511                         if (errno == EINTR || errno == EWOULDBLOCK
 512                             || errno == EAGAIN)
 513                                 continue;
 514                         die_from_readerr(errno);
 515                 }
 516         }
 517
 518         return ret;
 519 }
 520
 521 /**
 522  * Read a line into the "fname" buffer (which must be at least MAXPATHLEN
 523  * characters long).
 524  */
 525 int read_filesfrom_line(int fd, char *fname)
 526 {
 527         char ch, *s, *eob = fname + MAXPATHLEN - 1;
 528         int cnt;
 529         int reading_remotely = remote_filesfrom_file != NULL;
 530         int nulls = eol_nulls || reading_remotely;
 531
 532   start:
 533         s = fname;
 534         while (1) {
 535                 cnt = read(fd, &ch, 1);
 536                 if (cnt < 0 && (errno == EWOULDBLOCK
 537                   || errno == EINTR || errno == EAGAIN)) {
 538                         struct timeval tv;
 539                         fd_set fds;
 540                         FD_ZERO(&fds);
 541                         FD_SET(fd, &fds);
 542                         tv.tv_sec = select_timeout;
 543                         tv.tv_usec = 0;
 544                         if (!select(fd+1, &fds, NULL, NULL, &tv))
 545                                 check_timeout();
 546                         continue;
 547                 }
 548                 if (cnt != 1)
 549                         break;
 550                 if (nulls? !ch : (ch == '\r' || ch == '\n')) {
 551                         /* Skip empty lines if reading locally. */
 552                         if (!reading_remotely && s == fname)
 553                                 continue;
 554                         break;
 555                 }
 556                 if (s < eob)
 557                         *s++ = ch;
 558         }
 559         *s = '\0';
 560
 561         /* Dump comments. */
 562         if (*fname == '#' || *fname == ';')
 563                 goto start;
 564
 565         return s - fname;
 566 }
 567
 568
 569 /**
 570  * Continue trying to read len bytes - don't return until len has been
 571  * read.
 572  **/
 573 static void read_loop(int fd, char *buf, size_t len)
 574 {
 575         while (len) {
 576                 int n = read_timeout(fd, buf, len);
 577
 578                 buf += n;
 579                 len -= n;
 580         }
 581 }
 582
 583
 584 /**
 585  * Read from the file descriptor handling multiplexing - return number
 586  * of bytes read.
 587  *
 588  * Never returns <= 0.
 589  */
 590 static int read_unbuffered(int fd, char *buf, size_t len)
 591 {
 592         static size_t remaining;
 593         int tag, ret = 0;
 594         char line[1024];
 595         static char *buffer;
 596         static size_t bufferIdx = 0;
 597         static size_t bufferSz;
 598
 599         if (fd != multiplex_in_fd)
 600                 return read_timeout(fd, buf, len);
 601
 602         if (!io_multiplexing_in && remaining == 0) {
 603                 if (!buffer) {
 604                         bufferSz = 2 * IO_BUFFER_SIZE;
 605                         buffer   = new_array(char, bufferSz);
 606                         if (!buffer)
 607                                 out_of_memory("read_unbuffered");
 608                 }
 609                 remaining = read_timeout(fd, buffer, bufferSz);
 610                 bufferIdx = 0;
 611         }
 612
 613         while (ret == 0) {
 614                 if (remaining) {
 615                         len = MIN(len, remaining);
 616                         memcpy(buf, buffer + bufferIdx, len);
 617                         bufferIdx += len;
 618                         remaining -= len;
 619                         ret = len;
 620                         break;
 621                 }
 622
 623                 read_loop(fd, line, 4);
 624                 tag = IVAL(line, 0);
 625
 626                 remaining = tag & 0xFFFFFF;
 627                 tag = (tag >> 24) - MPLEX_BASE;
 628
 629                 switch (tag) {
 630                 case MSG_DATA:
 631                         if (!buffer || remaining > bufferSz) {
 632                                 buffer = realloc_array(buffer, char, remaining);
 633                                 if (!buffer)
 634                                         out_of_memory("read_unbuffered");
 635                                 bufferSz = remaining;
 636                         }
 637                         read_loop(fd, buffer, remaining);
 638                         bufferIdx = 0;
 639                         break;
 640                 case MSG_INFO:
 641                 case MSG_ERROR:
 642                         if (remaining >= sizeof line) {
 643                                 rprintf(FERROR, "multiplexing overflow %d:%ld\n\n",
 644                                         tag, (long)remaining);
 645                                 exit_cleanup(RERR_STREAMIO);
 646                         }
 647                         read_loop(fd, line, remaining);
 648                         rwrite((enum logcode)tag, line, remaining);
 649                         remaining = 0;
 650                         break;
 651                 default:
 652                         rprintf(FERROR, "unexpected tag %d\n", tag);
 653                         exit_cleanup(RERR_STREAMIO);
 654                 }
 655         }
 656
 657         if (remaining == 0)
 658                 io_flush(NORMAL_FLUSH);
 659
 660         return ret;
 661 }
 662
 663
 664
 665 /**
 666  * Do a buffered read from @p fd.  Don't return until all @p n bytes
 667  * have been read.  If all @p n can't be read then exit with an
 668  * error.
 669  **/
 670 static void readfd(int fd, char *buffer, size_t N)
 671 {
 672         int  ret;
 673         size_t total = 0;
 674
 675         while (total < N) {
 676                 ret = read_unbuffered(fd, buffer + total, N-total);
 677                 total += ret;
 678         }
 679
 680         stats.total_read += total;
 681 }
 682
 683
 684 int32 read_int(int f)
 685 {
 686         char b[4];
 687         int32 ret;
 688
 689         readfd(f,b,4);
 690         ret = IVAL(b,0);
 691         if (ret == (int32)0xffffffff)
 692                 return -1;
 693         return ret;
 694 }
 695
 696 int64 read_longint(int f)
 697 {
 698         int64 ret;
 699         char b[8];
 700         ret = read_int(f);
 701
 702         if ((int32)ret != (int32)0xffffffff)
 703                 return ret;
 704
 705 #ifdef NO_INT64
 706         rprintf(FERROR,"Integer overflow - attempted 64 bit offset\n");
 707         exit_cleanup(RERR_UNSUPPORTED);
 708 #else
 709         readfd(f,b,8);
 710         ret = IVAL(b,0) | (((int64)IVAL(b,4))<<32);
 711 #endif
 712
 713         return ret;
 714 }
 715
 716 void read_buf(int f,char *buf,size_t len)
 717 {
 718         readfd(f,buf,len);
 719 }
 720
 721 void read_sbuf(int f,char *buf,size_t len)
 722 {
 723         read_buf(f,buf,len);
 724         buf[len] = 0;
 725 }
 726
 727 unsigned char read_byte(int f)
 728 {
 729         unsigned char c;
 730         read_buf(f, (char *)&c, 1);
 731         return c;
 732 }
 733
 734
 735 /**
 736  * Sleep after writing to limit I/O bandwidth usage.
 737  *
 738  * @todo Rather than sleeping after each write, it might be better to
 739  * use some kind of averaging.  The current algorithm seems to always
 740  * use a bit less bandwidth than specified, because it doesn't make up
 741  * for slow periods.  But arguably this is a feature.  In addition, we
 742  * ought to take the time used to write the data into account.
 743  *
 744  * During some phases of big transfers (file FOO is uptodate) this is
 745  * called with a small bytes_written every time.  As the kernel has to
 746  * round small waits up to guarantee that we actually wait at least the
 747  * requested number of microseconds, this can become grossly inaccurate.
 748  * We therefore keep track of the bytes we've written over time and only
 749  * sleep when the accumulated delay is at least 1 tenth of a second.
 750  **/
 751 static void sleep_for_bwlimit(int bytes_written)
 752 {
 753         static struct timeval prior_tv;
 754         static long total_written = 0;
 755         struct timeval tv, start_tv;
 756         long elapsed_usec, sleep_usec;
 757
 758 #define ONE_SEC 1000000L /* # of microseconds in a second */
 759
 760         if (!bwlimit)
 761                 return;
 762
 763         total_written += bytes_written;
 764
 765         gettimeofday(&start_tv, NULL);
 766         if (prior_tv.tv_sec) {
 767                 elapsed_usec = (start_tv.tv_sec - prior_tv.tv_sec) * ONE_SEC
 768                              + (start_tv.tv_usec - prior_tv.tv_usec);
 769                 total_written -= elapsed_usec * bwlimit / (ONE_SEC/1024);
 770                 if (total_written < 0)
 771                         total_written = 0;
 772         }
 773
 774         sleep_usec = total_written * (ONE_SEC/1024) / bwlimit;
 775         if (sleep_usec < ONE_SEC / 10) {
 776                 prior_tv = start_tv;
 777                 return;
 778         }
 779
 780         tv.tv_sec  = sleep_usec / ONE_SEC;
 781         tv.tv_usec = sleep_usec % ONE_SEC;
 782         select(0, NULL, NULL, NULL, &tv);
 783
 784         gettimeofday(&prior_tv, NULL);
 785         elapsed_usec = (prior_tv.tv_sec - start_tv.tv_sec) * ONE_SEC
 786                      + (prior_tv.tv_usec - start_tv.tv_usec);
 787         total_written = (sleep_usec - elapsed_usec) * bwlimit / (ONE_SEC/1024);
 788 }
 789
 790
 791 /**
 792  * Write len bytes to the file descriptor @p fd.
 793  *
 794  * This function underlies the multiplexing system.  The body of the
 795  * application never calls this function directly.
 796  **/
 797 static void writefd_unbuffered(int fd,char *buf,size_t len)
 798 {
 799         size_t total = 0;
 800         fd_set w_fds, r_fds;
 801         int fd_count, count;
 802         struct timeval tv;
 803
 804         msg_list_push(NORMAL_FLUSH);
 805
 806         no_flush++;
 807
 808         while (total < len) {
 809                 FD_ZERO(&w_fds);
 810                 FD_SET(fd,&w_fds);
 811                 fd_count = fd;
 812
 813                 if (msg_fd_in >= 0) {
 814                         FD_ZERO(&r_fds);
 815                         FD_SET(msg_fd_in,&r_fds);
 816                         if (msg_fd_in > fd_count)
 817                                 fd_count = msg_fd_in;
 818                 }
 819
 820                 tv.tv_sec = select_timeout;
 821                 tv.tv_usec = 0;
 822
 823                 errno = 0;
 824                 count = select(fd_count+1, msg_fd_in >= 0 ? &r_fds : NULL,
 825                                &w_fds, NULL, &tv);
 826
 827                 if (count == 0) {
 828                         msg_list_push(NORMAL_FLUSH);
 829                         check_timeout();
 830                 }
 831
 832                 if (count <= 0) {
 833                         if (errno == EBADF)
 834                                 exit_cleanup(RERR_SOCKETIO);
 835                         continue;
 836                 }
 837
 838                 if (msg_fd_in >= 0 && FD_ISSET(msg_fd_in, &r_fds))
 839                         read_msg_fd();
 840
 841                 if (FD_ISSET(fd, &w_fds)) {
 842                         int ret;
 843                         size_t n = len-total;
 844                         if (bwlimit && n > bwlimit_writemax)
 845                                 n = bwlimit_writemax;
 846                         ret = write(fd,buf+total,n);
 847
 848                         if (ret < 0) {
 849                                 if (errno == EINTR)
 850                                         continue;
 851                                 if (errno == EWOULDBLOCK || errno == EAGAIN) {
 852                                         msleep(1);
 853                                         continue;
 854                                 }
 855                         }
 856
 857                         if (ret <= 0) {
 858                                 /* Don't try to write errors back
 859                                  * across the stream */
 860                                 io_multiplexing_close();
 861                                 rsyserr(FERROR, errno,
 862                                         "writefd_unbuffered failed to write %ld bytes: phase \"%s\"",
 863                                         (long)len, io_write_phase);
 864                                 exit_cleanup(RERR_STREAMIO);
 865                         }
 866
 867                         sleep_for_bwlimit(ret);
 868
 869                         total += ret;
 870
 871                         if (io_timeout)
 872                                 last_io = time(NULL);
 873                 }
 874         }
 875
 876         no_flush--;
 877 }
 878
 879
 880 static char *io_buffer;
 881 static int io_buffer_count;
 882
 883 void io_start_buffering_out(int fd)
 884 {
 885         if (io_buffer)
 886                 return;
 887         multiplex_out_fd = fd;
 888         io_buffer = new_array(char, IO_BUFFER_SIZE);
 889         if (!io_buffer)
 890                 out_of_memory("writefd");
 891         io_buffer_count = 0;
 892 }
 893
 894 void io_start_buffering_in(int fd)
 895 {
 896         multiplex_in_fd = fd;
 897 }
 898
 899 /**
 900  * Write an message to a multiplexed stream. If this fails then rsync
 901  * exits.
 902  **/
 903 static void mplex_write(int fd, enum msgcode code, char *buf, size_t len)
 904 {
 905         char buffer[4096];
 906         size_t n = len;
 907
 908         SIVAL(buffer, 0, ((MPLEX_BASE + (int)code)<<24) + len);
 909
 910         if (n > (sizeof buffer - 4)) {
 911                 n = sizeof buffer - 4;
 912         }
 913
 914         memcpy(&buffer[4], buf, n);
 915         writefd_unbuffered(fd, buffer, n+4);
 916
 917         len -= n;
 918         buf += n;
 919
 920         if (len) {
 921                 writefd_unbuffered(fd, buf, len);
 922         }
 923 }
 924
 925
 926 void io_flush(int flush_it_all)
 927 {
 928         int fd = multiplex_out_fd;
 929
 930         msg_list_push(flush_it_all);
 931
 932         if (!io_buffer_count || no_flush)
 933                 return;
 934
 935         if (io_multiplexing_out)
 936                 mplex_write(fd, MSG_DATA, io_buffer, io_buffer_count);
 937         else
 938                 writefd_unbuffered(fd, io_buffer, io_buffer_count);
 939         io_buffer_count = 0;
 940 }
 941
 942
 943 void io_end_buffering(void)
 944 {
 945         io_flush(NORMAL_FLUSH);
 946         if (!io_multiplexing_out) {
 947                 free(io_buffer);
 948                 io_buffer = NULL;
 949         }
 950 }
 951
 952 static void writefd(int fd,char *buf,size_t len)
 953 {
 954         stats.total_written += len;
 955
 956         msg_list_push(NORMAL_FLUSH);
 957
 958         if (!io_buffer || fd != multiplex_out_fd) {
 959                 writefd_unbuffered(fd, buf, len);
 960                 return;
 961         }
 962
 963         while (len) {
 964                 int n = MIN((int)len, IO_BUFFER_SIZE-io_buffer_count);
 965                 if (n > 0) {
 966                         memcpy(io_buffer+io_buffer_count, buf, n);
 967                         buf += n;
 968                         len -= n;
 969                         io_buffer_count += n;
 970                 }
 971
 972                 if (io_buffer_count == IO_BUFFER_SIZE)
 973                         io_flush(NORMAL_FLUSH);
 974         }
 975 }
 976
 977
 978 void write_int(int f,int32 x)
 979 {
 980         char b[4];
 981         SIVAL(b,0,x);
 982         writefd(f,b,4);
 983 }
 984
 985
 986 void write_int_named(int f, int32 x, const char *phase)
 987 {
 988         io_write_phase = phase;
 989         write_int(f, x);
 990         io_write_phase = phase_unknown;
 991 }
 992
 993
 994 /*
 995  * Note: int64 may actually be a 32-bit type if ./configure couldn't find any
 996  * 64-bit types on this platform.
 997  */
 998 void write_longint(int f, int64 x)
 999 {
1000         char b[8];
1001
1002         if (x <= 0x7FFFFFFF) {
1003                 write_int(f, (int)x);
1004                 return;
1005         }
1006
1007 #ifdef NO_INT64
1008         rprintf(FERROR,"Integer overflow - attempted 64 bit offset\n");
1009         exit_cleanup(RERR_UNSUPPORTED);
1010 #else
1011         write_int(f, (int32)0xFFFFFFFF);
1012         SIVAL(b,0,(x&0xFFFFFFFF));
1013         SIVAL(b,4,((x>>32)&0xFFFFFFFF));
1014
1015         writefd(f,b,8);
1016 #endif
1017 }
1018
1019 void write_buf(int f,char *buf,size_t len)
1020 {
1021         writefd(f,buf,len);
1022 }
1023
1024 /** Write a string to the connection */
1025 static void write_sbuf(int f,char *buf)
1026 {
1027         write_buf(f, buf, strlen(buf));
1028 }
1029
1030
1031 void write_byte(int f,unsigned char c)
1032 {
1033         write_buf(f,(char *)&c,1);
1034 }
1035
1036
1037
1038 /**
1039  * Read a line of up to @p maxlen characters into @p buf (not counting
1040  * the trailing null).  Strips the (required) trailing newline and all
1041  * carriage returns.
1042  *
1043  * @return 1 for success; 0 for I/O error or truncation.
1044  **/
1045 int read_line(int f, char *buf, size_t maxlen)
1046 {
1047         while (maxlen) {
1048                 buf[0] = 0;
1049                 read_buf(f, buf, 1);
1050                 if (buf[0] == 0)
1051                         return 0;
1052                 if (buf[0] == '\n')
1053                         break;
1054                 if (buf[0] != '\r') {
1055                         buf++;
1056                         maxlen--;
1057                 }
1058         }
1059         *buf = '\0';
1060         return maxlen > 0;
1061 }
1062
1063
1064 void io_printf(int fd, const char *format, ...)
1065 {
1066         va_list ap;
1067         char buf[1024];
1068         int len;
1069
1070         va_start(ap, format);
1071         len = vsnprintf(buf, sizeof buf, format, ap);
1072         va_end(ap);
1073
1074         if (len < 0)
1075                 exit_cleanup(RERR_STREAMIO);
1076
1077         write_sbuf(fd, buf);
1078 }
1079
1080
1081 /** Setup for multiplexing a MSG_* stream with the data stream. */
1082 void io_start_multiplex_out(int fd)
1083 {
1084         multiplex_out_fd = fd;
1085         io_flush(NORMAL_FLUSH);
1086         io_start_buffering_out(fd);
1087         io_multiplexing_out = 1;
1088 }
1089
1090 /** Setup for multiplexing a MSG_* stream with the data stream. */
1091 void io_start_multiplex_in(int fd)
1092 {
1093         multiplex_in_fd = fd;
1094         io_flush(NORMAL_FLUSH);
1095         io_multiplexing_in = 1;
1096 }
1097
1098 /** Write an message to the multiplexed data stream. */
1099 int io_multiplex_write(enum msgcode code, char *buf, size_t len)
1100 {
1101         if (!io_multiplexing_out)
1102                 return 0;
1103
1104         io_flush(NORMAL_FLUSH);
1105         stats.total_written += (len+4);
1106         mplex_write(multiplex_out_fd, code, buf, len);
1107         return 1;
1108 }
1109
1110 /** Stop output multiplexing. */
1111 void io_multiplexing_close(void)
1112 {
1113         io_multiplexing_out = 0;
1114 }
1115