inspector/virt-inspector

   1 #!/usr/bin/perl -w
   2 # virt-inspector
   3 # Copyright (C) 2010 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);
  24 use Pod::Usage;
  25 use Getopt::Long;
  26 use File::Temp qw/tempfile/;
  27 use File::Basename;
  28 use XML::Writer;
  29 use Locale::TextDomain 'libguestfs';
  30
  31 =encoding utf8
  32
  33 =head1 NAME
  34
  35 virt-inspector - Display operating system version and other information about a virtual machine
  36
  37 =head1 SYNOPSIS
  38
  39  virt-inspector [--connect URI] domname
  40
  41  virt-inspector guest.img [guest.img ...]
  42
  43 =head1 DESCRIPTION
  44
  45 B<virt-inspector> examines a virtual machine or disk image and tries
  46 to determine the version of the operating system and other information
  47 about the virtual machine.
  48
  49 Virt-inspector produces XML output for feeding into other programs.
  50
  51 In the normal usage, use C<virt-inspector domname> where C<domname> is
  52 the libvirt domain (see: C<virsh list --all>).
  53
  54 You can also run virt-inspector directly on disk images from a single
  55 virtual machine.  Use C<virt-inspector guest.img>.  In rare cases a
  56 domain has several block devices, in which case you should list them
  57 one after another, with the first corresponding to the guest's
  58 C</dev/sda>, the second to the guest's C</dev/sdb> and so on.
  59
  60 Virt-inspector can only inspect and report upon I<one domain at a
  61 time>.  To inspect several virtual machines, you have to run
  62 virt-inspector several times (for example, from a shell script
  63 for-loop).
  64
  65 Because virt-inspector needs direct access to guest images, it won't
  66 normally work over remote libvirt connections.
  67
  68 =head1 OPTIONS
  69
  70 =over 4
  71
  72 =cut
  73
  74 my $help;
  75
  76 =item B<--help>
  77
  78 Display brief help.
  79
  80 =cut
  81
  82 my $version;
  83
  84 =item B<--version>
  85
  86 Display version number and exit.
  87
  88 =cut
  89
  90 my $uri;
  91
  92 =item B<--connect URI> | B<-c URI>
  93
  94 If using libvirt, connect to the given I<URI>.  If omitted,
  95 then we connect to the default libvirt hypervisor.
  96
  97 Libvirt is only used if you specify a C<domname> on the
  98 command line.  If you specify guest block devices directly,
  99 then libvirt is not used at all.
 100
 101 =cut
 102
 103 my $format;
 104
 105 =item B<--format> raw
 106
 107 Specify the format of disk images given on the command line.  If this
 108 is omitted then the format is autodetected from the content of the
 109 disk image.
 110
 111 If disk images are requested from libvirt, then this program asks
 112 libvirt for this information.  In this case, the value of the format
 113 parameter is ignored.
 114
 115 If working with untrusted raw-format guest disk images, you should
 116 ensure the format is always specified.
 117
 118 =back
 119
 120 =cut
 121
 122 GetOptions ("help|?" => \$help,
 123             "version" => \$version,
 124             "connect|c=s" => \$uri,
 125             "format=s" => \$format,
 126     ) or pod2usage (2);
 127 pod2usage (1) if $help;
 128 if ($version) {
 129     my $g = Sys::Guestfs->new ();
 130     my %h = $g->version ();
 131     print "$h{major}.$h{minor}.$h{release}$h{extra}\n";
 132     exit
 133 }
 134 pod2usage (__"virt-inspector: no image or VM names given") if @ARGV == 0;
 135
 136 my @args = (\@ARGV);
 137 push @args, address => $uri if defined $uri;
 138 push @args, format => $format if defined $format;
 139 my $g = open_guest (@args);
 140
 141 $g->launch ();
 142
 143 my @roots = $g->inspect_os ();
 144 if (@roots == 0) {
 145     die __x("{prog}: No operating system could be detected inside this disk image.\n\nThis may be because the file is not a disk image, or is not a virtual machine\nimage, or because the OS type is not understood by libguestfs.\n\nIf you feel this is an error, please file a bug report including as much\ninformation about the disk image as possible.\n",
 146             prog => basename ($0));
 147 }
 148
 149 =head1 XML FORMAT
 150
 151 The virt-inspector XML is described precisely in a RELAX NG schema
 152 which is supplied with libguestfs.  This section is just an overview.
 153
 154 The top-level element is E<lt>operatingsystemsE<gt>, and it contains
 155 one or more E<lt>operatingsystemE<gt> elements.  You would only see
 156 more than one E<lt>operatingsystemE<gt> element if the virtual machine
 157 is multi-boot, which is vanishingly rare in real world VMs.
 158
 159 =head2 E<lt>operatingsystemE<gt>
 160
 161 In the E<lt>operatingsystemE<gt> tag are various optional fields that
 162 describe the operating system, its architecture, the descriptive
 163 "product name" string, the type of OS and so on, as in this example:
 164
 165  <operatingsystems>
 166    <operatingsystem>
 167      <root>/dev/sda2</root>
 168      <name>windows</name>
 169      <arch>i386</arch>
 170      <distro>windows</distro>
 171      <product_name>Windows 7 Enterprise</product_name>
 172      <major_version>6</major_version>
 173      <minor_version>1</minor_version>
 174      <windows_systemroot>/Windows</windows_systemroot>
 175
 176 These fields are derived from the libguestfs inspection API, and
 177 you can find more details in L<guestfs(3)/INSPECTION>.
 178
 179 The E<lt>rootE<gt> element is the root filesystem device, but from the
 180 point of view of libguestfs (block devices may have completely
 181 different names inside the VM itself).
 182
 183 =cut
 184
 185 # Start the XML output.
 186 my $xml = new XML::Writer (DATA_MODE => 1, DATA_INDENT => 2);
 187
 188 $xml->startTag ("operatingsystems");
 189
 190 my $root;
 191 foreach $root (@roots) {
 192     my %fses = $g->inspect_get_mountpoints ($root);
 193     my @fses = sort { length $a <=> length $b } keys %fses;
 194     foreach (@fses) {
 195         $g->mount_ro ($fses{$_}, $_);
 196     }
 197
 198     $xml->startTag ("operatingsystem");
 199
 200     # Basic OS fields.
 201     $xml->dataElement (root => canonicalize ($root));
 202
 203     my ($s, $distro, $major_version);
 204     $s = $g->inspect_get_type ($root);
 205     $xml->dataElement (name => $s) if $s ne "unknown";
 206     $s = $g->inspect_get_arch ($root);
 207     $xml->dataElement (arch => $s) if $s ne "unknown";
 208     $distro = $g->inspect_get_distro ($root);
 209     $xml->dataElement (distro => $distro) if $distro ne "unknown";
 210     $s = $g->inspect_get_product_name ($root);
 211     $xml->dataElement (product_name => $s) if $s ne "unknown";
 212     $major_version = $g->inspect_get_major_version ($root);
 213     $xml->dataElement (major_version => $major_version);
 214     $s = $g->inspect_get_minor_version ($root);
 215     $xml->dataElement (minor_version => $s);
 216
 217     eval {
 218         $s = $g->inspect_get_windows_systemroot ($root);
 219         $xml->dataElement (windows_systemroot => $s);
 220     };
 221
 222     # Mountpoints.
 223     output_mountpoints ($root, \@fses, \%fses);
 224
 225     # Filesystems.
 226     output_filesystems ($root);
 227
 228     # Package format / management and applications.
 229     output_applications ($root, $distro, $major_version);
 230
 231     $xml->endTag("operatingsystem");
 232
 233     $g->umount_all ();
 234 }
 235
 236 # End the XML output.
 237 $xml->endTag ("operatingsystems");
 238 $xml->end ();
 239
 240 =head2 E<lt>mountpointsE<gt>
 241
 242 Un*x-like guests typically have multiple filesystems which are mounted
 243 at various mountpoints, and these are described in the
 244 E<lt>mountpointsE<gt> element which looks like this:
 245
 246  <operatingsystems>
 247    <operatingsystem>
 248      ...
 249      <mountpoints>
 250        <mountpoint dev="/dev/vg_f13x64/lv_root">/</mountpoint>
 251        <mountpoint dev="/dev/sda1">/boot</mountpoint>
 252      </mountpoints>
 253
 254 As with E<lt>rootE<gt>, devices are from the point of view of
 255 libguestfs, and may have completely different names inside the guest.
 256 Only mountable filesystems appear in this list, not things like swap
 257 devices.
 258
 259 =cut
 260
 261 sub output_mountpoints
 262 {
 263     local $_;
 264     my $root = shift;
 265     my $fskeys = shift;
 266     my $fshash = shift;
 267
 268     $xml->startTag ("mountpoints");
 269     foreach (@$fskeys) {
 270         $xml->dataElement ("mountpoint", $_,
 271                            dev => canonicalize ($fshash->{$_}));
 272     }
 273     $xml->endTag ("mountpoints");
 274 }
 275
 276 =head2 E<lt>filesystemsE<gt>
 277
 278 E<lt>filesystemsE<gt> is like E<lt>mountpointsE<gt> but covers I<all>
 279 filesystems belonging to the guest, including swap and empty
 280 partitions.  (In the rare case of a multi-boot guest, it covers
 281 filesystems belonging to this OS or shared by this OS and other OSes).
 282
 283 You might see something like this:
 284
 285  <operatingsystems>
 286    <operatingsystem>
 287      ...
 288      <filesystems>
 289        <filesystem dev="/dev/vg_f13x64/lv_root">
 290          <type>ext4</type>
 291          <label>Fedora-13-x86_64</label>
 292          <uuid>e6a4db1e-15c2-477b-ac2a-699181c396aa</uuid>
 293        </filesystem>
 294
 295 The optional elements within E<lt>filesystemE<gt> are the filesystem
 296 type, the label, and the UUID.
 297
 298 =cut
 299
 300 sub output_filesystems
 301 {
 302     local $_;
 303     my $root = shift;
 304
 305     $xml->startTag ("filesystems");
 306
 307     my @fses = $g->inspect_get_filesystems ($root);
 308     foreach (@fses) {
 309         $xml->startTag ("filesystem",
 310                         dev => canonicalize ($_));
 311
 312         eval {
 313             my $type = $g->vfs_type ($_);
 314             $xml->dataElement (type => $type)
 315                 if defined $type && $type ne "";
 316         };
 317
 318         eval {
 319             my $label = $g->vfs_label ($_);
 320             $xml->dataElement (label => $label)
 321                 if defined $label && $label ne "";
 322         };
 323
 324         eval {
 325             my $uuid = $g->vfs_uuid ($_);
 326             $xml->dataElement (uuid => $uuid)
 327                 if defined $uuid && $uuid ne "";
 328         };
 329
 330         $xml->endTag ("filesystem");
 331     }
 332
 333     $xml->endTag ("filesystems");
 334 }
 335
 336 =head2 E<lt>applicationsE<gt>
 337
 338 The related elements E<lt>package_formatE<gt>,
 339 E<lt>package_managementE<gt> and E<lt>applicationsE<gt> describe
 340 applications installed in the virtual machine.  At the moment we are
 341 only able to list RPMs installed, but in future we will support other
 342 Linux distros and Windows.
 343
 344 E<lt>package_formatE<gt>, if present, describes the packaging
 345 system used.  Typical values would be C<rpm> and C<deb>.
 346
 347 E<lt>package_managementE<gt>, if present, describes the package
 348 manager.  Typical values include C<yum>, C<up2date> and C<apt>
 349
 350 E<lt>applicationsE<gt> lists the packages or applications
 351 installed.  At present this simply lists them by name:
 352
 353  <operatingsystems>
 354    <operatingsystem>
 355      ...
 356      <applications>
 357        <application>
 358          <name>coreutils</name>
 359        </application>
 360
 361 In future we will also include the version here.
 362
 363 =cut
 364
 365 sub output_applications
 366 {
 367     local $_;
 368     my $root = shift;
 369     my $distro = shift;
 370     my $major_version = shift;
 371
 372     # Based on the distro, take a guess at the package format
 373     # and package management.
 374     my ($package_format, $package_management);
 375     if (defined $distro) {
 376         if ($distro eq "debian") {
 377             $package_format = "deb";
 378             $package_management = "apt";
 379         }
 380         elsif ($distro eq "fedora") {
 381             $package_format = "rpm";
 382             $package_management = "yum";
 383         }
 384         elsif ($distro =~ /redhat/ || $distro =~ /rhel/) {
 385             if ($major_version >= 5) {
 386                 $package_format = "rpm";
 387                 $package_management = "yum";
 388             } else {
 389                 $package_format = "rpm";
 390                 $package_management = "up2date";
 391             }
 392         }
 393         # else unknown.
 394     }
 395
 396     $xml->dataElement (package_format => $package_format)
 397         if defined $package_format;
 398     $xml->dataElement (package_management => $package_management)
 399         if defined $package_management;
 400
 401     # Do we know how to get a list of applications?
 402     if (defined $package_format) {
 403         if ($package_format eq "rpm") {
 404             output_applications_rpm ($root);
 405         }
 406         # else no we don't.
 407     }
 408 }
 409
 410 sub output_applications_rpm
 411 {
 412     local $_;
 413     my $root = shift;
 414
 415     # Previous virt-inspector ran the 'rpm' program from the guest.
 416     # This is insecure, and unnecessary because we can get the same
 417     # information directly from the RPM database.
 418
 419     my @applications;
 420
 421     eval {
 422         my ($fh, $filename) = tempfile (UNLINK => 1);
 423         my $fddev = "/dev/fd/" . fileno ($fh);
 424         $g->download ("/var/lib/rpm/Name", $fddev);
 425         close $fh or die "close: $!";
 426
 427         # Read the database with the Berkeley DB dump tool.
 428         my $cmd = "db_dump -p '$filename'";
 429         open PIPE, "$cmd |" or die "close: $!";
 430         while (<PIPE>) {
 431             chomp;
 432             last if /^HEADER=END$/;
 433         }
 434         while (<PIPE>) {
 435             chomp;
 436             last if /^DATA=END$/;
 437
 438             # First character on each data line is a space.
 439             if (length $_ > 0 && substr ($_, 0, 1) eq ' ') {
 440                 $_ = substr ($_, 1);
 441             }
 442             # Name should never contain non-printable chars.
 443             die "name contains non-printable chars" if /\\/;
 444             push @applications, $_;
 445
 446             $_ = <PIPE>; # discard value
 447         }
 448         close PIPE or die "close: $!";
 449     };
 450     if (!$@ && @applications > 0) {
 451         @applications = sort @applications;
 452         $xml->startTag ("applications");
 453         foreach (@applications) {
 454             $xml->startTag ("application");
 455             $xml->dataElement (name => $_);
 456             $xml->endTag ("application");
 457         }
 458         $xml->endTag ("applications");
 459     }
 460 }
 461
 462 # The reverse of device name translation, see
 463 # BLOCK DEVICE NAMING in guestfs(3).
 464 sub canonicalize
 465 {
 466     local $_ = shift;
 467
 468     if (m{^/dev/[hv]d([a-z]\d)$}) {
 469         return "/dev/sd$1";
 470     }
 471     $_;
 472 }
 473
 474 =head1 USING XPATH
 475
 476 You can use the XPath query language, and/or the xpath tool, in order
 477 to select parts of the XML.
 478
 479 For example:
 480
 481  $ virt-inspector Guest | xpath //filesystems
 482  Found 1 nodes:
 483  -- NODE --
 484  <filesystems>
 485       <filesystem dev="/dev/vg_f13x64/lv_root">
 486         <type>ext4</type>
 487  [etc]
 488
 489  $ virt-inspector Guest | \
 490      xpath "string(//filesystem[@dev='/dev/sda1']/type)"
 491  Query didn't return a nodeset. Value: ext4
 492
 493 =head1 SHELL QUOTING
 494
 495 Libvirt guest names can contain arbitrary characters, some of which
 496 have meaning to the shell such as C<#> and space.  You may need to
 497 quote or escape these characters on the command line.  See the shell
 498 manual page L<sh(1)> for details.
 499
 500 =head1 SEE ALSO
 501
 502 L<guestfs(3)>,
 503 L<guestfish(1)>,
 504 L<Sys::Guestfs(3)>,
 505 L<Sys::Guestfs::Lib(3)>,
 506 L<Sys::Virt(3)>,
 507 L<http://www.w3.org/TR/xpath/>,
 508 L<http://libguestfs.org/>.
 509
 510 =head1 AUTHORS
 511
 512 =over 4
 513
 514 =item *
 515
 516 Richard W.M. Jones L<http://people.redhat.com/~rjones/>
 517
 518 =item *
 519
 520 Matthew Booth L<mbooth@redhat.com>
 521
 522 =back
 523
 524 =head1 COPYRIGHT
 525
 526 Copyright (C) 2010 Red Hat Inc.
 527
 528 This program is free software; you can redistribute it and/or modify
 529 it under the terms of the GNU General Public License as published by
 530 the Free Software Foundation; either version 2 of the License, or
 531 (at your option) any later version.
 532
 533 This program is distributed in the hope that it will be useful,
 534 but WITHOUT ANY WARRANTY; without even the implied warranty of
 535 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 536 GNU General Public License for more details.
 537
 538 You should have received a copy of the GNU General Public License
 539 along with this program; if not, write to the Free Software
 540 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.