Version 1.19.14.

This fixes commit 05d4e07918.

.gitignore

@@ -1,198 +1,420 @@
 *~
 *.a
-ABOUT-NLS
-aclocal.m4
-appliance/debian/debirf.conf
-appliance/initramfs.*.img
-appliance/initramfs.*.supermin.hostfiles
-appliance/kmod.whitelist
-appliance/libguestfs-supermin-helper
-appliance/make.sh
-appliance/packagelist
-appliance/stamp-debirf-modules
-appliance/supermin.incfiles
-appliance/supermin-make.sh
-appliance/supermin-split.sh
-appliance/update.sh
-appliance/vmlinuz.*
-autom4te.cache
 *.bak
-bindtests.tmp
-capitests/test-command
-capitests/test*.img
-capitests/tests
-capitests/tests.c
-capitests/test*.tmp
-cat/virt-cat.1
-ChangeLog
 *.class
 *.cma
 *.cmi
 *.cmo
 *.cmx
 *.cmxa
-compile
-config.guess
-config.h
-config.h.in
-config.log
-config.status
-config.sub
-configure
-daemon/actions.h
-daemon/guestfsd
-daemon/install-sh
-daemon/missing
-daemon/names.c
-daemon/stubs.c
-depcomp
-.deps
-df/virt-df.1
-emptydisk
-examples/hello
-examples/to-xml
-fish/cmds.c
-fish/completion.c
-fish/guestfish
-fish/rc_protocol.c
-fish/rc_protocol.h
-guestfish.1
-guestfish-actions.pod
-guestfs.3
-guestfs-actions.pod
-guestfs-structs.pod
-haskell/Bindtests
-haskell/Bindtests.hs
-haskell/Guestfs005Load
-haskell/Guestfs010Launch
-haskell/Guestfs050LVCreate
-haskell/Guestfs.hs
+*.diff
+*.eml
 *.hi
-html/guestfish.1.html
-html/guestfs.3.html
-html/recipes.html
-html/virt-cat.1.html
-html/virt-df.1.html
-html/virt-inspector.1.html
-images/100kallnewlines
-images/100kallspaces
-images/100kallzeroes
-images/100krandom
-images/10klines
-images/initrd
-images/initrd-x86_64.img
-images/initrd-x86_64.img.gz
-images/test.iso
-images/test-grep.txt.gz
-initramfs
-initramfs.timestamp
-inspector/virt-inspector.1
-install-sh
 *.jar
-java/api
-java/Bindtests.java
-java/com/redhat/et/libguestfs/Dirent.java
-java/com_redhat_et_libguestfs_GuestFS.c
-java/com_redhat_et_libguestfs_GuestFS.h
-java/com/redhat/et/libguestfs/GuestFS.java
-java/com/redhat/et/libguestfs/INotifyEvent.java
-java/com/redhat/et/libguestfs/IntBool.java
-java/com/redhat/et/libguestfs/LV.java
-java/com/redhat/et/libguestfs/PV.java
-java/com/redhat/et/libguestfs/Stat.java
-java/com/redhat/et/libguestfs/StatVFS.java
-java/com/redhat/et/libguestfs/Version.java
-java/com/redhat/et/libguestfs/VG.java
-java/com/redhat/et/libguestfs/XAttr.java
-java/doc-stamp
 *.la
-libguestfs.pc
-libguestfs.spec
-libguestfs-*.tar.gz
-.libs
-libtool
 *.lo
-localconfigure
-localrepo
-ltmain.sh
-m4/gnulib-cache.m4
-m4/intmax.m4
-m4/libtool.m4
-m4/lt~obsolete.m4
-m4/ltoptions.m4
-m4/ltsugar.m4
-m4/ltversion.m4
+*.o
+*.orig
+*.patch
+*.rej
+*.swp
+
+bindtests.tmp
+cscope.out
+.deps
+.gdb_history
+.libs
 Makefile
 Makefile.in
-missing
-*.o
-ocaml/bindtests
-ocaml/bindtests.ml
-ocaml/dllmlguestfs.so
-ocaml/examples/lvs
-ocaml/guestfs_c_actions.c
-ocaml/guestfs.ml
-ocaml/guestfs.mli
-ocaml/META
-ocaml/t/guestfs_005_load
-ocaml/t/guestfs_010_launch
-ocaml/t/guestfs_050_lvcreate
-ocaml/t/guestfs_060_readdir
-perl/bindtests.pl
-perl/blib
-perl/Guestfs.bs
-perl/Guestfs.c
-perl/Guestfs.xs
-perl/lib/Sys/Guestfs.pm
-perl/Makefile-pl
-perl/Makefile-pl.old
-perl/Makefile.PL
-perl/pm_to_blib
 pod2htm?.tmp
-po/*.gmo
-po/Makevars.template
-po/POTFILES
-po/remove-potcdate.sed
-po/stamp-it
-po/stamp-po
-po/LINGUAS
-po/Makefile.in.in
-po/Makevars
-po/Rules-quot
-po/boldquot.sed
-po/en@boldquot.header
-po/en@quot.header
-po/insert-header.sin
-po/quot.sed
-po/remove-potcdate.sin
-python/bindtests.py
-python/guestfs.py
-python/guestfs-py.c
-python/guestfs.pyc
-regressions/test1.img
-ruby/bindtests.rb
-ruby/ext/guestfs/extconf.h
-ruby/ext/guestfs/_guestfs.c
-ruby/ext/guestfs/_guestfs.so
-ruby/ext/guestfs/mkmf.log
-ruby/Rakefile
-src/guestfs-actions.c
-src/guestfs-actions.h
-src/guestfs-bindtests.c
-src/guestfs-internal-actions.h
-src/guestfs_protocol.c
-src/guestfs_protocol.h
-src/guestfs_protocol.x
-src/guestfs-structs.h
-src/.libs/libguestfs.so
-src/.pod2text.data
-src/stamp-generator
-stamp-h1
-test-tool/libguestfs-test-tool.1
-test-tool/libguestfs-test-tool
-test-tool/libguestfs-test-tool-helper
-/GNUmakefile
-/maint.mk
+
+/ABOUT-NLS
+/aclocal.m4
+/align/stamp-virt-alignment-scan.pod
+/align/virt-alignment-scan
+/align/virt-alignment-scan.1
+/appliance/excludelist
+/appliance/libguestfs-make-fixed-appliance
+/appliance/libguestfs-make-fixed-appliance.1
+/appliance/make.sh
+/appliance/packagelist
+/appliance/stamp-libguestfs-make-fixed-appliance.pod
+/appliance/stamp-supermin
+/appliance/supermin.d
+/autom4te.cache
 /build-aux
+/cat/stamp-virt-*.pod
+/cat/virt-cat
+/cat/virt-cat.1
+/cat/virt-filesystems
+/cat/virt-filesystems.1
+/cat/virt-ls
+/cat/virt-ls.1
+/ChangeLog
+/compile
+/config.guess
+/config.h
+/config.h.in
+/config.log
+/config.status
+/config.sub
+/configure
+/csharp/Libguestfs.cs
+/daemon/actions.h
+/daemon/errnostring.c
+/daemon/errnostring_gperf.c
+/daemon/errnostring_gperf.gperf
+/daemon/errnostring.h
+/daemon/guestfsd
+/daemon/guestfsd.exe
+/daemon/guestfs_protocol.c
+/daemon/guestfs_protocol.h
+/daemon/install-sh
+/daemon/missing
+/daemon/names.c
+/daemon/optgroups.c
+/daemon/optgroups.h
+/daemon/stubs.c
+/depcomp
+/df/stamp-virt-df.pod
+/df/virt-df
+/df/virt-df.1
+/edit/stamp-virt-*.pod
+/edit/virt-edit
+/edit/virt-edit.1
+/erlang/erl-guestfs
+/erlang/erl-guestfs.c
+/erlang/examples/guestfs-erlang.3
+/erlang/examples/stamp-guestfs-erlang.pod
+/erlang/guestfs.beam
+/erlang/guestfs.erl
+/examples/copy_over
+/examples/create_disk
+/examples/display_icon
+/examples/guestfs-examples.3
+/examples/guestfs-faq.1
+/examples/guestfs-performance.1
+/examples/guestfs-recipes.1
+/examples/guestfs-testing.1
+/examples/inspect_vm
+/examples/mount_local
+/examples/stamp-guestfs-examples.pod
+/examples/stamp-guestfs-faq.pod
+/examples/stamp-guestfs-performance.pod
+/examples/stamp-guestfs-recipes.pod
+/examples/stamp-guestfs-testing.pod
+/examples/virt-dhcp-address
+/fish/cmds.c
+/fish/cmds_gperf.c
+/fish/cmds_gperf.gperf
+/fish/completion.c
+/fish/event-names.c
+/fish/fish-cmds.h
+/fish/guestfish
+/fish/guestfish.1
+/fish/guestfish-actions.pod
+/fish/guestfish-commands.pod
+/fish/prepopts.c
+/fish/prepopts.h
+/fish/rc_protocol.c
+/fish/rc_protocol.h
+/fish/stamp-guestfish.pod
+/fish/stamp-virt-copy-in.pod
+/fish/stamp-virt-copy-out.pod
+/fish/stamp-virt-tar-in.pod
+/fish/stamp-virt-tar-out.pod
+/fish/virt-copy-in.1
+/fish/virt-copy-out.1
+/fish/virt-tar-in.1
+/fish/virt-tar-out.1
+/format/stamp-virt-format.pod
+/format/virt-format
+/format/virt-format.1
+/fuse/guestmount
+/fuse/guestmount.1
+/fuse/stamp-guestmount.pod
+/generator/.depend
+/generator/files-generated.txt
+/generator/generator
+/generator/.pod2text.data*
+/generator/stamp-generator
+/.gitattributes
+/.git-module-status
 /gnulib
-.git-module-status
+/GNUmakefile
+/gobject/bindtests.js
+/gobject/Guestfs-1.0.gir
+/gobject/Guestfs-1.0.typelib
+/gobject/guestfs-gobject*.c
+/gobject/guestfs-gobject*.h
+/.guestfs-*
+/guestfs.*
+/guestfsd-in-wine.log
+/haskell/Bindtests
+/haskell/Bindtests.hs
+/haskell/Guestfs005Load
+/haskell/Guestfs010Basic
+/haskell/Guestfs.hs
+/html/guestfish.1.html
+/html/guestfs.3.html
+/html/guestfs-erlang.3.html
+/html/guestfs-examples.3.html
+/html/guestfs-faq.1.html
+/html/guestfs-java.3.html
+/html/guestfs-ocaml.3.html
+/html/guestfs-performance.1.html
+/html/guestfs-perl.3.html
+/html/guestfs-python.3.html
+/html/guestfs-recipes.1.html
+/html/guestfs-ruby.3.html
+/html/guestfs-testing.1.html
+/html/guestmount.1.html
+/html/libguestfs-make-fixed-appliance.1.html
+/html/libguestfs-test-tool.1.html
+/html/virt-alignment-scan.1.html
+/html/virt-cat.1.html
+/html/virt-copy-in.1.html
+/html/virt-copy-out.1.html
+/html/virt-df.1.html
+/html/virt-edit.1.html
+/html/virt-filesystems.1.html
+/html/virt-format.1.html
+/html/virt-inspector.1.html
+/html/virt-list-filesystems.1.html
+/html/virt-list-partitions.1.html
+/html/virt-ls.1.html
+/html/virt-make-fs.1.html
+/html/virt-rescue.1.html
+/html/virt-resize.1.html
+/html/virt-sparsify.1.html
+/html/virt-sysprep.1.html
+/html/virt-tar.1.html
+/html/virt-tar-in.1.html
+/html/virt-tar-out.1.html
+/html/virt-win-reg.1.html
+/inspector/stamp-virt-inspector.pod
+/inspector/virt-inspector
+/inspector/virt-inspector.1
+/install-sh
+/java/api
+/java/Bindtests.java
+/java/com_redhat_et_libguestfs_GuestFS.c
+/java/com_redhat_et_libguestfs_GuestFS.h
+/java/com/redhat/et/libguestfs/GuestFS.java
+/java/doc-stamp
+/java/examples/guestfs-java.3
+/java/examples/stamp-guestfs-java.pod
+/libguestfs.spec
+/libguestfs-*.tar.gz
+/libtool
+/local*
+/ltmain.sh
+/m4/ChangeLog
+/m4/gnulib-cache.m4
+/m4/intmax.m4
+/m4/libtool.m4
+/m4/lt~obsolete.m4
+/m4/ltoptions.m4
+/m4/ltsugar.m4
+/m4/ltversion.m4
+/maint.mk
+/missing
+/ocaml/bindtests.bc
+/ocaml/bindtests.opt
+/ocaml/bindtests.ml
+/ocaml/.depend
+/ocaml/dllmlguestfs.so
+/ocaml/examples/create_disk
+/ocaml/examples/guestfs-ocaml.3
+/ocaml/examples/inspect_vm
+/ocaml/examples/stamp-guestfs-ocaml.pod
+/ocaml/guestfs_c_actions.c
+/ocaml/guestfs_inspector.ml
+/ocaml/guestfs_inspector.mli
+/ocaml/guestfs.ml
+/ocaml/guestfs.mli
+/ocamlinit-stamp
+/ocaml/META
+/ocaml/t/guestfs_005_load.bc
+/ocaml/t/guestfs_005_load.opt
+/ocaml/t/guestfs_010_basic.bc
+/ocaml/t/guestfs_010_basic.opt
+/ocaml/t/guestfs_070_threads.bc
+/ocaml/t/guestfs_070_threads.opt
+/ocaml/t/guestfs_080_optargs.bc
+/ocaml/t/guestfs_080_optargs.opt
+/ocaml/t/guestfs_400_events.bc
+/ocaml/t/guestfs_400_events.opt
+/ocaml/t/guestfs_400_progress.bc
+/ocaml/t/guestfs_400_progress.opt
+/ocaml/t/guestfs_500_parallel_mount_local.bc
+/ocaml/t/guestfs_500_parallel_mount_local.opt
+/perl/bindtests.pl
+/perl/blib
+/perl/examples/guestfs-perl.3
+/perl/examples/stamp-guestfs-perl.pod
+/perl/Guestfs.bs
+/perl/Guestfs.c
+/perl/Guestfs.xs
+/perl/lib/Sys/Guestfs.pm
+/perl/Makefile-pl
+/perl/Makefile.PL
+/perl/Makefile-pl.old
+/perl/MYMETA.json
+/perl/MYMETA.yml
+/perl/pm_to_blib
+/php/extension/acinclude.m4
+/php/extension/aclocal.m4
+/php/extension/autom4te.cache
+/php/extension/build/
+/php/extension/config.guess
+/php/extension/config.h
+/php/extension/config.h.in
+/php/extension/config.log
+/php/extension/config.nice
+/php/extension/config.status
+/php/extension/config.sub
+/php/extension/configure
+/php/extension/configure.in
+/php/extension/guestfs_php.c
+/php/extension/guestfs_php_*.diff
+/php/extension/guestfs_php_*.exp
+/php/extension/guestfs_php_*.log
+/php/extension/guestfs_php_*.out
+/php/extension/guestfs_php_*.php
+/php/extension/guestfs_php_*.sh
+/php/extension/install-sh
+/php/extension/libtool
+/php/extension/ltmain.sh
+/php/extension/Makefile.fragments
+/php/extension/Makefile.global
+/php/extension/Makefile.objects
+/php/extension/mkinstalldirs
+/php/extension/missing
+/php/extension/modules/
+/php/extension/php_guestfs_php.h
+/php/extension/run-tests.php
+/php/extension/tmp-php.ini
+/po-docs/*/*.1
+/po-docs/*/*.3
+/po-docs/*/*.pl
+/po-docs/po4a.conf
+/po-docs/*/*.pod
+/po-docs/*/stamp-update-po
+/podwrapper.sh
+/po/*.gmo
+/python/bindtests.py
+/python/examples/guestfs-python.3
+/python/examples/stamp-guestfs-python.pod
+/python/guestfs.py
+/python/guestfs-py.c
+/python/guestfs.pyc
+/python/guestfs.pyo
+/python/__pycache__
+/rescue/stamp-virt-rescue.pod
+/rescue/virt-rescue
+/rescue/virt-rescue.1
+/resize/.depend
+/resize/resize_gettext.ml
+/resize/stamp-virt-resize.pod
+/resize/utils_tests
+/resize/virt-resize
+/resize/virt-resize.1
+/ruby/bindtests.rb
+/ruby/doc/site/api
+/ruby/examples/guestfs-ruby.3
+/ruby/examples/stamp-guestfs-ruby.pod
+/ruby/ext/guestfs/extconf.h
+/ruby/ext/guestfs/_guestfs.bundle
+/ruby/ext/guestfs/_guestfs.c
+/ruby/ext/guestfs/_guestfs.so
+/ruby/ext/guestfs/mkmf.log
+/ruby/Rakefile
+/run
+/sparsify/.depend
+/sparsify/sparsify_gettext.ml
+/sparsify/stamp-virt-sparsify.pod
+/sparsify/virt-sparsify
+/sparsify/virt-sparsify.1
+/src/actions.c
+/src/bindtests.c
+/src/errnostring.c
+/src/errnostring_gperf.c
+/src/errnostring_gperf.gperf
+/src/errnostring.h
+/src/guestfs.3
+/src/guestfs-actions.pod
+/src/guestfs-availability.pod
+/src/guestfs.h
+/src/guestfs-internal-actions.h
+/src/guestfs_protocol.c
+/src/guestfs_protocol.h
+/src/guestfs_protocol.x
+/src/guestfs-structs.pod
+/src/libguestfs.pc
+/src/libguestfs.syms
+/src/.libs/libguestfs.so
+/src/stamp-guestfs.pod
+/stamp-h1
+/sysprep/.depend
+/sysprep/stamp-script1.sh
+/sysprep/stamp-script2.sh
+/sysprep/stamp-virt-sysprep.pod
+/sysprep/sysprep-extra-options.pod
+/sysprep/sysprep_gettext.ml
+/sysprep/sysprep-operations.pod
+/sysprep/virt-sysprep
+/sysprep/virt-sysprep.1
+/test1.img
+/test2.img
+/test.err
+/test.out
+/tests/c-api/test-add-drive-opts
+/tests/c-api/test-add-libvirt-dom
+/tests/c-api/test-command
+/tests/c-api/test-config
+/tests/c-api/test-create-handle
+/tests/c-api/test-debug-to-file
+/tests/c-api/test*.img
+/tests/c-api/test-just-header
+/tests/c-api/test-just-header-cxx
+/tests/c-api/test-last-errno
+/tests/c-api/test.log
+/tests/c-api/test-private-data
+/tests/c-api/tests
+/tests/c-api/tests.c
+/tests/c-api/test*.tmp
+/tests/c-api/test-user-cancel
+/tests/charsets/test-charset-fidelity
+/tests/data/100kallnewlines
+/tests/data/100kallspaces
+/tests/data/100kallzeroes
+/tests/data/100krandom
+/tests/data/10klines
+/tests/data/abssymlink
+/tests/data/hello.b64
+/tests/data/initrd
+/tests/data/initrd-x86_64.img
+/tests/data/initrd-x86_64.img.gz
+/tests/data/test-grep.txt.gz
+/tests/data/test.iso
+/tests/extra/valgrind.log
+/tests/guests/debian.img
+/tests/guests/fedora.img
+/tests/guests/fedora-md1.img
+/tests/guests/fedora-md2.img
+/tests/guests/guest-aux/fedora-name.db
+/tests/guests/guest-aux/fedora-packages.db
+/tests/guests/stamp-fedora-md.img
+/tests/guests/ubuntu.img
+/tests/guests/windows.img
+/tests/regressions/rhbz501893
+/tests/regressions/rhbz790721
+/test-tool/libguestfs-test-tool
+/test-tool/libguestfs-test-tool.1
+/test-tool/libguestfs-test-tool-helper
+/test-tool/stamp-libguestfs-test-tool.pod
+/tools/test.img
+/tools/virt-*.1
+/tools/virt-*.pl
+/valgrind.log.*

.lvimrc

@@ -0,0 +1,9 @@
+" Custom libguestfs indentation configuration for vim
+"
+" This configuration file requires localrc.vim to be installed. You can obtain
+" localrc.vim from http://www.vim.org/scripts/script.php?script_id=1408
+
+set sw=2
+set ts=2
+set tw=80
+set expandtab

.tx/config

@@ -0,0 +1,13 @@
+[main]
+host = https://www.transifex.net
+
+[libguestfs.libguestfspot]
+file_filter = po/<lang>.po
+source_file = po/libguestfs.pot
+source_lang = en
+
+[libguestfs.libguestfsdocspot]
+file_filter = po-docs/<lang>.po
+source_file = po-docs/libguestfs-docs.pot
+source_lang = en
+

.x-sc_TAB_in_indentation

@@ -1,5 +1,4 @@
-^appliance/debian/modules/
-^images/
+^tests/data/
 ^COPYING(.LIB)?$
 ^\.gitmodules$
 (^|\/)ChangeLog[^/]*$

.x-sc_avoid_ctype_macros

@@ -0,0 +1 @@
+^examples/to-xml\.c$

.x-sc_prohibit_magic_number_exit

@@ -0,0 +1,2 @@
+^.*\.java$
+^.*\.pl$

.x-sc_prohibit_strcmp

@@ -0,0 +1 @@
+^examples/to-xml\.c$

.x-sc_prohibit_strcmp_and_strncmp

@@ -0,0 +1 @@
+^examples/to-xml\.c$

.x-sc_trailing_blank

@@ -1 +1,2 @@
-images/bin-win64.exe
+tests/data/bin-win64.exe
+*.pod

AUTHORS

@@ -0,0 +1,28 @@
+Angus Salkeld <asalkeld@redhat.com>
+Ani Peter <apeter@redhat.com>
+Charles Duffy <cduffy@messageone.com>
+Daniel Berrange <berrange@redhat.com>
+Daniel Cabrera <logan@fedoraproject.org>
+Douglas Schilling Landgraf <dougsland@redhat.com>
+Erik Nolte <erik_nolte@acm.org>
+Geert Warrink <geert.warrink@onsnet.nu>
+Guido Günther <agx@sigxcpu.org>
+Hilko Bengen <bengen@hilluzination.de>
+Jaswinder Singh <jsingh@redhat.com>
+Jim Meyering <jim@meyering.net>
+Jiri Popelka <jpopelka@redhat.com>
+Karel Klíč <kklic@redhat.com>
+Marcin Gibula <m.gibula@e24cloud.com>
+Matthew Booth <mbooth@redhat.com>
+Maxim Koltsov <kolmax94@gmail.com>
+Michael Scherer <misc@zarb.org>
+Nikita A Menkovich <menkovich@gmail.com>
+Nikos Skalkotos <skalkoto@gmail.com>
+Piotr Drąg <piotrdrag@gmail.com>
+Qin Guan <qguan@redhat.com>
+Rajesh Ranjan <rranjan@redhat.com>
+Richard W.M. Jones <rich@annexia.org>
+Sandeep Shedmake <sshedmak@redhat.com>
+Shankar Prasad <svenkate@redhat.com>
+Thomas S Hatch <thatch45@gmail.com>
+Wanlong Gao <gaowanlong@cn.fujitsu.com>

BUGS

@@ -1,16 +1,244 @@
-Please note: This file used to contain a list of bugs.  Bugs in
-libguestfs are now tracked in Red Hat's Bugzilla.
+NOTE: This file is automatically generated from "update-bugs.sh".
+Last updated: 2012-06-28
 
-To get a list of bugs against libguestfs use this link:
-
-https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools
-
-To report a new bug against libguestfs use this link:
+This contains a local list of the bugs that are open against
+libguestfs.  Bugs are tracked in the Red Hat Bugzilla database
+at https://bugzilla.redhat.com/ and to report a new bug you
+should follow this link:
 
 https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools
 
-When reporting a bug, please check:
+When reporting a new bug, please check:
 
- - That the bug hasn't been reported already.
+ - That the bug has not been reported already.
  - That you are testing a recent version.
  - Describe the bug accurately, and give a way to reproduce it.
+ - Include the version of libguestfs, distro version and any other
+   relevant information.
+ - Attach the complete output of "libguestfs-test-tool".
+
+--------------------------------------------------
+Bugs in NEW or ASSIGNED state are open and waiting for someone to fix.
+
+507278 NEW https://bugzilla.redhat.com/show_bug.cgi?id=507278
+  libguestfs fails to build on Fedora sparc64
+
+547488 NEW https://bugzilla.redhat.com/show_bug.cgi?id=547488
+  guestfish cannot tab complete filenames that contain spaces
+
+554829 NEW https://bugzilla.redhat.com/show_bug.cgi?id=554829
+  SELinux handling could be done better.
+
+555803 NEW https://bugzilla.redhat.com/show_bug.cgi?id=555803
+  guestfs_tgz_out does not detect failure of tar command
+
+563450 NEW https://bugzilla.redhat.com/show_bug.cgi?id=563450
+  list-devices returns devices of different types out of order
+
+572337 NEW https://bugzilla.redhat.com/show_bug.cgi?id=572337
+  libguestfs should support gptsync
+
+578103 NEW https://bugzilla.redhat.com/show_bug.cgi?id=578103
+  [RFE] Tool to Compare Windows Registry Entries
+
+593511 NEW https://bugzilla.redhat.com/show_bug.cgi?id=593511
+  [RFE] function to get partition name
+
+596354 NEW https://bugzilla.redhat.com/show_bug.cgi?id=596354
+  guestfish.1.html and guestfs.3.html declared "XHTML 1.0 Strict" but are not in fact well-formed XML
+
+604041 NEW https://bugzilla.redhat.com/show_bug.cgi?id=604041
+  guestmount absolute symlinks don't work
+
+624334 NEW https://bugzilla.redhat.com/show_bug.cgi?id=624334
+  blockdev-setbsz succeeds, but does not affect blockdev-getbsz
+
+624335 NEW https://bugzilla.redhat.com/show_bug.cgi?id=624335
+  blockdev-setbsz succeeds, but does not affect blockdev-getbsz
+
+627675 NEW https://bugzilla.redhat.com/show_bug.cgi?id=627675
+  libguestfs inspector code cannot handle /dev/disk/by-id/* paths
+
+637251 NEW https://bugzilla.redhat.com/show_bug.cgi?id=637251
+  virt-inspector fails to recognize data-only NTFS disk image
+
+660687 NEW https://bugzilla.redhat.com/show_bug.cgi?id=660687
+  guestmount: "touch" command fails: touch: setting times of `timestamp': Invalid argument
+
+672485 NEW https://bugzilla.redhat.com/show_bug.cgi?id=672485
+  [RFE] virt-edit/tar/inspector do not support encrypted system
+
+676020 NEW https://bugzilla.redhat.com/show_bug.cgi?id=676020
+  After using virt-resize with an ntfs partition windows is not booting
+
+693064 NEW https://bugzilla.redhat.com/show_bug.cgi?id=693064
+  Symbolic links on ntfs-3g are not followed correctly by some commands
+
+696445 NEW https://bugzilla.redhat.com/show_bug.cgi?id=696445
+  Backport virt-inspector for virt-v2v
+
+696451 NEW https://bugzilla.redhat.com/show_bug.cgi?id=696451
+  libguestfs: unknown filesystem label SWAP-sda2
+
+696484 NEW https://bugzilla.redhat.com/show_bug.cgi?id=696484
+  [RFE] virt-v2v show the warning info after convert rhel4u8 guest if comment a line of swap in the fstab
+
+700342 NEW https://bugzilla.redhat.com/show_bug.cgi?id=700342
+  virt-inspector resports unknown filesystem UUID
+
+709326 NEW https://bugzilla.redhat.com/show_bug.cgi?id=709326
+  virt-inspector cannot detect ReactOS
+
+728224 NEW https://bugzilla.redhat.com/show_bug.cgi?id=728224
+  configure can't find qemu on PPC
+
+737261 NEW https://bugzilla.redhat.com/show_bug.cgi?id=737261
+  libguestfs grub-install API needs grub1
+
+745282 NEW https://bugzilla.redhat.com/show_bug.cgi?id=745282
+  [RFE] Support to use virt-filesystems with remote libvirt systems
+
+745576 NEW https://bugzilla.redhat.com/show_bug.cgi?id=745576
+  libguestfs (or qemu?) hangs if sparse file runs out of disk space
+
+761565 NEW https://bugzilla.redhat.com/show_bug.cgi?id=761565
+  Missing deps on netpbm-progs and icoutils
+
+770075 NEW https://bugzilla.redhat.com/show_bug.cgi?id=770075
+  FEBOOTSTRAP_MODULES fails if modules directory is not under /lib
+
+770076 NEW https://bugzilla.redhat.com/show_bug.cgi?id=770076
+  FEBOOTSTRAP_KERNEL causes appliance build to fail
+
+782167 NEW https://bugzilla.redhat.com/show_bug.cgi?id=782167
+  libguestfs doesn't recognize Windows Dynamic disks in some configurations, eg. spanned
+
+785603 NEW https://bugzilla.redhat.com/show_bug.cgi?id=785603
+  copy-out can't find root directory
+
+790837 NEW https://bugzilla.redhat.com/show_bug.cgi?id=790837
+  Use of atexit to clean up handles is wrong in multithreaded programs
+
+798979 NEW https://bugzilla.redhat.com/show_bug.cgi?id=798979
+  Ubuntu install CDs from oneiric onwards are not recognized: "multi-boot operating systems are not supported"
+
+801117 NEW https://bugzilla.redhat.com/show_bug.cgi?id=801117
+  libguestfs cannot get icon for Windows 8 preview
+
+801640 NEW https://bugzilla.redhat.com/show_bug.cgi?id=801640
+  [RFE] the error reported by resize2fs-M need to be more clear
+
+802389 NEW https://bugzilla.redhat.com/show_bug.cgi?id=802389
+  event handlers for 'close' event doesn't work in remote mode
+
+803643 NEW https://bugzilla.redhat.com/show_bug.cgi?id=803643
+  inspect-is-multipart return false when inspection results should be true
+
+803650 NEW https://bugzilla.redhat.com/show_bug.cgi?id=803650
+  inspect-is-live return false when inspection results should be true
+
+803657 NEW https://bugzilla.redhat.com/show_bug.cgi?id=803657
+  [RFE] inspect-is-netinst : support more distributions
+
+805417 NEW https://bugzilla.redhat.com/show_bug.cgi?id=805417
+  RFE: support inspection of installation ISOs of WinVista, Win7, Win2008 & Win2008r2
+
+806176 NEW https://bugzilla.redhat.com/show_bug.cgi?id=806176
+  libguestfs doesn't use the external tools (wrestool ...) to get icon even these tools are installed
+
+806179 NEW https://bugzilla.redhat.com/show_bug.cgi?id=806179
+  RFE: support inspection of icon for more Windows guests
+
+808193 NEW https://bugzilla.redhat.com/show_bug.cgi?id=808193
+  g.launch() crashes on RHEL 5
+
+811265 NEW https://bugzilla.redhat.com/show_bug.cgi?id=811265
+  the list-filesystems can detect the reiserFS,but can not mount it.and minix filesystem too.
+
+811395 NEW https://bugzilla.redhat.com/show_bug.cgi?id=811395
+  virt-inspector to detect ia64 Windows 2k3 install media
+
+811398 NEW https://bugzilla.redhat.com/show_bug.cgi?id=811398
+  virt-inspector fails to detect Win2k, Win2k8, Win2k8r2, WinVista, Win7 install media
+
+812970 NEW https://bugzilla.redhat.com/show_bug.cgi?id=812970
+  virt-rescue cannot set ><rescue> prompt, on Ubuntu 12.04
+
+813271 NEW https://bugzilla.redhat.com/show_bug.cgi?id=813271
+  intermittent appliance boot failures (divide_error)
+
+813290 NEW https://bugzilla.redhat.com/show_bug.cgi?id=813290
+  mdadm (md-detail) test occasionally fails with 'md device /dev/md125 does not appear to be active.'
+
+815149 NEW https://bugzilla.redhat.com/show_bug.cgi?id=815149
+  virt-alignment-scan gives error "part_list: could not parse row from output of parted print command: /dev/vda:4194304B:virtblk:512:512:msdos:Virtio Block Device"
+
+816839 NEW https://bugzilla.redhat.com/show_bug.cgi?id=816839
+  data overflow error when debug progress -1
+
+819086 NEW https://bugzilla.redhat.com/show_bug.cgi?id=819086
+  look for qemu-kvm on /usr/libexec
+
+822538 NEW https://bugzilla.redhat.com/show_bug.cgi?id=822538
+  libguestfs tools hang on qcow2 encrypted disks
+
+822626 NEW https://bugzilla.redhat.com/show_bug.cgi?id=822626
+  virt-ls error: "libguestfs: error: checksum: path: parameter cannot be NULL"
+
+824021 NEW https://bugzilla.redhat.com/show_bug.cgi?id=824021
+  inspection cannot recognize guest which uses btrfs subvolumes for root
+
+824782 NEW https://bugzilla.redhat.com/show_bug.cgi?id=824782
+  virt-resize cannot resize PowerPC guests
+
+825034 NEW https://bugzilla.redhat.com/show_bug.cgi?id=825034
+  libguestfs has bad depndency on /lib/libusb-1.0.so.0
+
+830135 NEW https://bugzilla.redhat.com/show_bug.cgi?id=830135
+  libguestfs should support mount-local APIs in RHEL 6 (for OpenStack)
+
+832602 NEW https://bugzilla.redhat.com/show_bug.cgi?id=832602
+  "error in chunked encoding" when trying to extract (tar-out) a truncated ISO image
+
+833362 NEW https://bugzilla.redhat.com/show_bug.cgi?id=833362
+  virt-make-fs test fails on ppc64 because filesystem block size is 64k
+
+834712 NEW https://bugzilla.redhat.com/show_bug.cgi?id=834712
+  virt-resize test failed once: lvresize_free: New size (91 extents) matches existing size (91 extents)
+
+834896 NEW https://bugzilla.redhat.com/show_bug.cgi?id=834896
+  'mount' command hangs if you try to mount an extended partition
+
+835622 NEW https://bugzilla.redhat.com/show_bug.cgi?id=835622
+  virt-sparsify to LVM thin raw volume isn't sparse
+
+503134 ASSIGNED https://bugzilla.redhat.com/show_bug.cgi?id=503134
+  guestfish's list splitting does not recognize internal quoting
+
+539746 ASSIGNED https://bugzilla.redhat.com/show_bug.cgi?id=539746
+  launch fails when run inside a Xen guest, when no non-PV kernels are installed
+
+541618 ASSIGNED https://bugzilla.redhat.com/show_bug.cgi?id=541618
+  guestfish not able to mount freebsd ufs2 partitions automatically
+
+619334 ASSIGNED https://bugzilla.redhat.com/show_bug.cgi?id=619334
+  RFE: Enable coredump capture in the appliance
+
+691389 ASSIGNED https://bugzilla.redhat.com/show_bug.cgi?id=691389
+  Extended attributes don't work over guestmount (FUSE)
+
+713678 ASSIGNED https://bugzilla.redhat.com/show_bug.cgi?id=713678
+  Not all febootstrap messages are redirected to log callbacks
+
+(70 bugs)
+
+--------------------------------------------------
+Bugs in MODIFIED, POST or ON_QA state are fixed.
+You can help by testing the fixes.
+
+749828 ON_QA https://bugzilla.redhat.com/show_bug.cgi?id=749828
+  p2v does not support raid devices
+
+(1 bugs)
+
+End of BUGS file.

HACKING

@@ -1,185 +1,2 @@
-PLEASE LOOK AT THE TOP OF EACH FILE BEFORE EDITING TO SEE WHETHER IT
-IS AUTOMATICALLY GENERATED OR NOT.
-
-Adding a new action
-----------------------------------------------------------------------
-
-All action functions are generated automatically, so there are only
-two files you need to edit:
-
-(1) src/generator.ml: Add your new action, parameters, description,
-etc. to the big list called 'functions' at the top of this file.
-
-(2) Edit/create a C file in daemon/ subdirectory which implements your
-'do_action' function.  Take a look at one of the numerous examples
-there.
-
-Formatting
-----------------------------------------------------------------------
-
-Try to use GNU / Emacs default formatting, following the convention
-used elsewhere in the source.
-
-Please make sure that the code compiles without warnings.
-
-Please test any changes.
-
-Useful targets:
-  make syntax-check    Checks the syntax of the C code.
-  make check           Runs the test suite.
-
-Enable warnings, and fix any you find:
-  ./configure --enable-gcc-warnings
-
-Code indentation
-----------------------------------------------------------------------
-Our C source code generally adheres to some basic code-formatting
-conventions.  The existing code base is not totally consistent on this
-front, but we do prefer that contributed code be formatted similarly.
-In short, use spaces-not-TABs for indentation, use 2 spaces for each
-indentation level, and other than that, follow the K&R style.
-
-If you use Emacs, add the following to one of one of your start-up files
-(e.g., ~/.emacs), to help ensure that you get indentation right:
-
-  ;;; In libguestfs, indent with spaces everywhere (not TABs).
-  ;;; Exceptions: Makefile and ChangeLog modes.
-  (add-hook 'find-file-hook
-      '(lambda () (if (and buffer-file-name
-                           (string-match "/libguestfs\\>" (buffer-file-name))
-                           (not (string-equal mode-name "Change Log"))
-                           (not (string-equal mode-name "Makefile")))
-                      (setq indent-tabs-mode nil))))
-
-  ;;; When editing C sources in libguestfs, use this style.
-  (defun libguestfs-c-mode ()
-    "C mode with adjusted defaults for use with libguestfs."
-    (interactive)
-    (c-set-style "K&R")
-    (setq c-indent-level 2)
-    (setq c-basic-offset 2))
-  (add-hook 'c-mode-hook
-            '(lambda () (if (string-match "/libguestfs\\>" (buffer-file-name))
-                            (libguestfs-c-mode))))
-
-Directories
-----------------------------------------------------------------------
-
-appliance/
-        The qemu appliance, build scripts and so on.
-
-cat/
-        The virt-cat tool.
-
-capitests/
-        Automated tests of the C API.
-
-contrib/
-        Outside contributions, experimental parts.
-
-daemon/
-        The daemon that runs inside the guest and carries out actions.
-
-df/
-        The virt-df tool.
-
-examples/
-        The examples.
-
-fish/
-        Guestfish (the command-line program / shell)
-
-haskell/
-        Haskell bindings.
-
-images/
-        Some guest images to test against.  These are gzipped to save
-        space.  You have to unzip them before use.
-
-        Also contains some files used by the test suite.
-
-inspector/
-        Virtual machine image inspector (virt-inspector).
-
-java/
-        Java bindings.
-
-m4/
-        M4 macros used by autoconf.
-
-ocaml/
-        OCaml bindings.
-
-po/
-        Translations.
-
-perl/
-        Perl bindings.
-
-python/
-        Python bindings.
-
-regressions/
-        Regression tests.
-
-ruby/
-        Ruby bindings.
-
-src/
-        Source code to the C library.
-        Also contains the crucial generator program.
-
-test-tool/
-        Interactive qemu/kernel test tool.
-
-Debugging
-----------------------------------------------------------------------
-
-It's a good idea to use guestfish to try out new commands.
-
-Debugging the daemon is a problem because it runs inside a minimal
-qemu environment.  However you can print messages from the daemon, and
-they will show up if you use 'guestfish -v'.
-
-Patches
-----------------------------------------------------------------------
-
-Submit patches to the mailing list:
-http://www.redhat.com/mailman/listinfo/libguestfs
-and CC to rjones@redhat.com
-
-I18N
-----------------------------------------------------------------------
-
-We support i18n (gettext anyhow) in the library.
-
-However many messages come from the daemon, and we don't translate
-those at the moment.  One reason is that the appliance generally has
-all locale files removed from it, because they take up a lot of space.
-So we'd have to readd some of those, as well as copying our PO files
-into the appliance.
-
-Debugging messages are never translated, since they are intended for
-the programmers.
-
-Extended printf
-----------------------------------------------------------------------
-
-In the daemon code we have created custom printf formatters %Q and %R,
-which are used to do shell quoting.
-
-%Q => Simple shell quoted string.  Any spaces or other shell characters
-      are escaped for you.
-
-%R => Same as %Q except the string is treated as a path which is prefixed
-      by the sysroot.
-
-eg.
-
-asprintf (&cmd, "cat %R", path);
-==> "cat /sysroot/some\ path\ with\ spaces"
-
-Note: Do NOT use these when you are passing parameters to the
-command{,r,v,rv}() functions.  These parameters do NOT need to be
-quoted because they are not passed via the shell (instead, straight to
-exec).  You probably want to use the sysroot_path() function however.
+The contents of this page have moved to the section "EXTENDING LIBGUESTFS"
+in the guestfs(3) man page.

Makefile.am

@@ -1,5 +1,5 @@
 # libguestfs
-# Copyright (C) 2009 Red Hat Inc.
+# Copyright (C) 2009-2012 Red Hat Inc.
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -13,149 +13,218 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with this program; if not, write to the Free Software
-# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+include $(top_srcdir)/subdir-rules.mk
 
 ACLOCAL_AMFLAGS = -I m4
 
-SUBDIRS = gnulib/lib src daemon appliance fish po examples images \
-	gnulib/tests capitests regressions test-tool
+# Gnulib - must be built and tested before the library.
+SUBDIRS = gnulib/lib gnulib/tests
 
-if HAVE_OCAML
-SUBDIRS += ocaml
+# Basic source for the library.
+SUBDIRS += tests/data generator src examples po
+
+if ENABLE_DAEMON
+SUBDIRS += daemon
 endif
+if ENABLE_APPLIANCE
+SUBDIRS += appliance
+endif
+
+# Tests - order is important.
+if ENABLE_APPLIANCE
+SUBDIRS += tests/qemu
+SUBDIRS += tests/guests
+SUBDIRS += tests/c-api
+SUBDIRS += tests/protocol
+SUBDIRS += tests/disks
+SUBDIRS += tests/lvm
+SUBDIRS += tests/luks
+SUBDIRS += tests/md
+SUBDIRS += tests/selinux
+SUBDIRS += tests/ntfsclone
+SUBDIRS += tests/btrfs
+SUBDIRS += tests/charsets
+SUBDIRS += tests/xml
+SUBDIRS += tests/regressions
+endif
+
+# Extra tests don't run by default.  You have to do 'make extra-tests'.
+SUBDIRS += tests/extra
+
+# libguestfs-test-tool
+SUBDIRS += test-tool
+
+# Guestfish.
+SUBDIRS += fish
+
+# virt-tools in C.
+SUBDIRS += align cat df edit format inspector rescue
+
+# Language bindings.
 if HAVE_PERL
-SUBDIRS += perl
+SUBDIRS += perl perl/examples
+endif
+if HAVE_OCAML
+SUBDIRS += ocaml ocaml/examples
 endif
 if HAVE_PYTHON
-SUBDIRS += python
+SUBDIRS += python python/examples
 endif
 if HAVE_RUBY
-SUBDIRS += ruby
+SUBDIRS += ruby ruby/examples
 endif
 if HAVE_JAVA
-SUBDIRS += java
+SUBDIRS += java java/examples
 endif
 if HAVE_HASKELL
 SUBDIRS += haskell
 endif
-if HAVE_INSPECTOR
-SUBDIRS += inspector
+if HAVE_PHP
+SUBDIRS += php
 endif
-if HAVE_DF
-SUBDIRS += df
+if HAVE_ERLANG
+SUBDIRS += erlang erlang/examples
 endif
-if HAVE_CAT
-SUBDIRS += cat
+if HAVE_GOBJECT
+SUBDIRS += gobject
+endif
+
+# Unconditional because nothing is built yet.
+SUBDIRS += csharp
+
+# OCaml tools.
+if HAVE_OCAML
+SUBDIRS += resize sparsify sysprep
+endif
+
+# Perl tools.
+if HAVE_TOOLS
+SUBDIRS += tools
+endif
+
+# guestmount
+if HAVE_FUSE
+SUBDIRS += fuse
+endif
+
+# po-docs must come after tools, inspector.
+if HAVE_PO4A
+SUBDIRS += po-docs
 endif
 
 EXTRA_DIST = \
-	guestfs.pod guestfs-actions.pod guestfs-structs.pod \
-	guestfish.pod guestfish-actions.pod \
-	html/pod.css \
-	HACKING TODO \
-	libguestfs.pc libguestfs.pc.in \
-	recipes/LICENSE \
-	recipes/README \
-	recipes/*.html \
-	recipes/*.sh \
-	recipes/*.example \
-	html/recipes.css \
-	make-recipes.sh \
-	contrib/README \
-	contrib/febootstrap/install.title \
-	contrib/febootstrap/install.html \
-	contrib/febootstrap/install.sh \
+	$(generator_built) \
+	BUGS HACKING RELEASE-NOTES ROADMAP TODO \
+	.gitignore \
+	bugs-in-changelog.sh \
+	autogen.sh \
 	bindtests \
-	libguestfs.3
+	contrib/autobuild/autobuild.sh \
+	contrib/guestfsd-in-wine.sh \
+	contrib/intro/libguestfs-intro.html \
+	contrib/intro/overview.svg \
+	contrib/intro/talk.txt \
+	contrib/intro/tools.svg \
+	contrib/make-check-on-installed.pl \
+	contrib/README \
+	contrib/visualize-alignment/.gitignore \
+	contrib/visualize-alignment/guestfish-add-mount.qtr \
+	contrib/visualize-alignment/guestfish-lv-ext4-4k.qtr \
+	contrib/visualize-alignment/guestfish-lv-ext4-4k-write-hello.qtr \
+	contrib/visualize-alignment/guestfish-N-fs-10M-aligned-part-disk.qtr \
+	contrib/visualize-alignment/guestfish-N-fs-10M.qtr \
+	contrib/visualize-alignment/guestfish-write-hello.qtr \
+	contrib/visualize-alignment/qemu-0.13-trace-block-device-access.patch \
+	contrib/visualize-alignment/README \
+	contrib/visualize-alignment/tracetops.ml \
+	html/pod.css \
+	libtool-kill-dependency_libs.sh \
+	logo/fish.svg logo/fish.png \
+	m4/.gitignore \
+	update-bugs.sh
 
-# Manual pages.
-# guestfs-actions.pod and guestfs-structs are autogenerated.  There is
-# no include mechanism for POD, so we have to do it by hand.
-
-man_MANS = guestfs.3 libguestfs.3 guestfish.1
-
-guestfs.3: guestfs.pod guestfs-actions.pod guestfs-structs.pod
-	sed \
-	  -e '/@ACTIONS@/rguestfs-actions.pod' -e 's/@ACTIONS@//' \
-	  -e '/@STRUCTS@/rguestfs-structs.pod' -e 's/@STRUCTS@//' \
-	  < $< | \
-	$(POD2MAN) \
-	  --section 3 \
-	  -c "Virtualization Support" \
-	  --name "guestfs" \
-	  --release "$(PACKAGE_NAME)-$(PACKAGE_VERSION)" \
-	  > $@
-
-guestfish.1: guestfish.pod guestfish-actions.pod
-	sed \
-	  -e '/@ACTIONS@/rguestfish-actions.pod' -e 's/@ACTIONS@//' \
-	  < $< | \
-	$(POD2MAN) \
-	  --section 1 \
-	  -c "Virtualization Support" \
-	  --name "guestfish" \
-	  --release "$(PACKAGE_NAME)-$(PACKAGE_VERSION)" \
-	  > $@
-
-noinst_DATA = html/guestfs.3.html html/guestfish.1.html
-
-html/guestfs.3.html: guestfs.pod guestfs-actions.pod guestfs-structs.pod
-	mkdir -p html
-	sed \
-	  -e '/@ACTIONS@/rguestfs-actions.pod' -e 's/@ACTIONS@//' \
-	  -e '/@STRUCTS@/rguestfs-structs.pod' -e 's/@STRUCTS@//' \
-	  < $< | \
-	pod2html \
-	  --css 'pod.css' \
-	  --title "libguestfs API documentation" \
-	  --htmldir html \
-	  --outfile $@
-
-html/guestfish.1.html: guestfish.pod guestfish-actions.pod
-	mkdir -p html
-	sed \
-	  -e '/@ACTIONS@/rguestfish-actions.pod' -e 's/@ACTIONS@//' \
-	  < $< | \
-	pod2html \
-	  --css 'pod.css' \
-	  --title "guestfish, libguestfs filesystem interactive shell" \
-	  --htmldir html \
-	  --outfile $@
-
-# Recipes web page.
-html/recipes.html: $(wildcard recipes/*.sh) $(wildcard recipes/*.html) $(wildcard recipes/*.example) Makefile make-recipes.sh
-	mkdir -p html
-	rm -f $@ $@-t
-	sh make-recipes.sh recipes/*.sh > $@-t
-	mv $@-t $@
-
-HTMLFILES = html/guestfs.3.html html/guestfish.1.html \
+# The website.
+HTMLFILES = \
+	html/guestfs.3.html \
+	html/guestfs-examples.3.html \
+	html/guestfs-erlang.3.html \
+	html/guestfs-faq.1.html \
+	html/guestfs-java.3.html \
+	html/guestfs-ocaml.3.html \
+	html/guestfs-performance.1.html \
+	html/guestfs-perl.3.html \
+	html/guestfs-python.3.html \
+	html/guestfs-recipes.1.html \
+	html/guestfs-ruby.3.html \
+	html/guestfs-testing.1.html \
+	html/guestfish.1.html \
+	html/guestmount.1.html \
+	html/libguestfs-make-fixed-appliance.1.html \
+	html/libguestfs-test-tool.1.html \
+	html/virt-alignment-scan.1.html \
 	html/virt-cat.1.html \
+	html/virt-copy-in.1.html \
+	html/virt-copy-out.1.html \
 	html/virt-df.1.html \
+	html/virt-edit.1.html \
+	html/virt-filesystems.1.html \
+	html/virt-format.1.html \
 	html/virt-inspector.1.html \
-	html/recipes.html \
-	html/pod.css html/recipes.css
+	html/virt-list-filesystems.1.html \
+	html/virt-list-partitions.1.html \
+	html/virt-ls.1.html \
+	html/virt-make-fs.1.html \
+	html/virt-rescue.1.html \
+	html/virt-resize.1.html \
+	html/virt-sparsify.1.html \
+	html/virt-sysprep.1.html \
+	html/virt-tar.1.html \
+	html/virt-tar-in.1.html \
+	html/virt-tar-out.1.html \
+	html/virt-win-reg.1.html
 
-TEXTFILES = README TODO HACKING
+TEXTFILES = BUGS README RELEASE-NOTES ROADMAP TODO
 
 WEBSITEDIR = $(HOME)/d/redhat/websites/libguestfs
 
+# For reasons not fully understood, we need to rebuild all the
+# man pages and HTMLFILES from scratch here.
 website: $(HTMLFILES) $(TEXTFILES)
+	find -name 'stamp-*.pod' -delete
+	$(MAKE)
 	cp $(HTMLFILES) $(WEBSITEDIR)
 	for f in $(TEXTFILES); do cp $$f $(WEBSITEDIR)/$$f.txt; done
+	cd $(WEBSITEDIR) && \
+	date=`date +%F`; \
+	sed -e "s/SUBST_VERSION/$(VERSION)/" \
+	    -e "s/SUBST_DATE/$$date/" \
+	< index.html.in > index.html
 
-# Generate the ChangeLog automatically from the gitlog.
-
+# When doing 'make dist' update a few files automatically.
 dist-hook:
 	$(top_srcdir)/build-aux/gitlog-to-changelog > ChangeLog
 	cp ChangeLog $(distdir)/ChangeLog
+	$(top_srcdir)/update-bugs.sh > BUGS-t
+	mv BUGS-t BUGS
+	cp BUGS $(distdir)/BUGS
+	git log --pretty="format:%an <%ae>" | sort -u | uniq -w 10 | \
+		grep -v rjones | \
+		grep -v "Richard Jones" \
+		> AUTHORS-t
+	mv AUTHORS-t AUTHORS
+	cp AUTHORS $(distdir)/AUTHORS
 
-# Update the list of translatable files in po/POTFILES.in.
+# Update the list of translatable files (po/POTFILES po/POTFILES-ml).
+# This has to be in the top-level Makefile.am so that we have access
+# to DIST_SUBDIRS.
 all-local:
 	cd $(srcdir); \
-	find $(DIST_SUBDIRS) -name '*.c' -o -name '*.pl' -o -name '*.pm' | \
+	find $(DIST_SUBDIRS) \
+	    -name '*.c' -o -name '*.pl' -o -name '*.pm' | \
 	grep -v '^perl/blib/' | \
-	grep -v '^capitests/' | \
+	grep -v '^tests/' | \
 	grep -v '^daemon/lib/' | \
 	grep -v '^daemon/tests/' | \
 	grep -v '^examples/' | \
@@ -163,21 +232,40 @@ all-local:
 	grep -v '^perl/examples/' | \
 	grep -v '/guestfs_protocol.c' | \
 	grep -v '/rc_protocol.c' | \
+	grep -v '^po-docs/' | \
+	grep -v '^images/' | \
 	LC_ALL=C sort | \
-	sed 's,^\./,,' > po/POTFILES.in
-
-# Pkgconfig.
-
-pkgconfigdir = $(libdir)/pkgconfig
-pkgconfig_DATA = libguestfs.pc
+	sed 's,^\./,,' > po/POTFILES
+	cd $(srcdir); \
+	find resize sparsify sysprep -name '*.ml' | \
+	LC_ALL=C sort > po/POTFILES-ml
 
 # Make clean.
 
-CLEANFILES = $(fs_DATA) \
-	emptydisk \
+CLEANFILES = \
 	pod2htm?.tmp \
-	html/*.html \
-	guestfs.3 guestfish.1
+	html/*.html
 
-clean-local:
-	rm -rf initramfs
+# If you don't want to run all of the tests ('make check') then this
+# will just run libguestfs-test-tool for a quick check.  Note this
+# is NOT a substitute for proper testing!
+
+quickcheck:
+	./run test-tool/libguestfs-test-tool $(QUICKCHECK_TEST_TOOL_ARGS)
+
+# Run extra-tests in tests/extra/ subdirectory.
+
+extra-tests:
+	make -C tests/extra $@
+
+# Make binary distribution.
+
+BINTMPDIR = /tmp/libguestfs-bin
+bindist:
+	rm -rf $(BINTMPDIR)
+	mkdir $(BINTMPDIR)
+	$(MAKE)
+	$(MAKE) DESTDIR=$(BINTMPDIR) install
+	-find $(BINTMPDIR) -type d -exec rmdir --ignore-fail-on-non-empty {} \;
+	(cd $(BINTMPDIR) && tar cf - .) | \
+	  gzip -c -9 > libguestfs-$(VERSION)-$(DISTRO)-$(host_cpu).tar.gz

README

@@ -1,88 +1,153 @@
-Libguestfs is a library for accessing and modifying guest disk images.
-Amongst the things this is good for: making batch configuration
-changes to guests, getting disk used/free statistics (see also:
-virt-df), migrating between virtualization systems (see also:
-virt-p2v), performing partial backups, performing partial guest
-clones, cloning guests and changing registry/UUID/hostname info, and
-much else besides.
-
-Libguestfs uses Linux kernel and qemu code, and can access any type of
-guest filesystem that Linux and qemu can, including but not limited
-to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
-schemes, qcow, qcow2, vmdk.
-
-Libguestfs provides ways to enumerate guest storage (eg. partitions,
-LVs, what filesystem is in each LV, etc.).  It can also run commands
-in the context of the guest.  Also you can access filesystems over FTP.
-
-Libguestfs is a library that can be linked with C and C++ management
-programs (or management programs written in OCaml, Perl, Python, Ruby, Java
-or Haskell).  You can also use it from shell scripts or the command line.
-
-Libguestfs was written by Richard W.M. Jones (rjones@redhat.com) and
-hacked on by lots of other people.  For discussion, development,
-patches, etc. please use the mailing list:
-
-  http://www.redhat.com/mailman/listinfo/libguestfs
-
-
-Home page
-----------------------------------------------------------------------
+Libguestfs is tools and a library for accessing and modifying guest
+disk images.  For more information see the home page:
 
   http://libguestfs.org/
 
+For discussion, development, patches, etc. please use the mailing
+list:
+
+  http://www.redhat.com/mailman/listinfo/libguestfs
+
 
 Requirements
 ----------------------------------------------------------------------
 
-- recent QEMU >= 0.10 with vmchannel support
-  http://lists.gnu.org/archive/html/qemu-devel/2009-02/msg01042.html
+Running ./configure will check you have all the requirements installed
+on your machine.
 
-- febootstrap >= 2.3
+Fedora/RHEL users:
 
-- fakeroot
+  A useful tip is to run:
 
-- fakechroot >= 2.9
+    yum-builddep libguestfs
+
+  which will install all build dependencies automatically.  If that is
+  successful, you don't need to bother with the rest of this section.
+
+Debian/Ubuntu users:
+
+  Use:
+
+    apt-get build-dep libguestfs
+
+  to install all build dependencies.  If that doesn't work, take a
+  look at the Debian source package:
+  http://packages.debian.org/source/libguestfs
+  at the list of 'build-depends' and 'build-depends-indep', and
+  install everything listed there.
+
+  If either of those techniques is successful, you don't need to
+  bother with the rest of this section.
+
+The full requirements are described below.
+
+For basic functionality and the C tools:
+
+- look at appliance/packagelist.in and install as many of the packages
+  that apply to your distro as possible
+
+- QEMU >= 1.0.
+
+- kernel >= 2.6.34 with virtio-serial support enabled.
+
+- virtio-block and virtio-net drivers should be compiled into your
+  host kernel (strictly speaking this is optional, but you will have
+  to make complex changes to the ./configure command line to get it
+  to work if you don't have virtio)
+
+- febootstrap >= 3.17
+
+  Notes: (1) febootstrap 2.x WILL NOT WORK
+         (2) febootstrap 3.x is distro-independent, and is required on
+             Debian and other distros as well as Fedora
+         (3) that is the minimum version, but later versions are better
 
 - XDR, rpcgen (on Linux these are provided by glibc)
 
-- squashfs-tools (mksquashfs only)
+- cpio
 
-- genisoimage / mkisofs
+- gperf
 
-- (Optional) Augeas (http://augeas.net/)
+- pcre (Perl Compatible Regular Expressions C library)
 
-- perldoc (pod2man, pod2text) to generate the manual pages and
-  other documentation.
+- genisoimage (NOT mkisofs any more)
 
-- (Optional) Readline to have nicer command-line editing in guestfish.
+- hivex >= 1.2.7 (http://libguestfs.org/download) (optional)
 
-- (Optional) 'reged' program from chntpw to decode Windows registry
-  entries (http://home.eunet.no/~pnordahl/ntpasswd/)
+- libmagic (the library that corresponds to the 'file' command) (optional)
 
-- (Optional) OCaml if you want to rebuild the generated files, and
-  also to build the OCaml bindings
+- libvirt (optional)
 
-- (Optional) local Fedora mirror
+- libxml2 (optional)
 
-- (Optional) Perl if you want to build the perl bindings
+- libconfig (optional)
 
-- (Optional) Python if you want to build the python bindings
+- augeas >= 0.5.0 (http://augeas.net/) (optional)
 
-- (Optional) Ruby, rake if you want to build the ruby bindings
+- Berkeley DB 'db_dump' and 'db_load' utilities
+  (db4-utils or db4.X-util or similar) (optional)
 
-- (Optional) Java, JNI, jpackage-utils if you want to build the java
-bindings
+- systemtap/DTrace userspace probes (optional)
+  http://sourceware.org/systemtap/wiki/AddingUserSpaceProbingToApps
 
-- (Optional) GHC if you want to build the Haskell bindings
+- perldoc (pod2man, pod2text, pod2html) to generate the manual pages
+  and other documentation.
 
-- (Optional) Perl XML::XPath, Sys::Virt modules (for libvirt support
-in virt-inspector).
+- Readline to have nicer command-line editing in guestfish (optional)
 
-- (Optional, but highly recommended) perl-libintl for translating perl code.
+- xmllint (part of libxml2) to validate virt-inspector
+  RELAX NG schema (optional)
 
-Running ./configure will check you have all the requirements installed
-on your machine.
+- OCaml if you want to rebuild the generated files, and
+  also to build the OCaml bindings (optional)
+
+- ocaml-gettext if you want to translate OCaml tools (optional)
+
+- po4a for translating manpages and POD files.
+  This is optional when compiling from the tarball, but mandatory
+  if you compile from git.
+
+- getfacl, getfattr libraries and programs (optional)
+
+- netpbm, icoutils (optional)
+  These programs are used to render icons from guests.
+
+To build FUSE support (guestmount):
+
+- FUSE libraries and kernel module (optional)
+
+To build language bindings:
+
+- Perl if you want to build the perl bindings (optional)
+
+- Python if you want to build the python bindings (optional)
+
+- Ruby, rake if you want to build the ruby bindings (optional)
+
+- Java, JNI, jpackage-utils if you want to build the java
+  bindings (optional)
+
+- GHC if you want to build the Haskell bindings (optional)
+
+- PHP, phpize if you want to build the PHP bindings (optional)
+
+To build the Perl tools:
+
+- Perl Sys::Virt module (optional)
+
+- Perl Win::Hivex module (optional)
+
+- Perl Pod::Usage module (optional)
+
+- Perl Test::More module (from perl Test::Simple) (optional)
+
+- Perl String::ShellQuote module (optional)
+
+- perl-libintl for translating perl code (optional)
+
+To run virt-sysprep:
+
+- virt-sysprep requires FUSE support since it uses guestmount
 
 
 Building
@@ -90,55 +155,55 @@ Building
 
 Then make the daemon, library and root filesystem:
 
-  ./configure [--with-mirror=URI]
+  ./configure
   make
 
-Use the optional --with-mirror parameter to specify the URI of a local
-Fedora mirror.  See the discussion of the MIRROR parameter in the
-febootstrap(8) manpage.
-
 Finally run the tests:
 
   make check
 
+There are some extra tests, but these require that you have some
+libvirt guests installed, that these guests' disks are accessible by
+the current user, and these tests may fail for other reasons which are
+not necessarily because of real problems.  If you want to run these
+extra tests do:
+
+  make extra-tests
+
 If everything works, you can install the library and tools by running
 this command as root:
 
   make install
 
+You can run guestfish, guestmount and the virt tools without needing
+to install, using the "run" script in the top directory.  This script
+sets up some environment variables.  For example:
 
-Fedora
-----------------------------------------------------------------------
+  ./run ./fish/guestfish [usual guestfish args ...]
 
-We provide packages for Fedora >= 11 in Fedora.  Use those, or build
-from our source RPMs - it's far simpler that way.
+  ./run ./inspector/virt-inspector [usual virt-inspector args ...]
 
-You can compile libguestfs on Fedora 10 but you cannot use it with the
-version of qemu in Fedora 10.  You need to compile your own qemu, see
-section 'qemu' below.
+If you are already in the fish/ subdirectory, then the following
+command will also work:
 
+  ../run ./guestfish [...]
 
-RHEL / EPEL / CentOS etc
-----------------------------------------------------------------------
+You can also make a symlink (note: NOT a hard link) from your $PATH to
+the run script, eg:
 
-We provide packages in EPEL which cover RHEL/CentOS >= 5.  Use those
-or build from our source RPMs.
+  cd ~/bin
+  ln -s ~/libguestfs/run libguestfs-run
+  cd ~/libguestfs
+  libguestfs-run ./inspector/virt-inspector [...]
 
+You can also run the C programs under valgrind like this:
 
-Debian
-----------------------------------------------------------------------
+  ./run valgrind [valgrind opts...] ./cat/virt-cat [virt-cat opts...]
 
-libguestfs is now built as a package in Debian by Guido Gunther and
-the other Debian libvirt maintainers.  See:
+This also works with sudo (eg. if you need root access for libvirt or
+to access a block device):
 
-http://wiki.debian.org/Teams/DebianLibvirtTeam#Packages
-
-You can build for Debian in two different ways, either building a
-Fedora-based appliance using febootstrap, yum, rpm, fakeroot,
-fakechroot (all packaged in Debian).  However the recommended way is
-to build a Debian-based appliance using debootstrap and debirf.
-
-Both ways are supported by the configure script.
+  sudo ./run ./cat/virt-cat -d LinuxGuest /etc/passwd
 
 
 qemu
@@ -147,16 +212,9 @@ qemu
 By far the most common problem is with broken or incompatible
 qemu releases.
 
-First of all, you need qemu >= 0.10.4, which contains a vmchannel
-implementation.  There are several, conflicting, incompatible things
-called 'vmchannel' which at one time or another have been added or
-proposed for qemu/KVM.  The _only_ one we support is this one:
-
-  http://lists.gnu.org/archive/html/qemu-devel/2009-02/msg01042.html
-
-Secondly, different versions of qemu have problems booting the
-appliance for different reasons.  This varies between versions of
-qemu, and Linux distributions which add their own patches.
+Different versions of qemu have problems booting the appliance for
+different reasons.  This varies between versions of qemu, and Linux
+distributions which add their own patches.
 
 If you find a problem, you could try using your own qemu built from
 source (qemu is very easy to build from source), with a 'qemu
@@ -183,82 +241,11 @@ On some systems, the chmod will not survive a reboot, and you will
 need to make edits to the udev configuration.
 
 
-Supermin appliance
-----------------------------------------------------------------------
-
-If you configure with --enable-supermin then we will build a supermin
-appliance (supermin = super-minimized).  This is a very specialized
-appliance which is built on-the-fly at runtime (specifically, when you
-call guestfs_launch).
-
-The normal appliance is a self-contained Linux operating system, based
-on the Fedora/RHEL/CentOS Linux distro.  So it contains a complete
-copy of all the libraries and programs needed, like kernel, libc,
-bash, coreutils etc etc.
-
-The supermin appliance removes the kernel and all the executable
-libraries and programs from the appliance.  That just leaves a
-skeleton of config files and some data files, which is obviously
-massively smaller than the normal appliance.  At runtime we rebuild
-the appliance on-the-fly from the libraries and programs on the host
-(eg. pulling in the real /lib/libc.so, the real /bin/bash etc.)
-
-Although this process of rebuilding the appliance each time sounds
-slow, it turns out to be faster than using the prebuilt appliance.
-(Most of the saving comes from not compressing the appliance - it
-transpires that decompressing the appliance is the slowest part of the
-whole boot sequence).  On my machine, a new appliance can be built in
-under a fifth of a second, and the boot time is several seconds
-shorter.
-
-The big advantage of the supermin appliance for distributions like
-Fedora is that it gets security fixes automatically from the host, so
-there is no need to rebuild the whole of libguestfs for a security
-update in some underlying library.
-
-There are several DISADVANTAGES:
-
-It won't work at all except in very narrow, controlled cases like the
-Fedora packaging case.  We control the dependencies of the libguestfs
-RPM tightly to ensure that the required binaries are actually present
-on the host.
-
-Furthermore there are certain unlikely changes in the packages on the
-host which could break a supermin appliance, eg. an updated library
-which depends on an additional data file.
-
-Also supermin appliances are subjected to changes in the host kernel
-which might break compatibility with qemu -- these are, of course,
-real bugs in any case.
-
-Lastly, supermin appliances really can't be moved between branches of
-distributions (eg. built on Fedora 12 and moved to Fedora 10) because
-they are not self-contained and they rely on certain libraries being
-around.  You shouldn't do this anyway.
-
-Use supermin appliances with caution.
-
-
-Notes on cross-architecture support
-----------------------------------------------------------------------
-
-At the moment we basically don't support cross-architecture or
-32-on-64.  This limits what is possible for some guests.  Filesystem
-operations and FTP export will work fine, but running commands in
-guests may not be possible.
-
-To enable this requires work for cross-architecture and 32-on-64
-support in febootstrap, fakeroot and fakechroot.
-
-The daemon/ directory contains its own configure script.  This is so
-that in future we will be able to cross-compile the daemon.
-
-
 Mirroring tip
 ----------------------------------------------------------------------
 
 On my machines I can usually rebuild the appliance in around 3
-minutes.  If it takes much longer for you, use a local Fedora mirror
+minutes.  If it takes much longer for you, use a local distro mirror
 or squid.
 
 To use squid to cache yum downloads, read this first:
@@ -282,21 +269,61 @@ distributions.  Non-Linux ports are trickier, but we will accept
 patches if they aren't too invasive.
 
 The main porting issues are with the dependencies needed to build the
-appliance.  You will need to find or port the following packages
-first:
+appliance.  You will need to port the febootstrap first
+(http://people.redhat.com/~rjones/febootstrap/).
 
- - fakeroot
- - fakechroot
- - python
- - rpm-python    http://www.rpm.org/
- - yum           http://yum.baseurl.org/
- - febootstrap   http://et.redhat.com/~rjones/febootstrap/
+
+Note on using clang (from LLVM) instead of GCC
+----------------------------------------------------------------------
+
+  export CC=clang
+  ./configure --disable-probes
+  make
+
+SystemTap/DTrace-style userspace probe points don't work under the
+clang compiler, which is why you may need to disable them.
+
+Don't enable GCC warnings (ie. *don't* use
+'./configure --enable-gcc-warnings').
+
+
+Note on using non-x86 architectures
+----------------------------------------------------------------------
+
+In theory libguestfs should work on non-x86 architectures.  Usually if
+it doesn't it's because qemu isn't available or cannot boot the
+kernel.
+
+For ARM you will need to specify the exact machine type and CPU
+variant that is required to boot the Linux kernel (there's no way to
+know this except by looking at how the Linux kernel was configured).
+For example:
+
+  ./configure \
+        --with-qemu="qemu-system-arm" \
+        --with-qemu-options="-M versatilepb -cpu arm926"
+  ./configure \
+        --with-qemu="qemu-system-arm" \
+        --with-qemu-options="-M vexpress-a9 -cpu cortex-a9"
+
+Note that since virtio is required by libguestfs, and virtio is a
+PCI-based architecture, whatever architecture qemu emulates must
+support PCI also.
+
+For PPC64 you will need to specify the IBM pSeries machine type:
+
+  ./configure \
+        --with-qemu="qemu-system-ppc64" \
+        --with-qemu-options="-M pseries"
+
+After building libguestfs, run 'make quickcheck' and pay close
+attention to the qemu command line and kernel output.
 
 
 Copyright and license information
 ----------------------------------------------------------------------
 
-Copyright (C) 2009 Red Hat Inc.
+Copyright (C) 2009-2012 Red Hat Inc.
 
 The library is distributed under the LGPLv2+.  The programs are
 distributed under the GPLv2+.  Please see the files COPYING and

ROADMAP

@@ -0,0 +1,52 @@
+Roadmap for future releases
+---------------------------
+
+Before you read this:
+
+(1) To see what's in the current release, read 'RELEASE-NOTES'.
+
+(2) To see the list of bugs, read 'BUGS'.
+
+(3) To understand libguestfs versioning, read this:
+    http://libguestfs.org/guestfs.3.html#libguestfs_version_numbers
+
+(4) For general "might be good to have" items, see 'TODO'.
+
+For next major stable release (1.20)
+------------------------------------
+
+* Allow remote libvirt volumes to be accessed.  This requires some
+  enhancements to libvirt which have been agreed but not yet
+  implemented.
+
+Bugs assigned to 1.20 (put "1.20" in the Devel Whiteboard field in
+Bugzilla):
+
+https://bugzilla.redhat.com/buglist.cgi?query_format=advanced&field0-0-0=cf_devel_whiteboard&bug_status=NEW&bug_status=ASSIGNED&bug_status=MODIFIED&bug_status=ON_DEV&bug_status=ON_QA&bug_status=VERIFIED&bug_status=FAILS_QA&bug_status=RELEASE_PENDING&bug_status=POST&bug_status=PASSES_QA&type0-0-0=anywords&value0-0-0=1.20&component=libguestfs&product=Virtualization%20Tools
+
+Beyond 1.20
+-----------
+
+* Make 'guestfish --ro' be the default, and get users to use
+  'guestfish --rw' for write access (but allow the default to be
+  overridden in a configuration file).  This was originally planned
+  for 1.10 but there's not nearly enough adoption of the new
+  'guestfish --rw' option out there to do this yet.
+
+* Allow alternate methods to start the appliance, including through
+  libvirt, by connecting to an existing appliance, and remotely over
+  ssh.  Libvirt integration was originally planned for 1.10 but we
+  didn't get patches in time.
+
+* Write a new partition handling library to replace parted, and use it
+  instead of parted.  (RHBZ#593511, RHBZ#642821).
+
+* Hot plugging of disks using QMP.  This would allow more efficient
+  reuse of the appliance in some circumstances: multiple disks
+  (ie. VMs) can be added in turn to the same appliance.  In particular
+  this would help virt-df.
+
+  [Note this requires upstream work on QMP, see:
+  https://www.redhat.com/archives/libguestfs/2011-March/msg00124.html]
+
+See TODO and BUGS files.

TODO

@@ -6,61 +6,27 @@ to libguestfs in future.
 
    - RWMJ
 
-Python bindings
----------------
-
-Ideas for the Python bindings:
-https://www.redhat.com/archives/fedora-virt/2009-April/msg00114.html
-
-FTP server or FUSE?
--------------------
-
-Originally we had intended to implement an NFS server inside the
-appliance, which would allow the guest filesystems to be mounted on
-the host, and large changes to be made.  We eventually rejected the
-idea of using NFS, partly because it requires root to mount
-filesystems in the host, and partly because of problems handling UID
-mappings between host and guest filesystem.
-
-Then we look at implementing an FTP server instead.  FTP clients are
-widely available for many languages, don't require root, and don't
-have any UID mapping problems.  However there is the problem of
-getting the TCP connection into the guest, and that FTP requires a
-secondary data connection either in or out of the guest (the NFS
-situation is even more dire).
-
-Thirdly we looked at implementing a FUSE-based filesystem.  This is
-plausible - it could be implemented just by adding the additional FUSE
-operations to the standard guestfs(3) API, and then implementing a
-simple FUSE daemon.  (The FUSE website has some very helpful
-documentation and examples).  I [RWMJ] am not particularly convinced
-that a FUSE-based filesystem would really be useful to anyone, but am
-prepared to accept patches if someone does all the work.
-
-See also the mountlo project:
-http://sourceforge.net/project/showfiles.php?group_id=121684&package_id=150116
-
-BufferIn
+FUSE API
 --------
 
-BufferIn should turn into <char *, int> and simple strings in other
-languages that can handle 8 bit clean strings.
+The API needs more test coverage, particularly lesser-used system
+calls.
 
-Limit on transfers would still be 2MB for these types.
- - then implement write-file properly
-
-febootstrap / debootstrap inside appliance
-------------------------------------------
-
-This was originally proposed as a way to install new operating systems
-in the appliance.  However no one has come up with a workable
-solution.
+The big unresolved issue is UID/GID mapping between guest filesystem
+IDs and the host.  It's not easy to automate this because you need
+extra details about the guest itself in order to get to its
+UID->username map (eg. /etc/passwd from the guest).
 
 Haskell bindings
 ----------------
 
 Complete the Haskell bindings (see discussion on haskell-cafe).
 
+PHP bindings
+------------
+
+Add bindtests to PHP bindings.
+
 Complete bind tests
 -------------------
 
@@ -77,90 +43,20 @@ data, at least partially.  This would be just another output type so:
 Note that recent versions of libvirt/virt-install allow guests to be
 imported, so this is not so useful any more.
 
-"Standalone/local mode"
------------------------
-
-Instead of running guestfsd (the daemon) inside qemu, there should be
-an option to just run guestfsd directly.
-
-The architecture in this mode would look like:
-
-     +------------------+
-     | main program     |
-     |------------------|
-     | libguestfs       |
-     +--------^---------+
-          |   | reply
-      cmd |   |
-     +----v-------------+
-     | guestfsd         |
-     +------------------+
-
-Notes:
-
-(1) This only makes sense if we are running as root.
-
-(2) There is no console / kernel messages in this configuration, but
-we might consider capturing stderr from the daemon.
-
-(3) guestfs_config and guestfs_add_drive become no-ops.
-
-Obviously in this configuration, commands are run directly on the
-local machine's disks.  You could just run the commands themselves
-directly, but libguestfs provides a convenient API and language
-bindings.  Also deals with tricky stuff like parsing the output of the
-LVM commands.  Also we get to leverage other code such as
-virt-inspector.
-
-This is mainly useful from live CDs, ie. virt-p2v.
-
-Should we bother having the daemon at all and just link the guestfsd
-code directly into libguestfs?
-
-PPC problems
-------------
-
-[This section should be filed as bugs, but no one seems to care for
-PPC hosts and the hardware is rapidly becoming obsolete]
-
-  ppc (32 bit) works with qemu from git, however there is no serial console
-
-  ppc64 requires extra parameters:
-    -M mac99 -cpu ppc64
-  however it still fails:
-    invalid/unsupported opcode: 01 - 01 - 1a (06301e83) 00000000018c2738 1
-    invalid bits: 00400000 for opcode: 0b - 19 - 15 (2d746572) 0000000000009230
-
-  no serial console in ppc or ppc64 because no one can tell us what
-  console=ttyXX option to use
-
-Supermin appliance to febootstrap
----------------------------------
-
-Supermin appliance functionality should be moved into febootstrap.
-
 Ideas for extra commands
 ------------------------
 
   General glibc / core programs:
     chgrp
-    dd (?)
-    utime / utimes / futimes / futimens / l..
     more mk*temp calls
-    trunc[ate??]
 
   ext2 properties:
-    chattr
-    lsattr
     badblocks
-    blkid
     debugfs
     dumpe2fs
     e2image
     e2undo
     filefrag
-    findfs
-    logsave
     mklost+found
 
   SELinux:
@@ -180,88 +76,425 @@ Such as:
 initrd-extract
 initrd-replace
 
-Simple editing of configuration files
--------------------------------------
-
-Some easy non-Augeas methods to edit configuration files.
-I'm thinking:
-
-  replace /etc/file key value
-
-which would look in /etc/file for any instances of
-
-  key=...
-  key ...
-  key:...
-
-and replace them with
-
-  key=value
-  key value
-  key:value
-
-That would solve about 50% of reconfiguration needs, and for the
-rest you'd use Augeas, 'download'+'upload' or 'edit'.
-
-RWMJ: I had a go at implementing this, but it's quite error-prone to
-do this sort of editing inside the C-based daemon code.  It's far
-better to do it with Augeas, or else to use an external language like
-Perl.
-
-Quick Perl scripts
-------------------
-
-Currently we can't do Perl "one-liners".  ie. The current syntax for
-any short Perl one-liner would be:
-
-  perl -MSys::Guestfs -e '$g = Sys::Guestfs->new(); $g->add_drive ("foo"); $g->launch; $g->wait_ready; $g->mount ("/dev/sda1", "/"); ....'
-
-You can see we're well beyond a single line just getting to the point
-of adding drives and mounting.
-
-First suggestion:
-
- $h = create ($filename, \"/dev/sda1\" => \"/\");
-
- $h = create ([$file1, $file2], \"/dev/sda1\" => \"/\");
-
-To mount read-only, add C<ro =E<gt> 1> like this:
-
- $h = create ($filename, \"/dev/sda1\" => \"/\", ro => 1);
-
-which is equivalent to the following sequence of calls:
-
- $h = Sys::Guestfs->new ();
- $h->set_autosync (1);
- $h->add_drive_ro ($filename);
- $h->launch ();
- $h->wait_ready ();
- $h->mount_ro (\"/dev/sda1\", \"/\");
-
-Command-line form would be:
-
- perl -MSys::Guestfs=:all -e '$_=create("guest.img", "/dev/sda1" => "/"); $_->cat ("/etc/fstab");'
-
-That's not brief enough for one-liners, so we could have an extra
-autogenerated module which creates a Sys::Guestfs handle singleton
-(the handle is an implicit global variable as in guestfish), eg:
-
- perl -MSys::Guestfs::One -e 'inspect("guest.img"); cat ("/etc/fstab");'
-
-How would editing files work?
-
-ntfsclone
----------
-
-Useful imaging tool:
-http://man.linux-ntfs.org/ntfsclone.8.html
-
-Standard images
+virt-rescue pty
 ---------------
 
-Equip guestfish with some standard images that it can load
-quickly, eg:
+See:
+http://search.cpan.org/~rgiersig/IO-Tty-1.08/Pty.pm
+http://www.perlmonks.org/index.pl?node_id=582185
 
-  load ext2
+Note that pty requires cooperation inside the C code too (there are
+two sides to a pty, and one has to be handled after the fork).
 
-Maybe it's better to create these on the fly?
+[I tried to implement this in the new C virt-rescue, but it doesn't
+work.  qemu is implementing its own ptys, and they are broken.  Need
+to fix qemu.]
+
+Windows-based daemon/appliance
+------------------------------
+
+See discussion on list:
+https://www.redhat.com/archives/libguestfs/2009-November/msg00165.html
+
+virt-disk-explore
+-----------------
+
+For multi-level disk images such as live CDs:
+http://rwmj.wordpress.com/2009/07/15/unpack-the-russian-doll-of-a-f11-live-cd/
+
+It's possible with libguestfs to recursively look for anything that
+might be a filesystem, mount-{,loop} it and look in those, revealing
+anything in a disk image.
+
+However this won't work easily for VM disk images in the disk image.
+One would have to download those to the host and launch another
+libguestfs instance.
+
+[Not sure this is such a good idea.  See also live CD inspection idea below.]
+
+Map filesystems to disk blocks
+------------------------------
+
+Map files/filesystems/(any other object) to the actual disk
+blocks they occupy.
+
+And vice versa.
+
+Is it even possible?
+
+See also contribs/visualize-alignment/
+
+Integration with host intrusion systems
+---------------------------------------
+
+Perfect way to monitor VMs from outside the VM.  Look for file
+hashes, log events, login/logout etc.
+
+http://www.ossec.net/
+http://la-samhna.de/samhain/
+http://sourceforge.net/projects/aide/
+http://osiris.shmoo.com/
+http://sourceforge.net/projects/tripwire/
+
+Freeze/thaw filesystems
+-----------------------
+
+Access to these ioctls:
+http://git.kernel.org/linus/fcccf502540e3d7
+
+Tips for new users in guestfish
+-------------------------------
+
+$ guestfish
+Tip: You need to 'add disk.img' or 'alloc disk.img nn' to make a new image.
+Type 'notips' to disable tips permanently.
+><fs> add mydisk
+Tip: You need to type 'run' before you can see into the disk image.
+><fs> run
+Tip: Use 'list-filesystems' to see what filesystems are available.
+><fs> list-filesystems
+/dev/vda1
+Tip: Use 'mount fs /' to mount a filesystem.
+><fs> mount /dev/vda1 /
+Tip: Use 'll /' to view the filesystem or ...
+><fs> ll /
+
+Could we make guestfish interactive if commands are used without params?
+------------------------------------------------------------------------
+
+><fs> sparse
+[[Prints man page]]
+Image name? disk.img
+Size of image? 10M
+
+Better support for encrypted devices
+------------------------------------
+
+Currently LUKS support only works if the device contains volume
+groups.  If it contains, eg., partitions, you cannot access them.
+We would like to add:
+
+  - Direct access to the /dev/mapper device (eg. if it contains
+    anything apart from VGs).
+
+Display image as PS
+-------------------
+
+Display the structure of an image file as a PS.
+
+Greater use of blkid / libblkid
+-------------------------------
+
+There are various useful functions in libblkid for listing partitions,
+devices etc which we are essentially duplicating in the daemon.  It
+would make more sense to just use libblkid for this.
+
+There are some places where we call out to the 'blkid' program.  This
+might be replaced by direct use of the library (if this is easier).
+
+But it is very hard to be compatible between RHEL6 and RHEL5 when
+using direct library.
+
+Visualization
+-------------
+
+Eric Sandeen pointed out the blktrace tool which is a better way of
+capturing traces than using patched qemu (see
+contrib/visualize-alignment).  We would still use the same
+visualization tools in conjunction with blktrace traces.
+
+guestfish parsing
+-----------------
+
+At the moment guestfish uses an ad hoc parser which has many
+shortcomings.  We should change to using a lex/yacc-based scanner and
+parser (there are better parsers out there, but yacc is sufficient and
+very widely available).
+
+The scanner must deal with the case of parsing a whole command string,
+eg. for a command that the user types in:
+
+ ><fs> add-drive-opts "/tmp/foo" readonly:true
+
+and also with parsing single words from the command line:
+
+ guestfish add-drive-opts /tmp/foo readonly:true
+
+Note the quotes are for scanning and don't indicate types.
+
+We should also allow variables and expressions as part of this new
+parsing code, eg:
+
+ set roots inspect-os
+ set product inspect-get-product-name %{roots[0]}
+
+% is better than $ because of shell escaping and confusion with shell
+variables.
+
+Can we combine this with ability to set and read environment
+variables?  Currently guestfish uses many environment variables like
+$EDITOR without any corresponding ability to set them.
+
+ set EDITOR /usr/bin/emacs
+ echo $EDITOR  # or %{EDITOR}
+ edit /etc/resolv.conf
+
+More ntfs tools
+---------------
+
+ntfsprogs actually has a lot more useful tools than we currently
+use.  Interesting ones are:
+
+ntfscluster: display file(s) that occupy a cluster or sector
+
+ntfsinfo: print various information about NTFS volume and files
+
+ntfs streams: extract alternate streams from NTFS files
+
+ntfsck: checker for NTFS filesystems
+
+Undelete files
+--------------
+
+Two useful tools:
+
+  - ext2undelete
+  - ntfsundelete
+
+More mkfs_opts options
+----------------------
+
+Useful options to offer:
+ - Set label.
+ - Set UUID.
+
+Use /proc/self/mountinfo
+------------------------
+
+This file contains lots of interesting information about
+what is mounted and where. eg:
+
+  16 21 0:3 / /proc rw,relatime - proc /proc rw
+  17 21 0:16 / /sys rw,relatime - sysfs /sys rw,seclabel
+  18 23 0:5 / /dev rw,relatime - devtmpfs udev rw,seclabel,size=1906740k,nr_inodes=476685,mode=755
+  26 21 253:3 / /home rw,relatime - ext4 /dev/mapper/vg-lv_home rw,seclabel,barrier=1,data=ordered
+
+This could be used instead of current hairy code to parse the output
+of the 'mount' command.  We could add new APIs to return kernel mount
+options, type of filesystem at a mountpoint etc.
+
+guestfish drive letters
+-----------------------
+
+There should be an option to mount all Windows drives as separate
+paths, like C: => /c/, D: => /d/ etc.
+
+More inspection features
+------------------------
+
+- last shutdown time
+- DHCP address
+- last time the software was updated
+- last user who logged in
+- lastlog, last, who
+
+Integrate virt-inspector with CMDBs
+-----------------------------------
+
+Either integrate virt-inspector with Configuration Management
+Databases (CMDBs) or at least check that virt-inspector produces the
+right range of data so that integration would be possible.  The
+standards for CMDBs come from the DMTF, see eg:
+
+http://dmtf.org/news/pr/2009/7/dmtf-releases-cmdbf-standard-federating-configuration-management-data
+
+Efficient way to visit all files
+--------------------------------
+
+https://rwmj.wordpress.com/2010/12/15/tip-audit-virtual-machine-for-setuid-files/#content
+
+A naive method would look like:
+
+  g#visit ~return_stats:true "/" (
+    fun pathname stat ->
+      ...
+  )
+
+However this has two disadvantages:
+
+ - requires hand-written custom bindings in each language
+ - unclear about locking, thread-safety and re-entrancy of handle g
+
+A better way would be to have some sort of explicit "download all
+filenames and stat structures", which could then be iterated over:
+
+  let files = g#find_opts ~return_stats:true "/" in
+  List.iter (
+    fun pathname stat ->
+      ...
+  )
+
+The problem with this is that 'files' is going to be larger than a
+protocol buffer.
+
+This leads to thinking about changes to the protocol / generator to
+make this simpler.  The proposal would be to add RBigStringList,
+RBigStructList [or RBig (Ranytype ...)].  These would work like
+FileOut, in that they would use file streaming to stream XDR
+structures (probably written to a file on the library side).
+Generated code would hide most of the implementation.
+
+We also need to think about security issues: is it possible for the
+daemon to keep sending back data forever, and if so what happens on
+the library side.
+
+[Users can now use virt-ls to solve some of these problems, but it is
+not a general solution at the API level]
+
+Interactive disk creator
+------------------------
+
+An interactive disk creator program.
+
+Attach method for disconnected operation
+----------------------------------------
+
+http://libguestfs.org/guestfs.3.html#guestfs_set_attach_method
+
+"Librarian" has an idea that he should be able to attach to a regular
+appliance, but disconnect from it and reconnect to it later.  This
+would be some sort of modified attach method (see link above).
+
+The complexity here is that we would no longer have access to
+stdin/stdout (or we'd have to direct that somewhere else).
+
+libosinfo mappings for virt-inspector
+-------------------------------------
+
+Return libosinfo mappings from inspection API.
+
+virt-sysprep ideas
+------------------
+
+ - other Spacewalk / RHN IDs (?)
+ - Windows sysprep
+   (see: https://github.com/clalancette/oz/blob/e74ce83283d468fd987583d6837b441608e5f8f0/oz/Windows.py )
+ - (librarian suggests ...)
+   . install a firstboot script      virt-sysprep --script=/tmp/foo.sh
+   . run external guestfish script   virt-sysprep --fish=/tmp/foo.fish
+ - if drives are encrypted, then dm-crypt key should be changed
+   and drives all re-encrypted
+ - /etc/pki
+   (Steve says ...)
+   Rpm uses nss. Nss sets up its crypto database in
+   /etc/pki. Depending on how long the machine ran before cloning, you
+   may have picked up some certificates or things. This is an area
+   that you would want to look into.
+ - secure erase of inodes etc using scrub (Steve Grubb)
+ - other directories that could require cleaning include:
+    /var/run/*
+   (thanks Marko Myllynen, James Antill)
+ - remove or modify UUIDs in /etc/fstab (eg. on Ubuntu)
+   (thanks Joshua Daniel Franklin)
+
+As well as 'virt-sysprep' there is a case for a 'virt-customize' tool
+which can customize templated guests.  This would be useful within
+companies/organizations that want to offer multiple guests, but all
+customized with the organization logo etc.  Some ideas:
+
+ - change the background image to some custom desktop
+ - change the sign-on messages (/etc/issue.net etc)
+ - firstboot script (as suggested by librarian above)
+ - Windows login script/service
+
+Launch remote sessions over ssh
+-------------------------------
+
+We had an idea you could add a launch method that uses ssh, ie.  all
+febootstrap and qemu commands happen the same as now, but prefixed by
+ssh so it happens on a remote machine.
+
+Note that proper remote support and integration with libvirt is
+different from this, and people are working on that.  ssh would just
+be "remote-lite".
+
+virt-make-fs and virt-win-reg need to not be in Perl
+----------------------------------------------------
+
+Probably they should be in C or OCaml.
+
+Integrate snap-type functionality in inspection tools
+-----------------------------------------------------
+
+Mo Morsi's "snap" program lets you describe a guest as the list of
+packages (eg. RPMs) installed + changes made to those RPMs + files
+added.
+
+http://projects.morsi.org/wiki/Snap
+
+This results in a compact description of the guest.  He even managed
+to do a kind of migration of guests by simply recreating the guest
+from the description on the target machine.
+
+It would be ideal to integrate this and/or use inspection to do this.
+
+Ongoing code cleanups
+---------------------
+
+Examine every use of 'int' in C code for signed overflow problems.
+
+All file descriptors in the library and daemon should normally be
+opened with O_CLOEXEC.  Therefore we need to examine every call to:
+
+ - open, openat
+ - creat
+ - pipe (see also: pipe2)
+ - dup, dup2 (see also: dup3)
+ - socket, socketpair
+ - accept (see also: accept4)
+ - signalfd, timerfd, epoll_create
+
+virt-sparsify enhancements
+--------------------------
+
+TMPDIR should be checked to ensure that we won't run out of space
+during the conversion, since current behaviour is very bad when this
+happens (it usually causes virt-sparsify to hang).  This requires
+writing a small C binding to statvfs for OCaml.
+
+'virt-sparsify --whitelist' option to generate skeletons (for
+debugging, bug forensics, diagnosis).  The whilelist option would
+specify a list of files to be *preserved*.  All other files in the
+image would be replaced by equivalent files of zeroes, thus minimizing
+the size of the debug image that needs to be shipped to us by the
+customer.
+
+Optimize the appliance
+----------------------
+
+Pass -cpu host.  Anything else?
+
+Sort out partitioning
+---------------------
+
+Ignoring some legacy APIs, we currently have a mixed selection of
+'part-*' APIs, implemented using parted.  We don't like parted or
+libparted very much, and would love to replace it with something else.
+The part-* APIs are quirky, but not too bad and we should maintain and
+extend them instead of making another set of APIs.
+
+One option is to write "libmbr" and "libgpt" libraries that would just
+do MBR and GPT respectively, and do it directly and do it well.  They
+wouldn't try to abstract anything (so, unlike libparted).  We could
+then reimplement the part-* APIs on top of these hopefully sensible
+libraries.  This is a lot of work.
+
+Another option is to look for tools or libraries to replace parted.
+For GPT there is a fairly obvious candidate: Rod Smith's GPT fdisk
+(http://www.rodsbooks.com/gdisk/).  Rod has spent a lot of time
+studying GPT, and seems to know more about it than any sane man
+should.  There is a command line tool designed for scripts called
+'sgdisk'.  The tools are packaged for many Linux distros.  Even if
+this approach works, it doesn't solve the MBR problem, so likely we'd
+have to write a library for that (or perhaps go back to sfdisk but
+using a very abstracted interface over sfdisk).

align/Makefile.am

@@ -0,0 +1,79 @@
+# libguestfs virt alignment tools
+# Copyright (C) 2011 Red Hat Inc.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+include $(top_srcdir)/subdir-rules.mk
+
+EXTRA_DIST = \
+	virt-alignment-scan.pod
+
+CLEANFILES = stamp-virt-alignment-scan.pod
+
+bin_PROGRAMS = virt-alignment-scan
+
+SHARED_SOURCE_FILES = \
+	../fish/config.c \
+	../fish/inspect.c \
+	../fish/keys.c \
+	../fish/options.h \
+	../fish/options.c \
+	../fish/virt.c
+
+virt_alignment_scan_SOURCES = \
+	$(SHARED_SOURCE_FILES) \
+	domains.c \
+	scan.c \
+	scan.h
+
+virt_alignment_scan_CFLAGS = \
+	-DGUESTFS_WARN_DEPRECATED=1 \
+	-I$(top_srcdir)/src -I$(top_builddir)/src \
+	-I$(top_srcdir)/fish \
+	-I$(srcdir)/../gnulib/lib -I../gnulib/lib \
+	-DLOCALEBASEDIR=\""$(datadir)/locale"\" \
+	$(WARN_CFLAGS) $(WERROR_CFLAGS) \
+	$(LIBCONFIG_CFLAGS) \
+	$(LIBVIRT_CFLAGS)
+
+virt_alignment_scan_LDADD = \
+	$(LIBCONFIG_LIBS) \
+	$(top_builddir)/src/libguestfs.la \
+	../gnulib/lib/libgnu.la \
+	$(LIBVIRT_LIBS) \
+	-lm
+
+# Manual pages and HTML files for the website.
+man_MANS = virt-alignment-scan.1
+noinst_DATA = $(top_builddir)/html/virt-alignment-scan.1.html
+
+virt-alignment-scan.1 $(top_builddir)/html/virt-alignment-scan.1.html: stamp-virt-alignment-scan.pod
+
+stamp-virt-alignment-scan.pod: virt-alignment-scan.pod
+	$(top_builddir)/podwrapper.sh \
+	  --man virt-alignment-scan.1 \
+	  --html $(top_builddir)/html/virt-alignment-scan.1.html \
+	  $<
+	touch $@
+
+# Tests.
+
+# random_val := $(shell awk 'BEGIN{srand(); print 1+int(255*rand())}' < /dev/null)
+
+# TESTS_ENVIRONMENT = \
+# 	MALLOC_PERTURB_=$(random_val) \
+# 	$(top_builddir)/run --test
+
+# TESTS = test-virt-alignment-scan.sh

align/domains.c

@@ -0,0 +1,360 @@
+/* virt-alignment-scan
+ * Copyright (C) 2012 Red Hat Inc.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#include <config.h>
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <libintl.h>
+#include <assert.h>
+
+#ifdef HAVE_LIBVIRT
+#include <libvirt/libvirt.h>
+#include <libvirt/virterror.h>
+#endif
+
+#include "progname.h"
+
+#if defined(HAVE_LIBVIRT) && defined(HAVE_LIBXML2)
+#define GUESTFS_PRIVATE_FOR_EACH_DISK 1
+#endif
+
+#include "guestfs.h"
+#include "options.h"
+#include "scan.h"
+
+#if defined(HAVE_LIBVIRT) && defined(HAVE_LIBXML2)
+
+/* The list of domains and disks that we build up in
+ * get_domains_from_libvirt.
+ */
+struct disk {
+  struct disk *next;
+  char *filename;
+  char *format; /* could be NULL */
+};
+
+struct domain {
+  char *name;
+  char *uuid;
+  struct disk *disks;
+  size_t nr_disks;
+};
+
+struct domain *domains = NULL;
+size_t nr_domains;
+
+static int
+compare_domain_names (const void *p1, const void *p2)
+{
+  const struct domain *d1 = p1;
+  const struct domain *d2 = p2;
+
+  return strcmp (d1->name, d2->name);
+}
+
+static void
+free_domain (struct domain *domain)
+{
+  struct disk *disk, *next;
+
+  for (disk = domain->disks; disk; disk = next) {
+    next = disk->next;
+    free (disk->filename);
+    free (disk->format);
+    free (disk);
+  }
+
+  free (domain->name);
+  free (domain->uuid);
+}
+
+static void add_domains_by_id (virConnectPtr conn, int *ids, size_t n);
+static void add_domains_by_name (virConnectPtr conn, char **names, size_t n);
+static void add_domain (virDomainPtr dom);
+static int add_disk (guestfs_h *g, const char *filename, const char *format, int readonly, void *domain_vp);
+static size_t add_disks_to_handle_reverse (struct disk *disk, size_t *errors_r);
+static void reset_guestfs_handle (void);
+
+void
+get_domains_from_libvirt (int uuid, size_t *worst_alignment_ptr)
+{
+  virErrorPtr err;
+  virConnectPtr conn;
+  int n;
+  size_t i, count, errors;
+  const char *prefix;
+
+  nr_domains = 0;
+  domains = NULL;
+
+  /* Get the list of all domains. */
+  conn = virConnectOpenReadOnly (libvirt_uri);
+  if (!conn) {
+    err = virGetLastError ();
+    fprintf (stderr,
+             _("%s: could not connect to libvirt (code %d, domain %d): %s\n"),
+             program_name, err->code, err->domain, err->message);
+    exit (EXIT_FAILURE);
+  }
+
+  n = virConnectNumOfDomains (conn);
+  if (n == -1) {
+    err = virGetLastError ();
+    fprintf (stderr,
+             _("%s: could not get number of running domains (code %d, domain %d): %s\n"),
+             program_name, err->code, err->domain, err->message);
+    exit (EXIT_FAILURE);
+  }
+
+  int ids[n];
+  n = virConnectListDomains (conn, ids, n);
+  if (n == -1) {
+    err = virGetLastError ();
+    fprintf (stderr,
+             _("%s: could not list running domains (code %d, domain %d): %s\n"),
+             program_name, err->code, err->domain, err->message);
+    exit (EXIT_FAILURE);
+  }
+
+  add_domains_by_id (conn, ids, n);
+
+  n = virConnectNumOfDefinedDomains (conn);
+  if (n == -1) {
+    err = virGetLastError ();
+    fprintf (stderr,
+             _("%s: could not get number of inactive domains (code %d, domain %d): %s\n"),
+             program_name, err->code, err->domain, err->message);
+    exit (EXIT_FAILURE);
+  }
+
+  char *names[n];
+  n = virConnectListDefinedDomains (conn, names, n);
+  if (n == -1) {
+    err = virGetLastError ();
+    fprintf (stderr,
+             _("%s: could not list inactive domains (code %d, domain %d): %s\n"),
+             program_name, err->code, err->domain, err->message);
+    exit (EXIT_FAILURE);
+  }
+
+  add_domains_by_name (conn, names, n);
+
+  /* You must free these even though the libvirt documentation doesn't
+   * mention it.
+   */
+  for (i = 0; i < (size_t) n; ++i)
+    free (names[i]);
+
+  virConnectClose (conn);
+
+  /* No domains? */
+  if (nr_domains == 0)
+    return;
+
+  /* Sort the domains alphabetically by name for display. */
+  qsort (domains, nr_domains, sizeof (struct domain), compare_domain_names);
+
+  errors = 0;
+  for (i = 0; i < nr_domains; ++i) {
+    if (domains[i].disks == NULL)
+      continue;
+
+    count = add_disks_to_handle_reverse (domains[i].disks, &errors);
+    if (count == 0)
+      continue;
+
+    if (guestfs_launch (g) == -1)
+      exit (EXIT_FAILURE);
+
+    prefix = !uuid ? domains[i].name : domains[i].uuid;
+
+    /* Perform the scan. */
+    scan (worst_alignment_ptr, prefix);
+
+    if (i < nr_domains - 1)
+      reset_guestfs_handle ();
+  }
+
+  /* Free up domains structure. */
+  for (i = 0; i < nr_domains; ++i)
+    free_domain (&domains[i]);
+  free (domains);
+
+  if (errors > 0) {
+    fprintf (stderr, _("%s: failed to analyze a disk, see error(s) above\n"),
+             program_name);
+    exit (EXIT_FAILURE);
+  }
+}
+
+static void
+add_domains_by_id (virConnectPtr conn, int *ids, size_t n)
+{
+  size_t i;
+  virDomainPtr dom;
+
+  for (i = 0; i < n; ++i) {
+    if (ids[i] != 0) {          /* RHBZ#538041 */
+      dom = virDomainLookupByID (conn, ids[i]);
+      if (dom) { /* transient errors are possible here, ignore them */
+        add_domain (dom);
+        virDomainFree (dom);
+      }
+    }
+  }
+}
+
+static void
+add_domains_by_name (virConnectPtr conn, char **names, size_t n)
+{
+  size_t i;
+  virDomainPtr dom;
+
+  for (i = 0; i < n; ++i) {
+    dom = virDomainLookupByName (conn, names[i]);
+    if (dom) { /* transient errors are possible here, ignore them */
+      add_domain (dom);
+      virDomainFree (dom);
+    }
+  }
+}
+
+static void
+add_domain (virDomainPtr dom)
+{
+  struct domain *domain;
+
+  domains = realloc (domains, (nr_domains + 1) * sizeof (struct domain));
+  if (domains == NULL) {
+    perror ("realloc");
+    exit (EXIT_FAILURE);
+  }
+
+  domain = &domains[nr_domains];
+  nr_domains++;
+
+  domain->name = strdup (virDomainGetName (dom));
+  if (domain->name == NULL) {
+    perror ("strdup");
+    exit (EXIT_FAILURE);
+  }
+
+  char uuid[VIR_UUID_STRING_BUFLEN];
+  if (virDomainGetUUIDString (dom, uuid) == 0) {
+    domain->uuid = strdup (uuid);
+    if (domain->uuid == NULL) {
+      perror ("strdup");
+      exit (EXIT_FAILURE);
+    }
+  }
+  else
+    domain->uuid = NULL;
+
+  domain->disks = NULL;
+  int n = guestfs___for_each_disk (g, dom, add_disk, domain);
+  if (n == -1)
+    exit (EXIT_FAILURE);
+  domain->nr_disks = n;
+}
+
+static int
+add_disk (guestfs_h *g,
+          const char *filename, const char *format, int readonly,
+          void *domain_vp)
+{
+  struct domain *domain = domain_vp;
+  struct disk *disk;
+
+  disk = malloc (sizeof *disk);
+  if (disk == NULL) {
+    perror ("malloc");
+    return -1;
+  }
+
+  disk->next = domain->disks;
+  domain->disks = disk;
+
+  disk->filename = strdup (filename);
+  if (disk->filename == NULL) {
+    perror ("malloc");
+    return -1;
+  }
+  if (format) {
+    disk->format = strdup (format);
+    if (disk->format == NULL) {
+      perror ("malloc");
+      return -1;
+    }
+  }
+  else
+    disk->format = NULL;
+
+  return 0;
+}
+
+static size_t
+add_disks_to_handle_reverse (struct disk *disk, size_t *errors_r)
+{
+  size_t nr_disks_added;
+
+  if (disk == NULL)
+    return 0;
+
+  nr_disks_added = add_disks_to_handle_reverse (disk->next, errors_r);
+
+  struct guestfs_add_drive_opts_argv optargs = { .bitmask = 0 };
+
+  optargs.bitmask |= GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK;
+  optargs.readonly = 1;
+
+  if (disk->format) {
+    optargs.bitmask |= GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK;
+    optargs.format = disk->format;
+  }
+
+  if (guestfs_add_drive_opts_argv (g, disk->filename, &optargs) == -1) {
+    (*errors_r)++;
+    return nr_disks_added;
+  }
+
+  return nr_disks_added+1;
+}
+
+/* Close and reopen the libguestfs handle. */
+static void
+reset_guestfs_handle (void)
+{
+  /* Copy the settings from the old handle. */
+  int verbose = guestfs_get_verbose (g);
+  int trace = guestfs_get_trace (g);
+
+  guestfs_close (g);
+
+  g = guestfs_create ();
+  if (g == NULL) {
+    fprintf (stderr, _("guestfs_create: failed to create handle\n"));
+    exit (EXIT_FAILURE);
+  }
+
+  guestfs_set_verbose (g, verbose);
+  guestfs_set_trace (g, trace);
+}
+
+#endif

align/scan.c

@@ -0,0 +1,318 @@
+/* virt-alignment-scan
+ * Copyright (C) 2011 Red Hat Inc.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#include <config.h>
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <stdint.h>
+#include <string.h>
+#include <inttypes.h>
+#include <unistd.h>
+#include <getopt.h>
+#include <locale.h>
+#include <assert.h>
+#include <libintl.h>
+
+#ifdef HAVE_LIBVIRT
+#include <libvirt/libvirt.h>
+#include <libvirt/virterror.h>
+#endif
+
+#include "progname.h"
+#include "c-ctype.h"
+
+#include "guestfs.h"
+#include "options.h"
+#include "scan.h"
+
+/* These globals are shared with options.c. */
+guestfs_h *g;
+
+int read_only = 1;
+int live = 0;
+int verbose = 0;
+int keys_from_stdin = 0;
+int echo_keys = 0;
+const char *libvirt_uri = NULL;
+int inspector = 0;
+
+static int quiet = 0;           /* --quiet */
+
+static inline char *
+bad_cast (char const *s)
+{
+  return (char *) s;
+}
+
+static void __attribute__((noreturn))
+usage (int status)
+{
+  if (status != EXIT_SUCCESS)
+    fprintf (stderr, _("Try `%s --help' for more information.\n"),
+             program_name);
+  else {
+    fprintf (stdout,
+           _("%s: check alignment of virtual machine partitions\n"
+             "Copyright (C) 2011 Red Hat Inc.\n"
+             "Usage:\n"
+             "  %s [--options] -d domname\n"
+             "  %s [--options] -a disk.img [-a disk.img ...]\n"
+             "Options:\n"
+             "  -a|--add image       Add image\n"
+             "  -c|--connect uri     Specify libvirt URI for -d option\n"
+             "  -d|--domain guest    Add disks from libvirt guest\n"
+             "  --format[=raw|..]    Force disk format for -a option\n"
+             "  --help               Display brief help\n"
+             "  -q|--quiet           No output, just exit code\n"
+             "  -v|--verbose         Verbose messages\n"
+             "  -V|--version         Display version and exit\n"
+             "  -x                   Trace libguestfs API calls\n"
+             "For more information, see the manpage %s(1).\n"),
+             program_name, program_name, program_name,
+             program_name);
+  }
+  exit (status);
+}
+
+int
+main (int argc, char *argv[])
+{
+  /* Set global program name that is not polluted with libtool artifacts.  */
+  set_program_name (argv[0]);
+
+  setlocale (LC_ALL, "");
+  bindtextdomain (PACKAGE, LOCALEBASEDIR);
+  textdomain (PACKAGE);
+
+  enum { HELP_OPTION = CHAR_MAX + 1 };
+
+  static const char *options = "a:c:d:qvVx";
+  static const struct option long_options[] = {
+    { "add", 1, 0, 'a' },
+    { "connect", 1, 0, 'c' },
+    { "domain", 1, 0, 'd' },
+    { "format", 2, 0, 0 },
+    { "help", 0, 0, HELP_OPTION },
+    { "quiet", 0, 0, 'q' },
+    { "uuid", 0, 0, 0, },
+    { "verbose", 0, 0, 'v' },
+    { "version", 0, 0, 'V' },
+    { 0, 0, 0, 0 }
+  };
+  struct drv *drvs = NULL;
+  struct drv *drv;
+  const char *format = NULL;
+  int c;
+  int option_index;
+  int uuid = 0;
+  /* This just needs to be larger than any alignment we care about. */
+  size_t worst_alignment = UINT_MAX;
+  int exit_code;
+
+  g = guestfs_create ();
+  if (g == NULL) {
+    fprintf (stderr, _("guestfs_create: failed to create handle\n"));
+    exit (EXIT_FAILURE);
+  }
+
+  argv[0] = bad_cast (program_name);
+
+  for (;;) {
+    c = getopt_long (argc, argv, options, long_options, &option_index);
+    if (c == -1) break;
+
+    switch (c) {
+    case 0:			/* options which are long only */
+      if (STREQ (long_options[option_index].name, "format")) {
+        if (!optarg || STREQ (optarg, ""))
+          format = NULL;
+        else
+          format = optarg;
+      } else if (STREQ (long_options[option_index].name, "uuid")) {
+        uuid = 1;
+      } else {
+        fprintf (stderr, _("%s: unknown long option: %s (%d)\n"),
+                 program_name, long_options[option_index].name, option_index);
+        exit (EXIT_FAILURE);
+      }
+      break;
+
+    case 'a':
+      OPTION_a;
+      break;
+
+    case 'c':
+      OPTION_c;
+      break;
+
+    case 'd':
+      OPTION_d;
+      break;
+
+    case 'q':
+      quiet = 1;
+      break;
+
+    case 'v':
+      OPTION_v;
+      break;
+
+    case 'V':
+      OPTION_V;
+      break;
+
+    case 'x':
+      OPTION_x;
+      break;
+
+    case HELP_OPTION:
+      usage (EXIT_SUCCESS);
+
+    default:
+      usage (EXIT_FAILURE);
+    }
+  }
+
+  /* These are really constants, but they have to be variables for the
+   * options parsing code.  Assert here that they have known-good
+   * values.
+   */
+  assert (read_only == 1);
+  assert (inspector == 0);
+  assert (live == 0);
+
+  /* Must be no extra arguments on the command line. */
+  if (optind != argc)
+    usage (EXIT_FAILURE);
+
+  /* The user didn't specify any drives to scan. */
+  if (drvs == NULL) {
+#if defined(HAVE_LIBVIRT) && defined(HAVE_LIBXML2)
+    get_domains_from_libvirt (uuid, &worst_alignment);
+#else
+    fprintf (stderr, _("%s: compiled without support for libvirt and/or libxml2.\n"),
+             program_name);
+    exit (EXIT_FAILURE);
+#endif
+  } else {
+    if (uuid) {
+      fprintf (stderr, _("%s: --uuid option cannot be used with -a or -d\n"),
+               program_name);
+      exit (EXIT_FAILURE);
+    }
+
+    /* Add domains/drives from the command line (for a single guest). */
+    add_drives (drvs, 'a');
+
+    if (guestfs_launch (g) == -1)
+      exit (EXIT_FAILURE);
+
+    /* Free up data structures, no longer needed after this point. */
+    free_drives (drvs);
+
+    /* Perform the scan. */
+    scan (&worst_alignment, NULL);
+
+    guestfs_close (g);
+  }
+
+  /* Decide on an appropriate exit code. */
+  if (worst_alignment < 10) /* 2^10 = 4096 */
+    exit_code = 3;
+  else if (worst_alignment < 16) /* 2^16 = 65536 */
+    exit_code = 2;
+  else
+    exit_code = 0;
+
+  exit (exit_code);
+}
+
+void
+scan (size_t *worst_alignment, const char *prefix)
+{
+  char **devices, *p;
+  size_t i, j;
+  size_t alignment;
+  uint64_t start;
+  struct guestfs_partition_list *parts;
+
+  devices = guestfs_list_devices (g);
+  if (devices == NULL)
+    exit (EXIT_FAILURE);
+
+  for (i = 0; devices[i] != NULL; ++i) {
+    parts = guestfs_part_list (g, devices[i]);
+    if (parts == NULL)
+      exit (EXIT_FAILURE);
+
+    /* Canonicalize the name of the device for printing. */
+    p = guestfs_canonical_device_name (g, devices[i]);
+    if (p == NULL)
+      exit (EXIT_FAILURE);
+    free (devices[i]);
+    devices[i] = p;
+
+    for (j = 0; j < parts->len; ++j) {
+      /* Start offset of the partition in bytes. */
+      start = parts->val[j].part_start;
+
+      if (!quiet) {
+        if (prefix)
+          printf ("%s:", prefix);
+
+        printf ("%s%d %12" PRIu64 " ",
+                devices[i], (int) parts->val[j].part_num, start);
+      }
+
+      /* What's the alignment? */
+      if (start == 0)           /* Probably not possible, but anyway. */
+        alignment = 64;
+      else
+        for (alignment = 0; (start & 1) == 0; alignment++, start /= 2)
+          ;
+
+      if (!quiet) {
+        if (alignment < 10)
+          printf ("%12" PRIu64 "    ", UINT64_C(1) << alignment);
+        else if (alignment < 64)
+          printf ("%12" PRIu64 "K   ", UINT64_C(1) << (alignment - 10));
+        else
+          printf ("- ");
+      }
+
+      if (alignment < *worst_alignment)
+        *worst_alignment = alignment;
+
+      if (alignment < 12) {     /* Bad in general: < 4K alignment */
+        if (!quiet)
+          printf ("bad (%s)\n", _("alignment < 4K"));
+      } else if (alignment < 16) { /* Bad on NetApps: < 64K alignment */
+        if (!quiet)
+          printf ("bad (%s)\n", _("alignment < 64K"));
+      } else {
+        if (!quiet)
+          printf ("ok\n");
+      }
+    }
+
+    guestfs_free_partition_list (parts);
+    free (devices[i]);
+  }
+  free (devices);
+}

align/scan.h

@@ -0,0 +1,30 @@
+/* virt-alignment-scan
+ * Copyright (C) 2012 Red Hat Inc.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#ifndef GUESTFS_VIRT_ALIGNMENT_SCAN_H_
+#define GUESTFS_VIRT_ALIGNMENT_SCAN_H_
+
+/* domains.c */
+#if defined(HAVE_LIBVIRT) && defined(HAVE_LIBXML2)
+extern void get_domains_from_libvirt (int uuid, size_t *worst_alignment);
+#endif
+
+/* scan.c */
+extern void scan (size_t *worst_alignment, const char *prefix);
+
+#endif /* GUESTFS_VIRT_ALIGNMENT_SCAN_H_ */

align/virt-alignment-scan.pod

@@ -0,0 +1,404 @@
+=encoding utf8
+
+=head1 NAME
+
+virt-alignment-scan - Check alignment of virtual machine partitions
+
+=head1 SYNOPSIS
+
+ virt-alignment-scan [--options] -d domname
+
+ virt-alignment-scan [--options] -a disk.img [-a disk.img ...]
+
+ virt-alignment-scan [--options]
+
+=head1 DESCRIPTION
+
+When older operating systems install themselves, the partitioning
+tools place partitions at a sector misaligned with the underlying
+storage (commonly the first partition starts on sector C<63>).
+Misaligned partitions can result in an operating system issuing more
+I/O than should be necessary.
+
+The virt-alignment-scan tool checks the alignment of partitions in
+virtual machines and disk images and warns you if there are alignment
+problems.
+
+Currently there is no virt tool for fixing alignment problems.  You
+can only reinstall the guest operating system.  The following NetApp
+document summarises the problem and possible solutions:
+L<http://media.netapp.com/documents/tr-3747.pdf>
+
+=head1 OUTPUT
+
+To run this tool on a disk image directly, use the I<-a> option:
+
+ $ virt-alignment-scan -a winxp.img
+ /dev/sda1        32256          512    bad (alignment < 4K)
+
+ $ virt-alignment-scan -a fedora16.img
+ /dev/sda1      1048576         1024K   ok
+ /dev/sda2      2097152         2048K   ok
+ /dev/sda3    526385152         2048K   ok
+
+To run the tool on a guest known to libvirt, use the I<-d> option and
+possibly the I<-c> option:
+
+ # virt-alignment-scan -d RHEL5
+ /dev/sda1        32256          512    bad (alignment < 4K)
+ /dev/sda2    106928640          512    bad (alignment < 4K)
+
+ $ virt-alignment-scan -c qemu:///system -d Win7TwoDisks
+ /dev/sda1      1048576         1024K   ok
+ /dev/sda2    105906176         1024K   ok
+ /dev/sdb1        65536           64K   ok
+
+Run virt-alignment-scan without any I<-a> or I<-d> options to scan all
+libvirt domains.
+
+ # virt-alignment-scan
+ F16x64:/dev/sda1      1048576         1024K   ok
+ F16x64:/dev/sda2      2097152         2048K   ok
+ F16x64:/dev/sda3    526385152         2048K   ok
+
+The output consists of 4 or more whitespace-separated columns.  Only
+the first 4 columns are significant if you want to parse this from a
+program.  The columns are:
+
+=over 4
+
+=item col 1
+
+The device and partition name (eg. C</dev/sda1> meaning the
+first partition on the first block device).
+
+When listing all libvirt domains (no I<-a> or I<-d> option given) this
+column is prefixed by the libvirt name or UUID (if I<--uuid> is
+given).  eg: C<WinXP:/dev/sda1>
+
+=item col 2
+
+the start of the partition in bytes
+
+=item col 3
+
+the alignment in bytes or Kbytes (eg. C<512> or C<4K>)
+
+=item col 4
+
+C<ok> if the alignment is best for performance, or C<bad> if the
+alignment can cause performance problems
+
+=item cols 5+
+
+optional free-text explanation.
+
+=back
+
+The exit code from the program changes depending on whether poorly
+aligned partitions were found.  See L</EXIT STATUS> below.
+
+If you just want the exit code with no output, use the I<-q> option.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<--help>
+
+Display brief help.
+
+=item B<-a> file
+
+=item B<--add> file
+
+Add I<file> which should be a disk image from a virtual machine.
+
+The format of the disk image is auto-detected.  To override this and
+force a particular format use the I<--format=..> option.
+
+=item B<-c> URI
+
+=item B<--connect> URI
+
+If using libvirt, connect to the given I<URI>.  If omitted, then we
+connect to the default libvirt hypervisor.
+
+If you specify guest block devices directly (I<-a>), then libvirt is
+not used at all.
+
+=item B<-d> guest
+
+=item B<--domain> guest
+
+Add all the disks from the named libvirt guest.  Domain UUIDs can be
+used instead of names.
+
+=item B<--format=raw|qcow2|..>
+
+=item B<--format>
+
+The default for the I<-a> option is to auto-detect the format of the
+disk image.  Using this forces the disk format for I<-a> options which
+follow on the command line.  Using I<--format> with no argument
+switches back to auto-detection for subsequent I<-a> options.
+
+For example:
+
+ virt-alignment-scan --format=raw -a disk.img
+
+forces raw format (no auto-detection) for C<disk.img>.
+
+ virt-alignment-scan --format=raw -a disk.img --format -a another.img
+
+forces raw format (no auto-detection) for C<disk.img> and reverts to
+auto-detection for C<another.img>.
+
+If you have untrusted raw-format guest disk images, you should use
+this option to specify the disk format.  This avoids a possible
+security problem with malicious guests (CVE-2010-3851).
+
+=item B<-q>
+
+=item B<--quiet>
+
+Don't produce any output.  Just set the exit code
+(see L</EXIT STATUS> below).
+
+=item B<--uuid>
+
+Print UUIDs instead of names.  This is useful for following a guest
+even when the guest is migrated or renamed, or when two guests happen
+to have the same name.
+
+This option only applies when listing all libvirt domains (when no
+I<-a> or I<-d> options are specified).
+
+=item B<-v>
+
+=item B<--verbose>
+
+Enable verbose messages for debugging.
+
+=item B<-V>
+
+=item B<--version>
+
+Display version number and exit.
+
+=item B<-x>
+
+Enable tracing of libguestfs API calls.
+
+=back
+
+=head1 RECOMMENDED ALIGNMENT
+
+Operating systems older than Windows 2008 and Linux before ca.2010
+place the first sector of the first partition at sector 63, with a 512
+byte sector size.  This happens because of a historical accident.
+Drives have to report a cylinder / head / sector (CHS) geometry to the
+BIOS.  The geometry is completely meaningless on modern drives, but it
+happens that the geometry reported always has 63 sectors per track.
+The operating system therefore places the first partition at the start
+of the second "track", at sector 63.
+
+When the guest OS is virtualized, the host operating system and
+hypervisor may prefer accesses aligned to one of:
+
+=over 4
+
+=item * 512 bytes
+
+if the host OS uses local storage directly on hard drive partitions,
+and the hard drive has 512 byte physical sectors.
+
+=item * 4 Kbytes
+
+for local storage on new hard drives with 4Kbyte physical sectors; for
+file-backed storage on filesystems with 4Kbyte block size; or for some
+types of network-attached storage.
+
+=item * 64 Kbytes
+
+for high-end network-attached storage.  This is the optimal block size
+for some NetApp hardware.
+
+=item * 1 Mbyte
+
+see L</1 MB PARTITION ALIGNMENT> below.
+
+=back
+
+Partitions which are not aligned correctly to the underlying
+storage cause extra I/O.  For example:
+
+                       sect#63
+                       +--------------------------+------
+                       |         guest            |
+                       |    filesystem block      |
+ ---+------------------+------+-------------------+-----+---
+    |  host block             |  host block             |
+    |                         |                         |
+ ---+-------------------------+-------------------------+---
+
+In this example, each time a 4K guest block is read, two blocks on the
+host must be accessed (so twice as much I/O is done).  When a 4K guest
+block is written, two host blocks must first be read, the old and new
+data combined, and the two blocks written back (4x I/O).
+
+=head2 LINUX HOST BLOCK AND I/O SIZE
+
+New versions of the Linux kernel expose the physical and logical block
+size, and minimum and recommended I/O size.
+
+For a typical consumer hard drive with 512 byte sectors:
+
+ $ cat /sys/block/sda/queue/hw_sector_size
+ 512
+ $ cat /sys/block/sda/queue/physical_block_size
+ 512
+ $ cat /sys/block/sda/queue/logical_block_size
+ 512
+ $ cat /sys/block/sda/queue/minimum_io_size
+ 512
+ $ cat /sys/block/sda/queue/optimal_io_size
+ 0
+
+For a new consumer hard drive with 4Kbyte sectors:
+
+ $ cat /sys/block/sda/queue/hw_sector_size
+ 4096
+ $ cat /sys/block/sda/queue/physical_block_size
+ 4096
+ $ cat /sys/block/sda/queue/logical_block_size
+ 4096
+ $ cat /sys/block/sda/queue/minimum_io_size
+ 4096
+ $ cat /sys/block/sda/queue/optimal_io_size
+ 0
+
+For a NetApp LUN:
+
+ $ cat /sys/block/sdc/queue/logical_block_size
+ 512
+ $ cat /sys/block/sdc/queue/physical_block_size
+ 512
+ $ cat /sys/block/sdc/queue/minimum_io_size
+ 4096
+ $ cat /sys/block/sdc/queue/optimal_io_size
+ 65536
+
+The NetApp allows 512 byte accesses (but they will be very
+inefficient), prefers a minimum 4K I/O size, but the optimal I/O size
+is 64K.
+
+For detailed information about what these numbers mean, see
+L<http://docs.redhat.com/docs/en-US/Red_Hat_Enterprise_Linux/6/html/Storage_Administration_Guide/newstorage-iolimits.html>
+
+[Thanks to Matt Booth for providing 4K drive data.  Thanks to Mike
+Snitzer for providing NetApp data and additional information.]
+
+=head2 1 MB PARTITION ALIGNMENT
+
+Microsoft picked 1 MB as the default alignment for all partitions
+starting with Windows 2008 Server, and Linux has followed this.
+
+Assuming 512 byte sectors in the guest, you will now see the first
+partition starting at sector 2048, and subsequent partitions (if any)
+will start at a multiple of 2048 sectors.
+
+1 MB alignment is compatible with all current alignment requirements
+(4K, 64K) and provides room for future growth in physical block sizes.
+
+=head2 SETTING ALIGNMENT
+
+L<virt-resize(1)> can change the alignment of the partitions of some
+guests.  Currently it can fully align all the partitions of all
+Windows guests, and it will fix the bootloader where necessary.  For
+Linux guests, it can align the second and subsequent partitions, so
+the majority of OS accesses except at boot will be aligned.
+
+Another way to correct partition alignment problems is to reinstall
+your guest operating systems.  If you install operating systems from
+templates, ensure these have correct partition alignment too.
+
+For older versions of Windows, the following NetApp document contains
+useful information: L<http://media.netapp.com/documents/tr-3747.pdf>
+
+For Red Hat Enterprise Linux E<le> 5, use a Kickstart script that
+contains an explicit C<%pre> section that creates aligned partitions
+using L<parted(8)>.  Do not use the Kickstart C<part> command.  The
+NetApp document above contains an example.
+
+=head1 SHELL QUOTING
+
+Libvirt guest names can contain arbitrary characters, some of which
+have meaning to the shell such as C<#> and space.  You may need to
+quote or escape these characters on the command line.  See the shell
+manual page L<sh(1)> for details.
+
+=head1 EXIT STATUS
+
+This program returns:
+
+=over 4
+
+=item *
+
+0
+
+successful exit, all partitions are aligned E<ge> 64K for best performance
+
+=item *
+
+1
+
+an error scanning the disk image or guest
+
+=item *
+
+2
+
+successful exit, some partitions have alignment E<lt> 64K which can result
+in poor performance on high end network storage
+
+=item *
+
+3
+
+successful exit, some partitions have alignment E<lt> 4K which can result
+in poor performance on most hypervisors
+
+=back
+
+=head1 SEE ALSO
+
+L<guestfs(3)>,
+L<guestfish(1)>,
+L<virt-filesystems(1)>,
+L<virt-rescue(1)>,
+L<virt-resize(1)>,
+L<http://libguestfs.org/>.
+
+=head1 AUTHOR
+
+Richard W.M. Jones L<http://people.redhat.com/~rjones/>
+
+=head1 COPYRIGHT
+
+Copyright (C) 2011 Red Hat Inc.
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

appliance/Makefile.am

@@ -13,136 +13,101 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with this program; if not, write to the Free Software
-# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+# Old RHEL 5 autoconf doesn't have builddir.
+builddir ?= .
+
+include $(top_srcdir)/subdir-rules.mk
 
 EXTRA_DIST = \
-	libguestfs-supermin-helper \
-	kmod.whitelist.in \
-	packagelist.in \
+	excludelist.in \
+	guestfsd.suppressions \
 	init \
-	debian/modules/install_kernel \
-	debian/modules/y0_install-guestfsd \
-	debian/modules/z99_final-cleanups \
-	debian/debirf.conf.in
+	libguestfs-make-fixed-appliance.in \
+	libguestfs-make-fixed-appliance.pod \
+	make.sh.in \
+	packagelist.in
 
-# Build the root filesystem (appliance).
-# Currently this is arch-dependent, so it seems like putting it in
-# $(libdir) is best.  When we build cross-architecture filesystems we
-# should probably move them to $(datadir).
 fsdir = $(libdir)/guestfs
-fs_DATA = $(APPLIANCE_FILES)
+superminfsdir = $(libdir)/guestfs/supermin.d
 
-# These are the resulting output files from the whole process:
-#   VMLINUZ        kernel for the full appliance
-#   INITRAMFSIMG   initramfs (ie. root fs) for the full appliance
-# For details of the supermin appliance, read the README file:
-#   SUPERMINIMG    initramfs (ie. partial root fs) for the supermin appliance
-#   SUPERMINFILES  list of missing files (the ones we will pull out of the
-#                    host filesystem at runtime) in the supermin appliance
-APPLIANCE_FILES = $(INITRAMFSIMG) $(VMLINUZ)
-if SUPERMIN
-APPLIANCE_FILES += $(SUPERMINIMG) $(SUPERMINFILES) kmod.whitelist
-bin_SCRIPTS = libguestfs-supermin-helper
+fs_DATA =
+superminfs_DATA = \
+	supermin.d/base.img \
+	supermin.d/daemon.img \
+	supermin.d/init.img \
+	supermin.d/hostfiles
+
+# This used to be a configure-generated file (as is update.sh still).
+# However config.status always touches the destination file, which
+# means the appliance got rebuilt too often.
+make.sh: make.sh.in
+	cd $(top_builddir) && \
+	  ./config.status --file=appliance/$@-t:appliance/$<
+	chmod +x $@-t
+	mv $@-t $@
+
+PACKAGELIST_CPP_FLAGS = -D$(DISTRO)=1
+if VALGRIND_DAEMON
+PACKAGELIST_CPP_FLAGS += -DVALGRIND_DAEMON=1
 endif
 
-# Don't change these names - they must be the same as in '*.sh' scripts.
-INITRAMFSIMG = initramfs.$(REPO).$(host_cpu).img
-VMLINUZ = vmlinuz.$(REPO).$(host_cpu)
-if SUPERMIN
-SUPERMINIMG = initramfs.$(REPO).$(host_cpu).supermin.img
-SUPERMINFILES = initramfs.$(REPO).$(host_cpu).supermin.hostfiles
-endif
-
-# This is for building the normal appliance:
-$(INITRAMFSIMG) $(VMLINUZ): $(top_builddir)/initramfs/fakeroot.log
-
-$(top_builddir)/initramfs/fakeroot.log: make.sh kmod.whitelist packagelist
-	mv $(INITRAMFSIMG) $(INITRAMFSIMG).bak 2>/dev/null; :
-	mv $(VMLINUZ) $(VMLINUZ).bak 2>/dev/null; :
-	if ! bash make.sh; then rm -f $@; exit 1; fi
-
-$(INITRAMFSIMG): $(top_builddir)/initramfs/fakeroot.log $(top_builddir)/daemon/guestfsd init update.sh
-	rm -f $@
-	bash update.sh
-	touch $@
-
-kmod.whitelist: kmod.whitelist.in
-	grep -v '^[[:space:]]*$$' < $< | grep -v '^#' > $@
-
 packagelist: packagelist.in
-	cpp -undef -D$(DIST)=1 < $< | \
-	grep -v '^[[:space:]]*$$' | grep -v '^#' > $@
+	cpp -undef $(PACKAGELIST_CPP_FLAGS) < $< | \
+	grep -v '^[[:space:]]*$$' | grep -v '^#' > $@-t
+	mv $@-t $@
 
-# This is for building the supermin appliance.  It has to be enabled
-# specifically with './configure --enable-supermin'.  You really need
-# to read the README file.
+excludelist: excludelist.in
+	cpp -undef $(PACKAGELIST_CPP_FLAGS) < $< | \
+	grep -v '^[[:space:]]*$$' | grep -v '^#' > $@-t
+	mv $@-t $@
 
-if SUPERMIN
-
-# First we need to decide which files go in and out of the supermin
-# appliance.  This decision is made by 'supermin-split.sh'.
-$(SUPERMINFILES): supermin.incfiles
-supermin.incfiles: $(top_builddir)/initramfs/fakeroot.log $(top_builddir)/daemon/guestfsd supermin-split.sh
-	rm -f supermin.incfiles $(SUPERMINFILES)
-	bash supermin-split.sh
-
-# Second we need to create a supermin appliance with just the included
-# files (leaving out the host files, which we'll add back at runtime).
-$(SUPERMINIMG): supermin.incfiles supermin-make.sh
-	rm -f $@
-	bash supermin-make.sh
-
-endif
-
-# Extra symlinks needed by the Debian appliance.
-debirf_symlinks = \
-	a0_prep-root \
-	z0_remove-aptitude \
-	z0_remove-locales \
-	z1_clean-root
-noinst_DATA = $(debirf_symlinks:%=debian/modules/%)
-$(debirf_symlinks:%=debian/modules/%): stamp-debirf-modules
-stamp-debirf-modules:
-	mkdir -p debian/modules
-	for f in $(debirf_symlinks); do \
-	  ln -sf /usr/share/debirf/modules/$$f debian/modules/$$f; \
-	done
+supermin.d/base.img supermin.d/hostfiles: stamp-supermin
+stamp-supermin: make.sh packagelist excludelist
+	mkdir -p supermin.d
+	rm -f $@ supermin.d/base.img supermin.d/hostfiles
+	./make.sh
 	touch $@
 
-#----------------------------------------------------------------------
-# Extra rules for testing the appliance.
+supermin.d/daemon.img: ../daemon/guestfsd guestfsd.suppressions
+	mkdir -p supermin.d
+	rm -f $@ $@-t
+	rm -rf tmp
+	mkdir -p tmp$(DAEMON_SUPERMIN_DIR) tmp/etc
+	ln ../daemon/guestfsd tmp$(DAEMON_SUPERMIN_DIR)/guestfsd
+	ln $(srcdir)/guestfsd.suppressions tmp/etc/guestfsd.suppressions
+	( cd tmp && find | cpio --quiet -o -H newc ) > $@-t
+	rm -rf tmp
+	mv $@-t $@
 
-# Test-boot the appliance.
+supermin.d/init.img: init
+	cmp -s $(srcdir)/init $(builddir)/init || cp $(srcdir)/init $(builddir)/init
+	mkdir -p supermin.d
+	rm -f $@ $@-t
+	echo "init" | cpio --quiet -o -H newc > $@-t
+	mv $@-t $@
 
-test-boot: emptydisk
-	qemu-system-$(host_cpu) \
-	  -m 384 \
-	  -kernel $(VMLINUZ) -initrd $(INITRAMFSIMG) \
-	  -hda emptydisk
+# libguestfs-make-fixed-appliance script and man page.
 
-emptydisk:
-	rm -f emptydisk
-	dd if=/dev/zero of=emptydisk bs=1024 count=1440
-	echo 0, | sfdisk -q -C 80 -H 2 -S 18 emptydisk > /dev/null
+sbin_SCRIPTS = libguestfs-make-fixed-appliance
 
-# This is a more realistic test boot command line which better
-# reflects what the library does.
+man_MANS = libguestfs-make-fixed-appliance.1
 
-test-boot-realistic: emptydisk
-	qemu-system-$(host_cpu) \
-	  -m 384 \
-	  -kernel $(VMLINUZ) -initrd $(INITRAMFSIMG) \
-	  -hda emptydisk \
-	  -append "console=ttyS0 guestfs=10.0.2.4:6666 guestfs_rescue=1" \
-	  -nographic \
-	  -serial stdio \
-	  -net channel,6666:unix:/tmp/sock,server,nowait \
-	  -net user,vlan=0 \
-	  -net nic,model=virtio,vlan=0
+libguestfs-make-fixed-appliance.1 $(top_builddir)/html/libguestfs-make-fixed-appliance.1.html: stamp-libguestfs-make-fixed-appliance.pod
+
+stamp-libguestfs-make-fixed-appliance.pod: libguestfs-make-fixed-appliance.pod
+	$(top_builddir)/podwrapper.sh \
+	  --man libguestfs-make-fixed-appliance.1 \
+	  --html $(top_builddir)/html/libguestfs-make-fixed-appliance.1.html \
+	  $<
+	touch $@
 
 # Make clean.
 
-CLEANFILES = $(APPLIANCE_FILES) packagelist kmod.whitelist supermin.incfiles
+CLEANFILES = packagelist excludelist \
+	libguestfs-make-fixed-appliance.1 \
+	stamp-libguestfs-make-fixed-appliance.pod
 
 clean-local:
-	rm -rf $(top_builddir)/initramfs
+	rm -rf supermin.d

appliance/debian/debirf.conf.in

@@ -1,5 +0,0 @@
-DEBIRF_LABEL="debirf-libguestfs"
-DEBIRF_SUITE=@REPO@
-DEBIRF_MIRROR=@MIRROR@/${DEBIRF_DISTRO}
-DEBIRF_KERNEL_ARCH=@DEBIAN_KERNEL_ARCH@
-DEBIRF_METHOD=stupid_simple

appliance/debian/modules/a0_prep-root

@@ -1 +0,0 @@
-/usr/share/debirf/modules/a0_prep-root

appliance/debian/modules/install_kernel

@@ -1,68 +0,0 @@
-#!/bin/bash -e
-
-# debirf module: install-kernel
-# install a kernel package, indicated by the expected environment
-# variables:
-#  DEBIRF_PATH
-#  DEBIRF_ROOT
-#  DEBIRF_KERNEL_PACKAGE
-#
-# *** REQUIRED MODULE ***
-# WARNING: this module is necessary for proper functioning of debirf.
-#
-# The debirf scripts were written by
-# Jameson Rollins <jrollins@fifthhorseman.net>
-# and
-# Daniel Kahn Gillmor <dkg-debian.org@fifthhorseman.net>.
-#
-# They are Copyright 2007, and are all released under the GPL,
-# version 3 or later.
-
-# clear out old modules if they exist, to avoid confusion
-rm -rf "$DEBIRF_ROOT/lib/modules"
-
-# download/copy in kernel package
-if [ -z "$DEBIRF_KERNEL_PACKAGE" ] ; then
-    # determine kernel to install. assume arch of build host.
-
-    # determine kernel arch.  need everything after the kernel version
-    # and debian version
-    if [ -z "$DEBIRF_KERNEL_ARCH" ]; then
-	KARCH=$(uname -r | cut -d- -f3-)
-    else
-	KARCH="$DEBIRF_KERNEL_ARCH"
-    fi
-
-    # determine the full kernel version from the dependency of the
-    # generic 2.6-ARCH package in the debirf root (since it may be
-    # different than what is installed on the build host)
-    KNAME=$(debirf_exec apt-cache show linux-image-2.6-"$KARCH" | grep '^Depends: ' | sed 's/^Depends: //')
-
-    # download only the desired kernel package directly into the apt
-    # cache for dpkg extraction
-    debirf_exec sh -c "cd /var/cache/apt/archives/ && aptitude download \"$KNAME\""
-else
-    # install kernel deb if given at command line
-    debirf_exec sh -c "cd /var/cache/apt/archives/ && aptitude download \"$DEBIRF_KERNEL_PACKAGE\""
-fi
-
-KPKG=$(basename "$DEBIRF_ROOT"/var/cache/apt/archives/linux-image-2.6.*)
-
-echo "extracting kernel package $KPKG..."
-debirf_exec dpkg --extract /var/cache/apt/archives/"$KPKG" /
-
-# install the module init tools, since they are needed for depmod
-debirf_exec apt-get --assume-yes install module-init-tools
-
-# depmod to create module list
-KVERS=$(ls -1 -t "$DEBIRF_ROOT/lib/modules" | head -n1)
-echo "generating modules.dep..."
-debirf_exec depmod -a "$KVERS"
-
-# extract kernel and debian stock initrd from the build root:
-mv "$DEBIRF_ROOT"/boot/vmlinu* "$DEBIRF_BUILDD"
-
-# remove kernel symlinks
-if [ -L "$DEBIRF_ROOT"/vmlinuz ] ; then
-    rm "$DEBIRF_BUILDD"/vmlinuz
-fi

appliance/debian/modules/y0_install-guestfsd

@@ -1,32 +0,0 @@
-#!/bin/bash -e
-# install guestfsd specific stuff
-
-# Kernel modules take up nearly half of the image.  Only include ones
-# which are on the whitelist.
-exec 5<../appliance/kmod.whitelist
-whitelist=
-while read kmod 0<&5; do
-    whitelist="$whitelist -a -not -name $kmod"
-done
-exec 5<&-
-
-echo "Module whitelist: $whitelist"
-find $DEBIRF_ROOT/lib/modules/*/kernel -name '*.ko' $whitelist -a -exec rm '{}' \;
-
-# install additional packages:
-PKGLIST=$(< packagelist)
-echo "Will add $PKGLIST"
-debirf_exec aptitude -R -y install $PKGLIST
-debirf_exec aptitude -y remove vim-tiny dhcp3-client iptables
-
-debirf_exec mkdir -p --mode=0777 /sysroot
-
-# cleanup some other heavy lifters:
-rm -rf "$DEBIRF_ROOT"/usr/share/doc/
-rm -rf "$DEBIRF_ROOT"/usr/share/zoneinfo/
-rm -rf "$DEBIRF_ROOT"/usr/share/man/
-
-# Install the actual appliance:
-echo $PWD
-install -o root -g root -m 0755 ../daemon/guestfsd "$DEBIRF_ROOT"/sbin/guestfsd
-install -o root -g root -m 0755 init "$DEBIRF_ROOT"/sbin/init

appliance/debian/modules/z0_remove-aptitude

@@ -1 +0,0 @@
-/usr/share/debirf/modules/z0_remove-aptitude

appliance/debian/modules/z0_remove-locales

@@ -1 +0,0 @@
-/usr/share/debirf/modules/z0_remove-locales

appliance/debian/modules/z1_clean-root

@@ -1 +0,0 @@
-/usr/share/debirf/modules/z1_clean-root

appliance/debian/modules/z99_final-cleanups

@@ -1,3 +0,0 @@
-#!/bin/sh
-
-rm -rf "$DEBIRF_ROOT"/var/lib/dpkg/info

appliance/excludelist.in

@@ -0,0 +1,52 @@
+/* This is the list of distro packages which are
+ * excluded from the appliance, even if they appear in
+ * packagelist.in (or more likely, as dependencies of
+ * packages in packagelist.in).
+ *
+ * List is a list of basic regular expressions, one per line.
+ *
+ * This file is processed by cpp with one of the
+ * following symbols defined (depending on the distro):
+ *
+ *   REDHAT=1     For Fedora, RHEL, EPEL and workalikes.
+ *   DEBIAN=1     For Debian.
+ *   UBUNTU=1     For Ubuntu.
+ *   ARCHLINUX=1  For Archlinux.
+ *
+ * Note that any file provided by one of these packages will
+ * be dropped from the appliance.  Of course, this may break
+ * the appliance, so be careful.  Other files are also dropped
+ * from the appliance such as docs and man pages: see 'make.sh.in'
+ * for the full details.
+ */
+
+/* Basically the same with a few minor tweaks. */
+#ifdef UBUNTU
+#define DEBIAN 1
+#endif
+
+/* Don't need any Perl or Python appearing in the appliance. */
+^perl
+^python
+
+/* Plymouth is a graphical boot thing - not needed. */
+^plymouth
+
+/* Linux firmware.  Note that febootstrap itself excludes the kernel
+ * which is also not needed since we get the kernel, modules etc
+ * from the host at appliance boot.
+ */
+^linux-firmware
+
+/* Keyboard maps - appliance is not interactive. */
+^kbd-misc
+
+#ifdef REDHAT
+^fedora-logos
+^redhat-logos
+^dracut
+#endif
+
+#ifdef DEBIAN
+^file-rc
+#endif

appliance/guestfsd.suppressions

@@ -0,0 +1,19 @@
+# This file is only used when libguestfs is configured with
+#
+#   ./configure --enable-valgrind-daemon
+#
+# (only used for development, and only used in the regular supermin
+# appliance, not libguestfs live).
+#
+# If there are any valgrind errors in the base libraries such as
+# glibc, then we can suppress them here, so we only see errors in
+# libguestfs daemon code.
+
+# libdl
+{
+  libdl_index_cond
+  Memcheck:Cond
+  fun:index
+  fun:expand_dynamic_string_token
+  fun:_dl_map_object
+}

appliance/init

@@ -2,66 +2,155 @@
 
 echo Starting /init script ...
 
-PATH=/sbin:/usr/sbin:$PATH
+PATH=/sbin:/usr/sbin:/bin:/usr/bin
+export PATH
 
+# Debian bug 606622.
+RUNLEVEL=S
+PREVLEVEL=N
+export RUNLEVEL PREVLEVEL
+
+mkdir -p /sysroot
+
+if [ ! -d /proc ]; then rm -f /proc; fi
+mkdir -p /proc
 mount -t proc /proc /proc
+if [ ! -d /sys ]; then rm -f /sys; fi
+mkdir -p /sys
 mount -t sysfs /sys /sys
+mkdir -p /run/lock
 
-if [ -x /etc/init.d/udev ]; then
-  /etc/init.d/udev start
-elif [ -x /sbin/start_udev ]; then
-  /sbin/start_udev
+# devtmpfs is required since udev 176
+mount -t devtmpfs /dev /dev
+
+if [ ! -L /etc/init.d/udev -a -x /etc/init.d/udev ]; then
+  if type service >/dev/null 2>&1; then
+     service udev start
+  else
+     /etc/init.d/udev start
+  fi
+elif [ -x /sbin/start_udev ] && /sbin/start_udev; then
+  :
 else
-  echo No udev, creating /dev manually
-  mount -t tmpfs none /dev
-  mkdir /dev/pts /dev/shm /dev/mapper
-  mount -t devpts -o gid=5,mode=620 /dev/pts /dev/pts
-  # Must do each MAKEDEV individually, because if one device fails,
-  # MAKEDEV will quit without creating the rest (RHBZ#507374).
-  for dev in mem null port zero core full ram tty console fd \
-    hda hdb hdc hdd sda sdb sdc sdd loop sd; do
-    MAKEDEV $dev ||:
+  # Find udevd and run it directly.
+  for f in /sbin/udevd /lib/udev/udevd /lib/systemd/systemd-udevd; do
+    if [ -x "$f" ]; then UDEVD="$f"; fi
   done
-  mknod /dev/ptmx c 5 2;    chmod 0666 /dev/ptmx
-  mknod /dev/random c 1 8;  chmod 0666 /dev/random
-  mknod /dev/urandom c 1 9; chmod 0444 /dev/urandom
-  ln -sf /proc/self/fd/0 /dev/stdin
-  ln -sf /proc/self/fd/1 /dev/stdout
-  ln -sf /proc/self/fd/2 /dev/stderr
+  if [ -n "$UDEVD" ]; then
+    echo -e '\000\000\000\000' > /proc/sys/kernel/hotplug
+    $UDEVD --daemon
+    udevadm trigger
+    udevadm settle --timeout=600
+  else
+    echo No udevd, creating /dev manually.
+    mount -t tmpfs none /dev
+    mkdir /dev/pts /dev/shm /dev/mapper
+    mount -t devpts -o gid=5,mode=620 /dev/pts /dev/pts
+    # Must do each MAKEDEV individually, because if one device fails,
+    # MAKEDEV will quit without creating the rest (RHBZ#507374).
+    for dev in mem null port zero core full ram tty console fd \
+      hda hdb hdc hdd sda sdb sdc sdd loop sd; do
+      MAKEDEV $dev ||:
+    done
+    mknod /dev/ptmx c 5 2;    chmod 0666 /dev/ptmx
+    mknod /dev/random c 1 8;  chmod 0666 /dev/random
+    mknod /dev/urandom c 1 9; chmod 0444 /dev/urandom
+    ln -sf /proc/self/fd/0 /dev/stdin
+    ln -sf /proc/self/fd/1 /dev/stdout
+    ln -sf /proc/self/fd/2 /dev/stderr
 
-  modprobe virtio_pci
-  modprobe virtio_net
+    modprobe virtio_pci
+    modprobe virtio_net
+  fi
 fi
 
 if grep -sq selinux=1 /proc/cmdline; then
   mount -t selinuxfs none /selinux
 fi
 
-modprobe dm_mod ||:
+# Update the system clock.
+hwclock -u -s
 
-ifconfig lo 127.0.0.1
-ifconfig eth0 10.0.2.10
-route add default gw 10.0.2.2
+# Set up the network.
+ip addr add 127.0.0.1/8 brd + dev lo scope host
+ip link set dev lo up
+
+ip addr add 169.254.2.10/16 brd + dev eth0 scope global
+ip link set dev eth0 up
+
+ip route add default via 169.254.2.2
+
+# Scan for MDs.
+mdadm -As --auto=yes --run
+
+# Scan for LVM.
+modprobe dm_mod ||:
 
 lvm vgscan --ignorelockingfailure
 lvm vgchange -ay --ignorelockingfailure
 
-# Keep these to enhance the usefulness of debug output.
-ls -l /dev
-cat /proc/mounts
-lvm pvs
-lvm vgs
-lvm lvs
-ifconfig
-netstat -rn
-lsmod
-#ping -n -v -c 5 10.0.2.2
-#ping -n -v -c 5 10.0.2.4
-
 # Improve virtio-blk performance (RHBZ#509383).
 for f in /sys/block/vd*/queue/rotational; do echo 1 > $f; done
 
-if grep -sq guestfs_rescue=1 /proc/cmdline; then
-  bash -i
+# http://kbase.redhat.com/faq/docs/DOC-5428
+# Disabled this until https://bugzilla.redhat.com/show_bug.cgi?id=630583
+# is fixed (broken in Linux 2.6.36).
+#for f in /sys/block/[hsv]d*/queue/scheduler; do echo noop > $f; done
+
+# These are useful when debugging.
+if grep -sq guestfs_verbose=1 /proc/cmdline; then
+    ls -lR /dev
+    cat /proc/mounts
+    lvm pvs
+    lvm vgs
+    lvm lvs
+    ip a
+    ip r
+    lsmod
+    #hwclock -r
+    date
+    #ping -n -v -c 5 10.0.2.2
+    #ping -n -v -c 5 10.0.2.4
+
+    echo -n "uptime: "; cat /proc/uptime
 fi
-exec guestfsd -f
+
+if ! grep -sq guestfs_rescue=1 /proc/cmdline; then
+  # Run the daemon under valgrind if ./configure --enable-valgrind-daemon
+  vg_channel=/dev/virtio-ports/org.libguestfs.valgrind
+  if [ -w $vg_channel ]; then
+    if [ -r /etc/guestfsd.suppressions ]; then
+      suppressions="--suppressions=/etc/guestfsd.suppressions"
+    fi
+    exec 3>$vg_channel
+    vg="valgrind --leak-check=full --log-fd=3 --error-exitcode=119 --max-stackframe=8388608 --child-silent-after-fork=yes $suppressions"
+    echo "enabling valgrind: $vg"
+  fi
+
+  # The host will kill qemu abruptly if guestfsd shuts down normally
+  $vg guestfsd
+
+  # Otherwise we try to clean up gracefully. For example, this ensures that a
+  # core dump generated by the guest daemon will be written to disk.
+else
+  # Use appliance in rescue mode, also used by the virt-rescue command.
+  eval $(grep -Eo 'TERM=[^[:space:]]+' /proc/cmdline)
+  PS1='><rescue> '
+  export TERM PS1
+  echo
+  echo "------------------------------------------------------------"
+  echo
+  echo "Welcome to virt-rescue, the libguestfs rescue shell."
+  echo
+  echo "Note: The contents of / are the rescue appliance."
+  echo "You have to mount the guest's partitions under /sysroot"
+  echo "before you can examine them."
+  echo
+  bash -i
+  echo
+  echo "virt-rescue: Syncing the disk now before exiting ..."
+  echo
+fi
+
+sync
+reboot -f

appliance/kmod.whitelist.in

@@ -1,56 +0,0 @@
-# List of kernel modules that we leave in the appliance.  This has to
-# include any dependencies needed by modules.
-
-# Any kernel module not listed here is deleted from the appliance.
-
-# Wildcards are permitted.
-
-virtio*.ko
-
-# We normally use virtio_net, but keep these in reserve.
-8390.ko
-ne2k-pci.ko
-
-# drivers for QEMUs IDE/SCSI device emulation
-cdrom.ko
-i2c-piix4.ko
-i2c-core.ko
-ide-*.ko
-libata.ko
-piix.ko
-scsi_transport_spi.ko
-scsi_mod.ko
-sd_mod.ko
-sym53c8xx.ko
-
-ext2.ko
-ext3.ko
-ext4*.ko
-
-crc16.ko
-jbd.ko
-jbd2.ko
-mbcache.ko
-
-fuse.ko
-
-vfat.ko
-fat.ko
-
-udf.ko
-crc_itu_t.ko
-nls_utf8.ko
-nls_cp437.ko
-nls_base.ko
-
-dm-*.ko
-
-cramfs.ko
-squashfs.ko
-
-hfsplus.ko
-ufs.ko
-exportfs.ko
-xfs.ko
-
-reiserfs.ko

appliance/libguestfs-make-fixed-appliance.in

@@ -0,0 +1,163 @@
+#!/bin/bash -
+# @configure_input@
+# libguestfs-make-fixed-appliance tool
+# Copyright (C) 2012 Red Hat Inc.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+unset CDPATH
+
+program="libguestfs-make-fixed-appliance"
+version="@PACKAGE_VERSION@"
+
+TEMP=`getopt \
+        -o V \
+        --long help,version,xz \
+        -n $program -- "$@"`
+if [ $? != 0 ]; then
+    echo "$program: problem parsing the command line arguments"
+    exit 1
+fi
+eval set -- "$TEMP"
+
+usage ()
+{
+    echo "Usage:"
+    echo "  $program [--options] OUTPUTDIR"
+    echo "  $program [--options] --xz"
+    echo
+    echo "Read $program(1) man page for more information."
+    exit $1
+}
+
+while true; do
+    case "$1" in
+        -V|--version)
+            echo "$program $version"
+            exit 0;;
+        --xz)
+            xz_mode=1
+            shift;;
+        --help)
+            usage 0;;
+        --)
+            shift
+            break;;
+        *)
+            echo "internal error ($1)"
+            exit 1;;
+    esac
+done
+
+# Either xz_mode or we expect one extra parameter (output directory).
+if [ -n "$xz_mode" ]; then
+    if [ $# -gt 0 ]; then
+        echo "error: $program: extra parameters on the command line"
+        echo
+        usage 1
+    fi
+else
+    if [ $# -ne 1 ]; then
+        echo "error: $program: missing output directory"
+        echo
+        usage 1
+    fi
+    outputdir="$1"
+fi
+
+# end of command line parsing
+#----------------------------------------------------------------------
+
+set -e
+
+# The two ways to build the appliance are roughly the same, except for
+# --xz we build into a temporary directory and tar it up at the end.
+
+if [ -n "$xz_mode" ]; then
+    tmpdir="$(mktemp -d)"
+    outputdir="$tmpdir/appliance"
+
+    cleanup ()
+    {
+        rm -rf $tmpdir ||:
+    }
+    trap cleanup EXIT ERR
+fi
+
+# Create the output directory.
+mkdir -p "$outputdir"
+
+# Build the supermin appliance, if not already.
+guestfish -a /dev/null run
+
+# Find the location of the appliance.
+if [ -n "$TMPDIR" ]; then
+    appliancedir="$TMPDIR/.guestfs-$(id -u)"
+else
+    appliancedir="/var/tmp/.guestfs-$(id -u)"
+fi
+
+cp "$appliancedir/kernel" "$outputdir/kernel"
+cp "$appliancedir/initrd" "$outputdir/initrd"
+cp --sparse=always "$appliancedir/root" "$outputdir/root"
+
+cat <<EOF >"$outputdir/README.fixed"
+This is the "fixed appliance", a pre-built binary appliance for
+libguestfs.  This was built using $program.
+
+Unpack the appliance directory:
+
+  tar -Jxvf appliance-<VERSION>.tar.xz
+
+Then copy all four files:
+
+ * kernel
+ * initrd
+ * root
+ * README.fixed
+
+into a directory somewhere, eg. /usr/local/lib/guestfs/appliance/
+
+Then build libguestfs (>= 1.16.7 or >= 1.17.10) from source, disabling
+the normal appliance and daemon:
+
+  ./configure --disable-appliance --disable-daemon
+  make
+  sudo make install
+
+Set LIBGUESTFS_PATH to the path where you unpacked these files, eg:
+
+  export LIBGUESTFS_PATH=/usr/local/lib/guestfs/appliance/
+
+and run the libguestfs programs and virt tools in the normal way.
+
+
+LICENSE
+-------
+
+This appliance contains software under a variety of open source
+licenses.  The software is from Fedora (https://fedoraproject.org/),
+and to rebuild it you need to download Fedora 17+ and
+libguestfs >= 1.17.10, and build libguestfs from source in the usual
+way.
+
+EOF
+
+# If --xz, compress the result.  Note -S option to preserve sparseness.
+if [ -n "$xz_mode" ]; then
+    tar -C "$tmpdir" -S -cf - appliance | xz --best > "appliance-$version.tar.xz"
+    rm -rf "$tmpdir" ||:
+    trap - EXIT ERR
+fi

appliance/libguestfs-make-fixed-appliance.pod

@@ -0,0 +1,174 @@
+=encoding utf8
+
+=head1 NAME
+
+libguestfs-make-fixed-appliance - Make a "fixed appliance" for libguestfs
+
+=head1 SYNOPSIS
+
+ libguestfs-make-fixed-appliance [--options] OUTPUTDIR
+
+ libguestfs-make-fixed-appliance [--options] --xz
+
+=head1 DESCRIPTION
+
+libguestfs-make-fixed-appliance lets you make a pre-built binary
+appliance for libguestfs.
+
+B<Note that ordinary users should not need to run this tool>.  The
+only reason to use it is if you want to make a self-contained
+libguestfs appliance that can be copied to another machine or platform
+that doesn't support L<febootstrap(8)>.  To understand why you might
+need to use this tool, read the section L</FIXED APPLIANCE> below.
+
+Instead of running this tool, you can download fixed appliances from
+L<http://libguestfs.org/download/binaries/appliance/>.  These
+appliances were made using this tool.
+
+There are two ways to use this tool.
+
+=over 4
+
+=item *
+
+Specify an output directory, for example:
+
+ libguestfs-make-fixed-appliance /usr/local/lib/guestfs/appliance
+
+The output directory is created if it does not exist.  Four files are
+created in this directory:
+
+ <OUTPUTDIR>/kernel
+ <OUTPUTDIR>/initrd
+ <OUTPUTDIR>/root
+ <OUTPUTDIR>/README.fixed
+
+Note that C<I<OUTPUTDIR>/root> is a sparse file, so take care when
+copying it.
+
+You can then run libguestfs (possibly after copying this directory to
+another machine) by setting the environment variable LIBGUESTFS_PATH
+to C<OUTPUTDIR>.
+
+=item *
+
+The alternative method is to use the I<--xz> option to create a
+compressed tarball:
+
+ libguestfs-make-fixed-appliance --xz
+
+This creates a tarball in the I<current> directory called:
+
+ appliance-<VERSION>.tar.xz
+
+(where C<VERSION> is the version of libguestfs).  The tarball contains
+the four files:
+
+ appliance/kernel
+ appliance/initrd
+ appliance/root
+ appliance/README.fixed
+
+Note that C<appliance/root> is a sparse file, so take care when
+copying it.
+
+=back
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<--help>
+
+Display short usage information and exit.
+
+=item B<-V>
+
+=item B<--version>
+
+Display the version number and exit.
+
+=item B<--xz>
+
+Instead of creating the appliance in an output directory, create a
+compressed tarball of the appliance in the current directory called
+C<appliance-I<VERSION>.tar.xz> where C<VERSION> is the version of
+libguestfs.
+
+Using I<--xz> can take some time.  If working normally, the tool is
+completely silent when it is running.
+
+=back
+
+=head1 FIXED APPLIANCE
+
+When libguestfs (or libguestfs tools) are run, they search a path
+looking for an appliance.  The path is built into libguestfs, or can
+be set using the C<LIBGUESTFS_PATH> environment variable.
+
+Normally a supermin appliance is located on this path (see
+L<febootstrap(8)/SUPERMIN APPLIANCE>).  libguestfs reconstructs this
+into a full appliance by running L<febootstrap-supermin-helper(8)>.
+
+However, a simpler "fixed appliance" can also be used.  libguestfs
+detects this by looking for a directory on the path containing four
+files called C<kernel>, C<initrd>, C<root> and C<README.fixed> (note
+the C<README.fixed> file must be present as well).
+
+If the fixed appliance is found, libguestfs skips febootstrap entirely
+and just runs qemu with the kernel, initrd and root disk from the
+fixed appliance.
+
+Thus the fixed appliance can be used when a platform or Linux distro
+does not support febootstrap.  You build the fixed appliance on a
+platform that does support febootstrap, and copy it over, and use that
+to run libguestfs.
+
+=head1 LICENSING
+
+The fixed appliance is a complete Linux binary distro.  If you
+distribute it, you may need to distribute corresponding source files
+to remain in legal compliance with the licenses of the software in the
+appliance (such as the GNU General Public License).
+
+=head1 EXIT STATUS
+
+libguestfs-make-fixed-appliance returns I<0> if the appliance was
+built without errors.
+
+=head1 ENVIRONMENT VARIABLES
+
+For the full list of environment variables which may affect
+libguestfs, please see the L<guestfs(3)> manual page.
+
+=head1 SEE ALSO
+
+L<guestfs(3)>,
+L<febootstrap(8)>,
+L<febootstrap-supermin-helper(8)>,
+L<xz(1)>,
+L<http://libguestfs.org/>,
+L<http://qemu.org/>.
+
+=head1 AUTHORS
+
+Richard W.M. Jones (C<rjones at redhat dot com>)
+
+=head1 COPYRIGHT
+
+Copyright (C) 2009-2012 Red Hat Inc.
+L<http://libguestfs.org/>
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

appliance/libguestfs-supermin-helper.in

@@ -1,86 +0,0 @@
-#!/bin/bash -
-# @configure_input@
-# Copyright (C) 2009 Red Hat Inc.
-#
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-
-# Helper script which constructs the supermin appliance at runtime.
-
-unset CDPATH
-
-set -e
-
-# Source directory containing the supermin input files.
-sourcedir=$(cd "$1" > /dev/null; pwd)
-
-# Output files.
-kernel="$2"
-initrd="$3"
-
-# Kernel:
-# Look for the most recent kernel named vmlinuz-*.<arch>* which has a
-# corresponding directory in /lib/modules/. If the architecture is x86, look
-# for any x86 kernel.
-#
-# RHEL 5 didn't append the arch to the kernel name, so look for kernels
-# without arch second.
-
-arch=$(echo "@host_cpu@" | sed 's/^i.86$/i?86/')
-kernels=$(ls -1vr /boot/vmlinuz-*.$arch* 2>/dev/null | grep -v xen; ls -1vr /boot/vmlinuz-* 2>/dev/null | grep -v xen)
-for f in $kernels; do
-    b=$(basename "$f")
-    b=$(echo "$b" | sed 's,vmlinuz-,,')
-    modpath="/lib/modules/$b"
-    if [ -d "$modpath" ]; then
-        ln -sf "$f" "$kernel"
-        break
-    fi
-    modpath=
-done
-
-if [ -z "$modpath" ]; then
-    echo "$0: failed to find a suitable kernel" >&2
-    exit 1
-fi
-
-# The initrd consists of these components:
-# (1) The base skeleton appliance that we constructed at build time.
-#     name = initramfs.@REPO@.@host_cpu@.supermin.img
-#     format = compressed cpio
-# (2) The modules from modpath which are on the module whitelist.
-#     format = plain cpio
-# (3) The host files which match wildcards in *.supermin.hostfiles.
-#     format = plain cpio
-
-cp "$sourcedir"/initramfs.@REPO@.@host_cpu@.supermin.img "$initrd"
-
-# Kernel modules (2).
-exec 5<"$sourcedir"/kmod.whitelist
-whitelist=
-while read kmod 0<&5; do
-    whitelist="$whitelist -o -name $kmod"
-done
-exec 5<&-
-
-find "$modpath" \( -not -name '*.ko' $whitelist \) -a -print0 |
-  cpio --quiet -o -0 -H newc >> "$initrd"
-
-# Host files (3).
-
-(cd / && \
-  ls -1df $(
-      cat "$sourcedir"/initramfs.@REPO@.@host_cpu@.supermin.hostfiles
-    ) 2>/dev/null |
-  cpio --quiet -o -H newc ) >> "$initrd"

appliance/make.sh.in

@@ -1,6 +1,6 @@
 #!/bin/bash -
 # @configure_input@
-# Copyright (C) 2009 Red Hat Inc.
+# Copyright (C) 2009-2012 Red Hat Inc.
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -14,138 +14,53 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with this program; if not, write to the Free Software
-# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-
-# This is called from the Makefile to build the initramfs.
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 unset CDPATH
 
 set -e
-set -x
 
-if [ "@DIST@" = "REDHAT" ]; then
-  cd @top_builddir@
-  # Decide on names for the final output.  These have to match Makefile.am.
-  output=appliance/initramfs.@REPO@.@host_cpu@.img
-  koutput=appliance/vmlinuz.@REPO@.@host_cpu@
-  rm -f $output
-  rm -f $koutput
+# Turn excludelist file into command line arguments.
+exec 5<excludelist
+while read regexp <&5; do
+    excludes="$excludes --exclude $regexp"
+done
+exec 5<&-
 
-  # Create the basic initramfs.
-  exec 5<appliance/packagelist
-  packages=
-  while read pkg 0<&5; do
-      packages="$packages -i $pkg"
-  done
-  exec 5<&-
-
-  @FEBOOTSTRAP@ $packages -u @UPDATES@ @REPO@ initramfs @MIRROR@
-
-  # /sysroot is where the guest root filesystem will be mounted.
-  @FEBOOTSTRAP_RUN@ initramfs -- mkdir -p --mode=0777 /sysroot
-
-  # Create /tmp if it is missing.
-  @FEBOOTSTRAP_RUN@ initramfs -- mkdir -p --mode=0777 /tmp
-
-  # Create /selinux if it is missing.
-  @FEBOOTSTRAP_RUN@ initramfs -- mkdir -p --mode=0755 /selinux
-
-  # Nuke some stuff.  The kernel pulls mkinitrd and plymouth which pulls in
-  # all of Python.  Sheez.
-  (cd initramfs && find -name '*plymouth*' -print0) |
-    xargs -0 @FEBOOTSTRAP_RUN@ initramfs -- rm -rf
-  (cd initramfs && find -name '*python*' -print0) |
-    xargs -0 @FEBOOTSTRAP_RUN@ initramfs -- rm -rf
-
-  # In Fedora >= 11, it pulls in all of Perl from somewhere.  Nuke from orbit.
-  @FEBOOTSTRAP_RUN@ initramfs -- rm -rf /usr/lib/perl5 /usr/lib64/perl5
-
-  # Anaconda?  JPEG images?
-  @FEBOOTSTRAP_RUN@ initramfs -- rm -rf /usr/lib/anaconda-runtime
-
-  # Don't need any firmware.
-  @FEBOOTSTRAP_RUN@ initramfs -- rm -rf /lib/firmware
-
-  # Don't need any keyboard maps.
-  @FEBOOTSTRAP_RUN@ initramfs -- rm -rf /lib/kbd
-
-  # Remove anything in home directory.  Because of the potential for disaster
-  # we don't put a slash before 'home'.
-  (cd initramfs && echo home/*) |
-    xargs @FEBOOTSTRAP_RUN@ initramfs -- rm -rf
-
-  # Remove /var/lib/yum stuff.
-  @FEBOOTSTRAP_RUN@ initramfs -- rm -rf /var/lib/yum
-
-  # Remove some unreadable binaries which are incompatible with
-  # the supermin appliance.  Since these binaries can't be read
-  # from the host filesystem, they generate warnings like:
-  #   cpio: ./usr/bin/chfn: Cannot open: Permission denied
-  # These binaries are not needed for operation of the appliance.
-  @FEBOOTSTRAP_RUN@ initramfs -- rm -f \
-    /usr/bin/chfn \
-    /usr/bin/chsh \
-    /usr/libexec/pt_chown \
-    /usr/sbin/groupdel \
-    /usr/sbin/groupadd \
-    /usr/sbin/useradd \
-    /usr/sbin/tzdata-update \
-    /usr/sbin/userdel \
-    /usr/sbin/usermod \
-    /usr/sbin/groupmod \
-    /usr/sbin/groupmems \
-    /sbin/unix_update \
-    /usr/sbin/tcpd \
-    $(cd initramfs && echo usr/sbin/glibc_post_upgrade.*)
-
-  # Kernel modules take up nearly half of the image.  Only include ones
-  # which are on the whitelist.
-  exec 5<appliance/kmod.whitelist
-  whitelist=
-  while read kmod 0<&5; do
-      whitelist="$whitelist -a -not -name $kmod"
-  done
-  exec 5<&-
-
-  (cd initramfs && \
-    find lib/modules/*/kernel -name '*.ko' $whitelist -a -print0 ) |
-    xargs -0 febootstrap-run initramfs -- rm
-
-  # Pull the kernel out into the current directory.  We don't want it in
-  # the initramfs image.
-  cp initramfs/boot/vmlinuz* $koutput
-  @FEBOOTSTRAP_RUN@ initramfs -- rm -rf boot
-
-  # Minimize the image.
-  @FEBOOTSTRAP_MINIMIZE@ initramfs
-
-  # Add some missing configuration files.
-  if [ ! -f initramfs/etc/hosts ]; then
-      cat > hosts.new <<'__EOF__'
-  127.0.0.1 guestfs localhost.localdomain localhost
-  ::1       localhost6.localdomain6 localhost6
-__EOF__
-      @FEBOOTSTRAP_INSTALL@ initramfs hosts.new /etc/hosts 0644 root.root
-      rm hosts.new
-  fi
-
-  if [ ! -f initramfs/etc/fstab ]; then
-      @FEBOOTSTRAP_RUN@ initramfs -- touch /etc/fstab
-  fi
-
-  echo nameserver 10.0.2.3 > resolv.conf.new
-  @FEBOOTSTRAP_INSTALL@ initramfs resolv.conf.new /etc/resolv.conf 0644 root.root
-  rm resolv.conf.new
-
-  ls -lh $koutput
-
-  # Now directly run the update script to copy/update the daemon in the
-  # initramfs.
-  cd appliance && bash update.sh
-
-elif [ "@DIST@" = "DEBIAN" ]; then
-  cd @top_builddir@/appliance
-  debirf make -n debian
-  mkdir -p @top_builddir@/initramfs
-  touch @top_builddir@/initramfs/fakeroot.log
+# Run febootstrap on the package list.
+if [ "x@FEBOOTSTRAP_YUM_CONFIG@" != "xno" ]; then
+    extra="--yum-config @FEBOOTSTRAP_YUM_CONFIG@"
 fi
+
+echo @FEBOOTSTRAP@ -v -o supermin.d --names $(< packagelist ) $excludes $extra
+@FEBOOTSTRAP@ -v -o supermin.d --names $(< packagelist ) $excludes $extra
+
+# Remove some things that we don't want in the appliance.  This is
+# copied from the old febootstrap-minimize.  However minimization is
+# not so important now that we are caching the appliance.
+< supermin.d/hostfiles \
+grep -v '^/usr/lib/locale' |
+grep -v '^/usr/share/locale' |
+grep -v '^/usr/lib/gconv' |
+grep -v '^/usr/lib64/gconv' |
+grep -v '^/usr/bin/localedef' |
+grep -v '^/usr/sbin/build-locale-archive' |
+grep -v '^/usr/share/man/' |
+grep -v '^/usr/share/doc/' |
+grep -v '^/usr/share/info/' |
+grep -v '^/usr/share/gnome/help/' |
+grep -v '^/usr/share/cracklib/' |
+grep -v '^/usr/share/i18n/' > supermin.d/hostfiles-t
+
+# XXX resolv.conf?  The old script had:
+# echo nameserver 169.254.2.3 > resolv.conf
+if ! grep -q /etc/resolv.conf supermin.d/hostfiles-t; then
+    echo /etc/resolv.conf >> supermin.d/hostfiles-t
+fi
+
+# Include any Augeas lenses from the host.
+if grep -q /usr/share/augeas/lenses supermin.d/hostfiles-t; then
+    echo "/usr/share/augeas/lenses/*.aug" >> supermin.d/hostfiles-t
+fi
+
+mv supermin.d/hostfiles-t supermin.d/hostfiles

appliance/packagelist.in

@@ -5,41 +5,133 @@
  * following symbols defined (depending on the distro):
  *
  *   REDHAT=1     For Fedora, RHEL, EPEL and workalikes.
- *   DEBIAN=1     For Debian based distros.
+ *   DEBIAN=1     For Debian.
+ *   UBUNTU=1     For Ubuntu.
+ *   ARCHLINUX=1  For Archlinux.
+ *
+ * There is also a list of packages which are excluded if they appear
+ * as dependencies of the packages below.  See: excludelist.in
  */
 
-#if REDHAT == 1
+/* Basically the same with a few minor tweaks. */
+#ifdef UBUNTU
+#define DEBIAN 1
+#endif
+
+#ifdef REDHAT
   augeas-libs
+  btrfs-progs
+  cryptsetup
+  cryptsetup-luks /* old name used before Fedora 17 */
   diffutils
+  e2fsprogs
   /* e4fsprogs only exists on RHEL 5, will be ignored everywhere else. */
   e4fsprogs
+  gfs-utils
+  gfs2-utils
+  grub
+  hfsplus-tools
   iputils
   kernel
   MAKEDEV
+  nilfs-utils
   ntfsprogs
-  scrub
+  ntfs-3g
+  reiserfs-utils
   libselinux
-  udev
+  systemd /* for /sbin/reboot */
   util-linux-ng
-#elif DEBIAN == 1
+  vim-minimal
+  xz
+  zfs-fuse
+#endif /* REDHAT */
+
+#ifdef DEBIAN
   bsdmainutils
+  btrfs-tools
+  cryptsetup
+  diff
+  e2fsprogs
+  gfs-tools
+  gfs2-tools
+  grub-pc
+  hfsplus
   iproute
   libaugeas0
-  udev
+  linux-image
+  nilfs-tools
+  ntfs-3g
+  ntfsprogs
+  reiserfsprogs
+  ufsutils
   util-linux
-#endif
+  vim-tiny
+  xz-utils
+  zfs-fuse
+#endif /* DEBIAN */
 
+#ifdef ARCHLINUX
+  linux
+  vim
+  btrfs-progs-unstable
+  cryptsetup
+  diffutils
+  augeas
+  zfs-fuse
+  e2fsprogs
+  grub
+  iputils
+  nilfs-utils
+  ntfsprogs
+  ntfs-3g
+  reiserfsprogs
+  util-linux-ng
+  xz
+#endif /* ARCHLINUX */
+
+acl
+attr
 bash
 binutils
+bzip2
 coreutils
+cpio
 dosfstools
 file
-grub
+findutils
+gawk
+genisoimage
+grep
+gzip
+iproute
+jfsutils
+libxml2
 lsof
+lsscsi
 lvm2
+lzop
+mdadm
 module-init-tools
-net-tools
-ntfs-3g
+/*
+Enabling this pulls out 140 extra packages
+into the appliance:
+ocfs2-tools
+*/
+parted
 procps
+psmisc
+scrub
 strace
+tar
+udev
+#ifndef UBUNTU
+/* on Ubuntu contains a file in /lib64 which conflicts with libc6 that has
+ * /lib64 as a symbolic link
+ */
+xfsprogs
+#endif
 zerofree
+
+#ifdef VALGRIND_DAEMON
+valgrind
+#endif

appliance/supermin-split.sh.in

@@ -1,93 +0,0 @@
-#!/bin/bash -
-# @configure_input@
-# Copyright (C) 2009 Red Hat Inc.
-#
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-
-# Decide which files will stay in the supermin appliance and which
-# files will be pulled out of the host at runtime.
-#
-# Read the README file!
-#
-# The basic idea is that we create two output files, one containing
-# the files that will stay, and the other listing the files that
-# will be pulled from the host (ie. not go into the appliance now).
-#
-# The list of files that stay ('supermin.incfiles') is just a straight
-# list of files and directories.
-#
-# The list of files that come from the host ('*.supermin.hostfiles')
-# can include wildcards, to allow libraries to be upgraded on the
-# host.
-
-unset CDPATH
-
-set -e
-
-cd @top_builddir@/initramfs
-
-incfiles=../appliance/supermin.incfiles
-hostfiles=../appliance/initramfs.@REPO@.@host_cpu@.supermin.hostfiles
-
-exec 5>$incfiles
-exec 6>$hostfiles
-
-# Note currently the initramfs contains ~2500 files, and none have
-# "funny characters" in the names.  So this is reasonable just to
-# simplify the script.
-for path in $(find -not -name fakeroot.log); do
-    dir=$(dirname "$path")
-    file=$(basename "$path")
-
-    # All we're going to keep are the special files /init, the daemon,
-    # configuration files (/etc), devices and modifiable stuff (/var).
-    if [ "$path" = "./init" -o "$file" = "guestfsd" ]; then
-        echo "$path" >&5
-
-    elif [[ "$path" =~ '^\./etc' || "$path" =~ '^./dev' || "$path" =~ '^\./var' ]]; then
-        echo "$path" >&5
-
-    # Kernel modules are always copied in from the host, including all
-    # the dependency files.
-    elif [[ "$path" =~ '^\./lib/modules/' ]]; then
-        :
-
-    elif [ -d "$path" ]; then
-        # Always write directory names to both output files.
-        echo "$path" >&5
-        echo "$path" >&6
-
-    # Some libraries need fixed version numbers replaced by wildcards.
-
-    elif [[ "$file" =~ '^ld-[.0-9]+\.so$' ]]; then
-        echo "$dir/ld-*.so" >&6
-
-    # libfoo-1.2.3.so
-    elif [[ "$file" =~ '^lib(.*)-[-.0-9]+\.so$' ]]; then
-        echo "$dir/lib${BASH_REMATCH[1]}-*.so" >&6
-
-    # libfoo-1.2.3.so.1.2.3 (but NOT '*.so.N')
-    elif [[ "$file" =~ '^lib(.*)-[-.0-9]+\.so\.([0-9]+)\.' ]]; then
-        echo "$dir/lib${BASH_REMATCH[1]}-*.so.${BASH_REMATCH[2]}.*" >&6
-
-    # libfoo.so.1.2.3 (but NOT '*.so.N')
-    elif [[ "$file" =~ '^lib(.*)\.so\.([0-9]+)\.' ]]; then
-        echo "$dir/lib${BASH_REMATCH[1]}.so.${BASH_REMATCH[2]}.*" >&6
-
-    else
-        # Anything else comes from the host directly.
-        echo "$path" >&6
-    fi
-done

appliance/update.sh.in

@@ -1,48 +0,0 @@
-#!/bin/bash -
-# @configure_input@
-# Copyright (C) 2009 Red Hat Inc.
-#
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-
-# Update the init script or daemon inside an existing initramfs.
-# Avoids the timeconsuming rebuild.
-
-unset CDPATH
-
-set -e
-
-if [ "@DIST@" = "REDHAT" ]; then
-  cd @top_builddir@
-  output=appliance/initramfs.@REPO@.@host_cpu@.img
-
-  # Create the init script.
-  @FEBOOTSTRAP_INSTALL@ initramfs appliance/@top_srcdir@/appliance/init /init 0755 root.root
-
-  # Copy the daemon into the filesystem.
-  @FEBOOTSTRAP_INSTALL@ initramfs daemon/guestfsd /sbin/guestfsd 0755 root.root
-
-  # Generate final image.
-  @FEBOOTSTRAP_TO_INITRAMFS@ initramfs > $output-t
-  mv $output-t $output
-  ls -lh $output
-elif [ "@DIST@" = "DEBIAN" ]; then
-  cd @top_builddir@/appliance
-
-  output=initramfs.@REPO@.@host_cpu@.img
-  vmlinuz=vmlinuz.@REPO@.@host_cpu@
-
-  ln -sf debian/debirf-libguestfs_@REPO@*.cgz $output
-  ln -sf debian/vmlinuz-* $vmlinuz
-fi

autogen.sh

@@ -14,7 +14,7 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with this program; if not, write to the Free Software
-# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 #
 # Rebuild the autotools environment.
 
@@ -24,7 +24,7 @@ set -v
 # Ensure that whenever we pull in a gnulib update or otherwise change to a
 # different version (i.e., when switching branches), we also rerun ./bootstrap.
 curr_status=.git-module-status
-t=$(git submodule status)
+t=$(git submodule status|sed 's/^[ +-]//;s/ .*//')
 if test "$t" = "$(cat $curr_status 2>/dev/null)"; then
     : # good, it's up to date
 else
@@ -44,7 +44,7 @@ fi
 
 # If no arguments were specified and configure has run before, use the previous
 # arguments
-if [ $# == 0 -a -x ./config.status ]; then
+if test $# == 0 && test -x ./config.status; then
     ./config.status --recheck
 else
     $CONFIGUREDIR/configure "$@"

bindtests

@@ -3,90 +3,168 @@ def
 []
 false
 0
+0
 123
 456
+<61><62><63><00><61><62><63>
+obool: true
+oint: 1
+oint64: unset
+ostring: unset
 abc
 null
 []
 false
 0
+0
 123
 456
+<61><62><63><00><61><62><63>
+obool: unset
+oint: unset
+oint64: 1
+ostring: string
 
 def
 []
 false
 0
+0
 123
 456
+<61><62><63><00><61><62><63>
+obool: false
+oint: unset
+oint64: unset
+ostring: unset
 
 
 []
 false
 0
+0
 123
 456
+<61><62><63><00><61><62><63>
+obool: unset
+oint: unset
+oint64: unset
+ostring: unset
 abc
 def
 ["1"]
 false
 0
+0
 123
 456
+<61><62><63><00><61><62><63>
+obool: unset
+oint: unset
+oint64: unset
+ostring: unset
 abc
 def
 ["1", "2"]
 false
 0
+0
 123
 456
+<61><62><63><00><61><62><63>
+obool: unset
+oint: unset
+oint64: unset
+ostring: unset
 abc
 def
 ["1"]
 true
 0
+0
 123
 456
+<61><62><63><00><61><62><63>
+obool: unset
+oint: unset
+oint64: unset
+ostring: unset
 abc
 def
 ["1"]
 false
 -1
+-1
 123
 456
+<61><62><63><00><61><62><63>
+obool: unset
+oint: unset
+oint64: unset
+ostring: unset
 abc
 def
 ["1"]
 false
 -2
+-2
 123
 456
+<61><62><63><00><61><62><63>
+obool: unset
+oint: unset
+oint64: unset
+ostring: unset
 abc
 def
 ["1"]
 false
 1
+1
 123
 456
+<61><62><63><00><61><62><63>
+obool: unset
+oint: unset
+oint64: unset
+ostring: unset
 abc
 def
 ["1"]
 false
 2
+2
 123
 456
+<61><62><63><00><61><62><63>
+obool: unset
+oint: unset
+oint64: unset
+ostring: unset
 abc
 def
 ["1"]
 false
 4095
+4095
 123
 456
+<61><62><63><00><61><62><63>
+obool: unset
+oint: unset
+oint64: unset
+ostring: unset
 abc
 def
 ["1"]
 false
 0
+0
 
 
+<61><62><63><00><61><62><63>
+obool: unset
+oint: unset
+oint64: unset
+ostring: unset
 EOF

bootstrap

@@ -26,51 +26,72 @@ git submodule init || exit $?
 git submodule update || exit $?
 GNULIB_SRCDIR=.gnulib
 
-ls po/*.po 2>/dev/null | sed 's|.*/||; s|\.po$||' > po/LINGUAS
-
-# Run autopoint, to get po/Makevars.template:
-# Also, released autopoint has the tendency to install macros that have
-# been obsoleted in current gnulib, so run this before gnulib-tool.
-autopoint --force
-
 # Autoreconf runs aclocal before libtoolize, which causes spurious
 # warnings if the initial aclocal is confused by the libtoolized
 # (or worse out-of-date) macro directory.
 libtoolize --copy --install
 
-# Create gettext configuration.
-echo "$0: Creating po/Makevars from po/Makevars.template ..."
-rm -f po/Makevars
-sed '
-  /^EXTRA_LOCALE_CATEGORIES *=/s/=.*/= '"$EXTRA_LOCALE_CATEGORIES"'/
-  /^MSGID_BUGS_ADDRESS *=/s/=.*/= '"$MSGID_BUGS_ADDRESS"'/
-  /^XGETTEXT_OPTIONS *=/{
-    s/$/ \\/
-    a\
-        '"$XGETTEXT_OPTIONS"' $${end_of_xgettext_options+}
-  }
-' po/Makevars.template >po/Makevars
-
 gnulib_tool=$GNULIB_SRCDIR/gnulib-tool
 <$gnulib_tool || exit
 
 (cd daemon && mkdir -p tests lib && ../$gnulib_tool --update)
 
 modules='
+accept4
+arpa_inet
+byteswap
+c-ctype
+cloexec
 closeout
+connect
+dup3
+error
+filevercmp
+fsusage
+fts
+full-read
+full-write
+futimens
+getaddrinfo
+getline
 gitlog-to-changelog
+glob
 gnu-make
 gnumakefile
+hash
+hash-pjw
+human
 ignore-value
+lock
 maintainer-makefile
 manywarnings
+mkdtemp
+netdb
+netinet_in
+openat
+perror
+pread
 progname
+read-file
+readlink
+select
+setenv
+sleep
+socket
 strchrnul
 strerror
 strndup
+symlinkat
+sys_select
+sys_wait
 vasprintf
 vc-list-files
 warnings
+xalloc
+xalloc-die
+xstrtol
+xstrtoll
+xvasprintf
 '
 
 $gnulib_tool			\
@@ -79,6 +100,7 @@ $gnulib_tool			\
   --m4-base=m4			\
   --source-base=gnulib/lib	\
   --tests-base=gnulib/tests	\
+  --libtool			\
   --import $modules
 
 # Disable autopoint and libtoolize, since they were already done above.

bugs-in-changelog.sh

@@ -0,0 +1,46 @@
+#!/bin/bash -
+# bugs-in-changelog.sh
+# Copyright (C) 2009-2012 Red Hat Inc.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+# Used when preparing the RELEASE-NOTES file.  This script looks at
+# the bugs noted in the git changelog since the last stable release
+# (or any release).  To use it, the only parameter should be the git
+# commit range, eg:
+#
+#   ./bugs-in-changelog.sh "1.0.89.."
+
+if [ -z "$1" ]; then
+    echo "$0 git-commit-range"
+    exit 1
+fi
+
+# Comma-separated list of Bugzilla IDs.
+bugids=$(
+    git log "$1" | egrep -o 'RHBZ#[0-9]+' |
+    sed 's/RHBZ#//' |
+    sort -u |
+    tr '\n' ',' |
+    sed 's/,$//'
+)
+
+#echo bugids "$bugids"
+
+# Filter out any bugs which may still be in NEW or ASSIGNED:
+bugzilla query -b "$bugids" \
+    -t MODIFIED,POST,ON_QA,PASSES_QA,VERIFIED,RELEASE_PENDING,CLOSED \
+    --outputformat=' - %{bug_id} %{short_desc}' |
+    sort -n -r

capitests/Makefile.am

@@ -1,62 +0,0 @@
-# libguestfs
-# Copyright (C) 2009 Red Hat Inc.
-#
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-
-EXTRA_DIST = \
-	tests.c
-
-# Tests.  These are auto-generated from the test descriptions
-# in the generator.
-
-check_PROGRAMS = tests test-command
-
-tests_SOURCES = tests.c
-tests_CFLAGS = -I$(top_srcdir)/src -I$(top_builddir)/src \
-  $(WARN_CFLAGS) $(WERROR_CFLAGS)
-tests_LDADD = $(top_builddir)/src/libguestfs.la
-
-# Old version of e2fsprogs which didn't support UUIDs?
-e2fs_uuid_not_supported :=                                              \
-  $(shell r=1;                                                          \
-    test -x ../initramfs/sbin/mkswap                                    \
-      && ../initramfs/sbin/mkswap --help 2>&1 | grep -sq -- -U          \
-      && r=1;                                                           \
-    echo $$r)
-
-TESTS = tests
-TESTS_ENVIRONMENT = \
-	SKIP_TEST_COMMAND=$(shell ldd test-command | grep -sq 'not a dynamic executable' || echo 1) \
-	SKIP_TEST_COMMAND_LINES=$(shell ldd test-command | grep -sq 'not a dynamic executable' || echo 1) \
-	SKIP_TEST_ZEROFREE=$(shell test -x ../initramfs/usr/sbin/zerofree || echo 1) \
-	SKIP_TEST_NTFS_3G_PROBE=$(shell test -x ../initramfs/bin/ntfs-3g.probe || echo 1) \
-	SKIP_TEST_CHECKSUM_8=$(shell if test `find ../initramfs -name squashfs.ko | wc -l` -eq 0; then echo 1; fi) \
-	SKIP_TEST_MKSWAP_U=$(e2fs_uuid_not_supported) \
-	SKIP_TEST_SWAPON_UUID=$(e2fs_uuid_not_supported) \
-	SKIP_TEST_MKE2JOURNAL_U=$(e2fs_uuid_not_supported) \
-	SKIP_TEST_SCRUB_FILE=$(shell test -x ../initramfs/usr/bin/scrub || echo 1) \
-	SKIP_TEST_SCRUB_DEVICE=$(shell test -x ../initramfs/usr/bin/scrub || echo 1) \
-	$(VG)
-
-# Run the tests under valgrind.
-
-valgrind:
-	$(MAKE) check VG="valgrind --quiet --leak-check=full"
-
-# This binary must be statically linked.  It is used for testing
-# the "guestfs_command" and "guestfs_command_lines" functions.
-
-test_command_SOURCES = test-command.c
-test_command_LDFLAGS = -all-static

cat/Makefile.am

@@ -1,5 +1,5 @@
-# libguestfs virt-cat
-# Copyright (C) 2009 Red Hat Inc.
+# libguestfs virt-cat, virt-filesystems and virt-ls.
+# Copyright (C) 2010-2012 Red Hat Inc.
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -13,36 +13,127 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with this program; if not, write to the Free Software
-# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+include $(top_srcdir)/subdir-rules.mk
 
 EXTRA_DIST = \
-	run-cat-locally \
-	virt-cat.pl
+	test-virt-cat.sh \
+	virt-cat.pod \
+	test-virt-filesystems.sh \
+	virt-filesystems.pod \
+	test-virt-ls.sh \
+	virt-ls.pod
 
-if HAVE_CAT
+CLEANFILES = stamp-virt-cat.pod stamp-virt-ls.pod stamp-virt-filesystems.pod
 
-man_MANS = virt-cat.1
+bin_PROGRAMS = virt-cat virt-filesystems virt-ls
 
-noinst_DATA = @top_builddir@/html/virt-cat.1.html
+SHARED_SOURCE_FILES = \
+	../fish/config.c \
+	../fish/inspect.c \
+	../fish/keys.c \
+	../fish/options.h \
+	../fish/options.c \
+	../fish/virt.c
 
-virt-cat.1: virt-cat.pl
-	$(POD2MAN) \
-	  --section 1 \
-	  -c "Virtualization Support" \
-	  --release "$(PACKAGE_NAME)-$(PACKAGE_VERSION)" \
-	  $< > $@
+virt_cat_SOURCES = \
+	$(SHARED_SOURCE_FILES) \
+	virt-cat.c
 
-@top_builddir@/html/virt-cat.1.html: virt-cat.pl
-	mkdir -p @top_builddir@/html
-	cd @top_builddir@ && pod2html \
-	  --css 'pod.css' \
-	  --title 'virt-cat, display a file in a virtual machine' \
-	  --htmldir html \
-	  --outfile html/virt-cat.1.html \
-	  cat/$<
+virt_cat_CFLAGS = \
+	-DGUESTFS_WARN_DEPRECATED=1 \
+	-I$(top_srcdir)/src -I$(top_builddir)/src \
+	-I$(top_srcdir)/fish \
+	-I$(srcdir)/../gnulib/lib -I../gnulib/lib \
+	-DLOCALEBASEDIR=\""$(datadir)/locale"\" \
+	$(WARN_CFLAGS) $(WERROR_CFLAGS) \
+	$(LIBCONFIG_CFLAGS)
 
-install-data-hook:
-	mkdir -p $(DESTDIR)$(bindir)
-	install -m 0755 virt-cat.pl $(DESTDIR)$(bindir)/virt-cat
+virt_cat_LDADD = \
+	$(LIBCONFIG_LIBS) \
+	$(top_builddir)/src/libguestfs.la \
+	../gnulib/lib/libgnu.la
 
-endif
+virt_filesystems_SOURCES = \
+	$(SHARED_SOURCE_FILES) \
+	virt-filesystems.c
+
+virt_filesystems_CFLAGS = \
+	-DGUESTFS_WARN_DEPRECATED=1 \
+	-I$(top_srcdir)/src -I$(top_builddir)/src \
+	-I$(top_srcdir)/fish \
+	-I$(srcdir)/../gnulib/lib -I../gnulib/lib \
+	-DLOCALEBASEDIR=\""$(datadir)/locale"\" \
+	$(WARN_CFLAGS) $(WERROR_CFLAGS) \
+	$(LIBCONFIG_CFLAGS)
+
+virt_filesystems_LDADD = \
+	$(LIBCONFIG_LIBS) \
+	$(top_builddir)/src/libguestfs.la \
+	../gnulib/lib/libgnu.la
+
+virt_ls_SOURCES = \
+	$(SHARED_SOURCE_FILES) \
+	virt-ls.c
+
+virt_ls_CFLAGS = \
+	-DGUESTFS_WARN_DEPRECATED=1 \
+	-I$(top_srcdir)/src -I$(top_builddir)/src \
+	-I$(top_srcdir)/fish \
+	-I$(srcdir)/../gnulib/lib -I../gnulib/lib \
+	-DLOCALEBASEDIR=\""$(datadir)/locale"\" \
+	$(WARN_CFLAGS) $(WERROR_CFLAGS) \
+	$(LIBCONFIG_CFLAGS)
+
+virt_ls_LDADD = \
+	$(LIBCONFIG_LIBS) \
+	$(top_builddir)/src/libguestfs.la \
+	../gnulib/lib/libgnu.la
+
+# Manual pages and HTML files for the website.
+man_MANS = virt-cat.1 virt-filesystems.1 virt-ls.1
+
+noinst_DATA = \
+	$(top_builddir)/html/virt-cat.1.html \
+	$(top_builddir)/html/virt-filesystems.1.html \
+	$(top_builddir)/html/virt-ls.1.html
+
+virt-cat.1 $(top_builddir)/html/virt-cat.1.html: stamp-virt-cat.pod
+
+stamp-virt-cat.pod: virt-cat.pod
+	$(top_builddir)/podwrapper.sh \
+	  --man virt-cat.1 \
+	  --html $(top_builddir)/html/virt-cat.1.html \
+	  $<
+	touch $@
+
+virt-ls.1 $(top_builddir)/html/virt-ls.1.html: stamp-virt-ls.pod
+
+stamp-virt-ls.pod: virt-ls.pod
+	$(top_builddir)/podwrapper.sh \
+	  --man virt-ls.1 \
+	  --html $(top_builddir)/html/virt-ls.1.html \
+	  $<
+	touch $@
+
+virt-filesystems.1 $(top_builddir)/html/virt-filesystems.1.html: stamp-virt-filesystems.pod
+
+stamp-virt-filesystems.pod: virt-filesystems.pod
+	$(top_builddir)/podwrapper.sh \
+	  --man virt-filesystems.1 \
+	  --html $(top_builddir)/html/virt-filesystems.1.html \
+	  $<
+	touch $@
+
+# Tests.
+
+random_val := $(shell awk 'BEGIN{srand(); print 1+int(255*rand())}' < /dev/null)
+
+TESTS_ENVIRONMENT = \
+	MALLOC_PERTURB_=$(random_val) \
+	$(top_builddir)/run --test
+
+if ENABLE_APPLIANCE
+TESTS = test-virt-cat.sh test-virt-filesystems.sh test-virt-ls.sh
+endif ENABLE_APPLIANCE

cat/run-cat-locally

@@ -1,52 +0,0 @@
-#!/usr/bin/perl
-# virt-cat
-# Copyright (C) 2009 Red Hat Inc.
-#
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-
-# This script sets up the environment so you can run virt-cat in place
-# without needing to do 'make install' first. You can also run virt-cat
-# by creating a symlink to this script and putting it in your path.
-#
-# Use it like this:
-#   ./run-cat-locally [usual virt-cat args ...]
-
-use strict;
-use warnings;
-
-use File::Basename qw(dirname);
-use File::Spec;
-use Cwd qw(abs_path);
-
-my $path = $0;
-
-# Follow symlinks until we get to the real file
-while(-l $path) {
-    my $link = readlink($path);
-    if(File::Spec->file_name_is_absolute($link)) {
-        $path = $link;
-    } else {
-        $path = File::Spec->catfile(dirname($path), $link);
-    }
-}
-
-# Get the absolute path of the parent directory
-$path = abs_path(dirname($path).'/..');
-
-$ENV{LD_LIBRARY_PATH} = $path.'/src/.libs';
-$ENV{LIBGUESTFS_PATH} = $path.'/appliance';
-$ENV{PERL5LIB}        = $path.'/perl/blib/lib:'.$path.'/perl/blib/arch';
-
-exec('perl', $path.'/cat/virt-cat.pl', @ARGV);

cat/test-virt-cat.sh

@@ -0,0 +1,14 @@
+#!/bin/bash -
+
+export LANG=C
+set -e
+
+# Read out the test files from the image using virt-cat.
+if [ "$(./virt-cat ../tests/guests/fedora.img /etc/test1)" != "abcdefg" ]; then
+    echo "$0: error: mismatch in file test1"
+    exit 1
+fi
+if [ "$(./virt-cat ../tests/guests/fedora.img /etc/test2)" != "" ]; then
+    echo "$0: error: mismatch in file test2"
+    exit 1
+fi

cat/test-virt-filesystems.sh

@@ -0,0 +1,33 @@
+#!/bin/bash -
+
+export LANG=C
+set -e
+
+output="$(./virt-filesystems -a ../tests/guests/fedora.img | sort)"
+expected="/dev/VG/LV1
+/dev/VG/LV2
+/dev/VG/LV3
+/dev/VG/Root
+/dev/sda1"
+
+if [ "$output" != "$expected" ]; then
+    echo "$0: error: mismatch in test 1"
+    echo "$output"
+    exit 1
+fi
+
+output="$(./virt-filesystems -a ../tests/guests/fedora.img --all --long --uuid -h --no-title | awk '{print $1}' | sort -u)"
+expected="/dev/VG
+/dev/VG/LV1
+/dev/VG/LV2
+/dev/VG/LV3
+/dev/VG/Root
+/dev/sda
+/dev/sda1
+/dev/sda2"
+
+if [ "$output" != "$expected" ]; then
+    echo "$0: error: mismatch in test 2"
+    echo "$output"
+    exit 1
+fi

cat/test-virt-ls.sh

@@ -0,0 +1,33 @@
+#!/bin/bash -
+
+export LANG=C
+set -e
+
+# Read out the test directory using virt-ls.
+if [ "$(./virt-ls ../tests/guests/fedora.img /bin)" != "ls
+test1
+test2
+test3
+test4
+test5
+test6
+test7" ]; then
+    echo "$0: error: unexpected output from virt-ls"
+    exit 1
+fi
+
+# Try the -lR option.
+output="$(./virt-ls -lR ../tests/guests/fedora.img /boot | awk '{print $1 $2 $4}')"
+expected="d0755/boot
+d0755/boot/grub
+-0644/boot/grub/grub.conf
+d0700/boot/lost+found"
+if [ "$output" != "$expected" ]; then
+    echo "$0: error: unexpected output from virt-ls -lR"
+    echo "output: ------------------------------------------"
+    echo "$output"
+    echo "expected: ----------------------------------------"
+    echo "$expected"
+    echo "--------------------------------------------------"
+    exit 1
+fi

cat/virt-cat.c

@@ -0,0 +1,390 @@
+/* virt-cat
+ * Copyright (C) 2010-2012 Red Hat Inc.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#include <config.h>
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <inttypes.h>
+#include <unistd.h>
+#include <getopt.h>
+#include <locale.h>
+#include <assert.h>
+#include <libintl.h>
+
+#include "progname.h"
+#include "c-ctype.h"
+
+#include "guestfs.h"
+#include "options.h"
+
+/* Currently open libguestfs handle. */
+guestfs_h *g;
+
+int read_only = 1;
+int live = 0;
+int verbose = 0;
+int keys_from_stdin = 0;
+int echo_keys = 0;
+const char *libvirt_uri = NULL;
+int inspector = 1;
+
+static int is_windows (guestfs_h *g, const char *root);
+static char *windows_path (guestfs_h *g, const char *root, const char *filename);
+
+static inline char *
+bad_cast (char const *s)
+{
+  return (char *) s;
+}
+
+static void __attribute__((noreturn))
+usage (int status)
+{
+  if (status != EXIT_SUCCESS)
+    fprintf (stderr, _("Try `%s --help' for more information.\n"),
+             program_name);
+  else {
+    fprintf (stdout,
+           _("%s: display files in a virtual machine\n"
+             "Copyright (C) 2010 Red Hat Inc.\n"
+             "Usage:\n"
+             "  %s [--options] -d domname file [file ...]\n"
+             "  %s [--options] -a disk.img [-a disk.img ...] file [file ...]\n"
+             "Options:\n"
+             "  -a|--add image       Add image\n"
+             "  -c|--connect uri     Specify libvirt URI for -d option\n"
+             "  -d|--domain guest    Add disks from libvirt guest\n"
+             "  --echo-keys          Don't turn off echo for passphrases\n"
+             "  --format[=raw|..]    Force disk format for -a option\n"
+             "  --help               Display brief help\n"
+             "  --keys-from-stdin    Read passphrases from stdin\n"
+             "  -v|--verbose         Verbose messages\n"
+             "  -V|--version         Display version and exit\n"
+             "  -x                   Trace libguestfs API calls\n"
+             "For more information, see the manpage %s(1).\n"),
+             program_name, program_name, program_name,
+             program_name);
+  }
+  exit (status);
+}
+
+int
+main (int argc, char *argv[])
+{
+  /* Set global program name that is not polluted with libtool artifacts.  */
+  set_program_name (argv[0]);
+
+  setlocale (LC_ALL, "");
+  bindtextdomain (PACKAGE, LOCALEBASEDIR);
+  textdomain (PACKAGE);
+
+  enum { HELP_OPTION = CHAR_MAX + 1 };
+
+  static const char *options = "a:c:d:vVx";
+  static const struct option long_options[] = {
+    { "add", 1, 0, 'a' },
+    { "connect", 1, 0, 'c' },
+    { "domain", 1, 0, 'd' },
+    { "echo-keys", 0, 0, 0 },
+    { "format", 2, 0, 0 },
+    { "help", 0, 0, HELP_OPTION },
+    { "keys-from-stdin", 0, 0, 0 },
+    { "verbose", 0, 0, 'v' },
+    { "version", 0, 0, 'V' },
+    { 0, 0, 0, 0 }
+  };
+  struct drv *drvs = NULL;
+  struct drv *drv;
+  const char *format = NULL;
+  int c;
+  int option_index;
+
+  g = guestfs_create ();
+  if (g == NULL) {
+    fprintf (stderr, _("guestfs_create: failed to create handle\n"));
+    exit (EXIT_FAILURE);
+  }
+
+  argv[0] = bad_cast (program_name);
+
+  for (;;) {
+    c = getopt_long (argc, argv, options, long_options, &option_index);
+    if (c == -1) break;
+
+    switch (c) {
+    case 0:			/* options which are long only */
+      if (STREQ (long_options[option_index].name, "keys-from-stdin")) {
+        keys_from_stdin = 1;
+      } else if (STREQ (long_options[option_index].name, "echo-keys")) {
+        echo_keys = 1;
+      } else if (STREQ (long_options[option_index].name, "format")) {
+        if (!optarg || STREQ (optarg, ""))
+          format = NULL;
+        else
+          format = optarg;
+      } else {
+        fprintf (stderr, _("%s: unknown long option: %s (%d)\n"),
+                 program_name, long_options[option_index].name, option_index);
+        exit (EXIT_FAILURE);
+      }
+      break;
+
+    case 'a':
+      OPTION_a;
+      break;
+
+    case 'c':
+      OPTION_c;
+      break;
+
+    case 'd':
+      OPTION_d;
+      break;
+
+    case 'h':
+      usage (EXIT_SUCCESS);
+
+    case 'v':
+      OPTION_v;
+      break;
+
+    case 'V':
+      OPTION_V;
+      break;
+
+    case 'x':
+      OPTION_x;
+      break;
+
+    case HELP_OPTION:
+      usage (EXIT_SUCCESS);
+
+    default:
+      usage (EXIT_FAILURE);
+    }
+  }
+
+  /* Old-style syntax?  There were no -a or -d options in the old
+   * virt-cat which is how we detect this.
+   */
+  if (drvs == NULL) {
+    /* argc - 1 because last parameter is the single filename. */
+    while (optind < argc - 1) {
+      if (strchr (argv[optind], '/') ||
+          access (argv[optind], F_OK) == 0) { /* simulate -a option */
+        drv = calloc (1, sizeof (struct drv));
+        if (!drv) {
+          perror ("malloc");
+          exit (EXIT_FAILURE);
+        }
+        drv->type = drv_a;
+        drv->a.filename = argv[optind];
+        drv->next = drvs;
+        drvs = drv;
+      } else {                  /* simulate -d option */
+        drv = calloc (1, sizeof (struct drv));
+        if (!drv) {
+          perror ("malloc");
+          exit (EXIT_FAILURE);
+        }
+        drv->type = drv_d;
+        drv->d.guest = argv[optind];
+        drv->next = drvs;
+        drvs = drv;
+      }
+
+      optind++;
+    }
+  }
+
+  /* These are really constants, but they have to be variables for the
+   * options parsing code.  Assert here that they have known-good
+   * values.
+   */
+  assert (read_only == 1);
+  assert (inspector == 1);
+  assert (live == 0);
+
+  /* User must specify at least one filename on the command line. */
+  if (optind >= argc || argc - optind < 1)
+    usage (EXIT_FAILURE);
+
+  /* User must have specified some drives. */
+  if (drvs == NULL)
+    usage (EXIT_FAILURE);
+
+  /* Add drives, inspect and mount.  Note that inspector is always true,
+   * and there is no -m option.
+   */
+  add_drives (drvs, 'a');
+
+  if (guestfs_launch (g) == -1)
+    exit (EXIT_FAILURE);
+
+  inspect_mount ();
+
+  /* Free up data structures, no longer needed after this point. */
+  free_drives (drvs);
+
+  unsigned errors = 0;
+  int windows;
+  char *root, **roots;
+
+  /* Get root mountpoint.  See: fish/inspect.c:inspect_mount */
+  roots = guestfs_inspect_get_roots (g);
+  assert (roots);
+  assert (roots[0] != NULL);
+  assert (roots[1] == NULL);
+  root = roots[0];
+  free (roots);
+
+  /* Windows?  Special handling is required. */
+  windows = is_windows (g, root);
+
+  for (; optind < argc; optind++) {
+    char *filename_to_free = NULL;
+    const char *filename = argv[optind];
+
+    if (windows) {
+      filename = filename_to_free = windows_path (g, root, filename);
+      if (filename == NULL) {
+        errors++;
+        continue;
+      }
+    }
+
+    if (guestfs_download (g, filename, "/dev/stdout") == -1)
+      errors++;
+
+    free (filename_to_free);
+  }
+
+  free (root);
+
+  guestfs_close (g);
+
+  exit (errors == 0 ? EXIT_SUCCESS : EXIT_FAILURE);
+}
+
+static int
+is_windows (guestfs_h *g, const char *root)
+{
+  char *type;
+  int w;
+
+  type = guestfs_inspect_get_type (g, root);
+  if (!type)
+    return 0;
+
+  w = STREQ (type, "windows");
+  free (type);
+  return w;
+}
+
+static void mount_drive_letter_ro (char drive_letter, const char *root);
+
+static char *
+windows_path (guestfs_h *g, const char *root, const char *path)
+{
+  char *ret;
+  size_t i;
+
+  /* If there is a drive letter, rewrite the path. */
+  if (c_isalpha (path[0]) && path[1] == ':') {
+    char drive_letter = c_tolower (path[0]);
+    /* This returns the newly allocated string. */
+    mount_drive_letter_ro (drive_letter, root);
+    ret = strdup (path + 2);
+    if (ret == NULL) {
+      perror ("strdup");
+      exit (EXIT_FAILURE);
+    }
+  }
+  else if (!*path) {
+    ret = strdup ("/");
+    if (ret == NULL) {
+      perror ("strdup");
+      exit (EXIT_FAILURE);
+    }
+  }
+  else {
+    ret = strdup (path);
+    if (ret == NULL) {
+      perror ("strdup");
+      exit (EXIT_FAILURE);
+    }
+  }
+
+  /* Blindly convert any backslashes into forward slashes.  Is this good? */
+  for (i = 0; i < strlen (ret); ++i)
+    if (ret[i] == '\\')
+      ret[i] = '/';
+
+  /* If this fails, we want to return NULL. */
+  char *t = guestfs_case_sensitive_path (g, ret);
+  free (ret);
+  ret = t;
+
+  return ret;
+}
+
+static void
+mount_drive_letter_ro (char drive_letter, const char *root)
+{
+  char **drives;
+  char *device;
+  size_t i;
+
+  /* Resolve the drive letter using the drive mappings table. */
+  drives = guestfs_inspect_get_drive_mappings (g, root);
+  if (drives == NULL || drives[0] == NULL) {
+    fprintf (stderr, _("%s: to use Windows drive letters, this must be a Windows guest\n"),
+             program_name);
+    exit (EXIT_FAILURE);
+  }
+
+  device = NULL;
+  for (i = 0; drives[i] != NULL; i += 2) {
+    if (c_tolower (drives[i][0]) == drive_letter && drives[i][1] == '\0') {
+      device = drives[i+1];
+      break;
+    }
+  }
+
+  if (device == NULL) {
+    fprintf (stderr, _("%s: drive '%c:' not found.\n"),
+             program_name, drive_letter);
+    exit (EXIT_FAILURE);
+  }
+
+  /* Unmount current disk and remount device. */
+  if (guestfs_umount_all (g) == -1)
+    exit (EXIT_FAILURE);
+
+  if (guestfs_mount_ro (g, device, "/") == -1)
+    exit (EXIT_FAILURE);
+
+  for (i = 0; drives[i] != NULL; ++i)
+    free (drives[i]);
+  free (drives);
+  /* Don't need to free (device) because that string was in the
+   * drives array.
+   */
+}

cat/virt-cat.pl

@@ -1,196 +0,0 @@
-#!/usr/bin/perl -w
-# virt-cat
-# Copyright (C) 2009 Red Hat Inc.
-#
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-
-use warnings;
-use strict;
-
-use Sys::Guestfs;
-use Sys::Guestfs::Lib qw(open_guest get_partitions resolve_windows_path
-  inspect_all_partitions inspect_partition
-  inspect_operating_systems mount_operating_system);
-use Pod::Usage;
-use Getopt::Long;
-use Data::Dumper;
-use File::Temp qw/tempdir/;
-use XML::Writer;
-use Locale::TextDomain 'libguestfs';
-
-=encoding utf8
-
-=head1 NAME
-
-virt-cat - Display a file in a virtual machine
-
-=head1 SYNOPSIS
-
- virt-cat [--options] domname file
-
- virt-cat [--options] disk.img [disk.img ...] file
-
-=head1 DESCRIPTION
-
-C<virt-cat> is a command line tool to display the contents of C<file>
-where C<file> exists in the named virtual machine (or disk image).
-
-C<virt-cat> can be used to quickly view a single file.  For more
-complex cases you should look at the L<guestfish(1)> tool.
-
-=head1 EXAMPLES
-
-Display C</etc/fstab> file from inside the libvirt VM called
-C<mydomain>:
-
- virt-cat mydomain /etc/fstab
-
-List syslog messages from a VM:
-
- virt-cat mydomain /var/log/messages | tail
-
-Find out what DHCP IP address a VM acquired:
-
- virt-cat mydomain /var/log/messages | grep 'dhclient: bound to' | tail
-
-Find out what packages were recently installed:
-
- virt-cat mydomain /var/log/yum.log | tail
-
-Find out who is logged on inside a virtual machine:
-
- virt-cat mydomain /var/run/utmp > /tmp/utmp
- who /tmp/utmp
-
-or who was logged on:
-
- virt-cat mydomain /var/log/wtmp > /tmp/wtmp
- last -f /tmp/wtmp
-
-=head1 OPTIONS
-
-=over 4
-
-=cut
-
-my $help;
-
-=item B<--help>
-
-Display brief help.
-
-=cut
-
-my $version;
-
-=item B<--version>
-
-Display version number and exit.
-
-=cut
-
-my $uri;
-
-=item B<--connect URI> | B<-c URI>
-
-If using libvirt, connect to the given I<URI>.  If omitted, then we
-connect to the default libvirt hypervisor.
-
-If you specify guest block devices directly, then libvirt is not used
-at all.
-
-=back
-
-=cut
-
-GetOptions ("help|?" => \$help,
-            "version" => \$version,
-            "connect|c=s" => \$uri,
-    ) or pod2usage (2);
-pod2usage (1) if $help;
-if ($version) {
-    my $g = Sys::Guestfs->new ();
-    my %h = $g->version ();
-    print "$h{major}.$h{minor}.$h{release}$h{extra}\n";
-    exit
-}
-
-pod2usage (__"virt-cat: no image, VM names or filenames to cat given")
-    if @ARGV <= 1;
-
-my $filename = pop @ARGV;
-
-my $g;
-if ($uri) {
-    $g = open_guest (\@ARGV, address => $uri);
-} else {
-    $g = open_guest (\@ARGV);
-}
-
-$g->launch ();
-$g->wait_ready ();
-
-# List of possible filesystems.
-my @partitions = get_partitions ($g);
-
-# Now query each one to build up a picture of what's in it.
-my %fses =
-    inspect_all_partitions ($g, \@partitions,
-      use_windows_registry => 0);
-
-my $oses = inspect_operating_systems ($g, \%fses);
-
-my @roots = keys %$oses;
-die __"no root device found in this operating system image" if @roots == 0;
-die __"multiboot operating systems are not supported by virt-cat" if @roots > 1;
-my $root_dev = $roots[0];
-
-my $os = $oses->{$root_dev};
-mount_operating_system ($g, $os);
-
-# Allow this to fail in case eg. the file does not exist.
-# NB: https://bugzilla.redhat.com/show_bug.cgi?id=501888
-print $g->download($filename, "/dev/stdout");
-
-=head1 SEE ALSO
-
-L<guestfs(3)>,
-L<guestfish(1)>,
-L<Sys::Guestfs(3)>,
-L<Sys::Guestfs::Lib(3)>,
-L<Sys::Virt(3)>,
-L<http://libguestfs.org/>.
-
-=head1 AUTHOR
-
-Richard W.M. Jones L<http://et.redhat.com/~rjones/>
-
-=head1 COPYRIGHT
-
-Copyright (C) 2009 Red Hat Inc.
-
-This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with this program; if not, write to the Free Software
-Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

cat/virt-cat.pod

@@ -0,0 +1,272 @@
+=encoding utf8
+
+=head1 NAME
+
+virt-cat - Display files in a virtual machine
+
+=head1 SYNOPSIS
+
+ virt-cat [--options] -d domname file [file ...]
+
+ virt-cat [--options] -a disk.img [-a disk.img ...] file [file ...]
+
+Old-style:
+
+ virt-cat domname file
+
+ virt-cat disk.img file
+
+=head1 DESCRIPTION
+
+C<virt-cat> is a command line tool to display the contents of C<file>
+where C<file> exists in the named virtual machine (or disk image).
+
+Multiple filenames can be given, in which case they are concatenated
+together.  Each filename must be a full path, starting at the root
+directory (starting with '/').
+
+C<virt-cat> can be used to quickly view a file.  To edit a file, use
+C<virt-edit>.  For more complex cases you should look at the
+L<guestfish(1)> tool (see L</USING GUESTFISH> below).
+
+=head1 EXAMPLES
+
+Display C</etc/fstab> file from inside the libvirt VM called
+C<mydomain>:
+
+ virt-cat -d mydomain /etc/fstab
+
+List syslog messages from a VM disk image file:
+
+ virt-cat -a disk.img /var/log/messages | tail
+
+Find out what DHCP IP address a VM acquired:
+
+ virt-cat -d mydomain /var/log/messages | \
+   grep 'dhclient: bound to' | tail
+
+Find out what packages were recently installed:
+
+ virt-cat -d mydomain /var/log/yum.log | tail
+
+Find out who is logged on inside a virtual machine:
+
+ virt-cat -d mydomain /var/run/utmp > /tmp/utmp
+ who /tmp/utmp
+
+or who was logged on:
+
+ virt-cat -d mydomain /var/log/wtmp > /tmp/wtmp
+ last -f /tmp/wtmp
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<--help>
+
+Display brief help.
+
+=item B<-a> file
+
+=item B<--add> file
+
+Add I<file> which should be a disk image from a virtual machine.  If
+the virtual machine has multiple block devices, you must supply all of
+them with separate I<-a> options.
+
+The format of the disk image is auto-detected.  To override this and
+force a particular format use the I<--format=..> option.
+
+=item B<-c> URI
+
+=item B<--connect> URI
+
+If using libvirt, connect to the given I<URI>.  If omitted, then we
+connect to the default libvirt hypervisor.
+
+If you specify guest block devices directly (I<-a>), then libvirt is
+not used at all.
+
+=item B<-d> guest
+
+=item B<--domain> guest
+
+Add all the disks from the named libvirt guest.  Domain UUIDs can be
+used instead of names.
+
+=item B<--echo-keys>
+
+When prompting for keys and passphrases, virt-cat normally turns
+echoing off so you cannot see what you are typing.  If you are not
+worried about Tempest attacks and there is no one else in the room you
+can specify this flag to see what you are typing.
+
+=item B<--format=raw|qcow2|..>
+
+=item B<--format>
+
+The default for the I<-a> option is to auto-detect the format of the
+disk image.  Using this forces the disk format for I<-a> options which
+follow on the command line.  Using I<--format> with no argument
+switches back to auto-detection for subsequent I<-a> options.
+
+For example:
+
+ virt-cat --format=raw -a disk.img file
+
+forces raw format (no auto-detection) for C<disk.img>.
+
+ virt-cat --format=raw -a disk.img --format -a another.img file
+
+forces raw format (no auto-detection) for C<disk.img> and reverts to
+auto-detection for C<another.img>.
+
+If you have untrusted raw-format guest disk images, you should use
+this option to specify the disk format.  This avoids a possible
+security problem with malicious guests (CVE-2010-3851).
+
+=item B<--keys-from-stdin>
+
+Read key or passphrase parameters from stdin.  The default is
+to try to read passphrases from the user by opening C</dev/tty>.
+
+=item B<-v>
+
+=item B<--verbose>
+
+Enable verbose messages for debugging.
+
+=item B<-V>
+
+=item B<--version>
+
+Display version number and exit.
+
+=item B<-x>
+
+Enable tracing of libguestfs API calls.
+
+=back
+
+=head1 OLD-STYLE COMMAND LINE ARGUMENTS
+
+Previous versions of virt-cat allowed you to write either:
+
+ virt-cat disk.img [disk.img ...] file
+
+or
+
+ virt-cat guestname file
+
+whereas in this version you should use I<-a> or I<-d> respectively
+to avoid the confusing case where a disk image might have the same
+name as a guest.
+
+For compatibility the old style is still supported.
+
+=head1 WINDOWS PATHS
+
+C<virt-cat> has a limited ability to understand Windows drive letters
+and paths (eg. C<E:\foo\bar.txt>).
+
+If and only if the guest is running Windows then:
+
+=over 4
+
+=item *
+
+Drive letter prefixes like C<C:> are resolved against the
+Windows Registry to the correct filesystem.
+
+=item *
+
+Any backslash (C<\>) characters in the path are replaced
+with forward slashes so that libguestfs can process it.
+
+=item *
+
+The path is resolved case insensitively to locate the file
+that should be displayed.
+
+=back
+
+There are some known shortcomings:
+
+=over 4
+
+=item *
+
+Some NTFS symbolic links may not be followed correctly.
+
+=item *
+
+NTFS junction points that cross filesystems are not followed.
+
+=back
+
+=head1 USING GUESTFISH
+
+L<guestfish(1)> is a more powerful, lower level tool which you can use
+when C<virt-cat> doesn't work.
+
+Using C<virt-cat> is approximately equivalent to doing:
+
+ guestfish --ro -i -d domname download file -
+
+where C<domname> is the name of the libvirt guest, and C<file> is the
+full path to the file.  Note the final C<-> (meaning "output to
+stdout").
+
+The command above uses libguestfs's guest inspection feature and so
+does not work on guests that libguestfs cannot inspect, or on things
+like arbitrary disk images that don't contain guests.  To display a
+file from a disk image directly, use:
+
+ guestfish --ro -a disk.img -m /dev/sda1 download file -
+
+where C<disk.img> is the disk image, C</dev/sda1> is the filesystem
+within the disk image, and C<file> is the full path to the file.
+
+=head1 SHELL QUOTING
+
+Libvirt guest names can contain arbitrary characters, some of which
+have meaning to the shell such as C<#> and space.  You may need to
+quote or escape these characters on the command line.  See the shell
+manual page L<sh(1)> for details.
+
+=head1 EXIT STATUS
+
+This program returns 0 if successful, or non-zero if there was an
+error.
+
+=head1 SEE ALSO
+
+L<guestfs(3)>,
+L<guestfish(1)>,
+L<virt-copy-out(1)>,
+L<virt-edit(1)>,
+L<virt-tar-out(1)>,
+L<http://libguestfs.org/>.
+
+=head1 AUTHOR
+
+Richard W.M. Jones L<http://people.redhat.com/~rjones/>
+
+=head1 COPYRIGHT
+
+Copyright (C) 2010-2012 Red Hat Inc.
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

cat/virt-filesystems.pod

@@ -0,0 +1,420 @@
+=encoding utf8
+
+=head1 NAME
+
+virt-filesystems - List filesystems, partitions, block devices, LVM in a virtual machine or disk image
+
+=head1 SYNOPSIS
+
+ virt-filesystems [--options] -d domname
+
+ virt-filesystems [--options] -a disk.img [-a disk.img ...]
+
+=head1 DESCRIPTION
+
+This tool allows you to discover filesystems, partitions, logical
+volumes, and their sizes in a disk image or virtual machine.  It is a
+replacement for L<virt-list-filesystems(1)> and
+L<virt-list-partitions(1)>.
+
+One use for this tool is from shell scripts to iterate over all
+filesystems from a disk image:
+
+ for fs in $(virt-filesystems -a disk.img); do
+   # ...
+ done
+
+Another use is to list partitions before using another tool to modify
+those partitions (such as L<virt-resize(1)>).  If you are curious
+about what an unknown disk image contains, use this tool along with
+L<virt-inspector(1)>.
+
+Various command line options control what this program displays.  You
+need to give either I<-a> or I<-d> options to specify the disk image
+or libvirt guest respectively.  If you just specify that then the
+program shows filesystems found, one per line, like this:
+
+ $ virt-filesystems -a disk.img
+ /dev/sda1
+ /dev/vg_guest/lv_root
+
+If you add I<-l> or I<--long> then the output includes extra
+information:
+
+ $ virt-filesystems -a disk.img -l
+ Name                   Type         VFS   Label  Size
+ /dev/sda1              filesystem   ext4  boot   524288000
+ /dev/vg_guest/lv_root  filesystem   ext4  root   10212081664
+
+If you add I<--extra> then non-mountable (swap, unknown) filesystems
+are shown as well:
+
+ $ virt-filesystems -a disk.img --extra
+ /dev/sda1
+ /dev/vg_guest/lv_root
+ /dev/vg_guest/lv_swap
+ /dev/vg_guest/lv_data
+
+If you add I<--partitions> then partitions are shown instead of filesystems:
+
+ $ virt-filesystems -a disk.img --partitions
+ /dev/sda1
+ /dev/sda2
+
+Similarly you can use I<--logical-volumes>, I<--volume-groups>,
+I<--physical-volumes>, I<--block-devices> to list those items.
+
+You can use these options in combination as well (if you want a
+combination including filesystems, you have to add I<--filesystems>).
+Notice that some items fall into several categories (eg. C</dev/sda1>
+might be both a partition and a filesystem).  These items are listed
+several times.  To get a list which includes absolutely everything
+that virt-filesystems knows about, use the I<--all> option.
+
+UUIDs (because they are quite long) are not shown by default.  Add the
+I<--uuid> option to display device and filesystem UUIDs in the long
+output.
+
+I<--all --long --uuid> is a useful combination to display all possible
+information about everything.
+
+ $ virt-filesystems -a win.img --all --long --uuid -h
+ Name      Type       VFS  Label           Size Parent   UUID
+ /dev/sda1 filesystem ntfs System Reserved 100M -        F81C92571C92112C
+ /dev/sda2 filesystem ntfs -               20G  -        F2E8996AE8992E3B
+ /dev/sda1 partition  -    -               100M /dev/sda -
+ /dev/sda2 partition  -    -               20G  /dev/sda -
+ /dev/sda  device     -    -               20G  -        -
+
+For machine-readable output, use I<--csv> to get Comma-Separated Values.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<--help>
+
+Display brief help.
+
+=item B<-a> file
+
+=item B<--add> file
+
+Add I<file> which should be a disk image from a virtual machine.  If
+the virtual machine has multiple block devices, you must supply all of
+them with separate I<-a> options.
+
+The format of the disk image is auto-detected.  To override this and
+force a particular format use the I<--format=..> option.
+
+=item B<--all>
+
+Display everything.  This is currently the same as specifying these
+options: I<--filesystems>, I<--extra>, I<--partitions>,
+I<--block-devices>, I<--logical-volumes>, I<--volume-groups>,
+I<--physical-volumes>.  (More may be added to this list in future).
+
+See also I<--long>.
+
+=item B<--blkdevs>
+
+=item B<--block-devices>
+
+Display block devices.
+
+=item B<-c> URI
+
+=item B<--connect> URI
+
+If using libvirt, connect to the given I<URI>.  If omitted, then we
+connect to the default libvirt hypervisor.
+
+If you specify guest block devices directly (I<-a>), then libvirt is
+not used at all.
+
+=item B<--csv>
+
+Write out the results in CSV format (comma-separated values).  This
+format can be imported easily into databases and spreadsheets, but
+read L</NOTE ABOUT CSV FORMAT> below.
+
+=item B<-d> guest
+
+=item B<--domain> guest
+
+Add all the disks from the named libvirt guest.  Domain UUIDs can be
+used instead of names.
+
+=item B<--echo-keys>
+
+When prompting for keys and passphrases, virt-filesystems normally
+turns echoing off so you cannot see what you are typing.  If you are
+not worried about Tempest attacks and there is no one else in the room
+you can specify this flag to see what you are typing.
+
+=item B<--extra>
+
+This causes filesystems that are not ordinary, mountable filesystems
+to be displayed.  This category includes swapspace, and filesystems
+that are empty or contain unknown data.
+
+This option implies I<--filesystems>.
+
+=item B<--filesystems>
+
+Display mountable filesystems.  If no display option was selected then
+this option is implied.
+
+With I<--extra>, non-mountable filesystems are shown too.
+
+=item B<--format=raw|qcow2|..>
+
+=item B<--format>
+
+The default for the I<-a> option is to auto-detect the format of the
+disk image.  Using this forces the disk format for I<-a> options which
+follow on the command line.  Using I<--format> with no argument
+switches back to auto-detection for subsequent I<-a> options.
+
+For example:
+
+ virt-filesystems --format=raw -a disk.img
+
+forces raw format (no auto-detection) for C<disk.img>.
+
+ virt-filesystems --format=raw -a disk.img --format -a another.img
+
+forces raw format (no auto-detection) for C<disk.img> and reverts to
+auto-detection for C<another.img>.
+
+If you have untrusted raw-format guest disk images, you should use
+this option to specify the disk format.  This avoids a possible
+security problem with malicious guests (CVE-2010-3851).
+
+=item B<-h>
+
+=item B<--human-readable>
+
+In I<--long> mode, display sizes in human-readable format.
+
+=item B<--keys-from-stdin>
+
+Read key or passphrase parameters from stdin.  The default is
+to try to read passphrases from the user by opening C</dev/tty>.
+
+=item B<-l>
+
+=item B<--long>
+
+Display extra columns of data ("long format").
+
+A title row is added unless you also specify I<--no-title>.
+
+The extra columns displayed depend on what output you select, and the
+ordering of columns may change in future versions.  Use the title row,
+I<--csv> output and/or L<csvtool(1)> to match columns to data in
+external programs.
+
+Use I<-h> if you want sizes to be displayed in human-readable format.
+The default is to show raw numbers of I<bytes>.
+
+Use I<--uuid> to display UUIDs too.
+
+=item B<--lvs>
+
+=item B<--logvols>
+
+=item B<--logical-volumes>
+
+Display LVM logical volumes.  In this mode, these are displayed
+irrespective of whether the LVs contain filesystems.
+
+=item B<--no-title>
+
+In I<--long> mode, don't add a title row.
+
+Note that the order of the columns is not fixed, and may change in
+future versions of virt-filesystems, so using this option may give you
+unexpected surprises.
+
+=item B<--parts>
+
+=item B<--partitions>
+
+Display partitions.  In this mode, these are displayed
+irrespective of whether the partitions contain filesystems.
+
+=item B<--pvs>
+
+=item B<--physvols>
+
+=item B<--physical-volumes>
+
+Display LVM physical volumes.
+
+=item B<--uuid>
+
+=item B<--uuids>
+
+In I<--long> mode, display UUIDs as well.
+
+=item B<-v>
+
+=item B<--verbose>
+
+Enable verbose messages for debugging.
+
+=item B<-V>
+
+=item B<--version>
+
+Display version number and exit.
+
+=item B<--vgs>
+
+=item B<--volgroups>
+
+=item B<--volume-groups>
+
+Display LVM volume groups.
+
+=item B<-x>
+
+Enable tracing of libguestfs API calls.
+
+=back
+
+=head1 COLUMNS
+
+Note that columns in the output are subject to reordering and change
+in future versions of this tool.
+
+=over 4
+
+=item B<Name>
+
+The filesystem, partition, block device or LVM name.
+
+For device and partition names these are displayed as canonical
+libguestfs names, so that for example C</dev/sda2> is the second
+partition on the first device.
+
+If the I<--long> option is B<not> specified, then only the name column
+is shown in the output.
+
+=item B<Type>
+
+The object type, for example C<filesystem>, C<lv>, C<device> etc.
+
+=item B<VFS>
+
+If there is a filesystem, then this column displays the filesystem
+type if one could be detected, eg. C<ext4>.
+
+=item B<Label>
+
+If the object has a label (used for identifying and mounting
+filesystems) then this column contains the label.
+
+=item B<MBR>
+
+The partition type byte, displayed as a two digit hexadecimal number.
+A comprehensive list of partition types can be found here:
+L<http://www.win.tue.nl/~aeb/partitions/partition_types-1.html>
+
+This is only applicable for DOS (MBR) partitions.
+
+=item B<Size>
+
+The size of the object in bytes.  If the I<--human> option is used
+then the size is displayed in a human-readable form.
+
+=item B<Parent>
+
+The parent column records the parent relationship between objects.
+
+For example, if the object is a partition, then this column contains
+the name of the containing device.  If the object is a logical volume,
+then this column is the name of the volume group.
+
+If there is more than one parent, then this column is (internal to the
+column) a comma-separated list, eg. C</dev/sda,/dev/sdb>.
+
+=item B<UUID>
+
+If the object has a UUID (used for identifying and mounting
+filesystems and block devices) then this column contains the UUID as a
+string.
+
+The UUID is only displayed if the I<--uuid> option is given.
+
+=back
+
+=head1 NOTE ABOUT CSV FORMAT
+
+Comma-separated values (CSV) is a deceptive format.  It I<seems> like
+it should be easy to parse, but it is definitely not easy to parse.
+
+Myth: Just split fields at commas.  Reality: This does I<not> work
+reliably.  This example has two columns:
+
+ "foo,bar",baz
+
+Myth: Read the file one line at a time.  Reality: This does I<not>
+work reliably.  This example has one row:
+
+ "foo
+ bar",baz
+
+For shell scripts, use C<csvtool> (L<http://merjis.com/developers/csv>
+also packaged in major Linux distributions).
+
+For other languages, use a CSV processing library (eg. C<Text::CSV>
+for Perl or Python's built-in csv library).
+
+Most spreadsheets and databases can import CSV directly.
+
+=head1 SHELL QUOTING
+
+Libvirt guest names can contain arbitrary characters, some of which
+have meaning to the shell such as C<#> and space.  You may need to
+quote or escape these characters on the command line.  See the shell
+manual page L<sh(1)> for details.
+
+=head1 EXIT STATUS
+
+This program returns 0 if successful, or non-zero if there was an
+error.
+
+=head1 SEE ALSO
+
+L<guestfs(3)>,
+L<guestfish(1)>,
+L<virt-cat(1)>,
+L<virt-df(1)>,
+L<virt-list-filesystems(1)>,
+L<virt-list-partitions(1)>,
+L<csvtool(1)>,
+L<http://libguestfs.org/>.
+
+=head1 AUTHOR
+
+Richard W.M. Jones L<http://people.redhat.com/~rjones/>
+
+=head1 COPYRIGHT
+
+Copyright (C) 2010 Red Hat Inc.
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

cat/virt-ls.pod

@@ -0,0 +1,527 @@
+=encoding utf8
+
+=head1 NAME
+
+virt-ls - List files in a virtual machine
+
+=head1 SYNOPSIS
+
+ virt-ls [--options] -d domname directory [directory ...]
+
+ virt-ls [--options] -a disk.img [-a disk.img ...] directory [directory ...]
+
+Old style:
+
+ virt-ls [--options] domname directory
+
+ virt-ls [--options] disk.img [disk.img ...] directory
+
+=head1 DESCRIPTION
+
+C<virt-ls> lists filenames, file sizes, checksums, extended attributes
+and more from a virtual machine or disk image.
+
+Multiple directory names can be given, in which case the output from
+each is concatenated.
+
+To list directories from a libvirt guest use the I<-d> option to
+specify the name of the guest.  For a disk image, use the I<-a>
+option.
+
+C<virt-ls> can do many simple file listings.  For more complicated
+cases you may need to use L<guestfish(1)>, or write a program directly
+to the L<guestfs(3)> API.
+
+=head1 EXAMPLES
+
+Get a list of all files and directories in a virtual machine:
+
+ virt-ls -R -d guest /
+
+List all setuid or setgid programs in a Linux virtual machine:
+
+ virt-ls -lR -d guest / | grep '^- [42]'
+
+List all public-writable directories in a Linux virtual machine:
+
+ virt-ls -lR -d guest / | grep '^d ...7'
+
+List all Unix domain sockets in a Linux virtual machine:
+
+ virt-ls -lR -d guest / | grep '^s'
+
+List all regular files with filenames ending in '.png':
+
+ virt-ls -lR -d guest / | grep -i '^-.*\.png$'
+
+To display files larger than 10MB in home directories:
+
+ virt-ls -lR -d guest /home | awk '$3 > 10*1024*1024'
+
+Find everything modified in the last 7 days:
+
+ virt-ls -lR -d guest --time-days / | awk '$6 <= 7'
+
+Find regular files modified in the last 24 hours:
+
+ virt-ls -lR -d guest --time-days / | grep '^-' | awk '$6 < 1'
+
+=head2 DIFFERENCES IN SNAPSHOTS AND BACKING FILES
+
+Find the differences between files in a guest and an earlier snapshot
+of the same guest.
+
+ virt-ls -lR -a snapshot.img / --uids --time-t > old
+ virt-ls -lR -a current.img / --uids --time-t > new
+ diff -u old new | less
+
+The commands above won't find files where the content has changed but
+the metadata (eg. file size and modification date) is the same.  To do
+that, you need to add the I<--checksum> parameter to both C<virt-ls>
+commands.  I<--checksum> can be quite slow since it has to read and
+compute a checksum of every regular file in the virtual machine.
+
+=head1 OUTPUT MODES
+
+C<virt-ls> has four output modes, controlled by different
+combinations of the I<-l> and I<-R> options.
+
+=head2 SIMPLE LISTING
+
+A simple listing is like the ordinary L<ls(1)> command:
+
+ $ virt-ls -d guest /
+ bin
+ boot
+ [etc.]
+
+=head2 LONG LISTING
+
+With the I<-l> (I<--long>) option, the output is like the C<ls -l>
+command (more specifically, like the C<guestfs_ll> function).
+
+ $ virt-ls -l -d guest /
+ total 204
+ dr-xr-xr-x.   2 root root   4096 2009-08-25 19:06 bin
+ dr-xr-xr-x.   5 root root   3072 2009-08-25 19:06 boot
+ [etc.]
+
+Note that while this is useful for displaying a directory, do not try
+parsing this output in another program.  Use L</RECURSIVE LONG LISTING>
+instead.
+
+=head2 RECURSIVE LISTING
+
+With the I<-R> (I<--recursive>) option, C<virt-ls> lists the names of
+files and directories recursively:
+
+ $ virt-ls -R -d guest /tmp
+ foo
+ foo/bar
+ [etc.]
+
+To generate this output, C<virt-ls> runs the C<guestfs_find0> function
+and converts C<\0> characters to C<\n>.
+
+=head2 RECURSIVE LONG LISTING
+
+Using I<-lR> options together changes the output to display
+directories recursively, with file stats, and optionally other
+features such as checksums and extended attributes.
+
+Most of the interesting features of C<virt-ls> are only available when
+using I<-lR> mode.
+
+The fields are normally space-separated.  Filenames are B<not> quoted,
+so you cannot use the output in another program (because filenames can
+contain spaces and other unsafe characters).  If the guest was
+untrusted and someone knew you were using C<virt-ls> to analyze the
+guest, they could play tricks on you by creating filenames with
+embedded newline characters.  To B<safely> parse the output in another
+program, use the I<--csv> (Comma-Separated Values) option.
+
+Note that this output format is completely unrelated to the C<ls -lR>
+command.
+
+ $ virt-ls -lR -d guest /bin
+ d 0555       4096 /bin
+ - 0755        123 /bin/alsaunmute
+ - 0755      28328 /bin/arch
+ l 0777          4 /bin/awk -> gawk
+ - 0755      27216 /bin/basename
+ - 0755     943360 /bin/bash
+ [etc.]
+
+These basic fields are always shown:
+
+=over 4
+
+=item type
+
+The file type, one of:
+C<-> (regular file),
+C<d> (directory),
+C<c> (character device),
+C<b> (block device),
+C<p> (named pipe),
+C<l> (symbolic link),
+C<s> (socket) or
+C<u> (unknown).
+
+=item permissions
+
+The Unix permissions, displayed as a 4 digit octal number.
+
+=item size
+
+The size of the file.  This is shown in bytes unless I<-h> or
+I<--human-readable> option is given, in which case this is shown as a
+human-readable number.
+
+=item path
+
+The full path of the file or directory.
+
+=item link
+
+For symbolic links only, the link target.
+
+=back
+
+In I<-lR> mode, additional command line options enable the display of
+more fields.
+
+With the I<--uids> flag, these additional fields are displayed before
+the path:
+
+=over 4
+
+=item uid
+
+=item gid
+
+The UID and GID of the owner of the file (displayed numerically).
+Note these only make sense in the context of a Unix-like guest.
+
+=back
+
+With the I<--times> flag, these additional fields are displayed:
+
+=over 4
+
+=item atime
+
+The time of last access.
+
+=item mtime
+
+The time of last modification.
+
+=item ctime
+
+The time of last status change.
+
+=back
+
+The time fields are displayed as string dates and times, unless one of
+the I<--time-t>, I<--time-relative> or I<--time-days> flags is given.
+
+With the I<--extra-stats> flag, these additional fields are displayed:
+
+=over 4
+
+=item device
+
+The device containing the file (displayed as major:minor).
+This may not match devices as known to the guest.
+
+=item inode
+
+The inode number.
+
+=item nlink
+
+The number of hard links.
+
+=item rdev
+
+For block and char special files, the device
+(displayed as major:minor).
+
+=item blocks
+
+The number of 512 byte blocks allocated to the file.
+
+=back
+
+With the I<--checksum> flag, the checksum of the file contents is
+shown (only for regular files).  Computing file checksums can take a
+considerable amount of time.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<--help>
+
+Display brief help.
+
+=item B<-a> file
+
+=item B<--add> file
+
+Add I<file> which should be a disk image from a virtual machine.  If
+the virtual machine has multiple block devices, you must supply all of
+them with separate I<-a> options.
+
+The format of the disk image is auto-detected.  To override this and
+force a particular format use the I<--format=..> option.
+
+=item B<--checksum>
+
+=item B<--checksum=crc|md5|sha1|sha224|sha256|sha384|sha512>
+
+Display checksum over file contents for regular files.  With no
+argument, this defaults to using I<md5>.  Using an argument, you can
+select the checksum type to use.
+
+This option only has effect in I<-lR> output mode.  See
+L</RECURSIVE LONG LISTING> above.
+
+=item B<-c> URI
+
+=item B<--connect> URI
+
+If using libvirt, connect to the given I<URI>.  If omitted, then we
+connect to the default libvirt hypervisor.
+
+If you specify guest block devices directly (I<-a>), then libvirt is
+not used at all.
+
+=item B<--csv>
+
+Write out the results in CSV format (comma-separated values).  This
+format can be imported easily into databases and spreadsheets, but
+read L</NOTE ABOUT CSV FORMAT> below.
+
+=item B<-d> guest
+
+=item B<--domain> guest
+
+Add all the disks from the named libvirt guest.  Domain UUIDs can be
+used instead of names.
+
+=item B<--echo-keys>
+
+When prompting for keys and passphrases, virt-ls normally turns
+echoing off so you cannot see what you are typing.  If you are not
+worried about Tempest attacks and there is no one else in the room you
+can specify this flag to see what you are typing.
+
+=item B<--extra-stats>
+
+Display extra stats.
+
+This option only has effect in I<-lR> output mode.  See
+L</RECURSIVE LONG LISTING> above.
+
+=item B<--format=raw|qcow2|..>
+
+=item B<--format>
+
+The default for the I<-a> option is to auto-detect the format of the
+disk image.  Using this forces the disk format for I<-a> options which
+follow on the command line.  Using I<--format> with no argument
+switches back to auto-detection for subsequent I<-a> options.
+
+For example:
+
+ virt-ls --format=raw -a disk.img /dir
+
+forces raw format (no auto-detection) for C<disk.img>.
+
+ virt-ls --format=raw -a disk.img --format -a another.img /dir
+
+forces raw format (no auto-detection) for C<disk.img> and reverts to
+auto-detection for C<another.img>.
+
+If you have untrusted raw-format guest disk images, you should use
+this option to specify the disk format.  This avoids a possible
+security problem with malicious guests (CVE-2010-3851).
+
+=item B<-h>
+
+=item B<--human-readable>
+
+Display file sizes in human-readable format.
+
+This option only has effect in I<-lR> output mode.  See
+L</RECURSIVE LONG LISTING> above.
+
+=item B<--keys-from-stdin>
+
+Read key or passphrase parameters from stdin.  The default is
+to try to read passphrases from the user by opening C</dev/tty>.
+
+=item B<-l>
+
+=item B<--long>
+
+=item B<-R>
+
+=item B<--recursive>
+
+Select the mode.  With neither of these options, C<virt-ls> produces a
+simple, flat list of the files in the named directory.  See
+L</SIMPLE LISTING>.
+
+C<virt-ls -l> produces a "long listing", which shows more detail.  See
+L</LONG LISTING>.
+
+C<virt-ls -R> produces a recursive list of files starting at the named
+directory.  See L</RECURSIVE LISTING>.
+
+C<virt-ls -lR> produces a recursive long listing which can be more
+easily parsed.  See L</RECURSIVE LONG LISTING>.
+
+=item B<--times>
+
+Display time fields.
+
+This option only has effect in I<-lR> output mode.  See
+L</RECURSIVE LONG LISTING> above.
+
+=item B<--time-days>
+
+Display time fields as days before now (negative if in the future).
+
+Note that C<0> in output means "up to 1 day before now", or that the
+age of the file is between 0 and 86399 seconds.
+
+This option only has effect in I<-lR> output mode.  See
+L</RECURSIVE LONG LISTING> above.
+
+=item B<--time-relative>
+
+Display time fields as seconds before now (negative if in the future).
+
+This option only has effect in I<-lR> output mode.  See
+L</RECURSIVE LONG LISTING> above.
+
+=item B<--time-t>
+
+Display time fields as seconds since the Unix epoch.
+
+This option only has effect in I<-lR> output mode.  See
+L</RECURSIVE LONG LISTING> above.
+
+=item B<--uids>
+
+Display UID and GID fields.
+
+This option only has effect in I<-lR> output mode.  See
+L</RECURSIVE LONG LISTING> above.
+
+=item B<-v>
+
+=item B<--verbose>
+
+Enable verbose messages for debugging.
+
+=item B<-V>
+
+=item B<--version>
+
+Display version number and exit.
+
+=item B<-x>
+
+Enable tracing of libguestfs API calls.
+
+=back
+
+=head1 OLD-STYLE COMMAND LINE ARGUMENTS
+
+Previous versions of virt-ls allowed you to write either:
+
+ virt-ls disk.img [disk.img ...] /dir
+
+or
+
+ virt-ls guestname /dir
+
+whereas in this version you should use I<-a> or I<-d> respectively
+to avoid the confusing case where a disk image might have the same
+name as a guest.
+
+For compatibility the old style is still supported.
+
+=head1 NOTE ABOUT CSV FORMAT
+
+Comma-separated values (CSV) is a deceptive format.  It I<seems> like
+it should be easy to parse, but it is definitely not easy to parse.
+
+Myth: Just split fields at commas.  Reality: This does I<not> work
+reliably.  This example has two columns:
+
+ "foo,bar",baz
+
+Myth: Read the file one line at a time.  Reality: This does I<not>
+work reliably.  This example has one row:
+
+ "foo
+ bar",baz
+
+For shell scripts, use C<csvtool> (L<http://merjis.com/developers/csv>
+also packaged in major Linux distributions).
+
+For other languages, use a CSV processing library (eg. C<Text::CSV>
+for Perl or Python's built-in csv library).
+
+Most spreadsheets and databases can import CSV directly.
+
+=head1 SHELL QUOTING
+
+Libvirt guest names can contain arbitrary characters, some of which
+have meaning to the shell such as C<#> and space.  You may need to
+quote or escape these characters on the command line.  See the shell
+manual page L<sh(1)> for details.
+
+=head1 EXIT STATUS
+
+This program returns 0 if successful, or non-zero if there was an
+error.
+
+=head1 SEE ALSO
+
+L<guestfs(3)>,
+L<guestfish(1)>,
+L<virt-cat(1)>,
+L<virt-copy-out(1)>,
+L<virt-tar-out(1)>,
+L<Sys::Guestfs(3)>,
+L<Sys::Guestfs::Lib(3)>,
+L<Sys::Virt(3)>,
+L<http://libguestfs.org/>.
+
+=head1 AUTHOR
+
+Richard W.M. Jones L<http://people.redhat.com/~rjones/>
+
+=head1 COPYRIGHT
+
+Copyright (C) 2009-2012 Red Hat Inc.
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

cfg.mk

@@ -27,47 +27,27 @@ url_dir_list = \
 # Tests not to run as part of "make distcheck".
 local-checks-to-skip =			\
   sc_po_check				\
-  changelog-check			\
-  check-AUTHORS				\
-  makefile-check			\
-  makefile_path_separator_check		\
-  patch-check				\
   sc_GPL_version			\
-  sc_always_defined_macros		\
-  sc_cast_of_alloca_return_value	\
-  sc_dd_max_sym_length			\
   sc_error_exit_success			\
   sc_file_system			\
-  sc_immutable_NEWS			\
   sc_makefile_path_separator_check	\
   sc_obsolete_symbols			\
-  sc_prohibit_S_IS_definition		\
   sc_prohibit_atoi_atof			\
-  sc_prohibit_jm_in_m4			\
   sc_prohibit_quote_without_use		\
   sc_prohibit_quotearg_without_use	\
   sc_prohibit_stat_st_blocks		\
-  sc_prohibit_strcmp_and_strncmp	\
-  sc_prohibit_strcmp			\
-  sc_root_tests				\
   sc_space_tab				\
-  sc_sun_os_names			\
-  sc_system_h_headers			\
-  sc_tight_scope			\
   sc_two_space_separator_in_usage	\
   sc_error_message_uppercase		\
   sc_program_name			\
-  sc_require_test_exit_idiom		\
-  sc_makefile_check			\
   $(disable_temporarily)		\
   sc_useless_cpp_parens
 
 disable_temporarily =			\
+  sc_makefile_check			\
   sc_unmarked_diagnostics		\
   sc_prohibit_ctype_h			\
   sc_prohibit_asprintf			\
-  sc_m4_quote_check			\
-  sc_avoid_ctype_macros			\
   sc_avoid_write
 
 # Avoid uses of write(2).  Either switch to streams (fwrite), or use
@@ -120,16 +100,16 @@ sc_avoid_ctype_macros:
 		1>&2; exit 1; } || :
 
 sc_prohibit_virBufferAdd_with_string_literal:
-	@re='\<virBufferAdd *\([^,]+, *"[^"]'				\
-	msg='use virBufferAddLit, not virBufferAdd, with a string literal' \
-	  $(_prohibit_regexp)
+	@prohibit='\<virBufferAdd *\([^,]+, *"[^"]'			\
+	halt='use virBufferAddLit, not virBufferAdd, with a string literal' \
+	  $(_sc_search_regexp)
 
 # Not only do they fail to deal well with ipv6, but the gethostby*
 # functions are also not thread-safe.
 sc_prohibit_gethostby:
-	@re='\<gethostby(addr|name2?) *\('				\
-	msg='use getaddrinfo, not gethostby*'				\
-	  $(_prohibit_regexp)
+	@prohibit='\<gethostby(addr|name2?) *\('			\
+	halt='use getaddrinfo, not gethostby*'				\
+	  $(_sc_search_regexp)
 
 # Disallow trailing blank lines.
 sc_prohibit_trailing_blank_lines:
@@ -152,7 +132,9 @@ ifeq (0,$(MAKELEVEL))
   # submodule name.  Contrast these:
   # -b653eda3ac4864de205419d9f41eec267cb89eeb .gnulib
   #  b653eda3ac4864de205419d9f41eec267cb89eeb .gnulib (v0.0-2286-gb653eda)
-  _submodule_hash = sed 's/.//;s/ .*//'
+  # $ cat .git-module-status
+  # b653eda3ac4864de205419d9f41eec267cb89eeb
+  _submodule_hash = sed 's/^[ +-]//;s/ .*//'
   _update_required := $(shell						\
       actual=$$(git submodule status | $(_submodule_hash));		\
       stamp="$$($(_submodule_hash) $(_curr_status) 2>/dev/null)";	\

contrib/README

@@ -1,15 +1,28 @@
-centos5.3-libguestfs.spec
-        [REMOVED]
-        This used to be a centos5.3 specfile.  Please use the specfile
-        from EL-5 here:
-        http://cvs.fedoraproject.org/viewvc/rpms/libguestfs/EL-5/
+Random contributions and things which don't fit in anywhere else
+----------------------------------------------------------------------
 
-febootstrap/
-        An experimental, non-working attempt to use febootstrap
-        to install operating systems.
+autobuild/
+        The autobuild script that we use to build and test the
+        tarballs on Debian and elsewhere.
 
-fedora-libguestfs.spec
-        [REMOVED]
-        This used to be a Fedora 10+ specfile.  Please use the specfile
-        from Fedora instead:
-        http://cvs.fedoraproject.org/viewvc/rpms/libguestfs/devel/
+guestfsd-in-wine.sh
+        Run a Windows-compiled guestfsd under Wine.  Read the
+        instructions at the top of this file carefully.
+
+intro/ "Slides" for an intro to libguestfs.  This is a short (10-15
+        min) talk that I give to introduce the main features of
+        libguestfs.  The slides are in the form of a complete
+        self-contained HTML page with a handful images that can be
+        easily distributed before the talk.
+
+make-check-on-installed.pl
+        This Perl script allows you to run the test suite (ie.  'make
+        check', 'make extra-tests' etc) on an installed RPM.  This is
+        useful for adding another layer of testing to packages before
+        we release them.  Note that a checked out copy of the source
+        from git is required.  Read the top of the file before using.
+
+visualize-alignment/
+        Tests for visualizing block device reads and writes and
+        alignment using a patched qemu.  See the README file in that
+        directory.

contrib/autobuild/autobuild.sh

@@ -0,0 +1,109 @@
+#!/bin/bash -
+# libguestfs autobuild script
+# Copyright (C) 2009-2012 Red Hat Inc.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+# This script is used to download and test the latest tarball on
+# Debian and other platforms.  It runs from a cron job and sends email
+# to the mailing list about the status.
+
+set -e
+
+# Subject line of email prefix.
+prefix="${1:-[autobuild]}"
+
+# Where we send mail.
+mailto="rjones@redhat.com"
+
+# Move to temporary directory for building.
+tmpdir="$(mktemp -d --tmpdir=/var/tmp)"
+cd "$tmpdir"
+
+# The libguestfs index page contains some hidden fields to help us
+# find the latest version programmatically.
+version=$(wget --no-cache -O- -q http://libguestfs.org |
+          grep '^LATEST-VERSION:' | awk '{print $2}')
+url=$(wget --no-cache -O- -q http://libguestfs.org |
+      grep '^LATEST-URL:' | awk '{print $2}')
+filename=$(basename "$url")
+directory=$(basename "$url" .tar.gz)
+
+echo "--------------------------------------------------"
+echo "prefix     $prefix"
+echo "libguestfs $version"
+echo "url        $url"
+echo "build dir  $tmpdir/$directory"
+echo "--------------------------------------------------"
+
+# Grab the latest tarball from upstream.
+wget "$url"
+
+# Unpack the tarball.
+tar zxf "$filename"
+
+# Enter directory.
+cd "$directory"
+
+# This function is called if any step fails.
+failed ()
+{
+    tail -100 ../build.log > ../build.log.tail
+    mutt -s "$prefix libguestfs $version FAILED $1" "$mailto" -a ../build.log.tail <<EOF
+Autobuild failed.  The last 100 lines of the build log are
+attached.
+
+For the full log see the build machine, in
+$tmpdir/build.log
+EOF
+    rm ../build.log.tail
+}
+
+# This function is called if the build is successful.
+ok ()
+{
+    mutt -s "$prefix libguestfs $version ok" "$mailto" <<EOF
+Autobuild was successful.
+
+For the full log see the build machine, in
+$tmpdir/build.log
+EOF
+}
+
+# Ensure that we get full debugging output.
+export LIBGUESTFS_DEBUG=1
+export LIBGUESTFS_TRACE=1
+
+# Configure and build.
+echo "configure"
+./configure > ../build.log 2>&1 || {
+    failed "configure"
+    exit 1
+}
+echo "make"
+make >> ../build.log 2>&1 || {
+    failed "make"
+    exit 1
+}
+
+# Run the tests.
+echo "make check"
+make check >> ../build.log 2>&1 || {
+    failed "make check"
+    exit 1
+}
+
+echo "finished"
+ok

contrib/febootstrap/install.html

@@ -1,21 +0,0 @@
-<p>
-This script shows how to make a fresh virtual machine, installing an
-operating system like Fedora or some Red Hat-derived operating system
-such as <a href="http://www.redhat.com/rhel/">Red Hat Enterprise
-Linux</a> or <a href="http://centos.org/">CentOS</a>.
-</p>
-
-<p>
-It's fairly easy to modify this script to install Debian derivatives
-too (even from a Fedora host),
-using <a href="http://packages.debian.org/stable/admin/debootstrap">debootstrap</a>.
-</p>
-
-<p>
-<i>After</i> running the script, you can boot the new virtual
-machine by doing:
-</p>
-
-<pre>
-qemu-kvm -m 512 -hda /tmp/vm.img
-</pre>

contrib/febootstrap/install.sh

@@ -1,39 +0,0 @@
-#!/bin/sh -
-
-#vm=/tmp/vm.img
-vm=/mnt/share/tmp/vm.img
-
-modules="--group-install Core -i kernel -i grub"
-
-# Choose one:
-#febootstrap $modules fedora-10 local
-febootstrap $modules fedora-11 local
-#febootstrap $modules centos-5 local http://mirror.centos.org/centos-5/5.3/os/i386/
-
-tar zcf local.tar.gz local
-#rm -rf local
-
-guestfish <<EOF
-#alloc $vm 8GB
-add $vm
-run
-sfdisk /dev/sda 0 0 0 ',100 ,'
-echo Size of /dev/sda1:
-blockdev-getsize64 /dev/sda1
-echo Size of /dev/sda2:
-blockdev-getsize64 /dev/sda2
-lvm-remove-all
-pvcreate /dev/sda2
-vgcreate VG /dev/sda2
-lvcreate Root VG 6000
-lvcreate Swap VG 500
-mkfs ext3 /dev/sda1
-mkfs ext3 /dev/VG/Root
-mount /dev/VG/Root /
-mkdir /boot
-mount /dev/sda1 /boot
-tgz-in local.tar.gz /
-grub-install / /dev/sda
-EOF
-
-#rm local.tar.gz

contrib/febootstrap/install.title

@@ -1 +0,0 @@
-Fresh install of Fedora or a Red Hat-derived operating system

contrib/guestfsd-in-wine.sh

@@ -0,0 +1,117 @@
+#!/bin/bash -
+# Copyright (C) 2009 Red Hat Inc.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+# INSTRUCTIONS
+#----------------------------------------------------------------------
+#
+# This is a QEMU wrapper script that allows you to run a
+# Windows-compiled guestfsd.exe (daemon) under Wine from a Linux main
+# program.  You need to read and understand all the instructions below
+# before use.
+#
+# To understand how to compile the daemon for Windows, please read:
+# http://www.redhat.com/archives/libguestfs/2009-November/msg00255.html
+#
+# Adjust the Wine configuration so it can find the libraries, as
+# described here:
+# http://fedoraproject.org/wiki/MinGW/Configure_wine
+#
+# On Fedora 13 there is a serious bug in Wine.  See:
+# https://bugzilla.redhat.com/show_bug.cgi?id=533806#c11
+#
+# If necessary, adjust the line 'guestfsd=...' below so it points to
+# the correct location of the guestfsd.exe program.  You can use an
+# absolute path here if you want.
+guestfsd=daemon/guestfsd.exe
+#
+# This script is a QEMU wrapper.  It pretends to be qemu as far as
+# libguestfs programs are concerned.  Read this to understand the
+# purpose of QEMU wrappers:
+# http://libguestfs.org/guestfs.3.html#qemu_wrappers
+#
+# With this script, the qemu program is not actually run.  Instead we
+# pretend to be qemu, parse out the necessary parts of the long
+# command line that libguestfs passes to qemu, and run the Windows
+# daemon, under Wine, with the right command line.  The Windows daemon
+# then hopefully connects back to the libguestfs socket, and as far as
+# the libguestfs program is concerned, it looks like a full appliance
+# is running.
+#
+# To use this script, you must set the environment variable
+# LIBGUESTFS_QEMU=/path/to/contrib/guestfsd-in-wine.sh (ie. the path
+# to this script).
+#
+# You can then run libguestfs test programs, and (hopefully!) they'll
+# use the Windows guestfsd.exe, simulating calls using Wine.
+#
+# For example from the top build directory:
+#
+# LIBGUESTFS_QEMU=contrib/guestfsd-in-wine.sh ./run ./fish/guestfish
+#
+# Another suggested environment variable is LIBGUESTFS_DEBUG=1 which
+# will give you must more detail about what is going on.  Also look at
+# the contents of the log file 'guestfsd-in-wine.log' after each run.
+#
+#----------------------------------------------------------------------
+
+# Note that stdout & stderr messages will get eaten by libguestfs
+# early on in the process.  Therefore write log messages to
+# a log file.
+exec 5>>guestfsd-in-wine.log
+echo "Environment:" >&5
+printenv | grep LIBGUESTFS >&5
+echo "Command line:" >&5
+echo "  $@" >&5
+
+# We're called several times, first with -help and -version, and we
+# have to pretend to be qemu!  (At least enough to trick libguestfs).
+if [ "$1" = "-help" ]; then
+    echo -- "  -net user  "
+    echo -- "  -no-hpet  "
+    echo -- "  -rtc-td-hack  "
+    exit 0
+elif [ "$1" = "-version" ]; then
+    echo -- "0.0.0"
+    exit 0
+fi
+
+# The interesting parameter is -append.
+append=
+while [ $# -gt 0 ]; do
+    if [ $1 = "-append" ]; then
+        append="$2"
+        shift
+    fi
+    shift
+done
+echo "Append parameter:" >&5
+echo "  $append" >&5
+
+# guestfs_vmchannel parameter.
+vmchannel_param=$(echo "$append" | grep -Eo 'guestfs_vmchannel=[^[:space:]]+')
+echo "Vmchannel parameter:" >&5
+echo "  $vmchannel_param" >&5
+
+# Port number.
+port=$(echo "$vmchannel_param" | grep -Eo '[[:digit:]]+$')
+echo "Port number:" >&5
+echo "  $vmchannel_param" >&5
+
+# Run guestfsd.exe.
+echo "Command:" >&5
+echo "  $guestfsd -f -v -c tcp:localhost:$port" >&5
+$guestfsd -f -v -c tcp:127.0.0.1:$port

contrib/intro/libguestfs-intro.html

@@ -0,0 +1,400 @@
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/>
+    <title>Short introduction to libguestfs</title>
+    <style>
+      body {
+        counter-reset: chapter;
+      }
+
+      body > p, body > img, body > pre, body > table {
+        margin-left: 2em;
+      }
+
+      h1 {
+        color: rgb(204,0,0);
+        font-size: 130%;
+        border-bottom: 1px solid rgb(204,0,0);
+      }
+      author {
+        display: block;
+        position: absolute;
+        right: 2em;
+        top: 1em;
+        font-size: 80%;
+        text-align: right;
+      }
+
+      h2 {
+        margin-top: 4em;
+        color: rgb(204,0,0);
+        counter-increment: chapter;
+        counter-reset: section;
+      }
+      h2:before {
+        font-size: 80%;
+        color: #666;
+        content: counter(chapter) " ... ";
+      }
+
+      pre {
+        background-color: #fcfcfc;
+        border-top: 1px dotted #eee;
+        border-bottom: 1px dotted #eee;
+        border-left: 2px solid rgb(204,0,0);
+        padding: 5px;
+        margin-left: 1em;
+      }
+
+      p.sourcelnk {
+        text-align: left;
+        font-size: 70%;
+      }
+    </style>
+  </head>
+  <body>
+    <h1>Short introduction to libguestfs</h1>
+    <author>by Richard W.M. Jones &lt;rjones@redhat.com&gt;</author>
+
+    <h2>The Idea</h2>
+
+    <p><b>Reuse qemu, Linux kernel and userspace tools</b> to read and
+    write disk images.</p>
+
+    <object type="image/svg+xml" data="overview.svg">
+      <img src="overview.png"/> <!-- fallback for lame IE -->
+    </object>
+
+    <h2>The Stable API</h2>
+
+<pre>
+  /* get the Linux VFS type corresponding to a mounted device */
+extern char *<b>guestfs_vfs_type</b> (guestfs_h *g, const char *device);
+</pre>
+
+<table style="margin-bottom: 4em;" width="100%">
+  <tr><td valign="top">Example using this API:</td><td>
+<pre>
+#include &lt;guestfs.h&gt;
+
+char *fstype = <b>guestfs_vfs_type (g, "/dev/vda1")</b>;
+printf ("%s\n", fstype);
+free (fstype);
+&rarr; <b>ntfs</b>
+</pre>
+<p class="sourcelnk"><a href="http://git.annexia.org/?p=libguestfs.git;a=blob;f=fish/inspect.c;h=2ca54d2296fce5370504c1085cbcd7ac1b51ad3a;hb=HEAD#l208">click&nbsp;to&nbsp;see&nbsp;a&nbsp;real&nbsp;example&nbsp;...</a></p>
+    </td>
+  </tr>
+</table>
+
+    <table width="100%">
+      <tr><td valign="top">
+
+<pre>
+  ("<b>vfs_type</b>",
+   (RString "fstype",
+        [Device "device"], []),
+   198, [],
+   [ (* tests *) ],
+   "get the Linux VFS type corresponding to a mounted device",
+   "\
+This command gets the filesystem type corresponding to
+the filesystem on C&lt;device&gt;.
+
+For most filesystems, the result is the name of the Linux
+VFS module which would be used to mount this filesystem
+if you mounted it without specifying the filesystem type.
+For example a string such as C&lt;ext3&gt; or C&lt;ntfs&gt;.");
+</pre>
+<p class="sourcelnk"><a href="http://git.annexia.org/?p=libguestfs.git;a=blob;f=generator/generator_actions.ml;h=d3fa3e0b939eb047a5ff103a68f09c6898807748;hb=HEAD#l4775">full&nbsp;source&nbsp;...</a></p>
+
+        </td>
+        <td valign="top">
+
+<pre>
+char *
+<b>do_vfs_type</b> (const char *device)
+{
+  return get_blkid_tag (device, "TYPE");
+}
+
+static char *
+get_blkid_tag (const char *device, const char *tag)
+{
+  char *out, *err;
+  int r;
+
+  r = commandr (&amp;out, &amp;err,
+                "blkid",
+                "-c", "/dev/null",
+                "-o", "value", "-s", tag, device, NULL);
+  if (r != 0 &amp;&amp; r != 2) {
+    if (r &gt;= 0)
+      reply_with_error ("%s: %s (blkid returned %d)",
+                        device, err, r);
+    else
+      reply_with_error ("%s: %s", device, err);
+    free (out);
+    free (err);
+    return NULL;
+  }
+
+  /* ... */
+
+  return out;             /* caller frees */
+}
+</pre>
+<p class="sourcelnk"><a href="http://git.annexia.org/?p=libguestfs.git;a=blob;f=daemon/blkid.c;hb=HEAD">full&nbsp;source&nbsp;...</a></p>
+
+        </td>
+      </tr>
+    </table>
+
+    <p>
+      Just these two fragments generate:
+    </p>
+
+    <ul>
+      <li> bindings in <a href="http://libguestfs.org/guestfs.3.html#api_overview">C</a>,
+        <a href="http://libguestfs.org/guestfs-perl.3.html">Perl</a>,
+        <a href="http://libguestfs.org/guestfs-python.3.html">Python</a>,
+        <a href="http://libguestfs.org/guestfs-ruby.3.html">Ruby</a>,
+        <a href="http://libguestfs.org/guestfs-java.3.html">Java</a>,
+        <a href="http://libguestfs.org/guestfs-ocaml.3.html">OCaml</a>,
+        PHP,
+        Haskell,
+        <a href="http://libguestfs.org/guestfs-erlang.3.html">Erlang</a>
+        and C# </li>
+      <li> <a href="http://libguestfs.org/guestfish.1.html">guestfish</a>
+        (shell script) </li>
+      <li> documentation in man pages and HTML </li>
+      <li> internal RPC code </li>
+    </ul>
+
+    <h2>Tools written around the API</h2>
+
+    <object type="image/svg+xml" data="tools.svg">
+      <img src="tools.png"/> <!-- fallback for lame IE -->
+    </object>
+
+    <table>
+      <tr><td valign="top" style="padding-bottom: 1.5em;" colspan="2">
+<pre>
+<b>guestfish -N bootrootlv:/dev/VG/LV:ext4:ext4:10G:256M &lt;&lt;EOF</b>
+  <font style="color: green;">mount-options "" /dev/VG/LV /
+  mkdir /boot
+  mount-options "" /dev/sda1 /boot
+  txz-in filesystem.tar.xz /
+  write /etc/HOSTNAME "test01.example.com\n"
+  upload /etc/resolv.conf /etc/resolv.conf</font>
+<b>EOF</b>
+<b>guestmount -a test1.img -i mnt/</b>
+<b>ls mnt</b>
+bin   dev  home        lib         mnt       proc  sbin  tmp  var
+boot  etc  initrd.img  lost+found  old-root  root  sys   usr  vmlinuz
+<b>cat mnt/etc/HOSTNAME</b>
+test01.example.com
+<b>fusermount -u mnt</b>
+</pre>
+<p class="sourcelnk"><a href="http://libguestfs.org/guestfish.1.html">manual&nbsp;for&nbsp;guestfish&nbsp;...</a> <br/>
+<a href="http://libguestfs.org/guestmount.1.html">manual&nbsp;for&nbsp;guestmount&nbsp;...</a></p>
+      </td></tr>
+      <tr><td valign="top" style="padding-bottom: 1.5em;">
+<pre>
+<b>virt-df -a /dev/vg/F15x32 -h</b>
+Filesystem                    Size  Used Available Use%
+F15x32:/dev/sda1              484M   31M      428M   7%
+F15x32:/dev/vg_f15x32/lv_root 5.5G  3.4G      1.8G  63%
+</pre>
+<p class="sourcelnk"><a href="http://libguestfs.org/virt-df.1.html">manual&nbsp;...</a></p>
+        </td>
+        <td valign="top" style="padding-bottom: 1.5em;">
+<pre>
+<b>virt-cat -c qemu:///system -d WinXP 'c:\boot.ini'</b>
+[boot loader]
+timeout=30
+default=multi(0)disk(0)rdisk(0)partition(1)\WINDOWS
+[operating systems]
+multi(0)disk(0)rdisk(0)partition(1)\WINDOWS=
+"Microsoft Windows XP Professional" /noexecute=optin
+/fastdetect
+</pre>
+<p class="sourcelnk"><a href="http://libguestfs.org/virt-cat.1.html">manual&nbsp;...</a></p>
+      </td></tr>
+      <tr><td valign="top" style="padding-bottom: 1.5em;">
+<pre>
+<b>virt-edit -c qemu:///system -d F15x32 /etc/passwd</b>
+<i>(launches text editor to edit guest /etc/passwd)</i>
+
+<b>virt-edit -c qemu:///system -d F15x32 /etc/passwd \
+  -e 's/^root:.*?:/root::/'</b>
+</pre>
+<p class="sourcelnk"><a href="http://libguestfs.org/virt-edit.1.html">manual&nbsp;...</a></p>
+        </td><td valign="top" style="padding-bottom: 1.5em;">
+<pre>
+<b>virt-win-reg -c qemu:///system --unsafe-printable-strings \
+  Win7x32 'HKLM\SYSTEM\ControlSet001\Services\Tcpip\Parameters' \
+  | grep DhcpIPAddress</b>
+"DhcpIPAddress"=str(1):"192.168.122.178"
+</pre>
+<p class="sourcelnk"><a href="http://libguestfs.org/virt-win-reg.1.html">manual&nbsp;...</a></p>
+      </td></tr>
+    </table>
+
+    <h2>Inspection</h2>
+
+<pre>
+$ <b>virt-filesystems -c qemu:///system -d Win7x32 --all --long -h --uuid</b>
+Name      Type       VFS  Label           MBR Size Parent   UUID
+/dev/sda1 filesystem ntfs System Reserved -   100M -        F81C92571C92112C
+/dev/sda2 filesystem ntfs -               -   20G  -        F2E8996AE8992E3B
+/dev/sda1 partition  -    -               07  100M /dev/sda -
+/dev/sda2 partition  -    -               07  20G  /dev/sda -
+/dev/sda  device     -    -               -   20G  -        -
+</pre>
+<p class="sourcelnk">
+<a href="http://libguestfs.org/virt-filesystems.1.html">manual&nbsp;...</a>
+</p>
+
+<pre>
+$ <b>virt-inspector -c qemu:///system -d Win7x32</b>
+<font style="color: #888;">&lt;?xml version="1.0"?&gt;</font>
+<font style="color: #888;">&lt;operatingsystems&gt;</font>
+  <font style="color: #888;">&lt;operatingsystem&gt;</font>
+    <font style="color: #888;">&lt;root&gt;</font>/dev/sda2<font style="color: #888;">&lt;/root&gt;</font>
+    <font style="color: #888;">&lt;name&gt;</font>windows<font style="color: #888;">&lt;/name&gt;</font>
+    <font style="color: #888;">&lt;arch&gt;</font>i386<font style="color: #888;">&lt;/arch&gt;</font>
+    <font style="color: #888;">&lt;distro&gt;</font>windows<font style="color: #888;">&lt;/distro&gt;</font>
+    <font style="color: #888;">&lt;product_name&gt;</font>Windows 7 Enterprise<font style="color: #888;">&lt;/product_name&gt;</font>
+    <font style="color: #888;">&lt;product_variant&gt;</font>Client<font style="color: #888;">&lt;/product_variant&gt;</font>
+    <font style="color: #888;">&lt;major_version&gt;</font>6<font style="color: #888;">&lt;/major_version&gt;</font>
+    <font style="color: #888;">&lt;minor_version&gt;</font>1<font style="color: #888;">&lt;/minor_version&gt;</font>
+    <font style="color: #888;">&lt;windows_systemroot&gt;</font>/Windows<font style="color: #888;">&lt;/windows_systemroot&gt;</font>
+    <font style="color: #888;">&lt;windows_current_control_set&gt;</font>ControlSet001<font style="color: #888;">&lt;/windows_current_control_set&gt;</font>
+    <font style="color: #888;">&lt;hostname&gt;</font>win7x32<font style="color: #888;">&lt;/hostname&gt;</font>
+<i>... etc ...</i>
+</pre>
+<p class="sourcelnk">
+<a href="win7.xml">full&nbsp;XML&nbsp;...</a> <br/>
+<a href="http://libguestfs.org/virt-inspector.1.html">manual&nbsp;...</a>
+</p>
+
+<pre>
+  char **roots;
+  size_t i;
+  char *type, *distro, *product_name;
+  int major, minor;
+
+  roots = <b>guestfs_inspect_os</b> (g);
+
+  if (roots == NULL)
+    exit (EXIT_FAILURE);
+
+  if (roots[0] == NULL) {
+    fprintf (stderr, "no operating systems found\n");
+    exit (EXIT_FAILURE);
+  }
+
+  for (i = 0; roots[i] != NULL; ++i) {
+    type = <b>guestfs_inspect_get_type</b> (g, roots[i]);
+    distro = <b>guestfs_inspect_get_distro</b> (g, roots[i]);
+    product_name = <b>guestfs_inspect_get_product_name</b> (g, roots[i]);
+    major = <b>guestfs_inspect_get_major_version</b> (g, roots[i]);
+    minor = <b>guestfs_inspect_get_minor_version</b> (g, roots[i]);
+
+    printf ("Root: %s\n"
+            "  Type: %s\n"
+            "  Distro: %s\n"
+            "  Version: %d.%d\n"
+            "  Product name: %s\n\n");
+            roots[i],
+            type ? : "unknown", distro ? : "unknown", major, minor,
+            product_name ? : "");
+
+    free (type);
+    free (distro);
+    free (product_name);
+    free (roots[i]);
+  }
+
+  free (roots);
+</pre>
+<p class="sourcelnk"><a href="http://git.annexia.org/?p=libguestfs.git;a=blob;f=rescue/virt-rescue.c;h=0c0036460434f1365d9591d6b2b805d999b07056;hb=HEAD#l351">full&nbsp;source&nbsp;...</a></p>
+
+    <table>
+      <tr><td colspan="2" align="middle">
+          <small><i>Click to enlarge the images</i></small>
+      </td></tr>
+      <tr><td width="50%">
+          <a href="virt-manager.png"><img src="virt-manager-t.png"></a>
+        </td><td width="50%" align="middle" valign="top">
+          <a href="vmm-icons.png"><img src="vmm-icons-t.png"></a>
+      </td></tr>
+    </table>
+
+
+
+
+    <h2>Graphical browsers</h2>
+
+    <p>
+    <img src="https://rwmj.files.wordpress.com/2011/07/guestfs-browser1.png?w=438&h=450"/>
+    </p>
+
+    <p>
+    <img src="https://rwmj.files.wordpress.com/2011/07/guestfs-browser2.png?w=438&h=450"/>
+    </p>
+
+    <p>
+    <img src="https://rwmj.files.wordpress.com/2011/07/guestfs-browser3.png?w=366&h=450"/>
+    </p>
+
+    <p>
+    <img src="https://rwmj.files.wordpress.com/2011/07/guestfs-browser4.png?w=366&h=450"/>
+    </p>
+    <p class="sourcelnk"><a href="https://rwmj.wordpress.com/2011/07/29/some-screenshots-from-the-new-guest-filesystem-browser/">source&nbsp;...</a></p>
+
+    <p>
+    <img src="https://rwmj.files.wordpress.com/2009/11/file-browser.png?w=500"/>
+    </p>
+    <p class="sourcelnk"><a href="https://rwmj.wordpress.com/2009/11/03/browsing-guests-using-fuse/">source&nbsp;...</a></p>
+
+
+
+    <h2>Find out more ...</h2>
+
+    <p>
+      <a href="http://libguestfs.org/">libguestfs.org</a> is the
+      main website.
+    </p>
+
+    <p>
+      <a href="http://libguestfs.org/guestfs.3.html">guestfs(3)</a>
+      is the manual page documenting the C API and the internals.
+    </p>
+
+    <p>
+      There are manual pages
+      documenting <a href="http://libguestfs.org/guestfish.1.html">guestfish</a>, <a href="http://libguestfs.org/guestmount.1.html">guestmount</a>
+      and each virt tool.  See
+      the <a href="http://libguestfs.org/">main website</a> or your
+      local man command.
+    </p>
+
+    <p>
+      For information about virt-v2v and virt-p2v, see
+      <a href="http://libguestfs.org/virt-v2v/">http://libguestfs.org/virt-v2v/</a>
+    </p>
+
+    <hr/>
+
+    <p style="font-size: 70%;">
+      This page &copy; 2011 Red Hat Inc. and distributed
+      under the terms of the GNU General Public License as published by
+      the Free Software Foundation; either version 2 of the License, or
+      (at your option) any later version.
+    </p>
+
+  </body>
+</html>

contrib/intro/talk.txt

@@ -0,0 +1,162 @@
+This is a short (10-15 min) talk that I give to introduce the main
+features of libguestfs.  The "slides" are in the form of a complete
+self-contained HTML page with a handful images that can be easily
+distributed before the talk.
+
+----------------------------------------------------------------------
+
+[1 The Idea]
+
+The "big idea" behind libguestfs is to read and write disk
+images by reusing all the qemu, Linux kernel and userspace
+code.
+
+This gives us tremendous power in a relatively small
+library: we can handle all Linux filesystems, all Windows
+filesystems, LVM, BSD, containers like raw and qcow, CD ISOs,
+USB keys, regular hard disks, and lots more.
+
+If you give us a btrfs filesystem in a BSD partition wrapped
+in a qcow2 file -- that is something we can handle.
+
+libguestfs -- as the name suggests -- is a plain, ordinary
+shared library written in C that you can link to C programs.
+You're all very smart people and you will have guessed
+already that we don't in fact run qemu as a library inside
+libguestfs as this diagram suggests.  Instead we fork
+qemu or KVM, running a small "appliance" which has
+the usual kernel, a small Linux distribution with tools
+like mkfs, lvcreate and parted, and a libguestfs daemon.
+The library and the daemon talk to each other over a
+virtio-serial connection.
+
+The qemu instance is connected to the disks we are
+examining using the ordinary qemu -drive option.
+
+[2 The Stable API]
+
+Consider how you might send commands to the daemon.
+Example: Create a filesystem (mkfs).
+
+One thing you might do is to send shell commands over
+the virtio-serial connection.  It would send "mkfs -t ..."
+
+This is something that is possible using the libguestfs
+API, but we don't encourage it.  There are three reasons
+why we don't encourage and support this: one is that
+because we're calling this from a C program, it's hard
+to construct shell commands.
+Secondly it's hard to parse the result from commands
+(think about parted or lvs which are two commands that
+produce quite complex output that is hard to parse).
+Thirdly the command line isn't very long-term stable,
+with some commands appearing and changing over time.
+
+I'd emphasize again that we do let you send shell
+commands over to the daemon if that's what you want to do.
+
+What we support, though, is a long-term stable API and ABI.
+It's slightly (but not very much) higher level than shell
+commands.
+
+I've got an example on the page.  This is the guestfs_vfs_type
+API which returns the name of the filesystem on a device.
+
+Like libvirt, we are serious about the long term stability
+of the API and ABI, and if you write your program against
+this API, you'll never have to change the program or even
+recompile it.
+
+Because there are 100s of commands that you might want to
+run, we made it exceptionally simple to add new APIs.
+Shown below is the actual code used to implement "vfs-type".
+
+On the right is the code fragment that runs in the daemon.
+This is a short C function which handles constructing the
+command line and parsing out the result.  Although there
+is parsing code here, the good thing is that it only exists
+in one place, and we can update it from time to time if
+the underlying shell commands change.
+
+On the left is the metadata for this API function.  It
+has a description of the parameters and return value,
+some tests (not shown), and a fragment of documentation.
+
+That's ALL you have to write.  From that, we generate
+header files, bindings in all the different languages,
+RPC for the virtio-serial connection, documentation, etc.
+Currently we generate about a quarter of a million lines
+of code and documentation.
+
+[3 Tools written around the API]
+
+Around this stable API, myself and the libguestfs team
+have written a number of tools.  There are also people
+in the community writing other tools.
+
+A few of them are shown on this diagram, in fact there
+are many more than are shown here.
+
+Starting at the top, "guestfish" is a shell for the API,
+letting you write simple shell scripts.  If you look at
+the code examples below, you can see a small guestfish
+script that creates a complete guest.  Then we mount it on
+the host using guestmount (FUSE) and browse around.
+
+Going round clockwise:
+
+The libguestfs API is a mix of high-level calls like
+mkfs, lvremove, vfs-type; and also low level POSIX calls
+like mkdir and writing to files.
+"guestmount" lets you mount an existing filesystem from
+a guest and access it as a regular mountpoint on the host.
+guestmount intelligently caches and prefetches data so it's
+quite usable and fast from the command line or graphical
+programs like the GNOME Nautilus file browser.
+
+"virt-rescue" lets you use the appliance directly, and
+it's a useful way to rescue guests by hand.
+
+"virt-win-reg" lets you read and write Windows Registry
+entries.  There is a rather complex example below right.
+
+Now we come round to the "inspection" tools, and these
+three tools let you inspect an unknown guest to find out
+what operating system it contains, what applications are
+installed, what filesystems, how the filesystems are used
+and much more.  I cover that in the next section, but if
+you look below you'll see an example of running "virt-df".
+
+Finally there are now tools to resize guests, make them
+sparse, align them, and check their alignment.  These
+last tools are ones that we eventually hope will become
+obsolete.
+
+[4 Inspection]
+
+Next I want to look at another aspect of the API which is
+called "inspection".
+
+Inspection means taking arbitrary disk images and finding
+out what they contain, from just what partitions and filesystems
+are in a disk image, to whether and what operating system(s)
+it contains, to what applications are installed.
+
+The two main command-line tools are virt-filesystems and
+virt-inspector, and you can see the output from these tools.
+However this information is also available through the
+API.  The example there shows getting operating system
+inspection data from a C program.  Programs can also get
+inspection information, as you can see in the screenshots
+from the latest virt-manager.
+
+[5 Graphical browsers]
+
+I've concentrated a lot on command line tools, but you can
+also use libguestfs from graphical programs.  I wrote an
+experimental program called guestfs-browser, and there are
+screenshots shown.  But many people will simply want to mount
+a filesystem on the host using guestmount, and then use
+ordinary tools.  At the bottom is a screenshot of GNOME
+Nautilus browsing into a guest filesystem.
+

contrib/intro/tools.svg

@@ -0,0 +1,711 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<svg
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   width="629.526"
+   height="475.37674"
+   preserveAspectRatio="xMinYMin meet"
+   viewBox="0 0 630.14339 474.34607"
+   id="svg2"
+   version="1.1"
+   inkscape:version="0.48.1 r9760"
+   sodipodi:docname="libguestfs-tools.svg">
+  <sodipodi:namedview
+     id="base"
+     pagecolor="#ffffff"
+     bordercolor="#666666"
+     borderopacity="1.0"
+     inkscape:pageopacity="0.0"
+     inkscape:pageshadow="2"
+     inkscape:zoom="1"
+     inkscape:cx="305.93218"
+     inkscape:cy="244.25314"
+     inkscape:document-units="px"
+     inkscape:current-layer="layer1"
+     showgrid="false"
+     inkscape:window-width="1400"
+     inkscape:window-height="833"
+     inkscape:window-x="26"
+     inkscape:window-y="31"
+     inkscape:window-maximized="0"
+     fit-margin-top="10"
+     fit-margin-left="10"
+     fit-margin-right="10"
+     fit-margin-bottom="10">
+    <inkscape:grid
+       type="xygrid"
+       id="grid3046"
+       empspacing="5"
+       visible="true"
+       enabled="true"
+       snapvisiblegridlinesonly="true" />
+  </sodipodi:namedview>
+  <defs
+     id="defs4">
+    <marker
+       style="overflow:visible"
+       id="Arrow1Mend"
+       refX="0"
+       refY="0"
+       orient="auto"
+       inkscape:stockid="Arrow1Mend">
+      <path
+         transform="matrix(-0.4,0,0,-0.4,-4,0)"
+         style="fill-rule:evenodd;stroke:#000000;stroke-width:1pt;marker-start:none"
+         d="M 0,0 5,-5 -12.5,0 5,5 0,0 z"
+         id="path4254"
+         inkscape:connector-curvature="0" />
+    </marker>
+    <marker
+       style="overflow:visible"
+       id="Arrow1Lend"
+       refX="0"
+       refY="0"
+       orient="auto"
+       inkscape:stockid="Arrow1Lend">
+      <path
+         inkscape:connector-curvature="0"
+         transform="matrix(-0.8,0,0,-0.8,-10,0)"
+         style="fill-rule:evenodd;stroke:#000000;stroke-width:1pt;marker-start:none"
+         d="M 0,0 5,-5 -12.5,0 5,5 0,0 z"
+         id="path4149" />
+    </marker>
+    <inkscape:perspective
+       id="perspective3761"
+       inkscape:persp3d-origin="372.04724 : 350.78739 : 1"
+       inkscape:vp_z="744.09448 : 526.18109 : 1"
+       inkscape:vp_y="0 : 1000 : 0"
+       inkscape:vp_x="0 : 526.18109 : 1"
+       sodipodi:type="inkscape:persp3d" />
+    <marker
+       style="overflow:visible"
+       id="Arrow1LendR"
+       refX="0"
+       refY="0"
+       orient="auto"
+       inkscape:stockid="Arrow1LendR">
+      <path
+         inkscape:connector-curvature="0"
+         transform="matrix(-0.8,0,0,-0.8,-10,0)"
+         style="fill:#8c8989;fill-rule:evenodd;stroke:#8c8989;stroke-width:1pt;marker-start:none"
+         d="M 0,0 5,-5 -12.5,0 5,5 0,0 z"
+         id="path4924" />
+    </marker>
+    <marker
+       style="overflow:visible"
+       id="Arrow1LendH"
+       refX="0"
+       refY="0"
+       orient="auto"
+       inkscape:stockid="Arrow1LendH">
+      <path
+         inkscape:connector-curvature="0"
+         transform="matrix(-0.8,0,0,-0.8,-10,0)"
+         style="fill:#888888;fill-rule:evenodd;stroke:#888888;stroke-width:1pt;marker-start:none"
+         d="M 0,0 5,-5 -12.5,0 5,5 0,0 z"
+         id="path5584" />
+    </marker>
+    <marker
+       style="overflow:visible"
+       id="Arrow1Lendi"
+       refX="0"
+       refY="0"
+       orient="auto"
+       inkscape:stockid="Arrow1Lendi">
+      <path
+         inkscape:connector-curvature="0"
+         transform="matrix(-0.8,0,0,-0.8,-10,0)"
+         style="fill:#888888;fill-rule:evenodd;stroke:#888888;stroke-width:1pt;marker-start:none"
+         d="M 0,0 5,-5 -12.5,0 5,5 0,0 z"
+         id="path5587" />
+    </marker>
+    <marker
+       style="overflow:visible"
+       id="Arrow1Lendn"
+       refX="0"
+       refY="0"
+       orient="auto"
+       inkscape:stockid="Arrow1Lendn">
+      <path
+         inkscape:connector-curvature="0"
+         transform="matrix(-0.8,0,0,-0.8,-10,0)"
+         style="fill:#000000;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;marker-start:none"
+         d="M 0,0 5,-5 -12.5,0 5,5 0,0 z"
+         id="path5590" />
+    </marker>
+    <marker
+       style="overflow:visible"
+       id="Arrow1LendnS"
+       refX="0"
+       refY="0"
+       orient="auto"
+       inkscape:stockid="Arrow1LendnS">
+      <path
+         inkscape:connector-curvature="0"
+         transform="matrix(-0.8,0,0,-0.8,-10,0)"
+         style="fill:#000000;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;marker-start:none"
+         d="M 0,0 5,-5 -12.5,0 5,5 0,0 z"
+         id="path5709" />
+    </marker>
+    <marker
+       style="overflow:visible"
+       id="Arrow1LendnS4"
+       refX="0"
+       refY="0"
+       orient="auto"
+       inkscape:stockid="Arrow1LendnS4">
+      <path
+         inkscape:connector-curvature="0"
+         transform="matrix(-0.8,0,0,-0.8,-10,0)"
+         style="fill:#888888;fill-rule:evenodd;stroke:#888888;stroke-width:1pt;marker-start:none"
+         d="M 0,0 5,-5 -12.5,0 5,5 0,0 z"
+         id="path5832" />
+    </marker>
+    <marker
+       style="overflow:visible"
+       id="Arrow1MendG"
+       refX="0"
+       refY="0"
+       orient="auto"
+       inkscape:stockid="Arrow1MendG">
+      <path
+         transform="matrix(-0.4,0,0,-0.4,-4,0)"
+         style="fill:#ff0000;fill-rule:evenodd;stroke:#ff0000;stroke-width:1pt;marker-start:none"
+         d="M 0,0 5,-5 -12.5,0 5,5 0,0 z"
+         id="path4721"
+         inkscape:connector-curvature="0" />
+    </marker>
+  </defs>
+  <metadata
+     id="metadata7">
+    <rdf:RDF>
+      <cc:Work
+         rdf:about="">
+        <dc:format>image/svg+xml</dc:format>
+        <dc:type
+           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
+        <dc:title />
+      </cc:Work>
+    </rdf:RDF>
+  </metadata>
+  <g
+     transform="translate(-61.579184,-78.961745)"
+     id="layer1"
+     inkscape:groupmode="layer"
+     inkscape:label="Layer 1">
+    <text
+       sodipodi:linespacing="125%"
+       id="text3793"
+       y="269.36218"
+       x="306"
+       style="font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans"
+       xml:space="preserve"><tspan
+         y="269.36218"
+         x="306"
+         id="tspan3795"
+         sodipodi:role="line" /></text>
+    <text
+       sodipodi:linespacing="125%"
+       id="text3797"
+       y="267.36218"
+       x="304"
+       style="font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans"
+       xml:space="preserve"><tspan
+         y="267.36218"
+         x="304"
+         id="tspan3799"
+         sodipodi:role="line" /></text>
+    <g
+       id="g3942"
+       transform="matrix(0.72385693,0,0,0.72385693,134.30682,108.78183)">
+      <rect
+         style="fill:#ffdcdc;fill-opacity:1;stroke:#190000;stroke-width:2.94564199;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none"
+         id="rect2985"
+         width="294.189"
+         height="237.99187"
+         x="190.705"
+         y="154.46817" />
+      <text
+         xml:space="preserve"
+         style="font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans"
+         x="239"
+         y="201.36218"
+         id="text3757"
+         sodipodi:linespacing="125%"><tspan
+           sodipodi:role="line"
+           id="tspan3759"
+           x="239"
+           y="201.36218">libguestfs</tspan></text>
+      <g
+         id="g4614"
+         transform="matrix(0.88003385,0,0,0.86189263,26.891233,24.839975)">
+        <rect
+           y="219.36218"
+           x="218"
+           height="40"
+           width="58"
+           id="rect3779"
+           style="fill:#fff6f6;fill-opacity:1;stroke:#190000;stroke-width:1;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" />
+        <text
+           sodipodi:linespacing="125%"
+           id="text3789"
+           y="247.36218"
+           x="223"
+           style="font-size:20px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans"
+           xml:space="preserve"><tspan
+             y="247.36218"
+             x="223"
+             id="tspan3791"
+             sodipodi:role="line">mkfs</tspan></text>
+      </g>
+      <g
+         transform="matrix(0.87343177,0,0,0.83132964,36.681547,40.720104)"
+         id="g3077">
+        <rect
+           style="fill:#fff6f6;fill-opacity:1;stroke:#190000;stroke-width:1.2677021;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none"
+           id="rect3781"
+           width="96.596542"
+           height="38.597645"
+           x="279.26575"
+           y="246.24846" />
+        <text
+           sodipodi:linespacing="125%"
+           id="text3801"
+           y="271.77777"
+           x="287.50287"
+           style="font-size:20px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans"
+           xml:space="preserve"><tspan
+             y="271.77777"
+             x="287.50287"
+             id="tspan3803"
+             sodipodi:role="line">lvcreate</tspan></text>
+      </g>
+      <g
+         transform="matrix(0.9731636,0,0,0.89682062,-4.7939037,17.840053)"
+         id="g3072">
+        <rect
+           y="228.36218"
+           x="389"
+           height="40"
+           width="77.964508"
+           id="rect3783"
+           style="fill:#fff6f6;fill-opacity:1;stroke:#190000;stroke-width:1.15940309;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" />
+        <text
+           sodipodi:linespacing="125%"
+           id="text3805"
+           y="256.36218"
+           x="396"
+           style="font-size:20px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans"
+           xml:space="preserve"><tspan
+             y="256.36218"
+             x="396"
+             id="tspan3807"
+             sodipodi:role="line">parted</tspan></text>
+      </g>
+      <g
+         id="g3931">
+        <rect
+           style="fill:#fff6f6;fill-opacity:1;stroke:#190000;stroke-width:0.74572152;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none"
+           id="rect3048"
+           width="264"
+           height="30.02943"
+           x="200.91432"
+           y="352.42081" />
+        <text
+           xml:space="preserve"
+           style="font-size:22px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans"
+           x="220.93394"
+           y="372.44043"
+           id="text3050"
+           sodipodi:linespacing="125%"><tspan
+             sodipodi:role="line"
+             id="tspan3052"
+             x="220.93394"
+             y="372.44043">qemu</tspan></text>
+        <text
+           xml:space="preserve"
+           style="font-size:14.01373005px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:condensed;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;font-family:Liberation Sans Narrow;-inkscape-font-specification:Sans"
+           x="371.08105"
+           y="372.44043"
+           id="text3054"
+           sodipodi:linespacing="125%"><tspan
+             sodipodi:role="line"
+             id="tspan3056"
+             x="371.08105"
+             y="372.44043">raw</tspan></text>
+        <text
+           xml:space="preserve"
+           style="font-size:14.01373005px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:condensed;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;font-family:Liberation Sans Narrow;-inkscape-font-specification:Sans"
+           x="421.1301"
+           y="372.44043"
+           id="text3058"
+           sodipodi:linespacing="125%"><tspan
+             sodipodi:role="line"
+             id="tspan3060"
+             x="421.1301"
+             y="372.44043">qcow2</tspan></text>
+        <text
+           xml:space="preserve"
+           style="font-size:14.01373005px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:condensed;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;font-family:Liberation Sans Narrow;-inkscape-font-specification:Sans"
+           x="323.02417"
+           y="372.91223"
+           id="text3062"
+           sodipodi:linespacing="125%"><tspan
+             sodipodi:role="line"
+             id="tspan3064"
+             x="323.02417"
+             y="372.91223">vmdk</tspan></text>
+      </g>
+      <g
+         id="g3922">
+        <rect
+           y="292.36197"
+           x="200.91432"
+           height="54"
+           width="264"
+           id="rect3777"
+           style="fill:#fff6f6;fill-opacity:1;stroke:#190000;stroke-width:1;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" />
+        <text
+           sodipodi:linespacing="125%"
+           id="text3785"
+           y="326.63818"
+           x="220.52794"
+           style="font-size:22px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans"
+           xml:space="preserve"><tspan
+             y="326.63818"
+             x="220.52794"
+             id="tspan3787"
+             sodipodi:role="line">Linux kernel</tspan></text>
+        <text
+           xml:space="preserve"
+           style="font-size:14.01373005px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:condensed;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;font-family:Liberation Sans Narrow;-inkscape-font-specification:Sans"
+           x="391.51471"
+           y="315.46762"
+           id="text3082"
+           sodipodi:linespacing="125%"><tspan
+             sodipodi:role="line"
+             id="tspan3084"
+             x="391.51471"
+             y="315.46762">ext4</tspan></text>
+        <text
+           xml:space="preserve"
+           style="font-size:14.01373005px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:condensed;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;font-family:Liberation Sans Narrow;-inkscape-font-specification:Sans"
+           x="426.90472"
+           y="333.87045"
+           id="text3086"
+           sodipodi:linespacing="125%"><tspan
+             sodipodi:role="line"
+             id="tspan3088"
+             x="426.90472"
+             y="333.87045">btrfs</tspan></text>
+      </g>
+    </g>
+    <g
+       id="g3888"
+       transform="translate(-85.64383,133.06644)">
+      <rect
+         ry="9.1923885"
+         transform="matrix(1.0009807,0,0,1.0009807,10.718182,61.430592)"
+         y="19.7358"
+         x="163.34166"
+         height="31.819805"
+         width="145.66399"
+         id="rect3060"
+         style="fill:#cc0000;fill-opacity:1;stroke:none" />
+      <text
+         transform="matrix(1.0009807,0,0,1.0009807,10.718182,61.430592)"
+         sodipodi:linespacing="125%"
+         id="text3884"
+         y="40.241898"
+         x="178.89801"
+         style="font-size:16px;font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#ffffff;fill-opacity:1;stroke:none;font-family:Liberation Sans;-inkscape-font-specification:Liberation Sans Bold"
+         xml:space="preserve"><tspan
+           y="40.241898"
+           x="178.89801"
+           id="tspan3886"
+           sodipodi:role="line">virt-resize</tspan></text>
+    </g>
+    <g
+       transform="translate(268.25631,31.143212)"
+       id="g3901">
+      <rect
+         style="fill:#cc0000;fill-opacity:1;stroke:none"
+         id="rect3895"
+         width="145.66399"
+         height="31.819805"
+         x="163.34166"
+         y="19.7358"
+         ry="9.1923885"
+         transform="matrix(1.0009807,0,0,1.0009807,10.718182,61.430592)" />
+      <text
+         xml:space="preserve"
+         style="font-size:16px;font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#ffffff;fill-opacity:1;stroke:none;font-family:Liberation Sans;-inkscape-font-specification:Liberation Sans Bold"
+         x="178.89801"
+         y="40.241898"
+         id="text3897"
+         sodipodi:linespacing="125%"
+         transform="matrix(1.0009807,0,0,1.0009807,10.718182,61.430592)"><tspan
+           sodipodi:role="line"
+           id="tspan3899"
+           x="178.89801"
+           y="40.241898">guestmount</tspan></text>
+    </g>
+    <g
+       transform="translate(94.845234,16.279406)"
+       id="g3917">
+      <rect
+         ry="9.2014036"
+         y="72.692146"
+         x="110.51801"
+         height="31.851011"
+         width="145.80684"
+         id="rect3908"
+         style="fill:#cc0000;fill-opacity:1;stroke:none" />
+      <text
+         sodipodi:linespacing="125%"
+         id="text3910"
+         y="93.218353"
+         x="126.08962"
+         style="font-size:16.01569176px;font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#ffffff;fill-opacity:1;stroke:none;font-family:Liberation Sans;-inkscape-font-specification:Liberation Sans Bold"
+         xml:space="preserve"><tspan
+           y="93.218353"
+           x="126.08962"
+           id="tspan3912"
+           sodipodi:role="line">guestfish</tspan></text>
+    </g>
+    <g
+       id="g4006"
+       transform="translate(12.032604,19.818407)">
+      <rect
+         style="fill:#cc0000;fill-opacity:1;stroke:none"
+         id="rect3997"
+         width="145.80684"
+         height="31.851011"
+         x="523.87335"
+         y="229.11598"
+         ry="9.2014036" />
+      <text
+         xml:space="preserve"
+         style="font-size:16.01569176px;font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#ffffff;fill-opacity:1;stroke:none;font-family:Liberation Sans;-inkscape-font-specification:Liberation Sans Bold"
+         x="539.44495"
+         y="249.6422"
+         id="text3999"
+         sodipodi:linespacing="125%"><tspan
+           sodipodi:role="line"
+           id="tspan4001"
+           x="539.44495"
+           y="249.6422">virt-rescue</tspan></text>
+    </g>
+    <g
+       transform="translate(-102.63104,181.19685)"
+       id="g4011">
+      <rect
+         style="fill:#cc0000;fill-opacity:1;stroke:none"
+         id="rect4013"
+         width="145.66399"
+         height="31.819805"
+         x="163.34166"
+         y="19.7358"
+         transform="matrix(1.0009807,0,0,1.0009807,10.718182,61.430592)"
+         ry="9.1923885" />
+      <text
+         xml:space="preserve"
+         style="font-size:16px;font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#ffffff;fill-opacity:1;stroke:none;font-family:Liberation Sans;-inkscape-font-specification:Liberation Sans Bold"
+         x="178.89801"
+         y="40.241898"
+         id="text4015"
+         sodipodi:linespacing="125%"
+         transform="matrix(1.0009807,0,0,1.0009807,10.718182,61.430592)"><tspan
+           sodipodi:role="line"
+           id="tspan4017"
+           x="178.89801"
+           y="40.241898">virt-sparsify</tspan></text>
+    </g>
+    <g
+       id="g4081"
+       transform="translate(-5.6624019,-29.72761)">
+      <rect
+         ry="9.2014036"
+         y="341.65622"
+         x="82.206001"
+         height="31.851011"
+         width="145.80684"
+         id="rect4021"
+         style="fill:#cc0000;fill-opacity:1;stroke:none" />
+      <text
+         transform="scale(0.97311457,1.0276282)"
+         sodipodi:linespacing="125%"
+         id="text4023"
+         y="352.44501"
+         x="87.536247"
+         style="font-size:15.58510303px;font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#ffffff;fill-opacity:1;stroke:none;font-family:Liberation Sans;-inkscape-font-specification:Liberation Sans Bold"
+         xml:space="preserve"><tspan
+           y="352.44501"
+           x="87.536247"
+           id="tspan4025"
+           sodipodi:role="line">virt-alignment-scan</tspan></text>
+    </g>
+    <g
+       id="g4038"
+       transform="translate(-7.7858026,8.4936029)">
+      <rect
+         style="fill:#cc0000;fill-opacity:1;stroke:none"
+         id="rect4029"
+         width="145.80684"
+         height="31.851011"
+         x="134.58322"
+         y="428.71567"
+         ry="9.2014036" />
+      <text
+         xml:space="preserve"
+         style="font-size:16.01569176px;font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#ffffff;fill-opacity:1;stroke:none;font-family:Liberation Sans;-inkscape-font-specification:Liberation Sans Bold"
+         x="150.15482"
+         y="449.24185"
+         id="text4031"
+         sodipodi:linespacing="125%"><tspan
+           sodipodi:role="line"
+           id="tspan4033"
+           x="150.15482"
+           y="449.24185">virt-inspector</tspan></text>
+    </g>
+    <g
+       transform="translate(75.026826,46.714815)"
+       id="g4043">
+      <rect
+         ry="9.2014036"
+         y="428.71567"
+         x="134.58322"
+         height="31.851011"
+         width="145.80684"
+         id="rect4045"
+         style="fill:#cc0000;fill-opacity:1;stroke:none" />
+      <text
+         sodipodi:linespacing="125%"
+         id="text4047"
+         y="449.24185"
+         x="150.15482"
+         style="font-size:16.01569176px;font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#ffffff;fill-opacity:1;stroke:none;font-family:Liberation Sans;-inkscape-font-specification:Liberation Sans Bold"
+         xml:space="preserve"><tspan
+           y="449.24185"
+           x="150.15482"
+           id="tspan4049"
+           sodipodi:role="line">virt-filesystems</tspan></text>
+    </g>
+    <g
+       id="g4076"
+       transform="translate(38.929013,4.2468014)">
+      <rect
+         style="fill:#cc0000;fill-opacity:1;stroke:none"
+         id="rect4053"
+         width="102.63103"
+         height="31.851011"
+         x="265.52628"
+         y="508.69708"
+         ry="9.2014036" />
+      <text
+         xml:space="preserve"
+         style="font-size:16.01569176px;font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#ffffff;fill-opacity:1;stroke:none;font-family:Liberation Sans;-inkscape-font-specification:Liberation Sans Bold"
+         x="281.09787"
+         y="529.22327"
+         id="text4055"
+         sodipodi:linespacing="125%"><tspan
+           sodipodi:role="line"
+           id="tspan4057"
+           x="281.09787"
+           y="529.22327">virt-df</tspan></text>
+    </g>
+    <g
+       id="g4108"
+       transform="translate(-7.0780024,24.773008)">
+      <rect
+         ry="9.2014036"
+         y="411.72845"
+         x="496.97693"
+         height="31.851011"
+         width="145.80684"
+         id="rect4061"
+         style="fill:#cc0000;fill-opacity:1;stroke:none" />
+      <text
+         sodipodi:linespacing="125%"
+         id="text4063"
+         y="432.25464"
+         x="512.54852"
+         style="font-size:16.01569176px;font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#ffffff;fill-opacity:1;stroke:none;font-family:Liberation Sans;-inkscape-font-specification:Liberation Sans Bold"
+         xml:space="preserve"><tspan
+           y="432.25464"
+           x="512.54852"
+           id="tspan4065"
+           sodipodi:role="line">virt-win-reg</tspan></text>
+    </g>
+    <text
+       xml:space="preserve"
+       style="font-size:14px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;font-family:Liberation Sans;-inkscape-font-specification:Liberation Sans"
+       x="380.42343"
+       y="96.660439"
+       id="text4086"
+       sodipodi:linespacing="125%"
+       transform="matrix(1.0009807,0,0,1.0009807,64.410388,68.552031)"><tspan
+         sodipodi:role="line"
+         id="tspan4088"
+         x="380.42343"
+         y="96.660439">FUSE / POSIX</tspan></text>
+    <text
+       xml:space="preserve"
+       style="font-size:14px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;font-family:Liberation Sans;-inkscape-font-specification:Liberation Sans"
+       x="180.31223"
+       y="81.811195"
+       id="text4090"
+       sodipodi:linespacing="125%"
+       transform="matrix(1.0009807,0,0,1.0009807,64.410388,68.552031)"><tspan
+         sodipodi:role="line"
+         id="tspan4092"
+         x="180.31223"
+         y="81.811195">shell scripts</tspan></text>
+    <text
+       xml:space="preserve"
+       style="font-size:14px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;font-family:Liberation Sans;-inkscape-font-specification:Liberation Sans"
+       x="105.35891"
+       y="291.11481"
+       id="text4094"
+       sodipodi:linespacing="125%"
+       transform="matrix(1.0009807,0,0,1.0009807,64.410388,68.552031)"><tspan
+         sodipodi:role="line"
+         id="tspan4096"
+         x="105.35891"
+         y="291.11481">align &amp; resize</tspan></text>
+    <text
+       xml:space="preserve"
+       style="font-size:14px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;font-family:Liberation Sans;-inkscape-font-specification:Liberation Sans"
+       x="247.48737"
+       y="384.45288"
+       id="text4098"
+       sodipodi:linespacing="125%"
+       transform="matrix(1.0009807,0,0,1.0009807,64.410388,68.552031)"><tspan
+         sodipodi:role="line"
+         id="tspan4100"
+         x="247.48737"
+         y="384.45288">inspection</tspan></text>
+    <text
+       xml:space="preserve"
+       style="font-size:14.01373005px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;font-family:Liberation Sans;-inkscape-font-specification:Liberation Sans"
+       x="500.41534"
+       y="405.25153"
+       id="text4102"
+       sodipodi:linespacing="125%"><tspan
+         sodipodi:role="line"
+         id="tspan4104"
+         x="500.41534"
+         y="405.25153">Windows</tspan><tspan
+         sodipodi:role="line"
+         x="500.41534"
+         y="422.76868"
+         id="tspan4106">guests</tspan></text>
+  </g>
+</svg>

contrib/intro/win7.xml

@@ -0,0 +1,164 @@
+<?xml version="1.0"?>
+<operatingsystems>
+  <operatingsystem>
+    <root>/dev/sda2</root>
+    <name>windows</name>
+    <arch>i386</arch>
+    <distro>windows</distro>
+    <product_name>Windows 7 Enterprise</product_name>
+    <product_variant>Client</product_variant>
+    <major_version>6</major_version>
+    <minor_version>1</minor_version>
+    <windows_systemroot>/Windows</windows_systemroot>
+    <windows_current_control_set>ControlSet001</windows_current_control_set>
+    <hostname>win7x32</hostname>
+    <format>installed</format>
+    <mountpoints>
+      <mountpoint dev="/dev/sda2">/</mountpoint>
+    </mountpoints>
+    <filesystems>
+      <filesystem dev="/dev/sda2">
+        <type>ntfs</type>
+        <uuid>F2E8996AE8992E3B</uuid>
+      </filesystem>
+    </filesystems>
+    <drive_mappings>
+      <drive_mapping name="C">/dev/sda2</drive_mapping>
+    </drive_mappings>
+    <applications>
+      <application>
+        <name>Microsoft .NET Framework 4 Client Profile</name>
+        <display_name>Microsoft .NET Framework 4 Client Profile</display_name>
+        <version>4.0.30319</version>
+        <install_path>C:\Windows\Microsoft.NET\Framework\v4.0.30319\SetupCache\Client</install_path>
+        <publisher>Microsoft Corporation</publisher>
+        <url>http://go.microsoft.com/fwlink/?LinkId=164164</url>
+      </application>
+      <application>
+        <name>Mozilla Firefox (3.6.12)</name>
+        <display_name>Mozilla Firefox (3.6.12)</display_name>
+        <version>3.6.12 (en-GB)</version>
+        <install_path>C:\Program Files\Mozilla Firefox</install_path>
+        <publisher>Mozilla</publisher>
+        <url>http://www.mozilla.com/en-GB/</url>
+        <description>Mozilla Firefox</description>
+      </application>
+      <application>
+        <name>VLC media player</name>
+        <display_name>VLC media player 1.1.5</display_name>
+        <version>1.1.5</version>
+        <install_path>C:\Program Files\VideoLAN\VLC</install_path>
+        <publisher>VideoLAN</publisher>
+        <url>http://www.videolan.org/</url>
+      </application>
+      <application>
+        <name>{3C3901C5-3455-3E0A-A214-0B093A5070A6}</name>
+        <display_name>Microsoft .NET Framework 4 Client Profile</display_name>
+        <version>4.0.30319</version>
+        <publisher>Microsoft Corporation</publisher>
+        <url>http://go.microsoft.com/fwlink/?LinkId=164164</url>
+      </application>
+      <application>
+        <name>{3C3901C5-3455-3E0A-A214-0B093A5070A6}.KB2468871</name>
+        <display_name>Update for Microsoft .NET Framework 4 Client Profile (KB2468871)</display_name>
+        <version>1</version>
+        <publisher>Microsoft Corporation</publisher>
+        <url>http://support.microsoft.com</url>
+        <description>This update is for Microsoft .NET Framework 4 Client Profile.&#13;
+If you later install a more recent service pack, this update will be uninstalled automatically.&#13;
+For more information, visit http://support.microsoft.com/kb/2468871.</description>
+      </application>
+      <application>
+        <name>{3C3901C5-3455-3E0A-A214-0B093A5070A6}.KB2518870</name>
+        <display_name>Security Update for Microsoft .NET Framework 4 Client Profile (KB2518870)</display_name>
+        <version>1</version>
+        <publisher>Microsoft Corporation</publisher>
+        <url>http://support.microsoft.com</url>
+        <description>This security update is for Microsoft .NET Framework 4 Client Profile.&#13;
+If you later install a more recent service pack, this security update will be uninstalled automatically.&#13;
+For more information, visit http://support.microsoft.com/kb/2518870.</description>
+      </application>
+      <application>
+        <name>{3C3901C5-3455-3E0A-A214-0B093A5070A6}.KB2533523</name>
+        <display_name>Update for Microsoft .NET Framework 4 Client Profile (KB2533523)</display_name>
+        <version>1</version>
+        <publisher>Microsoft Corporation</publisher>
+        <url>http://support.microsoft.com</url>
+        <description>This update is for Microsoft .NET Framework 4 Client Profile.&#13;
+If you later install a more recent service pack, this update will be uninstalled automatically.&#13;
+For more information, visit http://support.microsoft.com/kb/2533523.</description>
+      </application>
+      <application>
+        <name>{3C3901C5-3455-3E0A-A214-0B093A5070A6}.KB2539636</name>
+        <display_name>Security Update for Microsoft .NET Framework 4 Client Profile (KB2539636)</display_name>
+        <version>1</version>
+        <publisher>Microsoft Corporation</publisher>
+        <url>http://support.microsoft.com</url>
+        <description>This security update is for Microsoft .NET Framework 4 Client Profile.&#13;
+If you later install a more recent service pack, this security update will be uninstalled automatically.&#13;
+For more information, visit http://support.microsoft.com/kb/2539636.</description>
+      </application>
+    </applications>
+    <icon>iVBORw0KGgoAAAANSUhEUgAAADYAAAA3CAIAAADIey4vAAAMo0lEQVRoge2YaViTVxbHMQlb
+CCGCW6lVNinIYpURbQcqiiRAWILIIgLKLmEnkAQJa4CELYAJqwIadgFBVkHZEVAQQXZEwQVL
+rdpxaVWgdY4ynQ/zzMwzIm0/DOc5H9577/n//ue5yXvfNxEQWI3VWI3VWI3/t0CJIDYqIZXw
+KE07oW8cRPQCIOEChkhlPCxBwZ/WG2K9AkrD6ovD4eYR+ZzKntobd9pGHnZNzkHCBQwTK7oP
+heVtPhwGZVD8hza3BrtJeK+9If109bXbE7NP7z56MjbzaPD2gxvj9/rGpiHhAoYweWf2ydjD
+J5XdE/rULJCA8I9oD6l4YMdxVkPf5O2Hj6Gb1v6Jxt6x+p6R2q7hmq6hmqsfsmsIhjAJS1AA
+ZZMPHtf3ToAQ5AD53dpDCglpWPmnVgzfne0YmKi+Olje1l/SdKPwcm9+4/W8hmv8Sz3/TBjC
+JCxBAZRBMUhACHKACCAFf5f+MNouZ+t7rg1Plbf05Tf05NRezarqTK9sT7vQlnqhlVf+rwmT
+sAQFUAbFIAEhyAECKACuWG+ioqJ4PEEaT85vvNbQPZhb3Z5a3pxcciWhsJHFr4s4UxGSWhyU
+kk9LzjvJLQjNKIvKrWHlXWLnN0DGQhY0xBU0JhZdBgkIQQ4QQEkT3AEL8E/tb82aNd9++608
+3pGdf+liay+3pDEur5aZUx2WXUXnFvsxuawAymknC/6hA3wjrRxrfZanm184JyApn5FZEXqm
++resCjtTHZ5TDUKQAwRQsQWXAAtwsPikFuXk5LQMLfB+py62XI87Vx2WWU5PLQ3glnon5lMo
+YVV7dzYqS7fs2typvaX74NYegkw3fstlM3WOv/sJVo5vynk/bpk/70Nyyyjc90KQAwRQAAQs
+wMFi+f2hUCh9ff3Nhj6ll7ujz1wITCn0jOe7x/Ld4vLsQ9MTbCyadmzp0pHpNZa7aaUwZKc4
+4qg06qw0fEyh6YSBLZ3lEs2xDUt3YvNd4wvdIGPzXVhnnSIyncNTfWKzmVmlgAU4WIDR8rdQ
+0+CIQ9RZTl6Vd2yOU2SWXVjm0fCso+FnSP7xJSZaXQdk+g8rjDgoTXptn6Kq3GWo3g1RmQne
+Hu3n7ptI49Qf9ub4HaYyTSgJJEqiqV+siXeYsZeHGd3KISyIHJUBWICDxfI3UkdH53ND76zy
+y+4xWUeDuebUZDMa1zQozTgoneQS1GG0vf+w/Jib8hRNZSZK9X6i2kOu2kOe6lzSTksPGvu8
+b3a7aXIDIaKU6JthcTzOyjKGhGfq7ozQNjplQPTwtaZxAAtwsACj5fSHxWIPEs32eSSGphZZ
+0ThGPnEE73i8XzI+MHW/b7KX7bE+823wsd4JUrkXqzabrj53Tv37IvXHpaoDSbp495NFPQHn
+rzvyOy3Tmg2jqvA+BXjbLD2jFN2v2TqkaEttexrRmw1YgOt4JoIR2H10i7D56vpHvRLzHUO5
+RC+WzolobXKslhdHy4+3243NtSIM2ipOUbbPsFRnM94396RK7ekltR+bVNIYNocC6Y3D4bU3
+KWXXXc51WnKvGIRdIJDPESxTdfFJB/ABx/ccZwAQsAD35uSD0XI+aw0NjS8IbjRekTklfv+J
+qL3OzN2ubA13zk5yyi47RrPlrlEXpekI1Udp6o9L1J81qv/YofZjl8rLDjVrd+/ANEbXZELT
+UHhtv39Jj0N2GymulhBQSLDL0jXnETQdPXY5RAAQsACn8YrBCOw+usV9+/ZJG/kH8gqNfWK1
+XJkajswdzmw1N46SK8fCynncRuGOs1zDCc0cd3wO+WAL7asn+TIvhxRnazUVbOj5HfF9d9I6
+xmIbbzEqesl5V625lw0YpQSXHD3zRDPlI4HqjtEABCzAweJzY3+w++gW4SzAGVIdos6QKAna
+J2LUjjPl7KKkbdlrrWK0zVzNzWzlTX2/sAyRs4uWOxa1/nCwvHlggptuNl1f4Ri1dyb75nRW
+z2RSyzCzpt+/uNs+o8UospJA5uO/pR3daEaXs2MCELAABwswAruPbpFIJKJ0KVtJ/qrW9A1E
+XxG8L8qAhjAJQxgzJCyi1nvzZZKum5TO+DQ8iu99nj70glp5U/UEB3uUrR9BH3mYNz7Lvz7F
+axtl1d0MLLnmcLrVhFWDpxQbKhx3RhjQAAVAwAIcLMAI7JbVoh5VYI+9gKadgJYLQtcHRTyJ
+MosUIYVsiO4QT+rdkX3LtmT8ZP1MRs/cxdFnLdMvWr9bkCbz1jvGaDG8c1qZ3be53ZNxV4aC
+ynqd0lpIXgUG+0NI4uYBAAEUAAH7Hr7HHoyW0yLsvBCeioDmvnFA6rgj8RSUSSjKLGK9bezG
+qDYcp2f76UGrojFqzfSpzkdlw0+b777gtN1XIEc3N3H/Qonf4MhU8qIdCPPRZ5K/prlucybL
+2nhtsKSgLNkoq1hAARCwAAcLMFrOBw3fX3G8P0LHE/FXR+R+T6Q+FfpDkULlvHIlw5pw8V0y
+GTeN8kc8K6dimh/k3nhcM/nS4lQ1MSjgl8el774/33TlVEByFDEoVD+Q7hzikRJnOXZ6Z3Cs
+B+ooB2WTCCgAAhbgYAFGy7ld4BT4jEBG4AMRWk5IXW8kkY46FClIYsjQK9cGN0iyOtZz+77O
+HbIrmaDWTie0z5658eKrQF5atuub7yp/vs9/PZ26MBX5btzz3YjZuwGNX9sVnxRLawVECx7j
+oWxTUOZRAAQswMFCWp+8nEPnw9FtizCJRGi7IPV8kEbwRQyXtGZK0WpxtPp1kS1rE3tgI/H8
+EcfSCVrddMDFB7LenOkuj9f3sl7fSXgzGf52zG9hxHbx1r7Fa6rz9dtaMvdscE0Rcs0WtOeh
+LGIACFiAgwUYLefoXnoAIk2jEbpeCLwv0jgYZcJQcOchvSowlOr1jEapmA6plN5tWQN4/rBd
+6W3D5JadtJh3k/5vJxhvxwPnR90Xhm0Wbuku9qm/bVZ+dX4LK8FJ1C1bhMwXPJ4G30gAAhbg
+YLHMB6DAh9cIHDEAQWIi9LyRxgwUkaYSVLqGXC4cUC1Or8OFNGKj29Ym98pkDu4+O7GDcdYv
+yf3Xcef5kWPzw0cWhowXB7UWe9XnW5ReX/zyae5nh0KZYr4lol6FQo4ZglZxSJMQwAIcRwzc
+v3//cvqDkJeX1zQ8grRKRujD7czAWYVvpZULO2aKOKaLuZ7GkHNEPc8J+RSJhF/ZxBuVo2c2
+Vxr8Mnxg8Zb2wsDexRtfLXRvf3tF6eeLiq8K5AbTlBQDMrHUKrRPiYhzpuCROJRpCGCR1slg
+AUbLbHHplVbSiIqwSUIR6aIWTJEjbDHHVAm/4rUh9djoFgyrDRPViDl5YV3wReXwjHc9Kotd
+ygtXt8+3K79tUnpd++Wrsm0v8uSeZ3yez9Ff61+EO1mH8T0v6pIlBC0aBQEWZ0T9pFfapY2E
+d3eULU/QMkbYioV2zhT3LcYF1+Ni2sU5vRLcAVzakETqAJrXKxtfVJ6q97JKcb5m25sKhZ/P
+y78qkH2Zu/V55pY53mZ3FlUiuBqE4r4laJcsYWs2AAEL8OVv4VL84+eVgasguUDEJh5axPqW
+4Bj14uxObHIfLvUWLmtULHdSJG9K5NyoGK9Njx2TmGTRkaE5dFqtP31HXdI3kUxLAp2xLqxC
+PKoFhCAHCKAEyYXyhq4r8PNK4LcfqRuMKaKB5WLOGVifIonQS5jYq9iUflz6sHj2OLrgLvrC
+A7HaObG6R+jKO+iiQWx2x8a0unUptWhOMyahTYLTjeVcx7A7QQhygABqg3EAYNFo9Kf2txSS
+kpIEojHONBgbUYejlonDLsZ3SXBvwhZi+FNiFx5gLn2PaX0mdvVvYl3P32fHM0zzD5i6R2Ll
+96EAyqAYJCAEOTayHmfKACBgV6a/pZCWlsYbGm8ypkhE1WJTOsXjunC8AVzOOKZkBlM3h2l7
+hrn2Qqz/FXrgJ0i4gOH7SVgqmYEyKAYJCEG+CfbP0BiAK9nfUkhJSR3UwysYOKN9z+IKbknl
+jK7NncCU3xe/8gOm+7nYwE+io2+EJ95CwgUMYfL9Uvl9KINikKD9zoEcIIBa+f6WAr6X8LyH
+21DKnIGNrpGsmMJdnpNofyre+xI9/Ebo9gJy+hdIuIAhTMISFEAZNqYWJCAE+Qr8SfLfA25A
+eJ7CYbbb8Mg6Ek3YL1c0pwvTeg89/Fzo3jziu18h4QKGMAlLwv5npcxoUAwSOF9W4P79HwMO
+2/f/pWhpweN1h76trIGbFCkQZx8p5MSBhAspMypMwhIUQBkUf9L5/CkhLCwsIyOjrq4OJxx8
+iMYfAi5gCJOysrJQ8Od0thqrsRqrsRr/Ltb851zB+DtwIBrFFstMPwAAAABJRU5ErkJggg==</icon>
+  </operatingsystem>
+</operatingsystems>

contrib/make-check-on-installed.pl

@@ -0,0 +1,177 @@
+#!/usr/bin/perl -w
+# libguestfs
+# Copyright (C) 2009-2012 Red Hat Inc.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+# This script allows you to run the test suite ('make check' etc) on
+# an installed copy of libguestfs.  Currently only RPM installs are
+# supported, but adding support for dpkg would be relatively
+# straightforward.  It works by examining the installed packages, and
+# copying binaries (eg. '/usr/bin/guestfish') and libraries into the
+# correct place in the local directory.
+#
+# * You MUST have the full source tree unpacked locally.  Either
+#   use the same source tarball as the version you are testing, or
+#   check it out from git and 'git-reset' to the right version tag.
+#
+# * You MUST do a successful local build from source before using
+#   this script (ie. './autogen.sh && make').
+#
+# Run the script from the top builddir.  Usually:
+#
+#   ./contrib/make-check-on-installed.pl
+#
+# If the script runs successfully, then run the test suite as normal:
+#
+#   make check
+#   make extra-tests
+#
+# To switch back to running the test suite on the locally built
+# version, do:
+#
+#   make clean && make
+
+use strict;
+
+die "wrong directory -- read the file before running\n" unless -f "BUGS";
+
+my $cmd;
+
+# Remove all libtool crappage.
+$cmd = "find -name 'lt-*' | grep -v '/tests/' | grep '/.libs/lt-' | xargs -r rm";
+system ($cmd) == 0 or die "$cmd: failed\n";
+
+$cmd = "find -name 'lib*.so*' | grep -v '/tests/' | grep '/.libs/lib' | xargs -r rm";
+system ($cmd) == 0 or die "$cmd: failed\n";
+
+# Map of installed file to local file.  Key is a regexp.
+# Remember that ONLY libraries and binaries need to be copied.
+my %mapping = (
+    '/bin/erl-guestfs$' => "erlang",
+    '/bin/libguestfs-test-tool$' => "test-tool",
+    '/bin/guestfish$' => "fish",
+    '/bin/guestmount$' => "fuse",
+    '/bin/virt-alignment-scan$' => "align",
+    '/bin/virt-cat$' => "cat",
+    '/bin/virt-copy-in$' => "fish",
+    '/bin/virt-copy-out$' => "fish",
+    '/bin/virt-df$' => "df",
+    '/bin/virt-edit$' => "edit",
+    '/bin/virt-filesystems$' => "cat",
+    '/bin/virt-format$' => "format",
+    '/bin/virt-inspector$' => "inspector",
+    '/bin/virt-list-filesystems$' => "tools",
+    '/bin/virt-list-partitions$' => "tools",
+    '/bin/virt-ls$' => "cat",
+    '/bin/virt-make-fs$' => "tools",
+    '/bin/virt-rescue$' => "rescue",
+    '/bin/virt-resize$' => "resize",
+    '/bin/virt-sparsify$' => "sparsify",
+    '/bin/virt-sysprep$' => "sysprep",
+    '/bin/virt-tar$' => "tools",
+    '/bin/virt-tar-in$' => "fish",
+    '/bin/virt-tar-out$' => "fish",
+    '/bin/virt-win-reg$' => "tools",
+
+    # Ignore this because the daemon is included in the appliance.
+    '/sbin/guestfsd$' => "IGNORE",
+
+    '/erlang/lib/libguestfs-.*/ebin/guestfs\.beam$' => "erlang",
+
+    '/girepository-1\.0/Guestfs-1\.0\.typelib$' => "gobject",
+    '/gir-1.0/Guestfs-1.0.gir$' => "gobject",
+
+    '/guestfs/supermin.d/.*' => "appliance/supermin.d",
+
+    '/java/libguestfs-.*\.jar$' => "java",
+
+    '/libguestfs\.so.*' => "src/.libs",
+    '/libguestfs_jni\.so.*' => "java/.libs",
+    '/libguestfs-gobject-1\.0\.so.*' => "gobject/.libs",
+
+    '/ocaml/.*\.cmi$' => "IGNORE",
+    '/ocaml/.*\.cmo$' => "ocaml",
+    '/ocaml/.*\.cmx$' => "ocaml",
+    '/ocaml/.*\.cma$' => "ocaml",
+    '/ocaml/.*\.cmxa$' => "ocaml",
+    '/ocaml/.*\.a$' => "ocaml",
+    '/ocaml/.*\.so$' => "ocaml",
+    '/ocaml/.*\.so.owner$' => "IGNORE",
+    '/ocaml/.*META$' => "IGNORE",
+    '/ocaml/.*/guestfs\.mli$' => "IGNORE",
+    '/ocaml/.*/guestfs\.ml$' => "IGNORE",
+
+    '/perl5/.*/Guestfs\.so$' => "perl/blib/arch/auto/Sys/Guestfs",
+    '/perl5/.*/Guestfs.pm$' => "perl/blib/lib/Sys/Guestfs.pm",
+    '/perl5/.*/Lib.pm$' => "perl/blib/lib/Sys/Guestfs/Lib.pm",
+
+    '/php/modules/guestfs_php\.so$' => "php/extension/modules",
+    '/php/modules/guestfs_php\.so$' => "php/extension/.libs",
+
+    '/python.*/libguestfsmod\.so$' => "python/.libs",
+    '/python.*/guestfs\.py' => "IGNORE",
+    '/python.*/guestfs\.pyc$' => "python/guestfs.pyc",
+    '/python.*/guestfs\.pyo$' => "python/guestfs.pyo",
+
+    '/ruby/.*/_guestfs\.so$' => "ruby/ext/guestfs",
+    '/ruby/.*/guestfs\.rb$' => "IGNORE",
+
+    '/share/doc/' => "IGNORE",
+    '/share/javadoc/' => "IGNORE",
+    '/share/locale/' => "IGNORE",
+    '/share/man/' => "IGNORE",
+
+    '^/etc/' => "IGNORE",
+    '/systemd/' => "IGNORE",
+    '/include/guestfs\.h$' => "IGNORE",
+    '/include/guestfs-gobject\.h$' => "IGNORE",
+    '/libguestfs\.pc$' => "IGNORE",
+);
+
+# Get list of installed files.
+$cmd = 'rpm -ql $(rpm -qa | grep -i guestf | grep -v debug) | sort';
+my @files;
+open CMD, "$cmd |" or die "$cmd: $!";
+while (<CMD>) {
+    chomp;
+    push @files, $_;
+}
+close CMD;
+
+# Now try to map (copy) installed files to the local equivalents.
+foreach my $file (@files) {
+    my $match = 0;
+    foreach my $regexp (keys %mapping) {
+        if ($file =~ m/$regexp/) {
+            my $dest = $mapping{$regexp};
+            if ($dest ne "IGNORE") {
+                # Make destination writable if it's a file.
+                chmod 0644, "$dest" if -f "$dest" && ! -w "$dest";
+
+                # Copy file to destination.
+                $cmd = "cp '$file' '$dest'";
+                system ($cmd) == 0 or die "$cmd: failed\n";
+                print "$file => $dest\n";
+            }
+            $match++;
+        }
+    }
+    if ($match == 0) {
+        if (! -d $file) {
+            warn "WARNING: file '$file' is unmatched\n"
+        }
+    }
+}

contrib/visualize-alignment/.gitignore

@@ -0,0 +1,2 @@
+*.eps
+*.png

contrib/visualize-alignment/README

@@ -0,0 +1,70 @@
+This directory contains some experimental work for capturing traces of
+block device operations while filesystem operations are performed.
+
+You can trace any operation that libguestfs supports, including
+partitioning, mkfs, LVM operations, and filesystem operations.  You
+can enable and disable tracing in order to capture single operations
+such as a single write, or groups of operations.  You can examine the
+traces by hand (as text files) or turn them into graphical
+visualizations.
+
+IMPORTANT NOTE: This is not upstream (in qemu) nor integrated into
+libguestfs.  We should probably be using the 'blktrace' command
+instead, or if that is not suitable, get a more reliable and useful
+trace mechanism added to qemu (the current patch is not suitable for
+upstreaming).
+
+The *.qtr files are qemu trace files, produced using the unofficial
+qemu patch in the current directory.
+
+- guestfish-N-fs-10M.qtr
+
+  The command 'guestfish -N fs:ext2:10M' before we modified the
+  part-disk API to align the partition to 64 sectors.
+
+- guestfish-N-fs-10M-aligned-part-disk.qtr
+
+  The command 'guestfish -N fs:ext2:10M' after we modified the
+  part-disk API to align the partition to 64 sectors.
+
+- guestfish-add-mount.qtr
+
+  $ guestfish -a test1.img -m /dev/sda1
+  where test1.img was created by the previous command.
+
+- guestfish-write-hello.qtr
+
+  $ guestfish -a test1.img -m /dev/sda1 \
+      debug qtrace "/dev/vda on" : \
+      write /hello "hello, world." : \
+      debug qtrace "/dev/vda off"
+  where test1.img was created by the command above.
+
+  This is just the creation of a new file with a small amount of content.
+
+  Within this trace file, the qtrace on/off commands appear as patterns
+  of reads.  For on: 2, 21, 15, 2.  For off: 2, 15, 21, 2.
+
+- guestfish-lv-ext4-4k.qtr
+
+  $ guestfish \
+      alloc test1.img 40M : \
+      run : \
+      part-disk /dev/vda mbr : \
+      pvcreate /dev/vda : \
+      vgcreate VG /dev/vda : \
+      lvcreate LV VG 32 : \
+      mkfs-opts ext4 /dev/VG/LV blocksize:4096
+
+  Some points to note:
+    * an ext4 filesystem, so it has a journal and extents
+    * 4K block size, so we expect writes to be aligned
+    * located inside an LV, so more realistic
+
+- guestfish-lv-ext4-4k-write-hello.qtr
+
+  $ guestfish -a test1.img -m /dev/VG/LV \
+      debug qtrace "/dev/vda on" : \
+      write /hello "hello, world." : \
+      debug qtrace "/dev/vda off"
+  where test1.img was created by the previous command.

contrib/visualize-alignment/guestfish-N-fs-10M-aligned-part-disk.qtr

@@ -0,0 +1,122 @@
+S 20480
+R 0 1
+R 0 8
+R 8 8
+R 20352 8
+R 20464 8
+R 0 8
+R 8 8
+R 20472 8
+R 20216 8
+R 20416 8
+R 20224 8
+R 20080 8
+R 2048 8
+R 24 8
+R 56 8
+R 120 8
+R 16 8
+R 128 8
+R 64 8
+R 512 8
+R 32 8
+R 4096 8
+R 0 32
+R 20352 8
+R 20464 8
+R 0 8
+R 8 8
+R 0 8
+R 0 8
+R 0 32
+R 32 64
+R 128 8
+R 20456 8
+W 0 24
+W 20456 24
+R 0 8
+R 8 24
+W 0 8
+R 20352 8
+R 20464 8
+R 0 32
+R 32 64
+W 0 8
+R 20472 8
+R 20216 8
+R 20472 8
+R 20416 8
+R 20224 8
+R 20080 8
+R 20464 8
+R 8 8
+R 0 8
+R 2048 8
+R 24 8
+R 56 8
+R 120 8
+R 16 8
+R 128 8
+R 64 8
+R 512 8
+R 32 8
+R 4096 8
+R 20288 8
+R 20400 8
+R 64 8
+R 72 8
+R 20416 1
+R 20160 8
+R 20408 8
+R 2112 8
+R 88 8
+R 120 8
+R 184 8
+R 80 8
+R 192 8
+R 128 8
+R 576 8
+R 96 8
+R 4160 8
+R 0 8
+R 64 2
+W 64 379
+W 443 55
+W 16450 4
+W 16532 92
+R 20416 1
+R 20160 1
+R 20161 1
+R 20162 1
+R 20163 5
+R 2112 1
+R 2113 1
+R 2114 6
+R 576 1
+R 577 1
+R 578 6
+R 4160 1
+R 4161 1
+R 4162 6
+R 0 8
+W 16624 230
+W 20288 128
+W 66 2
+R 20288 8
+R 20400 8
+R 64 8
+R 72 8
+R 20416 1
+R 20160 8
+R 20408 8
+R 2112 8
+R 88 8
+R 120 8
+R 184 8
+R 80 8
+R 192 8
+R 128 8
+R 576 8
+R 96 8
+R 4160 8
+R 0 8

contrib/visualize-alignment/guestfish-N-fs-10M.qtr

@@ -0,0 +1,122 @@
+S 20480
+R 0 1
+R 0 8
+R 8 8
+R 20352 8
+R 20464 8
+R 0 8
+R 8 8
+R 20472 8
+R 20216 8
+R 20416 8
+R 20224 8
+R 20080 8
+R 2048 8
+R 24 8
+R 56 8
+R 120 8
+R 16 8
+R 128 8
+R 64 8
+R 512 8
+R 32 8
+R 4096 8
+R 0 32
+R 20352 8
+R 20464 8
+R 0 8
+R 8 8
+R 0 8
+R 0 8
+R 0 32
+R 32 64
+R 128 8
+R 20456 8
+W 0 24
+W 20456 24
+R 0 8
+R 8 24
+W 0 8
+R 20352 8
+R 20464 8
+R 0 32
+R 32 64
+W 0 8
+R 20472 8
+R 20216 8
+R 20416 8
+R 20224 8
+R 20080 8
+R 20464 8
+R 8 8
+R 0 8
+R 2048 8
+R 24 8
+R 56 8
+R 120 8
+R 16 8
+R 128 8
+R 64 8
+R 512 8
+R 32 8
+R 4096 8
+R 20225 8
+R 20457 8
+R 1 8
+R 9 8
+R 20473 7
+R 20217 8
+R 20465 8
+R 2049 8
+R 25 8
+R 57 8
+R 121 8
+R 17 8
+R 129 8
+R 65 8
+R 513 8
+R 33 8
+R 4097 8
+R 0 8
+R 1 2
+R 20225 8
+W 1 436
+W 16387 1
+W 16388 3
+W 16469 324
+W 20225 248
+R 20473 7
+R 20217 8
+R 2049 1
+R 2050 1
+R 2051 6
+R 513 1
+R 514 1
+R 515 1
+R 516 1
+R 517 1
+R 518 1
+R 519 1
+R 520 1
+R 4097 1
+R 4098 7
+R 0 8
+W 3 2
+R 20225 8
+R 20457 8
+R 1 8
+R 9 8
+R 20473 7
+R 20217 8
+R 20465 8
+R 2049 8
+R 25 8
+R 57 8
+R 121 8
+R 17 8
+R 129 8
+R 65 8
+R 513 8
+R 33 8
+R 4097 8
+R 0 8

contrib/visualize-alignment/guestfish-add-mount.qtr

@@ -0,0 +1,72 @@
+S 20480
+R 0 1
+R 0 8
+R 20352 8
+R 20464 8
+R 0 8
+R 8 8
+R 20472 8
+R 20216 8
+R 20416 8
+R 20224 8
+R 20080 8
+R 2048 8
+R 24 8
+R 56 8
+R 120 8
+R 16 8
+R 128 8
+R 64 8
+R 512 8
+R 32 8
+R 4096 8
+R 20288 8
+R 20400 8
+R 64 8
+R 72 8
+R 20416 1
+R 20160 8
+R 20408 8
+R 2112 8
+R 88 8
+R 120 8
+R 184 8
+R 80 8
+R 192 8
+R 128 8
+R 576 8
+R 96 8
+R 4160 8
+R 0 8
+R 0 32
+R 20288 1
+R 20400 1
+R 64 1
+R 72 1
+R 64 4
+R 64 4
+R 20288 8
+R 20400 8
+R 64 8
+R 72 8
+R 20416 1
+R 20160 8
+R 20408 8
+R 2112 8
+R 88 8
+R 120 8
+R 184 8
+R 80 8
+R 192 8
+R 128 8
+R 576 8
+R 96 8
+R 4160 8
+R 66 2
+R 68 2
+R 152 2
+W 66 2
+W 66 2
+W 66 2
+W 66 2
+W 66 2

contrib/visualize-alignment/guestfish-lv-ext4-4k-write-hello.qtr

@@ -0,0 +1,104 @@
+S 81920
+R 0 1
+R 0 8
+R 8 8
+R 81792 8
+R 81904 8
+R 0 8
+R 8 8
+R 81912 8
+R 81656 8
+R 81856 8
+R 81664 8
+R 81520 8
+R 0 32
+R 81792 8
+R 81904 8
+R 0 8
+R 8 8
+R 0 8
+R 8 8
+R 8 8
+R 8 8
+R 8 8
+R 8 8
+R 8 8
+R 0 8
+R 8 8
+R 8 8
+R 8 8
+R 0 8
+R 8 8
+R 8 8
+R 8 8
+R 8 8
+R 8 8
+R 8 8
+R 65792 8
+R 65904 8
+R 384 8
+R 392 8
+R 65912 8
+R 65656 8
+R 65856 8
+R 65664 8
+R 65520 8
+R 2432 8
+R 408 8
+R 440 8
+R 504 8
+R 400 8
+R 512 8
+R 448 8
+R 896 8
+R 416 8
+R 4480 8
+R 65792 8
+R 65904 8
+R 384 8
+R 392 8
+R 65912 8
+R 65656 8
+R 65856 8
+R 65664 8
+R 65520 8
+R 2432 8
+R 408 8
+R 440 8
+R 504 8
+R 400 8
+R 512 8
+R 448 8
+R 896 8
+R 416 8
+R 4480 8
+R 386 2
+R 384 8
+R 392 8
+R 664 8
+R 456 8
+W 384 8
+R 2 1
+R 21 1
+R 15 1
+R 2 1
+R 416 8
+R 536 8
+R 664 8
+R 408 8
+W 456 8
+W 464 8
+W 10712 8
+W 472 40
+W 512 8
+W 392 8
+W 408 16
+W 536 8
+W 664 8
+R 2 1
+R 15 1
+R 21 1
+R 2 1
+W 384 8
+W 456 8
+W 384 8

contrib/visualize-alignment/guestfish-lv-ext4-4k.qtr

@@ -0,0 +1,450 @@
+S 81920
+R 0 1
+R 0 8
+R 8 8
+R 81792 8
+R 81904 8
+R 0 8
+R 8 8
+R 81912 8
+R 81656 8
+R 81856 8
+R 81664 8
+R 81520 8
+R 2048 8
+R 24 8
+R 56 8
+R 120 8
+R 16 8
+R 128 8
+R 64 8
+R 512 8
+R 32 8
+R 4096 8
+R 0 32
+R 81792 8
+R 81904 8
+R 0 8
+R 8 8
+R 0 8
+R 0 8
+R 0 32
+R 32 64
+R 128 8
+R 81896 8
+W 0 24
+W 81896 24
+R 81792 8
+R 81904 8
+R 0 32
+W 0 8
+R 32 8
+R 40 56
+R 81912 8
+R 81656 8
+R 81856 8
+R 81664 8
+R 81520 8
+R 81904 8
+R 32 8
+R 0 32
+W 0 8
+R 2048 8
+R 120 8
+R 16 8
+R 128 8
+R 64 8
+R 0 8
+R 512 8
+R 32 8
+R 4096 8
+R 81728 8
+R 81840 8
+R 64 8
+R 72 8
+R 81856 1
+R 81600 8
+R 81848 8
+R 2112 8
+R 88 8
+R 120 8
+R 184 8
+R 80 8
+R 192 8
+R 128 8
+R 576 8
+R 96 8
+R 4160 8
+R 0 8
+R 0 8
+R 81792 8
+R 81904 8
+R 81792 8
+R 81904 8
+R 0 8
+R 8 8
+R 81912 8
+R 81656 8
+R 81856 8
+R 81664 8
+R 81520 8
+R 2048 8
+R 24 8
+R 56 8
+R 120 8
+R 16 8
+R 128 8
+R 64 8
+R 512 8
+R 32 8
+R 4096 8
+R 0 8
+R 8 8
+R 0 8
+R 8 8
+R 24 8
+R 120 8
+R 8 8
+R 81792 8
+R 81904 8
+R 0 8
+R 8 8
+R 81912 8
+R 81656 8
+R 81856 8
+R 81664 8
+R 81520 8
+R 2048 8
+R 24 8
+R 56 8
+R 120 8
+R 16 8
+R 128 8
+R 64 8
+R 512 8
+R 32 8
+R 4096 8
+W 8 8
+R 0 8
+R 0 8
+W 0 8
+R 8 8
+W 8 8
+R 0 8
+W 0 8
+R 81792 8
+R 81904 8
+R 0 8
+R 8 8
+R 81912 8
+R 81656 8
+R 81856 8
+R 81664 8
+R 81520 8
+R 0 8
+R 8 8
+R 81792 8
+R 81904 8
+R 0 8
+R 8 8
+R 81912 8
+R 81656 8
+R 81856 8
+R 81664 8
+R 81520 8
+R 81792 8
+R 81904 8
+R 0 8
+R 8 8
+R 81728 1
+R 81840 1
+R 64 1
+R 72 1
+R 64 4
+R 81792 8
+R 81904 8
+R 0 8
+R 8 8
+R 81912 8
+R 81656 8
+R 81856 8
+R 81664 8
+R 81520 8
+R 81728 8
+R 81840 8
+R 64 8
+R 72 8
+R 81856 1
+R 81600 8
+R 81848 1
+R 81849 1
+R 81850 1
+R 81851 1
+R 81852 4
+R 2112 1
+R 2113 1
+R 2114 1
+R 2115 1
+R 2116 1
+R 2117 1
+R 2118 1
+R 2119 1
+R 88 1
+R 89 1
+R 90 1
+R 91 1
+R 92 1
+R 93 1
+R 94 1
+R 95 1
+R 120 1
+R 121 1
+R 122 1
+R 123 1
+R 124 1
+R 125 1
+R 126 1
+R 127 1
+R 184 1
+R 185 1
+R 186 6
+R 80 1
+R 81 1
+R 82 1
+R 83 1
+R 84 1
+R 85 3
+R 192 1
+R 193 1
+R 194 1
+R 195 1
+R 196 1
+R 197 1
+R 198 1
+R 199 1
+R 128 1
+R 129 1
+R 130 1
+R 131 1
+R 132 1
+R 133 1
+R 134 1
+R 135 1
+R 576 1
+R 577 1
+R 578 1
+R 579 1
+R 580 1
+R 581 1
+R 582 1
+R 583 1
+R 96 1
+R 97 1
+R 98 1
+R 99 1
+R 100 1
+R 101 1
+R 102 1
+R 103 1
+R 4160 1
+R 4161 1
+R 4162 1
+R 4163 1
+R 4164 1
+R 4165 1
+R 4166 1
+R 4167 1
+R 0 32
+R 81792 8
+R 81904 8
+R 0 8
+R 56 8
+R 8 8
+R 81728 1
+R 81840 1
+R 64 1
+R 72 1
+R 64 4
+R 81728 8
+R 81840 8
+R 64 8
+R 72 8
+R 81856 1
+R 81600 8
+R 81848 8
+R 2112 8
+R 88 8
+R 120 8
+R 184 8
+R 80 8
+R 192 8
+R 128 8
+R 576 8
+R 96 8
+R 4160 8
+R 0 8
+R 0 8
+R 24 8
+R 56 8
+R 8 8
+R 0 8
+R 8 8
+R 81792 8
+R 81904 8
+R 8 8
+R 0 8
+R 81792 8
+R 81904 8
+R 0 8
+R 8 8
+R 0 8
+R 8 8
+R 81728 1
+R 81840 1
+R 64 1
+R 72 1
+R 64 1
+R 65 3
+R 81912 8
+R 81656 8
+R 81856 8
+R 81664 8
+R 81520 8
+R 81728 8
+R 81840 8
+R 64 8
+R 72 8
+R 81856 1
+R 81600 8
+R 81848 8
+R 2112 8
+R 88 8
+R 120 8
+R 184 8
+R 80 8
+R 192 8
+R 128 8
+R 576 8
+R 96 8
+R 4160 8
+R 8 8
+R 8 8
+W 8 8
+R 8 8
+R 8 8
+W 8 8
+R 8 8
+R 8 8
+W 8 8
+R 81728 8
+R 81840 8
+R 64 8
+R 72 8
+R 81856 1
+R 81600 8
+R 81848 8
+R 2112 8
+R 88 8
+R 120 8
+R 184 8
+R 80 8
+R 192 8
+R 128 8
+R 576 8
+R 96 8
+R 4160 8
+R 81792 8
+R 81904 8
+R 0 8
+R 8 8
+R 81912 8
+R 81656 8
+R 81856 8
+R 81664 8
+R 81520 8
+R 0 8
+R 8 8
+R 8 8
+R 8 8
+R 64 4
+R 8 8
+R 8 8
+R 8 8
+R 8 8
+R 8 8
+R 8 8
+W 8 8
+R 8 8
+R 8 8
+R 8 8
+W 8 8
+R 8 8
+R 8 8
+R 8 8
+W 8 8
+R 0 8
+R 8 8
+R 8 8
+R 8 8
+R 8 8
+R 8 8
+R 8 8
+R 81728 8
+R 81840 8
+R 64 8
+R 72 8
+R 81856 1
+R 81600 8
+R 81848 8
+R 2112 8
+R 88 8
+R 120 8
+R 184 8
+R 80 8
+R 192 8
+R 128 8
+R 576 8
+R 96 8
+R 4160 8
+R 0 8
+R 24 8
+R 56 8
+R 65792 8
+R 65904 8
+R 384 8
+R 392 8
+R 65912 8
+R 65656 8
+R 65856 8
+R 65664 8
+R 65520 8
+R 2432 8
+R 408 8
+R 440 8
+R 504 8
+R 400 8
+R 512 8
+R 448 8
+R 896 8
+R 416 8
+R 4480 8
+R 384 8
+W 384 8
+R 81792 8
+R 81904 8
+R 8 8
+R 81912 8
+R 81656 8
+R 81856 8
+R 81664 8
+R 81520 8
+R 384 8
+W 384 3032
+W 3416 576
+W 3992 1448
+W 5440 1608
+W 7048 3032
+W 10080 632
+W 65792 128
+W 384 8
+W 384 8

contrib/visualize-alignment/guestfish-write-hello.qtr

@@ -0,0 +1,101 @@
+S 20480
+R 0 1
+R 0 8
+R 20352 8
+R 20464 8
+R 0 8
+R 8 8
+R 20472 8
+R 20216 8
+R 20416 8
+R 20224 8
+R 20080 8
+R 2048 8
+R 24 8
+R 56 8
+R 120 8
+R 16 8
+R 128 8
+R 64 8
+R 512 8
+R 32 8
+R 4096 8
+R 20288 8
+R 20400 8
+R 64 8
+R 72 8
+R 20416 1
+R 20160 8
+R 20408 8
+R 2112 8
+R 88 8
+R 120 8
+R 184 8
+R 80 8
+R 192 8
+R 128 8
+R 576 8
+R 96 8
+R 4160 8
+R 0 8
+R 0 32
+R 20288 1
+R 20400 1
+R 64 1
+R 72 1
+R 64 4
+R 64 4
+R 20288 8
+R 20400 8
+R 64 8
+R 72 8
+R 20416 1
+R 20160 8
+R 20408 8
+R 2112 8
+R 88 8
+R 120 8
+R 184 8
+R 80 8
+R 192 8
+R 128 8
+R 576 8
+R 96 8
+R 4160 8
+R 66 2
+R 68 2
+R 152 2
+W 66 2
+W 66 2
+W 66 2
+W 66 2
+R 2 1
+R 21 1
+R 15 1
+R 2 1
+W 66 2
+W 66 2
+W 66 2
+R 470 2
+R 150 2
+R 154 2
+R 148 2
+W 470 2
+W 11330 2
+R 152 2
+W 66 2
+W 68 2
+W 148 8
+W 66 2
+W 66 2
+R 2 1
+R 15 1
+R 21 1
+R 2 1
+W 66 2
+W 66 2
+W 66 2
+W 66 2
+W 66 2
+W 66 2
+W 66 2

contrib/visualize-alignment/qemu-0.13-trace-block-device-access.patch

@@ -0,0 +1,104 @@
+From e04ef476fd330485e5a88c7018d29c55cf411fe2 Mon Sep 17 00:00:00 2001
+From: Richard W.M. Jones <rjones@redhat.com>
+Date: Tue, 5 Oct 2010 09:54:10 +0100
+Subject: [PATCH] Trace reads and writes to qemu block devices.
+
+NB: This patch is not suitable for nor intended to go upstream in
+its current form.
+
+When qemu opens a block device, this patch creates a trace file
+in /tmp with a name related to the block device.  Reads and writes
+to the device cause lines to be written to the trace file:
+
+  S <total_sectors>
+  W <sector> <nb_sectors>
+  R <sector> <nb_sectors>
+
+'S' is the summary line, printed first which just tells you how
+many sectors are on the device.
+
+'W' and 'R' are writes and reads, for the range <sector> through
+to <sector> + <nb_sectors> - 1.
+---
+ block.c     |   29 +++++++++++++++++++++++++++++
+ block_int.h |    3 +++
+ 2 files changed, 32 insertions(+), 0 deletions(-)
+
+diff --git a/block.c b/block.c
+index ebbc376..26ead5b 100644
+--- a/block.c
++++ b/block.c
+@@ -474,6 +474,23 @@ static int bdrv_open_common(BlockDriverState *bs, const char *filename,
+         goto free_and_fail;
+     }
+ 
++    /* Open trace file in /tmp based on filename. XXX */
++    size_t len = strlen (filename);
++    char *trace_file = qemu_malloc (10 + len);
++    snprintf (trace_file, 10 + len, "/tmp/%s.qtr", filename);
++    size_t i;
++    for (i = 5; i < 5 + len; ++i) {
++        if (trace_file[i] == '/')
++            trace_file[i] = '_';
++    }
++    bs->trace_fp = fopen (trace_file, "w");
++    if (bs->trace_fp) {
++        setlinebuf (bs->trace_fp);
++        fprintf (bs->trace_fp, "S %" PRIi64 "\n", bs->total_sectors);
++    } else {
++        perror (trace_file);
++    }
++
+ #ifndef _WIN32
+     if (bs->is_temporary) {
+         unlink(filename);
+@@ -665,6 +682,10 @@ void bdrv_close(BlockDriverState *bs)
+             bdrv_close(bs->file);
+         }
+ 
++        if (bs->trace_fp)
++            fclose (bs->trace_fp);
++        bs->trace_fp = NULL;
++
+         /* call the change callback */
+         bs->media_changed = 1;
+         if (bs->change_cb)
+@@ -1995,6 +2016,10 @@ BlockDriverAIOCB *bdrv_aio_readv(BlockDriverState *bs, int64_t sector_num,
+ 	/* Update stats even though technically transfer has not happened. */
+ 	bs->rd_bytes += (unsigned) nb_sectors * BDRV_SECTOR_SIZE;
+ 	bs->rd_ops ++;
++
++        if (bs->trace_fp)
++            fprintf (bs->trace_fp,
++                     "R %" PRIi64 " %d\n", sector_num, nb_sectors);
+     }
+ 
+     return ret;
+@@ -2028,6 +2053,10 @@ BlockDriverAIOCB *bdrv_aio_writev(BlockDriverState *bs, int64_t sector_num,
+         if (bs->wr_highest_sector < sector_num + nb_sectors - 1) {
+             bs->wr_highest_sector = sector_num + nb_sectors - 1;
+         }
++
++        if (bs->trace_fp)
++            fprintf (bs->trace_fp,
++                     "W %" PRIi64 " %d\n", sector_num, nb_sectors);
+     }
+ 
+     return ret;
+diff --git a/block_int.h b/block_int.h
+index e8e7156..03e7c9b 100644
+--- a/block_int.h
++++ b/block_int.h
+@@ -178,6 +178,9 @@ struct BlockDriverState {
+     uint64_t wr_ops;
+     uint64_t wr_highest_sector;
+ 
++    /* Trace to file. */
++    FILE *trace_fp;
++
+     /* Whether the disk can expand beyond total_sectors */
+     int growable;
+ 
+-- 
+1.7.3.1
+

contrib/visualize-alignment/tracetops.ml

@@ -0,0 +1,423 @@
+#!/usr/bin/ocamlrun /usr/bin/ocaml
+
+(* Convert *.qtr (qemu block device trace) to Postscript.
+ * Copyright (C) 2009-2012 Red Hat Inc.
+ * By Richard W.M. Jones <rjones@redhat.com>.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ *)
+
+(* Note that we use ordinary OCaml ints, which means this program is
+ * limited to: ~1TB disks for 32 bit machines, or effectively unlimited
+ * for 64 bit machines.  Also we make several 512 byte sector
+ * assumptions.
+ *)
+
+#use "topfind";;
+#require "extlib";;
+
+open ExtList
+open Scanf
+open Printf
+
+type op = Read | Write
+
+(* If 'true' then print debug messages. *)
+let debug = true
+
+(* Width of each row (in sectors) in the output. *)
+let row_size = 64
+
+(* Desirable alignment (sectors). *)
+let alignment = 8
+
+(* Height (in 1/72 inch) of the final image. *)
+let height = 6.*.72.
+
+(* Width (in 1/72 inch) of the final image. *)
+let width = 6.*.72.
+
+(* Reserve at left for the sector number (comes out of width). *)
+let sn_width = 36.
+
+let input =
+  if Array.length Sys.argv = 2 then
+    Sys.argv.(1)
+  else
+    failwith "usage: tracetops filename.qtr"
+
+(* Read the input file. *)
+let nb_sectors, accesses =
+  let chan = open_in input in
+  let nb_sectors =
+    let summary = input_line chan in
+    if String.length summary < 1 || summary.[0] <> 'S' then
+      failwith (sprintf "%s: input is not a qemu block device trace file"
+                  input);
+    sscanf summary "S %d" (fun x -> x) in
+
+  if nb_sectors mod row_size <> 0 then
+    failwith (sprintf "input nb_sectors (%d) not divisible by row size (%d)"
+                nb_sectors row_size);
+
+  (* Read the reads and writes from the remainder of the file. *)
+  let accesses = ref [] in
+  let rec loop () =
+    let line = input_line chan in
+    let rw, s, n = sscanf line "%c %d %d" (fun rw s n -> (rw, s, n)) in
+    let rw =
+      match rw with
+      | 'R' -> Read | 'W' -> Write
+      | c -> failwith
+          (sprintf "%s: error reading input: got '%c', expecting 'R' or 'W'"
+             input c) in
+    if n < 0 || s < 0 || s+n > nb_sectors then
+      failwith (sprintf "%s: s (%d), n (%d) out of range" input s n);
+    let aligned = s mod alignment = 0 && n mod alignment = 0 in
+    accesses := (rw, aligned, s, n) :: !accesses;
+    loop ()
+  in
+  (try loop () with
+   | End_of_file -> ()
+   | Scan_failure msg ->
+       failwith (sprintf "%s: error reading input: %s" input msg)
+  );
+  close_in chan;
+
+  let accesses = List.rev !accesses in
+
+  if debug then (
+    eprintf "%s: nb_sectors = %d, accesses = %d\n"
+      input nb_sectors (List.length accesses)
+  );
+
+  nb_sectors, accesses
+
+(* If the accesses list contains any qtrace on/off patterns (in
+ * guestfish: debug "qtrace /dev/vda (on|off)") then filter out the
+ * things we want to display.  Otherwise leave the whole trace.
+ *)
+let accesses =
+  let contains_qtrace_patterns =
+    let rec loop = function
+      | [] -> false
+      | (Read, _, 2, 1) :: (Read, _, 21, 1) :: (Read, _, 15, 1) ::
+          (Read, _, 2, 1) :: _ -> true
+      | (Read, _, 2, 1) :: (Read, _, 15, 1) :: (Read, _, 21, 1) ::
+          (Read, _, 2, 1) :: _ -> true
+      | _ :: rest -> loop rest
+    in
+    loop accesses in
+
+  if contains_qtrace_patterns then (
+    if debug then eprintf "%s: contains qtrace on/off patterns\n%!" input;
+
+    let rec find_qtrace_on = function
+      | [] -> []
+      | (Read, _, 2, 1) :: (Read, _, 21, 1) :: (Read, _, 15, 1) ::
+          (Read, _, 2, 1) :: rest -> rest
+      | (Read, _, 2, 1) :: (Read, _, 15, 1) :: (Read, _, 21, 1) ::
+          (Read, _, 2, 1) :: rest ->
+          eprintf "ignored 'qtrace off' pattern when expecting 'qtrace on'\n";
+          find_qtrace_on rest
+      | _ :: rest -> find_qtrace_on rest
+    and split_until_qtrace_off = function
+      | [] -> [], []
+      | (Read, _, 2, 1) :: (Read, _, 15, 1) :: (Read, _, 21, 1) ::
+          (Read, _, 2, 1) :: rest -> [], rest
+      | (Read, _, 2, 1) :: (Read, _, 21, 1) :: (Read, _, 15, 1) ::
+          (Read, _, 2, 1) :: rest ->
+          eprintf "found 'qtrace on' pattern when expecting 'qtrace off'\n";
+          split_until_qtrace_off rest
+      | x :: ys ->
+          let xs, ys = split_until_qtrace_off ys in
+          x :: xs, ys
+    and filter_accesses xs =
+      let xs = find_qtrace_on xs in
+      if xs <> [] then (
+        let xs, ys = split_until_qtrace_off xs in
+        let ys = filter_accesses ys in
+        xs @ ys
+      ) else
+        []
+    in
+    filter_accesses accesses
+  ) else
+    accesses
+
+let ranges =
+  (* Given the number of sectors, make the row array. *)
+  let nr_rows = nb_sectors / row_size in
+  let rows = Array.make nr_rows false in
+
+  List.iter (
+    fun (_, _, s, n) ->
+      let i0 = s / row_size in
+      let i1 = (s+n-1) / row_size in
+      for i = i0 to i1 do rows.(i) <- true done;
+  ) accesses;
+
+  (* Coalesce rows into a list of ranges of rows we will draw. *)
+  let rows = Array.to_list rows in
+  let rows = List.mapi (fun i v -> (v, i)) rows in
+  let ranges =
+    (* When called, we are in the middle of a range which started at i0. *)
+    let rec loop i0 = function
+      | (false, _) :: (false, _) :: (true, i1) :: []
+      | _ :: (_, i1) :: []
+      | (_, i1) :: [] ->
+          [i0, i1]
+      | (false, _) :: (false, _) :: (true, _) :: rest
+      | (false, _) :: (true, _) :: rest
+      | (true, _) :: rest ->
+          loop i0 rest
+      | (false, i1) :: rest ->
+          let i1 = i1 - 1 in
+          let rest = List.dropwhile (function (v, _) -> not v) rest in
+          (match rest with
+           | [] -> [i0, i1]
+           | (_, i2) :: rest -> (i0, i1) :: loop i2 rest)
+      | [] -> assert false
+    in
+    loop 0 (List.tl rows) in
+
+  if debug then (
+    eprintf "%s: rows = %d (ranges = %d)\n" input nr_rows (List.length ranges);
+    List.iter (
+      fun (i0, i1) ->
+        eprintf "  %d - %d (rows %d - %d)\n"
+          (i0 * row_size) ((i1 + 1) * row_size - 1) i0 i1
+    ) ranges
+  );
+
+  ranges
+
+(* Locate where we will draw the rows and cells in the final image. *)
+let iter_rows, mapxy, row_height, cell_width =
+  let nr_ranges = List.length ranges in
+  let nr_breaks = nr_ranges - 1 in
+  let nr_rows =
+    List.fold_left (+) 0 (List.map (fun (i0,i1) -> i1-i0+1) ranges) in
+  let nr_rnb = nr_rows + nr_breaks in
+  let row_height = height /. float nr_rnb in
+  let cell_width = (width -. sn_width) /. float row_size in
+
+  if debug then (
+    eprintf "number of rows and breaks = %d\n" nr_rnb;
+    eprintf "row_height x cell_width = %g x %g\n" row_height cell_width
+  );
+
+  (* Create a higher-order function to iterate over the rows. *)
+  let rec iter_rows f =
+    let rec loop row = function
+      | [] -> ()
+      | (i0,i1) :: rows ->
+          for i = i0 to i1 do
+            let y = float (row+i-i0) *. row_height in
+            f y (Some i)
+          done;
+          (* Call an extra time for the break. *)
+          let y = float (row+i1-i0+1) *. row_height in
+          if rows <> [] then f y None;
+          (* extra +1 here is to skip the break *)
+          loop (row+i1-i0+1+1) rows
+    in
+    loop 0 ranges
+  in
+
+  (* Create a hash which maps from the row number to the position
+   * where we draw the row.  If the row is not drawn, the hash value
+   * is missing.
+   *)
+  let row_y = Hashtbl.create nr_rows in
+  iter_rows (
+    fun y ->
+      function
+      | Some i -> Hashtbl.replace row_y i y
+      | None -> ()
+  );
+
+  (* Create a function which maps from the sector number to the final
+   * position that we will draw it.
+   *)
+  let mapxy s =
+    let r = s / row_size in
+    let y = try Hashtbl.find row_y r with Not_found -> assert false in
+    let x = sn_width +. cell_width *. float (s mod row_size) in
+    x, y
+  in
+
+  iter_rows, mapxy, row_height, cell_width
+
+(* Start the PostScript file. *)
+let () =
+  printf "%%!PS-Adobe-3.0 EPSF-3.0\n";
+  printf "%%%%BoundingBox: -10 -10 %g %g\n"
+    (width +. 10.) (height +. row_height +. 20.);
+  printf "%%%%Creator: tracetops.ml (part of libguestfs)\n";
+  printf "%%%%Title: %s\n" input;
+  printf "%%%%LanguageLevel: 2\n";
+  printf "%%%%Pages: 1\n";
+  printf "%%%%Page: 1 1\n";
+  printf "\n";
+
+  printf "/min { 2 copy gt { exch } if pop } def\n";
+  printf "/max { 2 copy lt { exch } if pop } def\n";
+
+  (* Function for drawing cells. *)
+  printf "/cell {\n";
+  printf "  newpath\n";
+  printf "    moveto\n";
+  printf "    %g 0 rlineto\n" cell_width;
+  printf "    0 %g rlineto\n" row_height;
+  printf "    -%g 0 rlineto\n" cell_width;
+  printf "  closepath\n";
+  printf "  gsave fill grestore 0.75 setgray stroke\n";
+  printf "} def\n";
+
+  (* Define colours for different cell types. *)
+  printf "/unalignedread  { 0.95 0.95 0 setrgbcolor } def\n";
+  printf "/unalignedwrite { 0.95 0 0    setrgbcolor } def\n";
+  printf "/alignedread    { 0 0.95 0    setrgbcolor } def\n";
+  printf "/alignedwrite   { 0 0 0.95    setrgbcolor } def\n";
+
+  (* Get width of text. *)
+  printf "/textwidth { stringwidth pop } def\n";
+
+  (* Draw the outline. *)
+  printf "/outline {\n";
+  printf "  newpath\n";
+  printf "    %g 0 moveto\n" sn_width;
+  printf "    %g 0 lineto\n" width;
+  printf "    %g %g lineto\n" width height;
+  printf "    %g %g lineto\n" sn_width height;
+  printf "  closepath\n";
+  printf "  0.5 setlinewidth 0.3 setgray stroke\n";
+  printf "} def\n";
+
+  (* Draw the outline breaks. *)
+  printf "/breaks {\n";
+  iter_rows (
+    fun y ->
+      function
+      | Some _ -> ()
+      | None ->
+          let f xmin xmax =
+            let yll = y +. row_height /. 3. -. 2. in
+            let ylr = y +. row_height /. 2. -. 2. in
+            let yur = y +. 2. *. row_height /. 3. in
+            let yul = y +. row_height /. 2. in
+            printf "  newpath\n";
+            printf "    %g %g moveto\n" xmin yll;
+            printf "    %g %g lineto\n" xmax ylr;
+            printf "    %g %g lineto\n" xmax yur;
+            printf "    %g %g lineto\n" xmin yul;
+            printf "  closepath\n";
+            printf "  1 setgray fill\n";
+            printf "  newpath\n";
+            printf "    %g %g moveto\n" xmin yll;
+            printf "    %g %g lineto\n" xmax ylr;
+            printf "    %g %g moveto\n" xmax yur;
+            printf "    %g %g lineto\n" xmin yul;
+            printf "  closepath\n";
+            printf "  0.5 setlinewidth 0.3 setgray stroke\n"
+          in
+          f (sn_width -. 6.) (sn_width +. 6.);
+          f (width -. 6.) (width +. 6.)
+  );
+  printf "} def\n";
+
+  (* Draw the labels. *)
+  printf "/labels {\n";
+  printf "  /Courier findfont\n";
+  printf "  0.75 %g mul 10 min scalefont\n" row_height;
+  printf "  setfont\n";
+  iter_rows (
+    fun y ->
+      function
+      | Some i ->
+          let sector = i * row_size in
+          printf "  newpath\n";
+          printf "    /s { (%d) } def\n" sector;
+          printf "    %g s textwidth sub 4 sub %g moveto\n" sn_width (y +. 2.);
+          printf "  s show\n"
+      | None -> ()
+  );
+  printf "} def\n";
+
+  (* Print the key. *)
+  printf "/key {\n";
+  printf "  /Times-Roman findfont\n";
+  printf "  10. scalefont\n";
+  printf "  setfont\n";
+  let x = sn_width and y = height +. 10. in
+  printf "  unalignedwrite %g %g cell\n" x y;
+  let x = x +. cell_width +. 4. in
+  printf "  newpath %g %g moveto (unaligned write) 0.3 setgray show\n" x y;
+  let x = x +. 72. in
+  printf "  unalignedread %g %g cell\n" x y;
+  let x = x +. cell_width +. 4. in
+  printf "  newpath %g %g moveto (unaligned read) 0.3 setgray show\n" x y;
+  let x = x +. 72. in
+  printf "  alignedwrite %g %g cell\n" x y;
+  let x = x +. cell_width +. 4. in
+  printf "  newpath %g %g moveto (aligned write) 0.3 setgray show\n" x y;
+  let x = x +. 72. in
+  printf "  alignedread %g %g cell\n" x y;
+  let x = x +. cell_width +. 4. in
+  printf "  newpath %g %g moveto (aligned read) 0.3 setgray show\n" x y;
+  printf "} def\n";
+
+  printf "\n"
+
+(* Draw the accesses. *)
+let () =
+  (* Sort the accesses so unaligned ones are displayed at the end (on
+   * top of aligned ones) and writes on top of reads.  This isn't
+   * really perfect, but it'll do.
+   *)
+  let cmp (rw, aligned, s, n) (rw', aligned', s', n') =
+    let r = compare rw rw' (* Write later *) in
+    if r <> 0 then r else (
+      let r = compare aligned' aligned (* unaligned later *) in
+      if r <> 0 then r else
+        compare (n, s) (n', s')
+    )
+  in
+  let accesses = List.sort ~cmp accesses in
+
+  List.iter (
+    fun op ->
+      let col, s, n =
+        match op with
+        | Read, false, s, n ->
+            "unalignedread", s, n
+        | Write, false, s, n ->
+            "unalignedwrite", s, n
+        | Read, true, s, n ->
+            "alignedread", s, n
+        | Write, true, s, n ->
+            "alignedwrite", s, n in
+      for i = s to s+n-1 do
+        let x, y = mapxy i in
+        printf "%s %g %g cell\n" col x y
+      done;
+      printf "\n"
+  ) accesses
+
+(* Finish off the PostScript output. *)
+let () =
+  printf "outline breaks labels key\n";
+  printf "%%%%EOF\n"

csharp/Makefile.am

@@ -0,0 +1,24 @@
+# libguestfs C# bindings
+# Copyright (C) 2010 Red Hat Inc.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+include $(top_srcdir)/subdir-rules.mk
+
+generator_built = \
+	Libguestfs.cs
+
+EXTRA_DIST = \
+	$(generator_built)

daemon/.gitignore

@@ -1,32 +0,0 @@
-build-aux
-lib
-link-warning.h
-m4/00gnulib.m4
-m4/errno_h.m4
-m4/error.m4
-m4/exitfail.m4
-m4/extensions.m4
-m4/gnulib-common.m4
-m4/gnulib-comp.m4
-m4/gnulib-tool.m4
-m4/hash.m4
-m4/include_next.m4
-m4/inline.m4
-m4/inttostr.m4
-m4/longlong.m4
-m4/manywarnings.m4
-m4/multiarch.m4
-m4/onceonly.m4
-m4/stdbool.m4
-m4/stddef_h.m4
-m4/stdint.m4
-m4/stdlib_h.m4
-m4/strerror.m4
-m4/string_h.m4
-m4/unistd_h.m4
-m4/warnings.m4
-m4/wchar.m4
-m4/wchar_t.m4
-m4/wint_t.m4
-m4/xalloc.m4
-tests

daemon/9p.c

@@ -0,0 +1,226 @@
+/* libguestfs - the guestfsd daemon
+ * Copyright (C) 2011 Red Hat Inc.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#include <config.h>
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <unistd.h>
+#include <limits.h>
+#include <errno.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <dirent.h>
+#include <fcntl.h>
+
+#include "daemon.h"
+#include "actions.h"
+
+#define BUS_PATH "/sys/bus/virtio/drivers/9pnet_virtio"
+
+static char *read_whole_file (const char *filename);
+
+/* https://bugzilla.redhat.com/show_bug.cgi?id=714981#c1 */
+char **
+do_list_9p (void)
+{
+  DECLARE_STRINGSBUF (r);
+
+  DIR *dir;
+
+  dir = opendir (BUS_PATH);
+  if (!dir) {
+    perror ("opendir: " BUS_PATH);
+    if (errno != ENOENT)
+      return NULL;
+
+    /* If this directory doesn't exist, it probably means that
+     * the virtio driver isn't loaded.  Don't return an error
+     * in this case, but return an empty list.
+     */
+    if (end_stringsbuf (&r) == -1)
+      return NULL;
+
+    return r.argv;
+  }
+
+  while (1) {
+    errno = 0;
+    struct dirent *d = readdir (dir);
+    if (d == NULL) break;
+
+    if (STRPREFIX (d->d_name, "virtio")) {
+      char mount_tag_path[256];
+      snprintf (mount_tag_path, sizeof mount_tag_path,
+                BUS_PATH "/%s/mount_tag", d->d_name);
+
+      /* A bit unclear, but it looks like the virtio transport allows
+       * the mount tag length to be unlimited (or up to 65536 bytes).
+       * See: linux/include/linux/virtio_9p.h
+       */
+      char *mount_tag = read_whole_file (mount_tag_path);
+      if (mount_tag == 0)
+        continue;
+
+      if (add_string (&r, mount_tag) == -1) {
+        free (mount_tag);
+        closedir (dir);
+        return NULL;
+      }
+
+      free (mount_tag);
+    }
+  }
+
+  /* Check readdir didn't fail */
+  if (errno != 0) {
+    reply_with_perror ("readdir: /sys/block");
+    free_stringslen (r.argv, r.size);
+    closedir (dir);
+    return NULL;
+  }
+
+  /* Close the directory handle */
+  if (closedir (dir) == -1) {
+    reply_with_perror ("closedir: /sys/block");
+    free_stringslen (r.argv, r.size);
+    return NULL;
+  }
+
+  /* Sort the tags. */
+  if (r.size > 0)
+    sort_strings (r.argv, r.size);
+
+  /* NULL terminate the list */
+  if (end_stringsbuf (&r) == -1)
+    return NULL;
+
+  return r.argv;
+}
+
+/* Read whole file into dynamically allocated array.  If there is an
+ * error, DON'T call reply_with_perror, just return NULL.  Returns a
+ * \0-terminated string.
+ */
+static char *
+read_whole_file (const char *filename)
+{
+  char *r = NULL;
+  size_t alloc = 0, size = 0;
+  int fd;
+
+  fd = open (filename, O_RDONLY|O_CLOEXEC);
+  if (fd == -1) {
+    perror (filename);
+    return NULL;
+  }
+
+  while (1) {
+    alloc += 256;
+    char *r2 = realloc (r, alloc);
+    if (r2 == NULL) {
+      perror ("realloc");
+      free (r);
+      close (fd);
+      return NULL;
+    }
+    r = r2;
+
+    /* The '- 1' in the size calculation ensures there is space below
+     * to add \0 to the end of the input.
+     */
+    ssize_t n = read (fd, r + size, alloc - size - 1);
+    if (n == -1) {
+      perror (filename);
+      free (r);
+      close (fd);
+      return NULL;
+    }
+    if (n == 0)
+      break;
+    size += n;
+  }
+
+  if (close (fd) == -1) {
+    perror (filename);
+    free (r);
+    return NULL;
+  }
+
+  r[size] = '\0';
+
+  return r;
+}
+
+/* Takes optional arguments, consult optargs_bitmask. */
+int
+do_mount_9p (const char *mount_tag, const char *mountpoint, const char *options)
+{
+  char *mp = NULL, *opts = NULL, *err = NULL;
+  struct stat statbuf;
+  int r = -1;
+
+  ABS_PATH (mountpoint, , return -1);
+
+  mp = sysroot_path (mountpoint);
+  if (!mp) {
+    reply_with_perror ("malloc");
+    goto out;
+  }
+
+  /* Check the mountpoint exists and is a directory. */
+  if (stat (mp, &statbuf) == -1) {
+    reply_with_perror ("%s", mountpoint);
+    goto out;
+  }
+  if (!S_ISDIR (statbuf.st_mode)) {
+    reply_with_perror ("%s: mount point is not a directory", mountpoint);
+    goto out;
+  }
+
+  /* Add trans=virtio to the options. */
+  if ((optargs_bitmask & GUESTFS_MOUNT_9P_OPTIONS_BITMASK) &&
+      STRNEQ (options, "")) {
+    if (asprintf (&opts, "trans=virtio,%s", options) == -1) {
+      reply_with_perror ("asprintf");
+      goto out;
+    }
+  }
+  else {
+    opts = strdup ("trans=virtio");
+    if (opts == NULL) {
+      reply_with_perror ("strdup");
+      goto out;
+    }
+  }
+
+  r = command (NULL, &err,
+               "mount", "-o", opts, "-t", "9p", mount_tag, mp, NULL);
+  if (r == -1) {
+    reply_with_error ("%s on %s: %s", mount_tag, mountpoint, err);
+    goto out;
+  }
+
+  r = 0;
+ out:
+  free (err);
+  free (opts);
+  free (mp);
+  return r;
+}

daemon/Makefile.am

@@ -1,5 +1,5 @@
 # libguestfs-daemon
-# Copyright (C) 2009 Red Hat Inc.
+# Copyright (C) 2011 Red Hat Inc.
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -13,22 +13,92 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with this program; if not, write to the Free Software
-# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
-ACLOCAL_AMFLAGS = -I m4
+include $(top_srcdir)/subdir-rules.mk
 
-SUBDIRS = lib tests .
+libsrcdir = $(top_builddir)/src
 
-noinst_PROGRAMS = guestfsd
-guestfsd_SOURCES = \
+generator_built = \
 	actions.h \
+	stubs.c \
+	names.c
+
+BUILT_SOURCES = \
+	$(generator_built) \
+	guestfs_protocol.c \
+	guestfs_protocol.h \
+	errnostring_gperf.c \
+	errnostring_gperf.gperf \
+	errnostring.c \
+	errnostring.h
+
+EXTRA_DIST = $(BUILT_SOURCES)
+
+noinst_LIBRARIES = libprotocol.a
+
+# This convenience library is solely to compile its generated sources with
+# custom flags.
+libprotocol_a_SOURCES = guestfs_protocol.c guestfs_protocol.h
+libprotocol_a_CFLAGS = -Wall -Wno-unused -fno-strict-aliasing
+
+guestfs_protocol.c: $(libsrcdir)/guestfs_protocol.c
+	rm -f $@
+	ln $< $@
+guestfs_protocol.h: $(libsrcdir)/guestfs_protocol.h
+	rm -f $@
+	ln $< $@
+$(libsrcdir)/guestfs_protocol.c: force
+	$(MAKE) -C $(libsrcdir) guestfs_protocol.c
+$(libsrcdir)/guestfs_protocol.h: force
+	$(MAKE) -C $(libsrcdir) guestfs_protocol.h
+
+# Build the errnostring perfect hash code.  The generated code has lots
+# of warnings so we must compile it in a separate mini-library.
+noinst_LIBRARIES += liberrnostring.a
+liberrnostring_a_SOURCES = \
+	errnostring_gperf.c \
+	errnostring.h \
+	errnostring.c
+liberrnostring_a_CFLAGS =
+
+errnostring_gperf.c: errnostring_gperf.gperf
+	rm -f $@
+	$(GPERF) -t $< > $@-t
+	mv $@-t $@
+errnostring_gperf.gperf: $(libsrcdir)/errnostring_gperf.gperf
+	rm -f $@
+	ln $< $@
+errnostring.c: $(libsrcdir)/errnostring.c
+	rm -f $@
+	ln $< $@
+errnostring.h: $(libsrcdir)/errnostring.h
+	rm -f $@
+	ln $< $@
+
+if INSTALL_DAEMON
+sbin_PROGRAMS = guestfsd
+else
+noinst_PROGRAMS = guestfsd
+endif
+
+guestfsd_SOURCES = \
+	9p.c \
+	actions.h \
+	available.c \
 	augeas.c \
+	base64.c \
+	blkid.c \
 	blockdev.c \
+	btrfs.c \
 	checksum.c \
 	cmp.c \
 	command.c \
+	compress.c \
+	copy.c \
 	cpmv.c \
 	daemon.h \
+	dd.c \
 	debug.c \
 	devsparts.c \
 	df.c \
@@ -40,25 +110,40 @@ guestfsd_SOURCES = \
 	ext2.c \
 	fallocate.c \
 	file.c \
+	findfs.c \
+	fill.c \
 	find.c \
 	fsck.c \
+	fstrim.c \
 	glob.c \
 	grep.c \
 	grub.c \
 	guestfsd.c \
 	headtail.c \
 	hexdump.c \
+	htonl.c \
 	initrd.c \
 	inotify.c \
+	internal.c \
+	is.c \
+	isoinfo.c \
+	labels.c \
 	link.c \
 	ls.c \
+	luks.c \
 	lvm.c \
+	lvm-filter.c \
+	md.c \
 	mkfs.c \
 	mknod.c \
 	modprobe.c \
 	mount.c \
 	names.c \
 	ntfs.c \
+	ntfsclone.c \
+	optgroups.c \
+	optgroups.h \
+	parted.c \
 	pingdaemon.c \
 	proto.c \
 	readdir.c \
@@ -68,21 +153,35 @@ guestfsd_SOURCES = \
 	sfdisk.c \
 	sleep.c \
 	stat.c \
+	statvfs.c \
 	strings.c \
 	stubs.c \
 	swap.c \
 	sync.c \
 	tar.c \
+	truncate.c \
 	umask.c \
 	upload.c \
+	utimens.c \
 	wc.c \
 	xattr.c \
 	zero.c \
-	zerofree.c \
-	$(top_builddir)/../src/guestfs_protocol.h \
-	$(top_builddir)/../src/guestfs_protocol.c
+	zerofree.c
+guestfsd_LDADD = \
+	liberrnostring.a \
+	libprotocol.a \
+	$(SELINUX_LIB) \
+	$(AUGEAS_LIBS) \
+	$(top_builddir)/gnulib/lib/.libs/libgnu.a \
+	$(GETADDRINFO_LIB) \
+	$(HOSTENT_LIB) \
+	$(INET_NTOP_LIB) \
+	$(LIBSOCKET) \
+	$(LIB_CLOCK_GETTIME) \
+	$(LIBINTL) \
+	$(SERVENT_LIB)
 
-AM_CPPFLAGS = -I$(srcdir)/lib -Ilib
-guestfsd_CFLAGS = $(WARN_CFLAGS) $(WERROR_CFLAGS)
+guestfsd_CPPFLAGS = -I$(top_srcdir)/gnulib/lib -I$(top_builddir)/gnulib/lib
+guestfsd_CFLAGS = $(WARN_CFLAGS) $(WERROR_CFLAGS) $(AUGEAS_CFLAGS)
 
-LDADD = lib/libgnu.a
+.PHONY: force

daemon/README

@@ -1 +0,0 @@
-Please see README in the parent directory.

daemon/augeas.c

@@ -13,7 +13,7 @@
  *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
- * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  */
 
 #include <config.h>
@@ -29,6 +29,7 @@
 
 #include "daemon.h"
 #include "actions.h"
+#include "optgroups.h"
 
 #ifdef HAVE_AUGEAS
 /* The Augeas handle.  We maintain a single handle per daemon, which
@@ -36,7 +37,17 @@
  * considerably.
  */
 static augeas *aug = NULL;
-#endif
+
+/* Clean up the augeas handle on daemon exit. */
+static void aug_finalize (void) __attribute__((destructor));
+static void
+aug_finalize (void)
+{
+  if (aug) {
+    aug_close (aug);
+    aug = NULL;
+  }
+}
 
 #define NEED_AUG(errcode)						\
   do {									\
@@ -47,11 +58,16 @@ static augeas *aug = NULL;
   }									\
   while (0)
 
+int
+optgroup_augeas_available (void)
+{
+  return 1;
+}
+
 /* We need to rewrite the root path so it is based at /sysroot. */
 int
 do_aug_init (const char *root, int flags)
 {
-#ifdef HAVE_AUGEAS
   char *buf;
 
   if (aug) {
@@ -74,26 +90,17 @@ do_aug_init (const char *root, int flags)
   }
 
   return 0;
-#else
-  reply_with_error ("%s is not available", __func__);
-  return -1;
-#endif
 }
 
 int
 do_aug_close (void)
 {
-#ifdef HAVE_AUGEAS
   NEED_AUG(-1);
 
   aug_close (aug);
   aug = NULL;
 
   return 0;
-#else
-  reply_with_error ("%s is not available", __func__);
-  return -1;
-#endif
 }
 
 int
@@ -111,7 +118,7 @@ do_aug_defvar (const char *name, const char *expr)
   }
   return r;
 #else
-  reply_with_error ("%s is not available", __func__);
+  reply_with_error ("function not available");
   return -1;
 #endif
 }
@@ -120,20 +127,29 @@ guestfs_int_int_bool *
 do_aug_defnode (const char *name, const char *expr, const char *val)
 {
 #ifdef HAVE_AUG_DEFNODE
-  static guestfs_int_int_bool r;
-  int created;
+  guestfs_int_int_bool *r;
+  int i, created;
 
   NEED_AUG (NULL);
 
-  r.i = aug_defnode (aug, name, expr, val, &created);
-  if (r.i == -1) {
+  i = aug_defnode (aug, name, expr, val, &created);
+  if (i == -1) {
     reply_with_error ("Augeas defnode failed");
     return NULL;
   }
-  r.b = created;
-  return &r;
+
+  r = malloc (sizeof *r);
+  if (r == NULL) {
+    reply_with_perror ("malloc");
+    return NULL;
+  }
+
+  r->i = i;
+  r->b = created;
+
+  return r;
 #else
-  reply_with_error ("%s is not available", __func__);
+  reply_with_error ("function not available");
   return NULL;
 #endif
 }
@@ -141,7 +157,6 @@ do_aug_defnode (const char *name, const char *expr, const char *val)
 char *
 do_aug_get (const char *path)
 {
-#ifdef HAVE_AUGEAS
   const char *value = NULL;
   char *v;
   int r;
@@ -175,16 +190,11 @@ do_aug_get (const char *path)
   }
 
   return v;			/* Caller frees. */
-#else
-  reply_with_error ("%s is not available", __func__);
-  return NULL;
-#endif
 }
 
 int
 do_aug_set (const char *path, const char *val)
 {
-#ifdef HAVE_AUGEAS
   int r;
 
   NEED_AUG (-1);
@@ -196,16 +206,27 @@ do_aug_set (const char *path, const char *val)
   }
 
   return 0;
-#else
-  reply_with_error ("%s is not available", __func__);
-  return -1;
-#endif
+}
+
+int
+do_aug_clear (const char *path)
+{
+  int r;
+
+  NEED_AUG (-1);
+
+  r = aug_set (aug, path, NULL);
+  if (r == -1) {
+    reply_with_error ("Augeas clear failed");
+    return -1;
+  }
+
+  return 0;
 }
 
 int
 do_aug_insert (const char *path, const char *label, int before)
 {
-#ifdef HAVE_AUGEAS
   int r;
 
   NEED_AUG (-1);
@@ -217,16 +238,11 @@ do_aug_insert (const char *path, const char *label, int before)
   }
 
   return 0;
-#else
-  reply_with_error ("%s is not available", __func__);
-  return -1;
-#endif
 }
 
 int
 do_aug_rm (const char *path)
 {
-#ifdef HAVE_AUGEAS
   int r;
 
   NEED_AUG (-1);
@@ -238,16 +254,11 @@ do_aug_rm (const char *path)
   }
 
   return r;
-#else
-  reply_with_error ("%s is not available", __func__);
-  return -1;
-#endif
 }
 
 int
 do_aug_mv (const char *src, const char *dest)
 {
-#ifdef HAVE_AUGEAS
   int r;
 
   NEED_AUG (-1);
@@ -259,16 +270,11 @@ do_aug_mv (const char *src, const char *dest)
   }
 
   return 0;
-#else
-  reply_with_error ("%s is not available", __func__);
-  return -1;
-#endif
 }
 
 char **
 do_aug_match (const char *path)
 {
-#ifdef HAVE_AUGEAS
   char **matches = NULL;
   void *vp;
   int r;
@@ -294,16 +300,11 @@ do_aug_match (const char *path)
   matches[r] = NULL;
 
   return matches;		/* Caller frees. */
-#else
-  reply_with_error ("%s is not available", __func__);
-  return NULL;
-#endif
 }
 
 int
 do_aug_save (void)
 {
-#ifdef HAVE_AUGEAS
   NEED_AUG (-1);
 
   if (aug_save (aug) == -1) {
@@ -312,10 +313,6 @@ do_aug_save (void)
   }
 
   return 0;
-#else
-  reply_with_error ("%s is not available", __func__);
-  return -1;
-#endif
 }
 
 int
@@ -331,7 +328,7 @@ do_aug_load (void)
 
   return 0;
 #else
-  reply_with_error ("%s is not available", __func__);
+  reply_with_error ("function not available");
   return -1;
 #endif
 }
@@ -340,14 +337,15 @@ do_aug_load (void)
 char **
 do_aug_ls (const char *path)
 {
-#ifdef HAVE_AUGEAS
   char **matches;
   char *buf;
-  int len;
+  size_t len;
 
   NEED_AUG (NULL);
 
-  ABS_PATH (path, return NULL);
+  /* Note that path might also be a previously defined variable
+   * (defined with aug_defvar).  See RHBZ#580016.
+   */
 
   len = strlen (path);
 
@@ -357,9 +355,8 @@ do_aug_ls (const char *path)
     return NULL;
   }
 
-  if (len == 1)
-    /* we know path must be "/" because of ABS_PATH above */
-    matches = do_aug_match ("/");
+  if (STREQ (path, "/"))
+    matches = do_aug_match ("/*");
   else {
     len += 3;			/* / * + terminating \0 */
     buf = malloc (len);
@@ -378,8 +375,102 @@ do_aug_ls (const char *path)
 
   sort_strings (matches, count_strings ((void *) matches));
   return matches;		/* Caller frees. */
-#else
-  reply_with_error ("%s is not available", __func__);
-  return NULL;
-#endif
 }
+
+#else /* !HAVE_AUGEAS */
+
+/* Note that the wrapper code (daemon/stubs.c) ensures that the
+ * functions below are never called because optgroup_augeas_available
+ * returns false.
+ */
+int
+optgroup_augeas_available (void)
+{
+  return 0;
+}
+
+int
+do_aug_init (const char *root, int flags)
+{
+  abort ();
+}
+
+int
+do_aug_close (void)
+{
+  abort ();
+}
+
+int
+do_aug_defvar (const char *name, const char *expr)
+{
+  abort ();
+}
+
+guestfs_int_int_bool *
+do_aug_defnode (const char *name, const char *expr, const char *val)
+{
+  abort ();
+}
+
+char *
+do_aug_get (const char *path)
+{
+  abort ();
+}
+
+int
+do_aug_set (const char *path, const char *val)
+{
+  abort ();
+}
+
+int
+do_aug_clear (const char *path)
+{
+  abort ();
+}
+
+int
+do_aug_insert (const char *path, const char *label, int before)
+{
+  abort ();
+}
+
+int
+do_aug_rm (const char *path)
+{
+  abort ();
+}
+
+int
+do_aug_mv (const char *src, const char *dest)
+{
+  abort ();
+}
+
+char **
+do_aug_match (const char *path)
+{
+  abort ();
+}
+
+int
+do_aug_save (void)
+{
+  abort ();
+}
+
+int
+do_aug_load (void)
+{
+  abort ();
+}
+
+char **
+do_aug_ls (const char *path)
+{
+  abort ();
+}
+
+#endif

daemon/available.c

@@ -0,0 +1,151 @@
+/* libguestfs - the guestfsd daemon
+ * Copyright (C) 2009 Red Hat Inc.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#include <config.h>
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+
+#include "c-ctype.h"
+
+#include "guestfs_protocol.h"
+#include "daemon.h"
+#include "actions.h"
+#include "optgroups.h"
+
+int
+do_available (char *const *groups)
+{
+  int av;
+  size_t i, j;
+
+  for (i = 0; groups[i] != NULL; ++i) {
+    for (j = 0; optgroups[j].group != NULL; ++j) {
+      if (STREQ (groups[i], optgroups[j].group)) {
+        av = optgroups[j].available ();
+        if (!av) {
+          reply_with_error ("%s: group not available", optgroups[j].group);
+          return -1;
+        }
+        break; /* out of for (j) loop */
+      }
+    }
+
+    /* Unknown group? */
+    if (optgroups[j].group == NULL) {
+      reply_with_error ("%s: unknown group", groups[i]);
+      return -1;
+    }
+  }
+
+  return 0;
+}
+
+char **
+do_available_all_groups (void)
+{
+  size_t i;
+  DECLARE_STRINGSBUF (groups);
+
+  for (i = 0; optgroups[i].group != NULL; ++i) {
+    if (add_string (&groups, optgroups[i].group) == -1)
+      return NULL;
+  }
+
+  if (end_stringsbuf (&groups) == -1)
+    return NULL;
+
+  return groups.argv;           /* caller frees */
+}
+
+/* Search for filesystem in /proc/filesystems, ignoring "nodev". */
+static int
+test_proc_filesystems (const char *filesystem)
+{
+  size_t len = strlen (filesystem) + 32;
+  char regex[len];
+  char *err;
+  int r;
+
+  snprintf (regex, len, "^[[:space:]]*%s$", filesystem);
+
+  r = commandr (NULL, &err, "grep", regex, "/proc/filesystems", NULL);
+  if (r == -1 || r >= 2) {
+    fprintf (stderr, "grep /proc/filesystems: %s", err);
+    free (err);
+    return -1;
+  }
+  free (err);
+
+  return r == 0;
+}
+
+/* Do modprobe, ignore any errors. */
+static void
+modprobe (const char *module)
+{
+  command (NULL, NULL, "modprobe", module, NULL);
+}
+
+/* Internal function for testing if a filesystem is available.  Note
+ * this must not call reply_with_error functions.
+ */
+int
+filesystem_available (const char *filesystem)
+{
+  int r;
+
+  r = test_proc_filesystems (filesystem);
+  if (r == -1 || r > 0)
+    return r;
+
+  /* Not found: try to modprobe the module, then test again. */
+  if (optgroup_linuxmodules_available ()) {
+    modprobe (filesystem);
+
+    r = test_proc_filesystems (filesystem);
+    if (r == -1)
+      return -1;
+  }
+
+  return r;
+}
+
+int
+do_filesystem_available (const char *filesystem)
+{
+  size_t i, len = strlen (filesystem);
+  int r;
+
+  for (i = 0; i < len; ++i) {
+    if (!c_isalnum (filesystem[i]) && filesystem[i] != '_') {
+      reply_with_error ("filesystem name contains non-alphanumeric characters");
+      return -1;
+    }
+  }
+
+  r = filesystem_available (filesystem);
+  if (r == -1) {
+    reply_with_error ("error testing for filesystem availability; "
+                      "enable verbose mode and look at preceeding output");
+    return -1;
+  }
+
+  return r;
+}

daemon/base64.c

@@ -0,0 +1,151 @@
+/* libguestfs - the guestfsd daemon
+ * Copyright (C) 2010 Red Hat Inc.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#include <config.h>
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <fcntl.h>
+
+#include "guestfs_protocol.h"
+#include "daemon.h"
+#include "actions.h"
+
+static int
+write_cb (void *fd_ptr, const void *buf, size_t len)
+{
+  int fd = *(int *)fd_ptr;
+  return xwrite (fd, buf, len);
+}
+
+/* Has one FileIn parameter. */
+int
+do_base64_in (const char *file)
+{
+  int err, r;
+  FILE *fp;
+  char *cmd;
+
+  if (asprintf_nowarn (&cmd, "base64 -d -i > %R", file) == -1) {
+    err = errno;
+    cancel_receive ();
+    errno = err;
+    reply_with_perror ("asprintf");
+    return -1;
+  }
+
+  if (verbose)
+    fprintf (stderr, "%s\n", cmd);
+
+  fp = popen (cmd, "w");
+  if (fp == NULL) {
+    err = errno;
+    cancel_receive ();
+    errno = err;
+    reply_with_perror ("%s", cmd);
+    free (cmd);
+    return -1;
+  }
+  free (cmd);
+
+  /* The semantics of fwrite are too undefined, so write to the
+   * file descriptor directly instead.
+   */
+  int fd = fileno (fp);
+
+  r = receive_file (write_cb, &fd);
+  if (r == -1) {		/* write error */
+    cancel_receive ();
+    reply_with_error ("write error on file: %s", file);
+    pclose (fp);
+    return -1;
+  }
+  if (r == -2) {		/* cancellation from library */
+    /* This error is ignored by the library since it initiated the
+     * cancel.  Nevertheless we must send an error reply here.
+     */
+    reply_with_error ("file upload cancelled");
+    pclose (fp);
+    return -1;
+  }
+
+  if (pclose (fp) != 0) {
+    reply_with_error ("base64 subcommand failed on file: %s", file);
+    return -1;
+  }
+
+  return 0;
+}
+
+/* Has one FileOut parameter. */
+int
+do_base64_out (const char *file)
+{
+  int r;
+  FILE *fp;
+  char *cmd;
+  char buf[GUESTFS_MAX_CHUNK_SIZE];
+
+  if (asprintf_nowarn (&cmd, "base64 %R", file) == -1) {
+    reply_with_perror ("asprintf");
+    return -1;
+  }
+
+  if (verbose)
+    fprintf (stderr, "%s\n", cmd);
+
+  fp = popen (cmd, "r");
+  if (fp == NULL) {
+    reply_with_perror ("%s", cmd);
+    free (cmd);
+    return -1;
+  }
+  free (cmd);
+
+  /* Now we must send the reply message, before the file contents.  After
+   * this there is no opportunity in the protocol to send any error
+   * message back.  Instead we can only cancel the transfer.
+   */
+  reply (NULL, NULL);
+
+  while ((r = fread (buf, 1, sizeof buf, fp)) > 0) {
+    if (send_file_write (buf, r) < 0) {
+      pclose (fp);
+      return -1;
+    }
+  }
+
+  if (ferror (fp)) {
+    perror (file);
+    send_file_end (1);		/* Cancel. */
+    pclose (fp);
+    return -1;
+  }
+
+  if (pclose (fp) != 0) {
+    perror (file);
+    send_file_end (1);		/* Cancel. */
+    return -1;
+  }
+
+  if (send_file_end (0))	/* Normal end of file. */
+    return -1;
+
+  return 0;
+}

daemon/blkid.c

@@ -0,0 +1,250 @@
+/* libguestfs - the guestfsd daemon
+ * Copyright (C) 2009 Red Hat Inc.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#include <config.h>
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <unistd.h>
+#include <limits.h>
+
+#include "daemon.h"
+#include "actions.h"
+
+static char *
+get_blkid_tag (const char *device, const char *tag)
+{
+  char *out, *err;
+  int r;
+
+  r = commandr (&out, &err,
+                "blkid",
+                /* Adding -c option kills all caching, even on RHEL 5. */
+                "-c", "/dev/null",
+                "-o", "value", "-s", tag, device, NULL);
+  if (r != 0 && r != 2) {
+    if (r >= 0)
+      reply_with_error ("%s: %s (blkid returned %d)", device, err, r);
+    else
+      reply_with_error ("%s: %s", device, err);
+    free (out);
+    free (err);
+    return NULL;
+  }
+
+  free (err);
+
+  if (r == 2) {                 /* means UUID etc not found */
+    free (out);
+    out = strdup ("");
+    if (out == NULL)
+      reply_with_perror ("strdup");
+    return out;
+  }
+
+  /* Trim trailing \n if present. */
+  size_t len = strlen (out);
+  if (len > 0 && out[len-1] == '\n')
+    out[len-1] = '\0';
+
+  return out;                   /* caller frees */
+}
+
+char *
+do_vfs_type (const char *device)
+{
+  return get_blkid_tag (device, "TYPE");
+}
+
+char *
+do_vfs_label (const char *device)
+{
+  return get_blkid_tag (device, "LABEL");
+}
+
+char *
+do_vfs_uuid (const char *device)
+{
+  return get_blkid_tag (device, "UUID");
+}
+
+/* RHEL5 blkid doesn't have the -p (low-level probing) option and the
+ * -i(I/O limits) option so we must test for these options the first
+ * time the function is called.
+ *
+ * Debian 6 has -p but not -i.
+ */
+static int
+test_blkid_p_i_opt (void)
+{
+  int r;
+  char *err;
+
+  r = commandr (NULL, &err, "blkid", "-p", "/dev/null", NULL);
+  if (r == -1) {
+    /* This means we couldn't run the blkid command at all. */
+  command_failed:
+    reply_with_error ("could not run 'blkid' command: %s", err);
+    free (err);
+    return -1;
+  }
+
+  if (strstr (err, "invalid option --")) {
+    free (err);
+    return 0;
+  }
+  free (err);
+
+  r = commandr (NULL, &err, "blkid", "-i", NULL);
+  if (r == -1)
+    goto command_failed;
+
+  if (strstr (err, "invalid option --")) {
+    free (err);
+    return 0;
+  }
+  free (err);
+
+  /* We have both options. */
+  return 1;
+}
+
+static char **
+blkid_with_p_i_opt (const char *device)
+{
+  size_t i;
+  int r;
+  char *out = NULL, *err = NULL;
+  char **lines = NULL;
+  DECLARE_STRINGSBUF (ret);
+
+  r = command (&out, &err, "blkid", "-c", "/dev/null",
+               "-p", "-i", "-o", "export", device, NULL);
+  if (r == -1) {
+    reply_with_error ("%s", err);
+    goto error;
+  }
+
+  /* Split the command output into lines */
+  lines = split_lines (out);
+  if (lines == NULL)
+    goto error;
+
+  /* Parse the output of blkid -p -i -o export:
+   * UUID=b6d83437-c6b4-4bf0-8381-ef3fc3578590
+   * VERSION=1.0
+   * TYPE=ext2
+   * USAGE=filesystem
+   * MINIMUM_IO_SIZE=512
+   * PHYSICAL_SECTOR_SIZE=512
+   * LOGICAL_SECTOR_SIZE=512
+   * PART_ENTRY_SCHEME=dos
+   * PART_ENTRY_TYPE=0x83
+   * PART_ENTRY_NUMBER=6
+   * PART_ENTRY_OFFSET=642875153
+   * PART_ENTRY_SIZE=104857600
+   * PART_ENTRY_DISK=8:0
+   */
+  for (i = 0; lines[i] != NULL; ++i) {
+    char *line = lines[i];
+
+    /* Skip blank lines (shouldn't happen) */
+    if (line[0] == '\0') continue;
+
+    /* Split the line in 2 at the equals sign */
+    char *eq = strchr (line, '=');
+    if (eq) {
+      *eq = '\0'; eq++;
+
+      /* Add the key/value pair to the output */
+      if (add_string (&ret, line) == -1 ||
+          add_string (&ret, eq) == -1) goto error;
+    } else {
+      fprintf (stderr, "blkid: unexpected blkid output ignored: %s", line);
+    }
+  }
+
+  if (end_stringsbuf (&ret) == -1) goto error;
+
+  free (out);
+  free (err);
+  free_strings (lines);
+
+  return ret.argv;
+
+error:
+  free (out);
+  free (err);
+  if (lines)
+    free_strings (lines);
+  if (ret.argv)
+    free_strings (ret.argv);
+
+  return NULL;
+}
+
+static char **
+blkid_without_p_i_opt(const char *device)
+{
+  char *s;
+  DECLARE_STRINGSBUF (ret);
+
+  if (add_string (&ret, "TYPE") == -1) goto error;
+  s = get_blkid_tag (device, "TYPE");
+  if (s == NULL) goto error;
+  if (add_string (&ret, s) == -1)
+    goto error;
+
+  if (add_string (&ret, "LABEL") == -1) goto error;
+  s = get_blkid_tag (device, "LABEL");
+  if (s == NULL) goto error;
+  if (add_string (&ret, s) == -1)
+    goto error;
+
+  if (add_string (&ret, "UUID") == -1) goto error;
+  s = get_blkid_tag (device, "UUID");
+  if (s == NULL) goto error;
+  if (add_string (&ret, s) == -1)
+    goto error;
+
+  if (end_stringsbuf (&ret) == -1) goto error;
+
+  return ret.argv;
+error:
+  if (ret.argv)
+    free_strings (ret.argv);
+  return NULL;
+}
+
+char **
+do_blkid (const char *device)
+{
+  static int blkid_has_p_i_opt = -1;
+
+  if (blkid_has_p_i_opt == -1) {
+    blkid_has_p_i_opt = test_blkid_p_i_opt ();
+    if (blkid_has_p_i_opt == -1)
+      return NULL;
+  }
+
+  if (blkid_has_p_i_opt)
+    return blkid_with_p_i_opt (device);
+  else
+    return blkid_without_p_i_opt (device);
+}

daemon/blockdev.c

@@ -13,7 +13,7 @@
  *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
- * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  */
 
 #include <config.h>
@@ -38,7 +38,7 @@ call_blockdev (const char *device, const char *switc, int extraarg, int prints)
   int64_t rv;
   char *out, *err;
   const char *argv[] = {
-    "/sbin/blockdev",
+    "blockdev",
     switc,
     NULL,
     NULL,
@@ -46,6 +46,20 @@ call_blockdev (const char *device, const char *switc, int extraarg, int prints)
   };
   char buf[64];
 
+  /* When you call close on any block device, udev kicks off a rule
+   * which runs blkid to reexamine the device.  We need to wait for
+   * this rule to finish running (from a previous operation) since it
+   * holds the device open and can cause other operations to fail,
+   * notably BLKRRPART.
+   *
+   * This is particularly a problem where we have just written to a
+   * device (eg. zeroing it) and immediately call blockdev --rereadpt.
+   *
+   * Therefore, wait for udev to finish all outstanding events before
+   * performing any blockdev command.
+   */
+  udev_settle ();
+
   if (extraarg > 0) {
     snprintf (buf, sizeof buf, "%d", extraarg);
     argv[2] = buf;
@@ -53,7 +67,7 @@ call_blockdev (const char *device, const char *switc, int extraarg, int prints)
   } else
     argv[2] = device;
 
-  r = commandv (&out, &err, (char **) argv);
+  r = commandv (&out, &err, argv);
 
   if (r == -1) {
     reply_with_error ("%s: %s", argv[0], err);
@@ -68,11 +82,13 @@ call_blockdev (const char *device, const char *switc, int extraarg, int prints)
     if (sscanf (out, "%" SCNi64, &rv) != 1) {
       reply_with_error ("%s: expected output, but got nothing", argv[0]);
       free (out);
+      free (err);
       return -1;
     }
   }
 
   free (out);
+  free (err);
 
   return rv;
 }
@@ -111,7 +127,7 @@ int
 do_blockdev_setbsz (const char *device, int blocksize)
 {
   if (blocksize <= 0 /* || blocksize >= what? */) {
-    reply_with_error ("blockdev_setbsz: blocksize must be > 0");
+    reply_with_error ("blocksize must be > 0");
     return -1;
   }
   return (int) call_blockdev (device, "--setbsz", blocksize, 0);