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