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 #ifdef SUPPORT_HARD_LINKS
 340                 if (hlink_list.head)
 341                         check_for_finished_hlinks(itemizing, code);
 342 #endif
 343                 read_msg_fd();
 344         }
 345
 346         active_filecnt++;
 347         active_bytecnt += F_LENGTH(the_file_list->files[ndx]);
 348 }
 349
 350 void decrement_active_files(int ndx)
 351 {
 352         active_filecnt--;
 353         active_bytecnt -= F_LENGTH(the_file_list->files[ndx]);
 354 }
 355
 356 /* Try to push messages off the list onto the wire.  If we leave with more
 357  * to do, return 0.  On error, return -1.  If everything flushed, return 1.
 358  * This is only active in the receiver. */
 359 static int msg2genr_flush(int flush_it_all)
 360 {
 361         static int written = 0;
 362         struct timeval tv;
 363         fd_set fds;
 364
 365         if (msg_fd_out < 0)
 366                 return -1;
 367
 368         while (msg2genr.head) {
 369                 struct msg_list_item *m = msg2genr.head;
 370                 int n = write(msg_fd_out, m->buf + written, m->len - written);
 371                 if (n < 0) {
 372                         if (errno == EINTR)
 373                                 continue;
 374                         if (errno != EWOULDBLOCK && errno != EAGAIN)
 375                                 return -1;
 376                         if (!flush_it_all)
 377                                 return 0;
 378                         FD_ZERO(&fds);
 379                         FD_SET(msg_fd_out, &fds);
 380                         tv.tv_sec = select_timeout;
 381                         tv.tv_usec = 0;
 382                         if (!select(msg_fd_out+1, NULL, &fds, NULL, &tv))
 383                                 check_timeout();
 384                 } else if ((written += n) == m->len) {
 385                         msg2genr.head = m->next;
 386                         if (!msg2genr.head)
 387                                 msg2genr.tail = NULL;
 388                         free(m);
 389                         written = 0;
 390                 }
 391         }
 392         return 1;
 393 }
 394
 395 int send_msg(enum msgcode code, const char *buf, int len)
 396 {
 397         if (msg_fd_out < 0) {
 398                 if (!defer_forwarding_messages)
 399                         return io_multiplex_write(code, buf, len);
 400                 if (!io_multiplexing_out)
 401                         return 0;
 402                 msg_list_add(&msg2sndr, code, buf, len);
 403                 return 1;
 404         }
 405         msg_list_add(&msg2genr, code, buf, len);
 406         msg2genr_flush(NORMAL_FLUSH);
 407         return 1;
 408 }
 409
 410 void send_msg_int(enum msgcode code, int num)
 411 {
 412         char numbuf[4];
 413         SIVAL(numbuf, 0, num);
 414         send_msg(code, numbuf, 4);
 415 }
 416
 417 int get_redo_num(int itemizing, enum logcode code)
 418 {
 419         while (1) {
 420 #ifdef SUPPORT_HARD_LINKS
 421                 if (hlink_list.head)
 422                         check_for_finished_hlinks(itemizing, code);
 423 #endif
 424                 if (redo_list.head)
 425                         break;
 426                 read_msg_fd();
 427         }
 428
 429         return flist_ndx_pop(&redo_list);
 430 }
 431
 432 int get_hlink_num(void)
 433 {
 434         return flist_ndx_pop(&hlink_list);
 435 }
 436
 437 /**
 438  * When we're the receiver and we have a local --files-from list of names
 439  * that needs to be sent over the socket to the sender, we have to do two
 440  * things at the same time: send the sender a list of what files we're
 441  * processing and read the incoming file+info list from the sender.  We do
 442  * this by augmenting the read_timeout() function to copy this data.  It
 443  * uses the io_filesfrom_buf to read a block of data from f_in (when it is
 444  * ready, since it might be a pipe) and then blast it out f_out (when it
 445  * is ready to receive more data).
 446  */
 447 void io_set_filesfrom_fds(int f_in, int f_out)
 448 {
 449         io_filesfrom_f_in = f_in;
 450         io_filesfrom_f_out = f_out;
 451         io_filesfrom_bp = io_filesfrom_buf;
 452         io_filesfrom_lastchar = '\0';
 453         io_filesfrom_buflen = 0;
 454 }
 455
 456 /* It's almost always an error to get an EOF when we're trying to read from the
 457  * network, because the protocol is (for the most part) self-terminating.
 458  *
 459  * There is one case for the receiver when it is at the end of the transfer
 460  * (hanging around reading any keep-alive packets that might come its way): if
 461  * the sender dies before the generator's kill-signal comes through, we can end
 462  * up here needing to loop until the kill-signal arrives.  In this situation,
 463  * kluge_around_eof will be < 0.
 464  *
 465  * There is another case for older protocol versions (< 24) where the module
 466  * listing was not terminated, so we must ignore an EOF error in that case and
 467  * exit.  In this situation, kluge_around_eof will be > 0. */
 468 static void whine_about_eof(int fd)
 469 {
 470         if (kluge_around_eof && fd == sock_f_in) {
 471                 int i;
 472                 if (kluge_around_eof > 0)
 473                         exit_cleanup(0);
 474                 /* If we're still here after 10 seconds, exit with an error. */
 475                 for (i = 10*1000/20; i--; )
 476                         msleep(20);
 477         }
 478
 479         rprintf(FERROR, RSYNC_NAME ": connection unexpectedly closed "
 480                 "(%.0f bytes received so far) [%s]\n",
 481                 (double)stats.total_read, who_am_i());
 482
 483         exit_cleanup(RERR_STREAMIO);
 484 }
 485
 486 /**
 487  * Read from a socket with I/O timeout. return the number of bytes
 488  * read. If no bytes can be read then exit, never return a number <= 0.
 489  *
 490  * TODO: If the remote shell connection fails, then current versions
 491  * actually report an "unexpected EOF" error here.  Since it's a
 492  * fairly common mistake to try to use rsh when ssh is required, we
 493  * should trap that: if we fail to read any data at all, we should
 494  * give a better explanation.  We can tell whether the connection has
 495  * started by looking e.g. at whether the remote version is known yet.
 496  */
 497 static int read_timeout(int fd, char *buf, size_t len)
 498 {
 499         int n, cnt = 0;
 500
 501         io_flush(NORMAL_FLUSH);
 502
 503         while (cnt == 0) {
 504                 /* until we manage to read *something* */
 505                 fd_set r_fds, w_fds;
 506                 struct timeval tv;
 507                 int maxfd = fd;
 508                 int count;
 509
 510                 FD_ZERO(&r_fds);
 511                 FD_ZERO(&w_fds);
 512                 FD_SET(fd, &r_fds);
 513                 if (msg2genr.head) {
 514                         FD_SET(msg_fd_out, &w_fds);
 515                         if (msg_fd_out > maxfd)
 516                                 maxfd = msg_fd_out;
 517                 }
 518                 if (io_filesfrom_f_out >= 0) {
 519                         int new_fd;
 520                         if (io_filesfrom_buflen == 0) {
 521                                 if (io_filesfrom_f_in >= 0) {
 522                                         FD_SET(io_filesfrom_f_in, &r_fds);
 523                                         new_fd = io_filesfrom_f_in;
 524                                 } else {
 525                                         io_filesfrom_f_out = -1;
 526                                         new_fd = -1;
 527                                 }
 528                         } else {
 529                                 FD_SET(io_filesfrom_f_out, &w_fds);
 530                                 new_fd = io_filesfrom_f_out;
 531                         }
 532                         if (new_fd > maxfd)
 533                                 maxfd = new_fd;
 534                 }
 535
 536                 tv.tv_sec = select_timeout;
 537                 tv.tv_usec = 0;
 538
 539                 errno = 0;
 540
 541                 count = select(maxfd + 1, &r_fds, &w_fds, NULL, &tv);
 542
 543                 if (count <= 0) {
 544                         if (errno == EBADF)
 545                                 exit_cleanup(RERR_SOCKETIO);
 546                         check_timeout();
 547                         continue;
 548                 }
 549
 550                 if (msg2genr.head && FD_ISSET(msg_fd_out, &w_fds))
 551                         msg2genr_flush(NORMAL_FLUSH);
 552
 553                 if (io_filesfrom_f_out >= 0) {
 554                         if (io_filesfrom_buflen) {
 555                                 if (FD_ISSET(io_filesfrom_f_out, &w_fds)) {
 556                                         int l = write(io_filesfrom_f_out,
 557                                                       io_filesfrom_bp,
 558                                                       io_filesfrom_buflen);
 559                                         if (l > 0) {
 560                                                 if (!(io_filesfrom_buflen -= l))
 561                                                         io_filesfrom_bp = io_filesfrom_buf;
 562                                                 else
 563                                                         io_filesfrom_bp += l;
 564                                         } else {
 565                                                 /* XXX should we complain? */
 566                                                 io_filesfrom_f_out = -1;
 567                                         }
 568                                 }
 569                         } else if (io_filesfrom_f_in >= 0) {
 570                                 if (FD_ISSET(io_filesfrom_f_in, &r_fds)) {
 571                                         int l = read(io_filesfrom_f_in,
 572                                                      io_filesfrom_buf,
 573                                                      sizeof io_filesfrom_buf);
 574                                         if (l <= 0) {
 575                                                 /* Send end-of-file marker */
 576                                                 io_filesfrom_buf[0] = '\0';
 577                                                 io_filesfrom_buf[1] = '\0';
 578                                                 io_filesfrom_buflen = io_filesfrom_lastchar? 2 : 1;
 579                                                 io_filesfrom_f_in = -1;
 580                                         } else {
 581                                                 if (!eol_nulls) {
 582                                                         char *s = io_filesfrom_buf + l;
 583                                                         /* Transform CR and/or LF into '\0' */
 584                                                         while (s-- > io_filesfrom_buf) {
 585                                                                 if (*s == '\n' || *s == '\r')
 586                                                                         *s = '\0';
 587                                                         }
 588                                                 }
 589                                                 if (!io_filesfrom_lastchar) {
 590                                                         /* Last buf ended with a '\0', so don't
 591                                                          * let this buf start with one. */
 592                                                         while (l && !*io_filesfrom_bp)
 593                                                                 io_filesfrom_bp++, l--;
 594                                                 }
 595                                                 if (!l)
 596                                                         io_filesfrom_bp = io_filesfrom_buf;
 597                                                 else {
 598                                                         char *f = io_filesfrom_bp;
 599                                                         char *t = f;
 600                                                         char *eob = f + l;
 601                                                         /* Eliminate any multi-'\0' runs. */
 602                                                         while (f != eob) {
 603                                                                 if (!(*t++ = *f++)) {
 604                                                                         while (f != eob && !*f)
 605                                                                                 f++, l--;
 606                                                                 }
 607                                                         }
 608                                                         io_filesfrom_lastchar = f[-1];
 609                                                 }
 610                                                 io_filesfrom_buflen = l;
 611                                         }
 612                                 }
 613                         }
 614                 }
 615
 616                 if (!FD_ISSET(fd, &r_fds))
 617                         continue;
 618
 619                 n = read(fd, buf, len);
 620
 621                 if (n <= 0) {
 622                         if (n == 0)
 623                                 whine_about_eof(fd); /* Doesn't return. */
 624                         if (errno == EINTR || errno == EWOULDBLOCK
 625                             || errno == EAGAIN)
 626                                 continue;
 627
 628                         /* Don't write errors on a dead socket. */
 629                         if (fd == sock_f_in) {
 630                                 close_multiplexing_out();
 631                                 rsyserr(FSOCKERR, errno, "read error");
 632                         } else
 633                                 rsyserr(FERROR, errno, "read error");
 634                         exit_cleanup(RERR_STREAMIO);
 635                 }
 636
 637                 buf += n;
 638                 len -= n;
 639                 cnt += n;
 640
 641                 if (fd == sock_f_in && io_timeout)
 642                         last_io_in = time(NULL);
 643         }
 644
 645         return cnt;
 646 }
 647
 648 /**
 649  * Read a line into the "fname" buffer (which must be at least MAXPATHLEN
 650  * characters long).
 651  */
 652 int read_filesfrom_line(int fd, char *fname)
 653 {
 654         char ch, *s, *eob = fname + MAXPATHLEN - 1;
 655         int cnt;
 656         int reading_remotely = filesfrom_host != NULL;
 657         int nulls = eol_nulls || reading_remotely;
 658
 659   start:
 660         s = fname;
 661         while (1) {
 662                 cnt = read(fd, &ch, 1);
 663                 if (cnt < 0 && (errno == EWOULDBLOCK
 664                   || errno == EINTR || errno == EAGAIN)) {
 665                         struct timeval tv;
 666                         fd_set r_fds, e_fds;
 667                         FD_ZERO(&r_fds);
 668                         FD_SET(fd, &r_fds);
 669                         FD_ZERO(&e_fds);
 670                         FD_SET(fd, &e_fds);
 671                         tv.tv_sec = select_timeout;
 672                         tv.tv_usec = 0;
 673                         if (!select(fd+1, &r_fds, NULL, &e_fds, &tv))
 674                                 check_timeout();
 675                         if (FD_ISSET(fd, &e_fds)) {
 676                                 rsyserr(FINFO, errno,
 677                                         "select exception on fd %d", fd);
 678                         }
 679                         continue;
 680                 }
 681                 if (cnt != 1)
 682                         break;
 683                 if (nulls? !ch : (ch == '\r' || ch == '\n')) {
 684                         /* Skip empty lines if reading locally. */
 685                         if (!reading_remotely && s == fname)
 686                                 continue;
 687                         break;
 688                 }
 689                 if (s < eob)
 690                         *s++ = ch;
 691         }
 692         *s = '\0';
 693
 694         /* Dump comments. */
 695         if (*fname == '#' || *fname == ';')
 696                 goto start;
 697
 698         return s - fname;
 699 }
 700
 701 static char *iobuf_out;
 702 static int iobuf_out_cnt;
 703
 704 void io_start_buffering_out(void)
 705 {
 706         if (iobuf_out)
 707                 return;
 708         if (!(iobuf_out = new_array(char, IO_BUFFER_SIZE)))
 709                 out_of_memory("io_start_buffering_out");
 710         iobuf_out_cnt = 0;
 711 }
 712
 713 static char *iobuf_in;
 714 static size_t iobuf_in_siz;
 715
 716 void io_start_buffering_in(void)
 717 {
 718         if (iobuf_in)
 719                 return;
 720         iobuf_in_siz = 2 * IO_BUFFER_SIZE;
 721         if (!(iobuf_in = new_array(char, iobuf_in_siz)))
 722                 out_of_memory("io_start_buffering_in");
 723 }
 724
 725 void io_end_buffering(void)
 726 {
 727         io_flush(NORMAL_FLUSH);
 728         if (!io_multiplexing_out) {
 729                 free(iobuf_out);
 730                 iobuf_out = NULL;
 731         }
 732 }
 733
 734 void maybe_flush_socket(void)
 735 {
 736         if (iobuf_out && iobuf_out_cnt && time(NULL) - last_io_out >= 5)
 737                 io_flush(NORMAL_FLUSH);
 738 }
 739
 740 void maybe_send_keepalive(void)
 741 {
 742         if (time(NULL) - last_io_out >= allowed_lull) {
 743                 if (!iobuf_out || !iobuf_out_cnt) {
 744                         if (protocol_version < 29)
 745                                 return; /* there's nothing we can do */
 746                         write_int(sock_f_out, the_file_list->count);
 747                         write_shortint(sock_f_out, ITEM_IS_NEW);
 748                 }
 749                 if (iobuf_out)
 750                         io_flush(NORMAL_FLUSH);
 751         }
 752 }
 753
 754 /**
 755  * Continue trying to read len bytes - don't return until len has been
 756  * read.
 757  **/
 758 static void read_loop(int fd, char *buf, size_t len)
 759 {
 760         while (len) {
 761                 int n = read_timeout(fd, buf, len);
 762
 763                 buf += n;
 764                 len -= n;
 765         }
 766 }
 767
 768 /**
 769  * Read from the file descriptor handling multiplexing - return number
 770  * of bytes read.
 771  *
 772  * Never returns <= 0.
 773  */
 774 static int readfd_unbuffered(int fd, char *buf, size_t len)
 775 {
 776         static size_t remaining;
 777         static size_t iobuf_in_ndx;
 778         size_t msg_bytes;
 779         int tag, cnt = 0;
 780         char line[BIGPATHBUFLEN];
 781
 782         if (!iobuf_in || fd != sock_f_in)
 783                 return read_timeout(fd, buf, len);
 784
 785         if (!io_multiplexing_in && remaining == 0) {
 786                 remaining = read_timeout(fd, iobuf_in, iobuf_in_siz);
 787                 iobuf_in_ndx = 0;
 788         }
 789
 790         while (cnt == 0) {
 791                 if (remaining) {
 792                         len = MIN(len, remaining);
 793                         memcpy(buf, iobuf_in + iobuf_in_ndx, len);
 794                         iobuf_in_ndx += len;
 795                         remaining -= len;
 796                         cnt = len;
 797                         break;
 798                 }
 799
 800                 read_loop(fd, line, 4);
 801                 tag = IVAL(line, 0);
 802
 803                 msg_bytes = tag & 0xFFFFFF;
 804                 tag = (tag >> 24) - MPLEX_BASE;
 805
 806                 switch (tag) {
 807                 case MSG_DATA:
 808                         if (msg_bytes > iobuf_in_siz) {
 809                                 if (!(iobuf_in = realloc_array(iobuf_in, char,
 810                                                                msg_bytes)))
 811                                         out_of_memory("readfd_unbuffered");
 812                                 iobuf_in_siz = msg_bytes;
 813                         }
 814                         read_loop(fd, iobuf_in, msg_bytes);
 815                         remaining = msg_bytes;
 816                         iobuf_in_ndx = 0;
 817                         break;
 818                 case MSG_DELETED:
 819                         if (msg_bytes >= sizeof line)
 820                                 goto overflow;
 821                         read_loop(fd, line, msg_bytes);
 822                         /* A directory name was sent with the trailing null */
 823                         if (msg_bytes > 0 && !line[msg_bytes-1])
 824                                 log_delete(line, S_IFDIR);
 825                         else {
 826                                 line[msg_bytes] = '\0';
 827                                 log_delete(line, S_IFREG);
 828                         }
 829                         break;
 830                 case MSG_SUCCESS:
 831                         if (msg_bytes != 4) {
 832                                 rprintf(FERROR, "invalid multi-message %d:%ld [%s]\n",
 833                                         tag, (long)msg_bytes, who_am_i());
 834                                 exit_cleanup(RERR_STREAMIO);
 835                         }
 836                         read_loop(fd, line, msg_bytes);
 837                         successful_send(IVAL(line, 0));
 838                         break;
 839                 case MSG_INFO:
 840                 case MSG_ERROR:
 841                         if (msg_bytes >= sizeof line) {
 842                             overflow:
 843                                 rprintf(FERROR,
 844                                         "multiplexing overflow %d:%ld [%s]\n",
 845                                         tag, (long)msg_bytes, who_am_i());
 846                                 exit_cleanup(RERR_STREAMIO);
 847                         }
 848                         read_loop(fd, line, msg_bytes);
 849                         rwrite((enum logcode)tag, line, msg_bytes);
 850                         break;
 851                 default:
 852                         rprintf(FERROR, "unexpected tag %d [%s]\n",
 853                                 tag, who_am_i());
 854                         exit_cleanup(RERR_STREAMIO);
 855                 }
 856         }
 857
 858         if (remaining == 0)
 859                 io_flush(NORMAL_FLUSH);
 860
 861         return cnt;
 862 }
 863
 864 /**
 865  * Do a buffered read from @p fd.  Don't return until all @p n bytes
 866  * have been read.  If all @p n can't be read then exit with an
 867  * error.
 868  **/
 869 static void readfd(int fd, char *buffer, size_t N)
 870 {
 871         int  cnt;
 872         size_t total = 0;
 873
 874         while (total < N) {
 875                 cnt = readfd_unbuffered(fd, buffer + total, N-total);
 876                 total += cnt;
 877         }
 878
 879         if (fd == write_batch_monitor_in) {
 880                 if ((size_t)write(batch_fd, buffer, total) != total)
 881                         exit_cleanup(RERR_FILEIO);
 882         }
 883
 884         if (fd == sock_f_in)
 885                 stats.total_read += total;
 886 }
 887
 888 unsigned short read_shortint(int f)
 889 {
 890         char b[2];
 891         readfd(f, b, 2);
 892         return (UVAL(b, 1) << 8) + UVAL(b, 0);
 893 }
 894
 895 int32 read_int(int f)
 896 {
 897         char b[4];
 898         int32 num;
 899
 900         readfd(f, b, 4);
 901         num = IVAL(b, 0);
 902 #if SIZEOF_INT32 > 4
 903         if (num & (int32)0x80000000)
 904                 num |= ~(int32)0xffffffff;
 905 #endif
 906         return num;
 907 }
 908
 909 int64 read_longint(int f)
 910 {
 911         int64 num;
 912         char b[9];
 913
 914         if (protocol_version < 30) {
 915                 num = read_int(f);
 916
 917                 if ((int32)num != (int32)0xffffffff)
 918                         return num;
 919
 920 #if SIZEOF_INT64 < 8
 921                 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
 922                 exit_cleanup(RERR_UNSUPPORTED);
 923 #else
 924                 readfd(f, b, 8);
 925                 num = IVAL(b,0) | (((int64)IVAL(b,4))<<32);
 926 #endif
 927         } else {
 928                 int cnt;
 929                 readfd(f, b, 3);
 930                 cnt = int_byte_cnt[CVAL(b, 0)];
 931 #if SIZEOF_INT64 < 8
 932                 if (cnt > 5 || (cnt == 5 && (CVAL(b,0)&0x3F || CVAL(b,1)&0x80))) {
 933                         rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
 934                         exit_cleanup(RERR_UNSUPPORTED);
 935                 }
 936 #endif
 937                 if (cnt > 3)
 938                         readfd(f, b + 3, cnt - 3);
 939                 switch (cnt) {
 940                 case 3:
 941                         num = NVAL3(b, 0);
 942                         break;
 943                 case 4:
 944                         num = NVAL4(b, 0x80);
 945                         break;
 946                 case 5:
 947                         num = NVAL5(b, 0xC0);
 948                         break;
 949 #if SIZEOF_INT64 >= 8
 950                 case 6:
 951                         num = NVAL6(b, 0xE0);
 952                         break;
 953                 case 7:
 954                         num = NVAL7(b, 0xF0);
 955                         break;
 956                 case 8:
 957                         num = NVAL8(b, 0xF8);
 958                         break;
 959                 case 9:
 960                         num = NVAL8(b+1, 0);
 961                         break;
 962 #endif
 963                 default:
 964                         exit_cleanup(RERR_PROTOCOL); /* impossible... */
 965                 }
 966         }
 967
 968         return num;
 969 }
 970
 971 void read_buf(int f, char *buf, size_t len)
 972 {
 973         readfd(f,buf,len);
 974 }
 975
 976 void read_sbuf(int f, char *buf, size_t len)
 977 {
 978         readfd(f, buf, len);
 979         buf[len] = '\0';
 980 }
 981
 982 uchar read_byte(int f)
 983 {
 984         uchar c;
 985         readfd(f, (char *)&c, 1);
 986         return c;
 987 }
 988
 989 int read_vstring(int f, char *buf, int bufsize)
 990 {
 991         int len = read_byte(f);
 992
 993         if (len & 0x80)
 994                 len = (len & ~0x80) * 0x100 + read_byte(f);
 995
 996         if (len >= bufsize) {
 997                 rprintf(FERROR, "over-long vstring received (%d > %d)\n",
 998                         len, bufsize - 1);
 999                 return -1;
1000         }
1001
1002         if (len)
1003                 readfd(f, buf, len);
1004         buf[len] = '\0';
1005         return len;
1006 }
1007
1008 /* Populate a sum_struct with values from the socket.  This is
1009  * called by both the sender and the receiver. */
1010 void read_sum_head(int f, struct sum_struct *sum)
1011 {
1012         sum->count = read_int(f);
1013         if (sum->count < 0) {
1014                 rprintf(FERROR, "Invalid checksum count %ld [%s]\n",
1015                         (long)sum->count, who_am_i());
1016                 exit_cleanup(RERR_PROTOCOL);
1017         }
1018         sum->blength = read_int(f);
1019         if (sum->blength < 0 || sum->blength > MAX_BLOCK_SIZE) {
1020                 rprintf(FERROR, "Invalid block length %ld [%s]\n",
1021                         (long)sum->blength, who_am_i());
1022                 exit_cleanup(RERR_PROTOCOL);
1023         }
1024         sum->s2length = protocol_version < 27 ? csum_length : (int)read_int(f);
1025         if (sum->s2length < 0 || sum->s2length > MD4_SUM_LENGTH) {
1026                 rprintf(FERROR, "Invalid checksum length %d [%s]\n",
1027                         sum->s2length, who_am_i());
1028                 exit_cleanup(RERR_PROTOCOL);
1029         }
1030         sum->remainder = read_int(f);
1031         if (sum->remainder < 0 || sum->remainder > sum->blength) {
1032                 rprintf(FERROR, "Invalid remainder length %ld [%s]\n",
1033                         (long)sum->remainder, who_am_i());
1034                 exit_cleanup(RERR_PROTOCOL);
1035         }
1036 }
1037
1038 /* Send the values from a sum_struct over the socket.  Set sum to
1039  * NULL if there are no checksums to send.  This is called by both
1040  * the generator and the sender. */
1041 void write_sum_head(int f, struct sum_struct *sum)
1042 {
1043         static struct sum_struct null_sum;
1044
1045         if (sum == NULL)
1046                 sum = &null_sum;
1047
1048         write_int(f, sum->count);
1049         write_int(f, sum->blength);
1050         if (protocol_version >= 27)
1051                 write_int(f, sum->s2length);
1052         write_int(f, sum->remainder);
1053 }
1054
1055 /**
1056  * Sleep after writing to limit I/O bandwidth usage.
1057  *
1058  * @todo Rather than sleeping after each write, it might be better to
1059  * use some kind of averaging.  The current algorithm seems to always
1060  * use a bit less bandwidth than specified, because it doesn't make up
1061  * for slow periods.  But arguably this is a feature.  In addition, we
1062  * ought to take the time used to write the data into account.
1063  *
1064  * During some phases of big transfers (file FOO is uptodate) this is
1065  * called with a small bytes_written every time.  As the kernel has to
1066  * round small waits up to guarantee that we actually wait at least the
1067  * requested number of microseconds, this can become grossly inaccurate.
1068  * We therefore keep track of the bytes we've written over time and only
1069  * sleep when the accumulated delay is at least 1 tenth of a second.
1070  **/
1071 static void sleep_for_bwlimit(int bytes_written)
1072 {
1073         static struct timeval prior_tv;
1074         static long total_written = 0;
1075         struct timeval tv, start_tv;
1076         long elapsed_usec, sleep_usec;
1077
1078 #define ONE_SEC 1000000L /* # of microseconds in a second */
1079
1080         if (!bwlimit_writemax)
1081                 return;
1082
1083         total_written += bytes_written;
1084
1085         gettimeofday(&start_tv, NULL);
1086         if (prior_tv.tv_sec) {
1087                 elapsed_usec = (start_tv.tv_sec - prior_tv.tv_sec) * ONE_SEC
1088                              + (start_tv.tv_usec - prior_tv.tv_usec);
1089                 total_written -= elapsed_usec * bwlimit / (ONE_SEC/1024);
1090                 if (total_written < 0)
1091                         total_written = 0;
1092         }
1093
1094         sleep_usec = total_written * (ONE_SEC/1024) / bwlimit;
1095         if (sleep_usec < ONE_SEC / 10) {
1096                 prior_tv = start_tv;
1097                 return;
1098         }
1099
1100         tv.tv_sec  = sleep_usec / ONE_SEC;
1101         tv.tv_usec = sleep_usec % ONE_SEC;
1102         select(0, NULL, NULL, NULL, &tv);
1103
1104         gettimeofday(&prior_tv, NULL);
1105         elapsed_usec = (prior_tv.tv_sec - start_tv.tv_sec) * ONE_SEC
1106                      + (prior_tv.tv_usec - start_tv.tv_usec);
1107         total_written = (sleep_usec - elapsed_usec) * bwlimit / (ONE_SEC/1024);
1108 }
1109
1110 /* Write len bytes to the file descriptor fd, looping as necessary to get
1111  * the job done and also (in certain circumstances) reading any data on
1112  * msg_fd_in to avoid deadlock.
1113  *
1114  * This function underlies the multiplexing system.  The body of the
1115  * application never calls this function directly. */
1116 static void writefd_unbuffered(int fd, const char *buf, size_t len)
1117 {
1118         size_t n, total = 0;
1119         fd_set w_fds, r_fds, e_fds;
1120         int maxfd, count, cnt, using_r_fds;
1121         int defer_save = defer_forwarding_messages;
1122         struct timeval tv;
1123
1124         no_flush++;
1125
1126         while (total < len) {
1127                 FD_ZERO(&w_fds);
1128                 FD_SET(fd, &w_fds);
1129                 FD_ZERO(&e_fds);
1130                 FD_SET(fd, &e_fds);
1131                 maxfd = fd;
1132
1133                 if (msg_fd_in >= 0) {
1134                         FD_ZERO(&r_fds);
1135                         FD_SET(msg_fd_in, &r_fds);
1136                         if (msg_fd_in > maxfd)
1137                                 maxfd = msg_fd_in;
1138                         using_r_fds = 1;
1139                 } else
1140                         using_r_fds = 0;
1141
1142                 tv.tv_sec = select_timeout;
1143                 tv.tv_usec = 0;
1144
1145                 errno = 0;
1146                 count = select(maxfd + 1, using_r_fds ? &r_fds : NULL,
1147                                &w_fds, &e_fds, &tv);
1148
1149                 if (count <= 0) {
1150                         if (count < 0 && errno == EBADF)
1151                                 exit_cleanup(RERR_SOCKETIO);
1152                         check_timeout();
1153                         continue;
1154                 }
1155
1156                 if (FD_ISSET(fd, &e_fds)) {
1157                         rsyserr(FINFO, errno,
1158                                 "select exception on fd %d", fd);
1159                 }
1160
1161                 if (using_r_fds && FD_ISSET(msg_fd_in, &r_fds))
1162                         read_msg_fd();
1163
1164                 if (!FD_ISSET(fd, &w_fds))
1165                         continue;
1166
1167                 n = len - total;
1168                 if (bwlimit_writemax && n > bwlimit_writemax)
1169                         n = bwlimit_writemax;
1170                 cnt = write(fd, buf + total, n);
1171
1172                 if (cnt <= 0) {
1173                         if (cnt < 0) {
1174                                 if (errno == EINTR)
1175                                         continue;
1176                                 if (errno == EWOULDBLOCK || errno == EAGAIN) {
1177                                         msleep(1);
1178                                         continue;
1179                                 }
1180                         }
1181
1182                         /* Don't try to write errors back across the stream. */
1183                         if (fd == sock_f_out)
1184                                 close_multiplexing_out();
1185                         rsyserr(FERROR, errno,
1186                                 "writefd_unbuffered failed to write %ld bytes [%s]",
1187                                 (long)len, who_am_i());
1188                         /* If the other side is sending us error messages, try
1189                          * to grab any messages they sent before they died. */
1190                         while (fd == sock_f_out && io_multiplexing_in) {
1191                                 set_io_timeout(30);
1192                                 ignore_timeout = 0;
1193                                 readfd_unbuffered(sock_f_in, io_filesfrom_buf,
1194                                                   sizeof io_filesfrom_buf);
1195                         }
1196                         exit_cleanup(RERR_STREAMIO);
1197                 }
1198
1199                 total += cnt;
1200                 defer_forwarding_messages = 1;
1201
1202                 if (fd == sock_f_out) {
1203                         if (io_timeout || am_generator)
1204                                 last_io_out = time(NULL);
1205                         sleep_for_bwlimit(cnt);
1206                 }
1207         }
1208
1209         defer_forwarding_messages = defer_save;
1210         no_flush--;
1211 }
1212
1213 static void msg2sndr_flush(void)
1214 {
1215         if (defer_forwarding_messages)
1216                 return;
1217
1218         while (msg2sndr.head && io_multiplexing_out) {
1219                 struct msg_list_item *m = msg2sndr.head;
1220                 if (!(msg2sndr.head = m->next))
1221                         msg2sndr.tail = NULL;
1222                 stats.total_written += m->len;
1223                 defer_forwarding_messages = 1;
1224                 writefd_unbuffered(sock_f_out, m->buf, m->len);
1225                 defer_forwarding_messages = 0;
1226                 free(m);
1227         }
1228 }
1229
1230 /**
1231  * Write an message to a multiplexed stream. If this fails then rsync
1232  * exits.
1233  **/
1234 static void mplex_write(enum msgcode code, const char *buf, size_t len)
1235 {
1236         char buffer[1024];
1237         size_t n = len;
1238
1239         SIVAL(buffer, 0, ((MPLEX_BASE + (int)code)<<24) + len);
1240
1241         if (n > sizeof buffer - 4)
1242                 n = 0;
1243         else
1244                 memcpy(buffer + 4, buf, n);
1245
1246         writefd_unbuffered(sock_f_out, buffer, n+4);
1247
1248         len -= n;
1249         buf += n;
1250
1251         if (len) {
1252                 defer_forwarding_messages = 1;
1253                 writefd_unbuffered(sock_f_out, buf, len);
1254                 defer_forwarding_messages = 0;
1255                 msg2sndr_flush();
1256         }
1257 }
1258
1259 void io_flush(int flush_it_all)
1260 {
1261         msg2genr_flush(flush_it_all);
1262         msg2sndr_flush();
1263
1264         if (!iobuf_out_cnt || no_flush)
1265                 return;
1266
1267         if (io_multiplexing_out)
1268                 mplex_write(MSG_DATA, iobuf_out, iobuf_out_cnt);
1269         else
1270                 writefd_unbuffered(sock_f_out, iobuf_out, iobuf_out_cnt);
1271         iobuf_out_cnt = 0;
1272 }
1273
1274 static void writefd(int fd, const char *buf, size_t len)
1275 {
1276         if (fd == msg_fd_out) {
1277                 rprintf(FERROR, "Internal error: wrong write used in receiver.\n");
1278                 exit_cleanup(RERR_PROTOCOL);
1279         }
1280
1281         if (fd == sock_f_out)
1282                 stats.total_written += len;
1283
1284         if (fd == write_batch_monitor_out) {
1285                 if ((size_t)write(batch_fd, buf, len) != len)
1286                         exit_cleanup(RERR_FILEIO);
1287         }
1288
1289         if (!iobuf_out || fd != sock_f_out) {
1290                 writefd_unbuffered(fd, buf, len);
1291                 return;
1292         }
1293
1294         while (len) {
1295                 int n = MIN((int)len, IO_BUFFER_SIZE - iobuf_out_cnt);
1296                 if (n > 0) {
1297                         memcpy(iobuf_out+iobuf_out_cnt, buf, n);
1298                         buf += n;
1299                         len -= n;
1300                         iobuf_out_cnt += n;
1301                 }
1302
1303                 if (iobuf_out_cnt == IO_BUFFER_SIZE)
1304                         io_flush(NORMAL_FLUSH);
1305         }
1306 }
1307
1308 void write_shortint(int f, unsigned short x)
1309 {
1310         char b[2];
1311         b[0] = (char)x;
1312         b[1] = (char)(x >> 8);
1313         writefd(f, b, 2);
1314 }
1315
1316 void write_int(int f, int32 x)
1317 {
1318         char b[4];
1319         SIVAL(b, 0, x);
1320         writefd(f, b, 4);
1321 }
1322
1323 /*
1324  * Note: int64 may actually be a 32-bit type if ./configure couldn't find any
1325  * 64-bit types on this platform.
1326  */
1327 void write_longint(int f, int64 x)
1328 {
1329         char b[12];
1330
1331 #if SIZEOF_INT64 < 8
1332         if (x < 0 || x > 0x7FFFFFFF) {
1333                 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1334                 exit_cleanup(RERR_UNSUPPORTED);
1335         }
1336 #endif
1337
1338         if (protocol_version < 30) {
1339                 char * const s = b+4;
1340                 SIVAL(s, 0, x);
1341 #if SIZEOF_INT64 < 8
1342                 writefd(f, s, 4);
1343 #else
1344                 if (x <= 0x7FFFFFFF && x >= 0) {
1345                         writefd(f, s, 4);
1346                         return;
1347                 }
1348
1349                 memset(b, 0xFF, 4);
1350                 SIVAL(s, 4, x >> 32);
1351                 writefd(f, b, 12);
1352         } else if (x < 0) {
1353                 goto all_bits;
1354 #endif
1355         } else if (x < ((int32)1<<(3*8-1))) {
1356                 b[0] = (char)(x >> 16);
1357                 b[1] = (char)(x >> 8);
1358                 b[2] = (char)x;
1359                 writefd(f, b, 3);
1360         } else if (x < ((int64)1<<(4*8-2))) {
1361                 b[0] = (char)((x >> 24) | 0x80);
1362                 b[1] = (char)(x >> 16);
1363                 b[2] = (char)(x >> 8);
1364                 b[3] = (char)x;
1365                 writefd(f, b, 4);
1366 #if SIZEOF_INT64 < 8
1367         } else {
1368                 b[0] = 0xC0;
1369                 b[1] = (char)(x >> 24);
1370                 b[2] = (char)(x >> 16);
1371                 b[3] = (char)(x >> 8);
1372                 b[4] = (char)x;
1373                 writefd(f, b, 5);
1374         }
1375 #else
1376         } else if (x < ((int64)1<<(5*8-3))) {
1377                 b[0] = (char)((x >> 32) | 0xC0);
1378                 b[1] = (char)(x >> 24);
1379                 b[2] = (char)(x >> 16);
1380                 b[3] = (char)(x >> 8);
1381                 b[4] = (char)x;
1382                 writefd(f, b, 5);
1383         } else if (x < ((int64)1<<(6*8-4))) {
1384                 b[0] = (char)((x >> 40) | 0xE0);
1385                 b[1] = (char)(x >> 32);
1386                 b[2] = (char)(x >> 24);
1387                 b[3] = (char)(x >> 16);
1388                 b[4] = (char)(x >> 8);
1389                 b[5] = (char)x;
1390                 writefd(f, b, 6);
1391         } else if (x < ((int64)1<<(7*8-5))) {
1392                 b[0] = (char)((x >> 48) | 0xF0);
1393                 b[1] = (char)(x >> 40);
1394                 b[2] = (char)(x >> 32);
1395                 b[3] = (char)(x >> 24);
1396                 b[4] = (char)(x >> 16);
1397                 b[5] = (char)(x >> 8);
1398                 b[6] = (char)x;
1399                 writefd(f, b, 7);
1400         } else if (x < ((int64)1<<(8*8-6))) {
1401                 b[0] = (char)((x >> 56) | 0xF8);
1402                 b[1] = (char)(x >> 48);
1403                 b[2] = (char)(x >> 40);
1404                 b[3] = (char)(x >> 32);
1405                 b[4] = (char)(x >> 24);
1406                 b[5] = (char)(x >> 16);
1407                 b[6] = (char)(x >> 8);
1408                 b[7] = (char)x;
1409                 writefd(f, b, 8);
1410         } else {
1411           all_bits:
1412                 b[0] = (char)0xFC;
1413                 b[1] = (char)(x >> 56);
1414                 b[2] = (char)(x >> 48);
1415                 b[3] = (char)(x >> 40);
1416                 b[4] = (char)(x >> 32);
1417                 b[5] = (char)(x >> 24);
1418                 b[6] = (char)(x >> 16);
1419                 b[7] = (char)(x >> 8);
1420                 b[8] = (char)x;
1421                 writefd(f, b, 9);
1422         }
1423 #endif
1424 }
1425
1426 void write_buf(int f, const char *buf, size_t len)
1427 {
1428         writefd(f,buf,len);
1429 }
1430
1431 /** Write a string to the connection */
1432 void write_sbuf(int f, const char *buf)
1433 {
1434         writefd(f, buf, strlen(buf));
1435 }
1436
1437 void write_byte(int f, uchar c)
1438 {
1439         writefd(f, (char *)&c, 1);
1440 }
1441
1442 void write_vstring(int f, const char *str, int len)
1443 {
1444         uchar lenbuf[3], *lb = lenbuf;
1445
1446         if (len > 0x7F) {
1447                 if (len > 0x7FFF) {
1448                         rprintf(FERROR,
1449                                 "attempting to send over-long vstring (%d > %d)\n",
1450                                 len, 0x7FFF);
1451                         exit_cleanup(RERR_PROTOCOL);
1452                 }
1453                 *lb++ = len / 0x100 + 0x80;
1454         }
1455         *lb = len;
1456
1457         writefd(f, (char*)lenbuf, lb - lenbuf + 1);
1458         if (len)
1459                 writefd(f, str, len);
1460 }
1461
1462 /**
1463  * Read a line of up to @p maxlen characters into @p buf (not counting
1464  * the trailing null).  Strips the (required) trailing newline and all
1465  * carriage returns.
1466  *
1467  * @return 1 for success; 0 for I/O error or truncation.
1468  **/
1469 int read_line(int f, char *buf, size_t maxlen)
1470 {
1471         while (maxlen) {
1472                 buf[0] = 0;
1473                 read_buf(f, buf, 1);
1474                 if (buf[0] == 0)
1475                         return 0;
1476                 if (buf[0] == '\n')
1477                         break;
1478                 if (buf[0] != '\r') {
1479                         buf++;
1480                         maxlen--;
1481                 }
1482         }
1483         *buf = '\0';
1484         return maxlen > 0;
1485 }
1486
1487 void io_printf(int fd, const char *format, ...)
1488 {
1489         va_list ap;
1490         char buf[BIGPATHBUFLEN];
1491         int len;
1492
1493         va_start(ap, format);
1494         len = vsnprintf(buf, sizeof buf, format, ap);
1495         va_end(ap);
1496
1497         if (len < 0)
1498                 exit_cleanup(RERR_STREAMIO);
1499
1500         if (len > (int)sizeof buf) {
1501                 rprintf(FERROR, "io_printf() was too long for the buffer.\n");
1502                 exit_cleanup(RERR_STREAMIO);
1503         }
1504
1505         write_sbuf(fd, buf);
1506 }
1507
1508 /** Setup for multiplexing a MSG_* stream with the data stream. */
1509 void io_start_multiplex_out(void)
1510 {
1511         io_flush(NORMAL_FLUSH);
1512         io_start_buffering_out();
1513         io_multiplexing_out = 1;
1514 }
1515
1516 /** Setup for multiplexing a MSG_* stream with the data stream. */
1517 void io_start_multiplex_in(void)
1518 {
1519         io_flush(NORMAL_FLUSH);
1520         io_start_buffering_in();
1521         io_multiplexing_in = 1;
1522 }
1523
1524 /** Write an message to the multiplexed data stream. */
1525 int io_multiplex_write(enum msgcode code, const char *buf, size_t len)
1526 {
1527         if (!io_multiplexing_out)
1528                 return 0;
1529
1530         io_flush(NORMAL_FLUSH);
1531         stats.total_written += (len+4);
1532         mplex_write(code, buf, len);
1533         return 1;
1534 }
1535
1536 void close_multiplexing_in(void)
1537 {
1538         io_multiplexing_in = 0;
1539 }
1540
1541 /** Stop output multiplexing. */
1542 void close_multiplexing_out(void)
1543 {
1544         io_multiplexing_out = 0;
1545 }
1546
1547 void start_write_batch(int fd)
1548 {
1549         write_stream_flags(batch_fd);
1550
1551         /* Some communication has already taken place, but we don't
1552          * enable batch writing until here so that we can write a
1553          * canonical record of the communication even though the
1554          * actual communication so far depends on whether a daemon
1555          * is involved. */
1556         write_int(batch_fd, protocol_version);
1557         write_int(batch_fd, checksum_seed);
1558
1559         if (am_sender)
1560                 write_batch_monitor_out = fd;
1561         else
1562                 write_batch_monitor_in = fd;
1563 }
1564
1565 void stop_write_batch(void)
1566 {
1567         write_batch_monitor_out = -1;
1568         write_batch_monitor_in = -1;
1569 }