1 /* Recursively descend the filesystem and visit each file. */
13 #include <sys/sysmacros.h>
14 #include <sys/types.h>
38 /* Version information. This will be filled in by the Makefile. */
40 #define LBS_VERSION Unknown
42 #define LBS_STRINGIFY(s) LBS_STRINGIFY2(s)
43 #define LBS_STRINGIFY2(s) #s
44 static const char lbs_version[] = LBS_STRINGIFY(LBS_VERSION);
46 static TarSegmentStore *tss = NULL;
47 static MetadataWriter *metawriter = NULL;
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;
53 /* Local database, which tracks objects written in this and previous
54 * invocations to help in creating incremental snapshots. */
57 /* Keep track of all segments which are needed to reconstruct the snapshot. */
58 std::set<string> segment_list;
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
67 bool relative_paths = true;
69 /* Ensure that the given segment is listed as a dependency of the current
71 void add_segment(const string& segment)
73 segment_list.insert(segment);
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
79 ssize_t file_read(int fd, char *buf, size_t maxlen)
81 size_t bytes_read = 0;
84 ssize_t res = read(fd, buf, maxlen);
88 fprintf(stderr, "error reading file: %m\n");
90 } else if (res == 0) {
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)
109 list<string> object_list;
110 const char *status = NULL; /* Status indicator printed out */
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. */
117 if (metawriter->find(path) && metawriter->is_unchanged(&stat_buf)) {
119 list<ObjectReference> blocks = metawriter->get_blocks();
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)) {
133 /* If everything looks okay, use the cached information */
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());
141 add_segment(ref.get_segment());
144 size = stat_buf.st_size;
148 /* If the file is new or changed, we must read in the contents a block at a
153 ssize_t bytes = file_read(fd, block_buf, LBS_BLOCK_SIZE);
157 fprintf(stderr, "Backup contents for %s may be incorrect\n",
162 hash.process(block_buf, bytes);
164 // Sparse file processing: if we read a block of all zeroes, encode
166 bool all_zero = true;
167 for (int i = 0; i < bytes; i++) {
168 if (block_buf[i] != 0) {
174 // Either find a copy of this block in an already-existing segment,
175 // or index it so it can be re-used in the future
176 double block_age = 0.0;
179 SHA1Checksum block_hash;
180 block_hash.process(block_buf, bytes);
181 string block_csum = block_hash.checksum_str();
184 ref = ObjectReference(ObjectReference::REF_ZERO);
185 ref.set_range(0, bytes);
187 ObjectReference ref = db->FindObject(block_csum, bytes);
190 // Store a copy of the object if one does not yet exist
192 LbsObject *o = new LbsObject;
195 /* We might still have seen this checksum before, if the object
196 * was stored at some time in the past, but we have decided to
197 * clean the segment the object was originally stored in
198 * (FindObject will not return such objects). When rewriting
199 * the object contents, put it in a separate group, so that old
200 * objects get grouped together. The hope is that these old
201 * objects will continue to be used in the future, and we
202 * obtain segments which will continue to be well-utilized.
203 * Additionally, keep track of the age of the data by looking
204 * up the age of the block which was expired and using that
205 * instead of the current time. */
206 if (db->IsOldObject(block_csum, bytes,
207 &block_age, &object_group)) {
208 if (object_group == 0) {
209 o->set_group("data");
212 sprintf(group, "compacted-%d", object_group);
218 o->set_group("data");
222 o->set_data(block_buf, bytes);
225 db->StoreObject(ref, block_csum, bytes, block_age);
229 object_list.push_back(ref.to_string());
231 add_segment(ref.get_segment());
239 file_info["checksum"] = hash.checksum_str();
243 printf(" [%s]\n", status);
245 string blocklist = "";
246 for (list<string>::iterator i = object_list.begin();
247 i != object_list.end(); ++i) {
248 if (i != object_list.begin())
252 file_info["data"] = blocklist;
257 /* Dump a specified filesystem object (file, directory, etc.) based on its
258 * inode information. If the object is a regular file, an open filehandle is
260 void dump_inode(const string& path, // Path within snapshot
261 const string& fullpath, // Path to object in filesystem
262 struct stat& stat_buf, // Results of stat() call
263 int fd) // Open filehandle if regular file
266 dictionary file_info;
270 printf("%s\n", path.c_str());
271 metawriter->find(path);
273 file_info["name"] = uri_encode(path);
274 file_info["mode"] = encode_int(stat_buf.st_mode & 07777, 8);
275 file_info["ctime"] = encode_int(stat_buf.st_ctime);
276 file_info["mtime"] = encode_int(stat_buf.st_mtime);
277 file_info["user"] = encode_int(stat_buf.st_uid);
278 file_info["group"] = encode_int(stat_buf.st_gid);
280 time_t now = time(NULL);
281 if (now - stat_buf.st_ctime < 30 || now - stat_buf.st_mtime < 30)
282 if ((stat_buf.st_mode & S_IFMT) != S_IFDIR)
283 file_info["volatile"] = "1";
285 struct passwd *pwd = getpwuid(stat_buf.st_uid);
287 file_info["user"] += " (" + uri_encode(pwd->pw_name) + ")";
290 struct group *grp = getgrgid(stat_buf.st_gid);
292 file_info["group"] += " (" + uri_encode(grp->gr_name) + ")";
295 if (stat_buf.st_nlink > 1 && (stat_buf.st_mode & S_IFMT) != S_IFDIR) {
296 file_info["links"] = encode_int(stat_buf.st_nlink);
299 file_info["inode"] = encode_int(major(stat_buf.st_dev))
300 + "/" + encode_int(minor(stat_buf.st_dev))
301 + "/" + encode_int(stat_buf.st_ino);
305 switch (stat_buf.st_mode & S_IFMT) {
314 inode_type = ((stat_buf.st_mode & S_IFMT) == S_IFBLK) ? 'b' : 'c';
315 file_info["device"] = encode_int(major(stat_buf.st_rdev))
316 + "/" + encode_int(minor(stat_buf.st_rdev));
321 /* Use the reported file size to allocate a buffer large enough to read
322 * the symlink. Allocate slightly more space, so that we ask for more
323 * bytes than we expect and so check for truncation. */
324 buf = new char[stat_buf.st_size + 2];
325 len = readlink(fullpath.c_str(), buf, stat_buf.st_size + 1);
327 fprintf(stderr, "error reading symlink: %m\n");
328 } else if (len <= stat_buf.st_size) {
330 file_info["target"] = uri_encode(buf);
331 } else if (len > stat_buf.st_size) {
332 fprintf(stderr, "error reading symlink: name truncated\n");
340 file_size = dumpfile(fd, file_info, path, stat_buf);
341 file_info["size"] = encode_int(file_size);
344 return; // error occurred; do not dump file
346 if (file_size != stat_buf.st_size) {
347 fprintf(stderr, "Warning: Size of %s changed during reading\n",
349 file_info["volatile"] = "1";
358 fprintf(stderr, "Unknown inode type: mode=%x\n", stat_buf.st_mode);
362 file_info["type"] = string(1, inode_type);
364 metawriter->add(file_info);
367 void scanfile(const string& path, bool include)
371 struct stat stat_buf;
378 true_path = "/" + path;
380 // Set to true if we should scan through the contents of this directory,
381 // but not actually back files up
382 bool scan_only = false;
384 // Check this file against the include/exclude list to see if it should be
386 for (list<string>::iterator i = includes.begin();
387 i != includes.end(); ++i) {
389 printf("Including %s\n", path.c_str());
394 for (list<string>::iterator i = excludes.begin();
395 i != excludes.end(); ++i) {
397 printf("Excluding %s\n", path.c_str());
402 for (list<string>::iterator i = searches.begin();
403 i != searches.end(); ++i) {
405 printf("Scanning %s\n", path.c_str());
410 if (!include && !scan_only)
413 if (lstat(true_path.c_str(), &stat_buf) < 0) {
414 fprintf(stderr, "lstat(%s): %m\n", path.c_str());
418 if ((stat_buf.st_mode & S_IFMT) == S_IFREG) {
419 /* Be paranoid when opening the file. We have no guarantee that the
420 * file was not replaced between the stat() call above and the open()
421 * call below, so we might not even be opening a regular file. We
422 * supply flags to open to to guard against various conditions before
423 * we can perform an lstat to check that the file is still a regular
425 * - O_NOFOLLOW: in the event the file was replaced by a symlink
426 * - O_NONBLOCK: prevents open() from blocking if the file was
428 * We also add in O_NOATIME, since this may reduce disk writes (for
429 * inode updates). However, O_NOATIME may result in EPERM, so if the
430 * initial open fails, try again without O_NOATIME. */
431 fd = open(true_path.c_str(), O_RDONLY|O_NOATIME|O_NOFOLLOW|O_NONBLOCK);
433 fd = open(true_path.c_str(), O_RDONLY|O_NOFOLLOW|O_NONBLOCK);
436 fprintf(stderr, "Unable to open file %s: %m\n", path.c_str());
440 /* Drop the use of the O_NONBLOCK flag; we only wanted that for file
442 flags = fcntl(fd, F_GETFL);
443 fcntl(fd, F_SETFL, flags & ~O_NONBLOCK);
445 /* Perform the stat call again, and check that we still have a regular
447 if (fstat(fd, &stat_buf) < 0) {
448 fprintf(stderr, "fstat: %m\n");
453 if ((stat_buf.st_mode & S_IFMT) != S_IFREG) {
454 fprintf(stderr, "file is no longer a regular file!\n");
460 dump_inode(path, true_path, stat_buf, fd);
465 // If we hit a directory, now that we've written the directory itself,
466 // recursively scan the directory.
467 if ((stat_buf.st_mode & S_IFMT) == S_IFDIR) {
468 DIR *dir = opendir(true_path.c_str());
471 fprintf(stderr, "Error: %m\n");
476 vector<string> contents;
477 while ((ent = readdir(dir)) != NULL) {
478 string filename(ent->d_name);
479 if (filename == "." || filename == "..")
481 contents.push_back(filename);
486 sort(contents.begin(), contents.end());
488 for (vector<string>::iterator i = contents.begin();
489 i != contents.end(); ++i) {
490 const string& filename = *i;
492 scanfile(filename, include);
494 scanfile(path + "/" + filename, include);
499 /* Include the specified file path in the backups. Append the path to the
500 * includes list, and to ensure that we actually see the path when scanning the
501 * directory tree, add all the parent directories to the search list, which
502 * means we will scan through the directory listing even if the files
503 * themselves are excluded from being backed up. */
504 void add_include(const char *path)
506 printf("Add: %s\n", path);
507 /* Was an absolute path specified? If so, we'll need to start scanning
508 * from the root directory. Make sure that the user was consistent in
509 * providing either all relative paths or all absolute paths. */
510 if (path[0] == '/') {
511 if (includes.size() > 0 && relative_paths == true) {
513 "Error: Cannot mix relative and absolute paths!\n");
517 relative_paths = false;
519 // Skip over leading '/'
521 } else if (relative_paths == false && path[0] != '/') {
522 fprintf(stderr, "Error: Cannot mix relative and absolute paths!\n");
526 includes.push_back(path);
528 /* Split the specified path into directory components, and ensure that we
529 * descend into all the directories along the path. */
530 const char *slash = path;
535 while ((slash = strchr(slash + 1, '/')) != NULL) {
536 string component(path, slash - path);
537 searches.push_back(component);
541 void usage(const char *program)
546 "Usage: %s [OPTION]... --dest=DEST PATHS...\n"
547 "Produce backup snapshot of files in SOURCE and store to DEST.\n"
550 " --dest=PATH path where backup is to be written [REQUIRED]\n"
551 " --exclude=PATH exclude files in PATH from snapshot\n"
552 " --localdb=PATH local backup metadata is stored in PATH\n"
553 " --filter=COMMAND program through which to filter segment data\n"
554 " (defaults to \"bzip2 -c\")\n"
555 " --filter-extension=EXT\n"
556 " string to append to segment files\n"
557 " (defaults to \".bz2\")\n"
558 " --signature-filter=COMMAND\n"
559 " program though which to filter descriptor\n"
560 " --scheme=NAME optional name for this snapshot\n",
565 int main(int argc, char *argv[])
567 string backup_dest = "";
568 string localdb_dir = "";
569 string backup_scheme = "";
570 string signature_filter = "";
573 static struct option long_options[] = {
574 {"localdb", 1, 0, 0}, // 0
575 {"exclude", 1, 0, 0}, // 1
576 {"filter", 1, 0, 0}, // 2
577 {"filter-extension", 1, 0, 0}, // 3
578 {"dest", 1, 0, 0}, // 4
579 {"scheme", 1, 0, 0}, // 5
580 {"signature-filter", 1, 0, 0}, // 6
585 int c = getopt_long(argc, argv, "", long_options, &long_index);
591 switch (long_index) {
593 localdb_dir = optarg;
596 if (optarg[0] != '/')
597 excludes.push_back(optarg);
599 excludes.push_back(optarg + 1);
602 filter_program = optarg;
604 case 3: // --filter-extension
605 filter_extension = optarg;
608 backup_dest = optarg;
611 backup_scheme = optarg;
613 case 6: // --signature-filter
614 signature_filter = optarg;
617 fprintf(stderr, "Unhandled long option!\n");
626 if (optind == argc) {
631 searches.push_back(".");
632 for (int i = optind; i < argc; i++)
633 add_include(argv[i]);
635 if (backup_dest == "") {
637 "Error: Backup destination must be specified with --dest=\n");
642 // Default for --localdb is the same as --dest
643 if (localdb_dir == "") {
644 localdb_dir = backup_dest;
647 // Dump paths for debugging/informational purposes
649 list<string>::const_iterator i;
651 printf("LBS Version: %s\n", lbs_version);
653 printf("--dest=%s\n--localdb=%s\n\n",
654 backup_dest.c_str(), localdb_dir.c_str());
656 printf("Includes:\n");
657 for (i = includes.begin(); i != includes.end(); ++i)
658 printf(" %s\n", i->c_str());
660 printf("Excludes:\n");
661 for (i = excludes.begin(); i != excludes.end(); ++i)
662 printf(" %s\n", i->c_str());
664 printf("Searching:\n");
665 for (i = searches.begin(); i != searches.end(); ++i)
666 printf(" %s\n", i->c_str());
669 block_buf = new char[LBS_BLOCK_SIZE];
671 /* Store the time when the backup started, so it can be included in the
677 localtime_r(&now, &time_buf);
678 strftime(desc_buf, sizeof(desc_buf), "%Y%m%dT%H%M%S", &time_buf);
680 /* Open the local database which tracks all objects that are stored
681 * remotely, for efficient incrementals. Provide it with the name of this
683 string database_path = localdb_dir + "/localdb.sqlite";
685 db->Open(database_path.c_str(), desc_buf,
686 backup_scheme.size() ? backup_scheme.c_str() : NULL);
688 tss = new TarSegmentStore(backup_dest, db);
690 /* Initialize the stat cache, for skipping over unchanged files. */
691 metawriter = new MetadataWriter(tss, localdb_dir.c_str(), desc_buf,
693 ? backup_scheme.c_str()
696 scanfile(".", false);
698 ObjectReference root_ref = metawriter->close();
699 add_segment(root_ref.get_segment());
700 string backup_root = root_ref.to_string();
708 /* Write out a checksums file which lists the checksums for all the
709 * segments included in this snapshot. The format is designed so that it
710 * may be easily verified using the sha1sums command. */
711 const char csum_type[] = "sha1";
712 string checksum_filename = backup_dest + "/snapshot-";
713 if (backup_scheme.size() > 0)
714 checksum_filename += backup_scheme + "-";
715 checksum_filename = checksum_filename + desc_buf + "." + csum_type + "sums";
716 FILE *checksums = fopen(checksum_filename.c_str(), "w");
717 if (checksums != NULL) {
718 for (std::set<string>::iterator i = segment_list.begin();
719 i != segment_list.end(); ++i) {
720 string seg_path, seg_csum;
721 if (db->GetSegmentChecksum(*i, &seg_path, &seg_csum)) {
722 const char *raw_checksum = NULL;
723 if (strncmp(seg_csum.c_str(), csum_type,
724 strlen(csum_type)) == 0) {
725 raw_checksum = seg_csum.c_str() + strlen(csum_type);
726 if (*raw_checksum == '=')
732 if (raw_checksum != NULL)
733 fprintf(checksums, "%s *%s\n",
734 raw_checksum, seg_path.c_str());
739 fprintf(stderr, "ERROR: Unable to write checksums file: %m\n");
744 /* Write a backup descriptor file, which says which segments are needed and
745 * where to start to restore this snapshot. The filename is based on the
746 * current time. If a signature filter program was specified, filter the
747 * data through that to give a chance to sign the descriptor contents. */
748 string desc_filename = backup_dest + "/snapshot-";
749 if (backup_scheme.size() > 0)
750 desc_filename += backup_scheme + "-";
751 desc_filename = desc_filename + desc_buf + ".lbs";
753 int descriptor_fd = open(desc_filename.c_str(), O_WRONLY | O_CREAT, 0666);
754 if (descriptor_fd < 0) {
755 fprintf(stderr, "Unable to open descriptor output file: %m\n");
758 pid_t signature_pid = 0;
759 if (signature_filter.size() > 0) {
760 int new_fd = spawn_filter(descriptor_fd, signature_filter.c_str(),
762 close(descriptor_fd);
763 descriptor_fd = new_fd;
765 FILE *descriptor = fdopen(descriptor_fd, "w");
767 fprintf(descriptor, "Format: LBS Snapshot v0.6\n");
768 fprintf(descriptor, "Producer: LBS %s\n", lbs_version);
769 strftime(desc_buf, sizeof(desc_buf), "%Y-%m-%d %H:%M:%S %z", &time_buf);
770 fprintf(descriptor, "Date: %s\n", desc_buf);
771 if (backup_scheme.size() > 0)
772 fprintf(descriptor, "Scheme: %s\n", backup_scheme.c_str());
773 fprintf(descriptor, "Root: %s\n", backup_root.c_str());
775 SHA1Checksum checksum_csum;
776 if (checksum_csum.process_file(checksum_filename.c_str())) {
777 string csum = checksum_csum.checksum_str();
778 fprintf(descriptor, "Checksums: %s\n", csum.c_str());
781 fprintf(descriptor, "Segments:\n");
782 for (std::set<string>::iterator i = segment_list.begin();
783 i != segment_list.end(); ++i) {
784 fprintf(descriptor, " %s\n", i->c_str());
791 waitpid(signature_pid, &status, 0);
793 if (!WIFEXITED(status) || WEXITSTATUS(status) != 0) {
794 throw IOException("Signature filter process error");