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