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