/usr/lib/perl5/Filesys/Df.pm is in libfilesys-df-perl 0.92-4build2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 | package Filesys::Df;
use strict;
use vars qw($VERSION @ISA @EXPORT @EXPORT_OK);
use Carp;
require Exporter;
require DynaLoader;
require 5.006;
@ISA = qw(Exporter DynaLoader);
@EXPORT = qw(df);
$VERSION = '0.92';
bootstrap Filesys::Df $VERSION;
sub df {
my ($dir, $block_size) = @_;
my ($used, $fused);
my ($per, $fper);
my ($user_blocks, $user_used);
my ($user_files, $user_fused);
my %fs = ();
(defined($dir)) ||
(croak "Usage: df\(\$dir\) or df\(\$dir\, \$block_size)");
#### If no requested block size then we will return the values in bytes
($block_size) ||
($block_size = 1024);
my ($frsize, $blocks, $bfree, $bavail, $files, $ffree, $favail);
#### If open filehandle call fstatvfs or fstatfs
if(defined(fileno($dir))) {
($frsize, $blocks, $bfree, $bavail, $files, $ffree, $favail) = _df_fh(fileno($dir));
}
else {
($frsize, $blocks, $bfree, $bavail, $files, $ffree, $favail) = _df($dir);
}
#### Some system or XS failure, something like /proc, or bad $dir
if($frsize == 0 || $blocks == 0) {
return();
}
#### Change to requested or default block size
if($block_size > $frsize) {
my $result = $block_size / $frsize;
$blocks /= $result;
($bfree != 0) &&
($bfree /= $result);
#### Keep bavail -
($bavail < 0) &&
($result *= -1);
($bavail != 0) &&
($bavail /= $result);
}
elsif($block_size < $frsize) {
my $result = $frsize / $block_size;
$blocks *= $result;
$bfree *= $result;
#### Keep bavail -
($bavail < 0) &&
($result *= -1);
$bavail *= $result;
}
$used = $blocks - $bfree;
#### There is a reserved amount for the su
#### or there are disk quotas
if($bfree > $bavail) {
$user_blocks = $blocks - ($bfree - $bavail);
$user_used = $user_blocks - $bavail;
if($bavail < 0) {
#### over 100%
my $tmp_bavail = $bavail;
$per = ($tmp_bavail *= -1) / $user_blocks;
}
else {
if($user_used == 0) {
$per = 0;
}
else {
$per = $user_used / $user_blocks;
}
}
}
#### No reserved amount or quotas
else {
if($used == 0) {
$per = 0;
}
else {
$per = $used / $blocks;
$user_blocks = $blocks;
$user_used = $used;
}
}
#### round
$per *= 100;
$per += .5;
#### over 100%
($bavail < 0) &&
($per += 100);
$fs{per} = int($per);
$fs{blocks} = $blocks;
$fs{bfree} = $bfree;
$fs{bavail} = $bavail;
$fs{used} = $used;
#### These are undocumented but kept for backwards compatibility
$fs{user_blocks} = $user_blocks;
$fs{user_bavail} = $bavail;
$fs{user_used} = $user_used;
$fs{su_bavail} = $bfree;
$fs{su_blocks} = $blocks;
#### Handle inodes if system supports them
if(defined $files && $files > 0) {
$fused = $files - $ffree;
#### There is a reserved amount
if($ffree > $favail) {
$user_files = $files - ($ffree - $favail);
$user_fused = $user_files - $favail;
if($favail < 0) {
#### over 100%
my $tmp_favail = $favail;
$fper = ($tmp_favail *= -1) / $user_files;
}
else {
if($user_fused == 0) {
$fper = 0;
}
else {
$fper = $user_fused / $user_files;
}
}
}
#### su and user amount are the same
else {
if($fused == 0) {
$fper = 0;
}
else {
$fper = $fused / $files;
}
$user_files = $files;
$user_fused = $fused;
}
#### round
$fper *= 100;
$fper += .5;
#### over 100%
($favail < 0) &&
($fper += 100);
$fs{fper} = int($fper);
$fs{files} = $files;
$fs{ffree} = $ffree;
$fs{favail} = $favail;
$fs{fused} = $fused;
#### These are undocumented but kept for backwards compatibility
$fs{user_fused} = $user_fused;
$fs{user_files} = $user_files;
$fs{su_favail} = $ffree;
$fs{su_files} = $files;
$fs{user_favail} = $favail;
}
#### No valid inode info. Probably NFS.
#### Instead of undefing, just have the user call exists().
#else {
# $fs{fper} = undef;
# $fs{files} = undef;
# $fs{ffree} = undef;
# $fs{favail} = undef;
# $fs{fused} = undef;
# $fs{user_fused} = undef;
# $fs{user_files} = undef;
#}
return(\%fs);
}
1;
__END__
=head1 NAME
Filesys::Df - Perl extension for filesystem disk space information.
=head1 SYNOPSIS
use Filesys::Df;
#### Get information by passing a scalar directory/filename value
my $ref = df("/tmp"); # Default output is 1K blocks
if(defined($ref)) {
print "Total 1k blocks: $ref->{blocks}\n";
print "Total 1k blocks free: $ref->{bfree}\n";
print "Total 1k blocks avail to me: $ref->{bavail}\n";
print "Total 1k blocks used: $ref->{used}\n";
print "Percent full: $ref->{per}\n";
if(exists($ref->{files})) {
print "Total inodes: $ref->{files}\n";
print "Total inodes free: $ref->{ffree}\n";
print "Inode percent full: $ref->{fper}\n";
}
}
#### Get information by passing a filehandle
open(FILE, "some_file"); # Get information for filesystem at "some_file"
my $ref = df(\*FILE);
#### or
my $ref = df(*FILE);
#### or
my $fhref = \*FILE;
my $ref = df($fhref);
#### Get information in other than 1k blocks
my $ref = df("/tmp", 8192); # output is 8K blocks
my $ref = df("/tmp", 1); # output is bytes
=head1 DESCRIPTION
This module provides a way to obtain filesystem disk space
information. This is a Unix only distribution. If you want to
gather this information for Unix and Windows, use C<Filesys::DfPortable>.
The only major benefit of using C<Filesys::Df> over C<Filesys::DfPortable>,
is that C<Filesys::Df> supports the use of open filehandles as arguments.
The module should work with all flavors of Unix that implement the
C<statvfs()> and C<fstatvfs()> calls, or the C<statfs()> and C<fstatfs()> calls.
This would include Linux, *BSD, HP-UX, AIX, Solaris, Mac OS X, Irix,
Cygwin, etc ...
C<df()> requires a argument that represents the filesystem you want to
query. The argument can be either a scalar directory/file name or a
open filehandle. There is also an optional block size argument so
you can tailor the size of the values returned. The default block
size is 1024. This will cause the function to return the values in 1k
blocks. If you want bytes, set the block size to 1.
C<df()> returns a reference to a hash. The keys available in
the hash are as follows:
C<{blocks}> = Total blocks on the filesystem.
C<{bfree}> = Total blocks free on the filesystem.
C<{bavail}> = Total blocks available to the user executing the Perl
application. This can be different than C<{bfree}> if you have per-user
quotas on the filesystem, or if the super user has a reserved amount.
C<{bavail}> can also be a negative value because of this. For instance
if there is more space being used then you have available to you.
C<{used}> = Total blocks used on the filesystem.
C<{per}> = Percent of disk space used. This is based on the disk space
available to the user executing the application. In other words, if
the filesystem has 10% of its space reserved for the superuser, then
the percent used can go up to 110%.
You can obtain inode information through the module as well, but you
must call C<exists()> on the C<{files}> key first, to make sure the information
is available. Some filesystems may not return inode information, for example
some NFS filesystems.
Here are the available inode keys:
C<{files}> = Total inodes on the filesystem.
C<{ffree}> = Total inodes free on the filesystem.
C<{favail}> = Total inodes available to the user executing the application.
See the rules for the C<{bavail}> key.
C<{fused}> = Total inodes used on the filesystem.
C<{fper}> = Percent of inodes used on the filesystem. See rules for the C<{per}>
key.
There are some undocumented keys that are defined to maintain backwards
compatibilty: C<{su_blocks}>, C<{user_blocks}>, etc ...
If the C<df()> call fails for any reason, it will return
undef. This will probably happen if you do anything crazy like try
to get information for /proc, or if you pass an invalid filesystem name,
or if there is an internal error. C<df()> will C<croak()> if you pass
it a undefined value.
Requirements:
Your system must contain C<statvfs()> and C<fstatvfs()>, or C<statfs()> and C<fstatfs()>
You must be running Perl 5.6 or higher.
=head1 AUTHOR
Ian Guthrie
IGuthrie@aol.com
Copyright (c) 2006 Ian Guthrie. All rights reserved.
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
=head1 SEE ALSO
statvfs(2), fstatvfs(2), statfs(2), fstatfs(2), df(1), Filesys::DfPortable
perl(1).
=cut
|