sender.c

   1 /*
   2  * Routines only used by the sending process.
   3  *
   4  * Copyright (C) 1996 Andrew Tridgell
   5  * Copyright (C) 1996 Paul Mackerras
   6  * Copyright (C) 2003-2014 Wayne Davison
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 3 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with this program; if not, visit the http://fsf.org website.
  20  */
  21
  22 #include "rsync.h"
  23 #include "inums.h"
  24
  25 extern int do_xfers;
  26 extern int am_server;
  27 extern int am_daemon;
  28 extern int inc_recurse;
  29 extern int log_before_transfer;
  30 extern int stdout_format_has_i;
  31 extern int logfile_format_has_i;
  32 extern int csum_length;
  33 extern int append_mode;
  34 extern int io_error;
  35 extern int flist_eof;
  36 extern int allowed_lull;
  37 extern int preserve_xattrs;
  38 extern int protocol_version;
  39 extern int remove_source_files;
  40 extern int updating_basis_file;
  41 extern int make_backups;
  42 extern int inplace;
  43 extern int batch_fd;
  44 extern int write_batch;
  45 extern int file_old_total;
  46 extern struct stats stats;
  47 extern struct file_list *cur_flist, *first_flist, *dir_flist;
  48
  49 BOOL extra_flist_sending_enabled;
  50
  51 /**
  52  * @file
  53  *
  54  * The sender gets checksums from the generator, calculates deltas,
  55  * and transmits them to the receiver.  The sender process runs on the
  56  * machine holding the source files.
  57  **/
  58
  59 /**
  60  * Receive the checksums for a buffer
  61  **/
  62 static struct sum_struct *receive_sums(int f)
  63 {
  64         struct sum_struct *s;
  65         int32 i;
  66         int lull_mod = protocol_version >= 31 ? 0 : allowed_lull * 5;
  67         OFF_T offset = 0;
  68
  69         if (!(s = new(struct sum_struct)))
  70                 out_of_memory("receive_sums");
  71
  72         read_sum_head(f, s);
  73
  74         s->sums = NULL;
  75
  76         if (DEBUG_GTE(DELTASUM, 3)) {
  77                 rprintf(FINFO, "count=%s n=%ld rem=%ld\n",
  78                         big_num(s->count), (long)s->blength, (long)s->remainder);
  79         }
  80
  81         if (append_mode > 0) {
  82                 s->flength = (OFF_T)s->count * s->blength;
  83                 if (s->remainder)
  84                         s->flength -= s->blength - s->remainder;
  85                 return s;
  86         }
  87
  88         if (s->count == 0)
  89                 return(s);
  90
  91         if (!(s->sums = new_array(struct sum_buf, s->count)))
  92                 out_of_memory("receive_sums");
  93
  94         for (i = 0; i < s->count; i++) {
  95                 s->sums[i].sum1 = read_int(f);
  96                 read_buf(f, s->sums[i].sum2, s->s2length);
  97
  98                 s->sums[i].offset = offset;
  99                 s->sums[i].flags = 0;
 100
 101                 if (i == s->count-1 && s->remainder != 0)
 102                         s->sums[i].len = s->remainder;
 103                 else
 104                         s->sums[i].len = s->blength;
 105                 offset += s->sums[i].len;
 106
 107                 if (lull_mod && !(i % lull_mod))
 108                         maybe_send_keepalive(time(NULL), True);
 109
 110                 if (DEBUG_GTE(DELTASUM, 3)) {
 111                         rprintf(FINFO,
 112                                 "chunk[%d] len=%d offset=%s sum1=%08x\n",
 113                                 i, s->sums[i].len, big_num(s->sums[i].offset),
 114                                 s->sums[i].sum1);
 115                 }
 116         }
 117
 118         s->flength = offset;
 119
 120         return s;
 121 }
 122
 123 void successful_send(int ndx)
 124 {
 125         char fname[MAXPATHLEN];
 126         char *failed_op;
 127         struct file_struct *file;
 128         struct file_list *flist;
 129         STRUCT_STAT st;
 130
 131         if (!remove_source_files)
 132                 return;
 133
 134         flist = flist_for_ndx(ndx, "successful_send");
 135         file = flist->files[ndx - flist->ndx_start];
 136         if (!change_pathname(file, NULL, 0))
 137                 return;
 138         f_name(file, fname);
 139
 140         if (do_lstat(fname, &st) < 0) {
 141                 failed_op = "re-lstat";
 142                 goto failed;
 143         }
 144
 145         if (st.st_size != F_LENGTH(file) || st.st_mtime != file->modtime
 146 #ifdef ST_MTIME_NSEC
 147          || (NSEC_BUMP(file) && (uint32)st.ST_MTIME_NSEC != F_MOD_NSEC(file))
 148 #endif
 149         ) {
 150                 rprintf(FERROR, "ERROR: Skipping sender remove for changed file: %s\n", fname);
 151                 return;
 152         }
 153
 154         if (do_unlink(fname) < 0) {
 155                 failed_op = "remove";
 156           failed:
 157                 if (errno == ENOENT)
 158                         rprintf(FINFO, "sender file already removed: %s\n", fname);
 159                 else
 160                         rsyserr(FERROR, errno, "sender failed to %s %s", failed_op, fname);
 161         } else {
 162                 if (INFO_GTE(REMOVE, 1))
 163                         rprintf(FINFO, "sender removed %s\n", fname);
 164         }
 165 }
 166
 167 static void write_ndx_and_attrs(int f_out, int ndx, int iflags,
 168                                 const char *fname, struct file_struct *file,
 169                                 uchar fnamecmp_type, char *buf, int len)
 170 {
 171         write_ndx(f_out, ndx);
 172         if (protocol_version < 29)
 173                 return;
 174         write_shortint(f_out, iflags);
 175         if (iflags & ITEM_BASIS_TYPE_FOLLOWS)
 176                 write_byte(f_out, fnamecmp_type);
 177         if (iflags & ITEM_XNAME_FOLLOWS)
 178                 write_vstring(f_out, buf, len);
 179 #ifdef SUPPORT_XATTRS
 180         if (preserve_xattrs && iflags & ITEM_REPORT_XATTR && do_xfers)
 181                 send_xattr_request(fname, file, f_out);
 182 #endif
 183 }
 184
 185 void send_files(int f_in, int f_out)
 186 {
 187         int fd = -1;
 188         struct sum_struct *s;
 189         struct map_struct *mbuf = NULL;
 190         STRUCT_STAT st;
 191         char fname[MAXPATHLEN], xname[MAXPATHLEN];
 192         const char *path, *slash;
 193         uchar fnamecmp_type;
 194         int iflags, xlen;
 195         struct file_struct *file;
 196         int phase = 0, max_phase = protocol_version >= 29 ? 2 : 1;
 197         int itemizing = am_server ? logfile_format_has_i : stdout_format_has_i;
 198         enum logcode log_code = log_before_transfer ? FLOG : FINFO;
 199         int f_xfer = write_batch < 0 ? batch_fd : f_out;
 200         int save_io_error = io_error;
 201         int ndx, j;
 202
 203         if (DEBUG_GTE(SEND, 1))
 204                 rprintf(FINFO, "send_files starting\n");
 205
 206         while (1) {
 207                 if (inc_recurse) {
 208                         send_extra_file_list(f_out, MIN_FILECNT_LOOKAHEAD);
 209                         extra_flist_sending_enabled = !flist_eof;
 210                 }
 211
 212                 /* This call also sets cur_flist. */
 213                 ndx = read_ndx_and_attrs(f_in, f_out, &iflags, &fnamecmp_type,
 214                                          xname, &xlen);
 215                 extra_flist_sending_enabled = False;
 216
 217                 if (ndx == NDX_DONE) {
 218                         if (!am_server && INFO_GTE(PROGRESS, 2) && cur_flist) {
 219                                 set_current_file_index(NULL, 0);
 220                                 end_progress(0);
 221                         }
 222                         if (inc_recurse && first_flist) {
 223                                 file_old_total -= first_flist->used;
 224                                 flist_free(first_flist);
 225                                 if (first_flist) {
 226                                         if (first_flist == cur_flist)
 227                                                 file_old_total = cur_flist->used;
 228                                         write_ndx(f_out, NDX_DONE);
 229                                         continue;
 230                                 }
 231                         }
 232                         if (++phase > max_phase)
 233                                 break;
 234                         if (DEBUG_GTE(SEND, 1))
 235                                 rprintf(FINFO, "send_files phase=%d\n", phase);
 236                         write_ndx(f_out, NDX_DONE);
 237                         continue;
 238                 }
 239
 240                 if (inc_recurse)
 241                         send_extra_file_list(f_out, MIN_FILECNT_LOOKAHEAD);
 242
 243                 if (ndx - cur_flist->ndx_start >= 0)
 244                         file = cur_flist->files[ndx - cur_flist->ndx_start];
 245                 else
 246                         file = dir_flist->files[cur_flist->parent_ndx];
 247                 if (F_PATHNAME(file)) {
 248                         path = F_PATHNAME(file);
 249                         slash = "/";
 250                 } else {
 251                         path = slash = "";
 252                 }
 253                 if (!change_pathname(file, NULL, 0))
 254                         continue;
 255                 f_name(file, fname);
 256
 257                 if (DEBUG_GTE(SEND, 1))
 258                         rprintf(FINFO, "send_files(%d, %s%s%s)\n", ndx, path,slash,fname);
 259
 260 #ifdef SUPPORT_XATTRS
 261                 if (preserve_xattrs && iflags & ITEM_REPORT_XATTR && do_xfers
 262                  && (protocol_version < 31 || !BITS_SET(iflags, ITEM_XNAME_FOLLOWS|ITEM_LOCAL_CHANGE)))
 263                         recv_xattr_request(file, f_in);
 264 #endif
 265
 266                 if (!(iflags & ITEM_TRANSFER)) {
 267                         maybe_log_item(file, iflags, itemizing, xname);
 268                         write_ndx_and_attrs(f_out, ndx, iflags, fname, file,
 269                                             fnamecmp_type, xname, xlen);
 270                         if (iflags & ITEM_IS_NEW) {
 271                                 stats.created_files++;
 272                                 if (S_ISREG(file->mode)) {
 273                                         /* Nothing further to count. */
 274                                 } else if (S_ISDIR(file->mode))
 275                                         stats.created_dirs++;
 276 #ifdef SUPPORT_LINKS
 277                                 else if (S_ISLNK(file->mode))
 278                                         stats.created_symlinks++;
 279 #endif
 280                                 else if (IS_DEVICE(file->mode))
 281                                         stats.created_devices++;
 282                                 else
 283                                         stats.created_specials++;
 284                         }
 285                         continue;
 286                 }
 287                 if (phase == 2) {
 288                         rprintf(FERROR,
 289                                 "got transfer request in phase 2 [%s]\n",
 290                                 who_am_i());
 291                         exit_cleanup(RERR_PROTOCOL);
 292                 }
 293
 294                 if (file->flags & FLAG_FILE_SENT) {
 295                         if (csum_length == SHORT_SUM_LENGTH) {
 296                                 /* For inplace: redo phase turns off the backup
 297                                  * flag so that we do a regular inplace send. */
 298                                 make_backups = -make_backups;
 299                                 append_mode = -append_mode;
 300                                 csum_length = SUM_LENGTH;
 301                         }
 302                 } else {
 303                         if (csum_length != SHORT_SUM_LENGTH) {
 304                                 make_backups = -make_backups;
 305                                 append_mode = -append_mode;
 306                                 csum_length = SHORT_SUM_LENGTH;
 307                         }
 308                         if (iflags & ITEM_IS_NEW)
 309                                 stats.created_files++;
 310                 }
 311
 312                 updating_basis_file = inplace && (protocol_version >= 29
 313                         ? fnamecmp_type == FNAMECMP_FNAME : make_backups <= 0);
 314
 315                 if (!am_server && INFO_GTE(PROGRESS, 1))
 316                         set_current_file_index(file, ndx);
 317                 stats.xferred_files++;
 318                 stats.total_transferred_size += F_LENGTH(file);
 319
 320                 if (!log_before_transfer)
 321                         remember_initial_stats();
 322
 323                 if (!do_xfers) { /* log the transfer */
 324                         log_item(FCLIENT, file, iflags, NULL);
 325                         write_ndx_and_attrs(f_out, ndx, iflags, fname, file,
 326                                             fnamecmp_type, xname, xlen);
 327                         continue;
 328                 }
 329
 330                 if (!(s = receive_sums(f_in))) {
 331                         io_error |= IOERR_GENERAL;
 332                         rprintf(FERROR_XFER, "receive_sums failed\n");
 333                         exit_cleanup(RERR_PROTOCOL);
 334                 }
 335
 336                 fd = do_open(fname, O_RDONLY, 0);
 337                 if (fd == -1) {
 338                         if (errno == ENOENT) {
 339                                 enum logcode c = am_daemon
 340                                     && protocol_version < 28 ? FERROR
 341                                                              : FWARNING;
 342                                 io_error |= IOERR_VANISHED;
 343                                 rprintf(c, "file has vanished: %s\n",
 344                                         full_fname(fname));
 345                         } else {
 346                                 io_error |= IOERR_GENERAL;
 347                                 rsyserr(FERROR_XFER, errno,
 348                                         "send_files failed to open %s",
 349                                         full_fname(fname));
 350                         }
 351                         free_sums(s);
 352                         if (protocol_version >= 30)
 353                                 send_msg_int(MSG_NO_SEND, ndx);
 354                         continue;
 355                 }
 356
 357                 /* map the local file */
 358                 if (do_fstat(fd, &st) != 0) {
 359                         io_error |= IOERR_GENERAL;
 360                         rsyserr(FERROR_XFER, errno, "fstat failed");
 361                         free_sums(s);
 362                         close(fd);
 363                         exit_cleanup(RERR_FILEIO);
 364                 }
 365
 366                 if (st.st_size) {
 367                         int32 read_size = MAX(s->blength * 3, MAX_MAP_SIZE);
 368                         mbuf = map_file(fd, st.st_size, read_size, s->blength);
 369                 } else
 370                         mbuf = NULL;
 371
 372                 if (DEBUG_GTE(DELTASUM, 2)) {
 373                         rprintf(FINFO, "send_files mapped %s%s%s of size %s\n",
 374                                 path,slash,fname, big_num(st.st_size));
 375                 }
 376
 377                 write_ndx_and_attrs(f_out, ndx, iflags, fname, file,
 378                                     fnamecmp_type, xname, xlen);
 379                 write_sum_head(f_xfer, s);
 380
 381                 if (DEBUG_GTE(DELTASUM, 2))
 382                         rprintf(FINFO, "calling match_sums %s%s%s\n", path,slash,fname);
 383
 384                 if (log_before_transfer)
 385                         log_item(FCLIENT, file, iflags, NULL);
 386                 else if (!am_server && INFO_GTE(NAME, 1) && INFO_EQ(PROGRESS, 1))
 387                         rprintf(FCLIENT, "%s\n", fname);
 388
 389                 set_compression(fname);
 390
 391                 match_sums(f_xfer, s, mbuf, st.st_size);
 392                 if (INFO_GTE(PROGRESS, 1))
 393                         end_progress(st.st_size);
 394
 395                 log_item(log_code, file, iflags, NULL);
 396
 397                 if (mbuf) {
 398                         j = unmap_file(mbuf);
 399                         if (j) {
 400                                 io_error |= IOERR_GENERAL;
 401                                 rsyserr(FERROR_XFER, j,
 402                                         "read errors mapping %s",
 403                                         full_fname(fname));
 404                         }
 405                 }
 406                 close(fd);
 407
 408                 free_sums(s);
 409
 410                 if (DEBUG_GTE(SEND, 1))
 411                         rprintf(FINFO, "sender finished %s%s%s\n", path,slash,fname);
 412
 413                 /* Flag that we actually sent this entry. */
 414                 file->flags |= FLAG_FILE_SENT;
 415         }
 416         if (make_backups < 0)
 417                 make_backups = -make_backups;
 418
 419         if (io_error != save_io_error && protocol_version >= 30)
 420                 send_msg_int(MSG_IO_ERROR, io_error);
 421
 422         if (DEBUG_GTE(SEND, 1))
 423                 rprintf(FINFO, "send files finished\n");
 424
 425         match_report();
 426
 427         write_ndx(f_out, NDX_DONE);
 428 }