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