Updates to documentation and contributed scripts for name change.
[cumulus.git] / scandir.cc
index eb05243..24e3927 100644 (file)
@@ -1,4 +1,25 @@
-/* Recursively descend the filesystem and visit each file. */
+/* Cumulus: Smart Filesystem Backup to Dumb Servers
+ *
+ * Copyright (C) 2006-2008  The Regents of the University of California
+ * Written by Michael Vrable <mvrable@cs.ucsd.edu>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+/* Main entry point for LBS.  Contains logic for traversing the filesystem and
+ * constructing a backup. */
 
 #include <dirent.h>
 #include <errno.h>
@@ -29,6 +50,7 @@
 #include "remote.h"
 #include "store.h"
 #include "sha1.h"
+#include "subfile.h"
 #include "util.h"
 
 using std::list;
@@ -37,12 +59,12 @@ using std::vector;
 using std::ostream;
 
 /* Version information.  This will be filled in by the Makefile. */
-#ifndef LBS_VERSION
-#define LBS_VERSION Unknown
+#ifndef CUMULUS_VERSION
+#define CUMULUS_VERSION Unknown
 #endif
-#define LBS_STRINGIFY(s) LBS_STRINGIFY2(s)
-#define LBS_STRINGIFY2(s) #s
-static const char lbs_version[] = LBS_STRINGIFY(LBS_VERSION);
+#define CUMULUS_STRINGIFY(s) CUMULUS_STRINGIFY2(s)
+#define CUMULUS_STRINGIFY2(s) #s
+static const char cumulus_version[] = CUMULUS_STRINGIFY(CUMULUS_VERSION);
 
 static RemoteStore *remote = NULL;
 static TarSegmentStore *tss = NULL;
@@ -118,17 +140,23 @@ int64_t dumpfile(int fd, dictionary &file_info, const string &path,
 
     /* Look up this file in the old stat cache, if we can.  If the stat
      * information indicates that the file has not changed, do not bother
-     * re-reading the entire contents. */
+     * re-reading the entire contents.  Even if the information has been
+     * changed, we can use the list of old blocks in the search for a sub-block
+     * incremental representation. */
     bool cached = false;
+    list<ObjectReference> old_blocks;
 
-    if (metawriter->find(path) && metawriter->is_unchanged(&stat_buf)) {
+    bool found = metawriter->find(path);
+    if (found)
+        old_blocks = metawriter->get_blocks();
+
+    if (found && metawriter->is_unchanged(&stat_buf)) {
         cached = true;
-        list<ObjectReference> blocks = metawriter->get_blocks();
 
         /* If any of the blocks in the object have been expired, then we should
          * fall back to fully reading in the file. */
-        for (list<ObjectReference>::const_iterator i = blocks.begin();
-             i != blocks.end(); ++i) {
+        for (list<ObjectReference>::const_iterator i = old_blocks.begin();
+             i != old_blocks.end(); ++i) {
             const ObjectReference &ref = *i;
             if (!db->IsAvailable(ref)) {
                 cached = false;
@@ -140,8 +168,8 @@ int64_t dumpfile(int fd, dictionary &file_info, const string &path,
         /* If everything looks okay, use the cached information */
         if (cached) {
             file_info["checksum"] = metawriter->get_checksum();
-            for (list<ObjectReference>::const_iterator i = blocks.begin();
-                 i != blocks.end(); ++i) {
+            for (list<ObjectReference>::const_iterator i = old_blocks.begin();
+                 i != old_blocks.end(); ++i) {
                 const ObjectReference &ref = *i;
                 object_list.push_back(ref.to_string());
                 if (ref.is_normal())
@@ -156,6 +184,9 @@ int64_t dumpfile(int fd, dictionary &file_info, const string &path,
      * time. */
     if (!cached) {
         SHA1Checksum hash;
+        Subfile subfile(db);
+        subfile.load_old_blocks(old_blocks);
+
         while (true) {
             ssize_t bytes = file_read(fd, block_buf, LBS_BLOCK_SIZE);
             if (bytes == 0)
@@ -194,6 +225,8 @@ int64_t dumpfile(int fd, dictionary &file_info, const string &path,
                 ref = db->FindObject(block_csum, bytes);
             }
 
+            list<ObjectReference> refs;
+
             // Store a copy of the object if one does not yet exist
             if (ref.is_null()) {
                 LbsObject *o = new LbsObject;
@@ -226,18 +259,19 @@ int64_t dumpfile(int fd, dictionary &file_info, const string &path,
                     status = "new";
                 }
 
-                o->set_data(block_buf, bytes);
-                o->write(tss);
-                ref = o->get_ref();
-                db->StoreObject(ref, block_csum, bytes, block_age);
-                ref.set_range(0, bytes);
-                delete o;
+                subfile.analyze_new_block(block_buf, bytes);
+                refs = subfile.create_incremental(tss, o, block_age);
+            } else {
+                refs.push_back(ref);
             }
 
-            object_list.push_back(ref.to_string());
-            if (ref.is_normal())
-                add_segment(ref.get_segment());
-            db->UseObject(ref);
+            while (!refs.empty()) {
+                ref = refs.front(); refs.pop_front();
+                object_list.push_back(ref.to_string());
+                if (ref.is_normal())
+                    add_segment(ref.get_segment());
+                db->UseObject(ref);
+            }
             size += bytes;
 
             if (status == NULL)
@@ -394,7 +428,6 @@ void scanfile(const string& path, bool include)
     for (list<string>::iterator i = includes.begin();
          i != includes.end(); ++i) {
         if (path == *i) {
-            printf("Including %s\n", path.c_str());
             include = true;
         }
     }
@@ -402,7 +435,6 @@ void scanfile(const string& path, bool include)
     for (list<string>::iterator i = excludes.begin();
          i != excludes.end(); ++i) {
         if (path == *i) {
-            printf("Excluding %s\n", path.c_str());
             include = false;
         }
     }
@@ -410,7 +442,6 @@ void scanfile(const string& path, bool include)
     for (list<string>::iterator i = searches.begin();
          i != searches.end(); ++i) {
         if (path == *i) {
-            printf("Scanning %s\n", path.c_str());
             scan_only = true;
         }
     }
@@ -511,7 +542,6 @@ void scanfile(const string& path, bool include)
  * themselves are excluded from being backed up. */
 void add_include(const char *path)
 {
-    printf("Add: %s\n", path);
     /* Was an absolute path specified?  If so, we'll need to start scanning
      * from the root directory.  Make sure that the user was consistent in
      * providing either all relative paths or all absolute paths. */
@@ -550,7 +580,7 @@ void usage(const char *program)
 {
     fprintf(
         stderr,
-        "LBS %s\n\n"
+        "Cumulus %s\n\n"
         "Usage: %s [OPTION]... --dest=DEST PATHS...\n"
         "Produce backup snapshot of files in SOURCE and store to DEST.\n"
         "\n"
@@ -575,7 +605,7 @@ void usage(const char *program)
         "  --full-metadata      do not re-use metadata from previous backups\n"
         "\n"
         "Exactly one of --dest or --upload-script must be specified.\n",
-        lbs_version, program
+        cumulus_version, program
     );
 }
 
@@ -696,28 +726,6 @@ int main(int argc, char *argv[])
         return 1;
     }
 
-    // Dump paths for debugging/informational purposes
-    {
-        list<string>::const_iterator i;
-
-        printf("LBS Version: %s\n", lbs_version);
-
-        printf("--dest=%s\n--localdb=%s\n--upload-script=%s\n",
-               backup_dest.c_str(), localdb_dir.c_str(), backup_script.c_str());
-
-        printf("Includes:\n");
-        for (i = includes.begin(); i != includes.end(); ++i)
-            printf("    %s\n", i->c_str());
-
-        printf("Excludes:\n");
-        for (i = excludes.begin(); i != excludes.end(); ++i)
-            printf("    %s\n", i->c_str());
-
-        printf("Searching:\n");
-        for (i = searches.begin(); i != searches.end(); ++i)
-            printf("    %s\n", i->c_str());
-    }
-
     block_buf = new char[LBS_BLOCK_SIZE];
 
     /* Initialize the remote storage layer.  If using an upload script, create
@@ -750,17 +758,14 @@ int main(int argc, char *argv[])
      * snapshot. */
     string database_path = localdb_dir + "/localdb.sqlite";
     db = new LocalDb;
-    db->Open(database_path.c_str(), desc_buf,
-             backup_scheme.size() ? backup_scheme.c_str() : NULL,
+    db->Open(database_path.c_str(), desc_buf, backup_scheme.c_str(),
              snapshot_intent);
 
     tss = new TarSegmentStore(remote, db);
 
     /* Initialize the stat cache, for skipping over unchanged files. */
     metawriter = new MetadataWriter(tss, localdb_dir.c_str(), desc_buf,
-                                    backup_scheme.size()
-                                        ? backup_scheme.c_str()
-                                        : NULL);
+                                    backup_scheme.c_str());
 
     scanfile(".", false);
 
@@ -842,7 +847,7 @@ int main(int argc, char *argv[])
     FILE *descriptor = fdopen(descriptor_fd, "w");
 
     fprintf(descriptor, "Format: LBS Snapshot v0.6\n");
-    fprintf(descriptor, "Producer: LBS %s\n", lbs_version);
+    fprintf(descriptor, "Producer: Cumulus %s\n", cumulus_version);
     strftime(desc_buf, sizeof(desc_buf), "%Y-%m-%d %H:%M:%S %z", &time_buf);
     fprintf(descriptor, "Date: %s\n", desc_buf);
     if (backup_scheme.size() > 0)