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