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