scandir.cc

   1 /* Recursively descend the filesystem and visit each file. */
   2
   3 #include <dirent.h>
   4 #include <errno.h>
   5 #include <fcntl.h>
   6 #include <getopt.h>
   7 #include <grp.h>
   8 #include <pwd.h>
   9 #include <stdint.h>
  10 #include <stdio.h>
  11 #include <stdlib.h>
  12 #include <sys/stat.h>
  13 #include <sys/sysmacros.h>
  14 #include <sys/types.h>
  15 #include <sys/wait.h>
  16 #include <unistd.h>
  17
  18 #include <algorithm>
  19 #include <fstream>
  20 #include <iostream>
  21 #include <list>
  22 #include <set>
  23 #include <sstream>
  24 #include <string>
  25 #include <vector>
  26
  27 #include "localdb.h"
  28 #include "metadata.h"
  29 #include "store.h"
  30 #include "sha1.h"
  31 #include "util.h"
  32
  33 using std::list;
  34 using std::string;
  35 using std::vector;
  36 using std::ostream;
  37
  38 /* Version information.  This will be filled in by the Makefile. */
  39 #ifndef LBS_VERSION
  40 #define LBS_VERSION Unknown
  41 #endif
  42 #define LBS_STRINGIFY(s) LBS_STRINGIFY2(s)
  43 #define LBS_STRINGIFY2(s) #s
  44 static const char lbs_version[] = LBS_STRINGIFY(LBS_VERSION);
  45
  46 static TarSegmentStore *tss = NULL;
  47 static MetadataWriter *metawriter = NULL;
  48
  49 /* Buffer for holding a single block of data read from a file. */
  50 static const size_t LBS_BLOCK_SIZE = 1024 * 1024;
  51 static char *block_buf;
  52
  53 /* Local database, which tracks objects written in this and previous
  54  * invocations to help in creating incremental snapshots. */
  55 LocalDb *db;
  56
  57 /* Keep track of all segments which are needed to reconstruct the snapshot. */
  58 std::set<string> segment_list;
  59
  60 /* Selection of files to include/exclude in the snapshot. */
  61 std::list<string> includes;         // Paths in which files should be saved
  62 std::list<string> excludes;         // Paths which will not be saved
  63 std::list<string> searches;         // Directories we don't want to save, but
  64                                     //   do want to descend searching for data
  65                                     //   in included paths
  66
  67 bool relative_paths = true;
  68
  69 /* Ensure that the given segment is listed as a dependency of the current
  70  * snapshot. */
  71 void add_segment(const string& segment)
  72 {
  73     segment_list.insert(segment);
  74 }
  75
  76 /* Read data from a file descriptor and return the amount of data read.  A
  77  * short read (less than the requested size) will only occur if end-of-file is
  78  * hit. */
  79 ssize_t file_read(int fd, char *buf, size_t maxlen)
  80 {
  81     size_t bytes_read = 0;
  82
  83     while (true) {
  84         ssize_t res = read(fd, buf, maxlen);
  85         if (res < 0) {
  86             if (errno == EINTR)
  87                 continue;
  88             fprintf(stderr, "error reading file: %m\n");
  89             return -1;
  90         } else if (res == 0) {
  91             break;
  92         } else {
  93             bytes_read += res;
  94             buf += res;
  95             maxlen -= res;
  96         }
  97     }
  98
  99     return bytes_read;
 100 }
 101
 102 /* Read the contents of a file (specified by an open file descriptor) and copy
 103  * the data to the store.  Returns the size of the file (number of bytes
 104  * dumped), or -1 on error. */
 105 int64_t dumpfile(int fd, dictionary &file_info, const string &path,
 106                  struct stat& stat_buf)
 107 {
 108     int64_t size = 0;
 109     list<string> object_list;
 110     const char *status = NULL;          /* Status indicator printed out */
 111
 112     /* Look up this file in the old stat cache, if we can.  If the stat
 113      * information indicates that the file has not changed, do not bother
 114      * re-reading the entire contents. */
 115     bool cached = false;
 116
 117     if (metawriter->find(path) && metawriter->is_unchanged(&stat_buf)) {
 118         cached = true;
 119         list<ObjectReference> blocks = metawriter->get_blocks();
 120
 121         /* If any of the blocks in the object have been expired, then we should
 122          * fall back to fully reading in the file. */
 123         for (list<ObjectReference>::const_iterator i = blocks.begin();
 124              i != blocks.end(); ++i) {
 125             const ObjectReference &ref = *i;
 126             if (!db->IsAvailable(ref)) {
 127                 cached = false;
 128                 status = "repack";
 129                 break;
 130             }
 131         }
 132
 133         /* If everything looks okay, use the cached information */
 134         if (cached) {
 135             file_info["checksum"] = metawriter->get_checksum();
 136             for (list<ObjectReference>::const_iterator i = blocks.begin();
 137                  i != blocks.end(); ++i) {
 138                 const ObjectReference &ref = *i;
 139                 object_list.push_back(ref.to_string());
 140                 segment_list.insert(ref.get_segment());
 141                 db->UseObject(ref);
 142             }
 143             size = stat_buf.st_size;
 144         }
 145     }
 146
 147     /* If the file is new or changed, we must read in the contents a block at a
 148      * time. */
 149     if (!cached) {
 150         SHA1Checksum hash;
 151         while (true) {
 152             ssize_t bytes = file_read(fd, block_buf, LBS_BLOCK_SIZE);
 153             if (bytes == 0)
 154                 break;
 155             if (bytes < 0) {
 156                 fprintf(stderr, "Backup contents for %s may be incorrect\n",
 157                         path.c_str());
 158                 break;
 159             }
 160
 161             hash.process(block_buf, bytes);
 162
 163             // Either find a copy of this block in an already-existing segment,
 164             // or index it so it can be re-used in the future
 165             double block_age = 0.0;
 166             SHA1Checksum block_hash;
 167             block_hash.process(block_buf, bytes);
 168             string block_csum = block_hash.checksum_str();
 169             ObjectReference ref = db->FindObject(block_csum, bytes);
 170
 171             // Store a copy of the object if one does not yet exist
 172             if (ref.get_segment().size() == 0) {
 173                 LbsObject *o = new LbsObject;
 174                 int object_group;
 175
 176                 /* We might still have seen this checksum before, if the object
 177                  * was stored at some time in the past, but we have decided to
 178                  * clean the segment the object was originally stored in
 179                  * (FindObject will not return such objects).  When rewriting
 180                  * the object contents, put it in a separate group, so that old
 181                  * objects get grouped together.  The hope is that these old
 182                  * objects will continue to be used in the future, and we
 183                  * obtain segments which will continue to be well-utilized.
 184                  * Additionally, keep track of the age of the data by looking
 185                  * up the age of the block which was expired and using that
 186                  * instead of the current time. */
 187                 if (db->IsOldObject(block_csum, bytes,
 188                                     &block_age, &object_group)) {
 189                     if (object_group == 0) {
 190                         o->set_group("data");
 191                     } else {
 192                         char group[32];
 193                         sprintf(group, "compacted-%d", object_group);
 194                         o->set_group(group);
 195                     }
 196                     if (status == NULL)
 197                         status = "partial";
 198                 } else {
 199                     o->set_group("data");
 200                     status = "new";
 201                 }
 202
 203                 o->set_data(block_buf, bytes);
 204                 o->write(tss);
 205                 ref = o->get_ref();
 206                 db->StoreObject(ref, block_csum, bytes, block_age);
 207                 delete o;
 208             }
 209
 210             object_list.push_back(ref.to_string());
 211             segment_list.insert(ref.get_segment());
 212             db->UseObject(ref);
 213             size += bytes;
 214
 215             if (status == NULL)
 216                 status = "old";
 217         }
 218
 219         file_info["checksum"] = hash.checksum_str();
 220     }
 221
 222     if (status != NULL)
 223         printf("    [%s]\n", status);
 224
 225     string blocklist = "";
 226     for (list<string>::iterator i = object_list.begin();
 227          i != object_list.end(); ++i) {
 228         if (i != object_list.begin())
 229             blocklist += "\n    ";
 230         blocklist += *i;
 231     }
 232     file_info["data"] = blocklist;
 233
 234     return size;
 235 }
 236
 237 /* Dump a specified filesystem object (file, directory, etc.) based on its
 238  * inode information.  If the object is a regular file, an open filehandle is
 239  * provided. */
 240 void dump_inode(const string& path,         // Path within snapshot
 241                 const string& fullpath,     // Path to object in filesystem
 242                 struct stat& stat_buf,      // Results of stat() call
 243                 int fd)                     // Open filehandle if regular file
 244 {
 245     char *buf;
 246     dictionary file_info;
 247     int64_t file_size;
 248     ssize_t len;
 249
 250     printf("%s\n", path.c_str());
 251
 252     file_info["name"] = uri_encode(path);
 253     file_info["mode"] = encode_int(stat_buf.st_mode & 07777, 8);
 254     file_info["ctime"] = encode_int(stat_buf.st_ctime);
 255     file_info["mtime"] = encode_int(stat_buf.st_mtime);
 256     file_info["user"] = encode_int(stat_buf.st_uid);
 257     file_info["group"] = encode_int(stat_buf.st_gid);
 258
 259     struct passwd *pwd = getpwuid(stat_buf.st_uid);
 260     if (pwd != NULL) {
 261         file_info["user"] += " (" + uri_encode(pwd->pw_name) + ")";
 262     }
 263
 264     struct group *grp = getgrgid(stat_buf.st_gid);
 265     if (pwd != NULL) {
 266         file_info["group"] += " (" + uri_encode(grp->gr_name) + ")";
 267     }
 268
 269     if (stat_buf.st_nlink > 1 && (stat_buf.st_mode & S_IFMT) != S_IFDIR) {
 270         file_info["links"] = encode_int(stat_buf.st_nlink);
 271     }
 272
 273     file_info["inode"] = encode_int(major(stat_buf.st_dev))
 274         + "/" + encode_int(minor(stat_buf.st_dev))
 275         + "/" + encode_int(stat_buf.st_ino);
 276
 277     char inode_type;
 278
 279     switch (stat_buf.st_mode & S_IFMT) {
 280     case S_IFIFO:
 281         inode_type = 'p';
 282         break;
 283     case S_IFSOCK:
 284         inode_type = 's';
 285         break;
 286     case S_IFBLK:
 287     case S_IFCHR:
 288         inode_type = ((stat_buf.st_mode & S_IFMT) == S_IFBLK) ? 'b' : 'c';
 289         file_info["device"] = encode_int(major(stat_buf.st_rdev))
 290             + "/" + encode_int(minor(stat_buf.st_rdev));
 291         break;
 292     case S_IFLNK:
 293         inode_type = 'l';
 294
 295         /* Use the reported file size to allocate a buffer large enough to read
 296          * the symlink.  Allocate slightly more space, so that we ask for more
 297          * bytes than we expect and so check for truncation. */
 298         buf = new char[stat_buf.st_size + 2];
 299         len = readlink(fullpath.c_str(), buf, stat_buf.st_size + 1);
 300         if (len < 0) {
 301             fprintf(stderr, "error reading symlink: %m\n");
 302         } else if (len <= stat_buf.st_size) {
 303             buf[len] = '\0';
 304             file_info["target"] = uri_encode(buf);
 305         } else if (len > stat_buf.st_size) {
 306             fprintf(stderr, "error reading symlink: name truncated\n");
 307         }
 308
 309         delete[] buf;
 310         break;
 311     case S_IFREG:
 312         inode_type = 'f';
 313
 314         file_size = dumpfile(fd, file_info, path, stat_buf);
 315         file_info["size"] = encode_int(file_size);
 316
 317         if (file_size < 0)
 318             return;             // error occurred; do not dump file
 319
 320         if (file_size != stat_buf.st_size) {
 321             fprintf(stderr, "Warning: Size of %s changed during reading\n",
 322                     path.c_str());
 323         }
 324
 325         break;
 326     case S_IFDIR:
 327         inode_type = 'd';
 328         break;
 329
 330     default:
 331         fprintf(stderr, "Unknown inode type: mode=%x\n", stat_buf.st_mode);
 332         return;
 333     }
 334
 335     file_info["type"] = string(1, inode_type);
 336
 337     metawriter->add(file_info);
 338 }
 339
 340 void scanfile(const string& path, bool include)
 341 {
 342     int fd = -1;
 343     long flags;
 344     struct stat stat_buf;
 345     list<string> refs;
 346
 347     string true_path;
 348     if (relative_paths)
 349         true_path = path;
 350     else
 351         true_path = "/" + path;
 352
 353     // Set to true if we should scan through the contents of this directory,
 354     // but not actually back files up
 355     bool scan_only = false;
 356
 357     // Check this file against the include/exclude list to see if it should be
 358     // considered
 359     for (list<string>::iterator i = includes.begin();
 360          i != includes.end(); ++i) {
 361         if (path == *i) {
 362             printf("Including %s\n", path.c_str());
 363             include = true;
 364         }
 365     }
 366
 367     for (list<string>::iterator i = excludes.begin();
 368          i != excludes.end(); ++i) {
 369         if (path == *i) {
 370             printf("Excluding %s\n", path.c_str());
 371             include = false;
 372         }
 373     }
 374
 375     for (list<string>::iterator i = searches.begin();
 376          i != searches.end(); ++i) {
 377         if (path == *i) {
 378             printf("Scanning %s\n", path.c_str());
 379             scan_only = true;
 380         }
 381     }
 382
 383     if (!include && !scan_only)
 384         return;
 385
 386     if (lstat(true_path.c_str(), &stat_buf) < 0) {
 387         fprintf(stderr, "lstat(%s): %m\n", path.c_str());
 388         return;
 389     }
 390
 391     if ((stat_buf.st_mode & S_IFMT) == S_IFREG) {
 392         /* Be paranoid when opening the file.  We have no guarantee that the
 393          * file was not replaced between the stat() call above and the open()
 394          * call below, so we might not even be opening a regular file.  We
 395          * supply flags to open to to guard against various conditions before
 396          * we can perform an lstat to check that the file is still a regular
 397          * file:
 398          *   - O_NOFOLLOW: in the event the file was replaced by a symlink
 399          *   - O_NONBLOCK: prevents open() from blocking if the file was
 400          *     replaced by a fifo
 401          * We also add in O_NOATIME, since this may reduce disk writes (for
 402          * inode updates).  However, O_NOATIME may result in EPERM, so if the
 403          * initial open fails, try again without O_NOATIME.  */
 404         fd = open(true_path.c_str(), O_RDONLY|O_NOATIME|O_NOFOLLOW|O_NONBLOCK);
 405         if (fd < 0) {
 406             fd = open(true_path.c_str(), O_RDONLY|O_NOFOLLOW|O_NONBLOCK);
 407         }
 408         if (fd < 0) {
 409             fprintf(stderr, "Unable to open file %s: %m\n", path.c_str());
 410             return;
 411         }
 412
 413         /* Drop the use of the O_NONBLOCK flag; we only wanted that for file
 414          * open. */
 415         flags = fcntl(fd, F_GETFL);
 416         fcntl(fd, F_SETFL, flags & ~O_NONBLOCK);
 417
 418         /* Perform the stat call again, and check that we still have a regular
 419          * file. */
 420         if (fstat(fd, &stat_buf) < 0) {
 421             fprintf(stderr, "fstat: %m\n");
 422             close(fd);
 423             return;
 424         }
 425
 426         if ((stat_buf.st_mode & S_IFMT) != S_IFREG) {
 427             fprintf(stderr, "file is no longer a regular file!\n");
 428             close(fd);
 429             return;
 430         }
 431     }
 432
 433     dump_inode(path, true_path, stat_buf, fd);
 434
 435     if (fd >= 0)
 436         close(fd);
 437
 438     // If we hit a directory, now that we've written the directory itself,
 439     // recursively scan the directory.
 440     if ((stat_buf.st_mode & S_IFMT) == S_IFDIR) {
 441         DIR *dir = opendir(true_path.c_str());
 442
 443         if (dir == NULL) {
 444             fprintf(stderr, "Error: %m\n");
 445             return;
 446         }
 447
 448         struct dirent *ent;
 449         vector<string> contents;
 450         while ((ent = readdir(dir)) != NULL) {
 451             string filename(ent->d_name);
 452             if (filename == "." || filename == "..")
 453                 continue;
 454             contents.push_back(filename);
 455         }
 456
 457         closedir(dir);
 458
 459         sort(contents.begin(), contents.end());
 460
 461         for (vector<string>::iterator i = contents.begin();
 462              i != contents.end(); ++i) {
 463             const string& filename = *i;
 464             if (path == ".")
 465                 scanfile(filename, include);
 466             else
 467                 scanfile(path + "/" + filename, include);
 468         }
 469     }
 470 }
 471
 472 /* Include the specified file path in the backups.  Append the path to the
 473  * includes list, and to ensure that we actually see the path when scanning the
 474  * directory tree, add all the parent directories to the search list, which
 475  * means we will scan through the directory listing even if the files
 476  * themselves are excluded from being backed up. */
 477 void add_include(const char *path)
 478 {
 479     printf("Add: %s\n", path);
 480     /* Was an absolute path specified?  If so, we'll need to start scanning
 481      * from the root directory.  Make sure that the user was consistent in
 482      * providing either all relative paths or all absolute paths. */
 483     if (path[0] == '/') {
 484         if (includes.size() > 0 && relative_paths == true) {
 485             fprintf(stderr,
 486                     "Error: Cannot mix relative and absolute paths!\n");
 487             exit(1);
 488         }
 489
 490         relative_paths = false;
 491
 492         // Skip over leading '/'
 493         path++;
 494     } else if (relative_paths == false && path[0] != '/') {
 495         fprintf(stderr, "Error: Cannot mix relative and absolute paths!\n");
 496         exit(1);
 497     }
 498
 499     includes.push_back(path);
 500
 501     /* Split the specified path into directory components, and ensure that we
 502      * descend into all the directories along the path. */
 503     const char *slash = path;
 504
 505     if (path[0] == '\0')
 506         return;
 507
 508     while ((slash = strchr(slash + 1, '/')) != NULL) {
 509         string component(path, slash - path);
 510         searches.push_back(component);
 511     }
 512 }
 513
 514 void usage(const char *program)
 515 {
 516     fprintf(
 517         stderr,
 518         "LBS %s\n\n"
 519         "Usage: %s [OPTION]... --dest=DEST PATHS...\n"
 520         "Produce backup snapshot of files in SOURCE and store to DEST.\n"
 521         "\n"
 522         "Options:\n"
 523         "  --dest=PATH          path where backup is to be written [REQUIRED]\n"
 524         "  --exclude=PATH       exclude files in PATH from snapshot\n"
 525         "  --localdb=PATH       local backup metadata is stored in PATH\n"
 526         "  --filter=COMMAND     program through which to filter segment data\n"
 527         "                           (defaults to \"bzip2 -c\")\n"
 528         "  --filter-extension=EXT\n"
 529         "                       string to append to segment files\n"
 530         "                           (defaults to \".bz2\")\n"
 531         "  --signature-filter=COMMAND\n"
 532         "                       program though which to filter descriptor\n"
 533         "  --scheme=NAME        optional name for this snapshot\n",
 534         lbs_version, program
 535     );
 536 }
 537
 538 int main(int argc, char *argv[])
 539 {
 540     string backup_dest = "";
 541     string localdb_dir = "";
 542     string backup_scheme = "";
 543     string signature_filter = "";
 544
 545     while (1) {
 546         static struct option long_options[] = {
 547             {"localdb", 1, 0, 0},           // 0
 548             {"exclude", 1, 0, 0},           // 1
 549             {"filter", 1, 0, 0},            // 2
 550             {"filter-extension", 1, 0, 0},  // 3
 551             {"dest", 1, 0, 0},              // 4
 552             {"scheme", 1, 0, 0},            // 5
 553             {"signature-filter", 1, 0, 0},  // 6
 554             {NULL, 0, 0, 0},
 555         };
 556
 557         int long_index;
 558         int c = getopt_long(argc, argv, "", long_options, &long_index);
 559
 560         if (c == -1)
 561             break;
 562
 563         if (c == 0) {
 564             switch (long_index) {
 565             case 0:     // --localdb
 566                 localdb_dir = optarg;
 567                 break;
 568             case 1:     // --exclude
 569                 if (optarg[0] != '/')
 570                     excludes.push_back(optarg);
 571                 else
 572                     excludes.push_back(optarg + 1);
 573                 break;
 574             case 2:     // --filter
 575                 filter_program = optarg;
 576                 break;
 577             case 3:     // --filter-extension
 578                 filter_extension = optarg;
 579                 break;
 580             case 4:     // --dest
 581                 backup_dest = optarg;
 582                 break;
 583             case 5:     // --scheme
 584                 backup_scheme = optarg;
 585                 break;
 586             case 6:     // --signature-filter
 587                 signature_filter = optarg;
 588                 break;
 589             default:
 590                 fprintf(stderr, "Unhandled long option!\n");
 591                 return 1;
 592             }
 593         } else {
 594             usage(argv[0]);
 595             return 1;
 596         }
 597     }
 598
 599     if (optind == argc) {
 600         usage(argv[0]);
 601         return 1;
 602     }
 603
 604     searches.push_back(".");
 605     for (int i = optind; i < argc; i++)
 606         add_include(argv[i]);
 607
 608     if (backup_dest == "") {
 609         fprintf(stderr,
 610                 "Error: Backup destination must be specified with --dest=\n");
 611         usage(argv[0]);
 612         return 1;
 613     }
 614
 615     // Default for --localdb is the same as --dest
 616     if (localdb_dir == "") {
 617         localdb_dir = backup_dest;
 618     }
 619
 620     // Dump paths for debugging/informational purposes
 621     {
 622         list<string>::const_iterator i;
 623
 624         printf("LBS Version: %s\n", lbs_version);
 625
 626         printf("--dest=%s\n--localdb=%s\n\n",
 627                backup_dest.c_str(), localdb_dir.c_str());
 628
 629         printf("Includes:\n");
 630         for (i = includes.begin(); i != includes.end(); ++i)
 631             printf("    %s\n", i->c_str());
 632
 633         printf("Excludes:\n");
 634         for (i = excludes.begin(); i != excludes.end(); ++i)
 635             printf("    %s\n", i->c_str());
 636
 637         printf("Searching:\n");
 638         for (i = searches.begin(); i != searches.end(); ++i)
 639             printf("    %s\n", i->c_str());
 640     }
 641
 642     block_buf = new char[LBS_BLOCK_SIZE];
 643
 644     /* Store the time when the backup started, so it can be included in the
 645      * snapshot name. */
 646     time_t now;
 647     struct tm time_buf;
 648     char desc_buf[256];
 649     time(&now);
 650     localtime_r(&now, &time_buf);
 651     strftime(desc_buf, sizeof(desc_buf), "%Y%m%dT%H%M%S", &time_buf);
 652
 653     /* Open the local database which tracks all objects that are stored
 654      * remotely, for efficient incrementals.  Provide it with the name of this
 655      * snapshot. */
 656     string database_path = localdb_dir + "/localdb.sqlite";
 657     db = new LocalDb;
 658     db->Open(database_path.c_str(), desc_buf,
 659              backup_scheme.size() ? backup_scheme.c_str() : NULL);
 660
 661     tss = new TarSegmentStore(backup_dest, db);
 662
 663     /* Initialize the stat cache, for skipping over unchanged files. */
 664     metawriter = new MetadataWriter(tss, localdb_dir.c_str(), desc_buf,
 665                                     backup_scheme.size()
 666                                         ? backup_scheme.c_str()
 667                                         : NULL);
 668
 669     scanfile(".", false);
 670
 671     ObjectReference root_ref = metawriter->close();
 672     add_segment(root_ref.get_segment());
 673     string backup_root = root_ref.to_string();
 674
 675     delete metawriter;
 676
 677     tss->sync();
 678     tss->dump_stats();
 679     delete tss;
 680
 681     /* Write out a checksums file which lists the checksums for all the
 682      * segments included in this snapshot.  The format is designed so that it
 683      * may be easily verified using the sha1sums command. */
 684     const char csum_type[] = "sha1";
 685     string checksum_filename = backup_dest + "/snapshot-";
 686     if (backup_scheme.size() > 0)
 687         checksum_filename += backup_scheme + "-";
 688     checksum_filename = checksum_filename + desc_buf + "." + csum_type + "sums";
 689     FILE *checksums = fopen(checksum_filename.c_str(), "w");
 690     if (checksums != NULL) {
 691         for (std::set<string>::iterator i = segment_list.begin();
 692              i != segment_list.end(); ++i) {
 693             string seg_path, seg_csum;
 694             if (db->GetSegmentChecksum(*i, &seg_path, &seg_csum)) {
 695                 const char *raw_checksum = NULL;
 696                 if (strncmp(seg_csum.c_str(), csum_type,
 697                             strlen(csum_type)) == 0) {
 698                     raw_checksum = seg_csum.c_str() + strlen(csum_type);
 699                     if (*raw_checksum == '=')
 700                         raw_checksum++;
 701                     else
 702                         raw_checksum = NULL;
 703                 }
 704
 705                 if (raw_checksum != NULL)
 706                     fprintf(checksums, "%s *%s\n",
 707                             raw_checksum, seg_path.c_str());
 708             }
 709         }
 710         fclose(checksums);
 711     } else {
 712         fprintf(stderr, "ERROR: Unable to write checksums file: %m\n");
 713     }
 714
 715     db->Close();
 716
 717     /* Write a backup descriptor file, which says which segments are needed and
 718      * where to start to restore this snapshot.  The filename is based on the
 719      * current time.  If a signature filter program was specified, filter the
 720      * data through that to give a chance to sign the descriptor contents. */
 721     string desc_filename = backup_dest + "/snapshot-";
 722     if (backup_scheme.size() > 0)
 723         desc_filename += backup_scheme + "-";
 724     desc_filename = desc_filename + desc_buf + ".lbs";
 725
 726     int descriptor_fd = open(desc_filename.c_str(), O_WRONLY | O_CREAT, 0666);
 727     if (descriptor_fd < 0) {
 728         fprintf(stderr, "Unable to open descriptor output file: %m\n");
 729         return 1;
 730     }
 731     pid_t signature_pid = 0;
 732     if (signature_filter.size() > 0) {
 733         int new_fd = spawn_filter(descriptor_fd, signature_filter.c_str(),
 734                                   &signature_pid);
 735         close(descriptor_fd);
 736         descriptor_fd = new_fd;
 737     }
 738     FILE *descriptor = fdopen(descriptor_fd, "w");
 739
 740     fprintf(descriptor, "Format: LBS Snapshot v0.6\n");
 741     fprintf(descriptor, "Producer: LBS %s\n", lbs_version);
 742     strftime(desc_buf, sizeof(desc_buf), "%Y-%m-%d %H:%M:%S %z", &time_buf);
 743     fprintf(descriptor, "Date: %s\n", desc_buf);
 744     if (backup_scheme.size() > 0)
 745         fprintf(descriptor, "Scheme: %s\n", backup_scheme.c_str());
 746     fprintf(descriptor, "Root: %s\n", backup_root.c_str());
 747
 748     SHA1Checksum checksum_csum;
 749     if (checksum_csum.process_file(checksum_filename.c_str())) {
 750         string csum = checksum_csum.checksum_str();
 751         fprintf(descriptor, "Checksums: %s\n", csum.c_str());
 752     }
 753
 754     fprintf(descriptor, "Segments:\n");
 755     for (std::set<string>::iterator i = segment_list.begin();
 756          i != segment_list.end(); ++i) {
 757         fprintf(descriptor, "    %s\n", i->c_str());
 758     }
 759
 760     fclose(descriptor);
 761
 762     if (signature_pid) {
 763         int status;
 764         waitpid(signature_pid, &status, 0);
 765
 766         if (!WIFEXITED(status) || WEXITSTATUS(status) != 0) {
 767             throw IOException("Signature filter process error");
 768         }
 769     }
 770
 771     return 0;
 772 }