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