src/generator.ml

   1 #!/usr/bin/env ocaml
   2 (* libguestfs
   3  * Copyright (C) 2009 Red Hat Inc.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  18  *)
  19
  20 (* This script generates a large amount of code and documentation for
  21  * all the daemon actions.
  22  *
  23  * To add a new action there are only two files you need to change,
  24  * this one to describe the interface (see the big table below), and
  25  * daemon/<somefile>.c to write the implementation.
  26  *
  27  * After editing this file, run it (./src/generator.ml) to regenerate
  28  * all the output files.
  29  *
  30  * IMPORTANT: This script should NOT print any warnings.  If it prints
  31  * warnings, you should treat them as errors.
  32  * [Need to add -warn-error to ocaml command line]
  33  *)
  34
  35 #load "unix.cma";;
  36 #load "str.cma";;
  37
  38 open Printf
  39
  40 type style = ret * args
  41 and ret =
  42     (* "RErr" as a return value means an int used as a simple error
  43      * indication, ie. 0 or -1.
  44      *)
  45   | RErr
  46     (* "RInt" as a return value means an int which is -1 for error
  47      * or any value >= 0 on success.  Only use this for smallish
  48      * positive ints (0 <= i < 2^30).
  49      *)
  50   | RInt of string
  51     (* "RInt64" is the same as RInt, but is guaranteed to be able
  52      * to return a full 64 bit value, _except_ that -1 means error
  53      * (so -1 cannot be a valid, non-error return value).
  54      *)
  55   | RInt64 of string
  56     (* "RBool" is a bool return value which can be true/false or
  57      * -1 for error.
  58      *)
  59   | RBool of string
  60     (* "RConstString" is a string that refers to a constant value.
  61      * Try to avoid using this.  In particular you cannot use this
  62      * for values returned from the daemon, because there is no
  63      * thread-safe way to return them in the C API.
  64      *)
  65   | RConstString of string
  66     (* "RString" and "RStringList" are caller-frees. *)
  67   | RString of string
  68   | RStringList of string
  69     (* Some limited tuples are possible: *)
  70   | RIntBool of string * string
  71     (* LVM PVs, VGs and LVs. *)
  72   | RPVList of string
  73   | RVGList of string
  74   | RLVList of string
  75     (* Stat buffers. *)
  76   | RStat of string
  77   | RStatVFS of string
  78     (* Key-value pairs of untyped strings.  Turns into a hashtable or
  79      * dictionary in languages which support it.  DON'T use this as a
  80      * general "bucket" for results.  Prefer a stronger typed return
  81      * value if one is available, or write a custom struct.  Don't use
  82      * this if the list could potentially be very long, since it is
  83      * inefficient.  Keys should be unique.  NULLs are not permitted.
  84      *)
  85   | RHashtable of string
  86
  87 and args = argt list    (* Function parameters, guestfs handle is implicit. *)
  88
  89     (* Note in future we should allow a "variable args" parameter as
  90      * the final parameter, to allow commands like
  91      *   chmod mode file [file(s)...]
  92      * This is not implemented yet, but many commands (such as chmod)
  93      * are currently defined with the argument order keeping this future
  94      * possibility in mind.
  95      *)
  96 and argt =
  97   | String of string    (* const char *name, cannot be NULL *)
  98   | OptString of string (* const char *name, may be NULL *)
  99   | StringList of string(* list of strings (each string cannot be NULL) *)
 100   | Bool of string      (* boolean *)
 101   | Int of string       (* int (smallish ints, signed, <= 31 bits) *)
 102     (* These are treated as filenames (simple string parameters) in
 103      * the C API and bindings.  But in the RPC protocol, we transfer
 104      * the actual file content up to or down from the daemon.
 105      * FileIn: local machine -> daemon (in request)
 106      * FileOut: daemon -> local machine (in reply)
 107      * In guestfish (only), the special name "-" means read from
 108      * stdin or write to stdout.
 109      *)
 110   | FileIn of string
 111   | FileOut of string
 112
 113 type flags =
 114   | ProtocolLimitWarning  (* display warning about protocol size limits *)
 115   | DangerWillRobinson    (* flags particularly dangerous commands *)
 116   | FishAlias of string   (* provide an alias for this cmd in guestfish *)
 117   | FishAction of string  (* call this function in guestfish *)
 118   | NotInFish             (* do not export via guestfish *)
 119   | NotInDocs             (* do not add this function to documentation *)
 120
 121 let protocol_limit_warning =
 122   "Because of the message protocol, there is a transfer limit
 123 of somewhere between 2MB and 4MB.  To transfer large files you should use
 124 FTP."
 125
 126 let danger_will_robinson =
 127   "B<This command is dangerous.  Without careful use you
 128 can easily destroy all your data>."
 129
 130 (* You can supply zero or as many tests as you want per API call.
 131  *
 132  * Note that the test environment has 3 block devices, of size 500MB,
 133  * 50MB and 10MB (respectively /dev/sda, /dev/sdb, /dev/sdc), and
 134  * a fourth squashfs block device with some known files on it (/dev/sdd).
 135  *
 136  * Note for partitioning purposes, the 500MB device has 63 cylinders.
 137  *
 138  * The squashfs block device (/dev/sdd) comes from images/test.sqsh.
 139  *
 140  * To be able to run the tests in a reasonable amount of time,
 141  * the virtual machine and block devices are reused between tests.
 142  * So don't try testing kill_subprocess :-x
 143  *
 144  * Between each test we blockdev-setrw, umount-all, lvm-remove-all.
 145  *
 146  * Don't assume anything about the previous contents of the block
 147  * devices.  Use 'Init*' to create some initial scenarios.
 148  *
 149  * You can add a prerequisite clause to any individual test.  This
 150  * is a run-time check, which, if it fails, causes the test to be
 151  * skipped.  Useful if testing a command which might not work on
 152  * all variations of libguestfs builds.  A test that has prerequisite
 153  * of 'Always' is run unconditionally.
 154  *
 155  * In addition, packagers can skip individual tests by setting the
 156  * environment variables:     eg:
 157  *   SKIP_TEST_<CMD>_<NUM>=1  SKIP_TEST_COMMAND_3=1  (skips test #3 of command)
 158  *   SKIP_TEST_<CMD>=1        SKIP_TEST_ZEROFREE=1   (skips all zerofree tests)
 159  *)
 160 type tests = (test_init * test_prereq * test) list
 161 and test =
 162     (* Run the command sequence and just expect nothing to fail. *)
 163   | TestRun of seq
 164     (* Run the command sequence and expect the output of the final
 165      * command to be the string.
 166      *)
 167   | TestOutput of seq * string
 168     (* Run the command sequence and expect the output of the final
 169      * command to be the list of strings.
 170      *)
 171   | TestOutputList of seq * string list
 172     (* Run the command sequence and expect the output of the final
 173      * command to be the list of block devices (could be either
 174      * "/dev/sd.." or "/dev/hd.." form - we don't check the 5th
 175      * character of each string).
 176      *)
 177   | TestOutputListOfDevices of seq * string list
 178     (* Run the command sequence and expect the output of the final
 179      * command to be the integer.
 180      *)
 181   | TestOutputInt of seq * int
 182     (* Run the command sequence and expect the output of the final
 183      * command to be a true value (!= 0 or != NULL).
 184      *)
 185   | TestOutputTrue of seq
 186     (* Run the command sequence and expect the output of the final
 187      * command to be a false value (== 0 or == NULL, but not an error).
 188      *)
 189   | TestOutputFalse of seq
 190     (* Run the command sequence and expect the output of the final
 191      * command to be a list of the given length (but don't care about
 192      * content).
 193      *)
 194   | TestOutputLength of seq * int
 195     (* Run the command sequence and expect the output of the final
 196      * command to be a structure.
 197      *)
 198   | TestOutputStruct of seq * test_field_compare list
 199     (* Run the command sequence and expect the final command (only)
 200      * to fail.
 201      *)
 202   | TestLastFail of seq
 203
 204 and test_field_compare =
 205   | CompareWithInt of string * int
 206   | CompareWithString of string * string
 207   | CompareFieldsIntEq of string * string
 208   | CompareFieldsStrEq of string * string
 209
 210 (* Test prerequisites. *)
 211 and test_prereq =
 212     (* Test always runs. *)
 213   | Always
 214     (* Test is currently disabled - eg. it fails, or it tests some
 215      * unimplemented feature.
 216      *)
 217   | Disabled
 218     (* 'string' is some C code (a function body) that should return
 219      * true or false.  The test will run if the code returns true.
 220      *)
 221   | If of string
 222     (* As for 'If' but the test runs _unless_ the code returns true. *)
 223   | Unless of string
 224
 225 (* Some initial scenarios for testing. *)
 226 and test_init =
 227     (* Do nothing, block devices could contain random stuff including
 228      * LVM PVs, and some filesystems might be mounted.  This is usually
 229      * a bad idea.
 230      *)
 231   | InitNone
 232     (* Block devices are empty and no filesystems are mounted. *)
 233   | InitEmpty
 234     (* /dev/sda contains a single partition /dev/sda1, which is formatted
 235      * as ext2, empty [except for lost+found] and mounted on /.
 236      * /dev/sdb and /dev/sdc may have random content.
 237      * No LVM.
 238      *)
 239   | InitBasicFS
 240     (* /dev/sda:
 241      *   /dev/sda1 (is a PV):
 242      *     /dev/VG/LV (size 8MB):
 243      *       formatted as ext2, empty [except for lost+found], mounted on /
 244      * /dev/sdb and /dev/sdc may have random content.
 245      *)
 246   | InitBasicFSonLVM
 247
 248 (* Sequence of commands for testing. *)
 249 and seq = cmd list
 250 and cmd = string list
 251
 252 (* Note about long descriptions: When referring to another
 253  * action, use the format C<guestfs_other> (ie. the full name of
 254  * the C function).  This will be replaced as appropriate in other
 255  * language bindings.
 256  *
 257  * Apart from that, long descriptions are just perldoc paragraphs.
 258  *)
 259
 260 (* These test functions are used in the language binding tests. *)
 261
 262 let test_all_args = [
 263   String "str";
 264   OptString "optstr";
 265   StringList "strlist";
 266   Bool "b";
 267   Int "integer";
 268   FileIn "filein";
 269   FileOut "fileout";
 270 ]
 271
 272 let test_all_rets = [
 273   (* except for RErr, which is tested thoroughly elsewhere *)
 274   "test0rint",         RInt "valout";
 275   "test0rint64",       RInt64 "valout";
 276   "test0rbool",        RBool "valout";
 277   "test0rconststring", RConstString "valout";
 278   "test0rstring",      RString "valout";
 279   "test0rstringlist",  RStringList "valout";
 280   "test0rintbool",     RIntBool ("valout", "valout");
 281   "test0rpvlist",      RPVList "valout";
 282   "test0rvglist",      RVGList "valout";
 283   "test0rlvlist",      RLVList "valout";
 284   "test0rstat",        RStat "valout";
 285   "test0rstatvfs",     RStatVFS "valout";
 286   "test0rhashtable",   RHashtable "valout";
 287 ]
 288
 289 let test_functions = [
 290   ("test0", (RErr, test_all_args), -1, [NotInFish; NotInDocs],
 291    [],
 292    "internal test function - do not use",
 293    "\
 294 This is an internal test function which is used to test whether
 295 the automatically generated bindings can handle every possible
 296 parameter type correctly.
 297
 298 It echos the contents of each parameter to stdout.
 299
 300 You probably don't want to call this function.");
 301 ] @ List.flatten (
 302   List.map (
 303     fun (name, ret) ->
 304       [(name, (ret, [String "val"]), -1, [NotInFish; NotInDocs],
 305         [],
 306         "internal test function - do not use",
 307         "\
 308 This is an internal test function which is used to test whether
 309 the automatically generated bindings can handle every possible
 310 return type correctly.
 311
 312 It converts string C<val> to the return type.
 313
 314 You probably don't want to call this function.");
 315        (name ^ "err", (ret, []), -1, [NotInFish; NotInDocs],
 316         [],
 317         "internal test function - do not use",
 318         "\
 319 This is an internal test function which is used to test whether
 320 the automatically generated bindings can handle every possible
 321 return type correctly.
 322
 323 This function always returns an error.
 324
 325 You probably don't want to call this function.")]
 326   ) test_all_rets
 327 )
 328
 329 (* non_daemon_functions are any functions which don't get processed
 330  * in the daemon, eg. functions for setting and getting local
 331  * configuration values.
 332  *)
 333
 334 let non_daemon_functions = test_functions @ [
 335   ("launch", (RErr, []), -1, [FishAlias "run"; FishAction "launch"],
 336    [],
 337    "launch the qemu subprocess",
 338    "\
 339 Internally libguestfs is implemented by running a virtual machine
 340 using L<qemu(1)>.
 341
 342 You should call this after configuring the handle
 343 (eg. adding drives) but before performing any actions.");
 344
 345   ("wait_ready", (RErr, []), -1, [NotInFish],
 346    [],
 347    "wait until the qemu subprocess launches",
 348    "\
 349 Internally libguestfs is implemented by running a virtual machine
 350 using L<qemu(1)>.
 351
 352 You should call this after C<guestfs_launch> to wait for the launch
 353 to complete.");
 354
 355   ("kill_subprocess", (RErr, []), -1, [],
 356    [],
 357    "kill the qemu subprocess",
 358    "\
 359 This kills the qemu subprocess.  You should never need to call this.");
 360
 361   ("add_drive", (RErr, [String "filename"]), -1, [FishAlias "add"],
 362    [],
 363    "add an image to examine or modify",
 364    "\
 365 This function adds a virtual machine disk image C<filename> to the
 366 guest.  The first time you call this function, the disk appears as IDE
 367 disk 0 (C</dev/sda>) in the guest, the second time as C</dev/sdb>, and
 368 so on.
 369
 370 You don't necessarily need to be root when using libguestfs.  However
 371 you obviously do need sufficient permissions to access the filename
 372 for whatever operations you want to perform (ie. read access if you
 373 just want to read the image or write access if you want to modify the
 374 image).
 375
 376 This is equivalent to the qemu parameter C<-drive file=filename>.
 377
 378 Note that this call checks for the existence of C<filename>.  This
 379 stops you from specifying other types of drive which are supported
 380 by qemu such as C<nbd:> and C<http:> URLs.  To specify those, use
 381 the general C<guestfs_config> call instead.");
 382
 383   ("add_cdrom", (RErr, [String "filename"]), -1, [FishAlias "cdrom"],
 384    [],
 385    "add a CD-ROM disk image to examine",
 386    "\
 387 This function adds a virtual CD-ROM disk image to the guest.
 388
 389 This is equivalent to the qemu parameter C<-cdrom filename>.
 390
 391 Note that this call checks for the existence of C<filename>.  This
 392 stops you from specifying other types of drive which are supported
 393 by qemu such as C<nbd:> and C<http:> URLs.  To specify those, use
 394 the general C<guestfs_config> call instead.");
 395
 396   ("add_drive_ro", (RErr, [String "filename"]), -1, [FishAlias "add-ro"],
 397    [],
 398    "add a drive in snapshot mode (read-only)",
 399    "\
 400 This adds a drive in snapshot mode, making it effectively
 401 read-only.
 402
 403 Note that writes to the device are allowed, and will be seen for
 404 the duration of the guestfs handle, but they are written
 405 to a temporary file which is discarded as soon as the guestfs
 406 handle is closed.  We don't currently have any method to enable
 407 changes to be committed, although qemu can support this.
 408
 409 This is equivalent to the qemu parameter
 410 C<-drive file=filename,snapshot=on>.
 411
 412 Note that this call checks for the existence of C<filename>.  This
 413 stops you from specifying other types of drive which are supported
 414 by qemu such as C<nbd:> and C<http:> URLs.  To specify those, use
 415 the general C<guestfs_config> call instead.");
 416
 417   ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"]), -1, [],
 418    [],
 419    "add qemu parameters",
 420    "\
 421 This can be used to add arbitrary qemu command line parameters
 422 of the form C<-param value>.  Actually it's not quite arbitrary - we
 423 prevent you from setting some parameters which would interfere with
 424 parameters that we use.
 425
 426 The first character of C<param> string must be a C<-> (dash).
 427
 428 C<value> can be NULL.");
 429
 430   ("set_qemu", (RErr, [String "qemu"]), -1, [FishAlias "qemu"],
 431    [],
 432    "set the qemu binary",
 433    "\
 434 Set the qemu binary that we will use.
 435
 436 The default is chosen when the library was compiled by the
 437 configure script.
 438
 439 You can also override this by setting the C<LIBGUESTFS_QEMU>
 440 environment variable.
 441
 442 Setting C<qemu> to C<NULL> restores the default qemu binary.");
 443
 444   ("get_qemu", (RConstString "qemu", []), -1, [],
 445    [],
 446    "get the qemu binary",
 447    "\
 448 Return the current qemu binary.
 449
 450 This is always non-NULL.  If it wasn't set already, then this will
 451 return the default qemu binary name.");
 452
 453   ("set_path", (RErr, [String "path"]), -1, [FishAlias "path"],
 454    [],
 455    "set the search path",
 456    "\
 457 Set the path that libguestfs searches for kernel and initrd.img.
 458
 459 The default is C<$libdir/guestfs> unless overridden by setting
 460 C<LIBGUESTFS_PATH> environment variable.
 461
 462 Setting C<path> to C<NULL> restores the default path.");
 463
 464   ("get_path", (RConstString "path", []), -1, [],
 465    [],
 466    "get the search path",
 467    "\
 468 Return the current search path.
 469
 470 This is always non-NULL.  If it wasn't set already, then this will
 471 return the default path.");
 472
 473   ("set_append", (RErr, [String "append"]), -1, [FishAlias "append"],
 474    [],
 475    "add options to kernel command line",
 476    "\
 477 This function is used to add additional options to the
 478 guest kernel command line.
 479
 480 The default is C<NULL> unless overridden by setting
 481 C<LIBGUESTFS_APPEND> environment variable.
 482
 483 Setting C<append> to C<NULL> means I<no> additional options
 484 are passed (libguestfs always adds a few of its own).");
 485
 486   ("get_append", (RConstString "append", []), -1, [],
 487    [],
 488    "get the additional kernel options",
 489    "\
 490 Return the additional kernel options which are added to the
 491 guest kernel command line.
 492
 493 If C<NULL> then no options are added.");
 494
 495   ("set_autosync", (RErr, [Bool "autosync"]), -1, [FishAlias "autosync"],
 496    [],
 497    "set autosync mode",
 498    "\
 499 If C<autosync> is true, this enables autosync.  Libguestfs will make a
 500 best effort attempt to run C<guestfs_umount_all> followed by
 501 C<guestfs_sync> when the handle is closed
 502 (also if the program exits without closing handles).
 503
 504 This is disabled by default (except in guestfish where it is
 505 enabled by default).");
 506
 507   ("get_autosync", (RBool "autosync", []), -1, [],
 508    [],
 509    "get autosync mode",
 510    "\
 511 Get the autosync flag.");
 512
 513   ("set_verbose", (RErr, [Bool "verbose"]), -1, [FishAlias "verbose"],
 514    [],
 515    "set verbose mode",
 516    "\
 517 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
 518
 519 Verbose messages are disabled unless the environment variable
 520 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.");
 521
 522   ("get_verbose", (RBool "verbose", []), -1, [],
 523    [],
 524    "get verbose mode",
 525    "\
 526 This returns the verbose messages flag.");
 527
 528   ("is_ready", (RBool "ready", []), -1, [],
 529    [],
 530    "is ready to accept commands",
 531    "\
 532 This returns true iff this handle is ready to accept commands
 533 (in the C<READY> state).
 534
 535 For more information on states, see L<guestfs(3)>.");
 536
 537   ("is_config", (RBool "config", []), -1, [],
 538    [],
 539    "is in configuration state",
 540    "\
 541 This returns true iff this handle is being configured
 542 (in the C<CONFIG> state).
 543
 544 For more information on states, see L<guestfs(3)>.");
 545
 546   ("is_launching", (RBool "launching", []), -1, [],
 547    [],
 548    "is launching subprocess",
 549    "\
 550 This returns true iff this handle is launching the subprocess
 551 (in the C<LAUNCHING> state).
 552
 553 For more information on states, see L<guestfs(3)>.");
 554
 555   ("is_busy", (RBool "busy", []), -1, [],
 556    [],
 557    "is busy processing a command",
 558    "\
 559 This returns true iff this handle is busy processing a command
 560 (in the C<BUSY> state).
 561
 562 For more information on states, see L<guestfs(3)>.");
 563
 564   ("get_state", (RInt "state", []), -1, [],
 565    [],
 566    "get the current state",
 567    "\
 568 This returns the current state as an opaque integer.  This is
 569 only useful for printing debug and internal error messages.
 570
 571 For more information on states, see L<guestfs(3)>.");
 572
 573   ("set_busy", (RErr, []), -1, [NotInFish],
 574    [],
 575    "set state to busy",
 576    "\
 577 This sets the state to C<BUSY>.  This is only used when implementing
 578 actions using the low-level API.
 579
 580 For more information on states, see L<guestfs(3)>.");
 581
 582   ("set_ready", (RErr, []), -1, [NotInFish],
 583    [],
 584    "set state to ready",
 585    "\
 586 This sets the state to C<READY>.  This is only used when implementing
 587 actions using the low-level API.
 588
 589 For more information on states, see L<guestfs(3)>.");
 590
 591   ("end_busy", (RErr, []), -1, [NotInFish],
 592    [],
 593    "leave the busy state",
 594    "\
 595 This sets the state to C<READY>, or if in C<CONFIG> then it leaves the
 596 state as is.  This is only used when implementing
 597 actions using the low-level API.
 598
 599 For more information on states, see L<guestfs(3)>.");
 600
 601 ]
 602
 603 (* daemon_functions are any functions which cause some action
 604  * to take place in the daemon.
 605  *)
 606
 607 let daemon_functions = [
 608   ("mount", (RErr, [String "device"; String "mountpoint"]), 1, [],
 609    [InitEmpty, Always, TestOutput (
 610       [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
 611        ["mkfs"; "ext2"; "/dev/sda1"];
 612        ["mount"; "/dev/sda1"; "/"];
 613        ["write_file"; "/new"; "new file contents"; "0"];
 614        ["cat"; "/new"]], "new file contents")],
 615    "mount a guest disk at a position in the filesystem",
 616    "\
 617 Mount a guest disk at a position in the filesystem.  Block devices
 618 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
 619 the guest.  If those block devices contain partitions, they will have
 620 the usual names (eg. C</dev/sda1>).  Also LVM C</dev/VG/LV>-style
 621 names can be used.
 622
 623 The rules are the same as for L<mount(2)>:  A filesystem must
 624 first be mounted on C</> before others can be mounted.  Other
 625 filesystems can only be mounted on directories which already
 626 exist.
 627
 628 The mounted filesystem is writable, if we have sufficient permissions
 629 on the underlying device.
 630
 631 The filesystem options C<sync> and C<noatime> are set with this
 632 call, in order to improve reliability.");
 633
 634   ("sync", (RErr, []), 2, [],
 635    [ InitEmpty, Always, TestRun [["sync"]]],
 636    "sync disks, writes are flushed through to the disk image",
 637    "\
 638 This syncs the disk, so that any writes are flushed through to the
 639 underlying disk image.
 640
 641 You should always call this if you have modified a disk image, before
 642 closing the handle.");
 643
 644   ("touch", (RErr, [String "path"]), 3, [],
 645    [InitBasicFS, Always, TestOutputTrue (
 646       [["touch"; "/new"];
 647        ["exists"; "/new"]])],
 648    "update file timestamps or create a new file",
 649    "\
 650 Touch acts like the L<touch(1)> command.  It can be used to
 651 update the timestamps on a file, or, if the file does not exist,
 652 to create a new zero-length file.");
 653
 654   ("cat", (RString "content", [String "path"]), 4, [ProtocolLimitWarning],
 655    [InitBasicFS, Always, TestOutput (
 656       [["write_file"; "/new"; "new file contents"; "0"];
 657        ["cat"; "/new"]], "new file contents")],
 658    "list the contents of a file",
 659    "\
 660 Return the contents of the file named C<path>.
 661
 662 Note that this function cannot correctly handle binary files
 663 (specifically, files containing C<\\0> character which is treated
 664 as end of string).  For those you need to use the C<guestfs_download>
 665 function which has a more complex interface.");
 666
 667   ("ll", (RString "listing", [String "directory"]), 5, [],
 668    [], (* XXX Tricky to test because it depends on the exact format
 669         * of the 'ls -l' command, which changes between F10 and F11.
 670         *)
 671    "list the files in a directory (long format)",
 672    "\
 673 List the files in C<directory> (relative to the root directory,
 674 there is no cwd) in the format of 'ls -la'.
 675
 676 This command is mostly useful for interactive sessions.  It
 677 is I<not> intended that you try to parse the output string.");
 678
 679   ("ls", (RStringList "listing", [String "directory"]), 6, [],
 680    [InitBasicFS, Always, TestOutputList (
 681       [["touch"; "/new"];
 682        ["touch"; "/newer"];
 683        ["touch"; "/newest"];
 684        ["ls"; "/"]], ["lost+found"; "new"; "newer"; "newest"])],
 685    "list the files in a directory",
 686    "\
 687 List the files in C<directory> (relative to the root directory,
 688 there is no cwd).  The '.' and '..' entries are not returned, but
 689 hidden files are shown.
 690
 691 This command is mostly useful for interactive sessions.  Programs
 692 should probably use C<guestfs_readdir> instead.");
 693
 694   ("list_devices", (RStringList "devices", []), 7, [],
 695    [InitEmpty, Always, TestOutputListOfDevices (
 696       [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
 697    "list the block devices",
 698    "\
 699 List all the block devices.
 700
 701 The full block device names are returned, eg. C</dev/sda>");
 702
 703   ("list_partitions", (RStringList "partitions", []), 8, [],
 704    [InitBasicFS, Always, TestOutputListOfDevices (
 705       [["list_partitions"]], ["/dev/sda1"]);
 706     InitEmpty, Always, TestOutputListOfDevices (
 707       [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
 708        ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
 709    "list the partitions",
 710    "\
 711 List all the partitions detected on all block devices.
 712
 713 The full partition device names are returned, eg. C</dev/sda1>
 714
 715 This does not return logical volumes.  For that you will need to
 716 call C<guestfs_lvs>.");
 717
 718   ("pvs", (RStringList "physvols", []), 9, [],
 719    [InitBasicFSonLVM, Always, TestOutputListOfDevices (
 720       [["pvs"]], ["/dev/sda1"]);
 721     InitEmpty, Always, TestOutputListOfDevices (
 722       [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
 723        ["pvcreate"; "/dev/sda1"];
 724        ["pvcreate"; "/dev/sda2"];
 725        ["pvcreate"; "/dev/sda3"];
 726        ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
 727    "list the LVM physical volumes (PVs)",
 728    "\
 729 List all the physical volumes detected.  This is the equivalent
 730 of the L<pvs(8)> command.
 731
 732 This returns a list of just the device names that contain
 733 PVs (eg. C</dev/sda2>).
 734
 735 See also C<guestfs_pvs_full>.");
 736
 737   ("vgs", (RStringList "volgroups", []), 10, [],
 738    [InitBasicFSonLVM, Always, TestOutputList (
 739       [["vgs"]], ["VG"]);
 740     InitEmpty, Always, TestOutputList (
 741       [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
 742        ["pvcreate"; "/dev/sda1"];
 743        ["pvcreate"; "/dev/sda2"];
 744        ["pvcreate"; "/dev/sda3"];
 745        ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
 746        ["vgcreate"; "VG2"; "/dev/sda3"];
 747        ["vgs"]], ["VG1"; "VG2"])],
 748    "list the LVM volume groups (VGs)",
 749    "\
 750 List all the volumes groups detected.  This is the equivalent
 751 of the L<vgs(8)> command.
 752
 753 This returns a list of just the volume group names that were
 754 detected (eg. C<VolGroup00>).
 755
 756 See also C<guestfs_vgs_full>.");
 757
 758   ("lvs", (RStringList "logvols", []), 11, [],
 759    [InitBasicFSonLVM, Always, TestOutputList (
 760       [["lvs"]], ["/dev/VG/LV"]);
 761     InitEmpty, Always, TestOutputList (
 762       [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
 763        ["pvcreate"; "/dev/sda1"];
 764        ["pvcreate"; "/dev/sda2"];
 765        ["pvcreate"; "/dev/sda3"];
 766        ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
 767        ["vgcreate"; "VG2"; "/dev/sda3"];
 768        ["lvcreate"; "LV1"; "VG1"; "50"];
 769        ["lvcreate"; "LV2"; "VG1"; "50"];
 770        ["lvcreate"; "LV3"; "VG2"; "50"];
 771        ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
 772    "list the LVM logical volumes (LVs)",
 773    "\
 774 List all the logical volumes detected.  This is the equivalent
 775 of the L<lvs(8)> command.
 776
 777 This returns a list of the logical volume device names
 778 (eg. C</dev/VolGroup00/LogVol00>).
 779
 780 See also C<guestfs_lvs_full>.");
 781
 782   ("pvs_full", (RPVList "physvols", []), 12, [],
 783    [], (* XXX how to test? *)
 784    "list the LVM physical volumes (PVs)",
 785    "\
 786 List all the physical volumes detected.  This is the equivalent
 787 of the L<pvs(8)> command.  The \"full\" version includes all fields.");
 788
 789   ("vgs_full", (RVGList "volgroups", []), 13, [],
 790    [], (* XXX how to test? *)
 791    "list the LVM volume groups (VGs)",
 792    "\
 793 List all the volumes groups detected.  This is the equivalent
 794 of the L<vgs(8)> command.  The \"full\" version includes all fields.");
 795
 796   ("lvs_full", (RLVList "logvols", []), 14, [],
 797    [], (* XXX how to test? *)
 798    "list the LVM logical volumes (LVs)",
 799    "\
 800 List all the logical volumes detected.  This is the equivalent
 801 of the L<lvs(8)> command.  The \"full\" version includes all fields.");
 802
 803   ("read_lines", (RStringList "lines", [String "path"]), 15, [],
 804    [InitBasicFS, Always, TestOutputList (
 805       [["write_file"; "/new"; "line1\r\nline2\nline3"; "0"];
 806        ["read_lines"; "/new"]], ["line1"; "line2"; "line3"]);
 807     InitBasicFS, Always, TestOutputList (
 808       [["write_file"; "/new"; ""; "0"];
 809        ["read_lines"; "/new"]], [])],
 810    "read file as lines",
 811    "\
 812 Return the contents of the file named C<path>.
 813
 814 The file contents are returned as a list of lines.  Trailing
 815 C<LF> and C<CRLF> character sequences are I<not> returned.
 816
 817 Note that this function cannot correctly handle binary files
 818 (specifically, files containing C<\\0> character which is treated
 819 as end of line).  For those you need to use the C<guestfs_read_file>
 820 function which has a more complex interface.");
 821
 822   ("aug_init", (RErr, [String "root"; Int "flags"]), 16, [],
 823    [], (* XXX Augeas code needs tests. *)
 824    "create a new Augeas handle",
 825    "\
 826 Create a new Augeas handle for editing configuration files.
 827 If there was any previous Augeas handle associated with this
 828 guestfs session, then it is closed.
 829
 830 You must call this before using any other C<guestfs_aug_*>
 831 commands.
 832
 833 C<root> is the filesystem root.  C<root> must not be NULL,
 834 use C</> instead.
 835
 836 The flags are the same as the flags defined in
 837 E<lt>augeas.hE<gt>, the logical I<or> of the following
 838 integers:
 839
 840 =over 4
 841
 842 =item C<AUG_SAVE_BACKUP> = 1
 843
 844 Keep the original file with a C<.augsave> extension.
 845
 846 =item C<AUG_SAVE_NEWFILE> = 2
 847
 848 Save changes into a file with extension C<.augnew>, and
 849 do not overwrite original.  Overrides C<AUG_SAVE_BACKUP>.
 850
 851 =item C<AUG_TYPE_CHECK> = 4
 852
 853 Typecheck lenses (can be expensive).
 854
 855 =item C<AUG_NO_STDINC> = 8
 856
 857 Do not use standard load path for modules.
 858
 859 =item C<AUG_SAVE_NOOP> = 16
 860
 861 Make save a no-op, just record what would have been changed.
 862
 863 =item C<AUG_NO_LOAD> = 32
 864
 865 Do not load the tree in C<guestfs_aug_init>.
 866
 867 =back
 868
 869 To close the handle, you can call C<guestfs_aug_close>.
 870
 871 To find out more about Augeas, see L<http://augeas.net/>.");
 872
 873   ("aug_close", (RErr, []), 26, [],
 874    [], (* XXX Augeas code needs tests. *)
 875    "close the current Augeas handle",
 876    "\
 877 Close the current Augeas handle and free up any resources
 878 used by it.  After calling this, you have to call
 879 C<guestfs_aug_init> again before you can use any other
 880 Augeas functions.");
 881
 882   ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"]), 17, [],
 883    [], (* XXX Augeas code needs tests. *)
 884    "define an Augeas variable",
 885    "\
 886 Defines an Augeas variable C<name> whose value is the result
 887 of evaluating C<expr>.  If C<expr> is NULL, then C<name> is
 888 undefined.
 889
 890 On success this returns the number of nodes in C<expr>, or
 891 C<0> if C<expr> evaluates to something which is not a nodeset.");
 892
 893   ("aug_defnode", (RIntBool ("nrnodes", "created"), [String "name"; String "expr"; String "val"]), 18, [],
 894    [], (* XXX Augeas code needs tests. *)
 895    "define an Augeas node",
 896    "\
 897 Defines a variable C<name> whose value is the result of
 898 evaluating C<expr>.
 899
 900 If C<expr> evaluates to an empty nodeset, a node is created,
 901 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
 902 C<name> will be the nodeset containing that single node.
 903
 904 On success this returns a pair containing the
 905 number of nodes in the nodeset, and a boolean flag
 906 if a node was created.");
 907
 908   ("aug_get", (RString "val", [String "path"]), 19, [],
 909    [], (* XXX Augeas code needs tests. *)
 910    "look up the value of an Augeas path",
 911    "\
 912 Look up the value associated with C<path>.  If C<path>
 913 matches exactly one node, the C<value> is returned.");
 914
 915   ("aug_set", (RErr, [String "path"; String "val"]), 20, [],
 916    [], (* XXX Augeas code needs tests. *)
 917    "set Augeas path to value",
 918    "\
 919 Set the value associated with C<path> to C<value>.");
 920
 921   ("aug_insert", (RErr, [String "path"; String "label"; Bool "before"]), 21, [],
 922    [], (* XXX Augeas code needs tests. *)
 923    "insert a sibling Augeas node",
 924    "\
 925 Create a new sibling C<label> for C<path>, inserting it into
 926 the tree before or after C<path> (depending on the boolean
 927 flag C<before>).
 928
 929 C<path> must match exactly one existing node in the tree, and
 930 C<label> must be a label, ie. not contain C</>, C<*> or end
 931 with a bracketed index C<[N]>.");
 932
 933   ("aug_rm", (RInt "nrnodes", [String "path"]), 22, [],
 934    [], (* XXX Augeas code needs tests. *)
 935    "remove an Augeas path",
 936    "\
 937 Remove C<path> and all of its children.
 938
 939 On success this returns the number of entries which were removed.");
 940
 941   ("aug_mv", (RErr, [String "src"; String "dest"]), 23, [],
 942    [], (* XXX Augeas code needs tests. *)
 943    "move Augeas node",
 944    "\
 945 Move the node C<src> to C<dest>.  C<src> must match exactly
 946 one node.  C<dest> is overwritten if it exists.");
 947
 948   ("aug_match", (RStringList "matches", [String "path"]), 24, [],
 949    [], (* XXX Augeas code needs tests. *)
 950    "return Augeas nodes which match path",
 951    "\
 952 Returns a list of paths which match the path expression C<path>.
 953 The returned paths are sufficiently qualified so that they match
 954 exactly one node in the current tree.");
 955
 956   ("aug_save", (RErr, []), 25, [],
 957    [], (* XXX Augeas code needs tests. *)
 958    "write all pending Augeas changes to disk",
 959    "\
 960 This writes all pending changes to disk.
 961
 962 The flags which were passed to C<guestfs_aug_init> affect exactly
 963 how files are saved.");
 964
 965   ("aug_load", (RErr, []), 27, [],
 966    [], (* XXX Augeas code needs tests. *)
 967    "load files into the tree",
 968    "\
 969 Load files into the tree.
 970
 971 See C<aug_load> in the Augeas documentation for the full gory
 972 details.");
 973
 974   ("aug_ls", (RStringList "matches", [String "path"]), 28, [],
 975    [], (* XXX Augeas code needs tests. *)
 976    "list Augeas nodes under a path",
 977    "\
 978 This is just a shortcut for listing C<guestfs_aug_match>
 979 C<path/*> and sorting the resulting nodes into alphabetical order.");
 980
 981   ("rm", (RErr, [String "path"]), 29, [],
 982    [InitBasicFS, Always, TestRun
 983       [["touch"; "/new"];
 984        ["rm"; "/new"]];
 985     InitBasicFS, Always, TestLastFail
 986       [["rm"; "/new"]];
 987     InitBasicFS, Always, TestLastFail
 988       [["mkdir"; "/new"];
 989        ["rm"; "/new"]]],
 990    "remove a file",
 991    "\
 992 Remove the single file C<path>.");
 993
 994   ("rmdir", (RErr, [String "path"]), 30, [],
 995    [InitBasicFS, Always, TestRun
 996       [["mkdir"; "/new"];
 997        ["rmdir"; "/new"]];
 998     InitBasicFS, Always, TestLastFail
 999       [["rmdir"; "/new"]];
1000     InitBasicFS, Always, TestLastFail
1001       [["touch"; "/new"];
1002        ["rmdir"; "/new"]]],
1003    "remove a directory",
1004    "\
1005 Remove the single directory C<path>.");
1006
1007   ("rm_rf", (RErr, [String "path"]), 31, [],
1008    [InitBasicFS, Always, TestOutputFalse
1009       [["mkdir"; "/new"];
1010        ["mkdir"; "/new/foo"];
1011        ["touch"; "/new/foo/bar"];
1012        ["rm_rf"; "/new"];
1013        ["exists"; "/new"]]],
1014    "remove a file or directory recursively",
1015    "\
1016 Remove the file or directory C<path>, recursively removing the
1017 contents if its a directory.  This is like the C<rm -rf> shell
1018 command.");
1019
1020   ("mkdir", (RErr, [String "path"]), 32, [],
1021    [InitBasicFS, Always, TestOutputTrue
1022       [["mkdir"; "/new"];
1023        ["is_dir"; "/new"]];
1024     InitBasicFS, Always, TestLastFail
1025       [["mkdir"; "/new/foo/bar"]]],
1026    "create a directory",
1027    "\
1028 Create a directory named C<path>.");
1029
1030   ("mkdir_p", (RErr, [String "path"]), 33, [],
1031    [InitBasicFS, Always, TestOutputTrue
1032       [["mkdir_p"; "/new/foo/bar"];
1033        ["is_dir"; "/new/foo/bar"]];
1034     InitBasicFS, Always, TestOutputTrue
1035       [["mkdir_p"; "/new/foo/bar"];
1036        ["is_dir"; "/new/foo"]];
1037     InitBasicFS, Always, TestOutputTrue
1038       [["mkdir_p"; "/new/foo/bar"];
1039        ["is_dir"; "/new"]];
1040     (* Regression tests for RHBZ#503133: *)
1041     InitBasicFS, Always, TestRun
1042       [["mkdir"; "/new"];
1043        ["mkdir_p"; "/new"]];
1044     InitBasicFS, Always, TestLastFail
1045       [["touch"; "/new"];
1046        ["mkdir_p"; "/new"]]],
1047    "create a directory and parents",
1048    "\
1049 Create a directory named C<path>, creating any parent directories
1050 as necessary.  This is like the C<mkdir -p> shell command.");
1051
1052   ("chmod", (RErr, [Int "mode"; String "path"]), 34, [],
1053    [], (* XXX Need stat command to test *)
1054    "change file mode",
1055    "\
1056 Change the mode (permissions) of C<path> to C<mode>.  Only
1057 numeric modes are supported.");
1058
1059   ("chown", (RErr, [Int "owner"; Int "group"; String "path"]), 35, [],
1060    [], (* XXX Need stat command to test *)
1061    "change file owner and group",
1062    "\
1063 Change the file owner to C<owner> and group to C<group>.
1064
1065 Only numeric uid and gid are supported.  If you want to use
1066 names, you will need to locate and parse the password file
1067 yourself (Augeas support makes this relatively easy).");
1068
1069   ("exists", (RBool "existsflag", [String "path"]), 36, [],
1070    [InitBasicFS, Always, TestOutputTrue (
1071       [["touch"; "/new"];
1072        ["exists"; "/new"]]);
1073     InitBasicFS, Always, TestOutputTrue (
1074       [["mkdir"; "/new"];
1075        ["exists"; "/new"]])],
1076    "test if file or directory exists",
1077    "\
1078 This returns C<true> if and only if there is a file, directory
1079 (or anything) with the given C<path> name.
1080
1081 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1082
1083   ("is_file", (RBool "fileflag", [String "path"]), 37, [],
1084    [InitBasicFS, Always, TestOutputTrue (
1085       [["touch"; "/new"];
1086        ["is_file"; "/new"]]);
1087     InitBasicFS, Always, TestOutputFalse (
1088       [["mkdir"; "/new"];
1089        ["is_file"; "/new"]])],
1090    "test if file exists",
1091    "\
1092 This returns C<true> if and only if there is a file
1093 with the given C<path> name.  Note that it returns false for
1094 other objects like directories.
1095
1096 See also C<guestfs_stat>.");
1097
1098   ("is_dir", (RBool "dirflag", [String "path"]), 38, [],
1099    [InitBasicFS, Always, TestOutputFalse (
1100       [["touch"; "/new"];
1101        ["is_dir"; "/new"]]);
1102     InitBasicFS, Always, TestOutputTrue (
1103       [["mkdir"; "/new"];
1104        ["is_dir"; "/new"]])],
1105    "test if file exists",
1106    "\
1107 This returns C<true> if and only if there is a directory
1108 with the given C<path> name.  Note that it returns false for
1109 other objects like files.
1110
1111 See also C<guestfs_stat>.");
1112
1113   ("pvcreate", (RErr, [String "device"]), 39, [],
1114    [InitEmpty, Always, TestOutputListOfDevices (
1115       [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
1116        ["pvcreate"; "/dev/sda1"];
1117        ["pvcreate"; "/dev/sda2"];
1118        ["pvcreate"; "/dev/sda3"];
1119        ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1120    "create an LVM physical volume",
1121    "\
1122 This creates an LVM physical volume on the named C<device>,
1123 where C<device> should usually be a partition name such
1124 as C</dev/sda1>.");
1125
1126   ("vgcreate", (RErr, [String "volgroup"; StringList "physvols"]), 40, [],
1127    [InitEmpty, Always, TestOutputList (
1128       [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
1129        ["pvcreate"; "/dev/sda1"];
1130        ["pvcreate"; "/dev/sda2"];
1131        ["pvcreate"; "/dev/sda3"];
1132        ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1133        ["vgcreate"; "VG2"; "/dev/sda3"];
1134        ["vgs"]], ["VG1"; "VG2"])],
1135    "create an LVM volume group",
1136    "\
1137 This creates an LVM volume group called C<volgroup>
1138 from the non-empty list of physical volumes C<physvols>.");
1139
1140   ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"]), 41, [],
1141    [InitEmpty, Always, TestOutputList (
1142       [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
1143        ["pvcreate"; "/dev/sda1"];
1144        ["pvcreate"; "/dev/sda2"];
1145        ["pvcreate"; "/dev/sda3"];
1146        ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1147        ["vgcreate"; "VG2"; "/dev/sda3"];
1148        ["lvcreate"; "LV1"; "VG1"; "50"];
1149        ["lvcreate"; "LV2"; "VG1"; "50"];
1150        ["lvcreate"; "LV3"; "VG2"; "50"];
1151        ["lvcreate"; "LV4"; "VG2"; "50"];
1152        ["lvcreate"; "LV5"; "VG2"; "50"];
1153        ["lvs"]],
1154       ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1155        "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1156    "create an LVM volume group",
1157    "\
1158 This creates an LVM volume group called C<logvol>
1159 on the volume group C<volgroup>, with C<size> megabytes.");
1160
1161   ("mkfs", (RErr, [String "fstype"; String "device"]), 42, [],
1162    [InitEmpty, Always, TestOutput (
1163       [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1164        ["mkfs"; "ext2"; "/dev/sda1"];
1165        ["mount"; "/dev/sda1"; "/"];
1166        ["write_file"; "/new"; "new file contents"; "0"];
1167        ["cat"; "/new"]], "new file contents")],
1168    "make a filesystem",
1169    "\
1170 This creates a filesystem on C<device> (usually a partition
1171 or LVM logical volume).  The filesystem type is C<fstype>, for
1172 example C<ext3>.");
1173
1174   ("sfdisk", (RErr, [String "device";
1175                      Int "cyls"; Int "heads"; Int "sectors";
1176                      StringList "lines"]), 43, [DangerWillRobinson],
1177    [],
1178    "create partitions on a block device",
1179    "\
1180 This is a direct interface to the L<sfdisk(8)> program for creating
1181 partitions on block devices.
1182
1183 C<device> should be a block device, for example C</dev/sda>.
1184
1185 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1186 and sectors on the device, which are passed directly to sfdisk as
1187 the I<-C>, I<-H> and I<-S> parameters.  If you pass C<0> for any
1188 of these, then the corresponding parameter is omitted.  Usually for
1189 'large' disks, you can just pass C<0> for these, but for small
1190 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1191 out the right geometry and you will need to tell it.
1192
1193 C<lines> is a list of lines that we feed to C<sfdisk>.  For more
1194 information refer to the L<sfdisk(8)> manpage.
1195
1196 To create a single partition occupying the whole disk, you would
1197 pass C<lines> as a single element list, when the single element being
1198 the string C<,> (comma).
1199
1200 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>");
1201
1202   ("write_file", (RErr, [String "path"; String "content"; Int "size"]), 44, [ProtocolLimitWarning],
1203    [InitBasicFS, Always, TestOutput (
1204       [["write_file"; "/new"; "new file contents"; "0"];
1205        ["cat"; "/new"]], "new file contents");
1206     InitBasicFS, Always, TestOutput (
1207       [["write_file"; "/new"; "\nnew file contents\n"; "0"];
1208        ["cat"; "/new"]], "\nnew file contents\n");
1209     InitBasicFS, Always, TestOutput (
1210       [["write_file"; "/new"; "\n\n"; "0"];
1211        ["cat"; "/new"]], "\n\n");
1212     InitBasicFS, Always, TestOutput (
1213       [["write_file"; "/new"; ""; "0"];
1214        ["cat"; "/new"]], "");
1215     InitBasicFS, Always, TestOutput (
1216       [["write_file"; "/new"; "\n\n\n"; "0"];
1217        ["cat"; "/new"]], "\n\n\n");
1218     InitBasicFS, Always, TestOutput (
1219       [["write_file"; "/new"; "\n"; "0"];
1220        ["cat"; "/new"]], "\n")],
1221    "create a file",
1222    "\
1223 This call creates a file called C<path>.  The contents of the
1224 file is the string C<content> (which can contain any 8 bit data),
1225 with length C<size>.
1226
1227 As a special case, if C<size> is C<0>
1228 then the length is calculated using C<strlen> (so in this case
1229 the content cannot contain embedded ASCII NULs).
1230
1231 I<NB.> Owing to a bug, writing content containing ASCII NUL
1232 characters does I<not> work, even if the length is specified.
1233 We hope to resolve this bug in a future version.  In the meantime
1234 use C<guestfs_upload>.");
1235
1236   ("umount", (RErr, [String "pathordevice"]), 45, [FishAlias "unmount"],
1237    [InitEmpty, Always, TestOutputListOfDevices (
1238       [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1239        ["mkfs"; "ext2"; "/dev/sda1"];
1240        ["mount"; "/dev/sda1"; "/"];
1241        ["mounts"]], ["/dev/sda1"]);
1242     InitEmpty, Always, TestOutputList (
1243       [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1244        ["mkfs"; "ext2"; "/dev/sda1"];
1245        ["mount"; "/dev/sda1"; "/"];
1246        ["umount"; "/"];
1247        ["mounts"]], [])],
1248    "unmount a filesystem",
1249    "\
1250 This unmounts the given filesystem.  The filesystem may be
1251 specified either by its mountpoint (path) or the device which
1252 contains the filesystem.");
1253
1254   ("mounts", (RStringList "devices", []), 46, [],
1255    [InitBasicFS, Always, TestOutputListOfDevices (
1256       [["mounts"]], ["/dev/sda1"])],
1257    "show mounted filesystems",
1258    "\
1259 This returns the list of currently mounted filesystems.  It returns
1260 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1261
1262 Some internal mounts are not shown.");
1263
1264   ("umount_all", (RErr, []), 47, [FishAlias "unmount-all"],
1265    [InitBasicFS, Always, TestOutputList (
1266       [["umount_all"];
1267        ["mounts"]], []);
1268     (* check that umount_all can unmount nested mounts correctly: *)
1269     InitEmpty, Always, TestOutputList (
1270       [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ",10 ,20 ,"];
1271        ["mkfs"; "ext2"; "/dev/sda1"];
1272        ["mkfs"; "ext2"; "/dev/sda2"];
1273        ["mkfs"; "ext2"; "/dev/sda3"];
1274        ["mount"; "/dev/sda1"; "/"];
1275        ["mkdir"; "/mp1"];
1276        ["mount"; "/dev/sda2"; "/mp1"];
1277        ["mkdir"; "/mp1/mp2"];
1278        ["mount"; "/dev/sda3"; "/mp1/mp2"];
1279        ["mkdir"; "/mp1/mp2/mp3"];
1280        ["umount_all"];
1281        ["mounts"]], [])],
1282    "unmount all filesystems",
1283    "\
1284 This unmounts all mounted filesystems.
1285
1286 Some internal mounts are not unmounted by this call.");
1287
1288   ("lvm_remove_all", (RErr, []), 48, [DangerWillRobinson],
1289    [],
1290    "remove all LVM LVs, VGs and PVs",
1291    "\
1292 This command removes all LVM logical volumes, volume groups
1293 and physical volumes.");
1294
1295   ("file", (RString "description", [String "path"]), 49, [],
1296    [InitBasicFS, Always, TestOutput (
1297       [["touch"; "/new"];
1298        ["file"; "/new"]], "empty");
1299     InitBasicFS, Always, TestOutput (
1300       [["write_file"; "/new"; "some content\n"; "0"];
1301        ["file"; "/new"]], "ASCII text");
1302     InitBasicFS, Always, TestLastFail (
1303       [["file"; "/nofile"]])],
1304    "determine file type",
1305    "\
1306 This call uses the standard L<file(1)> command to determine
1307 the type or contents of the file.  This also works on devices,
1308 for example to find out whether a partition contains a filesystem.
1309
1310 The exact command which runs is C<file -bsL path>.  Note in
1311 particular that the filename is not prepended to the output
1312 (the C<-b> option).");
1313
1314   ("command", (RString "output", [StringList "arguments"]), 50, [ProtocolLimitWarning],
1315    [InitBasicFS, Always, TestOutput (
1316       [["upload"; "test-command"; "/test-command"];
1317        ["chmod"; "493"; "/test-command"];
1318        ["command"; "/test-command 1"]], "Result1");
1319     InitBasicFS, Always, TestOutput (
1320       [["upload"; "test-command"; "/test-command"];
1321        ["chmod"; "493"; "/test-command"];
1322        ["command"; "/test-command 2"]], "Result2\n");
1323     InitBasicFS, Always, TestOutput (
1324       [["upload"; "test-command"; "/test-command"];
1325        ["chmod"; "493"; "/test-command"];
1326        ["command"; "/test-command 3"]], "\nResult3");
1327     InitBasicFS, Always, TestOutput (
1328       [["upload"; "test-command"; "/test-command"];
1329        ["chmod"; "493"; "/test-command"];
1330        ["command"; "/test-command 4"]], "\nResult4\n");
1331     InitBasicFS, Always, TestOutput (
1332       [["upload"; "test-command"; "/test-command"];
1333        ["chmod"; "493"; "/test-command"];
1334        ["command"; "/test-command 5"]], "\nResult5\n\n");
1335     InitBasicFS, Always, TestOutput (
1336       [["upload"; "test-command"; "/test-command"];
1337        ["chmod"; "493"; "/test-command"];
1338        ["command"; "/test-command 6"]], "\n\nResult6\n\n");
1339     InitBasicFS, Always, TestOutput (
1340       [["upload"; "test-command"; "/test-command"];
1341        ["chmod"; "493"; "/test-command"];
1342        ["command"; "/test-command 7"]], "");
1343     InitBasicFS, Always, TestOutput (
1344       [["upload"; "test-command"; "/test-command"];
1345        ["chmod"; "493"; "/test-command"];
1346        ["command"; "/test-command 8"]], "\n");
1347     InitBasicFS, Always, TestOutput (
1348       [["upload"; "test-command"; "/test-command"];
1349        ["chmod"; "493"; "/test-command"];
1350        ["command"; "/test-command 9"]], "\n\n");
1351     InitBasicFS, Always, TestOutput (
1352       [["upload"; "test-command"; "/test-command"];
1353        ["chmod"; "493"; "/test-command"];
1354        ["command"; "/test-command 10"]], "Result10-1\nResult10-2\n");
1355     InitBasicFS, Always, TestOutput (
1356       [["upload"; "test-command"; "/test-command"];
1357        ["chmod"; "493"; "/test-command"];
1358        ["command"; "/test-command 11"]], "Result11-1\nResult11-2");
1359     InitBasicFS, Always, TestLastFail (
1360       [["upload"; "test-command"; "/test-command"];
1361        ["chmod"; "493"; "/test-command"];
1362        ["command"; "/test-command"]])],
1363    "run a command from the guest filesystem",
1364    "\
1365 This call runs a command from the guest filesystem.  The
1366 filesystem must be mounted, and must contain a compatible
1367 operating system (ie. something Linux, with the same
1368 or compatible processor architecture).
1369
1370 The single parameter is an argv-style list of arguments.
1371 The first element is the name of the program to run.
1372 Subsequent elements are parameters.  The list must be
1373 non-empty (ie. must contain a program name).
1374
1375 The return value is anything printed to I<stdout> by
1376 the command.
1377
1378 If the command returns a non-zero exit status, then
1379 this function returns an error message.  The error message
1380 string is the content of I<stderr> from the command.
1381
1382 The C<$PATH> environment variable will contain at least
1383 C</usr/bin> and C</bin>.  If you require a program from
1384 another location, you should provide the full path in the
1385 first parameter.
1386
1387 Shared libraries and data files required by the program
1388 must be available on filesystems which are mounted in the
1389 correct places.  It is the caller's responsibility to ensure
1390 all filesystems that are needed are mounted at the right
1391 locations.");
1392
1393   ("command_lines", (RStringList "lines", [StringList "arguments"]), 51, [ProtocolLimitWarning],
1394    [InitBasicFS, Always, TestOutputList (
1395       [["upload"; "test-command"; "/test-command"];
1396        ["chmod"; "493"; "/test-command"];
1397        ["command_lines"; "/test-command 1"]], ["Result1"]);
1398     InitBasicFS, Always, TestOutputList (
1399       [["upload"; "test-command"; "/test-command"];
1400        ["chmod"; "493"; "/test-command"];
1401        ["command_lines"; "/test-command 2"]], ["Result2"]);
1402     InitBasicFS, Always, TestOutputList (
1403       [["upload"; "test-command"; "/test-command"];
1404        ["chmod"; "493"; "/test-command"];
1405        ["command_lines"; "/test-command 3"]], ["";"Result3"]);
1406     InitBasicFS, Always, TestOutputList (
1407       [["upload"; "test-command"; "/test-command"];
1408        ["chmod"; "493"; "/test-command"];
1409        ["command_lines"; "/test-command 4"]], ["";"Result4"]);
1410     InitBasicFS, Always, TestOutputList (
1411       [["upload"; "test-command"; "/test-command"];
1412        ["chmod"; "493"; "/test-command"];
1413        ["command_lines"; "/test-command 5"]], ["";"Result5";""]);
1414     InitBasicFS, Always, TestOutputList (
1415       [["upload"; "test-command"; "/test-command"];
1416        ["chmod"; "493"; "/test-command"];
1417        ["command_lines"; "/test-command 6"]], ["";"";"Result6";""]);
1418     InitBasicFS, Always, TestOutputList (
1419       [["upload"; "test-command"; "/test-command"];
1420        ["chmod"; "493"; "/test-command"];
1421        ["command_lines"; "/test-command 7"]], []);
1422     InitBasicFS, Always, TestOutputList (
1423       [["upload"; "test-command"; "/test-command"];
1424        ["chmod"; "493"; "/test-command"];
1425        ["command_lines"; "/test-command 8"]], [""]);
1426     InitBasicFS, Always, TestOutputList (
1427       [["upload"; "test-command"; "/test-command"];
1428        ["chmod"; "493"; "/test-command"];
1429        ["command_lines"; "/test-command 9"]], ["";""]);
1430     InitBasicFS, Always, TestOutputList (
1431       [["upload"; "test-command"; "/test-command"];
1432        ["chmod"; "493"; "/test-command"];
1433        ["command_lines"; "/test-command 10"]], ["Result10-1";"Result10-2"]);
1434     InitBasicFS, Always, TestOutputList (
1435       [["upload"; "test-command"; "/test-command"];
1436        ["chmod"; "493"; "/test-command"];
1437        ["command_lines"; "/test-command 11"]], ["Result11-1";"Result11-2"])],
1438    "run a command, returning lines",
1439    "\
1440 This is the same as C<guestfs_command>, but splits the
1441 result into a list of lines.");
1442
1443   ("stat", (RStat "statbuf", [String "path"]), 52, [],
1444    [InitBasicFS, Always, TestOutputStruct (
1445       [["touch"; "/new"];
1446        ["stat"; "/new"]], [CompareWithInt ("size", 0)])],
1447    "get file information",
1448    "\
1449 Returns file information for the given C<path>.
1450
1451 This is the same as the C<stat(2)> system call.");
1452
1453   ("lstat", (RStat "statbuf", [String "path"]), 53, [],
1454    [InitBasicFS, Always, TestOutputStruct (
1455       [["touch"; "/new"];
1456        ["lstat"; "/new"]], [CompareWithInt ("size", 0)])],
1457    "get file information for a symbolic link",
1458    "\
1459 Returns file information for the given C<path>.
1460
1461 This is the same as C<guestfs_stat> except that if C<path>
1462 is a symbolic link, then the link is stat-ed, not the file it
1463 refers to.
1464
1465 This is the same as the C<lstat(2)> system call.");
1466
1467   ("statvfs", (RStatVFS "statbuf", [String "path"]), 54, [],
1468    [InitBasicFS, Always, TestOutputStruct (
1469       [["statvfs"; "/"]], [CompareWithInt ("bfree", 487702);
1470                            CompareWithInt ("blocks", 490020);
1471                            CompareWithInt ("bsize", 1024)])],
1472    "get file system statistics",
1473    "\
1474 Returns file system statistics for any mounted file system.
1475 C<path> should be a file or directory in the mounted file system
1476 (typically it is the mount point itself, but it doesn't need to be).
1477
1478 This is the same as the C<statvfs(2)> system call.");
1479
1480   ("tune2fs_l", (RHashtable "superblock", [String "device"]), 55, [],
1481    [], (* XXX test *)
1482    "get ext2/ext3/ext4 superblock details",
1483    "\
1484 This returns the contents of the ext2, ext3 or ext4 filesystem
1485 superblock on C<device>.
1486
1487 It is the same as running C<tune2fs -l device>.  See L<tune2fs(8)>
1488 manpage for more details.  The list of fields returned isn't
1489 clearly defined, and depends on both the version of C<tune2fs>
1490 that libguestfs was built against, and the filesystem itself.");
1491
1492   ("blockdev_setro", (RErr, [String "device"]), 56, [],
1493    [InitEmpty, Always, TestOutputTrue (
1494       [["blockdev_setro"; "/dev/sda"];
1495        ["blockdev_getro"; "/dev/sda"]])],
1496    "set block device to read-only",
1497    "\
1498 Sets the block device named C<device> to read-only.
1499
1500 This uses the L<blockdev(8)> command.");
1501
1502   ("blockdev_setrw", (RErr, [String "device"]), 57, [],
1503    [InitEmpty, Always, TestOutputFalse (
1504       [["blockdev_setrw"; "/dev/sda"];
1505        ["blockdev_getro"; "/dev/sda"]])],
1506    "set block device to read-write",
1507    "\
1508 Sets the block device named C<device> to read-write.
1509
1510 This uses the L<blockdev(8)> command.");
1511
1512   ("blockdev_getro", (RBool "ro", [String "device"]), 58, [],
1513    [InitEmpty, Always, TestOutputTrue (
1514       [["blockdev_setro"; "/dev/sda"];
1515        ["blockdev_getro"; "/dev/sda"]])],
1516    "is block device set to read-only",
1517    "\
1518 Returns a boolean indicating if the block device is read-only
1519 (true if read-only, false if not).
1520
1521 This uses the L<blockdev(8)> command.");
1522
1523   ("blockdev_getss", (RInt "sectorsize", [String "device"]), 59, [],
1524    [InitEmpty, Always, TestOutputInt (
1525       [["blockdev_getss"; "/dev/sda"]], 512)],
1526    "get sectorsize of block device",
1527    "\
1528 This returns the size of sectors on a block device.
1529 Usually 512, but can be larger for modern devices.
1530
1531 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
1532 for that).
1533
1534 This uses the L<blockdev(8)> command.");
1535
1536   ("blockdev_getbsz", (RInt "blocksize", [String "device"]), 60, [],
1537    [InitEmpty, Always, TestOutputInt (
1538       [["blockdev_getbsz"; "/dev/sda"]], 4096)],
1539    "get blocksize of block device",
1540    "\
1541 This returns the block size of a device.
1542
1543 (Note this is different from both I<size in blocks> and
1544 I<filesystem block size>).
1545
1546 This uses the L<blockdev(8)> command.");
1547
1548   ("blockdev_setbsz", (RErr, [String "device"; Int "blocksize"]), 61, [],
1549    [], (* XXX test *)
1550    "set blocksize of block device",
1551    "\
1552 This sets the block size of a device.
1553
1554 (Note this is different from both I<size in blocks> and
1555 I<filesystem block size>).
1556
1557 This uses the L<blockdev(8)> command.");
1558
1559   ("blockdev_getsz", (RInt64 "sizeinsectors", [String "device"]), 62, [],
1560    [InitEmpty, Always, TestOutputInt (
1561       [["blockdev_getsz"; "/dev/sda"]], 1024000)],
1562    "get total size of device in 512-byte sectors",
1563    "\
1564 This returns the size of the device in units of 512-byte sectors
1565 (even if the sectorsize isn't 512 bytes ... weird).
1566
1567 See also C<guestfs_blockdev_getss> for the real sector size of
1568 the device, and C<guestfs_blockdev_getsize64> for the more
1569 useful I<size in bytes>.
1570
1571 This uses the L<blockdev(8)> command.");
1572
1573   ("blockdev_getsize64", (RInt64 "sizeinbytes", [String "device"]), 63, [],
1574    [InitEmpty, Always, TestOutputInt (
1575       [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
1576    "get total size of device in bytes",
1577    "\
1578 This returns the size of the device in bytes.
1579
1580 See also C<guestfs_blockdev_getsz>.
1581
1582 This uses the L<blockdev(8)> command.");
1583
1584   ("blockdev_flushbufs", (RErr, [String "device"]), 64, [],
1585    [InitEmpty, Always, TestRun
1586       [["blockdev_flushbufs"; "/dev/sda"]]],
1587    "flush device buffers",
1588    "\
1589 This tells the kernel to flush internal buffers associated
1590 with C<device>.
1591
1592 This uses the L<blockdev(8)> command.");
1593
1594   ("blockdev_rereadpt", (RErr, [String "device"]), 65, [],
1595    [InitEmpty, Always, TestRun
1596       [["blockdev_rereadpt"; "/dev/sda"]]],
1597    "reread partition table",
1598    "\
1599 Reread the partition table on C<device>.
1600
1601 This uses the L<blockdev(8)> command.");
1602
1603   ("upload", (RErr, [FileIn "filename"; String "remotefilename"]), 66, [],
1604    [InitBasicFS, Always, TestOutput (
1605       (* Pick a file from cwd which isn't likely to change. *)
1606     [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1607      ["checksum"; "md5"; "/COPYING.LIB"]], "e3eda01d9815f8d24aae2dbd89b68b06")],
1608    "upload a file from the local machine",
1609    "\
1610 Upload local file C<filename> to C<remotefilename> on the
1611 filesystem.
1612
1613 C<filename> can also be a named pipe.
1614
1615 See also C<guestfs_download>.");
1616
1617   ("download", (RErr, [String "remotefilename"; FileOut "filename"]), 67, [],
1618    [InitBasicFS, Always, TestOutput (
1619       (* Pick a file from cwd which isn't likely to change. *)
1620     [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1621      ["download"; "/COPYING.LIB"; "testdownload.tmp"];
1622      ["upload"; "testdownload.tmp"; "/upload"];
1623      ["checksum"; "md5"; "/upload"]], "e3eda01d9815f8d24aae2dbd89b68b06")],
1624    "download a file to the local machine",
1625    "\
1626 Download file C<remotefilename> and save it as C<filename>
1627 on the local machine.
1628
1629 C<filename> can also be a named pipe.
1630
1631 See also C<guestfs_upload>, C<guestfs_cat>.");
1632
1633   ("checksum", (RString "checksum", [String "csumtype"; String "path"]), 68, [],
1634    [InitBasicFS, Always, TestOutput (
1635       [["write_file"; "/new"; "test\n"; "0"];
1636        ["checksum"; "crc"; "/new"]], "935282863");
1637     InitBasicFS, Always, TestLastFail (
1638       [["checksum"; "crc"; "/new"]]);
1639     InitBasicFS, Always, TestOutput (
1640       [["write_file"; "/new"; "test\n"; "0"];
1641        ["checksum"; "md5"; "/new"]], "d8e8fca2dc0f896fd7cb4cb0031ba249");
1642     InitBasicFS, Always, TestOutput (
1643       [["write_file"; "/new"; "test\n"; "0"];
1644        ["checksum"; "sha1"; "/new"]], "4e1243bd22c66e76c2ba9eddc1f91394e57f9f83");
1645     InitBasicFS, Always, TestOutput (
1646       [["write_file"; "/new"; "test\n"; "0"];
1647        ["checksum"; "sha224"; "/new"]], "52f1bf093f4b7588726035c176c0cdb4376cfea53819f1395ac9e6ec");
1648     InitBasicFS, Always, TestOutput (
1649       [["write_file"; "/new"; "test\n"; "0"];
1650        ["checksum"; "sha256"; "/new"]], "f2ca1bb6c7e907d06dafe4687e579fce76b37e4e93b7605022da52e6ccc26fd2");
1651     InitBasicFS, Always, TestOutput (
1652       [["write_file"; "/new"; "test\n"; "0"];
1653        ["checksum"; "sha384"; "/new"]], "109bb6b5b6d5547c1ce03c7a8bd7d8f80c1cb0957f50c4f7fda04692079917e4f9cad52b878f3d8234e1a170b154b72d");
1654     InitBasicFS, Always, TestOutput (
1655       [["write_file"; "/new"; "test\n"; "0"];
1656        ["checksum"; "sha512"; "/new"]], "0e3e75234abc68f4378a86b3f4b32a198ba301845b0cd6e50106e874345700cc6663a86c1ea125dc5e92be17c98f9a0f85ca9d5f595db2012f7cc3571945c123");
1657     InitBasicFS, Always, TestOutput (
1658       (* RHEL 5 thinks this is an HFS+ filesystem unless we give
1659        * the type explicitly.
1660        *)
1661       [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
1662        ["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c")],
1663    "compute MD5, SHAx or CRC checksum of file",
1664    "\
1665 This call computes the MD5, SHAx or CRC checksum of the
1666 file named C<path>.
1667
1668 The type of checksum to compute is given by the C<csumtype>
1669 parameter which must have one of the following values:
1670
1671 =over 4
1672
1673 =item C<crc>
1674
1675 Compute the cyclic redundancy check (CRC) specified by POSIX
1676 for the C<cksum> command.
1677
1678 =item C<md5>
1679
1680 Compute the MD5 hash (using the C<md5sum> program).
1681
1682 =item C<sha1>
1683
1684 Compute the SHA1 hash (using the C<sha1sum> program).
1685
1686 =item C<sha224>
1687
1688 Compute the SHA224 hash (using the C<sha224sum> program).
1689
1690 =item C<sha256>
1691
1692 Compute the SHA256 hash (using the C<sha256sum> program).
1693
1694 =item C<sha384>
1695
1696 Compute the SHA384 hash (using the C<sha384sum> program).
1697
1698 =item C<sha512>
1699
1700 Compute the SHA512 hash (using the C<sha512sum> program).
1701
1702 =back
1703
1704 The checksum is returned as a printable string.");
1705
1706   ("tar_in", (RErr, [FileIn "tarfile"; String "directory"]), 69, [],
1707    [InitBasicFS, Always, TestOutput (
1708       [["tar_in"; "../images/helloworld.tar"; "/"];
1709        ["cat"; "/hello"]], "hello\n")],
1710    "unpack tarfile to directory",
1711    "\
1712 This command uploads and unpacks local file C<tarfile> (an
1713 I<uncompressed> tar file) into C<directory>.
1714
1715 To upload a compressed tarball, use C<guestfs_tgz_in>.");
1716
1717   ("tar_out", (RErr, [String "directory"; FileOut "tarfile"]), 70, [],
1718    [],
1719    "pack directory into tarfile",
1720    "\
1721 This command packs the contents of C<directory> and downloads
1722 it to local file C<tarfile>.
1723
1724 To download a compressed tarball, use C<guestfs_tgz_out>.");
1725
1726   ("tgz_in", (RErr, [FileIn "tarball"; String "directory"]), 71, [],
1727    [InitBasicFS, Always, TestOutput (
1728       [["tgz_in"; "../images/helloworld.tar.gz"; "/"];
1729        ["cat"; "/hello"]], "hello\n")],
1730    "unpack compressed tarball to directory",
1731    "\
1732 This command uploads and unpacks local file C<tarball> (a
1733 I<gzip compressed> tar file) into C<directory>.
1734
1735 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
1736
1737   ("tgz_out", (RErr, [String "directory"; FileOut "tarball"]), 72, [],
1738    [],
1739    "pack directory into compressed tarball",
1740    "\
1741 This command packs the contents of C<directory> and downloads
1742 it to local file C<tarball>.
1743
1744 To download an uncompressed tarball, use C<guestfs_tar_out>.");
1745
1746   ("mount_ro", (RErr, [String "device"; String "mountpoint"]), 73, [],
1747    [InitBasicFS, Always, TestLastFail (
1748       [["umount"; "/"];
1749        ["mount_ro"; "/dev/sda1"; "/"];
1750        ["touch"; "/new"]]);
1751     InitBasicFS, Always, TestOutput (
1752       [["write_file"; "/new"; "data"; "0"];
1753        ["umount"; "/"];
1754        ["mount_ro"; "/dev/sda1"; "/"];
1755        ["cat"; "/new"]], "data")],
1756    "mount a guest disk, read-only",
1757    "\
1758 This is the same as the C<guestfs_mount> command, but it
1759 mounts the filesystem with the read-only (I<-o ro>) flag.");
1760
1761   ("mount_options", (RErr, [String "options"; String "device"; String "mountpoint"]), 74, [],
1762    [],
1763    "mount a guest disk with mount options",
1764    "\
1765 This is the same as the C<guestfs_mount> command, but it
1766 allows you to set the mount options as for the
1767 L<mount(8)> I<-o> flag.");
1768
1769   ("mount_vfs", (RErr, [String "options"; String "vfstype"; String "device"; String "mountpoint"]), 75, [],
1770    [],
1771    "mount a guest disk with mount options and vfstype",
1772    "\
1773 This is the same as the C<guestfs_mount> command, but it
1774 allows you to set both the mount options and the vfstype
1775 as for the L<mount(8)> I<-o> and I<-t> flags.");
1776
1777   ("debug", (RString "result", [String "subcmd"; StringList "extraargs"]), 76, [],
1778    [],
1779    "debugging and internals",
1780    "\
1781 The C<guestfs_debug> command exposes some internals of
1782 C<guestfsd> (the guestfs daemon) that runs inside the
1783 qemu subprocess.
1784
1785 There is no comprehensive help for this command.  You have
1786 to look at the file C<daemon/debug.c> in the libguestfs source
1787 to find out what you can do.");
1788
1789   ("lvremove", (RErr, [String "device"]), 77, [],
1790    [InitEmpty, Always, TestOutputList (
1791       [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1792        ["pvcreate"; "/dev/sda1"];
1793        ["vgcreate"; "VG"; "/dev/sda1"];
1794        ["lvcreate"; "LV1"; "VG"; "50"];
1795        ["lvcreate"; "LV2"; "VG"; "50"];
1796        ["lvremove"; "/dev/VG/LV1"];
1797        ["lvs"]], ["/dev/VG/LV2"]);
1798     InitEmpty, Always, TestOutputList (
1799       [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1800        ["pvcreate"; "/dev/sda1"];
1801        ["vgcreate"; "VG"; "/dev/sda1"];
1802        ["lvcreate"; "LV1"; "VG"; "50"];
1803        ["lvcreate"; "LV2"; "VG"; "50"];
1804        ["lvremove"; "/dev/VG"];
1805        ["lvs"]], []);
1806     InitEmpty, Always, TestOutputList (
1807       [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1808        ["pvcreate"; "/dev/sda1"];
1809        ["vgcreate"; "VG"; "/dev/sda1"];
1810        ["lvcreate"; "LV1"; "VG"; "50"];
1811        ["lvcreate"; "LV2"; "VG"; "50"];
1812        ["lvremove"; "/dev/VG"];
1813        ["vgs"]], ["VG"])],
1814    "remove an LVM logical volume",
1815    "\
1816 Remove an LVM logical volume C<device>, where C<device> is
1817 the path to the LV, such as C</dev/VG/LV>.
1818
1819 You can also remove all LVs in a volume group by specifying
1820 the VG name, C</dev/VG>.");
1821
1822   ("vgremove", (RErr, [String "vgname"]), 78, [],
1823    [InitEmpty, Always, TestOutputList (
1824       [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1825        ["pvcreate"; "/dev/sda1"];
1826        ["vgcreate"; "VG"; "/dev/sda1"];
1827        ["lvcreate"; "LV1"; "VG"; "50"];
1828        ["lvcreate"; "LV2"; "VG"; "50"];
1829        ["vgremove"; "VG"];
1830        ["lvs"]], []);
1831     InitEmpty, Always, TestOutputList (
1832       [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1833        ["pvcreate"; "/dev/sda1"];
1834        ["vgcreate"; "VG"; "/dev/sda1"];
1835        ["lvcreate"; "LV1"; "VG"; "50"];
1836        ["lvcreate"; "LV2"; "VG"; "50"];
1837        ["vgremove"; "VG"];
1838        ["vgs"]], [])],
1839    "remove an LVM volume group",
1840    "\
1841 Remove an LVM volume group C<vgname>, (for example C<VG>).
1842
1843 This also forcibly removes all logical volumes in the volume
1844 group (if any).");
1845
1846   ("pvremove", (RErr, [String "device"]), 79, [],
1847    [InitEmpty, Always, TestOutputListOfDevices (
1848       [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1849        ["pvcreate"; "/dev/sda1"];
1850        ["vgcreate"; "VG"; "/dev/sda1"];
1851        ["lvcreate"; "LV1"; "VG"; "50"];
1852        ["lvcreate"; "LV2"; "VG"; "50"];
1853        ["vgremove"; "VG"];
1854        ["pvremove"; "/dev/sda1"];
1855        ["lvs"]], []);
1856     InitEmpty, Always, TestOutputListOfDevices (
1857       [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1858        ["pvcreate"; "/dev/sda1"];
1859        ["vgcreate"; "VG"; "/dev/sda1"];
1860        ["lvcreate"; "LV1"; "VG"; "50"];
1861        ["lvcreate"; "LV2"; "VG"; "50"];
1862        ["vgremove"; "VG"];
1863        ["pvremove"; "/dev/sda1"];
1864        ["vgs"]], []);
1865     InitEmpty, Always, TestOutputListOfDevices (
1866       [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
1867        ["pvcreate"; "/dev/sda1"];
1868        ["vgcreate"; "VG"; "/dev/sda1"];
1869        ["lvcreate"; "LV1"; "VG"; "50"];
1870        ["lvcreate"; "LV2"; "VG"; "50"];
1871        ["vgremove"; "VG"];
1872        ["pvremove"; "/dev/sda1"];
1873        ["pvs"]], [])],
1874    "remove an LVM physical volume",
1875    "\
1876 This wipes a physical volume C<device> so that LVM will no longer
1877 recognise it.
1878
1879 The implementation uses the C<pvremove> command which refuses to
1880 wipe physical volumes that contain any volume groups, so you have
1881 to remove those first.");
1882
1883   ("set_e2label", (RErr, [String "device"; String "label"]), 80, [],
1884    [InitBasicFS, Always, TestOutput (
1885       [["set_e2label"; "/dev/sda1"; "testlabel"];
1886        ["get_e2label"; "/dev/sda1"]], "testlabel")],
1887    "set the ext2/3/4 filesystem label",
1888    "\
1889 This sets the ext2/3/4 filesystem label of the filesystem on
1890 C<device> to C<label>.  Filesystem labels are limited to
1891 16 characters.
1892
1893 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
1894 to return the existing label on a filesystem.");
1895
1896   ("get_e2label", (RString "label", [String "device"]), 81, [],
1897    [],
1898    "get the ext2/3/4 filesystem label",
1899    "\
1900 This returns the ext2/3/4 filesystem label of the filesystem on
1901 C<device>.");
1902
1903   ("set_e2uuid", (RErr, [String "device"; String "uuid"]), 82, [],
1904    [InitBasicFS, Always, TestOutput (
1905       [["set_e2uuid"; "/dev/sda1"; "a3a61220-882b-4f61-89f4-cf24dcc7297d"];
1906        ["get_e2uuid"; "/dev/sda1"]], "a3a61220-882b-4f61-89f4-cf24dcc7297d");
1907     InitBasicFS, Always, TestOutput (
1908       [["set_e2uuid"; "/dev/sda1"; "clear"];
1909        ["get_e2uuid"; "/dev/sda1"]], "");
1910     (* We can't predict what UUIDs will be, so just check the commands run. *)
1911     InitBasicFS, Always, TestRun (
1912       [["set_e2uuid"; "/dev/sda1"; "random"]]);
1913     InitBasicFS, Always, TestRun (
1914       [["set_e2uuid"; "/dev/sda1"; "time"]])],
1915    "set the ext2/3/4 filesystem UUID",
1916    "\
1917 This sets the ext2/3/4 filesystem UUID of the filesystem on
1918 C<device> to C<uuid>.  The format of the UUID and alternatives
1919 such as C<clear>, C<random> and C<time> are described in the
1920 L<tune2fs(8)> manpage.
1921
1922 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
1923 to return the existing UUID of a filesystem.");
1924
1925   ("get_e2uuid", (RString "uuid", [String "device"]), 83, [],
1926    [],
1927    "get the ext2/3/4 filesystem UUID",
1928    "\
1929 This returns the ext2/3/4 filesystem UUID of the filesystem on
1930 C<device>.");
1931
1932   ("fsck", (RInt "status", [String "fstype"; String "device"]), 84, [],
1933    [InitBasicFS, Always, TestOutputInt (
1934       [["umount"; "/dev/sda1"];
1935        ["fsck"; "ext2"; "/dev/sda1"]], 0);
1936     InitBasicFS, Always, TestOutputInt (
1937       [["umount"; "/dev/sda1"];
1938        ["zero"; "/dev/sda1"];
1939        ["fsck"; "ext2"; "/dev/sda1"]], 8)],
1940    "run the filesystem checker",
1941    "\
1942 This runs the filesystem checker (fsck) on C<device> which
1943 should have filesystem type C<fstype>.
1944
1945 The returned integer is the status.  See L<fsck(8)> for the
1946 list of status codes from C<fsck>.
1947
1948 Notes:
1949
1950 =over 4
1951
1952 =item *
1953
1954 Multiple status codes can be summed together.
1955
1956 =item *
1957
1958 A non-zero return code can mean \"success\", for example if
1959 errors have been corrected on the filesystem.
1960
1961 =item *
1962
1963 Checking or repairing NTFS volumes is not supported
1964 (by linux-ntfs).
1965
1966 =back
1967
1968 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
1969
1970   ("zero", (RErr, [String "device"]), 85, [],
1971    [InitBasicFS, Always, TestOutput (
1972       [["umount"; "/dev/sda1"];
1973        ["zero"; "/dev/sda1"];
1974        ["file"; "/dev/sda1"]], "data")],
1975    "write zeroes to the device",
1976    "\
1977 This command writes zeroes over the first few blocks of C<device>.
1978
1979 How many blocks are zeroed isn't specified (but it's I<not> enough
1980 to securely wipe the device).  It should be sufficient to remove
1981 any partition tables, filesystem superblocks and so on.");
1982
1983   ("grub_install", (RErr, [String "root"; String "device"]), 86, [],
1984    [InitBasicFS, Always, TestOutputTrue (
1985       [["grub_install"; "/"; "/dev/sda1"];
1986        ["is_dir"; "/boot"]])],
1987    "install GRUB",
1988    "\
1989 This command installs GRUB (the Grand Unified Bootloader) on
1990 C<device>, with the root directory being C<root>.");
1991
1992   ("cp", (RErr, [String "src"; String "dest"]), 87, [],
1993    [InitBasicFS, Always, TestOutput (
1994       [["write_file"; "/old"; "file content"; "0"];
1995        ["cp"; "/old"; "/new"];
1996        ["cat"; "/new"]], "file content");
1997     InitBasicFS, Always, TestOutputTrue (
1998       [["write_file"; "/old"; "file content"; "0"];
1999        ["cp"; "/old"; "/new"];
2000        ["is_file"; "/old"]]);
2001     InitBasicFS, Always, TestOutput (
2002       [["write_file"; "/old"; "file content"; "0"];
2003        ["mkdir"; "/dir"];
2004        ["cp"; "/old"; "/dir/new"];
2005        ["cat"; "/dir/new"]], "file content")],
2006    "copy a file",
2007    "\
2008 This copies a file from C<src> to C<dest> where C<dest> is
2009 either a destination filename or destination directory.");
2010
2011   ("cp_a", (RErr, [String "src"; String "dest"]), 88, [],
2012    [InitBasicFS, Always, TestOutput (
2013       [["mkdir"; "/olddir"];
2014        ["mkdir"; "/newdir"];
2015        ["write_file"; "/olddir/file"; "file content"; "0"];
2016        ["cp_a"; "/olddir"; "/newdir"];
2017        ["cat"; "/newdir/olddir/file"]], "file content")],
2018    "copy a file or directory recursively",
2019    "\
2020 This copies a file or directory from C<src> to C<dest>
2021 recursively using the C<cp -a> command.");
2022
2023   ("mv", (RErr, [String "src"; String "dest"]), 89, [],
2024    [InitBasicFS, Always, TestOutput (
2025       [["write_file"; "/old"; "file content"; "0"];
2026        ["mv"; "/old"; "/new"];
2027        ["cat"; "/new"]], "file content");
2028     InitBasicFS, Always, TestOutputFalse (
2029       [["write_file"; "/old"; "file content"; "0"];
2030        ["mv"; "/old"; "/new"];
2031        ["is_file"; "/old"]])],
2032    "move a file",
2033    "\
2034 This moves a file from C<src> to C<dest> where C<dest> is
2035 either a destination filename or destination directory.");
2036
2037   ("drop_caches", (RErr, [Int "whattodrop"]), 90, [],
2038    [InitEmpty, Always, TestRun (
2039       [["drop_caches"; "3"]])],
2040    "drop kernel page cache, dentries and inodes",
2041    "\
2042 This instructs the guest kernel to drop its page cache,
2043 and/or dentries and inode caches.  The parameter C<whattodrop>
2044 tells the kernel what precisely to drop, see
2045 L<http://linux-mm.org/Drop_Caches>
2046
2047 Setting C<whattodrop> to 3 should drop everything.
2048
2049 This automatically calls L<sync(2)> before the operation,
2050 so that the maximum guest memory is freed.");
2051
2052   ("dmesg", (RString "kmsgs", []), 91, [],
2053    [InitEmpty, Always, TestRun (
2054       [["dmesg"]])],
2055    "return kernel messages",
2056    "\
2057 This returns the kernel messages (C<dmesg> output) from
2058 the guest kernel.  This is sometimes useful for extended
2059 debugging of problems.
2060
2061 Another way to get the same information is to enable
2062 verbose messages with C<guestfs_set_verbose> or by setting
2063 the environment variable C<LIBGUESTFS_DEBUG=1> before
2064 running the program.");
2065
2066   ("ping_daemon", (RErr, []), 92, [],
2067    [InitEmpty, Always, TestRun (
2068       [["ping_daemon"]])],
2069    "ping the guest daemon",
2070    "\
2071 This is a test probe into the guestfs daemon running inside
2072 the qemu subprocess.  Calling this function checks that the
2073 daemon responds to the ping message, without affecting the daemon
2074 or attached block device(s) in any other way.");
2075
2076   ("equal", (RBool "equality", [String "file1"; String "file2"]), 93, [],
2077    [InitBasicFS, Always, TestOutputTrue (
2078       [["write_file"; "/file1"; "contents of a file"; "0"];
2079        ["cp"; "/file1"; "/file2"];
2080        ["equal"; "/file1"; "/file2"]]);
2081     InitBasicFS, Always, TestOutputFalse (
2082       [["write_file"; "/file1"; "contents of a file"; "0"];
2083        ["write_file"; "/file2"; "contents of another file"; "0"];
2084        ["equal"; "/file1"; "/file2"]]);
2085     InitBasicFS, Always, TestLastFail (
2086       [["equal"; "/file1"; "/file2"]])],
2087    "test if two files have equal contents",
2088    "\
2089 This compares the two files C<file1> and C<file2> and returns
2090 true if their content is exactly equal, or false otherwise.
2091
2092 The external L<cmp(1)> program is used for the comparison.");
2093
2094   ("strings", (RStringList "stringsout", [String "path"]), 94, [ProtocolLimitWarning],
2095    [InitBasicFS, Always, TestOutputList (
2096       [["write_file"; "/new"; "hello\nworld\n"; "0"];
2097        ["strings"; "/new"]], ["hello"; "world"]);
2098     InitBasicFS, Always, TestOutputList (
2099       [["touch"; "/new"];
2100        ["strings"; "/new"]], [])],
2101    "print the printable strings in a file",
2102    "\
2103 This runs the L<strings(1)> command on a file and returns
2104 the list of printable strings found.");
2105
2106   ("strings_e", (RStringList "stringsout", [String "encoding"; String "path"]), 95, [ProtocolLimitWarning],
2107    [InitBasicFS, Always, TestOutputList (
2108       [["write_file"; "/new"; "hello\nworld\n"; "0"];
2109        ["strings_e"; "b"; "/new"]], []);
2110     InitBasicFS, Disabled, TestOutputList (
2111       [["write_file"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"; "24"];
2112        ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
2113    "print the printable strings in a file",
2114    "\
2115 This is like the C<guestfs_strings> command, but allows you to
2116 specify the encoding.
2117
2118 See the L<strings(1)> manpage for the full list of encodings.
2119
2120 Commonly useful encodings are C<l> (lower case L) which will
2121 show strings inside Windows/x86 files.
2122
2123 The returned strings are transcoded to UTF-8.");
2124
2125   ("hexdump", (RString "dump", [String "path"]), 96, [ProtocolLimitWarning],
2126    [InitBasicFS, Always, TestOutput (
2127       [["write_file"; "/new"; "hello\nworld\n"; "12"];
2128        ["hexdump"; "/new"]], "00000000  68 65 6c 6c 6f 0a 77 6f  72 6c 64 0a              |hello.world.|\n0000000c\n")],
2129    "dump a file in hexadecimal",
2130    "\
2131 This runs C<hexdump -C> on the given C<path>.  The result is
2132 the human-readable, canonical hex dump of the file.");
2133
2134   ("zerofree", (RErr, [String "device"]), 97, [],
2135    [InitNone, Always, TestOutput (
2136       [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
2137        ["mkfs"; "ext3"; "/dev/sda1"];
2138        ["mount"; "/dev/sda1"; "/"];
2139        ["write_file"; "/new"; "test file"; "0"];
2140        ["umount"; "/dev/sda1"];
2141        ["zerofree"; "/dev/sda1"];
2142        ["mount"; "/dev/sda1"; "/"];
2143        ["cat"; "/new"]], "test file")],
2144    "zero unused inodes and disk blocks on ext2/3 filesystem",
2145    "\
2146 This runs the I<zerofree> program on C<device>.  This program
2147 claims to zero unused inodes and disk blocks on an ext2/3
2148 filesystem, thus making it possible to compress the filesystem
2149 more effectively.
2150
2151 You should B<not> run this program if the filesystem is
2152 mounted.
2153
2154 It is possible that using this program can damage the filesystem
2155 or data on the filesystem.");
2156
2157   ("pvresize", (RErr, [String "device"]), 98, [],
2158    [],
2159    "resize an LVM physical volume",
2160    "\
2161 This resizes (expands or shrinks) an existing LVM physical
2162 volume to match the new size of the underlying device.");
2163
2164   ("sfdisk_N", (RErr, [String "device"; Int "n";
2165                        Int "cyls"; Int "heads"; Int "sectors";
2166                        String "line"]), 99, [DangerWillRobinson],
2167    [],
2168    "modify a single partition on a block device",
2169    "\
2170 This runs L<sfdisk(8)> option to modify just the single
2171 partition C<n> (note: C<n> counts from 1).
2172
2173 For other parameters, see C<guestfs_sfdisk>.  You should usually
2174 pass C<0> for the cyls/heads/sectors parameters.");
2175
2176   ("sfdisk_l", (RString "partitions", [String "device"]), 100, [],
2177    [],
2178    "display the partition table",
2179    "\
2180 This displays the partition table on C<device>, in the
2181 human-readable output of the L<sfdisk(8)> command.  It is
2182 not intended to be parsed.");
2183
2184   ("sfdisk_kernel_geometry", (RString "partitions", [String "device"]), 101, [],
2185    [],
2186    "display the kernel geometry",
2187    "\
2188 This displays the kernel's idea of the geometry of C<device>.
2189
2190 The result is in human-readable format, and not designed to
2191 be parsed.");
2192
2193   ("sfdisk_disk_geometry", (RString "partitions", [String "device"]), 102, [],
2194    [],
2195    "display the disk geometry from the partition table",
2196    "\
2197 This displays the disk geometry of C<device> read from the
2198 partition table.  Especially in the case where the underlying
2199 block device has been resized, this can be different from the
2200 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
2201
2202 The result is in human-readable format, and not designed to
2203 be parsed.");
2204
2205   ("vg_activate_all", (RErr, [Bool "activate"]), 103, [],
2206    [],
2207    "activate or deactivate all volume groups",
2208    "\
2209 This command activates or (if C<activate> is false) deactivates
2210 all logical volumes in all volume groups.
2211 If activated, then they are made known to the
2212 kernel, ie. they appear as C</dev/mapper> devices.  If deactivated,
2213 then those devices disappear.
2214
2215 This command is the same as running C<vgchange -a y|n>");
2216
2217   ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"]), 104, [],
2218    [],
2219    "activate or deactivate some volume groups",
2220    "\
2221 This command activates or (if C<activate> is false) deactivates
2222 all logical volumes in the listed volume groups C<volgroups>.
2223 If activated, then they are made known to the
2224 kernel, ie. they appear as C</dev/mapper> devices.  If deactivated,
2225 then those devices disappear.
2226
2227 This command is the same as running C<vgchange -a y|n volgroups...>
2228
2229 Note that if C<volgroups> is an empty list then B<all> volume groups
2230 are activated or deactivated.");
2231
2232   ("lvresize", (RErr, [String "device"; Int "mbytes"]), 105, [],
2233    [InitNone, Always, TestOutput (
2234     [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
2235      ["pvcreate"; "/dev/sda1"];
2236      ["vgcreate"; "VG"; "/dev/sda1"];
2237      ["lvcreate"; "LV"; "VG"; "10"];
2238      ["mkfs"; "ext2"; "/dev/VG/LV"];
2239      ["mount"; "/dev/VG/LV"; "/"];
2240      ["write_file"; "/new"; "test content"; "0"];
2241      ["umount"; "/"];
2242      ["lvresize"; "/dev/VG/LV"; "20"];
2243      ["e2fsck_f"; "/dev/VG/LV"];
2244      ["resize2fs"; "/dev/VG/LV"];
2245      ["mount"; "/dev/VG/LV"; "/"];
2246      ["cat"; "/new"]], "test content")],
2247    "resize an LVM logical volume",
2248    "\
2249 This resizes (expands or shrinks) an existing LVM logical
2250 volume to C<mbytes>.  When reducing, data in the reduced part
2251 is lost.");
2252
2253   ("resize2fs", (RErr, [String "device"]), 106, [],
2254    [], (* lvresize tests this *)
2255    "resize an ext2/ext3 filesystem",
2256    "\
2257 This resizes an ext2 or ext3 filesystem to match the size of
2258 the underlying device.
2259
2260 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
2261 on the C<device> before calling this command.  For unknown reasons
2262 C<resize2fs> sometimes gives an error about this and sometimes not.
2263 In any case, it is always safe to call C<guestfs_e2fsck_f> before
2264 calling this function.");
2265
2266   ("find", (RStringList "names", [String "directory"]), 107, [],
2267    [InitBasicFS, Always, TestOutputList (
2268       [["find"; "/"]], ["lost+found"]);
2269     InitBasicFS, Always, TestOutputList (
2270       [["touch"; "/a"];
2271        ["mkdir"; "/b"];
2272        ["touch"; "/b/c"];
2273        ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
2274     InitBasicFS, Always, TestOutputList (
2275       [["mkdir_p"; "/a/b/c"];
2276        ["touch"; "/a/b/c/d"];
2277        ["find"; "/a/b/"]], ["c"; "c/d"])],
2278    "find all files and directories",
2279    "\
2280 This command lists out all files and directories, recursively,
2281 starting at C<directory>.  It is essentially equivalent to
2282 running the shell command C<find directory -print> but some
2283 post-processing happens on the output, described below.
2284
2285 This returns a list of strings I<without any prefix>.  Thus
2286 if the directory structure was:
2287
2288  /tmp/a
2289  /tmp/b
2290  /tmp/c/d
2291
2292 then the returned list from C<guestfs_find> C</tmp> would be
2293 4 elements:
2294
2295  a
2296  b
2297  c
2298  c/d
2299
2300 If C<directory> is not a directory, then this command returns
2301 an error.
2302
2303 The returned list is sorted.");
2304
2305   ("e2fsck_f", (RErr, [String "device"]), 108, [],
2306    [], (* lvresize tests this *)
2307    "check an ext2/ext3 filesystem",
2308    "\
2309 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
2310 filesystem checker on C<device>, noninteractively (C<-p>),
2311 even if the filesystem appears to be clean (C<-f>).
2312
2313 This command is only needed because of C<guestfs_resize2fs>
2314 (q.v.).  Normally you should use C<guestfs_fsck>.");
2315
2316   ("sleep", (RErr, [Int "secs"]), 109, [],
2317    [InitNone, Always, TestRun (
2318     [["sleep"; "1"]])],
2319    "sleep for some seconds",
2320    "\
2321 Sleep for C<secs> seconds.");
2322
2323   ("ntfs_3g_probe", (RInt "status", [Bool "rw"; String "device"]), 110, [],
2324    [InitNone, Always, TestOutputInt (
2325       [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
2326        ["mkfs"; "ntfs"; "/dev/sda1"];
2327        ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
2328     InitNone, Always, TestOutputInt (
2329       [["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
2330        ["mkfs"; "ext2"; "/dev/sda1"];
2331        ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
2332    "probe NTFS volume",
2333    "\
2334 This command runs the L<ntfs-3g.probe(8)> command which probes
2335 an NTFS C<device> for mountability.  (Not all NTFS volumes can
2336 be mounted read-write, and some cannot be mounted at all).
2337
2338 C<rw> is a boolean flag.  Set it to true if you want to test
2339 if the volume can be mounted read-write.  Set it to false if
2340 you want to test if the volume can be mounted read-only.
2341
2342 The return value is an integer which C<0> if the operation
2343 would succeed, or some non-zero value documented in the
2344 L<ntfs-3g.probe(8)> manual page.");
2345
2346 ]
2347
2348 let all_functions = non_daemon_functions @ daemon_functions
2349
2350 (* In some places we want the functions to be displayed sorted
2351  * alphabetically, so this is useful:
2352  *)
2353 let all_functions_sorted =
2354   List.sort (fun (n1,_,_,_,_,_,_) (n2,_,_,_,_,_,_) ->
2355                compare n1 n2) all_functions
2356
2357 (* Column names and types from LVM PVs/VGs/LVs. *)
2358 let pv_cols = [
2359   "pv_name", `String;
2360   "pv_uuid", `UUID;
2361   "pv_fmt", `String;
2362   "pv_size", `Bytes;
2363   "dev_size", `Bytes;
2364   "pv_free", `Bytes;
2365   "pv_used", `Bytes;
2366   "pv_attr", `String (* XXX *);
2367   "pv_pe_count", `Int;
2368   "pv_pe_alloc_count", `Int;
2369   "pv_tags", `String;
2370   "pe_start", `Bytes;
2371   "pv_mda_count", `Int;
2372   "pv_mda_free", `Bytes;
2373 (* Not in Fedora 10:
2374   "pv_mda_size", `Bytes;
2375 *)
2376 ]
2377 let vg_cols = [
2378   "vg_name", `String;
2379   "vg_uuid", `UUID;
2380   "vg_fmt", `String;
2381   "vg_attr", `String (* XXX *);
2382   "vg_size", `Bytes;
2383   "vg_free", `Bytes;
2384   "vg_sysid", `String;
2385   "vg_extent_size", `Bytes;
2386   "vg_extent_count", `Int;
2387   "vg_free_count", `Int;
2388   "max_lv", `Int;
2389   "max_pv", `Int;
2390   "pv_count", `Int;
2391   "lv_count", `Int;
2392   "snap_count", `Int;
2393   "vg_seqno", `Int;
2394   "vg_tags", `String;
2395   "vg_mda_count", `Int;
2396   "vg_mda_free", `Bytes;
2397 (* Not in Fedora 10:
2398   "vg_mda_size", `Bytes;
2399 *)
2400 ]
2401 let lv_cols = [
2402   "lv_name", `String;
2403   "lv_uuid", `UUID;
2404   "lv_attr", `String (* XXX *);
2405   "lv_major", `Int;
2406   "lv_minor", `Int;
2407   "lv_kernel_major", `Int;
2408   "lv_kernel_minor", `Int;
2409   "lv_size", `Bytes;
2410   "seg_count", `Int;
2411   "origin", `String;
2412   "snap_percent", `OptPercent;
2413   "copy_percent", `OptPercent;
2414   "move_pv", `String;
2415   "lv_tags", `String;
2416   "mirror_log", `String;
2417   "modules", `String;
2418 ]
2419
2420 (* Column names and types from stat structures.
2421  * NB. Can't use things like 'st_atime' because glibc header files
2422  * define some of these as macros.  Ugh.
2423  *)
2424 let stat_cols = [
2425   "dev", `Int;
2426   "ino", `Int;
2427   "mode", `Int;
2428   "nlink", `Int;
2429   "uid", `Int;
2430   "gid", `Int;
2431   "rdev", `Int;
2432   "size", `Int;
2433   "blksize", `Int;
2434   "blocks", `Int;
2435   "atime", `Int;
2436   "mtime", `Int;
2437   "ctime", `Int;
2438 ]
2439 let statvfs_cols = [
2440   "bsize", `Int;
2441   "frsize", `Int;
2442   "blocks", `Int;
2443   "bfree", `Int;
2444   "bavail", `Int;
2445   "files", `Int;
2446   "ffree", `Int;
2447   "favail", `Int;
2448   "fsid", `Int;
2449   "flag", `Int;
2450   "namemax", `Int;
2451 ]
2452
2453 (* Used for testing language bindings. *)
2454 type callt =
2455   | CallString of string
2456   | CallOptString of string option
2457   | CallStringList of string list
2458   | CallInt of int
2459   | CallBool of bool
2460
2461 (* Useful functions.
2462  * Note we don't want to use any external OCaml libraries which
2463  * makes this a bit harder than it should be.
2464  *)
2465 let failwithf fs = ksprintf failwith fs
2466
2467 let replace_char s c1 c2 =
2468   let s2 = String.copy s in
2469   let r = ref false in
2470   for i = 0 to String.length s2 - 1 do
2471     if String.unsafe_get s2 i = c1 then (
2472       String.unsafe_set s2 i c2;
2473       r := true
2474     )
2475   done;
2476   if not !r then s else s2
2477
2478 let isspace c =
2479   c = ' '
2480   (* || c = '\f' *) || c = '\n' || c = '\r' || c = '\t' (* || c = '\v' *)
2481
2482 let triml ?(test = isspace) str =
2483   let i = ref 0 in
2484   let n = ref (String.length str) in
2485   while !n > 0 && test str.[!i]; do
2486     decr n;
2487     incr i
2488   done;
2489   if !i = 0 then str
2490   else String.sub str !i !n
2491
2492 let trimr ?(test = isspace) str =
2493   let n = ref (String.length str) in
2494   while !n > 0 && test str.[!n-1]; do
2495     decr n
2496   done;
2497   if !n = String.length str then str
2498   else String.sub str 0 !n
2499
2500 let trim ?(test = isspace) str =
2501   trimr ~test (triml ~test str)
2502
2503 let rec find s sub =
2504   let len = String.length s in
2505   let sublen = String.length sub in
2506   let rec loop i =
2507     if i <= len-sublen then (
2508       let rec loop2 j =
2509         if j < sublen then (
2510           if s.[i+j] = sub.[j] then loop2 (j+1)
2511           else -1
2512         ) else
2513           i (* found *)
2514       in
2515       let r = loop2 0 in
2516       if r = -1 then loop (i+1) else r
2517     ) else
2518       -1 (* not found *)
2519   in
2520   loop 0
2521
2522 let rec replace_str s s1 s2 =
2523   let len = String.length s in
2524   let sublen = String.length s1 in
2525   let i = find s s1 in
2526   if i = -1 then s
2527   else (
2528     let s' = String.sub s 0 i in
2529     let s'' = String.sub s (i+sublen) (len-i-sublen) in
2530     s' ^ s2 ^ replace_str s'' s1 s2
2531   )
2532
2533 let rec string_split sep str =
2534   let len = String.length str in
2535   let seplen = String.length sep in
2536   let i = find str sep in
2537   if i = -1 then [str]
2538   else (
2539     let s' = String.sub str 0 i in
2540     let s'' = String.sub str (i+seplen) (len-i-seplen) in
2541     s' :: string_split sep s''
2542   )
2543
2544 let files_equal n1 n2 =
2545   let cmd = sprintf "cmp -s %s %s" (Filename.quote n1) (Filename.quote n2) in
2546   match Sys.command cmd with
2547   | 0 -> true
2548   | 1 -> false
2549   | i -> failwithf "%s: failed with error code %d" cmd i
2550
2551 let rec find_map f = function
2552   | [] -> raise Not_found
2553   | x :: xs ->
2554       match f x with
2555       | Some y -> y
2556       | None -> find_map f xs
2557
2558 let iteri f xs =
2559   let rec loop i = function
2560     | [] -> ()
2561     | x :: xs -> f i x; loop (i+1) xs
2562   in
2563   loop 0 xs
2564
2565 let mapi f xs =
2566   let rec loop i = function
2567     | [] -> []
2568     | x :: xs -> let r = f i x in r :: loop (i+1) xs
2569   in
2570   loop 0 xs
2571
2572 let name_of_argt = function
2573   | String n | OptString n | StringList n | Bool n | Int n
2574   | FileIn n | FileOut n -> n
2575
2576 let seq_of_test = function
2577   | TestRun s | TestOutput (s, _) | TestOutputList (s, _)
2578   | TestOutputListOfDevices (s, _)
2579   | TestOutputInt (s, _) | TestOutputTrue s | TestOutputFalse s
2580   | TestOutputLength (s, _) | TestOutputStruct (s, _)
2581   | TestLastFail s -> s
2582
2583 (* Check function names etc. for consistency. *)
2584 let check_functions () =
2585   let contains_uppercase str =
2586     let len = String.length str in
2587     let rec loop i =
2588       if i >= len then false
2589       else (
2590         let c = str.[i] in
2591         if c >= 'A' && c <= 'Z' then true
2592         else loop (i+1)
2593       )
2594     in
2595     loop 0
2596   in
2597
2598   (* Check function names. *)
2599   List.iter (
2600     fun (name, _, _, _, _, _, _) ->
2601       if String.length name >= 7 && String.sub name 0 7 = "guestfs" then
2602         failwithf "function name %s does not need 'guestfs' prefix" name;
2603       if name = "" then
2604         failwithf "function name is empty";
2605       if name.[0] < 'a' || name.[0] > 'z' then
2606         failwithf "function name %s must start with lowercase a-z" name;
2607       if String.contains name '-' then
2608         failwithf "function name %s should not contain '-', use '_' instead."
2609           name
2610   ) all_functions;
2611
2612   (* Check function parameter/return names. *)
2613   List.iter (
2614     fun (name, style, _, _, _, _, _) ->
2615       let check_arg_ret_name n =
2616         if contains_uppercase n then
2617           failwithf "%s param/ret %s should not contain uppercase chars"
2618             name n;
2619         if String.contains n '-' || String.contains n '_' then
2620           failwithf "%s param/ret %s should not contain '-' or '_'"
2621             name n;
2622         if n = "value" then
2623           failwithf "%s has a param/ret called 'value', which causes conflicts in the OCaml bindings, use something like 'val' or a more descriptive name" name;
2624         if n = "int" || n = "char" || n = "short" || n = "long" then
2625           failwithf "%s has a param/ret which conflicts with a C type (eg. 'int', 'char' etc.)" name;
2626         if n = "i" then
2627           failwithf "%s has a param/ret called 'i', which will cause some conflicts in the generated code" name;
2628         if n = "argv" || n = "args" then
2629           failwithf "%s has a param/ret called 'argv' or 'args', which will cause some conflicts in the generated code" name
2630       in
2631
2632       (match fst style with
2633        | RErr -> ()
2634        | RInt n | RInt64 n | RBool n | RConstString n | RString n
2635        | RStringList n | RPVList n | RVGList n | RLVList n
2636        | RStat n | RStatVFS n
2637        | RHashtable n ->
2638            check_arg_ret_name n
2639        | RIntBool (n,m) ->
2640            check_arg_ret_name n;
2641            check_arg_ret_name m
2642       );
2643       List.iter (fun arg -> check_arg_ret_name (name_of_argt arg)) (snd style)
2644   ) all_functions;
2645
2646   (* Check short descriptions. *)
2647   List.iter (
2648     fun (name, _, _, _, _, shortdesc, _) ->
2649       if shortdesc.[0] <> Char.lowercase shortdesc.[0] then
2650         failwithf "short description of %s should begin with lowercase." name;
2651       let c = shortdesc.[String.length shortdesc-1] in
2652       if c = '\n' || c = '.' then
2653         failwithf "short description of %s should not end with . or \\n." name
2654   ) all_functions;
2655
2656   (* Check long dscriptions. *)
2657   List.iter (
2658     fun (name, _, _, _, _, _, longdesc) ->
2659       if longdesc.[String.length longdesc-1] = '\n' then
2660         failwithf "long description of %s should not end with \\n." name
2661   ) all_functions;
2662
2663   (* Check proc_nrs. *)
2664   List.iter (
2665     fun (name, _, proc_nr, _, _, _, _) ->
2666       if proc_nr <= 0 then
2667         failwithf "daemon function %s should have proc_nr > 0" name
2668   ) daemon_functions;
2669
2670   List.iter (
2671     fun (name, _, proc_nr, _, _, _, _) ->
2672       if proc_nr <> -1 then
2673         failwithf "non-daemon function %s should have proc_nr -1" name
2674   ) non_daemon_functions;
2675
2676   let proc_nrs =
2677     List.map (fun (name, _, proc_nr, _, _, _, _) -> name, proc_nr)
2678       daemon_functions in
2679   let proc_nrs =
2680     List.sort (fun (_,nr1) (_,nr2) -> compare nr1 nr2) proc_nrs in
2681   let rec loop = function
2682     | [] -> ()
2683     | [_] -> ()
2684     | (name1,nr1) :: ((name2,nr2) :: _ as rest) when nr1 < nr2 ->
2685         loop rest
2686     | (name1,nr1) :: (name2,nr2) :: _ ->
2687         failwithf "%s and %s have conflicting procedure numbers (%d, %d)"
2688           name1 name2 nr1 nr2
2689   in
2690   loop proc_nrs;
2691
2692   (* Check tests. *)
2693   List.iter (
2694     function
2695       (* Ignore functions that have no tests.  We generate a
2696        * warning when the user does 'make check' instead.
2697        *)
2698     | name, _, _, _, [], _, _ -> ()
2699     | name, _, _, _, tests, _, _ ->
2700         let funcs =
2701           List.map (
2702             fun (_, _, test) ->
2703               match seq_of_test test with
2704               | [] ->
2705                   failwithf "%s has a test containing an empty sequence" name
2706               | cmds -> List.map List.hd cmds
2707           ) tests in
2708         let funcs = List.flatten funcs in
2709
2710         let tested = List.mem name funcs in
2711
2712         if not tested then
2713           failwithf "function %s has tests but does not test itself" name
2714   ) all_functions
2715
2716 (* 'pr' prints to the current output file. *)
2717 let chan = ref stdout
2718 let pr fs = ksprintf (output_string !chan) fs
2719
2720 (* Generate a header block in a number of standard styles. *)
2721 type comment_style = CStyle | HashStyle | OCamlStyle | HaskellStyle
2722 type license = GPLv2 | LGPLv2
2723
2724 let generate_header comment license =
2725   let c = match comment with
2726     | CStyle ->     pr "/* "; " *"
2727     | HashStyle ->  pr "# ";  "#"
2728     | OCamlStyle -> pr "(* "; " *"
2729     | HaskellStyle -> pr "{- "; "  " in
2730   pr "libguestfs generated file\n";
2731   pr "%s WARNING: THIS FILE IS GENERATED BY 'src/generator.ml'.\n" c;
2732   pr "%s ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.\n" c;
2733   pr "%s\n" c;
2734   pr "%s Copyright (C) 2009 Red Hat Inc.\n" c;
2735   pr "%s\n" c;
2736   (match license with
2737    | GPLv2 ->
2738        pr "%s This program is free software; you can redistribute it and/or modify\n" c;
2739        pr "%s it under the terms of the GNU General Public License as published by\n" c;
2740        pr "%s the Free Software Foundation; either version 2 of the License, or\n" c;
2741        pr "%s (at your option) any later version.\n" c;
2742        pr "%s\n" c;
2743        pr "%s This program is distributed in the hope that it will be useful,\n" c;
2744        pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
2745        pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n" c;
2746        pr "%s GNU General Public License for more details.\n" c;
2747        pr "%s\n" c;
2748        pr "%s You should have received a copy of the GNU General Public License along\n" c;
2749        pr "%s with this program; if not, write to the Free Software Foundation, Inc.,\n" c;
2750        pr "%s 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n" c;
2751
2752    | LGPLv2 ->
2753        pr "%s This library is free software; you can redistribute it and/or\n" c;
2754        pr "%s modify it under the terms of the GNU Lesser General Public\n" c;
2755        pr "%s License as published by the Free Software Foundation; either\n" c;
2756        pr "%s version 2 of the License, or (at your option) any later version.\n" c;
2757        pr "%s\n" c;
2758        pr "%s This library is distributed in the hope that it will be useful,\n" c;
2759        pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
2760        pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU\n" c;
2761        pr "%s Lesser General Public License for more details.\n" c;
2762        pr "%s\n" c;
2763        pr "%s You should have received a copy of the GNU Lesser General Public\n" c;
2764        pr "%s License along with this library; if not, write to the Free Software\n" c;
2765        pr "%s Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n" c;
2766   );
2767   (match comment with
2768    | CStyle -> pr " */\n"
2769    | HashStyle -> ()
2770    | OCamlStyle -> pr " *)\n"
2771    | HaskellStyle -> pr "-}\n"
2772   );
2773   pr "\n"
2774
2775 (* Start of main code generation functions below this line. *)
2776
2777 (* Generate the pod documentation for the C API. *)
2778 let rec generate_actions_pod () =
2779   List.iter (
2780     fun (shortname, style, _, flags, _, _, longdesc) ->
2781       if not (List.mem NotInDocs flags) then (
2782         let name = "guestfs_" ^ shortname in
2783         pr "=head2 %s\n\n" name;
2784         pr " ";
2785         generate_prototype ~extern:false ~handle:"handle" name style;
2786         pr "\n\n";
2787         pr "%s\n\n" longdesc;
2788         (match fst style with
2789          | RErr ->
2790              pr "This function returns 0 on success or -1 on error.\n\n"
2791          | RInt _ ->
2792              pr "On error this function returns -1.\n\n"
2793          | RInt64 _ ->
2794              pr "On error this function returns -1.\n\n"
2795          | RBool _ ->
2796              pr "This function returns a C truth value on success or -1 on error.\n\n"
2797          | RConstString _ ->
2798              pr "This function returns a string, or NULL on error.
2799 The string is owned by the guest handle and must I<not> be freed.\n\n"
2800          | RString _ ->
2801              pr "This function returns a string, or NULL on error.
2802 I<The caller must free the returned string after use>.\n\n"
2803          | RStringList _ ->
2804              pr "This function returns a NULL-terminated array of strings
2805 (like L<environ(3)>), or NULL if there was an error.
2806 I<The caller must free the strings and the array after use>.\n\n"
2807          | RIntBool _ ->
2808              pr "This function returns a C<struct guestfs_int_bool *>,
2809 or NULL if there was an error.
2810 I<The caller must call C<guestfs_free_int_bool> after use>.\n\n"
2811          | RPVList _ ->
2812              pr "This function returns a C<struct guestfs_lvm_pv_list *>
2813 (see E<lt>guestfs-structs.hE<gt>),
2814 or NULL if there was an error.
2815 I<The caller must call C<guestfs_free_lvm_pv_list> after use>.\n\n"
2816          | RVGList _ ->
2817              pr "This function returns a C<struct guestfs_lvm_vg_list *>
2818 (see E<lt>guestfs-structs.hE<gt>),
2819 or NULL if there was an error.
2820 I<The caller must call C<guestfs_free_lvm_vg_list> after use>.\n\n"
2821          | RLVList _ ->
2822              pr "This function returns a C<struct guestfs_lvm_lv_list *>
2823 (see E<lt>guestfs-structs.hE<gt>),
2824 or NULL if there was an error.
2825 I<The caller must call C<guestfs_free_lvm_lv_list> after use>.\n\n"
2826          | RStat _ ->
2827              pr "This function returns a C<struct guestfs_stat *>
2828 (see L<stat(2)> and E<lt>guestfs-structs.hE<gt>),
2829 or NULL if there was an error.
2830 I<The caller must call C<free> after use>.\n\n"
2831          | RStatVFS _ ->
2832              pr "This function returns a C<struct guestfs_statvfs *>
2833 (see L<statvfs(2)> and E<lt>guestfs-structs.hE<gt>),
2834 or NULL if there was an error.
2835 I<The caller must call C<free> after use>.\n\n"
2836          | RHashtable _ ->
2837              pr "This function returns a NULL-terminated array of
2838 strings, or NULL if there was an error.
2839 The array of strings will always have length C<2n+1>, where
2840 C<n> keys and values alternate, followed by the trailing NULL entry.
2841 I<The caller must free the strings and the array after use>.\n\n"
2842         );
2843         if List.mem ProtocolLimitWarning flags then
2844           pr "%s\n\n" protocol_limit_warning;
2845         if List.mem DangerWillRobinson flags then
2846           pr "%s\n\n" danger_will_robinson
2847       )
2848   ) all_functions_sorted
2849
2850 and generate_structs_pod () =
2851   (* LVM structs documentation. *)
2852   List.iter (
2853     fun (typ, cols) ->
2854       pr "=head2 guestfs_lvm_%s\n" typ;
2855       pr "\n";
2856       pr " struct guestfs_lvm_%s {\n" typ;
2857       List.iter (
2858         function
2859         | name, `String -> pr "  char *%s;\n" name
2860         | name, `UUID ->
2861             pr "  /* The next field is NOT nul-terminated, be careful when printing it: */\n";
2862             pr "  char %s[32];\n" name
2863         | name, `Bytes -> pr "  uint64_t %s;\n" name
2864         | name, `Int -> pr "  int64_t %s;\n" name
2865         | name, `OptPercent ->
2866             pr "  /* The next field is [0..100] or -1 meaning 'not present': */\n";
2867             pr "  float %s;\n" name
2868       ) cols;
2869       pr " \n";
2870       pr " struct guestfs_lvm_%s_list {\n" typ;
2871       pr "   uint32_t len; /* Number of elements in list. */\n";
2872       pr "   struct guestfs_lvm_%s *val; /* Elements. */\n" typ;
2873       pr " };\n";
2874       pr " \n";
2875       pr " void guestfs_free_lvm_%s_list (struct guestfs_free_lvm_%s_list *);\n"
2876         typ typ;
2877       pr "\n"
2878   ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
2879
2880 (* Generate the protocol (XDR) file, 'guestfs_protocol.x' and
2881  * indirectly 'guestfs_protocol.h' and 'guestfs_protocol.c'.
2882  *
2883  * We have to use an underscore instead of a dash because otherwise
2884  * rpcgen generates incorrect code.
2885  *
2886  * This header is NOT exported to clients, but see also generate_structs_h.
2887  *)
2888 and generate_xdr () =
2889   generate_header CStyle LGPLv2;
2890
2891   (* This has to be defined to get around a limitation in Sun's rpcgen. *)
2892   pr "typedef string str<>;\n";
2893   pr "\n";
2894
2895   (* LVM internal structures. *)
2896   List.iter (
2897     function
2898     | typ, cols ->
2899         pr "struct guestfs_lvm_int_%s {\n" typ;
2900         List.iter (function
2901                    | name, `String -> pr "  string %s<>;\n" name
2902                    | name, `UUID -> pr "  opaque %s[32];\n" name
2903                    | name, `Bytes -> pr "  hyper %s;\n" name
2904                    | name, `Int -> pr "  hyper %s;\n" name
2905                    | name, `OptPercent -> pr "  float %s;\n" name
2906                   ) cols;
2907         pr "};\n";
2908         pr "\n";
2909         pr "typedef struct guestfs_lvm_int_%s guestfs_lvm_int_%s_list<>;\n" typ typ;
2910         pr "\n";
2911   ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
2912
2913   (* Stat internal structures. *)
2914   List.iter (
2915     function
2916     | typ, cols ->
2917         pr "struct guestfs_int_%s {\n" typ;
2918         List.iter (function
2919                    | name, `Int -> pr "  hyper %s;\n" name
2920                   ) cols;
2921         pr "};\n";
2922         pr "\n";
2923   ) ["stat", stat_cols; "statvfs", statvfs_cols];
2924
2925   List.iter (
2926     fun (shortname, style, _, _, _, _, _) ->
2927       let name = "guestfs_" ^ shortname in
2928
2929       (match snd style with
2930        | [] -> ()
2931        | args ->
2932            pr "struct %s_args {\n" name;
2933            List.iter (
2934              function
2935              | String n -> pr "  string %s<>;\n" n
2936              | OptString n -> pr "  str *%s;\n" n
2937              | StringList n -> pr "  str %s<>;\n" n
2938              | Bool n -> pr "  bool %s;\n" n
2939              | Int n -> pr "  int %s;\n" n
2940              | FileIn _ | FileOut _ -> ()
2941            ) args;
2942            pr "};\n\n"
2943       );
2944       (match fst style with
2945        | RErr -> ()
2946        | RInt n ->
2947            pr "struct %s_ret {\n" name;
2948            pr "  int %s;\n" n;
2949            pr "};\n\n"
2950        | RInt64 n ->
2951            pr "struct %s_ret {\n" name;
2952            pr "  hyper %s;\n" n;
2953            pr "};\n\n"
2954        | RBool n ->
2955            pr "struct %s_ret {\n" name;
2956            pr "  bool %s;\n" n;
2957            pr "};\n\n"
2958        | RConstString _ ->
2959            failwithf "RConstString cannot be returned from a daemon function"
2960        | RString n ->
2961            pr "struct %s_ret {\n" name;
2962            pr "  string %s<>;\n" n;
2963            pr "};\n\n"
2964        | RStringList n ->
2965            pr "struct %s_ret {\n" name;
2966            pr "  str %s<>;\n" n;
2967            pr "};\n\n"
2968        | RIntBool (n,m) ->
2969            pr "struct %s_ret {\n" name;
2970            pr "  int %s;\n" n;
2971            pr "  bool %s;\n" m;
2972            pr "};\n\n"
2973        | RPVList n ->
2974            pr "struct %s_ret {\n" name;
2975            pr "  guestfs_lvm_int_pv_list %s;\n" n;
2976            pr "};\n\n"
2977        | RVGList n ->
2978            pr "struct %s_ret {\n" name;
2979            pr "  guestfs_lvm_int_vg_list %s;\n" n;
2980            pr "};\n\n"
2981        | RLVList n ->
2982            pr "struct %s_ret {\n" name;
2983            pr "  guestfs_lvm_int_lv_list %s;\n" n;
2984            pr "};\n\n"
2985        | RStat n ->
2986            pr "struct %s_ret {\n" name;
2987            pr "  guestfs_int_stat %s;\n" n;
2988            pr "};\n\n"
2989        | RStatVFS n ->
2990            pr "struct %s_ret {\n" name;
2991            pr "  guestfs_int_statvfs %s;\n" n;
2992            pr "};\n\n"
2993        | RHashtable n ->
2994            pr "struct %s_ret {\n" name;
2995            pr "  str %s<>;\n" n;
2996            pr "};\n\n"
2997       );
2998   ) daemon_functions;
2999
3000   (* Table of procedure numbers. *)
3001   pr "enum guestfs_procedure {\n";
3002   List.iter (
3003     fun (shortname, _, proc_nr, _, _, _, _) ->
3004       pr "  GUESTFS_PROC_%s = %d,\n" (String.uppercase shortname) proc_nr
3005   ) daemon_functions;
3006   pr "  GUESTFS_PROC_NR_PROCS\n";
3007   pr "};\n";
3008   pr "\n";
3009
3010   (* Having to choose a maximum message size is annoying for several
3011    * reasons (it limits what we can do in the API), but it (a) makes
3012    * the protocol a lot simpler, and (b) provides a bound on the size
3013    * of the daemon which operates in limited memory space.  For large
3014    * file transfers you should use FTP.
3015    *)
3016   pr "const GUESTFS_MESSAGE_MAX = %d;\n" (4 * 1024 * 1024);
3017   pr "\n";
3018
3019   (* Message header, etc. *)
3020   pr "\
3021 /* The communication protocol is now documented in the guestfs(3)
3022  * manpage.
3023  */
3024
3025 const GUESTFS_PROGRAM = 0x2000F5F5;
3026 const GUESTFS_PROTOCOL_VERSION = 1;
3027
3028 /* These constants must be larger than any possible message length. */
3029 const GUESTFS_LAUNCH_FLAG = 0xf5f55ff5;
3030 const GUESTFS_CANCEL_FLAG = 0xffffeeee;
3031
3032 enum guestfs_message_direction {
3033   GUESTFS_DIRECTION_CALL = 0,        /* client -> daemon */
3034   GUESTFS_DIRECTION_REPLY = 1        /* daemon -> client */
3035 };
3036
3037 enum guestfs_message_status {
3038   GUESTFS_STATUS_OK = 0,
3039   GUESTFS_STATUS_ERROR = 1
3040 };
3041
3042 const GUESTFS_ERROR_LEN = 256;
3043
3044 struct guestfs_message_error {
3045   string error_message<GUESTFS_ERROR_LEN>;
3046 };
3047
3048 struct guestfs_message_header {
3049   unsigned prog;                     /* GUESTFS_PROGRAM */
3050   unsigned vers;                     /* GUESTFS_PROTOCOL_VERSION */
3051   guestfs_procedure proc;            /* GUESTFS_PROC_x */
3052   guestfs_message_direction direction;
3053   unsigned serial;                   /* message serial number */
3054   guestfs_message_status status;
3055 };
3056
3057 const GUESTFS_MAX_CHUNK_SIZE = 8192;
3058
3059 struct guestfs_chunk {
3060   int cancel;                        /* if non-zero, transfer is cancelled */
3061   /* data size is 0 bytes if the transfer has finished successfully */
3062   opaque data<GUESTFS_MAX_CHUNK_SIZE>;
3063 };
3064 "
3065
3066 (* Generate the guestfs-structs.h file. *)
3067 and generate_structs_h () =
3068   generate_header CStyle LGPLv2;
3069
3070   (* This is a public exported header file containing various
3071    * structures.  The structures are carefully written to have
3072    * exactly the same in-memory format as the XDR structures that
3073    * we use on the wire to the daemon.  The reason for creating
3074    * copies of these structures here is just so we don't have to
3075    * export the whole of guestfs_protocol.h (which includes much
3076    * unrelated and XDR-dependent stuff that we don't want to be
3077    * public, or required by clients).
3078    *
3079    * To reiterate, we will pass these structures to and from the
3080    * client with a simple assignment or memcpy, so the format
3081    * must be identical to what rpcgen / the RFC defines.
3082    *)
3083
3084   (* guestfs_int_bool structure. *)
3085   pr "struct guestfs_int_bool {\n";
3086   pr "  int32_t i;\n";
3087   pr "  int32_t b;\n";
3088   pr "};\n";
3089   pr "\n";
3090
3091   (* LVM public structures. *)
3092   List.iter (
3093     function
3094     | typ, cols ->
3095         pr "struct guestfs_lvm_%s {\n" typ;
3096         List.iter (
3097           function
3098           | name, `String -> pr "  char *%s;\n" name
3099           | name, `UUID -> pr "  char %s[32]; /* this is NOT nul-terminated, be careful when printing */\n" name
3100           | name, `Bytes -> pr "  uint64_t %s;\n" name
3101           | name, `Int -> pr "  int64_t %s;\n" name
3102           | name, `OptPercent -> pr "  float %s; /* [0..100] or -1 */\n" name
3103         ) cols;
3104         pr "};\n";
3105         pr "\n";
3106         pr "struct guestfs_lvm_%s_list {\n" typ;
3107         pr "  uint32_t len;\n";
3108         pr "  struct guestfs_lvm_%s *val;\n" typ;
3109         pr "};\n";
3110         pr "\n"
3111   ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
3112
3113   (* Stat structures. *)
3114   List.iter (
3115     function
3116     | typ, cols ->
3117         pr "struct guestfs_%s {\n" typ;
3118         List.iter (
3119           function
3120           | name, `Int -> pr "  int64_t %s;\n" name
3121         ) cols;
3122         pr "};\n";
3123         pr "\n"
3124   ) ["stat", stat_cols; "statvfs", statvfs_cols]
3125
3126 (* Generate the guestfs-actions.h file. *)
3127 and generate_actions_h () =
3128   generate_header CStyle LGPLv2;
3129   List.iter (
3130     fun (shortname, style, _, _, _, _, _) ->
3131       let name = "guestfs_" ^ shortname in
3132       generate_prototype ~single_line:true ~newline:true ~handle:"handle"
3133         name style
3134   ) all_functions
3135
3136 (* Generate the client-side dispatch stubs. *)
3137 and generate_client_actions () =
3138   generate_header CStyle LGPLv2;
3139
3140   pr "\
3141 #include <stdio.h>
3142 #include <stdlib.h>
3143
3144 #include \"guestfs.h\"
3145 #include \"guestfs_protocol.h\"
3146
3147 #define error guestfs_error
3148 #define perrorf guestfs_perrorf
3149 #define safe_malloc guestfs_safe_malloc
3150 #define safe_realloc guestfs_safe_realloc
3151 #define safe_strdup guestfs_safe_strdup
3152 #define safe_memdup guestfs_safe_memdup
3153
3154 /* Check the return message from a call for validity. */
3155 static int
3156 check_reply_header (guestfs_h *g,
3157                     const struct guestfs_message_header *hdr,
3158                     int proc_nr, int serial)
3159 {
3160   if (hdr->prog != GUESTFS_PROGRAM) {
3161     error (g, \"wrong program (%%d/%%d)\", hdr->prog, GUESTFS_PROGRAM);
3162     return -1;
3163   }
3164   if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
3165     error (g, \"wrong protocol version (%%d/%%d)\",
3166            hdr->vers, GUESTFS_PROTOCOL_VERSION);
3167     return -1;
3168   }
3169   if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
3170     error (g, \"unexpected message direction (%%d/%%d)\",
3171            hdr->direction, GUESTFS_DIRECTION_REPLY);
3172     return -1;
3173   }
3174   if (hdr->proc != proc_nr) {
3175     error (g, \"unexpected procedure number (%%d/%%d)\", hdr->proc, proc_nr);
3176     return -1;
3177   }
3178   if (hdr->serial != serial) {
3179     error (g, \"unexpected serial (%%d/%%d)\", hdr->serial, serial);
3180     return -1;
3181   }
3182
3183   return 0;
3184 }
3185
3186 /* Check we are in the right state to run a high-level action. */
3187 static int
3188 check_state (guestfs_h *g, const char *caller)
3189 {
3190   if (!guestfs_is_ready (g)) {
3191     if (guestfs_is_config (g))
3192       error (g, \"%%s: call launch() before using this function\",
3193         caller);
3194     else if (guestfs_is_launching (g))
3195       error (g, \"%%s: call wait_ready() before using this function\",
3196         caller);
3197     else
3198       error (g, \"%%s called from the wrong state, %%d != READY\",
3199         caller, guestfs_get_state (g));
3200     return -1;
3201   }
3202   return 0;
3203 }
3204
3205 ";
3206
3207   (* Client-side stubs for each function. *)
3208   List.iter (
3209     fun (shortname, style, _, _, _, _, _) ->
3210       let name = "guestfs_" ^ shortname in
3211
3212       (* Generate the context struct which stores the high-level
3213        * state between callback functions.
3214        *)
3215       pr "struct %s_ctx {\n" shortname;
3216       pr "  /* This flag is set by the callbacks, so we know we've done\n";
3217       pr "   * the callbacks as expected, and in the right sequence.\n";
3218       pr "   * 0 = not called, 1 = reply_cb called.\n";
3219       pr "   */\n";
3220       pr "  int cb_sequence;\n";
3221       pr "  struct guestfs_message_header hdr;\n";
3222       pr "  struct guestfs_message_error err;\n";
3223       (match fst style with
3224        | RErr -> ()
3225        | RConstString _ ->
3226            failwithf "RConstString cannot be returned from a daemon function"
3227        | RInt _ | RInt64 _
3228        | RBool _ | RString _ | RStringList _
3229        | RIntBool _
3230        | RPVList _ | RVGList _ | RLVList _
3231        | RStat _ | RStatVFS _
3232        | RHashtable _ ->
3233            pr "  struct %s_ret ret;\n" name
3234       );
3235       pr "};\n";
3236       pr "\n";
3237
3238       (* Generate the reply callback function. *)
3239       pr "static void %s_reply_cb (guestfs_h *g, void *data, XDR *xdr)\n" shortname;
3240       pr "{\n";
3241       pr "  guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
3242       pr "  struct %s_ctx *ctx = (struct %s_ctx *) data;\n" shortname shortname;
3243       pr "\n";
3244       pr "  /* This should definitely not happen. */\n";
3245       pr "  if (ctx->cb_sequence != 0) {\n";
3246       pr "    ctx->cb_sequence = 9999;\n";
3247       pr "    error (g, \"%%s: internal error: reply callback called twice\", \"%s\");\n" name;
3248       pr "    return;\n";
3249       pr "  }\n";
3250       pr "\n";
3251       pr "  ml->main_loop_quit (ml, g);\n";
3252       pr "\n";
3253       pr "  if (!xdr_guestfs_message_header (xdr, &ctx->hdr)) {\n";
3254       pr "    error (g, \"%%s: failed to parse reply header\", \"%s\");\n" name;
3255       pr "    return;\n";
3256       pr "  }\n";
3257       pr "  if (ctx->hdr.status == GUESTFS_STATUS_ERROR) {\n";
3258       pr "    if (!xdr_guestfs_message_error (xdr, &ctx->err)) {\n";
3259       pr "      error (g, \"%%s: failed to parse reply error\", \"%s\");\n"
3260         name;
3261       pr "      return;\n";
3262       pr "    }\n";
3263       pr "    goto done;\n";
3264       pr "  }\n";
3265
3266       (match fst style with
3267        | RErr -> ()
3268        | RConstString _ ->
3269            failwithf "RConstString cannot be returned from a daemon function"
3270        | RInt _ | RInt64 _
3271        | RBool _ | RString _ | RStringList _
3272        | RIntBool _
3273        | RPVList _ | RVGList _ | RLVList _
3274        | RStat _ | RStatVFS _
3275        | RHashtable _ ->
3276             pr "  if (!xdr_%s_ret (xdr, &ctx->ret)) {\n" name;
3277             pr "    error (g, \"%%s: failed to parse reply\", \"%s\");\n" name;
3278             pr "    return;\n";
3279             pr "  }\n";
3280       );
3281
3282       pr " done:\n";
3283       pr "  ctx->cb_sequence = 1;\n";
3284       pr "}\n\n";
3285
3286       (* Generate the action stub. *)
3287       generate_prototype ~extern:false ~semicolon:false ~newline:true
3288         ~handle:"g" name style;
3289
3290       let error_code =
3291         match fst style with
3292         | RErr | RInt _ | RInt64 _ | RBool _ -> "-1"
3293         | RConstString _ ->
3294             failwithf "RConstString cannot be returned from a daemon function"
3295         | RString _ | RStringList _ | RIntBool _
3296         | RPVList _ | RVGList _ | RLVList _
3297         | RStat _ | RStatVFS _
3298         | RHashtable _ ->
3299             "NULL" in
3300
3301       pr "{\n";
3302
3303       (match snd style with
3304        | [] -> ()
3305        | _ -> pr "  struct %s_args args;\n" name
3306       );
3307
3308       pr "  struct %s_ctx ctx;\n" shortname;
3309       pr "  guestfs_main_loop *ml = guestfs_get_main_loop (g);\n";
3310       pr "  int serial;\n";
3311       pr "\n";
3312       pr "  if (check_state (g, \"%s\") == -1) return %s;\n" name error_code;
3313       pr "  guestfs_set_busy (g);\n";
3314       pr "\n";
3315       pr "  memset (&ctx, 0, sizeof ctx);\n";
3316       pr "\n";
3317
3318       (* Send the main header and arguments. *)
3319       (match snd style with
3320        | [] ->
3321            pr "  serial = guestfs__send_sync (g, GUESTFS_PROC_%s, NULL, NULL);\n"
3322              (String.uppercase shortname)
3323        | args ->
3324            List.iter (
3325              function
3326              | String n ->
3327                  pr "  args.%s = (char *) %s;\n" n n
3328              | OptString n ->
3329                  pr "  args.%s = %s ? (char **) &%s : NULL;\n" n n n
3330              | StringList n ->
3331                  pr "  args.%s.%s_val = (char **) %s;\n" n n n;
3332                  pr "  for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n;
3333              | Bool n ->
3334                  pr "  args.%s = %s;\n" n n
3335              | Int n ->
3336                  pr "  args.%s = %s;\n" n n
3337              | FileIn _ | FileOut _ -> ()
3338            ) args;
3339            pr "  serial = guestfs__send_sync (g, GUESTFS_PROC_%s,\n"
3340              (String.uppercase shortname);
3341            pr "        (xdrproc_t) xdr_%s_args, (char *) &args);\n"
3342              name;
3343       );
3344       pr "  if (serial == -1) {\n";
3345       pr "    guestfs_end_busy (g);\n";
3346       pr "    return %s;\n" error_code;
3347       pr "  }\n";
3348       pr "\n";
3349
3350       (* Send any additional files (FileIn) requested. *)
3351       let need_read_reply_label = ref false in
3352       List.iter (
3353         function
3354         | FileIn n ->
3355             pr "  {\n";
3356             pr "    int r;\n";
3357             pr "\n";
3358             pr "    r = guestfs__send_file_sync (g, %s);\n" n;
3359             pr "    if (r == -1) {\n";
3360             pr "      guestfs_end_busy (g);\n";
3361             pr "      return %s;\n" error_code;
3362             pr "    }\n";
3363             pr "    if (r == -2) /* daemon cancelled */\n";
3364             pr "      goto read_reply;\n";
3365             need_read_reply_label := true;
3366             pr "  }\n";
3367             pr "\n";
3368         | _ -> ()
3369       ) (snd style);
3370
3371       (* Wait for the reply from the remote end. *)
3372       if !need_read_reply_label then pr " read_reply:\n";
3373       pr "  guestfs__switch_to_receiving (g);\n";
3374       pr "  ctx.cb_sequence = 0;\n";
3375       pr "  guestfs_set_reply_callback (g, %s_reply_cb, &ctx);\n" shortname;
3376       pr "  (void) ml->main_loop_run (ml, g);\n";
3377       pr "  guestfs_set_reply_callback (g, NULL, NULL);\n";
3378       pr "  if (ctx.cb_sequence != 1) {\n";
3379       pr "    error (g, \"%%s reply failed, see earlier error messages\", \"%s\");\n" name;
3380       pr "    guestfs_end_busy (g);\n";
3381       pr "    return %s;\n" error_code;
3382       pr "  }\n";
3383       pr "\n";
3384
3385       pr "  if (check_reply_header (g, &ctx.hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
3386         (String.uppercase shortname);
3387       pr "    guestfs_end_busy (g);\n";
3388       pr "    return %s;\n" error_code;
3389       pr "  }\n";
3390       pr "\n";
3391
3392       pr "  if (ctx.hdr.status == GUESTFS_STATUS_ERROR) {\n";
3393       pr "    error (g, \"%%s\", ctx.err.error_message);\n";
3394       pr "    free (ctx.err.error_message);\n";
3395       pr "    guestfs_end_busy (g);\n";
3396       pr "    return %s;\n" error_code;
3397       pr "  }\n";
3398       pr "\n";
3399
3400       (* Expecting to receive further files (FileOut)? *)
3401       List.iter (
3402         function
3403         | FileOut n ->
3404             pr "  if (guestfs__receive_file_sync (g, %s) == -1) {\n" n;
3405             pr "    guestfs_end_busy (g);\n";
3406             pr "    return %s;\n" error_code;
3407             pr "  }\n";
3408             pr "\n";
3409         | _ -> ()
3410       ) (snd style);
3411
3412       pr "  guestfs_end_busy (g);\n";
3413
3414       (match fst style with
3415        | RErr -> pr "  return 0;\n"
3416        | RInt n | RInt64 n | RBool n ->
3417            pr "  return ctx.ret.%s;\n" n
3418        | RConstString _ ->
3419            failwithf "RConstString cannot be returned from a daemon function"
3420        | RString n ->
3421            pr "  return ctx.ret.%s; /* caller will free */\n" n
3422        | RStringList n | RHashtable n ->
3423            pr "  /* caller will free this, but we need to add a NULL entry */\n";
3424            pr "  ctx.ret.%s.%s_val =\n" n n;
3425            pr "    safe_realloc (g, ctx.ret.%s.%s_val,\n" n n;
3426            pr "                  sizeof (char *) * (ctx.ret.%s.%s_len + 1));\n"
3427              n n;
3428            pr "  ctx.ret.%s.%s_val[ctx.ret.%s.%s_len] = NULL;\n" n n n n;
3429            pr "  return ctx.ret.%s.%s_val;\n" n n
3430        | RIntBool _ ->
3431            pr "  /* caller with free this */\n";
3432            pr "  return safe_memdup (g, &ctx.ret, sizeof (ctx.ret));\n"
3433        | RPVList n | RVGList n | RLVList n
3434        | RStat n | RStatVFS n ->
3435            pr "  /* caller will free this */\n";
3436            pr "  return safe_memdup (g, &ctx.ret.%s, sizeof (ctx.ret.%s));\n" n n
3437       );
3438
3439       pr "}\n\n"
3440   ) daemon_functions
3441
3442 (* Generate daemon/actions.h. *)
3443 and generate_daemon_actions_h () =
3444   generate_header CStyle GPLv2;
3445
3446   pr "#include \"../src/guestfs_protocol.h\"\n";
3447   pr "\n";
3448
3449   List.iter (
3450     fun (name, style, _, _, _, _, _) ->
3451         generate_prototype
3452           ~single_line:true ~newline:true ~in_daemon:true ~prefix:"do_"
3453           name style;
3454   ) daemon_functions
3455
3456 (* Generate the server-side stubs. *)
3457 and generate_daemon_actions () =
3458   generate_header CStyle GPLv2;
3459
3460   pr "#include <config.h>\n";
3461   pr "\n";
3462   pr "#include <stdio.h>\n";
3463   pr "#include <stdlib.h>\n";
3464   pr "#include <string.h>\n";
3465   pr "#include <inttypes.h>\n";
3466   pr "#include <ctype.h>\n";
3467   pr "#include <rpc/types.h>\n";
3468   pr "#include <rpc/xdr.h>\n";
3469   pr "\n";
3470   pr "#include \"daemon.h\"\n";
3471   pr "#include \"../src/guestfs_protocol.h\"\n";
3472   pr "#include \"actions.h\"\n";
3473   pr "\n";
3474
3475   List.iter (
3476     fun (name, style, _, _, _, _, _) ->
3477       (* Generate server-side stubs. *)
3478       pr "static void %s_stub (XDR *xdr_in)\n" name;
3479       pr "{\n";
3480       let error_code =
3481         match fst style with
3482         | RErr | RInt _ -> pr "  int r;\n"; "-1"
3483         | RInt64 _ -> pr "  int64_t r;\n"; "-1"
3484         | RBool _ -> pr "  int r;\n"; "-1"
3485         | RConstString _ ->
3486             failwithf "RConstString cannot be returned from a daemon function"
3487         | RString _ -> pr "  char *r;\n"; "NULL"
3488         | RStringList _ | RHashtable _ -> pr "  char **r;\n"; "NULL"
3489         | RIntBool _ -> pr "  guestfs_%s_ret *r;\n" name; "NULL"
3490         | RPVList _ -> pr "  guestfs_lvm_int_pv_list *r;\n"; "NULL"
3491         | RVGList _ -> pr "  guestfs_lvm_int_vg_list *r;\n"; "NULL"
3492         | RLVList _ -> pr "  guestfs_lvm_int_lv_list *r;\n"; "NULL"
3493         | RStat _ -> pr "  guestfs_int_stat *r;\n"; "NULL"
3494         | RStatVFS _ -> pr "  guestfs_int_statvfs *r;\n"; "NULL" in
3495
3496       (match snd style with
3497        | [] -> ()
3498        | args ->
3499            pr "  struct guestfs_%s_args args;\n" name;
3500            List.iter (
3501              function
3502                (* Note we allow the string to be writable, in order to
3503                 * allow device name translation.  This is safe because
3504                 * we can modify the string (passed from RPC).
3505                 *)
3506              | String n
3507              | OptString n -> pr "  char *%s;\n" n
3508              | StringList n -> pr "  char **%s;\n" n
3509              | Bool n -> pr "  int %s;\n" n
3510              | Int n -> pr "  int %s;\n" n
3511              | FileIn _ | FileOut _ -> ()
3512            ) args
3513       );
3514       pr "\n";
3515
3516       (match snd style with
3517        | [] -> ()
3518        | args ->
3519            pr "  memset (&args, 0, sizeof args);\n";
3520            pr "\n";
3521            pr "  if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name;
3522            pr "    reply_with_error (\"%%s: daemon failed to decode procedure arguments\", \"%s\");\n" name;
3523            pr "    return;\n";
3524            pr "  }\n";
3525            List.iter (
3526              function
3527              | String n -> pr "  %s = args.%s;\n" n n
3528              | OptString n -> pr "  %s = args.%s ? *args.%s : NULL;\n" n n n
3529              | StringList n ->
3530                  pr "  %s = realloc (args.%s.%s_val,\n" n n n;
3531                  pr "                sizeof (char *) * (args.%s.%s_len+1));\n" n n;
3532                  pr "  if (%s == NULL) {\n" n;
3533                  pr "    reply_with_perror (\"realloc\");\n";
3534                  pr "    goto done;\n";
3535                  pr "  }\n";
3536                  pr "  %s[args.%s.%s_len] = NULL;\n" n n n;
3537                  pr "  args.%s.%s_val = %s;\n" n n n;
3538              | Bool n -> pr "  %s = args.%s;\n" n n
3539              | Int n -> pr "  %s = args.%s;\n" n n
3540              | FileIn _ | FileOut _ -> ()
3541            ) args;
3542            pr "\n"
3543       );
3544
3545       (* Don't want to call the impl with any FileIn or FileOut
3546        * parameters, since these go "outside" the RPC protocol.
3547        *)
3548       let argsnofile =
3549         List.filter (function FileIn _ | FileOut _ -> false | _ -> true)
3550           (snd style) in
3551       pr "  r = do_%s " name;
3552       generate_call_args argsnofile;
3553       pr ";\n";
3554
3555       pr "  if (r == %s)\n" error_code;
3556       pr "    /* do_%s has already called reply_with_error */\n" name;
3557       pr "    goto done;\n";
3558       pr "\n";
3559
3560       (* If there are any FileOut parameters, then the impl must
3561        * send its own reply.
3562        *)
3563       let no_reply =
3564         List.exists (function FileOut _ -> true | _ -> false) (snd style) in
3565       if no_reply then
3566         pr "  /* do_%s has already sent a reply */\n" name
3567       else (
3568         match fst style with
3569         | RErr -> pr "  reply (NULL, NULL);\n"
3570         | RInt n | RInt64 n | RBool n ->
3571             pr "  struct guestfs_%s_ret ret;\n" name;
3572             pr "  ret.%s = r;\n" n;
3573             pr "  reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
3574               name
3575         | RConstString _ ->
3576             failwithf "RConstString cannot be returned from a daemon function"
3577         | RString n ->
3578             pr "  struct guestfs_%s_ret ret;\n" name;
3579             pr "  ret.%s = r;\n" n;
3580             pr "  reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
3581               name;
3582             pr "  free (r);\n"
3583         | RStringList n | RHashtable n ->
3584             pr "  struct guestfs_%s_ret ret;\n" name;
3585             pr "  ret.%s.%s_len = count_strings (r);\n" n n;
3586             pr "  ret.%s.%s_val = r;\n" n n;
3587             pr "  reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
3588               name;
3589             pr "  free_strings (r);\n"
3590         | RIntBool _ ->
3591             pr "  reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) r);\n"
3592               name;
3593             pr "  xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) r);\n" name
3594         | RPVList n | RVGList n | RLVList n
3595         | RStat n | RStatVFS n ->
3596             pr "  struct guestfs_%s_ret ret;\n" name;
3597             pr "  ret.%s = *r;\n" n;
3598             pr "  reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
3599               name;
3600             pr "  xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
3601               name
3602       );
3603
3604       (* Free the args. *)
3605       (match snd style with
3606        | [] ->
3607            pr "done: ;\n";
3608        | _ ->
3609            pr "done:\n";
3610            pr "  xdr_free ((xdrproc_t) xdr_guestfs_%s_args, (char *) &args);\n"
3611              name
3612       );
3613
3614       pr "}\n\n";
3615   ) daemon_functions;
3616
3617   (* Dispatch function. *)
3618   pr "void dispatch_incoming_message (XDR *xdr_in)\n";
3619   pr "{\n";
3620   pr "  switch (proc_nr) {\n";
3621
3622   List.iter (
3623     fun (name, style, _, _, _, _, _) ->
3624         pr "    case GUESTFS_PROC_%s:\n" (String.uppercase name);
3625         pr "      %s_stub (xdr_in);\n" name;
3626         pr "      break;\n"
3627   ) daemon_functions;
3628
3629   pr "    default:\n";
3630   pr "      reply_with_error (\"dispatch_incoming_message: unknown procedure number %%d\", proc_nr);\n";
3631   pr "  }\n";
3632   pr "}\n";
3633   pr "\n";
3634
3635   (* LVM columns and tokenization functions. *)
3636   (* XXX This generates crap code.  We should rethink how we
3637    * do this parsing.
3638    *)
3639   List.iter (
3640     function
3641     | typ, cols ->
3642         pr "static const char *lvm_%s_cols = \"%s\";\n"
3643           typ (String.concat "," (List.map fst cols));
3644         pr "\n";
3645
3646         pr "static int lvm_tokenize_%s (char *str, struct guestfs_lvm_int_%s *r)\n" typ typ;
3647         pr "{\n";
3648         pr "  char *tok, *p, *next;\n";
3649         pr "  int i, j;\n";
3650         pr "\n";
3651         (*
3652         pr "  fprintf (stderr, \"%%s: <<%%s>>\\n\", __func__, str);\n";
3653         pr "\n";
3654         *)
3655         pr "  if (!str) {\n";
3656         pr "    fprintf (stderr, \"%%s: failed: passed a NULL string\\n\", __func__);\n";
3657         pr "    return -1;\n";
3658         pr "  }\n";
3659         pr "  if (!*str || isspace (*str)) {\n";
3660         pr "    fprintf (stderr, \"%%s: failed: passed a empty string or one beginning with whitespace\\n\", __func__);\n";
3661         pr "    return -1;\n";
3662         pr "  }\n";
3663         pr "  tok = str;\n";
3664         List.iter (
3665           fun (name, coltype) ->
3666             pr "  if (!tok) {\n";
3667             pr "    fprintf (stderr, \"%%s: failed: string finished early, around token %%s\\n\", __func__, \"%s\");\n" name;
3668             pr "    return -1;\n";
3669             pr "  }\n";
3670             pr "  p = strchrnul (tok, ',');\n";
3671             pr "  if (*p) next = p+1; else next = NULL;\n";
3672             pr "  *p = '\\0';\n";
3673             (match coltype with
3674              | `String ->
3675                  pr "  r->%s = strdup (tok);\n" name;
3676                  pr "  if (r->%s == NULL) {\n" name;
3677                  pr "    perror (\"strdup\");\n";
3678                  pr "    return -1;\n";
3679                  pr "  }\n"
3680              | `UUID ->
3681                  pr "  for (i = j = 0; i < 32; ++j) {\n";
3682                  pr "    if (tok[j] == '\\0') {\n";
3683                  pr "      fprintf (stderr, \"%%s: failed to parse UUID from '%%s'\\n\", __func__, tok);\n";
3684                  pr "      return -1;\n";
3685                  pr "    } else if (tok[j] != '-')\n";
3686                  pr "      r->%s[i++] = tok[j];\n" name;
3687                  pr "  }\n";
3688              | `Bytes ->
3689                  pr "  if (sscanf (tok, \"%%\"SCNu64, &r->%s) != 1) {\n" name;
3690                  pr "    fprintf (stderr, \"%%s: failed to parse size '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
3691                  pr "    return -1;\n";
3692                  pr "  }\n";
3693              | `Int ->
3694                  pr "  if (sscanf (tok, \"%%\"SCNi64, &r->%s) != 1) {\n" name;
3695                  pr "    fprintf (stderr, \"%%s: failed to parse int '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
3696                  pr "    return -1;\n";
3697                  pr "  }\n";
3698              | `OptPercent ->
3699                  pr "  if (tok[0] == '\\0')\n";
3700                  pr "    r->%s = -1;\n" name;
3701                  pr "  else if (sscanf (tok, \"%%f\", &r->%s) != 1) {\n" name;
3702                  pr "    fprintf (stderr, \"%%s: failed to parse float '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
3703                  pr "    return -1;\n";
3704                  pr "  }\n";
3705             );
3706             pr "  tok = next;\n";
3707         ) cols;
3708
3709         pr "  if (tok != NULL) {\n";
3710         pr "    fprintf (stderr, \"%%s: failed: extra tokens at end of string\\n\", __func__);\n";
3711         pr "    return -1;\n";
3712         pr "  }\n";
3713         pr "  return 0;\n";
3714         pr "}\n";
3715         pr "\n";
3716
3717         pr "guestfs_lvm_int_%s_list *\n" typ;
3718         pr "parse_command_line_%ss (void)\n" typ;
3719         pr "{\n";
3720         pr "  char *out, *err;\n";
3721         pr "  char *p, *pend;\n";
3722         pr "  int r, i;\n";
3723         pr "  guestfs_lvm_int_%s_list *ret;\n" typ;
3724         pr "  void *newp;\n";
3725         pr "\n";
3726         pr "  ret = malloc (sizeof *ret);\n";
3727         pr "  if (!ret) {\n";
3728         pr "    reply_with_perror (\"malloc\");\n";
3729         pr "    return NULL;\n";
3730         pr "  }\n";
3731         pr "\n";
3732         pr "  ret->guestfs_lvm_int_%s_list_len = 0;\n" typ;
3733         pr "  ret->guestfs_lvm_int_%s_list_val = NULL;\n" typ;
3734         pr "\n";
3735         pr "  r = command (&out, &err,\n";
3736         pr "           \"/sbin/lvm\", \"%ss\",\n" typ;
3737         pr "           \"-o\", lvm_%s_cols, \"--unbuffered\", \"--noheadings\",\n" typ;
3738         pr "           \"--nosuffix\", \"--separator\", \",\", \"--units\", \"b\", NULL);\n";
3739         pr "  if (r == -1) {\n";
3740         pr "    reply_with_error (\"%%s\", err);\n";
3741         pr "    free (out);\n";
3742         pr "    free (err);\n";
3743         pr "    free (ret);\n";
3744         pr "    return NULL;\n";
3745         pr "  }\n";
3746         pr "\n";
3747         pr "  free (err);\n";
3748         pr "\n";
3749         pr "  /* Tokenize each line of the output. */\n";
3750         pr "  p = out;\n";
3751         pr "  i = 0;\n";
3752         pr "  while (p) {\n";
3753         pr "    pend = strchr (p, '\\n');       /* Get the next line of output. */\n";
3754         pr "    if (pend) {\n";
3755         pr "      *pend = '\\0';\n";
3756         pr "      pend++;\n";
3757         pr "    }\n";
3758         pr "\n";
3759         pr "    while (*p && isspace (*p))      /* Skip any leading whitespace. */\n";
3760         pr "      p++;\n";
3761         pr "\n";
3762         pr "    if (!*p) {                      /* Empty line?  Skip it. */\n";
3763         pr "      p = pend;\n";
3764         pr "      continue;\n";
3765         pr "    }\n";
3766         pr "\n";
3767         pr "    /* Allocate some space to store this next entry. */\n";
3768         pr "    newp = realloc (ret->guestfs_lvm_int_%s_list_val,\n" typ;
3769         pr "                sizeof (guestfs_lvm_int_%s) * (i+1));\n" typ;
3770         pr "    if (newp == NULL) {\n";
3771         pr "      reply_with_perror (\"realloc\");\n";
3772         pr "      free (ret->guestfs_lvm_int_%s_list_val);\n" typ;
3773         pr "      free (ret);\n";
3774         pr "      free (out);\n";
3775         pr "      return NULL;\n";
3776         pr "    }\n";
3777         pr "    ret->guestfs_lvm_int_%s_list_val = newp;\n" typ;
3778         pr "\n";
3779         pr "    /* Tokenize the next entry. */\n";
3780         pr "    r = lvm_tokenize_%s (p, &ret->guestfs_lvm_int_%s_list_val[i]);\n" typ typ;
3781         pr "    if (r == -1) {\n";
3782         pr "      reply_with_error (\"failed to parse output of '%ss' command\");\n" typ;
3783         pr "      free (ret->guestfs_lvm_int_%s_list_val);\n" typ;
3784         pr "      free (ret);\n";
3785         pr "      free (out);\n";
3786         pr "      return NULL;\n";
3787         pr "    }\n";
3788         pr "\n";
3789         pr "    ++i;\n";
3790         pr "    p = pend;\n";
3791         pr "  }\n";
3792         pr "\n";
3793         pr "  ret->guestfs_lvm_int_%s_list_len = i;\n" typ;
3794         pr "\n";
3795         pr "  free (out);\n";
3796         pr "  return ret;\n";
3797         pr "}\n"
3798
3799   ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
3800
3801 (* Generate the tests. *)
3802 and generate_tests () =
3803   generate_header CStyle GPLv2;
3804
3805   pr "\
3806 #include <stdio.h>
3807 #include <stdlib.h>
3808 #include <string.h>
3809 #include <unistd.h>
3810 #include <sys/types.h>
3811 #include <fcntl.h>
3812
3813 #include \"guestfs.h\"
3814
3815 static guestfs_h *g;
3816 static int suppress_error = 0;
3817
3818 static void print_error (guestfs_h *g, void *data, const char *msg)
3819 {
3820   if (!suppress_error)
3821     fprintf (stderr, \"%%s\\n\", msg);
3822 }
3823
3824 static void print_strings (char * const * const argv)
3825 {
3826   int argc;
3827
3828   for (argc = 0; argv[argc] != NULL; ++argc)
3829     printf (\"\\t%%s\\n\", argv[argc]);
3830 }
3831
3832 /*
3833 static void print_table (char * const * const argv)
3834 {
3835   int i;
3836
3837   for (i = 0; argv[i] != NULL; i += 2)
3838     printf (\"%%s: %%s\\n\", argv[i], argv[i+1]);
3839 }
3840 */
3841
3842 static void no_test_warnings (void)
3843 {
3844 ";
3845
3846   List.iter (
3847     function
3848     | name, _, _, _, [], _, _ ->
3849         pr "  fprintf (stderr, \"warning: \\\"guestfs_%s\\\" has no tests\\n\");\n" name
3850     | name, _, _, _, tests, _, _ -> ()
3851   ) all_functions;
3852
3853   pr "}\n";
3854   pr "\n";
3855
3856   (* Generate the actual tests.  Note that we generate the tests
3857    * in reverse order, deliberately, so that (in general) the
3858    * newest tests run first.  This makes it quicker and easier to
3859    * debug them.
3860    *)
3861   let test_names =
3862     List.map (
3863       fun (name, _, _, _, tests, _, _) ->
3864         mapi (generate_one_test name) tests
3865     ) (List.rev all_functions) in
3866   let test_names = List.concat test_names in
3867   let nr_tests = List.length test_names in
3868
3869   pr "\
3870 int main (int argc, char *argv[])
3871 {
3872   char c = 0;
3873   int failed = 0;
3874   const char *filename;
3875   int fd;
3876   int nr_tests, test_num = 0;
3877
3878   no_test_warnings ();
3879
3880   g = guestfs_create ();
3881   if (g == NULL) {
3882     printf (\"guestfs_create FAILED\\n\");
3883     exit (1);
3884   }
3885
3886   guestfs_set_error_handler (g, print_error, NULL);
3887
3888   guestfs_set_path (g, \"../appliance\");
3889
3890   filename = \"test1.img\";
3891   fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
3892   if (fd == -1) {
3893     perror (filename);
3894     exit (1);
3895   }
3896   if (lseek (fd, %d, SEEK_SET) == -1) {
3897     perror (\"lseek\");
3898     close (fd);
3899     unlink (filename);
3900     exit (1);
3901   }
3902   if (write (fd, &c, 1) == -1) {
3903     perror (\"write\");
3904     close (fd);
3905     unlink (filename);
3906     exit (1);
3907   }
3908   if (close (fd) == -1) {
3909     perror (filename);
3910     unlink (filename);
3911     exit (1);
3912   }
3913   if (guestfs_add_drive (g, filename) == -1) {
3914     printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
3915     exit (1);
3916   }
3917
3918   filename = \"test2.img\";
3919   fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
3920   if (fd == -1) {
3921     perror (filename);
3922     exit (1);
3923   }
3924   if (lseek (fd, %d, SEEK_SET) == -1) {
3925     perror (\"lseek\");
3926     close (fd);
3927     unlink (filename);
3928     exit (1);
3929   }
3930   if (write (fd, &c, 1) == -1) {
3931     perror (\"write\");
3932     close (fd);
3933     unlink (filename);
3934     exit (1);
3935   }
3936   if (close (fd) == -1) {
3937     perror (filename);
3938     unlink (filename);
3939     exit (1);
3940   }
3941   if (guestfs_add_drive (g, filename) == -1) {
3942     printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
3943     exit (1);
3944   }
3945
3946   filename = \"test3.img\";
3947   fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
3948   if (fd == -1) {
3949     perror (filename);
3950     exit (1);
3951   }
3952   if (lseek (fd, %d, SEEK_SET) == -1) {
3953     perror (\"lseek\");
3954     close (fd);
3955     unlink (filename);
3956     exit (1);
3957   }
3958   if (write (fd, &c, 1) == -1) {
3959     perror (\"write\");
3960     close (fd);
3961     unlink (filename);
3962     exit (1);
3963   }
3964   if (close (fd) == -1) {
3965     perror (filename);
3966     unlink (filename);
3967     exit (1);
3968   }
3969   if (guestfs_add_drive (g, filename) == -1) {
3970     printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
3971     exit (1);
3972   }
3973
3974   if (guestfs_add_drive_ro (g, \"../images/test.sqsh\") == -1) {
3975     printf (\"guestfs_add_drive_ro ../images/test.sqsh FAILED\\n\");
3976     exit (1);
3977   }
3978
3979   if (guestfs_launch (g) == -1) {
3980     printf (\"guestfs_launch FAILED\\n\");
3981     exit (1);
3982   }
3983   if (guestfs_wait_ready (g) == -1) {
3984     printf (\"guestfs_wait_ready FAILED\\n\");
3985     exit (1);
3986   }
3987
3988   nr_tests = %d;
3989
3990 " (500 * 1024 * 1024) (50 * 1024 * 1024) (10 * 1024 * 1024) nr_tests;
3991
3992   iteri (
3993     fun i test_name ->
3994       pr "  test_num++;\n";
3995       pr "  printf (\"%%3d/%%3d %s\\n\", test_num, nr_tests);\n" test_name;
3996       pr "  if (%s () == -1) {\n" test_name;
3997       pr "    printf (\"%s FAILED\\n\");\n" test_name;
3998       pr "    failed++;\n";
3999       pr "  }\n";
4000   ) test_names;
4001   pr "\n";
4002
4003   pr "  guestfs_close (g);\n";
4004   pr "  unlink (\"test1.img\");\n";
4005   pr "  unlink (\"test2.img\");\n";
4006   pr "  unlink (\"test3.img\");\n";
4007   pr "\n";
4008
4009   pr "  if (failed > 0) {\n";
4010   pr "    printf (\"***** %%d / %%d tests FAILED *****\\n\", failed, nr_tests);\n";
4011   pr "    exit (1);\n";
4012   pr "  }\n";
4013   pr "\n";
4014
4015   pr "  exit (0);\n";
4016   pr "}\n"
4017
4018 and generate_one_test name i (init, prereq, test) =
4019   let test_name = sprintf "test_%s_%d" name i in
4020
4021   pr "\
4022 static int %s_skip (void)
4023 {
4024   const char *str;
4025
4026   str = getenv (\"SKIP_%s\");
4027   if (str && strcmp (str, \"1\") == 0) return 1;
4028   str = getenv (\"SKIP_TEST_%s\");
4029   if (str && strcmp (str, \"1\") == 0) return 1;
4030   return 0;
4031 }
4032
4033 " test_name (String.uppercase test_name) (String.uppercase name);
4034
4035   (match prereq with
4036    | Disabled | Always -> ()
4037    | If code | Unless code ->
4038        pr "static int %s_prereq (void)\n" test_name;
4039        pr "{\n";
4040        pr "  %s\n" code;
4041        pr "}\n";
4042        pr "\n";
4043   );
4044
4045   pr "\
4046 static int %s (void)
4047 {
4048   if (%s_skip ()) {
4049     printf (\"%%s skipped (reason: SKIP_TEST_* variable set)\\n\", \"%s\");
4050     return 0;
4051   }
4052
4053 " test_name test_name test_name;
4054
4055   (match prereq with
4056    | Disabled ->
4057        pr "  printf (\"%%s skipped (reason: test disabled in generator)\\n\", \"%s\");\n" test_name
4058    | If _ ->
4059        pr "  if (! %s_prereq ()) {\n" test_name;
4060        pr "    printf (\"%%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
4061        pr "    return 0;\n";
4062        pr "  }\n";
4063        pr "\n";
4064        generate_one_test_body name i test_name init test;
4065    | Unless _ ->
4066        pr "  if (%s_prereq ()) {\n" test_name;
4067        pr "    printf (\"%%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
4068        pr "    return 0;\n";
4069        pr "  }\n";
4070        pr "\n";
4071        generate_one_test_body name i test_name init test;
4072    | Always ->
4073        generate_one_test_body name i test_name init test
4074   );
4075
4076   pr "  return 0;\n";
4077   pr "}\n";
4078   pr "\n";
4079   test_name
4080
4081 and generate_one_test_body name i test_name init test =
4082   (match init with
4083    | InitNone
4084    | InitEmpty ->
4085        pr "  /* InitNone|InitEmpty for %s */\n" test_name;
4086        List.iter (generate_test_command_call test_name)
4087          [["blockdev_setrw"; "/dev/sda"];
4088           ["umount_all"];
4089           ["lvm_remove_all"]]
4090    | InitBasicFS ->
4091        pr "  /* InitBasicFS for %s: create ext2 on /dev/sda1 */\n" test_name;
4092        List.iter (generate_test_command_call test_name)
4093          [["blockdev_setrw"; "/dev/sda"];
4094           ["umount_all"];
4095           ["lvm_remove_all"];
4096           ["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
4097           ["mkfs"; "ext2"; "/dev/sda1"];
4098           ["mount"; "/dev/sda1"; "/"]]
4099    | InitBasicFSonLVM ->
4100        pr "  /* InitBasicFSonLVM for %s: create ext2 on /dev/VG/LV */\n"
4101          test_name;
4102        List.iter (generate_test_command_call test_name)
4103          [["blockdev_setrw"; "/dev/sda"];
4104           ["umount_all"];
4105           ["lvm_remove_all"];
4106           ["sfdisk"; "/dev/sda"; "0"; "0"; "0"; ","];
4107           ["pvcreate"; "/dev/sda1"];
4108           ["vgcreate"; "VG"; "/dev/sda1"];
4109           ["lvcreate"; "LV"; "VG"; "8"];
4110           ["mkfs"; "ext2"; "/dev/VG/LV"];
4111           ["mount"; "/dev/VG/LV"; "/"]]
4112   );
4113
4114   let get_seq_last = function
4115     | [] ->
4116         failwithf "%s: you cannot use [] (empty list) when expecting a command"
4117           test_name
4118     | seq ->
4119         let seq = List.rev seq in
4120         List.rev (List.tl seq), List.hd seq
4121   in
4122
4123   match test with
4124   | TestRun seq ->
4125       pr "  /* TestRun for %s (%d) */\n" name i;
4126       List.iter (generate_test_command_call test_name) seq
4127   | TestOutput (seq, expected) ->
4128       pr "  /* TestOutput for %s (%d) */\n" name i;
4129       pr "  char expected[] = \"%s\";\n" (c_quote expected);
4130       let seq, last = get_seq_last seq in
4131       let test () =
4132         pr "    if (strcmp (r, expected) != 0) {\n";
4133         pr "      fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
4134         pr "      return -1;\n";
4135         pr "    }\n"
4136       in
4137       List.iter (generate_test_command_call test_name) seq;
4138       generate_test_command_call ~test test_name last
4139   | TestOutputList (seq, expected) ->
4140       pr "  /* TestOutputList for %s (%d) */\n" name i;
4141       let seq, last = get_seq_last seq in
4142       let test () =
4143         iteri (
4144           fun i str ->
4145             pr "    if (!r[%d]) {\n" i;
4146             pr "      fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
4147             pr "      print_strings (r);\n";
4148             pr "      return -1;\n";
4149             pr "    }\n";
4150             pr "    {\n";
4151             pr "      char expected[] = \"%s\";\n" (c_quote str);
4152             pr "      if (strcmp (r[%d], expected) != 0) {\n" i;
4153             pr "        fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
4154             pr "        return -1;\n";
4155             pr "      }\n";
4156             pr "    }\n"
4157         ) expected;
4158         pr "    if (r[%d] != NULL) {\n" (List.length expected);
4159         pr "      fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
4160           test_name;
4161         pr "      print_strings (r);\n";
4162         pr "      return -1;\n";
4163         pr "    }\n"
4164       in
4165       List.iter (generate_test_command_call test_name) seq;
4166       generate_test_command_call ~test test_name last
4167   | TestOutputListOfDevices (seq, expected) ->
4168       pr "  /* TestOutputListOfDevices for %s (%d) */\n" name i;
4169       let seq, last = get_seq_last seq in
4170       let test () =
4171         iteri (
4172           fun i str ->
4173             pr "    if (!r[%d]) {\n" i;
4174             pr "      fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
4175             pr "      print_strings (r);\n";
4176             pr "      return -1;\n";
4177             pr "    }\n";
4178             pr "    {\n";
4179             pr "      char expected[] = \"%s\";\n" (c_quote str);
4180             pr "      r[%d][5] = 's';\n" i;
4181             pr "      if (strcmp (r[%d], expected) != 0) {\n" i;
4182             pr "        fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
4183             pr "        return -1;\n";
4184             pr "      }\n";
4185             pr "    }\n"
4186         ) expected;
4187         pr "    if (r[%d] != NULL) {\n" (List.length expected);
4188         pr "      fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
4189           test_name;
4190         pr "      print_strings (r);\n";
4191         pr "      return -1;\n";
4192         pr "    }\n"
4193       in
4194       List.iter (generate_test_command_call test_name) seq;
4195       generate_test_command_call ~test test_name last
4196   | TestOutputInt (seq, expected) ->
4197       pr "  /* TestOutputInt for %s (%d) */\n" name i;
4198       let seq, last = get_seq_last seq in
4199       let test () =
4200         pr "    if (r != %d) {\n" expected;
4201         pr "      fprintf (stderr, \"%s: expected %d but got %%d\\n\","
4202           test_name expected;
4203         pr "               (int) r);\n";
4204         pr "      return -1;\n";
4205         pr "    }\n"
4206       in
4207       List.iter (generate_test_command_call test_name) seq;
4208       generate_test_command_call ~test test_name last
4209   | TestOutputTrue seq ->
4210       pr "  /* TestOutputTrue for %s (%d) */\n" name i;
4211       let seq, last = get_seq_last seq in
4212       let test () =
4213         pr "    if (!r) {\n";
4214         pr "      fprintf (stderr, \"%s: expected true, got false\\n\");\n"
4215           test_name;
4216         pr "      return -1;\n";
4217         pr "    }\n"
4218       in
4219       List.iter (generate_test_command_call test_name) seq;
4220       generate_test_command_call ~test test_name last
4221   | TestOutputFalse seq ->
4222       pr "  /* TestOutputFalse for %s (%d) */\n" name i;
4223       let seq, last = get_seq_last seq in
4224       let test () =
4225         pr "    if (r) {\n";
4226         pr "      fprintf (stderr, \"%s: expected false, got true\\n\");\n"
4227           test_name;
4228         pr "      return -1;\n";
4229         pr "    }\n"
4230       in
4231       List.iter (generate_test_command_call test_name) seq;
4232       generate_test_command_call ~test test_name last
4233   | TestOutputLength (seq, expected) ->
4234       pr "  /* TestOutputLength for %s (%d) */\n" name i;
4235       let seq, last = get_seq_last seq in
4236       let test () =
4237         pr "    int j;\n";
4238         pr "    for (j = 0; j < %d; ++j)\n" expected;
4239         pr "      if (r[j] == NULL) {\n";
4240         pr "        fprintf (stderr, \"%s: short list returned\\n\");\n"
4241           test_name;
4242         pr "        print_strings (r);\n";
4243         pr "        return -1;\n";
4244         pr "      }\n";
4245         pr "    if (r[j] != NULL) {\n";
4246         pr "      fprintf (stderr, \"%s: long list returned\\n\");\n"
4247           test_name;
4248         pr "      print_strings (r);\n";
4249         pr "      return -1;\n";
4250         pr "    }\n"
4251       in
4252       List.iter (generate_test_command_call test_name) seq;
4253       generate_test_command_call ~test test_name last
4254   | TestOutputStruct (seq, checks) ->
4255       pr "  /* TestOutputStruct for %s (%d) */\n" name i;
4256       let seq, last = get_seq_last seq in
4257       let test () =
4258         List.iter (
4259           function
4260           | CompareWithInt (field, expected) ->
4261               pr "    if (r->%s != %d) {\n" field expected;
4262               pr "      fprintf (stderr, \"%s: %s was %%d, expected %d\\n\",\n"
4263                 test_name field expected;
4264               pr "               (int) r->%s);\n" field;
4265               pr "      return -1;\n";
4266               pr "    }\n"
4267           | CompareWithString (field, expected) ->
4268               pr "    if (strcmp (r->%s, \"%s\") != 0) {\n" field expected;
4269               pr "      fprintf (stderr, \"%s: %s was \"%%s\", expected \"%s\"\\n\",\n"
4270                 test_name field expected;
4271               pr "               r->%s);\n" field;
4272               pr "      return -1;\n";
4273               pr "    }\n"
4274           | CompareFieldsIntEq (field1, field2) ->
4275               pr "    if (r->%s != r->%s) {\n" field1 field2;
4276               pr "      fprintf (stderr, \"%s: %s (%%d) <> %s (%%d)\\n\",\n"
4277                 test_name field1 field2;
4278               pr "               (int) r->%s, (int) r->%s);\n" field1 field2;
4279               pr "      return -1;\n";
4280               pr "    }\n"
4281           | CompareFieldsStrEq (field1, field2) ->
4282               pr "    if (strcmp (r->%s, r->%s) != 0) {\n" field1 field2;
4283               pr "      fprintf (stderr, \"%s: %s (\"%%s\") <> %s (\"%%s\")\\n\",\n"
4284                 test_name field1 field2;
4285               pr "               r->%s, r->%s);\n" field1 field2;
4286               pr "      return -1;\n";
4287               pr "    }\n"
4288         ) checks
4289       in
4290       List.iter (generate_test_command_call test_name) seq;
4291       generate_test_command_call ~test test_name last
4292   | TestLastFail seq ->
4293       pr "  /* TestLastFail for %s (%d) */\n" name i;
4294       let seq, last = get_seq_last seq in
4295       List.iter (generate_test_command_call test_name) seq;
4296       generate_test_command_call test_name ~expect_error:true last
4297
4298 (* Generate the code to run a command, leaving the result in 'r'.
4299  * If you expect to get an error then you should set expect_error:true.
4300  *)
4301 and generate_test_command_call ?(expect_error = false) ?test test_name cmd =
4302   match cmd with
4303   | [] -> assert false
4304   | name :: args ->
4305       (* Look up the command to find out what args/ret it has. *)
4306       let style =
4307         try
4308           let _, style, _, _, _, _, _ =
4309             List.find (fun (n, _, _, _, _, _, _) -> n = name) all_functions in
4310           style
4311         with Not_found ->
4312           failwithf "%s: in test, command %s was not found" test_name name in
4313
4314       if List.length (snd style) <> List.length args then
4315         failwithf "%s: in test, wrong number of args given to %s"
4316           test_name name;
4317
4318       pr "  {\n";
4319
4320       List.iter (
4321         function
4322         | OptString n, "NULL" -> ()
4323         | String n, arg
4324         | OptString n, arg ->
4325             pr "    char %s[] = \"%s\";\n" n (c_quote arg);
4326         | Int _, _
4327         | Bool _, _
4328         | FileIn _, _ | FileOut _, _ -> ()
4329         | StringList n, arg ->
4330             let strs = string_split " " arg in
4331             iteri (
4332               fun i str ->
4333                 pr "    char %s_%d[] = \"%s\";\n" n i (c_quote str);
4334             ) strs;
4335             pr "    char *%s[] = {\n" n;
4336             iteri (
4337               fun i _ -> pr "      %s_%d,\n" n i
4338             ) strs;
4339             pr "      NULL\n";
4340             pr "    };\n";
4341       ) (List.combine (snd style) args);
4342
4343       let error_code =
4344         match fst style with
4345         | RErr | RInt _ | RBool _ -> pr "    int r;\n"; "-1"
4346         | RInt64 _ -> pr "    int64_t r;\n"; "-1"
4347         | RConstString _ -> pr "    const char *r;\n"; "NULL"
4348         | RString _ -> pr "    char *r;\n"; "NULL"
4349         | RStringList _ | RHashtable _ ->
4350             pr "    char **r;\n";
4351             pr "    int i;\n";
4352             "NULL"
4353         | RIntBool _ ->
4354             pr "    struct guestfs_int_bool *r;\n"; "NULL"
4355         | RPVList _ ->
4356             pr "    struct guestfs_lvm_pv_list *r;\n"; "NULL"
4357         | RVGList _ ->
4358             pr "    struct guestfs_lvm_vg_list *r;\n"; "NULL"
4359         | RLVList _ ->
4360             pr "    struct guestfs_lvm_lv_list *r;\n"; "NULL"
4361         | RStat _ ->
4362             pr "    struct guestfs_stat *r;\n"; "NULL"
4363         | RStatVFS _ ->
4364             pr "    struct guestfs_statvfs *r;\n"; "NULL" in
4365
4366       pr "    suppress_error = %d;\n" (if expect_error then 1 else 0);
4367       pr "    r = guestfs_%s (g" name;
4368
4369       (* Generate the parameters. *)
4370       List.iter (
4371         function
4372         | OptString _, "NULL" -> pr ", NULL"
4373         | String n, _
4374         | OptString n, _ ->
4375             pr ", %s" n
4376         | FileIn _, arg | FileOut _, arg ->
4377             pr ", \"%s\"" (c_quote arg)
4378         | StringList n, _ ->
4379             pr ", %s" n
4380         | Int _, arg ->
4381             let i =
4382               try int_of_string arg
4383               with Failure "int_of_string" ->
4384                 failwithf "%s: expecting an int, but got '%s'" test_name arg in
4385             pr ", %d" i
4386         | Bool _, arg ->
4387             let b = bool_of_string arg in pr ", %d" (if b then 1 else 0)
4388       ) (List.combine (snd style) args);
4389
4390       pr ");\n";
4391       if not expect_error then
4392         pr "    if (r == %s)\n" error_code
4393       else
4394         pr "    if (r != %s)\n" error_code;
4395       pr "      return -1;\n";
4396
4397       (* Insert the test code. *)
4398       (match test with
4399        | None -> ()
4400        | Some f -> f ()
4401       );
4402
4403       (match fst style with
4404        | RErr | RInt _ | RInt64 _ | RBool _ | RConstString _ -> ()
4405        | RString _ -> pr "    free (r);\n"
4406        | RStringList _ | RHashtable _ ->
4407            pr "    for (i = 0; r[i] != NULL; ++i)\n";
4408            pr "      free (r[i]);\n";
4409            pr "    free (r);\n"
4410        | RIntBool _ ->
4411            pr "    guestfs_free_int_bool (r);\n"
4412        | RPVList _ ->
4413            pr "    guestfs_free_lvm_pv_list (r);\n"
4414        | RVGList _ ->
4415            pr "    guestfs_free_lvm_vg_list (r);\n"
4416        | RLVList _ ->
4417            pr "    guestfs_free_lvm_lv_list (r);\n"
4418        | RStat _ | RStatVFS _ ->
4419            pr "    free (r);\n"
4420       );
4421
4422       pr "  }\n"
4423
4424 and c_quote str =
4425   let str = replace_str str "\r" "\\r" in
4426   let str = replace_str str "\n" "\\n" in
4427   let str = replace_str str "\t" "\\t" in
4428   let str = replace_str str "\000" "\\0" in
4429   str
4430
4431 (* Generate a lot of different functions for guestfish. *)
4432 and generate_fish_cmds () =
4433   generate_header CStyle GPLv2;
4434
4435   let all_functions =
4436     List.filter (
4437       fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
4438     ) all_functions in
4439   let all_functions_sorted =
4440     List.filter (
4441       fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
4442     ) all_functions_sorted in
4443
4444   pr "#include <stdio.h>\n";
4445   pr "#include <stdlib.h>\n";
4446   pr "#include <string.h>\n";
4447   pr "#include <inttypes.h>\n";
4448   pr "\n";
4449   pr "#include <guestfs.h>\n";
4450   pr "#include \"fish.h\"\n";
4451   pr "\n";
4452
4453   (* list_commands function, which implements guestfish -h *)
4454   pr "void list_commands (void)\n";
4455   pr "{\n";
4456   pr "  printf (\"    %%-16s     %%s\\n\", \"Command\", \"Description\");\n";
4457   pr "  list_builtin_commands ();\n";
4458   List.iter (
4459     fun (name, _, _, flags, _, shortdesc, _) ->
4460       let name = replace_char name '_' '-' in
4461       pr "  printf (\"%%-20s %%s\\n\", \"%s\", \"%s\");\n"
4462         name shortdesc
4463   ) all_functions_sorted;
4464   pr "  printf (\"    Use -h <cmd> / help <cmd> to show detailed help for a command.\\n\");\n";
4465   pr "}\n";
4466   pr "\n";
4467
4468   (* display_command function, which implements guestfish -h cmd *)
4469   pr "void display_command (const char *cmd)\n";
4470   pr "{\n";
4471   List.iter (
4472     fun (name, style, _, flags, _, shortdesc, longdesc) ->
4473       let name2 = replace_char name '_' '-' in
4474       let alias =
4475         try find_map (function FishAlias n -> Some n | _ -> None) flags
4476         with Not_found -> name in
4477       let longdesc = replace_str longdesc "C<guestfs_" "C<" in
4478       let synopsis =
4479         match snd style with
4480         | [] -> name2
4481         | args ->
4482             sprintf "%s <%s>"
4483               name2 (String.concat "> <" (List.map name_of_argt args)) in
4484
4485       let warnings =
4486         if List.mem ProtocolLimitWarning flags then
4487           ("\n\n" ^ protocol_limit_warning)
4488         else "" in
4489
4490       (* For DangerWillRobinson commands, we should probably have
4491        * guestfish prompt before allowing you to use them (especially
4492        * in interactive mode). XXX
4493        *)
4494       let warnings =
4495         warnings ^
4496           if List.mem DangerWillRobinson flags then
4497             ("\n\n" ^ danger_will_robinson)
4498           else "" in
4499
4500       let describe_alias =
4501         if name <> alias then
4502           sprintf "\n\nYou can use '%s' as an alias for this command." alias
4503         else "" in
4504
4505       pr "  if (";
4506       pr "strcasecmp (cmd, \"%s\") == 0" name;
4507       if name <> name2 then
4508         pr " || strcasecmp (cmd, \"%s\") == 0" name2;
4509       if name <> alias then
4510         pr " || strcasecmp (cmd, \"%s\") == 0" alias;
4511       pr ")\n";
4512       pr "    pod2text (\"%s - %s\", %S);\n"
4513         name2 shortdesc
4514         (" " ^ synopsis ^ "\n\n" ^ longdesc ^ warnings ^ describe_alias);
4515       pr "  else\n"
4516   ) all_functions;
4517   pr "    display_builtin_command (cmd);\n";
4518   pr "}\n";
4519   pr "\n";
4520
4521   (* print_{pv,vg,lv}_list functions *)
4522   List.iter (
4523     function
4524     | typ, cols ->
4525         pr "static void print_%s (struct guestfs_lvm_%s *%s)\n" typ typ typ;
4526         pr "{\n";
4527         pr "  int i;\n";
4528         pr "\n";
4529         List.iter (
4530           function
4531           | name, `String ->
4532               pr "  printf (\"%s: %%s\\n\", %s->%s);\n" name typ name
4533           | name, `UUID ->
4534               pr "  printf (\"%s: \");\n" name;
4535               pr "  for (i = 0; i < 32; ++i)\n";
4536               pr "    printf (\"%%c\", %s->%s[i]);\n" typ name;
4537               pr "  printf (\"\\n\");\n"
4538           | name, `Bytes ->
4539               pr "  printf (\"%s: %%\" PRIu64 \"\\n\", %s->%s);\n" name typ name
4540           | name, `Int ->
4541               pr "  printf (\"%s: %%\" PRIi64 \"\\n\", %s->%s);\n" name typ name
4542           | name, `OptPercent ->
4543               pr "  if (%s->%s >= 0) printf (\"%s: %%g %%%%\\n\", %s->%s);\n"
4544                 typ name name typ name;
4545               pr "  else printf (\"%s: \\n\");\n" name
4546         ) cols;
4547         pr "}\n";
4548         pr "\n";
4549         pr "static void print_%s_list (struct guestfs_lvm_%s_list *%ss)\n"
4550           typ typ typ;
4551         pr "{\n";
4552         pr "  int i;\n";
4553         pr "\n";
4554         pr "  for (i = 0; i < %ss->len; ++i)\n" typ;
4555         pr "    print_%s (&%ss->val[i]);\n" typ typ;
4556         pr "}\n";
4557         pr "\n";
4558   ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
4559
4560   (* print_{stat,statvfs} functions *)
4561   List.iter (
4562     function
4563     | typ, cols ->
4564         pr "static void print_%s (struct guestfs_%s *%s)\n" typ typ typ;
4565         pr "{\n";
4566         List.iter (
4567           function
4568           | name, `Int ->
4569               pr "  printf (\"%s: %%\" PRIi64 \"\\n\", %s->%s);\n" name typ name
4570         ) cols;
4571         pr "}\n";
4572         pr "\n";
4573   ) ["stat", stat_cols; "statvfs", statvfs_cols];
4574
4575   (* run_<action> actions *)
4576   List.iter (
4577     fun (name, style, _, flags, _, _, _) ->
4578       pr "static int run_%s (const char *cmd, int argc, char *argv[])\n" name;
4579       pr "{\n";
4580       (match fst style with
4581        | RErr
4582        | RInt _
4583        | RBool _ -> pr "  int r;\n"
4584        | RInt64 _ -> pr "  int64_t r;\n"
4585        | RConstString _ -> pr "  const char *r;\n"
4586        | RString _ -> pr "  char *r;\n"
4587        | RStringList _ | RHashtable _ -> pr "  char **r;\n"
4588        | RIntBool _ -> pr "  struct guestfs_int_bool *r;\n"
4589        | RPVList _ -> pr "  struct guestfs_lvm_pv_list *r;\n"
4590        | RVGList _ -> pr "  struct guestfs_lvm_vg_list *r;\n"
4591        | RLVList _ -> pr "  struct guestfs_lvm_lv_list *r;\n"
4592        | RStat _ -> pr "  struct guestfs_stat *r;\n"
4593        | RStatVFS _ -> pr "  struct guestfs_statvfs *r;\n"
4594       );
4595       List.iter (
4596         function
4597         | String n
4598         | OptString n
4599         | FileIn n
4600         | FileOut n -> pr "  const char *%s;\n" n
4601         | StringList n -> pr "  char **%s;\n" n
4602         | Bool n -> pr "  int %s;\n" n
4603         | Int n -> pr "  int %s;\n" n
4604       ) (snd style);
4605
4606       (* Check and convert parameters. *)
4607       let argc_expected = List.length (snd style) in
4608       pr "  if (argc != %d) {\n" argc_expected;
4609       pr "    fprintf (stderr, \"%%s should have %d parameter(s)\\n\", cmd);\n"
4610         argc_expected;
4611       pr "    fprintf (stderr, \"type 'help %%s' for help on %%s\\n\", cmd, cmd);\n";
4612       pr "    return -1;\n";
4613       pr "  }\n";
4614       iteri (
4615         fun i ->
4616           function
4617           | String name -> pr "  %s = argv[%d];\n" name i
4618           | OptString name ->
4619               pr "  %s = strcmp (argv[%d], \"\") != 0 ? argv[%d] : NULL;\n"
4620                 name i i
4621           | FileIn name ->
4622               pr "  %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdin\";\n"
4623                 name i i
4624           | FileOut name ->
4625               pr "  %s = strcmp (argv[%d], \"-\") != 0 ? argv[%d] : \"/dev/stdout\";\n"
4626                 name i i
4627           | StringList name ->
4628               pr "  %s = parse_string_list (argv[%d]);\n" name i
4629           | Bool name ->
4630               pr "  %s = is_true (argv[%d]) ? 1 : 0;\n" name i
4631           | Int name ->
4632               pr "  %s = atoi (argv[%d]);\n" name i
4633       ) (snd style);
4634
4635       (* Call C API function. *)
4636       let fn =
4637         try find_map (function FishAction n -> Some n | _ -> None) flags
4638         with Not_found -> sprintf "guestfs_%s" name in
4639       pr "  r = %s " fn;
4640       generate_call_args ~handle:"g" (snd style);
4641       pr ";\n";
4642
4643       (* Check return value for errors and display command results. *)
4644       (match fst style with
4645        | RErr -> pr "  return r;\n"
4646        | RInt _ ->
4647            pr "  if (r == -1) return -1;\n";
4648            pr "  printf (\"%%d\\n\", r);\n";
4649            pr "  return 0;\n"
4650        | RInt64 _ ->
4651            pr "  if (r == -1) return -1;\n";
4652            pr "  printf (\"%%\" PRIi64 \"\\n\", r);\n";
4653            pr "  return 0;\n"
4654        | RBool _ ->
4655            pr "  if (r == -1) return -1;\n";
4656            pr "  if (r) printf (\"true\\n\"); else printf (\"false\\n\");\n";
4657            pr "  return 0;\n"
4658        | RConstString _ ->
4659            pr "  if (r == NULL) return -1;\n";
4660            pr "  printf (\"%%s\\n\", r);\n";
4661            pr "  return 0;\n"
4662        | RString _ ->
4663            pr "  if (r == NULL) return -1;\n";
4664            pr "  printf (\"%%s\\n\", r);\n";
4665            pr "  free (r);\n";
4666            pr "  return 0;\n"
4667        | RStringList _ ->
4668            pr "  if (r == NULL) return -1;\n";
4669            pr "  print_strings (r);\n";
4670            pr "  free_strings (r);\n";
4671            pr "  return 0;\n"
4672        | RIntBool _ ->
4673            pr "  if (r == NULL) return -1;\n";
4674            pr "  printf (\"%%d, %%s\\n\", r->i,\n";
4675            pr "    r->b ? \"true\" : \"false\");\n";
4676            pr "  guestfs_free_int_bool (r);\n";
4677            pr "  return 0;\n"
4678        | RPVList _ ->
4679            pr "  if (r == NULL) return -1;\n";
4680            pr "  print_pv_list (r);\n";
4681            pr "  guestfs_free_lvm_pv_list (r);\n";
4682            pr "  return 0;\n"
4683        | RVGList _ ->
4684            pr "  if (r == NULL) return -1;\n";
4685            pr "  print_vg_list (r);\n";
4686            pr "  guestfs_free_lvm_vg_list (r);\n";
4687            pr "  return 0;\n"
4688        | RLVList _ ->
4689            pr "  if (r == NULL) return -1;\n";
4690            pr "  print_lv_list (r);\n";
4691            pr "  guestfs_free_lvm_lv_list (r);\n";
4692            pr "  return 0;\n"
4693        | RStat _ ->
4694            pr "  if (r == NULL) return -1;\n";
4695            pr "  print_stat (r);\n";
4696            pr "  free (r);\n";
4697            pr "  return 0;\n"
4698        | RStatVFS _ ->
4699            pr "  if (r == NULL) return -1;\n";
4700            pr "  print_statvfs (r);\n";
4701            pr "  free (r);\n";
4702            pr "  return 0;\n"
4703        | RHashtable _ ->
4704            pr "  if (r == NULL) return -1;\n";
4705            pr "  print_table (r);\n";
4706            pr "  free_strings (r);\n";
4707            pr "  return 0;\n"
4708       );
4709       pr "}\n";
4710       pr "\n"
4711   ) all_functions;
4712
4713   (* run_action function *)
4714   pr "int run_action (const char *cmd, int argc, char *argv[])\n";
4715   pr "{\n";
4716   List.iter (
4717     fun (name, _, _, flags, _, _, _) ->
4718       let name2 = replace_char name '_' '-' in
4719       let alias =
4720         try find_map (function FishAlias n -> Some n | _ -> None) flags
4721         with Not_found -> name in
4722       pr "  if (";
4723       pr "strcasecmp (cmd, \"%s\") == 0" name;
4724       if name <> name2 then
4725         pr " || strcasecmp (cmd, \"%s\") == 0" name2;
4726       if name <> alias then
4727         pr " || strcasecmp (cmd, \"%s\") == 0" alias;
4728       pr ")\n";
4729       pr "    return run_%s (cmd, argc, argv);\n" name;
4730       pr "  else\n";
4731   ) all_functions;
4732   pr "    {\n";
4733   pr "      fprintf (stderr, \"%%s: unknown command\\n\", cmd);\n";
4734   pr "      return -1;\n";
4735   pr "    }\n";
4736   pr "  return 0;\n";
4737   pr "}\n";
4738   pr "\n"
4739
4740 (* Readline completion for guestfish. *)
4741 and generate_fish_completion () =
4742   generate_header CStyle GPLv2;
4743
4744   let all_functions =
4745     List.filter (
4746       fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
4747     ) all_functions in
4748
4749   pr "\
4750 #include <config.h>
4751
4752 #include <stdio.h>
4753 #include <stdlib.h>
4754 #include <string.h>
4755
4756 #ifdef HAVE_LIBREADLINE
4757 #include <readline/readline.h>
4758 #endif
4759
4760 #include \"fish.h\"
4761
4762 #ifdef HAVE_LIBREADLINE
4763
4764 static const char *const commands[] = {
4765   BUILTIN_COMMANDS_FOR_COMPLETION,
4766 ";
4767
4768   (* Get the commands, including the aliases.  They don't need to be
4769    * sorted - the generator() function just does a dumb linear search.
4770    *)
4771   let commands =
4772     List.map (
4773       fun (name, _, _, flags, _, _, _) ->
4774         let name2 = replace_char name '_' '-' in
4775         let alias =
4776           try find_map (function FishAlias n -> Some n | _ -> None) flags
4777           with Not_found -> name in
4778
4779         if name <> alias then [name2; alias] else [name2]
4780     ) all_functions in
4781   let commands = List.flatten commands in
4782
4783   List.iter (pr "  \"%s\",\n") commands;
4784
4785   pr "  NULL
4786 };
4787
4788 static char *
4789 generator (const char *text, int state)
4790 {
4791   static int index, len;
4792   const char *name;
4793
4794   if (!state) {
4795     index = 0;
4796     len = strlen (text);
4797   }
4798
4799   while ((name = commands[index]) != NULL) {
4800     index++;
4801     if (strncasecmp (name, text, len) == 0)
4802       return strdup (name);
4803   }
4804
4805   return NULL;
4806 }
4807
4808 #endif /* HAVE_LIBREADLINE */
4809
4810 char **do_completion (const char *text, int start, int end)
4811 {
4812   char **matches = NULL;
4813
4814 #ifdef HAVE_LIBREADLINE
4815   if (start == 0)
4816     matches = rl_completion_matches (text, generator);
4817 #endif
4818
4819   return matches;
4820 }
4821 ";
4822
4823 (* Generate the POD documentation for guestfish. *)
4824 and generate_fish_actions_pod () =
4825   let all_functions_sorted =
4826     List.filter (
4827       fun (_, _, _, flags, _, _, _) ->
4828         not (List.mem NotInFish flags || List.mem NotInDocs flags)
4829     ) all_functions_sorted in
4830
4831   let rex = Str.regexp "C<guestfs_\\([^>]+\\)>" in
4832
4833   List.iter (
4834     fun (name, style, _, flags, _, _, longdesc) ->
4835       let longdesc =
4836         Str.global_substitute rex (
4837           fun s ->
4838             let sub =
4839               try Str.matched_group 1 s
4840               with Not_found ->
4841                 failwithf "error substituting C<guestfs_...> in longdesc of function %s" name in
4842             "C<" ^ replace_char sub '_' '-' ^ ">"
4843         ) longdesc in
4844       let name = replace_char name '_' '-' in
4845       let alias =
4846         try find_map (function FishAlias n -> Some n | _ -> None) flags
4847         with Not_found -> name in
4848
4849       pr "=head2 %s" name;
4850       if name <> alias then
4851         pr " | %s" alias;
4852       pr "\n";
4853       pr "\n";
4854       pr " %s" name;
4855       List.iter (
4856         function
4857         | String n -> pr " %s" n
4858         | OptString n -> pr " %s" n
4859         | StringList n -> pr " '%s ...'" n
4860         | Bool _ -> pr " true|false"
4861         | Int n -> pr " %s" n
4862         | FileIn n | FileOut n -> pr " (%s|-)" n
4863       ) (snd style);
4864       pr "\n";
4865       pr "\n";
4866       pr "%s\n\n" longdesc;
4867
4868       if List.exists (function FileIn _ | FileOut _ -> true
4869                       | _ -> false) (snd style) then
4870         pr "Use C<-> instead of a filename to read/write from stdin/stdout.\n\n";
4871
4872       if List.mem ProtocolLimitWarning flags then
4873         pr "%s\n\n" protocol_limit_warning;
4874
4875       if List.mem DangerWillRobinson flags then
4876         pr "%s\n\n" danger_will_robinson
4877   ) all_functions_sorted
4878
4879 (* Generate a C function prototype. *)
4880 and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true)
4881     ?(single_line = false) ?(newline = false) ?(in_daemon = false)
4882     ?(prefix = "")
4883     ?handle name style =
4884   if extern then pr "extern ";
4885   if static then pr "static ";
4886   (match fst style with
4887    | RErr -> pr "int "
4888    | RInt _ -> pr "int "
4889    | RInt64 _ -> pr "int64_t "
4890    | RBool _ -> pr "int "
4891    | RConstString _ -> pr "const char *"
4892    | RString _ -> pr "char *"
4893    | RStringList _ | RHashtable _ -> pr "char **"
4894    | RIntBool _ ->
4895        if not in_daemon then pr "struct guestfs_int_bool *"
4896        else pr "guestfs_%s_ret *" name
4897    | RPVList _ ->
4898        if not in_daemon then pr "struct guestfs_lvm_pv_list *"
4899        else pr "guestfs_lvm_int_pv_list *"
4900    | RVGList _ ->
4901        if not in_daemon then pr "struct guestfs_lvm_vg_list *"
4902        else pr "guestfs_lvm_int_vg_list *"
4903    | RLVList _ ->
4904        if not in_daemon then pr "struct guestfs_lvm_lv_list *"
4905        else pr "guestfs_lvm_int_lv_list *"
4906    | RStat _ ->
4907        if not in_daemon then pr "struct guestfs_stat *"
4908        else pr "guestfs_int_stat *"
4909    | RStatVFS _ ->
4910        if not in_daemon then pr "struct guestfs_statvfs *"
4911        else pr "guestfs_int_statvfs *"
4912   );
4913   pr "%s%s (" prefix name;
4914   if handle = None && List.length (snd style) = 0 then
4915     pr "void"
4916   else (
4917     let comma = ref false in
4918     (match handle with
4919      | None -> ()
4920      | Some handle -> pr "guestfs_h *%s" handle; comma := true
4921     );
4922     let next () =
4923       if !comma then (
4924         if single_line then pr ", " else pr ",\n\t\t"
4925       );
4926       comma := true
4927     in
4928     List.iter (
4929       function
4930       | String n
4931       | OptString n ->
4932           next ();
4933           if not in_daemon then pr "const char *%s" n
4934           else pr "char *%s" n
4935       | StringList n ->
4936           next ();
4937           if not in_daemon then pr "char * const* const %s" n
4938           else pr "char **%s" n
4939       | Bool n -> next (); pr "int %s" n
4940       | Int n -> next (); pr "int %s" n
4941       | FileIn n
4942       | FileOut n ->
4943           if not in_daemon then (next (); pr "const char *%s" n)
4944     ) (snd style);
4945   );
4946   pr ")";
4947   if semicolon then pr ";";
4948   if newline then pr "\n"
4949
4950 (* Generate C call arguments, eg "(handle, foo, bar)" *)
4951 and generate_call_args ?handle args =
4952   pr "(";
4953   let comma = ref false in
4954   (match handle with
4955    | None -> ()
4956    | Some handle -> pr "%s" handle; comma := true
4957   );
4958   List.iter (
4959     fun arg ->
4960       if !comma then pr ", ";
4961       comma := true;
4962       pr "%s" (name_of_argt arg)
4963   ) args;
4964   pr ")"
4965
4966 (* Generate the OCaml bindings interface. *)
4967 and generate_ocaml_mli () =
4968   generate_header OCamlStyle LGPLv2;
4969
4970   pr "\
4971 (** For API documentation you should refer to the C API
4972     in the guestfs(3) manual page.  The OCaml API uses almost
4973     exactly the same calls. *)
4974
4975 type t
4976 (** A [guestfs_h] handle. *)
4977
4978 exception Error of string
4979 (** This exception is raised when there is an error. *)
4980
4981 val create : unit -> t
4982
4983 val close : t -> unit
4984 (** Handles are closed by the garbage collector when they become
4985     unreferenced, but callers can also call this in order to
4986     provide predictable cleanup. *)
4987
4988 ";
4989   generate_ocaml_lvm_structure_decls ();
4990
4991   generate_ocaml_stat_structure_decls ();
4992
4993   (* The actions. *)
4994   List.iter (
4995     fun (name, style, _, _, _, shortdesc, _) ->
4996       generate_ocaml_prototype name style;
4997       pr "(** %s *)\n" shortdesc;
4998       pr "\n"
4999   ) all_functions
5000
5001 (* Generate the OCaml bindings implementation. *)
5002 and generate_ocaml_ml () =
5003   generate_header OCamlStyle LGPLv2;
5004
5005   pr "\
5006 type t
5007 exception Error of string
5008 external create : unit -> t = \"ocaml_guestfs_create\"
5009 external close : t -> unit = \"ocaml_guestfs_close\"
5010
5011 let () =
5012   Callback.register_exception \"ocaml_guestfs_error\" (Error \"\")
5013
5014 ";
5015
5016   generate_ocaml_lvm_structure_decls ();
5017
5018   generate_ocaml_stat_structure_decls ();
5019
5020   (* The actions. *)
5021   List.iter (
5022     fun (name, style, _, _, _, shortdesc, _) ->
5023       generate_ocaml_prototype ~is_external:true name style;
5024   ) all_functions
5025
5026 (* Generate the OCaml bindings C implementation. *)
5027 and generate_ocaml_c () =
5028   generate_header CStyle LGPLv2;
5029
5030   pr "\
5031 #include <stdio.h>
5032 #include <stdlib.h>
5033 #include <string.h>
5034
5035 #include <caml/config.h>
5036 #include <caml/alloc.h>
5037 #include <caml/callback.h>
5038 #include <caml/fail.h>
5039 #include <caml/memory.h>
5040 #include <caml/mlvalues.h>
5041 #include <caml/signals.h>
5042
5043 #include <guestfs.h>
5044
5045 #include \"guestfs_c.h\"
5046
5047 /* Copy a hashtable of string pairs into an assoc-list.  We return
5048  * the list in reverse order, but hashtables aren't supposed to be
5049  * ordered anyway.
5050  */
5051 static CAMLprim value
5052 copy_table (char * const * argv)
5053 {
5054   CAMLparam0 ();
5055   CAMLlocal5 (rv, pairv, kv, vv, cons);
5056   int i;
5057
5058   rv = Val_int (0);
5059   for (i = 0; argv[i] != NULL; i += 2) {
5060     kv = caml_copy_string (argv[i]);
5061     vv = caml_copy_string (argv[i+1]);
5062     pairv = caml_alloc (2, 0);
5063     Store_field (pairv, 0, kv);
5064     Store_field (pairv, 1, vv);
5065     cons = caml_alloc (2, 0);
5066     Store_field (cons, 1, rv);
5067     rv = cons;
5068     Store_field (cons, 0, pairv);
5069   }
5070
5071   CAMLreturn (rv);
5072 }
5073
5074 ";
5075
5076   (* LVM struct copy functions. *)
5077   List.iter (
5078     fun (typ, cols) ->
5079       let has_optpercent_col =
5080         List.exists (function (_, `OptPercent) -> true | _ -> false) cols in
5081
5082       pr "static CAMLprim value\n";
5083       pr "copy_lvm_%s (const struct guestfs_lvm_%s *%s)\n" typ typ typ;
5084       pr "{\n";
5085       pr "  CAMLparam0 ();\n";
5086       if has_optpercent_col then
5087         pr "  CAMLlocal3 (rv, v, v2);\n"
5088       else
5089         pr "  CAMLlocal2 (rv, v);\n";
5090       pr "\n";
5091       pr "  rv = caml_alloc (%d, 0);\n" (List.length cols);
5092       iteri (
5093         fun i col ->
5094           (match col with
5095            | name, `String ->
5096                pr "  v = caml_copy_string (%s->%s);\n" typ name
5097            | name, `UUID ->
5098                pr "  v = caml_alloc_string (32);\n";
5099                pr "  memcpy (String_val (v), %s->%s, 32);\n" typ name
5100            | name, `Bytes
5101            | name, `Int ->
5102                pr "  v = caml_copy_int64 (%s->%s);\n" typ name
5103            | name, `OptPercent ->
5104                pr "  if (%s->%s >= 0) { /* Some %s */\n" typ name name;
5105                pr "    v2 = caml_copy_double (%s->%s);\n" typ name;
5106                pr "    v = caml_alloc (1, 0);\n";
5107                pr "    Store_field (v, 0, v2);\n";
5108                pr "  } else /* None */\n";
5109                pr "    v = Val_int (0);\n";
5110           );
5111           pr "  Store_field (rv, %d, v);\n" i
5112       ) cols;
5113       pr "  CAMLreturn (rv);\n";
5114       pr "}\n";
5115       pr "\n";
5116
5117       pr "static CAMLprim value\n";
5118       pr "copy_lvm_%s_list (const struct guestfs_lvm_%s_list *%ss)\n"
5119         typ typ typ;
5120       pr "{\n";
5121       pr "  CAMLparam0 ();\n";
5122       pr "  CAMLlocal2 (rv, v);\n";
5123       pr "  int i;\n";
5124       pr "\n";
5125       pr "  if (%ss->len == 0)\n" typ;
5126       pr "    CAMLreturn (Atom (0));\n";
5127       pr "  else {\n";
5128       pr "    rv = caml_alloc (%ss->len, 0);\n" typ;
5129       pr "    for (i = 0; i < %ss->len; ++i) {\n" typ;
5130       pr "      v = copy_lvm_%s (&%ss->val[i]);\n" typ typ;
5131       pr "      caml_modify (&Field (rv, i), v);\n";
5132       pr "    }\n";
5133       pr "    CAMLreturn (rv);\n";
5134       pr "  }\n";
5135       pr "}\n";
5136       pr "\n";
5137   ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
5138
5139   (* Stat copy functions. *)
5140   List.iter (
5141     fun (typ, cols) ->
5142       pr "static CAMLprim value\n";
5143       pr "copy_%s (const struct guestfs_%s *%s)\n" typ typ typ;
5144       pr "{\n";
5145       pr "  CAMLparam0 ();\n";
5146       pr "  CAMLlocal2 (rv, v);\n";
5147       pr "\n";
5148       pr "  rv = caml_alloc (%d, 0);\n" (List.length cols);
5149       iteri (
5150         fun i col ->
5151           (match col with
5152            | name, `Int ->
5153                pr "  v = caml_copy_int64 (%s->%s);\n" typ name
5154           );
5155           pr "  Store_field (rv, %d, v);\n" i
5156       ) cols;
5157       pr "  CAMLreturn (rv);\n";
5158       pr "}\n";
5159       pr "\n";
5160   ) ["stat", stat_cols; "statvfs", statvfs_cols];
5161
5162   (* The wrappers. *)
5163   List.iter (
5164     fun (name, style, _, _, _, _, _) ->
5165       let params =
5166         "gv" :: List.map (fun arg -> name_of_argt arg ^ "v") (snd style) in
5167
5168       pr "CAMLprim value\n";
5169       pr "ocaml_guestfs_%s (value %s" name (List.hd params);
5170       List.iter (pr ", value %s") (List.tl params);
5171       pr ")\n";
5172       pr "{\n";
5173
5174       (match params with
5175        | [p1; p2; p3; p4; p5] ->
5176            pr "  CAMLparam5 (%s);\n" (String.concat ", " params)
5177        | p1 :: p2 :: p3 :: p4 :: p5 :: rest ->
5178            pr "  CAMLparam5 (%s);\n" (String.concat ", " [p1; p2; p3; p4; p5]);
5179            pr "  CAMLxparam%d (%s);\n"
5180              (List.length rest) (String.concat ", " rest)
5181        | ps ->
5182            pr "  CAMLparam%d (%s);\n" (List.length ps) (String.concat ", " ps)
5183       );
5184       pr "  CAMLlocal1 (rv);\n";
5185       pr "\n";
5186
5187       pr "  guestfs_h *g = Guestfs_val (gv);\n";
5188       pr "  if (g == NULL)\n";
5189       pr "    caml_failwith (\"%s: used handle after closing it\");\n" name;
5190       pr "\n";
5191
5192       List.iter (
5193         function
5194         | String n
5195         | FileIn n
5196         | FileOut n ->
5197             pr "  const char *%s = String_val (%sv);\n" n n
5198         | OptString n ->
5199             pr "  const char *%s =\n" n;
5200             pr "    %sv != Val_int (0) ? String_val (Field (%sv, 0)) : NULL;\n"
5201               n n
5202         | StringList n ->
5203             pr "  char **%s = ocaml_guestfs_strings_val (g, %sv);\n" n n
5204         | Bool n ->
5205             pr "  int %s = Bool_val (%sv);\n" n n
5206         | Int n ->
5207             pr "  int %s = Int_val (%sv);\n" n n
5208       ) (snd style);
5209       let error_code =
5210         match fst style with
5211         | RErr -> pr "  int r;\n"; "-1"
5212         | RInt _ -> pr "  int r;\n"; "-1"
5213         | RInt64 _ -> pr "  int64_t r;\n"; "-1"
5214         | RBool _ -> pr "  int r;\n"; "-1"
5215         | RConstString _ -> pr "  const char *r;\n"; "NULL"
5216         | RString _ -> pr "  char *r;\n"; "NULL"
5217         | RStringList _ ->
5218             pr "  int i;\n";
5219             pr "  char **r;\n";
5220             "NULL"
5221         | RIntBool _ ->
5222             pr "  struct guestfs_int_bool *r;\n"; "NULL"
5223         | RPVList _ ->
5224             pr "  struct guestfs_lvm_pv_list *r;\n"; "NULL"
5225         | RVGList _ ->
5226             pr "  struct guestfs_lvm_vg_list *r;\n"; "NULL"
5227         | RLVList _ ->
5228             pr "  struct guestfs_lvm_lv_list *r;\n"; "NULL"
5229         | RStat _ ->
5230             pr "  struct guestfs_stat *r;\n"; "NULL"
5231         | RStatVFS _ ->
5232             pr "  struct guestfs_statvfs *r;\n"; "NULL"
5233         | RHashtable _ ->
5234             pr "  int i;\n";
5235             pr "  char **r;\n";
5236             "NULL" in
5237       pr "\n";
5238
5239       pr "  caml_enter_blocking_section ();\n";
5240       pr "  r = guestfs_%s " name;
5241       generate_call_args ~handle:"g" (snd style);
5242       pr ";\n";
5243       pr "  caml_leave_blocking_section ();\n";
5244
5245       List.iter (
5246         function
5247         | StringList n ->
5248             pr "  ocaml_guestfs_free_strings (%s);\n" n;
5249         | String _ | OptString _ | Bool _ | Int _ | FileIn _ | FileOut _ -> ()
5250       ) (snd style);
5251
5252       pr "  if (r == %s)\n" error_code;
5253       pr "    ocaml_guestfs_raise_error (g, \"%s\");\n" name;
5254       pr "\n";
5255
5256       (match fst style with
5257        | RErr -> pr "  rv = Val_unit;\n"
5258        | RInt _ -> pr "  rv = Val_int (r);\n"
5259        | RInt64 _ ->
5260            pr "  rv = caml_copy_int64 (r);\n"
5261        | RBool _ -> pr "  rv = Val_bool (r);\n"
5262        | RConstString _ -> pr "  rv = caml_copy_string (r);\n"
5263        | RString _ ->
5264            pr "  rv = caml_copy_string (r);\n";
5265            pr "  free (r);\n"
5266        | RStringList _ ->
5267            pr "  rv = caml_copy_string_array ((const char **) r);\n";
5268            pr "  for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
5269            pr "  free (r);\n"
5270        | RIntBool _ ->
5271            pr "  rv = caml_alloc (2, 0);\n";
5272            pr "  Store_field (rv, 0, Val_int (r->i));\n";
5273            pr "  Store_field (rv, 1, Val_bool (r->b));\n";
5274            pr "  guestfs_free_int_bool (r);\n";
5275        | RPVList _ ->
5276            pr "  rv = copy_lvm_pv_list (r);\n";
5277            pr "  guestfs_free_lvm_pv_list (r);\n";
5278        | RVGList _ ->
5279            pr "  rv = copy_lvm_vg_list (r);\n";
5280            pr "  guestfs_free_lvm_vg_list (r);\n";
5281        | RLVList _ ->
5282            pr "  rv = copy_lvm_lv_list (r);\n";
5283            pr "  guestfs_free_lvm_lv_list (r);\n";
5284        | RStat _ ->
5285            pr "  rv = copy_stat (r);\n";
5286            pr "  free (r);\n";
5287        | RStatVFS _ ->
5288            pr "  rv = copy_statvfs (r);\n";
5289            pr "  free (r);\n";
5290        | RHashtable _ ->
5291            pr "  rv = copy_table (r);\n";
5292            pr "  for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
5293            pr "  free (r);\n";
5294       );
5295
5296       pr "  CAMLreturn (rv);\n";
5297       pr "}\n";
5298       pr "\n";
5299
5300       if List.length params > 5 then (
5301         pr "CAMLprim value\n";
5302         pr "ocaml_guestfs_%s_byte (value *argv, int argn)\n" name;
5303         pr "{\n";
5304         pr "  return ocaml_guestfs_%s (argv[0]" name;
5305         iteri (fun i _ -> pr ", argv[%d]" i) (List.tl params);
5306         pr ");\n";
5307         pr "}\n";
5308         pr "\n"
5309       )
5310   ) all_functions
5311
5312 and generate_ocaml_lvm_structure_decls () =
5313   List.iter (
5314     fun (typ, cols) ->
5315       pr "type lvm_%s = {\n" typ;
5316       List.iter (
5317         function
5318         | name, `String -> pr "  %s : string;\n" name
5319         | name, `UUID -> pr "  %s : string;\n" name
5320         | name, `Bytes -> pr "  %s : int64;\n" name
5321         | name, `Int -> pr "  %s : int64;\n" name
5322         | name, `OptPercent -> pr "  %s : float option;\n" name
5323       ) cols;
5324       pr "}\n";
5325       pr "\n"
5326   ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols]
5327
5328 and generate_ocaml_stat_structure_decls () =
5329   List.iter (
5330     fun (typ, cols) ->
5331       pr "type %s = {\n" typ;
5332       List.iter (
5333         function
5334         | name, `Int -> pr "  %s : int64;\n" name
5335       ) cols;
5336       pr "}\n";
5337       pr "\n"
5338   ) ["stat", stat_cols; "statvfs", statvfs_cols]
5339
5340 and generate_ocaml_prototype ?(is_external = false) name style =
5341   if is_external then pr "external " else pr "val ";
5342   pr "%s : t -> " name;
5343   List.iter (
5344     function
5345     | String _ | FileIn _ | FileOut _ -> pr "string -> "
5346     | OptString _ -> pr "string option -> "
5347     | StringList _ -> pr "string array -> "
5348     | Bool _ -> pr "bool -> "
5349     | Int _ -> pr "int -> "
5350   ) (snd style);
5351   (match fst style with
5352    | RErr -> pr "unit" (* all errors are turned into exceptions *)
5353    | RInt _ -> pr "int"
5354    | RInt64 _ -> pr "int64"
5355    | RBool _ -> pr "bool"
5356    | RConstString _ -> pr "string"
5357    | RString _ -> pr "string"
5358    | RStringList _ -> pr "string array"
5359    | RIntBool _ -> pr "int * bool"
5360    | RPVList _ -> pr "lvm_pv array"
5361    | RVGList _ -> pr "lvm_vg array"
5362    | RLVList _ -> pr "lvm_lv array"
5363    | RStat _ -> pr "stat"
5364    | RStatVFS _ -> pr "statvfs"
5365    | RHashtable _ -> pr "(string * string) list"
5366   );
5367   if is_external then (
5368     pr " = ";
5369     if List.length (snd style) + 1 > 5 then
5370       pr "\"ocaml_guestfs_%s_byte\" " name;
5371     pr "\"ocaml_guestfs_%s\"" name
5372   );
5373   pr "\n"
5374
5375 (* Generate Perl xs code, a sort of crazy variation of C with macros. *)
5376 and generate_perl_xs () =
5377   generate_header CStyle LGPLv2;
5378
5379   pr "\
5380 #include \"EXTERN.h\"
5381 #include \"perl.h\"
5382 #include \"XSUB.h\"
5383
5384 #include <guestfs.h>
5385
5386 #ifndef PRId64
5387 #define PRId64 \"lld\"
5388 #endif
5389
5390 static SV *
5391 my_newSVll(long long val) {
5392 #ifdef USE_64_BIT_ALL
5393   return newSViv(val);
5394 #else
5395   char buf[100];
5396   int len;
5397   len = snprintf(buf, 100, \"%%\" PRId64, val);
5398   return newSVpv(buf, len);
5399 #endif
5400 }
5401
5402 #ifndef PRIu64
5403 #define PRIu64 \"llu\"
5404 #endif
5405
5406 static SV *
5407 my_newSVull(unsigned long long val) {
5408 #ifdef USE_64_BIT_ALL
5409   return newSVuv(val);
5410 #else
5411   char buf[100];
5412   int len;
5413   len = snprintf(buf, 100, \"%%\" PRIu64, val);
5414   return newSVpv(buf, len);
5415 #endif
5416 }
5417
5418 /* http://www.perlmonks.org/?node_id=680842 */
5419 static char **
5420 XS_unpack_charPtrPtr (SV *arg) {
5421   char **ret;
5422   AV *av;
5423   I32 i;
5424
5425   if (!arg || !SvOK (arg) || !SvROK (arg) || SvTYPE (SvRV (arg)) != SVt_PVAV)
5426     croak (\"array reference expected\");
5427
5428   av = (AV *)SvRV (arg);
5429   ret = malloc ((av_len (av) + 1 + 1) * sizeof (char *));
5430   if (!ret)
5431     croak (\"malloc failed\");
5432
5433   for (i = 0; i <= av_len (av); i++) {
5434     SV **elem = av_fetch (av, i, 0);
5435
5436     if (!elem || !*elem)
5437       croak (\"missing element in list\");
5438
5439     ret[i] = SvPV_nolen (*elem);
5440   }
5441
5442   ret[i] = NULL;
5443
5444   return ret;
5445 }
5446
5447 MODULE = Sys::Guestfs  PACKAGE = Sys::Guestfs
5448
5449 PROTOTYPES: ENABLE
5450
5451 guestfs_h *
5452 _create ()
5453    CODE:
5454       RETVAL = guestfs_create ();
5455       if (!RETVAL)
5456         croak (\"could not create guestfs handle\");
5457       guestfs_set_error_handler (RETVAL, NULL, NULL);
5458  OUTPUT:
5459       RETVAL
5460
5461 void
5462 DESTROY (g)
5463       guestfs_h *g;
5464  PPCODE:
5465       guestfs_close (g);
5466
5467 ";
5468
5469   List.iter (
5470     fun (name, style, _, _, _, _, _) ->
5471       (match fst style with
5472        | RErr -> pr "void\n"
5473        | RInt _ -> pr "SV *\n"
5474        | RInt64 _ -> pr "SV *\n"
5475        | RBool _ -> pr "SV *\n"
5476        | RConstString _ -> pr "SV *\n"
5477        | RString _ -> pr "SV *\n"
5478        | RStringList _
5479        | RIntBool _
5480        | RPVList _ | RVGList _ | RLVList _
5481        | RStat _ | RStatVFS _
5482        | RHashtable _ ->
5483            pr "void\n" (* all lists returned implictly on the stack *)
5484       );
5485       (* Call and arguments. *)
5486       pr "%s " name;
5487       generate_call_args ~handle:"g" (snd style);
5488       pr "\n";
5489       pr "      guestfs_h *g;\n";
5490       iteri (
5491         fun i ->
5492           function
5493           | String n | FileIn n | FileOut n -> pr "      char *%s;\n" n
5494           | OptString n ->
5495               (* http://www.perlmonks.org/?node_id=554277
5496                * Note that the implicit handle argument means we have
5497                * to add 1 to the ST(x) operator.
5498                *)
5499               pr "      char *%s = SvOK(ST(%d)) ? SvPV_nolen(ST(%d)) : NULL;\n" n (i+1) (i+1)
5500           | StringList n -> pr "      char **%s;\n" n
5501           | Bool n -> pr "      int %s;\n" n
5502           | Int n -> pr "      int %s;\n" n
5503       ) (snd style);
5504
5505       let do_cleanups () =
5506         List.iter (
5507           function
5508           | String _ | OptString _ | Bool _ | Int _
5509           | FileIn _ | FileOut _ -> ()
5510           | StringList n -> pr "      free (%s);\n" n
5511         ) (snd style)
5512       in
5513
5514       (* Code. *)
5515       (match fst style with
5516        | RErr ->
5517            pr "PREINIT:\n";
5518            pr "      int r;\n";
5519            pr " PPCODE:\n";
5520            pr "      r = guestfs_%s " name;
5521            generate_call_args ~handle:"g" (snd style);
5522            pr ";\n";
5523            do_cleanups ();
5524            pr "      if (r == -1)\n";
5525            pr "        croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5526        | RInt n
5527        | RBool n ->
5528            pr "PREINIT:\n";
5529            pr "      int %s;\n" n;
5530            pr "   CODE:\n";
5531            pr "      %s = guestfs_%s " n name;
5532            generate_call_args ~handle:"g" (snd style);
5533            pr ";\n";
5534            do_cleanups ();
5535            pr "      if (%s == -1)\n" n;
5536            pr "        croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5537            pr "      RETVAL = newSViv (%s);\n" n;
5538            pr " OUTPUT:\n";
5539            pr "      RETVAL\n"
5540        | RInt64 n ->
5541            pr "PREINIT:\n";
5542            pr "      int64_t %s;\n" n;
5543            pr "   CODE:\n";
5544            pr "      %s = guestfs_%s " n name;
5545            generate_call_args ~handle:"g" (snd style);
5546            pr ";\n";
5547            do_cleanups ();
5548            pr "      if (%s == -1)\n" n;
5549            pr "        croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5550            pr "      RETVAL = my_newSVll (%s);\n" n;
5551            pr " OUTPUT:\n";
5552            pr "      RETVAL\n"
5553        | RConstString n ->
5554            pr "PREINIT:\n";
5555            pr "      const char *%s;\n" n;
5556            pr "   CODE:\n";
5557            pr "      %s = guestfs_%s " n name;
5558            generate_call_args ~handle:"g" (snd style);
5559            pr ";\n";
5560            do_cleanups ();
5561            pr "      if (%s == NULL)\n" n;
5562            pr "        croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5563            pr "      RETVAL = newSVpv (%s, 0);\n" n;
5564            pr " OUTPUT:\n";
5565            pr "      RETVAL\n"
5566        | RString n ->
5567            pr "PREINIT:\n";
5568            pr "      char *%s;\n" n;
5569            pr "   CODE:\n";
5570            pr "      %s = guestfs_%s " n name;
5571            generate_call_args ~handle:"g" (snd style);
5572            pr ";\n";
5573            do_cleanups ();
5574            pr "      if (%s == NULL)\n" n;
5575            pr "        croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5576            pr "      RETVAL = newSVpv (%s, 0);\n" n;
5577            pr "      free (%s);\n" n;
5578            pr " OUTPUT:\n";
5579            pr "      RETVAL\n"
5580        | RStringList n | RHashtable n ->
5581            pr "PREINIT:\n";
5582            pr "      char **%s;\n" n;
5583            pr "      int i, n;\n";
5584            pr " PPCODE:\n";
5585            pr "      %s = guestfs_%s " n name;
5586            generate_call_args ~handle:"g" (snd style);
5587            pr ";\n";
5588            do_cleanups ();
5589            pr "      if (%s == NULL)\n" n;
5590            pr "        croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5591            pr "      for (n = 0; %s[n] != NULL; ++n) /**/;\n" n;
5592            pr "      EXTEND (SP, n);\n";
5593            pr "      for (i = 0; i < n; ++i) {\n";
5594            pr "        PUSHs (sv_2mortal (newSVpv (%s[i], 0)));\n" n;
5595            pr "        free (%s[i]);\n" n;
5596            pr "      }\n";
5597            pr "      free (%s);\n" n;
5598        | RIntBool _ ->
5599            pr "PREINIT:\n";
5600            pr "      struct guestfs_int_bool *r;\n";
5601            pr " PPCODE:\n";
5602            pr "      r = guestfs_%s " name;
5603            generate_call_args ~handle:"g" (snd style);
5604            pr ";\n";
5605            do_cleanups ();
5606            pr "      if (r == NULL)\n";
5607            pr "        croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5608            pr "      EXTEND (SP, 2);\n";
5609            pr "      PUSHs (sv_2mortal (newSViv (r->i)));\n";
5610            pr "      PUSHs (sv_2mortal (newSViv (r->b)));\n";
5611            pr "      guestfs_free_int_bool (r);\n";
5612        | RPVList n ->
5613            generate_perl_lvm_code "pv" pv_cols name style n do_cleanups
5614        | RVGList n ->
5615            generate_perl_lvm_code "vg" vg_cols name style n do_cleanups
5616        | RLVList n ->
5617            generate_perl_lvm_code "lv" lv_cols name style n do_cleanups
5618        | RStat n ->
5619            generate_perl_stat_code "stat" stat_cols name style n do_cleanups
5620        | RStatVFS n ->
5621            generate_perl_stat_code
5622              "statvfs" statvfs_cols name style n do_cleanups
5623       );
5624
5625       pr "\n"
5626   ) all_functions
5627
5628 and generate_perl_lvm_code typ cols name style n do_cleanups =
5629   pr "PREINIT:\n";
5630   pr "      struct guestfs_lvm_%s_list *%s;\n" typ n;
5631   pr "      int i;\n";
5632   pr "      HV *hv;\n";
5633   pr " PPCODE:\n";
5634   pr "      %s = guestfs_%s " n name;
5635   generate_call_args ~handle:"g" (snd style);
5636   pr ";\n";
5637   do_cleanups ();
5638   pr "      if (%s == NULL)\n" n;
5639   pr "        croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5640   pr "      EXTEND (SP, %s->len);\n" n;
5641   pr "      for (i = 0; i < %s->len; ++i) {\n" n;
5642   pr "        hv = newHV ();\n";
5643   List.iter (
5644     function
5645     | name, `String ->
5646         pr "        (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 0), 0);\n"
5647           name (String.length name) n name
5648     | name, `UUID ->
5649         pr "        (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 32), 0);\n"
5650           name (String.length name) n name
5651     | name, `Bytes ->
5652         pr "        (void) hv_store (hv, \"%s\", %d, my_newSVull (%s->val[i].%s), 0);\n"
5653           name (String.length name) n name
5654     | name, `Int ->
5655         pr "        (void) hv_store (hv, \"%s\", %d, my_newSVll (%s->val[i].%s), 0);\n"
5656           name (String.length name) n name
5657     | name, `OptPercent ->
5658         pr "        (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
5659           name (String.length name) n name
5660   ) cols;
5661   pr "        PUSHs (sv_2mortal ((SV *) hv));\n";
5662   pr "      }\n";
5663   pr "      guestfs_free_lvm_%s_list (%s);\n" typ n
5664
5665 and generate_perl_stat_code typ cols name style n do_cleanups =
5666   pr "PREINIT:\n";
5667   pr "      struct guestfs_%s *%s;\n" typ n;
5668   pr " PPCODE:\n";
5669   pr "      %s = guestfs_%s " n name;
5670   generate_call_args ~handle:"g" (snd style);
5671   pr ";\n";
5672   do_cleanups ();
5673   pr "      if (%s == NULL)\n" n;
5674   pr "        croak (\"%s: %%s\", guestfs_last_error (g));\n" name;
5675   pr "      EXTEND (SP, %d);\n" (List.length cols);
5676   List.iter (
5677     function
5678     | name, `Int ->
5679         pr "      PUSHs (sv_2mortal (my_newSVll (%s->%s)));\n" n name
5680   ) cols;
5681   pr "      free (%s);\n" n
5682
5683 (* Generate Sys/Guestfs.pm. *)
5684 and generate_perl_pm () =
5685   generate_header HashStyle LGPLv2;
5686
5687   pr "\
5688 =pod
5689
5690 =head1 NAME
5691
5692 Sys::Guestfs - Perl bindings for libguestfs
5693
5694 =head1 SYNOPSIS
5695
5696  use Sys::Guestfs;
5697
5698  my $h = Sys::Guestfs->new ();
5699  $h->add_drive ('guest.img');
5700  $h->launch ();
5701  $h->wait_ready ();
5702  $h->mount ('/dev/sda1', '/');
5703  $h->touch ('/hello');
5704  $h->sync ();
5705
5706 =head1 DESCRIPTION
5707
5708 The C<Sys::Guestfs> module provides a Perl XS binding to the
5709 libguestfs API for examining and modifying virtual machine
5710 disk images.
5711
5712 Amongst the things this is good for: making batch configuration
5713 changes to guests, getting disk used/free statistics (see also:
5714 virt-df), migrating between virtualization systems (see also:
5715 virt-p2v), performing partial backups, performing partial guest
5716 clones, cloning guests and changing registry/UUID/hostname info, and
5717 much else besides.
5718
5719 Libguestfs uses Linux kernel and qemu code, and can access any type of
5720 guest filesystem that Linux and qemu can, including but not limited
5721 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
5722 schemes, qcow, qcow2, vmdk.
5723
5724 Libguestfs provides ways to enumerate guest storage (eg. partitions,
5725 LVs, what filesystem is in each LV, etc.).  It can also run commands
5726 in the context of the guest.  Also you can access filesystems over FTP.
5727
5728 =head1 ERRORS
5729
5730 All errors turn into calls to C<croak> (see L<Carp(3)>).
5731
5732 =head1 METHODS
5733
5734 =over 4
5735
5736 =cut
5737
5738 package Sys::Guestfs;
5739
5740 use strict;
5741 use warnings;
5742
5743 require XSLoader;
5744 XSLoader::load ('Sys::Guestfs');
5745
5746 =item $h = Sys::Guestfs->new ();
5747
5748 Create a new guestfs handle.
5749
5750 =cut
5751
5752 sub new {
5753   my $proto = shift;
5754   my $class = ref ($proto) || $proto;
5755
5756   my $self = Sys::Guestfs::_create ();
5757   bless $self, $class;
5758   return $self;
5759 }
5760
5761 ";
5762
5763   (* Actions.  We only need to print documentation for these as
5764    * they are pulled in from the XS code automatically.
5765    *)
5766   List.iter (
5767     fun (name, style, _, flags, _, _, longdesc) ->
5768       if not (List.mem NotInDocs flags) then (
5769         let longdesc = replace_str longdesc "C<guestfs_" "C<$h-E<gt>" in
5770         pr "=item ";
5771         generate_perl_prototype name style;
5772         pr "\n\n";
5773         pr "%s\n\n" longdesc;
5774         if List.mem ProtocolLimitWarning flags then
5775           pr "%s\n\n" protocol_limit_warning;
5776         if List.mem DangerWillRobinson flags then
5777           pr "%s\n\n" danger_will_robinson
5778       )
5779   ) all_functions_sorted;
5780
5781   (* End of file. *)
5782   pr "\
5783 =cut
5784
5785 1;
5786
5787 =back
5788
5789 =head1 COPYRIGHT
5790
5791 Copyright (C) 2009 Red Hat Inc.
5792
5793 =head1 LICENSE
5794
5795 Please see the file COPYING.LIB for the full license.
5796
5797 =head1 SEE ALSO
5798
5799 L<guestfs(3)>, L<guestfish(1)>.
5800
5801 =cut
5802 "
5803
5804 and generate_perl_prototype name style =
5805   (match fst style with
5806    | RErr -> ()
5807    | RBool n
5808    | RInt n
5809    | RInt64 n
5810    | RConstString n
5811    | RString n -> pr "$%s = " n
5812    | RIntBool (n, m) -> pr "($%s, $%s) = " n m
5813    | RStringList n
5814    | RPVList n
5815    | RVGList n
5816    | RLVList n -> pr "@%s = " n
5817    | RStat n
5818    | RStatVFS n
5819    | RHashtable n -> pr "%%%s = " n
5820   );
5821   pr "$h->%s (" name;
5822   let comma = ref false in
5823   List.iter (
5824     fun arg ->
5825       if !comma then pr ", ";
5826       comma := true;
5827       match arg with
5828       | String n | OptString n | Bool n | Int n | FileIn n | FileOut n ->
5829           pr "$%s" n
5830       | StringList n ->
5831           pr "\\@%s" n
5832   ) (snd style);
5833   pr ");"
5834
5835 (* Generate Python C module. *)
5836 and generate_python_c () =
5837   generate_header CStyle LGPLv2;
5838
5839   pr "\
5840 #include <stdio.h>
5841 #include <stdlib.h>
5842 #include <assert.h>
5843
5844 #include <Python.h>
5845
5846 #include \"guestfs.h\"
5847
5848 typedef struct {
5849   PyObject_HEAD
5850   guestfs_h *g;
5851 } Pyguestfs_Object;
5852
5853 static guestfs_h *
5854 get_handle (PyObject *obj)
5855 {
5856   assert (obj);
5857   assert (obj != Py_None);
5858   return ((Pyguestfs_Object *) obj)->g;
5859 }
5860
5861 static PyObject *
5862 put_handle (guestfs_h *g)
5863 {
5864   assert (g);
5865   return
5866     PyCObject_FromVoidPtrAndDesc ((void *) g, (char *) \"guestfs_h\", NULL);
5867 }
5868
5869 /* This list should be freed (but not the strings) after use. */
5870 static const char **
5871 get_string_list (PyObject *obj)
5872 {
5873   int i, len;
5874   const char **r;
5875
5876   assert (obj);
5877
5878   if (!PyList_Check (obj)) {
5879     PyErr_SetString (PyExc_RuntimeError, \"expecting a list parameter\");
5880     return NULL;
5881   }
5882
5883   len = PyList_Size (obj);
5884   r = malloc (sizeof (char *) * (len+1));
5885   if (r == NULL) {
5886     PyErr_SetString (PyExc_RuntimeError, \"get_string_list: out of memory\");
5887     return NULL;
5888   }
5889
5890   for (i = 0; i < len; ++i)
5891     r[i] = PyString_AsString (PyList_GetItem (obj, i));
5892   r[len] = NULL;
5893
5894   return r;
5895 }
5896
5897 static PyObject *
5898 put_string_list (char * const * const argv)
5899 {
5900   PyObject *list;
5901   int argc, i;
5902
5903   for (argc = 0; argv[argc] != NULL; ++argc)
5904     ;
5905
5906   list = PyList_New (argc);
5907   for (i = 0; i < argc; ++i)
5908     PyList_SetItem (list, i, PyString_FromString (argv[i]));
5909
5910   return list;
5911 }
5912
5913 static PyObject *
5914 put_table (char * const * const argv)
5915 {
5916   PyObject *list, *item;
5917   int argc, i;
5918
5919   for (argc = 0; argv[argc] != NULL; ++argc)
5920     ;
5921
5922   list = PyList_New (argc >> 1);
5923   for (i = 0; i < argc; i += 2) {
5924     item = PyTuple_New (2);
5925     PyTuple_SetItem (item, 0, PyString_FromString (argv[i]));
5926     PyTuple_SetItem (item, 1, PyString_FromString (argv[i+1]));
5927     PyList_SetItem (list, i >> 1, item);
5928   }
5929
5930   return list;
5931 }
5932
5933 static void
5934 free_strings (char **argv)
5935 {
5936   int argc;
5937
5938   for (argc = 0; argv[argc] != NULL; ++argc)
5939     free (argv[argc]);
5940   free (argv);
5941 }
5942
5943 static PyObject *
5944 py_guestfs_create (PyObject *self, PyObject *args)
5945 {
5946   guestfs_h *g;
5947
5948   g = guestfs_create ();
5949   if (g == NULL) {
5950     PyErr_SetString (PyExc_RuntimeError,
5951                      \"guestfs.create: failed to allocate handle\");
5952     return NULL;
5953   }
5954   guestfs_set_error_handler (g, NULL, NULL);
5955   return put_handle (g);
5956 }
5957
5958 static PyObject *
5959 py_guestfs_close (PyObject *self, PyObject *args)
5960 {
5961   PyObject *py_g;
5962   guestfs_h *g;
5963
5964   if (!PyArg_ParseTuple (args, (char *) \"O:guestfs_close\", &py_g))
5965     return NULL;
5966   g = get_handle (py_g);
5967
5968   guestfs_close (g);
5969
5970   Py_INCREF (Py_None);
5971   return Py_None;
5972 }
5973
5974 ";
5975
5976   (* LVM structures, turned into Python dictionaries. *)
5977   List.iter (
5978     fun (typ, cols) ->
5979       pr "static PyObject *\n";
5980       pr "put_lvm_%s (struct guestfs_lvm_%s *%s)\n" typ typ typ;
5981       pr "{\n";
5982       pr "  PyObject *dict;\n";
5983       pr "\n";
5984       pr "  dict = PyDict_New ();\n";
5985       List.iter (
5986         function
5987         | name, `String ->
5988             pr "  PyDict_SetItemString (dict, \"%s\",\n" name;
5989             pr "                        PyString_FromString (%s->%s));\n"
5990               typ name
5991         | name, `UUID ->
5992             pr "  PyDict_SetItemString (dict, \"%s\",\n" name;
5993             pr "                        PyString_FromStringAndSize (%s->%s, 32));\n"
5994               typ name
5995         | name, `Bytes ->
5996             pr "  PyDict_SetItemString (dict, \"%s\",\n" name;
5997             pr "                        PyLong_FromUnsignedLongLong (%s->%s));\n"
5998               typ name
5999         | name, `Int ->
6000             pr "  PyDict_SetItemString (dict, \"%s\",\n" name;
6001             pr "                        PyLong_FromLongLong (%s->%s));\n"
6002               typ name
6003         | name, `OptPercent ->
6004             pr "  if (%s->%s >= 0)\n" typ name;
6005             pr "    PyDict_SetItemString (dict, \"%s\",\n" name;
6006             pr "                          PyFloat_FromDouble ((double) %s->%s));\n"
6007               typ name;
6008             pr "  else {\n";
6009             pr "    Py_INCREF (Py_None);\n";
6010             pr "    PyDict_SetItemString (dict, \"%s\", Py_None);" name;
6011             pr "  }\n"
6012       ) cols;
6013       pr "  return dict;\n";
6014       pr "};\n";
6015       pr "\n";
6016
6017       pr "static PyObject *\n";
6018       pr "put_lvm_%s_list (struct guestfs_lvm_%s_list *%ss)\n" typ typ typ;
6019       pr "{\n";
6020       pr "  PyObject *list;\n";
6021       pr "  int i;\n";
6022       pr "\n";
6023       pr "  list = PyList_New (%ss->len);\n" typ;
6024       pr "  for (i = 0; i < %ss->len; ++i)\n" typ;
6025       pr "    PyList_SetItem (list, i, put_lvm_%s (&%ss->val[i]));\n" typ typ;
6026       pr "  return list;\n";
6027       pr "};\n";
6028       pr "\n"
6029   ) ["pv", pv_cols; "vg", vg_cols; "lv", lv_cols];
6030
6031   (* Stat structures, turned into Python dictionaries. *)
6032   List.iter (
6033     fun (typ, cols) ->
6034       pr "static PyObject *\n";
6035       pr "put_%s (struct guestfs_%s *%s)\n" typ typ typ;
6036       pr "{\n";
6037       pr "  PyObject *dict;\n";
6038       pr "\n";
6039       pr "  dict = PyDict_New ();\n";
6040       List.iter (
6041         function
6042         | name, `Int ->
6043             pr "  PyDict_SetItemString (dict, \"%s\",\n" name;
6044             pr "                        PyLong_FromLongLong (%s->%s));\n"
6045               typ name
6046       ) cols;
6047       pr "  return dict;\n";
6048       pr "};\n";
6049       pr "\n";
6050   ) ["stat", stat_cols; "statvfs", statvfs_cols];
6051
6052   (* Python wrapper functions. *)
6053   List.iter (
6054     fun (name, style, _, _, _, _, _) ->
6055       pr "static PyObject *\n";
6056       pr "py_guestfs_%s (PyObject *self, PyObject *args)\n" name;
6057       pr "{\n";
6058
6059       pr "  PyObject *py_g;\n";
6060       pr "  guestfs_h *g;\n";
6061       pr "  PyObject *py_r;\n";
6062
6063       let error_code =
6064         match fst style with
6065         | RErr | RInt _ | RBool _ -> pr "  int r;\n"; "-1"
6066         | RInt64 _ -> pr "  int64_t r;\n"; "-1"
6067         | RConstString _ -> pr "  const char *r;\n"; "NULL"
6068         | RString _ -> pr "  char *r;\n"; "NULL"
6069         | RStringList _ | RHashtable _ -> pr "  char **r;\n"; "NULL"
6070         | RIntBool _ -> pr "  struct guestfs_int_bool *r;\n"; "NULL"
6071         | RPVList n -> pr "  struct guestfs_lvm_pv_list *r;\n"; "NULL"
6072         | RVGList n -> pr "  struct guestfs_lvm_vg_list *r;\n"; "NULL"
6073         | RLVList n -> pr "  struct guestfs_lvm_lv_list *r;\n"; "NULL"
6074         | RStat n -> pr "  struct guestfs_stat *r;\n"; "NULL"
6075         | RStatVFS n -> pr "  struct guestfs_statvfs *r;\n"; "NULL" in
6076
6077       List.iter (
6078         function
6079         | String n | FileIn n | FileOut n -> pr "  const char *%s;\n" n
6080         | OptString n -> pr "  const char *%s;\n" n
6081         | StringList n ->
6082             pr "  PyObject *py_%s;\n" n;
6083             pr "  const char **%s;\n" n
6084         | Bool n -> pr "  int %s;\n" n
6085         | Int n -> pr "  int %s;\n" n
6086       ) (snd style);
6087
6088       pr "\n";
6089
6090       (* Convert the parameters. *)
6091       pr "  if (!PyArg_ParseTuple (args, (char *) \"O";
6092       List.iter (
6093         function
6094         | String _ | FileIn _ | FileOut _ -> pr "s"
6095         | OptString _ -> pr "z"
6096         | StringList _ -> pr "O"
6097         | Bool _ -> pr "i" (* XXX Python has booleans? *)
6098         | Int _ -> pr "i"
6099       ) (snd style);
6100       pr ":guestfs_%s\",\n" name;
6101       pr "                         &py_g";
6102       List.iter (
6103         function
6104         | String n | FileIn n | FileOut n -> pr ", &%s" n
6105         | OptString n -> pr ", &%s" n
6106         | StringList n -> pr ", &py_%s" n
6107         | Bool n -> pr ", &%s" n
6108         | Int n -> pr ", &%s" n
6109       ) (snd style);
6110
6111       pr "))\n";
6112       pr "    return NULL;\n";
6113
6114       pr "  g = get_handle (py_g);\n";
6115       List.iter (
6116         function
6117         | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
6118         | StringList n ->
6119             pr "  %s = get_string_list (py_%s);\n" n n;
6120             pr "  if (!%s) return NULL;\n" n
6121       ) (snd style);
6122
6123       pr "\n";
6124
6125       pr "  r = guestfs_%s " name;
6126       generate_call_args ~handle:"g" (snd style);
6127       pr ";\n";
6128
6129       List.iter (
6130         function
6131         | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
6132         | StringList n ->
6133             pr "  free (%s);\n" n
6134       ) (snd style);
6135
6136       pr "  if (r == %s) {\n" error_code;
6137       pr "    PyErr_SetString (PyExc_RuntimeError, guestfs_last_error (g));\n";
6138       pr "    return NULL;\n";
6139       pr "  }\n";
6140       pr "\n";
6141
6142       (match fst style with
6143        | RErr ->
6144            pr "  Py_INCREF (Py_None);\n";
6145            pr "  py_r = Py_None;\n"
6146        | RInt _
6147        | RBool _ -> pr "  py_r = PyInt_FromLong ((long) r);\n"
6148        | RInt64 _ -> pr "  py_r = PyLong_FromLongLong (r);\n"
6149        | RConstString _ -> pr "  py_r = PyString_FromString (r);\n"
6150        | RString _ ->
6151            pr "  py_r = PyString_FromString (r);\n";
6152            pr "  free (r);\n"
6153        | RStringList _ ->
6154            pr "  py_r = put_string_list (r);\n";
6155            pr "  free_strings (r);\n"
6156        | RIntBool _ ->
6157            pr "  py_r = PyTuple_New (2);\n";
6158            pr "  PyTuple_SetItem (py_r, 0, PyInt_FromLong ((long) r->i));\n";
6159            pr "  PyTuple_SetItem (py_r, 1, PyInt_FromLong ((long) r->b));\n";
6160            pr "  guestfs_free_int_bool (r);\n"
6161        | RPVList n ->
6162            pr "  py_r = put_lvm_pv_list (r);\n";
6163            pr "  guestfs_free_lvm_pv_list (r);\n"
6164        | RVGList n ->
6165            pr "  py_r = put_lvm_vg_list (r);\n";
6166            pr "  guestfs_free_lvm_vg_list (r);\n"
6167        | RLVList n ->
6168            pr "  py_r = put_lvm_lv_list (r);\n";
6169            pr "  guestfs_free_lvm_lv_list (r);\n"
6170        | RStat n ->
6171            pr "  py_r = put_stat (r);\n";
6172            pr "  free (r);\n"
6173        | RStatVFS n ->
6174            pr "  py_r = put_statvfs (r);\n";
6175            pr "  free (r);\n"
6176        | RHashtable n ->
6177            pr "  py_r = put_table (r);\n";
6178            pr "  free_strings (r);\n"
6179       );
6180
6181       pr "  return py_r;\n";
6182       pr "}\n";
6183       pr "\n"
6184   ) all_functions;
6185
6186   (* Table of functions. *)
6187   pr "static PyMethodDef methods[] = {\n";
6188   pr "  { (char *) \"create\", py_guestfs_create, METH_VARARGS, NULL },\n";
6189   pr "  { (char *) \"close\", py_guestfs_close, METH_VARARGS, NULL },\n";
6190   List.iter (
6191     fun (name, _, _, _, _, _, _) ->
6192       pr "  { (char *) \"%s\", py_guestfs_%s, METH_VARARGS, NULL },\n"
6193         name name
6194   ) all_functions;
6195   pr "  { NULL, NULL, 0, NULL }\n";
6196   pr "};\n";
6197   pr "\n";
6198
6199   (* Init function. *)
6200   pr "\
6201 void
6202 initlibguestfsmod (void)
6203 {
6204   static int initialized = 0;
6205
6206   if (initialized) return;
6207   Py_InitModule ((char *) \"libguestfsmod\", methods);
6208   initialized = 1;
6209 }
6210 "
6211
6212 (* Generate Python module. *)
6213 and generate_python_py () =
6214   generate_header HashStyle LGPLv2;
6215
6216   pr "\
6217 u\"\"\"Python bindings for libguestfs
6218
6219 import guestfs
6220 g = guestfs.GuestFS ()
6221 g.add_drive (\"guest.img\")
6222 g.launch ()
6223 g.wait_ready ()
6224 parts = g.list_partitions ()
6225
6226 The guestfs module provides a Python binding to the libguestfs API
6227 for examining and modifying virtual machine disk images.
6228
6229 Amongst the things this is good for: making batch configuration
6230 changes to guests, getting disk used/free statistics (see also:
6231 virt-df), migrating between virtualization systems (see also:
6232 virt-p2v), performing partial backups, performing partial guest
6233 clones, cloning guests and changing registry/UUID/hostname info, and
6234 much else besides.
6235
6236 Libguestfs uses Linux kernel and qemu code, and can access any type of
6237 guest filesystem that Linux and qemu can, including but not limited
6238 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
6239 schemes, qcow, qcow2, vmdk.
6240
6241 Libguestfs provides ways to enumerate guest storage (eg. partitions,
6242 LVs, what filesystem is in each LV, etc.).  It can also run commands
6243 in the context of the guest.  Also you can access filesystems over FTP.
6244
6245 Errors which happen while using the API are turned into Python
6246 RuntimeError exceptions.
6247
6248 To create a guestfs handle you usually have to perform the following
6249 sequence of calls:
6250
6251 # Create the handle, call add_drive at least once, and possibly
6252 # several times if the guest has multiple block devices:
6253 g = guestfs.GuestFS ()
6254 g.add_drive (\"guest.img\")
6255
6256 # Launch the qemu subprocess and wait for it to become ready:
6257 g.launch ()
6258 g.wait_ready ()
6259
6260 # Now you can issue commands, for example:
6261 logvols = g.lvs ()
6262
6263 \"\"\"
6264
6265 import libguestfsmod
6266
6267 class GuestFS:
6268     \"\"\"Instances of this class are libguestfs API handles.\"\"\"
6269
6270     def __init__ (self):
6271         \"\"\"Create a new libguestfs handle.\"\"\"
6272         self._o = libguestfsmod.create ()
6273
6274     def __del__ (self):
6275         libguestfsmod.close (self._o)
6276
6277 ";
6278
6279   List.iter (
6280     fun (name, style, _, flags, _, _, longdesc) ->
6281       pr "    def %s " name;
6282       generate_call_args ~handle:"self" (snd style);
6283       pr ":\n";
6284
6285       if not (List.mem NotInDocs flags) then (
6286         let doc = replace_str longdesc "C<guestfs_" "C<g." in
6287         let doc =
6288           match fst style with
6289           | RErr | RInt _ | RInt64 _ | RBool _ | RConstString _
6290           | RString _ -> doc
6291           | RStringList _ ->
6292               doc ^ "\n\nThis function returns a list of strings."
6293           | RIntBool _ ->
6294               doc ^ "\n\nThis function returns a tuple (int, bool).\n"
6295           | RPVList _ ->
6296               doc ^ "\n\nThis function returns a list of PVs.  Each PV is represented as a dictionary."
6297           | RVGList _ ->
6298               doc ^ "\n\nThis function returns a list of VGs.  Each VG is represented as a dictionary."
6299           | RLVList _ ->
6300               doc ^ "\n\nThis function returns a list of LVs.  Each LV is represented as a dictionary."
6301           | RStat _ ->
6302               doc ^ "\n\nThis function returns a dictionary, with keys matching the various fields in the stat structure."
6303           | RStatVFS _ ->
6304               doc ^ "\n\nThis function returns a dictionary, with keys matching the various fields in the statvfs structure."
6305           | RHashtable _ ->
6306               doc ^ "\n\nThis function returns a dictionary." in
6307         let doc =
6308           if List.mem ProtocolLimitWarning flags then
6309             doc ^ "\n\n" ^ protocol_limit_warning
6310           else doc in
6311         let doc =
6312           if List.mem DangerWillRobinson flags then
6313             doc ^ "\n\n" ^ danger_will_robinson
6314           else doc in
6315         let doc = pod2text ~width:60 name doc in
6316         let doc = List.map (fun line -> replace_str line "\\" "\\\\") doc in
6317         let doc = String.concat "\n        " doc in
6318         pr "        u\"\"\"%s\"\"\"\n" doc;
6319       );
6320       pr "        return libguestfsmod.%s " name;
6321       generate_call_args ~handle:"self._o" (snd style);
6322       pr "\n";
6323       pr "\n";
6324   ) all_functions
6325
6326 (* Useful if you need the longdesc POD text as plain text.  Returns a
6327  * list of lines.
6328  *
6329  * This is the slowest thing about autogeneration.
6330  *)
6331 and pod2text ~width name longdesc =
6332   let filename, chan = Filename.open_temp_file "gen" ".tmp" in
6333   fprintf chan "=head1 %s\n\n%s\n" name longdesc;
6334   close_out chan;
6335   let cmd = sprintf "pod2text -w %d %s" width (Filename.quote filename) in
6336   let chan = Unix.open_process_in cmd in
6337   let lines = ref [] in
6338   let rec loop i =
6339     let line = input_line chan in
6340     if i = 1 then               (* discard the first line of output *)
6341       loop (i+1)
6342     else (
6343       let line = triml line in
6344       lines := line :: !lines;
6345       loop (i+1)
6346     ) in
6347   let lines = try loop 1 with End_of_file -> List.rev !lines in
6348   Unix.unlink filename;
6349   match Unix.close_process_in chan with
6350   | Unix.WEXITED 0 -> lines
6351   | Unix.WEXITED i ->
6352       failwithf "pod2text: process exited with non-zero status (%d)" i
6353   | Unix.WSIGNALED i | Unix.WSTOPPED i ->
6354       failwithf "pod2text: process signalled or stopped by signal %d" i
6355
6356 (* Generate ruby bindings. *)
6357 and generate_ruby_c () =
6358   generate_header CStyle LGPLv2;
6359
6360   pr "\
6361 #include <stdio.h>
6362 #include <stdlib.h>
6363
6364 #include <ruby.h>
6365
6366 #include \"guestfs.h\"
6367
6368 #include \"extconf.h\"
6369
6370 /* For Ruby < 1.9 */
6371 #ifndef RARRAY_LEN
6372 #define RARRAY_LEN(r) (RARRAY((r))->len)
6373 #endif
6374
6375 static VALUE m_guestfs;                 /* guestfs module */
6376 static VALUE c_guestfs;                 /* guestfs_h handle */
6377 static VALUE e_Error;                   /* used for all errors */
6378
6379 static void ruby_guestfs_free (void *p)
6380 {
6381   if (!p) return;
6382   guestfs_close ((guestfs_h *) p);
6383 }
6384
6385 static VALUE ruby_guestfs_create (VALUE m)
6386 {
6387   guestfs_h *g;
6388
6389   g = guestfs_create ();
6390   if (!g)
6391     rb_raise (e_Error, \"failed to create guestfs handle\");
6392
6393   /* Don't print error messages to stderr by default. */
6394   guestfs_set_error_handler (g, NULL, NULL);
6395
6396   /* Wrap it, and make sure the close function is called when the
6397    * handle goes away.
6398    */
6399   return Data_Wrap_Struct (c_guestfs, NULL, ruby_guestfs_free, g);
6400 }
6401
6402 static VALUE ruby_guestfs_close (VALUE gv)
6403 {
6404   guestfs_h *g;
6405   Data_Get_Struct (gv, guestfs_h, g);
6406
6407   ruby_guestfs_free (g);
6408   DATA_PTR (gv) = NULL;
6409
6410   return Qnil;
6411 }
6412
6413 ";
6414
6415   List.iter (
6416     fun (name, style, _, _, _, _, _) ->
6417       pr "static VALUE ruby_guestfs_%s (VALUE gv" name;
6418       List.iter (fun arg -> pr ", VALUE %sv" (name_of_argt arg)) (snd style);
6419       pr ")\n";
6420       pr "{\n";
6421       pr "  guestfs_h *g;\n";
6422       pr "  Data_Get_Struct (gv, guestfs_h, g);\n";
6423       pr "  if (!g)\n";
6424       pr "    rb_raise (rb_eArgError, \"%%s: used handle after closing it\", \"%s\");\n"
6425         name;
6426       pr "\n";
6427
6428       List.iter (
6429         function
6430         | String n | FileIn n | FileOut n ->
6431             pr "  const char *%s = StringValueCStr (%sv);\n" n n;
6432             pr "  if (!%s)\n" n;
6433             pr "    rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
6434             pr "              \"%s\", \"%s\");\n" n name
6435         | OptString n ->
6436             pr "  const char *%s = !NIL_P (%sv) ? StringValueCStr (%sv) : NULL;\n" n n n
6437         | StringList n ->
6438             pr "  char **%s;" n;
6439             pr "  {\n";
6440             pr "    int i, len;\n";
6441             pr "    len = RARRAY_LEN (%sv);\n" n;
6442             pr "    %s = guestfs_safe_malloc (g, sizeof (char *) * (len+1));\n"
6443               n;
6444             pr "    for (i = 0; i < len; ++i) {\n";
6445             pr "      VALUE v = rb_ary_entry (%sv, i);\n" n;
6446             pr "      %s[i] = StringValueCStr (v);\n" n;
6447             pr "    }\n";
6448             pr "    %s[len] = NULL;\n" n;
6449             pr "  }\n";
6450         | Bool n ->
6451             pr "  int %s = RTEST (%sv);\n" n n
6452         | Int n ->
6453             pr "  int %s = NUM2INT (%sv);\n" n n
6454       ) (snd style);
6455       pr "\n";
6456
6457       let error_code =
6458         match fst style with
6459         | RErr | RInt _ | RBool _ -> pr "  int r;\n"; "-1"
6460         | RInt64 _ -> pr "  int64_t r;\n"; "-1"
6461         | RConstString _ -> pr "  const char *r;\n"; "NULL"
6462         | RString _ -> pr "  char *r;\n"; "NULL"
6463         | RStringList _ | RHashtable _ -> pr "  char **r;\n"; "NULL"
6464         | RIntBool _ -> pr "  struct guestfs_int_bool *r;\n"; "NULL"
6465         | RPVList n -> pr "  struct guestfs_lvm_pv_list *r;\n"; "NULL"
6466         | RVGList n -> pr "  struct guestfs_lvm_vg_list *r;\n"; "NULL"
6467         | RLVList n -> pr "  struct guestfs_lvm_lv_list *r;\n"; "NULL"
6468         | RStat n -> pr "  struct guestfs_stat *r;\n"; "NULL"
6469         | RStatVFS n -> pr "  struct guestfs_statvfs *r;\n"; "NULL" in
6470       pr "\n";
6471
6472       pr "  r = guestfs_%s " name;
6473       generate_call_args ~handle:"g" (snd style);
6474       pr ";\n";
6475
6476       List.iter (
6477         function
6478         | String _ | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ -> ()
6479         | StringList n ->
6480             pr "  free (%s);\n" n
6481       ) (snd style);
6482
6483       pr "  if (r == %s)\n" error_code;
6484       pr "    rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n";
6485       pr "\n";
6486
6487       (match fst style with
6488        | RErr ->
6489            pr "  return Qnil;\n"
6490        | RInt _ | RBool _ ->
6491            pr "  return INT2NUM (r);\n"
6492        | RInt64 _ ->
6493            pr "  return ULL2NUM (r);\n"
6494        | RConstString _ ->
6495            pr "  return rb_str_new2 (r);\n";
6496        | RString _ ->
6497            pr "  VALUE rv = rb_str_new2 (r);\n";
6498            pr "  free (r);\n";
6499            pr "  return rv;\n";
6500        | RStringList _ ->
6501            pr "  int i, len = 0;\n";
6502            pr "  for (i = 0; r[i] != NULL; ++i) len++;\n";
6503            pr "  VALUE rv = rb_ary_new2 (len);\n";
6504            pr "  for (i = 0; r[i] != NULL; ++i) {\n";
6505            pr "    rb_ary_push (rv, rb_str_new2 (r[i]));\n";
6506            pr "    free (r[i]);\n";
6507            pr "  }\n";
6508            pr "  free (r);\n";
6509            pr "  return rv;\n"
6510        | RIntBool _ ->
6511            pr "  VALUE rv = rb_ary_new2 (2);\n";
6512            pr "  rb_ary_push (rv, INT2NUM (r->i));\n";
6513            pr "  rb_ary_push (rv, INT2NUM (r->b));\n";
6514            pr "  guestfs_free_int_bool (r);\n";
6515            pr "  return rv;\n"
6516        | RPVList n ->
6517            generate_ruby_lvm_code "pv" pv_cols
6518        | RVGList n ->
6519            generate_ruby_lvm_code "vg" vg_cols
6520        | RLVList n ->
6521            generate_ruby_lvm_code "lv" lv_cols
6522        | RStat n ->
6523            pr "  VALUE rv = rb_hash_new ();\n";
6524            List.iter (
6525              function
6526              | name, `Int ->
6527                  pr "  rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
6528            ) stat_cols;
6529            pr "  free (r);\n";
6530            pr "  return rv;\n"
6531        | RStatVFS n ->
6532            pr "  VALUE rv = rb_hash_new ();\n";
6533            List.iter (
6534              function
6535              | name, `Int ->
6536                  pr "  rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
6537            ) statvfs_cols;
6538            pr "  free (r);\n";
6539            pr "  return rv;\n"
6540        | RHashtable _ ->
6541            pr "  VALUE rv = rb_hash_new ();\n";
6542            pr "  int i;\n";
6543            pr "  for (i = 0; r[i] != NULL; i+=2) {\n";
6544            pr "    rb_hash_aset (rv, rb_str_new2 (r[i]), rb_str_new2 (r[i+1]));\n";
6545            pr "    free (r[i]);\n";
6546            pr "    free (r[i+1]);\n";
6547            pr "  }\n";
6548            pr "  free (r);\n";
6549            pr "  return rv;\n"
6550       );
6551
6552       pr "}\n";
6553       pr "\n"
6554   ) all_functions;
6555
6556   pr "\
6557 /* Initialize the module. */
6558 void Init__guestfs ()
6559 {
6560   m_guestfs = rb_define_module (\"Guestfs\");
6561   c_guestfs = rb_define_class_under (m_guestfs, \"Guestfs\", rb_cObject);
6562   e_Error = rb_define_class_under (m_guestfs, \"Error\", rb_eStandardError);
6563
6564   rb_define_module_function (m_guestfs, \"create\", ruby_guestfs_create, 0);
6565   rb_define_method (c_guestfs, \"close\", ruby_guestfs_close, 0);
6566
6567 ";
6568   (* Define the rest of the methods. *)
6569   List.iter (
6570     fun (name, style, _, _, _, _, _) ->
6571       pr "  rb_define_method (c_guestfs, \"%s\",\n" name;
6572       pr "        ruby_guestfs_%s, %d);\n" name (List.length (snd style))
6573   ) all_functions;
6574
6575   pr "}\n"
6576
6577 (* Ruby code to return an LVM struct list. *)
6578 and generate_ruby_lvm_code typ cols =
6579   pr "  VALUE rv = rb_ary_new2 (r->len);\n";
6580   pr "  int i;\n";
6581   pr "  for (i = 0; i < r->len; ++i) {\n";
6582   pr "    VALUE hv = rb_hash_new ();\n";
6583   List.iter (
6584     function
6585     | name, `String ->
6586         pr "    rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new2 (r->val[i].%s));\n" name name
6587     | name, `UUID ->
6588         pr "    rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, 32));\n" name name
6589     | name, `Bytes
6590     | name, `Int ->
6591         pr "    rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
6592     | name, `OptPercent ->
6593         pr "    rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_dbl2big (r->val[i].%s));\n" name name
6594   ) cols;
6595   pr "    rb_ary_push (rv, hv);\n";
6596   pr "  }\n";
6597   pr "  guestfs_free_lvm_%s_list (r);\n" typ;
6598   pr "  return rv;\n"
6599
6600 (* Generate Java bindings GuestFS.java file. *)
6601 and generate_java_java () =
6602   generate_header CStyle LGPLv2;
6603
6604   pr "\
6605 package com.redhat.et.libguestfs;
6606
6607 import java.util.HashMap;
6608 import com.redhat.et.libguestfs.LibGuestFSException;
6609 import com.redhat.et.libguestfs.PV;
6610 import com.redhat.et.libguestfs.VG;
6611 import com.redhat.et.libguestfs.LV;
6612 import com.redhat.et.libguestfs.Stat;
6613 import com.redhat.et.libguestfs.StatVFS;
6614 import com.redhat.et.libguestfs.IntBool;
6615
6616 /**
6617  * The GuestFS object is a libguestfs handle.
6618  *
6619  * @author rjones
6620  */
6621 public class GuestFS {
6622   // Load the native code.
6623   static {
6624     System.loadLibrary (\"guestfs_jni\");
6625   }
6626
6627   /**
6628    * The native guestfs_h pointer.
6629    */
6630   long g;
6631
6632   /**
6633    * Create a libguestfs handle.
6634    *
6635    * @throws LibGuestFSException
6636    */
6637   public GuestFS () throws LibGuestFSException
6638   {
6639     g = _create ();
6640   }
6641   private native long _create () throws LibGuestFSException;
6642
6643   /**
6644    * Close a libguestfs handle.
6645    *
6646    * You can also leave handles to be collected by the garbage
6647    * collector, but this method ensures that the resources used
6648    * by the handle are freed up immediately.  If you call any
6649    * other methods after closing the handle, you will get an
6650    * exception.
6651    *
6652    * @throws LibGuestFSException
6653    */
6654   public void close () throws LibGuestFSException
6655   {
6656     if (g != 0)
6657       _close (g);
6658     g = 0;
6659   }
6660   private native void _close (long g) throws LibGuestFSException;
6661
6662   public void finalize () throws LibGuestFSException
6663   {
6664     close ();
6665   }
6666
6667 ";
6668
6669   List.iter (
6670     fun (name, style, _, flags, _, shortdesc, longdesc) ->
6671       if not (List.mem NotInDocs flags); then (
6672         let doc = replace_str longdesc "C<guestfs_" "C<g." in
6673         let doc =
6674           if List.mem ProtocolLimitWarning flags then
6675             doc ^ "\n\n" ^ protocol_limit_warning
6676           else doc in
6677         let doc =
6678           if List.mem DangerWillRobinson flags then
6679             doc ^ "\n\n" ^ danger_will_robinson
6680           else doc in
6681         let doc = pod2text ~width:60 name doc in
6682         let doc = List.map (            (* RHBZ#501883 *)
6683           function
6684           | "" -> "<p>"
6685           | nonempty -> nonempty
6686         ) doc in
6687         let doc = String.concat "\n   * " doc in
6688
6689         pr "  /**\n";
6690         pr "   * %s\n" shortdesc;
6691         pr "   * <p>\n";
6692         pr "   * %s\n" doc;
6693         pr "   * @throws LibGuestFSException\n";
6694         pr "   */\n";
6695         pr "  ";
6696       );
6697       generate_java_prototype ~public:true ~semicolon:false name style;
6698       pr "\n";
6699       pr "  {\n";
6700       pr "    if (g == 0)\n";
6701       pr "      throw new LibGuestFSException (\"%s: handle is closed\");\n"
6702         name;
6703       pr "    ";
6704       if fst style <> RErr then pr "return ";
6705       pr "_%s " name;
6706       generate_call_args ~handle:"g" (snd style);
6707       pr ";\n";
6708       pr "  }\n";
6709       pr "  ";
6710       generate_java_prototype ~privat:true ~native:true name style;
6711       pr "\n";
6712       pr "\n";
6713   ) all_functions;
6714
6715   pr "}\n"
6716
6717 and generate_java_prototype ?(public=false) ?(privat=false) ?(native=false)
6718     ?(semicolon=true) name style =
6719   if privat then pr "private ";
6720   if public then pr "public ";
6721   if native then pr "native ";
6722
6723   (* return type *)
6724   (match fst style with
6725    | RErr -> pr "void ";
6726    | RInt _ -> pr "int ";
6727    | RInt64 _ -> pr "long ";
6728    | RBool _ -> pr "boolean ";
6729    | RConstString _ | RString _ -> pr "String ";
6730    | RStringList _ -> pr "String[] ";
6731    | RIntBool _ -> pr "IntBool ";
6732    | RPVList _ -> pr "PV[] ";
6733    | RVGList _ -> pr "VG[] ";
6734    | RLVList _ -> pr "LV[] ";
6735    | RStat _ -> pr "Stat ";
6736    | RStatVFS _ -> pr "StatVFS ";
6737    | RHashtable _ -> pr "HashMap<String,String> ";
6738   );
6739
6740   if native then pr "_%s " name else pr "%s " name;
6741   pr "(";
6742   let needs_comma = ref false in
6743   if native then (
6744     pr "long g";
6745     needs_comma := true
6746   );
6747
6748   (* args *)
6749   List.iter (
6750     fun arg ->
6751       if !needs_comma then pr ", ";
6752       needs_comma := true;
6753
6754       match arg with
6755       | String n
6756       | OptString n
6757       | FileIn n
6758       | FileOut n ->
6759           pr "String %s" n
6760       | StringList n ->
6761           pr "String[] %s" n
6762       | Bool n ->
6763           pr "boolean %s" n
6764       | Int n ->
6765           pr "int %s" n
6766   ) (snd style);
6767
6768   pr ")\n";
6769   pr "    throws LibGuestFSException";
6770   if semicolon then pr ";"
6771
6772 and generate_java_struct typ cols =
6773   generate_header CStyle LGPLv2;
6774
6775   pr "\
6776 package com.redhat.et.libguestfs;
6777
6778 /**
6779  * Libguestfs %s structure.
6780  *
6781  * @author rjones
6782  * @see GuestFS
6783  */
6784 public class %s {
6785 " typ typ;
6786
6787   List.iter (
6788     function
6789     | name, `String
6790     | name, `UUID -> pr "  public String %s;\n" name
6791     | name, `Bytes
6792     | name, `Int -> pr "  public long %s;\n" name
6793     | name, `OptPercent ->
6794         pr "  /* The next field is [0..100] or -1 meaning 'not present': */\n";
6795         pr "  public float %s;\n" name
6796   ) cols;
6797
6798   pr "}\n"
6799
6800 and generate_java_c () =
6801   generate_header CStyle LGPLv2;
6802
6803   pr "\
6804 #include <stdio.h>
6805 #include <stdlib.h>
6806 #include <string.h>
6807
6808 #include \"com_redhat_et_libguestfs_GuestFS.h\"
6809 #include \"guestfs.h\"
6810
6811 /* Note that this function returns.  The exception is not thrown
6812  * until after the wrapper function returns.
6813  */
6814 static void
6815 throw_exception (JNIEnv *env, const char *msg)
6816 {
6817   jclass cl;
6818   cl = (*env)->FindClass (env,
6819                           \"com/redhat/et/libguestfs/LibGuestFSException\");
6820   (*env)->ThrowNew (env, cl, msg);
6821 }
6822
6823 JNIEXPORT jlong JNICALL
6824 Java_com_redhat_et_libguestfs_GuestFS__1create
6825   (JNIEnv *env, jobject obj)
6826 {
6827   guestfs_h *g;
6828
6829   g = guestfs_create ();
6830   if (g == NULL) {
6831     throw_exception (env, \"GuestFS.create: failed to allocate handle\");
6832     return 0;
6833   }
6834   guestfs_set_error_handler (g, NULL, NULL);
6835   return (jlong) (long) g;
6836 }
6837
6838 JNIEXPORT void JNICALL
6839 Java_com_redhat_et_libguestfs_GuestFS__1close
6840   (JNIEnv *env, jobject obj, jlong jg)
6841 {
6842   guestfs_h *g = (guestfs_h *) (long) jg;
6843   guestfs_close (g);
6844 }
6845
6846 ";
6847
6848   List.iter (
6849     fun (name, style, _, _, _, _, _) ->
6850       pr "JNIEXPORT ";
6851       (match fst style with
6852        | RErr -> pr "void ";
6853        | RInt _ -> pr "jint ";
6854        | RInt64 _ -> pr "jlong ";
6855        | RBool _ -> pr "jboolean ";
6856        | RConstString _ | RString _ -> pr "jstring ";
6857        | RIntBool _ | RStat _ | RStatVFS _ | RHashtable _ ->
6858            pr "jobject ";
6859        | RStringList _ | RPVList _ | RVGList _ | RLVList _ ->
6860            pr "jobjectArray ";
6861       );
6862       pr "JNICALL\n";
6863       pr "Java_com_redhat_et_libguestfs_GuestFS_";
6864       pr "%s" (replace_str ("_" ^ name) "_" "_1");
6865       pr "\n";
6866       pr "  (JNIEnv *env, jobject obj, jlong jg";
6867       List.iter (
6868         function
6869         | String n
6870         | OptString n
6871         | FileIn n
6872         | FileOut n ->
6873             pr ", jstring j%s" n
6874         | StringList n ->
6875             pr ", jobjectArray j%s" n
6876         | Bool n ->
6877             pr ", jboolean j%s" n
6878         | Int n ->
6879             pr ", jint j%s" n
6880       ) (snd style);
6881       pr ")\n";
6882       pr "{\n";
6883       pr "  guestfs_h *g = (guestfs_h *) (long) jg;\n";
6884       let error_code, no_ret =
6885         match fst style with
6886         | RErr -> pr "  int r;\n"; "-1", ""
6887         | RBool _
6888         | RInt _ -> pr "  int r;\n"; "-1", "0"
6889         | RInt64 _ -> pr "  int64_t r;\n"; "-1", "0"
6890         | RConstString _ -> pr "  const char *r;\n"; "NULL", "NULL"
6891         | RString _ ->
6892             pr "  jstring jr;\n";
6893             pr "  char *r;\n"; "NULL", "NULL"
6894         | RStringList _ ->
6895             pr "  jobjectArray jr;\n";
6896             pr "  int r_len;\n";
6897             pr "  jclass cl;\n";
6898             pr "  jstring jstr;\n";
6899             pr "  char **r;\n"; "NULL", "NULL"
6900         | RIntBool _ ->
6901             pr "  jobject jr;\n";
6902             pr "  jclass cl;\n";
6903             pr "  jfieldID fl;\n";
6904             pr "  struct guestfs_int_bool *r;\n"; "NULL", "NULL"
6905         | RStat _ ->
6906             pr "  jobject jr;\n";
6907             pr "  jclass cl;\n";
6908             pr "  jfieldID fl;\n";
6909             pr "  struct guestfs_stat *r;\n"; "NULL", "NULL"
6910         | RStatVFS _ ->
6911             pr "  jobject jr;\n";
6912             pr "  jclass cl;\n";
6913             pr "  jfieldID fl;\n";
6914             pr "  struct guestfs_statvfs *r;\n"; "NULL", "NULL"
6915         | RPVList _ ->
6916             pr "  jobjectArray jr;\n";
6917             pr "  jclass cl;\n";
6918             pr "  jfieldID fl;\n";
6919             pr "  jobject jfl;\n";
6920             pr "  struct guestfs_lvm_pv_list *r;\n"; "NULL", "NULL"
6921         | RVGList _ ->
6922             pr "  jobjectArray jr;\n";
6923             pr "  jclass cl;\n";
6924             pr "  jfieldID fl;\n";
6925             pr "  jobject jfl;\n";
6926             pr "  struct guestfs_lvm_vg_list *r;\n"; "NULL", "NULL"
6927         | RLVList _ ->
6928             pr "  jobjectArray jr;\n";
6929             pr "  jclass cl;\n";
6930             pr "  jfieldID fl;\n";
6931             pr "  jobject jfl;\n";
6932             pr "  struct guestfs_lvm_lv_list *r;\n"; "NULL", "NULL"
6933         | RHashtable _ -> pr "  char **r;\n"; "NULL", "NULL" in
6934       List.iter (
6935         function
6936         | String n
6937         | OptString n
6938         | FileIn n
6939         | FileOut n ->
6940             pr "  const char *%s;\n" n
6941         | StringList n ->
6942             pr "  int %s_len;\n" n;
6943             pr "  const char **%s;\n" n
6944         | Bool n
6945         | Int n ->
6946             pr "  int %s;\n" n
6947       ) (snd style);
6948
6949       let needs_i =
6950         (match fst style with
6951          | RStringList _ | RPVList _ | RVGList _ | RLVList _ -> true
6952          | RErr | RBool _ | RInt _ | RInt64 _ | RConstString _
6953          | RString _ | RIntBool _ | RStat _ | RStatVFS _
6954          | RHashtable _ -> false) ||
6955         List.exists (function StringList _ -> true | _ -> false) (snd style) in
6956       if needs_i then
6957         pr "  int i;\n";
6958
6959       pr "\n";
6960
6961       (* Get the parameters. *)
6962       List.iter (
6963         function
6964         | String n
6965         | FileIn n
6966         | FileOut n ->
6967             pr "  %s = (*env)->GetStringUTFChars (env, j%s, NULL);\n" n n
6968         | OptString n ->
6969             (* This is completely undocumented, but Java null becomes
6970              * a NULL parameter.
6971              *)
6972             pr "  %s = j%s ? (*env)->GetStringUTFChars (env, j%s, NULL) : NULL;\n" n n n
6973         | StringList n ->
6974             pr "  %s_len = (*env)->GetArrayLength (env, j%s);\n" n n;
6975             pr "  %s = guestfs_safe_malloc (g, sizeof (char *) * (%s_len+1));\n" n n;
6976             pr "  for (i = 0; i < %s_len; ++i) {\n" n;
6977             pr "    jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
6978               n;
6979             pr "    %s[i] = (*env)->GetStringUTFChars (env, o, NULL);\n" n;
6980             pr "  }\n";
6981             pr "  %s[%s_len] = NULL;\n" n n;
6982         | Bool n
6983         | Int n ->
6984             pr "  %s = j%s;\n" n n
6985       ) (snd style);
6986
6987       (* Make the call. *)
6988       pr "  r = guestfs_%s " name;
6989       generate_call_args ~handle:"g" (snd style);
6990       pr ";\n";
6991
6992       (* Release the parameters. *)
6993       List.iter (
6994         function
6995         | String n
6996         | FileIn n
6997         | FileOut n ->
6998             pr "  (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
6999         | OptString n ->
7000             pr "  if (j%s)\n" n;
7001             pr "    (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
7002         | StringList n ->
7003             pr "  for (i = 0; i < %s_len; ++i) {\n" n;
7004             pr "    jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
7005               n;
7006             pr "    (*env)->ReleaseStringUTFChars (env, o, %s[i]);\n" n;
7007             pr "  }\n";
7008             pr "  free (%s);\n" n
7009         | Bool n
7010         | Int n -> ()
7011       ) (snd style);
7012
7013       (* Check for errors. *)
7014       pr "  if (r == %s) {\n" error_code;
7015       pr "    throw_exception (env, guestfs_last_error (g));\n";
7016       pr "    return %s;\n" no_ret;
7017       pr "  }\n";
7018
7019       (* Return value. *)
7020       (match fst style with
7021        | RErr -> ()
7022        | RInt _ -> pr "  return (jint) r;\n"
7023        | RBool _ -> pr "  return (jboolean) r;\n"
7024        | RInt64 _ -> pr "  return (jlong) r;\n"
7025        | RConstString _ -> pr "  return (*env)->NewStringUTF (env, r);\n"
7026        | RString _ ->
7027            pr "  jr = (*env)->NewStringUTF (env, r);\n";
7028            pr "  free (r);\n";
7029            pr "  return jr;\n"
7030        | RStringList _ ->
7031            pr "  for (r_len = 0; r[r_len] != NULL; ++r_len) ;\n";
7032            pr "  cl = (*env)->FindClass (env, \"java/lang/String\");\n";
7033            pr "  jstr = (*env)->NewStringUTF (env, \"\");\n";
7034            pr "  jr = (*env)->NewObjectArray (env, r_len, cl, jstr);\n";
7035            pr "  for (i = 0; i < r_len; ++i) {\n";
7036            pr "    jstr = (*env)->NewStringUTF (env, r[i]);\n";
7037            pr "    (*env)->SetObjectArrayElement (env, jr, i, jstr);\n";
7038            pr "    free (r[i]);\n";
7039            pr "  }\n";
7040            pr "  free (r);\n";
7041            pr "  return jr;\n"
7042        | RIntBool _ ->
7043            pr "  cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/IntBool\");\n";
7044            pr "  jr = (*env)->AllocObject (env, cl);\n";
7045            pr "  fl = (*env)->GetFieldID (env, cl, \"i\", \"I\");\n";
7046            pr "  (*env)->SetIntField (env, jr, fl, r->i);\n";
7047            pr "  fl = (*env)->GetFieldID (env, cl, \"i\", \"Z\");\n";
7048            pr "  (*env)->SetBooleanField (env, jr, fl, r->b);\n";
7049            pr "  guestfs_free_int_bool (r);\n";
7050            pr "  return jr;\n"
7051        | RStat _ ->
7052            pr "  cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/Stat\");\n";
7053            pr "  jr = (*env)->AllocObject (env, cl);\n";
7054            List.iter (
7055              function
7056              | name, `Int ->
7057                  pr "  fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n"
7058                    name;
7059                  pr "  (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
7060            ) stat_cols;
7061            pr "  free (r);\n";
7062            pr "  return jr;\n"
7063        | RStatVFS _ ->
7064            pr "  cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/StatVFS\");\n";
7065            pr "  jr = (*env)->AllocObject (env, cl);\n";
7066            List.iter (
7067              function
7068              | name, `Int ->
7069                  pr "  fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n"
7070                    name;
7071                  pr "  (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
7072            ) statvfs_cols;
7073            pr "  free (r);\n";
7074            pr "  return jr;\n"
7075        | RPVList _ ->
7076            generate_java_lvm_return "pv" "PV" pv_cols
7077        | RVGList _ ->
7078            generate_java_lvm_return "vg" "VG" vg_cols
7079        | RLVList _ ->
7080            generate_java_lvm_return "lv" "LV" lv_cols
7081        | RHashtable _ ->
7082            (* XXX *)
7083            pr "  throw_exception (env, \"%s: internal error: please let us know how to make a Java HashMap from JNI bindings!\");\n" name;
7084            pr "  return NULL;\n"
7085       );
7086
7087       pr "}\n";
7088       pr "\n"
7089   ) all_functions
7090
7091 and generate_java_lvm_return typ jtyp cols =
7092   pr "  cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
7093   pr "  jr = (*env)->NewObjectArray (env, r->len, cl, NULL);\n";
7094   pr "  for (i = 0; i < r->len; ++i) {\n";
7095   pr "    jfl = (*env)->AllocObject (env, cl);\n";
7096   List.iter (
7097     function
7098     | name, `String ->
7099         pr "    fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
7100         pr "    (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, r->val[i].%s));\n" name;
7101     | name, `UUID ->
7102         pr "    {\n";
7103         pr "      char s[33];\n";
7104         pr "      memcpy (s, r->val[i].%s, 32);\n" name;
7105         pr "      s[32] = 0;\n";
7106         pr "      fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
7107         pr "      (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
7108         pr "    }\n";
7109     | name, (`Bytes|`Int) ->
7110         pr "    fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
7111         pr "    (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
7112     | name, `OptPercent ->
7113         pr "    fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
7114         pr "    (*env)->SetFloatField (env, jfl, fl, r->val[i].%s);\n" name;
7115   ) cols;
7116   pr "    (*env)->SetObjectArrayElement (env, jfl, i, jfl);\n";
7117   pr "  }\n";
7118   pr "  guestfs_free_lvm_%s_list (r);\n" typ;
7119   pr "  return jr;\n"
7120
7121 and generate_haskell_hs () =
7122   generate_header HaskellStyle LGPLv2;
7123
7124   (* XXX We only know how to generate partial FFI for Haskell
7125    * at the moment.  Please help out!
7126    *)
7127   let can_generate style =
7128     let check_no_bad_args =
7129       List.for_all (function Bool _ | Int _ -> false | _ -> true)
7130     in
7131     match style with
7132     | RErr, args -> check_no_bad_args args
7133     | RBool _, _
7134     | RInt _, _
7135     | RInt64 _, _
7136     | RConstString _, _
7137     | RString _, _
7138     | RStringList _, _
7139     | RIntBool _, _
7140     | RPVList _, _
7141     | RVGList _, _
7142     | RLVList _, _
7143     | RStat _, _
7144     | RStatVFS _, _
7145     | RHashtable _, _ -> false in
7146
7147   pr "\
7148 {-# INCLUDE <guestfs.h> #-}
7149 {-# LANGUAGE ForeignFunctionInterface #-}
7150
7151 module Guestfs (
7152   create";
7153
7154   (* List out the names of the actions we want to export. *)
7155   List.iter (
7156     fun (name, style, _, _, _, _, _) ->
7157       if can_generate style then pr ",\n  %s" name
7158   ) all_functions;
7159
7160   pr "
7161   ) where
7162 import Foreign
7163 import Foreign.C
7164 import IO
7165 import Control.Exception
7166 import Data.Typeable
7167
7168 data GuestfsS = GuestfsS            -- represents the opaque C struct
7169 type GuestfsP = Ptr GuestfsS        -- guestfs_h *
7170 type GuestfsH = ForeignPtr GuestfsS -- guestfs_h * with attached finalizer
7171
7172 -- XXX define properly later XXX
7173 data PV = PV
7174 data VG = VG
7175 data LV = LV
7176 data IntBool = IntBool
7177 data Stat = Stat
7178 data StatVFS = StatVFS
7179 data Hashtable = Hashtable
7180
7181 foreign import ccall unsafe \"guestfs_create\" c_create
7182   :: IO GuestfsP
7183 foreign import ccall unsafe \"&guestfs_close\" c_close
7184   :: FunPtr (GuestfsP -> IO ())
7185 foreign import ccall unsafe \"guestfs_set_error_handler\" c_set_error_handler
7186   :: GuestfsP -> Ptr CInt -> Ptr CInt -> IO ()
7187
7188 create :: IO GuestfsH
7189 create = do
7190   p <- c_create
7191   c_set_error_handler p nullPtr nullPtr
7192   h <- newForeignPtr c_close p
7193   return h
7194
7195 foreign import ccall unsafe \"guestfs_last_error\" c_last_error
7196   :: GuestfsP -> IO CString
7197
7198 -- last_error :: GuestfsH -> IO (Maybe String)
7199 -- last_error h = do
7200 --   str <- withForeignPtr h (\\p -> c_last_error p)
7201 --   maybePeek peekCString str
7202
7203 last_error :: GuestfsH -> IO (String)
7204 last_error h = do
7205   str <- withForeignPtr h (\\p -> c_last_error p)
7206   if (str == nullPtr)
7207     then return \"no error\"
7208     else peekCString str
7209
7210 ";
7211
7212   (* Generate wrappers for each foreign function. *)
7213   List.iter (
7214     fun (name, style, _, _, _, _, _) ->
7215       if can_generate style then (
7216         pr "foreign import ccall unsafe \"guestfs_%s\" c_%s\n" name name;
7217         pr "  :: ";
7218         generate_haskell_prototype ~handle:"GuestfsP" style;
7219         pr "\n";
7220         pr "\n";
7221         pr "%s :: " name;
7222         generate_haskell_prototype ~handle:"GuestfsH" ~hs:true style;
7223         pr "\n";
7224         pr "%s %s = do\n" name
7225           (String.concat " " ("h" :: List.map name_of_argt (snd style)));
7226         pr "  r <- ";
7227         List.iter (
7228           function
7229           | FileIn n
7230           | FileOut n
7231           | String n -> pr "withCString %s $ \\%s -> " n n
7232           | OptString n -> pr "maybeWith withCString %s $ \\%s -> " n n
7233           | StringList n -> pr "withMany withCString %s $ \\%s -> withArray0 nullPtr %s $ \\%s -> " n n n n
7234           | Bool n ->
7235               (* XXX this doesn't work *)
7236               pr "      let\n";
7237               pr "        %s = case %s of\n" n n;
7238               pr "          False -> 0\n";
7239               pr "          True -> 1\n";
7240               pr "      in fromIntegral %s $ \\%s ->\n" n n
7241           | Int n -> pr "fromIntegral %s $ \\%s -> " n n
7242         ) (snd style);
7243         pr "withForeignPtr h (\\p -> c_%s %s)\n" name
7244           (String.concat " " ("p" :: List.map name_of_argt (snd style)));
7245         (match fst style with
7246          | RErr | RInt _ | RInt64 _ | RBool _ ->
7247              pr "  if (r == -1)\n";
7248              pr "    then do\n";
7249              pr "      err <- last_error h\n";
7250              pr "      fail err\n";
7251          | RConstString _ | RString _ | RStringList _ | RIntBool _
7252          | RPVList _ | RVGList _ | RLVList _ | RStat _ | RStatVFS _
7253          | RHashtable _ ->
7254              pr "  if (r == nullPtr)\n";
7255              pr "    then do\n";
7256              pr "      err <- last_error h\n";
7257              pr "      fail err\n";
7258         );
7259         (match fst style with
7260          | RErr ->
7261              pr "    else return ()\n"
7262          | RInt _ ->
7263              pr "    else return (fromIntegral r)\n"
7264          | RInt64 _ ->
7265              pr "    else return (fromIntegral r)\n"
7266          | RBool _ ->
7267              pr "    else return (toBool r)\n"
7268          | RConstString _
7269          | RString _
7270          | RStringList _
7271          | RIntBool _
7272          | RPVList _
7273          | RVGList _
7274          | RLVList _
7275          | RStat _
7276          | RStatVFS _
7277          | RHashtable _ ->
7278              pr "    else return ()\n" (* XXXXXXXXXXXXXXXXXXXX *)
7279         );
7280         pr "\n";
7281       )
7282   ) all_functions
7283
7284 and generate_haskell_prototype ~handle ?(hs = false) style =
7285   pr "%s -> " handle;
7286   let string = if hs then "String" else "CString" in
7287   let int = if hs then "Int" else "CInt" in
7288   let bool = if hs then "Bool" else "CInt" in
7289   let int64 = if hs then "Integer" else "Int64" in
7290   List.iter (
7291     fun arg ->
7292       (match arg with
7293        | String _ -> pr "%s" string
7294        | OptString _ -> if hs then pr "Maybe String" else pr "CString"
7295        | StringList _ -> if hs then pr "[String]" else pr "Ptr CString"
7296        | Bool _ -> pr "%s" bool
7297        | Int _ -> pr "%s" int
7298        | FileIn _ -> pr "%s" string
7299        | FileOut _ -> pr "%s" string
7300       );
7301       pr " -> ";
7302   ) (snd style);
7303   pr "IO (";
7304   (match fst style with
7305    | RErr -> if not hs then pr "CInt"
7306    | RInt _ -> pr "%s" int
7307    | RInt64 _ -> pr "%s" int64
7308    | RBool _ -> pr "%s" bool
7309    | RConstString _ -> pr "%s" string
7310    | RString _ -> pr "%s" string
7311    | RStringList _ -> pr "[%s]" string
7312    | RIntBool _ -> pr "IntBool"
7313    | RPVList _ -> pr "[PV]"
7314    | RVGList _ -> pr "[VG]"
7315    | RLVList _ -> pr "[LV]"
7316    | RStat _ -> pr "Stat"
7317    | RStatVFS _ -> pr "StatVFS"
7318    | RHashtable _ -> pr "Hashtable"
7319   );
7320   pr ")"
7321
7322 and generate_bindtests () =
7323   generate_header CStyle LGPLv2;
7324
7325   pr "\
7326 #include <stdio.h>
7327 #include <stdlib.h>
7328 #include <inttypes.h>
7329 #include <string.h>
7330
7331 #include \"guestfs.h\"
7332 #include \"guestfs_protocol.h\"
7333
7334 #define error guestfs_error
7335
7336 static void
7337 print_strings (char * const* const argv)
7338 {
7339   int argc;
7340
7341   printf (\"[\");
7342   for (argc = 0; argv[argc] != NULL; ++argc) {
7343     if (argc > 0) printf (\", \");
7344     printf (\"\\\"%%s\\\"\", argv[argc]);
7345   }
7346   printf (\"]\\n\");
7347 }
7348
7349 /* The test0 function prints its parameters to stdout. */
7350 ";
7351
7352   let test0, tests =
7353     match test_functions with
7354     | [] -> assert false
7355     | test0 :: tests -> test0, tests in
7356
7357   let () =
7358     let (name, style, _, _, _, _, _) = test0 in
7359     generate_prototype ~extern:false ~semicolon:false ~newline:true
7360       ~handle:"g" ~prefix:"guestfs_" name style;
7361     pr "{\n";
7362     List.iter (
7363       function
7364       | String n
7365       | FileIn n
7366       | FileOut n -> pr "  printf (\"%%s\\n\", %s);\n" n
7367       | OptString n -> pr "  printf (\"%%s\\n\", %s ? %s : \"null\");\n" n n
7368       | StringList n -> pr "  print_strings (%s);\n" n
7369       | Bool n -> pr "  printf (\"%%s\\n\", %s ? \"true\" : \"false\");\n" n
7370       | Int n -> pr "  printf (\"%%d\\n\", %s);\n" n
7371     ) (snd style);
7372     pr "  /* Java changes stdout line buffering so we need this: */\n";
7373     pr "  fflush (stdout);\n";
7374     pr "  return 0;\n";
7375     pr "}\n";
7376     pr "\n" in
7377
7378   List.iter (
7379     fun (name, style, _, _, _, _, _) ->
7380       if String.sub name (String.length name - 3) 3 <> "err" then (
7381         pr "/* Test normal return. */\n";
7382         generate_prototype ~extern:false ~semicolon:false ~newline:true
7383           ~handle:"g" ~prefix:"guestfs_" name style;
7384         pr "{\n";
7385         (match fst style with
7386          | RErr ->
7387              pr "  return 0;\n"
7388          | RInt _ ->
7389              pr "  int r;\n";
7390              pr "  sscanf (val, \"%%d\", &r);\n";
7391              pr "  return r;\n"
7392          | RInt64 _ ->
7393              pr "  int64_t r;\n";
7394              pr "  sscanf (val, \"%%\" SCNi64, &r);\n";
7395              pr "  return r;\n"
7396          | RBool _ ->
7397              pr "  return strcmp (val, \"true\") == 0;\n"
7398          | RConstString _ ->
7399              (* Can't return the input string here.  Return a static
7400               * string so we ensure we get a segfault if the caller
7401               * tries to free it.
7402               *)
7403              pr "  return \"static string\";\n"
7404          | RString _ ->
7405              pr "  return strdup (val);\n"
7406          | RStringList _ ->
7407              pr "  char **strs;\n";
7408              pr "  int n, i;\n";
7409              pr "  sscanf (val, \"%%d\", &n);\n";
7410              pr "  strs = malloc ((n+1) * sizeof (char *));\n";
7411              pr "  for (i = 0; i < n; ++i) {\n";
7412              pr "    strs[i] = malloc (16);\n";
7413              pr "    snprintf (strs[i], 16, \"%%d\", i);\n";
7414              pr "  }\n";
7415              pr "  strs[n] = NULL;\n";
7416              pr "  return strs;\n"
7417          | RIntBool _ ->
7418              pr "  struct guestfs_int_bool *r;\n";
7419              pr "  r = malloc (sizeof (struct guestfs_int_bool));\n";
7420              pr "  sscanf (val, \"%%\" SCNi32, &r->i);\n";
7421              pr "  r->b = 0;\n";
7422              pr "  return r;\n"
7423          | RPVList _ ->
7424              pr "  struct guestfs_lvm_pv_list *r;\n";
7425              pr "  int i;\n";
7426              pr "  r = malloc (sizeof (struct guestfs_lvm_pv_list));\n";
7427              pr "  sscanf (val, \"%%d\", &r->len);\n";
7428              pr "  r->val = calloc (r->len, sizeof (struct guestfs_lvm_pv));\n";
7429              pr "  for (i = 0; i < r->len; ++i) {\n";
7430              pr "    r->val[i].pv_name = malloc (16);\n";
7431              pr "    snprintf (r->val[i].pv_name, 16, \"%%d\", i);\n";
7432              pr "  }\n";
7433              pr "  return r;\n"
7434          | RVGList _ ->
7435              pr "  struct guestfs_lvm_vg_list *r;\n";
7436              pr "  int i;\n";
7437              pr "  r = malloc (sizeof (struct guestfs_lvm_vg_list));\n";
7438              pr "  sscanf (val, \"%%d\", &r->len);\n";
7439              pr "  r->val = calloc (r->len, sizeof (struct guestfs_lvm_vg));\n";
7440              pr "  for (i = 0; i < r->len; ++i) {\n";
7441              pr "    r->val[i].vg_name = malloc (16);\n";
7442              pr "    snprintf (r->val[i].vg_name, 16, \"%%d\", i);\n";
7443              pr "  }\n";
7444              pr "  return r;\n"
7445          | RLVList _ ->
7446              pr "  struct guestfs_lvm_lv_list *r;\n";
7447              pr "  int i;\n";
7448              pr "  r = malloc (sizeof (struct guestfs_lvm_lv_list));\n";
7449              pr "  sscanf (val, \"%%d\", &r->len);\n";
7450              pr "  r->val = calloc (r->len, sizeof (struct guestfs_lvm_lv));\n";
7451              pr "  for (i = 0; i < r->len; ++i) {\n";
7452              pr "    r->val[i].lv_name = malloc (16);\n";
7453              pr "    snprintf (r->val[i].lv_name, 16, \"%%d\", i);\n";
7454              pr "  }\n";
7455              pr "  return r;\n"
7456          | RStat _ ->
7457              pr "  struct guestfs_stat *r;\n";
7458              pr "  r = calloc (1, sizeof (*r));\n";
7459              pr "  sscanf (val, \"%%\" SCNi64, &r->dev);\n";
7460              pr "  return r;\n"
7461          | RStatVFS _ ->
7462              pr "  struct guestfs_statvfs *r;\n";
7463              pr "  r = calloc (1, sizeof (*r));\n";
7464              pr "  sscanf (val, \"%%\" SCNi64, &r->bsize);\n";
7465              pr "  return r;\n"
7466          | RHashtable _ ->
7467              pr "  char **strs;\n";
7468              pr "  int n, i;\n";
7469              pr "  sscanf (val, \"%%d\", &n);\n";
7470              pr "  strs = malloc ((n*2+1) * sizeof (char *));\n";
7471              pr "  for (i = 0; i < n; ++i) {\n";
7472              pr "    strs[i*2] = malloc (16);\n";
7473              pr "    strs[i*2+1] = malloc (16);\n";
7474              pr "    snprintf (strs[i*2], 16, \"%%d\", i);\n";
7475              pr "    snprintf (strs[i*2+1], 16, \"%%d\", i);\n";
7476              pr "  }\n";
7477              pr "  strs[n*2] = NULL;\n";
7478              pr "  return strs;\n"
7479         );
7480         pr "}\n";
7481         pr "\n"
7482       ) else (
7483         pr "/* Test error return. */\n";
7484         generate_prototype ~extern:false ~semicolon:false ~newline:true
7485           ~handle:"g" ~prefix:"guestfs_" name style;
7486         pr "{\n";
7487         pr "  error (g, \"error\");\n";
7488         (match fst style with
7489          | RErr | RInt _ | RInt64 _ | RBool _ ->
7490              pr "  return -1;\n"
7491          | RConstString _
7492          | RString _ | RStringList _ | RIntBool _
7493          | RPVList _ | RVGList _ | RLVList _ | RStat _ | RStatVFS _
7494          | RHashtable _ ->
7495              pr "  return NULL;\n"
7496         );
7497         pr "}\n";
7498         pr "\n"
7499       )
7500   ) tests
7501
7502 and generate_ocaml_bindtests () =
7503   generate_header OCamlStyle GPLv2;
7504
7505   pr "\
7506 let () =
7507   let g = Guestfs.create () in
7508 ";
7509
7510   let mkargs args =
7511     String.concat " " (
7512       List.map (
7513         function
7514         | CallString s -> "\"" ^ s ^ "\""
7515         | CallOptString None -> "None"
7516         | CallOptString (Some s) -> sprintf "(Some \"%s\")" s
7517         | CallStringList xs ->
7518             "[|" ^ String.concat ";" (List.map (sprintf "\"%s\"") xs) ^ "|]"
7519         | CallInt i when i >= 0 -> string_of_int i
7520         | CallInt i (* when i < 0 *) -> "(" ^ string_of_int i ^ ")"
7521         | CallBool b -> string_of_bool b
7522       ) args
7523     )
7524   in
7525
7526   generate_lang_bindtests (
7527     fun f args -> pr "  Guestfs.%s g %s;\n" f (mkargs args)
7528   );
7529
7530   pr "print_endline \"EOF\"\n"
7531
7532 and generate_perl_bindtests () =
7533   pr "#!/usr/bin/perl -w\n";
7534   generate_header HashStyle GPLv2;
7535
7536   pr "\
7537 use strict;
7538
7539 use Sys::Guestfs;
7540
7541 my $g = Sys::Guestfs->new ();
7542 ";
7543
7544   let mkargs args =
7545     String.concat ", " (
7546       List.map (
7547         function
7548         | CallString s -> "\"" ^ s ^ "\""
7549         | CallOptString None -> "undef"
7550         | CallOptString (Some s) -> sprintf "\"%s\"" s
7551         | CallStringList xs ->
7552             "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
7553         | CallInt i -> string_of_int i
7554         | CallBool b -> if b then "1" else "0"
7555       ) args
7556     )
7557   in
7558
7559   generate_lang_bindtests (
7560     fun f args -> pr "$g->%s (%s);\n" f (mkargs args)
7561   );
7562
7563   pr "print \"EOF\\n\"\n"
7564
7565 and generate_python_bindtests () =
7566   generate_header HashStyle GPLv2;
7567
7568   pr "\
7569 import guestfs
7570
7571 g = guestfs.GuestFS ()
7572 ";
7573
7574   let mkargs args =
7575     String.concat ", " (
7576       List.map (
7577         function
7578         | CallString s -> "\"" ^ s ^ "\""
7579         | CallOptString None -> "None"
7580         | CallOptString (Some s) -> sprintf "\"%s\"" s
7581         | CallStringList xs ->
7582             "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
7583         | CallInt i -> string_of_int i
7584         | CallBool b -> if b then "1" else "0"
7585       ) args
7586     )
7587   in
7588
7589   generate_lang_bindtests (
7590     fun f args -> pr "g.%s (%s)\n" f (mkargs args)
7591   );
7592
7593   pr "print \"EOF\"\n"
7594
7595 and generate_ruby_bindtests () =
7596   generate_header HashStyle GPLv2;
7597
7598   pr "\
7599 require 'guestfs'
7600
7601 g = Guestfs::create()
7602 ";
7603
7604   let mkargs args =
7605     String.concat ", " (
7606       List.map (
7607         function
7608         | CallString s -> "\"" ^ s ^ "\""
7609         | CallOptString None -> "nil"
7610         | CallOptString (Some s) -> sprintf "\"%s\"" s
7611         | CallStringList xs ->
7612             "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
7613         | CallInt i -> string_of_int i
7614         | CallBool b -> string_of_bool b
7615       ) args
7616     )
7617   in
7618
7619   generate_lang_bindtests (
7620     fun f args -> pr "g.%s(%s)\n" f (mkargs args)
7621   );
7622
7623   pr "print \"EOF\\n\"\n"
7624
7625 and generate_java_bindtests () =
7626   generate_header CStyle GPLv2;
7627
7628   pr "\
7629 import com.redhat.et.libguestfs.*;
7630
7631 public class Bindtests {
7632     public static void main (String[] argv)
7633     {
7634         try {
7635             GuestFS g = new GuestFS ();
7636 ";
7637
7638   let mkargs args =
7639     String.concat ", " (
7640       List.map (
7641         function
7642         | CallString s -> "\"" ^ s ^ "\""
7643         | CallOptString None -> "null"
7644         | CallOptString (Some s) -> sprintf "\"%s\"" s
7645         | CallStringList xs ->
7646             "new String[]{" ^
7647               String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "}"
7648         | CallInt i -> string_of_int i
7649         | CallBool b -> string_of_bool b
7650       ) args
7651     )
7652   in
7653
7654   generate_lang_bindtests (
7655     fun f args -> pr "            g.%s (%s);\n" f (mkargs args)
7656   );
7657
7658   pr "
7659             System.out.println (\"EOF\");
7660         }
7661         catch (Exception exn) {
7662             System.err.println (exn);
7663             System.exit (1);
7664         }
7665     }
7666 }
7667 "
7668
7669 and generate_haskell_bindtests () =
7670   () (* XXX Haskell bindings need to be fleshed out. *)
7671
7672 (* Language-independent bindings tests - we do it this way to
7673  * ensure there is parity in testing bindings across all languages.
7674  *)
7675 and generate_lang_bindtests call =
7676   call "test0" [CallString "abc"; CallOptString (Some "def");
7677                 CallStringList []; CallBool false;
7678                 CallInt 0; CallString "123"; CallString "456"];
7679   call "test0" [CallString "abc"; CallOptString None;
7680                 CallStringList []; CallBool false;
7681                 CallInt 0; CallString "123"; CallString "456"];
7682   call "test0" [CallString ""; CallOptString (Some "def");
7683                 CallStringList []; CallBool false;
7684                 CallInt 0; CallString "123"; CallString "456"];
7685   call "test0" [CallString ""; CallOptString (Some "");
7686                 CallStringList []; CallBool false;
7687                 CallInt 0; CallString "123"; CallString "456"];
7688   call "test0" [CallString "abc"; CallOptString (Some "def");
7689                 CallStringList ["1"]; CallBool false;
7690                 CallInt 0; CallString "123"; CallString "456"];
7691   call "test0" [CallString "abc"; CallOptString (Some "def");
7692                 CallStringList ["1"; "2"]; CallBool false;
7693                 CallInt 0; CallString "123"; CallString "456"];
7694   call "test0" [CallString "abc"; CallOptString (Some "def");
7695                 CallStringList ["1"]; CallBool true;
7696                 CallInt 0; CallString "123"; CallString "456"];
7697   call "test0" [CallString "abc"; CallOptString (Some "def");
7698                 CallStringList ["1"]; CallBool false;
7699                 CallInt (-1); CallString "123"; CallString "456"];
7700   call "test0" [CallString "abc"; CallOptString (Some "def");
7701                 CallStringList ["1"]; CallBool false;
7702                 CallInt (-2); CallString "123"; CallString "456"];
7703   call "test0" [CallString "abc"; CallOptString (Some "def");
7704                 CallStringList ["1"]; CallBool false;
7705                 CallInt 1; CallString "123"; CallString "456"];
7706   call "test0" [CallString "abc"; CallOptString (Some "def");
7707                 CallStringList ["1"]; CallBool false;
7708                 CallInt 2; CallString "123"; CallString "456"];
7709   call "test0" [CallString "abc"; CallOptString (Some "def");
7710                 CallStringList ["1"]; CallBool false;
7711                 CallInt 4095; CallString "123"; CallString "456"];
7712   call "test0" [CallString "abc"; CallOptString (Some "def");
7713                 CallStringList ["1"]; CallBool false;
7714                 CallInt 0; CallString ""; CallString ""]
7715
7716   (* XXX Add here tests of the return and error functions. *)
7717
7718 let output_to filename =
7719   let filename_new = filename ^ ".new" in
7720   chan := open_out filename_new;
7721   let close () =
7722     close_out !chan;
7723     chan := stdout;
7724
7725     (* Is the new file different from the current file? *)
7726     if Sys.file_exists filename && files_equal filename filename_new then
7727       Unix.unlink filename_new          (* same, so skip it *)
7728     else (
7729       (* different, overwrite old one *)
7730       (try Unix.chmod filename 0o644 with Unix.Unix_error _ -> ());
7731       Unix.rename filename_new filename;
7732       Unix.chmod filename 0o444;
7733       printf "written %s\n%!" filename;
7734     )
7735   in
7736   close
7737
7738 (* Main program. *)
7739 let () =
7740   check_functions ();
7741
7742   if not (Sys.file_exists "configure.ac") then (
7743     eprintf "\
7744 You are probably running this from the wrong directory.
7745 Run it from the top source directory using the command
7746   src/generator.ml
7747 ";
7748     exit 1
7749   );
7750
7751   let close = output_to "src/guestfs_protocol.x" in
7752   generate_xdr ();
7753   close ();
7754
7755   let close = output_to "src/guestfs-structs.h" in
7756   generate_structs_h ();
7757   close ();
7758
7759   let close = output_to "src/guestfs-actions.h" in
7760   generate_actions_h ();
7761   close ();
7762
7763   let close = output_to "src/guestfs-actions.c" in
7764   generate_client_actions ();
7765   close ();
7766
7767   let close = output_to "daemon/actions.h" in
7768   generate_daemon_actions_h ();
7769   close ();
7770
7771   let close = output_to "daemon/stubs.c" in
7772   generate_daemon_actions ();
7773   close ();
7774
7775   let close = output_to "capitests/tests.c" in
7776   generate_tests ();
7777   close ();
7778
7779   let close = output_to "src/guestfs-bindtests.c" in
7780   generate_bindtests ();
7781   close ();
7782
7783   let close = output_to "fish/cmds.c" in
7784   generate_fish_cmds ();
7785   close ();
7786
7787   let close = output_to "fish/completion.c" in
7788   generate_fish_completion ();
7789   close ();
7790
7791   let close = output_to "guestfs-structs.pod" in
7792   generate_structs_pod ();
7793   close ();
7794
7795   let close = output_to "guestfs-actions.pod" in
7796   generate_actions_pod ();
7797   close ();
7798
7799   let close = output_to "guestfish-actions.pod" in
7800   generate_fish_actions_pod ();
7801   close ();
7802
7803   let close = output_to "ocaml/guestfs.mli" in
7804   generate_ocaml_mli ();
7805   close ();
7806
7807   let close = output_to "ocaml/guestfs.ml" in
7808   generate_ocaml_ml ();
7809   close ();
7810
7811   let close = output_to "ocaml/guestfs_c_actions.c" in
7812   generate_ocaml_c ();
7813   close ();
7814
7815   let close = output_to "ocaml/bindtests.ml" in
7816   generate_ocaml_bindtests ();
7817   close ();
7818
7819   let close = output_to "perl/Guestfs.xs" in
7820   generate_perl_xs ();
7821   close ();
7822
7823   let close = output_to "perl/lib/Sys/Guestfs.pm" in
7824   generate_perl_pm ();
7825   close ();
7826
7827   let close = output_to "perl/bindtests.pl" in
7828   generate_perl_bindtests ();
7829   close ();
7830
7831   let close = output_to "python/guestfs-py.c" in
7832   generate_python_c ();
7833   close ();
7834
7835   let close = output_to "python/guestfs.py" in
7836   generate_python_py ();
7837   close ();
7838
7839   let close = output_to "python/bindtests.py" in
7840   generate_python_bindtests ();
7841   close ();
7842
7843   let close = output_to "ruby/ext/guestfs/_guestfs.c" in
7844   generate_ruby_c ();
7845   close ();
7846
7847   let close = output_to "ruby/bindtests.rb" in
7848   generate_ruby_bindtests ();
7849   close ();
7850
7851   let close = output_to "java/com/redhat/et/libguestfs/GuestFS.java" in
7852   generate_java_java ();
7853   close ();
7854
7855   let close = output_to "java/com/redhat/et/libguestfs/PV.java" in
7856   generate_java_struct "PV" pv_cols;
7857   close ();
7858
7859   let close = output_to "java/com/redhat/et/libguestfs/VG.java" in
7860   generate_java_struct "VG" vg_cols;
7861   close ();
7862
7863   let close = output_to "java/com/redhat/et/libguestfs/LV.java" in
7864   generate_java_struct "LV" lv_cols;
7865   close ();
7866
7867   let close = output_to "java/com/redhat/et/libguestfs/Stat.java" in
7868   generate_java_struct "Stat" stat_cols;
7869   close ();
7870
7871   let close = output_to "java/com/redhat/et/libguestfs/StatVFS.java" in
7872   generate_java_struct "StatVFS" statvfs_cols;
7873   close ();
7874
7875   let close = output_to "java/com_redhat_et_libguestfs_GuestFS.c" in
7876   generate_java_c ();
7877   close ();
7878
7879   let close = output_to "java/Bindtests.java" in
7880   generate_java_bindtests ();
7881   close ();
7882
7883   let close = output_to "haskell/Guestfs.hs" in
7884   generate_haskell_hs ();
7885   close ();
7886
7887   let close = output_to "haskell/bindtests.hs" in
7888   generate_haskell_bindtests ();
7889   close ();