X-Git-Url: http://git.rot13.org/?a=blobdiff_plain;f=Fuse.pm;h=060ab99af37f58a0df6529f05bf7dad0f502e6a5;hb=ea6e4fd27a10f60467acd1fc3d7c458a7748a8f9;hp=cc09f75db1d17014bdee783df27c292c7c5fe43f;hpb=b89b2ef79bcaebef14366a01e95da0739b18bf57;p=perl-fuse.git diff --git a/Fuse.pm b/Fuse.pm old mode 100644 new mode 100755 index cc09f75..060ab99 --- a/Fuse.pm +++ b/Fuse.pm @@ -10,7 +10,6 @@ use Config; require Exporter; require DynaLoader; use AutoLoader; -use Data::Dumper; our @ISA = qw(Exporter DynaLoader); # Items to export into callers namespace by default. Note: do not export @@ -21,14 +20,14 @@ our @ISA = qw(Exporter DynaLoader); # If you do not need this, moving things directly into @EXPORT or @EXPORT_OK # will save memory. our %EXPORT_TAGS = ( - 'all' => [ qw(XATTR_CREATE XATTR_REPLACE fuse_get_context) ], + 'all' => [ qw(XATTR_CREATE XATTR_REPLACE fuse_get_context fuse_version) ], 'xattr' => [ qw(XATTR_CREATE XATTR_REPLACE) ] ); our @EXPORT_OK = ( @{ $EXPORT_TAGS{'all'} } ); our @EXPORT = (); -our $VERSION = '0.09_3'; +our $VERSION = '0.12'; sub AUTOLOAD { # This AUTOLOAD is used to 'autoload' constants from the constant() @@ -62,29 +61,43 @@ sub AUTOLOAD { goto &$AUTOLOAD; } -sub XATTR_CREATE { - # See . - return 1; -} - -sub XATTR_REPLACE { - # See . - return 2; -} - bootstrap Fuse $VERSION; sub main { my @names = qw(getattr readlink getdir mknod mkdir unlink rmdir symlink rename link chmod chown truncate utime open read write statfs flush release fsync setxattr getxattr listxattr removexattr); + my $fuse_version = fuse_version(); + if ($fuse_version >= 2.3) { + push(@names, qw/opendir readdir releasedir fsyncdir init destroy/); + } + if ($fuse_version >= 2.5) { + push(@names, qw/access create ftruncate fgetattr/); + } + if ($fuse_version >= 2.6) { + push(@names, qw/lock utimens bmap/); + } +# if ($fuse_version >= 2.8) { +# # junk doesn't contain a function pointer, and hopefully +# # never will; it's a "dead" zone in the struct +# # fuse_operations where a flag bit is declared. we don't +# # need to concern ourselves with it, and it appears any +# # arch with a 64 bit pointer will align everything to +# # 8 bytes, making the question of pointer alignment for +# # the last 2 wrapper functions no big thing. +# push(@names, qw/junk ioctl poll/); +# } my @subs = map {undef} @names; - my @validOpts = qw(ro allow_other default_permissions fsname use_ino nonempty); my $tmp = 0; my %mapping = map { $_ => $tmp++ } @names; - my %optmap = map { $_ => 1 } @validOpts; - my @otherargs = qw(debug threaded mountpoint mountopts); - my %otherargs = (debug=>0, threaded=>0, mountpoint=>"", mountopts=>""); + my @otherargs = qw(debug threaded mountpoint mountopts nullpath_ok); + my %otherargs = ( + debug => 0, + threaded => 0, + mountpoint => "", + mountopts => "", + nullpath_ok => 0, + ); while(my $name = shift) { my ($subref) = shift; if(exists($otherargs{$name})) { @@ -95,10 +108,6 @@ sub main { $subs[$mapping{$name}] = $subref; } } - foreach my $opt ( map {m/^([^=]*)/; $1} split(/,/,$otherargs{mountopts}) ) { - next if exists($optmap{$opt}); - croak "Fuse::main: invalid '$opt' argument in mountopts"; - } if($otherargs{threaded}) { # make sure threads are both available, and loaded. if($Config{useithreads}) { @@ -234,6 +243,19 @@ threads::shared.) =back +nullpath_ok => boolean + +=over 1 + +This flag tells Fuse to not pass paths for functions that operate on file +or directory handles. This will yield empty path parameters for functions +including read, write, flush, release, fsync, readdir, releasedir, +fsyncdir, truncate, fgetattr and lock. If you use this, you must return +file/directory handles from open, opendir and create. Default is 0 (off). +Only effective on Fuse 2.8 and up; with earlier versions, this does nothing. + +=back + =head3 Fuse::fuse_get_context use Fuse "fuse_get_context"; @@ -243,6 +265,12 @@ threads::shared.) Access context information about the current Fuse operation. +=head3 Fuse::fuse_version + +Indicates the Fuse version in use; more accurately, indicates the version +of the Fuse API in use at build time. Returned as a decimal value; i.e., +for Fuse API v2.6, will return "2.6". + =head2 FUNCTIONS YOUR FILESYSTEM MAY IMPLEMENT =head3 getattr @@ -294,7 +322,7 @@ example rv: return "/proc/self/fd/stdin"; Arguments: Containing directory name. Returns a list: 0 or more text strings (the filenames), followed by a numeric errno (usually 0). -This is used to obtain directory listings. Its opendir(), readdir(), filldir() and closedir() all in one call. +This is used to obtain directory listings. It's opendir(), readdir(), filldir() and closedir() all in one call. example rv: return ('.', 'a', 'b', 0); @@ -379,26 +407,31 @@ Called to change access/modification times for a file/directory/device/symlink. =head3 open Arguments: Pathname, numeric flags (which is an OR-ing of stuff like O_RDONLY -and O_SYNC, constants you can import from POSIX). -Returns an errno. +and O_SYNC, constants you can import from POSIX), fileinfo hash reference. +Returns an errno, a file handle (optional). No creation, or trunctation flags (O_CREAT, O_EXCL, O_TRUNC) will be passed to open(). +The fileinfo hash reference contains flags from the Fuse open call which may be modified by the module. The only fields presently supported are: + direct_io (version 2.4 onwards) + keep_cache (version 2.4 onwards) + nonseekable (version 2.9 onwards) Your open() method needs only check if the operation is permitted for the given flags, and return 0 for success. +Optionally a file handle may be returned, which will be passed to subsequent read, write, flush, fsync and release calls. =head3 read -Arguments: Pathname, numeric requestedsize, numeric offset. +Arguments: Pathname, numeric requested size, numeric offset, file handle Returns a numeric errno, or a string scalar with up to $requestedsize bytes of data. Called in an attempt to fetch a portion of the file. =head3 write -Arguments: Pathname, scalar buffer, numeric offset. You can use length($buffer) to +Arguments: Pathname, scalar buffer, numeric offset, file handle. You can use length($buffer) to find the buffersize. Returns length($buffer) if successful (number of bytes written). -Called in an attempt to write (or overwrite) a portion of the file. Be prepared because $buffer could contain random binary data with NULLs and all sorts of other wonderful stuff. +Called in an attempt to write (or overwrite) a portion of the file. Be prepared because $buffer could contain random binary data with NULs and all sorts of other wonderful stuff. =head3 statfs @@ -417,7 +450,7 @@ or =head3 flush -Arguments: Pathname +Arguments: Pathname, file handle Returns an errno or 0 on success. Called to synchronise any cached data. This is called before the file @@ -425,7 +458,7 @@ is closed. It may be called multiple times before a file is closed. =head3 release -Arguments: Pathname, numeric flags passed to open +Arguments: Pathname, numeric flags passed to open, file handle Returns an errno or 0 on success. Called to indicate that there are no more references to the file. Called once @@ -479,6 +512,129 @@ Returns a list: 0 or more text strings (the extended attribute names), followed Arguments: Pathname, extended attribute's name Returns an errno or 0 on success. +=head3 opendir + +Arguments: Pathname of a directory +Returns an errno, and a directory handle (optional) + +Called when opening a directory for reading. If special handling is +required to open a directory, this operation can be implemented to handle +that. + +=head3 readdir + +Arguments: Pathname of a directory, numeric offset, (optional) directory handle +Returns a list of 0 or more entries, followed by a numeric errno (usually 0). +The entries can be simple strings (filenames), or arrays containing an +offset number, the filename, and optionally an array ref containing the +stat values (as would be returned from getattr()). + +This is used to read entries from a directory. It can be used to return just +entry names like getdir(), or can get a segment of the available entries, +which requires using array refs and the 2- or 3-item form, with offset values +starting from 1. If you wish to return the parameters to fill each entry's +struct stat, but do not wish to do partial entry lists/entry counting, set +the first element of each array to 0 always. + +Note that if this call is implemented, it overrides getdir() ALWAYS. + +=head3 releasedir + +Arguments: Pathname of a directory, (optional) directory handle +Returns an errno or 0 on success + +Called when there are no more references to an opened directory. Called once +for each pathname or handle passed to opendir(). Similar to release(), but +for directories. Accepts a return value, but like release(), the response +code will not propagate to any corresponding closedir() calls. + +=head3 fsyncdir + +Arguments: Pathname of a directory, numeric flags, (optional) directory handle +Returns an errno or 0 on success. + +Called to synchronize any changes to a directory's contents. If flag is +non-zero, only synchronize user data, otherwise synchronize user data and +metadata. + +=head3 init + +Arguments: None. +Returns (optionally) an SV to be passed as private_data via fuse_get_context(). + +=head3 destroy + +Arguments: (optional) private data SV returned from init(), if any. +Returns nothing. + +=head3 access + +Arguments: Pathname, access mode flags +Returns an errno or 0 on success. + +Determine if the user attempting to access the indicated file has access to +perform the requested actions. The user ID can be determined by calling +fuse_get_context(). See access(2) for more information. + +=head3 create + +Arguments: Pathname, create mask, open mode flags +Returns errno or 0 on success, and (optional) file handle. + +Create a file with the path indicated, then open a handle for reading and/or +writing with the supplied mode flags. Can also return a file handle like +open() as part of the call. + +=head3 ftruncate + +Arguments: Pathname, numeric offset, (optional) file handle +Returns errno or 0 on success + +Like truncate(), but on an opened file. + +=head3 fgetattr + +Arguments: Pathname, (optional) file handle +Returns a list, very similar to the 'stat' function (see +perlfunc). On error, simply return a single numeric scalar +value (e.g. "return -ENOENT();"). + +Like getattr(), but on an opened file. + +=head3 lock + +Arguments: Pathname, numeric command code, hashref containing lock parameters, (optional) file handle +Returns errno or 0 on success + +Used to lock or unlock regions of a file. Locking is handled locally, but this +allows (especially for networked file systems) for protocol-level locking +semantics to also be employed, if any are available. + +See the Fuse documentation for more explanation of lock(). The needed symbols +for the lock constants can be obtained by importing Fcntl. + +=head3 utimens + +Arguments: Pathname, last accessed time, last modified time +Returns errno or 0 on success + +Like utime(), but allows time resolution down to the nanosecond. Currently +times are passed as "numeric" (internally I believe these are represented +typically as "long double"), so the sub-second portion is represented as +fractions of a second. + +Note that if this call is implemented, it overrides utime() ALWAYS. + +=head3 bmap + +Arguments: Pathname, numeric blocksize, numeric block number +Returns errno or 0 on success, and physical block number if successful + +Used to map a block number offset in a file to the physical block offset +on the block device backing the file system. This is intended for +filesystems that are stored on an actual block device, with the 'blkdev' +option passed. + =head1 AUTHOR Mark Glines, Emark@glines.orgE