Implement 'vgrename' and 'lvrename' APIs.
[libguestfs.git] / src / generator.ml
1 #!/usr/bin/env ocaml
2 (* libguestfs
3  * Copyright (C) 2009-2010 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 of
25  * 'daemon_functions' below), and daemon/<somefile>.c to write the
26  * implementation.
27  * 
28  * After editing this file, run it (./src/generator.ml) to regenerate
29  * all the output files.  'make' will rerun this automatically when
30  * necessary.  Note that if you are using a separate build directory
31  * you must run generator.ml from the _source_ directory.
32  * 
33  * IMPORTANT: This script should NOT print any warnings.  If it prints
34  * warnings, you should treat them as errors.
35  *
36  * OCaml tips:
37  * (1) In emacs, install tuareg-mode to display and format OCaml code
38  * correctly.  'vim' comes with a good OCaml editing mode by default.
39  * (2) Read the resources at http://ocaml-tutorial.org/
40  *)
41
42 #load "unix.cma";;
43 #load "str.cma";;
44 #directory "+xml-light";;
45 #load "xml-light.cma";;
46
47 open Unix
48 open Printf
49
50 type style = ret * args
51 and ret =
52     (* "RErr" as a return value means an int used as a simple error
53      * indication, ie. 0 or -1.
54      *)
55   | RErr
56
57     (* "RInt" as a return value means an int which is -1 for error
58      * or any value >= 0 on success.  Only use this for smallish
59      * positive ints (0 <= i < 2^30).
60      *)
61   | RInt of string
62
63     (* "RInt64" is the same as RInt, but is guaranteed to be able
64      * to return a full 64 bit value, _except_ that -1 means error
65      * (so -1 cannot be a valid, non-error return value).
66      *)
67   | RInt64 of string
68
69     (* "RBool" is a bool return value which can be true/false or
70      * -1 for error.
71      *)
72   | RBool of string
73
74     (* "RConstString" is a string that refers to a constant value.
75      * The return value must NOT be NULL (since NULL indicates
76      * an error).
77      *
78      * Try to avoid using this.  In particular you cannot use this
79      * for values returned from the daemon, because there is no
80      * thread-safe way to return them in the C API.
81      *)
82   | RConstString of string
83
84     (* "RConstOptString" is an even more broken version of
85      * "RConstString".  The returned string may be NULL and there
86      * is no way to return an error indication.  Avoid using this!
87      *)
88   | RConstOptString of string
89
90     (* "RString" is a returned string.  It must NOT be NULL, since
91      * a NULL return indicates an error.  The caller frees this.
92      *)
93   | RString of string
94
95     (* "RStringList" is a list of strings.  No string in the list
96      * can be NULL.  The caller frees the strings and the array.
97      *)
98   | RStringList of string
99
100     (* "RStruct" is a function which returns a single named structure
101      * or an error indication (in C, a struct, and in other languages
102      * with varying representations, but usually very efficient).  See
103      * after the function list below for the structures.
104      *)
105   | RStruct of string * string          (* name of retval, name of struct *)
106
107     (* "RStructList" is a function which returns either a list/array
108      * of structures (could be zero-length), or an error indication.
109      *)
110   | RStructList of string * string      (* name of retval, name of struct *)
111
112     (* Key-value pairs of untyped strings.  Turns into a hashtable or
113      * dictionary in languages which support it.  DON'T use this as a
114      * general "bucket" for results.  Prefer a stronger typed return
115      * value if one is available, or write a custom struct.  Don't use
116      * this if the list could potentially be very long, since it is
117      * inefficient.  Keys should be unique.  NULLs are not permitted.
118      *)
119   | RHashtable of string
120
121     (* "RBufferOut" is handled almost exactly like RString, but
122      * it allows the string to contain arbitrary 8 bit data including
123      * ASCII NUL.  In the C API this causes an implicit extra parameter
124      * to be added of type <size_t *size_r>.  The extra parameter
125      * returns the actual size of the return buffer in bytes.
126      *
127      * Other programming languages support strings with arbitrary 8 bit
128      * data.
129      *
130      * At the RPC layer we have to use the opaque<> type instead of
131      * string<>.  Returned data is still limited to the max message
132      * size (ie. ~ 2 MB).
133      *)
134   | RBufferOut of string
135
136 and args = argt list    (* Function parameters, guestfs handle is implicit. *)
137
138     (* Note in future we should allow a "variable args" parameter as
139      * the final parameter, to allow commands like
140      *   chmod mode file [file(s)...]
141      * This is not implemented yet, but many commands (such as chmod)
142      * are currently defined with the argument order keeping this future
143      * possibility in mind.
144      *)
145 and argt =
146   | String of string    (* const char *name, cannot be NULL *)
147   | Device of string    (* /dev device name, cannot be NULL *)
148   | Pathname of string  (* file name, cannot be NULL *)
149   | Dev_or_Path of string (* /dev device name or Pathname, cannot be NULL *)
150   | OptString of string (* const char *name, may be NULL *)
151   | StringList of string(* list of strings (each string cannot be NULL) *)
152   | DeviceList of string(* list of Device names (each cannot be NULL) *)
153   | Bool of string      (* boolean *)
154   | Int of string       (* int (smallish ints, signed, <= 31 bits) *)
155   | Int64 of string     (* any 64 bit int *)
156     (* These are treated as filenames (simple string parameters) in
157      * the C API and bindings.  But in the RPC protocol, we transfer
158      * the actual file content up to or down from the daemon.
159      * FileIn: local machine -> daemon (in request)
160      * FileOut: daemon -> local machine (in reply)
161      * In guestfish (only), the special name "-" means read from
162      * stdin or write to stdout.
163      *)
164   | FileIn of string
165   | FileOut of string
166 (* Not implemented:
167     (* Opaque buffer which can contain arbitrary 8 bit data.
168      * In the C API, this is expressed as <char *, int> pair.
169      * Most other languages have a string type which can contain
170      * ASCII NUL.  We use whatever type is appropriate for each
171      * language.
172      * Buffers are limited by the total message size.  To transfer
173      * large blocks of data, use FileIn/FileOut parameters instead.
174      * To return an arbitrary buffer, use RBufferOut.
175      *)
176   | BufferIn of string
177 *)
178
179 type flags =
180   | ProtocolLimitWarning  (* display warning about protocol size limits *)
181   | DangerWillRobinson    (* flags particularly dangerous commands *)
182   | FishAlias of string   (* provide an alias for this cmd in guestfish *)
183   | FishAction of string  (* call this function in guestfish *)
184   | NotInFish             (* do not export via guestfish *)
185   | NotInDocs             (* do not add this function to documentation *)
186   | DeprecatedBy of string (* function is deprecated, use .. instead *)
187   | Optional of string    (* function is part of an optional group *)
188
189 (* You can supply zero or as many tests as you want per API call.
190  *
191  * Note that the test environment has 3 block devices, of size 500MB,
192  * 50MB and 10MB (respectively /dev/sda, /dev/sdb, /dev/sdc), and
193  * a fourth ISO block device with some known files on it (/dev/sdd).
194  *
195  * Note for partitioning purposes, the 500MB device has 1015 cylinders.
196  * Number of cylinders was 63 for IDE emulated disks with precisely
197  * the same size.  How exactly this is calculated is a mystery.
198  *
199  * The ISO block device (/dev/sdd) comes from images/test.iso.
200  *
201  * To be able to run the tests in a reasonable amount of time,
202  * the virtual machine and block devices are reused between tests.
203  * So don't try testing kill_subprocess :-x
204  *
205  * Between each test we blockdev-setrw, umount-all, lvm-remove-all.
206  *
207  * Don't assume anything about the previous contents of the block
208  * devices.  Use 'Init*' to create some initial scenarios.
209  *
210  * You can add a prerequisite clause to any individual test.  This
211  * is a run-time check, which, if it fails, causes the test to be
212  * skipped.  Useful if testing a command which might not work on
213  * all variations of libguestfs builds.  A test that has prerequisite
214  * of 'Always' is run unconditionally.
215  *
216  * In addition, packagers can skip individual tests by setting the
217  * environment variables:     eg:
218  *   SKIP_TEST_<CMD>_<NUM>=1  SKIP_TEST_COMMAND_3=1  (skips test #3 of command)
219  *   SKIP_TEST_<CMD>=1        SKIP_TEST_ZEROFREE=1   (skips all zerofree tests)
220  *)
221 type tests = (test_init * test_prereq * test) list
222 and test =
223     (* Run the command sequence and just expect nothing to fail. *)
224   | TestRun of seq
225
226     (* Run the command sequence and expect the output of the final
227      * command to be the string.
228      *)
229   | TestOutput of seq * string
230
231     (* Run the command sequence and expect the output of the final
232      * command to be the list of strings.
233      *)
234   | TestOutputList of seq * string list
235
236     (* Run the command sequence and expect the output of the final
237      * command to be the list of block devices (could be either
238      * "/dev/sd.." or "/dev/hd.." form - we don't check the 5th
239      * character of each string).
240      *)
241   | TestOutputListOfDevices of seq * string list
242
243     (* Run the command sequence and expect the output of the final
244      * command to be the integer.
245      *)
246   | TestOutputInt of seq * int
247
248     (* Run the command sequence and expect the output of the final
249      * command to be <op> <int>, eg. ">=", "1".
250      *)
251   | TestOutputIntOp of seq * string * int
252
253     (* Run the command sequence and expect the output of the final
254      * command to be a true value (!= 0 or != NULL).
255      *)
256   | TestOutputTrue of seq
257
258     (* Run the command sequence and expect the output of the final
259      * command to be a false value (== 0 or == NULL, but not an error).
260      *)
261   | TestOutputFalse of seq
262
263     (* Run the command sequence and expect the output of the final
264      * command to be a list of the given length (but don't care about
265      * content).
266      *)
267   | TestOutputLength of seq * int
268
269     (* Run the command sequence and expect the output of the final
270      * command to be a buffer (RBufferOut), ie. string + size.
271      *)
272   | TestOutputBuffer of seq * string
273
274     (* Run the command sequence and expect the output of the final
275      * command to be a structure.
276      *)
277   | TestOutputStruct of seq * test_field_compare list
278
279     (* Run the command sequence and expect the final command (only)
280      * to fail.
281      *)
282   | TestLastFail of seq
283
284 and test_field_compare =
285   | CompareWithInt of string * int
286   | CompareWithIntOp of string * string * int
287   | CompareWithString of string * string
288   | CompareFieldsIntEq of string * string
289   | CompareFieldsStrEq of string * string
290
291 (* Test prerequisites. *)
292 and test_prereq =
293     (* Test always runs. *)
294   | Always
295
296     (* Test is currently disabled - eg. it fails, or it tests some
297      * unimplemented feature.
298      *)
299   | Disabled
300
301     (* 'string' is some C code (a function body) that should return
302      * true or false.  The test will run if the code returns true.
303      *)
304   | If of string
305
306     (* As for 'If' but the test runs _unless_ the code returns true. *)
307   | Unless of string
308
309 (* Some initial scenarios for testing. *)
310 and test_init =
311     (* Do nothing, block devices could contain random stuff including
312      * LVM PVs, and some filesystems might be mounted.  This is usually
313      * a bad idea.
314      *)
315   | InitNone
316
317     (* Block devices are empty and no filesystems are mounted. *)
318   | InitEmpty
319
320     (* /dev/sda contains a single partition /dev/sda1, with random
321      * content.  /dev/sdb and /dev/sdc may have random content.
322      * No LVM.
323      *)
324   | InitPartition
325
326     (* /dev/sda contains a single partition /dev/sda1, which is formatted
327      * as ext2, empty [except for lost+found] and mounted on /.
328      * /dev/sdb and /dev/sdc may have random content.
329      * No LVM.
330      *)
331   | InitBasicFS
332
333     (* /dev/sda:
334      *   /dev/sda1 (is a PV):
335      *     /dev/VG/LV (size 8MB):
336      *       formatted as ext2, empty [except for lost+found], mounted on /
337      * /dev/sdb and /dev/sdc may have random content.
338      *)
339   | InitBasicFSonLVM
340
341     (* /dev/sdd (the ISO, see images/ directory in source)
342      * is mounted on /
343      *)
344   | InitISOFS
345
346 (* Sequence of commands for testing. *)
347 and seq = cmd list
348 and cmd = string list
349
350 (* Note about long descriptions: When referring to another
351  * action, use the format C<guestfs_other> (ie. the full name of
352  * the C function).  This will be replaced as appropriate in other
353  * language bindings.
354  *
355  * Apart from that, long descriptions are just perldoc paragraphs.
356  *)
357
358 (* Generate a random UUID (used in tests). *)
359 let uuidgen () =
360   let chan = open_process_in "uuidgen" in
361   let uuid = input_line chan in
362   (match close_process_in chan with
363    | WEXITED 0 -> ()
364    | WEXITED _ ->
365        failwith "uuidgen: process exited with non-zero status"
366    | WSIGNALED _ | WSTOPPED _ ->
367        failwith "uuidgen: process signalled or stopped by signal"
368   );
369   uuid
370
371 (* These test functions are used in the language binding tests. *)
372
373 let test_all_args = [
374   String "str";
375   OptString "optstr";
376   StringList "strlist";
377   Bool "b";
378   Int "integer";
379   Int64 "integer64";
380   FileIn "filein";
381   FileOut "fileout";
382 ]
383
384 let test_all_rets = [
385   (* except for RErr, which is tested thoroughly elsewhere *)
386   "test0rint",         RInt "valout";
387   "test0rint64",       RInt64 "valout";
388   "test0rbool",        RBool "valout";
389   "test0rconststring", RConstString "valout";
390   "test0rconstoptstring", RConstOptString "valout";
391   "test0rstring",      RString "valout";
392   "test0rstringlist",  RStringList "valout";
393   "test0rstruct",      RStruct ("valout", "lvm_pv");
394   "test0rstructlist",  RStructList ("valout", "lvm_pv");
395   "test0rhashtable",   RHashtable "valout";
396 ]
397
398 let test_functions = [
399   ("test0", (RErr, test_all_args), -1, [NotInFish; NotInDocs],
400    [],
401    "internal test function - do not use",
402    "\
403 This is an internal test function which is used to test whether
404 the automatically generated bindings can handle every possible
405 parameter type correctly.
406
407 It echos the contents of each parameter to stdout.
408
409 You probably don't want to call this function.");
410 ] @ List.flatten (
411   List.map (
412     fun (name, ret) ->
413       [(name, (ret, [String "val"]), -1, [NotInFish; NotInDocs],
414         [],
415         "internal test function - do not use",
416         "\
417 This is an internal test function which is used to test whether
418 the automatically generated bindings can handle every possible
419 return type correctly.
420
421 It converts string C<val> to the return type.
422
423 You probably don't want to call this function.");
424        (name ^ "err", (ret, []), -1, [NotInFish; NotInDocs],
425         [],
426         "internal test function - do not use",
427         "\
428 This is an internal test function which is used to test whether
429 the automatically generated bindings can handle every possible
430 return type correctly.
431
432 This function always returns an error.
433
434 You probably don't want to call this function.")]
435   ) test_all_rets
436 )
437
438 (* non_daemon_functions are any functions which don't get processed
439  * in the daemon, eg. functions for setting and getting local
440  * configuration values.
441  *)
442
443 let non_daemon_functions = test_functions @ [
444   ("launch", (RErr, []), -1, [FishAlias "run"; FishAction "launch"],
445    [],
446    "launch the qemu subprocess",
447    "\
448 Internally libguestfs is implemented by running a virtual machine
449 using L<qemu(1)>.
450
451 You should call this after configuring the handle
452 (eg. adding drives) but before performing any actions.");
453
454   ("wait_ready", (RErr, []), -1, [NotInFish],
455    [],
456    "wait until the qemu subprocess launches (no op)",
457    "\
458 This function is a no op.
459
460 In versions of the API E<lt> 1.0.71 you had to call this function
461 just after calling C<guestfs_launch> to wait for the launch
462 to complete.  However this is no longer necessary because
463 C<guestfs_launch> now does the waiting.
464
465 If you see any calls to this function in code then you can just
466 remove them, unless you want to retain compatibility with older
467 versions of the API.");
468
469   ("kill_subprocess", (RErr, []), -1, [],
470    [],
471    "kill the qemu subprocess",
472    "\
473 This kills the qemu subprocess.  You should never need to call this.");
474
475   ("add_drive", (RErr, [String "filename"]), -1, [FishAlias "add"],
476    [],
477    "add an image to examine or modify",
478    "\
479 This function adds a virtual machine disk image C<filename> to the
480 guest.  The first time you call this function, the disk appears as IDE
481 disk 0 (C</dev/sda>) in the guest, the second time as C</dev/sdb>, and
482 so on.
483
484 You don't necessarily need to be root when using libguestfs.  However
485 you obviously do need sufficient permissions to access the filename
486 for whatever operations you want to perform (ie. read access if you
487 just want to read the image or write access if you want to modify the
488 image).
489
490 This is equivalent to the qemu parameter
491 C<-drive file=filename,cache=off,if=...>.
492 C<cache=off> is omitted in cases where it is not supported by
493 the underlying filesystem.
494
495 Note that this call checks for the existence of C<filename>.  This
496 stops you from specifying other types of drive which are supported
497 by qemu such as C<nbd:> and C<http:> URLs.  To specify those, use
498 the general C<guestfs_config> call instead.");
499
500   ("add_cdrom", (RErr, [String "filename"]), -1, [FishAlias "cdrom"],
501    [],
502    "add a CD-ROM disk image to examine",
503    "\
504 This function adds a virtual CD-ROM disk image to the guest.
505
506 This is equivalent to the qemu parameter C<-cdrom filename>.
507
508 Note that this call checks for the existence of C<filename>.  This
509 stops you from specifying other types of drive which are supported
510 by qemu such as C<nbd:> and C<http:> URLs.  To specify those, use
511 the general C<guestfs_config> call instead.");
512
513   ("add_drive_ro", (RErr, [String "filename"]), -1, [FishAlias "add-ro"],
514    [],
515    "add a drive in snapshot mode (read-only)",
516    "\
517 This adds a drive in snapshot mode, making it effectively
518 read-only.
519
520 Note that writes to the device are allowed, and will be seen for
521 the duration of the guestfs handle, but they are written
522 to a temporary file which is discarded as soon as the guestfs
523 handle is closed.  We don't currently have any method to enable
524 changes to be committed, although qemu can support this.
525
526 This is equivalent to the qemu parameter
527 C<-drive file=filename,snapshot=on,if=...>.
528
529 Note that this call checks for the existence of C<filename>.  This
530 stops you from specifying other types of drive which are supported
531 by qemu such as C<nbd:> and C<http:> URLs.  To specify those, use
532 the general C<guestfs_config> call instead.");
533
534   ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"]), -1, [],
535    [],
536    "add qemu parameters",
537    "\
538 This can be used to add arbitrary qemu command line parameters
539 of the form C<-param value>.  Actually it's not quite arbitrary - we
540 prevent you from setting some parameters which would interfere with
541 parameters that we use.
542
543 The first character of C<param> string must be a C<-> (dash).
544
545 C<value> can be NULL.");
546
547   ("set_qemu", (RErr, [String "qemu"]), -1, [FishAlias "qemu"],
548    [],
549    "set the qemu binary",
550    "\
551 Set the qemu binary that we will use.
552
553 The default is chosen when the library was compiled by the
554 configure script.
555
556 You can also override this by setting the C<LIBGUESTFS_QEMU>
557 environment variable.
558
559 Setting C<qemu> to C<NULL> restores the default qemu binary.");
560
561   ("get_qemu", (RConstString "qemu", []), -1, [],
562    [InitNone, Always, TestRun (
563       [["get_qemu"]])],
564    "get the qemu binary",
565    "\
566 Return the current qemu binary.
567
568 This is always non-NULL.  If it wasn't set already, then this will
569 return the default qemu binary name.");
570
571   ("set_path", (RErr, [String "searchpath"]), -1, [FishAlias "path"],
572    [],
573    "set the search path",
574    "\
575 Set the path that libguestfs searches for kernel and initrd.img.
576
577 The default is C<$libdir/guestfs> unless overridden by setting
578 C<LIBGUESTFS_PATH> environment variable.
579
580 Setting C<path> to C<NULL> restores the default path.");
581
582   ("get_path", (RConstString "path", []), -1, [],
583    [InitNone, Always, TestRun (
584       [["get_path"]])],
585    "get the search path",
586    "\
587 Return the current search path.
588
589 This is always non-NULL.  If it wasn't set already, then this will
590 return the default path.");
591
592   ("set_append", (RErr, [OptString "append"]), -1, [FishAlias "append"],
593    [],
594    "add options to kernel command line",
595    "\
596 This function is used to add additional options to the
597 guest kernel command line.
598
599 The default is C<NULL> unless overridden by setting
600 C<LIBGUESTFS_APPEND> environment variable.
601
602 Setting C<append> to C<NULL> means I<no> additional options
603 are passed (libguestfs always adds a few of its own).");
604
605   ("get_append", (RConstOptString "append", []), -1, [],
606    (* This cannot be tested with the current framework.  The
607     * function can return NULL in normal operations, which the
608     * test framework interprets as an error.
609     *)
610    [],
611    "get the additional kernel options",
612    "\
613 Return the additional kernel options which are added to the
614 guest kernel command line.
615
616 If C<NULL> then no options are added.");
617
618   ("set_autosync", (RErr, [Bool "autosync"]), -1, [FishAlias "autosync"],
619    [],
620    "set autosync mode",
621    "\
622 If C<autosync> is true, this enables autosync.  Libguestfs will make a
623 best effort attempt to run C<guestfs_umount_all> followed by
624 C<guestfs_sync> when the handle is closed
625 (also if the program exits without closing handles).
626
627 This is disabled by default (except in guestfish where it is
628 enabled by default).");
629
630   ("get_autosync", (RBool "autosync", []), -1, [],
631    [InitNone, Always, TestRun (
632       [["get_autosync"]])],
633    "get autosync mode",
634    "\
635 Get the autosync flag.");
636
637   ("set_verbose", (RErr, [Bool "verbose"]), -1, [FishAlias "verbose"],
638    [],
639    "set verbose mode",
640    "\
641 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
642
643 Verbose messages are disabled unless the environment variable
644 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.");
645
646   ("get_verbose", (RBool "verbose", []), -1, [],
647    [],
648    "get verbose mode",
649    "\
650 This returns the verbose messages flag.");
651
652   ("is_ready", (RBool "ready", []), -1, [],
653    [InitNone, Always, TestOutputTrue (
654       [["is_ready"]])],
655    "is ready to accept commands",
656    "\
657 This returns true iff this handle is ready to accept commands
658 (in the C<READY> state).
659
660 For more information on states, see L<guestfs(3)>.");
661
662   ("is_config", (RBool "config", []), -1, [],
663    [InitNone, Always, TestOutputFalse (
664       [["is_config"]])],
665    "is in configuration state",
666    "\
667 This returns true iff this handle is being configured
668 (in the C<CONFIG> state).
669
670 For more information on states, see L<guestfs(3)>.");
671
672   ("is_launching", (RBool "launching", []), -1, [],
673    [InitNone, Always, TestOutputFalse (
674       [["is_launching"]])],
675    "is launching subprocess",
676    "\
677 This returns true iff this handle is launching the subprocess
678 (in the C<LAUNCHING> state).
679
680 For more information on states, see L<guestfs(3)>.");
681
682   ("is_busy", (RBool "busy", []), -1, [],
683    [InitNone, Always, TestOutputFalse (
684       [["is_busy"]])],
685    "is busy processing a command",
686    "\
687 This returns true iff this handle is busy processing a command
688 (in the C<BUSY> state).
689
690 For more information on states, see L<guestfs(3)>.");
691
692   ("get_state", (RInt "state", []), -1, [],
693    [],
694    "get the current state",
695    "\
696 This returns the current state as an opaque integer.  This is
697 only useful for printing debug and internal error messages.
698
699 For more information on states, see L<guestfs(3)>.");
700
701   ("set_memsize", (RErr, [Int "memsize"]), -1, [FishAlias "memsize"],
702    [InitNone, Always, TestOutputInt (
703       [["set_memsize"; "500"];
704        ["get_memsize"]], 500)],
705    "set memory allocated to the qemu subprocess",
706    "\
707 This sets the memory size in megabytes allocated to the
708 qemu subprocess.  This only has any effect if called before
709 C<guestfs_launch>.
710
711 You can also change this by setting the environment
712 variable C<LIBGUESTFS_MEMSIZE> before the handle is
713 created.
714
715 For more information on the architecture of libguestfs,
716 see L<guestfs(3)>.");
717
718   ("get_memsize", (RInt "memsize", []), -1, [],
719    [InitNone, Always, TestOutputIntOp (
720       [["get_memsize"]], ">=", 256)],
721    "get memory allocated to the qemu subprocess",
722    "\
723 This gets the memory size in megabytes allocated to the
724 qemu subprocess.
725
726 If C<guestfs_set_memsize> was not called
727 on this handle, and if C<LIBGUESTFS_MEMSIZE> was not set,
728 then this returns the compiled-in default value for memsize.
729
730 For more information on the architecture of libguestfs,
731 see L<guestfs(3)>.");
732
733   ("get_pid", (RInt "pid", []), -1, [FishAlias "pid"],
734    [InitNone, Always, TestOutputIntOp (
735       [["get_pid"]], ">=", 1)],
736    "get PID of qemu subprocess",
737    "\
738 Return the process ID of the qemu subprocess.  If there is no
739 qemu subprocess, then this will return an error.
740
741 This is an internal call used for debugging and testing.");
742
743   ("version", (RStruct ("version", "version"), []), -1, [],
744    [InitNone, Always, TestOutputStruct (
745       [["version"]], [CompareWithInt ("major", 1)])],
746    "get the library version number",
747    "\
748 Return the libguestfs version number that the program is linked
749 against.
750
751 Note that because of dynamic linking this is not necessarily
752 the version of libguestfs that you compiled against.  You can
753 compile the program, and then at runtime dynamically link
754 against a completely different C<libguestfs.so> library.
755
756 This call was added in version C<1.0.58>.  In previous
757 versions of libguestfs there was no way to get the version
758 number.  From C code you can use ELF weak linking tricks to find out if
759 this symbol exists (if it doesn't, then it's an earlier version).
760
761 The call returns a structure with four elements.  The first
762 three (C<major>, C<minor> and C<release>) are numbers and
763 correspond to the usual version triplet.  The fourth element
764 (C<extra>) is a string and is normally empty, but may be
765 used for distro-specific information.
766
767 To construct the original version string:
768 C<$major.$minor.$release$extra>
769
770 I<Note:> Don't use this call to test for availability
771 of features.  Distro backports makes this unreliable.  Use
772 C<guestfs_available> instead.");
773
774   ("set_selinux", (RErr, [Bool "selinux"]), -1, [FishAlias "selinux"],
775    [InitNone, Always, TestOutputTrue (
776       [["set_selinux"; "true"];
777        ["get_selinux"]])],
778    "set SELinux enabled or disabled at appliance boot",
779    "\
780 This sets the selinux flag that is passed to the appliance
781 at boot time.  The default is C<selinux=0> (disabled).
782
783 Note that if SELinux is enabled, it is always in
784 Permissive mode (C<enforcing=0>).
785
786 For more information on the architecture of libguestfs,
787 see L<guestfs(3)>.");
788
789   ("get_selinux", (RBool "selinux", []), -1, [],
790    [],
791    "get SELinux enabled flag",
792    "\
793 This returns the current setting of the selinux flag which
794 is passed to the appliance at boot time.  See C<guestfs_set_selinux>.
795
796 For more information on the architecture of libguestfs,
797 see L<guestfs(3)>.");
798
799   ("set_trace", (RErr, [Bool "trace"]), -1, [FishAlias "trace"],
800    [InitNone, Always, TestOutputFalse (
801       [["set_trace"; "false"];
802        ["get_trace"]])],
803    "enable or disable command traces",
804    "\
805 If the command trace flag is set to 1, then commands are
806 printed on stdout before they are executed in a format
807 which is very similar to the one used by guestfish.  In
808 other words, you can run a program with this enabled, and
809 you will get out a script which you can feed to guestfish
810 to perform the same set of actions.
811
812 If you want to trace C API calls into libguestfs (and
813 other libraries) then possibly a better way is to use
814 the external ltrace(1) command.
815
816 Command traces are disabled unless the environment variable
817 C<LIBGUESTFS_TRACE> is defined and set to C<1>.");
818
819   ("get_trace", (RBool "trace", []), -1, [],
820    [],
821    "get command trace enabled flag",
822    "\
823 Return the command trace flag.");
824
825   ("set_direct", (RErr, [Bool "direct"]), -1, [FishAlias "direct"],
826    [InitNone, Always, TestOutputFalse (
827       [["set_direct"; "false"];
828        ["get_direct"]])],
829    "enable or disable direct appliance mode",
830    "\
831 If the direct appliance mode flag is enabled, then stdin and
832 stdout are passed directly through to the appliance once it
833 is launched.
834
835 One consequence of this is that log messages aren't caught
836 by the library and handled by C<guestfs_set_log_message_callback>,
837 but go straight to stdout.
838
839 You probably don't want to use this unless you know what you
840 are doing.
841
842 The default is disabled.");
843
844   ("get_direct", (RBool "direct", []), -1, [],
845    [],
846    "get direct appliance mode flag",
847    "\
848 Return the direct appliance mode flag.");
849
850   ("set_recovery_proc", (RErr, [Bool "recoveryproc"]), -1, [FishAlias "recovery-proc"],
851    [InitNone, Always, TestOutputTrue (
852       [["set_recovery_proc"; "true"];
853        ["get_recovery_proc"]])],
854    "enable or disable the recovery process",
855    "\
856 If this is called with the parameter C<false> then
857 C<guestfs_launch> does not create a recovery process.  The
858 purpose of the recovery process is to stop runaway qemu
859 processes in the case where the main program aborts abruptly.
860
861 This only has any effect if called before C<guestfs_launch>,
862 and the default is true.
863
864 About the only time when you would want to disable this is
865 if the main process will fork itself into the background
866 (\"daemonize\" itself).  In this case the recovery process
867 thinks that the main program has disappeared and so kills
868 qemu, which is not very helpful.");
869
870   ("get_recovery_proc", (RBool "recoveryproc", []), -1, [],
871    [],
872    "get recovery process enabled flag",
873    "\
874 Return the recovery process enabled flag.");
875
876 ]
877
878 (* daemon_functions are any functions which cause some action
879  * to take place in the daemon.
880  *)
881
882 let daemon_functions = [
883   ("mount", (RErr, [Device "device"; String "mountpoint"]), 1, [],
884    [InitEmpty, Always, TestOutput (
885       [["part_disk"; "/dev/sda"; "mbr"];
886        ["mkfs"; "ext2"; "/dev/sda1"];
887        ["mount"; "/dev/sda1"; "/"];
888        ["write_file"; "/new"; "new file contents"; "0"];
889        ["cat"; "/new"]], "new file contents")],
890    "mount a guest disk at a position in the filesystem",
891    "\
892 Mount a guest disk at a position in the filesystem.  Block devices
893 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
894 the guest.  If those block devices contain partitions, they will have
895 the usual names (eg. C</dev/sda1>).  Also LVM C</dev/VG/LV>-style
896 names can be used.
897
898 The rules are the same as for L<mount(2)>:  A filesystem must
899 first be mounted on C</> before others can be mounted.  Other
900 filesystems can only be mounted on directories which already
901 exist.
902
903 The mounted filesystem is writable, if we have sufficient permissions
904 on the underlying device.
905
906 The filesystem options C<sync> and C<noatime> are set with this
907 call, in order to improve reliability.");
908
909   ("sync", (RErr, []), 2, [],
910    [ InitEmpty, Always, TestRun [["sync"]]],
911    "sync disks, writes are flushed through to the disk image",
912    "\
913 This syncs the disk, so that any writes are flushed through to the
914 underlying disk image.
915
916 You should always call this if you have modified a disk image, before
917 closing the handle.");
918
919   ("touch", (RErr, [Pathname "path"]), 3, [],
920    [InitBasicFS, Always, TestOutputTrue (
921       [["touch"; "/new"];
922        ["exists"; "/new"]])],
923    "update file timestamps or create a new file",
924    "\
925 Touch acts like the L<touch(1)> command.  It can be used to
926 update the timestamps on a file, or, if the file does not exist,
927 to create a new zero-length file.");
928
929   ("cat", (RString "content", [Pathname "path"]), 4, [ProtocolLimitWarning],
930    [InitISOFS, Always, TestOutput (
931       [["cat"; "/known-2"]], "abcdef\n")],
932    "list the contents of a file",
933    "\
934 Return the contents of the file named C<path>.
935
936 Note that this function cannot correctly handle binary files
937 (specifically, files containing C<\\0> character which is treated
938 as end of string).  For those you need to use the C<guestfs_read_file>
939 or C<guestfs_download> functions which have a more complex interface.");
940
941   ("ll", (RString "listing", [Pathname "directory"]), 5, [],
942    [], (* XXX Tricky to test because it depends on the exact format
943         * of the 'ls -l' command, which changes between F10 and F11.
944         *)
945    "list the files in a directory (long format)",
946    "\
947 List the files in C<directory> (relative to the root directory,
948 there is no cwd) in the format of 'ls -la'.
949
950 This command is mostly useful for interactive sessions.  It
951 is I<not> intended that you try to parse the output string.");
952
953   ("ls", (RStringList "listing", [Pathname "directory"]), 6, [],
954    [InitBasicFS, Always, TestOutputList (
955       [["touch"; "/new"];
956        ["touch"; "/newer"];
957        ["touch"; "/newest"];
958        ["ls"; "/"]], ["lost+found"; "new"; "newer"; "newest"])],
959    "list the files in a directory",
960    "\
961 List the files in C<directory> (relative to the root directory,
962 there is no cwd).  The '.' and '..' entries are not returned, but
963 hidden files are shown.
964
965 This command is mostly useful for interactive sessions.  Programs
966 should probably use C<guestfs_readdir> instead.");
967
968   ("list_devices", (RStringList "devices", []), 7, [],
969    [InitEmpty, Always, TestOutputListOfDevices (
970       [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
971    "list the block devices",
972    "\
973 List all the block devices.
974
975 The full block device names are returned, eg. C</dev/sda>");
976
977   ("list_partitions", (RStringList "partitions", []), 8, [],
978    [InitBasicFS, Always, TestOutputListOfDevices (
979       [["list_partitions"]], ["/dev/sda1"]);
980     InitEmpty, Always, TestOutputListOfDevices (
981       [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
982        ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
983    "list the partitions",
984    "\
985 List all the partitions detected on all block devices.
986
987 The full partition device names are returned, eg. C</dev/sda1>
988
989 This does not return logical volumes.  For that you will need to
990 call C<guestfs_lvs>.");
991
992   ("pvs", (RStringList "physvols", []), 9, [Optional "lvm2"],
993    [InitBasicFSonLVM, Always, TestOutputListOfDevices (
994       [["pvs"]], ["/dev/sda1"]);
995     InitEmpty, Always, TestOutputListOfDevices (
996       [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
997        ["pvcreate"; "/dev/sda1"];
998        ["pvcreate"; "/dev/sda2"];
999        ["pvcreate"; "/dev/sda3"];
1000        ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1001    "list the LVM physical volumes (PVs)",
1002    "\
1003 List all the physical volumes detected.  This is the equivalent
1004 of the L<pvs(8)> command.
1005
1006 This returns a list of just the device names that contain
1007 PVs (eg. C</dev/sda2>).
1008
1009 See also C<guestfs_pvs_full>.");
1010
1011   ("vgs", (RStringList "volgroups", []), 10, [Optional "lvm2"],
1012    [InitBasicFSonLVM, Always, TestOutputList (
1013       [["vgs"]], ["VG"]);
1014     InitEmpty, Always, TestOutputList (
1015       [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1016        ["pvcreate"; "/dev/sda1"];
1017        ["pvcreate"; "/dev/sda2"];
1018        ["pvcreate"; "/dev/sda3"];
1019        ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1020        ["vgcreate"; "VG2"; "/dev/sda3"];
1021        ["vgs"]], ["VG1"; "VG2"])],
1022    "list the LVM volume groups (VGs)",
1023    "\
1024 List all the volumes groups detected.  This is the equivalent
1025 of the L<vgs(8)> command.
1026
1027 This returns a list of just the volume group names that were
1028 detected (eg. C<VolGroup00>).
1029
1030 See also C<guestfs_vgs_full>.");
1031
1032   ("lvs", (RStringList "logvols", []), 11, [Optional "lvm2"],
1033    [InitBasicFSonLVM, Always, TestOutputList (
1034       [["lvs"]], ["/dev/VG/LV"]);
1035     InitEmpty, Always, TestOutputList (
1036       [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1037        ["pvcreate"; "/dev/sda1"];
1038        ["pvcreate"; "/dev/sda2"];
1039        ["pvcreate"; "/dev/sda3"];
1040        ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1041        ["vgcreate"; "VG2"; "/dev/sda3"];
1042        ["lvcreate"; "LV1"; "VG1"; "50"];
1043        ["lvcreate"; "LV2"; "VG1"; "50"];
1044        ["lvcreate"; "LV3"; "VG2"; "50"];
1045        ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1046    "list the LVM logical volumes (LVs)",
1047    "\
1048 List all the logical volumes detected.  This is the equivalent
1049 of the L<lvs(8)> command.
1050
1051 This returns a list of the logical volume device names
1052 (eg. C</dev/VolGroup00/LogVol00>).
1053
1054 See also C<guestfs_lvs_full>.");
1055
1056   ("pvs_full", (RStructList ("physvols", "lvm_pv"), []), 12, [Optional "lvm2"],
1057    [], (* XXX how to test? *)
1058    "list the LVM physical volumes (PVs)",
1059    "\
1060 List all the physical volumes detected.  This is the equivalent
1061 of the L<pvs(8)> command.  The \"full\" version includes all fields.");
1062
1063   ("vgs_full", (RStructList ("volgroups", "lvm_vg"), []), 13, [Optional "lvm2"],
1064    [], (* XXX how to test? *)
1065    "list the LVM volume groups (VGs)",
1066    "\
1067 List all the volumes groups detected.  This is the equivalent
1068 of the L<vgs(8)> command.  The \"full\" version includes all fields.");
1069
1070   ("lvs_full", (RStructList ("logvols", "lvm_lv"), []), 14, [Optional "lvm2"],
1071    [], (* XXX how to test? *)
1072    "list the LVM logical volumes (LVs)",
1073    "\
1074 List all the logical volumes detected.  This is the equivalent
1075 of the L<lvs(8)> command.  The \"full\" version includes all fields.");
1076
1077   ("read_lines", (RStringList "lines", [Pathname "path"]), 15, [],
1078    [InitISOFS, Always, TestOutputList (
1079       [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1080     InitISOFS, Always, TestOutputList (
1081       [["read_lines"; "/empty"]], [])],
1082    "read file as lines",
1083    "\
1084 Return the contents of the file named C<path>.
1085
1086 The file contents are returned as a list of lines.  Trailing
1087 C<LF> and C<CRLF> character sequences are I<not> returned.
1088
1089 Note that this function cannot correctly handle binary files
1090 (specifically, files containing C<\\0> character which is treated
1091 as end of line).  For those you need to use the C<guestfs_read_file>
1092 function which has a more complex interface.");
1093
1094   ("aug_init", (RErr, [Pathname "root"; Int "flags"]), 16, [Optional "augeas"],
1095    [], (* XXX Augeas code needs tests. *)
1096    "create a new Augeas handle",
1097    "\
1098 Create a new Augeas handle for editing configuration files.
1099 If there was any previous Augeas handle associated with this
1100 guestfs session, then it is closed.
1101
1102 You must call this before using any other C<guestfs_aug_*>
1103 commands.
1104
1105 C<root> is the filesystem root.  C<root> must not be NULL,
1106 use C</> instead.
1107
1108 The flags are the same as the flags defined in
1109 E<lt>augeas.hE<gt>, the logical I<or> of the following
1110 integers:
1111
1112 =over 4
1113
1114 =item C<AUG_SAVE_BACKUP> = 1
1115
1116 Keep the original file with a C<.augsave> extension.
1117
1118 =item C<AUG_SAVE_NEWFILE> = 2
1119
1120 Save changes into a file with extension C<.augnew>, and
1121 do not overwrite original.  Overrides C<AUG_SAVE_BACKUP>.
1122
1123 =item C<AUG_TYPE_CHECK> = 4
1124
1125 Typecheck lenses (can be expensive).
1126
1127 =item C<AUG_NO_STDINC> = 8
1128
1129 Do not use standard load path for modules.
1130
1131 =item C<AUG_SAVE_NOOP> = 16
1132
1133 Make save a no-op, just record what would have been changed.
1134
1135 =item C<AUG_NO_LOAD> = 32
1136
1137 Do not load the tree in C<guestfs_aug_init>.
1138
1139 =back
1140
1141 To close the handle, you can call C<guestfs_aug_close>.
1142
1143 To find out more about Augeas, see L<http://augeas.net/>.");
1144
1145   ("aug_close", (RErr, []), 26, [Optional "augeas"],
1146    [], (* XXX Augeas code needs tests. *)
1147    "close the current Augeas handle",
1148    "\
1149 Close the current Augeas handle and free up any resources
1150 used by it.  After calling this, you have to call
1151 C<guestfs_aug_init> again before you can use any other
1152 Augeas functions.");
1153
1154   ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"]), 17, [Optional "augeas"],
1155    [], (* XXX Augeas code needs tests. *)
1156    "define an Augeas variable",
1157    "\
1158 Defines an Augeas variable C<name> whose value is the result
1159 of evaluating C<expr>.  If C<expr> is NULL, then C<name> is
1160 undefined.
1161
1162 On success this returns the number of nodes in C<expr>, or
1163 C<0> if C<expr> evaluates to something which is not a nodeset.");
1164
1165   ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"]), 18, [Optional "augeas"],
1166    [], (* XXX Augeas code needs tests. *)
1167    "define an Augeas node",
1168    "\
1169 Defines a variable C<name> whose value is the result of
1170 evaluating C<expr>.
1171
1172 If C<expr> evaluates to an empty nodeset, a node is created,
1173 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1174 C<name> will be the nodeset containing that single node.
1175
1176 On success this returns a pair containing the
1177 number of nodes in the nodeset, and a boolean flag
1178 if a node was created.");
1179
1180   ("aug_get", (RString "val", [String "augpath"]), 19, [Optional "augeas"],
1181    [], (* XXX Augeas code needs tests. *)
1182    "look up the value of an Augeas path",
1183    "\
1184 Look up the value associated with C<path>.  If C<path>
1185 matches exactly one node, the C<value> is returned.");
1186
1187   ("aug_set", (RErr, [String "augpath"; String "val"]), 20, [Optional "augeas"],
1188    [], (* XXX Augeas code needs tests. *)
1189    "set Augeas path to value",
1190    "\
1191 Set the value associated with C<path> to C<value>.");
1192
1193   ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"]), 21, [Optional "augeas"],
1194    [], (* XXX Augeas code needs tests. *)
1195    "insert a sibling Augeas node",
1196    "\
1197 Create a new sibling C<label> for C<path>, inserting it into
1198 the tree before or after C<path> (depending on the boolean
1199 flag C<before>).
1200
1201 C<path> must match exactly one existing node in the tree, and
1202 C<label> must be a label, ie. not contain C</>, C<*> or end
1203 with a bracketed index C<[N]>.");
1204
1205   ("aug_rm", (RInt "nrnodes", [String "augpath"]), 22, [Optional "augeas"],
1206    [], (* XXX Augeas code needs tests. *)
1207    "remove an Augeas path",
1208    "\
1209 Remove C<path> and all of its children.
1210
1211 On success this returns the number of entries which were removed.");
1212
1213   ("aug_mv", (RErr, [String "src"; String "dest"]), 23, [Optional "augeas"],
1214    [], (* XXX Augeas code needs tests. *)
1215    "move Augeas node",
1216    "\
1217 Move the node C<src> to C<dest>.  C<src> must match exactly
1218 one node.  C<dest> is overwritten if it exists.");
1219
1220   ("aug_match", (RStringList "matches", [String "augpath"]), 24, [Optional "augeas"],
1221    [], (* XXX Augeas code needs tests. *)
1222    "return Augeas nodes which match augpath",
1223    "\
1224 Returns a list of paths which match the path expression C<path>.
1225 The returned paths are sufficiently qualified so that they match
1226 exactly one node in the current tree.");
1227
1228   ("aug_save", (RErr, []), 25, [Optional "augeas"],
1229    [], (* XXX Augeas code needs tests. *)
1230    "write all pending Augeas changes to disk",
1231    "\
1232 This writes all pending changes to disk.
1233
1234 The flags which were passed to C<guestfs_aug_init> affect exactly
1235 how files are saved.");
1236
1237   ("aug_load", (RErr, []), 27, [Optional "augeas"],
1238    [], (* XXX Augeas code needs tests. *)
1239    "load files into the tree",
1240    "\
1241 Load files into the tree.
1242
1243 See C<aug_load> in the Augeas documentation for the full gory
1244 details.");
1245
1246   ("aug_ls", (RStringList "matches", [String "augpath"]), 28, [Optional "augeas"],
1247    [], (* XXX Augeas code needs tests. *)
1248    "list Augeas nodes under augpath",
1249    "\
1250 This is just a shortcut for listing C<guestfs_aug_match>
1251 C<path/*> and sorting the resulting nodes into alphabetical order.");
1252
1253   ("rm", (RErr, [Pathname "path"]), 29, [],
1254    [InitBasicFS, Always, TestRun
1255       [["touch"; "/new"];
1256        ["rm"; "/new"]];
1257     InitBasicFS, Always, TestLastFail
1258       [["rm"; "/new"]];
1259     InitBasicFS, Always, TestLastFail
1260       [["mkdir"; "/new"];
1261        ["rm"; "/new"]]],
1262    "remove a file",
1263    "\
1264 Remove the single file C<path>.");
1265
1266   ("rmdir", (RErr, [Pathname "path"]), 30, [],
1267    [InitBasicFS, Always, TestRun
1268       [["mkdir"; "/new"];
1269        ["rmdir"; "/new"]];
1270     InitBasicFS, Always, TestLastFail
1271       [["rmdir"; "/new"]];
1272     InitBasicFS, Always, TestLastFail
1273       [["touch"; "/new"];
1274        ["rmdir"; "/new"]]],
1275    "remove a directory",
1276    "\
1277 Remove the single directory C<path>.");
1278
1279   ("rm_rf", (RErr, [Pathname "path"]), 31, [],
1280    [InitBasicFS, Always, TestOutputFalse
1281       [["mkdir"; "/new"];
1282        ["mkdir"; "/new/foo"];
1283        ["touch"; "/new/foo/bar"];
1284        ["rm_rf"; "/new"];
1285        ["exists"; "/new"]]],
1286    "remove a file or directory recursively",
1287    "\
1288 Remove the file or directory C<path>, recursively removing the
1289 contents if its a directory.  This is like the C<rm -rf> shell
1290 command.");
1291
1292   ("mkdir", (RErr, [Pathname "path"]), 32, [],
1293    [InitBasicFS, Always, TestOutputTrue
1294       [["mkdir"; "/new"];
1295        ["is_dir"; "/new"]];
1296     InitBasicFS, Always, TestLastFail
1297       [["mkdir"; "/new/foo/bar"]]],
1298    "create a directory",
1299    "\
1300 Create a directory named C<path>.");
1301
1302   ("mkdir_p", (RErr, [Pathname "path"]), 33, [],
1303    [InitBasicFS, Always, TestOutputTrue
1304       [["mkdir_p"; "/new/foo/bar"];
1305        ["is_dir"; "/new/foo/bar"]];
1306     InitBasicFS, Always, TestOutputTrue
1307       [["mkdir_p"; "/new/foo/bar"];
1308        ["is_dir"; "/new/foo"]];
1309     InitBasicFS, Always, TestOutputTrue
1310       [["mkdir_p"; "/new/foo/bar"];
1311        ["is_dir"; "/new"]];
1312     (* Regression tests for RHBZ#503133: *)
1313     InitBasicFS, Always, TestRun
1314       [["mkdir"; "/new"];
1315        ["mkdir_p"; "/new"]];
1316     InitBasicFS, Always, TestLastFail
1317       [["touch"; "/new"];
1318        ["mkdir_p"; "/new"]]],
1319    "create a directory and parents",
1320    "\
1321 Create a directory named C<path>, creating any parent directories
1322 as necessary.  This is like the C<mkdir -p> shell command.");
1323
1324   ("chmod", (RErr, [Int "mode"; Pathname "path"]), 34, [],
1325    [], (* XXX Need stat command to test *)
1326    "change file mode",
1327    "\
1328 Change the mode (permissions) of C<path> to C<mode>.  Only
1329 numeric modes are supported.
1330
1331 I<Note>: When using this command from guestfish, C<mode>
1332 by default would be decimal, unless you prefix it with
1333 C<0> to get octal, ie. use C<0700> not C<700>.");
1334
1335   ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"]), 35, [],
1336    [], (* XXX Need stat command to test *)
1337    "change file owner and group",
1338    "\
1339 Change the file owner to C<owner> and group to C<group>.
1340
1341 Only numeric uid and gid are supported.  If you want to use
1342 names, you will need to locate and parse the password file
1343 yourself (Augeas support makes this relatively easy).");
1344
1345   ("exists", (RBool "existsflag", [Pathname "path"]), 36, [],
1346    [InitISOFS, Always, TestOutputTrue (
1347       [["exists"; "/empty"]]);
1348     InitISOFS, Always, TestOutputTrue (
1349       [["exists"; "/directory"]])],
1350    "test if file or directory exists",
1351    "\
1352 This returns C<true> if and only if there is a file, directory
1353 (or anything) with the given C<path> name.
1354
1355 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1356
1357   ("is_file", (RBool "fileflag", [Pathname "path"]), 37, [],
1358    [InitISOFS, Always, TestOutputTrue (
1359       [["is_file"; "/known-1"]]);
1360     InitISOFS, Always, TestOutputFalse (
1361       [["is_file"; "/directory"]])],
1362    "test if file exists",
1363    "\
1364 This returns C<true> if and only if there is a file
1365 with the given C<path> name.  Note that it returns false for
1366 other objects like directories.
1367
1368 See also C<guestfs_stat>.");
1369
1370   ("is_dir", (RBool "dirflag", [Pathname "path"]), 38, [],
1371    [InitISOFS, Always, TestOutputFalse (
1372       [["is_dir"; "/known-3"]]);
1373     InitISOFS, Always, TestOutputTrue (
1374       [["is_dir"; "/directory"]])],
1375    "test if file exists",
1376    "\
1377 This returns C<true> if and only if there is a directory
1378 with the given C<path> name.  Note that it returns false for
1379 other objects like files.
1380
1381 See also C<guestfs_stat>.");
1382
1383   ("pvcreate", (RErr, [Device "device"]), 39, [Optional "lvm2"],
1384    [InitEmpty, Always, TestOutputListOfDevices (
1385       [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1386        ["pvcreate"; "/dev/sda1"];
1387        ["pvcreate"; "/dev/sda2"];
1388        ["pvcreate"; "/dev/sda3"];
1389        ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1390    "create an LVM physical volume",
1391    "\
1392 This creates an LVM physical volume on the named C<device>,
1393 where C<device> should usually be a partition name such
1394 as C</dev/sda1>.");
1395
1396   ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"]), 40, [Optional "lvm2"],
1397    [InitEmpty, Always, TestOutputList (
1398       [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1399        ["pvcreate"; "/dev/sda1"];
1400        ["pvcreate"; "/dev/sda2"];
1401        ["pvcreate"; "/dev/sda3"];
1402        ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1403        ["vgcreate"; "VG2"; "/dev/sda3"];
1404        ["vgs"]], ["VG1"; "VG2"])],
1405    "create an LVM volume group",
1406    "\
1407 This creates an LVM volume group called C<volgroup>
1408 from the non-empty list of physical volumes C<physvols>.");
1409
1410   ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"]), 41, [Optional "lvm2"],
1411    [InitEmpty, Always, TestOutputList (
1412       [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1413        ["pvcreate"; "/dev/sda1"];
1414        ["pvcreate"; "/dev/sda2"];
1415        ["pvcreate"; "/dev/sda3"];
1416        ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1417        ["vgcreate"; "VG2"; "/dev/sda3"];
1418        ["lvcreate"; "LV1"; "VG1"; "50"];
1419        ["lvcreate"; "LV2"; "VG1"; "50"];
1420        ["lvcreate"; "LV3"; "VG2"; "50"];
1421        ["lvcreate"; "LV4"; "VG2"; "50"];
1422        ["lvcreate"; "LV5"; "VG2"; "50"];
1423        ["lvs"]],
1424       ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1425        "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1426    "create an LVM volume group",
1427    "\
1428 This creates an LVM volume group called C<logvol>
1429 on the volume group C<volgroup>, with C<size> megabytes.");
1430
1431   ("mkfs", (RErr, [String "fstype"; Device "device"]), 42, [],
1432    [InitEmpty, Always, TestOutput (
1433       [["part_disk"; "/dev/sda"; "mbr"];
1434        ["mkfs"; "ext2"; "/dev/sda1"];
1435        ["mount"; "/dev/sda1"; "/"];
1436        ["write_file"; "/new"; "new file contents"; "0"];
1437        ["cat"; "/new"]], "new file contents")],
1438    "make a filesystem",
1439    "\
1440 This creates a filesystem on C<device> (usually a partition
1441 or LVM logical volume).  The filesystem type is C<fstype>, for
1442 example C<ext3>.");
1443
1444   ("sfdisk", (RErr, [Device "device";
1445                      Int "cyls"; Int "heads"; Int "sectors";
1446                      StringList "lines"]), 43, [DangerWillRobinson],
1447    [],
1448    "create partitions on a block device",
1449    "\
1450 This is a direct interface to the L<sfdisk(8)> program for creating
1451 partitions on block devices.
1452
1453 C<device> should be a block device, for example C</dev/sda>.
1454
1455 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1456 and sectors on the device, which are passed directly to sfdisk as
1457 the I<-C>, I<-H> and I<-S> parameters.  If you pass C<0> for any
1458 of these, then the corresponding parameter is omitted.  Usually for
1459 'large' disks, you can just pass C<0> for these, but for small
1460 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1461 out the right geometry and you will need to tell it.
1462
1463 C<lines> is a list of lines that we feed to C<sfdisk>.  For more
1464 information refer to the L<sfdisk(8)> manpage.
1465
1466 To create a single partition occupying the whole disk, you would
1467 pass C<lines> as a single element list, when the single element being
1468 the string C<,> (comma).
1469
1470 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
1471 C<guestfs_part_init>");
1472
1473   ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"]), 44, [ProtocolLimitWarning],
1474    [InitBasicFS, Always, TestOutput (
1475       [["write_file"; "/new"; "new file contents"; "0"];
1476        ["cat"; "/new"]], "new file contents");
1477     InitBasicFS, Always, TestOutput (
1478       [["write_file"; "/new"; "\nnew file contents\n"; "0"];
1479        ["cat"; "/new"]], "\nnew file contents\n");
1480     InitBasicFS, Always, TestOutput (
1481       [["write_file"; "/new"; "\n\n"; "0"];
1482        ["cat"; "/new"]], "\n\n");
1483     InitBasicFS, Always, TestOutput (
1484       [["write_file"; "/new"; ""; "0"];
1485        ["cat"; "/new"]], "");
1486     InitBasicFS, Always, TestOutput (
1487       [["write_file"; "/new"; "\n\n\n"; "0"];
1488        ["cat"; "/new"]], "\n\n\n");
1489     InitBasicFS, Always, TestOutput (
1490       [["write_file"; "/new"; "\n"; "0"];
1491        ["cat"; "/new"]], "\n")],
1492    "create a file",
1493    "\
1494 This call creates a file called C<path>.  The contents of the
1495 file is the string C<content> (which can contain any 8 bit data),
1496 with length C<size>.
1497
1498 As a special case, if C<size> is C<0>
1499 then the length is calculated using C<strlen> (so in this case
1500 the content cannot contain embedded ASCII NULs).
1501
1502 I<NB.> Owing to a bug, writing content containing ASCII NUL
1503 characters does I<not> work, even if the length is specified.
1504 We hope to resolve this bug in a future version.  In the meantime
1505 use C<guestfs_upload>.");
1506
1507   ("umount", (RErr, [String "pathordevice"]), 45, [FishAlias "unmount"],
1508    [InitEmpty, Always, TestOutputListOfDevices (
1509       [["part_disk"; "/dev/sda"; "mbr"];
1510        ["mkfs"; "ext2"; "/dev/sda1"];
1511        ["mount"; "/dev/sda1"; "/"];
1512        ["mounts"]], ["/dev/sda1"]);
1513     InitEmpty, Always, TestOutputList (
1514       [["part_disk"; "/dev/sda"; "mbr"];
1515        ["mkfs"; "ext2"; "/dev/sda1"];
1516        ["mount"; "/dev/sda1"; "/"];
1517        ["umount"; "/"];
1518        ["mounts"]], [])],
1519    "unmount a filesystem",
1520    "\
1521 This unmounts the given filesystem.  The filesystem may be
1522 specified either by its mountpoint (path) or the device which
1523 contains the filesystem.");
1524
1525   ("mounts", (RStringList "devices", []), 46, [],
1526    [InitBasicFS, Always, TestOutputListOfDevices (
1527       [["mounts"]], ["/dev/sda1"])],
1528    "show mounted filesystems",
1529    "\
1530 This returns the list of currently mounted filesystems.  It returns
1531 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1532
1533 Some internal mounts are not shown.
1534
1535 See also: C<guestfs_mountpoints>");
1536
1537   ("umount_all", (RErr, []), 47, [FishAlias "unmount-all"],
1538    [InitBasicFS, Always, TestOutputList (
1539       [["umount_all"];
1540        ["mounts"]], []);
1541     (* check that umount_all can unmount nested mounts correctly: *)
1542     InitEmpty, Always, TestOutputList (
1543       [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1544        ["mkfs"; "ext2"; "/dev/sda1"];
1545        ["mkfs"; "ext2"; "/dev/sda2"];
1546        ["mkfs"; "ext2"; "/dev/sda3"];
1547        ["mount"; "/dev/sda1"; "/"];
1548        ["mkdir"; "/mp1"];
1549        ["mount"; "/dev/sda2"; "/mp1"];
1550        ["mkdir"; "/mp1/mp2"];
1551        ["mount"; "/dev/sda3"; "/mp1/mp2"];
1552        ["mkdir"; "/mp1/mp2/mp3"];
1553        ["umount_all"];
1554        ["mounts"]], [])],
1555    "unmount all filesystems",
1556    "\
1557 This unmounts all mounted filesystems.
1558
1559 Some internal mounts are not unmounted by this call.");
1560
1561   ("lvm_remove_all", (RErr, []), 48, [DangerWillRobinson; Optional "lvm2"],
1562    [],
1563    "remove all LVM LVs, VGs and PVs",
1564    "\
1565 This command removes all LVM logical volumes, volume groups
1566 and physical volumes.");
1567
1568   ("file", (RString "description", [Dev_or_Path "path"]), 49, [],
1569    [InitISOFS, Always, TestOutput (
1570       [["file"; "/empty"]], "empty");
1571     InitISOFS, Always, TestOutput (
1572       [["file"; "/known-1"]], "ASCII text");
1573     InitISOFS, Always, TestLastFail (
1574       [["file"; "/notexists"]])],
1575    "determine file type",
1576    "\
1577 This call uses the standard L<file(1)> command to determine
1578 the type or contents of the file.  This also works on devices,
1579 for example to find out whether a partition contains a filesystem.
1580
1581 This call will also transparently look inside various types
1582 of compressed file.
1583
1584 The exact command which runs is C<file -zbsL path>.  Note in
1585 particular that the filename is not prepended to the output
1586 (the C<-b> option).");
1587
1588   ("command", (RString "output", [StringList "arguments"]), 50, [ProtocolLimitWarning],
1589    [InitBasicFS, Always, TestOutput (
1590       [["upload"; "test-command"; "/test-command"];
1591        ["chmod"; "0o755"; "/test-command"];
1592        ["command"; "/test-command 1"]], "Result1");
1593     InitBasicFS, Always, TestOutput (
1594       [["upload"; "test-command"; "/test-command"];
1595        ["chmod"; "0o755"; "/test-command"];
1596        ["command"; "/test-command 2"]], "Result2\n");
1597     InitBasicFS, Always, TestOutput (
1598       [["upload"; "test-command"; "/test-command"];
1599        ["chmod"; "0o755"; "/test-command"];
1600        ["command"; "/test-command 3"]], "\nResult3");
1601     InitBasicFS, Always, TestOutput (
1602       [["upload"; "test-command"; "/test-command"];
1603        ["chmod"; "0o755"; "/test-command"];
1604        ["command"; "/test-command 4"]], "\nResult4\n");
1605     InitBasicFS, Always, TestOutput (
1606       [["upload"; "test-command"; "/test-command"];
1607        ["chmod"; "0o755"; "/test-command"];
1608        ["command"; "/test-command 5"]], "\nResult5\n\n");
1609     InitBasicFS, Always, TestOutput (
1610       [["upload"; "test-command"; "/test-command"];
1611        ["chmod"; "0o755"; "/test-command"];
1612        ["command"; "/test-command 6"]], "\n\nResult6\n\n");
1613     InitBasicFS, Always, TestOutput (
1614       [["upload"; "test-command"; "/test-command"];
1615        ["chmod"; "0o755"; "/test-command"];
1616        ["command"; "/test-command 7"]], "");
1617     InitBasicFS, Always, TestOutput (
1618       [["upload"; "test-command"; "/test-command"];
1619        ["chmod"; "0o755"; "/test-command"];
1620        ["command"; "/test-command 8"]], "\n");
1621     InitBasicFS, Always, TestOutput (
1622       [["upload"; "test-command"; "/test-command"];
1623        ["chmod"; "0o755"; "/test-command"];
1624        ["command"; "/test-command 9"]], "\n\n");
1625     InitBasicFS, Always, TestOutput (
1626       [["upload"; "test-command"; "/test-command"];
1627        ["chmod"; "0o755"; "/test-command"];
1628        ["command"; "/test-command 10"]], "Result10-1\nResult10-2\n");
1629     InitBasicFS, Always, TestOutput (
1630       [["upload"; "test-command"; "/test-command"];
1631        ["chmod"; "0o755"; "/test-command"];
1632        ["command"; "/test-command 11"]], "Result11-1\nResult11-2");
1633     InitBasicFS, Always, TestLastFail (
1634       [["upload"; "test-command"; "/test-command"];
1635        ["chmod"; "0o755"; "/test-command"];
1636        ["command"; "/test-command"]])],
1637    "run a command from the guest filesystem",
1638    "\
1639 This call runs a command from the guest filesystem.  The
1640 filesystem must be mounted, and must contain a compatible
1641 operating system (ie. something Linux, with the same
1642 or compatible processor architecture).
1643
1644 The single parameter is an argv-style list of arguments.
1645 The first element is the name of the program to run.
1646 Subsequent elements are parameters.  The list must be
1647 non-empty (ie. must contain a program name).  Note that
1648 the command runs directly, and is I<not> invoked via
1649 the shell (see C<guestfs_sh>).
1650
1651 The return value is anything printed to I<stdout> by
1652 the command.
1653
1654 If the command returns a non-zero exit status, then
1655 this function returns an error message.  The error message
1656 string is the content of I<stderr> from the command.
1657
1658 The C<$PATH> environment variable will contain at least
1659 C</usr/bin> and C</bin>.  If you require a program from
1660 another location, you should provide the full path in the
1661 first parameter.
1662
1663 Shared libraries and data files required by the program
1664 must be available on filesystems which are mounted in the
1665 correct places.  It is the caller's responsibility to ensure
1666 all filesystems that are needed are mounted at the right
1667 locations.");
1668
1669   ("command_lines", (RStringList "lines", [StringList "arguments"]), 51, [ProtocolLimitWarning],
1670    [InitBasicFS, Always, TestOutputList (
1671       [["upload"; "test-command"; "/test-command"];
1672        ["chmod"; "0o755"; "/test-command"];
1673        ["command_lines"; "/test-command 1"]], ["Result1"]);
1674     InitBasicFS, Always, TestOutputList (
1675       [["upload"; "test-command"; "/test-command"];
1676        ["chmod"; "0o755"; "/test-command"];
1677        ["command_lines"; "/test-command 2"]], ["Result2"]);
1678     InitBasicFS, Always, TestOutputList (
1679       [["upload"; "test-command"; "/test-command"];
1680        ["chmod"; "0o755"; "/test-command"];
1681        ["command_lines"; "/test-command 3"]], ["";"Result3"]);
1682     InitBasicFS, Always, TestOutputList (
1683       [["upload"; "test-command"; "/test-command"];
1684        ["chmod"; "0o755"; "/test-command"];
1685        ["command_lines"; "/test-command 4"]], ["";"Result4"]);
1686     InitBasicFS, Always, TestOutputList (
1687       [["upload"; "test-command"; "/test-command"];
1688        ["chmod"; "0o755"; "/test-command"];
1689        ["command_lines"; "/test-command 5"]], ["";"Result5";""]);
1690     InitBasicFS, Always, TestOutputList (
1691       [["upload"; "test-command"; "/test-command"];
1692        ["chmod"; "0o755"; "/test-command"];
1693        ["command_lines"; "/test-command 6"]], ["";"";"Result6";""]);
1694     InitBasicFS, Always, TestOutputList (
1695       [["upload"; "test-command"; "/test-command"];
1696        ["chmod"; "0o755"; "/test-command"];
1697        ["command_lines"; "/test-command 7"]], []);
1698     InitBasicFS, Always, TestOutputList (
1699       [["upload"; "test-command"; "/test-command"];
1700        ["chmod"; "0o755"; "/test-command"];
1701        ["command_lines"; "/test-command 8"]], [""]);
1702     InitBasicFS, Always, TestOutputList (
1703       [["upload"; "test-command"; "/test-command"];
1704        ["chmod"; "0o755"; "/test-command"];
1705        ["command_lines"; "/test-command 9"]], ["";""]);
1706     InitBasicFS, Always, TestOutputList (
1707       [["upload"; "test-command"; "/test-command"];
1708        ["chmod"; "0o755"; "/test-command"];
1709        ["command_lines"; "/test-command 10"]], ["Result10-1";"Result10-2"]);
1710     InitBasicFS, Always, TestOutputList (
1711       [["upload"; "test-command"; "/test-command"];
1712        ["chmod"; "0o755"; "/test-command"];
1713        ["command_lines"; "/test-command 11"]], ["Result11-1";"Result11-2"])],
1714    "run a command, returning lines",
1715    "\
1716 This is the same as C<guestfs_command>, but splits the
1717 result into a list of lines.
1718
1719 See also: C<guestfs_sh_lines>");
1720
1721   ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"]), 52, [],
1722    [InitISOFS, Always, TestOutputStruct (
1723       [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
1724    "get file information",
1725    "\
1726 Returns file information for the given C<path>.
1727
1728 This is the same as the C<stat(2)> system call.");
1729
1730   ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"]), 53, [],
1731    [InitISOFS, Always, TestOutputStruct (
1732       [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
1733    "get file information for a symbolic link",
1734    "\
1735 Returns file information for the given C<path>.
1736
1737 This is the same as C<guestfs_stat> except that if C<path>
1738 is a symbolic link, then the link is stat-ed, not the file it
1739 refers to.
1740
1741 This is the same as the C<lstat(2)> system call.");
1742
1743   ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"]), 54, [],
1744    [InitISOFS, Always, TestOutputStruct (
1745       [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
1746    "get file system statistics",
1747    "\
1748 Returns file system statistics for any mounted file system.
1749 C<path> should be a file or directory in the mounted file system
1750 (typically it is the mount point itself, but it doesn't need to be).
1751
1752 This is the same as the C<statvfs(2)> system call.");
1753
1754   ("tune2fs_l", (RHashtable "superblock", [Device "device"]), 55, [],
1755    [], (* XXX test *)
1756    "get ext2/ext3/ext4 superblock details",
1757    "\
1758 This returns the contents of the ext2, ext3 or ext4 filesystem
1759 superblock on C<device>.
1760
1761 It is the same as running C<tune2fs -l device>.  See L<tune2fs(8)>
1762 manpage for more details.  The list of fields returned isn't
1763 clearly defined, and depends on both the version of C<tune2fs>
1764 that libguestfs was built against, and the filesystem itself.");
1765
1766   ("blockdev_setro", (RErr, [Device "device"]), 56, [],
1767    [InitEmpty, Always, TestOutputTrue (
1768       [["blockdev_setro"; "/dev/sda"];
1769        ["blockdev_getro"; "/dev/sda"]])],
1770    "set block device to read-only",
1771    "\
1772 Sets the block device named C<device> to read-only.
1773
1774 This uses the L<blockdev(8)> command.");
1775
1776   ("blockdev_setrw", (RErr, [Device "device"]), 57, [],
1777    [InitEmpty, Always, TestOutputFalse (
1778       [["blockdev_setrw"; "/dev/sda"];
1779        ["blockdev_getro"; "/dev/sda"]])],
1780    "set block device to read-write",
1781    "\
1782 Sets the block device named C<device> to read-write.
1783
1784 This uses the L<blockdev(8)> command.");
1785
1786   ("blockdev_getro", (RBool "ro", [Device "device"]), 58, [],
1787    [InitEmpty, Always, TestOutputTrue (
1788       [["blockdev_setro"; "/dev/sda"];
1789        ["blockdev_getro"; "/dev/sda"]])],
1790    "is block device set to read-only",
1791    "\
1792 Returns a boolean indicating if the block device is read-only
1793 (true if read-only, false if not).
1794
1795 This uses the L<blockdev(8)> command.");
1796
1797   ("blockdev_getss", (RInt "sectorsize", [Device "device"]), 59, [],
1798    [InitEmpty, Always, TestOutputInt (
1799       [["blockdev_getss"; "/dev/sda"]], 512)],
1800    "get sectorsize of block device",
1801    "\
1802 This returns the size of sectors on a block device.
1803 Usually 512, but can be larger for modern devices.
1804
1805 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
1806 for that).
1807
1808 This uses the L<blockdev(8)> command.");
1809
1810   ("blockdev_getbsz", (RInt "blocksize", [Device "device"]), 60, [],
1811    [InitEmpty, Always, TestOutputInt (
1812       [["blockdev_getbsz"; "/dev/sda"]], 4096)],
1813    "get blocksize of block device",
1814    "\
1815 This returns the block size of a device.
1816
1817 (Note this is different from both I<size in blocks> and
1818 I<filesystem block size>).
1819
1820 This uses the L<blockdev(8)> command.");
1821
1822   ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"]), 61, [],
1823    [], (* XXX test *)
1824    "set blocksize of block device",
1825    "\
1826 This sets the block size of a device.
1827
1828 (Note this is different from both I<size in blocks> and
1829 I<filesystem block size>).
1830
1831 This uses the L<blockdev(8)> command.");
1832
1833   ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"]), 62, [],
1834    [InitEmpty, Always, TestOutputInt (
1835       [["blockdev_getsz"; "/dev/sda"]], 1024000)],
1836    "get total size of device in 512-byte sectors",
1837    "\
1838 This returns the size of the device in units of 512-byte sectors
1839 (even if the sectorsize isn't 512 bytes ... weird).
1840
1841 See also C<guestfs_blockdev_getss> for the real sector size of
1842 the device, and C<guestfs_blockdev_getsize64> for the more
1843 useful I<size in bytes>.
1844
1845 This uses the L<blockdev(8)> command.");
1846
1847   ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"]), 63, [],
1848    [InitEmpty, Always, TestOutputInt (
1849       [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
1850    "get total size of device in bytes",
1851    "\
1852 This returns the size of the device in bytes.
1853
1854 See also C<guestfs_blockdev_getsz>.
1855
1856 This uses the L<blockdev(8)> command.");
1857
1858   ("blockdev_flushbufs", (RErr, [Device "device"]), 64, [],
1859    [InitEmpty, Always, TestRun
1860       [["blockdev_flushbufs"; "/dev/sda"]]],
1861    "flush device buffers",
1862    "\
1863 This tells the kernel to flush internal buffers associated
1864 with C<device>.
1865
1866 This uses the L<blockdev(8)> command.");
1867
1868   ("blockdev_rereadpt", (RErr, [Device "device"]), 65, [],
1869    [InitEmpty, Always, TestRun
1870       [["blockdev_rereadpt"; "/dev/sda"]]],
1871    "reread partition table",
1872    "\
1873 Reread the partition table on C<device>.
1874
1875 This uses the L<blockdev(8)> command.");
1876
1877   ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"]), 66, [],
1878    [InitBasicFS, Always, TestOutput (
1879       (* Pick a file from cwd which isn't likely to change. *)
1880       [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1881        ["checksum"; "md5"; "/COPYING.LIB"]],
1882       Digest.to_hex (Digest.file "COPYING.LIB"))],
1883    "upload a file from the local machine",
1884    "\
1885 Upload local file C<filename> to C<remotefilename> on the
1886 filesystem.
1887
1888 C<filename> can also be a named pipe.
1889
1890 See also C<guestfs_download>.");
1891
1892   ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"]), 67, [],
1893    [InitBasicFS, Always, TestOutput (
1894       (* Pick a file from cwd which isn't likely to change. *)
1895       [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1896        ["download"; "/COPYING.LIB"; "testdownload.tmp"];
1897        ["upload"; "testdownload.tmp"; "/upload"];
1898        ["checksum"; "md5"; "/upload"]],
1899       Digest.to_hex (Digest.file "COPYING.LIB"))],
1900    "download a file to the local machine",
1901    "\
1902 Download file C<remotefilename> and save it as C<filename>
1903 on the local machine.
1904
1905 C<filename> can also be a named pipe.
1906
1907 See also C<guestfs_upload>, C<guestfs_cat>.");
1908
1909   ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"]), 68, [],
1910    [InitISOFS, Always, TestOutput (
1911       [["checksum"; "crc"; "/known-3"]], "2891671662");
1912     InitISOFS, Always, TestLastFail (
1913       [["checksum"; "crc"; "/notexists"]]);
1914     InitISOFS, Always, TestOutput (
1915       [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
1916     InitISOFS, Always, TestOutput (
1917       [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
1918     InitISOFS, Always, TestOutput (
1919       [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
1920     InitISOFS, Always, TestOutput (
1921       [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
1922     InitISOFS, Always, TestOutput (
1923       [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
1924     InitISOFS, Always, TestOutput (
1925       [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6")],
1926    "compute MD5, SHAx or CRC checksum of file",
1927    "\
1928 This call computes the MD5, SHAx or CRC checksum of the
1929 file named C<path>.
1930
1931 The type of checksum to compute is given by the C<csumtype>
1932 parameter which must have one of the following values:
1933
1934 =over 4
1935
1936 =item C<crc>
1937
1938 Compute the cyclic redundancy check (CRC) specified by POSIX
1939 for the C<cksum> command.
1940
1941 =item C<md5>
1942
1943 Compute the MD5 hash (using the C<md5sum> program).
1944
1945 =item C<sha1>
1946
1947 Compute the SHA1 hash (using the C<sha1sum> program).
1948
1949 =item C<sha224>
1950
1951 Compute the SHA224 hash (using the C<sha224sum> program).
1952
1953 =item C<sha256>
1954
1955 Compute the SHA256 hash (using the C<sha256sum> program).
1956
1957 =item C<sha384>
1958
1959 Compute the SHA384 hash (using the C<sha384sum> program).
1960
1961 =item C<sha512>
1962
1963 Compute the SHA512 hash (using the C<sha512sum> program).
1964
1965 =back
1966
1967 The checksum is returned as a printable string.");
1968
1969   ("tar_in", (RErr, [FileIn "tarfile"; String "directory"]), 69, [],
1970    [InitBasicFS, Always, TestOutput (
1971       [["tar_in"; "../images/helloworld.tar"; "/"];
1972        ["cat"; "/hello"]], "hello\n")],
1973    "unpack tarfile to directory",
1974    "\
1975 This command uploads and unpacks local file C<tarfile> (an
1976 I<uncompressed> tar file) into C<directory>.
1977
1978 To upload a compressed tarball, use C<guestfs_tgz_in>.");
1979
1980   ("tar_out", (RErr, [String "directory"; FileOut "tarfile"]), 70, [],
1981    [],
1982    "pack directory into tarfile",
1983    "\
1984 This command packs the contents of C<directory> and downloads
1985 it to local file C<tarfile>.
1986
1987 To download a compressed tarball, use C<guestfs_tgz_out>.");
1988
1989   ("tgz_in", (RErr, [FileIn "tarball"; String "directory"]), 71, [],
1990    [InitBasicFS, Always, TestOutput (
1991       [["tgz_in"; "../images/helloworld.tar.gz"; "/"];
1992        ["cat"; "/hello"]], "hello\n")],
1993    "unpack compressed tarball to directory",
1994    "\
1995 This command uploads and unpacks local file C<tarball> (a
1996 I<gzip compressed> tar file) into C<directory>.
1997
1998 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
1999
2000   ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"]), 72, [],
2001    [],
2002    "pack directory into compressed tarball",
2003    "\
2004 This command packs the contents of C<directory> and downloads
2005 it to local file C<tarball>.
2006
2007 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2008
2009   ("mount_ro", (RErr, [Device "device"; String "mountpoint"]), 73, [],
2010    [InitBasicFS, Always, TestLastFail (
2011       [["umount"; "/"];
2012        ["mount_ro"; "/dev/sda1"; "/"];
2013        ["touch"; "/new"]]);
2014     InitBasicFS, Always, TestOutput (
2015       [["write_file"; "/new"; "data"; "0"];
2016        ["umount"; "/"];
2017        ["mount_ro"; "/dev/sda1"; "/"];
2018        ["cat"; "/new"]], "data")],
2019    "mount a guest disk, read-only",
2020    "\
2021 This is the same as the C<guestfs_mount> command, but it
2022 mounts the filesystem with the read-only (I<-o ro>) flag.");
2023
2024   ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"]), 74, [],
2025    [],
2026    "mount a guest disk with mount options",
2027    "\
2028 This is the same as the C<guestfs_mount> command, but it
2029 allows you to set the mount options as for the
2030 L<mount(8)> I<-o> flag.");
2031
2032   ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"]), 75, [],
2033    [],
2034    "mount a guest disk with mount options and vfstype",
2035    "\
2036 This is the same as the C<guestfs_mount> command, but it
2037 allows you to set both the mount options and the vfstype
2038 as for the L<mount(8)> I<-o> and I<-t> flags.");
2039
2040   ("debug", (RString "result", [String "subcmd"; StringList "extraargs"]), 76, [],
2041    [],
2042    "debugging and internals",
2043    "\
2044 The C<guestfs_debug> command exposes some internals of
2045 C<guestfsd> (the guestfs daemon) that runs inside the
2046 qemu subprocess.
2047
2048 There is no comprehensive help for this command.  You have
2049 to look at the file C<daemon/debug.c> in the libguestfs source
2050 to find out what you can do.");
2051
2052   ("lvremove", (RErr, [Device "device"]), 77, [Optional "lvm2"],
2053    [InitEmpty, Always, TestOutputList (
2054       [["part_disk"; "/dev/sda"; "mbr"];
2055        ["pvcreate"; "/dev/sda1"];
2056        ["vgcreate"; "VG"; "/dev/sda1"];
2057        ["lvcreate"; "LV1"; "VG"; "50"];
2058        ["lvcreate"; "LV2"; "VG"; "50"];
2059        ["lvremove"; "/dev/VG/LV1"];
2060        ["lvs"]], ["/dev/VG/LV2"]);
2061     InitEmpty, Always, TestOutputList (
2062       [["part_disk"; "/dev/sda"; "mbr"];
2063        ["pvcreate"; "/dev/sda1"];
2064        ["vgcreate"; "VG"; "/dev/sda1"];
2065        ["lvcreate"; "LV1"; "VG"; "50"];
2066        ["lvcreate"; "LV2"; "VG"; "50"];
2067        ["lvremove"; "/dev/VG"];
2068        ["lvs"]], []);
2069     InitEmpty, Always, TestOutputList (
2070       [["part_disk"; "/dev/sda"; "mbr"];
2071        ["pvcreate"; "/dev/sda1"];
2072        ["vgcreate"; "VG"; "/dev/sda1"];
2073        ["lvcreate"; "LV1"; "VG"; "50"];
2074        ["lvcreate"; "LV2"; "VG"; "50"];
2075        ["lvremove"; "/dev/VG"];
2076        ["vgs"]], ["VG"])],
2077    "remove an LVM logical volume",
2078    "\
2079 Remove an LVM logical volume C<device>, where C<device> is
2080 the path to the LV, such as C</dev/VG/LV>.
2081
2082 You can also remove all LVs in a volume group by specifying
2083 the VG name, C</dev/VG>.");
2084
2085   ("vgremove", (RErr, [String "vgname"]), 78, [Optional "lvm2"],
2086    [InitEmpty, Always, TestOutputList (
2087       [["part_disk"; "/dev/sda"; "mbr"];
2088        ["pvcreate"; "/dev/sda1"];
2089        ["vgcreate"; "VG"; "/dev/sda1"];
2090        ["lvcreate"; "LV1"; "VG"; "50"];
2091        ["lvcreate"; "LV2"; "VG"; "50"];
2092        ["vgremove"; "VG"];
2093        ["lvs"]], []);
2094     InitEmpty, Always, TestOutputList (
2095       [["part_disk"; "/dev/sda"; "mbr"];
2096        ["pvcreate"; "/dev/sda1"];
2097        ["vgcreate"; "VG"; "/dev/sda1"];
2098        ["lvcreate"; "LV1"; "VG"; "50"];
2099        ["lvcreate"; "LV2"; "VG"; "50"];
2100        ["vgremove"; "VG"];
2101        ["vgs"]], [])],
2102    "remove an LVM volume group",
2103    "\
2104 Remove an LVM volume group C<vgname>, (for example C<VG>).
2105
2106 This also forcibly removes all logical volumes in the volume
2107 group (if any).");
2108
2109   ("pvremove", (RErr, [Device "device"]), 79, [Optional "lvm2"],
2110    [InitEmpty, Always, TestOutputListOfDevices (
2111       [["part_disk"; "/dev/sda"; "mbr"];
2112        ["pvcreate"; "/dev/sda1"];
2113        ["vgcreate"; "VG"; "/dev/sda1"];
2114        ["lvcreate"; "LV1"; "VG"; "50"];
2115        ["lvcreate"; "LV2"; "VG"; "50"];
2116        ["vgremove"; "VG"];
2117        ["pvremove"; "/dev/sda1"];
2118        ["lvs"]], []);
2119     InitEmpty, Always, TestOutputListOfDevices (
2120       [["part_disk"; "/dev/sda"; "mbr"];
2121        ["pvcreate"; "/dev/sda1"];
2122        ["vgcreate"; "VG"; "/dev/sda1"];
2123        ["lvcreate"; "LV1"; "VG"; "50"];
2124        ["lvcreate"; "LV2"; "VG"; "50"];
2125        ["vgremove"; "VG"];
2126        ["pvremove"; "/dev/sda1"];
2127        ["vgs"]], []);
2128     InitEmpty, Always, TestOutputListOfDevices (
2129       [["part_disk"; "/dev/sda"; "mbr"];
2130        ["pvcreate"; "/dev/sda1"];
2131        ["vgcreate"; "VG"; "/dev/sda1"];
2132        ["lvcreate"; "LV1"; "VG"; "50"];
2133        ["lvcreate"; "LV2"; "VG"; "50"];
2134        ["vgremove"; "VG"];
2135        ["pvremove"; "/dev/sda1"];
2136        ["pvs"]], [])],
2137    "remove an LVM physical volume",
2138    "\
2139 This wipes a physical volume C<device> so that LVM will no longer
2140 recognise it.
2141
2142 The implementation uses the C<pvremove> command which refuses to
2143 wipe physical volumes that contain any volume groups, so you have
2144 to remove those first.");
2145
2146   ("set_e2label", (RErr, [Device "device"; String "label"]), 80, [],
2147    [InitBasicFS, Always, TestOutput (
2148       [["set_e2label"; "/dev/sda1"; "testlabel"];
2149        ["get_e2label"; "/dev/sda1"]], "testlabel")],
2150    "set the ext2/3/4 filesystem label",
2151    "\
2152 This sets the ext2/3/4 filesystem label of the filesystem on
2153 C<device> to C<label>.  Filesystem labels are limited to
2154 16 characters.
2155
2156 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2157 to return the existing label on a filesystem.");
2158
2159   ("get_e2label", (RString "label", [Device "device"]), 81, [],
2160    [],
2161    "get the ext2/3/4 filesystem label",
2162    "\
2163 This returns the ext2/3/4 filesystem label of the filesystem on
2164 C<device>.");
2165
2166   ("set_e2uuid", (RErr, [Device "device"; String "uuid"]), 82, [],
2167    (let uuid = uuidgen () in
2168     [InitBasicFS, Always, TestOutput (
2169        [["set_e2uuid"; "/dev/sda1"; uuid];
2170         ["get_e2uuid"; "/dev/sda1"]], uuid);
2171      InitBasicFS, Always, TestOutput (
2172        [["set_e2uuid"; "/dev/sda1"; "clear"];
2173         ["get_e2uuid"; "/dev/sda1"]], "");
2174      (* We can't predict what UUIDs will be, so just check the commands run. *)
2175      InitBasicFS, Always, TestRun (
2176        [["set_e2uuid"; "/dev/sda1"; "random"]]);
2177      InitBasicFS, Always, TestRun (
2178        [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2179    "set the ext2/3/4 filesystem UUID",
2180    "\
2181 This sets the ext2/3/4 filesystem UUID of the filesystem on
2182 C<device> to C<uuid>.  The format of the UUID and alternatives
2183 such as C<clear>, C<random> and C<time> are described in the
2184 L<tune2fs(8)> manpage.
2185
2186 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2187 to return the existing UUID of a filesystem.");
2188
2189   ("get_e2uuid", (RString "uuid", [Device "device"]), 83, [],
2190    [],
2191    "get the ext2/3/4 filesystem UUID",
2192    "\
2193 This returns the ext2/3/4 filesystem UUID of the filesystem on
2194 C<device>.");
2195
2196   ("fsck", (RInt "status", [String "fstype"; Device "device"]), 84, [],
2197    [InitBasicFS, Always, TestOutputInt (
2198       [["umount"; "/dev/sda1"];
2199        ["fsck"; "ext2"; "/dev/sda1"]], 0);
2200     InitBasicFS, Always, TestOutputInt (
2201       [["umount"; "/dev/sda1"];
2202        ["zero"; "/dev/sda1"];
2203        ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2204    "run the filesystem checker",
2205    "\
2206 This runs the filesystem checker (fsck) on C<device> which
2207 should have filesystem type C<fstype>.
2208
2209 The returned integer is the status.  See L<fsck(8)> for the
2210 list of status codes from C<fsck>.
2211
2212 Notes:
2213
2214 =over 4
2215
2216 =item *
2217
2218 Multiple status codes can be summed together.
2219
2220 =item *
2221
2222 A non-zero return code can mean \"success\", for example if
2223 errors have been corrected on the filesystem.
2224
2225 =item *
2226
2227 Checking or repairing NTFS volumes is not supported
2228 (by linux-ntfs).
2229
2230 =back
2231
2232 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2233
2234   ("zero", (RErr, [Device "device"]), 85, [],
2235    [InitBasicFS, Always, TestOutput (
2236       [["umount"; "/dev/sda1"];
2237        ["zero"; "/dev/sda1"];
2238        ["file"; "/dev/sda1"]], "data")],
2239    "write zeroes to the device",
2240    "\
2241 This command writes zeroes over the first few blocks of C<device>.
2242
2243 How many blocks are zeroed isn't specified (but it's I<not> enough
2244 to securely wipe the device).  It should be sufficient to remove
2245 any partition tables, filesystem superblocks and so on.
2246
2247 See also: C<guestfs_scrub_device>.");
2248
2249   ("grub_install", (RErr, [Pathname "root"; Device "device"]), 86, [],
2250    (* Test disabled because grub-install incompatible with virtio-blk driver.
2251     * See also: https://bugzilla.redhat.com/show_bug.cgi?id=479760
2252     *)
2253    [InitBasicFS, Disabled, TestOutputTrue (
2254       [["grub_install"; "/"; "/dev/sda1"];
2255        ["is_dir"; "/boot"]])],
2256    "install GRUB",
2257    "\
2258 This command installs GRUB (the Grand Unified Bootloader) on
2259 C<device>, with the root directory being C<root>.");
2260
2261   ("cp", (RErr, [Pathname "src"; Pathname "dest"]), 87, [],
2262    [InitBasicFS, Always, TestOutput (
2263       [["write_file"; "/old"; "file content"; "0"];
2264        ["cp"; "/old"; "/new"];
2265        ["cat"; "/new"]], "file content");
2266     InitBasicFS, Always, TestOutputTrue (
2267       [["write_file"; "/old"; "file content"; "0"];
2268        ["cp"; "/old"; "/new"];
2269        ["is_file"; "/old"]]);
2270     InitBasicFS, Always, TestOutput (
2271       [["write_file"; "/old"; "file content"; "0"];
2272        ["mkdir"; "/dir"];
2273        ["cp"; "/old"; "/dir/new"];
2274        ["cat"; "/dir/new"]], "file content")],
2275    "copy a file",
2276    "\
2277 This copies a file from C<src> to C<dest> where C<dest> is
2278 either a destination filename or destination directory.");
2279
2280   ("cp_a", (RErr, [Pathname "src"; Pathname "dest"]), 88, [],
2281    [InitBasicFS, Always, TestOutput (
2282       [["mkdir"; "/olddir"];
2283        ["mkdir"; "/newdir"];
2284        ["write_file"; "/olddir/file"; "file content"; "0"];
2285        ["cp_a"; "/olddir"; "/newdir"];
2286        ["cat"; "/newdir/olddir/file"]], "file content")],
2287    "copy a file or directory recursively",
2288    "\
2289 This copies a file or directory from C<src> to C<dest>
2290 recursively using the C<cp -a> command.");
2291
2292   ("mv", (RErr, [Pathname "src"; Pathname "dest"]), 89, [],
2293    [InitBasicFS, Always, TestOutput (
2294       [["write_file"; "/old"; "file content"; "0"];
2295        ["mv"; "/old"; "/new"];
2296        ["cat"; "/new"]], "file content");
2297     InitBasicFS, Always, TestOutputFalse (
2298       [["write_file"; "/old"; "file content"; "0"];
2299        ["mv"; "/old"; "/new"];
2300        ["is_file"; "/old"]])],
2301    "move a file",
2302    "\
2303 This moves a file from C<src> to C<dest> where C<dest> is
2304 either a destination filename or destination directory.");
2305
2306   ("drop_caches", (RErr, [Int "whattodrop"]), 90, [],
2307    [InitEmpty, Always, TestRun (
2308       [["drop_caches"; "3"]])],
2309    "drop kernel page cache, dentries and inodes",
2310    "\
2311 This instructs the guest kernel to drop its page cache,
2312 and/or dentries and inode caches.  The parameter C<whattodrop>
2313 tells the kernel what precisely to drop, see
2314 L<http://linux-mm.org/Drop_Caches>
2315
2316 Setting C<whattodrop> to 3 should drop everything.
2317
2318 This automatically calls L<sync(2)> before the operation,
2319 so that the maximum guest memory is freed.");
2320
2321   ("dmesg", (RString "kmsgs", []), 91, [],
2322    [InitEmpty, Always, TestRun (
2323       [["dmesg"]])],
2324    "return kernel messages",
2325    "\
2326 This returns the kernel messages (C<dmesg> output) from
2327 the guest kernel.  This is sometimes useful for extended
2328 debugging of problems.
2329
2330 Another way to get the same information is to enable
2331 verbose messages with C<guestfs_set_verbose> or by setting
2332 the environment variable C<LIBGUESTFS_DEBUG=1> before
2333 running the program.");
2334
2335   ("ping_daemon", (RErr, []), 92, [],
2336    [InitEmpty, Always, TestRun (
2337       [["ping_daemon"]])],
2338    "ping the guest daemon",
2339    "\
2340 This is a test probe into the guestfs daemon running inside
2341 the qemu subprocess.  Calling this function checks that the
2342 daemon responds to the ping message, without affecting the daemon
2343 or attached block device(s) in any other way.");
2344
2345   ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"]), 93, [],
2346    [InitBasicFS, Always, TestOutputTrue (
2347       [["write_file"; "/file1"; "contents of a file"; "0"];
2348        ["cp"; "/file1"; "/file2"];
2349        ["equal"; "/file1"; "/file2"]]);
2350     InitBasicFS, Always, TestOutputFalse (
2351       [["write_file"; "/file1"; "contents of a file"; "0"];
2352        ["write_file"; "/file2"; "contents of another file"; "0"];
2353        ["equal"; "/file1"; "/file2"]]);
2354     InitBasicFS, Always, TestLastFail (
2355       [["equal"; "/file1"; "/file2"]])],
2356    "test if two files have equal contents",
2357    "\
2358 This compares the two files C<file1> and C<file2> and returns
2359 true if their content is exactly equal, or false otherwise.
2360
2361 The external L<cmp(1)> program is used for the comparison.");
2362
2363   ("strings", (RStringList "stringsout", [Pathname "path"]), 94, [ProtocolLimitWarning],
2364    [InitISOFS, Always, TestOutputList (
2365       [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
2366     InitISOFS, Always, TestOutputList (
2367       [["strings"; "/empty"]], [])],
2368    "print the printable strings in a file",
2369    "\
2370 This runs the L<strings(1)> command on a file and returns
2371 the list of printable strings found.");
2372
2373   ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"]), 95, [ProtocolLimitWarning],
2374    [InitISOFS, Always, TestOutputList (
2375       [["strings_e"; "b"; "/known-5"]], []);
2376     InitBasicFS, Disabled, TestOutputList (
2377       [["write_file"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"; "24"];
2378        ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
2379    "print the printable strings in a file",
2380    "\
2381 This is like the C<guestfs_strings> command, but allows you to
2382 specify the encoding.
2383
2384 See the L<strings(1)> manpage for the full list of encodings.
2385
2386 Commonly useful encodings are C<l> (lower case L) which will
2387 show strings inside Windows/x86 files.
2388
2389 The returned strings are transcoded to UTF-8.");
2390
2391   ("hexdump", (RString "dump", [Pathname "path"]), 96, [ProtocolLimitWarning],
2392    [InitISOFS, Always, TestOutput (
2393       [["hexdump"; "/known-4"]], "00000000  61 62 63 0a 64 65 66 0a  67 68 69                 |abc.def.ghi|\n0000000b\n");
2394     (* Test for RHBZ#501888c2 regression which caused large hexdump
2395      * commands to segfault.
2396      *)
2397     InitISOFS, Always, TestRun (
2398       [["hexdump"; "/100krandom"]])],
2399    "dump a file in hexadecimal",
2400    "\
2401 This runs C<hexdump -C> on the given C<path>.  The result is
2402 the human-readable, canonical hex dump of the file.");
2403
2404   ("zerofree", (RErr, [Device "device"]), 97, [Optional "zerofree"],
2405    [InitNone, Always, TestOutput (
2406       [["part_disk"; "/dev/sda"; "mbr"];
2407        ["mkfs"; "ext3"; "/dev/sda1"];
2408        ["mount"; "/dev/sda1"; "/"];
2409        ["write_file"; "/new"; "test file"; "0"];
2410        ["umount"; "/dev/sda1"];
2411        ["zerofree"; "/dev/sda1"];
2412        ["mount"; "/dev/sda1"; "/"];
2413        ["cat"; "/new"]], "test file")],
2414    "zero unused inodes and disk blocks on ext2/3 filesystem",
2415    "\
2416 This runs the I<zerofree> program on C<device>.  This program
2417 claims to zero unused inodes and disk blocks on an ext2/3
2418 filesystem, thus making it possible to compress the filesystem
2419 more effectively.
2420
2421 You should B<not> run this program if the filesystem is
2422 mounted.
2423
2424 It is possible that using this program can damage the filesystem
2425 or data on the filesystem.");
2426
2427   ("pvresize", (RErr, [Device "device"]), 98, [Optional "lvm2"],
2428    [],
2429    "resize an LVM physical volume",
2430    "\
2431 This resizes (expands or shrinks) an existing LVM physical
2432 volume to match the new size of the underlying device.");
2433
2434   ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
2435                        Int "cyls"; Int "heads"; Int "sectors";
2436                        String "line"]), 99, [DangerWillRobinson],
2437    [],
2438    "modify a single partition on a block device",
2439    "\
2440 This runs L<sfdisk(8)> option to modify just the single
2441 partition C<n> (note: C<n> counts from 1).
2442
2443 For other parameters, see C<guestfs_sfdisk>.  You should usually
2444 pass C<0> for the cyls/heads/sectors parameters.
2445
2446 See also: C<guestfs_part_add>");
2447
2448   ("sfdisk_l", (RString "partitions", [Device "device"]), 100, [],
2449    [],
2450    "display the partition table",
2451    "\
2452 This displays the partition table on C<device>, in the
2453 human-readable output of the L<sfdisk(8)> command.  It is
2454 not intended to be parsed.
2455
2456 See also: C<guestfs_part_list>");
2457
2458   ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"]), 101, [],
2459    [],
2460    "display the kernel geometry",
2461    "\
2462 This displays the kernel's idea of the geometry of C<device>.
2463
2464 The result is in human-readable format, and not designed to
2465 be parsed.");
2466
2467   ("sfdisk_disk_geometry", (RString "partitions", [Device "device"]), 102, [],
2468    [],
2469    "display the disk geometry from the partition table",
2470    "\
2471 This displays the disk geometry of C<device> read from the
2472 partition table.  Especially in the case where the underlying
2473 block device has been resized, this can be different from the
2474 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
2475
2476 The result is in human-readable format, and not designed to
2477 be parsed.");
2478
2479   ("vg_activate_all", (RErr, [Bool "activate"]), 103, [Optional "lvm2"],
2480    [],
2481    "activate or deactivate all volume groups",
2482    "\
2483 This command activates or (if C<activate> is false) deactivates
2484 all logical volumes in all volume groups.
2485 If activated, then they are made known to the
2486 kernel, ie. they appear as C</dev/mapper> devices.  If deactivated,
2487 then those devices disappear.
2488
2489 This command is the same as running C<vgchange -a y|n>");
2490
2491   ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"]), 104, [Optional "lvm2"],
2492    [],
2493    "activate or deactivate some volume groups",
2494    "\
2495 This command activates or (if C<activate> is false) deactivates
2496 all logical volumes in the listed volume groups C<volgroups>.
2497 If activated, then they are made known to the
2498 kernel, ie. they appear as C</dev/mapper> devices.  If deactivated,
2499 then those devices disappear.
2500
2501 This command is the same as running C<vgchange -a y|n volgroups...>
2502
2503 Note that if C<volgroups> is an empty list then B<all> volume groups
2504 are activated or deactivated.");
2505
2506   ("lvresize", (RErr, [Device "device"; Int "mbytes"]), 105, [Optional "lvm2"],
2507    [InitNone, Always, TestOutput (
2508       [["part_disk"; "/dev/sda"; "mbr"];
2509        ["pvcreate"; "/dev/sda1"];
2510        ["vgcreate"; "VG"; "/dev/sda1"];
2511        ["lvcreate"; "LV"; "VG"; "10"];
2512        ["mkfs"; "ext2"; "/dev/VG/LV"];
2513        ["mount"; "/dev/VG/LV"; "/"];
2514        ["write_file"; "/new"; "test content"; "0"];
2515        ["umount"; "/"];
2516        ["lvresize"; "/dev/VG/LV"; "20"];
2517        ["e2fsck_f"; "/dev/VG/LV"];
2518        ["resize2fs"; "/dev/VG/LV"];
2519        ["mount"; "/dev/VG/LV"; "/"];
2520        ["cat"; "/new"]], "test content")],
2521    "resize an LVM logical volume",
2522    "\
2523 This resizes (expands or shrinks) an existing LVM logical
2524 volume to C<mbytes>.  When reducing, data in the reduced part
2525 is lost.");
2526
2527   ("resize2fs", (RErr, [Device "device"]), 106, [],
2528    [], (* lvresize tests this *)
2529    "resize an ext2/ext3 filesystem",
2530    "\
2531 This resizes an ext2 or ext3 filesystem to match the size of
2532 the underlying device.
2533
2534 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
2535 on the C<device> before calling this command.  For unknown reasons
2536 C<resize2fs> sometimes gives an error about this and sometimes not.
2537 In any case, it is always safe to call C<guestfs_e2fsck_f> before
2538 calling this function.");
2539
2540   ("find", (RStringList "names", [Pathname "directory"]), 107, [ProtocolLimitWarning],
2541    [InitBasicFS, Always, TestOutputList (
2542       [["find"; "/"]], ["lost+found"]);
2543     InitBasicFS, Always, TestOutputList (
2544       [["touch"; "/a"];
2545        ["mkdir"; "/b"];
2546        ["touch"; "/b/c"];
2547        ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
2548     InitBasicFS, Always, TestOutputList (
2549       [["mkdir_p"; "/a/b/c"];
2550        ["touch"; "/a/b/c/d"];
2551        ["find"; "/a/b/"]], ["c"; "c/d"])],
2552    "find all files and directories",
2553    "\
2554 This command lists out all files and directories, recursively,
2555 starting at C<directory>.  It is essentially equivalent to
2556 running the shell command C<find directory -print> but some
2557 post-processing happens on the output, described below.
2558
2559 This returns a list of strings I<without any prefix>.  Thus
2560 if the directory structure was:
2561
2562  /tmp/a
2563  /tmp/b
2564  /tmp/c/d
2565
2566 then the returned list from C<guestfs_find> C</tmp> would be
2567 4 elements:
2568
2569  a
2570  b
2571  c
2572  c/d
2573
2574 If C<directory> is not a directory, then this command returns
2575 an error.
2576
2577 The returned list is sorted.
2578
2579 See also C<guestfs_find0>.");
2580
2581   ("e2fsck_f", (RErr, [Device "device"]), 108, [],
2582    [], (* lvresize tests this *)
2583    "check an ext2/ext3 filesystem",
2584    "\
2585 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
2586 filesystem checker on C<device>, noninteractively (C<-p>),
2587 even if the filesystem appears to be clean (C<-f>).
2588
2589 This command is only needed because of C<guestfs_resize2fs>
2590 (q.v.).  Normally you should use C<guestfs_fsck>.");
2591
2592   ("sleep", (RErr, [Int "secs"]), 109, [],
2593    [InitNone, Always, TestRun (
2594       [["sleep"; "1"]])],
2595    "sleep for some seconds",
2596    "\
2597 Sleep for C<secs> seconds.");
2598
2599   ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"]), 110, [Optional "ntfs3g"],
2600    [InitNone, Always, TestOutputInt (
2601       [["part_disk"; "/dev/sda"; "mbr"];
2602        ["mkfs"; "ntfs"; "/dev/sda1"];
2603        ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
2604     InitNone, Always, TestOutputInt (
2605       [["part_disk"; "/dev/sda"; "mbr"];
2606        ["mkfs"; "ext2"; "/dev/sda1"];
2607        ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
2608    "probe NTFS volume",
2609    "\
2610 This command runs the L<ntfs-3g.probe(8)> command which probes
2611 an NTFS C<device> for mountability.  (Not all NTFS volumes can
2612 be mounted read-write, and some cannot be mounted at all).
2613
2614 C<rw> is a boolean flag.  Set it to true if you want to test
2615 if the volume can be mounted read-write.  Set it to false if
2616 you want to test if the volume can be mounted read-only.
2617
2618 The return value is an integer which C<0> if the operation
2619 would succeed, or some non-zero value documented in the
2620 L<ntfs-3g.probe(8)> manual page.");
2621
2622   ("sh", (RString "output", [String "command"]), 111, [],
2623    [], (* XXX needs tests *)
2624    "run a command via the shell",
2625    "\
2626 This call runs a command from the guest filesystem via the
2627 guest's C</bin/sh>.
2628
2629 This is like C<guestfs_command>, but passes the command to:
2630
2631  /bin/sh -c \"command\"
2632
2633 Depending on the guest's shell, this usually results in
2634 wildcards being expanded, shell expressions being interpolated
2635 and so on.
2636
2637 All the provisos about C<guestfs_command> apply to this call.");
2638
2639   ("sh_lines", (RStringList "lines", [String "command"]), 112, [],
2640    [], (* XXX needs tests *)
2641    "run a command via the shell returning lines",
2642    "\
2643 This is the same as C<guestfs_sh>, but splits the result
2644 into a list of lines.
2645
2646 See also: C<guestfs_command_lines>");
2647
2648   ("glob_expand", (RStringList "paths", [Pathname "pattern"]), 113, [],
2649    (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
2650     * code in stubs.c, since all valid glob patterns must start with "/".
2651     * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
2652     *)
2653    [InitBasicFS, Always, TestOutputList (
2654       [["mkdir_p"; "/a/b/c"];
2655        ["touch"; "/a/b/c/d"];
2656        ["touch"; "/a/b/c/e"];
2657        ["glob_expand"; "/a/b/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2658     InitBasicFS, Always, TestOutputList (
2659       [["mkdir_p"; "/a/b/c"];
2660        ["touch"; "/a/b/c/d"];
2661        ["touch"; "/a/b/c/e"];
2662        ["glob_expand"; "/a/*/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2663     InitBasicFS, Always, TestOutputList (
2664       [["mkdir_p"; "/a/b/c"];
2665        ["touch"; "/a/b/c/d"];
2666        ["touch"; "/a/b/c/e"];
2667        ["glob_expand"; "/a/*/x/*"]], [])],
2668    "expand a wildcard path",
2669    "\
2670 This command searches for all the pathnames matching
2671 C<pattern> according to the wildcard expansion rules
2672 used by the shell.
2673
2674 If no paths match, then this returns an empty list
2675 (note: not an error).
2676
2677 It is just a wrapper around the C L<glob(3)> function
2678 with flags C<GLOB_MARK|GLOB_BRACE>.
2679 See that manual page for more details.");
2680
2681   ("scrub_device", (RErr, [Device "device"]), 114, [DangerWillRobinson; Optional "scrub"],
2682    [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
2683       [["scrub_device"; "/dev/sdc"]])],
2684    "scrub (securely wipe) a device",
2685    "\
2686 This command writes patterns over C<device> to make data retrieval
2687 more difficult.
2688
2689 It is an interface to the L<scrub(1)> program.  See that
2690 manual page for more details.");
2691
2692   ("scrub_file", (RErr, [Pathname "file"]), 115, [Optional "scrub"],
2693    [InitBasicFS, Always, TestRun (
2694       [["write_file"; "/file"; "content"; "0"];
2695        ["scrub_file"; "/file"]])],
2696    "scrub (securely wipe) a file",
2697    "\
2698 This command writes patterns over a file to make data retrieval
2699 more difficult.
2700
2701 The file is I<removed> after scrubbing.
2702
2703 It is an interface to the L<scrub(1)> program.  See that
2704 manual page for more details.");
2705
2706   ("scrub_freespace", (RErr, [Pathname "dir"]), 116, [Optional "scrub"],
2707    [], (* XXX needs testing *)
2708    "scrub (securely wipe) free space",
2709    "\
2710 This command creates the directory C<dir> and then fills it
2711 with files until the filesystem is full, and scrubs the files
2712 as for C<guestfs_scrub_file>, and deletes them.
2713 The intention is to scrub any free space on the partition
2714 containing C<dir>.
2715
2716 It is an interface to the L<scrub(1)> program.  See that
2717 manual page for more details.");
2718
2719   ("mkdtemp", (RString "dir", [Pathname "template"]), 117, [],
2720    [InitBasicFS, Always, TestRun (
2721       [["mkdir"; "/tmp"];
2722        ["mkdtemp"; "/tmp/tmpXXXXXX"]])],
2723    "create a temporary directory",
2724    "\
2725 This command creates a temporary directory.  The
2726 C<template> parameter should be a full pathname for the
2727 temporary directory name with the final six characters being
2728 \"XXXXXX\".
2729
2730 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
2731 the second one being suitable for Windows filesystems.
2732
2733 The name of the temporary directory that was created
2734 is returned.
2735
2736 The temporary directory is created with mode 0700
2737 and is owned by root.
2738
2739 The caller is responsible for deleting the temporary
2740 directory and its contents after use.
2741
2742 See also: L<mkdtemp(3)>");
2743
2744   ("wc_l", (RInt "lines", [Pathname "path"]), 118, [],
2745    [InitISOFS, Always, TestOutputInt (
2746       [["wc_l"; "/10klines"]], 10000)],
2747    "count lines in a file",
2748    "\
2749 This command counts the lines in a file, using the
2750 C<wc -l> external command.");
2751
2752   ("wc_w", (RInt "words", [Pathname "path"]), 119, [],
2753    [InitISOFS, Always, TestOutputInt (
2754       [["wc_w"; "/10klines"]], 10000)],
2755    "count words in a file",
2756    "\
2757 This command counts the words in a file, using the
2758 C<wc -w> external command.");
2759
2760   ("wc_c", (RInt "chars", [Pathname "path"]), 120, [],
2761    [InitISOFS, Always, TestOutputInt (
2762       [["wc_c"; "/100kallspaces"]], 102400)],
2763    "count characters in a file",
2764    "\
2765 This command counts the characters in a file, using the
2766 C<wc -c> external command.");
2767
2768   ("head", (RStringList "lines", [Pathname "path"]), 121, [ProtocolLimitWarning],
2769    [InitISOFS, Always, TestOutputList (
2770       [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
2771    "return first 10 lines of a file",
2772    "\
2773 This command returns up to the first 10 lines of a file as
2774 a list of strings.");
2775
2776   ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"]), 122, [ProtocolLimitWarning],
2777    [InitISOFS, Always, TestOutputList (
2778       [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2779     InitISOFS, Always, TestOutputList (
2780       [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2781     InitISOFS, Always, TestOutputList (
2782       [["head_n"; "0"; "/10klines"]], [])],
2783    "return first N lines of a file",
2784    "\
2785 If the parameter C<nrlines> is a positive number, this returns the first
2786 C<nrlines> lines of the file C<path>.
2787
2788 If the parameter C<nrlines> is a negative number, this returns lines
2789 from the file C<path>, excluding the last C<nrlines> lines.
2790
2791 If the parameter C<nrlines> is zero, this returns an empty list.");
2792
2793   ("tail", (RStringList "lines", [Pathname "path"]), 123, [ProtocolLimitWarning],
2794    [InitISOFS, Always, TestOutputList (
2795       [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
2796    "return last 10 lines of a file",
2797    "\
2798 This command returns up to the last 10 lines of a file as
2799 a list of strings.");
2800
2801   ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"]), 124, [ProtocolLimitWarning],
2802    [InitISOFS, Always, TestOutputList (
2803       [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2804     InitISOFS, Always, TestOutputList (
2805       [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2806     InitISOFS, Always, TestOutputList (
2807       [["tail_n"; "0"; "/10klines"]], [])],
2808    "return last N lines of a file",
2809    "\
2810 If the parameter C<nrlines> is a positive number, this returns the last
2811 C<nrlines> lines of the file C<path>.
2812
2813 If the parameter C<nrlines> is a negative number, this returns lines
2814 from the file C<path>, starting with the C<-nrlines>th line.
2815
2816 If the parameter C<nrlines> is zero, this returns an empty list.");
2817
2818   ("df", (RString "output", []), 125, [],
2819    [], (* XXX Tricky to test because it depends on the exact format
2820         * of the 'df' command and other imponderables.
2821         *)
2822    "report file system disk space usage",
2823    "\
2824 This command runs the C<df> command to report disk space used.
2825
2826 This command is mostly useful for interactive sessions.  It
2827 is I<not> intended that you try to parse the output string.
2828 Use C<statvfs> from programs.");
2829
2830   ("df_h", (RString "output", []), 126, [],
2831    [], (* XXX Tricky to test because it depends on the exact format
2832         * of the 'df' command and other imponderables.
2833         *)
2834    "report file system disk space usage (human readable)",
2835    "\
2836 This command runs the C<df -h> command to report disk space used
2837 in human-readable format.
2838
2839 This command is mostly useful for interactive sessions.  It
2840 is I<not> intended that you try to parse the output string.
2841 Use C<statvfs> from programs.");
2842
2843   ("du", (RInt64 "sizekb", [Pathname "path"]), 127, [],
2844    [InitISOFS, Always, TestOutputInt (
2845       [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
2846    "estimate file space usage",
2847    "\
2848 This command runs the C<du -s> command to estimate file space
2849 usage for C<path>.
2850
2851 C<path> can be a file or a directory.  If C<path> is a directory
2852 then the estimate includes the contents of the directory and all
2853 subdirectories (recursively).
2854
2855 The result is the estimated size in I<kilobytes>
2856 (ie. units of 1024 bytes).");
2857
2858   ("initrd_list", (RStringList "filenames", [Pathname "path"]), 128, [],
2859    [InitISOFS, Always, TestOutputList (
2860       [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
2861    "list files in an initrd",
2862    "\
2863 This command lists out files contained in an initrd.
2864
2865 The files are listed without any initial C</> character.  The
2866 files are listed in the order they appear (not necessarily
2867 alphabetical).  Directory names are listed as separate items.
2868
2869 Old Linux kernels (2.4 and earlier) used a compressed ext2
2870 filesystem as initrd.  We I<only> support the newer initramfs
2871 format (compressed cpio files).");
2872
2873   ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"]), 129, [],
2874    [],
2875    "mount a file using the loop device",
2876    "\
2877 This command lets you mount C<file> (a filesystem image
2878 in a file) on a mount point.  It is entirely equivalent to
2879 the command C<mount -o loop file mountpoint>.");
2880
2881   ("mkswap", (RErr, [Device "device"]), 130, [],
2882    [InitEmpty, Always, TestRun (
2883       [["part_disk"; "/dev/sda"; "mbr"];
2884        ["mkswap"; "/dev/sda1"]])],
2885    "create a swap partition",
2886    "\
2887 Create a swap partition on C<device>.");
2888
2889   ("mkswap_L", (RErr, [String "label"; Device "device"]), 131, [],
2890    [InitEmpty, Always, TestRun (
2891       [["part_disk"; "/dev/sda"; "mbr"];
2892        ["mkswap_L"; "hello"; "/dev/sda1"]])],
2893    "create a swap partition with a label",
2894    "\
2895 Create a swap partition on C<device> with label C<label>.
2896
2897 Note that you cannot attach a swap label to a block device
2898 (eg. C</dev/sda>), just to a partition.  This appears to be
2899 a limitation of the kernel or swap tools.");
2900
2901   ("mkswap_U", (RErr, [String "uuid"; Device "device"]), 132, [Optional "linuxfsuuid"],
2902    (let uuid = uuidgen () in
2903     [InitEmpty, Always, TestRun (
2904        [["part_disk"; "/dev/sda"; "mbr"];
2905         ["mkswap_U"; uuid; "/dev/sda1"]])]),
2906    "create a swap partition with an explicit UUID",
2907    "\
2908 Create a swap partition on C<device> with UUID C<uuid>.");
2909
2910   ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 133, [Optional "mknod"],
2911    [InitBasicFS, Always, TestOutputStruct (
2912       [["mknod"; "0o10777"; "0"; "0"; "/node"];
2913        (* NB: default umask 022 means 0777 -> 0755 in these tests *)
2914        ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)]);
2915     InitBasicFS, Always, TestOutputStruct (
2916       [["mknod"; "0o60777"; "66"; "99"; "/node"];
2917        ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
2918    "make block, character or FIFO devices",
2919    "\
2920 This call creates block or character special devices, or
2921 named pipes (FIFOs).
2922
2923 The C<mode> parameter should be the mode, using the standard
2924 constants.  C<devmajor> and C<devminor> are the
2925 device major and minor numbers, only used when creating block
2926 and character special devices.");
2927
2928   ("mkfifo", (RErr, [Int "mode"; Pathname "path"]), 134, [Optional "mknod"],
2929    [InitBasicFS, Always, TestOutputStruct (
2930       [["mkfifo"; "0o777"; "/node"];
2931        ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)])],
2932    "make FIFO (named pipe)",
2933    "\
2934 This call creates a FIFO (named pipe) called C<path> with
2935 mode C<mode>.  It is just a convenient wrapper around
2936 C<guestfs_mknod>.");
2937
2938   ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 135, [Optional "mknod"],
2939    [InitBasicFS, Always, TestOutputStruct (
2940       [["mknod_b"; "0o777"; "99"; "66"; "/node"];
2941        ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
2942    "make block device node",
2943    "\
2944 This call creates a block device node called C<path> with
2945 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
2946 It is just a convenient wrapper around C<guestfs_mknod>.");
2947
2948   ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 136, [Optional "mknod"],
2949    [InitBasicFS, Always, TestOutputStruct (
2950       [["mknod_c"; "0o777"; "99"; "66"; "/node"];
2951        ["stat"; "/node"]], [CompareWithInt ("mode", 0o20755)])],
2952    "make char device node",
2953    "\
2954 This call creates a char device node called C<path> with
2955 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
2956 It is just a convenient wrapper around C<guestfs_mknod>.");
2957
2958   ("umask", (RInt "oldmask", [Int "mask"]), 137, [],
2959    [], (* XXX umask is one of those stateful things that we should
2960         * reset between each test.
2961         *)
2962    "set file mode creation mask (umask)",
2963    "\
2964 This function sets the mask used for creating new files and
2965 device nodes to C<mask & 0777>.
2966
2967 Typical umask values would be C<022> which creates new files
2968 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
2969 C<002> which creates new files with permissions like
2970 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
2971
2972 The default umask is C<022>.  This is important because it
2973 means that directories and device nodes will be created with
2974 C<0644> or C<0755> mode even if you specify C<0777>.
2975
2976 See also L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
2977
2978 This call returns the previous umask.");
2979
2980   ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"]), 138, [],
2981    [],
2982    "read directories entries",
2983    "\
2984 This returns the list of directory entries in directory C<dir>.
2985
2986 All entries in the directory are returned, including C<.> and
2987 C<..>.  The entries are I<not> sorted, but returned in the same
2988 order as the underlying filesystem.
2989
2990 Also this call returns basic file type information about each
2991 file.  The C<ftyp> field will contain one of the following characters:
2992
2993 =over 4
2994
2995 =item 'b'
2996
2997 Block special
2998
2999 =item 'c'
3000
3001 Char special
3002
3003 =item 'd'
3004
3005 Directory
3006
3007 =item 'f'
3008
3009 FIFO (named pipe)
3010
3011 =item 'l'
3012
3013 Symbolic link
3014
3015 =item 'r'
3016
3017 Regular file
3018
3019 =item 's'
3020
3021 Socket
3022
3023 =item 'u'
3024
3025 Unknown file type
3026
3027 =item '?'
3028
3029 The L<readdir(3)> returned a C<d_type> field with an
3030 unexpected value
3031
3032 =back
3033
3034 This function is primarily intended for use by programs.  To
3035 get a simple list of names, use C<guestfs_ls>.  To get a printable
3036 directory for human consumption, use C<guestfs_ll>.");
3037
3038   ("sfdiskM", (RErr, [Device "device"; StringList "lines"]), 139, [DangerWillRobinson],
3039    [],
3040    "create partitions on a block device",
3041    "\
3042 This is a simplified interface to the C<guestfs_sfdisk>
3043 command, where partition sizes are specified in megabytes
3044 only (rounded to the nearest cylinder) and you don't need
3045 to specify the cyls, heads and sectors parameters which
3046 were rarely if ever used anyway.
3047
3048 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3049 and C<guestfs_part_disk>");
3050
3051   ("zfile", (RString "description", [String "meth"; Pathname "path"]), 140, [DeprecatedBy "file"],
3052    [],
3053    "determine file type inside a compressed file",
3054    "\
3055 This command runs C<file> after first decompressing C<path>
3056 using C<method>.
3057
3058 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3059
3060 Since 1.0.63, use C<guestfs_file> instead which can now
3061 process compressed files.");
3062
3063   ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"]), 141, [Optional "linuxxattrs"],
3064    [],
3065    "list extended attributes of a file or directory",
3066    "\
3067 This call lists the extended attributes of the file or directory
3068 C<path>.
3069
3070 At the system call level, this is a combination of the
3071 L<listxattr(2)> and L<getxattr(2)> calls.
3072
3073 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3074
3075   ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"]), 142, [Optional "linuxxattrs"],
3076    [],
3077    "list extended attributes of a file or directory",
3078    "\
3079 This is the same as C<guestfs_getxattrs>, but if C<path>
3080 is a symbolic link, then it returns the extended attributes
3081 of the link itself.");
3082
3083   ("setxattr", (RErr, [String "xattr";
3084                        String "val"; Int "vallen"; (* will be BufferIn *)
3085                        Pathname "path"]), 143, [Optional "linuxxattrs"],
3086    [],
3087    "set extended attribute of a file or directory",
3088    "\
3089 This call sets the extended attribute named C<xattr>
3090 of the file C<path> to the value C<val> (of length C<vallen>).
3091 The value is arbitrary 8 bit data.
3092
3093 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3094
3095   ("lsetxattr", (RErr, [String "xattr";
3096                         String "val"; Int "vallen"; (* will be BufferIn *)
3097                         Pathname "path"]), 144, [Optional "linuxxattrs"],
3098    [],
3099    "set extended attribute of a file or directory",
3100    "\
3101 This is the same as C<guestfs_setxattr>, but if C<path>
3102 is a symbolic link, then it sets an extended attribute
3103 of the link itself.");
3104
3105   ("removexattr", (RErr, [String "xattr"; Pathname "path"]), 145, [Optional "linuxxattrs"],
3106    [],
3107    "remove extended attribute of a file or directory",
3108    "\
3109 This call removes the extended attribute named C<xattr>
3110 of the file C<path>.
3111
3112 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3113
3114   ("lremovexattr", (RErr, [String "xattr"; Pathname "path"]), 146, [Optional "linuxxattrs"],
3115    [],
3116    "remove extended attribute of a file or directory",
3117    "\
3118 This is the same as C<guestfs_removexattr>, but if C<path>
3119 is a symbolic link, then it removes an extended attribute
3120 of the link itself.");
3121
3122   ("mountpoints", (RHashtable "mps", []), 147, [],
3123    [],
3124    "show mountpoints",
3125    "\
3126 This call is similar to C<guestfs_mounts>.  That call returns
3127 a list of devices.  This one returns a hash table (map) of
3128 device name to directory where the device is mounted.");
3129
3130   ("mkmountpoint", (RErr, [String "exemptpath"]), 148, [],
3131    (* This is a special case: while you would expect a parameter
3132     * of type "Pathname", that doesn't work, because it implies
3133     * NEED_ROOT in the generated calling code in stubs.c, and
3134     * this function cannot use NEED_ROOT.
3135     *)
3136    [],
3137    "create a mountpoint",
3138    "\
3139 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3140 specialized calls that can be used to create extra mountpoints
3141 before mounting the first filesystem.
3142
3143 These calls are I<only> necessary in some very limited circumstances,
3144 mainly the case where you want to mount a mix of unrelated and/or
3145 read-only filesystems together.
3146
3147 For example, live CDs often contain a \"Russian doll\" nest of
3148 filesystems, an ISO outer layer, with a squashfs image inside, with
3149 an ext2/3 image inside that.  You can unpack this as follows
3150 in guestfish:
3151
3152  add-ro Fedora-11-i686-Live.iso
3153  run
3154  mkmountpoint /cd
3155  mkmountpoint /squash
3156  mkmountpoint /ext3
3157  mount /dev/sda /cd
3158  mount-loop /cd/LiveOS/squashfs.img /squash
3159  mount-loop /squash/LiveOS/ext3fs.img /ext3
3160
3161 The inner filesystem is now unpacked under the /ext3 mountpoint.");
3162
3163   ("rmmountpoint", (RErr, [String "exemptpath"]), 149, [],
3164    [],
3165    "remove a mountpoint",
3166    "\
3167 This calls removes a mountpoint that was previously created
3168 with C<guestfs_mkmountpoint>.  See C<guestfs_mkmountpoint>
3169 for full details.");
3170
3171   ("read_file", (RBufferOut "content", [Pathname "path"]), 150, [ProtocolLimitWarning],
3172    [InitISOFS, Always, TestOutputBuffer (
3173       [["read_file"; "/known-4"]], "abc\ndef\nghi")],
3174    "read a file",
3175    "\
3176 This calls returns the contents of the file C<path> as a
3177 buffer.
3178
3179 Unlike C<guestfs_cat>, this function can correctly
3180 handle files that contain embedded ASCII NUL characters.
3181 However unlike C<guestfs_download>, this function is limited
3182 in the total size of file that can be handled.");
3183
3184   ("grep", (RStringList "lines", [String "regex"; Pathname "path"]), 151, [ProtocolLimitWarning],
3185    [InitISOFS, Always, TestOutputList (
3186       [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3187     InitISOFS, Always, TestOutputList (
3188       [["grep"; "nomatch"; "/test-grep.txt"]], [])],
3189    "return lines matching a pattern",
3190    "\
3191 This calls the external C<grep> program and returns the
3192 matching lines.");
3193
3194   ("egrep", (RStringList "lines", [String "regex"; Pathname "path"]), 152, [ProtocolLimitWarning],
3195    [InitISOFS, Always, TestOutputList (
3196       [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3197    "return lines matching a pattern",
3198    "\
3199 This calls the external C<egrep> program and returns the
3200 matching lines.");
3201
3202   ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"]), 153, [ProtocolLimitWarning],
3203    [InitISOFS, Always, TestOutputList (
3204       [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3205    "return lines matching a pattern",
3206    "\
3207 This calls the external C<fgrep> program and returns the
3208 matching lines.");
3209
3210   ("grepi", (RStringList "lines", [String "regex"; Pathname "path"]), 154, [ProtocolLimitWarning],
3211    [InitISOFS, Always, TestOutputList (
3212       [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3213    "return lines matching a pattern",
3214    "\
3215 This calls the external C<grep -i> program and returns the
3216 matching lines.");
3217
3218   ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 155, [ProtocolLimitWarning],
3219    [InitISOFS, Always, TestOutputList (
3220       [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3221    "return lines matching a pattern",
3222    "\
3223 This calls the external C<egrep -i> program and returns the
3224 matching lines.");
3225
3226   ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"]), 156, [ProtocolLimitWarning],
3227    [InitISOFS, Always, TestOutputList (
3228       [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3229    "return lines matching a pattern",
3230    "\
3231 This calls the external C<fgrep -i> program and returns the
3232 matching lines.");
3233
3234   ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"]), 157, [ProtocolLimitWarning],
3235    [InitISOFS, Always, TestOutputList (
3236       [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3237    "return lines matching a pattern",
3238    "\
3239 This calls the external C<zgrep> program and returns the
3240 matching lines.");
3241
3242   ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"]), 158, [ProtocolLimitWarning],
3243    [InitISOFS, Always, TestOutputList (
3244       [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3245    "return lines matching a pattern",
3246    "\
3247 This calls the external C<zegrep> program and returns the
3248 matching lines.");
3249
3250   ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"]), 159, [ProtocolLimitWarning],
3251    [InitISOFS, Always, TestOutputList (
3252       [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3253    "return lines matching a pattern",
3254    "\
3255 This calls the external C<zfgrep> program and returns the
3256 matching lines.");
3257
3258   ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 160, [ProtocolLimitWarning],
3259    [InitISOFS, Always, TestOutputList (
3260       [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3261    "return lines matching a pattern",
3262    "\
3263 This calls the external C<zgrep -i> program and returns the
3264 matching lines.");
3265
3266   ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 161, [ProtocolLimitWarning],
3267    [InitISOFS, Always, TestOutputList (
3268       [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3269    "return lines matching a pattern",
3270    "\
3271 This calls the external C<zegrep -i> program and returns the
3272 matching lines.");
3273
3274   ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"]), 162, [ProtocolLimitWarning],
3275    [InitISOFS, Always, TestOutputList (
3276       [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3277    "return lines matching a pattern",
3278    "\
3279 This calls the external C<zfgrep -i> program and returns the
3280 matching lines.");
3281
3282   ("realpath", (RString "rpath", [Pathname "path"]), 163, [Optional "realpath"],
3283    [InitISOFS, Always, TestOutput (
3284       [["realpath"; "/../directory"]], "/directory")],
3285    "canonicalized absolute pathname",
3286    "\
3287 Return the canonicalized absolute pathname of C<path>.  The
3288 returned path has no C<.>, C<..> or symbolic link path elements.");
3289
3290   ("ln", (RErr, [String "target"; Pathname "linkname"]), 164, [],
3291    [InitBasicFS, Always, TestOutputStruct (
3292       [["touch"; "/a"];
3293        ["ln"; "/a"; "/b"];
3294        ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3295    "create a hard link",
3296    "\
3297 This command creates a hard link using the C<ln> command.");
3298
3299   ("ln_f", (RErr, [String "target"; Pathname "linkname"]), 165, [],
3300    [InitBasicFS, Always, TestOutputStruct (
3301       [["touch"; "/a"];
3302        ["touch"; "/b"];
3303        ["ln_f"; "/a"; "/b"];
3304        ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3305    "create a hard link",
3306    "\
3307 This command creates a hard link using the C<ln -f> command.
3308 The C<-f> option removes the link (C<linkname>) if it exists already.");
3309
3310   ("ln_s", (RErr, [String "target"; Pathname "linkname"]), 166, [],
3311    [InitBasicFS, Always, TestOutputStruct (
3312       [["touch"; "/a"];
3313        ["ln_s"; "a"; "/b"];
3314        ["lstat"; "/b"]], [CompareWithInt ("mode", 0o120777)])],
3315    "create a symbolic link",
3316    "\
3317 This command creates a symbolic link using the C<ln -s> command.");
3318
3319   ("ln_sf", (RErr, [String "target"; Pathname "linkname"]), 167, [],
3320    [InitBasicFS, Always, TestOutput (
3321       [["mkdir_p"; "/a/b"];
3322        ["touch"; "/a/b/c"];
3323        ["ln_sf"; "../d"; "/a/b/c"];
3324        ["readlink"; "/a/b/c"]], "../d")],
3325    "create a symbolic link",
3326    "\
3327 This command creates a symbolic link using the C<ln -sf> command,
3328 The C<-f> option removes the link (C<linkname>) if it exists already.");
3329
3330   ("readlink", (RString "link", [Pathname "path"]), 168, [],
3331    [] (* XXX tested above *),
3332    "read the target of a symbolic link",
3333    "\
3334 This command reads the target of a symbolic link.");
3335
3336   ("fallocate", (RErr, [Pathname "path"; Int "len"]), 169, [],
3337    [InitBasicFS, Always, TestOutputStruct (
3338       [["fallocate"; "/a"; "1000000"];
3339        ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
3340    "preallocate a file in the guest filesystem",
3341    "\
3342 This command preallocates a file (containing zero bytes) named
3343 C<path> of size C<len> bytes.  If the file exists already, it
3344 is overwritten.
3345
3346 Do not confuse this with the guestfish-specific
3347 C<alloc> command which allocates a file in the host and
3348 attaches it as a device.");
3349
3350   ("swapon_device", (RErr, [Device "device"]), 170, [],
3351    [InitPartition, Always, TestRun (
3352       [["mkswap"; "/dev/sda1"];
3353        ["swapon_device"; "/dev/sda1"];
3354        ["swapoff_device"; "/dev/sda1"]])],
3355    "enable swap on device",
3356    "\
3357 This command enables the libguestfs appliance to use the
3358 swap device or partition named C<device>.  The increased
3359 memory is made available for all commands, for example
3360 those run using C<guestfs_command> or C<guestfs_sh>.
3361
3362 Note that you should not swap to existing guest swap
3363 partitions unless you know what you are doing.  They may
3364 contain hibernation information, or other information that
3365 the guest doesn't want you to trash.  You also risk leaking
3366 information about the host to the guest this way.  Instead,
3367 attach a new host device to the guest and swap on that.");
3368
3369   ("swapoff_device", (RErr, [Device "device"]), 171, [],
3370    [], (* XXX tested by swapon_device *)
3371    "disable swap on device",
3372    "\
3373 This command disables the libguestfs appliance swap
3374 device or partition named C<device>.
3375 See C<guestfs_swapon_device>.");
3376
3377   ("swapon_file", (RErr, [Pathname "file"]), 172, [],
3378    [InitBasicFS, Always, TestRun (
3379       [["fallocate"; "/swap"; "8388608"];
3380        ["mkswap_file"; "/swap"];
3381        ["swapon_file"; "/swap"];
3382        ["swapoff_file"; "/swap"]])],
3383    "enable swap on file",
3384    "\
3385 This command enables swap to a file.
3386 See C<guestfs_swapon_device> for other notes.");
3387
3388   ("swapoff_file", (RErr, [Pathname "file"]), 173, [],
3389    [], (* XXX tested by swapon_file *)
3390    "disable swap on file",
3391    "\
3392 This command disables the libguestfs appliance swap on file.");
3393
3394   ("swapon_label", (RErr, [String "label"]), 174, [],
3395    [InitEmpty, Always, TestRun (
3396       [["part_disk"; "/dev/sdb"; "mbr"];
3397        ["mkswap_L"; "swapit"; "/dev/sdb1"];
3398        ["swapon_label"; "swapit"];
3399        ["swapoff_label"; "swapit"];
3400        ["zero"; "/dev/sdb"];
3401        ["blockdev_rereadpt"; "/dev/sdb"]])],
3402    "enable swap on labeled swap partition",
3403    "\
3404 This command enables swap to a labeled swap partition.
3405 See C<guestfs_swapon_device> for other notes.");
3406
3407   ("swapoff_label", (RErr, [String "label"]), 175, [],
3408    [], (* XXX tested by swapon_label *)
3409    "disable swap on labeled swap partition",
3410    "\
3411 This command disables the libguestfs appliance swap on
3412 labeled swap partition.");
3413
3414   ("swapon_uuid", (RErr, [String "uuid"]), 176, [Optional "linuxfsuuid"],
3415    (let uuid = uuidgen () in
3416     [InitEmpty, Always, TestRun (
3417        [["mkswap_U"; uuid; "/dev/sdb"];
3418         ["swapon_uuid"; uuid];
3419         ["swapoff_uuid"; uuid]])]),
3420    "enable swap on swap partition by UUID",
3421    "\
3422 This command enables swap to a swap partition with the given UUID.
3423 See C<guestfs_swapon_device> for other notes.");
3424
3425   ("swapoff_uuid", (RErr, [String "uuid"]), 177, [Optional "linuxfsuuid"],
3426    [], (* XXX tested by swapon_uuid *)
3427    "disable swap on swap partition by UUID",
3428    "\
3429 This command disables the libguestfs appliance swap partition
3430 with the given UUID.");
3431
3432   ("mkswap_file", (RErr, [Pathname "path"]), 178, [],
3433    [InitBasicFS, Always, TestRun (
3434       [["fallocate"; "/swap"; "8388608"];
3435        ["mkswap_file"; "/swap"]])],
3436    "create a swap file",
3437    "\
3438 Create a swap file.
3439
3440 This command just writes a swap file signature to an existing
3441 file.  To create the file itself, use something like C<guestfs_fallocate>.");
3442
3443   ("inotify_init", (RErr, [Int "maxevents"]), 179, [Optional "inotify"],
3444    [InitISOFS, Always, TestRun (
3445       [["inotify_init"; "0"]])],
3446    "create an inotify handle",
3447    "\
3448 This command creates a new inotify handle.
3449 The inotify subsystem can be used to notify events which happen to
3450 objects in the guest filesystem.
3451
3452 C<maxevents> is the maximum number of events which will be
3453 queued up between calls to C<guestfs_inotify_read> or
3454 C<guestfs_inotify_files>.
3455 If this is passed as C<0>, then the kernel (or previously set)
3456 default is used.  For Linux 2.6.29 the default was 16384 events.
3457 Beyond this limit, the kernel throws away events, but records
3458 the fact that it threw them away by setting a flag
3459 C<IN_Q_OVERFLOW> in the returned structure list (see
3460 C<guestfs_inotify_read>).
3461
3462 Before any events are generated, you have to add some
3463 watches to the internal watch list.  See:
3464 C<guestfs_inotify_add_watch>,
3465 C<guestfs_inotify_rm_watch> and
3466 C<guestfs_inotify_watch_all>.
3467
3468 Queued up events should be read periodically by calling
3469 C<guestfs_inotify_read>
3470 (or C<guestfs_inotify_files> which is just a helpful
3471 wrapper around C<guestfs_inotify_read>).  If you don't
3472 read the events out often enough then you risk the internal
3473 queue overflowing.
3474
3475 The handle should be closed after use by calling
3476 C<guestfs_inotify_close>.  This also removes any
3477 watches automatically.
3478
3479 See also L<inotify(7)> for an overview of the inotify interface
3480 as exposed by the Linux kernel, which is roughly what we expose
3481 via libguestfs.  Note that there is one global inotify handle
3482 per libguestfs instance.");
3483
3484   ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"]), 180, [Optional "inotify"],
3485    [InitBasicFS, Always, TestOutputList (
3486       [["inotify_init"; "0"];
3487        ["inotify_add_watch"; "/"; "1073741823"];
3488        ["touch"; "/a"];
3489        ["touch"; "/b"];
3490        ["inotify_files"]], ["a"; "b"])],
3491    "add an inotify watch",
3492    "\
3493 Watch C<path> for the events listed in C<mask>.
3494
3495 Note that if C<path> is a directory then events within that
3496 directory are watched, but this does I<not> happen recursively
3497 (in subdirectories).
3498
3499 Note for non-C or non-Linux callers: the inotify events are
3500 defined by the Linux kernel ABI and are listed in
3501 C</usr/include/sys/inotify.h>.");
3502
3503   ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"]), 181, [Optional "inotify"],
3504    [],
3505    "remove an inotify watch",
3506    "\
3507 Remove a previously defined inotify watch.
3508 See C<guestfs_inotify_add_watch>.");
3509
3510   ("inotify_read", (RStructList ("events", "inotify_event"), []), 182, [Optional "inotify"],
3511    [],
3512    "return list of inotify events",
3513    "\
3514 Return the complete queue of events that have happened
3515 since the previous read call.
3516
3517 If no events have happened, this returns an empty list.
3518
3519 I<Note>: In order to make sure that all events have been
3520 read, you must call this function repeatedly until it
3521 returns an empty list.  The reason is that the call will
3522 read events up to the maximum appliance-to-host message
3523 size and leave remaining events in the queue.");
3524
3525   ("inotify_files", (RStringList "paths", []), 183, [Optional "inotify"],
3526    [],
3527    "return list of watched files that had events",
3528    "\
3529 This function is a helpful wrapper around C<guestfs_inotify_read>
3530 which just returns a list of pathnames of objects that were
3531 touched.  The returned pathnames are sorted and deduplicated.");
3532
3533   ("inotify_close", (RErr, []), 184, [Optional "inotify"],
3534    [],
3535    "close the inotify handle",
3536    "\
3537 This closes the inotify handle which was previously
3538 opened by inotify_init.  It removes all watches, throws
3539 away any pending events, and deallocates all resources.");
3540
3541   ("setcon", (RErr, [String "context"]), 185, [Optional "selinux"],
3542    [],
3543    "set SELinux security context",
3544    "\
3545 This sets the SELinux security context of the daemon
3546 to the string C<context>.
3547
3548 See the documentation about SELINUX in L<guestfs(3)>.");
3549
3550   ("getcon", (RString "context", []), 186, [Optional "selinux"],
3551    [],
3552    "get SELinux security context",
3553    "\
3554 This gets the SELinux security context of the daemon.
3555
3556 See the documentation about SELINUX in L<guestfs(3)>,
3557 and C<guestfs_setcon>");
3558
3559   ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"]), 187, [],
3560    [InitEmpty, Always, TestOutput (
3561       [["part_disk"; "/dev/sda"; "mbr"];
3562        ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
3563        ["mount"; "/dev/sda1"; "/"];
3564        ["write_file"; "/new"; "new file contents"; "0"];
3565        ["cat"; "/new"]], "new file contents")],
3566    "make a filesystem with block size",
3567    "\
3568 This call is similar to C<guestfs_mkfs>, but it allows you to
3569 control the block size of the resulting filesystem.  Supported
3570 block sizes depend on the filesystem type, but typically they
3571 are C<1024>, C<2048> or C<4096> only.");
3572
3573   ("mke2journal", (RErr, [Int "blocksize"; Device "device"]), 188, [],
3574    [InitEmpty, Always, TestOutput (
3575       [["sfdiskM"; "/dev/sda"; ",100 ,"];
3576        ["mke2journal"; "4096"; "/dev/sda1"];
3577        ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
3578        ["mount"; "/dev/sda2"; "/"];
3579        ["write_file"; "/new"; "new file contents"; "0"];
3580        ["cat"; "/new"]], "new file contents")],
3581    "make ext2/3/4 external journal",
3582    "\
3583 This creates an ext2 external journal on C<device>.  It is equivalent
3584 to the command:
3585
3586  mke2fs -O journal_dev -b blocksize device");
3587
3588   ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"]), 189, [],
3589    [InitEmpty, Always, TestOutput (
3590       [["sfdiskM"; "/dev/sda"; ",100 ,"];
3591        ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
3592        ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
3593        ["mount"; "/dev/sda2"; "/"];
3594        ["write_file"; "/new"; "new file contents"; "0"];
3595        ["cat"; "/new"]], "new file contents")],
3596    "make ext2/3/4 external journal with label",
3597    "\
3598 This creates an ext2 external journal on C<device> with label C<label>.");
3599
3600   ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"]), 190, [Optional "linuxfsuuid"],
3601    (let uuid = uuidgen () in
3602     [InitEmpty, Always, TestOutput (
3603        [["sfdiskM"; "/dev/sda"; ",100 ,"];
3604         ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
3605         ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
3606         ["mount"; "/dev/sda2"; "/"];
3607         ["write_file"; "/new"; "new file contents"; "0"];
3608         ["cat"; "/new"]], "new file contents")]),
3609    "make ext2/3/4 external journal with UUID",
3610    "\
3611 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
3612
3613   ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"]), 191, [],
3614    [],
3615    "make ext2/3/4 filesystem with external journal",
3616    "\
3617 This creates an ext2/3/4 filesystem on C<device> with
3618 an external journal on C<journal>.  It is equivalent
3619 to the command:
3620
3621  mke2fs -t fstype -b blocksize -J device=<journal> <device>
3622
3623 See also C<guestfs_mke2journal>.");
3624
3625   ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"]), 192, [],
3626    [],
3627    "make ext2/3/4 filesystem with external journal",
3628    "\
3629 This creates an ext2/3/4 filesystem on C<device> with
3630 an external journal on the journal labeled C<label>.
3631
3632 See also C<guestfs_mke2journal_L>.");
3633
3634   ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"]), 193, [Optional "linuxfsuuid"],
3635    [],
3636    "make ext2/3/4 filesystem with external journal",
3637    "\
3638 This creates an ext2/3/4 filesystem on C<device> with
3639 an external journal on the journal with UUID C<uuid>.
3640
3641 See also C<guestfs_mke2journal_U>.");
3642
3643   ("modprobe", (RErr, [String "modulename"]), 194, [Optional "linuxmodules"],
3644    [InitNone, Always, TestRun [["modprobe"; "fat"]]],
3645    "load a kernel module",
3646    "\
3647 This loads a kernel module in the appliance.
3648
3649 The kernel module must have been whitelisted when libguestfs
3650 was built (see C<appliance/kmod.whitelist.in> in the source).");
3651
3652   ("echo_daemon", (RString "output", [StringList "words"]), 195, [],
3653    [InitNone, Always, TestOutput (
3654       [["echo_daemon"; "This is a test"]], "This is a test"
3655     )],
3656    "echo arguments back to the client",
3657    "\
3658 This command concatenate the list of C<words> passed with single spaces between
3659 them and returns the resulting string.
3660
3661 You can use this command to test the connection through to the daemon.
3662
3663 See also C<guestfs_ping_daemon>.");
3664
3665   ("find0", (RErr, [Pathname "directory"; FileOut "files"]), 196, [],
3666    [], (* There is a regression test for this. *)
3667    "find all files and directories, returning NUL-separated list",
3668    "\
3669 This command lists out all files and directories, recursively,
3670 starting at C<directory>, placing the resulting list in the
3671 external file called C<files>.
3672
3673 This command works the same way as C<guestfs_find> with the
3674 following exceptions:
3675
3676 =over 4
3677
3678 =item *
3679
3680 The resulting list is written to an external file.
3681
3682 =item *
3683
3684 Items (filenames) in the result are separated
3685 by C<\\0> characters.  See L<find(1)> option I<-print0>.
3686
3687 =item *
3688
3689 This command is not limited in the number of names that it
3690 can return.
3691
3692 =item *
3693
3694 The result list is not sorted.
3695
3696 =back");
3697
3698   ("case_sensitive_path", (RString "rpath", [Pathname "path"]), 197, [],
3699    [InitISOFS, Always, TestOutput (
3700       [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
3701     InitISOFS, Always, TestOutput (
3702       [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
3703     InitISOFS, Always, TestOutput (
3704       [["case_sensitive_path"; "/Known-1"]], "/known-1");
3705     InitISOFS, Always, TestLastFail (
3706       [["case_sensitive_path"; "/Known-1/"]]);
3707     InitBasicFS, Always, TestOutput (
3708       [["mkdir"; "/a"];
3709        ["mkdir"; "/a/bbb"];
3710        ["touch"; "/a/bbb/c"];
3711        ["case_sensitive_path"; "/A/bbB/C"]], "/a/bbb/c");
3712     InitBasicFS, Always, TestOutput (
3713       [["mkdir"; "/a"];
3714        ["mkdir"; "/a/bbb"];
3715        ["touch"; "/a/bbb/c"];
3716        ["case_sensitive_path"; "/A////bbB/C"]], "/a/bbb/c");
3717     InitBasicFS, Always, TestLastFail (
3718       [["mkdir"; "/a"];
3719        ["mkdir"; "/a/bbb"];
3720        ["touch"; "/a/bbb/c"];
3721        ["case_sensitive_path"; "/A/bbb/../bbb/C"]])],
3722    "return true path on case-insensitive filesystem",
3723    "\
3724 This can be used to resolve case insensitive paths on
3725 a filesystem which is case sensitive.  The use case is
3726 to resolve paths which you have read from Windows configuration
3727 files or the Windows Registry, to the true path.
3728
3729 The command handles a peculiarity of the Linux ntfs-3g
3730 filesystem driver (and probably others), which is that although
3731 the underlying filesystem is case-insensitive, the driver
3732 exports the filesystem to Linux as case-sensitive.
3733
3734 One consequence of this is that special directories such
3735 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
3736 (or other things) depending on the precise details of how
3737 they were created.  In Windows itself this would not be
3738 a problem.
3739
3740 Bug or feature?  You decide:
3741 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
3742
3743 This function resolves the true case of each element in the
3744 path and returns the case-sensitive path.
3745
3746 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
3747 might return C<\"/WINDOWS/system32\"> (the exact return value
3748 would depend on details of how the directories were originally
3749 created under Windows).
3750
3751 I<Note>:
3752 This function does not handle drive names, backslashes etc.
3753
3754 See also C<guestfs_realpath>.");
3755
3756   ("vfs_type", (RString "fstype", [Device "device"]), 198, [],
3757    [InitBasicFS, Always, TestOutput (
3758       [["vfs_type"; "/dev/sda1"]], "ext2")],
3759    "get the Linux VFS type corresponding to a mounted device",
3760    "\
3761 This command gets the block device type corresponding to
3762 a mounted device called C<device>.
3763
3764 Usually the result is the name of the Linux VFS module that
3765 is used to mount this device (probably determined automatically
3766 if you used the C<guestfs_mount> call).");
3767
3768   ("truncate", (RErr, [Pathname "path"]), 199, [],
3769    [InitBasicFS, Always, TestOutputStruct (
3770       [["write_file"; "/test"; "some stuff so size is not zero"; "0"];
3771        ["truncate"; "/test"];
3772        ["stat"; "/test"]], [CompareWithInt ("size", 0)])],
3773    "truncate a file to zero size",
3774    "\
3775 This command truncates C<path> to a zero-length file.  The
3776 file must exist already.");
3777
3778   ("truncate_size", (RErr, [Pathname "path"; Int64 "size"]), 200, [],
3779    [InitBasicFS, Always, TestOutputStruct (
3780       [["touch"; "/test"];
3781        ["truncate_size"; "/test"; "1000"];
3782        ["stat"; "/test"]], [CompareWithInt ("size", 1000)])],
3783    "truncate a file to a particular size",
3784    "\
3785 This command truncates C<path> to size C<size> bytes.  The file
3786 must exist already.  If the file is smaller than C<size> then
3787 the file is extended to the required size with null bytes.");
3788
3789   ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"]), 201, [],
3790    [InitBasicFS, Always, TestOutputStruct (
3791       [["touch"; "/test"];
3792        ["utimens"; "/test"; "12345"; "67890"; "9876"; "5432"];
3793        ["stat"; "/test"]], [CompareWithInt ("mtime", 9876)])],
3794    "set timestamp of a file with nanosecond precision",
3795    "\
3796 This command sets the timestamps of a file with nanosecond
3797 precision.
3798
3799 C<atsecs, atnsecs> are the last access time (atime) in secs and
3800 nanoseconds from the epoch.
3801
3802 C<mtsecs, mtnsecs> are the last modification time (mtime) in
3803 secs and nanoseconds from the epoch.
3804
3805 If the C<*nsecs> field contains the special value C<-1> then
3806 the corresponding timestamp is set to the current time.  (The
3807 C<*secs> field is ignored in this case).
3808
3809 If the C<*nsecs> field contains the special value C<-2> then
3810 the corresponding timestamp is left unchanged.  (The
3811 C<*secs> field is ignored in this case).");
3812
3813   ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"]), 202, [],
3814    [InitBasicFS, Always, TestOutputStruct (
3815       [["mkdir_mode"; "/test"; "0o111"];
3816        ["stat"; "/test"]], [CompareWithInt ("mode", 0o40111)])],
3817    "create a directory with a particular mode",
3818    "\
3819 This command creates a directory, setting the initial permissions
3820 of the directory to C<mode>.  See also C<guestfs_mkdir>.");
3821
3822   ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"]), 203, [],
3823    [], (* XXX *)
3824    "change file owner and group",
3825    "\
3826 Change the file owner to C<owner> and group to C<group>.
3827 This is like C<guestfs_chown> but if C<path> is a symlink then
3828 the link itself is changed, not the target.
3829
3830 Only numeric uid and gid are supported.  If you want to use
3831 names, you will need to locate and parse the password file
3832 yourself (Augeas support makes this relatively easy).");
3833
3834   ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"]), 204, [],
3835    [], (* XXX *)
3836    "lstat on multiple files",
3837    "\
3838 This call allows you to perform the C<guestfs_lstat> operation
3839 on multiple files, where all files are in the directory C<path>.
3840 C<names> is the list of files from this directory.
3841
3842 On return you get a list of stat structs, with a one-to-one
3843 correspondence to the C<names> list.  If any name did not exist
3844 or could not be lstat'd, then the C<ino> field of that structure
3845 is set to C<-1>.
3846
3847 This call is intended for programs that want to efficiently
3848 list a directory contents without making many round-trips.
3849 See also C<guestfs_lxattrlist> for a similarly efficient call
3850 for getting extended attributes.  Very long directory listings
3851 might cause the protocol message size to be exceeded, causing
3852 this call to fail.  The caller must split up such requests
3853 into smaller groups of names.");
3854
3855   ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"]), 205, [Optional "linuxxattrs"],
3856    [], (* XXX *)
3857    "lgetxattr on multiple files",
3858    "\
3859 This call allows you to get the extended attributes
3860 of multiple files, where all files are in the directory C<path>.
3861 C<names> is the list of files from this directory.
3862
3863 On return you get a flat list of xattr structs which must be
3864 interpreted sequentially.  The first xattr struct always has a zero-length
3865 C<attrname>.  C<attrval> in this struct is zero-length
3866 to indicate there was an error doing C<lgetxattr> for this
3867 file, I<or> is a C string which is a decimal number
3868 (the number of following attributes for this file, which could
3869 be C<\"0\">).  Then after the first xattr struct are the
3870 zero or more attributes for the first named file.
3871 This repeats for the second and subsequent files.
3872
3873 This call is intended for programs that want to efficiently
3874 list a directory contents without making many round-trips.
3875 See also C<guestfs_lstatlist> for a similarly efficient call
3876 for getting standard stats.  Very long directory listings
3877 might cause the protocol message size to be exceeded, causing
3878 this call to fail.  The caller must split up such requests
3879 into smaller groups of names.");
3880
3881   ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"]), 206, [],
3882    [], (* XXX *)
3883    "readlink on multiple files",
3884    "\
3885 This call allows you to do a C<readlink> operation
3886 on multiple files, where all files are in the directory C<path>.
3887 C<names> is the list of files from this directory.
3888
3889 On return you get a list of strings, with a one-to-one
3890 correspondence to the C<names> list.  Each string is the
3891 value of the symbol link.
3892
3893 If the C<readlink(2)> operation fails on any name, then
3894 the corresponding result string is the empty string C<\"\">.
3895 However the whole operation is completed even if there
3896 were C<readlink(2)> errors, and so you can call this
3897 function with names where you don't know if they are
3898 symbolic links already (albeit slightly less efficient).
3899
3900 This call is intended for programs that want to efficiently
3901 list a directory contents without making many round-trips.
3902 Very long directory listings might cause the protocol
3903 message size to be exceeded, causing
3904 this call to fail.  The caller must split up such requests
3905 into smaller groups of names.");
3906
3907   ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"]), 207, [ProtocolLimitWarning],
3908    [InitISOFS, Always, TestOutputBuffer (
3909       [["pread"; "/known-4"; "1"; "3"]], "\n");
3910     InitISOFS, Always, TestOutputBuffer (
3911       [["pread"; "/empty"; "0"; "100"]], "")],
3912    "read part of a file",
3913    "\
3914 This command lets you read part of a file.  It reads C<count>
3915 bytes of the file, starting at C<offset>, from file C<path>.
3916
3917 This may read fewer bytes than requested.  For further details
3918 see the L<pread(2)> system call.");
3919
3920   ("part_init", (RErr, [Device "device"; String "parttype"]), 208, [],
3921    [InitEmpty, Always, TestRun (
3922       [["part_init"; "/dev/sda"; "gpt"]])],
3923    "create an empty partition table",
3924    "\
3925 This creates an empty partition table on C<device> of one of the
3926 partition types listed below.  Usually C<parttype> should be
3927 either C<msdos> or C<gpt> (for large disks).
3928
3929 Initially there are no partitions.  Following this, you should
3930 call C<guestfs_part_add> for each partition required.
3931
3932 Possible values for C<parttype> are:
3933
3934 =over 4
3935
3936 =item B<efi> | B<gpt>
3937
3938 Intel EFI / GPT partition table.
3939
3940 This is recommended for >= 2 TB partitions that will be accessed
3941 from Linux and Intel-based Mac OS X.  It also has limited backwards
3942 compatibility with the C<mbr> format.
3943
3944 =item B<mbr> | B<msdos>
3945
3946 The standard PC \"Master Boot Record\" (MBR) format used
3947 by MS-DOS and Windows.  This partition type will B<only> work
3948 for device sizes up to 2 TB.  For large disks we recommend
3949 using C<gpt>.
3950
3951 =back
3952
3953 Other partition table types that may work but are not
3954 supported include:
3955
3956 =over 4
3957
3958 =item B<aix>
3959
3960 AIX disk labels.
3961
3962 =item B<amiga> | B<rdb>
3963
3964 Amiga \"Rigid Disk Block\" format.
3965
3966 =item B<bsd>
3967
3968 BSD disk labels.
3969
3970 =item B<dasd>
3971
3972 DASD, used on IBM mainframes.
3973
3974 =item B<dvh>
3975
3976 MIPS/SGI volumes.
3977
3978 =item B<mac>
3979
3980 Old Mac partition format.  Modern Macs use C<gpt>.
3981
3982 =item B<pc98>
3983
3984 NEC PC-98 format, common in Japan apparently.
3985
3986 =item B<sun>
3987
3988 Sun disk labels.
3989
3990 =back");
3991
3992   ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"]), 209, [],
3993    [InitEmpty, Always, TestRun (
3994       [["part_init"; "/dev/sda"; "mbr"];
3995        ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
3996     InitEmpty, Always, TestRun (
3997       [["part_init"; "/dev/sda"; "gpt"];
3998        ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
3999        ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4000     InitEmpty, Always, TestRun (
4001       [["part_init"; "/dev/sda"; "mbr"];
4002        ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4003        ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4004        ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4005        ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4006    "add a partition to the device",
4007    "\
4008 This command adds a partition to C<device>.  If there is no partition
4009 table on the device, call C<guestfs_part_init> first.
4010
4011 The C<prlogex> parameter is the type of partition.  Normally you
4012 should pass C<p> or C<primary> here, but MBR partition tables also
4013 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4014 types.
4015
4016 C<startsect> and C<endsect> are the start and end of the partition
4017 in I<sectors>.  C<endsect> may be negative, which means it counts
4018 backwards from the end of the disk (C<-1> is the last sector).
4019
4020 Creating a partition which covers the whole disk is not so easy.
4021 Use C<guestfs_part_disk> to do that.");
4022
4023   ("part_disk", (RErr, [Device "device"; String "parttype"]), 210, [DangerWillRobinson],
4024    [InitEmpty, Always, TestRun (
4025       [["part_disk"; "/dev/sda"; "mbr"]]);
4026     InitEmpty, Always, TestRun (
4027       [["part_disk"; "/dev/sda"; "gpt"]])],
4028    "partition whole disk with a single primary partition",
4029    "\
4030 This command is simply a combination of C<guestfs_part_init>
4031 followed by C<guestfs_part_add> to create a single primary partition
4032 covering the whole disk.
4033
4034 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
4035 but other possible values are described in C<guestfs_part_init>.");
4036
4037   ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"]), 211, [],
4038    [InitEmpty, Always, TestRun (
4039       [["part_disk"; "/dev/sda"; "mbr"];
4040        ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
4041    "make a partition bootable",
4042    "\
4043 This sets the bootable flag on partition numbered C<partnum> on
4044 device C<device>.  Note that partitions are numbered from 1.
4045
4046 The bootable flag is used by some PC BIOSes to determine which
4047 partition to boot from.  It is by no means universally recognized,
4048 and in any case if your operating system installed a boot
4049 sector on the device itself, then that takes precedence.");
4050
4051   ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"]), 212, [],
4052    [InitEmpty, Always, TestRun (
4053       [["part_disk"; "/dev/sda"; "gpt"];
4054        ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
4055    "set partition name",
4056    "\
4057 This sets the partition name on partition numbered C<partnum> on
4058 device C<device>.  Note that partitions are numbered from 1.
4059
4060 The partition name can only be set on certain types of partition
4061 table.  This works on C<gpt> but not on C<mbr> partitions.");
4062
4063   ("part_list", (RStructList ("partitions", "partition"), [Device "device"]), 213, [],
4064    [], (* XXX Add a regression test for this. *)
4065    "list partitions on a device",
4066    "\
4067 This command parses the partition table on C<device> and
4068 returns the list of partitions found.
4069
4070 The fields in the returned structure are:
4071
4072 =over 4
4073
4074 =item B<part_num>
4075
4076 Partition number, counting from 1.
4077
4078 =item B<part_start>
4079
4080 Start of the partition I<in bytes>.  To get sectors you have to
4081 divide by the device's sector size, see C<guestfs_blockdev_getss>.
4082
4083 =item B<part_end>
4084
4085 End of the partition in bytes.
4086
4087 =item B<part_size>
4088
4089 Size of the partition in bytes.
4090
4091 =back");
4092
4093   ("part_get_parttype", (RString "parttype", [Device "device"]), 214, [],
4094    [InitEmpty, Always, TestOutput (
4095       [["part_disk"; "/dev/sda"; "gpt"];
4096        ["part_get_parttype"; "/dev/sda"]], "gpt")],
4097    "get the partition table type",
4098    "\
4099 This command examines the partition table on C<device> and
4100 returns the partition table type (format) being used.
4101
4102 Common return values include: C<msdos> (a DOS/Windows style MBR
4103 partition table), C<gpt> (a GPT/EFI-style partition table).  Other
4104 values are possible, although unusual.  See C<guestfs_part_init>
4105 for a full list.");
4106
4107   ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"]), 215, [],
4108    [InitBasicFS, Always, TestOutputBuffer (
4109       [["fill"; "0x63"; "10"; "/test"];
4110        ["read_file"; "/test"]], "cccccccccc")],
4111    "fill a file with octets",
4112    "\
4113 This command creates a new file called C<path>.  The initial
4114 content of the file is C<len> octets of C<c>, where C<c>
4115 must be a number in the range C<[0..255]>.
4116
4117 To fill a file with zero bytes (sparsely), it is
4118 much more efficient to use C<guestfs_truncate_size>.");
4119
4120   ("available", (RErr, [StringList "groups"]), 216, [],
4121    [InitNone, Always, TestRun [["available"; ""]]],
4122    "test availability of some parts of the API",
4123    "\
4124 This command is used to check the availability of some
4125 groups of functionality in the appliance, which not all builds of
4126 the libguestfs appliance will be able to provide.
4127
4128 The libguestfs groups, and the functions that those
4129 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
4130
4131 The argument C<groups> is a list of group names, eg:
4132 C<[\"inotify\", \"augeas\"]> would check for the availability of
4133 the Linux inotify functions and Augeas (configuration file
4134 editing) functions.
4135
4136 The command returns no error if I<all> requested groups are available.
4137
4138 It fails with an error if one or more of the requested
4139 groups is unavailable in the appliance.
4140
4141 If an unknown group name is included in the
4142 list of groups then an error is always returned.
4143
4144 I<Notes:>
4145
4146 =over 4
4147
4148 =item *
4149
4150 You must call C<guestfs_launch> before calling this function.
4151
4152 The reason is because we don't know what groups are
4153 supported by the appliance/daemon until it is running and can
4154 be queried.
4155
4156 =item *
4157
4158 If a group of functions is available, this does not necessarily
4159 mean that they will work.  You still have to check for errors
4160 when calling individual API functions even if they are
4161 available.
4162
4163 =item *
4164
4165 It is usually the job of distro packagers to build
4166 complete functionality into the libguestfs appliance.
4167 Upstream libguestfs, if built from source with all
4168 requirements satisfied, will support everything.
4169
4170 =item *
4171
4172 This call was added in version C<1.0.80>.  In previous
4173 versions of libguestfs all you could do would be to speculatively
4174 execute a command to find out if the daemon implemented it.
4175 See also C<guestfs_version>.
4176
4177 =back");
4178
4179   ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"]), 217, [],
4180    [InitBasicFS, Always, TestOutputBuffer (
4181       [["write_file"; "/src"; "hello, world"; "0"];
4182        ["dd"; "/src"; "/dest"];
4183        ["read_file"; "/dest"]], "hello, world")],
4184    "copy from source to destination using dd",
4185    "\
4186 This command copies from one source device or file C<src>
4187 to another destination device or file C<dest>.  Normally you
4188 would use this to copy to or from a device or partition, for
4189 example to duplicate a filesystem.
4190
4191 If the destination is a device, it must be as large or larger
4192 than the source file or device, otherwise the copy will fail.
4193 This command cannot do partial copies.");
4194
4195   ("filesize", (RInt64 "size", [Pathname "file"]), 218, [],
4196    [InitBasicFS, Always, TestOutputInt (
4197       [["write_file"; "/file"; "hello, world"; "0"];
4198        ["filesize"; "/file"]], 12)],
4199    "return the size of the file in bytes",
4200    "\
4201 This command returns the size of C<file> in bytes.
4202
4203 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
4204 C<guestfs_is_dir>, C<guestfs_is_file> etc.
4205 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
4206
4207   ("lvrename", (RErr, [String "logvol"; String "newlogvol"]), 219, [],
4208    [InitBasicFSonLVM, Always, TestOutputList (
4209       [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
4210        ["lvs"]], ["/dev/VG/LV2"])],
4211    "rename an LVM logical volume",
4212    "\
4213 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
4214
4215   ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"]), 220, [],
4216    [InitBasicFSonLVM, Always, TestOutputList (
4217       [["umount"; "/"];
4218        ["vg_activate"; "false"; "VG"];
4219        ["vgrename"; "VG"; "VG2"];
4220        ["vg_activate"; "true"; "VG2"];
4221        ["mount"; "/dev/VG2/LV"; "/"];
4222        ["vgs"]], ["VG2"])],
4223    "rename an LVM volume group",
4224    "\
4225 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
4226
4227 ]
4228
4229 let all_functions = non_daemon_functions @ daemon_functions
4230
4231 (* In some places we want the functions to be displayed sorted
4232  * alphabetically, so this is useful:
4233  *)
4234 let all_functions_sorted =
4235   List.sort (fun (n1,_,_,_,_,_,_) (n2,_,_,_,_,_,_) ->
4236                compare n1 n2) all_functions
4237
4238 (* Field types for structures. *)
4239 type field =
4240   | FChar                       (* C 'char' (really, a 7 bit byte). *)
4241   | FString                     (* nul-terminated ASCII string, NOT NULL. *)
4242   | FBuffer                     (* opaque buffer of bytes, (char *, int) pair *)
4243   | FUInt32
4244   | FInt32
4245   | FUInt64
4246   | FInt64
4247   | FBytes                      (* Any int measure that counts bytes. *)
4248   | FUUID                       (* 32 bytes long, NOT nul-terminated. *)
4249   | FOptPercent                 (* [0..100], or -1 meaning "not present". *)
4250
4251 (* Because we generate extra parsing code for LVM command line tools,
4252  * we have to pull out the LVM columns separately here.
4253  *)
4254 let lvm_pv_cols = [
4255   "pv_name", FString;
4256   "pv_uuid", FUUID;
4257   "pv_fmt", FString;
4258   "pv_size", FBytes;
4259   "dev_size", FBytes;
4260   "pv_free", FBytes;
4261   "pv_used", FBytes;
4262   "pv_attr", FString (* XXX *);
4263   "pv_pe_count", FInt64;
4264   "pv_pe_alloc_count", FInt64;
4265   "pv_tags", FString;
4266   "pe_start", FBytes;
4267   "pv_mda_count", FInt64;
4268   "pv_mda_free", FBytes;
4269   (* Not in Fedora 10:
4270      "pv_mda_size", FBytes;
4271   *)
4272 ]
4273 let lvm_vg_cols = [
4274   "vg_name", FString;
4275   "vg_uuid", FUUID;
4276   "vg_fmt", FString;
4277   "vg_attr", FString (* XXX *);
4278   "vg_size", FBytes;
4279   "vg_free", FBytes;
4280   "vg_sysid", FString;
4281   "vg_extent_size", FBytes;
4282   "vg_extent_count", FInt64;
4283   "vg_free_count", FInt64;
4284   "max_lv", FInt64;
4285   "max_pv", FInt64;
4286   "pv_count", FInt64;
4287   "lv_count", FInt64;
4288   "snap_count", FInt64;
4289   "vg_seqno", FInt64;
4290   "vg_tags", FString;
4291   "vg_mda_count", FInt64;
4292   "vg_mda_free", FBytes;
4293   (* Not in Fedora 10:
4294      "vg_mda_size", FBytes;
4295   *)
4296 ]
4297 let lvm_lv_cols = [
4298   "lv_name", FString;
4299   "lv_uuid", FUUID;
4300   "lv_attr", FString (* XXX *);
4301   "lv_major", FInt64;
4302   "lv_minor", FInt64;
4303   "lv_kernel_major", FInt64;
4304   "lv_kernel_minor", FInt64;
4305   "lv_size", FBytes;
4306   "seg_count", FInt64;
4307   "origin", FString;
4308   "snap_percent", FOptPercent;
4309   "copy_percent", FOptPercent;
4310   "move_pv", FString;
4311   "lv_tags", FString;
4312   "mirror_log", FString;
4313   "modules", FString;
4314 ]
4315
4316 (* Names and fields in all structures (in RStruct and RStructList)
4317  * that we support.
4318  *)
4319 let structs = [
4320   (* The old RIntBool return type, only ever used for aug_defnode.  Do
4321    * not use this struct in any new code.
4322    *)
4323   "int_bool", [
4324     "i", FInt32;                (* for historical compatibility *)
4325     "b", FInt32;                (* for historical compatibility *)
4326   ];
4327
4328   (* LVM PVs, VGs, LVs. *)
4329   "lvm_pv", lvm_pv_cols;
4330   "lvm_vg", lvm_vg_cols;
4331   "lvm_lv", lvm_lv_cols;
4332
4333   (* Column names and types from stat structures.
4334    * NB. Can't use things like 'st_atime' because glibc header files
4335    * define some of these as macros.  Ugh.
4336    *)
4337   "stat", [
4338     "dev", FInt64;
4339     "ino", FInt64;
4340     "mode", FInt64;
4341     "nlink", FInt64;
4342     "uid", FInt64;
4343     "gid", FInt64;
4344     "rdev", FInt64;
4345     "size", FInt64;
4346     "blksize", FInt64;
4347     "blocks", FInt64;
4348     "atime", FInt64;
4349     "mtime", FInt64;
4350     "ctime", FInt64;
4351   ];
4352   "statvfs", [
4353     "bsize", FInt64;
4354     "frsize", FInt64;
4355     "blocks", FInt64;
4356     "bfree", FInt64;
4357     "bavail", FInt64;
4358     "files", FInt64;
4359     "ffree", FInt64;
4360     "favail", FInt64;
4361     "fsid", FInt64;
4362     "flag", FInt64;
4363     "namemax", FInt64;
4364   ];
4365
4366   (* Column names in dirent structure. *)
4367   "dirent", [
4368     "ino", FInt64;
4369     (* 'b' 'c' 'd' 'f' (FIFO) 'l' 'r' (regular file) 's' 'u' '?' *)
4370     "ftyp", FChar;
4371     "name", FString;
4372   ];
4373
4374   (* Version numbers. *)
4375   "version", [
4376     "major", FInt64;
4377     "minor", FInt64;
4378     "release", FInt64;
4379     "extra", FString;
4380   ];
4381
4382   (* Extended attribute. *)
4383   "xattr", [
4384     "attrname", FString;
4385     "attrval", FBuffer;
4386   ];
4387
4388   (* Inotify events. *)
4389   "inotify_event", [
4390     "in_wd", FInt64;
4391     "in_mask", FUInt32;
4392     "in_cookie", FUInt32;
4393     "in_name", FString;
4394   ];
4395
4396   (* Partition table entry. *)
4397   "partition", [
4398     "part_num", FInt32;
4399     "part_start", FBytes;
4400     "part_end", FBytes;
4401     "part_size", FBytes;
4402   ];
4403 ] (* end of structs *)
4404
4405 (* Ugh, Java has to be different ..
4406  * These names are also used by the Haskell bindings.
4407  *)
4408 let java_structs = [
4409   "int_bool", "IntBool";
4410   "lvm_pv", "PV";
4411   "lvm_vg", "VG";
4412   "lvm_lv", "LV";
4413   "stat", "Stat";
4414   "statvfs", "StatVFS";
4415   "dirent", "Dirent";
4416   "version", "Version";