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