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