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