Differentiate between never-before-seen objects and seen-but-expired.
[cumulus.git] / scandir.cc
index c8a4180..aa7ce53 100644 (file)
@@ -1,24 +1,29 @@
 /* Recursively descend the filesystem and visit each file. */
 
-#include <stdio.h>
-#include <stdlib.h>
-#include <stdint.h>
 #include <dirent.h>
 #include <errno.h>
 #include <fcntl.h>
-#include <sys/types.h>
+#include <getopt.h>
+#include <grp.h>
+#include <pwd.h>
+#include <stdint.h>
+#include <stdio.h>
+#include <stdlib.h>
 #include <sys/stat.h>
+#include <sys/types.h>
 #include <unistd.h>
 
 #include <algorithm>
-#include <string>
-#include <list>
-#include <vector>
+#include <fstream>
 #include <iostream>
-#include <sstream>
+#include <list>
 #include <set>
+#include <sstream>
+#include <string>
+#include <vector>
 
 #include "format.h"
+#include "localdb.h"
 #include "store.h"
 #include "sha1.h"
 
@@ -30,9 +35,15 @@ using std::ostream;
 static TarSegmentStore *tss = NULL;
 
 /* Buffer for holding a single block of data read from a file. */
-static const int LBS_BLOCK_SIZE = 1024 * 1024;
+static const size_t LBS_BLOCK_SIZE = 1024 * 1024;
 static char *block_buf;
 
+static const size_t LBS_METADATA_BLOCK_SIZE = 65536;
+
+/* Local database, which tracks objects written in this and previous
+ * invocations to help in creating incremental snapshots. */
+LocalDb *db;
+
 /* Contents of the root object.  This will contain a set of indirect links to
  * the metadata objects. */
 std::ostringstream metadata_root;
@@ -45,6 +56,9 @@ std::set<string> segment_list;
 
 void scandir(const string& path);
 
+/* Selection of files to include/exclude in the snapshot. */
+std::list<string> excludes;
+
 /* Ensure contents of metadata are flushed to an object. */
 void metadata_flush()
 {
@@ -95,8 +109,9 @@ size_t file_read(int fd, char *buf, size_t maxlen)
 }
 
 /* Read the contents of a file (specified by an open file descriptor) and copy
- * the data to the store. */
-void dumpfile(int fd, dictionary &file_info)
+ * the data to the store.  Returns the size of the file (number of bytes
+ * dumped), or -1 on error. */
+int64_t dumpfile(int fd, dictionary &file_info)
 {
     struct stat stat_buf;
     fstat(fd, &stat_buf);
@@ -104,8 +119,8 @@ void dumpfile(int fd, dictionary &file_info)
     list<string> object_list;
 
     if ((stat_buf.st_mode & S_IFMT) != S_IFREG) {
-        printf("file is no longer a regular file!\n");
-        return;
+        fprintf(stderr, "file is no longer a regular file!\n");
+        return -1;
     }
 
     /* The index data consists of a sequence of pointers to the data blocks
@@ -120,15 +135,40 @@ void dumpfile(int fd, dictionary &file_info)
 
         hash.process(block_buf, bytes);
 
-        // tarstore processing
-        LbsObject *o = new LbsObject;
-        o->set_group("data");
-        o->set_data(block_buf, bytes);
-        o->write(tss);
-        object_list.push_back(o->get_name());
-        segment_list.insert(o->get_ref().get_segment());
-        delete o;
+        // Either find a copy of this block in an already-existing segment, or
+        // index it so it can be re-used in the future
+        SHA1Checksum block_hash;
+        block_hash.process(block_buf, bytes);
+        string block_csum = block_hash.checksum_str();
+        ObjectReference ref = db->FindObject(block_csum, bytes);
+
+        // Store a copy of the object if one does not yet exist
+        if (ref.get_segment().size() == 0) {
+            LbsObject *o = new LbsObject;
+
+            /* We might still have seen this checksum before, if the object was
+             * stored at some time in the past, but we have decided to clean
+             * the segment the object was originally stored in (FindObject will
+             * not return such objects).  When rewriting the object contents,
+             * put it in a separate group, so that old objects get grouped
+             * together.  The hope is that these old objects will continue to
+             * be used in the future, and we obtain segments which will
+             * continue to be well-utilized. */
+            if (db->IsOldObject(block_csum, bytes))
+                o->set_group("compacted");
+            else
+                o->set_group("data");
+
+            o->set_data(block_buf, bytes);
+            o->write(tss);
+            ref = o->get_ref();
+            db->StoreObject(ref, block_csum, bytes);
+            delete o;
+        }
 
+        object_list.push_back(ref.to_string());
+        segment_list.insert(ref.get_segment());
+        db->UseObject(ref);
         size += bytes;
     }
 
@@ -161,6 +201,8 @@ void dumpfile(int fd, dictionary &file_info)
         segment_list.insert(i->get_ref().get_segment());
         delete i;
     }
+
+    return size;
 }
 
 void scanfile(const string& path)
@@ -170,26 +212,43 @@ void scanfile(const string& path)
     struct stat stat_buf;
     char *buf;
     ssize_t len;
+    int64_t file_size;
     list<string> refs;
 
     // Set to true if the item is a directory and we should recursively scan
     bool recurse = false;
 
+    // Check this file against the include/exclude list to see if it should be
+    // considered
+    for (list<string>::iterator i = excludes.begin();
+         i != excludes.end(); ++i) {
+        if (path == *i) {
+            printf("Excluding %s\n", path.c_str());
+            return;
+        }
+    }
+
     dictionary file_info;
 
     lstat(path.c_str(), &stat_buf);
 
     printf("%s\n", path.c_str());
 
-    metadata << "name: " << uri_encode(path) << "\n";
-
     file_info["mode"] = encode_int(stat_buf.st_mode & 07777);
-    file_info["atime"] = encode_int(stat_buf.st_atime);
-    file_info["ctime"] = encode_int(stat_buf.st_ctime);
     file_info["mtime"] = encode_int(stat_buf.st_mtime);
     file_info["user"] = encode_int(stat_buf.st_uid);
     file_info["group"] = encode_int(stat_buf.st_gid);
 
+    struct passwd *pwd = getpwuid(stat_buf.st_uid);
+    if (pwd != NULL) {
+        file_info["user"] += " (" + uri_encode(pwd->pw_name) + ")";
+    }
+
+    struct group *grp = getgrgid(stat_buf.st_gid);
+    if (pwd != NULL) {
+        file_info["group"] += " (" + uri_encode(grp->gr_name) + ")";
+    }
+
     char inode_type;
 
     switch (stat_buf.st_mode & S_IFMT) {
@@ -214,16 +273,14 @@ void scanfile(const string& path)
         buf = new char[stat_buf.st_size + 2];
         len = readlink(path.c_str(), buf, stat_buf.st_size + 1);
         if (len < 0) {
-            printf("error reading symlink: %m\n");
+            fprintf(stderr, "error reading symlink: %m\n");
         } else if (len <= stat_buf.st_size) {
             buf[len] = '\0';
-            printf("    contents=%s\n", buf);
+            file_info["contents"] = uri_encode(buf);
         } else if (len > stat_buf.st_size) {
-            printf("error reading symlink: name truncated\n");
+            fprintf(stderr, "error reading symlink: name truncated\n");
         }
 
-        file_info["contents"] = uri_encode(buf);
-
         delete[] buf;
         break;
     case S_IFREG:
@@ -239,18 +296,34 @@ void scanfile(const string& path)
          *   - O_NONBLOCK: prevents open() from blocking if the file was
          *     replaced by a fifo
          * We also add in O_NOATIME, since this may reduce disk writes (for
-         * inode updates). */
+         * inode updates).  However, O_NOATIME may result in EPERM, so if the
+         * initial open fails, try again without O_NOATIME.  */
         fd = open(path.c_str(), O_RDONLY|O_NOATIME|O_NOFOLLOW|O_NONBLOCK);
+        if (fd < 0) {
+            fd = open(path.c_str(), O_RDONLY|O_NOFOLLOW|O_NONBLOCK);
+        }
+        if (fd < 0) {
+            fprintf(stderr, "Unable to open file %s: %m\n", path.c_str());
+            return;
+        }
 
         /* Drop the use of the O_NONBLOCK flag; we only wanted that for file
          * open. */
         flags = fcntl(fd, F_GETFL);
         fcntl(fd, F_SETFL, flags & ~O_NONBLOCK);
 
-        file_info["size"] = encode_int(stat_buf.st_size);
-        dumpfile(fd, file_info);
+        file_size = dumpfile(fd, file_info);
+        file_info["size"] = encode_int(file_size);
         close(fd);
 
+        if (file_size < 0)
+            return;             // error occurred; do not dump file
+
+        if (file_size != stat_buf.st_size) {
+            fprintf(stderr, "Warning: Size of %s changed during reading\n",
+                    path.c_str());
+        }
+
         break;
     case S_IFDIR:
         inode_type = 'd';
@@ -263,13 +336,13 @@ void scanfile(const string& path)
     }
 
     file_info["type"] = string(1, inode_type);
-    metadata << "type: " << inode_type << "\n";
 
+    metadata << "name: " << uri_encode(path) << "\n";
     dict_output(metadata, file_info);
     metadata << "\n";
 
     // Break apart metadata listing if it becomes too large.
-    if (metadata.str().size() > 4096)
+    if (metadata.str().size() > LBS_METADATA_BLOCK_SIZE)
         metadata_flush();
 
     // If we hit a directory, now that we've written the directory itself,
@@ -283,7 +356,7 @@ void scandir(const string& path)
     DIR *dir = opendir(path.c_str());
 
     if (dir == NULL) {
-        printf("Error: %m\n");
+        fprintf(stderr, "Error: %m\n");
         return;
     }
 
@@ -301,22 +374,101 @@ void scandir(const string& path)
     for (vector<string>::iterator i = contents.begin();
          i != contents.end(); ++i) {
         const string& filename = *i;
-        scanfile(path + "/" + filename);
+        if (path == ".")
+            scanfile(filename);
+        else
+            scanfile(path + "/" + filename);
     }
 
     closedir(dir);
 }
 
+void usage(const char *program)
+{
+    fprintf(stderr,
+            "Usage: %s [OPTION]... SOURCE DEST\n"
+            "Produce backup snapshot of files in SOURCE and store to DEST.\n"
+            "\n"
+            "Options:\n"
+            "  --exclude=PATH       exclude files in PATH from snapshot\n"
+            "  --localdb=PATH       local backup metadata is stored in PATH\n",
+            program);
+}
+
 int main(int argc, char *argv[])
 {
-    block_buf = new char[LBS_BLOCK_SIZE];
+    string backup_source = ".";
+    string backup_dest = ".";
+    string localdb_dir = "";
 
-    if (argc > 1) {
-        tss = new TarSegmentStore(argv[1]);
-    } else {
-        tss = new TarSegmentStore(".");
+    while (1) {
+        static struct option long_options[] = {
+            {"localdb", 1, 0, 0},   // 0
+            {"exclude", 1, 0, 0},   // 1
+            {NULL, 0, 0, 0},
+        };
+
+        int long_index;
+        int c = getopt_long(argc, argv, "", long_options, &long_index);
+
+        if (c == -1)
+            break;
+
+        if (c == 0) {
+            switch (long_index) {
+            case 0:     // --localdb
+                localdb_dir = optarg;
+                break;
+            case 1:     // --exclude
+                excludes.push_back(optarg);
+                break;
+            default:
+                fprintf(stderr, "Unhandled long option!\n");
+                return 1;
+            }
+        } else {
+            usage(argv[0]);
+            return 1;
+        }
     }
 
+    if (argc < optind + 2) {
+        usage(argv[0]);
+        return 1;
+    }
+
+    backup_source = argv[optind];
+    backup_dest = argv[argc - 1];
+
+    if (localdb_dir == "") {
+        localdb_dir = backup_dest;
+    }
+
+    printf("Source: %s, Dest: %s\n",
+           backup_source.c_str(), backup_dest.c_str());
+
+    tss = new TarSegmentStore(backup_dest);
+    block_buf = new char[LBS_BLOCK_SIZE];
+
+    /* Write a backup descriptor file, which says which segments are needed and
+     * where to start to restore this snapshot.  The filename is based on the
+     * current time. */
+    time_t now;
+    struct tm time_buf;
+    char desc_buf[256];
+    time(&now);
+    localtime_r(&now, &time_buf);
+    strftime(desc_buf, sizeof(desc_buf), "%Y%m%dT%H%M%S", &time_buf);
+    string desc_filename = backup_dest + "/" + desc_buf + ".lbs";
+    std::ofstream descriptor(desc_filename.c_str());
+
+    /* Open the local database which tracks all objects that are stored
+     * remotely, for efficient incrementals.  Provide it with the name of this
+     * snapshot. */
+    string database_path = backup_dest + "/localdb.sqlite";
+    db = new LocalDb;
+    db->Open(database_path.c_str(), desc_buf);
+
     try {
         scanfile(".");
     } catch (IOException e) {
@@ -333,16 +485,20 @@ int main(int argc, char *argv[])
     root->checksum();
 
     segment_list.insert(root->get_ref().get_segment());
-    string r = root->get_ref().to_string();
-    printf("root: %s\n\n", r.c_str());
+    descriptor << "Root: " << root->get_ref().to_string() << "\n";
+    strftime(desc_buf, sizeof(desc_buf), "%Y-%m-%d %H:%M:%S %z", &time_buf);
+    descriptor << "Date: " << desc_buf << "\n";
+
     delete root;
 
-    printf("segments:\n");
+    descriptor << "Segments:\n";
     for (std::set<string>::iterator i = segment_list.begin();
          i != segment_list.end(); ++i) {
-        printf("    %s\n", i->c_str());
+        descriptor << "    " << *i << "\n";
     }
 
+    db->Close();
+
     tss->sync();
     delete tss;