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.
26 use File::Temp qw/tempdir/;
30 eval "use Sys::Virt;";
31 eval "use XML::XPath;";
32 eval "use XML::XPath::XMLParser;";
33 eval "use YAML::Any;";
39 virt-inspector - Display OS version, kernel, drivers, mount points, applications, etc. in a virtual machine
43 virt-inspector [--connect URI] domname
45 virt-inspector guest.img [guest.img ...]
49 B<virt-inspector> examines a virtual machine and tries to determine
50 the version of the OS, the kernel version, what drivers are installed,
51 whether the virtual machine is fully virtualized (FV) or
52 para-virtualized (PV), what applications are installed and more.
54 Virt-inspector can produce output in several formats, including a
55 readable text report, and XML for feeding into other programs.
57 Virt-inspector should only be run on I<inactive> virtual machines.
58 The program tries to determine that the machine is inactive and will
59 refuse to run if it thinks you are trying to inspect a running domain.
61 In the normal usage, use C<virt-inspector domname> where C<domname> is
62 the libvirt domain (see: C<virsh list --all>).
64 You can also run virt-inspector directly on disk images from a single
65 virtual machine. Use C<virt-inspector guest.img>. In rare cases a
66 domain has several block devices, in which case you should list them
67 one after another, with the first corresponding to the guest's
68 C</dev/sda>, the second to the guest's C</dev/sdb> and so on.
70 Virt-inspector can only inspect and report upon I<one domain at a
71 time>. To inspect several virtual machines, you have to run
72 virt-inspector several times (for example, from a shell script
75 Because virt-inspector needs direct access to guest images, it won't
76 normally work over remote libvirt connections.
94 =item B<--connect URI> | B<-c URI>
96 If using libvirt, connect to the given I<URI>. If omitted,
97 then we connect to the default libvirt hypervisor.
99 Libvirt is only used if you specify a C<domname> on the
100 command line. If you specify guest block devices directly,
101 then libvirt is not used at all.
109 Force reading a particular guest even if it appears to be active. In
110 earlier versions of virt-inspector, this could be dangerous (for
111 example, corrupting the guest's disk image). However in more recent
112 versions, it should not cause corruption, but might cause
113 virt-inspector to crash or produce incorrect results.
121 The following options select the output format. Use only one of them.
122 The default is a readable text report.
126 =item B<--text> (default)
132 Produce no output at all.
136 If you select I<--xml> then you get XML output which can be fed
141 If you select I<--yaml> then you get YAML output which can be fed
146 If you select I<--perl> then you get Perl structures output which
147 can be used directly in another Perl program.
153 If you select I<--fish> then we print a L<guestfish(1)> command
154 line which will automatically mount up the filesystems on the
155 correct mount points. Try this for example:
157 guestfish $(virt-inspector --fish guest.img)
159 I<--ro-fish> is the same, but the I<--ro> option is passed to
160 guestfish so that the filesystems are mounted read-only.
164 In "query mode" we answer common questions about the guest, such
165 as whether it is fullvirt or needs a Xen hypervisor to run.
167 See section I<QUERY MODE> below.
171 my $windows_registry;
173 =item B<--windows-registry>
175 If this item is passed, I<and> the guest is Windows, I<and> the
176 external program C<reged> is available (see SEE ALSO section), then we
177 attempt to parse the Windows registry. This allows much more
178 information to be gathered for Windows guests.
180 This is quite an expensive and slow operation, so we don't do it by
187 GetOptions ("help|?" => \$help,
188 "connect|c=s" => \$uri,
190 "text" => sub { $output = "text" },
191 "none" => sub { $output = "none" },
192 "xml" => sub { $output = "xml" },
193 "yaml" => sub { $output = "yaml" },
194 "perl" => sub { $output = "perl" },
195 "fish" => sub { $output = "fish" },
196 "guestfish" => sub { $output = "fish" },
197 "ro-fish" => sub { $output = "ro-fish" },
198 "ro-guestfish" => sub { $output = "ro-fish" },
199 "query" => sub { $output = "query" },
200 "windows-registry" => \$windows_registry,
202 pod2usage (1) if $help;
203 pod2usage ("$0: no image or VM names given") if @ARGV == 0;
205 # Domain name or guest image(s)?
213 die "guest image $_ does not exist or is not readable\n"
217 die "virt-inspector: no libvirt support (install Sys::Virt, XML::XPath and XML::XPath::XMLParser)\n"
218 unless exists $INC{"Sys/Virt.pm"} &&
219 exists $INC{"XML/XPath.pm"} &&
220 exists $INC{"XML/XPath/XMLParser.pm"};
222 pod2usage ("$0: too many domains listed on command line") if @ARGV > 1;
226 $vmm = Sys::Virt->new (uri => $uri, readonly => 1);
228 $vmm = Sys::Virt->new (readonly => 1);
230 die "cannot connect to libvirt $uri\n" unless $vmm;
232 my @doms = $vmm->list_defined_domains ();
233 my $isitinactive = "an inactive libvirt domain";
234 if ($output ne "fish") {
235 # In the special case where we want read-only access to
236 # a domain, allow the user to specify an active domain too.
237 push @doms, $vmm->list_domains ();
238 $isitinactive = "a libvirt domain";
242 if ($_->get_name () eq $ARGV[0]) {
247 die "$ARGV[0] is not the name of $isitinactive\n" unless $dom;
249 # Get the names of the image(s).
250 my $xml = $dom->get_xml_description ();
252 my $p = XML::XPath->new (xml => $xml);
253 my @disks = $p->findnodes ('//devices/disk/source/@dev');
254 @images = map { $_->getData } @disks;
257 # We've now got the list of @images, so feed them to libguestfs.
258 my $g = Sys::Guestfs->new ();
259 $g->add_drive_ro ($_) foreach @images;
263 # We want to get the list of LVs and partitions (ie. anything that
264 # could contain a filesystem). Discard any partitions which are PVs.
265 my @partitions = $g->list_partitions ();
266 my @pvs = $g->pvs ();
270 return 1 if $_ eq $t;
274 @partitions = grep { ! is_pv ($_) } @partitions;
276 my @lvs = $g->lvs ();
282 Linux (distro + version)
286 +--- Filesystems ---------- Installed apps --- Kernel & drivers
287 ----------- -------------- ----------------
288 mount point => device List of apps Extra information
289 mount point => device and versions about kernel(s)
292 (plus lots of extra information
293 about each filesystem)
295 The output of virt-inspector is a complex two-level data structure.
297 At the top level is a list of the operating systems installed on the
298 guest. (For the vast majority of guests, only a single OS is
299 installed.) The data returned for the OS includes the name (Linux,
300 Windows), the distribution and version.
302 The diagram above shows what we return for each OS.
304 With the I<--xml> option the output is mapped into an XML document.
305 Unfortunately there is no clear schema for this document
306 (contributions welcome) but you can get an idea of the format by
307 looking at other documents and as a last resort the source for this
310 With the I<--fish> or I<--ro-fish> option the mount points are mapped to
311 L<guestfish(1)> command line parameters, so that you can go in
312 afterwards and inspect the guest with everything mounted in the
313 right place. For example:
315 guestfish $(virt-inspector --ro-fish guest.img)
316 ==> guestfish --ro -a guest.img -m /dev/VG/LV:/ -m /dev/sda1:/boot
320 # List of possible filesystems.
321 my @devices = sort (@lvs, @partitions);
323 # Now query each one to build up a picture of what's in it.
324 my %fses = map { $_ => check_fs ($_) } @devices;
326 # Now the complex checking code itself.
327 # check_fs takes a device name (LV or partition name) and returns
328 # a hashref containing everything we can find out about the device.
331 my $dev = shift; # LV or partition name.
333 my %r; # Result hash.
335 # First try 'file(1)' on it.
336 my $file = $g->file ($dev);
337 if ($file =~ /ext2 filesystem data/) {
340 } elsif ($file =~ /ext3 filesystem data/) {
343 } elsif ($file =~ /ext4 filesystem data/) {
346 } elsif ($file =~ m{Linux/i386 swap file}) {
352 # If it's ext2/3/4, then we want the UUID and label.
353 if (exists $r{fstype} && $r{fstype} =~ /^ext/) {
354 $r{uuid} = $g->get_e2uuid ($dev);
355 $r{label} = $g->get_e2label ($dev);
358 # Try mounting it, fnarrr.
360 $r{is_mountable} = 1;
361 eval { $g->mount_ro ($dev, "/") };
363 # It's not mountable, probably empty or some format
364 # we don't understand.
365 $r{is_mountable} = 0;
370 if ($g->is_file ("/grub/menu.lst") ||
371 $g->is_file ("/grub/grub.conf")) {
372 $r{content} = "linux-grub";
378 if ($g->is_dir ("/etc") && $g->is_dir ("/bin") &&
379 $g->is_file ("/etc/fstab")) {
380 $r{content} = "linux-root";
382 check_linux_root (\%r);
387 if ($g->is_dir ("/etc") && $g->is_dir ("/bin") &&
388 $g->is_dir ("/share") && !$g->exists ("/local") &&
389 !$g->is_file ("/etc/fstab")) {
390 $r{content} = "linux-usrlocal";
395 if ($g->is_dir ("/etc") && $g->is_dir ("/bin") &&
396 $g->is_dir ("/share") && $g->exists ("/local") &&
397 !$g->is_file ("/etc/fstab")) {
398 $r{content} = "linux-usr";
403 if ($g->is_file ("/AUTOEXEC.BAT") ||
404 $g->is_file ("/autoexec.bat") ||
405 $g->is_dir ("/Program Files") ||
406 $g->is_dir ("/WINDOWS") ||
407 $g->is_file ("/boot.ini") ||
408 $g->is_file ("/ntldr")) {
409 $r{fstype} = "ntfs"; # XXX this is a guess
410 $r{fsos} = "windows";
411 $r{content} = "windows-root";
413 check_windows_root (\%r);
428 # Look into /etc to see if we recognise the operating system.
429 if ($g->is_file ("/etc/redhat-release")) {
430 $_ = $g->cat ("/etc/redhat-release");
431 if (/Fedora release (\d+\.\d+)/) {
432 $r->{osdistro} = "fedora";
433 $r->{osversion} = "$1"
434 } elsif (/(Red Hat Enterprise Linux|CentOS|Scientific Linux).*release (\d+).*Update (\d+)/) {
435 $r->{osdistro} = "redhat";
436 $r->{osversion} = "$2.$3";
437 } elsif (/(Red Hat Enterprise Linux|CentOS|Scientific Linux).*release (\d+(?:\.(\d+))?)/) {
438 $r->{osdistro} = "redhat";
439 $r->{osversion} = "$2";
441 $r->{osdistro} = "redhat";
443 } elsif ($g->is_file ("/etc/debian_version")) {
444 $_ = $g->cat ("/etc/debian_version");
446 $r->{osdistro} = "debian";
447 $r->{osversion} = "$1";
449 $r->{osdistro} = "debian";
453 # Parse the contents of /etc/fstab. This is pretty vital so
454 # we can determine where filesystems are supposed to be mounted.
455 eval "\$_ = \$g->cat ('/etc/fstab');";
457 my @lines = split /\n/;
460 my @fields = split /[ \t]+/;
462 my $spec = $fields[0]; # first column (dev/label/uuid)
463 my $file = $fields[1]; # second column (mountpoint)
464 if ($spec =~ m{^/} ||
465 $spec =~ m{^LABEL=} ||
466 $spec =~ m{^UUID=} ||
468 push @fstab, [$spec, $file]
472 $r->{fstab} = \@fstab if @fstab;
476 # We only support NT. The control file /boot.ini contains a list of
477 # Windows installations and their %systemroot%s in a simple text
480 # XXX We could parse this better. This won't work if /boot.ini is on
481 # a different drive from the %systemroot%, and in other unusual cases.
483 sub check_windows_root
488 my $boot_ini = resolve_windows_path ("/", "boot.ini");
489 $r->{boot_ini} = $boot_ini;
491 if (defined $r->{boot_ini}) {
492 $_ = $g->cat ($boot_ini);
493 my @lines = split /\n/;
499 } elsif (m/^default=.*?\\(\w+)$/i) {
502 } elsif (m/\\(\w+)=/) {
508 if (defined $systemroot) {
509 $r->{systemroot} = resolve_windows_path ("/", $systemroot);
510 if (defined $r->{systemroot} && $windows_registry) {
511 check_windows_registry ($r, $r->{systemroot});
517 sub check_windows_registry
521 my $systemroot = shift;
523 # Download the system registry files. Only download the
524 # interesting ones, and we don't bother with user profiles at all.
525 my $system32 = resolve_windows_path ($systemroot, "system32");
526 if (defined $system32) {
527 my $config = resolve_windows_path ($system32, "config");
528 if (defined $config) {
529 my $software = resolve_windows_path ($config, "software");
530 if (defined $software) {
531 load_windows_registry ($r, $software,
532 "HKEY_LOCAL_MACHINE\\SOFTWARE");
534 my $system = resolve_windows_path ($config, "system");
535 if (defined $system) {
536 load_windows_registry ($r, $system,
537 "HKEY_LOCAL_MACHINE\\System");
543 sub load_windows_registry
550 my $dir = tempdir (CLEANUP => 1);
552 $g->download ($regfile, "$dir/reg");
554 # 'reged' command is particularly noisy. Redirect stdout and
555 # stderr to /dev/null temporarily.
556 open SAVEOUT, ">&STDOUT";
557 open SAVEERR, ">&STDERR";
558 open STDOUT, ">/dev/null";
559 open STDERR, ">/dev/null";
561 my @cmd = ("reged", "-x", "$dir/reg", "$prefix", "\\", "$dir/out");
562 my $res = system (@cmd);
566 open STDOUT, ">&SAVEOUT";
567 open STDERR, ">&SAVEERR";
572 warn "reged command failed: $?";
576 # Some versions of reged segfault on inputs. If that happens we
577 # may get no / partial output file. Anyway, if it exists, load
580 unless (open F, "$dir/out") {
581 warn "no output from reged command: $!";
584 { local $/ = undef; $content = <F>; }
588 @registry = @{$r->{registry}} if exists $r->{registry};
589 push @registry, $content;
590 $r->{registry} = \@registry;
593 # Because of case sensitivity, the actual path might have a different
594 # name, and ntfs-3g is always case sensitive. Find out what the real
595 # path is. Returns the correct full path, or undef.
596 sub resolve_windows_path
599 my $parent = shift; # Must exist, with correct case.
602 foreach ($g->ls ($parent)) {
603 if (lc ($_) eq lc ($dir)) {
604 if ($parent eq "/") {
620 # Grub version, if we care.
623 #print Dumper (\%fses);
625 #----------------------------------------------------------------------
626 # Now find out how many operating systems we've got. Usually just one.
630 foreach (sort keys %fses) {
631 if ($fses{$_}->{is_root}) {
636 get_os_version (\%r);
637 assign_mount_points (\%r);
647 $r->{os} = $r->{root}->{fsos} if exists $r->{root}->{fsos};
648 $r->{distro} = $r->{root}->{osdistro} if exists $r->{root}->{osdistro};
649 $r->{version} = $r->{root}->{osversion} if exists $r->{root}->{osversion};
652 sub assign_mount_points
657 $r->{mounts} = { "/" => $r->{root_device} };
658 $r->{filesystems} = { $r->{root_device} => $r->{root} };
660 # Use /etc/fstab if we have it to mount the rest.
661 if (exists $r->{root}->{fstab}) {
662 my @fstab = @{$r->{root}->{fstab}};
664 my ($spec, $file) = @$_;
666 my ($dev, $fs) = find_filesystem ($spec);
668 $r->{mounts}->{$file} = $dev;
669 $r->{filesystems}->{$dev} = $fs;
670 if (exists $fs->{used}) {
680 # Find filesystem by device name, LABEL=.. or UUID=..
687 foreach (sort keys %fses) {
688 if (exists $fses{$_}->{label} &&
689 $fses{$_}->{label} eq $label) {
690 return ($_, $fses{$_});
693 warn "unknown filesystem label $label\n";
695 } elsif (/^UUID=(.*)/) {
697 foreach (sort keys %fses) {
698 if (exists $fses{$_}->{uuid} &&
699 $fses{$_}->{uuid} eq $uuid) {
700 return ($_, $fses{$_});
703 warn "unknown filesystem UUID $uuid\n";
706 return ($_, $fses{$_}) if exists $fses{$_};
708 if (m{^/dev/hd(.*)} && exists $fses{"/dev/sd$1"}) {
709 return ("/dev/sd$1", $fses{"/dev/sd$1"});
711 if (m{^/dev/xvd(.*)} && exists $fses{"/dev/sd$1"}) {
712 return ("/dev/sd$1", $fses{"/dev/sd$1"});
715 return () if m{/dev/cdrom};
717 warn "unknown filesystem $_\n";
722 #print Dumper(\%oses);
724 #----------------------------------------------------------------------
725 # Mount up the disks so we can check for applications
726 # and kernels. Skip this if the output is "*fish" because
727 # we don't need to know.
729 if ($output !~ /.*fish$/) {
730 # Temporary directory for use by check_for_initrd.
731 my $dir = tempdir (CLEANUP => 1);
734 foreach $root_dev (sort keys %oses) {
735 my $mounts = $oses{$root_dev}->{mounts};
736 # Have to mount / first. Luckily '/' is early in the ASCII
737 # character set, so this should be OK.
738 foreach (sort keys %$mounts) {
739 $g->mount_ro ($mounts->{$_}, $_)
740 if $_ ne "swap" && ($_ eq '/' || $g->is_dir ($_));
743 check_for_applications ($root_dev);
744 check_for_kernels ($root_dev);
745 if ($oses{$root_dev}->{os} eq "linux") {
746 check_for_modprobe_aliases ($root_dev);
747 check_for_initrd ($root_dev, $dir);
754 sub check_for_applications
757 my $root_dev = shift;
761 my $os = $oses{$root_dev}->{os};
762 if ($os eq "linux") {
763 my $distro = $oses{$root_dev}->{distro};
764 if (defined $distro && ($distro eq "redhat" || $distro eq "fedora")) {
765 my @lines = $g->command_lines
768 "--qf", "%{name} %{epoch} %{version} %{release} %{arch}\n"]);
770 if (m/^(.*) (.*) (.*) (.*) (.*)$/) {
772 $epoch = "" if $epoch eq "(none)";
784 } elsif ($os eq "windows") {
786 # I worked out a general plan for this, but haven't
787 # implemented it yet. We can iterate over /Program Files
788 # looking for *.EXE files, which we download, then use
789 # i686-pc-mingw32-windres on, to find the VERSIONINFO
790 # section, which has a lot of useful information.
793 $oses{$root_dev}->{apps} = \@apps;
796 sub check_for_kernels
799 my $root_dev = shift;
803 my $os = $oses{$root_dev}->{os};
804 if ($os eq "linux") {
805 # Installed kernels will have a corresponding /lib/modules/<version>
806 # directory, which is the easiest way to find out what kernels
807 # are installed, and what modules are available.
808 foreach ($g->ls ("/lib/modules")) {
809 if ($g->is_dir ("/lib/modules/$_")) {
811 $kernel{version} = $_;
815 foreach ($g->find ("/lib/modules/$_")) {
816 if (m,/([^/]+)\.ko$, || m,([^/]+)\.o$,) {
821 $kernel{modules} = \@modules;
823 push @kernels, \%kernel;
827 } elsif ($os eq "windows") {
831 $oses{$root_dev}->{kernels} = \@kernels;
834 # Check /etc/modprobe.conf to see if there are any specified
835 # drivers associated with network (ethX) or hard drives. Normally
836 # one might find something like:
839 # alias scsi_hostadapter xenblk
841 # XXX This doesn't look beyond /etc/modprobe.conf, eg. in /etc/modprobe.d/
843 sub check_for_modprobe_aliases
846 my $root_dev = shift;
850 $success = $g->aug_init("/", 16);
852 # Register /etc/modules.conf and /etc/conf.modules to the Modprobe lens
854 @results = $g->aug_match("/augeas/load/Modprobe/incl");
856 # Calculate the next index of /augeas/load/Modprobe/incl
858 foreach ( @results ) {
859 next unless m{/augeas/load/Modprobe/incl\[(\d*)]};
860 $i = $1 + 1 if ($1 == $i);
863 $success = $g->aug_set("/augeas/load/Modprobe/incl[$i]",
864 "/etc/modules.conf");
866 $success = $g->aug_set("/augeas/load/Modprobe/incl[$i]",
867 "/etc/conf.modules");
870 $success = $g->aug_load();
872 my %modprobe_aliases;
874 for my $pattern qw(/files/etc/conf.modules/alias
875 /files/etc/modules.conf/alias
876 /files/etc/modprobe.conf/alias
877 /files/etc/modprobe.d/*/alias) {
878 @results = $g->aug_match($pattern);
880 for my $path ( @results ) {
882 $alias = $g->aug_get($path);
885 $modulename = $g->aug_get($path.'/modulename');
887 $modprobe_aliases{$alias} = $modulename;
891 $oses{$root_dev}->{modprobe_aliases} = \%modprobe_aliases;
894 # Get a listing of device drivers in any initrd corresponding to a
895 # kernel. This is an indication of what can possibly be booted.
900 my $root_dev = shift;
905 foreach my $initrd ($g->ls ("/boot")) {
906 if ($initrd =~ m/^initrd-(.*)\.img$/ && $g->is_file ("/boot/$initrd")) {
909 # We have to download these to a temporary file.
910 $g->download ("/boot/$initrd", "$dir/initrd");
912 my $cmd = "zcat $dir/initrd | file -";
913 open P, "$cmd |" or die "$cmd: $!";
915 { local $/ = undef; $lines = <P>; }
917 if ($lines =~ /ext\d filesystem data/) {
918 # Before initramfs came along, these were compressed
919 # ext2 filesystems. We could run another libguestfs
920 # instance to unpack these, but punt on them for now. (XXX)
921 warn "initrd image is unsupported ext2/3/4 filesystem\n";
923 elsif ($lines =~ /cpio/) {
924 my $cmd = "zcat $dir/initrd | cpio --quiet -it";
925 open P, "$cmd |" or die "$cmd: $!";
928 if m,([^/]+)\.ko$, || m,([^/]+)\.o$,;
931 unlink "$dir/initrd";
932 $initrd_modules{$version} = \@modules;
936 warn "unrecognized initrd image: $lines\n";
941 $oses{$root_dev}->{initrd_modules} = \%initrd_modules;
944 #----------------------------------------------------------------------
947 if ($output eq "fish" || $output eq "ro-fish") {
948 my @osdevs = keys %oses;
949 # This only works if there is a single OS.
950 die "--fish output is only possible with a single OS\n" if @osdevs != 1;
952 my $root_dev = $osdevs[0];
954 if ($output eq "ro-fish") {
958 print "-a $_ " foreach @images;
960 my $mounts = $oses{$root_dev}->{mounts};
961 # Have to mount / first. Luckily '/' is early in the ASCII
962 # character set, so this should be OK.
963 foreach (sort keys %$mounts) {
964 print "-m $mounts->{$_}:$_ " if $_ ne "swap";
970 elsif ($output eq "perl") {
971 print Dumper(\%oses);
975 elsif ($output eq "yaml") {
976 die "virt-inspector: no YAML support\n"
977 unless exists $INC{"YAML/Any.pm"};
982 # Plain text output (the default).
983 elsif ($output eq "text") {
988 elsif ($output eq "xml") {
993 elsif ($output eq "query") {
999 output_text_os ($oses{$_}) foreach sort keys %oses;
1006 print $os->{os}, " " if exists $os->{os};
1007 print $os->{distro}, " " if exists $os->{distro};
1008 print $os->{version}, " " if exists $os->{version};
1009 print "on ", $os->{root_device}, ":\n";
1011 print " Mountpoints:\n";
1012 my $mounts = $os->{mounts};
1013 foreach (sort keys %$mounts) {
1014 printf " %-30s %s\n", $mounts->{$_}, $_
1017 print " Filesystems:\n";
1018 my $filesystems = $os->{filesystems};
1019 foreach (sort keys %$filesystems) {
1021 print " label: $filesystems->{$_}{label}\n"
1022 if exists $filesystems->{$_}{label};
1023 print " UUID: $filesystems->{$_}{uuid}\n"
1024 if exists $filesystems->{$_}{uuid};
1025 print " type: $filesystems->{$_}{fstype}\n"
1026 if exists $filesystems->{$_}{fstype};
1027 print " content: $filesystems->{$_}{content}\n"
1028 if exists $filesystems->{$_}{content};
1031 if (exists $os->{modprobe_aliases}) {
1032 my %aliases = %{$os->{modprobe_aliases}};
1033 my @keys = sort keys %aliases;
1035 print " Modprobe aliases:\n";
1037 printf " %-30s %s\n", $_, $aliases{$_}
1042 if (exists $os->{initrd_modules}) {
1043 my %modvers = %{$os->{initrd_modules}};
1044 my @keys = sort keys %modvers;
1046 print " Initrd modules:\n";
1048 my @modules = @{$modvers{$_}};
1050 print " $_\n" foreach @modules;
1055 print " Applications:\n";
1056 my @apps = @{$os->{apps}};
1058 print " $_->{name} $_->{version}\n"
1061 print " Kernels:\n";
1062 my @kernels = @{$os->{kernels}};
1063 foreach (@kernels) {
1064 print " $_->{version}\n";
1065 my @modules = @{$_->{modules}};
1066 foreach (@modules) {
1071 if (exists $os->{root}->{registry}) {
1072 print " Windows Registry entries:\n";
1073 # These are just lumps of text - dump them out.
1074 foreach (@{$os->{root}->{registry}}) {
1082 my $xml = new XML::Writer(DATA_MODE => 1, DATA_INDENT => 2);
1084 $xml->startTag("operatingsystems");
1085 output_xml_os ($oses{$_}, $xml) foreach sort keys %oses;
1086 $xml->endTag("operatingsystems");
1093 my ($os, $xml) = @_;
1095 $xml->startTag("operatingsystem");
1097 foreach ( [ "name" => "os" ],
1098 [ "distro" => "distro" ],
1099 [ "version" => "version" ],
1100 [ "root" => "root_device" ] ) {
1101 $xml->dataElement($_->[0], $os->{$_->[1]}) if exists $os->{$_->[1]};
1104 $xml->startTag("mountpoints");
1105 my $mounts = $os->{mounts};
1106 foreach (sort keys %$mounts) {
1107 $xml->dataElement("mountpoint", $_, "dev" => $mounts->{$_});
1109 $xml->endTag("mountpoints");
1111 $xml->startTag("filesystems");
1112 my $filesystems = $os->{filesystems};
1113 foreach (sort keys %$filesystems) {
1114 $xml->startTag("filesystem", "dev" => $_);
1116 foreach my $field ( [ "label" => "label" ],
1117 [ "uuid" => "uuid" ],
1118 [ "type" => "fstype" ],
1119 [ "content" => "content" ] ) {
1120 $xml->dataElement($field->[0], $filesystems->{$_}{$field->[1]})
1121 if exists $filesystems->{$_}{$field->[1]};
1124 $xml->endTag("filesystem");
1126 $xml->endTag("filesystems");
1128 if (exists $os->{modprobe_aliases}) {
1129 my %aliases = %{$os->{modprobe_aliases}};
1130 my @keys = sort keys %aliases;
1132 $xml->startTag("modprobealiases");
1134 $xml->dataElement("alias", $aliases{$_}, "device" => $_);
1136 $xml->endTag("modprobealiases");
1140 if (exists $os->{initrd_modules}) {
1141 my %modvers = %{$os->{initrd_modules}};
1142 my @keys = sort keys %modvers;
1144 $xml->startTag("initrds");
1146 my @modules = @{$modvers{$_}};
1147 $xml->startTag("initrd", "version" => $_);
1148 $xml->dataElement("module", $_) foreach @modules;
1149 $xml->endTag("initrd");
1151 $xml->endTag("initrds");
1155 $xml->startTag("applications");
1156 my @apps = @{$os->{apps}};
1158 $xml->startTag("application");
1159 $xml->dataElement("name", $_->{name});
1160 $xml->dataElement("version", $_->{version});
1161 $xml->endTag("application");
1163 $xml->endTag("applications");
1165 $xml->startTag("kernels");
1166 my @kernels = @{$os->{kernels}};
1167 foreach (@kernels) {
1168 $xml->startTag("kernel", "version" => $_->{version});
1169 $xml->startTag("modules");
1170 my @modules = @{$_->{modules}};
1171 foreach (@modules) {
1172 $xml->dataElement("module", $_);
1174 $xml->endTag("modules");
1175 $xml->endTag("kernel");
1177 $xml->endTag("kernels");
1179 if (exists $os->{root}->{registry}) {
1180 $xml->startTag("windowsregistryentries");
1181 # These are just lumps of text - dump them out.
1182 foreach (@{$os->{root}->{registry}}) {
1183 $xml->dataElement("windowsregistryentry", $_);
1185 $xml->endTag("windowsregistryentries");
1188 $xml->endTag("operatingsystem");
1193 When you use C<virt-inspector --query>, the output is a series of
1201 (each answer is usually C<yes> or C<no>, or the line is completely
1202 missing if we could not determine the answer at all).
1204 If the guest is multiboot, you can get apparently conflicting answers
1205 (eg. C<windows=yes> and C<linux=yes>, or a guest which is both
1206 fullvirt and has a Xen PV kernel). This is normal, and just means
1207 that the guest can do both things, although it might require operator
1208 intervention such as selecting a boot option when the guest is
1211 This section describes the full range of answers possible.
1219 output_query_windows ();
1220 output_query_linux ();
1221 output_query_rhel ();
1222 output_query_fedora ();
1223 output_query_debian ();
1224 output_query_fullvirt ();
1225 output_query_xen_domU_kernel ();
1226 output_query_xen_pv_drivers ();
1227 output_query_virtio_drivers ();
1230 =item windows=(yes|no)
1232 Answer C<yes> if Microsoft Windows is installed in the guest.
1236 sub output_query_windows
1239 foreach my $os (keys %oses) {
1240 $windows="yes" if $oses{$os}->{os} eq "windows";
1242 print "windows=$windows\n";
1245 =item linux=(yes|no)
1247 Answer C<yes> if a Linux kernel is installed in the guest.
1251 sub output_query_linux
1254 foreach my $os (keys %oses) {
1255 $linux="yes" if $oses{$os}->{os} eq "linux";
1257 print "linux=$linux\n";
1262 Answer C<yes> if the guest contains Red Hat Enterprise Linux.
1266 sub output_query_rhel
1269 foreach my $os (keys %oses) {
1270 $rhel="yes" if $oses{$os}->{os} eq "linux" && $oses{$os}->{distro} eq "redhat";
1272 print "rhel=$rhel\n";
1275 =item fedora=(yes|no)
1277 Answer C<yes> if the guest contains the Fedora Linux distribution.
1281 sub output_query_fedora
1284 foreach my $os (keys %oses) {
1285 $fedora="yes" if $oses{$os}->{os} eq "linux" && $oses{$os}->{distro} eq "fedora";
1287 print "fedora=$fedora\n";
1290 =item debian=(yes|no)
1292 Answer C<yes> if the guest contains the Debian Linux distribution.
1296 sub output_query_debian
1299 foreach my $os (keys %oses) {
1300 $debian="yes" if $oses{$os}->{os} eq "linux" && $oses{$os}->{distro} eq "debian";
1302 print "debian=$debian\n";
1305 =item fullvirt=(yes|no)
1307 Answer C<yes> if there is at least one operating system kernel
1308 installed in the guest which runs fully virtualized. Such a guest
1309 would require a hypervisor which supports full system virtualization.
1313 sub output_query_fullvirt
1315 # The assumption is full-virt, unless all installed kernels
1316 # are identified as paravirt.
1317 # XXX Fails on Windows guests.
1318 foreach my $os (keys %oses) {
1319 foreach my $kernel (@{$oses{$os}->{kernels}}) {
1320 my $is_pv = $kernel->{version} =~ m/xen/;
1322 print "fullvirt=yes\n";
1327 print "fullvirt=no\n";
1330 =item xen_domU_kernel=(yes|no)
1332 Answer C<yes> if there is at least one Linux kernel installed in
1333 the guest which is compiled as a Xen DomU (a Xen paravirtualized
1338 sub output_query_xen_domU_kernel
1340 foreach my $os (keys %oses) {
1341 foreach my $kernel (@{$oses{$os}->{kernels}}) {
1342 my $is_xen = $kernel->{version} =~ m/xen/;
1344 print "xen_domU_kernel=yes\n";
1349 print "xen_domU_kernel=no\n";
1352 =item xen_pv_drivers=(yes|no)
1354 Answer C<yes> if the guest has Xen paravirtualized drivers installed
1355 (usually the kernel itself will be fully virtualized, but the PV
1356 drivers have been installed by the administrator for performance
1361 sub output_query_xen_pv_drivers
1363 foreach my $os (keys %oses) {
1364 foreach my $kernel (@{$oses{$os}->{kernels}}) {
1365 foreach my $module (@{$kernel->{modules}}) {
1366 if ($module =~ m/xen-/) {
1367 print "xen_pv_drivers=yes\n";
1373 print "xen_pv_drivers=no\n";
1376 =item virtio_drivers=(yes|no)
1378 Answer C<yes> if the guest has virtio paravirtualized drivers
1379 installed. Virtio drivers are commonly used to improve the
1384 sub output_query_virtio_drivers
1386 foreach my $os (keys %oses) {
1387 foreach my $kernel (@{$oses{$os}->{kernels}}) {
1388 foreach my $module (@{$kernel->{modules}}) {
1389 if ($module =~ m/virtio_/) {
1390 print "virtio_drivers=yes\n";
1396 print "virtio_drivers=no\n";
1407 L<http://libguestfs.org/>.
1409 For Windows registry parsing we require the C<reged> program
1410 from L<http://home.eunet.no/~pnordahl/ntpasswd/>.
1414 Richard W.M. Jones L<http://et.redhat.com/~rjones/>
1418 Copyright (C) 2009 Red Hat Inc.
1420 This program is free software; you can redistribute it and/or modify
1421 it under the terms of the GNU General Public License as published by
1422 the Free Software Foundation; either version 2 of the License, or
1423 (at your option) any later version.
1425 This program is distributed in the hope that it will be useful,
1426 but WITHOUT ANY WARRANTY; without even the implied warranty of
1427 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1428 GNU General Public License for more details.
1430 You should have received a copy of the GNU General Public License
1431 along with this program; if not, write to the Free Software
1432 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.