generator: Optional arguments, add-drive-opts (RHBZ#642934,CVE-2010-3851).

This large commit changes the generator so that optional arguments
can be supported for functions.

The model for arguments (known as the "style") is changed from
(ret, args) to (ret, args, optargs) where optargs is a more limited
list of arguments.

One function has been added which takes optional arguments, it is
"add-drive-opts", modelled as:

  (RErr, [String "filename"], #required
         [Bool "readonly"; String "format"; String "iface"]) #optional

Note that this function is processed in the library (does not go over
the RPC protocol to the daemon).  This has allowed us to simplify
the current implementation by omitting changes related to RPC or the
daemon, although we plan to add these at some point in the future.

From C this function can be called in 3 different ways as in these
examples:

  guestfs_add_drive_opts (g, filename,
                          GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,
			  GUESTFS_ADD_DRIVE_OPTS_FORMAT, "raw",
                          -1);

(the argument(s) between 'filename' and '-1' are the optional ones).

  guestfs_add_drive_opts_va (g, filename, args);

where 'args' is a va_list.  This works like the first version.

  struct guestfs_add_drive_opts_argv optargs = {
    .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK,
    .readonly = 1,
  }
  guestfs_add_drive_opts_argv (g, filename, &optargs);

This last form lets you construct lists of optional arguments, and
is used by guestfish and the language bindings.

In guestfish optional arguments are used like this:

  add-drive-opts filename readonly:true

In OCaml these are mapped naturally to OCaml optional arguments, eg:

  g#add_drive_opts ~readonly:true filename;

In Perl these are mapped to extra arguments, eg:

  $g->add_drive_opts ($filename, readonly => 1);

In Python these are mapped to optional arguments, eg:

  g.add_drive_opts ("file", readonly = 1, format = "qcow2")

In Ruby these are mapped to a final hash argument, eg:

  g.add_drive_opts("file", {})
  g.add_drive_opts("file", :readonly => 1)
  g.add_drive_opts("file", :readonly => 1, :iface => "virtio")

In PHP these are mapped to extra parameters.  This is not quite
accurate since you cannot omit arbitrary optional parameters, but
there's not much than can be done within the limitations of PHP
as a language.

Unimplemented in: Haskell, C#, Java.

2 files changed, 7 insertions, 1 deletions

diff --git a/regressions/rhbz501893.c b/regressions/rhbz501893.c
index fcda5cd3..aa752716 100644
--- a/regressions/rhbz501893.c
+++ b/regressions/rhbz501893.c
@@ -39,6 +39,12 @@ main (int argc, char *argv[])
   assert (guestfs_add_drive (g, NULL) == -1);
   assert (guestfs_config (g, NULL, NULL) == -1);
 
+  /* This optional argument must not be NULL. */
+
+  assert (guestfs_add_drive_opts (g, "/dev/null",
+                                  GUESTFS_ADD_DRIVE_OPTS_FORMAT, NULL,
+                                  -1) == -1);
+
   /* These can be safely set to NULL, should be no error. */
 
   assert (guestfs_set_path (g, NULL) == 0);
diff --git a/regressions/test-lvm-mapping.pl b/regressions/test-lvm-mapping.pl
index 8a38232e..7af2842e 100755
--- a/regressions/test-lvm-mapping.pl
+++ b/regressions/test-lvm-mapping.pl
@@ -34,7 +34,7 @@ my $g = Sys::Guestfs->new ();
 #$g->set_verbose (1);
 #$g->set_trace (1);
 
-$g->add_drive ($testimg);
+$g->add_drive_opts ($testimg, format => "raw");
 $g->launch ();
 
 # Create an arrangement of PVs, VGs and LVs.