New API: case-sensitive-path to return case sensitive path on NTFS 3g fs

This function handles an annoyance/peculiarity of the Linux
NTFS 3g driver, which is that it exports NTFS filesystems with
names case sensitive, even though under Windows they would be
case insensitive.

This causes problems because the location of (eg.) c:\windows
might appear as /windows or /WINDOWS (etc) depending on the
inconsequential details of how it was originally created.

Example of this problem on a real Windows guest:

  ><fs> file /windows/system32/config/system.log
  libguestfs: error: file: access: /windows/system32/config/system.log: No such file or directory
  ><fs> case-sensitive-path /windows/system32/config/system.log
  /WINDOWS/system32/config/system.LOG
  ><fs> file /WINDOWS/system32/config/system.LOG
  MS Windows registry file, NT/2000 or above

inspector: Remove inaccurate paragraph from documentation.

Include HFS (Mac OS X) driver.

Set LC_ALL=C before running qemu.

init: Check that start_udev succeeded

If start_udev fails for any reason, notice and fall through to manual /dev
creation.

Patch from Charles Duffy <charles@dyfis.net>

Version 1.0.74.

Tab to space fixes, now passes 'make syntax-check'

guestfs_find: Fix memory leak of sysrootdir.

virt-ls: Modify to use find0 instead of find.

find0 is more scalable than find.  virt-ls will no longer
crash if asked to recursively list / on a Linux guest.

New API: find0 (unlimited version of find)

This adds a new API call guestfs_find0, which is like guestfs_find
but mainly doesn't suffer from the protocol limit of the earlier
command.  The earlier command is not deprecated because it is
still very useful.

guestfs_find0 uses a FileOut parameter and writes the results to
an external file.  The filenames in the output are separated by
ASCII NUL characters (so a bit like "find -print0").

There is also the addition of a regression test for this command.

guestfs_find: Document protocol limits for this API call.

guestfs_find has to send the complete list of files in a single
protocol message (hence, limited to 2-4 MB).  Unfortunately on
a typical Linux guest, guestfs_find ("/") will exceed this limit
resulting in an error.

Therefore we should add an unlimited version of this call in a
future commit.  This commit just documents the current limit.

New tool: virt-ls

This tool makes available the functionality of "ls", "ll", and "find"
in a slightly simpler to use form.

Examples:

  virt-ls -l myguest /tmp

New tool: virt-tar

This adds a new tool call virt-tar which is a general purpose
archive and uploading tool.  It doesn't add any functionality
which wasn't previously possible using guestfish, but makes it
simpler to access for some users.

Examples:

 virt-tar -zx myguest /home home.tar.gz
 virt-tar -zu myguest uploadstuff.tar.gz /tmp

tools: Make warnings about running on live guests more prominent.

Add prominent warnings to the man pages about how it is dangerous
to run these tools against live guests.

Move virt tools (virt-cat, virt-edit etc) into tools/ subdirectory.

This moves the tool programs into a single directory:
  cat/* -> tools/virt-cat
  df/* -> tools/virt-df
  edit/* -> tools/virt-edit
  rescue/* -> tools/virt-rescue

This in itself simplifies the build process because we only need
one Makefile and one copy of 'run-locally'.

'run-*-locally' has become just 'run-locally' and takes an extra
parameter which is the name of the tool, eg:
  run-locally cat [virt-cat params...]

virt-inspector stays in its own directory, because this contains
more than just a single Perl script.

Comment: Describe the build order requirements for toplevel directories.

Prepare for 1.0.73.

Add some missing EXTRA_DIST files.

inspector: Generate language bindings for OCaml.

This commit adds a generic mechanism for deriving language bindings
for virt-inspector, and implements one concrete binding, for OCaml.

The bindings are generated from the RELAX NG schema (virt-inspector.rng)
which is supposed to be a correct and always up to date description
of the XML that the virt-inspector program can generate.

From the RNG we generate a set of types to describe the output of
virt-inspector for the language, plus an XML parser, plus some
glue code to actually run an external instance of virt-inspector
and parse the resulting XML.

At runtime, an external 'virt-inspector --xml <name>' command runs
and the XML is parsed into language-specific structures.

This has been tested on the four example files (inspector/example?.xml)

The only particular difficulty about the OCaml binding is the use of
Obj.magic, which is naughty but works because of the isomorphism
between the representation of tuples and records in OCaml.  This
seems to cause no problems in my test program.  Apart from this, the
OCaml binding is straightforward and could be adapted easily for any
other languages that want type-safe virt-inspector bindings.

It's important to keep virt-inspector.rng up to date with changes
to virt-inspector's XML output format.

build: avoid parallel ocaml/... build failure

A parallel build could fail due to the use in ocaml/examples
of ocaml/guestfs.cmi before it was built.
* Makefile.am (SUBDIRS): Add both ocaml and ocaml/examples,
to ensure they're built in this order, and not in parallel.
* ocaml/Makefile.am (SUBDIRS): Don't define.

Updated Polish translation

inspector: Fix inspector/Makefile.am

Accidentally pushed the older version of the patch in
commit 9d25e82491ddcf495e1d30694327e4bfd3a23445.

This includes Jim Meyering's suggested changes from
https://www.redhat.com/archives/libguestfs/2009-October/msg00017.html

build: fix compile error

Link demo scripts with just-build library, not the installed one.
* ocaml/examples/Makefile.am (OCAMLFINDFLAGS): New variable.
(lvs, viewer): Use it.
This fix is based on a suggestion from Rich Jones.
This addresses RHBZ#526917.

inspector: Add tests for RELAX NG schema.

inspector: Add RELAX NG schema for virt-inspector --xml output.

configure: Update comment about viewer.ml.

inspector: Canonicalize device names (fix RHBZ#526717).

Make filesystem device names canonical, so they are /dev/sd*
instead of /dev/vd*.

run-*-locally: The programs are now virt-[tool], not virt-[tool].pl

This fixes commit b488436cc54288fcae8988493749f2e6c87f274c.

inspector: Don't bomb if no kernels detected.

If $os->{kernels} wasn't defined, virt-inspector would exit with
an error, leaving partial XML output.

Change the code so it doesn't die in this case, instead just
leaves out the <kernels> section.

OCaml viewer: Use ocamlduce to replace xpath code.

OCaml viewer: Handle exceptions properly.

OCaml example: graphical disk usage viewer.

This is an example of how to write an app which uses libguestfs
and libvirt, and has a responsive user interface (using threads).
It is a Gtk-based "graphical virt-df".

Read the top of the 'viewer.ml' file first for instructions on
how to compile.  This program is not compiled by default.

virt-df: Add note about parsing CSV.

avoid use of all ctype macros

* cfg.mk (disable_temporarily): Don't disable sc_avoid_ctype_macros.
* fish/tilde.c: Remove unnecessary inclusion of ctype.h.
* bootstrap: Add gnulib's c-ctype module to the list.
* daemon/m4/gnulib-cache.m4: Likewise.
* daemon/ext2.c: Include "c-ctype.h", not <ctype.h>.
Use c_isspace, etc, rather than isspace.
* daemon/guestfsd.c: Likewise.
* daemon/lvm.c: Likewise.
* daemon/proto.c: Likewise.
* fish/fish.c: Likewise.
* fish/tilde.c: Likewise.
* src/generator.ml: Likewise.
* src/guestfs.c: Likewise.
* examples/to-xml.c: Likewise.
* examples/Makefile.am (to_xml_CPPFLAGS): Add -I$(top_srcdir)/gnulib/lib
so inclusion of "c-ctype.h" works.
(to_xml_CPPFLAGS): Rename from to_xml_CFLAGS.

maint: prune dead wood from list of skipped syntax-check rules

* cfg.mk (local-checks-to-skip): Remove now-passing and
no-longer-relevant rule names.

maint: use spaces, not TABs for indentation

"make syntax-check" was failing.  This fixes it.
* HACKING: Indent with spaces, not TABs.
* configure.ac: Likewise.
* rescue/virt-rescue: Likewise.
* src/generator.ml: Likewise.

Prepare for 1.0.72.

Also update PO files.

More HTMLFILES.

Include virt tools in EXTRA_DIST.

Partially revert b488436cc54288fcae8988493749f2e6c87f274c.
It turns out that automake doesn't automatically place bin_SCRIPTS
in EXTRA_DIST.

Rename virt-[tool].pl as virt-[tool]

Check return value from readlink.

Create manpage atomically.

Don't fail with a partial file if disk full, etc.

Replace @...@ with $(...) in these common Makefile.am files.

guestfish: Update 'SEE ALSO' section of the manpage.

New tool: virt-edit

Edit any file in a guest.  This was possibly previously
using guestfish, but having a separate command makes it
simpler.

The usage is simply:

  virt-edit mydomain /some/file

It runs $EDITOR or vi on the file, and if the user changes
it, uploads the result back to the VM.

virt-cat: Remove some unused Perl module includes.

Add 'virt-rescue' command.

This command runs a "rescue appliance" against a virtual machine
or disk image.  This is useful for making ad-hoc interactive
changes to virtual machines.

  $ virt-rescue --ro /dev/vg_trick/F11x64

  Welcome to virt-rescue, the libguestfs rescue shell.

  Note: The contents of / are the rescue appliance.
  You have to mount the guest's partitions under /sysroot
  before you will be able to examine them.

  bash: cannot set terminal process group (-1): Inappropriate ioctl for device
  bash: no job control in this shell
  ><rescue> mount /dev/vg_f11x64/lv_root /sysroot
  EXT4-fs (dm-0): barriers enabled
  kjournald2 starting: pid 269, dev dm-0:8, commit interval 5 seconds
  EXT4-fs (dm-0): internal journal on dm-0:8
  EXT4-fs (dm-0): delayed allocation enabled
  EXT4-fs: file extents enabled
  EXT4-fs: mballoc enabled
  EXT4-fs (dm-0): mounted filesystem with ordered data mode
  ><rescue> ls /sysroot/
  bin   dev  home  lib64       media  opt   root  selinux  sys  usr
  boot  etc  lib   lost+found  mnt    proc  sbin  srv      tmp  var
  ><rescue> exit

Add direct appliance mode flag and implementation.

When the g->direct flag is set, the appliance stdin/stdout
are not connected to the library.  Instead they inherit the
stdin/stdout of the caller.

This is used to implement virt-rescue.

Tidy up appliance rescue code.

The appliance shouldn't run the daemon after we leave the
rescue shell.  It should just exit instead.

Rejig configure.ac tests for qemu vmchannel support.

vmchannel is no longer required, so we shouldn't test for it.
However we should test instead for user mode networking support.

Also fix up the documentation / error messages.

Always test for vmchannel and user mode networking support in
qemu.  This gives us more troubleshooting information if people
report bugs.

Prepare for 1.0.71.

Update version number and update PO files.

Put latest version and release date on the website front page.

Change handling of spaces on Linux kernel command line.

Update documentation of qemu / vmchannel.

Implement "null vmchannel" - no vmchannel needed!

This commit removes the requirement for vmchannel, although retaining
support for it.

In this configuration, known as "null vmchannel", the library
listens on a random loopback port.  It passes the number of this
port to the appliance (guestfs_vmchannel=tcp:10.0.2.2:12345), and
the daemon then connects back.  The library, instead of connecting,
listens and accepts the connection during guestfs_launch.

QEMU SLIRP (user mode networking) is still required to make this
work: SLIRP forwards the TCP connection transparently (instead of
explicitly as with guestfwd) to 127.0.0.1:<port>

There is a window in which any other local process on the machine
could see the port number in the qemu command line and try to
connect to it.  This would be a devastating security hole, because
any local process could pretend to be the daemon and feed back
malicious replies to our remote procedure calls.  To prevent this,
we check the UID of the other side of the TCP connection.  If
the UID is different from the library's EUID, then we reject the
connection.  To do this we have to parse /proc/net/tcp.  (On Solaris
we could use getsockopt (SO_PEERCRED), but this doesn't work on
Linux TCP sockets).

Other vmchannel(s) are still supported.  This is important, because
we can't in general be sure the qemu will always support SLIRP.
In particular, in recent versions of qemu it is possible to compile
out SLIRP.

Gnulib: Add arpa-inet and netinet-in modules.

Flexible guestfs_vmchannel parameter for future appliances.

This reimplements parts of commit da0a4f8d1f6ddd302ceba028d87c6e009589e503
in a different, but compatible way.

We pass guestfs_vmchannel=tcp:<ip>:<port> on the command line.  This
is intended to be used as follows (now and in future versions):

  tcp:10.0.2.4:6666    for guestfwd vmchannel
  tcp:10.0.2.2:<port>  for future "no vmchannel" implementation
  /dev/vcon4           for future virtio-console vmchannel*

It also accepts the old-style guestfs=10.0.2.4:6666 parameter which
is sent by older libraries, and turns this transparently into the
correct format above.

If no guestfs_vmchannel is passed, then this defaults to the guestfwd
vmchannel which older libraries would expect.

* Maybe this last one should be dev:/dev/vcon4 or file:/dev/vcon4, but
we don't need to decide that now.

Rearrange and tidy up code in guestfsd.c

This just tidies up the main() function in the daemon.  There is
no longer a huge fixed-sized buffer used for the kernel command
line.  Variables are moved closer to where they are used.  Some
local variables turned out to be unused - these are removed.  Finally
the part that reads the kernel command line is moved into a separate
function.

There is only minimal functional change here (it now prints out
the kernel command line).

Literal '4' replaced with 'sizeof' expression, at Jim Meyering's
suggestion during patch review.

Make GUESTFWD_PORT into a string.

Remove unnecessary extra space from qemu command line.

Remove guestfs_wait_ready (turn it into a no-op).

This commit changes guestfs_launch so that it both launches
the appliance and waits until it is ready (ie. the daemon communicates
back to us).

Since we removed the pretence that we could implement a low-level
asynchronous API, the need to call launch() followed by wait_ready()
has looked a bit silly.

Now guestfs_wait_ready() is basically a no-op.  It is left in the
API for backwards compatibility.  Any calls to guestfs_wait_ready()
can be removed from client code.

Combine temporary buffers.

buf[], append[] and memsize_str[] were all temporary buffers
used in non-overlapping code.

Combine them to use a single buffer (buf[]).

Rearrange qemu command line order (no functional change).

Enable new-style -chardev ... guestfwd command line.

Newer versions of qemu have changed the command line format
(again).  '-net channel' is now deprecated.  Instead we use:

    -chardev socket,id=guestfsvmc,path=/path/to/sock,server,nowait
    -net user,vlan=0,net=10.0.2.0/8,guestfwd=tcp:10.0.2.4:6666-chardev:guestfsvmc
    -net nic,model=ne2k_pci,vlan=0

The old style format is still used if the new style is not
detected at runtime.

Fix code which looked for leaked FDs between each command.

This code was not checking the return value from system()
so it failed if uncommented.  Add ignore_value() around the
call to system.  However, leave the code still disabled.

Remove explicit guestfs=10.0.2.4:6666 kernel command line parameter.

Since we control the appliance tightly, we can just specify
that it will always use a particular host and port, and we
don't need to pass it on the command line each time.

Also the VMCHANNEL_* constants are only relevant to the
particular guestfwd vmchannel implementation, so we rename
them as GUESTFWD_*.

Daemon: fix handling of errors from xread and xwrite.

If xread or xwrite returns -1, that indicates an error and we
should exit.  Note that xread/xwrite has already printed the
error message.

Fix verbose packet dumping functions.

Add the configure parameter --enable-packet-dump so that this
code can be enabled without editing the source.

This code is normally commented out, because it is too verbose
unless you happen to be debugging the underlying protocol.  Because
it is normally commented out, I found it had bit-rotted slightly.
This commit also fixes the obvious problems.

'len' should be an unsigned 32 bit int.

This only happened to work by accident before because 'unsigned len'
happens to be 32 bit on all platforms we support.

Disable -Wunsafe-loop-optimizations

This warning indicates that GCC could not do a particular sort
of loop optimization.  It pops up randomly in certain forms of
looping code, and seems safe to ignore.

Update PO files (no functional change).

Prepare for version 1.0.70.

Update PO files.

Set minimum gettext version to 0.17.

This fixes the problem that the 1.0.69 tarball would fail in
the po/ subdirectory when installing:

make[1]: Entering directory `/builddir/build/BUILD/libguestfs-1.0.69/po'
/bin/sh @MKINSTALLDIRS@ /builddir/build/BUILDROOT/libguestfs-1.0.69-1.fc11.x86_64/usr/share
/bin/sh: @MKINSTALLDIRS@: No such file or directory
make[1]: Leaving directory `/builddir/build/BUILD/libguestfs-1.0.69/po'

RHEL 5.3 has gettext 0.14.6.  However the tarball will still
build (since it includes all the required code).  This may cause
a problem if RHEL users want to build from the git repository.

Fix comparison between signed and unsigned (for RHEL 5).

Move decl out for C99 compliance.

Update PO files.

Move guestfs-internal-actions.h to EXTRA_DIST.

Prepare for 1.0.69.

Remove main loop.

This commit removes the external main loop, which never worked
and caused a number of bugs.  Requests are now done synchronously,
and if the user wants to have requests issued in the background
or to have a responsive GUI, then they'll just have to use threads.

The big change is to push all reads and writes through two
functions called send_to_daemon (for writes) and recv_from_daemon
(for reads) which operate synchronously.  These functions
read/write whole messages, and also handle checking for EOF
(ie. daemon died) and asynchronous log message events from
qemu (eg. from debug / dmesg printed by the guest).  A more
complete description of how these work can be found in the code.

This code passes a complete run of the tests.

Bugs believed to be fixed by this commit:

  https://bugzilla.redhat.com/show_bug.cgi?id=501888
  internal error: reply callback called twice

  https://bugzilla.redhat.com/show_bug.cgi?id=504418
  In virt-inspector: "download: guestfs_download reply failed, see earlier error messages"

I have tried to avoid reintroducing this:

  https://bugzilla.redhat.com/show_bug.cgi?id=508713
  libguestfs: error: write: Broken pipe (guestfish only)

One other benefit of this is that 'set_busy/end_busy' calls
no longer appear in traces.

Don't enable trace in set_trace test.

This leaves trace enabled afterwards, resulting in some
ugly test messages.

Fix type punning warning about use of CMSG_DATA in Rawhide.

guestfish: Enable grouping in string lists

This change adds the ability to group entries in a string list with single
quotes. So the string:
  "'foo bar'"
becomes 1 token rather than 2. Consequently single quotes must now be escaped:
  "\'"
resolves to a literal single quote.

Incidentally, this change also alters another, probably unintentional behaviour
of the previous implementation, in that tokens are separated by any amount of
whitespace rather than a single whitespace character. I.e.:
  "a  b"
resolves to:
  'a' 'b'
rather than:
  'a' '' 'b'
That last syntax can be used if an empty argument is still desired. Whitespace
is now also defined to include tabs.

parse_string_list can also now fail if it contains an unmatched open quote.

Ignore localrepo/ directory.

This can be used by people building from source and packagers for
their own purposes.

Add command trace functionality.

Enable this by calling guestfs_trace (handle, 1) or by
setting the LIBGUESTFS_TRACE=1 environment variable.

Non-daemon actions indirect through generated code.

Previously non-daemon actions were called directly by
user code, eg:

/* Non-generated */
int
guestfs_set_verbose (guestfs_h *g, int v)
{
  g->verbose = !!v;
  return 0;
}

This changes these actions so they go indirectly via
some generated code, eg:

/* Generated */
int guestfs_set_verbose (guestfs_h *g,
int verbose)
{
  return guestfs__set_verbose (g, verbose);
}

/* Non-generated */
int
guestfs__set_verbose (guestfs_h *g, int v)
{
  g->verbose = !!v;
  return 0;
}

The aim is to have a place in the generated code where
we can add debug or tracing information for these non-
daemon calls.

guestfish: Redirect stdout when executing remote commands

guestfish --listen necessarily redirects its stdout to /dev/null so as not to
interfere with eval. The remote protocol doesn't contain any other provision for
collecting stdout for the caller, so executing guestfish --remote will never
generate any output.

This patch fixes that by forwarding the caller's STDOUT to the listener over the
unix socket connection. The listener redirects its STDOUT to the caller's STDOUT
for the duration of the command, then closes it again.

Update TODO list

Add diffutils package.

On Fedora 12, /usr/bin/cmp is not pulled in unless we explicitly
add the diffutils package.

Add echo_daemon command

echo_daemon is a simple echo which can be used to test connectivity between the
client and daemon.

generator.ml: Fix string list memory leak

Parsed string lists are allocated by malloc, but were never freed.

Ignore some more m4 files.

Don't include gnulib files in POTFILES.in.

avoid build-from-scratch failure due to missing daemon/configure

* bootstrap: Don't use autoreconf's --norecursive
option.  We require the default --recursive behavior in order
to create daemon/configure.  Reported by Matthew Booth.

maint: guestfs.c: avoid warning about possible NULL deref from llvm/clang

* src/guestfs.h (guestfs_abort_cb): Declare with attribute noreturn.

maint: guestfs.c: remove unnecessary initialization

* src/guestfs.c (guestfs__receive_file_sync): Don't set "r",
only to ignore it.

generator.ml: avoid a warning about signed overflow in tests.c

* src/generator.ml: Emit "unsigned long int n_failed;" rather than
"int failed;", to avoid warning from gcc about "assuming signed
overflow does not occur when simplifying conditional to constant".

generator.ml: avoid defined-but-not-used warnings in guestfs_c_actions.c

* src/generator.ml (emit_ocaml_copy_list_function): New function.
Emit a function definition only if it will be used.

generator.ml: avoid warnings in generated ocaml/guestfs_c_actions.c

* src/generator.ml: Emit prototypes for ocaml_guestfs_* functions,
to avoid warnings from gcc -Wmissing-prototypes.  Normally we'd put
these somewhere else, but in this unusual case, they're not needed
anywhere else.  Handle the >5-argument case, too, for these:
ocaml_guestfs_test0_byte, ocaml_guestfs_sfdisk_byte,
ocaml_guestfs_sfdisk_N_byte.

build: enable gcc warnings in capitests/ and ocaml/

* capitests/Makefile.am: Use $(WARN_CFLAGS) and $(WERROR_CFLAGS).
* ocaml/Makefile.am:: Likewise.

ocaml/guestfs_c.c: avoid warning about missing prototypes

* ocaml/guestfs_c.c (ocaml_guestfs_create, ocaml_guestfs_close): Declare.