minor editing and document fusedisk
[rrq/fusefile.git] / fusefile.c
index 59dcaa5fb746b13f90098c69c7e278b21b73490e..eeb0e72789f1e322b52419b2fcd04ebf3b995fc1 100644 (file)
 #include <time.h>
 #include <errno.h>
 
+struct Region {
+    off_t beg;
+    off_t end;
+};
+
 struct Source {
     char *filename;
     ssize_t from;
     ssize_t to;
     ssize_t start; // starting position in concatenated file
     int fd;
+    int dirty;
 };
 
 static struct {
@@ -53,7 +59,224 @@ static struct {
     time_t mtime;
     time_t ctime;
 } times;
-    
+
+/**
+ * Overlay
+ */
+static struct {
+    struct Source source;
+    struct Region *table;
+    size_t count;
+    size_t limit;
+} overlay;
+
+static void usage();
+
+/**
+ * Find the nearest overlay.table region below pos. Returns the index,
+ * or -1 if there is none, i.e. pos < overlay.table[0].
+ */
+static ssize_t overlay_prior_fragment(off_t pos) {
+    size_t lo = 0, hi = overlay.count;
+    while ( lo < hi ) {
+       size_t m = ( lo + hi ) / 2;
+       if ( m == lo ) {
+           return overlay.table[m].beg <= pos? m : -1;
+       }
+       if ( overlay.table[m].beg <= pos ) {
+           lo = m;
+       } else {
+           hi = m;
+       }
+    }
+    return -1;
+}
+
+/**
+ * Save the entry count for overlay.table as 64-bit integer
+ * immediately following the overlay content at the index
+ * corresponding to the fused file size.
+ */
+static void overlay_save_count() {
+    lseek( overlay.source.fd, overlay.source.to, SEEK_SET );
+    size_t size = sizeof( overlay.count );
+    char *p = (char *) &overlay.count ;
+    while ( size > 0 ) {
+       size_t n = write( overlay.source.fd, p, size );
+       if ( n < 0 ) {
+           perror( overlay.source.filename );
+           exit( 1 );
+       }
+       size -= n;
+       p += n;
+    }
+    if ( overlay.source.dirty++ > 1000 ) {
+       fsync( overlay.source.fd );
+       overlay.source.dirty = 0;
+    }
+}
+
+/**
+ * Update the on-disk cache of overlay.table between the given
+ * indexes. The table is laid out immediately following the table
+ * count with each region saved as two 64-bit unsigned integers.
+ */
+static void overlay_save_table(size_t lo,size_t hi) {
+    char *p = (char *) &overlay.table[ lo ];
+    size_t pos =  overlay.source.to + sizeof( overlay.count ) +
+       lo * sizeof( struct Region );
+    size_t size = ( hi - lo ) * sizeof( struct Region );
+    if ( pos != lseek( overlay.source.fd, pos, SEEK_SET ) ) {
+       fprintf( stderr, "%s: seek error\n", overlay.source.filename );
+       exit( 1 );
+    }
+    while ( size > 0 ) {
+       size_t n = write( overlay.source.fd, p, size );
+       if ( n < 0 ) {
+           perror( overlay.source.filename );
+           exit( 1 );
+       }
+       size -= n;
+       p += n;
+    }
+    if ( overlay.source.dirty++ > 1000 ) {
+       fsync( overlay.source.fd );
+       overlay.source.dirty = 0;
+    }
+}
+
+/**
+ * Insert a new region at index p, with previous portion [p,count]
+ * moved up to make space.
+ */
+static void overlay_insert(size_t p,off_t beg,off_t end) {
+    size_t bytes;
+    // Grow the table if needed
+    if ( overlay.count >= overlay.limit ) {
+       overlay.limit = overlay.count + 10;
+       bytes = overlay.limit * sizeof( struct Region );
+       overlay.table = overlay.table?
+           realloc( overlay.table, bytes ) : malloc( bytes );
+    }
+    bytes = ( overlay.count++ - p ) * sizeof( struct Region );
+    if ( bytes ) {
+       memmove( (char*) &overlay.table[ p+1 ],
+                (char*) &overlay.table[ p ],
+                bytes );
+    }
+    overlay.table[ p ].beg = beg;
+    overlay.table[ p ].end = end;
+    overlay_save_count();
+}
+
+/**
+ * Delete the region entry at p by moving the portion [p+1,count]
+ * down.
+ */
+static void overlay_delete(size_t p) {
+    size_t bytes = ( --overlay.count - p ) * sizeof( struct Region );
+    if ( bytes ) {
+       memmove( (char*) &overlay.table[ p ],
+                (char*) &overlay.table[ p+1 ],
+                bytes );
+    }
+}
+
+/**
+ * Mark the given region as updated, i.e. written to the overlay. The
+ * mark region may attach to prior marked regions or be a new,
+ * separate region. If attaching, it causes the prior regions to
+ * expand and the table adjusted by deleting any regions that become
+ * fully contained in other regions.
+ */
+static void overlay_mark(off_t beg,off_t end) {
+#if DEBUG
+    fprintf( stderr, "overlay_mark( %ld, %ld )\n", beg, end );
+#endif
+    int deleted = 0;
+    ssize_t q;
+    ssize_t p = overlay_prior_fragment( beg );
+    // p is the nearest region below or at beg (or -1)
+    if ( p >= 0 && beg <= overlay.table[p].end ) {
+       // p overlaps mark region
+       if ( end <= overlay.table[p].end ) {
+           // region p covers mark region already
+#if DEBUG
+           fprintf( stderr, "overlay covering ( %ld %ld )\n",
+                    overlay.table[p].beg, overlay.table[p].end );
+#endif
+           return;
+       }
+       // the new mark region extends region p
+       overlay.table[p].end = end;
+       q = p+1;
+       while ( q < overlay.count &&
+               overlay.table[q].beg <= overlay.table[p].end ) {
+           // Extended region merges with subsequent region
+           if ( overlay.table[p].end < overlay.table[q].end ) {
+               overlay.table[p].end = overlay.table[q].end;
+           }
+           overlay_delete( q );
+           deleted++;
+       }
+       if ( deleted ) {
+           overlay_save_count();
+           q = overlay.count;
+       }
+       overlay_save_table( p, q );
+#if DEBUG
+       fprintf( stderr, "overlay expand ( %ld %ld ) deleted %d\n",
+                overlay.table[p].beg, overlay.table[p].end, deleted );
+#endif
+       return;
+    }
+    // The prior region p does not expand into new mark region
+    p++; // subsequent region 
+    if ( p >= overlay.count || end < overlay.table[p].beg ) {
+       // New mark region is a separate region at p
+       overlay_insert( p, beg, end );
+#if DEBUG
+       fprintf( stderr, "overlay new ( %ld %ld )\n",
+                overlay.table[p].beg, overlay.table[p].end );
+#endif
+       overlay_save_table( p, overlay.count );
+       return;
+    }
+    // New marks start before and overlap with region p => change p
+    // and handle any subsequent regions being covered
+    overlay.table[p].beg = beg;
+    q = p+1;
+    if ( overlay.table[p].end < end ) {
+       overlay.table[p].end = end;
+       while ( q < overlay.count &&
+               overlay.table[q].beg <= overlay.table[p].end ) {
+           if ( overlay.table[p].end < overlay.table[q].end ) {
+               overlay.table[p].end = overlay.table[q].end;
+           }
+           overlay_delete( q );
+           deleted++;
+       }
+       if ( deleted ) {
+           overlay_save_count();
+           q = overlay.count;
+       }
+    }
+    overlay_save_table( p, q );
+#if DEBUG
+    fprintf( stderr, "overlay before ( %ld %ld ) deleted %d\n",
+            overlay.table[p].beg, overlay.table[p].end, deleted );
+#endif
+}
+
+static void setup_overlay(char *filename) {
+    overlay.source.filename = filename;
+    overlay.source.fd = open( filename, O_RDWR | O_CREAT, S_IRUSR | S_IWUSR );
+    if ( overlay.source.fd < 0 ) {
+       perror( filename );
+       usage();
+    }
+}
+
 #if DEBUG
 static void print_source(struct Source *p) {
     fprintf( stderr, "%p { %s, %ld, %ld, %ld, %d }\n",
@@ -225,6 +448,37 @@ static int find_source(off_t offset) {
     return lo;
 }
 
+static int overlay_merge(char *buf,off_t beg,off_t end) {
+#if DEBUG
+    fprintf( stderr, "merge %ld %ld\n", beg, end );
+#endif
+    // Find nearest overlay data before or at beg
+    ssize_t p = overlay_prior_fragment( beg );
+    if ( p < 0 ) {
+       p = 0;
+    }
+    for ( ; p < overlay.count && overlay.table[p].beg < end; p++ ) {
+       if ( overlay.table[p].end < beg ) {
+           continue;
+       }
+       if ( overlay.table[p].beg > beg ) {
+           size_t delta = overlay.table[p].beg - beg;
+           buf += delta;
+           beg += delta;
+       }
+       size_t size = ( overlay.table[p].end <= end )?
+           ( overlay.table[p].end - beg ) : ( end - beg ); 
+       lseek( overlay.source.fd, beg, SEEK_SET );
+       while ( size > 0 ) {
+           size_t n = read( overlay.source.fd, buf, size );
+           size -= n;
+           buf += n;
+           beg += n; //
+       }
+    }
+    return 0;
+}
+
 // Read <size> bytes from <offset> in file
 static int fusefile_read(const char *path, char *buf, size_t size,
                         off_t off, struct fuse_file_info *fi)
@@ -259,6 +513,10 @@ static int fusefile_read(const char *path, char *buf, size_t size,
        if ( n > size ) {
            n = size;
        }
+       if ( sources.array[i].dirty ) {
+           fsync( sources.array[i].fd );
+           sources.array[i].dirty = 0;
+       }
 #if DEBUG
        fprintf( stderr, "  seek fd=%d to %ld\n", sources.array[i].fd, b );
 #endif
@@ -281,6 +539,16 @@ static int fusefile_read(const char *path, char *buf, size_t size,
        if ( r == 0 ) {
            break;
        }
+       if ( overlay.source.filename ) {
+           if ( overlay.source.dirty ) {
+               fsync( overlay.source.fd );
+               overlay.source.dirty = 0;
+           }
+           int x = overlay_merge( buf + rr, off + rr, off + rr + r );
+           if ( x ) {
+               return x;
+           }
+       }
        rr += r;
        off += r;
        size -= r;
@@ -309,6 +577,30 @@ int fusefile_poll(const char *path, struct fuse_file_info *fi,
     return 0;
 }
 
+static void overlay_load() {
+    lseek( overlay.source.fd, overlay.source.to, SEEK_SET );
+    size_t x = 0;
+    size_t size = sizeof( overlay.count );
+    if ( read( overlay.source.fd, &x, size ) != size ) {
+       return;
+    }
+#if DEBUG
+    fprintf( stderr, "overlay: %s with %ld regions\n",
+            overlay.source.filename, x );
+#endif
+    struct Region f = { 0, 0 };
+    size = sizeof( struct Region );
+    while ( x-- > 0 ) {
+       if ( read( overlay.source.fd, &f, size ) != size ) {
+           fprintf( stderr, "%s: bad meta data\n", overlay.source.filename );
+           exit( 1 );
+       }
+#if DEBUG
+       fprintf( stderr, "overlay region: %ld %ld\n", f.beg, f.end );
+#endif
+       overlay_mark( f.beg, f.end );
+    }
+}
 
 /**
  * Write a full block of data over the sources at the offset
@@ -317,12 +609,16 @@ static int write_block(off_t off,const char *buf,size_t size) {
 #if DEBUG
     fprintf( stderr, "write_block( %ld, ?, %ld )\n", off, size );
 #endif
+    if ( overlay.source.filename ) {
+       overlay_mark( off, off + size ); // Mark region as written
+    }
     while ( size > 0 ) {
        int index = find_source( off ); // index of source file
        if ( index < 0 ) {
            return -EIO; // past EOF
        }
-       struct Source *source = &sources.array[ index ];
+       struct Source *source = overlay.source.filename?
+           &overlay.source :  &sources.array[ index ];
        off_t from = off - source->start + source->from;
        off_t max = source->to - from;
        if ( lseek( source->fd, from, SEEK_SET ) < 0 ) {
@@ -340,6 +636,10 @@ static int write_block(off_t off,const char *buf,size_t size) {
            size -= n;
            off += n;
        }
+       if ( source->dirty++ >= 1000 ) {
+           fsync( source->fd );
+           source->dirty = 0;
+       }
     }
     return 0;
 }
@@ -403,6 +703,20 @@ static void fusefile_destroy(void *data) {
     }
 }
 
+static void fsync_all_dirty() {
+    int i = 0;
+    for ( ; i < sources.count; i++ ) {
+       if ( sources.array[i].dirty ) {
+           fsync( sources.array[i].fd );
+           sources.array[i].dirty = 0;
+       }
+    }
+    if ( overlay.source.filename && overlay.source.dirty ) {
+       fsync( overlay.source.fd );
+       overlay.source.dirty = 0;
+    }
+}
+
 static int fusefile_flush(const char *path, struct fuse_file_info *info) {
 #if DEBUG
     fprintf( stderr, "fusefile_flush( %s )\n", path );
@@ -410,6 +724,7 @@ static int fusefile_flush(const char *path, struct fuse_file_info *info) {
     if ( strcmp( path, "/" ) != 0 ) {
        return -ENOENT;
     }
+    fsync_all_dirty();
     return 0;
 }
 
@@ -430,6 +745,7 @@ static int fusefile_fsync(const char *path, int x, struct fuse_file_info *fi) {
     if ( strcmp( path, "/" ) != 0 ) {
        return -ENOENT;
     }
+    fsync_all_dirty();
     return 0;
 }
 
@@ -539,9 +855,22 @@ int main(int argc, char *argv[])
     }
     fuseargc = i;
     mnt = argv[ i++ ]; // First non-option argument is the mount pount
+    char *overlaytag = "-overlay:";
+    int overlaytagsize = strlen( overlaytag );
+    if ( strncmp( argv[i], overlaytag, overlaytagsize ) == 0 ) {
+       // consume "-overlay:filename"
+       setup_overlay( argv[i++] + overlaytagsize ); // Need a writable file
+       if ( i >= argc ) {
+           usage();
+       }
+    }
     if ( setup_sources( argv, i, argc-i ) ) {
        return 1;
     }
+    if ( overlay.source.filename ) {
+       overlay.source.to = sources.size; // Register total size.
+       overlay_load();
+    }
     if ( stat( mnt, &stbuf ) == -1 ) {
        int fd = open( mnt, O_CREAT | O_RDWR, S_IRUSR | S_IWUSR );
        if ( fd < 0 ) {