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