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