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