generator: Optional arguments, add-drive-opts (RHBZ#642934,CVE-2010-3851).
authorRichard W.M. Jones <rjones@redhat.com>
Wed, 20 Oct 2010 10:34:57 +0000 (11:34 +0100)
committerRichard W.M. Jones <rjones@redhat.com>
Fri, 22 Oct 2010 16:45:00 +0000 (17:45 +0100)
commit14490c3e1aac61c6ac90f28828896683f64f0dc9
tree9855d3ef5cd421acf4841525c96696933097db79
parent87be9b26e7004a9a58970b4e97d0d152dc1c0704
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.
36 files changed:
.gitignore
configure.ac
examples/hello.c
examples/to-xml.c
fish/guestfish.pod
generator/generator_actions.ml
generator/generator_bindtests.ml
generator/generator_c.ml
generator/generator_capitests.ml
generator/generator_checks.ml
generator/generator_csharp.ml
generator/generator_daemon.ml
generator/generator_fish.ml
generator/generator_haskell.ml
generator/generator_java.ml
generator/generator_ocaml.ml
generator/generator_perl.ml
generator/generator_php.ml
generator/generator_python.ml
generator/generator_ruby.ml
generator/generator_types.ml
generator/generator_utils.ml
generator/generator_xdr.ml
ocaml/Makefile.am
ocaml/examples/lvs.ml
ocaml/t/guestfs_080_optargs.ml [new file with mode: 0644]
perl/examples/lvs.pl
perl/t/070-optargs.t [new file with mode: 0644]
php/extension/guestfs_php_004.phpt [new file with mode: 0644]
python/t/060-optargs.py [new file with mode: 0644]
regressions/rhbz501893.c
regressions/test-lvm-mapping.pl
ruby/tests/tc_060_optargs.rb [new file with mode: 0644]
src/guestfs.pod
src/launch.c
test-tool/test-tool.c