scandir.cc

   1 /* Cumulus: Smart Filesystem Backup to Dumb Servers
   2  *
   3  * Copyright (C) 2006-2008  The Regents of the University of California
   4  * Written by Michael Vrable <mvrable@cs.ucsd.edu>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19  */
  20
  21 /* Main entry point for LBS.  Contains logic for traversing the filesystem and
  22  * constructing a backup. */
  23
  24 #include <dirent.h>
  25 #include <errno.h>
  26 #include <fcntl.h>
  27 #include <getopt.h>
  28 #include <grp.h>
  29 #include <pwd.h>
  30 #include <stdint.h>
  31 #include <stdio.h>
  32 #include <stdlib.h>
  33 #include <string.h>
  34 #include <sys/stat.h>
  35 #include <sys/sysmacros.h>
  36 #include <sys/types.h>
  37 #include <sys/wait.h>
  38 #include <unistd.h>
  39
  40 #include <algorithm>
  41 #include <fstream>
  42 #include <iostream>
  43 #include <list>
  44 #include <set>
  45 #include <sstream>
  46 #include <string>
  47 #include <vector>
  48
  49 #include "localdb.h"
  50 #include "metadata.h"
  51 #include "remote.h"
  52 #include "store.h"
  53 #include "sha1.h"
  54 #include "subfile.h"
  55 #include "util.h"
  56
  57 using std::list;
  58 using std::string;
  59 using std::vector;
  60 using std::ostream;
  61
  62 /* Version information.  This will be filled in by the Makefile. */
  63 #ifndef CUMULUS_VERSION
  64 #define CUMULUS_VERSION Unknown
  65 #endif
  66 #define CUMULUS_STRINGIFY(s) CUMULUS_STRINGIFY2(s)
  67 #define CUMULUS_STRINGIFY2(s) #s
  68 static const char cumulus_version[] = CUMULUS_STRINGIFY(CUMULUS_VERSION);
  69
  70 static RemoteStore *remote = NULL;
  71 static TarSegmentStore *tss = NULL;
  72 static MetadataWriter *metawriter = NULL;
  73
  74 /* Buffer for holding a single block of data read from a file. */
  75 static const size_t LBS_BLOCK_SIZE = 1024 * 1024;
  76 static char *block_buf;
  77
  78 /* Local database, which tracks objects written in this and previous
  79  * invocations to help in creating incremental snapshots. */
  80 LocalDb *db;
  81
  82 /* Keep track of all segments which are needed to reconstruct the snapshot. */
  83 std::set<string> segment_list;
  84
  85 /* Snapshot intent: 1=daily, 7=weekly, etc.  This is not used directly, but is
  86  * stored in the local database and can help guide segment cleaning and
  87  * snapshot expiration policies. */
  88 double snapshot_intent = 1.0;
  89
  90 /* Selection of files to include/exclude in the snapshot. */
  91 std::list<string> includes;         // Paths in which files should be saved
  92 std::list<string> excludes;         // Paths which will not be saved
  93 std::list<string> searches;         // Directories we don't want to save, but
  94                                     //   do want to descend searching for data
  95                                     //   in included paths
  96
  97 bool relative_paths = true;
  98
  99 bool flag_rebuild_statcache = false;
 100
 101 /* Whether verbose output is enabled. */
 102 bool verbose = false;
 103
 104 /* Ensure that the given segment is listed as a dependency of the current
 105  * snapshot. */
 106 void add_segment(const string& segment)
 107 {
 108     segment_list.insert(segment);
 109 }
 110
 111 /* Read data from a file descriptor and return the amount of data read.  A
 112  * short read (less than the requested size) will only occur if end-of-file is
 113  * hit. */
 114 ssize_t file_read(int fd, char *buf, size_t maxlen)
 115 {
 116     size_t bytes_read = 0;
 117
 118     while (true) {
 119         ssize_t res = read(fd, buf, maxlen);
 120         if (res < 0) {
 121             if (errno == EINTR)
 122                 continue;
 123             fprintf(stderr, "error reading file: %m\n");
 124             return -1;
 125         } else if (res == 0) {
 126             break;
 127         } else {
 128             bytes_read += res;
 129             buf += res;
 130             maxlen -= res;
 131         }
 132     }
 133
 134     return bytes_read;
 135 }
 136
 137 /* Read the contents of a file (specified by an open file descriptor) and copy
 138  * the data to the store.  Returns the size of the file (number of bytes
 139  * dumped), or -1 on error. */
 140 int64_t dumpfile(int fd, dictionary &file_info, const string &path,
 141                  struct stat& stat_buf)
 142 {
 143     int64_t size = 0;
 144     list<string> object_list;
 145     const char *status = NULL;          /* Status indicator printed out */
 146
 147     /* Look up this file in the old stat cache, if we can.  If the stat
 148      * information indicates that the file has not changed, do not bother
 149      * re-reading the entire contents.  Even if the information has been
 150      * changed, we can use the list of old blocks in the search for a sub-block
 151      * incremental representation. */
 152     bool cached = false;
 153     list<ObjectReference> old_blocks;
 154
 155     bool found = metawriter->find(path);
 156     if (found)
 157         old_blocks = metawriter->get_blocks();
 158
 159     if (found
 160         && !flag_rebuild_statcache
 161         && metawriter->is_unchanged(&stat_buf)) {
 162         cached = true;
 163
 164         /* If any of the blocks in the object have been expired, then we should
 165          * fall back to fully reading in the file. */
 166         for (list<ObjectReference>::const_iterator i = old_blocks.begin();
 167              i != old_blocks.end(); ++i) {
 168             const ObjectReference &ref = *i;
 169             if (!db->IsAvailable(ref)) {
 170                 cached = false;
 171                 status = "repack";
 172                 break;
 173             }
 174         }
 175
 176         /* If everything looks okay, use the cached information */
 177         if (cached) {
 178             file_info["checksum"] = metawriter->get_checksum();
 179             for (list<ObjectReference>::const_iterator i = old_blocks.begin();
 180                  i != old_blocks.end(); ++i) {
 181                 const ObjectReference &ref = *i;
 182                 object_list.push_back(ref.to_string());
 183                 if (ref.is_normal())
 184                     add_segment(ref.get_segment());
 185                 db->UseObject(ref);
 186             }
 187             size = stat_buf.st_size;
 188         }
 189     }
 190
 191     /* If the file is new or changed, we must read in the contents a block at a
 192      * time. */
 193     if (!cached) {
 194         SHA1Checksum hash;
 195         Subfile subfile(db);
 196         subfile.load_old_blocks(old_blocks);
 197
 198         while (true) {
 199             ssize_t bytes = file_read(fd, block_buf, LBS_BLOCK_SIZE);
 200             if (bytes == 0)
 201                 break;
 202             if (bytes < 0) {
 203                 fprintf(stderr, "Backup contents for %s may be incorrect\n",
 204                         path.c_str());
 205                 break;
 206             }
 207
 208             hash.process(block_buf, bytes);
 209
 210             // Sparse file processing: if we read a block of all zeroes, encode
 211             // that explicitly.
 212             bool all_zero = true;
 213             for (int i = 0; i < bytes; i++) {
 214                 if (block_buf[i] != 0) {
 215                     all_zero = false;
 216                     break;
 217                 }
 218             }
 219
 220             // Either find a copy of this block in an already-existing segment,
 221             // or index it so it can be re-used in the future
 222             double block_age = 0.0;
 223             ObjectReference ref;
 224
 225             SHA1Checksum block_hash;
 226             block_hash.process(block_buf, bytes);
 227             string block_csum = block_hash.checksum_str();
 228
 229             if (all_zero) {
 230                 ref = ObjectReference(ObjectReference::REF_ZERO);
 231                 ref.set_range(0, bytes);
 232             } else {
 233                 ref = db->FindObject(block_csum, bytes);
 234             }
 235
 236             list<ObjectReference> refs;
 237
 238             // Store a copy of the object if one does not yet exist
 239             if (ref.is_null()) {
 240                 LbsObject *o = new LbsObject;
 241                 int object_group;
 242
 243                 /* We might still have seen this checksum before, if the object
 244                  * was stored at some time in the past, but we have decided to
 245                  * clean the segment the object was originally stored in
 246                  * (FindObject will not return such objects).  When rewriting
 247                  * the object contents, put it in a separate group, so that old
 248                  * objects get grouped together.  The hope is that these old
 249                  * objects will continue to be used in the future, and we
 250                  * obtain segments which will continue to be well-utilized.
 251                  * Additionally, keep track of the age of the data by looking
 252                  * up the age of the block which was expired and using that
 253                  * instead of the current time. */
 254                 if (db->IsOldObject(block_csum, bytes,
 255                                     &block_age, &object_group)) {
 256                     if (object_group == 0) {
 257                         o->set_group("data");
 258                     } else {
 259                         char group[32];
 260                         sprintf(group, "compacted-%d", object_group);
 261                         o->set_group(group);
 262                     }
 263                     if (status == NULL)
 264                         status = "partial";
 265                 } else {
 266                     o->set_group("data");
 267                     status = "new";
 268                 }
 269
 270                 subfile.analyze_new_block(block_buf, bytes);
 271                 refs = subfile.create_incremental(tss, o, block_age);
 272             } else {
 273                 refs.push_back(ref);
 274             }
 275
 276             while (!refs.empty()) {
 277                 ref = refs.front(); refs.pop_front();
 278                 object_list.push_back(ref.to_string());
 279                 if (ref.is_normal())
 280                     add_segment(ref.get_segment());
 281                 db->UseObject(ref);
 282             }
 283             size += bytes;
 284
 285             if (status == NULL)
 286                 status = "old";
 287         }
 288
 289         file_info["checksum"] = hash.checksum_str();
 290     }
 291
 292     // Sanity check: if we are rebuilding the statcache, but the file looks
 293     // like it hasn't changed, then the newly-computed checksum should match
 294     // the checksum in the statcache.  If not, we have possible disk corruption
 295     // and report a warning.
 296     if (flag_rebuild_statcache) {
 297         if (found && file_info["checksum"] != metawriter->get_checksum()) {
 298             fprintf(stderr,
 299                     "Warning: Checksum for %s does not match expected value\n"
 300                     "    expected: %s\n"
 301                     "    actual:   %s\n",
 302                     path.c_str(),
 303                     metawriter->get_checksum().c_str(),
 304                     file_info["checksum"].c_str());
 305         }
 306     }
 307
 308     if (verbose && status != NULL)
 309         printf("    [%s]\n", status);
 310
 311     string blocklist = "";
 312     for (list<string>::iterator i = object_list.begin();
 313          i != object_list.end(); ++i) {
 314         if (i != object_list.begin())
 315             blocklist += "\n    ";
 316         blocklist += *i;
 317     }
 318     file_info["data"] = blocklist;
 319
 320     return size;
 321 }
 322
 323 /* Dump a specified filesystem object (file, directory, etc.) based on its
 324  * inode information.  If the object is a regular file, an open filehandle is
 325  * provided. */
 326 void dump_inode(const string& path,         // Path within snapshot
 327                 const string& fullpath,     // Path to object in filesystem
 328                 struct stat& stat_buf,      // Results of stat() call
 329                 int fd)                     // Open filehandle if regular file
 330 {
 331     char *buf;
 332     dictionary file_info;
 333     int64_t file_size;
 334     ssize_t len;
 335
 336     if (verbose)
 337         printf("%s\n", path.c_str());
 338     metawriter->find(path);
 339
 340     file_info["name"] = uri_encode(path);
 341     file_info["mode"] = encode_int(stat_buf.st_mode & 07777, 8);
 342     file_info["ctime"] = encode_int(stat_buf.st_ctime);
 343     file_info["mtime"] = encode_int(stat_buf.st_mtime);
 344     file_info["user"] = encode_int(stat_buf.st_uid);
 345     file_info["group"] = encode_int(stat_buf.st_gid);
 346
 347     time_t now = time(NULL);
 348     if (now - stat_buf.st_ctime < 30 || now - stat_buf.st_mtime < 30)
 349         if ((stat_buf.st_mode & S_IFMT) != S_IFDIR)
 350             file_info["volatile"] = "1";
 351
 352     struct passwd *pwd = getpwuid(stat_buf.st_uid);
 353     if (pwd != NULL) {
 354         file_info["user"] += " (" + uri_encode(pwd->pw_name) + ")";
 355     }
 356
 357     struct group *grp = getgrgid(stat_buf.st_gid);
 358     if (pwd != NULL) {
 359         file_info["group"] += " (" + uri_encode(grp->gr_name) + ")";
 360     }
 361
 362     if (stat_buf.st_nlink > 1 && (stat_buf.st_mode & S_IFMT) != S_IFDIR) {
 363         file_info["links"] = encode_int(stat_buf.st_nlink);
 364     }
 365
 366     file_info["inode"] = encode_int(major(stat_buf.st_dev))
 367         + "/" + encode_int(minor(stat_buf.st_dev))
 368         + "/" + encode_int(stat_buf.st_ino);
 369
 370     char inode_type;
 371
 372     switch (stat_buf.st_mode & S_IFMT) {
 373     case S_IFIFO:
 374         inode_type = 'p';
 375         break;
 376     case S_IFSOCK:
 377         inode_type = 's';
 378         break;
 379     case S_IFBLK:
 380     case S_IFCHR:
 381         inode_type = ((stat_buf.st_mode & S_IFMT) == S_IFBLK) ? 'b' : 'c';
 382         file_info["device"] = encode_int(major(stat_buf.st_rdev))
 383             + "/" + encode_int(minor(stat_buf.st_rdev));
 384         break;
 385     case S_IFLNK:
 386         inode_type = 'l';
 387
 388         /* Use the reported file size to allocate a buffer large enough to read
 389          * the symlink.  Allocate slightly more space, so that we ask for more
 390          * bytes than we expect and so check for truncation. */
 391         buf = new char[stat_buf.st_size + 2];
 392         len = readlink(fullpath.c_str(), buf, stat_buf.st_size + 1);
 393         if (len < 0) {
 394             fprintf(stderr, "error reading symlink: %m\n");
 395         } else if (len <= stat_buf.st_size) {
 396             buf[len] = '\0';
 397             file_info["target"] = uri_encode(buf);
 398         } else if (len > stat_buf.st_size) {
 399             fprintf(stderr, "error reading symlink: name truncated\n");
 400         }
 401
 402         delete[] buf;
 403         break;
 404     case S_IFREG:
 405         inode_type = 'f';
 406
 407         file_size = dumpfile(fd, file_info, path, stat_buf);
 408         file_info["size"] = encode_int(file_size);
 409
 410         if (file_size < 0)
 411             return;             // error occurred; do not dump file
 412
 413         if (file_size != stat_buf.st_size) {
 414             fprintf(stderr, "Warning: Size of %s changed during reading\n",
 415                     path.c_str());
 416             file_info["volatile"] = "1";
 417         }
 418
 419         break;
 420     case S_IFDIR:
 421         inode_type = 'd';
 422         break;
 423
 424     default:
 425         fprintf(stderr, "Unknown inode type: mode=%x\n", stat_buf.st_mode);
 426         return;
 427     }
 428
 429     file_info["type"] = string(1, inode_type);
 430
 431     metawriter->add(file_info);
 432 }
 433
 434 void scanfile(const string& path, bool include)
 435 {
 436     int fd = -1;
 437     long flags;
 438     struct stat stat_buf;
 439     list<string> refs;
 440
 441     string true_path;
 442     if (relative_paths)
 443         true_path = path;
 444     else
 445         true_path = "/" + path;
 446
 447     // Set to true if we should scan through the contents of this directory,
 448     // but not actually back files up
 449     bool scan_only = false;
 450
 451     // Check this file against the include/exclude list to see if it should be
 452     // considered
 453     for (list<string>::iterator i = includes.begin();
 454          i != includes.end(); ++i) {
 455         if (path == *i) {
 456             include = true;
 457         }
 458     }
 459
 460     for (list<string>::iterator i = excludes.begin();
 461          i != excludes.end(); ++i) {
 462         if (path == *i) {
 463             include = false;
 464         }
 465     }
 466
 467     for (list<string>::iterator i = searches.begin();
 468          i != searches.end(); ++i) {
 469         if (path == *i) {
 470             scan_only = true;
 471         }
 472     }
 473
 474     if (!include && !scan_only)
 475         return;
 476
 477     if (lstat(true_path.c_str(), &stat_buf) < 0) {
 478         fprintf(stderr, "lstat(%s): %m\n", path.c_str());
 479         return;
 480     }
 481
 482     if ((stat_buf.st_mode & S_IFMT) == S_IFREG) {
 483         /* Be paranoid when opening the file.  We have no guarantee that the
 484          * file was not replaced between the stat() call above and the open()
 485          * call below, so we might not even be opening a regular file.  We
 486          * supply flags to open to to guard against various conditions before
 487          * we can perform an lstat to check that the file is still a regular
 488          * file:
 489          *   - O_NOFOLLOW: in the event the file was replaced by a symlink
 490          *   - O_NONBLOCK: prevents open() from blocking if the file was
 491          *     replaced by a fifo
 492          * We also add in O_NOATIME, since this may reduce disk writes (for
 493          * inode updates).  However, O_NOATIME may result in EPERM, so if the
 494          * initial open fails, try again without O_NOATIME.  */
 495         fd = open(true_path.c_str(), O_RDONLY|O_NOATIME|O_NOFOLLOW|O_NONBLOCK);
 496         if (fd < 0) {
 497             fd = open(true_path.c_str(), O_RDONLY|O_NOFOLLOW|O_NONBLOCK);
 498         }
 499         if (fd < 0) {
 500             fprintf(stderr, "Unable to open file %s: %m\n", path.c_str());
 501             return;
 502         }
 503
 504         /* Drop the use of the O_NONBLOCK flag; we only wanted that for file
 505          * open. */
 506         flags = fcntl(fd, F_GETFL);
 507         fcntl(fd, F_SETFL, flags & ~O_NONBLOCK);
 508
 509         /* Perform the stat call again, and check that we still have a regular
 510          * file. */
 511         if (fstat(fd, &stat_buf) < 0) {
 512             fprintf(stderr, "fstat: %m\n");
 513             close(fd);
 514             return;
 515         }
 516
 517         if ((stat_buf.st_mode & S_IFMT) != S_IFREG) {
 518             fprintf(stderr, "file is no longer a regular file!\n");
 519             close(fd);
 520             return;
 521         }
 522     }
 523
 524     dump_inode(path, true_path, stat_buf, fd);
 525
 526     if (fd >= 0)
 527         close(fd);
 528
 529     // If we hit a directory, now that we've written the directory itself,
 530     // recursively scan the directory.
 531     if ((stat_buf.st_mode & S_IFMT) == S_IFDIR) {
 532         DIR *dir = opendir(true_path.c_str());
 533
 534         if (dir == NULL) {
 535             fprintf(stderr, "Error: %m\n");
 536             return;
 537         }
 538
 539         struct dirent *ent;
 540         vector<string> contents;
 541         while ((ent = readdir(dir)) != NULL) {
 542             string filename(ent->d_name);
 543             if (filename == "." || filename == "..")
 544                 continue;
 545             contents.push_back(filename);
 546         }
 547
 548         closedir(dir);
 549
 550         sort(contents.begin(), contents.end());
 551
 552         for (vector<string>::iterator i = contents.begin();
 553              i != contents.end(); ++i) {
 554             const string& filename = *i;
 555             if (path == ".")
 556                 scanfile(filename, include);
 557             else
 558                 scanfile(path + "/" + filename, include);
 559         }
 560     }
 561 }
 562
 563 /* Include the specified file path in the backups.  Append the path to the
 564  * includes list, and to ensure that we actually see the path when scanning the
 565  * directory tree, add all the parent directories to the search list, which
 566  * means we will scan through the directory listing even if the files
 567  * themselves are excluded from being backed up. */
 568 void add_include(const char *path)
 569 {
 570     /* Was an absolute path specified?  If so, we'll need to start scanning
 571      * from the root directory.  Make sure that the user was consistent in
 572      * providing either all relative paths or all absolute paths. */
 573     if (path[0] == '/') {
 574         if (includes.size() > 0 && relative_paths == true) {
 575             fprintf(stderr,
 576                     "Error: Cannot mix relative and absolute paths!\n");
 577             exit(1);
 578         }
 579
 580         relative_paths = false;
 581
 582         // Skip over leading '/'
 583         path++;
 584     } else if (relative_paths == false && path[0] != '/') {
 585         fprintf(stderr, "Error: Cannot mix relative and absolute paths!\n");
 586         exit(1);
 587     }
 588
 589     includes.push_back(path);
 590
 591     /* Split the specified path into directory components, and ensure that we
 592      * descend into all the directories along the path. */
 593     const char *slash = path;
 594
 595     if (path[0] == '\0')
 596         return;
 597
 598     while ((slash = strchr(slash + 1, '/')) != NULL) {
 599         string component(path, slash - path);
 600         searches.push_back(component);
 601     }
 602 }
 603
 604 void usage(const char *program)
 605 {
 606     fprintf(
 607         stderr,
 608         "Cumulus %s\n\n"
 609         "Usage: %s [OPTION]... --dest=DEST PATHS...\n"
 610         "Produce backup snapshot of files in SOURCE and store to DEST.\n"
 611         "\n"
 612         "Options:\n"
 613         "  --dest=PATH          path where backup is to be written\n"
 614         "  --upload-script=COMMAND\n"
 615         "                       program to invoke for each backup file generated\n"
 616         "  --exclude=PATH       exclude files in PATH from snapshot\n"
 617         "  --localdb=PATH       local backup metadata is stored in PATH\n"
 618         "  --tmpdir=PATH        path for temporarily storing backup files\n"
 619         "                           (defaults to TMPDIR environment variable or /tmp)\n"
 620         "  --filter=COMMAND     program through which to filter segment data\n"
 621         "                           (defaults to \"bzip2 -c\")\n"
 622         "  --filter-extension=EXT\n"
 623         "                       string to append to segment files\n"
 624         "                           (defaults to \".bz2\")\n"
 625         "  --signature-filter=COMMAND\n"
 626         "                       program though which to filter descriptor\n"
 627         "  --scheme=NAME        optional name for this snapshot\n"
 628         "  --intent=FLOAT       intended backup type: 1=daily, 7=weekly, ...\n"
 629         "                           (defaults to \"1\")\n"
 630         "  --full-metadata      do not re-use metadata from previous backups\n"
 631         "  -v --verbose         list files as they are backed up\n"
 632         "\n"
 633         "Exactly one of --dest or --upload-script must be specified.\n",
 634         cumulus_version, program
 635     );
 636 }
 637
 638 int main(int argc, char *argv[])
 639 {
 640     string backup_dest = "", backup_script = "";
 641     string localdb_dir = "";
 642     string backup_scheme = "";
 643     string signature_filter = "";
 644
 645     string tmp_dir = "/tmp";
 646     if (getenv("TMPDIR") != NULL)
 647         tmp_dir = getenv("TMPDIR");
 648
 649     while (1) {
 650         static struct option long_options[] = {
 651             {"localdb", 1, 0, 0},           // 0
 652             {"exclude", 1, 0, 0},           // 1
 653             {"filter", 1, 0, 0},            // 2
 654             {"filter-extension", 1, 0, 0},  // 3
 655             {"dest", 1, 0, 0},              // 4
 656             {"scheme", 1, 0, 0},            // 5
 657             {"signature-filter", 1, 0, 0},  // 6
 658             {"intent", 1, 0, 0},            // 7
 659             {"full-metadata", 0, 0, 0},     // 8
 660             {"tmpdir", 1, 0, 0},            // 9
 661             {"upload-script", 1, 0, 0},     // 10
 662             {"rebuild-statcache", 0, 0, 0}, // 11
 663             // Aliases for short options
 664             {"verbose", 0, 0, 'v'},
 665             {NULL, 0, 0, 0},
 666         };
 667
 668         int long_index;
 669         int c = getopt_long(argc, argv, "v", long_options, &long_index);
 670
 671         if (c == -1)
 672             break;
 673
 674         if (c == 0) {
 675             switch (long_index) {
 676             case 0:     // --localdb
 677                 localdb_dir = optarg;
 678                 break;
 679             case 1:     // --exclude
 680                 if (optarg[0] != '/')
 681                     excludes.push_back(optarg);
 682                 else
 683                     excludes.push_back(optarg + 1);
 684                 break;
 685             case 2:     // --filter
 686                 filter_program = optarg;
 687                 break;
 688             case 3:     // --filter-extension
 689                 filter_extension = optarg;
 690                 break;
 691             case 4:     // --dest
 692                 backup_dest = optarg;
 693                 break;
 694             case 5:     // --scheme
 695                 backup_scheme = optarg;
 696                 break;
 697             case 6:     // --signature-filter
 698                 signature_filter = optarg;
 699                 break;
 700             case 7:     // --intent
 701                 snapshot_intent = atof(optarg);
 702                 if (snapshot_intent <= 0)
 703                     snapshot_intent = 1;
 704                 break;
 705             case 8:     // --full-metadata
 706                 flag_full_metadata = true;
 707                 break;
 708             case 9:     // --tmpdir
 709                 tmp_dir = optarg;
 710                 break;
 711             case 10:    // --upload-script
 712                 backup_script = optarg;
 713                 break;
 714             case 11:    // --rebuild-statcache
 715                 flag_rebuild_statcache = true;
 716                 break;
 717             default:
 718                 fprintf(stderr, "Unhandled long option!\n");
 719                 return 1;
 720             }
 721         } else {
 722             switch (c) {
 723             case 'v':
 724                 verbose = true;
 725                 break;
 726             default:
 727                 usage(argv[0]);
 728                 return 1;
 729             }
 730         }
 731     }
 732
 733     if (optind == argc) {
 734         usage(argv[0]);
 735         return 1;
 736     }
 737
 738     searches.push_back(".");
 739     for (int i = optind; i < argc; i++)
 740         add_include(argv[i]);
 741
 742     if (backup_dest == "" && backup_script == "") {
 743         fprintf(stderr,
 744                 "Error: Backup destination must be specified using --dest= or --upload-script=\n");
 745         usage(argv[0]);
 746         return 1;
 747     }
 748
 749     if (backup_dest != "" && backup_script != "") {
 750         fprintf(stderr,
 751                 "Error: Cannot specify both --dest= and --upload-script=\n");
 752         usage(argv[0]);
 753         return 1;
 754     }
 755
 756     // Default for --localdb is the same as --dest
 757     if (localdb_dir == "") {
 758         localdb_dir = backup_dest;
 759     }
 760     if (localdb_dir == "") {
 761         fprintf(stderr,
 762                 "Error: Must specify local database path with --localdb=\n");
 763         usage(argv[0]);
 764         return 1;
 765     }
 766
 767     block_buf = new char[LBS_BLOCK_SIZE];
 768
 769     /* Initialize the remote storage layer.  If using an upload script, create
 770      * a temporary directory for staging files.  Otherwise, write backups
 771      * directly to the destination directory. */
 772     if (backup_script != "") {
 773         tmp_dir = tmp_dir + "/lbs." + generate_uuid();
 774         if (mkdir(tmp_dir.c_str(), 0700) < 0) {
 775             fprintf(stderr, "Cannot create temporary directory %s: %m\n",
 776                     tmp_dir.c_str());
 777             return 1;
 778         }
 779         remote = new RemoteStore(tmp_dir);
 780         remote->set_script(backup_script);
 781     } else {
 782         remote = new RemoteStore(backup_dest);
 783     }
 784
 785     /* Store the time when the backup started, so it can be included in the
 786      * snapshot name. */
 787     time_t now;
 788     struct tm time_buf;
 789     char desc_buf[256];
 790     time(&now);
 791     localtime_r(&now, &time_buf);
 792     strftime(desc_buf, sizeof(desc_buf), "%Y%m%dT%H%M%S", &time_buf);
 793
 794     /* Open the local database which tracks all objects that are stored
 795      * remotely, for efficient incrementals.  Provide it with the name of this
 796      * snapshot. */
 797     string database_path = localdb_dir + "/localdb.sqlite";
 798     db = new LocalDb;
 799     db->Open(database_path.c_str(), desc_buf, backup_scheme.c_str(),
 800              snapshot_intent);
 801
 802     tss = new TarSegmentStore(remote, db);
 803
 804     /* Initialize the stat cache, for skipping over unchanged files. */
 805     metawriter = new MetadataWriter(tss, localdb_dir.c_str(), desc_buf,
 806                                     backup_scheme.c_str());
 807
 808     scanfile(".", false);
 809
 810     ObjectReference root_ref = metawriter->close();
 811     add_segment(root_ref.get_segment());
 812     string backup_root = root_ref.to_string();
 813
 814     delete metawriter;
 815
 816     tss->sync();
 817     tss->dump_stats();
 818     delete tss;
 819
 820     /* Write out a checksums file which lists the checksums for all the
 821      * segments included in this snapshot.  The format is designed so that it
 822      * may be easily verified using the sha1sums command. */
 823     const char csum_type[] = "sha1";
 824     string checksum_filename = "snapshot-";
 825     if (backup_scheme.size() > 0)
 826         checksum_filename += backup_scheme + "-";
 827     checksum_filename = checksum_filename + desc_buf + "." + csum_type + "sums";
 828     RemoteFile *checksum_file = remote->alloc_file(checksum_filename,
 829                                                    "checksums");
 830     FILE *checksums = fdopen(checksum_file->get_fd(), "w");
 831
 832     for (std::set<string>::iterator i = segment_list.begin();
 833          i != segment_list.end(); ++i) {
 834         string seg_path, seg_csum;
 835         if (db->GetSegmentChecksum(*i, &seg_path, &seg_csum)) {
 836             const char *raw_checksum = NULL;
 837             if (strncmp(seg_csum.c_str(), csum_type,
 838                         strlen(csum_type)) == 0) {
 839                 raw_checksum = seg_csum.c_str() + strlen(csum_type);
 840                 if (*raw_checksum == '=')
 841                     raw_checksum++;
 842                 else
 843                     raw_checksum = NULL;
 844             }
 845
 846             if (raw_checksum != NULL)
 847                 fprintf(checksums, "%s *%s\n",
 848                         raw_checksum, seg_path.c_str());
 849         }
 850     }
 851     fclose(checksums);
 852
 853     SHA1Checksum checksum_csum;
 854     string csum;
 855     checksum_filename = checksum_file->get_local_path();
 856     if (checksum_csum.process_file(checksum_filename.c_str())) {
 857         csum = checksum_csum.checksum_str();
 858     }
 859
 860     checksum_file->send();
 861
 862     db->Close();
 863
 864     /* All other files should be flushed to remote storage before writing the
 865      * backup descriptor below, so that it is not possible to have a backup
 866      * descriptor written out depending on non-existent (not yet written)
 867      * files. */
 868     remote->sync();
 869
 870     /* Write a backup descriptor file, which says which segments are needed and
 871      * where to start to restore this snapshot.  The filename is based on the
 872      * current time.  If a signature filter program was specified, filter the
 873      * data through that to give a chance to sign the descriptor contents. */
 874     string desc_filename = "snapshot-";
 875     if (backup_scheme.size() > 0)
 876         desc_filename += backup_scheme + "-";
 877     desc_filename = desc_filename + desc_buf + ".lbs";
 878
 879     RemoteFile *descriptor_file = remote->alloc_file(desc_filename,
 880                                                      "snapshots");
 881     int descriptor_fd = descriptor_file->get_fd();
 882     if (descriptor_fd < 0) {
 883         fprintf(stderr, "Unable to open descriptor output file: %m\n");
 884         return 1;
 885     }
 886     pid_t signature_pid = 0;
 887     if (signature_filter.size() > 0) {
 888         int new_fd = spawn_filter(descriptor_fd, signature_filter.c_str(),
 889                                   &signature_pid);
 890         close(descriptor_fd);
 891         descriptor_fd = new_fd;
 892     }
 893     FILE *descriptor = fdopen(descriptor_fd, "w");
 894
 895     fprintf(descriptor, "Format: LBS Snapshot v0.8\n");
 896     fprintf(descriptor, "Producer: Cumulus %s\n", cumulus_version);
 897     strftime(desc_buf, sizeof(desc_buf), "%Y-%m-%d %H:%M:%S %z", &time_buf);
 898     fprintf(descriptor, "Date: %s\n", desc_buf);
 899     if (backup_scheme.size() > 0)
 900         fprintf(descriptor, "Scheme: %s\n", backup_scheme.c_str());
 901     fprintf(descriptor, "Backup-Intent: %g\n", snapshot_intent);
 902     fprintf(descriptor, "Root: %s\n", backup_root.c_str());
 903
 904     if (csum.size() > 0) {
 905         fprintf(descriptor, "Checksums: %s\n", csum.c_str());
 906     }
 907
 908     fprintf(descriptor, "Segments:\n");
 909     for (std::set<string>::iterator i = segment_list.begin();
 910          i != segment_list.end(); ++i) {
 911         fprintf(descriptor, "    %s\n", i->c_str());
 912     }
 913
 914     fclose(descriptor);
 915
 916     if (signature_pid) {
 917         int status;
 918         waitpid(signature_pid, &status, 0);
 919
 920         if (!WIFEXITED(status) || WEXITSTATUS(status) != 0) {
 921             throw IOException("Signature filter process error");
 922         }
 923     }
 924
 925     descriptor_file->send();
 926
 927     remote->sync();
 928     delete remote;
 929
 930     if (backup_script != "") {
 931         if (rmdir(tmp_dir.c_str()) < 0) {
 932             fprintf(stderr,
 933                     "Warning: Cannot delete temporary directory %s: %m\n",
 934                     tmp_dir.c_str());
 935         }
 936     }
 937
 938     return 0;
 939 }