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