io.c

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