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