/[fuse.before_github]/perl-llin/Fuse.pm
This is repository of my old source code which isn't updated any more. Go to git.rot13.org for current projects!
ViewVC logotype

Diff of /perl-llin/Fuse.pm

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

perl/trunk/Fuse.pm revision 14 by richdawe, Sun Apr 10 13:30:11 2005 UTC perl-llin/Fuse.pm revision 123 by dpavlin, Wed Mar 19 19:40:20 2008 UTC
# Line 5  use strict; Line 5  use strict;
5  use warnings;  use warnings;
6  use Errno;  use Errno;
7  use Carp;  use Carp;
8    use Config;
9    
10  require Exporter;  require Exporter;
11  require DynaLoader;  require DynaLoader;
# Line 20  our @ISA = qw(Exporter DynaLoader); Line 21  our @ISA = qw(Exporter DynaLoader);
21  # If you do not need this, moving things directly into @EXPORT or @EXPORT_OK  # If you do not need this, moving things directly into @EXPORT or @EXPORT_OK
22  # will save memory.  # will save memory.
23  our %EXPORT_TAGS = (  our %EXPORT_TAGS = (
24                      'all' => [ qw(FUSE_DEBUG XATTR_CREATE XATTR_REPLACE) ],                      'all' => [ qw(XATTR_CREATE XATTR_REPLACE fuse_get_context) ],
                     'debug' => [ qw(FUSE_DEBUG) ],  
25                      'xattr' => [ qw(XATTR_CREATE XATTR_REPLACE) ]                      'xattr' => [ qw(XATTR_CREATE XATTR_REPLACE) ]
26                      );                      );
27    
28  our @EXPORT_OK = ( @{ $EXPORT_TAGS{'all'} } );  our @EXPORT_OK = ( @{ $EXPORT_TAGS{'all'} } );
29    
30  our @EXPORT = qw(  our @EXPORT = ();
31          FUSE_DEBUG  our $VERSION = '0.09_3';
 );  
 our $VERSION = '0.06';  
32    
33  sub AUTOLOAD {  sub AUTOLOAD {
34      # This AUTOLOAD is used to 'autoload' constants from the constant()      # This AUTOLOAD is used to 'autoload' constants from the constant()
# Line 77  sub XATTR_REPLACE { Line 75  sub XATTR_REPLACE {
75  bootstrap Fuse $VERSION;  bootstrap Fuse $VERSION;
76    
77  sub main {  sub main {
78          my (@subs) = (0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0);          my @names = qw(getattr readlink getdir mknod mkdir unlink rmdir symlink
79          my (@names) = qw(getattr readlink getdir mknod mkdir unlink rmdir symlink                          rename link chmod chown truncate utime open read write statfs
80                           rename link chmod chown truncate utime open read write statfs                          flush release fsync setxattr getxattr listxattr removexattr);
81                           flush release fsync setxattr getxattr listxattr removexattr);          my @subs = map {undef} @names;
82          my ($tmp) = 0;          my @validOpts = qw(ro allow_other default_permissions fsname use_ino nonempty);
83          my (%mapping) = map { $_ => $tmp++ } (@names);          my $tmp = 0;
84          my (%otherargs) = (debug=>0, mountpoint=>"");          my %mapping = map { $_ => $tmp++ } @names;
85            my %optmap  = map { $_ => 1 } @validOpts;
86            my @otherargs = qw(debug threaded mountpoint mountopts);
87            my %otherargs = (debug=>0, threaded=>0, mountpoint=>"", mountopts=>"");
88          while(my $name = shift) {          while(my $name = shift) {
89                  my ($subref) = shift;                  my ($subref) = shift;
90                  if(exists($otherargs{$name})) {                  if(exists($otherargs{$name})) {
91                          $otherargs{$name} = $subref;                          $otherargs{$name} = $subref;
92                  } else {                  } else {
93                          croak "There is no function $name" unless exists($mapping{$name});                          croak "There is no function $name" unless exists($mapping{$name});
94                          croak "Usage: Fuse::main(getattr => &my_getattr, ...)" unless $subref;                          croak "Usage: Fuse::main(getattr => \"main::my_getattr\", ...)" unless $subref;
                         croak "Usage: Fuse::main(getattr => &my_getattr, ...)" unless ref($subref);  
                         croak "Usage: Fuse::main(getattr => &my_getattr, ...)" unless ref($subref) eq "CODE";  
95                          $subs[$mapping{$name}] = $subref;                          $subs[$mapping{$name}] = $subref;
96                  }                  }
97          }          }
98          perl_fuse_main($otherargs{debug},$otherargs{mountpoint},@subs);          foreach my $opt ( map {m/^([^=]*)/; $1} split(/,/,$otherargs{mountopts}) ) {
99              next if exists($optmap{$opt});
100              croak "Fuse::main: invalid '$opt' argument in mountopts";
101            }
102            if($otherargs{threaded}) {
103                    # make sure threads are both available, and loaded.
104                    if($Config{useithreads}) {
105                            if(exists($threads::{VERSION})) {
106                                    if(exists($threads::shared::{VERSION})) {
107                                            # threads will work.
108                                    } else {
109                                            carp("Thread support requires you to use threads::shared.\nThreads are disabled.\n");
110                                            $otherargs{threaded} = 0;
111                                    }
112                            } else {
113                                    carp("Thread support requires you to use threads and threads::shared.\nThreads are disabled.\n");
114                                    $otherargs{threaded} = 0;
115                            }
116                    } else {
117                            carp("Thread support was not compiled into this build of perl.\nThreads are disabled.\n");
118                            $otherargs{threaded} = 0;
119                    }
120            }
121            perl_fuse_main(@otherargs{@otherargs},@subs);
122  }  }
123    
124  # Autoload methods go after =cut, and are processed by the autosplit program.  # Autoload methods go after =cut, and are processed by the autosplit program.
# Line 113  Fuse - write filesystems in Perl using F Line 135  Fuse - write filesystems in Perl using F
135    use Fuse;    use Fuse;
136    my ($mountpoint) = "";    my ($mountpoint) = "";
137    $mountpoint = shift(@ARGV) if @ARGV;    $mountpoint = shift(@ARGV) if @ARGV;
138    Fuse::main(mountpoint=>$mountpoint, getattr=>\&my_getattr, getdir=>\&my_getdir, ...);    Fuse::main(mountpoint=>$mountpoint, getattr=>"main::my_getattr", getdir=>"main::my_getdir", ...);
139    
140  =head1 DESCRIPTION  =head1 DESCRIPTION
141    
# Line 122  This lets you implement filesystems in p Line 144  This lets you implement filesystems in p
144    
145  FUSE expects you to implement callbacks for the various functions.  FUSE expects you to implement callbacks for the various functions.
146    
 NOTE:  I have only tested the things implemented in example.pl!  
 It should work, but some things may not.  
   
147  In the following definitions, "errno" can be 0 (for a success),  In the following definitions, "errno" can be 0 (for a success),
148  -EINVAL, -ENOENT, -EONFIRE, any integer less than 1 really.  -EINVAL, -ENOENT, -EONFIRE, any integer less than 1 really.
149    
# Line 137  See their respective documentations, for Line 156  See their respective documentations, for
156    
157  =head2 EXPORTED SYMBOLS  =head2 EXPORTED SYMBOLS
158    
159  FUSE_DEBUG by default.  None by default.
160    
161  You can request all exportable symbols by using the tag ":all".  You can request all exportable symbols by using the tag ":all".
162    
 You can request all debug symbols by using the tag ":debug".  
 This will export FUSE_DEBUG.  
   
163  You can request the extended attribute symbols by using the tag ":xattr".  You can request the extended attribute symbols by using the tag ":xattr".
164  This will export XATTR_CREATE and XATTR_REPLACE.  This will export XATTR_CREATE and XATTR_REPLACE.
165    
# Line 174  specify this.  An example would be '/mnt Line 190  specify this.  An example would be '/mnt
190    
191  =back  =back
192    
193  unthreaded => boolean  mountopts => string
194    
195  =over 1  =over 1
196    
197  This turns FUSE multithreading off and on.  NOTE: This perlmodule does not  This is a comma seperated list of mount options to pass to the FUSE kernel
198  currently work properly in multithreaded mode!  The author is unfortunately  module.
199  not familiar enough with perl-threads internals, and according to the  
200  documentation available at time of writing (2002-03-08), those internals are  At present, it allows the specification of the allow_other
201  subject to changing anyway.  Note that singlethreaded mode also means that  argument when mounting the new FUSE filesystem. To use this, you will also
202  you will not have to worry about reentrancy, though you will have to worry  need 'user_allow_other' in /etc/fuse.conf as per the FUSE documention
203  about recursive lookups (since the kernel holds a global lock on your  
204  filesystem and blocks waiting for one callback to complete before calling    mountopts => "allow_other" or
205  another).    mountopts => ""
   
 I hope to add full multithreading functionality later, but for now, I  
 recommend you leave this option at the default, 1 (which means  
 unthreaded, no threads will be used and no reentrancy is needed).  
206    
207  =back  =back
208    
209    threaded => boolean
210    
211    =over 1
212    
213    This turns FUSE multithreading on and off.  The default is 0, meaning your FUSE
214    script will run in single-threaded mode.  Note that single-threaded mode also
215    means that you will not have to worry about reentrancy, though you will have to
216    worry about recursive lookups.  In single-threaded mode, FUSE holds a global
217    lock on your filesystem, and will wait for one callback to return before
218    calling another.  This can lead to deadlocks, if your script makes any attempt
219    to access files or directories in the filesystem it is providing.  (This
220    includes calling stat() on the mount-point, statfs() calls from the 'df'
221    command, and so on and so forth.)  It is worth paying a little attention and
222    being careful about this.
223    
224    Enabling multithreading will cause FUSE to make multiple simultaneous calls
225    into the various callback functions of your perl script.  If you enable
226    threaded mode, you can enjoy all the parallel execution and interactive
227    response benefits of threads, and you get to enjoy all the benefits of race
228    conditions and locking bugs, too.  Please also ensure any other perl modules
229    you're using are also thread-safe.
230    
231    (If enabled, this option will cause a warning if your perl interpreter was not
232    built with USE_ITHREADS, or if you have failed to use threads or
233    threads::shared.)
234    
235    =back
236    
237    =head3 Fuse::fuse_get_context
238    
239     use Fuse "fuse_get_context";
240     my $caller_uid = fuse_get_context()->{"uid"};
241     my $caller_gid = fuse_get_context()->{"gid"};
242     my $caller_pid = fuse_get_context()->{"pid"};
243    
244    Access context information about the current Fuse operation.
245    
246  =head2 FUNCTIONS YOUR FILESYSTEM MAY IMPLEMENT  =head2 FUNCTIONS YOUR FILESYSTEM MAY IMPLEMENT
247    
248  =head3 getattr  =head3 getattr
Legend:
Removed from v.14  
changed lines
  Added in v.123
  ViewVC Help
Powered by ViewVC 1.1.26