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