df/virt-df.pl

   1 #!/usr/bin/perl -w
   2 # virt-df
   3 # Copyright (C) 2009 Red Hat Inc.
   4 #
   5 # This program is free software; you can redistribute it and/or modify
   6 # it under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation; either version 2 of the License, or
   8 # (at your option) any later version.
   9 #
  10 # This program is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with this program; if not, write to the Free Software
  17 # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18
  19 use warnings;
  20 use strict;
  21
  22 use Sys::Guestfs;
  23 use Sys::Guestfs::Lib qw(open_guest get_partitions resolve_windows_path
  24   inspect_all_partitions inspect_partition
  25   inspect_operating_systems mount_operating_system inspect_in_detail);
  26 use Pod::Usage;
  27 use Getopt::Long;
  28 use Data::Dumper;
  29 use File::Temp qw/tempdir/;
  30 use XML::Writer;
  31
  32 =encoding utf8
  33
  34 =head1 NAME
  35
  36 virt-df - Display free space on virtual filesystems
  37
  38 =head1 SYNOPSIS
  39
  40  virt-df [--options]
  41
  42  virt-df [--options] domname
  43
  44  virt-df [--options] disk.img [disk.img ...]
  45
  46 =head1 DESCRIPTION
  47
  48 C<virt-df> is a command line tool to display free space on virtual
  49 machine filesystems.  Unlike other tools, it doesn't just display the
  50 amount of space allocated to a virtual machine, but can look inside
  51 the virtual machine to see how much space is really being used.
  52
  53 It is like the L<df(1)> command, but for virtual machines, except that
  54 it also works for Windows virtual machines.
  55
  56 If used without any arguments, C<virt-df> checks with libvirt to get a
  57 list of all active and inactive guests, and performs a C<df>-type
  58 operation on each one in turn, printing out the results.
  59
  60 If used with any argument(s), C<virt-df> performs a C<df>-type
  61 operation on either the single named libvirt domain, or on the disk
  62 image(s) listed on the command line (which must all belong to a single
  63 VM).  In this mode (with arguments), C<virt-df> will I<only work for a
  64 single guest>.  If you want to run on multiple guests, then you have
  65 to invoke C<virt-df> multiple times.
  66
  67 Use the C<--csv> option to get a format which can be easily parsed by
  68 other programs.  Other options are mostly similar to standard C<df>
  69 options.  See below for the complete list.
  70
  71 =head1 OPTIONS
  72
  73 =over 4
  74
  75 =cut
  76
  77 my $help;
  78
  79 =item B<--help>
  80
  81 Display brief help.
  82
  83 =cut
  84
  85 my $version;
  86
  87 =item B<--version>
  88
  89 Display version number and exit.
  90
  91 =cut
  92
  93 my $uri;
  94
  95 =item B<--connect URI> | B<-c URI>
  96
  97 If using libvirt, connect to the given I<URI>.  If omitted, then we
  98 connect to the default libvirt hypervisor.
  99
 100 If you specify guest block devices directly, then libvirt is not used
 101 at all.
 102
 103 =cut
 104
 105 my $csv;
 106
 107 =item B<--csv>
 108
 109 Write out the results in CSV format (comma-separated values).
 110 This format can be imported easily into databases and spreadsheets.
 111
 112 =cut
 113
 114 my $human;
 115
 116 =item B<--human-readable> | B<-h>
 117
 118 Print sizes in human-readable format.
 119
 120 =cut
 121
 122 my $inodes;
 123
 124 =item B<--inodes> | B<-i>
 125
 126 Print inodes instead of blocks.
 127
 128 =back
 129
 130 =cut
 131
 132 GetOptions ("help|?" => \$help,
 133             "version" => \$version,
 134             "connect|c=s" => \$uri,
 135             "csv" => \$csv,
 136             "human-readable|human|h" => \$human,
 137             "inodes|i" => \$inodes,
 138     ) or pod2usage (2);
 139 pod2usage (1) if $help;
 140 if ($version) {
 141     my $g = Sys::Guestfs->new ();
 142     my %h = $g->version ();
 143     print "$h{major}.$h{minor}.$h{release}$h{extra}\n";
 144     exit
 145 }
 146
 147 # Open the guest handle.
 148
 149 if (@ARGV == 0) {
 150     my $conn;
 151
 152     if ($uri) {
 153         $conn = Sys::Virt->new (readonly => 1, address => $uri);
 154     } else {
 155         $conn = Sys::Virt->new (readonly => 1);
 156     }
 157
 158     my @doms = $conn->list_defined_domains ();
 159     push @doms, $conn->list_domains ();
 160
 161     my @domnames = map { $_->get_name () } @doms;
 162
 163     if (@domnames) {
 164         print_title ();
 165         foreach (@domnames) {
 166             do_df ($_);
 167         }
 168     }
 169 } else {
 170     print_title ();
 171     do_df (@ARGV);
 172 }
 173
 174 sub do_df
 175 {
 176     my $g;
 177
 178     if ($uri) {
 179         $g = open_guest (\@_, address => $uri);
 180     } else {
 181         $g = open_guest (\@_);
 182     }
 183
 184     $g->launch ();
 185     $g->wait_ready ();
 186
 187     my @partitions = get_partitions ($g);
 188
 189     # Think of a printable name for this domain.  Just choose the
 190     # first parameter passed to this function, which will work for
 191     # most cases (it'll either be the domain name or the first disk
 192     # image name).
 193     my $domname = $_[0];
 194
 195     # Mount each partition in turn, and if mountable, do a statvfs on it.
 196     foreach my $partition (@partitions) {
 197         my %stat;
 198         eval {
 199             $g->mount_ro ($partition, "/");
 200             %stat = $g->statvfs ("/");
 201         };
 202         if (!$@) {
 203             print_stat ($domname, $partition, \%stat);
 204         }
 205         $g->umount_all ();
 206     }
 207 }
 208
 209 sub print_stat
 210 {
 211     my $domname = shift;
 212     my $partition = shift;
 213     my $stat = shift;
 214
 215     my @cols = ($domname, $partition);
 216
 217     if (!$inodes) {
 218         my $bsize = $stat->{bsize};     # block size
 219         my $blocks = $stat->{blocks};   # total number of blocks
 220         my $bfree = $stat->{bfree};     # blocks free (total)
 221         my $bavail = $stat->{bavail};   # blocks free (for non-root users)
 222
 223         my $factor = $bsize / 1024;
 224
 225         push @cols, $blocks*$factor;    # total 1K blocks
 226         push @cols, ($blocks-$bfree)*$factor; # total 1K blocks used
 227         push @cols, $bavail*$factor;    # total 1K blocks available
 228
 229         # XXX %used column comes out different from the native 'df'
 230         # program.  Need to check how 'df' calculates this.
 231         push @cols, 100.0 - 100.0 * $bavail / $blocks;
 232
 233         if ($human) {
 234             $cols[2] = human_size ($cols[2]);
 235             $cols[3] = human_size ($cols[3]);
 236             $cols[4] = human_size ($cols[4]);
 237         }
 238     } else {
 239         my $files = $stat->{files};     # total number of inodes
 240         my $ffree = $stat->{ffree};     # inodes free (total)
 241         my $favail = $stat->{favail};   # inodes free (for non-root users)
 242
 243         push @cols, $files;
 244         push @cols, $files-$ffree;
 245         push @cols, $ffree;
 246
 247         # XXX %used column comes out different from the native 'df'
 248         # program.  Need to check how 'df' calculates this.
 249         push @cols, 100.0 - 100.0 * $favail / $files;
 250     }
 251
 252     print_cols (@cols);
 253 }
 254
 255 sub print_title
 256 {
 257     my @cols = ("Virtual Machine", "Filesystem");
 258     if (!$inodes) {
 259         if (!$human) {
 260             push @cols, "1K-blocks";
 261         } else {
 262             push @cols, "Size";
 263         }
 264         push @cols, "Used";
 265         push @cols, "Available";
 266         push @cols, "Use%";
 267     } else {
 268         push @cols, "Inodes";
 269         push @cols, "IUsed";
 270         push @cols, "IFree";
 271         push @cols, "IUse%";
 272     }
 273
 274     if (!$csv) {
 275         # ignore $cols[0] in this mode
 276         printf "%-36s%10s %10s %10s %5s\n",
 277           $cols[1], $cols[2], $cols[3], $cols[4], $cols[5];
 278     } else {
 279         print (join (",", @cols), "\n");
 280     }
 281 }
 282
 283 sub print_cols
 284 {
 285     if (!$csv) {
 286         my $label = sprintf "%s:%s", $_[0], $_[1];
 287
 288         printf ("%-36s", $label);
 289         print "\n"," "x32 if length ($label) > 36;
 290
 291         my $percent = sprintf "%3.1f%%", $_[5];
 292         printf ("%10s %10s %10s %5s\n", $_[2], $_[3], $_[4], $percent);
 293     } else {
 294         printf ("\"%s\",\"%s\",%d,%d,%d,%.1f%%\n", @_);
 295     }
 296 }
 297
 298 # Convert a number of 1K blocks to a human-readable number.
 299 sub human_size
 300 {
 301     local $_ = shift;
 302
 303     if ($_ < 1024) {
 304         sprintf "%dK", $_;
 305     } elsif ($_ < 1024 * 1024) {
 306         sprintf "%.1fM", ($_ / 1024);
 307     } else {
 308         sprintf "%.1fG", ($_ / 1024 / 1024);
 309     }
 310 }
 311
 312 =head1 SEE ALSO
 313
 314 L<guestfs(3)>,
 315 L<guestfish(1)>,
 316 L<Sys::Guestfs(3)>,
 317 L<Sys::Guestfs::Lib(3)>,
 318 L<Sys::Virt(3)>,
 319 L<http://libguestfs.org/>.
 320
 321 =head1 AUTHOR
 322
 323 Richard W.M. Jones L<http://et.redhat.com/~rjones/>
 324
 325 =head1 COPYRIGHT
 326
 327 Copyright (C) 2009 Red Hat Inc.
 328
 329 This program is free software; you can redistribute it and/or modify
 330 it under the terms of the GNU General Public License as published by
 331 the Free Software Foundation; either version 2 of the License, or
 332 (at your option) any later version.
 333
 334 This program is distributed in the hope that it will be useful,
 335 but WITHOUT ANY WARRANTY; without even the implied warranty of
 336 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 337 GNU General Public License for more details.
 338
 339 You should have received a copy of the GNU General Public License
 340 along with this program; if not, write to the Free Software
 341 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.