batch.c

   1 /* -*- c-file-style: "linux" -*-
   2
   3    Weiss 1/1999
   4    Batch utilities for rsync.
   5
   6 */
   7
   8 #include "rsync.h"
   9 #include <time.h>
  10
  11 extern char *batch_prefix;
  12
  13 struct file_list *batch_flist;
  14
  15 static char rsync_flist_file[] = ".rsync_flist";
  16 static char rsync_csums_file[] = ".rsync_csums";
  17 static char rsync_delta_file[] = ".rsync_delta";
  18 static char rsync_argvs_file[] = ".rsync_argvs";
  19
  20 static int fdb;
  21 static int fdb_delta;
  22 static int fdb_open;
  23 static int fdb_close;
  24
  25 void write_batch_flist_file(char *buff, int bytes_to_write)
  26 {
  27         char filename[MAXPATHLEN];
  28
  29         if (fdb_open) {
  30                 /* Set up file extension */
  31                 strlcpy(filename, batch_prefix, sizeof(filename));
  32                 strlcat(filename, rsync_flist_file, sizeof(filename));
  33
  34                 /*
  35                  * Open batch flist file for writing;
  36                  * create it if it doesn't exist
  37                  */
  38                 fdb = do_open(filename, O_WRONLY | O_CREAT | O_TRUNC,
  39                             S_IREAD | S_IWRITE);
  40                 if (fdb == -1) {
  41                         rprintf(FERROR, "Batch file %s open error: %s\n",
  42                                 filename, strerror(errno));
  43                         close(fdb);
  44                         exit_cleanup(1);
  45                 }
  46                 fdb_open = 0;
  47         }
  48
  49         /* Write buffer to batch flist file */
  50
  51         if (write(fdb, buff, bytes_to_write) == -1) {
  52                 rprintf(FERROR, "Batch file %s write error: %s\n",
  53                         filename, strerror(errno));
  54                 close(fdb);
  55                 exit_cleanup(1);
  56         }
  57
  58         if (fdb_close) {
  59                 close(fdb);
  60         }
  61 }
  62
  63 void write_batch_flist_info(int flist_count, struct file_struct **fptr)
  64 {
  65         int i;
  66         int bytes_to_write;
  67
  68         /* Write flist info to batch file */
  69
  70         bytes_to_write =
  71             sizeof(unsigned) +
  72             sizeof(time_t) +
  73             sizeof(OFF_T) +
  74             sizeof(mode_t) +
  75             sizeof(INO64_T) +
  76             sizeof(DEV64_T) +
  77             sizeof(DEV64_T) +
  78             sizeof(uid_t) +
  79             sizeof(gid_t);
  80
  81         fdb_open = 1;
  82         fdb_close = 0;
  83
  84         for (i = 0; i < flist_count; i++) {
  85                 write_batch_flist_file((char *) fptr[i], bytes_to_write);
  86                 write_char_bufs(fptr[i]->basename);
  87                 write_char_bufs(fptr[i]->dirname);
  88                 write_char_bufs(fptr[i]->basedir);
  89                 write_char_bufs(fptr[i]->link);
  90                 if (i == flist_count - 1) {
  91                         fdb_close = 1;
  92                 }
  93                 write_char_bufs(fptr[i]->sum);
  94         }
  95 }
  96
  97 void write_char_bufs(char *buf)
  98 {
  99         /* Write the size of the string which will follow  */
 100
 101         char b[4];
 102
 103         SIVAL(b, 0, buf != NULL ? strlen(buf) : 0);
 104
 105         write_batch_flist_file(b, sizeof(int));
 106
 107         /*  Write the string if there is one */
 108
 109         if (buf != NULL) {
 110                 write_batch_flist_file(buf, strlen(buf));
 111         }
 112 }
 113
 114 void write_batch_argvs_file(int argc, char *argv[])
 115 {
 116         int fdb;
 117         int i;
 118         char buff[256]; /* XXX */
 119         char buff2[MAXPATHLEN + 6];
 120         char filename[MAXPATHLEN];
 121
 122         /* Set up file extension */
 123         strlcpy(filename, batch_prefix, sizeof(filename));
 124         strlcat(filename, rsync_argvs_file, sizeof(filename));
 125
 126         /*
 127          * Open batch argvs file for writing;
 128          * create it if it doesn't exist
 129          */
 130         fdb = do_open(filename, O_WRONLY | O_CREAT | O_TRUNC,
 131                       S_IREAD | S_IWRITE | S_IEXEC);
 132         if (fdb == -1) {
 133                 rprintf(FERROR, "Batch file %s open error: %s\n",
 134                         filename, strerror(errno));
 135                 close(fdb);
 136                 exit_cleanup(1);
 137         }
 138         buff[0] = '\0';
 139
 140         /* Write argvs info to batch file */
 141
 142         for (i = 0; i < argc; ++i) {
 143                 if (i == argc - 2) /* Skip source directory on cmdline */
 144                     continue;
 145                 /*
 146                  * FIXME:
 147                  * I think directly manipulating argv[] is probably bogus
 148                  */
 149                 if (!strncmp(argv[i], "--write-batch",
 150                         strlen("--write-batch"))) {
 151                         /* Safer to change it here than script */
 152                         /*
 153                          * Change to --read-batch=prefix
 154                          * to get ready for remote
 155                          */
 156                         strlcat(buff, "--read-batch=", sizeof(buff));
 157                         strlcat(buff, batch_prefix, sizeof(buff));
 158                 } else
 159                 if (i == argc - 1) {
 160                     snprintf(buff2, sizeof(buff2), "${1:-%s}", argv[i]);
 161                     strlcat(buff, buff2, sizeof(buff));
 162                 }
 163                 else {
 164                         strlcat(buff, argv[i], sizeof(buff));
 165                 }
 166
 167                 if (i < (argc - 1)) {
 168                         strlcat(buff, " ", sizeof(buff));
 169                 }
 170         }
 171         strlcat(buff, "\n", sizeof(buff));
 172         if (!write(fdb, buff, strlen(buff))) {
 173                 rprintf(FERROR, "Batch file %s write error: %s\n",
 174                         filename, strerror(errno));
 175                 close(fdb);
 176                 exit_cleanup(1);
 177         }
 178         close(fdb);
 179 }
 180
 181 struct file_list *create_flist_from_batch(void)
 182 {
 183         unsigned char flags;
 184
 185         fdb_open = 1;
 186         fdb_close = 0;
 187
 188         batch_flist = (struct file_list *) malloc(sizeof(batch_flist[0]));
 189         if (!batch_flist) {
 190                 out_of_memory("create_flist_from_batch");
 191         }
 192         batch_flist->count = 0;
 193         batch_flist->malloced = 1000;
 194         batch_flist->files =
 195             (struct file_struct **) malloc(sizeof(batch_flist->files[0]) *
 196                                            batch_flist->malloced);
 197         if (!batch_flist->files) {
 198                 out_of_memory("create_flist_from_batch");
 199         }
 200
 201         for (flags = read_batch_flags(); flags; flags = read_batch_flags()) {
 202
 203                 int i = batch_flist->count;
 204
 205                 if (i >= batch_flist->malloced) {
 206                         if (batch_flist->malloced < 1000)
 207                                 batch_flist->malloced += 1000;
 208                         else
 209                                 batch_flist->malloced *= 2;
 210                         batch_flist->files =
 211                             (struct file_struct **) realloc(batch_flist->
 212                                                             files,
 213                                                             sizeof
 214                                                             (batch_flist->
 215                                                              files[0]) *
 216                                                             batch_flist->
 217                                                             malloced);
 218                         if (!batch_flist->files)
 219                                 out_of_memory("create_flist_from_batch");
 220                 }
 221                 read_batch_flist_info(&batch_flist->files[i]);
 222                 batch_flist->files[i]->flags = flags;
 223
 224                 batch_flist->count++;
 225         }
 226
 227         return batch_flist;
 228 }
 229
 230 int read_batch_flist_file(char *buff, int len)
 231 {
 232         int bytes_read;
 233         char filename[MAXPATHLEN];
 234
 235         if (fdb_open) {
 236                 /* Set up file extension */
 237                 strlcpy(filename, batch_prefix, sizeof(filename));
 238                 strlcat(filename, rsync_flist_file, sizeof(filename));
 239
 240                 /* Open batch flist file for reading */
 241                 fdb = do_open(filename, O_RDONLY, 0);
 242                 if (fdb == -1) {
 243                         rprintf(FERROR, "Batch file %s open error: %s\n",
 244                                 filename, strerror(errno));
 245                         close(fdb);
 246                         exit_cleanup(1);
 247                 }
 248                 fdb_open = 0;
 249         }
 250
 251         /* Read flist batch file */
 252
 253         switch (bytes_read = read(fdb, buff, len)) {
 254             case -1:
 255                 rprintf(FERROR, "Batch file %s read error: %s\n",
 256                         filename, strerror(errno));
 257                 close(fdb);
 258                 exit_cleanup(1);
 259                 break;
 260             case 0:     /* EOF */
 261                 close(fdb);
 262         }
 263
 264         return bytes_read;
 265 }
 266
 267 unsigned char read_batch_flags(void)
 268 {
 269         int flags;
 270
 271         if (read_batch_flist_file((char *) &flags, 4)) {
 272                 return 1;
 273         } else {
 274                 return 0;
 275         }
 276 }
 277
 278 void read_batch_flist_info(struct file_struct **fptr)
 279 {
 280         int int_str_len;
 281         char char_str_len[4];
 282         char buff[256];
 283         struct file_struct *file;
 284
 285         file = (struct file_struct *) malloc(sizeof(*file));
 286         if (!file)
 287                 out_of_memory("read_batch_flist_info");
 288         memset((char *) file, 0, sizeof(*file));
 289
 290         *fptr = file;
 291
 292         /*
 293          * Keep these in sync with bytes_to_write assignment
 294          * in write_batch_flist_info()
 295          */
 296         read_batch_flist_file((char *) &file->modtime, sizeof(time_t));
 297         read_batch_flist_file((char *) &file->length, sizeof(OFF_T));
 298         read_batch_flist_file((char *) &file->mode, sizeof(mode_t));
 299         read_batch_flist_file((char *) &file->inode, sizeof(INO64_T));
 300         read_batch_flist_file((char *) &file->dev, sizeof(DEV64_T));
 301         read_batch_flist_file((char *) &file->rdev, sizeof(DEV64_T));
 302         read_batch_flist_file((char *) &file->uid, sizeof(uid_t));
 303         read_batch_flist_file((char *) &file->gid, sizeof(gid_t));
 304         read_batch_flist_file(char_str_len, sizeof(char_str_len));
 305         int_str_len = IVAL(char_str_len, 0);
 306         if (int_str_len > 0) {
 307                 read_batch_flist_file(buff, int_str_len);
 308                 buff[int_str_len] = '\0';
 309                 file->basename = strdup(buff);
 310         } else {
 311                 file->basename = NULL;
 312         }
 313
 314         read_batch_flist_file(char_str_len, sizeof(char_str_len));
 315         int_str_len = IVAL(char_str_len, 0);
 316         if (int_str_len > 0) {
 317                 read_batch_flist_file(buff, int_str_len);
 318                 buff[int_str_len] = '\0';
 319                 file[0].dirname = strdup(buff);
 320         } else {
 321                 file[0].dirname = NULL;
 322         }
 323
 324         read_batch_flist_file(char_str_len, sizeof(char_str_len));
 325         int_str_len = IVAL(char_str_len, 0);
 326         if (int_str_len > 0) {
 327                 read_batch_flist_file(buff, int_str_len);
 328                 buff[int_str_len] = '\0';
 329                 file[0].basedir = strdup(buff);
 330         } else {
 331                 file[0].basedir = NULL;
 332         }
 333
 334         read_batch_flist_file(char_str_len, sizeof(char_str_len));
 335         int_str_len = IVAL(char_str_len, 0);
 336         if (int_str_len > 0) {
 337                 read_batch_flist_file(buff, int_str_len);
 338                 buff[int_str_len] = '\0';
 339                 file[0].link = strdup(buff);
 340         } else {
 341                 file[0].link = NULL;
 342         }
 343
 344         read_batch_flist_file(char_str_len, sizeof(char_str_len));
 345         int_str_len = IVAL(char_str_len, 0);
 346         if (int_str_len > 0) {
 347                 read_batch_flist_file(buff, int_str_len);
 348                 buff[int_str_len] = '\0';
 349                 file[0].sum = strdup(buff);
 350         } else {
 351                 file[0].sum = NULL;
 352         }
 353 }
 354
 355 void write_batch_csums_file(void *buff, int bytes_to_write)
 356 {
 357         static int fdb_open = 1;
 358         char filename[MAXPATHLEN];
 359
 360         if (fdb_open) {
 361                 /* Set up file extension */
 362                 strlcpy(filename, batch_prefix, sizeof(filename));
 363                 strlcat(filename, rsync_csums_file, sizeof(filename));
 364
 365                 /*
 366                  * Open batch csums file for writing;
 367                  * create it if it doesn't exist
 368                  */
 369                 fdb = do_open(filename, O_WRONLY | O_CREAT | O_TRUNC,
 370                             S_IREAD | S_IWRITE);
 371                 if (fdb == -1) {
 372                         rprintf(FERROR, "Batch file %s open error: %s\n",
 373                                 filename, strerror(errno));
 374                         close(fdb);
 375                         exit_cleanup(1);
 376                 }
 377                 fdb_open = 0;
 378         }
 379
 380         /* Write buffer to batch csums file */
 381
 382         if (write(fdb, buff, bytes_to_write) == -1) {
 383                 rprintf(FERROR, "Batch file %s write error: %s\n",
 384                         filename, strerror(errno));
 385                 close(fdb);
 386                 exit_cleanup(1);
 387         }
 388 }
 389
 390 void close_batch_csums_file(void)
 391 {
 392         close(fdb);
 393 }
 394
 395
 396 /**
 397  * Write csum info to batch file
 398  *
 399  * @todo This will break if s->count is ever larger than maxint.  The
 400  * batch code should probably be changed to consistently use the
 401  * variable-length integer routines, which is probably a compatible
 402  * change.
 403  **/
 404 void write_batch_csum_info(int *flist_entry, int flist_count,
 405                            struct sum_struct *s)
 406 {
 407         size_t i;
 408         int int_count;
 409         extern int csum_length;
 410
 411         fdb_open = 1;
 412
 413         write_batch_csums_file(flist_entry, sizeof(int));
 414         int_count = s ? (int) s->count : 0;
 415         write_batch_csums_file(&int_count, sizeof int_count);
 416
 417         if (s) {
 418                 for (i = 0; i < s->count; i++) {
 419                         write_batch_csums_file(&s->sums[i].sum1, sizeof(uint32));
 420                         if ((*flist_entry == flist_count - 1)
 421                             && (i == s->count - 1)) {
 422                                 fdb_close = 1;
 423                         }
 424                         write_batch_csums_file(s->sums[i].sum2, csum_length);
 425                 }
 426         }
 427 }
 428
 429 int read_batch_csums_file(char *buff, int len)
 430 {
 431         static int fdb_open = 1;
 432         int bytes_read;
 433         char filename[MAXPATHLEN];
 434
 435         if (fdb_open) {
 436                 /* Set up file extension */
 437                 strlcpy(filename, batch_prefix, sizeof(filename));
 438                 strlcat(filename, rsync_csums_file, sizeof(filename));
 439
 440                 /* Open batch flist file for reading */
 441                 fdb = do_open(filename, O_RDONLY, 0);
 442                 if (fdb == -1) {
 443                         rprintf(FERROR, "Batch file %s open error: %s\n",
 444                                 filename, strerror(errno));
 445                         close(fdb);
 446                         exit_cleanup(1);
 447                 }
 448                 fdb_open = 0;
 449         }
 450
 451         /* Read csums batch file */
 452
 453         bytes_read = read(fdb, buff, len);
 454
 455         if (bytes_read == -1) {
 456                 rprintf(FERROR, "Batch file %s read error: %s\n",
 457                         filename, strerror(errno));
 458                 close(fdb);
 459                 exit_cleanup(1);
 460         }
 461
 462         return bytes_read;
 463 }
 464
 465 void read_batch_csum_info(int flist_entry, struct sum_struct *s,
 466                           int *checksums_match)
 467 {
 468         int i;
 469         int file_flist_entry;
 470         int file_chunk_ct;
 471         uint32 file_sum1;
 472         char file_sum2[SUM_LENGTH];
 473         extern int csum_length;
 474
 475         read_batch_csums_file((char *) &file_flist_entry, sizeof(int));
 476         if (file_flist_entry != flist_entry) {
 477                 rprintf(FINFO, "file_flist_entry (%d) != flist_entry (%d)\n",
 478                         file_flist_entry, flist_entry);
 479                 close(fdb);
 480                 exit_cleanup(1);
 481
 482         } else {
 483                 read_batch_csums_file((char *) &file_chunk_ct,
 484                                       sizeof(int));
 485                 *checksums_match = 1;
 486                 for (i = 0; i < file_chunk_ct; i++) {
 487
 488                         read_batch_csums_file((char *) &file_sum1,
 489                                               sizeof(uint32));
 490                         read_batch_csums_file(file_sum2, csum_length);
 491
 492                         if ((s->sums[i].sum1 != file_sum1) ||
 493                             (memcmp(s->sums[i].sum2, file_sum2, csum_length)
 494                                 != 0)) {
 495                                 *checksums_match = 0;
 496                         }
 497                 }               /*  end for  */
 498         }
 499 }
 500
 501 void write_batch_delta_file(char *buff, int bytes_to_write)
 502 {
 503         static int fdb_delta_open = 1;
 504         char filename[MAXPATHLEN];
 505
 506         if (fdb_delta_open) {
 507                 /* Set up file extension */
 508                 strlcpy(filename, batch_prefix, sizeof(filename));
 509                 strlcat(filename, rsync_delta_file, sizeof(filename));
 510
 511                 /*
 512                  * Open batch delta file for writing;
 513                  * create it if it doesn't exist
 514                  */
 515                 fdb_delta = do_open(filename, O_WRONLY | O_CREAT | O_TRUNC,
 516                             S_IREAD | S_IWRITE);
 517                 if (fdb_delta == -1) {
 518                         rprintf(FERROR, "Batch file %s open error: %s\n",
 519                                 filename, strerror(errno));
 520                         close(fdb_delta);
 521                         exit_cleanup(1);
 522                 }
 523                 fdb_delta_open = 0;
 524         }
 525
 526         /* Write buffer to batch delta file */
 527
 528         if (write(fdb_delta, buff, bytes_to_write) == -1) {
 529                 rprintf(FERROR, "Batch file %s write error: %s\n",
 530                         filename, strerror(errno));
 531                 close(fdb_delta);
 532                 exit_cleanup(1);
 533         }
 534 }
 535
 536 void close_batch_delta_file(void)
 537 {
 538         close(fdb_delta);
 539 }
 540
 541 int read_batch_delta_file(char *buff, int len)
 542 {
 543         static int fdb_delta_open = 1;
 544         int bytes_read;
 545         char filename[MAXPATHLEN];
 546
 547         if (fdb_delta_open) {
 548                 /* Set up file extension */
 549                 strlcpy(filename, batch_prefix, sizeof(filename));
 550                 strlcat(filename, rsync_delta_file, sizeof(filename));
 551
 552                 /* Open batch flist file for reading */
 553                 fdb_delta = do_open(filename, O_RDONLY, 0);
 554                 if (fdb_delta == -1) {
 555                         rprintf(FERROR, "Batch file %s open error: %s\n",
 556                                 filename, strerror(errno));
 557                         close(fdb_delta);
 558                         exit_cleanup(1);
 559                 }
 560                 fdb_delta_open = 0;
 561         }
 562
 563         /* Read delta batch file */
 564
 565         bytes_read = read(fdb_delta, buff, len);
 566
 567         if (bytes_read == -1) {
 568                 rprintf(FERROR, "Batch file %s read error: %s\n",
 569                         filename, strerror(errno));
 570                 close(fdb_delta);
 571                 exit_cleanup(1);
 572         }
 573
 574         return bytes_read;
 575 }
 576
 577 void show_flist(int index, struct file_struct **fptr)
 578 {
 579         /*  for debugging    show_flist(flist->count, flist->files * */
 580
 581         int i;
 582         for (i = 0; i < index; i++) {
 583                 rprintf(FINFO, "flist->flags=%#x\n", fptr[i]->flags);
 584                 rprintf(FINFO, "flist->modtime=%#lx\n",
 585                         (long unsigned) fptr[i]->modtime);
 586                 rprintf(FINFO, "flist->length=%.0f\n",
 587                         (double) fptr[i]->length);
 588                 rprintf(FINFO, "flist->mode=%#o\n", (int) fptr[i]->mode);
 589                 rprintf(FINFO, "flist->basename=%s\n", fptr[i]->basename);
 590                 if (fptr[i]->dirname)
 591                         rprintf(FINFO, "flist->dirname=%s\n",
 592                                 fptr[i]->dirname);
 593                 if (fptr[i]->basedir)
 594                         rprintf(FINFO, "flist->basedir=%s\n",
 595                                 fptr[i]->basedir);
 596         }
 597 }
 598
 599 void show_argvs(int argc, char *argv[])
 600 {
 601         /*  for debugging  * */
 602
 603         int i;
 604         rprintf(FINFO, "BATCH.C:show_argvs,argc=%d\n", argc);
 605         for (i = 0; i < argc; i++) {
 606                 /*    if (argv[i])   */
 607                 rprintf(FINFO, "i=%d,argv[i]=%s\n", i, argv[i]);
 608
 609         }
 610 }