X-Git-Url: http://git.rot13.org/?a=blobdiff_plain;f=Fuse.pm;h=7a5b99905768d731490e70b37fec56d6211295b8;hb=f7c371654fb9afd842bacb11d40ad763bfb37f72;hp=1d830398c839cbc9dccc3fdeec968163c39bb9be;hpb=68b94a8b8eda99bd54082864cd396e748c20eb77;p=perl-fuse.git diff --git a/Fuse.pm b/Fuse.pm index 1d83039..7a5b999 100755 --- 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,15 @@ 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 fuse_version) ], - 'xattr' => [ qw(XATTR_CREATE XATTR_REPLACE) ] + 'all' => [ qw(XATTR_CREATE XATTR_REPLACE fuse_get_context fuse_version FUSE_IOCTL_COMPAT FUSE_IOCTL_UNRESTRICTED FUSE_IOCTL_RETRY FUSE_IOCTL_MAX_IOV) ], + 'xattr' => [ qw(XATTR_CREATE XATTR_REPLACE) ], + 'ioctl' => [ qw(FUSE_IOCTL_COMPAT FUSE_IOCTL_UNRESTRICTED FUSE_IOCTL_RETRY FUSE_IOCTL_MAX_IOV) ], ); our @EXPORT_OK = ( @{ $EXPORT_TAGS{'all'} } ); our @EXPORT = (); -our $VERSION = '0.11'; +our $VERSION = '0.14'; sub AUTOLOAD { # This AUTOLOAD is used to 'autoload' constants from the constant() @@ -62,18 +62,13 @@ sub AUTOLOAD { goto &$AUTOLOAD; } -sub XATTR_CREATE { - # See . - return 1; -} - -sub XATTR_REPLACE { - # See . - return 2; -} - bootstrap Fuse $VERSION; +use constant FUSE_IOCTL_COMPAT => (1 << 0); +use constant FUSE_IOCTL_UNRESTRICTED => (1 << 1); +use constant FUSE_IOCTL_RETRY => (1 << 2); +use constant FUSE_IOCTL_MAX_IOV => 256; + sub main { my @names = qw(getattr readlink getdir mknod mkdir unlink rmdir symlink rename link chmod chown truncate utime open read write statfs @@ -88,16 +83,17 @@ sub main { 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. + 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/); # push(@names, qw/junk ioctl poll/); -# } + } my @subs = map {undef} @names; my $tmp = 0; my %mapping = map { $_ => $tmp++ } @names; @@ -287,6 +283,7 @@ for Fuse API v2.6, will return "2.6". =head3 getattr Arguments: filename. + Returns a list, very similar to the 'stat' function (see perlfunc). On error, simply return a single numeric scalar value (e.g. "return -ENOENT();"). @@ -322,6 +319,7 @@ Here are the meaning of the fields: =head3 readlink Arguments: link pathname. + Returns a scalar: either a numeric constant, or a text string. This is called when dereferencing symbolic links, to learn the target. @@ -331,20 +329,17 @@ example rv: return "/proc/self/fd/stdin"; =head3 getdir 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. It's opendir(), readdir(), filldir() and closedir() all in one call. example rv: return ('.', 'a', 'b', 0); -=head3 readdir - -Arguments: Directory name, offset -Returns: filename, offset to the next dirent, numeric errno 0 or -ENOENT() - =head3 mknod Arguments: Filename, numeric modes, numeric device + Returns an errno (0 upon success, as usual). This function is called for all non-directory, non-symlink nodes, @@ -353,6 +348,7 @@ not just devices. =head3 mkdir Arguments: New directory pathname, numeric modes. + Returns an errno. Called to create a directory. @@ -360,6 +356,7 @@ Called to create a directory. =head3 unlink Arguments: Filename. + Returns an errno. Called to remove a file, device, or symlink. @@ -367,6 +364,7 @@ Called to remove a file, device, or symlink. =head3 rmdir Arguments: Pathname. + Returns an errno. Called to remove a directory. @@ -374,6 +372,7 @@ Called to remove a directory. =head3 symlink Arguments: Existing filename, symlink name. + Returns an errno. Called to create a symbolic link. @@ -381,6 +380,7 @@ Called to create a symbolic link. =head3 rename Arguments: old filename, new filename. + Returns an errno. Called to rename a file, and/or move a file from one directory to another. @@ -388,6 +388,7 @@ Called to rename a file, and/or move a file from one directory to another. =head3 link Arguments: Existing filename, hardlink name. + Returns an errno. Called to create hard links. @@ -395,6 +396,7 @@ Called to create hard links. =head3 chmod Arguments: Pathname, numeric modes. + Returns an errno. Called to change permissions on a file/directory/device/symlink. @@ -402,6 +404,7 @@ Called to change permissions on a file/directory/device/symlink. =head3 chown Arguments: Pathname, numeric uid, numeric gid. + Returns an errno. Called to change ownership of a file/directory/device/symlink. @@ -409,6 +412,7 @@ Called to change ownership of a file/directory/device/symlink. =head3 truncate Arguments: Pathname, numeric offset. + Returns an errno. Called to truncate a file, at the given offset. @@ -416,6 +420,7 @@ Called to truncate a file, at the given offset. =head3 utime Arguments: Pathname, numeric actime, numeric modtime. + Returns an errno. Called to change access/modification times for a file/directory/device/symlink. @@ -424,6 +429,7 @@ Called to change access/modification times for a file/directory/device/symlink. Arguments: Pathname, numeric flags (which is an OR-ing of stuff like O_RDONLY 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(). @@ -437,6 +443,7 @@ Optionally a file handle may be returned, which will be passed to subsequent rea =head3 read 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. @@ -452,6 +459,7 @@ Called in an attempt to write (or overwrite) a portion of the file. Be prepared =head3 statfs Arguments: none + Returns any of the following: -ENOANO() @@ -467,6 +475,7 @@ or =head3 flush Arguments: Pathname, file handle + Returns an errno or 0 on success. Called to synchronise any cached data. This is called before the file @@ -483,6 +492,7 @@ for every file with the same pathname and flags as were passed to open. =head3 fsync Arguments: Pathname, numeric flags + Returns an errno or 0 on success. Called to synchronise the file's contents. If flags is non-zero, @@ -491,6 +501,7 @@ only synchronise the user data. Otherwise synchronise the user and meta data. =head3 setxattr Arguments: Pathname, extended attribute's name, extended attribute's value, numeric flags (which is an OR-ing of XATTR_CREATE and XATTR_REPLACE + Returns an errno or 0 on success. Called to set the value of the named extended attribute. @@ -514,6 +525,7 @@ or: =head3 getxattr Arguments: Pathname, extended attribute's name + Returns an errno, 0 if there was no value, or the extended attribute's value. Called to get the value of the named extended attribute. @@ -521,11 +533,13 @@ Called to get the value of the named extended attribute. =head3 listxattr Arguments: Pathname + Returns a list: 0 or more text strings (the extended attribute names), followed by a numeric errno (usually 0). =head3 removexattr Arguments: Pathname, extended attribute's name + Returns an errno or 0 on success. =head3 opendir @@ -540,6 +554,7 @@ 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 @@ -557,6 +572,7 @@ 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 @@ -567,6 +583,7 @@ 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 @@ -576,16 +593,19 @@ 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 @@ -595,6 +615,7 @@ 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 @@ -604,6 +625,7 @@ 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. @@ -611,6 +633,7 @@ 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();"). @@ -620,6 +643,7 @@ 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 @@ -632,6 +656,7 @@ 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 @@ -644,6 +669,7 @@ 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 @@ -651,6 +677,21 @@ 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. +=head3 ioctl + +Arguments: Pathname, (signed) ioctl command code, flags, data if ioctl op is a write, (optional) file handle + +Returns errno or 0 on success, and data if ioctl op is a read + +Used to handle ioctl() operations on files. See ioctl(2) for more +information on the fine details of ioctl operation numbers. May need to +h2ph system headers to get the necessary macros; keep in mind the macros +are highly OS-dependent. + +Keep in mind that read and write are from the client perspective, so +read from our end means data is going *out*, and write means data is +coming *in*. It can be slightly confusing. + =head1 AUTHOR Mark Glines, Emark@glines.orgE