3 # Copyright (C) 2009 Red Hat Inc.
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.
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.
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.
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);
29 use File::Temp qw/tempdir/;
31 use Locale::TextDomain 'libguestfs';
37 virt-df - Display free space on virtual filesystems
43 virt-df [--options] domname
45 virt-df [--options] disk.img [disk.img ...]
49 C<virt-df> is a command line tool to display free space on virtual
50 machine filesystems. Unlike other tools, it doesn't just display the
51 amount of space allocated to a virtual machine, but can look inside
52 the virtual machine to see how much space is really being used.
54 It is like the L<df(1)> command, but for virtual machines, except that
55 it also works for Windows virtual machines.
57 If used without any arguments, C<virt-df> checks with libvirt to get a
58 list of all active and inactive guests, and performs a C<df>-type
59 operation on each one in turn, printing out the results.
61 If used with any argument(s), C<virt-df> performs a C<df>-type
62 operation on either the single named libvirt domain, or on the disk
63 image(s) listed on the command line (which must all belong to a single
64 VM). In this mode (with arguments), C<virt-df> will I<only work for a
65 single guest>. If you want to run on multiple guests, then you have
66 to invoke C<virt-df> multiple times.
68 Use the C<--csv> option to get a format which can be easily parsed by
69 other programs. Other options are mostly similar to standard C<df>
70 options. See below for the complete list.
90 Display version number and exit.
96 =item B<--connect URI> | B<-c URI>
98 If using libvirt, connect to the given I<URI>. If omitted, then we
99 connect to the default libvirt hypervisor.
101 If you specify guest block devices directly, then libvirt is not used
110 Write out the results in CSV format (comma-separated values). This
111 format can be imported easily into databases and spreadsheets, but
112 read L</NOTE ABOUT CSV FORMAT> below.
118 =item B<--human-readable> | B<-h>
120 Print sizes in human-readable format.
126 =item B<--inodes> | B<-i>
128 Print inodes instead of blocks.
134 GetOptions ("help|?" => \$help,
135 "version" => \$version,
136 "connect|c=s" => \$uri,
138 "human-readable|human|h" => \$human,
139 "inodes|i" => \$inodes,
141 pod2usage (1) if $help;
143 my $g = Sys::Guestfs->new ();
144 my %h = $g->version ();
145 print "$h{major}.$h{minor}.$h{release}$h{extra}\n";
149 # Open the guest handle.
155 $conn = Sys::Virt->new (readonly => 1, address => $uri);
157 $conn = Sys::Virt->new (readonly => 1);
160 my @doms = $conn->list_defined_domains ();
161 push @doms, $conn->list_domains ();
163 # https://bugzilla.redhat.com/show_bug.cgi?id=538041
164 @doms = grep { $_->get_id () != 0 } @doms;
166 my @domnames = map { $_->get_name () } @doms;
170 foreach (@domnames) {
171 eval { do_df ($_); };
185 $g = open_guest (\@_, address => $uri);
187 $g = open_guest (\@_);
192 my @partitions = get_partitions ($g);
194 # Think of a printable name for this domain. Just choose the
195 # first parameter passed to this function, which will work for
196 # most cases (it'll either be the domain name or the first disk
200 # Mount each partition in turn, and if mountable, do a statvfs on it.
201 foreach my $partition (@partitions) {
204 $g->mount_ro ($partition, "/");
205 %stat = $g->statvfs ("/");
208 print_stat ($domname, $partition, \%stat);
217 my $partition = shift;
220 my @cols = ($domname, $partition);
223 my $bsize = $stat->{bsize}; # block size
224 my $blocks = $stat->{blocks}; # total number of blocks
225 my $bfree = $stat->{bfree}; # blocks free (total)
226 my $bavail = $stat->{bavail}; # blocks free (for non-root users)
228 my $factor = $bsize / 1024;
230 push @cols, $blocks*$factor; # total 1K blocks
231 push @cols, ($blocks-$bfree)*$factor; # total 1K blocks used
232 push @cols, $bavail*$factor; # total 1K blocks available
234 # XXX %used column comes out different from the native 'df'
235 # program. Need to check how 'df' calculates this.
236 push @cols, 100.0 - 100.0 * $bavail / $blocks;
239 $cols[2] = human_size ($cols[2]);
240 $cols[3] = human_size ($cols[3]);
241 $cols[4] = human_size ($cols[4]);
244 my $files = $stat->{files}; # total number of inodes
245 my $ffree = $stat->{ffree}; # inodes free (total)
246 my $favail = $stat->{favail}; # inodes free (for non-root users)
249 push @cols, $files-$ffree;
252 # XXX %used column comes out different from the native 'df'
253 # program. Need to check how 'df' calculates this.
254 push @cols, 100.0 - 100.0 * $favail / $files;
262 my @cols = (__"Virtual Machine", __"Filesystem");
265 push @cols, __"1K-blocks";
267 push @cols, __"Size";
269 push @cols, __"Used";
270 push @cols, __"Available";
271 push @cols, __"Use%";
273 push @cols, __"Inodes";
274 push @cols, __"IUsed";
275 push @cols, __"IFree";
276 push @cols, __"IUse%";
280 # ignore $cols[0] in this mode
281 printf "%-36s%10s %10s %10s %5s\n",
282 $cols[1], $cols[2], $cols[3], $cols[4], $cols[5];
284 print (join (",", @cols), "\n");
291 my $label = sprintf "%s:%s", $_[0], $_[1];
293 printf ("%-36s", $label);
294 print "\n"," "x36 if length ($label) > 36;
296 my $percent = sprintf "%3.1f%%", $_[5];
297 printf ("%10s %10s %10s %5s\n", $_[2], $_[3], $_[4], $percent);
299 printf ("\"%s\",\"%s\",%d,%d,%d,%.1f%%\n", @_);
303 # Convert a number of 1K blocks to a human-readable number.
310 } elsif ($_ < 1024 * 1024) {
311 sprintf "%.1fM", ($_ / 1024);
313 sprintf "%.1fG", ($_ / 1024 / 1024);
317 =head1 NOTE ABOUT CSV FORMAT
319 Comma-separated values (CSV) is a deceptive format. It I<seems> like
320 it should be easy to parse, but it is definitely not easy to parse.
322 Myth: Just split fields at commas. Reality: This does I<not> work
323 reliably. This example has two columns:
327 Myth: Read the file one line at a time. Reality: This does I<not>
328 work reliably. This example has one row:
333 For shell scripts, use C<csvtool> (L<http://merjis.com/developers/csv>
334 also packaged in major Linux distributions).
336 For other languages, use a CSV processing library (eg. C<Text::CSV>
337 for Perl or Python's built-in csv library).
339 Most spreadsheets and databases can import CSV directly.
346 L<Sys::Guestfs::Lib(3)>,
348 L<http://libguestfs.org/>.
352 Richard W.M. Jones L<http://et.redhat.com/~rjones/>
356 Copyright (C) 2009 Red Hat Inc.
358 This program is free software; you can redistribute it and/or modify
359 it under the terms of the GNU General Public License as published by
360 the Free Software Foundation; either version 2 of the License, or
361 (at your option) any later version.
363 This program is distributed in the hope that it will be useful,
364 but WITHOUT ANY WARRANTY; without even the implied warranty of
365 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
366 GNU General Public License for more details.
368 You should have received a copy of the GNU General Public License
369 along with this program; if not, write to the Free Software
370 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.