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 IO 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;
  45 static int multiplex_out_fd;
  46 static time_t last_io;
  47 static int no_flush;
  48
  49 extern int bwlimit;
  50 extern int verbose;
  51 extern int io_timeout;
  52 extern struct stats stats;
  53
  54
  55 const char phase_unknown[] = "unknown";
  56
  57 /**
  58  * The connection might be dropped at some point; perhaps because the
  59  * remote instance crashed.  Just giving the offset on the stream is
  60  * not very helpful.  So instead we try to make io_phase_name point to
  61  * something useful.
  62  *
  63  * For buffered/multiplexed IO these names will be somewhat
  64  * approximate; perhaps for ease of support we would rather make the
  65  * buffer always flush when a single application-level IO finishes.
  66  *
  67  * @todo Perhaps we want some simple stack functionality, but there's
  68  * no need to overdo it.
  69  **/
  70 const char *io_write_phase = phase_unknown;
  71 const char *io_read_phase = phase_unknown;
  72
  73 /** Ignore EOF errors while reading a module listing if the remote
  74     version is 24 or less. */
  75 int kludge_around_eof = False;
  76
  77
  78 static int io_error_fd = -1;
  79 static int io_filesfrom_f_in = -1;
  80 static int io_filesfrom_f_out = -1;
  81 static char io_filesfrom_buf[2048];
  82 static char *io_filesfrom_bp;
  83 static char io_filesfrom_lastchar;
  84 static int io_filesfrom_buflen;
  85
  86 static void read_loop(int fd, char *buf, size_t len);
  87
  88 static void check_timeout(void)
  89 {
  90         extern int am_server, am_daemon;
  91         time_t t;
  92
  93         err_list_push();
  94
  95         if (!io_timeout) return;
  96
  97         if (!last_io) {
  98                 last_io = time(NULL);
  99                 return;
 100         }
 101
 102         t = time(NULL);
 103
 104         if (last_io && io_timeout && (t-last_io) >= io_timeout) {
 105                 if (!am_server && !am_daemon) {
 106                         rprintf(FERROR,"io timeout after %d seconds - exiting\n",
 107                                 (int)(t-last_io));
 108                 }
 109                 exit_cleanup(RERR_TIMEOUT);
 110         }
 111 }
 112
 113 /** Setup the fd used to propagate errors */
 114 void io_set_error_fd(int fd)
 115 {
 116         io_error_fd = fd;
 117 }
 118
 119 /** Read some data from the error fd and write it to the write log code */
 120 static void read_error_fd(void)
 121 {
 122         char buf[200];
 123         size_t n;
 124         int fd = io_error_fd;
 125         int tag, len;
 126
 127         /* io_error_fd is temporarily disabled -- is this meant to
 128          * prevent indefinite recursion? */
 129         io_error_fd = -1;
 130
 131         read_loop(fd, buf, 4);
 132         tag = IVAL(buf, 0);
 133
 134         len = tag & 0xFFFFFF;
 135         tag = tag >> 24;
 136         tag -= MPLEX_BASE;
 137
 138         while (len) {
 139                 n = len;
 140                 if (n > (sizeof buf - 1))
 141                         n = sizeof buf - 1;
 142                 read_loop(fd, buf, n);
 143                 rwrite((enum logcode)tag, buf, n);
 144                 len -= n;
 145         }
 146
 147         io_error_fd = fd;
 148 }
 149
 150 /**
 151  * When we're the receiver and we have a local --files-from list of names
 152  * that needs to be sent over the socket to the sender, we have to do two
 153  * things at the same time: send the sender a list of what files we're
 154  * processing and read the incoming file+info list from the sender.  We do
 155  * this by augmenting the read_timeout() function to copy this data.  It
 156  * uses the io_filesfrom_buf to read a block of data from f_in (when it is
 157  * ready, since it might be a pipe) and then blast it out f_out (when it
 158  * is ready to receive more data).
 159  */
 160 void io_set_filesfrom_fds(int f_in, int f_out)
 161 {
 162         io_filesfrom_f_in = f_in;
 163         io_filesfrom_f_out = f_out;
 164         io_filesfrom_bp = io_filesfrom_buf;
 165         io_filesfrom_lastchar = '\0';
 166         io_filesfrom_buflen = 0;
 167 }
 168
 169 /**
 170  * It's almost always an error to get an EOF when we're trying to read
 171  * from the network, because the protocol is self-terminating.
 172  *
 173  * However, there is one unfortunate cases where it is not, which is
 174  * rsync <2.4.6 sending a list of modules on a server, since the list
 175  * is terminated by closing the socket. So, for the section of the
 176  * program where that is a problem (start_socket_client),
 177  * kludge_around_eof is True and we just exit.
 178  */
 179 static void whine_about_eof(void)
 180 {
 181         if (kludge_around_eof)
 182                 exit_cleanup(0);
 183         else {
 184                 rprintf(FERROR,
 185                         "%s: connection unexpectedly closed "
 186                         "(%.0f bytes read so far)\n",
 187                         RSYNC_NAME, (double)stats.total_read);
 188
 189                 exit_cleanup(RERR_STREAMIO);
 190         }
 191 }
 192
 193
 194 static void die_from_readerr(int err)
 195 {
 196         /* this prevents us trying to write errors on a dead socket */
 197         io_multiplexing_close();
 198
 199         rprintf(FERROR, "%s: read error: %s\n",
 200                 RSYNC_NAME, strerror(err));
 201         exit_cleanup(RERR_STREAMIO);
 202 }
 203
 204
 205 /**
 206  * Read from a socket with IO timeout. return the number of bytes
 207  * read. If no bytes can be read then exit, never return a number <= 0.
 208  *
 209  * TODO: If the remote shell connection fails, then current versions
 210  * actually report an "unexpected EOF" error here.  Since it's a
 211  * fairly common mistake to try to use rsh when ssh is required, we
 212  * should trap that: if we fail to read any data at all, we should
 213  * give a better explanation.  We can tell whether the connection has
 214  * started by looking e.g. at whether the remote version is known yet.
 215  */
 216 static int read_timeout(int fd, char *buf, size_t len)
 217 {
 218         int n, ret=0;
 219
 220         io_flush();
 221
 222         while (ret == 0) {
 223                 /* until we manage to read *something* */
 224                 fd_set r_fds, w_fds;
 225                 struct timeval tv;
 226                 int fd_count = fd+1;
 227                 int count;
 228
 229                 FD_ZERO(&r_fds);
 230                 FD_SET(fd, &r_fds);
 231                 if (io_error_fd != -1) {
 232                         FD_SET(io_error_fd, &r_fds);
 233                         if (io_error_fd >= fd_count) fd_count = io_error_fd+1;
 234                 }
 235                 if (io_filesfrom_f_out != -1) {
 236                         int new_fd;
 237                         if (io_filesfrom_buflen == 0) {
 238                                 if (io_filesfrom_f_in != -1) {
 239                                         FD_SET(io_filesfrom_f_in, &r_fds);
 240                                         new_fd = io_filesfrom_f_in;
 241                                 } else {
 242                                         io_filesfrom_f_out = -1;
 243                                         new_fd = -1;
 244                                 }
 245                         } else {
 246                                 FD_ZERO(&w_fds);
 247                                 FD_SET(io_filesfrom_f_out, &w_fds);
 248                                 new_fd = io_filesfrom_f_out;
 249                         }
 250                         if (new_fd >= fd_count) fd_count = new_fd+1;
 251                 }
 252
 253                 tv.tv_sec = io_timeout?io_timeout:SELECT_TIMEOUT;
 254                 tv.tv_usec = 0;
 255
 256                 errno = 0;
 257
 258                 count = select(fd_count, &r_fds,
 259                                io_filesfrom_buflen? &w_fds : NULL,
 260                                NULL, &tv);
 261
 262                 if (count == 0) {
 263                         check_timeout();
 264                 }
 265
 266                 if (count <= 0) {
 267                         if (errno == EBADF) {
 268                                 exit_cleanup(RERR_SOCKETIO);
 269                         }
 270                         continue;
 271                 }
 272
 273
 274                 if (io_error_fd != -1 && FD_ISSET(io_error_fd, &r_fds)) {
 275                         read_error_fd();
 276                 }
 277
 278                 if (io_filesfrom_f_out != -1) {
 279                         if (io_filesfrom_buflen) {
 280                                 if (FD_ISSET(io_filesfrom_f_out, &w_fds)) {
 281                                         int l = write(io_filesfrom_f_out,
 282                                                       io_filesfrom_bp,
 283                                                       io_filesfrom_buflen);
 284                                         if (l > 0) {
 285                                                 if (!(io_filesfrom_buflen -= l))
 286                                                         io_filesfrom_bp = io_filesfrom_buf;
 287                                                 else
 288                                                         io_filesfrom_bp += l;
 289                                         } else {
 290                                                 /* XXX should we complain? */
 291                                                 io_filesfrom_f_out = -1;
 292                                         }
 293                                 }
 294                         } else if (io_filesfrom_f_in != -1) {
 295                                 if (FD_ISSET(io_filesfrom_f_in, &r_fds)) {
 296                                         int l = read(io_filesfrom_f_in,
 297                                                      io_filesfrom_buf,
 298                                                      sizeof io_filesfrom_buf);
 299                                         if (l <= 0) {
 300                                                 /* Send end-of-file marker */
 301                                                 io_filesfrom_buf[0] = '\0';
 302                                                 io_filesfrom_buf[1] = '\0';
 303                                                 io_filesfrom_buflen = io_filesfrom_lastchar? 2 : 1;
 304                                                 io_filesfrom_f_in = -1;
 305                                         } else {
 306                                                 extern int eol_nulls;
 307                                                 if (!eol_nulls) {
 308                                                         char *s = io_filesfrom_buf + l;
 309                                                         /* Transform CR and/or LF into '\0' */
 310                                                         while (s-- > io_filesfrom_buf) {
 311                                                                 if (*s == '\n' || *s == '\r')
 312                                                                         *s = '\0';
 313                                                         }
 314                                                 }
 315                                                 if (!io_filesfrom_lastchar) {
 316                                                         /* Last buf ended with a '\0', so don't
 317                                                          * let this buf start with one. */
 318                                                         while (l && !*io_filesfrom_bp)
 319                                                                 io_filesfrom_bp++, l--;
 320                                                 }
 321                                                 if (!l)
 322                                                         io_filesfrom_bp = io_filesfrom_buf;
 323                                                 else {
 324                                                         char *f = io_filesfrom_bp;
 325                                                         char *t = f;
 326                                                         char *eob = f + l;
 327                                                         /* Eliminate any multi-'\0' runs. */
 328                                                         while (f != eob) {
 329                                                                 if (!(*t++ = *f++)) {
 330                                                                         while (f != eob && !*f)
 331                                                                                 f++, l--;
 332                                                                 }
 333                                                         }
 334                                                         io_filesfrom_lastchar = f[-1];
 335                                                 }
 336                                                 io_filesfrom_buflen = l;
 337                                         }
 338                                 }
 339                         }
 340                 }
 341
 342                 if (!FD_ISSET(fd, &r_fds)) continue;
 343
 344                 n = read(fd, buf, len);
 345
 346                 if (n > 0) {
 347                         buf += n;
 348                         len -= n;
 349                         ret += n;
 350                         if (io_timeout)
 351                                 last_io = time(NULL);
 352                         continue;
 353                 } else if (n == 0) {
 354                         whine_about_eof();
 355                         return -1; /* doesn't return */
 356                 } else if (n == -1) {
 357                         if (errno == EINTR || errno == EWOULDBLOCK ||
 358                             errno == EAGAIN)
 359                                 continue;
 360                         die_from_readerr(errno);
 361                 }
 362         }
 363
 364         return ret;
 365 }
 366
 367 /**
 368  * Read a line into the "fname" buffer (which must be at least MAXPATHLEN
 369  * characters long).
 370  */
 371 int read_filesfrom_line(int fd, char *fname)
 372 {
 373         char ch, *s, *eob = fname + MAXPATHLEN - 1;
 374         int cnt;
 375         extern int io_timeout;
 376         extern int eol_nulls;
 377         extern char *remote_filesfrom_file;
 378         int reading_remotely = remote_filesfrom_file != NULL;
 379         int nulls = eol_nulls || reading_remotely;
 380
 381   start:
 382         s = fname;
 383         while (1) {
 384                 cnt = read(fd, &ch, 1);
 385                 if (cnt < 0 && (errno == EWOULDBLOCK
 386                   || errno == EINTR || errno == EAGAIN)) {
 387                         struct timeval tv;
 388                         fd_set fds;
 389                         FD_ZERO(&fds);
 390                         FD_SET(fd, &fds);
 391                         tv.tv_sec = io_timeout? io_timeout : SELECT_TIMEOUT;
 392                         tv.tv_usec = 0;
 393                         if (!select(fd+1, &fds, NULL, NULL, &tv))
 394                                 check_timeout();
 395                         continue;
 396                 }
 397                 if (cnt != 1)
 398                         break;
 399                 if (nulls? !ch : (ch == '\r' || ch == '\n')) {
 400                         /* Skip empty lines if reading locally. */
 401                         if (!reading_remotely && s == fname)
 402                                 continue;
 403                         break;
 404                 }
 405                 if (s < eob)
 406                         *s++ = ch;
 407         }
 408         *s = '\0';
 409
 410         /* Dump comments. */
 411         if (*fname == '#' || *fname == ';')
 412                 goto start;
 413
 414         return s - fname;
 415 }
 416
 417
 418 /**
 419  * Continue trying to read len bytes - don't return until len has been
 420  * read.
 421  **/
 422 static void read_loop(int fd, char *buf, size_t len)
 423 {
 424         while (len) {
 425                 int n = read_timeout(fd, buf, len);
 426
 427                 buf += n;
 428                 len -= n;
 429         }
 430 }
 431
 432
 433 /**
 434  * Read from the file descriptor handling multiplexing - return number
 435  * of bytes read.
 436  *
 437  * Never returns <= 0.
 438  */
 439 static int read_unbuffered(int fd, char *buf, size_t len)
 440 {
 441         static size_t remaining;
 442         int tag, ret = 0;
 443         char line[1024];
 444
 445         if (!io_multiplexing_in || fd != multiplex_in_fd)
 446                 return read_timeout(fd, buf, len);
 447
 448         while (ret == 0) {
 449                 if (remaining) {
 450                         len = MIN(len, remaining);
 451                         read_loop(fd, buf, len);
 452                         remaining -= len;
 453                         ret = len;
 454                         continue;
 455                 }
 456
 457                 read_loop(fd, line, 4);
 458                 tag = IVAL(line, 0);
 459
 460                 remaining = tag & 0xFFFFFF;
 461                 tag = tag >> 24;
 462
 463                 if (tag == MPLEX_BASE)
 464                         continue;
 465
 466                 tag -= MPLEX_BASE;
 467
 468                 if (tag != FERROR && tag != FINFO) {
 469                         rprintf(FERROR, "unexpected tag %d\n", tag);
 470                         exit_cleanup(RERR_STREAMIO);
 471                 }
 472
 473                 if (remaining > sizeof line - 1) {
 474                         rprintf(FERROR, "multiplexing overflow %ld\n\n",
 475                                 (long)remaining);
 476                         exit_cleanup(RERR_STREAMIO);
 477                 }
 478
 479                 read_loop(fd, line, remaining);
 480                 line[remaining] = 0;
 481
 482                 rprintf((enum logcode) tag, "%s", line);
 483                 remaining = 0;
 484         }
 485
 486         return ret;
 487 }
 488
 489
 490
 491 /**
 492  * Do a buffered read from @p fd.  Don't return until all @p n bytes
 493  * have been read.  If all @p n can't be read then exit with an
 494  * error.
 495  **/
 496 static void readfd(int fd, char *buffer, size_t N)
 497 {
 498         int  ret;
 499         size_t total=0;
 500
 501         while (total < N) {
 502                 io_flush();
 503
 504                 ret = read_unbuffered(fd, buffer + total, N-total);
 505                 total += ret;
 506         }
 507
 508         stats.total_read += total;
 509 }
 510
 511
 512 int32 read_int(int f)
 513 {
 514         char b[4];
 515         int32 ret;
 516
 517         readfd(f,b,4);
 518         ret = IVAL(b,0);
 519         if (ret == (int32)0xffffffff) return -1;
 520         return ret;
 521 }
 522
 523 int64 read_longint(int f)
 524 {
 525         int64 ret;
 526         char b[8];
 527         ret = read_int(f);
 528
 529         if ((int32)ret != (int32)0xffffffff) {
 530                 return ret;
 531         }
 532
 533 #ifdef NO_INT64
 534         rprintf(FERROR,"Integer overflow - attempted 64 bit offset\n");
 535         exit_cleanup(RERR_UNSUPPORTED);
 536 #else
 537         readfd(f,b,8);
 538         ret = IVAL(b,0) | (((int64)IVAL(b,4))<<32);
 539 #endif
 540
 541         return ret;
 542 }
 543
 544 void read_buf(int f,char *buf,size_t len)
 545 {
 546         readfd(f,buf,len);
 547 }
 548
 549 void read_sbuf(int f,char *buf,size_t len)
 550 {
 551         read_buf(f,buf,len);
 552         buf[len] = 0;
 553 }
 554
 555 unsigned char read_byte(int f)
 556 {
 557         unsigned char c;
 558         read_buf(f, (char *)&c, 1);
 559         return c;
 560 }
 561
 562
 563 /**
 564  * Sleep after writing to limit I/O bandwidth usage.
 565  *
 566  * @todo Rather than sleeping after each write, it might be better to
 567  * use some kind of averaging.  The current algorithm seems to always
 568  * use a bit less bandwidth than specified, because it doesn't make up
 569  * for slow periods.  But arguably this is a feature.  In addition, we
 570  * ought to take the time used to write the data into account.
 571  **/
 572 static void sleep_for_bwlimit(int bytes_written)
 573 {
 574         struct timeval tv;
 575
 576         if (!bwlimit)
 577                 return;
 578
 579         assert(bytes_written > 0);
 580         assert(bwlimit > 0);
 581
 582         tv.tv_usec = bytes_written * 1000 / bwlimit;
 583         tv.tv_sec  = tv.tv_usec / 1000000;
 584         tv.tv_usec = tv.tv_usec % 1000000;
 585
 586         select(0, NULL, NULL, NULL, &tv);
 587 }
 588
 589
 590 /**
 591  * Write len bytes to the file descriptor @p fd.
 592  *
 593  * This function underlies the multiplexing system.  The body of the
 594  * application never calls this function directly.
 595  **/
 596 static void writefd_unbuffered(int fd,char *buf,size_t len)
 597 {
 598         size_t total = 0;
 599         fd_set w_fds, r_fds;
 600         int fd_count, count;
 601         struct timeval tv;
 602
 603         err_list_push();
 604
 605         no_flush++;
 606
 607         while (total < len) {
 608                 FD_ZERO(&w_fds);
 609                 FD_SET(fd,&w_fds);
 610                 fd_count = fd;
 611
 612                 if (io_error_fd != -1) {
 613                         FD_ZERO(&r_fds);
 614                         FD_SET(io_error_fd,&r_fds);
 615                         if (io_error_fd > fd_count)
 616                                 fd_count = io_error_fd;
 617                 }
 618
 619                 tv.tv_sec = io_timeout?io_timeout:SELECT_TIMEOUT;
 620                 tv.tv_usec = 0;
 621
 622                 errno = 0;
 623
 624                 count = select(fd_count+1,
 625                                io_error_fd != -1?&r_fds:NULL,
 626                                &w_fds,NULL,
 627                                &tv);
 628
 629                 if (count == 0) {
 630                         check_timeout();
 631                 }
 632
 633                 if (count <= 0) {
 634                         if (errno == EBADF) {
 635                                 exit_cleanup(RERR_SOCKETIO);
 636                         }
 637                         continue;
 638                 }
 639
 640                 if (io_error_fd != -1 && FD_ISSET(io_error_fd, &r_fds)) {
 641                         read_error_fd();
 642                 }
 643
 644                 if (FD_ISSET(fd, &w_fds)) {
 645                         int ret;
 646                         size_t n = len-total;
 647                         ret = write(fd,buf+total,n);
 648
 649                         if (ret == -1 && errno == EINTR) {
 650                                 continue;
 651                         }
 652
 653                         if (ret == -1 &&
 654                             (errno == EWOULDBLOCK || errno == EAGAIN)) {
 655                                 msleep(1);
 656                                 continue;
 657                         }
 658
 659                         if (ret <= 0) {
 660                                 /* Don't try to write errors back
 661                                  * across the stream */
 662                                 io_multiplexing_close();
 663                                 rprintf(FERROR, RSYNC_NAME
 664                                         ": writefd_unbuffered failed to write %ld bytes: phase \"%s\": %s\n",
 665                                         (long) len, io_write_phase,
 666                                         strerror(errno));
 667                                 exit_cleanup(RERR_STREAMIO);
 668                         }
 669
 670                         sleep_for_bwlimit(ret);
 671
 672                         total += ret;
 673
 674                         if (io_timeout)
 675                                 last_io = time(NULL);
 676                 }
 677         }
 678
 679         no_flush--;
 680 }
 681
 682
 683 static char *io_buffer;
 684 static int io_buffer_count;
 685
 686 void io_start_buffering(int fd)
 687 {
 688         if (io_buffer) return;
 689         multiplex_out_fd = fd;
 690         io_buffer = new_array(char, IO_BUFFER_SIZE);
 691         if (!io_buffer) out_of_memory("writefd");
 692         io_buffer_count = 0;
 693 }
 694
 695 /**
 696  * Write an message to a multiplexed stream. If this fails then rsync
 697  * exits.
 698  **/
 699 static void mplex_write(int fd, enum logcode code, char *buf, size_t len)
 700 {
 701         char buffer[4096];
 702         size_t n = len;
 703
 704         SIVAL(buffer, 0, ((MPLEX_BASE + (int)code)<<24) + len);
 705
 706         if (n > (sizeof buffer - 4)) {
 707                 n = sizeof buffer - 4;
 708         }
 709
 710         memcpy(&buffer[4], buf, n);
 711         writefd_unbuffered(fd, buffer, n+4);
 712
 713         len -= n;
 714         buf += n;
 715
 716         if (len) {
 717                 writefd_unbuffered(fd, buf, len);
 718         }
 719 }
 720
 721
 722 void io_flush(void)
 723 {
 724         int fd = multiplex_out_fd;
 725
 726         err_list_push();
 727
 728         if (!io_buffer_count || no_flush) return;
 729
 730         if (io_multiplexing_out) {
 731                 mplex_write(fd, FNONE, io_buffer, io_buffer_count);
 732         } else {
 733                 writefd_unbuffered(fd, io_buffer, io_buffer_count);
 734         }
 735         io_buffer_count = 0;
 736 }
 737
 738
 739 void io_end_buffering(void)
 740 {
 741         io_flush();
 742         if (!io_multiplexing_out) {
 743                 free(io_buffer);
 744                 io_buffer = NULL;
 745         }
 746 }
 747
 748 static void writefd(int fd,char *buf,size_t len)
 749 {
 750         stats.total_written += len;
 751
 752         err_list_push();
 753
 754         if (!io_buffer || fd != multiplex_out_fd) {
 755                 writefd_unbuffered(fd, buf, len);
 756                 return;
 757         }
 758
 759         while (len) {
 760                 int n = MIN((int) len, IO_BUFFER_SIZE-io_buffer_count);
 761                 if (n > 0) {
 762                         memcpy(io_buffer+io_buffer_count, buf, n);
 763                         buf += n;
 764                         len -= n;
 765                         io_buffer_count += n;
 766                 }
 767
 768                 if (io_buffer_count == IO_BUFFER_SIZE) io_flush();
 769         }
 770 }
 771
 772
 773 void write_int(int f,int32 x)
 774 {
 775         char b[4];
 776         SIVAL(b,0,x);
 777         writefd(f,b,4);
 778 }
 779
 780
 781 void write_int_named(int f, int32 x, const char *phase)
 782 {
 783         io_write_phase = phase;
 784         write_int(f, x);
 785         io_write_phase = phase_unknown;
 786 }
 787
 788
 789 /*
 790  * Note: int64 may actually be a 32-bit type if ./configure couldn't find any
 791  * 64-bit types on this platform.
 792  */
 793 void write_longint(int f, int64 x)
 794 {
 795         char b[8];
 796
 797         if (x <= 0x7FFFFFFF) {
 798                 write_int(f, (int)x);
 799                 return;
 800         }
 801
 802 #ifdef NO_INT64
 803         rprintf(FERROR,"Integer overflow - attempted 64 bit offset\n");
 804         exit_cleanup(RERR_UNSUPPORTED);
 805 #else
 806         write_int(f, (int32)0xFFFFFFFF);
 807         SIVAL(b,0,(x&0xFFFFFFFF));
 808         SIVAL(b,4,((x>>32)&0xFFFFFFFF));
 809
 810         writefd(f,b,8);
 811 #endif
 812 }
 813
 814 void write_buf(int f,char *buf,size_t len)
 815 {
 816         writefd(f,buf,len);
 817 }
 818
 819 /** Write a string to the connection */
 820 static void write_sbuf(int f,char *buf)
 821 {
 822         write_buf(f, buf, strlen(buf));
 823 }
 824
 825
 826 void write_byte(int f,unsigned char c)
 827 {
 828         write_buf(f,(char *)&c,1);
 829 }
 830
 831
 832
 833 /**
 834  * Read a line of up to @p maxlen characters into @p buf.  Does not
 835  * contain a trailing newline or carriage return.
 836  *
 837  * @return 1 for success; 0 for io error or truncation.
 838  **/
 839 int read_line(int f, char *buf, size_t maxlen)
 840 {
 841         while (maxlen) {
 842                 buf[0] = 0;
 843                 read_buf(f, buf, 1);
 844                 if (buf[0] == 0)
 845                         return 0;
 846                 if (buf[0] == '\n') {
 847                         buf[0] = 0;
 848                         break;
 849                 }
 850                 if (buf[0] != '\r') {
 851                         buf++;
 852                         maxlen--;
 853                 }
 854         }
 855         if (maxlen == 0) {
 856                 *buf = 0;
 857                 return 0;
 858         }
 859
 860         return 1;
 861 }
 862
 863
 864 void io_printf(int fd, const char *format, ...)
 865 {
 866         va_list ap;
 867         char buf[1024];
 868         int len;
 869
 870         va_start(ap, format);
 871         len = vsnprintf(buf, sizeof buf, format, ap);
 872         va_end(ap);
 873
 874         if (len < 0) exit_cleanup(RERR_STREAMIO);
 875
 876         write_sbuf(fd, buf);
 877 }
 878
 879
 880 /** Setup for multiplexing an error stream with the data stream */
 881 void io_start_multiplex_out(int fd)
 882 {
 883         multiplex_out_fd = fd;
 884         io_flush();
 885         io_start_buffering(fd);
 886         io_multiplexing_out = 1;
 887 }
 888
 889 /** Setup for multiplexing an error stream with the data stream */
 890 void io_start_multiplex_in(int fd)
 891 {
 892         multiplex_in_fd = fd;
 893         io_flush();
 894         io_multiplexing_in = 1;
 895 }
 896
 897 /** Write an message to the multiplexed error stream */
 898 int io_multiplex_write(enum logcode code, char *buf, size_t len)
 899 {
 900         if (!io_multiplexing_out) return 0;
 901
 902         io_flush();
 903         stats.total_written += (len+4);
 904         mplex_write(multiplex_out_fd, code, buf, len);
 905         return 1;
 906 }
 907
 908 /** Stop output multiplexing */
 909 void io_multiplexing_close(void)
 910 {
 911         io_multiplexing_out = 0;
 912 }
 913