3 our $VERSION = '1.04_01';
7 FileCache - keep more files open than the system permits
13 use FileCache maxopen => 16;
15 cacheout $mode, $path;
20 $fh = cacheout $mode, $path;
27 The C<cacheout> function will make sure that there's a filehandle open
28 for reading or writing available as the pathname you give it. It
29 automatically closes and re-opens files if you exceed your system's
30 maximum number of file descriptors, or the suggested maximum I<maxopen>.
36 The 1-argument form of cacheout will open a file for writing (C<< '>' >>)
37 on it's first use, and appending (C<<< '>>' >>>) thereafter.
39 Returns EXPR on success for convenience. You may neglect the
40 return value and manipulate EXPR as the filehandle directly if you prefer.
42 =item cacheout MODE, EXPR
44 The 2-argument form of cacheout will use the supplied mode for the initial
45 and subsequent openings. Most valid modes for 3-argument C<open> are supported
46 namely; C<< '>' >>, C<< '+>' >>, C<< '<' >>, C<< '<+' >>, C<<< '>>' >>>,
47 C< '|-' > and C< '-|' >
49 To pass supplemental arguments to a program opened with C< '|-' > or C< '-|' >
50 append them to the command string as you would system EXPR.
52 Returns EXPR on success for convenience. You may neglect the
53 return value and manipulate EXPR as the filehandle directly if you prefer.
57 While it is permissible to C<close> a FileCache managed file,
58 do not do so if you are calling C<FileCache::cacheout> from a package other
59 than which it was imported, or with another module which overrides C<close>.
60 If you must, use C<FileCache::cacheout_close>.
62 Although FileCache can be used with piped opens ('-|' or '|-') doing so is
63 strongly discouraged. If FileCache finds it necessary to close and then reopen
64 a pipe, the command at the far end of the pipe will be reexecuted - the results
65 of performing IO on FileCache'd pipes is unlikely to be what you expect. The
66 ability to use FileCache on pipes may be removed in a future release.
68 FileCache does not store the current file offset if it finds it necessary to
69 close a file. When the file is reopened, the offset will be as specified by the
70 original C<open> file mode. This could be construed to be a bug.
74 F<sys/param.h> lies with its C<NOFILE> define on some systems,
75 so you may have to set I<maxopen> yourself.
84 # These are not C<my> for legacy reasons.
85 # Previous versions requested the user set $cacheout_maxopen by hand.
86 # Some authors fiddled with %saw to overcome the clobber on initial open.
87 use vars qw(%saw $cacheout_maxopen);
94 *{$pkg.'::cacheout'} = \&cacheout;
95 *{$pkg.'::close'} = \&cacheout_close;
97 # Truth is okay here because setting maxopen to 0 would be bad
98 return $cacheout_maxopen = $args{maxopen} if $args{maxopen};
99 foreach my $param ( '/usr/include/sys/param.h' ){
100 if (open($param, '<', $param)) {
103 if( /^\s*#\s*define\s+NOFILE\s+(\d+)/ ){
104 $cacheout_maxopen = $1 - 4;
112 $cacheout_maxopen ||= 16;
115 # Open in their package.
117 return open(*{caller(1) . '::' . $_[1]}, $_[0], $_[1]) && $_[1];
120 # Close in their package.
122 # Short-circuit in case the filehandle disappeared
123 my $pkg = caller($_[1]||0);
124 fileno(*{$pkg . '::' . $_[0]}) &&
125 CORE::close(*{$pkg . '::' . $_[0]});
126 delete $isopen{$_[0]};
129 # But only this sub name is visible to them.
131 my($mode, $file, $class, $ret, $ref, $narg);
132 croak "Not enough arguments for cacheout" unless $narg = scalar @_;
133 croak "Too many arguments for cacheout" if $narg > 2;
136 ($file, $mode) = ($mode, $file) if $narg == 1;
137 croak "Invalid mode for cacheout" if $mode &&
138 ( $mode !~ /^\s*(?:>>|\+?>|\+?<|\|\-|)|\-\|\s*$/ );
141 if( $isopen{$file} && ($mode||'>') ne $isopen{$file}->[2] ){
142 &cacheout_close($file, 1);
145 if( $isopen{$file}) {
147 $isopen{$file}->[0]++;
150 if( scalar keys(%isopen) > $cacheout_maxopen -1 ) {
151 my @lru = sort{ $isopen{$a}->[0] <=> $isopen{$b}->[0] } keys(%isopen);
153 $isopen{$_}->[0] = $cacheout_seq++ for
154 splice(@lru, int($cacheout_maxopen / 3)||$cacheout_maxopen);
155 &cacheout_close($_, 1) for @lru;
159 $mode ||= $saw{$file} ? '>>' : ($saw{$file}=1, '>');
161 #XXX should we just return the value from cacheout_open, no croak?
162 $ret = cacheout_open($mode, $file) or croak("Can't create $file: $!");
164 $isopen{$file} = [++$cacheout_seq, $mode];