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