io.c

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