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