Move guestfs(3) and guestfish(1) man pages into subdirectories.
[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   ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"]), 35, [],
1332    [], (* XXX Need stat command to test *)
1333    "change file owner and group",
1334    "\
1335 Change the file owner to C<owner> and group to C<group>.
1336
1337 Only numeric uid and gid are supported.  If you want to use
1338 names, you will need to locate and parse the password file
1339 yourself (Augeas support makes this relatively easy).");
1340
1341   ("exists", (RBool "existsflag", [Pathname "path"]), 36, [],
1342    [InitISOFS, Always, TestOutputTrue (
1343       [["exists"; "/empty"]]);
1344     InitISOFS, Always, TestOutputTrue (
1345       [["exists"; "/directory"]])],
1346    "test if file or directory exists",
1347    "\
1348 This returns C<true> if and only if there is a file, directory
1349 (or anything) with the given C<path> name.
1350
1351 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1352
1353   ("is_file", (RBool "fileflag", [Pathname "path"]), 37, [],
1354    [InitISOFS, Always, TestOutputTrue (
1355       [["is_file"; "/known-1"]]);
1356     InitISOFS, Always, TestOutputFalse (
1357       [["is_file"; "/directory"]])],
1358    "test if file exists",
1359    "\
1360 This returns C<true> if and only if there is a file
1361 with the given C<path> name.  Note that it returns false for
1362 other objects like directories.
1363
1364 See also C<guestfs_stat>.");
1365
1366   ("is_dir", (RBool "dirflag", [Pathname "path"]), 38, [],
1367    [InitISOFS, Always, TestOutputFalse (
1368       [["is_dir"; "/known-3"]]);
1369     InitISOFS, Always, TestOutputTrue (
1370       [["is_dir"; "/directory"]])],
1371    "test if file exists",
1372    "\
1373 This returns C<true> if and only if there is a directory
1374 with the given C<path> name.  Note that it returns false for
1375 other objects like files.
1376
1377 See also C<guestfs_stat>.");
1378
1379   ("pvcreate", (RErr, [Device "device"]), 39, [Optional "lvm2"],
1380    [InitEmpty, Always, TestOutputListOfDevices (
1381       [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1382        ["pvcreate"; "/dev/sda1"];
1383        ["pvcreate"; "/dev/sda2"];
1384        ["pvcreate"; "/dev/sda3"];
1385        ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1386    "create an LVM physical volume",
1387    "\
1388 This creates an LVM physical volume on the named C<device>,
1389 where C<device> should usually be a partition name such
1390 as C</dev/sda1>.");
1391
1392   ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"]), 40, [Optional "lvm2"],
1393    [InitEmpty, Always, TestOutputList (
1394       [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1395        ["pvcreate"; "/dev/sda1"];
1396        ["pvcreate"; "/dev/sda2"];
1397        ["pvcreate"; "/dev/sda3"];
1398        ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1399        ["vgcreate"; "VG2"; "/dev/sda3"];
1400        ["vgs"]], ["VG1"; "VG2"])],
1401    "create an LVM volume group",
1402    "\
1403 This creates an LVM volume group called C<volgroup>
1404 from the non-empty list of physical volumes C<physvols>.");
1405
1406   ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"]), 41, [Optional "lvm2"],
1407    [InitEmpty, Always, TestOutputList (
1408       [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1409        ["pvcreate"; "/dev/sda1"];
1410        ["pvcreate"; "/dev/sda2"];
1411        ["pvcreate"; "/dev/sda3"];
1412        ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1413        ["vgcreate"; "VG2"; "/dev/sda3"];
1414        ["lvcreate"; "LV1"; "VG1"; "50"];
1415        ["lvcreate"; "LV2"; "VG1"; "50"];
1416        ["lvcreate"; "LV3"; "VG2"; "50"];
1417        ["lvcreate"; "LV4"; "VG2"; "50"];
1418        ["lvcreate"; "LV5"; "VG2"; "50"];
1419        ["lvs"]],
1420       ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1421        "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1422    "create an LVM volume group",
1423    "\
1424 This creates an LVM volume group called C<logvol>
1425 on the volume group C<volgroup>, with C<size> megabytes.");
1426
1427   ("mkfs", (RErr, [String "fstype"; Device "device"]), 42, [],
1428    [InitEmpty, Always, TestOutput (
1429       [["part_disk"; "/dev/sda"; "mbr"];
1430        ["mkfs"; "ext2"; "/dev/sda1"];
1431        ["mount"; "/dev/sda1"; "/"];
1432        ["write_file"; "/new"; "new file contents"; "0"];
1433        ["cat"; "/new"]], "new file contents")],
1434    "make a filesystem",
1435    "\
1436 This creates a filesystem on C<device> (usually a partition
1437 or LVM logical volume).  The filesystem type is C<fstype>, for
1438 example C<ext3>.");
1439
1440   ("sfdisk", (RErr, [Device "device";
1441                      Int "cyls"; Int "heads"; Int "sectors";
1442                      StringList "lines"]), 43, [DangerWillRobinson],
1443    [],
1444    "create partitions on a block device",
1445    "\
1446 This is a direct interface to the L<sfdisk(8)> program for creating
1447 partitions on block devices.
1448
1449 C<device> should be a block device, for example C</dev/sda>.
1450
1451 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1452 and sectors on the device, which are passed directly to sfdisk as
1453 the I<-C>, I<-H> and I<-S> parameters.  If you pass C<0> for any
1454 of these, then the corresponding parameter is omitted.  Usually for
1455 'large' disks, you can just pass C<0> for these, but for small
1456 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1457 out the right geometry and you will need to tell it.
1458
1459 C<lines> is a list of lines that we feed to C<sfdisk>.  For more
1460 information refer to the L<sfdisk(8)> manpage.
1461
1462 To create a single partition occupying the whole disk, you would
1463 pass C<lines> as a single element list, when the single element being
1464 the string C<,> (comma).
1465
1466 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
1467 C<guestfs_part_init>");
1468
1469   ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"]), 44, [ProtocolLimitWarning],
1470    [InitBasicFS, Always, TestOutput (
1471       [["write_file"; "/new"; "new file contents"; "0"];
1472        ["cat"; "/new"]], "new file contents");
1473     InitBasicFS, Always, TestOutput (
1474       [["write_file"; "/new"; "\nnew file contents\n"; "0"];
1475        ["cat"; "/new"]], "\nnew file contents\n");
1476     InitBasicFS, Always, TestOutput (
1477       [["write_file"; "/new"; "\n\n"; "0"];
1478        ["cat"; "/new"]], "\n\n");
1479     InitBasicFS, Always, TestOutput (
1480       [["write_file"; "/new"; ""; "0"];
1481        ["cat"; "/new"]], "");
1482     InitBasicFS, Always, TestOutput (
1483       [["write_file"; "/new"; "\n\n\n"; "0"];
1484        ["cat"; "/new"]], "\n\n\n");
1485     InitBasicFS, Always, TestOutput (
1486       [["write_file"; "/new"; "\n"; "0"];
1487        ["cat"; "/new"]], "\n")],
1488    "create a file",
1489    "\
1490 This call creates a file called C<path>.  The contents of the
1491 file is the string C<content> (which can contain any 8 bit data),
1492 with length C<size>.
1493
1494 As a special case, if C<size> is C<0>
1495 then the length is calculated using C<strlen> (so in this case
1496 the content cannot contain embedded ASCII NULs).
1497
1498 I<NB.> Owing to a bug, writing content containing ASCII NUL
1499 characters does I<not> work, even if the length is specified.
1500 We hope to resolve this bug in a future version.  In the meantime
1501 use C<guestfs_upload>.");
1502
1503   ("umount", (RErr, [String "pathordevice"]), 45, [FishAlias "unmount"],
1504    [InitEmpty, Always, TestOutputListOfDevices (
1505       [["part_disk"; "/dev/sda"; "mbr"];
1506        ["mkfs"; "ext2"; "/dev/sda1"];
1507        ["mount"; "/dev/sda1"; "/"];
1508        ["mounts"]], ["/dev/sda1"]);
1509     InitEmpty, Always, TestOutputList (
1510       [["part_disk"; "/dev/sda"; "mbr"];
1511        ["mkfs"; "ext2"; "/dev/sda1"];
1512        ["mount"; "/dev/sda1"; "/"];
1513        ["umount"; "/"];
1514        ["mounts"]], [])],
1515    "unmount a filesystem",
1516    "\
1517 This unmounts the given filesystem.  The filesystem may be
1518 specified either by its mountpoint (path) or the device which
1519 contains the filesystem.");
1520
1521   ("mounts", (RStringList "devices", []), 46, [],
1522    [InitBasicFS, Always, TestOutputListOfDevices (
1523       [["mounts"]], ["/dev/sda1"])],
1524    "show mounted filesystems",
1525    "\
1526 This returns the list of currently mounted filesystems.  It returns
1527 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1528
1529 Some internal mounts are not shown.
1530
1531 See also: C<guestfs_mountpoints>");
1532
1533   ("umount_all", (RErr, []), 47, [FishAlias "unmount-all"],
1534    [InitBasicFS, Always, TestOutputList (
1535       [["umount_all"];
1536        ["mounts"]], []);
1537     (* check that umount_all can unmount nested mounts correctly: *)
1538     InitEmpty, Always, TestOutputList (
1539       [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1540        ["mkfs"; "ext2"; "/dev/sda1"];
1541        ["mkfs"; "ext2"; "/dev/sda2"];
1542        ["mkfs"; "ext2"; "/dev/sda3"];
1543        ["mount"; "/dev/sda1"; "/"];
1544        ["mkdir"; "/mp1"];
1545        ["mount"; "/dev/sda2"; "/mp1"];
1546        ["mkdir"; "/mp1/mp2"];
1547        ["mount"; "/dev/sda3"; "/mp1/mp2"];
1548        ["mkdir"; "/mp1/mp2/mp3"];
1549        ["umount_all"];
1550        ["mounts"]], [])],
1551    "unmount all filesystems",
1552    "\
1553 This unmounts all mounted filesystems.
1554
1555 Some internal mounts are not unmounted by this call.");
1556
1557   ("lvm_remove_all", (RErr, []), 48, [DangerWillRobinson; Optional "lvm2"],
1558    [],
1559    "remove all LVM LVs, VGs and PVs",
1560    "\
1561 This command removes all LVM logical volumes, volume groups
1562 and physical volumes.");
1563
1564   ("file", (RString "description", [Dev_or_Path "path"]), 49, [],
1565    [InitISOFS, Always, TestOutput (
1566       [["file"; "/empty"]], "empty");
1567     InitISOFS, Always, TestOutput (
1568       [["file"; "/known-1"]], "ASCII text");
1569     InitISOFS, Always, TestLastFail (
1570       [["file"; "/notexists"]])],
1571    "determine file type",
1572    "\
1573 This call uses the standard L<file(1)> command to determine
1574 the type or contents of the file.  This also works on devices,
1575 for example to find out whether a partition contains a filesystem.
1576
1577 This call will also transparently look inside various types
1578 of compressed file.
1579
1580 The exact command which runs is C<file -zbsL path>.  Note in
1581 particular that the filename is not prepended to the output
1582 (the C<-b> option).");
1583
1584   ("command", (RString "output", [StringList "arguments"]), 50, [ProtocolLimitWarning],
1585    [InitBasicFS, Always, TestOutput (
1586       [["upload"; "test-command"; "/test-command"];
1587        ["chmod"; "0o755"; "/test-command"];
1588        ["command"; "/test-command 1"]], "Result1");
1589     InitBasicFS, Always, TestOutput (
1590       [["upload"; "test-command"; "/test-command"];
1591        ["chmod"; "0o755"; "/test-command"];
1592        ["command"; "/test-command 2"]], "Result2\n");
1593     InitBasicFS, Always, TestOutput (
1594       [["upload"; "test-command"; "/test-command"];
1595        ["chmod"; "0o755"; "/test-command"];
1596        ["command"; "/test-command 3"]], "\nResult3");
1597     InitBasicFS, Always, TestOutput (
1598       [["upload"; "test-command"; "/test-command"];
1599        ["chmod"; "0o755"; "/test-command"];
1600        ["command"; "/test-command 4"]], "\nResult4\n");
1601     InitBasicFS, Always, TestOutput (
1602       [["upload"; "test-command"; "/test-command"];
1603        ["chmod"; "0o755"; "/test-command"];
1604        ["command"; "/test-command 5"]], "\nResult5\n\n");
1605     InitBasicFS, Always, TestOutput (
1606       [["upload"; "test-command"; "/test-command"];
1607        ["chmod"; "0o755"; "/test-command"];
1608        ["command"; "/test-command 6"]], "\n\nResult6\n\n");
1609     InitBasicFS, Always, TestOutput (
1610       [["upload"; "test-command"; "/test-command"];
1611        ["chmod"; "0o755"; "/test-command"];
1612        ["command"; "/test-command 7"]], "");
1613     InitBasicFS, Always, TestOutput (
1614       [["upload"; "test-command"; "/test-command"];
1615        ["chmod"; "0o755"; "/test-command"];
1616        ["command"; "/test-command 8"]], "\n");
1617     InitBasicFS, Always, TestOutput (
1618       [["upload"; "test-command"; "/test-command"];
1619        ["chmod"; "0o755"; "/test-command"];
1620        ["command"; "/test-command 9"]], "\n\n");
1621     InitBasicFS, Always, TestOutput (
1622       [["upload"; "test-command"; "/test-command"];
1623        ["chmod"; "0o755"; "/test-command"];
1624        ["command"; "/test-command 10"]], "Result10-1\nResult10-2\n");
1625     InitBasicFS, Always, TestOutput (
1626       [["upload"; "test-command"; "/test-command"];
1627        ["chmod"; "0o755"; "/test-command"];
1628        ["command"; "/test-command 11"]], "Result11-1\nResult11-2");
1629     InitBasicFS, Always, TestLastFail (
1630       [["upload"; "test-command"; "/test-command"];
1631        ["chmod"; "0o755"; "/test-command"];
1632        ["command"; "/test-command"]])],
1633    "run a command from the guest filesystem",
1634    "\
1635 This call runs a command from the guest filesystem.  The
1636 filesystem must be mounted, and must contain a compatible
1637 operating system (ie. something Linux, with the same
1638 or compatible processor architecture).
1639
1640 The single parameter is an argv-style list of arguments.
1641 The first element is the name of the program to run.
1642 Subsequent elements are parameters.  The list must be
1643 non-empty (ie. must contain a program name).  Note that
1644 the command runs directly, and is I<not> invoked via
1645 the shell (see C<guestfs_sh>).
1646
1647 The return value is anything printed to I<stdout> by
1648 the command.
1649
1650 If the command returns a non-zero exit status, then
1651 this function returns an error message.  The error message
1652 string is the content of I<stderr> from the command.
1653
1654 The C<$PATH> environment variable will contain at least
1655 C</usr/bin> and C</bin>.  If you require a program from
1656 another location, you should provide the full path in the
1657 first parameter.
1658
1659 Shared libraries and data files required by the program
1660 must be available on filesystems which are mounted in the
1661 correct places.  It is the caller's responsibility to ensure
1662 all filesystems that are needed are mounted at the right
1663 locations.");
1664
1665   ("command_lines", (RStringList "lines", [StringList "arguments"]), 51, [ProtocolLimitWarning],
1666    [InitBasicFS, Always, TestOutputList (
1667       [["upload"; "test-command"; "/test-command"];
1668        ["chmod"; "0o755"; "/test-command"];
1669        ["command_lines"; "/test-command 1"]], ["Result1"]);
1670     InitBasicFS, Always, TestOutputList (
1671       [["upload"; "test-command"; "/test-command"];
1672        ["chmod"; "0o755"; "/test-command"];
1673        ["command_lines"; "/test-command 2"]], ["Result2"]);
1674     InitBasicFS, Always, TestOutputList (
1675       [["upload"; "test-command"; "/test-command"];
1676        ["chmod"; "0o755"; "/test-command"];
1677        ["command_lines"; "/test-command 3"]], ["";"Result3"]);
1678     InitBasicFS, Always, TestOutputList (
1679       [["upload"; "test-command"; "/test-command"];
1680        ["chmod"; "0o755"; "/test-command"];
1681        ["command_lines"; "/test-command 4"]], ["";"Result4"]);
1682     InitBasicFS, Always, TestOutputList (
1683       [["upload"; "test-command"; "/test-command"];
1684        ["chmod"; "0o755"; "/test-command"];
1685        ["command_lines"; "/test-command 5"]], ["";"Result5";""]);
1686     InitBasicFS, Always, TestOutputList (
1687       [["upload"; "test-command"; "/test-command"];
1688        ["chmod"; "0o755"; "/test-command"];
1689        ["command_lines"; "/test-command 6"]], ["";"";"Result6";""]);
1690     InitBasicFS, Always, TestOutputList (
1691       [["upload"; "test-command"; "/test-command"];
1692        ["chmod"; "0o755"; "/test-command"];
1693        ["command_lines"; "/test-command 7"]], []);
1694     InitBasicFS, Always, TestOutputList (
1695       [["upload"; "test-command"; "/test-command"];
1696        ["chmod"; "0o755"; "/test-command"];
1697        ["command_lines"; "/test-command 8"]], [""]);
1698     InitBasicFS, Always, TestOutputList (
1699       [["upload"; "test-command"; "/test-command"];
1700        ["chmod"; "0o755"; "/test-command"];
1701        ["command_lines"; "/test-command 9"]], ["";""]);
1702     InitBasicFS, Always, TestOutputList (
1703       [["upload"; "test-command"; "/test-command"];
1704        ["chmod"; "0o755"; "/test-command"];
1705        ["command_lines"; "/test-command 10"]], ["Result10-1";"Result10-2"]);
1706     InitBasicFS, Always, TestOutputList (
1707       [["upload"; "test-command"; "/test-command"];
1708        ["chmod"; "0o755"; "/test-command"];
1709        ["command_lines"; "/test-command 11"]], ["Result11-1";"Result11-2"])],
1710    "run a command, returning lines",
1711    "\
1712 This is the same as C<guestfs_command>, but splits the
1713 result into a list of lines.
1714
1715 See also: C<guestfs_sh_lines>");
1716
1717   ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"]), 52, [],
1718    [InitISOFS, Always, TestOutputStruct (
1719       [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
1720    "get file information",
1721    "\
1722 Returns file information for the given C<path>.
1723
1724 This is the same as the C<stat(2)> system call.");
1725
1726   ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"]), 53, [],
1727    [InitISOFS, Always, TestOutputStruct (
1728       [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
1729    "get file information for a symbolic link",
1730    "\
1731 Returns file information for the given C<path>.
1732
1733 This is the same as C<guestfs_stat> except that if C<path>
1734 is a symbolic link, then the link is stat-ed, not the file it
1735 refers to.
1736
1737 This is the same as the C<lstat(2)> system call.");
1738
1739   ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"]), 54, [],
1740    [InitISOFS, Always, TestOutputStruct (
1741       [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
1742    "get file system statistics",
1743    "\
1744 Returns file system statistics for any mounted file system.
1745 C<path> should be a file or directory in the mounted file system
1746 (typically it is the mount point itself, but it doesn't need to be).
1747
1748 This is the same as the C<statvfs(2)> system call.");
1749
1750   ("tune2fs_l", (RHashtable "superblock", [Device "device"]), 55, [],
1751    [], (* XXX test *)
1752    "get ext2/ext3/ext4 superblock details",
1753    "\
1754 This returns the contents of the ext2, ext3 or ext4 filesystem
1755 superblock on C<device>.
1756
1757 It is the same as running C<tune2fs -l device>.  See L<tune2fs(8)>
1758 manpage for more details.  The list of fields returned isn't
1759 clearly defined, and depends on both the version of C<tune2fs>
1760 that libguestfs was built against, and the filesystem itself.");
1761
1762   ("blockdev_setro", (RErr, [Device "device"]), 56, [],
1763    [InitEmpty, Always, TestOutputTrue (
1764       [["blockdev_setro"; "/dev/sda"];
1765        ["blockdev_getro"; "/dev/sda"]])],
1766    "set block device to read-only",
1767    "\
1768 Sets the block device named C<device> to read-only.
1769
1770 This uses the L<blockdev(8)> command.");
1771
1772   ("blockdev_setrw", (RErr, [Device "device"]), 57, [],
1773    [InitEmpty, Always, TestOutputFalse (
1774       [["blockdev_setrw"; "/dev/sda"];
1775        ["blockdev_getro"; "/dev/sda"]])],
1776    "set block device to read-write",
1777    "\
1778 Sets the block device named C<device> to read-write.
1779
1780 This uses the L<blockdev(8)> command.");
1781
1782   ("blockdev_getro", (RBool "ro", [Device "device"]), 58, [],
1783    [InitEmpty, Always, TestOutputTrue (
1784       [["blockdev_setro"; "/dev/sda"];
1785        ["blockdev_getro"; "/dev/sda"]])],
1786    "is block device set to read-only",
1787    "\
1788 Returns a boolean indicating if the block device is read-only
1789 (true if read-only, false if not).
1790
1791 This uses the L<blockdev(8)> command.");
1792
1793   ("blockdev_getss", (RInt "sectorsize", [Device "device"]), 59, [],
1794    [InitEmpty, Always, TestOutputInt (
1795       [["blockdev_getss"; "/dev/sda"]], 512)],
1796    "get sectorsize of block device",
1797    "\
1798 This returns the size of sectors on a block device.
1799 Usually 512, but can be larger for modern devices.
1800
1801 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
1802 for that).
1803
1804 This uses the L<blockdev(8)> command.");
1805
1806   ("blockdev_getbsz", (RInt "blocksize", [Device "device"]), 60, [],
1807    [InitEmpty, Always, TestOutputInt (
1808       [["blockdev_getbsz"; "/dev/sda"]], 4096)],
1809    "get blocksize of block device",
1810    "\
1811 This returns the block size of a device.
1812
1813 (Note this is different from both I<size in blocks> and
1814 I<filesystem block size>).
1815
1816 This uses the L<blockdev(8)> command.");
1817
1818   ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"]), 61, [],
1819    [], (* XXX test *)
1820    "set blocksize of block device",
1821    "\
1822 This sets the block size of a device.
1823
1824 (Note this is different from both I<size in blocks> and
1825 I<filesystem block size>).
1826
1827 This uses the L<blockdev(8)> command.");
1828
1829   ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"]), 62, [],
1830    [InitEmpty, Always, TestOutputInt (
1831       [["blockdev_getsz"; "/dev/sda"]], 1024000)],
1832    "get total size of device in 512-byte sectors",
1833    "\
1834 This returns the size of the device in units of 512-byte sectors
1835 (even if the sectorsize isn't 512 bytes ... weird).
1836
1837 See also C<guestfs_blockdev_getss> for the real sector size of
1838 the device, and C<guestfs_blockdev_getsize64> for the more
1839 useful I<size in bytes>.
1840
1841 This uses the L<blockdev(8)> command.");
1842
1843   ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"]), 63, [],
1844    [InitEmpty, Always, TestOutputInt (
1845       [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
1846    "get total size of device in bytes",
1847    "\
1848 This returns the size of the device in bytes.
1849
1850 See also C<guestfs_blockdev_getsz>.
1851
1852 This uses the L<blockdev(8)> command.");
1853
1854   ("blockdev_flushbufs", (RErr, [Device "device"]), 64, [],
1855    [InitEmpty, Always, TestRun
1856       [["blockdev_flushbufs"; "/dev/sda"]]],
1857    "flush device buffers",
1858    "\
1859 This tells the kernel to flush internal buffers associated
1860 with C<device>.
1861
1862 This uses the L<blockdev(8)> command.");
1863
1864   ("blockdev_rereadpt", (RErr, [Device "device"]), 65, [],
1865    [InitEmpty, Always, TestRun
1866       [["blockdev_rereadpt"; "/dev/sda"]]],
1867    "reread partition table",
1868    "\
1869 Reread the partition table on C<device>.
1870
1871 This uses the L<blockdev(8)> command.");
1872
1873   ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"]), 66, [],
1874    [InitBasicFS, Always, TestOutput (
1875       (* Pick a file from cwd which isn't likely to change. *)
1876       [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1877        ["checksum"; "md5"; "/COPYING.LIB"]],
1878       Digest.to_hex (Digest.file "COPYING.LIB"))],
1879    "upload a file from the local machine",
1880    "\
1881 Upload local file C<filename> to C<remotefilename> on the
1882 filesystem.
1883
1884 C<filename> can also be a named pipe.
1885
1886 See also C<guestfs_download>.");
1887
1888   ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"]), 67, [],
1889    [InitBasicFS, Always, TestOutput (
1890       (* Pick a file from cwd which isn't likely to change. *)
1891       [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1892        ["download"; "/COPYING.LIB"; "testdownload.tmp"];
1893        ["upload"; "testdownload.tmp"; "/upload"];
1894        ["checksum"; "md5"; "/upload"]],
1895       Digest.to_hex (Digest.file "COPYING.LIB"))],
1896    "download a file to the local machine",
1897    "\
1898 Download file C<remotefilename> and save it as C<filename>
1899 on the local machine.
1900
1901 C<filename> can also be a named pipe.
1902
1903 See also C<guestfs_upload>, C<guestfs_cat>.");
1904
1905   ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"]), 68, [],
1906    [InitISOFS, Always, TestOutput (
1907       [["checksum"; "crc"; "/known-3"]], "2891671662");
1908     InitISOFS, Always, TestLastFail (
1909       [["checksum"; "crc"; "/notexists"]]);
1910     InitISOFS, Always, TestOutput (
1911       [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
1912     InitISOFS, Always, TestOutput (
1913       [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
1914     InitISOFS, Always, TestOutput (
1915       [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
1916     InitISOFS, Always, TestOutput (
1917       [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
1918     InitISOFS, Always, TestOutput (
1919       [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
1920     InitISOFS, Always, TestOutput (
1921       [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6")],
1922    "compute MD5, SHAx or CRC checksum of file",
1923    "\
1924 This call computes the MD5, SHAx or CRC checksum of the
1925 file named C<path>.
1926
1927 The type of checksum to compute is given by the C<csumtype>
1928 parameter which must have one of the following values:
1929
1930 =over 4
1931
1932 =item C<crc>
1933
1934 Compute the cyclic redundancy check (CRC) specified by POSIX
1935 for the C<cksum> command.
1936
1937 =item C<md5>
1938
1939 Compute the MD5 hash (using the C<md5sum> program).
1940
1941 =item C<sha1>
1942
1943 Compute the SHA1 hash (using the C<sha1sum> program).
1944
1945 =item C<sha224>
1946
1947 Compute the SHA224 hash (using the C<sha224sum> program).
1948
1949 =item C<sha256>
1950
1951 Compute the SHA256 hash (using the C<sha256sum> program).
1952
1953 =item C<sha384>
1954
1955 Compute the SHA384 hash (using the C<sha384sum> program).
1956
1957 =item C<sha512>
1958
1959 Compute the SHA512 hash (using the C<sha512sum> program).
1960
1961 =back
1962
1963 The checksum is returned as a printable string.");
1964
1965   ("tar_in", (RErr, [FileIn "tarfile"; String "directory"]), 69, [],
1966    [InitBasicFS, Always, TestOutput (
1967       [["tar_in"; "../images/helloworld.tar"; "/"];
1968        ["cat"; "/hello"]], "hello\n")],
1969    "unpack tarfile to directory",
1970    "\
1971 This command uploads and unpacks local file C<tarfile> (an
1972 I<uncompressed> tar file) into C<directory>.
1973
1974 To upload a compressed tarball, use C<guestfs_tgz_in>.");
1975
1976   ("tar_out", (RErr, [String "directory"; FileOut "tarfile"]), 70, [],
1977    [],
1978    "pack directory into tarfile",
1979    "\
1980 This command packs the contents of C<directory> and downloads
1981 it to local file C<tarfile>.
1982
1983 To download a compressed tarball, use C<guestfs_tgz_out>.");
1984
1985   ("tgz_in", (RErr, [FileIn "tarball"; String "directory"]), 71, [],
1986    [InitBasicFS, Always, TestOutput (
1987       [["tgz_in"; "../images/helloworld.tar.gz"; "/"];
1988        ["cat"; "/hello"]], "hello\n")],
1989    "unpack compressed tarball to directory",
1990    "\
1991 This command uploads and unpacks local file C<tarball> (a
1992 I<gzip compressed> tar file) into C<directory>.
1993
1994 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
1995
1996   ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"]), 72, [],
1997    [],
1998    "pack directory into compressed tarball",
1999    "\
2000 This command packs the contents of C<directory> and downloads
2001 it to local file C<tarball>.
2002
2003 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2004
2005   ("mount_ro", (RErr, [Device "device"; String "mountpoint"]), 73, [],
2006    [InitBasicFS, Always, TestLastFail (
2007       [["umount"; "/"];
2008        ["mount_ro"; "/dev/sda1"; "/"];
2009        ["touch"; "/new"]]);
2010     InitBasicFS, Always, TestOutput (
2011       [["write_file"; "/new"; "data"; "0"];
2012        ["umount"; "/"];
2013        ["mount_ro"; "/dev/sda1"; "/"];
2014        ["cat"; "/new"]], "data")],
2015    "mount a guest disk, read-only",
2016    "\
2017 This is the same as the C<guestfs_mount> command, but it
2018 mounts the filesystem with the read-only (I<-o ro>) flag.");
2019
2020   ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"]), 74, [],
2021    [],
2022    "mount a guest disk with mount options",
2023    "\
2024 This is the same as the C<guestfs_mount> command, but it
2025 allows you to set the mount options as for the
2026 L<mount(8)> I<-o> flag.");
2027
2028   ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"]), 75, [],
2029    [],
2030    "mount a guest disk with mount options and vfstype",
2031    "\
2032 This is the same as the C<guestfs_mount> command, but it
2033 allows you to set both the mount options and the vfstype
2034 as for the L<mount(8)> I<-o> and I<-t> flags.");
2035
2036   ("debug", (RString "result", [String "subcmd"; StringList "extraargs"]), 76, [],
2037    [],
2038    "debugging and internals",
2039    "\
2040 The C<guestfs_debug> command exposes some internals of
2041 C<guestfsd> (the guestfs daemon) that runs inside the
2042 qemu subprocess.
2043
2044 There is no comprehensive help for this command.  You have
2045 to look at the file C<daemon/debug.c> in the libguestfs source
2046 to find out what you can do.");
2047
2048   ("lvremove", (RErr, [Device "device"]), 77, [Optional "lvm2"],
2049    [InitEmpty, Always, TestOutputList (
2050       [["part_disk"; "/dev/sda"; "mbr"];
2051        ["pvcreate"; "/dev/sda1"];
2052        ["vgcreate"; "VG"; "/dev/sda1"];
2053        ["lvcreate"; "LV1"; "VG"; "50"];
2054        ["lvcreate"; "LV2"; "VG"; "50"];
2055        ["lvremove"; "/dev/VG/LV1"];
2056        ["lvs"]], ["/dev/VG/LV2"]);
2057     InitEmpty, Always, TestOutputList (
2058       [["part_disk"; "/dev/sda"; "mbr"];
2059        ["pvcreate"; "/dev/sda1"];
2060        ["vgcreate"; "VG"; "/dev/sda1"];
2061        ["lvcreate"; "LV1"; "VG"; "50"];
2062        ["lvcreate"; "LV2"; "VG"; "50"];
2063        ["lvremove"; "/dev/VG"];
2064        ["lvs"]], []);
2065     InitEmpty, Always, TestOutputList (
2066       [["part_disk"; "/dev/sda"; "mbr"];
2067        ["pvcreate"; "/dev/sda1"];
2068        ["vgcreate"; "VG"; "/dev/sda1"];
2069        ["lvcreate"; "LV1"; "VG"; "50"];
2070        ["lvcreate"; "LV2"; "VG"; "50"];
2071        ["lvremove"; "/dev/VG"];
2072        ["vgs"]], ["VG"])],
2073    "remove an LVM logical volume",
2074    "\
2075 Remove an LVM logical volume C<device>, where C<device> is
2076 the path to the LV, such as C</dev/VG/LV>.
2077
2078 You can also remove all LVs in a volume group by specifying
2079 the VG name, C</dev/VG>.");
2080
2081   ("vgremove", (RErr, [String "vgname"]), 78, [Optional "lvm2"],
2082    [InitEmpty, Always, TestOutputList (
2083       [["part_disk"; "/dev/sda"; "mbr"];
2084        ["pvcreate"; "/dev/sda1"];
2085        ["vgcreate"; "VG"; "/dev/sda1"];
2086        ["lvcreate"; "LV1"; "VG"; "50"];
2087        ["lvcreate"; "LV2"; "VG"; "50"];
2088        ["vgremove"; "VG"];
2089        ["lvs"]], []);
2090     InitEmpty, Always, TestOutputList (
2091       [["part_disk"; "/dev/sda"; "mbr"];
2092        ["pvcreate"; "/dev/sda1"];
2093        ["vgcreate"; "VG"; "/dev/sda1"];
2094        ["lvcreate"; "LV1"; "VG"; "50"];
2095        ["lvcreate"; "LV2"; "VG"; "50"];
2096        ["vgremove"; "VG"];
2097        ["vgs"]], [])],
2098    "remove an LVM volume group",
2099    "\
2100 Remove an LVM volume group C<vgname>, (for example C<VG>).
2101
2102 This also forcibly removes all logical volumes in the volume
2103 group (if any).");
2104
2105   ("pvremove", (RErr, [Device "device"]), 79, [Optional "lvm2"],
2106    [InitEmpty, Always, TestOutputListOfDevices (
2107       [["part_disk"; "/dev/sda"; "mbr"];
2108        ["pvcreate"; "/dev/sda1"];
2109        ["vgcreate"; "VG"; "/dev/sda1"];
2110        ["lvcreate"; "LV1"; "VG"; "50"];
2111        ["lvcreate"; "LV2"; "VG"; "50"];
2112        ["vgremove"; "VG"];
2113        ["pvremove"; "/dev/sda1"];
2114        ["lvs"]], []);
2115     InitEmpty, Always, TestOutputListOfDevices (
2116       [["part_disk"; "/dev/sda"; "mbr"];
2117        ["pvcreate"; "/dev/sda1"];
2118        ["vgcreate"; "VG"; "/dev/sda1"];
2119        ["lvcreate"; "LV1"; "VG"; "50"];
2120        ["lvcreate"; "LV2"; "VG"; "50"];
2121        ["vgremove"; "VG"];
2122        ["pvremove"; "/dev/sda1"];
2123        ["vgs"]], []);
2124     InitEmpty, Always, TestOutputListOfDevices (
2125       [["part_disk"; "/dev/sda"; "mbr"];
2126        ["pvcreate"; "/dev/sda1"];
2127        ["vgcreate"; "VG"; "/dev/sda1"];
2128        ["lvcreate"; "LV1"; "VG"; "50"];
2129        ["lvcreate"; "LV2"; "VG"; "50"];
2130        ["vgremove"; "VG"];
2131        ["pvremove"; "/dev/sda1"];
2132        ["pvs"]], [])],
2133    "remove an LVM physical volume",
2134    "\
2135 This wipes a physical volume C<device> so that LVM will no longer
2136 recognise it.
2137
2138 The implementation uses the C<pvremove> command which refuses to
2139 wipe physical volumes that contain any volume groups, so you have
2140 to remove those first.");
2141
2142   ("set_e2label", (RErr, [Device "device"; String "label"]), 80, [],
2143    [InitBasicFS, Always, TestOutput (
2144       [["set_e2label"; "/dev/sda1"; "testlabel"];
2145        ["get_e2label"; "/dev/sda1"]], "testlabel")],
2146    "set the ext2/3/4 filesystem label",
2147    "\
2148 This sets the ext2/3/4 filesystem label of the filesystem on
2149 C<device> to C<label>.  Filesystem labels are limited to
2150 16 characters.
2151
2152 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2153 to return the existing label on a filesystem.");
2154
2155   ("get_e2label", (RString "label", [Device "device"]), 81, [],
2156    [],
2157    "get the ext2/3/4 filesystem label",
2158    "\
2159 This returns the ext2/3/4 filesystem label of the filesystem on
2160 C<device>.");
2161
2162   ("set_e2uuid", (RErr, [Device "device"; String "uuid"]), 82, [],
2163    (let uuid = uuidgen () in
2164     [InitBasicFS, Always, TestOutput (
2165        [["set_e2uuid"; "/dev/sda1"; uuid];
2166         ["get_e2uuid"; "/dev/sda1"]], uuid);
2167      InitBasicFS, Always, TestOutput (
2168        [["set_e2uuid"; "/dev/sda1"; "clear"];
2169         ["get_e2uuid"; "/dev/sda1"]], "");
2170      (* We can't predict what UUIDs will be, so just check the commands run. *)
2171      InitBasicFS, Always, TestRun (
2172        [["set_e2uuid"; "/dev/sda1"; "random"]]);
2173      InitBasicFS, Always, TestRun (
2174        [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2175    "set the ext2/3/4 filesystem UUID",
2176    "\
2177 This sets the ext2/3/4 filesystem UUID of the filesystem on
2178 C<device> to C<uuid>.  The format of the UUID and alternatives
2179 such as C<clear>, C<random> and C<time> are described in the
2180 L<tune2fs(8)> manpage.
2181
2182 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2183 to return the existing UUID of a filesystem.");
2184
2185   ("get_e2uuid", (RString "uuid", [Device "device"]), 83, [],
2186    [],
2187    "get the ext2/3/4 filesystem UUID",
2188    "\
2189 This returns the ext2/3/4 filesystem UUID of the filesystem on
2190 C<device>.");
2191
2192   ("fsck", (RInt "status", [String "fstype"; Device "device"]), 84, [],
2193    [InitBasicFS, Always, TestOutputInt (
2194       [["umount"; "/dev/sda1"];
2195        ["fsck"; "ext2"; "/dev/sda1"]], 0);
2196     InitBasicFS, Always, TestOutputInt (
2197       [["umount"; "/dev/sda1"];
2198        ["zero"; "/dev/sda1"];
2199        ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2200    "run the filesystem checker",
2201    "\
2202 This runs the filesystem checker (fsck) on C<device> which
2203 should have filesystem type C<fstype>.
2204
2205 The returned integer is the status.  See L<fsck(8)> for the
2206 list of status codes from C<fsck>.
2207
2208 Notes:
2209
2210 =over 4
2211
2212 =item *
2213
2214 Multiple status codes can be summed together.
2215
2216 =item *
2217
2218 A non-zero return code can mean \"success\", for example if
2219 errors have been corrected on the filesystem.
2220
2221 =item *
2222
2223 Checking or repairing NTFS volumes is not supported
2224 (by linux-ntfs).
2225
2226 =back
2227
2228 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2229
2230   ("zero", (RErr, [Device "device"]), 85, [],
2231    [InitBasicFS, Always, TestOutput (
2232       [["umount"; "/dev/sda1"];
2233        ["zero"; "/dev/sda1"];
2234        ["file"; "/dev/sda1"]], "data")],
2235    "write zeroes to the device",
2236    "\
2237 This command writes zeroes over the first few blocks of C<device>.
2238
2239 How many blocks are zeroed isn't specified (but it's I<not> enough
2240 to securely wipe the device).  It should be sufficient to remove
2241 any partition tables, filesystem superblocks and so on.
2242
2243 See also: C<guestfs_scrub_device>.");
2244
2245   ("grub_install", (RErr, [Pathname "root"; Device "device"]), 86, [],
2246    (* Test disabled because grub-install incompatible with virtio-blk driver.
2247     * See also: https://bugzilla.redhat.com/show_bug.cgi?id=479760
2248     *)
2249    [InitBasicFS, Disabled, TestOutputTrue (
2250       [["grub_install"; "/"; "/dev/sda1"];
2251        ["is_dir"; "/boot"]])],
2252    "install GRUB",
2253    "\
2254 This command installs GRUB (the Grand Unified Bootloader) on
2255 C<device>, with the root directory being C<root>.");
2256
2257   ("cp", (RErr, [Pathname "src"; Pathname "dest"]), 87, [],
2258    [InitBasicFS, Always, TestOutput (
2259       [["write_file"; "/old"; "file content"; "0"];
2260        ["cp"; "/old"; "/new"];
2261        ["cat"; "/new"]], "file content");
2262     InitBasicFS, Always, TestOutputTrue (
2263       [["write_file"; "/old"; "file content"; "0"];
2264        ["cp"; "/old"; "/new"];
2265        ["is_file"; "/old"]]);
2266     InitBasicFS, Always, TestOutput (
2267       [["write_file"; "/old"; "file content"; "0"];
2268        ["mkdir"; "/dir"];
2269        ["cp"; "/old"; "/dir/new"];
2270        ["cat"; "/dir/new"]], "file content")],
2271    "copy a file",
2272    "\
2273 This copies a file from C<src> to C<dest> where C<dest> is
2274 either a destination filename or destination directory.");
2275
2276   ("cp_a", (RErr, [Pathname "src"; Pathname "dest"]), 88, [],
2277    [InitBasicFS, Always, TestOutput (
2278       [["mkdir"; "/olddir"];
2279        ["mkdir"; "/newdir"];
2280        ["write_file"; "/olddir/file"; "file content"; "0"];
2281        ["cp_a"; "/olddir"; "/newdir"];
2282        ["cat"; "/newdir/olddir/file"]], "file content")],
2283    "copy a file or directory recursively",
2284    "\
2285 This copies a file or directory from C<src> to C<dest>
2286 recursively using the C<cp -a> command.");
2287
2288   ("mv", (RErr, [Pathname "src"; Pathname "dest"]), 89, [],
2289    [InitBasicFS, Always, TestOutput (
2290       [["write_file"; "/old"; "file content"; "0"];
2291        ["mv"; "/old"; "/new"];
2292        ["cat"; "/new"]], "file content");
2293     InitBasicFS, Always, TestOutputFalse (
2294       [["write_file"; "/old"; "file content"; "0"];
2295        ["mv"; "/old"; "/new"];
2296        ["is_file"; "/old"]])],
2297    "move a file",
2298    "\
2299 This moves a file from C<src> to C<dest> where C<dest> is
2300 either a destination filename or destination directory.");
2301
2302   ("drop_caches", (RErr, [Int "whattodrop"]), 90, [],
2303    [InitEmpty, Always, TestRun (
2304       [["drop_caches"; "3"]])],
2305    "drop kernel page cache, dentries and inodes",
2306    "\
2307 This instructs the guest kernel to drop its page cache,
2308 and/or dentries and inode caches.  The parameter C<whattodrop>
2309 tells the kernel what precisely to drop, see
2310 L<http://linux-mm.org/Drop_Caches>
2311
2312 Setting C<whattodrop> to 3 should drop everything.
2313
2314 This automatically calls L<sync(2)> before the operation,
2315 so that the maximum guest memory is freed.");
2316
2317   ("dmesg", (RString "kmsgs", []), 91, [],
2318    [InitEmpty, Always, TestRun (
2319       [["dmesg"]])],
2320    "return kernel messages",
2321    "\
2322 This returns the kernel messages (C<dmesg> output) from
2323 the guest kernel.  This is sometimes useful for extended
2324 debugging of problems.
2325
2326 Another way to get the same information is to enable
2327 verbose messages with C<guestfs_set_verbose> or by setting
2328 the environment variable C<LIBGUESTFS_DEBUG=1> before
2329 running the program.");
2330
2331   ("ping_daemon", (RErr, []), 92, [],
2332    [InitEmpty, Always, TestRun (
2333       [["ping_daemon"]])],
2334    "ping the guest daemon",
2335    "\
2336 This is a test probe into the guestfs daemon running inside
2337 the qemu subprocess.  Calling this function checks that the
2338 daemon responds to the ping message, without affecting the daemon
2339 or attached block device(s) in any other way.");
2340
2341   ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"]), 93, [],
2342    [InitBasicFS, Always, TestOutputTrue (
2343       [["write_file"; "/file1"; "contents of a file"; "0"];
2344        ["cp"; "/file1"; "/file2"];
2345        ["equal"; "/file1"; "/file2"]]);
2346     InitBasicFS, Always, TestOutputFalse (
2347       [["write_file"; "/file1"; "contents of a file"; "0"];
2348        ["write_file"; "/file2"; "contents of another file"; "0"];
2349        ["equal"; "/file1"; "/file2"]]);
2350     InitBasicFS, Always, TestLastFail (
2351       [["equal"; "/file1"; "/file2"]])],
2352    "test if two files have equal contents",
2353    "\
2354 This compares the two files C<file1> and C<file2> and returns
2355 true if their content is exactly equal, or false otherwise.
2356
2357 The external L<cmp(1)> program is used for the comparison.");
2358
2359   ("strings", (RStringList "stringsout", [Pathname "path"]), 94, [ProtocolLimitWarning],
2360    [InitISOFS, Always, TestOutputList (
2361       [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
2362     InitISOFS, Always, TestOutputList (
2363       [["strings"; "/empty"]], [])],
2364    "print the printable strings in a file",
2365    "\
2366 This runs the L<strings(1)> command on a file and returns
2367 the list of printable strings found.");
2368
2369   ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"]), 95, [ProtocolLimitWarning],
2370    [InitISOFS, Always, TestOutputList (
2371       [["strings_e"; "b"; "/known-5"]], []);
2372     InitBasicFS, Disabled, TestOutputList (
2373       [["write_file"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"; "24"];
2374        ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
2375    "print the printable strings in a file",
2376    "\
2377 This is like the C<guestfs_strings> command, but allows you to
2378 specify the encoding.
2379
2380 See the L<strings(1)> manpage for the full list of encodings.
2381
2382 Commonly useful encodings are C<l> (lower case L) which will
2383 show strings inside Windows/x86 files.
2384
2385 The returned strings are transcoded to UTF-8.");
2386
2387   ("hexdump", (RString "dump", [Pathname "path"]), 96, [ProtocolLimitWarning],
2388    [InitISOFS, Always, TestOutput (
2389       [["hexdump"; "/known-4"]], "00000000  61 62 63 0a 64 65 66 0a  67 68 69                 |abc.def.ghi|\n0000000b\n");
2390     (* Test for RHBZ#501888c2 regression which caused large hexdump
2391      * commands to segfault.
2392      *)
2393     InitISOFS, Always, TestRun (
2394       [["hexdump"; "/100krandom"]])],
2395    "dump a file in hexadecimal",
2396    "\
2397 This runs C<hexdump -C> on the given C<path>.  The result is
2398 the human-readable, canonical hex dump of the file.");
2399
2400   ("zerofree", (RErr, [Device "device"]), 97, [Optional "zerofree"],
2401    [InitNone, Always, TestOutput (
2402       [["part_disk"; "/dev/sda"; "mbr"];
2403        ["mkfs"; "ext3"; "/dev/sda1"];
2404        ["mount"; "/dev/sda1"; "/"];
2405        ["write_file"; "/new"; "test file"; "0"];
2406        ["umount"; "/dev/sda1"];
2407        ["zerofree"; "/dev/sda1"];
2408        ["mount"; "/dev/sda1"; "/"];
2409        ["cat"; "/new"]], "test file")],
2410    "zero unused inodes and disk blocks on ext2/3 filesystem",
2411    "\
2412 This runs the I<zerofree> program on C<device>.  This program
2413 claims to zero unused inodes and disk blocks on an ext2/3
2414 filesystem, thus making it possible to compress the filesystem
2415 more effectively.
2416
2417 You should B<not> run this program if the filesystem is
2418 mounted.
2419
2420 It is possible that using this program can damage the filesystem
2421 or data on the filesystem.");
2422
2423   ("pvresize", (RErr, [Device "device"]), 98, [Optional "lvm2"],
2424    [],
2425    "resize an LVM physical volume",
2426    "\
2427 This resizes (expands or shrinks) an existing LVM physical
2428 volume to match the new size of the underlying device.");
2429
2430   ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
2431                        Int "cyls"; Int "heads"; Int "sectors";
2432                        String "line"]), 99, [DangerWillRobinson],
2433    [],
2434    "modify a single partition on a block device",
2435    "\
2436 This runs L<sfdisk(8)> option to modify just the single
2437 partition C<n> (note: C<n> counts from 1).
2438
2439 For other parameters, see C<guestfs_sfdisk>.  You should usually
2440 pass C<0> for the cyls/heads/sectors parameters.
2441
2442 See also: C<guestfs_part_add>");
2443
2444   ("sfdisk_l", (RString "partitions", [Device "device"]), 100, [],
2445    [],
2446    "display the partition table",
2447    "\
2448 This displays the partition table on C<device>, in the
2449 human-readable output of the L<sfdisk(8)> command.  It is
2450 not intended to be parsed.
2451
2452 See also: C<guestfs_part_list>");
2453
2454   ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"]), 101, [],
2455    [],
2456    "display the kernel geometry",
2457    "\
2458 This displays the kernel's idea of the geometry of C<device>.
2459
2460 The result is in human-readable format, and not designed to
2461 be parsed.");
2462
2463   ("sfdisk_disk_geometry", (RString "partitions", [Device "device"]), 102, [],
2464    [],
2465    "display the disk geometry from the partition table",
2466    "\
2467 This displays the disk geometry of C<device> read from the
2468 partition table.  Especially in the case where the underlying
2469 block device has been resized, this can be different from the
2470 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
2471
2472 The result is in human-readable format, and not designed to
2473 be parsed.");
2474
2475   ("vg_activate_all", (RErr, [Bool "activate"]), 103, [Optional "lvm2"],
2476    [],
2477    "activate or deactivate all volume groups",
2478    "\
2479 This command activates or (if C<activate> is false) deactivates
2480 all logical volumes in all volume groups.
2481 If activated, then they are made known to the
2482 kernel, ie. they appear as C</dev/mapper> devices.  If deactivated,
2483 then those devices disappear.
2484
2485 This command is the same as running C<vgchange -a y|n>");
2486
2487   ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"]), 104, [Optional "lvm2"],
2488    [],
2489    "activate or deactivate some volume groups",
2490    "\
2491 This command activates or (if C<activate> is false) deactivates
2492 all logical volumes in the listed volume groups C<volgroups>.
2493 If activated, then they are made known to the
2494 kernel, ie. they appear as C</dev/mapper> devices.  If deactivated,
2495 then those devices disappear.
2496
2497 This command is the same as running C<vgchange -a y|n volgroups...>
2498
2499 Note that if C<volgroups> is an empty list then B<all> volume groups
2500 are activated or deactivated.");
2501
2502   ("lvresize", (RErr, [Device "device"; Int "mbytes"]), 105, [Optional "lvm2"],
2503    [InitNone, Always, TestOutput (
2504       [["part_disk"; "/dev/sda"; "mbr"];
2505        ["pvcreate"; "/dev/sda1"];
2506        ["vgcreate"; "VG"; "/dev/sda1"];
2507        ["lvcreate"; "LV"; "VG"; "10"];
2508        ["mkfs"; "ext2"; "/dev/VG/LV"];
2509        ["mount"; "/dev/VG/LV"; "/"];
2510        ["write_file"; "/new"; "test content"; "0"];
2511        ["umount"; "/"];
2512        ["lvresize"; "/dev/VG/LV"; "20"];
2513        ["e2fsck_f"; "/dev/VG/LV"];
2514        ["resize2fs"; "/dev/VG/LV"];
2515        ["mount"; "/dev/VG/LV"; "/"];
2516        ["cat"; "/new"]], "test content")],
2517    "resize an LVM logical volume",
2518    "\
2519 This resizes (expands or shrinks) an existing LVM logical
2520 volume to C<mbytes>.  When reducing, data in the reduced part
2521 is lost.");
2522
2523   ("resize2fs", (RErr, [Device "device"]), 106, [],
2524    [], (* lvresize tests this *)
2525    "resize an ext2/ext3 filesystem",
2526    "\
2527 This resizes an ext2 or ext3 filesystem to match the size of
2528 the underlying device.
2529
2530 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
2531 on the C<device> before calling this command.  For unknown reasons
2532 C<resize2fs> sometimes gives an error about this and sometimes not.
2533 In any case, it is always safe to call C<guestfs_e2fsck_f> before
2534 calling this function.");
2535
2536   ("find", (RStringList "names", [Pathname "directory"]), 107, [ProtocolLimitWarning],
2537    [InitBasicFS, Always, TestOutputList (
2538       [["find"; "/"]], ["lost+found"]);
2539     InitBasicFS, Always, TestOutputList (
2540       [["touch"; "/a"];
2541        ["mkdir"; "/b"];
2542        ["touch"; "/b/c"];
2543        ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
2544     InitBasicFS, Always, TestOutputList (
2545       [["mkdir_p"; "/a/b/c"];
2546        ["touch"; "/a/b/c/d"];
2547        ["find"; "/a/b/"]], ["c"; "c/d"])],
2548    "find all files and directories",
2549    "\
2550 This command lists out all files and directories, recursively,
2551 starting at C<directory>.  It is essentially equivalent to
2552 running the shell command C<find directory -print> but some
2553 post-processing happens on the output, described below.
2554
2555 This returns a list of strings I<without any prefix>.  Thus
2556 if the directory structure was:
2557
2558  /tmp/a
2559  /tmp/b
2560  /tmp/c/d
2561
2562 then the returned list from C<guestfs_find> C</tmp> would be
2563 4 elements:
2564
2565  a
2566  b
2567  c
2568  c/d
2569
2570 If C<directory> is not a directory, then this command returns
2571 an error.
2572
2573 The returned list is sorted.
2574
2575 See also C<guestfs_find0>.");
2576
2577   ("e2fsck_f", (RErr, [Device "device"]), 108, [],
2578    [], (* lvresize tests this *)
2579    "check an ext2/ext3 filesystem",
2580    "\
2581 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
2582 filesystem checker on C<device>, noninteractively (C<-p>),
2583 even if the filesystem appears to be clean (C<-f>).
2584
2585 This command is only needed because of C<guestfs_resize2fs>
2586 (q.v.).  Normally you should use C<guestfs_fsck>.");
2587
2588   ("sleep", (RErr, [Int "secs"]), 109, [],
2589    [InitNone, Always, TestRun (
2590       [["sleep"; "1"]])],
2591    "sleep for some seconds",
2592    "\
2593 Sleep for C<secs> seconds.");
2594
2595   ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"]), 110, [Optional "ntfs3g"],
2596    [InitNone, Always, TestOutputInt (
2597       [["part_disk"; "/dev/sda"; "mbr"];
2598        ["mkfs"; "ntfs"; "/dev/sda1"];
2599        ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
2600     InitNone, Always, TestOutputInt (
2601       [["part_disk"; "/dev/sda"; "mbr"];
2602        ["mkfs"; "ext2"; "/dev/sda1"];
2603        ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
2604    "probe NTFS volume",
2605    "\
2606 This command runs the L<ntfs-3g.probe(8)> command which probes
2607 an NTFS C<device> for mountability.  (Not all NTFS volumes can
2608 be mounted read-write, and some cannot be mounted at all).
2609
2610 C<rw> is a boolean flag.  Set it to true if you want to test
2611 if the volume can be mounted read-write.  Set it to false if
2612 you want to test if the volume can be mounted read-only.
2613
2614 The return value is an integer which C<0> if the operation
2615 would succeed, or some non-zero value documented in the
2616 L<ntfs-3g.probe(8)> manual page.");
2617
2618   ("sh", (RString "output", [String "command"]), 111, [],
2619    [], (* XXX needs tests *)
2620    "run a command via the shell",
2621    "\
2622 This call runs a command from the guest filesystem via the
2623 guest's C</bin/sh>.
2624
2625 This is like C<guestfs_command>, but passes the command to:
2626
2627  /bin/sh -c \"command\"
2628
2629 Depending on the guest's shell, this usually results in
2630 wildcards being expanded, shell expressions being interpolated
2631 and so on.
2632
2633 All the provisos about C<guestfs_command> apply to this call.");
2634
2635   ("sh_lines", (RStringList "lines", [String "command"]), 112, [],
2636    [], (* XXX needs tests *)
2637    "run a command via the shell returning lines",
2638    "\
2639 This is the same as C<guestfs_sh>, but splits the result
2640 into a list of lines.
2641
2642 See also: C<guestfs_command_lines>");
2643
2644   ("glob_expand", (RStringList "paths", [Pathname "pattern"]), 113, [],
2645    (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
2646     * code in stubs.c, since all valid glob patterns must start with "/".
2647     * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
2648     *)
2649    [InitBasicFS, Always, TestOutputList (
2650       [["mkdir_p"; "/a/b/c"];
2651        ["touch"; "/a/b/c/d"];
2652        ["touch"; "/a/b/c/e"];
2653        ["glob_expand"; "/a/b/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2654     InitBasicFS, Always, TestOutputList (
2655       [["mkdir_p"; "/a/b/c"];
2656        ["touch"; "/a/b/c/d"];
2657        ["touch"; "/a/b/c/e"];
2658        ["glob_expand"; "/a/*/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2659     InitBasicFS, Always, TestOutputList (
2660       [["mkdir_p"; "/a/b/c"];
2661        ["touch"; "/a/b/c/d"];
2662        ["touch"; "/a/b/c/e"];
2663        ["glob_expand"; "/a/*/x/*"]], [])],
2664    "expand a wildcard path",
2665    "\
2666 This command searches for all the pathnames matching
2667 C<pattern> according to the wildcard expansion rules
2668 used by the shell.
2669
2670 If no paths match, then this returns an empty list
2671 (note: not an error).
2672
2673 It is just a wrapper around the C L<glob(3)> function
2674 with flags C<GLOB_MARK|GLOB_BRACE>.
2675 See that manual page for more details.");
2676
2677   ("scrub_device", (RErr, [Device "device"]), 114, [DangerWillRobinson; Optional "scrub"],
2678    [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
2679       [["scrub_device"; "/dev/sdc"]])],
2680    "scrub (securely wipe) a device",
2681    "\
2682 This command writes patterns over C<device> to make data retrieval
2683 more difficult.
2684
2685 It is an interface to the L<scrub(1)> program.  See that
2686 manual page for more details.");
2687
2688   ("scrub_file", (RErr, [Pathname "file"]), 115, [Optional "scrub"],
2689    [InitBasicFS, Always, TestRun (
2690       [["write_file"; "/file"; "content"; "0"];
2691        ["scrub_file"; "/file"]])],
2692    "scrub (securely wipe) a file",
2693    "\
2694 This command writes patterns over a file to make data retrieval
2695 more difficult.
2696
2697 The file is I<removed> after scrubbing.
2698
2699 It is an interface to the L<scrub(1)> program.  See that
2700 manual page for more details.");
2701
2702   ("scrub_freespace", (RErr, [Pathname "dir"]), 116, [Optional "scrub"],
2703    [], (* XXX needs testing *)
2704    "scrub (securely wipe) free space",
2705    "\
2706 This command creates the directory C<dir> and then fills it
2707 with files until the filesystem is full, and scrubs the files
2708 as for C<guestfs_scrub_file>, and deletes them.
2709 The intention is to scrub any free space on the partition
2710 containing C<dir>.
2711
2712 It is an interface to the L<scrub(1)> program.  See that
2713 manual page for more details.");
2714
2715   ("mkdtemp", (RString "dir", [Pathname "template"]), 117, [],
2716    [InitBasicFS, Always, TestRun (
2717       [["mkdir"; "/tmp"];
2718        ["mkdtemp"; "/tmp/tmpXXXXXX"]])],
2719    "create a temporary directory",
2720    "\
2721 This command creates a temporary directory.  The
2722 C<template> parameter should be a full pathname for the
2723 temporary directory name with the final six characters being
2724 \"XXXXXX\".
2725
2726 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
2727 the second one being suitable for Windows filesystems.
2728
2729 The name of the temporary directory that was created
2730 is returned.
2731
2732 The temporary directory is created with mode 0700
2733 and is owned by root.
2734
2735 The caller is responsible for deleting the temporary
2736 directory and its contents after use.
2737
2738 See also: L<mkdtemp(3)>");
2739
2740   ("wc_l", (RInt "lines", [Pathname "path"]), 118, [],
2741    [InitISOFS, Always, TestOutputInt (
2742       [["wc_l"; "/10klines"]], 10000)],
2743    "count lines in a file",
2744    "\
2745 This command counts the lines in a file, using the
2746 C<wc -l> external command.");
2747
2748   ("wc_w", (RInt "words", [Pathname "path"]), 119, [],
2749    [InitISOFS, Always, TestOutputInt (
2750       [["wc_w"; "/10klines"]], 10000)],
2751    "count words in a file",
2752    "\
2753 This command counts the words in a file, using the
2754 C<wc -w> external command.");
2755
2756   ("wc_c", (RInt "chars", [Pathname "path"]), 120, [],
2757    [InitISOFS, Always, TestOutputInt (
2758       [["wc_c"; "/100kallspaces"]], 102400)],
2759    "count characters in a file",
2760    "\
2761 This command counts the characters in a file, using the
2762 C<wc -c> external command.");
2763
2764   ("head", (RStringList "lines", [Pathname "path"]), 121, [ProtocolLimitWarning],
2765    [InitISOFS, Always, TestOutputList (
2766       [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
2767    "return first 10 lines of a file",
2768    "\
2769 This command returns up to the first 10 lines of a file as
2770 a list of strings.");
2771
2772   ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"]), 122, [ProtocolLimitWarning],
2773    [InitISOFS, Always, TestOutputList (
2774       [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2775     InitISOFS, Always, TestOutputList (
2776       [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2777     InitISOFS, Always, TestOutputList (
2778       [["head_n"; "0"; "/10klines"]], [])],
2779    "return first N lines of a file",
2780    "\
2781 If the parameter C<nrlines> is a positive number, this returns the first
2782 C<nrlines> lines of the file C<path>.
2783
2784 If the parameter C<nrlines> is a negative number, this returns lines
2785 from the file C<path>, excluding the last C<nrlines> lines.
2786
2787 If the parameter C<nrlines> is zero, this returns an empty list.");
2788
2789   ("tail", (RStringList "lines", [Pathname "path"]), 123, [ProtocolLimitWarning],
2790    [InitISOFS, Always, TestOutputList (
2791       [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
2792    "return last 10 lines of a file",
2793    "\
2794 This command returns up to the last 10 lines of a file as
2795 a list of strings.");
2796
2797   ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"]), 124, [ProtocolLimitWarning],
2798    [InitISOFS, Always, TestOutputList (
2799       [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2800     InitISOFS, Always, TestOutputList (
2801       [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2802     InitISOFS, Always, TestOutputList (
2803       [["tail_n"; "0"; "/10klines"]], [])],
2804    "return last N lines of a file",
2805    "\
2806 If the parameter C<nrlines> is a positive number, this returns the last
2807 C<nrlines> lines of the file C<path>.
2808
2809 If the parameter C<nrlines> is a negative number, this returns lines
2810 from the file C<path>, starting with the C<-nrlines>th line.
2811
2812 If the parameter C<nrlines> is zero, this returns an empty list.");
2813
2814   ("df", (RString "output", []), 125, [],
2815    [], (* XXX Tricky to test because it depends on the exact format
2816         * of the 'df' command and other imponderables.
2817         *)
2818    "report file system disk space usage",
2819    "\
2820 This command runs the C<df> command to report disk space used.
2821
2822 This command is mostly useful for interactive sessions.  It
2823 is I<not> intended that you try to parse the output string.
2824 Use C<statvfs> from programs.");
2825
2826   ("df_h", (RString "output", []), 126, [],
2827    [], (* XXX Tricky to test because it depends on the exact format
2828         * of the 'df' command and other imponderables.
2829         *)
2830    "report file system disk space usage (human readable)",
2831    "\
2832 This command runs the C<df -h> command to report disk space used
2833 in human-readable format.
2834
2835 This command is mostly useful for interactive sessions.  It
2836 is I<not> intended that you try to parse the output string.
2837 Use C<statvfs> from programs.");
2838
2839   ("du", (RInt64 "sizekb", [Pathname "path"]), 127, [],
2840    [InitISOFS, Always, TestOutputInt (
2841       [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
2842    "estimate file space usage",
2843    "\
2844 This command runs the C<du -s> command to estimate file space
2845 usage for C<path>.
2846
2847 C<path> can be a file or a directory.  If C<path> is a directory
2848 then the estimate includes the contents of the directory and all
2849 subdirectories (recursively).
2850
2851 The result is the estimated size in I<kilobytes>
2852 (ie. units of 1024 bytes).");
2853
2854   ("initrd_list", (RStringList "filenames", [Pathname "path"]), 128, [],
2855    [InitISOFS, Always, TestOutputList (
2856       [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
2857    "list files in an initrd",
2858    "\
2859 This command lists out files contained in an initrd.
2860
2861 The files are listed without any initial C</> character.  The
2862 files are listed in the order they appear (not necessarily
2863 alphabetical).  Directory names are listed as separate items.
2864
2865 Old Linux kernels (2.4 and earlier) used a compressed ext2
2866 filesystem as initrd.  We I<only> support the newer initramfs
2867 format (compressed cpio files).");
2868
2869   ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"]), 129, [],
2870    [],
2871    "mount a file using the loop device",
2872    "\
2873 This command lets you mount C<file> (a filesystem image
2874 in a file) on a mount point.  It is entirely equivalent to
2875 the command C<mount -o loop file mountpoint>.");
2876
2877   ("mkswap", (RErr, [Device "device"]), 130, [],
2878    [InitEmpty, Always, TestRun (
2879       [["part_disk"; "/dev/sda"; "mbr"];
2880        ["mkswap"; "/dev/sda1"]])],
2881    "create a swap partition",
2882    "\
2883 Create a swap partition on C<device>.");
2884
2885   ("mkswap_L", (RErr, [String "label"; Device "device"]), 131, [],
2886    [InitEmpty, Always, TestRun (
2887       [["part_disk"; "/dev/sda"; "mbr"];
2888        ["mkswap_L"; "hello"; "/dev/sda1"]])],
2889    "create a swap partition with a label",
2890    "\
2891 Create a swap partition on C<device> with label C<label>.
2892
2893 Note that you cannot attach a swap label to a block device
2894 (eg. C</dev/sda>), just to a partition.  This appears to be
2895 a limitation of the kernel or swap tools.");
2896
2897   ("mkswap_U", (RErr, [String "uuid"; Device "device"]), 132, [Optional "linuxfsuuid"],
2898    (let uuid = uuidgen () in
2899     [InitEmpty, Always, TestRun (
2900        [["part_disk"; "/dev/sda"; "mbr"];
2901         ["mkswap_U"; uuid; "/dev/sda1"]])]),
2902    "create a swap partition with an explicit UUID",
2903    "\
2904 Create a swap partition on C<device> with UUID C<uuid>.");
2905
2906   ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 133, [Optional "mknod"],
2907    [InitBasicFS, Always, TestOutputStruct (
2908       [["mknod"; "0o10777"; "0"; "0"; "/node"];
2909        (* NB: default umask 022 means 0777 -> 0755 in these tests *)
2910        ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)]);
2911     InitBasicFS, Always, TestOutputStruct (
2912       [["mknod"; "0o60777"; "66"; "99"; "/node"];
2913        ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
2914    "make block, character or FIFO devices",
2915    "\
2916 This call creates block or character special devices, or
2917 named pipes (FIFOs).
2918
2919 The C<mode> parameter should be the mode, using the standard
2920 constants.  C<devmajor> and C<devminor> are the
2921 device major and minor numbers, only used when creating block
2922 and character special devices.");
2923
2924   ("mkfifo", (RErr, [Int "mode"; Pathname "path"]), 134, [Optional "mknod"],
2925    [InitBasicFS, Always, TestOutputStruct (
2926       [["mkfifo"; "0o777"; "/node"];
2927        ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)])],
2928    "make FIFO (named pipe)",
2929    "\
2930 This call creates a FIFO (named pipe) called C<path> with
2931 mode C<mode>.  It is just a convenient wrapper around
2932 C<guestfs_mknod>.");
2933
2934   ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 135, [Optional "mknod"],
2935    [InitBasicFS, Always, TestOutputStruct (
2936       [["mknod_b"; "0o777"; "99"; "66"; "/node"];
2937        ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
2938    "make block device node",
2939    "\
2940 This call creates a block device node called C<path> with
2941 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
2942 It is just a convenient wrapper around C<guestfs_mknod>.");
2943
2944   ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 136, [Optional "mknod"],
2945    [InitBasicFS, Always, TestOutputStruct (
2946       [["mknod_c"; "0o777"; "99"; "66"; "/node"];
2947        ["stat"; "/node"]], [CompareWithInt ("mode", 0o20755)])],
2948    "make char device node",
2949    "\
2950 This call creates a char device node called C<path> with
2951 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
2952 It is just a convenient wrapper around C<guestfs_mknod>.");
2953
2954   ("umask", (RInt "oldmask", [Int "mask"]), 137, [],
2955    [], (* XXX umask is one of those stateful things that we should
2956         * reset between each test.
2957         *)
2958    "set file mode creation mask (umask)",
2959    "\
2960 This function sets the mask used for creating new files and
2961 device nodes to C<mask & 0777>.
2962
2963 Typical umask values would be C<022> which creates new files
2964 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
2965 C<002> which creates new files with permissions like
2966 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
2967
2968 The default umask is C<022>.  This is important because it
2969 means that directories and device nodes will be created with
2970 C<0644> or C<0755> mode even if you specify C<0777>.
2971
2972 See also L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
2973
2974 This call returns the previous umask.");
2975
2976   ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"]), 138, [],
2977    [],
2978    "read directories entries",
2979    "\
2980 This returns the list of directory entries in directory C<dir>.
2981
2982 All entries in the directory are returned, including C<.> and
2983 C<..>.  The entries are I<not> sorted, but returned in the same
2984 order as the underlying filesystem.
2985
2986 Also this call returns basic file type information about each
2987 file.  The C<ftyp> field will contain one of the following characters:
2988
2989 =over 4
2990
2991 =item 'b'
2992
2993 Block special
2994
2995 =item 'c'
2996
2997 Char special
2998
2999 =item 'd'
3000
3001 Directory
3002
3003 =item 'f'
3004
3005 FIFO (named pipe)
3006
3007 =item 'l'
3008
3009 Symbolic link
3010
3011 =item 'r'
3012
3013 Regular file
3014
3015 =item 's'
3016
3017 Socket
3018
3019 =item 'u'
3020
3021 Unknown file type
3022
3023 =item '?'
3024
3025 The L<readdir(3)> returned a C<d_type> field with an
3026 unexpected value
3027
3028 =back
3029
3030 This function is primarily intended for use by programs.  To
3031 get a simple list of names, use C<guestfs_ls>.  To get a printable
3032 directory for human consumption, use C<guestfs_ll>.");
3033
3034   ("sfdiskM", (RErr, [Device "device"; StringList "lines"]), 139, [DangerWillRobinson],
3035    [],
3036    "create partitions on a block device",
3037    "\
3038 This is a simplified interface to the C<guestfs_sfdisk>
3039 command, where partition sizes are specified in megabytes
3040 only (rounded to the nearest cylinder) and you don't need
3041 to specify the cyls, heads and sectors parameters which
3042 were rarely if ever used anyway.
3043
3044 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3045 and C<guestfs_part_disk>");
3046
3047   ("zfile", (RString "description", [String "meth"; Pathname "path"]), 140, [DeprecatedBy "file"],
3048    [],
3049    "determine file type inside a compressed file",
3050    "\
3051 This command runs C<file> after first decompressing C<path>
3052 using C<method>.
3053
3054 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3055
3056 Since 1.0.63, use C<guestfs_file> instead which can now
3057 process compressed files.");
3058
3059   ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"]), 141, [Optional "linuxxattrs"],
3060    [],
3061    "list extended attributes of a file or directory",
3062    "\
3063 This call lists the extended attributes of the file or directory
3064 C<path>.
3065
3066 At the system call level, this is a combination of the
3067 L<listxattr(2)> and L<getxattr(2)> calls.
3068
3069 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3070
3071   ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"]), 142, [Optional "linuxxattrs"],
3072    [],
3073    "list extended attributes of a file or directory",
3074    "\
3075 This is the same as C<guestfs_getxattrs>, but if C<path>
3076 is a symbolic link, then it returns the extended attributes
3077 of the link itself.");
3078
3079   ("setxattr", (RErr, [String "xattr";
3080                        String "val"; Int "vallen"; (* will be BufferIn *)
3081                        Pathname "path"]), 143, [Optional "linuxxattrs"],
3082    [],
3083    "set extended attribute of a file or directory",
3084    "\
3085 This call sets the extended attribute named C<xattr>
3086 of the file C<path> to the value C<val> (of length C<vallen>).
3087 The value is arbitrary 8 bit data.
3088
3089 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3090
3091   ("lsetxattr", (RErr, [String "xattr";
3092                         String "val"; Int "vallen"; (* will be BufferIn *)
3093                         Pathname "path"]), 144, [Optional "linuxxattrs"],
3094    [],
3095    "set extended attribute of a file or directory",
3096    "\
3097 This is the same as C<guestfs_setxattr>, but if C<path>
3098 is a symbolic link, then it sets an extended attribute
3099 of the link itself.");
3100
3101   ("removexattr", (RErr, [String "xattr"; Pathname "path"]), 145, [Optional "linuxxattrs"],
3102    [],
3103    "remove extended attribute of a file or directory",
3104    "\
3105 This call removes the extended attribute named C<xattr>
3106 of the file C<path>.
3107
3108 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3109
3110   ("lremovexattr", (RErr, [String "xattr"; Pathname "path"]), 146, [Optional "linuxxattrs"],
3111    [],
3112    "remove extended attribute of a file or directory",
3113    "\
3114 This is the same as C<guestfs_removexattr>, but if C<path>
3115 is a symbolic link, then it removes an extended attribute
3116 of the link itself.");
3117
3118   ("mountpoints", (RHashtable "mps", []), 147, [],
3119    [],
3120    "show mountpoints",
3121    "\
3122 This call is similar to C<guestfs_mounts>.  That call returns
3123 a list of devices.  This one returns a hash table (map) of
3124 device name to directory where the device is mounted.");
3125
3126   ("mkmountpoint", (RErr, [String "exemptpath"]), 148, [],
3127    (* This is a special case: while you would expect a parameter
3128     * of type "Pathname", that doesn't work, because it implies
3129     * NEED_ROOT in the generated calling code in stubs.c, and
3130     * this function cannot use NEED_ROOT.
3131     *)
3132    [],
3133    "create a mountpoint",
3134    "\
3135 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3136 specialized calls that can be used to create extra mountpoints
3137 before mounting the first filesystem.
3138
3139 These calls are I<only> necessary in some very limited circumstances,
3140 mainly the case where you want to mount a mix of unrelated and/or
3141 read-only filesystems together.
3142
3143 For example, live CDs often contain a \"Russian doll\" nest of
3144 filesystems, an ISO outer layer, with a squashfs image inside, with
3145 an ext2/3 image inside that.  You can unpack this as follows
3146 in guestfish:
3147
3148  add-ro Fedora-11-i686-Live.iso
3149  run
3150  mkmountpoint /cd
3151  mkmountpoint /squash
3152  mkmountpoint /ext3
3153  mount /dev/sda /cd
3154  mount-loop /cd/LiveOS/squashfs.img /squash
3155  mount-loop /squash/LiveOS/ext3fs.img /ext3
3156
3157 The inner filesystem is now unpacked under the /ext3 mountpoint.");
3158
3159   ("rmmountpoint", (RErr, [String "exemptpath"]), 149, [],
3160    [],
3161    "remove a mountpoint",
3162    "\
3163 This calls removes a mountpoint that was previously created
3164 with C<guestfs_mkmountpoint>.  See C<guestfs_mkmountpoint>
3165 for full details.");
3166
3167   ("read_file", (RBufferOut "content", [Pathname "path"]), 150, [ProtocolLimitWarning],
3168    [InitISOFS, Always, TestOutputBuffer (
3169       [["read_file"; "/known-4"]], "abc\ndef\nghi")],
3170    "read a file",
3171    "\
3172 This calls returns the contents of the file C<path> as a
3173 buffer.
3174
3175 Unlike C<guestfs_cat>, this function can correctly
3176 handle files that contain embedded ASCII NUL characters.
3177 However unlike C<guestfs_download>, this function is limited
3178 in the total size of file that can be handled.");
3179
3180   ("grep", (RStringList "lines", [String "regex"; Pathname "path"]), 151, [ProtocolLimitWarning],
3181    [InitISOFS, Always, TestOutputList (
3182       [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3183     InitISOFS, Always, TestOutputList (
3184       [["grep"; "nomatch"; "/test-grep.txt"]], [])],
3185    "return lines matching a pattern",
3186    "\
3187 This calls the external C<grep> program and returns the
3188 matching lines.");
3189
3190   ("egrep", (RStringList "lines", [String "regex"; Pathname "path"]), 152, [ProtocolLimitWarning],
3191    [InitISOFS, Always, TestOutputList (
3192       [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3193    "return lines matching a pattern",
3194    "\
3195 This calls the external C<egrep> program and returns the
3196 matching lines.");
3197
3198   ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"]), 153, [ProtocolLimitWarning],
3199    [InitISOFS, Always, TestOutputList (
3200       [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3201    "return lines matching a pattern",
3202    "\
3203 This calls the external C<fgrep> program and returns the
3204 matching lines.");
3205
3206   ("grepi", (RStringList "lines", [String "regex"; Pathname "path"]), 154, [ProtocolLimitWarning],
3207    [InitISOFS, Always, TestOutputList (
3208       [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3209    "return lines matching a pattern",
3210    "\
3211 This calls the external C<grep -i> program and returns the
3212 matching lines.");
3213
3214   ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 155, [ProtocolLimitWarning],
3215    [InitISOFS, Always, TestOutputList (
3216       [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3217    "return lines matching a pattern",
3218    "\
3219 This calls the external C<egrep -i> program and returns the
3220 matching lines.");
3221
3222   ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"]), 156, [ProtocolLimitWarning],
3223    [InitISOFS, Always, TestOutputList (
3224       [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3225    "return lines matching a pattern",
3226    "\
3227 This calls the external C<fgrep -i> program and returns the
3228 matching lines.");
3229
3230   ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"]), 157, [ProtocolLimitWarning],
3231    [InitISOFS, Always, TestOutputList (
3232       [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3233    "return lines matching a pattern",
3234    "\
3235 This calls the external C<zgrep> program and returns the
3236 matching lines.");
3237
3238   ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"]), 158, [ProtocolLimitWarning],
3239    [InitISOFS, Always, TestOutputList (
3240       [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3241    "return lines matching a pattern",
3242    "\
3243 This calls the external C<zegrep> program and returns the
3244 matching lines.");
3245
3246   ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"]), 159, [ProtocolLimitWarning],
3247    [InitISOFS, Always, TestOutputList (
3248       [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3249    "return lines matching a pattern",
3250    "\
3251 This calls the external C<zfgrep> program and returns the
3252 matching lines.");
3253
3254   ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 160, [ProtocolLimitWarning],
3255    [InitISOFS, Always, TestOutputList (
3256       [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3257    "return lines matching a pattern",
3258    "\
3259 This calls the external C<zgrep -i> program and returns the
3260 matching lines.");
3261
3262   ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 161, [ProtocolLimitWarning],
3263    [InitISOFS, Always, TestOutputList (
3264       [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3265    "return lines matching a pattern",
3266    "\
3267 This calls the external C<zegrep -i> program and returns the
3268 matching lines.");
3269
3270   ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"]), 162, [ProtocolLimitWarning],
3271    [InitISOFS, Always, TestOutputList (
3272       [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3273    "return lines matching a pattern",
3274    "\
3275 This calls the external C<zfgrep -i> program and returns the
3276 matching lines.");
3277
3278   ("realpath", (RString "rpath", [Pathname "path"]), 163, [Optional "realpath"],
3279    [InitISOFS, Always, TestOutput (
3280       [["realpath"; "/../directory"]], "/directory")],
3281    "canonicalized absolute pathname",
3282    "\
3283 Return the canonicalized absolute pathname of C<path>.  The
3284 returned path has no C<.>, C<..> or symbolic link path elements.");
3285
3286   ("ln", (RErr, [String "target"; Pathname "linkname"]), 164, [],
3287    [InitBasicFS, Always, TestOutputStruct (
3288       [["touch"; "/a"];
3289        ["ln"; "/a"; "/b"];
3290        ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3291    "create a hard link",
3292    "\
3293 This command creates a hard link using the C<ln> command.");
3294
3295   ("ln_f", (RErr, [String "target"; Pathname "linkname"]), 165, [],
3296    [InitBasicFS, Always, TestOutputStruct (
3297       [["touch"; "/a"];
3298        ["touch"; "/b"];
3299        ["ln_f"; "/a"; "/b"];
3300        ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3301    "create a hard link",
3302    "\
3303 This command creates a hard link using the C<ln -f> command.
3304 The C<-f> option removes the link (C<linkname>) if it exists already.");
3305
3306   ("ln_s", (RErr, [String "target"; Pathname "linkname"]), 166, [],
3307    [InitBasicFS, Always, TestOutputStruct (
3308       [["touch"; "/a"];
3309        ["ln_s"; "a"; "/b"];
3310        ["lstat"; "/b"]], [CompareWithInt ("mode", 0o120777)])],
3311    "create a symbolic link",
3312    "\
3313 This command creates a symbolic link using the C<ln -s> command.");
3314
3315   ("ln_sf", (RErr, [String "target"; Pathname "linkname"]), 167, [],
3316    [InitBasicFS, Always, TestOutput (
3317       [["mkdir_p"; "/a/b"];
3318        ["touch"; "/a/b/c"];
3319        ["ln_sf"; "../d"; "/a/b/c"];
3320        ["readlink"; "/a/b/c"]], "../d")],
3321    "create a symbolic link",
3322    "\
3323 This command creates a symbolic link using the C<ln -sf> command,
3324 The C<-f> option removes the link (C<linkname>) if it exists already.");
3325
3326   ("readlink", (RString "link", [Pathname "path"]), 168, [],
3327    [] (* XXX tested above *),
3328    "read the target of a symbolic link",
3329    "\
3330 This command reads the target of a symbolic link.");
3331
3332   ("fallocate", (RErr, [Pathname "path"; Int "len"]), 169, [],
3333    [InitBasicFS, Always, TestOutputStruct (
3334       [["fallocate"; "/a"; "1000000"];
3335        ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
3336    "preallocate a file in the guest filesystem",
3337    "\
3338 This command preallocates a file (containing zero bytes) named
3339 C<path> of size C<len> bytes.  If the file exists already, it
3340 is overwritten.
3341
3342 Do not confuse this with the guestfish-specific
3343 C<alloc> command which allocates a file in the host and
3344 attaches it as a device.");
3345
3346   ("swapon_device", (RErr, [Device "device"]), 170, [],
3347    [InitPartition, Always, TestRun (
3348       [["mkswap"; "/dev/sda1"];
3349        ["swapon_device"; "/dev/sda1"];
3350        ["swapoff_device"; "/dev/sda1"]])],
3351    "enable swap on device",
3352    "\
3353 This command enables the libguestfs appliance to use the
3354 swap device or partition named C<device>.  The increased
3355 memory is made available for all commands, for example
3356 those run using C<guestfs_command> or C<guestfs_sh>.
3357
3358 Note that you should not swap to existing guest swap
3359 partitions unless you know what you are doing.  They may
3360 contain hibernation information, or other information that
3361 the guest doesn't want you to trash.  You also risk leaking
3362 information about the host to the guest this way.  Instead,
3363 attach a new host device to the guest and swap on that.");
3364
3365   ("swapoff_device", (RErr, [Device "device"]), 171, [],
3366    [], (* XXX tested by swapon_device *)
3367    "disable swap on device",
3368    "\
3369 This command disables the libguestfs appliance swap
3370 device or partition named C<device>.
3371 See C<guestfs_swapon_device>.");
3372
3373   ("swapon_file", (RErr, [Pathname "file"]), 172, [],
3374    [InitBasicFS, Always, TestRun (
3375       [["fallocate"; "/swap"; "8388608"];
3376        ["mkswap_file"; "/swap"];
3377        ["swapon_file"; "/swap"];
3378        ["swapoff_file"; "/swap"]])],
3379    "enable swap on file",
3380    "\
3381 This command enables swap to a file.
3382 See C<guestfs_swapon_device> for other notes.");
3383
3384   ("swapoff_file", (RErr, [Pathname "file"]), 173, [],
3385    [], (* XXX tested by swapon_file *)
3386    "disable swap on file",
3387    "\
3388 This command disables the libguestfs appliance swap on file.");
3389
3390   ("swapon_label", (RErr, [String "label"]), 174, [],
3391    [InitEmpty, Always, TestRun (
3392       [["part_disk"; "/dev/sdb"; "mbr"];
3393        ["mkswap_L"; "swapit"; "/dev/sdb1"];
3394        ["swapon_label"; "swapit"];
3395        ["swapoff_label"; "swapit"];
3396        ["zero"; "/dev/sdb"];
3397        ["blockdev_rereadpt"; "/dev/sdb"]])],
3398    "enable swap on labeled swap partition",
3399    "\
3400 This command enables swap to a labeled swap partition.
3401 See C<guestfs_swapon_device> for other notes.");
3402
3403   ("swapoff_label", (RErr, [String "label"]), 175, [],
3404    [], (* XXX tested by swapon_label *)
3405    "disable swap on labeled swap partition",
3406    "\
3407 This command disables the libguestfs appliance swap on
3408 labeled swap partition.");
3409
3410   ("swapon_uuid", (RErr, [String "uuid"]), 176, [Optional "linuxfsuuid"],
3411    (let uuid = uuidgen () in
3412     [InitEmpty, Always, TestRun (
3413        [["mkswap_U"; uuid; "/dev/sdb"];
3414         ["swapon_uuid"; uuid];
3415         ["swapoff_uuid"; uuid]])]),
3416    "enable swap on swap partition by UUID",
3417    "\
3418 This command enables swap to a swap partition with the given UUID.
3419 See C<guestfs_swapon_device> for other notes.");
3420
3421   ("swapoff_uuid", (RErr, [String "uuid"]), 177, [Optional "linuxfsuuid"],
3422    [], (* XXX tested by swapon_uuid *)
3423    "disable swap on swap partition by UUID",
3424    "\
3425 This command disables the libguestfs appliance swap partition
3426 with the given UUID.");
3427
3428   ("mkswap_file", (RErr, [Pathname "path"]), 178, [],
3429    [InitBasicFS, Always, TestRun (
3430       [["fallocate"; "/swap"; "8388608"];
3431        ["mkswap_file"; "/swap"]])],
3432    "create a swap file",
3433    "\
3434 Create a swap file.
3435
3436 This command just writes a swap file signature to an existing
3437 file.  To create the file itself, use something like C<guestfs_fallocate>.");
3438
3439   ("inotify_init", (RErr, [Int "maxevents"]), 179, [Optional "inotify"],
3440    [InitISOFS, Always, TestRun (
3441       [["inotify_init"; "0"]])],
3442    "create an inotify handle",
3443    "\
3444 This command creates a new inotify handle.
3445 The inotify subsystem can be used to notify events which happen to
3446 objects in the guest filesystem.
3447
3448 C<maxevents> is the maximum number of events which will be
3449 queued up between calls to C<guestfs_inotify_read> or
3450 C<guestfs_inotify_files>.
3451 If this is passed as C<0>, then the kernel (or previously set)
3452 default is used.  For Linux 2.6.29 the default was 16384 events.
3453 Beyond this limit, the kernel throws away events, but records
3454 the fact that it threw them away by setting a flag
3455 C<IN_Q_OVERFLOW> in the returned structure list (see
3456 C<guestfs_inotify_read>).
3457
3458 Before any events are generated, you have to add some
3459 watches to the internal watch list.  See:
3460 C<guestfs_inotify_add_watch>,
3461 C<guestfs_inotify_rm_watch> and
3462 C<guestfs_inotify_watch_all>.
3463
3464 Queued up events should be read periodically by calling
3465 C<guestfs_inotify_read>
3466 (or C<guestfs_inotify_files> which is just a helpful
3467 wrapper around C<guestfs_inotify_read>).  If you don't
3468 read the events out often enough then you risk the internal
3469 queue overflowing.
3470
3471 The handle should be closed after use by calling
3472 C<guestfs_inotify_close>.  This also removes any
3473 watches automatically.
3474
3475 See also L<inotify(7)> for an overview of the inotify interface
3476 as exposed by the Linux kernel, which is roughly what we expose
3477 via libguestfs.  Note that there is one global inotify handle
3478 per libguestfs instance.");
3479
3480   ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"]), 180, [Optional "inotify"],
3481    [InitBasicFS, Always, TestOutputList (
3482       [["inotify_init"; "0"];
3483        ["inotify_add_watch"; "/"; "1073741823"];
3484        ["touch"; "/a"];
3485        ["touch"; "/b"];
3486        ["inotify_files"]], ["a"; "b"])],
3487    "add an inotify watch",
3488    "\
3489 Watch C<path> for the events listed in C<mask>.
3490
3491 Note that if C<path> is a directory then events within that
3492 directory are watched, but this does I<not> happen recursively
3493 (in subdirectories).
3494
3495 Note for non-C or non-Linux callers: the inotify events are
3496 defined by the Linux kernel ABI and are listed in
3497 C</usr/include/sys/inotify.h>.");
3498
3499   ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"]), 181, [Optional "inotify"],
3500    [],
3501    "remove an inotify watch",
3502    "\
3503 Remove a previously defined inotify watch.
3504 See C<guestfs_inotify_add_watch>.");
3505
3506   ("inotify_read", (RStructList ("events", "inotify_event"), []), 182, [Optional "inotify"],
3507    [],
3508    "return list of inotify events",
3509    "\
3510 Return the complete queue of events that have happened
3511 since the previous read call.
3512
3513 If no events have happened, this returns an empty list.
3514
3515 I<Note>: In order to make sure that all events have been
3516 read, you must call this function repeatedly until it
3517 returns an empty list.  The reason is that the call will
3518 read events up to the maximum appliance-to-host message
3519 size and leave remaining events in the queue.");
3520
3521   ("inotify_files", (RStringList "paths", []), 183, [Optional "inotify"],
3522    [],
3523    "return list of watched files that had events",
3524    "\
3525 This function is a helpful wrapper around C<guestfs_inotify_read>
3526 which just returns a list of pathnames of objects that were
3527 touched.  The returned pathnames are sorted and deduplicated.");
3528
3529   ("inotify_close", (RErr, []), 184, [Optional "inotify"],
3530    [],
3531    "close the inotify handle",
3532    "\
3533 This closes the inotify handle which was previously
3534 opened by inotify_init.  It removes all watches, throws
3535 away any pending events, and deallocates all resources.");
3536
3537   ("setcon", (RErr, [String "context"]), 185, [Optional "selinux"],
3538    [],
3539    "set SELinux security context",
3540    "\
3541 This sets the SELinux security context of the daemon
3542 to the string C<context>.
3543
3544 See the documentation about SELINUX in L<guestfs(3)>.");
3545
3546   ("getcon", (RString "context", []), 186, [Optional "selinux"],
3547    [],
3548    "get SELinux security context",
3549    "\
3550 This gets the SELinux security context of the daemon.
3551
3552 See the documentation about SELINUX in L<guestfs(3)>,
3553 and C<guestfs_setcon>");
3554
3555   ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"]), 187, [],
3556    [InitEmpty, Always, TestOutput (
3557       [["part_disk"; "/dev/sda"; "mbr"];
3558        ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
3559        ["mount"; "/dev/sda1"; "/"];
3560        ["write_file"; "/new"; "new file contents"; "0"];
3561        ["cat"; "/new"]], "new file contents")],
3562    "make a filesystem with block size",
3563    "\
3564 This call is similar to C<guestfs_mkfs>, but it allows you to
3565 control the block size of the resulting filesystem.  Supported
3566 block sizes depend on the filesystem type, but typically they
3567 are C<1024>, C<2048> or C<4096> only.");
3568
3569   ("mke2journal", (RErr, [Int "blocksize"; Device "device"]), 188, [],
3570    [InitEmpty, Always, TestOutput (
3571       [["sfdiskM"; "/dev/sda"; ",100 ,"];
3572        ["mke2journal"; "4096"; "/dev/sda1"];
3573        ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
3574        ["mount"; "/dev/sda2"; "/"];
3575        ["write_file"; "/new"; "new file contents"; "0"];
3576        ["cat"; "/new"]], "new file contents")],
3577    "make ext2/3/4 external journal",
3578    "\
3579 This creates an ext2 external journal on C<device>.  It is equivalent
3580 to the command:
3581
3582  mke2fs -O journal_dev -b blocksize device");
3583
3584   ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"]), 189, [],
3585    [InitEmpty, Always, TestOutput (
3586       [["sfdiskM"; "/dev/sda"; ",100 ,"];
3587        ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
3588        ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
3589        ["mount"; "/dev/sda2"; "/"];
3590        ["write_file"; "/new"; "new file contents"; "0"];
3591        ["cat"; "/new"]], "new file contents")],
3592    "make ext2/3/4 external journal with label",
3593    "\
3594 This creates an ext2 external journal on C<device> with label C<label>.");
3595
3596   ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"]), 190, [Optional "linuxfsuuid"],
3597    (let uuid = uuidgen () in
3598     [InitEmpty, Always, TestOutput (
3599        [["sfdiskM"; "/dev/sda"; ",100 ,"];
3600         ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
3601         ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
3602         ["mount"; "/dev/sda2"; "/"];
3603         ["write_file"; "/new"; "new file contents"; "0"];
3604         ["cat"; "/new"]], "new file contents")]),
3605    "make ext2/3/4 external journal with UUID",
3606    "\
3607 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
3608
3609   ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"]), 191, [],
3610    [],
3611    "make ext2/3/4 filesystem with external journal",
3612    "\
3613 This creates an ext2/3/4 filesystem on C<device> with
3614 an external journal on C<journal>.  It is equivalent
3615 to the command:
3616
3617  mke2fs -t fstype -b blocksize -J device=<journal> <device>
3618
3619 See also C<guestfs_mke2journal>.");
3620
3621   ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"]), 192, [],
3622    [],
3623    "make ext2/3/4 filesystem with external journal",
3624    "\
3625 This creates an ext2/3/4 filesystem on C<device> with
3626 an external journal on the journal labeled C<label>.
3627
3628 See also C<guestfs_mke2journal_L>.");
3629
3630   ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"]), 193, [Optional "linuxfsuuid"],
3631    [],
3632    "make ext2/3/4 filesystem with external journal",
3633    "\
3634 This creates an ext2/3/4 filesystem on C<device> with
3635 an external journal on the journal with UUID C<uuid>.
3636
3637 See also C<guestfs_mke2journal_U>.");
3638
3639   ("modprobe", (RErr, [String "modulename"]), 194, [Optional "linuxmodules"],
3640    [InitNone, Always, TestRun [["modprobe"; "fat"]]],
3641    "load a kernel module",
3642    "\
3643 This loads a kernel module in the appliance.
3644
3645 The kernel module must have been whitelisted when libguestfs
3646 was built (see C<appliance/kmod.whitelist.in> in the source).");
3647
3648   ("echo_daemon", (RString "output", [StringList "words"]), 195, [],
3649    [InitNone, Always, TestOutput (
3650       [["echo_daemon"; "This is a test"]], "This is a test"
3651     )],
3652    "echo arguments back to the client",
3653    "\
3654 This command concatenate the list of C<words> passed with single spaces between
3655 them and returns the resulting string.
3656
3657 You can use this command to test the connection through to the daemon.
3658
3659 See also C<guestfs_ping_daemon>.");
3660
3661   ("find0", (RErr, [Pathname "directory"; FileOut "files"]), 196, [],
3662    [], (* There is a regression test for this. *)
3663    "find all files and directories, returning NUL-separated list",
3664    "\
3665 This command lists out all files and directories, recursively,
3666 starting at C<directory>, placing the resulting list in the
3667 external file called C<files>.
3668
3669 This command works the same way as C<guestfs_find> with the
3670 following exceptions:
3671
3672 =over 4
3673
3674 =item *
3675
3676 The resulting list is written to an external file.
3677
3678 =item *
3679
3680 Items (filenames) in the result are separated
3681 by C<\\0> characters.  See L<find(1)> option I<-print0>.
3682
3683 =item *
3684
3685 This command is not limited in the number of names that it
3686 can return.
3687
3688 =item *
3689
3690 The result list is not sorted.
3691
3692 =back");
3693
3694   ("case_sensitive_path", (RString "rpath", [Pathname "path"]), 197, [],
3695    [InitISOFS, Always, TestOutput (
3696       [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
3697     InitISOFS, Always, TestOutput (
3698       [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
3699     InitISOFS, Always, TestOutput (
3700       [["case_sensitive_path"; "/Known-1"]], "/known-1");
3701     InitISOFS, Always, TestLastFail (
3702       [["case_sensitive_path"; "/Known-1/"]]);
3703     InitBasicFS, Always, TestOutput (
3704       [["mkdir"; "/a"];
3705        ["mkdir"; "/a/bbb"];
3706        ["touch"; "/a/bbb/c"];
3707        ["case_sensitive_path"; "/A/bbB/C"]], "/a/bbb/c");
3708     InitBasicFS, Always, TestOutput (
3709       [["mkdir"; "/a"];
3710        ["mkdir"; "/a/bbb"];
3711        ["touch"; "/a/bbb/c"];
3712        ["case_sensitive_path"; "/A////bbB/C"]], "/a/bbb/c");
3713     InitBasicFS, Always, TestLastFail (
3714       [["mkdir"; "/a"];
3715        ["mkdir"; "/a/bbb"];
3716        ["touch"; "/a/bbb/c"];
3717        ["case_sensitive_path"; "/A/bbb/../bbb/C"]])],
3718    "return true path on case-insensitive filesystem",
3719    "\
3720 This can be used to resolve case insensitive paths on
3721 a filesystem which is case sensitive.  The use case is
3722 to resolve paths which you have read from Windows configuration
3723 files or the Windows Registry, to the true path.
3724
3725 The command handles a peculiarity of the Linux ntfs-3g
3726 filesystem driver (and probably others), which is that although
3727 the underlying filesystem is case-insensitive, the driver
3728 exports the filesystem to Linux as case-sensitive.
3729
3730 One consequence of this is that special directories such
3731 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
3732 (or other things) depending on the precise details of how
3733 they were created.  In Windows itself this would not be
3734 a problem.
3735
3736 Bug or feature?  You decide:
3737 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
3738
3739 This function resolves the true case of each element in the
3740 path and returns the case-sensitive path.
3741
3742 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
3743 might return C<\"/WINDOWS/system32\"> (the exact return value
3744 would depend on details of how the directories were originally
3745 created under Windows).
3746
3747 I<Note>:
3748 This function does not handle drive names, backslashes etc.
3749
3750 See also C<guestfs_realpath>.");
3751
3752   ("vfs_type", (RString "fstype", [Device "device"]), 198, [],
3753    [InitBasicFS, Always, TestOutput (
3754       [["vfs_type"; "/dev/sda1"]], "ext2")],
3755    "get the Linux VFS type corresponding to a mounted device",
3756    "\
3757 This command gets the block device type corresponding to
3758 a mounted device called C<device>.
3759
3760 Usually the result is the name of the Linux VFS module that
3761 is used to mount this device (probably determined automatically
3762 if you used the C<guestfs_mount> call).");
3763
3764   ("truncate", (RErr, [Pathname "path"]), 199, [],
3765    [InitBasicFS, Always, TestOutputStruct (
3766       [["write_file"; "/test"; "some stuff so size is not zero"; "0"];
3767        ["truncate"; "/test"];
3768        ["stat"; "/test"]], [CompareWithInt ("size", 0)])],
3769    "truncate a file to zero size",
3770    "\
3771 This command truncates C<path> to a zero-length file.  The
3772 file must exist already.");
3773
3774   ("truncate_size", (RErr, [Pathname "path"; Int64 "size"]), 200, [],
3775    [InitBasicFS, Always, TestOutputStruct (
3776       [["touch"; "/test"];
3777        ["truncate_size"; "/test"; "1000"];
3778        ["stat"; "/test"]], [CompareWithInt ("size", 1000)])],
3779    "truncate a file to a particular size",
3780    "\
3781 This command truncates C<path> to size C<size> bytes.  The file
3782 must exist already.  If the file is smaller than C<size> then
3783 the file is extended to the required size with null bytes.");
3784
3785   ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"]), 201, [],
3786    [InitBasicFS, Always, TestOutputStruct (
3787       [["touch"; "/test"];
3788        ["utimens"; "/test"; "12345"; "67890"; "9876"; "5432"];
3789        ["stat"; "/test"]], [CompareWithInt ("mtime", 9876)])],
3790    "set timestamp of a file with nanosecond precision",
3791    "\
3792 This command sets the timestamps of a file with nanosecond
3793 precision.
3794
3795 C<atsecs, atnsecs> are the last access time (atime) in secs and
3796 nanoseconds from the epoch.
3797
3798 C<mtsecs, mtnsecs> are the last modification time (mtime) in
3799 secs and nanoseconds from the epoch.
3800
3801 If the C<*nsecs> field contains the special value C<-1> then
3802 the corresponding timestamp is set to the current time.  (The
3803 C<*secs> field is ignored in this case).
3804
3805 If the C<*nsecs> field contains the special value C<-2> then
3806 the corresponding timestamp is left unchanged.  (The
3807 C<*secs> field is ignored in this case).");
3808
3809   ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"]), 202, [],
3810    [InitBasicFS, Always, TestOutputStruct (
3811       [["mkdir_mode"; "/test"; "0o111"];
3812        ["stat"; "/test"]], [CompareWithInt ("mode", 0o40111)])],
3813    "create a directory with a particular mode",
3814    "\
3815 This command creates a directory, setting the initial permissions
3816 of the directory to C<mode>.  See also C<guestfs_mkdir>.");
3817
3818   ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"]), 203, [],
3819    [], (* XXX *)
3820    "change file owner and group",
3821    "\
3822 Change the file owner to C<owner> and group to C<group>.
3823 This is like C<guestfs_chown> but if C<path> is a symlink then
3824 the link itself is changed, not the target.
3825
3826 Only numeric uid and gid are supported.  If you want to use
3827 names, you will need to locate and parse the password file
3828 yourself (Augeas support makes this relatively easy).");
3829
3830   ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"]), 204, [],
3831    [], (* XXX *)
3832    "lstat on multiple files",
3833    "\
3834 This call allows you to perform the C<guestfs_lstat> operation
3835 on multiple files, where all files are in the directory C<path>.
3836 C<names> is the list of files from this directory.
3837
3838 On return you get a list of stat structs, with a one-to-one
3839 correspondence to the C<names> list.  If any name did not exist
3840 or could not be lstat'd, then the C<ino> field of that structure
3841 is set to C<-1>.
3842
3843 This call is intended for programs that want to efficiently
3844 list a directory contents without making many round-trips.
3845 See also C<guestfs_lxattrlist> for a similarly efficient call
3846 for getting extended attributes.  Very long directory listings
3847 might cause the protocol message size to be exceeded, causing
3848 this call to fail.  The caller must split up such requests
3849 into smaller groups of names.");
3850
3851   ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"]), 205, [Optional "linuxxattrs"],
3852    [], (* XXX *)
3853    "lgetxattr on multiple files",
3854    "\
3855 This call allows you to get the extended attributes
3856 of multiple files, where all files are in the directory C<path>.
3857 C<names> is the list of files from this directory.
3858
3859 On return you get a flat list of xattr structs which must be
3860 interpreted sequentially.  The first xattr struct always has a zero-length
3861 C<attrname>.  C<attrval> in this struct is zero-length
3862 to indicate there was an error doing C<lgetxattr> for this
3863 file, I<or> is a C string which is a decimal number
3864 (the number of following attributes for this file, which could
3865 be C<\"0\">).  Then after the first xattr struct are the
3866 zero or more attributes for the first named file.
3867 This repeats for the second and subsequent files.
3868
3869 This call is intended for programs that want to efficiently
3870 list a directory contents without making many round-trips.
3871 See also C<guestfs_lstatlist> for a similarly efficient call
3872 for getting standard stats.  Very long directory listings
3873 might cause the protocol message size to be exceeded, causing
3874 this call to fail.  The caller must split up such requests
3875 into smaller groups of names.");
3876
3877   ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"]), 206, [],
3878    [], (* XXX *)
3879    "readlink on multiple files",
3880    "\
3881 This call allows you to do a C<readlink> operation
3882 on multiple files, where all files are in the directory C<path>.
3883 C<names> is the list of files from this directory.
3884
3885 On return you get a list of strings, with a one-to-one
3886 correspondence to the C<names> list.  Each string is the
3887 value of the symbol link.
3888
3889 If the C<readlink(2)> operation fails on any name, then
3890 the corresponding result string is the empty string C<\"\">.
3891 However the whole operation is completed even if there
3892 were C<readlink(2)> errors, and so you can call this
3893 function with names where you don't know if they are
3894 symbolic links already (albeit slightly less efficient).
3895
3896 This call is intended for programs that want to efficiently
3897 list a directory contents without making many round-trips.
3898 Very long directory listings might cause the protocol
3899 message size to be exceeded, causing
3900 this call to fail.  The caller must split up such requests
3901 into smaller groups of names.");
3902
3903   ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"]), 207, [ProtocolLimitWarning],
3904    [InitISOFS, Always, TestOutputBuffer (
3905       [["pread"; "/known-4"; "1"; "3"]], "\n");
3906     InitISOFS, Always, TestOutputBuffer (
3907       [["pread"; "/empty"; "0"; "100"]], "")],
3908    "read part of a file",
3909    "\
3910 This command lets you read part of a file.  It reads C<count>
3911 bytes of the file, starting at C<offset>, from file C<path>.
3912
3913 This may read fewer bytes than requested.  For further details
3914 see the L<pread(2)> system call.");
3915
3916   ("part_init", (RErr, [Device "device"; String "parttype"]), 208, [],
3917    [InitEmpty, Always, TestRun (
3918       [["part_init"; "/dev/sda"; "gpt"]])],
3919    "create an empty partition table",
3920    "\
3921 This creates an empty partition table on C<device> of one of the
3922 partition types listed below.  Usually C<parttype> should be
3923 either C<msdos> or C<gpt> (for large disks).
3924
3925 Initially there are no partitions.  Following this, you should
3926 call C<guestfs_part_add> for each partition required.
3927
3928 Possible values for C<parttype> are:
3929
3930 =over 4
3931
3932 =item B<efi> | B<gpt>
3933
3934 Intel EFI / GPT partition table.
3935
3936 This is recommended for >= 2 TB partitions that will be accessed
3937 from Linux and Intel-based Mac OS X.  It also has limited backwards
3938 compatibility with the C<mbr> format.
3939
3940 =item B<mbr> | B<msdos>
3941
3942 The standard PC \"Master Boot Record\" (MBR) format used
3943 by MS-DOS and Windows.  This partition type will B<only> work
3944 for device sizes up to 2 TB.  For large disks we recommend
3945 using C<gpt>.
3946
3947 =back
3948
3949 Other partition table types that may work but are not
3950 supported include:
3951
3952 =over 4
3953
3954 =item B<aix>
3955
3956 AIX disk labels.
3957
3958 =item B<amiga> | B<rdb>
3959
3960 Amiga \"Rigid Disk Block\" format.
3961
3962 =item B<bsd>
3963
3964 BSD disk labels.
3965
3966 =item B<dasd>
3967
3968 DASD, used on IBM mainframes.
3969
3970 =item B<dvh>
3971
3972 MIPS/SGI volumes.
3973
3974 =item B<mac>
3975
3976 Old Mac partition format.  Modern Macs use C<gpt>.
3977
3978 =item B<pc98>
3979
3980 NEC PC-98 format, common in Japan apparently.
3981
3982 =item B<sun>
3983
3984 Sun disk labels.
3985
3986 =back");
3987
3988   ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"]), 209, [],
3989    [InitEmpty, Always, TestRun (
3990       [["part_init"; "/dev/sda"; "mbr"];
3991        ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
3992     InitEmpty, Always, TestRun (
3993       [["part_init"; "/dev/sda"; "gpt"];
3994        ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
3995        ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
3996     InitEmpty, Always, TestRun (
3997       [["part_init"; "/dev/sda"; "mbr"];
3998        ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
3999        ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4000        ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4001        ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4002    "add a partition to the device",
4003    "\
4004 This command adds a partition to C<device>.  If there is no partition
4005 table on the device, call C<guestfs_part_init> first.
4006
4007 The C<prlogex> parameter is the type of partition.  Normally you
4008 should pass C<p> or C<primary> here, but MBR partition tables also
4009 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4010 types.
4011
4012 C<startsect> and C<endsect> are the start and end of the partition
4013 in I<sectors>.  C<endsect> may be negative, which means it counts
4014 backwards from the end of the disk (C<-1> is the last sector).
4015
4016 Creating a partition which covers the whole disk is not so easy.
4017 Use C<guestfs_part_disk> to do that.");
4018
4019   ("part_disk", (RErr, [Device "device"; String "parttype"]), 210, [DangerWillRobinson],
4020    [InitEmpty, Always, TestRun (
4021       [["part_disk"; "/dev/sda"; "mbr"]]);
4022     InitEmpty, Always, TestRun (
4023       [["part_disk"; "/dev/sda"; "gpt"]])],
4024    "partition whole disk with a single primary partition",
4025    "\
4026 This command is simply a combination of C<guestfs_part_init>
4027 followed by C<guestfs_part_add> to create a single primary partition
4028 covering the whole disk.
4029
4030 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
4031 but other possible values are described in C<guestfs_part_init>.");
4032
4033   ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"]), 211, [],
4034    [InitEmpty, Always, TestRun (
4035       [["part_disk"; "/dev/sda"; "mbr"];
4036        ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
4037    "make a partition bootable",
4038    "\
4039 This sets the bootable flag on partition numbered C<partnum> on
4040 device C<device>.  Note that partitions are numbered from 1.
4041
4042 The bootable flag is used by some PC BIOSes to determine which
4043 partition to boot from.  It is by no means universally recognized,
4044 and in any case if your operating system installed a boot
4045 sector on the device itself, then that takes precedence.");
4046
4047   ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"]), 212, [],
4048    [InitEmpty, Always, TestRun (
4049       [["part_disk"; "/dev/sda"; "gpt"];
4050        ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
4051    "set partition name",
4052    "\
4053 This sets the partition name on partition numbered C<partnum> on
4054 device C<device>.  Note that partitions are numbered from 1.
4055
4056 The partition name can only be set on certain types of partition
4057 table.  This works on C<gpt> but not on C<mbr> partitions.");
4058
4059   ("part_list", (RStructList ("partitions", "partition"), [Device "device"]), 213, [],
4060    [], (* XXX Add a regression test for this. *)
4061    "list partitions on a device",
4062    "\
4063 This command parses the partition table on C<device> and
4064 returns the list of partitions found.
4065
4066 The fields in the returned structure are:
4067
4068 =over 4
4069
4070 =item B<part_num>
4071
4072 Partition number, counting from 1.
4073
4074 =item B<part_start>
4075
4076 Start of the partition I<in bytes>.  To get sectors you have to
4077 divide by the device's sector size, see C<guestfs_blockdev_getss>.
4078
4079 =item B<part_end>
4080
4081 End of the partition in bytes.
4082
4083 =item B<part_size>
4084
4085 Size of the partition in bytes.
4086
4087 =back");
4088
4089   ("part_get_parttype", (RString "parttype", [Device "device"]), 214, [],
4090    [InitEmpty, Always, TestOutput (
4091       [["part_disk"; "/dev/sda"; "gpt"];
4092        ["part_get_parttype"; "/dev/sda"]], "gpt")],
4093    "get the partition table type",
4094    "\
4095 This command examines the partition table on C<device> and
4096 returns the partition table type (format) being used.
4097
4098 Common return values include: C<msdos> (a DOS/Windows style MBR
4099 partition table), C<gpt> (a GPT/EFI-style partition table).  Other
4100 values are possible, although unusual.  See C<guestfs_part_init>
4101 for a full list.");
4102
4103   ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"]), 215, [],
4104    [InitBasicFS, Always, TestOutputBuffer (
4105       [["fill"; "0x63"; "10"; "/test"];
4106        ["read_file"; "/test"]], "cccccccccc")],
4107    "fill a file with octets",
4108    "\
4109 This command creates a new file called C<path>.  The initial
4110 content of the file is C<len> octets of C<c>, where C<c>
4111 must be a number in the range C<[0..255]>.
4112
4113 To fill a file with zero bytes (sparsely), it is
4114 much more efficient to use C<guestfs_truncate_size>.");
4115
4116   ("available", (RErr, [StringList "groups"]), 216, [],
4117    [InitNone, Always, TestRun [["available"; ""]]],
4118    "test availability of some parts of the API",
4119    "\
4120 This command is used to check the availability of some
4121 groups of functionality in the appliance, which not all builds of
4122 the libguestfs appliance will be able to provide.
4123
4124 The libguestfs groups, and the functions that those
4125 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
4126
4127 The argument C<groups> is a list of group names, eg:
4128 C<[\"inotify\", \"augeas\"]> would check for the availability of
4129 the Linux inotify functions and Augeas (configuration file
4130 editing) functions.
4131
4132 The command returns no error if I<all> requested groups are available.
4133
4134 It fails with an error if one or more of the requested
4135 groups is unavailable in the appliance.
4136
4137 If an unknown group name is included in the
4138 list of groups then an error is always returned.
4139
4140 I<Notes:>
4141
4142 =over 4
4143
4144 =item *
4145
4146 You must call C<guestfs_launch> before calling this function.
4147
4148 The reason is because we don't know what groups are
4149 supported by the appliance/daemon until it is running and can
4150 be queried.
4151
4152 =item *
4153
4154 If a group of functions is available, this does not necessarily
4155 mean that they will work.  You still have to check for errors
4156 when calling individual API functions even if they are
4157 available.
4158
4159 =item *
4160
4161 It is usually the job of distro packagers to build
4162 complete functionality into the libguestfs appliance.
4163 Upstream libguestfs, if built from source with all
4164 requirements satisfied, will support everything.
4165
4166 =item *
4167
4168 This call was added in version C<1.0.80>.  In previous
4169 versions of libguestfs all you could do would be to speculatively
4170 execute a command to find out if the daemon implemented it.
4171 See also C<guestfs_version>.
4172
4173 =back");
4174
4175   ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"]), 217, [],
4176    [InitBasicFS, Always, TestOutputBuffer (
4177       [["write_file"; "/src"; "hello, world"; "0"];
4178        ["dd"; "/src"; "/dest"];
4179        ["read_file"; "/dest"]], "hello, world")],
4180    "copy from source to destination using dd",
4181    "\
4182 This command copies from one source device or file C<src>
4183 to another destination device or file C<dest>.  Normally you
4184 would use this to copy to or from a device or partition, for
4185 example to duplicate a filesystem.
4186
4187 If the destination is a device, it must be as large or larger
4188 than the source file or device, otherwise the copy will fail.
4189 This command cannot do partial copies.");
4190
4191 ]
4192
4193 let all_functions = non_daemon_functions @ daemon_functions
4194
4195 (* In some places we want the functions to be displayed sorted
4196  * alphabetically, so this is useful:
4197  *)
4198 let all_functions_sorted =
4199   List.sort (fun (n1,_,_,_,_,_,_) (n2,_,_,_,_,_,_) ->
4200                compare n1 n2) all_functions
4201
4202 (* Field types for structures. *)
4203 type field =
4204   | FChar                       (* C 'char' (really, a 7 bit byte). *)
4205   | FString                     (* nul-terminated ASCII string, NOT NULL. *)
4206   | FBuffer                     (* opaque buffer of bytes, (char *, int) pair *)
4207   | FUInt32
4208   | FInt32
4209   | FUInt64
4210   | FInt64
4211   | FBytes                      (* Any int measure that counts bytes. *)
4212   | FUUID                       (* 32 bytes long, NOT nul-terminated. *)
4213   | FOptPercent                 (* [0..100], or -1 meaning "not present". *)
4214
4215 (* Because we generate extra parsing code for LVM command line tools,
4216  * we have to pull out the LVM columns separately here.
4217  *)
4218 let lvm_pv_cols = [
4219   "pv_name", FString;
4220   "pv_uuid", FUUID;
4221   "pv_fmt", FString;
4222   "pv_size", FBytes;
4223   "dev_size", FBytes;
4224   "pv_free", FBytes;
4225   "pv_used", FBytes;
4226   "pv_attr", FString (* XXX *);
4227   "pv_pe_count", FInt64;
4228   "pv_pe_alloc_count", FInt64;
4229   "pv_tags", FString;
4230   "pe_start", FBytes;
4231   "pv_mda_count", FInt64;
4232   "pv_mda_free", FBytes;
4233   (* Not in Fedora 10:
4234      "pv_mda_size", FBytes;
4235   *)
4236 ]
4237 let lvm_vg_cols = [
4238   "vg_name", FString;
4239   "vg_uuid", FUUID;
4240   "vg_fmt", FString;
4241   "vg_attr", FString (* XXX *);
4242   "vg_size", FBytes;
4243   "vg_free", FBytes;
4244   "vg_sysid", FString;
4245   "vg_extent_size", FBytes;
4246   "vg_extent_count", FInt64;
4247   "vg_free_count", FInt64;
4248   "max_lv", FInt64;
4249   "max_pv", FInt64;
4250   "pv_count", FInt64;
4251   "lv_count", FInt64;
4252   "snap_count", FInt64;
4253   "vg_seqno", FInt64;
4254   "vg_tags", FString;
4255   "vg_mda_count", FInt64;
4256   "vg_mda_free", FBytes;
4257   (* Not in Fedora 10:
4258      "vg_mda_size", FBytes;
4259   *)
4260 ]
4261 let lvm_lv_cols = [
4262   "lv_name", FString;
4263   "lv_uuid", FUUID;
4264   "lv_attr", FString (* XXX *);
4265   "lv_major", FInt64;
4266   "lv_minor", FInt64;
4267   "lv_kernel_major", FInt64;
4268   "lv_kernel_minor", FInt64;
4269   "lv_size", FBytes;
4270   "seg_count", FInt64;
4271   "origin", FString;
4272   "snap_percent", FOptPercent;
4273   "copy_percent", FOptPercent;
4274   "move_pv", FString;
4275   "lv_tags", FString;
4276   "mirror_log", FString;
4277   "modules", FString;
4278 ]
4279
4280 (* Names and fields in all structures (in RStruct and RStructList)
4281  * that we support.
4282  *)
4283 let structs = [
4284   (* The old RIntBool return type, only ever used for aug_defnode.  Do
4285    * not use this struct in any new code.
4286    *)
4287   "int_bool", [
4288     "i", FInt32;                (* for historical compatibility *)
4289     "b", FInt32;                (* for historical compatibility *)
4290   ];
4291
4292   (* LVM PVs, VGs, LVs. *)
4293   "lvm_pv", lvm_pv_cols;
4294   "lvm_vg", lvm_vg_cols;
4295   "lvm_lv", lvm_lv_cols;
4296
4297   (* Column names and types from stat structures.
4298    * NB. Can't use things like 'st_atime' because glibc header files
4299    * define some of these as macros.  Ugh.
4300    *)
4301   "stat", [
4302     "dev", FInt64;
4303     "ino", FInt64;
4304     "mode", FInt64;
4305     "nlink", FInt64;
4306     "uid", FInt64;
4307     "gid", FInt64;
4308     "rdev", FInt64;
4309     "size", FInt64;
4310     "blksize", FInt64;
4311     "blocks", FInt64;
4312     "atime", FInt64;
4313     "mtime", FInt64;
4314     "ctime", FInt64;
4315   ];
4316   "statvfs", [
4317     "bsize", FInt64;
4318     "frsize", FInt64;
4319     "blocks", FInt64;
4320     "bfree", FInt64;
4321     "bavail", FInt64;
4322     "files", FInt64;
4323     "ffree", FInt64;
4324     "favail", FInt64;
4325     "fsid", FInt64;
4326     "flag", FInt64;
4327     "namemax", FInt64;
4328   ];
4329
4330   (* Column names in dirent structure. *)
4331   "dirent", [
4332     "ino", FInt64;
4333     (* 'b' 'c' 'd' 'f' (FIFO) 'l' 'r' (regular file) 's' 'u' '?' *)
4334     "ftyp", FChar;
4335     "name", FString;
4336   ];
4337
4338   (* Version numbers. *)
4339   "version", [
4340     "major", FInt64;
4341     "minor", FInt64;
4342     "release", FInt64;
4343     "extra", FString;
4344   ];
4345
4346   (* Extended attribute. *)
4347   "xattr", [
4348     "attrname", FString;
4349     "attrval", FBuffer;
4350   ];
4351
4352   (* Inotify events. *)
4353   "inotify_event", [
4354     "in_wd", FInt64;
4355     "in_mask", FUInt32;
4356     "in_cookie", FUInt32;
4357     "in_name", FString;
4358   ];
4359
4360   (* Partition table entry. *)
4361   "partition", [
4362     "part_num", FInt32;
4363     "part_start", FBytes;
4364     "part_end", FBytes;
4365     "part_size", FBytes;
4366   ];
4367 ] (* end of structs *)
4368
4369 (* Ugh, Java has to be different ..
4370  * These names are also used by the Haskell bindings.
4371  *)
4372 let java_structs = [
4373   "int_bool", "IntBool";
4374   "lvm_pv", "PV";
4375   "lvm_vg", "VG";
4376   "lvm_lv", "LV";
4377   "stat", "Stat";
4378   "statvfs", "StatVFS";
4379   "dirent", "Dirent";
4380   "version", "Version";
4381   "xattr", "XAttr";
4382   "inotify_event", "INotifyEvent";
4383   "partition", "Partition";
4384 ]
4385
4386 (* What structs are actually returned. *)
4387 type rstructs_used_t = RStructOnly | RStructListOnly | RStructAndList
4388
4389 (* Returns a list of RStruct/RStructList structs that are returned
4390  * by any function.  Each element of returned list is a pair:
4391  *
4392  * (structname, RStructOnly)
4393  *    == there exists function which returns RStruct (_, structname)
4394  * (structname, RStructListOnly)
4395  *    == there exists function which returns RStructList (_, structname)
4396  * (structname, RStructAndList)
4397  *    == there are functions returning both RStruct (_, structname)
4398  *                                      and RStructList (_, structname)
4399  *)
4400 let rstructs_used_by functions =
4401   (* ||| is a "logical OR" for rstructs_used_t *)
4402   let (|||) a b =
4403     match a, b with
4404     | RStructAndList, _
4405     | _, RStructAndList -> RStructAndList
4406     | RStructOnly, RStructListOnly
4407     | RStructListOnly, RStructOnly -> RStructAndList
4408     | RStructOnly, RStructOnly -> RStructOnly
4409     | RStructListOnly, RStructListOnly -> RStructListOnly
4410   in
4411
4412   let h = Hashtbl.create 13 in
4413
4414   (* if elem->oldv exists, update entry using ||| operator,
4415    * else just add elem->newv to the hash
4416    *)
4417   let update elem newv =
4418     try  let oldv = Hashtbl.find h elem in