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, 2004, 2005, 2006 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 2 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, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
  21  */
  22
  23 #include "rsync.h"
  24
  25 extern int verbose;
  26 extern int do_xfers;
  27 extern int am_server;
  28 extern int am_daemon;
  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 allowed_lull;
  36 extern int protocol_version;
  37 extern int remove_source_files;
  38 extern int updating_basis_file;
  39 extern int make_backups;
  40 extern int do_progress;
  41 extern int inplace;
  42 extern int batch_fd;
  43 extern int write_batch;
  44 extern struct stats stats;
  45 extern struct file_list *the_file_list;
  46 extern char *stdout_format;
  47
  48
  49 /**
  50  * @file
  51  *
  52  * The sender gets checksums from the generator, calculates deltas,
  53  * and transmits them to the receiver.  The sender process runs on the
  54  * machine holding the source files.
  55  **/
  56
  57 /**
  58  * Receive the checksums for a buffer
  59  **/
  60 static struct sum_struct *receive_sums(int f)
  61 {
  62         struct sum_struct *s;
  63         int32 i;
  64         int lull_mod = allowed_lull * 5;
  65         OFF_T offset = 0;
  66
  67         if (!(s = new(struct sum_struct)))
  68                 out_of_memory("receive_sums");
  69
  70         read_sum_head(f, s);
  71
  72         s->sums = NULL;
  73
  74         if (verbose > 3) {
  75                 rprintf(FINFO, "count=%.0f n=%ld rem=%ld\n",
  76                         (double)s->count, (long)s->blength, (long)s->remainder);
  77         }
  78
  79         if (append_mode) {
  80                 s->flength = (OFF_T)s->count * s->blength;
  81                 if (s->remainder)
  82                         s->flength -= s->blength - s->remainder;
  83                 return s;
  84         }
  85
  86         if (s->count == 0)
  87                 return(s);
  88
  89         if (!(s->sums = new_array(struct sum_buf, s->count)))
  90                 out_of_memory("receive_sums");
  91
  92         for (i = 0; i < s->count; i++) {
  93                 s->sums[i].sum1 = read_int(f);
  94                 read_buf(f, s->sums[i].sum2, s->s2length);
  95
  96                 s->sums[i].offset = offset;
  97                 s->sums[i].flags = 0;
  98
  99                 if (i == s->count-1 && s->remainder != 0)
 100                         s->sums[i].len = s->remainder;
 101                 else
 102                         s->sums[i].len = s->blength;
 103                 offset += s->sums[i].len;
 104
 105                 if (allowed_lull && !(i % lull_mod))
 106                         maybe_send_keepalive();
 107
 108                 if (verbose > 3) {
 109                         rprintf(FINFO,
 110                                 "chunk[%d] len=%d offset=%.0f sum1=%08x\n",
 111                                 i, s->sums[i].len, (double)s->sums[i].offset,
 112                                 s->sums[i].sum1);
 113                 }
 114         }
 115
 116         s->flength = offset;
 117
 118         return s;
 119 }
 120
 121 void successful_send(int ndx)
 122 {
 123         char fname[MAXPATHLEN];
 124         struct file_struct *file;
 125         unsigned int offset;
 126
 127         if (ndx < 0 || ndx >= the_file_list->count)
 128                 return;
 129
 130         file = the_file_list->files[ndx];
 131         if (file->dir.root) {
 132                 offset = stringjoin(fname, sizeof fname,
 133                                     file->dir.root, "/", NULL);
 134         } else
 135                 offset = 0;
 136         f_name(file, fname + offset);
 137         if (remove_source_files && do_unlink(fname) == 0 && verbose > 1)
 138                 rprintf(FINFO, "sender removed %s\n", fname + offset);
 139 }
 140
 141 static void write_ndx_and_attrs(int f_out, int ndx, int iflags,
 142                                 uchar fnamecmp_type, char *buf, int len)
 143 {
 144         write_int(f_out, ndx);
 145         if (protocol_version < 29)
 146                 return;
 147         write_shortint(f_out, iflags);
 148         if (iflags & ITEM_BASIS_TYPE_FOLLOWS)
 149                 write_byte(f_out, fnamecmp_type);
 150         if (iflags & ITEM_XNAME_FOLLOWS)
 151                 write_vstring(f_out, buf, len);
 152 }
 153
 154 /* This is also used by receive.c with f_out = -1. */
 155 int read_item_attrs(int f_in, int f_out, int ndx, uchar *type_ptr,
 156                     char *buf, int *len_ptr)
 157 {
 158         int len;
 159         uchar fnamecmp_type = FNAMECMP_FNAME;
 160         int iflags = protocol_version >= 29 ? read_shortint(f_in)
 161                    : ITEM_TRANSFER | ITEM_MISSING_DATA;
 162
 163         /* Handle the new keep-alive (no-op) packet. */
 164         if (ndx == the_file_list->count && iflags == ITEM_IS_NEW)
 165                 ;
 166         else if (ndx < 0 || ndx >= the_file_list->count) {
 167                 rprintf(FERROR, "Invalid file index: %d (count=%d) [%s]\n",
 168                         ndx, the_file_list->count, who_am_i());
 169                 exit_cleanup(RERR_PROTOCOL);
 170         } else if (iflags == ITEM_IS_NEW) {
 171                 rprintf(FERROR, "Invalid itemized flag word: %x [%s]\n",
 172                         iflags, who_am_i());
 173                 exit_cleanup(RERR_PROTOCOL);
 174         }
 175
 176         if (iflags & ITEM_BASIS_TYPE_FOLLOWS)
 177                 fnamecmp_type = read_byte(f_in);
 178         *type_ptr = fnamecmp_type;
 179
 180         if (iflags & ITEM_XNAME_FOLLOWS) {
 181                 if ((len = read_vstring(f_in, buf, MAXPATHLEN)) < 0)
 182                         exit_cleanup(RERR_PROTOCOL);
 183         } else {
 184                 *buf = '\0';
 185                 len = -1;
 186         }
 187         *len_ptr = len;
 188
 189         if (iflags & ITEM_TRANSFER) {
 190                 if (!S_ISREG(the_file_list->files[ndx]->mode)) {
 191                         rprintf(FERROR,
 192                                 "received request to transfer non-regular file: %d [%s]\n",
 193                                 ndx, who_am_i());
 194                         exit_cleanup(RERR_PROTOCOL);
 195                 }
 196         } else if (f_out >= 0) {
 197                 write_ndx_and_attrs(f_out, ndx, iflags,
 198                                     fnamecmp_type, buf, len);
 199         }
 200
 201         return iflags;
 202 }
 203
 204 void send_files(struct file_list *flist, int f_out, int f_in)
 205 {
 206         int fd = -1;
 207         struct sum_struct *s;
 208         struct map_struct *mbuf = NULL;
 209         STRUCT_STAT st;
 210         char *fname2, fname[MAXPATHLEN];
 211         char xname[MAXPATHLEN];
 212         uchar fnamecmp_type;
 213         int iflags, xlen;
 214         struct file_struct *file;
 215         int phase = 0, max_phase = protocol_version >= 29 ? 2 : 1;
 216         struct stats initial_stats;
 217         int save_make_backups = make_backups;
 218         int itemizing = am_server ? logfile_format_has_i : stdout_format_has_i;
 219         enum logcode log_code = log_before_transfer ? FLOG : FINFO;
 220         int f_xfer = write_batch < 0 ? batch_fd : f_out;
 221         int i, j;
 222
 223         if (verbose > 2)
 224                 rprintf(FINFO, "send_files starting\n");
 225
 226         while (1) {
 227                 unsigned int offset;
 228
 229                 i = read_int(f_in);
 230                 if (i == -1) {
 231                         if (++phase > max_phase)
 232                                 break;
 233                         csum_length = SUM_LENGTH;
 234                         if (verbose > 2)
 235                                 rprintf(FINFO, "send_files phase=%d\n", phase);
 236                         write_int(f_out, -1);
 237                         /* For inplace: redo phase turns off the backup
 238                          * flag so that we do a regular inplace send. */
 239                         make_backups = 0;
 240                         append_mode = 0;
 241                         continue;
 242                 }
 243
 244                 iflags = read_item_attrs(f_in, f_out, i, &fnamecmp_type,
 245                                          xname, &xlen);
 246                 if (iflags == ITEM_IS_NEW) /* no-op packet */
 247                         continue;
 248
 249                 file = flist->files[i];
 250                 if (file->dir.root) {
 251                         /* N.B. We're sure that this fits, so offset is OK. */
 252                         offset = strlcpy(fname, file->dir.root, sizeof fname);
 253                         if (!offset || fname[offset-1] != '/')
 254                                 fname[offset++] = '/';
 255                 } else
 256                         offset = 0;
 257                 fname2 = f_name(file, fname + offset);
 258
 259                 if (verbose > 2)
 260                         rprintf(FINFO, "send_files(%d, %s)\n", i, fname);
 261
 262                 if (!(iflags & ITEM_TRANSFER)) {
 263                         maybe_log_item(file, iflags, itemizing, xname);
 264                         continue;
 265                 }
 266                 if (phase == 2) {
 267                         rprintf(FERROR,
 268                                 "got transfer request in phase 2 [%s]\n",
 269                                 who_am_i());
 270                         exit_cleanup(RERR_PROTOCOL);
 271                 }
 272
 273                 updating_basis_file = inplace && (protocol_version >= 29
 274                         ? fnamecmp_type == FNAMECMP_FNAME : !make_backups);
 275
 276                 stats.current_file_index = i;
 277                 stats.num_transferred_files++;
 278                 stats.total_transferred_size += file->length;
 279
 280                 if (!do_xfers) { /* log the transfer */
 281                         log_item(FCLIENT, file, &stats, iflags, NULL);
 282                         write_ndx_and_attrs(f_out, i, iflags, fnamecmp_type,
 283                                             xname, xlen);
 284                         continue;
 285                 }
 286
 287                 initial_stats = stats;
 288
 289                 if (!(s = receive_sums(f_in))) {
 290                         io_error |= IOERR_GENERAL;
 291                         rprintf(FERROR, "receive_sums failed\n");
 292                         return;
 293                 }
 294
 295                 fd = do_open(fname, O_RDONLY, 0);
 296                 if (fd == -1) {
 297                         if (errno == ENOENT) {
 298                                 enum logcode c = am_daemon
 299                                     && protocol_version < 28 ? FERROR
 300                                                              : FINFO;
 301                                 io_error |= IOERR_VANISHED;
 302                                 rprintf(c, "file has vanished: %s\n",
 303                                         full_fname(fname));
 304                         } else {
 305                                 io_error |= IOERR_GENERAL;
 306                                 rsyserr(FERROR, errno,
 307                                         "send_files failed to open %s",
 308                                         full_fname(fname));
 309                         }
 310                         free_sums(s);
 311                         continue;
 312                 }
 313
 314                 /* map the local file */
 315                 if (do_fstat(fd, &st) != 0) {
 316                         io_error |= IOERR_GENERAL;
 317                         rsyserr(FERROR, errno, "fstat failed");
 318                         free_sums(s);
 319                         close(fd);
 320                         return;
 321                 }
 322
 323                 if (st.st_size) {
 324                         int32 read_size = MAX(s->blength * 3, MAX_MAP_SIZE);
 325                         mbuf = map_file(fd, st.st_size, read_size, s->blength);
 326                 } else
 327                         mbuf = NULL;
 328
 329                 if (verbose > 2) {
 330                         rprintf(FINFO, "send_files mapped %s of size %.0f\n",
 331                                 fname, (double)st.st_size);
 332                 }
 333
 334                 write_ndx_and_attrs(f_out, i, iflags, fnamecmp_type,
 335                                     xname, xlen);
 336                 write_sum_head(f_xfer, s);
 337
 338                 if (verbose > 2)
 339                         rprintf(FINFO, "calling match_sums %s\n", fname);
 340
 341                 if (log_before_transfer)
 342                         log_item(FCLIENT, file, &initial_stats, iflags, NULL);
 343                 else if (!am_server && verbose && do_progress)
 344                         rprintf(FCLIENT, "%s\n", fname2);
 345
 346                 set_compression(fname);
 347
 348                 match_sums(f_xfer, s, mbuf, st.st_size);
 349                 if (do_progress)
 350                         end_progress(st.st_size);
 351
 352                 log_item(log_code, file, &initial_stats, iflags, NULL);
 353
 354                 if (mbuf) {
 355                         j = unmap_file(mbuf);
 356                         if (j) {
 357                                 io_error |= IOERR_GENERAL;
 358                                 rsyserr(FERROR, j,
 359                                         "read errors mapping %s",
 360                                         full_fname(fname));
 361                         }
 362                 }
 363                 close(fd);
 364
 365                 free_sums(s);
 366
 367                 if (verbose > 2)
 368                         rprintf(FINFO, "sender finished %s\n", fname);
 369
 370                 /* Flag that we actually sent this entry. */
 371                 file->flags |= FLAG_SENT;
 372         }
 373         make_backups = save_make_backups;
 374
 375         if (verbose > 2)
 376                 rprintf(FINFO, "send files finished\n");
 377
 378         match_report();
 379
 380         write_int(f_out, -1);
 381 }