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     (* "RStruct" is a function which returns a single named structure
  70      * or an error indication (in C, a struct, and in other languages
  71      * with varying representations, but usually very efficient).  See
  72      * after the function list below for the structures.
  73      *)
  74   | RStruct of string * string          (* name of retval, name of struct *)
  75     (* "RStructList" is a function which returns either a list/array
  76      * of structures (could be zero-length), or an error indication.
  77      *)
  78   | RStructList of string * string      (* name of retval, name of struct *)
  79     (* Key-value pairs of untyped strings.  Turns into a hashtable or
  80      * dictionary in languages which support it.  DON'T use this as a
  81      * general "bucket" for results.  Prefer a stronger typed return
  82      * value if one is available, or write a custom struct.  Don't use
  83      * this if the list could potentially be very long, since it is
  84      * inefficient.  Keys should be unique.  NULLs are not permitted.
  85      *)
  86   | RHashtable of string
  87 (* Not implemented:
  88     (* "RBufferOut" is handled almost exactly like RString, but
  89      * it allows the string to contain arbitrary 8 bit data including
  90      * ASCII NUL.  In the C API this causes an implicit extra parameter
  91      * to be added of type <size_t *size_r>.  Other programming languages
  92      * support strings with arbitrary 8 bit data.  At the RPC layer
  93      * we have to use the opaque<> type instead of string<>.
  94      *)
  95   | RBufferOut of string
  96 *)
  97
  98 and args = argt list    (* Function parameters, guestfs handle is implicit. *)
  99
 100     (* Note in future we should allow a "variable args" parameter as
 101      * the final parameter, to allow commands like
 102      *   chmod mode file [file(s)...]
 103      * This is not implemented yet, but many commands (such as chmod)
 104      * are currently defined with the argument order keeping this future
 105      * possibility in mind.
 106      *)
 107 and argt =
 108   | String of string    (* const char *name, cannot be NULL *)
 109   | OptString of string (* const char *name, may be NULL *)
 110   | StringList of string(* list of strings (each string cannot be NULL) *)
 111   | Bool of string      (* boolean *)
 112   | Int of string       (* int (smallish ints, signed, <= 31 bits) *)
 113     (* These are treated as filenames (simple string parameters) in
 114      * the C API and bindings.  But in the RPC protocol, we transfer
 115      * the actual file content up to or down from the daemon.
 116      * FileIn: local machine -> daemon (in request)
 117      * FileOut: daemon -> local machine (in reply)
 118      * In guestfish (only), the special name "-" means read from
 119      * stdin or write to stdout.
 120      *)
 121   | FileIn of string
 122   | FileOut of string
 123 (* Not implemented:
 124     (* Opaque buffer which can contain arbitrary 8 bit data.
 125      * In the C API, this is expressed as <char *, int> pair.
 126      * Most other languages have a string type which can contain
 127      * ASCII NUL.  We use whatever type is appropriate for each
 128      * language.
 129      * Buffers are limited by the total message size.  To transfer
 130      * large blocks of data, use FileIn/FileOut parameters instead.
 131      * To return an arbitrary buffer, use RBufferOut.
 132      *)
 133   | BufferIn of string
 134 *)
 135
 136 type flags =
 137   | ProtocolLimitWarning  (* display warning about protocol size limits *)
 138   | DangerWillRobinson    (* flags particularly dangerous commands *)
 139   | FishAlias of string   (* provide an alias for this cmd in guestfish *)
 140   | FishAction of string  (* call this function in guestfish *)
 141   | NotInFish             (* do not export via guestfish *)
 142   | NotInDocs             (* do not add this function to documentation *)
 143
 144 let protocol_limit_warning =
 145   "Because of the message protocol, there is a transfer limit
 146 of somewhere between 2MB and 4MB.  To transfer large files you should use
 147 FTP."
 148
 149 let danger_will_robinson =
 150   "B<This command is dangerous.  Without careful use you
 151 can easily destroy all your data>."
 152
 153 (* You can supply zero or as many tests as you want per API call.
 154  *
 155  * Note that the test environment has 3 block devices, of size 500MB,
 156  * 50MB and 10MB (respectively /dev/sda, /dev/sdb, /dev/sdc), and
 157  * a fourth squashfs block device with some known files on it (/dev/sdd).
 158  *
 159  * Note for partitioning purposes, the 500MB device has 1015 cylinders.
 160  * Number of cylinders was 63 for IDE emulated disks with precisely
 161  * the same size.  How exactly this is calculated is a mystery.
 162  *
 163  * The squashfs block device (/dev/sdd) comes from images/test.sqsh.
 164  *
 165  * To be able to run the tests in a reasonable amount of time,
 166  * the virtual machine and block devices are reused between tests.
 167  * So don't try testing kill_subprocess :-x
 168  *
 169  * Between each test we blockdev-setrw, umount-all, lvm-remove-all.
 170  *
 171  * Don't assume anything about the previous contents of the block
 172  * devices.  Use 'Init*' to create some initial scenarios.
 173  *
 174  * You can add a prerequisite clause to any individual test.  This
 175  * is a run-time check, which, if it fails, causes the test to be
 176  * skipped.  Useful if testing a command which might not work on
 177  * all variations of libguestfs builds.  A test that has prerequisite
 178  * of 'Always' is run unconditionally.
 179  *
 180  * In addition, packagers can skip individual tests by setting the
 181  * environment variables:     eg:
 182  *   SKIP_TEST_<CMD>_<NUM>=1  SKIP_TEST_COMMAND_3=1  (skips test #3 of command)
 183  *   SKIP_TEST_<CMD>=1        SKIP_TEST_ZEROFREE=1   (skips all zerofree tests)
 184  *)
 185 type tests = (test_init * test_prereq * test) list
 186 and test =
 187     (* Run the command sequence and just expect nothing to fail. *)
 188   | TestRun of seq
 189     (* Run the command sequence and expect the output of the final
 190      * command to be the string.
 191      *)
 192   | TestOutput of seq * string
 193     (* Run the command sequence and expect the output of the final
 194      * command to be the list of strings.
 195      *)
 196   | TestOutputList of seq * string list
 197     (* Run the command sequence and expect the output of the final
 198      * command to be the list of block devices (could be either
 199      * "/dev/sd.." or "/dev/hd.." form - we don't check the 5th
 200      * character of each string).
 201      *)
 202   | TestOutputListOfDevices of seq * string list
 203     (* Run the command sequence and expect the output of the final
 204      * command to be the integer.
 205      *)
 206   | TestOutputInt of seq * int
 207     (* Run the command sequence and expect the output of the final
 208      * command to be a true value (!= 0 or != NULL).
 209      *)
 210   | TestOutputTrue of seq
 211     (* Run the command sequence and expect the output of the final
 212      * command to be a false value (== 0 or == NULL, but not an error).
 213      *)
 214   | TestOutputFalse of seq
 215     (* Run the command sequence and expect the output of the final
 216      * command to be a list of the given length (but don't care about
 217      * content).
 218      *)
 219   | TestOutputLength of seq * int
 220     (* Run the command sequence and expect the output of the final
 221      * command to be a structure.
 222      *)
 223   | TestOutputStruct of seq * test_field_compare list
 224     (* Run the command sequence and expect the final command (only)
 225      * to fail.
 226      *)
 227   | TestLastFail of seq
 228
 229 and test_field_compare =
 230   | CompareWithInt of string * int
 231   | CompareWithString of string * string
 232   | CompareFieldsIntEq of string * string
 233   | CompareFieldsStrEq of string * string
 234
 235 (* Test prerequisites. *)
 236 and test_prereq =
 237     (* Test always runs. *)
 238   | Always
 239     (* Test is currently disabled - eg. it fails, or it tests some
 240      * unimplemented feature.
 241      *)
 242   | Disabled
 243     (* 'string' is some C code (a function body) that should return
 244      * true or false.  The test will run if the code returns true.
 245      *)
 246   | If of string
 247     (* As for 'If' but the test runs _unless_ the code returns true. *)
 248   | Unless of string
 249
 250 (* Some initial scenarios for testing. *)
 251 and test_init =
 252     (* Do nothing, block devices could contain random stuff including
 253      * LVM PVs, and some filesystems might be mounted.  This is usually
 254      * a bad idea.
 255      *)
 256   | InitNone
 257     (* Block devices are empty and no filesystems are mounted. *)
 258   | InitEmpty
 259     (* /dev/sda contains a single partition /dev/sda1, which is formatted
 260      * as ext2, empty [except for lost+found] and mounted on /.
 261      * /dev/sdb and /dev/sdc may have random content.
 262      * No LVM.
 263      *)
 264   | InitBasicFS
 265     (* /dev/sda:
 266      *   /dev/sda1 (is a PV):
 267      *     /dev/VG/LV (size 8MB):
 268      *       formatted as ext2, empty [except for lost+found], mounted on /
 269      * /dev/sdb and /dev/sdc may have random content.
 270      *)
 271   | InitBasicFSonLVM
 272
 273 (* Sequence of commands for testing. *)
 274 and seq = cmd list
 275 and cmd = string list
 276
 277 (* Note about long descriptions: When referring to another
 278  * action, use the format C<guestfs_other> (ie. the full name of
 279  * the C function).  This will be replaced as appropriate in other
 280  * language bindings.
 281  *
 282  * Apart from that, long descriptions are just perldoc paragraphs.
 283  *)
 284
 285 (* These test functions are used in the language binding tests. *)
 286
 287 let test_all_args = [
 288   String "str";
 289   OptString "optstr";
 290   StringList "strlist";
 291   Bool "b";
 292   Int "integer";
 293   FileIn "filein";
 294   FileOut "fileout";
 295 ]
 296
 297 let test_all_rets = [
 298   (* except for RErr, which is tested thoroughly elsewhere *)
 299   "test0rint",         RInt "valout";
 300   "test0rint64",       RInt64 "valout";
 301   "test0rbool",        RBool "valout";
 302   "test0rconststring", RConstString "valout";
 303   "test0rstring",      RString "valout";
 304   "test0rstringlist",  RStringList "valout";
 305   "test0rstruct",      RStruct ("valout", "lvm_pv");
 306   "test0rstructlist",  RStructList ("valout", "lvm_pv");
 307   "test0rhashtable",   RHashtable "valout";
 308 ]
 309
 310 let test_functions = [
 311   ("test0", (RErr, test_all_args), -1, [NotInFish; NotInDocs],
 312    [],
 313    "internal test function - do not use",
 314    "\
 315 This is an internal test function which is used to test whether
 316 the automatically generated bindings can handle every possible
 317 parameter type correctly.
 318
 319 It echos the contents of each parameter to stdout.
 320
 321 You probably don't want to call this function.");
 322 ] @ List.flatten (
 323   List.map (
 324     fun (name, ret) ->
 325       [(name, (ret, [String "val"]), -1, [NotInFish; NotInDocs],
 326         [],
 327         "internal test function - do not use",
 328         "\
 329 This is an internal test function which is used to test whether
 330 the automatically generated bindings can handle every possible
 331 return type correctly.
 332
 333 It converts string C<val> to the return type.
 334
 335 You probably don't want to call this function.");
 336        (name ^ "err", (ret, []), -1, [NotInFish; NotInDocs],
 337         [],
 338         "internal test function - do not use",
 339         "\
 340 This is an internal test function which is used to test whether
 341 the automatically generated bindings can handle every possible
 342 return type correctly.
 343
 344 This function always returns an error.
 345
 346 You probably don't want to call this function.")]
 347   ) test_all_rets
 348 )
 349
 350 (* non_daemon_functions are any functions which don't get processed
 351  * in the daemon, eg. functions for setting and getting local
 352  * configuration values.
 353  *)
 354
 355 let non_daemon_functions = test_functions @ [
 356   ("launch", (RErr, []), -1, [FishAlias "run"; FishAction "launch"],
 357    [],
 358    "launch the qemu subprocess",
 359    "\
 360 Internally libguestfs is implemented by running a virtual machine
 361 using L<qemu(1)>.
 362
 363 You should call this after configuring the handle
 364 (eg. adding drives) but before performing any actions.");
 365
 366   ("wait_ready", (RErr, []), -1, [NotInFish],
 367    [],
 368    "wait until the qemu subprocess launches",
 369    "\
 370 Internally libguestfs is implemented by running a virtual machine
 371 using L<qemu(1)>.
 372
 373 You should call this after C<guestfs_launch> to wait for the launch
 374 to complete.");
 375
 376   ("kill_subprocess", (RErr, []), -1, [],
 377    [],
 378    "kill the qemu subprocess",
 379    "\
 380 This kills the qemu subprocess.  You should never need to call this.");
 381
 382   ("add_drive", (RErr, [String "filename"]), -1, [FishAlias "add"],
 383    [],
 384    "add an image to examine or modify",
 385    "\
 386 This function adds a virtual machine disk image C<filename> to the
 387 guest.  The first time you call this function, the disk appears as IDE
 388 disk 0 (C</dev/sda>) in the guest, the second time as C</dev/sdb>, and
 389 so on.
 390
 391 You don't necessarily need to be root when using libguestfs.  However
 392 you obviously do need sufficient permissions to access the filename
 393 for whatever operations you want to perform (ie. read access if you
 394 just want to read the image or write access if you want to modify the
 395 image).
 396
 397 This is equivalent to the qemu parameter
 398 C<-drive file=filename,cache=off,if=...>.
 399
 400 Note that this call checks for the existence of C<filename>.  This
 401 stops you from specifying other types of drive which are supported
 402 by qemu such as C<nbd:> and C<http:> URLs.  To specify those, use
 403 the general C<guestfs_config> call instead.");
 404
 405   ("add_cdrom", (RErr, [String "filename"]), -1, [FishAlias "cdrom"],
 406    [],
 407    "add a CD-ROM disk image to examine",
 408    "\
 409 This function adds a virtual CD-ROM disk image to the guest.
 410
 411 This is equivalent to the qemu parameter C<-cdrom filename>.
 412
 413 Note that this call checks for the existence of C<filename>.  This
 414 stops you from specifying other types of drive which are supported
 415 by qemu such as C<nbd:> and C<http:> URLs.  To specify those, use
 416 the general C<guestfs_config> call instead.");
 417
 418   ("add_drive_ro", (RErr, [String "filename"]), -1, [FishAlias "add-ro"],
 419    [],
 420    "add a drive in snapshot mode (read-only)",
 421    "\
 422 This adds a drive in snapshot mode, making it effectively
 423 read-only.
 424
 425 Note that writes to the device are allowed, and will be seen for
 426 the duration of the guestfs handle, but they are written
 427 to a temporary file which is discarded as soon as the guestfs
 428 handle is closed.  We don't currently have any method to enable
 429 changes to be committed, although qemu can support this.
 430
 431 This is equivalent to the qemu parameter
 432 C<-drive file=filename,snapshot=on,if=...>.
 433
 434 Note that this call checks for the existence of C<filename>.  This
 435 stops you from specifying other types of drive which are supported
 436 by qemu such as C<nbd:> and C<http:> URLs.  To specify those, use
 437 the general C<guestfs_config> call instead.");
 438
 439   ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"]), -1, [],
 440    [],
 441    "add qemu parameters",
 442    "\
 443 This can be used to add arbitrary qemu command line parameters
 444 of the form C<-param value>.  Actually it's not quite arbitrary - we
 445 prevent you from setting some parameters which would interfere with
 446 parameters that we use.
 447
 448 The first character of C<param> string must be a C<-> (dash).
 449
 450 C<value> can be NULL.");
 451
 452   ("set_qemu", (RErr, [String "qemu"]), -1, [FishAlias "qemu"],
 453    [],
 454    "set the qemu binary",
 455    "\
 456 Set the qemu binary that we will use.
 457
 458 The default is chosen when the library was compiled by the
 459 configure script.
 460
 461 You can also override this by setting the C<LIBGUESTFS_QEMU>
 462 environment variable.
 463
 464 Setting C<qemu> to C<NULL> restores the default qemu binary.");
 465
 466   ("get_qemu", (RConstString "qemu", []), -1, [],
 467    [],
 468    "get the qemu binary",
 469    "\
 470 Return the current qemu binary.
 471
 472 This is always non-NULL.  If it wasn't set already, then this will
 473 return the default qemu binary name.");
 474
 475   ("set_path", (RErr, [String "path"]), -1, [FishAlias "path"],
 476    [],
 477    "set the search path",
 478    "\
 479 Set the path that libguestfs searches for kernel and initrd.img.
 480
 481 The default is C<$libdir/guestfs> unless overridden by setting
 482 C<LIBGUESTFS_PATH> environment variable.
 483
 484 Setting C<path> to C<NULL> restores the default path.");
 485
 486   ("get_path", (RConstString "path", []), -1, [],
 487    [],
 488    "get the search path",
 489    "\
 490 Return the current search path.
 491
 492 This is always non-NULL.  If it wasn't set already, then this will
 493 return the default path.");
 494
 495   ("set_append", (RErr, [String "append"]), -1, [FishAlias "append"],
 496    [],
 497    "add options to kernel command line",
 498    "\
 499 This function is used to add additional options to the
 500 guest kernel command line.
 501
 502 The default is C<NULL> unless overridden by setting
 503 C<LIBGUESTFS_APPEND> environment variable.
 504
 505 Setting C<append> to C<NULL> means I<no> additional options
 506 are passed (libguestfs always adds a few of its own).");
 507
 508   ("get_append", (RConstString "append", []), -1, [],
 509    [],
 510    "get the additional kernel options",
 511    "\
 512 Return the additional kernel options which are added to the
 513 guest kernel command line.
 514
 515 If C<NULL> then no options are added.");
 516
 517   ("set_autosync", (RErr, [Bool "autosync"]), -1, [FishAlias "autosync"],
 518    [],
 519    "set autosync mode",
 520    "\
 521 If C<autosync> is true, this enables autosync.  Libguestfs will make a
 522 best effort attempt to run C<guestfs_umount_all> followed by
 523 C<guestfs_sync> when the handle is closed
 524 (also if the program exits without closing handles).
 525
 526 This is disabled by default (except in guestfish where it is
 527 enabled by default).");
 528
 529   ("get_autosync", (RBool "autosync", []), -1, [],
 530    [],
 531    "get autosync mode",
 532    "\
 533 Get the autosync flag.");
 534
 535   ("set_verbose", (RErr, [Bool "verbose"]), -1, [FishAlias "verbose"],
 536    [],
 537    "set verbose mode",
 538    "\
 539 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
 540
 541 Verbose messages are disabled unless the environment variable
 542 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.");
 543
 544   ("get_verbose", (RBool "verbose", []), -1, [],
 545    [],
 546    "get verbose mode",
 547    "\
 548 This returns the verbose messages flag.");
 549
 550   ("is_ready", (RBool "ready", []), -1, [],
 551    [],
 552    "is ready to accept commands",
 553    "\
 554 This returns true iff this handle is ready to accept commands
 555 (in the C<READY> state).
 556
 557 For more information on states, see L<guestfs(3)>.");
 558
 559   ("is_config", (RBool "config", []), -1, [],
 560    [],
 561    "is in configuration state",
 562    "\
 563 This returns true iff this handle is being configured
 564 (in the C<CONFIG> state).
 565
 566 For more information on states, see L<guestfs(3)>.");
 567
 568   ("is_launching", (RBool "launching", []), -1, [],
 569    [],
 570    "is launching subprocess",
 571    "\
 572 This returns true iff this handle is launching the subprocess
 573 (in the C<LAUNCHING> state).
 574
 575 For more information on states, see L<guestfs(3)>.");
 576
 577   ("is_busy", (RBool "busy", []), -1, [],
 578    [],
 579    "is busy processing a command",
 580    "\
 581 This returns true iff this handle is busy processing a command
 582 (in the C<BUSY> state).
 583
 584 For more information on states, see L<guestfs(3)>.");
 585
 586   ("get_state", (RInt "state", []), -1, [],
 587    [],
 588    "get the current state",
 589    "\
 590 This returns the current state as an opaque integer.  This is
 591 only useful for printing debug and internal error messages.
 592
 593 For more information on states, see L<guestfs(3)>.");
 594
 595   ("set_busy", (RErr, []), -1, [NotInFish],
 596    [],
 597    "set state to busy",
 598    "\
 599 This sets the state to C<BUSY>.  This is only used when implementing
 600 actions using the low-level API.
 601
 602 For more information on states, see L<guestfs(3)>.");
 603
 604   ("set_ready", (RErr, []), -1, [NotInFish],
 605    [],
 606    "set state to ready",
 607    "\
 608 This sets the state to C<READY>.  This is only used when implementing
 609 actions using the low-level API.
 610
 611 For more information on states, see L<guestfs(3)>.");
 612
 613   ("end_busy", (RErr, []), -1, [NotInFish],
 614    [],
 615    "leave the busy state",
 616    "\
 617 This sets the state to C<READY>, or if in C<CONFIG> then it leaves the
 618 state as is.  This is only used when implementing
 619 actions using the low-level API.
 620
 621 For more information on states, see L<guestfs(3)>.");
 622
 623   ("set_memsize", (RErr, [Int "memsize"]), -1, [FishAlias "memsize"],
 624    [],
 625    "set memory allocated to the qemu subprocess",
 626    "\
 627 This sets the memory size in megabytes allocated to the
 628 qemu subprocess.  This only has any effect if called before
 629 C<guestfs_launch>.
 630
 631 You can also change this by setting the environment
 632 variable C<LIBGUESTFS_MEMSIZE> before the handle is
 633 created.
 634
 635 For more information on the architecture of libguestfs,
 636 see L<guestfs(3)>.");
 637
 638   ("get_memsize", (RInt "memsize", []), -1, [],
 639    [],
 640    "get memory allocated to the qemu subprocess",
 641    "\
 642 This gets the memory size in megabytes allocated to the
 643 qemu subprocess.
 644
 645 If C<guestfs_set_memsize> was not called
 646 on this handle, and if C<LIBGUESTFS_MEMSIZE> was not set,
 647 then this returns the compiled-in default value for memsize.
 648
 649 For more information on the architecture of libguestfs,
 650 see L<guestfs(3)>.");
 651
 652   ("get_pid", (RInt "pid", []), -1, [FishAlias "pid"],
 653    [],
 654    "get PID of qemu subprocess",
 655    "\
 656 Return the process ID of the qemu subprocess.  If there is no
 657 qemu subprocess, then this will return an error.
 658
 659 This is an internal call used for debugging and testing.");
 660
 661   ("version", (RStruct ("version", "version"), []), -1, [],
 662    [InitNone, Always, TestOutputStruct (
 663       [["version"]], [CompareWithInt ("major", 1)])],
 664    "get the library version number",
 665    "\
 666 Return the libguestfs version number that the program is linked
 667 against.
 668
 669 Note that because of dynamic linking this is not necessarily
 670 the version of libguestfs that you compiled against.  You can
 671 compile the program, and then at runtime dynamically link
 672 against a completely different C<libguestfs.so> library.
 673
 674 This call was added in version C<1.0.58>.  In previous
 675 versions of libguestfs there was no way to get the version
 676 number.  From C code you can use ELF weak linking tricks to find out if
 677 this symbol exists (if it doesn't, then it's an earlier version).
 678
 679 The call returns a structure with four elements.  The first
 680 three (C<major>, C<minor> and C<release>) are numbers and
 681 correspond to the usual version triplet.  The fourth element
 682 (C<extra>) is a string and is normally empty, but may be
 683 used for distro-specific information.
 684
 685 To construct the original version string:
 686 C<$major.$minor.$release$extra>
 687
 688 I<Note:> Don't use this call to test for availability
 689 of features.  Distro backports makes this unreliable.");
 690
 691 ]
 692
 693 (* daemon_functions are any functions which cause some action
 694  * to take place in the daemon.
 695  *)
 696
 697 let daemon_functions = [
 698   ("mount", (RErr, [String "device"; String "mountpoint"]), 1, [],
 699    [InitEmpty, Always, TestOutput (
 700       [["sfdiskM"; "/dev/sda"; ","];
 701        ["mkfs"; "ext2"; "/dev/sda1"];
 702        ["mount"; "/dev/sda1"; "/"];
 703        ["write_file"; "/new"; "new file contents"; "0"];
 704        ["cat"; "/new"]], "new file contents")],
 705    "mount a guest disk at a position in the filesystem",
 706    "\
 707 Mount a guest disk at a position in the filesystem.  Block devices
 708 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
 709 the guest.  If those block devices contain partitions, they will have
 710 the usual names (eg. C</dev/sda1>).  Also LVM C</dev/VG/LV>-style
 711 names can be used.
 712
 713 The rules are the same as for L<mount(2)>:  A filesystem must
 714 first be mounted on C</> before others can be mounted.  Other
 715 filesystems can only be mounted on directories which already
 716 exist.
 717
 718 The mounted filesystem is writable, if we have sufficient permissions
 719 on the underlying device.
 720
 721 The filesystem options C<sync> and C<noatime> are set with this
 722 call, in order to improve reliability.");
 723
 724   ("sync", (RErr, []), 2, [],
 725    [ InitEmpty, Always, TestRun [["sync"]]],
 726    "sync disks, writes are flushed through to the disk image",
 727    "\
 728 This syncs the disk, so that any writes are flushed through to the
 729 underlying disk image.
 730
 731 You should always call this if you have modified a disk image, before
 732 closing the handle.");
 733
 734   ("touch", (RErr, [String "path"]), 3, [],
 735    [InitBasicFS, Always, TestOutputTrue (
 736       [["touch"; "/new"];
 737        ["exists"; "/new"]])],
 738    "update file timestamps or create a new file",
 739    "\
 740 Touch acts like the L<touch(1)> command.  It can be used to
 741 update the timestamps on a file, or, if the file does not exist,
 742 to create a new zero-length file.");
 743
 744   ("cat", (RString "content", [String "path"]), 4, [ProtocolLimitWarning],
 745    [InitBasicFS, Always, TestOutput (
 746       [["write_file"; "/new"; "new file contents"; "0"];
 747        ["cat"; "/new"]], "new file contents")],
 748    "list the contents of a file",
 749    "\
 750 Return the contents of the file named C<path>.
 751
 752 Note that this function cannot correctly handle binary files
 753 (specifically, files containing C<\\0> character which is treated
 754 as end of string).  For those you need to use the C<guestfs_download>
 755 function which has a more complex interface.");
 756
 757   ("ll", (RString "listing", [String "directory"]), 5, [],
 758    [], (* XXX Tricky to test because it depends on the exact format
 759         * of the 'ls -l' command, which changes between F10 and F11.
 760         *)
 761    "list the files in a directory (long format)",
 762    "\
 763 List the files in C<directory> (relative to the root directory,
 764 there is no cwd) in the format of 'ls -la'.
 765
 766 This command is mostly useful for interactive sessions.  It
 767 is I<not> intended that you try to parse the output string.");
 768
 769   ("ls", (RStringList "listing", [String "directory"]), 6, [],
 770    [InitBasicFS, Always, TestOutputList (
 771       [["touch"; "/new"];
 772        ["touch"; "/newer"];
 773        ["touch"; "/newest"];
 774        ["ls"; "/"]], ["lost+found"; "new"; "newer"; "newest"])],
 775    "list the files in a directory",
 776    "\
 777 List the files in C<directory> (relative to the root directory,
 778 there is no cwd).  The '.' and '..' entries are not returned, but
 779 hidden files are shown.
 780
 781 This command is mostly useful for interactive sessions.  Programs
 782 should probably use C<guestfs_readdir> instead.");
 783
 784   ("list_devices", (RStringList "devices", []), 7, [],
 785    [InitEmpty, Always, TestOutputListOfDevices (
 786       [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
 787    "list the block devices",
 788    "\
 789 List all the block devices.
 790
 791 The full block device names are returned, eg. C</dev/sda>");
 792
 793   ("list_partitions", (RStringList "partitions", []), 8, [],
 794    [InitBasicFS, Always, TestOutputListOfDevices (
 795       [["list_partitions"]], ["/dev/sda1"]);
 796     InitEmpty, Always, TestOutputListOfDevices (
 797       [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
 798        ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
 799    "list the partitions",
 800    "\
 801 List all the partitions detected on all block devices.
 802
 803 The full partition device names are returned, eg. C</dev/sda1>
 804
 805 This does not return logical volumes.  For that you will need to
 806 call C<guestfs_lvs>.");
 807
 808   ("pvs", (RStringList "physvols", []), 9, [],
 809    [InitBasicFSonLVM, Always, TestOutputListOfDevices (
 810       [["pvs"]], ["/dev/sda1"]);
 811     InitEmpty, Always, TestOutputListOfDevices (
 812       [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
 813        ["pvcreate"; "/dev/sda1"];
 814        ["pvcreate"; "/dev/sda2"];
 815        ["pvcreate"; "/dev/sda3"];
 816        ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
 817    "list the LVM physical volumes (PVs)",
 818    "\
 819 List all the physical volumes detected.  This is the equivalent
 820 of the L<pvs(8)> command.
 821
 822 This returns a list of just the device names that contain
 823 PVs (eg. C</dev/sda2>).
 824
 825 See also C<guestfs_pvs_full>.");
 826
 827   ("vgs", (RStringList "volgroups", []), 10, [],
 828    [InitBasicFSonLVM, Always, TestOutputList (
 829       [["vgs"]], ["VG"]);
 830     InitEmpty, Always, TestOutputList (
 831       [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
 832        ["pvcreate"; "/dev/sda1"];
 833        ["pvcreate"; "/dev/sda2"];
 834        ["pvcreate"; "/dev/sda3"];
 835        ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
 836        ["vgcreate"; "VG2"; "/dev/sda3"];
 837        ["vgs"]], ["VG1"; "VG2"])],
 838    "list the LVM volume groups (VGs)",
 839    "\
 840 List all the volumes groups detected.  This is the equivalent
 841 of the L<vgs(8)> command.
 842
 843 This returns a list of just the volume group names that were
 844 detected (eg. C<VolGroup00>).
 845
 846 See also C<guestfs_vgs_full>.");
 847
 848   ("lvs", (RStringList "logvols", []), 11, [],
 849    [InitBasicFSonLVM, Always, TestOutputList (
 850       [["lvs"]], ["/dev/VG/LV"]);
 851     InitEmpty, Always, TestOutputList (
 852       [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
 853        ["pvcreate"; "/dev/sda1"];
 854        ["pvcreate"; "/dev/sda2"];
 855        ["pvcreate"; "/dev/sda3"];
 856        ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
 857        ["vgcreate"; "VG2"; "/dev/sda3"];
 858        ["lvcreate"; "LV1"; "VG1"; "50"];
 859        ["lvcreate"; "LV2"; "VG1"; "50"];
 860        ["lvcreate"; "LV3"; "VG2"; "50"];
 861        ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
 862    "list the LVM logical volumes (LVs)",
 863    "\
 864 List all the logical volumes detected.  This is the equivalent
 865 of the L<lvs(8)> command.
 866
 867 This returns a list of the logical volume device names
 868 (eg. C</dev/VolGroup00/LogVol00>).
 869
 870 See also C<guestfs_lvs_full>.");
 871
 872   ("pvs_full", (RStructList ("physvols", "lvm_pv"), []), 12, [],
 873    [], (* XXX how to test? *)
 874    "list the LVM physical volumes (PVs)",
 875    "\
 876 List all the physical volumes detected.  This is the equivalent
 877 of the L<pvs(8)> command.  The \"full\" version includes all fields.");
 878
 879   ("vgs_full", (RStructList ("volgroups", "lvm_vg"), []), 13, [],
 880    [], (* XXX how to test? *)
 881    "list the LVM volume groups (VGs)",
 882    "\
 883 List all the volumes groups detected.  This is the equivalent
 884 of the L<vgs(8)> command.  The \"full\" version includes all fields.");
 885
 886   ("lvs_full", (RStructList ("logvols", "lvm_lv"), []), 14, [],
 887    [], (* XXX how to test? *)
 888    "list the LVM logical volumes (LVs)",
 889    "\
 890 List all the logical volumes detected.  This is the equivalent
 891 of the L<lvs(8)> command.  The \"full\" version includes all fields.");
 892
 893   ("read_lines", (RStringList "lines", [String "path"]), 15, [],
 894    [InitBasicFS, Always, TestOutputList (
 895       [["write_file"; "/new"; "line1\r\nline2\nline3"; "0"];
 896        ["read_lines"; "/new"]], ["line1"; "line2"; "line3"]);
 897     InitBasicFS, Always, TestOutputList (
 898       [["write_file"; "/new"; ""; "0"];
 899        ["read_lines"; "/new"]], [])],
 900    "read file as lines",
 901    "\
 902 Return the contents of the file named C<path>.
 903
 904 The file contents are returned as a list of lines.  Trailing
 905 C<LF> and C<CRLF> character sequences are I<not> returned.
 906
 907 Note that this function cannot correctly handle binary files
 908 (specifically, files containing C<\\0> character which is treated
 909 as end of line).  For those you need to use the C<guestfs_read_file>
 910 function which has a more complex interface.");
 911
 912   ("aug_init", (RErr, [String "root"; Int "flags"]), 16, [],
 913    [], (* XXX Augeas code needs tests. *)
 914    "create a new Augeas handle",
 915    "\
 916 Create a new Augeas handle for editing configuration files.
 917 If there was any previous Augeas handle associated with this
 918 guestfs session, then it is closed.
 919
 920 You must call this before using any other C<guestfs_aug_*>
 921 commands.
 922
 923 C<root> is the filesystem root.  C<root> must not be NULL,
 924 use C</> instead.
 925
 926 The flags are the same as the flags defined in
 927 E<lt>augeas.hE<gt>, the logical I<or> of the following
 928 integers:
 929
 930 =over 4
 931
 932 =item C<AUG_SAVE_BACKUP> = 1
 933
 934 Keep the original file with a C<.augsave> extension.
 935
 936 =item C<AUG_SAVE_NEWFILE> = 2
 937
 938 Save changes into a file with extension C<.augnew>, and
 939 do not overwrite original.  Overrides C<AUG_SAVE_BACKUP>.
 940
 941 =item C<AUG_TYPE_CHECK> = 4
 942
 943 Typecheck lenses (can be expensive).
 944
 945 =item C<AUG_NO_STDINC> = 8
 946
 947 Do not use standard load path for modules.
 948
 949 =item C<AUG_SAVE_NOOP> = 16
 950
 951 Make save a no-op, just record what would have been changed.
 952
 953 =item C<AUG_NO_LOAD> = 32
 954
 955 Do not load the tree in C<guestfs_aug_init>.
 956
 957 =back
 958
 959 To close the handle, you can call C<guestfs_aug_close>.
 960
 961 To find out more about Augeas, see L<http://augeas.net/>.");
 962
 963   ("aug_close", (RErr, []), 26, [],
 964    [], (* XXX Augeas code needs tests. *)
 965    "close the current Augeas handle",
 966    "\
 967 Close the current Augeas handle and free up any resources
 968 used by it.  After calling this, you have to call
 969 C<guestfs_aug_init> again before you can use any other
 970 Augeas functions.");
 971
 972   ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"]), 17, [],
 973    [], (* XXX Augeas code needs tests. *)
 974    "define an Augeas variable",
 975    "\
 976 Defines an Augeas variable C<name> whose value is the result
 977 of evaluating C<expr>.  If C<expr> is NULL, then C<name> is
 978 undefined.
 979
 980 On success this returns the number of nodes in C<expr>, or
 981 C<0> if C<expr> evaluates to something which is not a nodeset.");
 982
 983   ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"]), 18, [],
 984    [], (* XXX Augeas code needs tests. *)
 985    "define an Augeas node",
 986    "\
 987 Defines a variable C<name> whose value is the result of
 988 evaluating C<expr>.
 989
 990 If C<expr> evaluates to an empty nodeset, a node is created,
 991 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
 992 C<name> will be the nodeset containing that single node.
 993
 994 On success this returns a pair containing the
 995 number of nodes in the nodeset, and a boolean flag
 996 if a node was created.");
 997
 998   ("aug_get", (RString "val", [String "path"]), 19, [],
 999    [], (* XXX Augeas code needs tests. *)
1000    "look up the value of an Augeas path",
1001    "\
1002 Look up the value associated with C<path>.  If C<path>
1003 matches exactly one node, the C<value> is returned.");
1004
1005   ("aug_set", (RErr, [String "path"; String "val"]), 20, [],
1006    [], (* XXX Augeas code needs tests. *)
1007    "set Augeas path to value",
1008    "\
1009 Set the value associated with C<path> to C<value>.");
1010
1011   ("aug_insert", (RErr, [String "path"; String "label"; Bool "before"]), 21, [],
1012    [], (* XXX Augeas code needs tests. *)
1013    "insert a sibling Augeas node",
1014    "\
1015 Create a new sibling C<label> for C<path>, inserting it into
1016 the tree before or after C<path> (depending on the boolean
1017 flag C<before>).
1018
1019 C<path> must match exactly one existing node in the tree, and
1020 C<label> must be a label, ie. not contain C</>, C<*> or end
1021 with a bracketed index C<[N]>.");
1022
1023   ("aug_rm", (RInt "nrnodes", [String "path"]), 22, [],
1024    [], (* XXX Augeas code needs tests. *)
1025    "remove an Augeas path",
1026    "\
1027 Remove C<path> and all of its children.
1028
1029 On success this returns the number of entries which were removed.");
1030
1031   ("aug_mv", (RErr, [String "src"; String "dest"]), 23, [],
1032    [], (* XXX Augeas code needs tests. *)
1033    "move Augeas node",
1034    "\
1035 Move the node C<src> to C<dest>.  C<src> must match exactly
1036 one node.  C<dest> is overwritten if it exists.");
1037
1038   ("aug_match", (RStringList "matches", [String "path"]), 24, [],
1039    [], (* XXX Augeas code needs tests. *)
1040    "return Augeas nodes which match path",
1041    "\
1042 Returns a list of paths which match the path expression C<path>.
1043 The returned paths are sufficiently qualified so that they match
1044 exactly one node in the current tree.");
1045
1046   ("aug_save", (RErr, []), 25, [],
1047    [], (* XXX Augeas code needs tests. *)
1048    "write all pending Augeas changes to disk",
1049    "\
1050 This writes all pending changes to disk.
1051
1052 The flags which were passed to C<guestfs_aug_init> affect exactly
1053 how files are saved.");
1054
1055   ("aug_load", (RErr, []), 27, [],
1056    [], (* XXX Augeas code needs tests. *)
1057    "load files into the tree",
1058    "\
1059 Load files into the tree.
1060
1061 See C<aug_load> in the Augeas documentation for the full gory
1062 details.");
1063
1064   ("aug_ls", (RStringList "matches", [String "path"]), 28, [],
1065    [], (* XXX Augeas code needs tests. *)
1066    "list Augeas nodes under a path",
1067    "\
1068 This is just a shortcut for listing C<guestfs_aug_match>
1069 C<path/*> and sorting the resulting nodes into alphabetical order.");
1070
1071   ("rm", (RErr, [String "path"]), 29, [],
1072    [InitBasicFS, Always, TestRun
1073       [["touch"; "/new"];
1074        ["rm"; "/new"]];
1075     InitBasicFS, Always, TestLastFail
1076       [["rm"; "/new"]];
1077     InitBasicFS, Always, TestLastFail
1078       [["mkdir"; "/new"];
1079        ["rm"; "/new"]]],
1080    "remove a file",
1081    "\
1082 Remove the single file C<path>.");
1083
1084   ("rmdir", (RErr, [String "path"]), 30, [],
1085    [InitBasicFS, Always, TestRun
1086       [["mkdir"; "/new"];
1087        ["rmdir"; "/new"]];
1088     InitBasicFS, Always, TestLastFail
1089       [["rmdir"; "/new"]];
1090     InitBasicFS, Always, TestLastFail
1091       [["touch"; "/new"];
1092        ["rmdir"; "/new"]]],
1093    "remove a directory",
1094    "\
1095 Remove the single directory C<path>.");
1096
1097   ("rm_rf", (RErr, [String "path"]), 31, [],
1098    [InitBasicFS, Always, TestOutputFalse
1099       [["mkdir"; "/new"];
1100        ["mkdir"; "/new/foo"];
1101        ["touch"; "/new/foo/bar"];
1102        ["rm_rf"; "/new"];
1103        ["exists"; "/new"]]],
1104    "remove a file or directory recursively",
1105    "\
1106 Remove the file or directory C<path>, recursively removing the
1107 contents if its a directory.  This is like the C<rm -rf> shell
1108 command.");
1109
1110   ("mkdir", (RErr, [String "path"]), 32, [],
1111    [InitBasicFS, Always, TestOutputTrue
1112       [["mkdir"; "/new"];
1113        ["is_dir"; "/new"]];
1114     InitBasicFS, Always, TestLastFail
1115       [["mkdir"; "/new/foo/bar"]]],
1116    "create a directory",
1117    "\
1118 Create a directory named C<path>.");
1119
1120   ("mkdir_p", (RErr, [String "path"]), 33, [],
1121    [InitBasicFS, Always, TestOutputTrue
1122       [["mkdir_p"; "/new/foo/bar"];
1123        ["is_dir"; "/new/foo/bar"]];
1124     InitBasicFS, Always, TestOutputTrue
1125       [["mkdir_p"; "/new/foo/bar"];
1126        ["is_dir"; "/new/foo"]];
1127     InitBasicFS, Always, TestOutputTrue
1128       [["mkdir_p"; "/new/foo/bar"];
1129        ["is_dir"; "/new"]];
1130     (* Regression tests for RHBZ#503133: *)
1131     InitBasicFS, Always, TestRun
1132       [["mkdir"; "/new"];
1133        ["mkdir_p"; "/new"]];
1134     InitBasicFS, Always, TestLastFail
1135       [["touch"; "/new"];
1136        ["mkdir_p"; "/new"]]],
1137    "create a directory and parents",
1138    "\
1139 Create a directory named C<path>, creating any parent directories
1140 as necessary.  This is like the C<mkdir -p> shell command.");
1141
1142   ("chmod", (RErr, [Int "mode"; String "path"]), 34, [],
1143    [], (* XXX Need stat command to test *)
1144    "change file mode",
1145    "\
1146 Change the mode (permissions) of C<path> to C<mode>.  Only
1147 numeric modes are supported.");
1148
1149   ("chown", (RErr, [Int "owner"; Int "group"; String "path"]), 35, [],
1150    [], (* XXX Need stat command to test *)
1151    "change file owner and group",
1152    "\
1153 Change the file owner to C<owner> and group to C<group>.
1154
1155 Only numeric uid and gid are supported.  If you want to use
1156 names, you will need to locate and parse the password file
1157 yourself (Augeas support makes this relatively easy).");
1158
1159   ("exists", (RBool "existsflag", [String "path"]), 36, [],
1160    [InitBasicFS, Always, TestOutputTrue (
1161       [["touch"; "/new"];
1162        ["exists"; "/new"]]);
1163     InitBasicFS, Always, TestOutputTrue (
1164       [["mkdir"; "/new"];
1165        ["exists"; "/new"]])],
1166    "test if file or directory exists",
1167    "\
1168 This returns C<true> if and only if there is a file, directory
1169 (or anything) with the given C<path> name.
1170
1171 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1172
1173   ("is_file", (RBool "fileflag", [String "path"]), 37, [],
1174    [InitBasicFS, Always, TestOutputTrue (
1175       [["touch"; "/new"];
1176        ["is_file"; "/new"]]);
1177     InitBasicFS, Always, TestOutputFalse (
1178       [["mkdir"; "/new"];
1179        ["is_file"; "/new"]])],
1180    "test if file exists",
1181    "\
1182 This returns C<true> if and only if there is a file
1183 with the given C<path> name.  Note that it returns false for
1184 other objects like directories.
1185
1186 See also C<guestfs_stat>.");
1187
1188   ("is_dir", (RBool "dirflag", [String "path"]), 38, [],
1189    [InitBasicFS, Always, TestOutputFalse (
1190       [["touch"; "/new"];
1191        ["is_dir"; "/new"]]);
1192     InitBasicFS, Always, TestOutputTrue (
1193       [["mkdir"; "/new"];
1194        ["is_dir"; "/new"]])],
1195    "test if file exists",
1196    "\
1197 This returns C<true> if and only if there is a directory
1198 with the given C<path> name.  Note that it returns false for
1199 other objects like files.
1200
1201 See also C<guestfs_stat>.");
1202
1203   ("pvcreate", (RErr, [String "device"]), 39, [],
1204    [InitEmpty, Always, TestOutputListOfDevices (
1205       [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1206        ["pvcreate"; "/dev/sda1"];
1207        ["pvcreate"; "/dev/sda2"];
1208        ["pvcreate"; "/dev/sda3"];
1209        ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1210    "create an LVM physical volume",
1211    "\
1212 This creates an LVM physical volume on the named C<device>,
1213 where C<device> should usually be a partition name such
1214 as C</dev/sda1>.");
1215
1216   ("vgcreate", (RErr, [String "volgroup"; StringList "physvols"]), 40, [],
1217    [InitEmpty, Always, TestOutputList (
1218       [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1219        ["pvcreate"; "/dev/sda1"];
1220        ["pvcreate"; "/dev/sda2"];
1221        ["pvcreate"; "/dev/sda3"];
1222        ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1223        ["vgcreate"; "VG2"; "/dev/sda3"];
1224        ["vgs"]], ["VG1"; "VG2"])],
1225    "create an LVM volume group",
1226    "\
1227 This creates an LVM volume group called C<volgroup>
1228 from the non-empty list of physical volumes C<physvols>.");
1229
1230   ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"]), 41, [],
1231    [InitEmpty, Always, TestOutputList (
1232       [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1233        ["pvcreate"; "/dev/sda1"];
1234        ["pvcreate"; "/dev/sda2"];
1235        ["pvcreate"; "/dev/sda3"];
1236        ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1237        ["vgcreate"; "VG2"; "/dev/sda3"];
1238        ["lvcreate"; "LV1"; "VG1"; "50"];
1239        ["lvcreate"; "LV2"; "VG1"; "50"];
1240        ["lvcreate"; "LV3"; "VG2"; "50"];
1241        ["lvcreate"; "LV4"; "VG2"; "50"];
1242        ["lvcreate"; "LV5"; "VG2"; "50"];
1243        ["lvs"]],
1244       ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1245        "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1246    "create an LVM volume group",
1247    "\
1248 This creates an LVM volume group called C<logvol>
1249 on the volume group C<volgroup>, with C<size> megabytes.");
1250
1251   ("mkfs", (RErr, [String "fstype"; String "device"]), 42, [],
1252    [InitEmpty, Always, TestOutput (
1253       [["sfdiskM"; "/dev/sda"; ","];
1254        ["mkfs"; "ext2"; "/dev/sda1"];
1255        ["mount"; "/dev/sda1"; "/"];
1256        ["write_file"; "/new"; "new file contents"; "0"];
1257        ["cat"; "/new"]], "new file contents")],
1258    "make a filesystem",
1259    "\
1260 This creates a filesystem on C<device> (usually a partition
1261 or LVM logical volume).  The filesystem type is C<fstype>, for
1262 example C<ext3>.");
1263
1264   ("sfdisk", (RErr, [String "device";
1265                      Int "cyls"; Int "heads"; Int "sectors";
1266                      StringList "lines"]), 43, [DangerWillRobinson],
1267    [],
1268    "create partitions on a block device",
1269    "\
1270 This is a direct interface to the L<sfdisk(8)> program for creating
1271 partitions on block devices.
1272
1273 C<device> should be a block device, for example C</dev/sda>.
1274
1275 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1276 and sectors on the device, which are passed directly to sfdisk as
1277 the I<-C>, I<-H> and I<-S> parameters.  If you pass C<0> for any
1278 of these, then the corresponding parameter is omitted.  Usually for
1279 'large' disks, you can just pass C<0> for these, but for small
1280 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1281 out the right geometry and you will need to tell it.
1282
1283 C<lines> is a list of lines that we feed to C<sfdisk>.  For more
1284 information refer to the L<sfdisk(8)> manpage.
1285
1286 To create a single partition occupying the whole disk, you would
1287 pass C<lines> as a single element list, when the single element being
1288 the string C<,> (comma).
1289
1290 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>");
1291
1292   ("write_file", (RErr, [String "path"; String "content"; Int "size"]), 44, [ProtocolLimitWarning],
1293    [InitBasicFS, Always, TestOutput (
1294       [["write_file"; "/new"; "new file contents"; "0"];
1295        ["cat"; "/new"]], "new file contents");
1296     InitBasicFS, Always, TestOutput (
1297       [["write_file"; "/new"; "\nnew file contents\n"; "0"];
1298        ["cat"; "/new"]], "\nnew file contents\n");
1299     InitBasicFS, Always, TestOutput (
1300       [["write_file"; "/new"; "\n\n"; "0"];
1301        ["cat"; "/new"]], "\n\n");
1302     InitBasicFS, Always, TestOutput (
1303       [["write_file"; "/new"; ""; "0"];
1304        ["cat"; "/new"]], "");
1305     InitBasicFS, Always, TestOutput (
1306       [["write_file"; "/new"; "\n\n\n"; "0"];
1307        ["cat"; "/new"]], "\n\n\n");
1308     InitBasicFS, Always, TestOutput (
1309       [["write_file"; "/new"; "\n"; "0"];
1310        ["cat"; "/new"]], "\n")],
1311    "create a file",
1312    "\
1313 This call creates a file called C<path>.  The contents of the
1314 file is the string C<content> (which can contain any 8 bit data),
1315 with length C<size>.
1316
1317 As a special case, if C<size> is C<0>
1318 then the length is calculated using C<strlen> (so in this case
1319 the content cannot contain embedded ASCII NULs).
1320
1321 I<NB.> Owing to a bug, writing content containing ASCII NUL
1322 characters does I<not> work, even if the length is specified.
1323 We hope to resolve this bug in a future version.  In the meantime
1324 use C<guestfs_upload>.");
1325
1326   ("umount", (RErr, [String "pathordevice"]), 45, [FishAlias "unmount"],
1327    [InitEmpty, Always, TestOutputListOfDevices (
1328       [["sfdiskM"; "/dev/sda"; ","];
1329        ["mkfs"; "ext2"; "/dev/sda1"];
1330        ["mount"; "/dev/sda1"; "/"];
1331        ["mounts"]], ["/dev/sda1"]);
1332     InitEmpty, Always, TestOutputList (
1333       [["sfdiskM"; "/dev/sda"; ","];
1334        ["mkfs"; "ext2"; "/dev/sda1"];
1335        ["mount"; "/dev/sda1"; "/"];
1336        ["umount"; "/"];
1337        ["mounts"]], [])],
1338    "unmount a filesystem",
1339    "\
1340 This unmounts the given filesystem.  The filesystem may be
1341 specified either by its mountpoint (path) or the device which
1342 contains the filesystem.");
1343
1344   ("mounts", (RStringList "devices", []), 46, [],
1345    [InitBasicFS, Always, TestOutputListOfDevices (
1346       [["mounts"]], ["/dev/sda1"])],
1347    "show mounted filesystems",
1348    "\
1349 This returns the list of currently mounted filesystems.  It returns
1350 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1351
1352 Some internal mounts are not shown.");
1353
1354   ("umount_all", (RErr, []), 47, [FishAlias "unmount-all"],
1355    [InitBasicFS, Always, TestOutputList (
1356       [["umount_all"];
1357        ["mounts"]], []);
1358     (* check that umount_all can unmount nested mounts correctly: *)
1359     InitEmpty, Always, TestOutputList (
1360       [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1361        ["mkfs"; "ext2"; "/dev/sda1"];
1362        ["mkfs"; "ext2"; "/dev/sda2"];
1363        ["mkfs"; "ext2"; "/dev/sda3"];
1364        ["mount"; "/dev/sda1"; "/"];
1365        ["mkdir"; "/mp1"];
1366        ["mount"; "/dev/sda2"; "/mp1"];
1367        ["mkdir"; "/mp1/mp2"];
1368        ["mount"; "/dev/sda3"; "/mp1/mp2"];
1369        ["mkdir"; "/mp1/mp2/mp3"];
1370        ["umount_all"];
1371        ["mounts"]], [])],
1372    "unmount all filesystems",
1373    "\
1374 This unmounts all mounted filesystems.
1375
1376 Some internal mounts are not unmounted by this call.");
1377
1378   ("lvm_remove_all", (RErr, []), 48, [DangerWillRobinson],
1379    [],
1380    "remove all LVM LVs, VGs and PVs",
1381    "\
1382 This command removes all LVM logical volumes, volume groups
1383 and physical volumes.");
1384
1385   ("file", (RString "description", [String "path"]), 49, [],
1386    [InitBasicFS, Always, TestOutput (
1387       [["touch"; "/new"];
1388        ["file"; "/new"]], "empty");
1389     InitBasicFS, Always, TestOutput (
1390       [["write_file"; "/new"; "some content\n"; "0"];
1391        ["file"; "/new"]], "ASCII text");
1392     InitBasicFS, Always, TestLastFail (
1393       [["file"; "/nofile"]])],
1394    "determine file type",
1395    "\
1396 This call uses the standard L<file(1)> command to determine
1397 the type or contents of the file.  This also works on devices,
1398 for example to find out whether a partition contains a filesystem.
1399
1400 The exact command which runs is C<file -bsL path>.  Note in
1401 particular that the filename is not prepended to the output
1402 (the C<-b> option).");
1403
1404   ("command", (RString "output", [StringList "arguments"]), 50, [ProtocolLimitWarning],
1405    [InitBasicFS, Always, TestOutput (
1406       [["upload"; "test-command"; "/test-command"];
1407        ["chmod"; "0o755"; "/test-command"];
1408        ["command"; "/test-command 1"]], "Result1");
1409     InitBasicFS, Always, TestOutput (
1410       [["upload"; "test-command"; "/test-command"];
1411        ["chmod"; "0o755"; "/test-command"];
1412        ["command"; "/test-command 2"]], "Result2\n");
1413     InitBasicFS, Always, TestOutput (
1414       [["upload"; "test-command"; "/test-command"];
1415        ["chmod"; "0o755"; "/test-command"];
1416        ["command"; "/test-command 3"]], "\nResult3");
1417     InitBasicFS, Always, TestOutput (
1418       [["upload"; "test-command"; "/test-command"];
1419        ["chmod"; "0o755"; "/test-command"];
1420        ["command"; "/test-command 4"]], "\nResult4\n");
1421     InitBasicFS, Always, TestOutput (
1422       [["upload"; "test-command"; "/test-command"];
1423        ["chmod"; "0o755"; "/test-command"];
1424        ["command"; "/test-command 5"]], "\nResult5\n\n");
1425     InitBasicFS, Always, TestOutput (
1426       [["upload"; "test-command"; "/test-command"];
1427        ["chmod"; "0o755"; "/test-command"];
1428        ["command"; "/test-command 6"]], "\n\nResult6\n\n");
1429     InitBasicFS, Always, TestOutput (
1430       [["upload"; "test-command"; "/test-command"];
1431        ["chmod"; "0o755"; "/test-command"];
1432        ["command"; "/test-command 7"]], "");
1433     InitBasicFS, Always, TestOutput (
1434       [["upload"; "test-command"; "/test-command"];
1435        ["chmod"; "0o755"; "/test-command"];
1436        ["command"; "/test-command 8"]], "\n");
1437     InitBasicFS, Always, TestOutput (
1438       [["upload"; "test-command"; "/test-command"];
1439        ["chmod"; "0o755"; "/test-command"];
1440        ["command"; "/test-command 9"]], "\n\n");
1441     InitBasicFS, Always, TestOutput (
1442       [["upload"; "test-command"; "/test-command"];
1443        ["chmod"; "0o755"; "/test-command"];
1444        ["command"; "/test-command 10"]], "Result10-1\nResult10-2\n");
1445     InitBasicFS, Always, TestOutput (
1446       [["upload"; "test-command"; "/test-command"];
1447        ["chmod"; "0o755"; "/test-command"];
1448        ["command"; "/test-command 11"]], "Result11-1\nResult11-2");
1449     InitBasicFS, Always, TestLastFail (
1450       [["upload"; "test-command"; "/test-command"];
1451        ["chmod"; "0o755"; "/test-command"];
1452        ["command"; "/test-command"]])],
1453    "run a command from the guest filesystem",
1454    "\
1455 This call runs a command from the guest filesystem.  The
1456 filesystem must be mounted, and must contain a compatible
1457 operating system (ie. something Linux, with the same
1458 or compatible processor architecture).
1459
1460 The single parameter is an argv-style list of arguments.
1461 The first element is the name of the program to run.
1462 Subsequent elements are parameters.  The list must be
1463 non-empty (ie. must contain a program name).  Note that
1464 the command runs directly, and is I<not> invoked via
1465 the shell (see C<guestfs_sh>).
1466
1467 The return value is anything printed to I<stdout> by
1468 the command.
1469
1470 If the command returns a non-zero exit status, then
1471 this function returns an error message.  The error message
1472 string is the content of I<stderr> from the command.
1473
1474 The C<$PATH> environment variable will contain at least
1475 C</usr/bin> and C</bin>.  If you require a program from
1476 another location, you should provide the full path in the
1477 first parameter.
1478
1479 Shared libraries and data files required by the program
1480 must be available on filesystems which are mounted in the
1481 correct places.  It is the caller's responsibility to ensure
1482 all filesystems that are needed are mounted at the right
1483 locations.");
1484
1485   ("command_lines", (RStringList "lines", [StringList "arguments"]), 51, [ProtocolLimitWarning],
1486    [InitBasicFS, Always, TestOutputList (
1487       [["upload"; "test-command"; "/test-command"];
1488        ["chmod"; "0o755"; "/test-command"];
1489        ["command_lines"; "/test-command 1"]], ["Result1"]);
1490     InitBasicFS, Always, TestOutputList (
1491       [["upload"; "test-command"; "/test-command"];
1492        ["chmod"; "0o755"; "/test-command"];
1493        ["command_lines"; "/test-command 2"]], ["Result2"]);
1494     InitBasicFS, Always, TestOutputList (
1495       [["upload"; "test-command"; "/test-command"];
1496        ["chmod"; "0o755"; "/test-command"];
1497        ["command_lines"; "/test-command 3"]], ["";"Result3"]);
1498     InitBasicFS, Always, TestOutputList (
1499       [["upload"; "test-command"; "/test-command"];
1500        ["chmod"; "0o755"; "/test-command"];
1501        ["command_lines"; "/test-command 4"]], ["";"Result4"]);
1502     InitBasicFS, Always, TestOutputList (
1503       [["upload"; "test-command"; "/test-command"];
1504        ["chmod"; "0o755"; "/test-command"];
1505        ["command_lines"; "/test-command 5"]], ["";"Result5";""]);
1506     InitBasicFS, Always, TestOutputList (
1507       [["upload"; "test-command"; "/test-command"];
1508        ["chmod"; "0o755"; "/test-command"];
1509        ["command_lines"; "/test-command 6"]], ["";"";"Result6";""]);
1510     InitBasicFS, Always, TestOutputList (
1511       [["upload"; "test-command"; "/test-command"];
1512        ["chmod"; "0o755"; "/test-command"];
1513        ["command_lines"; "/test-command 7"]], []);
1514     InitBasicFS, Always, TestOutputList (
1515       [["upload"; "test-command"; "/test-command"];
1516        ["chmod"; "0o755"; "/test-command"];
1517        ["command_lines"; "/test-command 8"]], [""]);
1518     InitBasicFS, Always, TestOutputList (
1519       [["upload"; "test-command"; "/test-command"];
1520        ["chmod"; "0o755"; "/test-command"];
1521        ["command_lines"; "/test-command 9"]], ["";""]);
1522     InitBasicFS, Always, TestOutputList (
1523       [["upload"; "test-command"; "/test-command"];
1524        ["chmod"; "0o755"; "/test-command"];
1525        ["command_lines"; "/test-command 10"]], ["Result10-1";"Result10-2"]);
1526     InitBasicFS, Always, TestOutputList (
1527       [["upload"; "test-command"; "/test-command"];
1528        ["chmod"; "0o755"; "/test-command"];
1529        ["command_lines"; "/test-command 11"]], ["Result11-1";"Result11-2"])],
1530    "run a command, returning lines",
1531    "\
1532 This is the same as C<guestfs_command>, but splits the
1533 result into a list of lines.
1534
1535 See also: C<guestfs_sh_lines>");
1536
1537   ("stat", (RStruct ("statbuf", "stat"), [String "path"]), 52, [],
1538    [InitBasicFS, Always, TestOutputStruct (
1539       [["touch"; "/new"];
1540        ["stat"; "/new"]], [CompareWithInt ("size", 0)])],
1541    "get file information",
1542    "\
1543 Returns file information for the given C<path>.
1544
1545 This is the same as the C<stat(2)> system call.");
1546
1547   ("lstat", (RStruct ("statbuf", "stat"), [String "path"]), 53, [],
1548    [InitBasicFS, Always, TestOutputStruct (
1549       [["touch"; "/new"];
1550        ["lstat"; "/new"]], [CompareWithInt ("size", 0)])],
1551    "get file information for a symbolic link",
1552    "\
1553 Returns file information for the given C<path>.
1554
1555 This is the same as C<guestfs_stat> except that if C<path>
1556 is a symbolic link, then the link is stat-ed, not the file it
1557 refers to.
1558
1559 This is the same as the C<lstat(2)> system call.");
1560
1561   ("statvfs", (RStruct ("statbuf", "statvfs"), [String "path"]), 54, [],
1562    [InitBasicFS, Always, TestOutputStruct (
1563       [["statvfs"; "/"]], [CompareWithInt ("namemax", 255);
1564                            CompareWithInt ("bsize", 1024)])],
1565    "get file system statistics",
1566    "\
1567 Returns file system statistics for any mounted file system.
1568 C<path> should be a file or directory in the mounted file system
1569 (typically it is the mount point itself, but it doesn't need to be).
1570
1571 This is the same as the C<statvfs(2)> system call.");
1572
1573   ("tune2fs_l", (RHashtable "superblock", [String "device"]), 55, [],
1574    [], (* XXX test *)
1575    "get ext2/ext3/ext4 superblock details",
1576    "\
1577 This returns the contents of the ext2, ext3 or ext4 filesystem
1578 superblock on C<device>.
1579
1580 It is the same as running C<tune2fs -l device>.  See L<tune2fs(8)>
1581 manpage for more details.  The list of fields returned isn't
1582 clearly defined, and depends on both the version of C<tune2fs>
1583 that libguestfs was built against, and the filesystem itself.");
1584
1585   ("blockdev_setro", (RErr, [String "device"]), 56, [],
1586    [InitEmpty, Always, TestOutputTrue (
1587       [["blockdev_setro"; "/dev/sda"];
1588        ["blockdev_getro"; "/dev/sda"]])],
1589    "set block device to read-only",
1590    "\
1591 Sets the block device named C<device> to read-only.
1592
1593 This uses the L<blockdev(8)> command.");
1594
1595   ("blockdev_setrw", (RErr, [String "device"]), 57, [],
1596    [InitEmpty, Always, TestOutputFalse (
1597       [["blockdev_setrw"; "/dev/sda"];
1598        ["blockdev_getro"; "/dev/sda"]])],
1599    "set block device to read-write",
1600    "\
1601 Sets the block device named C<device> to read-write.
1602
1603 This uses the L<blockdev(8)> command.");
1604
1605   ("blockdev_getro", (RBool "ro", [String "device"]), 58, [],
1606    [InitEmpty, Always, TestOutputTrue (
1607       [["blockdev_setro"; "/dev/sda"];
1608        ["blockdev_getro"; "/dev/sda"]])],
1609    "is block device set to read-only",
1610    "\
1611 Returns a boolean indicating if the block device is read-only
1612 (true if read-only, false if not).
1613
1614 This uses the L<blockdev(8)> command.");
1615
1616   ("blockdev_getss", (RInt "sectorsize", [String "device"]), 59, [],
1617    [InitEmpty, Always, TestOutputInt (
1618       [["blockdev_getss"; "/dev/sda"]], 512)],
1619    "get sectorsize of block device",
1620    "\
1621 This returns the size of sectors on a block device.
1622 Usually 512, but can be larger for modern devices.
1623
1624 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
1625 for that).
1626
1627 This uses the L<blockdev(8)> command.");
1628
1629   ("blockdev_getbsz", (RInt "blocksize", [String "device"]), 60, [],
1630    [InitEmpty, Always, TestOutputInt (
1631       [["blockdev_getbsz"; "/dev/sda"]], 4096)],
1632    "get blocksize of block device",
1633    "\
1634 This returns the block size of a device.
1635
1636 (Note this is different from both I<size in blocks> and
1637 I<filesystem block size>).
1638
1639 This uses the L<blockdev(8)> command.");
1640
1641   ("blockdev_setbsz", (RErr, [String "device"; Int "blocksize"]), 61, [],
1642    [], (* XXX test *)
1643    "set blocksize of block device",
1644    "\
1645 This sets the block size of a device.
1646
1647 (Note this is different from both I<size in blocks> and
1648 I<filesystem block size>).
1649
1650 This uses the L<blockdev(8)> command.");
1651
1652   ("blockdev_getsz", (RInt64 "sizeinsectors", [String "device"]), 62, [],
1653    [InitEmpty, Always, TestOutputInt (
1654       [["blockdev_getsz"; "/dev/sda"]], 1024000)],
1655    "get total size of device in 512-byte sectors",
1656    "\
1657 This returns the size of the device in units of 512-byte sectors
1658 (even if the sectorsize isn't 512 bytes ... weird).
1659
1660 See also C<guestfs_blockdev_getss> for the real sector size of
1661 the device, and C<guestfs_blockdev_getsize64> for the more
1662 useful I<size in bytes>.
1663
1664 This uses the L<blockdev(8)> command.");
1665
1666   ("blockdev_getsize64", (RInt64 "sizeinbytes", [String "device"]), 63, [],
1667    [InitEmpty, Always, TestOutputInt (
1668       [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
1669    "get total size of device in bytes",
1670    "\
1671 This returns the size of the device in bytes.
1672
1673 See also C<guestfs_blockdev_getsz>.
1674
1675 This uses the L<blockdev(8)> command.");
1676
1677   ("blockdev_flushbufs", (RErr, [String "device"]), 64, [],
1678    [InitEmpty, Always, TestRun
1679       [["blockdev_flushbufs"; "/dev/sda"]]],
1680    "flush device buffers",
1681    "\
1682 This tells the kernel to flush internal buffers associated
1683 with C<device>.
1684
1685 This uses the L<blockdev(8)> command.");
1686
1687   ("blockdev_rereadpt", (RErr, [String "device"]), 65, [],
1688    [InitEmpty, Always, TestRun
1689       [["blockdev_rereadpt"; "/dev/sda"]]],
1690    "reread partition table",
1691    "\
1692 Reread the partition table on C<device>.
1693
1694 This uses the L<blockdev(8)> command.");
1695
1696   ("upload", (RErr, [FileIn "filename"; String "remotefilename"]), 66, [],
1697    [InitBasicFS, Always, TestOutput (
1698       (* Pick a file from cwd which isn't likely to change. *)
1699     [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1700      ["checksum"; "md5"; "/COPYING.LIB"]], "e3eda01d9815f8d24aae2dbd89b68b06")],
1701    "upload a file from the local machine",
1702    "\
1703 Upload local file C<filename> to C<remotefilename> on the
1704 filesystem.
1705
1706 C<filename> can also be a named pipe.
1707
1708 See also C<guestfs_download>.");
1709
1710   ("download", (RErr, [String "remotefilename"; FileOut "filename"]), 67, [],
1711    [InitBasicFS, Always, TestOutput (
1712       (* Pick a file from cwd which isn't likely to change. *)
1713     [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1714      ["download"; "/COPYING.LIB"; "testdownload.tmp"];
1715      ["upload"; "testdownload.tmp"; "/upload"];
1716      ["checksum"; "md5"; "/upload"]], "e3eda01d9815f8d24aae2dbd89b68b06")],
1717    "download a file to the local machine",
1718    "\
1719 Download file C<remotefilename> and save it as C<filename>
1720 on the local machine.
1721
1722 C<filename> can also be a named pipe.
1723
1724 See also C<guestfs_upload>, C<guestfs_cat>.");
1725
1726   ("checksum", (RString "checksum", [String "csumtype"; String "path"]), 68, [],
1727    [InitBasicFS, Always, TestOutput (
1728       [["write_file"; "/new"; "test\n"; "0"];
1729        ["checksum"; "crc"; "/new"]], "935282863");
1730     InitBasicFS, Always, TestLastFail (
1731       [["checksum"; "crc"; "/new"]]);
1732     InitBasicFS, Always, TestOutput (
1733       [["write_file"; "/new"; "test\n"; "0"];
1734        ["checksum"; "md5"; "/new"]], "d8e8fca2dc0f896fd7cb4cb0031ba249");
1735     InitBasicFS, Always, TestOutput (
1736       [["write_file"; "/new"; "test\n"; "0"];
1737        ["checksum"; "sha1"; "/new"]], "4e1243bd22c66e76c2ba9eddc1f91394e57f9f83");
1738     InitBasicFS, Always, TestOutput (
1739       [["write_file"; "/new"; "test\n"; "0"];
1740        ["checksum"; "sha224"; "/new"]], "52f1bf093f4b7588726035c176c0cdb4376cfea53819f1395ac9e6ec");
1741     InitBasicFS, Always, TestOutput (
1742       [["write_file"; "/new"; "test\n"; "0"];
1743        ["checksum"; "sha256"; "/new"]], "f2ca1bb6c7e907d06dafe4687e579fce76b37e4e93b7605022da52e6ccc26fd2");
1744     InitBasicFS, Always, TestOutput (
1745       [["write_file"; "/new"; "test\n"; "0"];
1746        ["checksum"; "sha384"; "/new"]], "109bb6b5b6d5547c1ce03c7a8bd7d8f80c1cb0957f50c4f7fda04692079917e4f9cad52b878f3d8234e1a170b154b72d");
1747     InitBasicFS, Always, TestOutput (
1748       [["write_file"; "/new"; "test\n"; "0"];
1749        ["checksum"; "sha512"; "/new"]], "0e3e75234abc68f4378a86b3f4b32a198ba301845b0cd6e50106e874345700cc6663a86c1ea125dc5e92be17c98f9a0f85ca9d5f595db2012f7cc3571945c123");
1750     InitBasicFS, Always, TestOutput (
1751       (* RHEL 5 thinks this is an HFS+ filesystem unless we give
1752        * the type explicitly.
1753        *)
1754       [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
1755        ["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c")],
1756    "compute MD5, SHAx or CRC checksum of file",
1757    "\
1758 This call computes the MD5, SHAx or CRC checksum of the
1759 file named C<path>.
1760
1761 The type of checksum to compute is given by the C<csumtype>
1762 parameter which must have one of the following values:
1763
1764 =over 4
1765
1766 =item C<crc>
1767
1768 Compute the cyclic redundancy check (CRC) specified by POSIX
1769 for the C<cksum> command.
1770
1771 =item C<md5>
1772
1773 Compute the MD5 hash (using the C<md5sum> program).
1774
1775 =item C<sha1>
1776
1777 Compute the SHA1 hash (using the C<sha1sum> program).
1778
1779 =item C<sha224>
1780
1781 Compute the SHA224 hash (using the C<sha224sum> program).
1782
1783 =item C<sha256>
1784
1785 Compute the SHA256 hash (using the C<sha256sum> program).
1786
1787 =item C<sha384>
1788
1789 Compute the SHA384 hash (using the C<sha384sum> program).
1790
1791 =item C<sha512>
1792
1793 Compute the SHA512 hash (using the C<sha512sum> program).
1794
1795 =back
1796
1797 The checksum is returned as a printable string.");
1798
1799   ("tar_in", (RErr, [FileIn "tarfile"; String "directory"]), 69, [],
1800    [InitBasicFS, Always, TestOutput (
1801       [["tar_in"; "../images/helloworld.tar"; "/"];
1802        ["cat"; "/hello"]], "hello\n")],
1803    "unpack tarfile to directory",
1804    "\
1805 This command uploads and unpacks local file C<tarfile> (an
1806 I<uncompressed> tar file) into C<directory>.
1807
1808 To upload a compressed tarball, use C<guestfs_tgz_in>.");
1809
1810   ("tar_out", (RErr, [String "directory"; FileOut "tarfile"]), 70, [],
1811    [],
1812    "pack directory into tarfile",
1813    "\
1814 This command packs the contents of C<directory> and downloads
1815 it to local file C<tarfile>.
1816
1817 To download a compressed tarball, use C<guestfs_tgz_out>.");
1818
1819   ("tgz_in", (RErr, [FileIn "tarball"; String "directory"]), 71, [],
1820    [InitBasicFS, Always, TestOutput (
1821       [["tgz_in"; "../images/helloworld.tar.gz"; "/"];
1822        ["cat"; "/hello"]], "hello\n")],
1823    "unpack compressed tarball to directory",
1824    "\
1825 This command uploads and unpacks local file C<tarball> (a
1826 I<gzip compressed> tar file) into C<directory>.
1827
1828 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
1829
1830   ("tgz_out", (RErr, [String "directory"; FileOut "tarball"]), 72, [],
1831    [],
1832    "pack directory into compressed tarball",
1833    "\
1834 This command packs the contents of C<directory> and downloads
1835 it to local file C<tarball>.
1836
1837 To download an uncompressed tarball, use C<guestfs_tar_out>.");
1838
1839   ("mount_ro", (RErr, [String "device"; String "mountpoint"]), 73, [],
1840    [InitBasicFS, Always, TestLastFail (
1841       [["umount"; "/"];
1842        ["mount_ro"; "/dev/sda1"; "/"];
1843        ["touch"; "/new"]]);
1844     InitBasicFS, Always, TestOutput (
1845       [["write_file"; "/new"; "data"; "0"];
1846        ["umount"; "/"];
1847        ["mount_ro"; "/dev/sda1"; "/"];
1848        ["cat"; "/new"]], "data")],
1849    "mount a guest disk, read-only",
1850    "\
1851 This is the same as the C<guestfs_mount> command, but it
1852 mounts the filesystem with the read-only (I<-o ro>) flag.");
1853
1854   ("mount_options", (RErr, [String "options"; String "device"; String "mountpoint"]), 74, [],
1855    [],
1856    "mount a guest disk with mount options",
1857    "\
1858 This is the same as the C<guestfs_mount> command, but it
1859 allows you to set the mount options as for the
1860 L<mount(8)> I<-o> flag.");
1861
1862   ("mount_vfs", (RErr, [String "options"; String "vfstype"; String "device"; String "mountpoint"]), 75, [],
1863    [],
1864    "mount a guest disk with mount options and vfstype",
1865    "\
1866 This is the same as the C<guestfs_mount> command, but it
1867 allows you to set both the mount options and the vfstype
1868 as for the L<mount(8)> I<-o> and I<-t> flags.");
1869
1870   ("debug", (RString "result", [String "subcmd"; StringList "extraargs"]), 76, [],
1871    [],
1872    "debugging and internals",
1873    "\
1874 The C<guestfs_debug> command exposes some internals of
1875 C<guestfsd> (the guestfs daemon) that runs inside the
1876 qemu subprocess.
1877
1878 There is no comprehensive help for this command.  You have
1879 to look at the file C<daemon/debug.c> in the libguestfs source
1880 to find out what you can do.");
1881
1882   ("lvremove", (RErr, [String "device"]), 77, [],
1883    [InitEmpty, Always, TestOutputList (
1884       [["sfdiskM"; "/dev/sda"; ","];
1885        ["pvcreate"; "/dev/sda1"];
1886        ["vgcreate"; "VG"; "/dev/sda1"];
1887        ["lvcreate"; "LV1"; "VG"; "50"];
1888        ["lvcreate"; "LV2"; "VG"; "50"];
1889        ["lvremove"; "/dev/VG/LV1"];
1890        ["lvs"]], ["/dev/VG/LV2"]);
1891     InitEmpty, Always, TestOutputList (
1892       [["sfdiskM"; "/dev/sda"; ","];
1893        ["pvcreate"; "/dev/sda1"];
1894        ["vgcreate"; "VG"; "/dev/sda1"];
1895        ["lvcreate"; "LV1"; "VG"; "50"];
1896        ["lvcreate"; "LV2"; "VG"; "50"];
1897        ["lvremove"; "/dev/VG"];
1898        ["lvs"]], []);
1899     InitEmpty, Always, TestOutputList (
1900       [["sfdiskM"; "/dev/sda"; ","];
1901        ["pvcreate"; "/dev/sda1"];
1902        ["vgcreate"; "VG"; "/dev/sda1"];
1903        ["lvcreate"; "LV1"; "VG"; "50"];
1904        ["lvcreate"; "LV2"; "VG"; "50"];
1905        ["lvremove"; "/dev/VG"];
1906        ["vgs"]], ["VG"])],
1907    "remove an LVM logical volume",
1908    "\
1909 Remove an LVM logical volume C<device>, where C<device> is
1910 the path to the LV, such as C</dev/VG/LV>.
1911
1912 You can also remove all LVs in a volume group by specifying
1913 the VG name, C</dev/VG>.");
1914
1915   ("vgremove", (RErr, [String "vgname"]), 78, [],
1916    [InitEmpty, Always, TestOutputList (
1917       [["sfdiskM"; "/dev/sda"; ","];
1918        ["pvcreate"; "/dev/sda1"];
1919        ["vgcreate"; "VG"; "/dev/sda1"];
1920        ["lvcreate"; "LV1"; "VG"; "50"];
1921        ["lvcreate"; "LV2"; "VG"; "50"];
1922        ["vgremove"; "VG"];
1923        ["lvs"]], []);
1924     InitEmpty, Always, TestOutputList (
1925       [["sfdiskM"; "/dev/sda"; ","];
1926        ["pvcreate"; "/dev/sda1"];
1927        ["vgcreate"; "VG"; "/dev/sda1"];
1928        ["lvcreate"; "LV1"; "VG"; "50"];
1929        ["lvcreate"; "LV2"; "VG"; "50"];
1930        ["vgremove"; "VG"];
1931        ["vgs"]], [])],
1932    "remove an LVM volume group",
1933    "\
1934 Remove an LVM volume group C<vgname>, (for example C<VG>).
1935
1936 This also forcibly removes all logical volumes in the volume
1937 group (if any).");
1938
1939   ("pvremove", (RErr, [String "device"]), 79, [],
1940    [InitEmpty, Always, TestOutputListOfDevices (
1941       [["sfdiskM"; "/dev/sda"; ","];
1942        ["pvcreate"; "/dev/sda1"];
1943        ["vgcreate"; "VG"; "/dev/sda1"];
1944        ["lvcreate"; "LV1"; "VG"; "50"];
1945        ["lvcreate"; "LV2"; "VG"; "50"];
1946        ["vgremove"; "VG"];
1947        ["pvremove"; "/dev/sda1"];
1948        ["lvs"]], []);
1949     InitEmpty, Always, TestOutputListOfDevices (
1950       [["sfdiskM"; "/dev/sda"; ","];
1951        ["pvcreate"; "/dev/sda1"];
1952        ["vgcreate"; "VG"; "/dev/sda1"];
1953        ["lvcreate"; "LV1"; "VG"; "50"];
1954        ["lvcreate"; "LV2"; "VG"; "50"];
1955        ["vgremove"; "VG"];
1956        ["pvremove"; "/dev/sda1"];
1957        ["vgs"]], []);
1958     InitEmpty, Always, TestOutputListOfDevices (
1959       [["sfdiskM"; "/dev/sda"; ","];
1960        ["pvcreate"; "/dev/sda1"];
1961        ["vgcreate"; "VG"; "/dev/sda1"];
1962        ["lvcreate"; "LV1"; "VG"; "50"];
1963        ["lvcreate"; "LV2"; "VG"; "50"];
1964        ["vgremove"; "VG"];
1965        ["pvremove"; "/dev/sda1"];
1966        ["pvs"]], [])],
1967    "remove an LVM physical volume",
1968    "\
1969 This wipes a physical volume C<device> so that LVM will no longer
1970 recognise it.
1971
1972 The implementation uses the C<pvremove> command which refuses to
1973 wipe physical volumes that contain any volume groups, so you have
1974 to remove those first.");
1975
1976   ("set_e2label", (RErr, [String "device"; String "label"]), 80, [],
1977    [InitBasicFS, Always, TestOutput (
1978       [["set_e2label"; "/dev/sda1"; "testlabel"];
1979        ["get_e2label"; "/dev/sda1"]], "testlabel")],
1980    "set the ext2/3/4 filesystem label",
1981    "\
1982 This sets the ext2/3/4 filesystem label of the filesystem on
1983 C<device> to C<label>.  Filesystem labels are limited to
1984 16 characters.
1985
1986 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
1987 to return the existing label on a filesystem.");
1988
1989   ("get_e2label", (RString "label", [String "device"]), 81, [],
1990    [],
1991    "get the ext2/3/4 filesystem label",
1992    "\
1993 This returns the ext2/3/4 filesystem label of the filesystem on
1994 C<device>.");
1995
1996   ("set_e2uuid", (RErr, [String "device"; String "uuid"]), 82, [],
1997    [InitBasicFS, Always, TestOutput (
1998       [["set_e2uuid"; "/dev/sda1"; "a3a61220-882b-4f61-89f4-cf24dcc7297d"];
1999        ["get_e2uuid"; "/dev/sda1"]], "a3a61220-882b-4f61-89f4-cf24dcc7297d");
2000     InitBasicFS, Always, TestOutput (
2001       [["set_e2uuid"; "/dev/sda1"; "clear"];
2002        ["get_e2uuid"; "/dev/sda1"]], "");
2003     (* We can't predict what UUIDs will be, so just check the commands run. *)
2004     InitBasicFS, Always, TestRun (
2005       [["set_e2uuid"; "/dev/sda1"; "random"]]);
2006     InitBasicFS, Always, TestRun (
2007       [["set_e2uuid"; "/dev/sda1"; "time"]])],
2008    "set the ext2/3/4 filesystem UUID",
2009    "\
2010 This sets the ext2/3/4 filesystem UUID of the filesystem on
2011 C<device> to C<uuid>.  The format of the UUID and alternatives
2012 such as C<clear>, C<random> and C<time> are described in the
2013 L<tune2fs(8)> manpage.
2014
2015 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2016 to return the existing UUID of a filesystem.");
2017
2018   ("get_e2uuid", (RString "uuid", [String "device"]), 83, [],
2019    [],
2020    "get the ext2/3/4 filesystem UUID",
2021    "\
2022 This returns the ext2/3/4 filesystem UUID of the filesystem on
2023 C<device>.");
2024
2025   ("fsck", (RInt "status", [String "fstype"; String "device"]), 84, [],
2026    [InitBasicFS, Always, TestOutputInt (
2027       [["umount"; "/dev/sda1"];
2028        ["fsck"; "ext2"; "/dev/sda1"]], 0);
2029     InitBasicFS, Always, TestOutputInt (
2030       [["umount"; "/dev/sda1"];
2031        ["zero"; "/dev/sda1"];
2032        ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2033    "run the filesystem checker",
2034    "\
2035 This runs the filesystem checker (fsck) on C<device> which
2036 should have filesystem type C<fstype>.
2037
2038 The returned integer is the status.  See L<fsck(8)> for the
2039 list of status codes from C<fsck>.
2040
2041 Notes:
2042
2043 =over 4
2044
2045 =item *
2046
2047 Multiple status codes can be summed together.
2048
2049 =item *
2050
2051 A non-zero return code can mean \"success\", for example if
2052 errors have been corrected on the filesystem.
2053
2054 =item *
2055
2056 Checking or repairing NTFS volumes is not supported
2057 (by linux-ntfs).
2058
2059 =back
2060
2061 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2062
2063   ("zero", (RErr, [String "device"]), 85, [],
2064    [InitBasicFS, Always, TestOutput (
2065       [["umount"; "/dev/sda1"];
2066        ["zero"; "/dev/sda1"];
2067        ["file"; "/dev/sda1"]], "data")],
2068    "write zeroes to the device",
2069    "\
2070 This command writes zeroes over the first few blocks of C<device>.
2071
2072 How many blocks are zeroed isn't specified (but it's I<not> enough
2073 to securely wipe the device).  It should be sufficient to remove
2074 any partition tables, filesystem superblocks and so on.
2075
2076 See also: C<guestfs_scrub_device>.");
2077
2078   ("grub_install", (RErr, [String "root"; String "device"]), 86, [],
2079    (* Test disabled because grub-install incompatible with virtio-blk driver.
2080     * See also: https://bugzilla.redhat.com/show_bug.cgi?id=479760
2081     *)
2082    [InitBasicFS, Disabled, TestOutputTrue (
2083       [["grub_install"; "/"; "/dev/sda1"];
2084        ["is_dir"; "/boot"]])],
2085    "install GRUB",
2086    "\
2087 This command installs GRUB (the Grand Unified Bootloader) on
2088 C<device>, with the root directory being C<root>.");
2089
2090   ("cp", (RErr, [String "src"; String "dest"]), 87, [],
2091    [InitBasicFS, Always, TestOutput (
2092       [["write_file"; "/old"; "file content"; "0"];
2093        ["cp"; "/old"; "/new"];
2094        ["cat"; "/new"]], "file content");
2095     InitBasicFS, Always, TestOutputTrue (
2096       [["write_file"; "/old"; "file content"; "0"];
2097        ["cp"; "/old"; "/new"];
2098        ["is_file"; "/old"]]);
2099     InitBasicFS, Always, TestOutput (
2100       [["write_file"; "/old"; "file content"; "0"];
2101        ["mkdir"; "/dir"];
2102        ["cp"; "/old"; "/dir/new"];
2103        ["cat"; "/dir/new"]], "file content")],
2104    "copy a file",
2105    "\
2106 This copies a file from C<src> to C<dest> where C<dest> is
2107 either a destination filename or destination directory.");
2108
2109   ("cp_a", (RErr, [String "src"; String "dest"]), 88, [],
2110    [InitBasicFS, Always, TestOutput (
2111       [["mkdir"; "/olddir"];
2112        ["mkdir"; "/newdir"];
2113        ["write_file"; "/olddir/file"; "file content"; "0"];
2114        ["cp_a"; "/olddir"; "/newdir"];
2115        ["cat"; "/newdir/olddir/file"]], "file content")],
2116    "copy a file or directory recursively",
2117    "\
2118 This copies a file or directory from C<src> to C<dest>
2119 recursively using the C<cp -a> command.");
2120
2121   ("mv", (RErr, [String "src"; String "dest"]), 89, [],
2122    [InitBasicFS, Always, TestOutput (
2123       [["write_file"; "/old"; "file content"; "0"];
2124        ["mv"; "/old"; "/new"];
2125        ["cat"; "/new"]], "file content");
2126     InitBasicFS, Always, TestOutputFalse (
2127       [["write_file"; "/old"; "file content"; "0"];
2128        ["mv"; "/old"; "/new"];
2129        ["is_file"; "/old"]])],
2130    "move a file",
2131    "\
2132 This moves a file from C<src> to C<dest> where C<dest> is
2133 either a destination filename or destination directory.");
2134
2135   ("drop_caches", (RErr, [Int "whattodrop"]), 90, [],
2136    [InitEmpty, Always, TestRun (
2137       [["drop_caches"; "3"]])],
2138    "drop kernel page cache, dentries and inodes",
2139    "\
2140 This instructs the guest kernel to drop its page cache,
2141 and/or dentries and inode caches.  The parameter C<whattodrop>
2142 tells the kernel what precisely to drop, see
2143 L<http://linux-mm.org/Drop_Caches>
2144
2145 Setting C<whattodrop> to 3 should drop everything.
2146
2147 This automatically calls L<sync(2)> before the operation,
2148 so that the maximum guest memory is freed.");
2149
2150   ("dmesg", (RString "kmsgs", []), 91, [],
2151    [InitEmpty, Always, TestRun (
2152       [["dmesg"]])],
2153    "return kernel messages",
2154    "\
2155 This returns the kernel messages (C<dmesg> output) from
2156 the guest kernel.  This is sometimes useful for extended
2157 debugging of problems.
2158
2159 Another way to get the same information is to enable
2160 verbose messages with C<guestfs_set_verbose> or by setting
2161 the environment variable C<LIBGUESTFS_DEBUG=1> before
2162 running the program.");
2163
2164   ("ping_daemon", (RErr, []), 92, [],
2165    [InitEmpty, Always, TestRun (
2166       [["ping_daemon"]])],
2167    "ping the guest daemon",
2168    "\
2169 This is a test probe into the guestfs daemon running inside
2170 the qemu subprocess.  Calling this function checks that the
2171 daemon responds to the ping message, without affecting the daemon
2172 or attached block device(s) in any other way.");
2173
2174   ("equal", (RBool "equality", [String "file1"; String "file2"]), 93, [],
2175    [InitBasicFS, Always, TestOutputTrue (
2176       [["write_file"; "/file1"; "contents of a file"; "0"];
2177        ["cp"; "/file1"; "/file2"];
2178        ["equal"; "/file1"; "/file2"]]);
2179     InitBasicFS, Always, TestOutputFalse (
2180       [["write_file"; "/file1"; "contents of a file"; "0"];
2181        ["write_file"; "/file2"; "contents of another file"; "0"];
2182        ["equal"; "/file1"; "/file2"]]);
2183     InitBasicFS, Always, TestLastFail (
2184       [["equal"; "/file1"; "/file2"]])],
2185    "test if two files have equal contents",
2186    "\
2187 This compares the two files C<file1> and C<file2> and returns
2188 true if their content is exactly equal, or false otherwise.
2189
2190 The external L<cmp(1)> program is used for the comparison.");
2191
2192   ("strings", (RStringList "stringsout", [String "path"]), 94, [ProtocolLimitWarning],
2193    [InitBasicFS, Always, TestOutputList (
2194       [["write_file"; "/new"; "hello\nworld\n"; "0"];
2195        ["strings"; "/new"]], ["hello"; "world"]);
2196     InitBasicFS, Always, TestOutputList (
2197       [["touch"; "/new"];
2198        ["strings"; "/new"]], [])],
2199    "print the printable strings in a file",
2200    "\
2201 This runs the L<strings(1)> command on a file and returns
2202 the list of printable strings found.");
2203
2204   ("strings_e", (RStringList "stringsout", [String "encoding"; String "path"]), 95, [ProtocolLimitWarning],
2205    [InitBasicFS, Always, TestOutputList (
2206       [["write_file"; "/new"; "hello\nworld\n"; "0"];
2207        ["strings_e"; "b"; "/new"]], []);
2208     InitBasicFS, Disabled, TestOutputList (
2209       [["write_file"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"; "24"];
2210        ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
2211    "print the printable strings in a file",
2212    "\
2213 This is like the C<guestfs_strings> command, but allows you to
2214 specify the encoding.
2215
2216 See the L<strings(1)> manpage for the full list of encodings.
2217
2218 Commonly useful encodings are C<l> (lower case L) which will
2219 show strings inside Windows/x86 files.
2220
2221 The returned strings are transcoded to UTF-8.");
2222
2223   ("hexdump", (RString "dump", [String "path"]), 96, [ProtocolLimitWarning],
2224    [InitBasicFS, Always, TestOutput (
2225       [["write_file"; "/new"; "hello\nworld\n"; "12"];
2226        ["hexdump"; "/new"]], "00000000  68 65 6c 6c 6f 0a 77 6f  72 6c 64 0a              |hello.world.|\n0000000c\n");
2227     (* Test for RHBZ#501888c2 regression which caused large hexdump
2228      * commands to segfault.
2229      *)
2230     InitBasicFS, Always, TestRun (
2231       [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2232        ["hexdump"; "/100krandom"]])],
2233    "dump a file in hexadecimal",
2234    "\
2235 This runs C<hexdump -C> on the given C<path>.  The result is
2236 the human-readable, canonical hex dump of the file.");
2237
2238   ("zerofree", (RErr, [String "device"]), 97, [],
2239    [InitNone, Always, TestOutput (
2240       [["sfdiskM"; "/dev/sda"; ","];
2241        ["mkfs"; "ext3"; "/dev/sda1"];
2242        ["mount"; "/dev/sda1"; "/"];
2243        ["write_file"; "/new"; "test file"; "0"];
2244        ["umount"; "/dev/sda1"];
2245        ["zerofree"; "/dev/sda1"];
2246        ["mount"; "/dev/sda1"; "/"];
2247        ["cat"; "/new"]], "test file")],
2248    "zero unused inodes and disk blocks on ext2/3 filesystem",
2249    "\
2250 This runs the I<zerofree> program on C<device>.  This program
2251 claims to zero unused inodes and disk blocks on an ext2/3
2252 filesystem, thus making it possible to compress the filesystem
2253 more effectively.
2254
2255 You should B<not> run this program if the filesystem is
2256 mounted.
2257
2258 It is possible that using this program can damage the filesystem
2259 or data on the filesystem.");
2260
2261   ("pvresize", (RErr, [String "device"]), 98, [],
2262    [],
2263    "resize an LVM physical volume",
2264    "\
2265 This resizes (expands or shrinks) an existing LVM physical
2266 volume to match the new size of the underlying device.");
2267
2268   ("sfdisk_N", (RErr, [String "device"; Int "partnum";
2269                        Int "cyls"; Int "heads"; Int "sectors";
2270                        String "line"]), 99, [DangerWillRobinson],
2271    [],
2272    "modify a single partition on a block device",
2273    "\
2274 This runs L<sfdisk(8)> option to modify just the single
2275 partition C<n> (note: C<n> counts from 1).
2276
2277 For other parameters, see C<guestfs_sfdisk>.  You should usually
2278 pass C<0> for the cyls/heads/sectors parameters.");
2279
2280   ("sfdisk_l", (RString "partitions", [String "device"]), 100, [],
2281    [],
2282    "display the partition table",
2283    "\
2284 This displays the partition table on C<device>, in the
2285 human-readable output of the L<sfdisk(8)> command.  It is
2286 not intended to be parsed.");
2287
2288   ("sfdisk_kernel_geometry", (RString "partitions", [String "device"]), 101, [],
2289    [],
2290    "display the kernel geometry",
2291    "\
2292 This displays the kernel's idea of the geometry of C<device>.
2293
2294 The result is in human-readable format, and not designed to
2295 be parsed.");
2296
2297   ("sfdisk_disk_geometry", (RString "partitions", [String "device"]), 102, [],
2298    [],
2299    "display the disk geometry from the partition table",
2300    "\
2301 This displays the disk geometry of C<device> read from the
2302 partition table.  Especially in the case where the underlying
2303 block device has been resized, this can be different from the
2304 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
2305
2306 The result is in human-readable format, and not designed to
2307 be parsed.");
2308
2309   ("vg_activate_all", (RErr, [Bool "activate"]), 103, [],
2310    [],
2311    "activate or deactivate all volume groups",
2312    "\
2313 This command activates or (if C<activate> is false) deactivates
2314 all logical volumes in all volume groups.
2315 If activated, then they are made known to the
2316 kernel, ie. they appear as C</dev/mapper> devices.  If deactivated,
2317 then those devices disappear.
2318
2319 This command is the same as running C<vgchange -a y|n>");
2320
2321   ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"]), 104, [],
2322    [],
2323    "activate or deactivate some volume groups",
2324    "\
2325 This command activates or (if C<activate> is false) deactivates
2326 all logical volumes in the listed volume groups C<volgroups>.
2327 If activated, then they are made known to the
2328 kernel, ie. they appear as C</dev/mapper> devices.  If deactivated,
2329 then those devices disappear.
2330
2331 This command is the same as running C<vgchange -a y|n volgroups...>
2332
2333 Note that if C<volgroups> is an empty list then B<all> volume groups
2334 are activated or deactivated.");
2335
2336   ("lvresize", (RErr, [String "device"; Int "mbytes"]), 105, [],
2337    [InitNone, Always, TestOutput (
2338     [["sfdiskM"; "/dev/sda"; ","];
2339      ["pvcreate"; "/dev/sda1"];
2340      ["vgcreate"; "VG"; "/dev/sda1"];
2341      ["lvcreate"; "LV"; "VG"; "10"];
2342      ["mkfs"; "ext2"; "/dev/VG/LV"];
2343      ["mount"; "/dev/VG/LV"; "/"];
2344      ["write_file"; "/new"; "test content"; "0"];
2345      ["umount"; "/"];
2346      ["lvresize"; "/dev/VG/LV"; "20"];
2347      ["e2fsck_f"; "/dev/VG/LV"];
2348      ["resize2fs"; "/dev/VG/LV"];
2349      ["mount"; "/dev/VG/LV"; "/"];
2350      ["cat"; "/new"]], "test content")],
2351    "resize an LVM logical volume",
2352    "\
2353 This resizes (expands or shrinks) an existing LVM logical
2354 volume to C<mbytes>.  When reducing, data in the reduced part
2355 is lost.");
2356
2357   ("resize2fs", (RErr, [String "device"]), 106, [],
2358    [], (* lvresize tests this *)
2359    "resize an ext2/ext3 filesystem",
2360    "\
2361 This resizes an ext2 or ext3 filesystem to match the size of
2362 the underlying device.
2363
2364 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
2365 on the C<device> before calling this command.  For unknown reasons
2366 C<resize2fs> sometimes gives an error about this and sometimes not.
2367 In any case, it is always safe to call C<guestfs_e2fsck_f> before
2368 calling this function.");
2369
2370   ("find", (RStringList "names", [String "directory"]), 107, [],
2371    [InitBasicFS, Always, TestOutputList (
2372       [["find"; "/"]], ["lost+found"]);
2373     InitBasicFS, Always, TestOutputList (
2374       [["touch"; "/a"];
2375        ["mkdir"; "/b"];
2376        ["touch"; "/b/c"];
2377        ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
2378     InitBasicFS, Always, TestOutputList (
2379       [["mkdir_p"; "/a/b/c"];
2380        ["touch"; "/a/b/c/d"];
2381        ["find"; "/a/b/"]], ["c"; "c/d"])],
2382    "find all files and directories",
2383    "\
2384 This command lists out all files and directories, recursively,
2385 starting at C<directory>.  It is essentially equivalent to
2386 running the shell command C<find directory -print> but some
2387 post-processing happens on the output, described below.
2388
2389 This returns a list of strings I<without any prefix>.  Thus
2390 if the directory structure was:
2391
2392  /tmp/a
2393  /tmp/b
2394  /tmp/c/d
2395
2396 then the returned list from C<guestfs_find> C</tmp> would be
2397 4 elements:
2398
2399  a
2400  b
2401  c
2402  c/d
2403
2404 If C<directory> is not a directory, then this command returns
2405 an error.
2406
2407 The returned list is sorted.");
2408
2409   ("e2fsck_f", (RErr, [String "device"]), 108, [],
2410    [], (* lvresize tests this *)
2411    "check an ext2/ext3 filesystem",
2412    "\
2413 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
2414 filesystem checker on C<device>, noninteractively (C<-p>),
2415 even if the filesystem appears to be clean (C<-f>).
2416
2417 This command is only needed because of C<guestfs_resize2fs>
2418 (q.v.).  Normally you should use C<guestfs_fsck>.");
2419
2420   ("sleep", (RErr, [Int "secs"]), 109, [],
2421    [InitNone, Always, TestRun (
2422     [["sleep"; "1"]])],
2423    "sleep for some seconds",
2424    "\
2425 Sleep for C<secs> seconds.");
2426
2427   ("ntfs_3g_probe", (RInt "status", [Bool "rw"; String "device"]), 110, [],
2428    [InitNone, Always, TestOutputInt (
2429       [["sfdiskM"; "/dev/sda"; ","];
2430        ["mkfs"; "ntfs"; "/dev/sda1"];
2431        ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
2432     InitNone, Always, TestOutputInt (
2433       [["sfdiskM"; "/dev/sda"; ","];
2434        ["mkfs"; "ext2"; "/dev/sda1"];
2435        ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
2436    "probe NTFS volume",
2437    "\
2438 This command runs the L<ntfs-3g.probe(8)> command which probes
2439 an NTFS C<device> for mountability.  (Not all NTFS volumes can
2440 be mounted read-write, and some cannot be mounted at all).
2441
2442 C<rw> is a boolean flag.  Set it to true if you want to test
2443 if the volume can be mounted read-write.  Set it to false if
2444 you want to test if the volume can be mounted read-only.
2445
2446 The return value is an integer which C<0> if the operation
2447 would succeed, or some non-zero value documented in the
2448 L<ntfs-3g.probe(8)> manual page.");
2449
2450   ("sh", (RString "output", [String "command"]), 111, [],
2451    [], (* XXX needs tests *)
2452    "run a command via the shell",
2453    "\
2454 This call runs a command from the guest filesystem via the
2455 guest's C</bin/sh>.
2456
2457 This is like C<guestfs_command>, but passes the command to:
2458
2459  /bin/sh -c \"command\"
2460
2461 Depending on the guest's shell, this usually results in
2462 wildcards being expanded, shell expressions being interpolated
2463 and so on.
2464
2465 All the provisos about C<guestfs_command> apply to this call.");
2466
2467   ("sh_lines", (RStringList "lines", [String "command"]), 112, [],
2468    [], (* XXX needs tests *)
2469    "run a command via the shell returning lines",
2470    "\
2471 This is the same as C<guestfs_sh>, but splits the result
2472 into a list of lines.
2473
2474 See also: C<guestfs_command_lines>");
2475
2476   ("glob_expand", (RStringList "paths", [String "pattern"]), 113, [],
2477    [InitBasicFS, Always, TestOutputList (
2478       [["mkdir_p"; "/a/b/c"];
2479        ["touch"; "/a/b/c/d"];
2480        ["touch"; "/a/b/c/e"];
2481        ["glob_expand"; "/a/b/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2482     InitBasicFS, Always, TestOutputList (
2483       [["mkdir_p"; "/a/b/c"];
2484        ["touch"; "/a/b/c/d"];
2485        ["touch"; "/a/b/c/e"];
2486        ["glob_expand"; "/a/*/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2487     InitBasicFS, Always, TestOutputList (
2488       [["mkdir_p"; "/a/b/c"];
2489        ["touch"; "/a/b/c/d"];
2490        ["touch"; "/a/b/c/e"];
2491        ["glob_expand"; "/a/*/x/*"]], [])],
2492    "expand a wildcard path",
2493    "\
2494 This command searches for all the pathnames matching
2495 C<pattern> according to the wildcard expansion rules
2496 used by the shell.
2497
2498 If no paths match, then this returns an empty list
2499 (note: not an error).
2500
2501 It is just a wrapper around the C L<glob(3)> function
2502 with flags C<GLOB_MARK|GLOB_BRACE>.
2503 See that manual page for more details.");
2504
2505   ("scrub_device", (RErr, [String "device"]), 114, [DangerWillRobinson],
2506    [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
2507       [["scrub_device"; "/dev/sdc"]])],
2508    "scrub (securely wipe) a device",
2509    "\
2510 This command writes patterns over C<device> to make data retrieval
2511 more difficult.
2512
2513 It is an interface to the L<scrub(1)> program.  See that
2514 manual page for more details.");
2515
2516   ("scrub_file", (RErr, [String "file"]), 115, [],
2517    [InitBasicFS, Always, TestRun (
2518       [["write_file"; "/file"; "content"; "0"];
2519        ["scrub_file"; "/file"]])],
2520    "scrub (securely wipe) a file",
2521    "\
2522 This command writes patterns over a file to make data retrieval
2523 more difficult.
2524
2525 The file is I<removed> after scrubbing.
2526
2527 It is an interface to the L<scrub(1)> program.  See that
2528 manual page for more details.");
2529
2530   ("scrub_freespace", (RErr, [String "dir"]), 116, [],
2531    [], (* XXX needs testing *)
2532    "scrub (securely wipe) free space",
2533    "\
2534 This command creates the directory C<dir> and then fills it
2535 with files until the filesystem is full, and scrubs the files
2536 as for C<guestfs_scrub_file>, and deletes them.
2537 The intention is to scrub any free space on the partition
2538 containing C<dir>.
2539
2540 It is an interface to the L<scrub(1)> program.  See that
2541 manual page for more details.");
2542
2543   ("mkdtemp", (RString "dir", [String "template"]), 117, [],
2544    [InitBasicFS, Always, TestRun (
2545       [["mkdir"; "/tmp"];
2546        ["mkdtemp"; "/tmp/tmpXXXXXX"]])],
2547    "create a temporary directory",
2548    "\
2549 This command creates a temporary directory.  The
2550 C<template> parameter should be a full pathname for the
2551 temporary directory name with the final six characters being
2552 \"XXXXXX\".
2553
2554 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
2555 the second one being suitable for Windows filesystems.
2556
2557 The name of the temporary directory that was created
2558 is returned.
2559
2560 The temporary directory is created with mode 0700
2561 and is owned by root.
2562
2563 The caller is responsible for deleting the temporary
2564 directory and its contents after use.
2565
2566 See also: L<mkdtemp(3)>");
2567
2568   ("wc_l", (RInt "lines", [String "path"]), 118, [],
2569    [InitBasicFS, Always, TestOutputInt (
2570       [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2571        ["wc_l"; "/10klines"]], 10000)],
2572    "count lines in a file",
2573    "\
2574 This command counts the lines in a file, using the
2575 C<wc -l> external command.");
2576
2577   ("wc_w", (RInt "words", [String "path"]), 119, [],
2578    [InitBasicFS, Always, TestOutputInt (
2579       [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2580        ["wc_w"; "/10klines"]], 10000)],
2581    "count words in a file",
2582    "\
2583 This command counts the words in a file, using the
2584 C<wc -w> external command.");
2585
2586   ("wc_c", (RInt "chars", [String "path"]), 120, [],
2587    [InitBasicFS, Always, TestOutputInt (
2588       [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2589        ["wc_c"; "/100kallspaces"]], 102400)],
2590    "count characters in a file",
2591    "\
2592 This command counts the characters in a file, using the
2593 C<wc -c> external command.");
2594
2595   ("head", (RStringList "lines", [String "path"]), 121, [ProtocolLimitWarning],
2596    [InitBasicFS, Always, TestOutputList (
2597       [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2598        ["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
2599    "return first 10 lines of a file",
2600    "\
2601 This command returns up to the first 10 lines of a file as
2602 a list of strings.");
2603
2604   ("head_n", (RStringList "lines", [Int "nrlines"; String "path"]), 122, [ProtocolLimitWarning],
2605    [InitBasicFS, Always, TestOutputList (
2606       [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2607        ["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2608     InitBasicFS, Always, TestOutputList (
2609       [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2610        ["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2611     InitBasicFS, Always, TestOutputList (
2612       [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2613        ["head_n"; "0"; "/10klines"]], [])],
2614    "return first N lines of a file",
2615    "\
2616 If the parameter C<nrlines> is a positive number, this returns the first
2617 C<nrlines> lines of the file C<path>.
2618
2619 If the parameter C<nrlines> is a negative number, this returns lines
2620 from the file C<path>, excluding the last C<nrlines> lines.
2621
2622 If the parameter C<nrlines> is zero, this returns an empty list.");
2623
2624   ("tail", (RStringList "lines", [String "path"]), 123, [ProtocolLimitWarning],
2625    [InitBasicFS, Always, TestOutputList (
2626       [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2627        ["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
2628    "return last 10 lines of a file",
2629    "\
2630 This command returns up to the last 10 lines of a file as
2631 a list of strings.");
2632
2633   ("tail_n", (RStringList "lines", [Int "nrlines"; String "path"]), 124, [ProtocolLimitWarning],
2634    [InitBasicFS, Always, TestOutputList (
2635       [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2636        ["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2637     InitBasicFS, Always, TestOutputList (
2638       [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2639        ["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2640     InitBasicFS, Always, TestOutputList (
2641       [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2642        ["tail_n"; "0"; "/10klines"]], [])],
2643    "return last N lines of a file",
2644    "\
2645 If the parameter C<nrlines> is a positive number, this returns the last
2646 C<nrlines> lines of the file C<path>.
2647
2648 If the parameter C<nrlines> is a negative number, this returns lines
2649 from the file C<path>, starting with the C<-nrlines>th line.
2650
2651 If the parameter C<nrlines> is zero, this returns an empty list.");
2652
2653   ("df", (RString "output", []), 125, [],
2654    [], (* XXX Tricky to test because it depends on the exact format
2655         * of the 'df' command and other imponderables.
2656         *)
2657    "report file system disk space usage",
2658    "\
2659 This command runs the C<df> command to report disk space used.
2660
2661 This command is mostly useful for interactive sessions.  It
2662 is I<not> intended that you try to parse the output string.
2663 Use C<statvfs> from programs.");
2664
2665   ("df_h", (RString "output", []), 126, [],
2666    [], (* XXX Tricky to test because it depends on the exact format
2667         * of the 'df' command and other imponderables.
2668         *)
2669    "report file system disk space usage (human readable)",
2670    "\
2671 This command runs the C<df -h> command to report disk space used
2672 in human-readable format.
2673
2674 This command is mostly useful for interactive sessions.  It
2675 is I<not> intended that you try to parse the output string.
2676 Use C<statvfs> from programs.");
2677
2678   ("du", (RInt64 "sizekb", [String "path"]), 127, [],
2679    [InitBasicFS, Always, TestOutputInt (
2680       [["mkdir"; "/p"];
2681        ["du"; "/p"]], 1 (* ie. 1 block, so depends on ext3 blocksize *))],
2682    "estimate file space usage",
2683    "\
2684 This command runs the C<du -s> command to estimate file space
2685 usage for C<path>.
2686
2687 C<path> can be a file or a directory.  If C<path> is a directory
2688 then the estimate includes the contents of the directory and all
2689 subdirectories (recursively).
2690
2691 The result is the estimated size in I<kilobytes>
2692 (ie. units of 1024 bytes).");
2693
2694   ("initrd_list", (RStringList "filenames", [String "path"]), 128, [],
2695    [InitBasicFS, Always, TestOutputList (
2696       [["mount_vfs"; "ro"; "squashfs"; "/dev/sdd"; "/"];
2697        ["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3"])],
2698    "list files in an initrd",
2699    "\
2700 This command lists out files contained in an initrd.
2701
2702 The files are listed without any initial C</> character.  The
2703 files are listed in the order they appear (not necessarily
2704 alphabetical).  Directory names are listed as separate items.
2705
2706 Old Linux kernels (2.4 and earlier) used a compressed ext2
2707 filesystem as initrd.  We I<only> support the newer initramfs
2708 format (compressed cpio files).");
2709
2710   ("mount_loop", (RErr, [String "file"; String "mountpoint"]), 129, [],
2711    [],
2712    "mount a file using the loop device",
2713    "\
2714 This command lets you mount C<file> (a filesystem image
2715 in a file) on a mount point.  It is entirely equivalent to
2716 the command C<mount -o loop file mountpoint>.");
2717
2718   ("mkswap", (RErr, [String "device"]), 130, [],
2719    [InitEmpty, Always, TestRun (
2720       [["sfdiskM"; "/dev/sda"; ","];
2721        ["mkswap"; "/dev/sda1"]])],
2722    "create a swap partition",
2723    "\
2724 Create a swap partition on C<device>.");
2725
2726   ("mkswap_L", (RErr, [String "label"; String "device"]), 131, [],
2727    [InitEmpty, Always, TestRun (
2728       [["sfdiskM"; "/dev/sda"; ","];
2729        ["mkswap_L"; "hello"; "/dev/sda1"]])],
2730    "create a swap partition with a label",
2731    "\
2732 Create a swap partition on C<device> with label C<label>.");
2733
2734   ("mkswap_U", (RErr, [String "uuid"; String "device"]), 132, [],
2735    [InitEmpty, Always, TestRun (
2736       [["sfdiskM"; "/dev/sda"; ","];
2737        ["mkswap_U"; "a3a61220-882b-4f61-89f4-cf24dcc7297d"; "/dev/sda1"]])],
2738    "create a swap partition with an explicit UUID",
2739    "\
2740 Create a swap partition on C<device> with UUID C<uuid>.");
2741
2742   ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; String "path"]), 133, [],
2743    [InitBasicFS, Always, TestOutputStruct (
2744       [["mknod"; "0o10777"; "0"; "0"; "/node"];
2745        (* NB: default umask 022 means 0777 -> 0755 in these tests *)
2746        ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)]);
2747     InitBasicFS, Always, TestOutputStruct (
2748       [["mknod"; "0o60777"; "66"; "99"; "/node"];
2749        ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
2750    "make block, character or FIFO devices",
2751    "\
2752 This call creates block or character special devices, or
2753 named pipes (FIFOs).
2754
2755 The C<mode> parameter should be the mode, using the standard
2756 constants.  C<devmajor> and C<devminor> are the
2757 device major and minor numbers, only used when creating block
2758 and character special devices.");
2759
2760   ("mkfifo", (RErr, [Int "mode"; String "path"]), 134, [],
2761    [InitBasicFS, Always, TestOutputStruct (
2762       [["mkfifo"; "0o777"; "/node"];
2763        ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)])],
2764    "make FIFO (named pipe)",
2765    "\
2766 This call creates a FIFO (named pipe) called C<path> with
2767 mode C<mode>.  It is just a convenient wrapper around
2768 C<guestfs_mknod>.");
2769
2770   ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; String "path"]), 135, [],
2771    [InitBasicFS, Always, TestOutputStruct (
2772       [["mknod_b"; "0o777"; "99"; "66"; "/node"];
2773        ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
2774    "make block device node",
2775    "\
2776 This call creates a block device node called C<path> with
2777 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
2778 It is just a convenient wrapper around C<guestfs_mknod>.");
2779
2780   ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; String "path"]), 136, [],
2781    [InitBasicFS, Always, TestOutputStruct (
2782       [["mknod_c"; "0o777"; "99"; "66"; "/node"];
2783        ["stat"; "/node"]], [CompareWithInt ("mode", 0o20755)])],
2784    "make char device node",
2785    "\
2786 This call creates a char device node called C<path> with
2787 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
2788 It is just a convenient wrapper around C<guestfs_mknod>.");
2789
2790   ("umask", (RInt "oldmask", [Int "mask"]), 137, [],
2791    [], (* XXX umask is one of those stateful things that we should
2792         * reset between each test.
2793         *)
2794    "set file mode creation mask (umask)",
2795    "\
2796 This function sets the mask used for creating new files and
2797 device nodes to C<mask & 0777>.
2798
2799 Typical umask values would be C<022> which creates new files
2800 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
2801 C<002> which creates new files with permissions like
2802 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
2803
2804 The default umask is C<022>.  This is important because it
2805 means that directories and device nodes will be created with
2806 C<0644> or C<0755> mode even if you specify C<0777>.
2807
2808 See also L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
2809
2810 This call returns the previous umask.");
2811
2812   ("readdir", (RStructList ("entries", "dirent"), [String "dir"]), 138, [],
2813    [],
2814    "read directories entries",
2815    "\
2816 This returns the list of directory entries in directory C<dir>.
2817
2818 All entries in the directory are returned, including C<.> and
2819 C<..>.  The entries are I<not> sorted, but returned in the same
2820 order as the underlying filesystem.
2821
2822 This function is primarily intended for use by programs.  To
2823 get a simple list of names, use C<guestfs_ls>.  To get a printable
2824 directory for human consumption, use C<guestfs_ll>.");
2825
2826   ("sfdiskM", (RErr, [String "device"; StringList "lines"]), 139, [DangerWillRobinson],
2827    [],
2828    "create partitions on a block device",
2829    "\
2830 This is a simplified interface to the C<guestfs_sfdisk>
2831 command, where partition sizes are specified in megabytes
2832 only (rounded to the nearest cylinder) and you don't need
2833 to specify the cyls, heads and sectors parameters which
2834 were rarely if ever used anyway.
2835
2836 See also C<guestfs_sfdisk> and the L<sfdisk(8)> manpage.");
2837
2838 ]
2839
2840 let all_functions = non_daemon_functions @ daemon_functions
2841
2842 (* In some places we want the functions to be displayed sorted
2843  * alphabetically, so this is useful:
2844  *)
2845 let all_functions_sorted =
2846   List.sort (fun (n1,_,_,_,_,_,_) (n2,_,_,_,_,_,_) ->
2847                compare n1 n2) all_functions
2848
2849 (* Field types for structures. *)
2850 type field =
2851   | FChar                       (* C 'char' (really, a 7 bit byte). *)
2852   | FString                     (* nul-terminated ASCII string. *)
2853   | FUInt32
2854   | FInt32
2855   | FUInt64
2856   | FInt64
2857   | FBytes                      (* Any int measure that counts bytes. *)
2858   | FUUID                       (* 32 bytes long, NOT nul-terminated. *)
2859   | FOptPercent                 (* [0..100], or -1 meaning "not present". *)
2860
2861 (* Because we generate extra parsing code for LVM command line tools,
2862  * we have to pull out the LVM columns separately here.
2863  *)
2864 let lvm_pv_cols = [
2865   "pv_name", FString;
2866   "pv_uuid", FUUID;
2867   "pv_fmt", FString;
2868   "pv_size", FBytes;
2869   "dev_size", FBytes;
2870   "pv_free", FBytes;
2871   "pv_used", FBytes;
2872   "pv_attr", FString (* XXX *);
2873   "pv_pe_count", FInt64;
2874   "pv_pe_alloc_count", FInt64;
2875   "pv_tags", FString;
2876   "pe_start", FBytes;
2877   "pv_mda_count", FInt64;
2878   "pv_mda_free", FBytes;
2879   (* Not in Fedora 10:
2880      "pv_mda_size", FBytes;
2881   *)
2882 ]
2883 let lvm_vg_cols = [
2884   "vg_name", FString;
2885   "vg_uuid", FUUID;
2886   "vg_fmt", FString;
2887   "vg_attr", FString (* XXX *);
2888   "vg_size", FBytes;
2889   "vg_free", FBytes;
2890   "vg_sysid", FString;
2891   "vg_extent_size", FBytes;
2892   "vg_extent_count", FInt64;
2893   "vg_free_count", FInt64;
2894   "max_lv", FInt64;
2895   "max_pv", FInt64;
2896   "pv_count", FInt64;
2897   "lv_count", FInt64;
2898   "snap_count", FInt64;
2899   "vg_seqno", FInt64;
2900   "vg_tags", FString;
2901   "vg_mda_count", FInt64;
2902   "vg_mda_free", FBytes;
2903   (* Not in Fedora 10:
2904      "vg_mda_size", FBytes;
2905   *)
2906 ]
2907 let lvm_lv_cols = [
2908   "lv_name", FString;
2909   "lv_uuid", FUUID;
2910   "lv_attr", FString (* XXX *);
2911   "lv_major", FInt64;
2912   "lv_minor", FInt64;
2913   "lv_kernel_major", FInt64;
2914   "lv_kernel_minor", FInt64;
2915   "lv_size", FBytes;
2916   "seg_count", FInt64;
2917   "origin", FString;
2918   "snap_percent", FOptPercent;
2919   "copy_percent", FOptPercent;
2920   "move_pv", FString;
2921   "lv_tags", FString;
2922   "mirror_log", FString;
2923   "modules", FString;
2924 ]
2925
2926 (* Names and fields in all structures (in RStruct and RStructList)
2927  * that we support.
2928  *)
2929 let structs = [
2930   (* The old RIntBool return type, only ever used for aug_defnode.  Do
2931    * not use this struct in any new code.
2932    *)
2933   "int_bool", [
2934     "i", FInt32;                (* for historical compatibility *)
2935     "b", FInt32;                (* for historical compatibility *)
2936   ];
2937
2938   (* LVM PVs, VGs, LVs. *)
2939   "lvm_pv", lvm_pv_cols;
2940   "lvm_vg", lvm_vg_cols;
2941   "lvm_lv", lvm_lv_cols;
2942
2943   (* Column names and types from stat structures.
2944    * NB. Can't use things like 'st_atime' because glibc header files
2945    * define some of these as macros.  Ugh.
2946    *)
2947   "stat", [
2948     "dev", FInt64;
2949     "ino", FInt64;
2950     "mode", FInt64;
2951     "nlink", FInt64;
2952     "uid", FInt64;
2953     "gid", FInt64;
2954     "rdev", FInt64;
2955     "size", FInt64;
2956     "blksize", FInt64;
2957     "blocks", FInt64;
2958     "atime", FInt64;
2959     "mtime", FInt64;
2960     "ctime", FInt64;
2961   ];
2962   "statvfs", [
2963     "bsize", FInt64;
2964     "frsize", FInt64;
2965     "blocks", FInt64;
2966     "bfree", FInt64;
2967     "bavail", FInt64;
2968     "files", FInt64;
2969     "ffree", FInt64;
2970     "favail", FInt64;
2971     "fsid", FInt64;
2972     "flag", FInt64;
2973     "namemax", FInt64;
2974   ];
2975
2976   (* Column names in dirent structure. *)
2977   "dirent", [
2978     "ino", FInt64;
2979     (* 'b' 'c' 'd' 'f' (FIFO) 'l' 'r' (regular file) 's' 'u' '?' *)
2980     "ftyp", FChar;
2981     "name", FString;
2982   ];
2983
2984   (* Version numbers. *)
2985   "version", [
2986     "major", FInt64;
2987     "minor", FInt64;
2988     "release", FInt64;
2989     "extra", FString;
2990   ];
2991 ] (* end of structs *)
2992
2993 (* Ugh, Java has to be different ..
2994  * These names are also used by the Haskell bindings.
2995  *)
2996 let java_structs = [
2997   "int_bool", "IntBool";
2998   "lvm_pv", "PV";
2999   "lvm_vg", "VG";
3000   "lvm_lv", "LV";
3001   "stat", "Stat";
3002   "statvfs", "StatVFS";
3003   "dirent", "Dirent";
3004   "version", "Version";
3005 ]
3006
3007 (* Used for testing language bindings. *)
3008 type callt =
3009   | CallString of string
3010   | CallOptString of string option
3011   | CallStringList of string list
3012   | CallInt of int
3013   | CallBool of bool
3014
3015 (* Used to memoize the result of pod2text. *)
3016 let pod2text_memo_filename = "src/.pod2text.data"
3017 let pod2text_memo : ((int * string * string), string list) Hashtbl.t =
3018   try
3019     let chan = open_in pod2text_memo_filename in
3020     let v = input_value chan in
3021     close_in chan;
3022     v
3023   with
3024     _ -> Hashtbl.create 13
3025
3026 (* Useful functions.
3027  * Note we don't want to use any external OCaml libraries which
3028  * makes this a bit harder than it should be.
3029  *)
3030 let failwithf fs = ksprintf failwith fs
3031
3032 let replace_char s c1 c2 =
3033   let s2 = String.copy s in
3034   let r = ref false in
3035   for i = 0 to String.length s2 - 1 do
3036     if String.unsafe_get s2 i = c1 then (
3037       String.unsafe_set s2 i c2;
3038       r := true
3039     )
3040   done;
3041   if not !r then s else s2
3042
3043 let isspace c =
3044   c = ' '
3045   (* || c = '\f' *) || c = '\n' || c = '\r' || c = '\t' (* || c = '\v' *)
3046
3047 let triml ?(test = isspace) str =
3048   let i = ref 0 in
3049   let n = ref (String.length str) in
3050   while !n > 0 && test str.[!i]; do
3051     decr n;
3052     incr i
3053   done;
3054   if !i = 0 then str
3055   else String.sub str !i !n
3056
3057 let trimr ?(test = isspace) str =
3058   let n = ref (String.length str) in
3059   while !n > 0 && test str.[!n-1]; do
3060     decr n
3061   done;
3062   if !n = String.length str then str
3063   else String.sub str 0 !n
3064
3065 let trim ?(test = isspace) str =
3066   trimr ~test (triml ~test str)
3067
3068 let rec find s sub =
3069   let len = String.length s in
3070   let sublen = String.length sub in
3071   let rec loop i =
3072     if i <= len-sublen then (
3073       let rec loop2 j =
3074         if j < sublen then (
3075           if s.[i+j] = sub.[j] then loop2 (j+1)
3076           else -1
3077         ) else
3078           i (* found *)
3079       in
3080       let r = loop2 0 in
3081       if r = -1 then loop (i+1) else r
3082     ) else
3083       -1 (* not found *)
3084   in
3085   loop 0
3086
3087 let rec replace_str s s1 s2 =
3088   let len = String.length s in
3089   let sublen = String.length s1 in
3090   let i = find s s1 in
3091   if i = -1 then s
3092   else (
3093     let s' = String.sub s 0 i in
3094     let s'' = String.sub s (i+sublen) (len-i-sublen) in
3095     s' ^ s2 ^ replace_str s'' s1 s2
3096   )
3097
3098 let rec string_split sep str =
3099   let len = String.length str in
3100   let seplen = String.length sep in
3101   let i = find str sep in
3102   if i = -1 then [str]
3103   else (
3104     let s' = String.sub str 0 i in
3105     let s'' = String.sub str (i+seplen) (len-i-seplen) in
3106     s' :: string_split sep s''
3107   )
3108
3109 let files_equal n1 n2 =
3110   let cmd = sprintf "cmp -s %s %s" (Filename.quote n1) (Filename.quote n2) in
3111   match Sys.command cmd with
3112   | 0 -> true
3113   | 1 -> false
3114   | i -> failwithf "%s: failed with error code %d" cmd i
3115
3116 let rec find_map f = function
3117   | [] -> raise Not_found
3118   | x :: xs ->
3119       match f x with
3120       | Some y -> y
3121       | None -> find_map f xs
3122
3123 let iteri f xs =
3124   let rec loop i = function
3125     | [] -> ()
3126     | x :: xs -> f i x; loop (i+1) xs
3127   in
3128   loop 0 xs
3129
3130 let mapi f xs =
3131   let rec loop i = function
3132     | [] -> []
3133     | x :: xs -> let r = f i x in r :: loop (i+1) xs
3134   in
3135   loop 0 xs
3136
3137 let name_of_argt = function
3138   | String n | OptString n | StringList n | Bool n | Int n
3139   | FileIn n | FileOut n -> n
3140
3141 let java_name_of_struct typ =
3142   try List.assoc typ java_structs
3143   with Not_found ->
3144     failwithf
3145       "java_name_of_struct: no java_structs entry corresponding to %s" typ
3146
3147 let cols_of_struct typ =
3148   try List.assoc typ structs
3149   with Not_found ->
3150     failwithf "cols_of_struct: unknown struct %s" typ
3151
3152 let seq_of_test = function
3153   | TestRun s | TestOutput (s, _) | TestOutputList (s, _)
3154   | TestOutputListOfDevices (s, _)
3155   | TestOutputInt (s, _) | TestOutputTrue s | TestOutputFalse s
3156   | TestOutputLength (s, _) | TestOutputStruct (s, _)
3157   | TestLastFail s -> s
3158
3159 (* Check function names etc. for consistency. *)
3160 let check_functions () =
3161   let contains_uppercase str =
3162     let len = String.length str in
3163     let rec loop i =
3164       if i >= len then false
3165       else (
3166         let c = str.[i] in
3167         if c >= 'A' && c <= 'Z' then true
3168         else loop (i+1)
3169       )
3170     in
3171     loop 0
3172   in
3173
3174   (* Check function names. *)
3175   List.iter (
3176     fun (name, _, _, _, _, _, _) ->
3177       if String.length name >= 7 && String.sub name 0 7 = "guestfs" then
3178         failwithf "function name %s does not need 'guestfs' prefix" name;
3179       if name = "" then
3180         failwithf "function name is empty";
3181       if name.[0] < 'a' || name.[0] > 'z' then
3182         failwithf "function name %s must start with lowercase a-z" name;
3183       if String.contains name '-' then
3184         failwithf "function name %s should not contain '-', use '_' instead."
3185           name
3186   ) all_functions;
3187
3188   (* Check function parameter/return names. *)
3189   List.iter (
3190     fun (name, style, _, _, _, _, _) ->
3191       let check_arg_ret_name n =
3192         if contains_uppercase n then
3193           failwithf "%s param/ret %s should not contain uppercase chars"
3194             name n;
3195         if String.contains n '-' || String.contains n '_' then
3196           failwithf "%s param/ret %s should not contain '-' or '_'"
3197             name n;
3198         if n = "value" then
3199           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;
3200         if n = "int" || n = "char" || n = "short" || n = "long" then
3201           failwithf "%s has a param/ret which conflicts with a C type (eg. 'int', 'char' etc.)" name;
3202         if n = "i" || n = "n" then
3203           failwithf "%s has a param/ret called 'i' or 'n', which will cause some conflicts in the generated code" name;
3204         if n = "argv" || n = "args" then
3205           failwithf "%s has a param/ret called 'argv' or 'args', which will cause some conflicts in the generated code" name
3206       in
3207
3208       (match fst style with
3209        | RErr -> ()
3210        | RInt n | RInt64 n | RBool n | RConstString n | RString n
3211        | RStringList n | RStruct (n, _) | RStructList (n, _)
3212        | RHashtable n ->
3213            check_arg_ret_name n
3214       );
3215       List.iter (fun arg -> check_arg_ret_name (name_of_argt arg)) (snd style)
3216   ) all_functions;
3217
3218   (* Check short descriptions. *)
3219   List.iter (
3220     fun (name, _, _, _, _, shortdesc, _) ->
3221       if shortdesc.[0] <> Char.lowercase shortdesc.[0] then
3222         failwithf "short description of %s should begin with lowercase." name;
3223       let c = shortdesc.[String.length shortdesc-1] in
3224       if c = '\n' || c = '.' then
3225         failwithf "short description of %s should not end with . or \\n." name
3226   ) all_functions;
3227
3228   (* Check long dscriptions. *)
3229   List.iter (
3230     fun (name, _, _, _, _, _, longdesc) ->
3231       if longdesc.[String.length longdesc-1] = '\n' then
3232         failwithf "long description of %s should not end with \\n." name
3233   ) all_functions;
3234
3235   (* Check proc_nrs. *)
3236   List.iter (
3237     fun (name, _, proc_nr, _, _, _, _) ->
3238       if proc_nr <= 0 then
3239         failwithf "daemon function %s should have proc_nr > 0" name
3240   ) daemon_functions;
3241
3242   List.iter (
3243     fun (name, _, proc_nr, _, _, _, _) ->
3244       if proc_nr <> -1 then
3245         failwithf "non-daemon function %s should have proc_nr -1" name
3246   ) non_daemon_functions;
3247
3248   let proc_nrs =
3249     List.map (fun (name, _, proc_nr, _, _, _, _) -> name, proc_nr)
3250       daemon_functions in
3251   let proc_nrs =
3252     List.sort (fun (_,nr1) (_,nr2) -> compare nr1 nr2) proc_nrs in
3253   let rec loop = function
3254     | [] -> ()
3255     | [_] -> ()
3256     | (name1,nr1) :: ((name2,nr2) :: _ as rest) when nr1 < nr2 ->
3257         loop rest
3258     | (name1,nr1) :: (name2,nr2) :: _ ->
3259         failwithf "%s and %s have conflicting procedure numbers (%d, %d)"
3260           name1 name2 nr1 nr2
3261   in
3262   loop proc_nrs;
3263
3264   (* Check tests. *)
3265   List.iter (
3266     function
3267       (* Ignore functions that have no tests.  We generate a
3268        * warning when the user does 'make check' instead.
3269        *)
3270     | name, _, _, _, [], _, _ -> ()
3271     | name, _, _, _, tests, _, _ ->
3272         let funcs =
3273           List.map (
3274             fun (_, _, test) ->
3275               match seq_of_test test with
3276               | [] ->
3277                   failwithf "%s has a test containing an empty sequence" name
3278               | cmds -> List.map List.hd cmds
3279           ) tests in
3280         let funcs = List.flatten funcs in
3281
3282         let tested = List.mem name funcs in
3283
3284         if not tested then
3285           failwithf "function %s has tests but does not test itself" name
3286   ) all_functions
3287
3288 (* 'pr' prints to the current output file. *)
3289 let chan = ref stdout
3290 let pr fs = ksprintf (output_string !chan) fs
3291
3292 (* Generate a header block in a number of standard styles. *)
3293 type comment_style = CStyle | HashStyle | OCamlStyle | HaskellStyle
3294 type license = GPLv2 | LGPLv2
3295
3296 let generate_header comment license =
3297   let c = match comment with
3298     | CStyle ->     pr "/* "; " *"
3299     | HashStyle ->  pr "# ";  "#"
3300     | OCamlStyle -> pr "(* "; " *"
3301     | HaskellStyle -> pr "{- "; "  " in
3302   pr "libguestfs generated file\n";
3303   pr "%s WARNING: THIS FILE IS GENERATED BY 'src/generator.ml'.\n" c;
3304   pr "%s ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.\n" c;
3305   pr "%s\n" c;
3306   pr "%s Copyright (C) 2009 Red Hat Inc.\n" c;
3307   pr "%s\n" c;
3308   (match license with
3309    | GPLv2 ->
3310        pr "%s This program is free software; you can redistribute it and/or modify\n" c;
3311        pr "%s it under the terms of the GNU General Public License as published by\n" c;
3312        pr "%s the Free Software Foundation; either version 2 of the License, or\n" c;
3313        pr "%s (at your option) any later version.\n" c;
3314        pr "%s\n" c;
3315        pr "%s This program is distributed in the hope that it will be useful,\n" c;
3316        pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
3317        pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n" c;
3318        pr "%s GNU General Public License for more details.\n" c;
3319        pr "%s\n" c;
3320        pr "%s You should have received a copy of the GNU General Public License along\n" c;
3321        pr "%s with this program; if not, write to the Free Software Foundation, Inc.,\n" c;
3322        pr "%s 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n" c;
3323
3324    | LGPLv2 ->
3325        pr "%s This library is free software; you can redistribute it and/or\n" c;
3326        pr "%s modify it under the terms of the GNU Lesser General Public\n" c;
3327        pr "%s License as published by the Free Software Foundation; either\n" c;
3328        pr "%s version 2 of the License, or (at your option) any later version.\n" c;
3329        pr "%s\n" c;
3330        pr "%s This library is distributed in the hope that it will be useful,\n" c;
3331        pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
3332        pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU\n" c;
3333        pr "%s Lesser General Public License for more details.\n" c;
3334        pr "%s\n" c;
3335        pr "%s You should have received a copy of the GNU Lesser General Public\n" c;
3336        pr "%s License along with this library; if not, write to the Free Software\n" c;
3337        pr "%s Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n" c;
3338   );
3339   (match comment with
3340    | CStyle -> pr " */\n"
3341    | HashStyle -> ()
3342    | OCamlStyle -> pr " *)\n"
3343    | HaskellStyle -> pr "-}\n"
3344   );
3345   pr "\n"
3346
3347 (* Start of main code generation functions below this line. *)
3348
3349 (* Generate the pod documentation for the C API. *)
3350 let rec generate_actions_pod () =
3351   List.iter (
3352     fun (shortname, style, _, flags, _, _, longdesc) ->
3353       if not (List.mem NotInDocs flags) then (
3354         let name = "guestfs_" ^ shortname in
3355         pr "=head2 %s\n\n" name;
3356         pr " ";
3357         generate_prototype ~extern:false ~handle:"handle" name style;
3358         pr "\n\n";
3359         pr "%s\n\n" longdesc;
3360         (match fst style with
3361          | RErr ->
3362              pr "This function returns 0 on success or -1 on error.\n\n"
3363          | RInt _ ->
3364              pr "On error this function returns -1.\n\n"
3365          | RInt64 _ ->
3366              pr "On error this function returns -1.\n\n"
3367          | RBool _ ->
3368              pr "This function returns a C truth value on success or -1 on error.\n\n"
3369          | RConstString _ ->
3370              pr "This function returns a string, or NULL on error.
3371 The string is owned by the guest handle and must I<not> be freed.\n\n"
3372          | RString _ ->
3373              pr "This function returns a string, or NULL on error.
3374 I<The caller must free the returned string after use>.\n\n"
3375          | RStringList _ ->
3376              pr "This function returns a NULL-terminated array of strings
3377 (like L<environ(3)>), or NULL if there was an error.
3378 I<The caller must free the strings and the array after use>.\n\n"
3379          | RStruct (_, typ) ->
3380              pr "This function returns a C<struct guestfs_%s *>,
3381 or NULL if there was an error.
3382 I<The caller must call C<guestfs_free_%s> after use>.\n\n" typ typ
3383          | RStructList (_, typ) ->
3384              pr "This function returns a C<struct guestfs_%s_list *>
3385 (see E<lt>guestfs-structs.hE<gt>),
3386 or NULL if there was an error.
3387 I<The caller must call C<guestfs_free_%s_list> after use>.\n\n" typ typ
3388          | RHashtable _ ->
3389              pr "This function returns a NULL-terminated array of
3390 strings, or NULL if there was an error.
3391 The array of strings will always have length C<2n+1>, where
3392 C<n> keys and values alternate, followed by the trailing NULL entry.
3393 I<The caller must free the strings and the array after use>.\n\n"
3394         );
3395         if List.mem ProtocolLimitWarning flags then
3396           pr "%s\n\n" protocol_limit_warning;
3397         if List.mem DangerWillRobinson flags then
3398           pr "%s\n\n" danger_will_robinson
3399       )
3400   ) all_functions_sorted
3401
3402 and generate_structs_pod () =
3403   (* Structs documentation. *)
3404   List.iter (
3405     fun (typ, cols) ->
3406       pr "=head2 guestfs_%s\n" typ;
3407       pr "\n";
3408       pr " struct guestfs_%s {\n" typ;
3409       List.iter (
3410         function
3411         | name, FChar -> pr "   char %s;\n" name
3412         | name, FUInt32 -> pr "   uint32_t %s;\n" name
3413         | name, FInt32 -> pr "   int32_t %s;\n" name
3414         | name, (FUInt64|FBytes) -> pr "   uint64_t %s;\n" name
3415         | name, FInt64 -> pr "   int64_t %s;\n" name
3416         | name, FString -> pr "   char *%s;\n" name
3417         | name, FUUID ->
3418             pr "   /* The next field is NOT nul-terminated, be careful when printing it: */\n";
3419             pr "   char %s[32];\n" name
3420         | name, FOptPercent ->
3421             pr "   /* The next field is [0..100] or -1 meaning 'not present': */\n";
3422             pr "   float %s;\n" name
3423       ) cols;
3424       pr " };\n";
3425       pr " \n";
3426       pr " struct guestfs_%s_list {\n" typ;
3427       pr "   uint32_t len; /* Number of elements in list. */\n";
3428       pr "   struct guestfs_%s *val; /* Elements. */\n" typ;
3429       pr " };\n";
3430       pr " \n";
3431       pr " void guestfs_free_%s (struct guestfs_free_%s *);\n" typ typ;
3432       pr " void guestfs_free_%s_list (struct guestfs_free_%s_list *);\n"
3433         typ typ;
3434       pr "\n"
3435   ) structs
3436
3437 (* Generate the protocol (XDR) file, 'guestfs_protocol.x' and
3438  * indirectly 'guestfs_protocol.h' and 'guestfs_protocol.c'.
3439  *
3440  * We have to use an underscore instead of a dash because otherwise
3441  * rpcgen generates incorrect code.
3442  *
3443  * This header is NOT exported to clients, but see also generate_structs_h.
3444  *)
3445 and generate_xdr () =
3446   generate_header CStyle LGPLv2;
3447
3448   (* This has to be defined to get around a limitation in Sun's rpcgen. *)
3449   pr "typedef string str<>;\n";
3450   pr "\n";
3451
3452   (* Internal structures. *)
3453   List.iter (
3454     function
3455     | typ, cols ->
3456         pr "struct guestfs_int_%s {\n" typ;
3457         List.iter (function
3458                    | name, FChar -> pr "  char %s;\n" name
3459                    | name, FString -> pr "  string %s<>;\n" name
3460                    | name, FUUID -> pr "  opaque %s[32];\n" name
3461                    | name, (FInt32|FUInt32) -> pr "  int %s;\n" name
3462                    | name, (FInt64|FUInt64|FBytes) -> pr "  hyper %s;\n" name
3463                    | name, FOptPercent -> pr "  float %s;\n" name
3464                   ) cols;
3465         pr "};\n";
3466         pr "\n";
3467         pr "typedef struct guestfs_int_%s guestfs_int_%s_list<>;\n" typ typ;
3468         pr "\n";
3469   ) structs;
3470
3471   List.iter (
3472     fun (shortname, style, _, _, _, _, _) ->
3473       let name = "guestfs_" ^ shortname in
3474
3475       (match snd style with
3476        | [] -> ()
3477        | args ->
3478            pr "struct %s_args {\n" name;
3479            List.iter (
3480              function
3481              | String n -> pr "  string %s<>;\n" n
3482              | OptString n -> pr "  str *%s;\n" n
3483              | StringList n -> pr "  str %s<>;\n" n
3484              | Bool n -> pr "  bool %s;\n" n
3485              | Int n -> pr "  int %s;\n" n
3486              | FileIn _ | FileOut _ -> ()
3487            ) args;
3488            pr "};\n\n"
3489       );
3490       (match fst style with
3491        | RErr -> ()
3492        | RInt n ->
3493            pr "struct %s_ret {\n" name;
3494            pr "  int %s;\n" n;
3495            pr "};\n\n"
3496        | RInt64 n ->
3497            pr "struct %s_ret {\n" name;
3498            pr "  hyper %s;\n" n;
3499            pr "};\n\n"
3500        | RBool n ->
3501            pr "struct %s_ret {\n" name;
3502            pr "  bool %s;\n" n;
3503            pr "};\n\n"
3504        | RConstString _ ->
3505            failwithf "RConstString cannot be returned from a daemon function"
3506        | RString n ->
3507            pr "struct %s_ret {\n" name;
3508            pr "  string %s<>;\n" n;
3509            pr "};\n\n"
3510        | RStringList n ->
3511            pr "struct %s_ret {\n" name;
3512            pr "  str %s<>;\n" n;
3513            pr "};\n\n"
3514        | RStruct (n, typ) ->
3515            pr "struct %s_ret {\n" name;
3516            pr "  guestfs_int_%s %s;\n" typ n;
3517            pr "};\n\n"
3518        | RStructList (n, typ) ->
3519            pr "struct %s_ret {\n" name;
3520            pr "  guestfs_int_%s_list %s;\n" typ n;
3521            pr "};\n\n"
3522        | RHashtable n ->
3523            pr "struct %s_ret {\n" name;
3524            pr "  str %s<>;\n" n;
3525            pr "};\n\n"
3526       );
3527   ) daemon_functions;
3528
3529   (* Table of procedure numbers. *)
3530   pr "enum guestfs_procedure {\n";
3531   List.iter (
3532     fun (shortname, _, proc_nr, _, _, _, _) ->
3533       pr "  GUESTFS_PROC_%s = %d,\n" (String.uppercase shortname) proc_nr
3534   ) daemon_functions;
3535   pr "  GUESTFS_PROC_NR_PROCS\n";
3536   pr "};\n";
3537   pr "\n";
3538
3539   (* Having to choose a maximum message size is annoying for several
3540    * reasons (it limits what we can do in the API), but it (a) makes
3541    * the protocol a lot simpler, and (b) provides a bound on the size
3542    * of the daemon which operates in limited memory space.  For large
3543    * file transfers you should use FTP.
3544    *)
3545   pr "const GUESTFS_MESSAGE_MAX = %d;\n" (4 * 1024 * 1024);
3546   pr "\n";
3547
3548   (* Message header, etc. *)
3549   pr "\
3550 /* The communication protocol is now documented in the guestfs(3)
3551  * manpage.
3552  */
3553
3554 const GUESTFS_PROGRAM = 0x2000F5F5;
3555 const GUESTFS_PROTOCOL_VERSION = 1;
3556
3557 /* These constants must be larger than any possible message length. */
3558 const GUESTFS_LAUNCH_FLAG = 0xf5f55ff5;
3559 const GUESTFS_CANCEL_FLAG = 0xffffeeee;
3560
3561 enum guestfs_message_direction {
3562   GUESTFS_DIRECTION_CALL = 0,        /* client -> daemon */
3563   GUESTFS_DIRECTION_REPLY = 1        /* daemon -> client */
3564 };
3565
3566 enum guestfs_message_status {
3567   GUESTFS_STATUS_OK = 0,
3568   GUESTFS_STATUS_ERROR = 1
3569 };
3570
3571 const GUESTFS_ERROR_LEN = 256;
3572
3573 struct guestfs_message_error {
3574   string error_message<GUESTFS_ERROR_LEN>;
3575 };
3576
3577 struct guestfs_message_header {
3578   unsigned prog;                     /* GUESTFS_PROGRAM */
3579   unsigned vers;                     /* GUESTFS_PROTOCOL_VERSION */
3580   guestfs_procedure proc;            /* GUESTFS_PROC_x */
3581   guestfs_message_direction direction;
3582   unsigned serial;                   /* message serial number */
3583   guestfs_message_status status;
3584 };
3585
3586 const GUESTFS_MAX_CHUNK_SIZE = 8192;
3587
3588 struct guestfs_chunk {
3589   int cancel;                        /* if non-zero, transfer is cancelled */
3590   /* data size is 0 bytes if the transfer has finished successfully */
3591   opaque data<GUESTFS_MAX_CHUNK_SIZE>;
3592 };
3593 "
3594
3595 (* Generate the guestfs-structs.h file. *)
3596 and generate_structs_h () =
3597   generate_header CStyle LGPLv2;
3598
3599   (* This is a public exported header file containing various
3600    * structures.  The structures are carefully written to have
3601    * exactly the same in-memory format as the XDR structures that
3602    * we use on the wire to the daemon.  The reason for creating
3603    * copies of these structures here is just so we don't have to
3604    * export the whole of guestfs_protocol.h (which includes much
3605    * unrelated and XDR-dependent stuff that we don't want to be
3606    * public, or required by clients).
3607    *
3608    * To reiterate, we will pass these structures to and from the
3609    * client with a simple assignment or memcpy, so the format
3610    * must be identical to what rpcgen / the RFC defines.
3611    *)
3612
3613   (* Public structures. *)
3614   List.iter (
3615     fun (typ, cols) ->
3616       pr "struct guestfs_%s {\n" typ;
3617       List.iter (
3618         function
3619         | name, FChar -> pr "  char %s;\n" name
3620         | name, FString -> pr "  char *%s;\n" name
3621         | name, FUUID -> pr "  char %s[32]; /* this is NOT nul-terminated, be careful when printing */\n" name
3622         | name, FUInt32 -> pr "  uint32_t %s;\n" name
3623         | name, FInt32 -> pr "  int32_t %s;\n" name
3624         | name, (FUInt64|FBytes) -> pr "  uint64_t %s;\n" name
3625         | name, FInt64 -> pr "  int64_t %s;\n" name
3626         | name, FOptPercent -> pr "  float %s; /* [0..100] or -1 */\n" name
3627       ) cols;
3628       pr "};\n";
3629       pr "\n";
3630       pr "struct guestfs_%s_list {\n" typ;
3631       pr "  uint32_t len;\n";
3632       pr "  struct guestfs_%s *val;\n" typ;
3633       pr "};\n";
3634       pr "\n";
3635       pr "extern void guestfs_free_%s (struct guestfs_%s *);\n" typ typ;
3636       pr "extern void guestfs_free_%s_list (struct guestfs_%s_list *);\n" typ typ;
3637       pr "\n"
3638   ) structs
3639
3640 (* Generate the guestfs-actions.h file. *)
3641 and generate_actions_h () =
3642   generate_header CStyle LGPLv2;
3643   List.iter (
3644     fun (shortname, style, _, _, _, _, _) ->
3645       let name = "guestfs_" ^ shortname in
3646       generate_prototype ~single_line:true ~newline:true ~handle:"handle"
3647         name style
3648   ) all_functions
3649
3650 (* Generate the client-side dispatch stubs. *)
3651 and generate_client_actions () =
3652   generate_header CStyle LGPLv2;
3653
3654   pr "\
3655 #include <stdio.h>
3656 #include <stdlib.h>
3657
3658 #include \"guestfs.h\"
3659 #include \"guestfs_protocol.h\"
3660
3661 #define error guestfs_error
3662 #define perrorf guestfs_perrorf
3663 #define safe_malloc guestfs_safe_malloc
3664 #define safe_realloc guestfs_safe_realloc
3665 #define safe_strdup guestfs_safe_strdup
3666 #define safe_memdup guestfs_safe_memdup
3667
3668 /* Check the return message from a call for validity. */
3669 static int
3670 check_reply_header (guestfs_h *g,
3671                     const struct guestfs_message_header *hdr,
3672                     int proc_nr, int serial)
3673 {
3674   if (hdr->prog != GUESTFS_PROGRAM) {
3675     error (g, \"wrong program (%%d/%%d)\", hdr->prog, GUESTFS_PROGRAM);
3676     return -1;
3677   }
3678   if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
3679     error (g, \"wrong protocol version (%%d/%%d)\",
3680            hdr->vers, GUESTFS_PROTOCOL_VERSION);
3681     return -1;
3682   }
3683   if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
3684     error (g, \"unexpected message direction (%%d/%%d)\",
3685            hdr->direction, GUESTFS_DIRECTION_REPLY);
3686     return -1;
3687   }
3688   if (hdr->proc != proc_nr) {
3689     error (g, \"unexpected procedure number (%%d/%%d)\", hdr->proc, proc_nr);
3690     return -1;
3691   }
3692   if (hdr->serial != serial) {
3693     error (g, \"unexpected serial (%%d/%%d)\", hdr->serial, serial);
3694     return -1;
3695   }
3696
3697   return 0;
3698 }
3699
3700 /* Check we are in the right state to run a high-level action. */