main.cc

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