sender.c

   1 /*
   2    Copyright (C) Andrew Tridgell 1996
   3    Copyright (C) Paul Mackerras 1996
   4
   5    This program is free software; you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by
   7    the Free Software Foundation; either version 2 of the License, or
   8    (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program; if not, write to the Free Software
  17    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18 */
  19
  20 #include "rsync.h"
  21
  22 extern int verbose;
  23 extern int do_xfers;
  24 extern int am_server;
  25 extern int am_daemon;
  26 extern int log_before_transfer;
  27 extern int log_format_has_i;
  28 extern int daemon_log_format_has_i;
  29 extern int csum_length;
  30 extern int append_mode;
  31 extern int io_error;
  32 extern int allowed_lull;
  33 extern int protocol_version;
  34 extern int remove_sent_files;
  35 extern int updating_basis_file;
  36 extern int make_backups;
  37 extern int do_progress;
  38 extern int inplace;
  39 extern int batch_fd;
  40 extern int write_batch;
  41 extern struct stats stats;
  42 extern struct file_list *the_file_list;
  43 extern char *log_format;
  44
  45
  46 /**
  47  * @file
  48  *
  49  * The sender gets checksums from the generator, calculates deltas,
  50  * and transmits them to the receiver.  The sender process runs on the
  51  * machine holding the source files.
  52  **/
  53
  54 /**
  55  * Receive the checksums for a buffer
  56  **/
  57 static struct sum_struct *receive_sums(int f)
  58 {
  59         struct sum_struct *s;
  60         int32 i;
  61         int lull_mod = allowed_lull * 5;
  62         OFF_T offset = 0;
  63
  64         if (!(s = new(struct sum_struct)))
  65                 out_of_memory("receive_sums");
  66
  67         read_sum_head(f, s);
  68
  69         s->sums = NULL;
  70
  71         if (verbose > 3) {
  72                 rprintf(FINFO, "count=%.0f n=%ld rem=%ld\n",
  73                         (double)s->count, (long)s->blength, (long)s->remainder);
  74         }
  75
  76         if (append_mode) {
  77                 s->flength = (OFF_T)s->count * s->blength;
  78                 if (s->remainder)
  79                         s->flength -= s->blength - s->remainder;
  80                 return s;
  81         }
  82
  83         if (s->count == 0)
  84                 return(s);
  85
  86         if (!(s->sums = new_array(struct sum_buf, s->count)))
  87                 out_of_memory("receive_sums");
  88
  89         for (i = 0; i < s->count; i++) {
  90                 s->sums[i].sum1 = read_int(f);
  91                 read_buf(f, s->sums[i].sum2, s->s2length);
  92
  93                 s->sums[i].offset = offset;
  94                 s->sums[i].flags = 0;
  95
  96                 if (i == s->count-1 && s->remainder != 0)
  97                         s->sums[i].len = s->remainder;
  98                 else
  99                         s->sums[i].len = s->blength;
 100                 offset += s->sums[i].len;
 101
 102                 if (allowed_lull && !(i % lull_mod))
 103                         maybe_send_keepalive();
 104
 105                 if (verbose > 3) {
 106                         rprintf(FINFO,
 107                                 "chunk[%d] len=%d offset=%.0f sum1=%08x\n",
 108                                 i, s->sums[i].len, (double)s->sums[i].offset,
 109                                 s->sums[i].sum1);
 110                 }
 111         }
 112
 113         s->flength = offset;
 114
 115         return s;
 116 }
 117
 118 void successful_send(int ndx)
 119 {
 120         char fname[MAXPATHLEN];
 121         struct file_struct *file;
 122         unsigned int offset;
 123
 124         if (ndx < 0 || ndx >= the_file_list->count)
 125                 return;
 126
 127         file = the_file_list->files[ndx];
 128         /* The generator might tell us about symlinks we didn't send. */
 129         if (!(file->flags & FLAG_SENT) && !S_ISLNK(file->mode))
 130                 return;
 131         if (file->dir.root) {
 132                 offset = stringjoin(fname, sizeof fname,
 133                                     file->dir.root, "/", NULL);
 134         } else
 135                 offset = 0;
 136         f_name_to(file, fname + offset);
 137         if (remove_sent_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_daemon ? daemon_log_format_has_i
 219                       : !am_server && log_format_has_i;
 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_to(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                         if (!am_server && log_format)
 282                                 log_item(file, &stats, iflags, NULL);
 283                         write_ndx_and_attrs(f_out, i, iflags, fnamecmp_type,
 284                                             xname, xlen);
 285                         continue;
 286                 }
 287
 288                 initial_stats = stats;
 289
 290                 if (!(s = receive_sums(f_in))) {
 291                         io_error |= IOERR_GENERAL;
 292                         rprintf(FERROR, "receive_sums failed\n");
 293                         return;
 294                 }
 295
 296                 fd = do_open(fname, O_RDONLY, 0);
 297                 if (fd == -1) {
 298                         if (errno == ENOENT) {
 299                                 enum logcode c = am_daemon
 300                                     && protocol_version < 28 ? FERROR
 301                                                              : FINFO;
 302                                 io_error |= IOERR_VANISHED;
 303                                 rprintf(c, "file has vanished: %s\n",
 304                                         full_fname(fname));
 305                         } else {
 306                                 io_error |= IOERR_GENERAL;
 307                                 rsyserr(FERROR, errno,
 308                                         "send_files failed to open %s",
 309                                         full_fname(fname));
 310                         }
 311                         free_sums(s);
 312                         continue;
 313                 }
 314
 315                 /* map the local file */
 316                 if (do_fstat(fd, &st) != 0) {
 317                         io_error |= IOERR_GENERAL;
 318                         rsyserr(FERROR, errno, "fstat failed");
 319                         free_sums(s);
 320                         close(fd);
 321                         return;
 322                 }
 323
 324                 if (st.st_size) {
 325                         int32 read_size = MAX(s->blength * 3, MAX_MAP_SIZE);
 326                         mbuf = map_file(fd, st.st_size, read_size, s->blength);
 327                 } else
 328                         mbuf = NULL;
 329
 330                 if (verbose > 2) {
 331                         rprintf(FINFO, "send_files mapped %s of size %.0f\n",
 332                                 fname, (double)st.st_size);
 333                 }
 334
 335                 write_ndx_and_attrs(f_out, i, iflags, fnamecmp_type,
 336                                     xname, xlen);
 337                 write_sum_head(f_xfer, s);
 338
 339                 if (verbose > 2)
 340                         rprintf(FINFO, "calling match_sums %s\n", fname);
 341
 342                 if (log_before_transfer)
 343                         log_item(file, &initial_stats, iflags, NULL);
 344                 else if (!am_server && verbose && do_progress)
 345                         rprintf(FINFO, "%s\n", fname2);
 346
 347                 set_compression(fname);
 348
 349                 match_sums(f_xfer, s, mbuf, st.st_size);
 350                 if (do_progress)
 351                         end_progress(st.st_size);
 352
 353                 if (!log_before_transfer)
 354                         log_item(file, &initial_stats, iflags, NULL);
 355
 356                 if (mbuf) {
 357                         j = unmap_file(mbuf);
 358                         if (j) {
 359                                 io_error |= IOERR_GENERAL;
 360                                 rsyserr(FERROR, j,
 361                                         "read errors mapping %s",
 362                                         full_fname(fname));
 363                         }
 364                 }
 365                 close(fd);
 366
 367                 free_sums(s);
 368
 369                 if (verbose > 2)
 370                         rprintf(FINFO, "sender finished %s\n", fname);
 371
 372                 /* Flag that we actually sent this entry. */
 373                 file->flags |= FLAG_SENT;
 374         }
 375         make_backups = save_make_backups;
 376
 377         if (verbose > 2)
 378                 rprintf(FINFO, "send files finished\n");
 379
 380         match_report();
 381
 382         write_int(f_out, -1);
 383 }