2 fusefile - overlay a file path with a concatenation of parts of
3 other files, read only.
5 Copyright (C) 2019 Ralph Ronnquist
7 This program is free software: you can redistribute it and/or
8 modify it under the terms of the GNU General Public License as
9 published by the Free Software Foundation, either version 3 of the
10 License, or (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see
19 <http://www.gnu.org/licenses/>.
21 This source was inspired by the "null.c" example of the libfuse
22 sources, which is distributed under GPL2, and copyright (C)
23 2001-2007 Miklos Szeredi <miklos@szeredi.hu>.
26 #define FUSE_USE_VERSION 33
29 #include <fuse/fuse_lowlevel.h>
41 ssize_t start; // starting position in concatenated file
58 static void print_source(struct Source *p) {
59 fprintf( stderr, "%p { %s, %ld, %ld, %ld, %d }\n",
60 p, p->filename, p->from, p->to, p->start, p-> fd );
65 static unsigned int c;
66 static int RANGE(int s,int n ) {
67 return ( s == n ) && *(range+c) == 0;
70 static int setup_sources(char **argv,int i,int n) {
71 sources.array = calloc( n, sizeof( struct Source ) );
72 if ( sources.array == 0 ) {
78 for ( ; j < n; i++, j++ ) {
80 struct Source *p = sources.array + j;
81 // Open the fragment file rw if possible, else ro
82 range = strrchr( argv[i], '/' ); // last '/'
83 p->filename = range? strndup( argv[i], range - argv[i] ) : argv[i];
84 p->fd = open( p->filename, O_RDWR );
88 p->fd = open( p->filename, O_RDONLY );
91 perror( p->filename );
92 return 1; // Error return
94 if ( stat( p->filename, &filestat ) ) {
95 perror( p->filename );
99 fprintf( stderr, "** %s opened read-only\n", p->filename );
102 p->to = filestat.st_size;
103 // Process any range variation
104 if ( range && *(++range) ) {
107 } else if ( RANGE( sscanf( range, "%d:%d%n", &a, &b, &c ), 2 )) {
108 p->from = ( a < 0 )? ( p->to + a ) : a;
109 p->to = ( b < 0 )? ( p->to + b ) : b;
110 } else if ( RANGE( sscanf( range, "%d+%d%n", &a, &b, &c ), 2 )) {
111 p->from = ( a < 0 )? ( p->to + a ) : a;
112 p->to = ( ( b < 0 )? p->to : p->from ) + b;
113 } else if ( RANGE( sscanf( range, "%d+%n", &a, &c ), 1 )) {
114 p->from = ( a < 0 )? ( p->to + a ) : a;
115 } else if ( RANGE( sscanf( range, ":%d%n", &b, &c ), 1 )) {
116 p->to = ( b < 0 )? ( p->to + b ) : b;
117 } else if ( RANGE( sscanf( range, "%d:%n", &a, &c ), 1 )) {
118 p->from = ( a < 0 )? ( p->to + a ) : a;
119 } else if ( RANGE( sscanf( range, "%d%n", &a, &c ), 1 )) {
125 } else if ( RANGE( sscanf( range, ":%n", &c), 0 ) ) {
128 fprintf( stderr, "** BAD RANGE: %s\n", argv[i] );
132 if ( p->from >= p->to ||
133 p->from >= filestat.st_size || p->to > filestat.st_size ) {
134 fprintf( stderr, "** BAD RANGE: %s [%ld:%ld]\n",
135 argv[i], p->from, p->to );
138 p->start = sources.size; // the fusefile position of fragment
139 sources.size += p->to - p->from;
147 static int fusefile_getattr(const char *path,struct stat *stbuf) {
149 fprintf( stderr, "fusefile_getattr( %s )\n", path );
151 if ( strcmp( path, "/" ) != 0 ) {
155 fprintf( stderr, "getattr %ld\n", sources.size );
157 memset( stbuf, 0, sizeof( struct stat ) );
158 stbuf->st_mode = S_IFREG | 0644; // Hmmm
160 stbuf->st_size = sources.size;
161 stbuf->st_atime = times.atime;
162 stbuf->st_mtime = times.mtime;
163 stbuf->st_ctime = times.ctime;
164 stbuf->st_uid = getuid();
165 stbuf->st_gid = getgid();
169 static int fusefile_chmod(const char *path,mode_t m) {
171 fprintf( stderr, "fusefile_chmod( %s, %d )\n", path, m );
176 static int fusefile_open(const char *path,struct fuse_file_info *fi) {
178 fprintf( stderr, "fusefile_open( %s, %d )\n", path, fi->flags );
179 fprintf( stderr, "fixing( %d )\n", fi->flags | O_CLOEXEC );
181 if ( strcmp( path, "/" ) != 0 ) {
184 // set O-CLOEXEC for this opening?
185 times.atime = time( 0 );
189 static int find_source(off_t offset) {
191 int hi = sources.count;
192 if ( offset >= sources.size ) {
195 while ( lo + 1 < hi ) {
196 int m = ( lo + hi ) / 2;
197 if ( offset < sources.array[ m ].start ) {
206 // Read <size> bytes from <offset> in file
207 static int fusefile_read(const char *path, char *buf, size_t size,
208 off_t off, struct fuse_file_info *fi)
211 fprintf( stderr, "fusefile_read( %s )\n", path );
213 if( strcmp( path, "/" ) != 0 ) {
217 fprintf( stderr, "read %ld %ld\n", off, size );
222 fprintf( stderr, "find_source %ld %ld\n", off, size );
224 int i = find_source( off );
226 return ( off == sources.size )? rr : -ENOENT;
228 if ( sources.array[i].fd < 0 ) {
232 print_source( &sources.array[i] );
234 times.atime = time( 0 );
235 size_t b = off - sources.array[i].start + sources.array[i].from;
236 size_t n = sources.array[i].to - b;
240 if ( lseek( sources.array[i].fd, b, SEEK_SET ) < 0 ) {
241 perror( sources.array[i].filename );
245 fprintf( stderr, "get %ld bytes at %ld\n", n, rr );
247 ssize_t r = read( sources.array[i].fd, buf + rr, n );
249 fprintf( stderr, "got %ld bytes\n", r );
252 perror( sources.array[i].filename );
266 * Poll for IO readiness.
268 int fusefile_poll(const char *path, struct fuse_file_info *fi,
269 struct fuse_pollhandle *ph, unsigned *reventsp )
272 fprintf( stderr, "fusefile_poll( %s ) %p %d\n", path, ph, *reventsp );
274 if( strcmp( path, "/" ) != 0 ) {
278 return fuse_notify_poll( ph );
285 * Write a full block of data over the sources at the offset
287 static int write_block(off_t off,const char *buf,size_t size) {
289 fprintf( stderr, "write_block( %ld, ?, %ld )\n", off, size );
292 int index = find_source( off ); // index of source file
294 return -EIO; // past EOF
296 struct Source *source = &sources.array[ index ];
297 off_t from = off - source->start + source->from;
298 off_t max = source->to - from;
299 if ( lseek( source->fd, from, SEEK_SET ) < 0 ) {
302 ssize_t todo = ( size < max )? size : max;
304 times.mtime = time( 0 );
305 ssize_t n = write( source->fd, buf, todo );
307 return -EIO; // Something wrong
318 static int fusefile_write_buf(const char *path, struct fuse_bufvec *buf,
319 off_t off, struct fuse_file_info *fi) {
321 fprintf( stderr, "fusefile_write_buf( %s )\n", path );
323 if ( strcmp( path, "/" ) != 0 ) {
329 for ( i = 0; i < buf->count; i++ ) {
330 struct fuse_buf *p = &buf->buf[i];
331 if ( p->flags & FUSE_BUF_IS_FD ) {
333 fprintf( stderr, "Content held in a file ... HELP!!\n" );
337 if ( write_block( off, (char*) p->mem, p->size ) < 0 ) {
343 fprintf( stderr, "fusefile_write_buf written %ld\n", size );
349 * Write a fragment at <off>. This overwrites files.
351 static int fusefile_write(const char *path, const char *buf, size_t size,
352 off_t off, struct fuse_file_info *fi)
355 fprintf( stderr, "fusefile_write( %s %ld )\n", path, size );
357 if ( strcmp( path, "/" ) != 0 ) {
361 if ( write_block( off, buf, size ) < 0 ) {
367 static void fusefile_destroy(void *data) {
368 char *mnt = (char*) data; // As passed to fuse_main
370 fprintf( stderr, "fusefile_destroy( %s )\n", mnt? mnt : "" );
377 static int fusefile_flush(const char *path, struct fuse_file_info *info) {
379 fprintf( stderr, "fusefile_flush( %s )\n", path );
381 if ( strcmp( path, "/" ) != 0 ) {
387 static int fusefile_release(const char *path, struct fuse_file_info *fi) {
389 fprintf( stderr, "fusefile_release( %s, %d )\n", path, fi->flags );
391 if ( strcmp( path, "/" ) != 0 ) {
397 static int fusefile_fsync(const char *path, int x, struct fuse_file_info *fi) {
399 fprintf( stderr, "fusefile_fsync( %s, %d )\n", path, x );
401 if ( strcmp( path, "/" ) != 0 ) {
410 static int fusefile_truncate(const char *path, off_t len) {
412 fprintf( stderr, "fusefile_truncate( %s, %ld )\n", path, len );
414 if ( strcmp( path, "/" ) != 0 ) {
420 void *fusefile_init(struct fuse_conn_info *fci) {
422 fprintf( stderr, "fusefile_init( %d, %d )\n", fci->async_read, fci->want );
424 // Disable asynchronous reading
426 fci->want &= ~FUSE_CAP_ASYNC_READ;
428 fprintf( stderr, "fusefile_init( %d, %d )\n", fci->async_read, fci->want );
433 static struct fuse_operations fusefile_oper = {
434 .getattr = fusefile_getattr,
435 .chmod = fusefile_chmod,
436 .open = fusefile_open,
437 .read = fusefile_read,
438 .poll = fusefile_poll,
439 .write = fusefile_write,
440 .write_buf = fusefile_write_buf,
441 .destroy = fusefile_destroy,
442 .flush = fusefile_flush,
443 .release = fusefile_release,
444 .fsync = fusefile_fsync,
445 .truncate = fusefile_truncate,
446 //.truncate = fusefile_truncate,
447 //.release = fusefile_release,
448 .init = fusefile_init,
451 static void usage() {
453 "Usage: fusefile [ <fuse options> ] <mount> <file/from-to> ... \n"
454 "Mounts a virtual, read-only file that is a concatenation of file fragments\n"
456 fprintf( stderr, "%s", usage );
461 * Set up the arguments for the fuse_main call, adding our own.
462 * argv[argc] is the mount point argument
464 static int setup_argv(int argc,char ***argv) {
465 // note: (*argv)[ argc ] is the mount point argument
467 "-odefault_permissions",
470 #define OURSN ( sizeof( OURS ) / sizeof( char* ) )
471 int N = argc + OURSN;
472 // Allocate new arg array plus terminating null pointer
473 char **out = malloc( ( N + 1 ) * sizeof( char* ) );
475 for ( i = 0; i < argc; i++ ) {
476 out[ i ] = (*argv)[i];
477 //fprintf( stderr, " %s", out[ i ] );
479 for ( i = 0; i < OURSN; i++ ) {
480 out[ argc + i ] = OURS[i];
481 //fprintf( stderr, " %s", out[ i ] );
484 //fprintf( stderr, "\n" );
486 return N; // Don't include the terminating null pointer
490 * Mount a concatenation of files,
491 * [ <fuse options> ] <mount> <file/from-to> ...
493 int main(int argc, char *argv[])
503 for ( i = 1; i < argc; i++ ) {
504 if ( *argv[i] != '-' ) {
508 if ( i > argc - 2 ) { // At least mount point plus one source
512 mnt = argv[ i++ ]; // First non-option argument is the mount pount
513 if ( setup_sources( argv, i, argc-i ) ) {
516 if ( stat( mnt, &stbuf ) == -1 ) {
517 int fd = open( mnt, O_CREAT | O_RDWR, S_IRUSR | S_IWUSR );
522 time_t now = time( 0 );
528 } else if ( ! S_ISREG( stbuf.st_mode ) ) {
529 fprintf( stderr, "mountpoint is not a regular file\n" );
532 times.atime = stbuf.st_atime;
533 times.mtime = stbuf.st_mtime;
534 times.ctime = stbuf.st_ctime;
537 fuseargc = setup_argv( fuseargc, &argv );
538 struct fuse_args args = FUSE_ARGS_INIT( fuseargc, argv );
539 if ( fuse_parse_cmdline( &args, &mnt, &mt, &fg ) ) {
542 fuse_opt_free_args( &args );
544 fprintf( stderr, "missing mountpoint parameter\n" );
547 return fuse_main( fuseargc, argv, &fusefile_oper, temporary? mnt : NULL );