3 * Copyright (C) 2009 Red Hat Inc.
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.
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.
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
20 (* This script generates a large amount of code and documentation for
21 * all the daemon actions.
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.
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.
31 * IMPORTANT: This script should NOT print any warnings. If it prints
32 * warnings, you should treat them as errors.
40 type style = ret * args
42 (* "RErr" as a return value means an int used as a simple error
43 * indication, ie. 0 or -1.
47 (* "RInt" as a return value means an int which is -1 for error
48 * or any value >= 0 on success. Only use this for smallish
49 * positive ints (0 <= i < 2^30).
53 (* "RInt64" is the same as RInt, but is guaranteed to be able
54 * to return a full 64 bit value, _except_ that -1 means error
55 * (so -1 cannot be a valid, non-error return value).
59 (* "RBool" is a bool return value which can be true/false or
64 (* "RConstString" is a string that refers to a constant value.
65 * The return value must NOT be NULL (since NULL indicates
68 * Try to avoid using this. In particular you cannot use this
69 * for values returned from the daemon, because there is no
70 * thread-safe way to return them in the C API.
72 | RConstString of string
74 (* "RConstOptString" is an even more broken version of
75 * "RConstString". The returned string may be NULL and there
76 * is no way to return an error indication. Avoid using this!
78 | RConstOptString of string
80 (* "RString" is a returned string. It must NOT be NULL, since
81 * a NULL return indicates an error. The caller frees this.
85 (* "RStringList" is a list of strings. No string in the list
86 * can be NULL. The caller frees the strings and the array.
88 | RStringList of string
90 (* "RStruct" is a function which returns a single named structure
91 * or an error indication (in C, a struct, and in other languages
92 * with varying representations, but usually very efficient). See
93 * after the function list below for the structures.
95 | RStruct of string * string (* name of retval, name of struct *)
97 (* "RStructList" is a function which returns either a list/array
98 * of structures (could be zero-length), or an error indication.
100 | RStructList of string * string (* name of retval, name of struct *)
102 (* Key-value pairs of untyped strings. Turns into a hashtable or
103 * dictionary in languages which support it. DON'T use this as a
104 * general "bucket" for results. Prefer a stronger typed return
105 * value if one is available, or write a custom struct. Don't use
106 * this if the list could potentially be very long, since it is
107 * inefficient. Keys should be unique. NULLs are not permitted.
109 | RHashtable of string
111 (* "RBufferOut" is handled almost exactly like RString, but
112 * it allows the string to contain arbitrary 8 bit data including
113 * ASCII NUL. In the C API this causes an implicit extra parameter
114 * to be added of type <size_t *size_r>. The extra parameter
115 * returns the actual size of the return buffer in bytes.
117 * Other programming languages support strings with arbitrary 8 bit
120 * At the RPC layer we have to use the opaque<> type instead of
121 * string<>. Returned data is still limited to the max message
124 | RBufferOut of string
126 and args = argt list (* Function parameters, guestfs handle is implicit. *)
128 (* Note in future we should allow a "variable args" parameter as
129 * the final parameter, to allow commands like
130 * chmod mode file [file(s)...]
131 * This is not implemented yet, but many commands (such as chmod)
132 * are currently defined with the argument order keeping this future
133 * possibility in mind.
136 | String of string (* const char *name, cannot be NULL *)
137 | Device of string (* /dev device name, cannot be NULL *)
138 | Pathname of string (* file name, cannot be NULL *)
139 | Dev_or_Path of string (* /dev device name or Pathname, cannot be NULL *)
140 | OptString of string (* const char *name, may be NULL *)
141 | StringList of string(* list of strings (each string cannot be NULL) *)
142 | DeviceList of string(* list of Device names (each cannot be NULL) *)
143 | Bool of string (* boolean *)
144 | Int of string (* int (smallish ints, signed, <= 31 bits) *)
145 (* These are treated as filenames (simple string parameters) in
146 * the C API and bindings. But in the RPC protocol, we transfer
147 * the actual file content up to or down from the daemon.
148 * FileIn: local machine -> daemon (in request)
149 * FileOut: daemon -> local machine (in reply)
150 * In guestfish (only), the special name "-" means read from
151 * stdin or write to stdout.
156 (* Opaque buffer which can contain arbitrary 8 bit data.
157 * In the C API, this is expressed as <char *, int> pair.
158 * Most other languages have a string type which can contain
159 * ASCII NUL. We use whatever type is appropriate for each
161 * Buffers are limited by the total message size. To transfer
162 * large blocks of data, use FileIn/FileOut parameters instead.
163 * To return an arbitrary buffer, use RBufferOut.
169 | ProtocolLimitWarning (* display warning about protocol size limits *)
170 | DangerWillRobinson (* flags particularly dangerous commands *)
171 | FishAlias of string (* provide an alias for this cmd in guestfish *)
172 | FishAction of string (* call this function in guestfish *)
173 | NotInFish (* do not export via guestfish *)
174 | NotInDocs (* do not add this function to documentation *)
175 | DeprecatedBy of string (* function is deprecated, use .. instead *)
177 (* You can supply zero or as many tests as you want per API call.
179 * Note that the test environment has 3 block devices, of size 500MB,
180 * 50MB and 10MB (respectively /dev/sda, /dev/sdb, /dev/sdc), and
181 * a fourth ISO block device with some known files on it (/dev/sdd).
183 * Note for partitioning purposes, the 500MB device has 1015 cylinders.
184 * Number of cylinders was 63 for IDE emulated disks with precisely
185 * the same size. How exactly this is calculated is a mystery.
187 * The ISO block device (/dev/sdd) comes from images/test.iso.
189 * To be able to run the tests in a reasonable amount of time,
190 * the virtual machine and block devices are reused between tests.
191 * So don't try testing kill_subprocess :-x
193 * Between each test we blockdev-setrw, umount-all, lvm-remove-all.
195 * Don't assume anything about the previous contents of the block
196 * devices. Use 'Init*' to create some initial scenarios.
198 * You can add a prerequisite clause to any individual test. This
199 * is a run-time check, which, if it fails, causes the test to be
200 * skipped. Useful if testing a command which might not work on
201 * all variations of libguestfs builds. A test that has prerequisite
202 * of 'Always' is run unconditionally.
204 * In addition, packagers can skip individual tests by setting the
205 * environment variables: eg:
206 * SKIP_TEST_<CMD>_<NUM>=1 SKIP_TEST_COMMAND_3=1 (skips test #3 of command)
207 * SKIP_TEST_<CMD>=1 SKIP_TEST_ZEROFREE=1 (skips all zerofree tests)
209 type tests = (test_init * test_prereq * test) list
211 (* Run the command sequence and just expect nothing to fail. *)
214 (* Run the command sequence and expect the output of the final
215 * command to be the string.
217 | TestOutput of seq * string
219 (* Run the command sequence and expect the output of the final
220 * command to be the list of strings.
222 | TestOutputList of seq * string list
224 (* Run the command sequence and expect the output of the final
225 * command to be the list of block devices (could be either
226 * "/dev/sd.." or "/dev/hd.." form - we don't check the 5th
227 * character of each string).
229 | TestOutputListOfDevices of seq * string list
231 (* Run the command sequence and expect the output of the final
232 * command to be the integer.
234 | TestOutputInt of seq * int
236 (* Run the command sequence and expect the output of the final
237 * command to be <op> <int>, eg. ">=", "1".
239 | TestOutputIntOp of seq * string * int
241 (* Run the command sequence and expect the output of the final
242 * command to be a true value (!= 0 or != NULL).
244 | TestOutputTrue of seq
246 (* Run the command sequence and expect the output of the final
247 * command to be a false value (== 0 or == NULL, but not an error).
249 | TestOutputFalse of seq
251 (* Run the command sequence and expect the output of the final
252 * command to be a list of the given length (but don't care about
255 | TestOutputLength of seq * int
257 (* Run the command sequence and expect the output of the final
258 * command to be a buffer (RBufferOut), ie. string + size.
260 | TestOutputBuffer of seq * string
262 (* Run the command sequence and expect the output of the final
263 * command to be a structure.
265 | TestOutputStruct of seq * test_field_compare list
267 (* Run the command sequence and expect the final command (only)
270 | TestLastFail of seq
272 and test_field_compare =
273 | CompareWithInt of string * int
274 | CompareWithIntOp of string * string * int
275 | CompareWithString of string * string
276 | CompareFieldsIntEq of string * string
277 | CompareFieldsStrEq of string * string
279 (* Test prerequisites. *)
281 (* Test always runs. *)
284 (* Test is currently disabled - eg. it fails, or it tests some
285 * unimplemented feature.
289 (* 'string' is some C code (a function body) that should return
290 * true or false. The test will run if the code returns true.
294 (* As for 'If' but the test runs _unless_ the code returns true. *)
297 (* Some initial scenarios for testing. *)
299 (* Do nothing, block devices could contain random stuff including
300 * LVM PVs, and some filesystems might be mounted. This is usually
305 (* Block devices are empty and no filesystems are mounted. *)
308 (* /dev/sda contains a single partition /dev/sda1, with random
309 * content. /dev/sdb and /dev/sdc may have random content.
314 (* /dev/sda contains a single partition /dev/sda1, which is formatted
315 * as ext2, empty [except for lost+found] and mounted on /.
316 * /dev/sdb and /dev/sdc may have random content.
322 * /dev/sda1 (is a PV):
323 * /dev/VG/LV (size 8MB):
324 * formatted as ext2, empty [except for lost+found], mounted on /
325 * /dev/sdb and /dev/sdc may have random content.
329 (* /dev/sdd (the ISO, see images/ directory in source)
334 (* Sequence of commands for testing. *)
336 and cmd = string list
338 (* Note about long descriptions: When referring to another
339 * action, use the format C<guestfs_other> (ie. the full name of
340 * the C function). This will be replaced as appropriate in other
343 * Apart from that, long descriptions are just perldoc paragraphs.
346 (* Generate a random UUID (used in tests). *)
348 let chan = Unix.open_process_in "uuidgen" in
349 let uuid = input_line chan in
350 (match Unix.close_process_in chan with
351 | Unix.WEXITED 0 -> ()
353 failwith "uuidgen: process exited with non-zero status"
354 | Unix.WSIGNALED _ | Unix.WSTOPPED _ ->
355 failwith "uuidgen: process signalled or stopped by signal"
359 (* These test functions are used in the language binding tests. *)
361 let test_all_args = [
364 StringList "strlist";
371 let test_all_rets = [
372 (* except for RErr, which is tested thoroughly elsewhere *)
373 "test0rint", RInt "valout";
374 "test0rint64", RInt64 "valout";
375 "test0rbool", RBool "valout";
376 "test0rconststring", RConstString "valout";
377 "test0rconstoptstring", RConstOptString "valout";
378 "test0rstring", RString "valout";
379 "test0rstringlist", RStringList "valout";
380 "test0rstruct", RStruct ("valout", "lvm_pv");
381 "test0rstructlist", RStructList ("valout", "lvm_pv");
382 "test0rhashtable", RHashtable "valout";
385 let test_functions = [
386 ("test0", (RErr, test_all_args), -1, [NotInFish; NotInDocs],
388 "internal test function - do not use",
390 This is an internal test function which is used to test whether
391 the automatically generated bindings can handle every possible
392 parameter type correctly.
394 It echos the contents of each parameter to stdout.
396 You probably don't want to call this function.");
400 [(name, (ret, [String "val"]), -1, [NotInFish; NotInDocs],
402 "internal test function - do not use",
404 This is an internal test function which is used to test whether
405 the automatically generated bindings can handle every possible
406 return type correctly.
408 It converts string C<val> to the return type.
410 You probably don't want to call this function.");
411 (name ^ "err", (ret, []), -1, [NotInFish; NotInDocs],
413 "internal test function - do not use",
415 This is an internal test function which is used to test whether
416 the automatically generated bindings can handle every possible
417 return type correctly.
419 This function always returns an error.
421 You probably don't want to call this function.")]
425 (* non_daemon_functions are any functions which don't get processed
426 * in the daemon, eg. functions for setting and getting local
427 * configuration values.
430 let non_daemon_functions = test_functions @ [
431 ("launch", (RErr, []), -1, [FishAlias "run"; FishAction "launch"],
433 "launch the qemu subprocess",
435 Internally libguestfs is implemented by running a virtual machine
438 You should call this after configuring the handle
439 (eg. adding drives) but before performing any actions.");
441 ("wait_ready", (RErr, []), -1, [NotInFish],
443 "wait until the qemu subprocess launches (no op)",
445 This function is a no op.
447 In versions of the API E<lt> 1.0.71 you had to call this function
448 just after calling C<guestfs_launch> to wait for the launch
449 to complete. However this is no longer necessary because
450 C<guestfs_launch> now does the waiting.
452 If you see any calls to this function in code then you can just
453 remove them, unless you want to retain compatibility with older
454 versions of the API.");
456 ("kill_subprocess", (RErr, []), -1, [],
458 "kill the qemu subprocess",
460 This kills the qemu subprocess. You should never need to call this.");
462 ("add_drive", (RErr, [String "filename"]), -1, [FishAlias "add"],
464 "add an image to examine or modify",
466 This function adds a virtual machine disk image C<filename> to the
467 guest. The first time you call this function, the disk appears as IDE
468 disk 0 (C</dev/sda>) in the guest, the second time as C</dev/sdb>, and
471 You don't necessarily need to be root when using libguestfs. However
472 you obviously do need sufficient permissions to access the filename
473 for whatever operations you want to perform (ie. read access if you
474 just want to read the image or write access if you want to modify the
477 This is equivalent to the qemu parameter
478 C<-drive file=filename,cache=off,if=...>.
479 C<cache=off> is omitted in cases where it is not supported by
480 the underlying filesystem.
482 Note that this call checks for the existence of C<filename>. This
483 stops you from specifying other types of drive which are supported
484 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
485 the general C<guestfs_config> call instead.");
487 ("add_cdrom", (RErr, [String "filename"]), -1, [FishAlias "cdrom"],
489 "add a CD-ROM disk image to examine",
491 This function adds a virtual CD-ROM disk image to the guest.
493 This is equivalent to the qemu parameter C<-cdrom filename>.
495 Note that this call checks for the existence of C<filename>. This
496 stops you from specifying other types of drive which are supported
497 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
498 the general C<guestfs_config> call instead.");
500 ("add_drive_ro", (RErr, [String "filename"]), -1, [FishAlias "add-ro"],
502 "add a drive in snapshot mode (read-only)",
504 This adds a drive in snapshot mode, making it effectively
507 Note that writes to the device are allowed, and will be seen for
508 the duration of the guestfs handle, but they are written
509 to a temporary file which is discarded as soon as the guestfs
510 handle is closed. We don't currently have any method to enable
511 changes to be committed, although qemu can support this.
513 This is equivalent to the qemu parameter
514 C<-drive file=filename,snapshot=on,if=...>.
516 Note that this call checks for the existence of C<filename>. This
517 stops you from specifying other types of drive which are supported
518 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
519 the general C<guestfs_config> call instead.");
521 ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"]), -1, [],
523 "add qemu parameters",
525 This can be used to add arbitrary qemu command line parameters
526 of the form C<-param value>. Actually it's not quite arbitrary - we
527 prevent you from setting some parameters which would interfere with
528 parameters that we use.
530 The first character of C<param> string must be a C<-> (dash).
532 C<value> can be NULL.");
534 ("set_qemu", (RErr, [String "qemu"]), -1, [FishAlias "qemu"],
536 "set the qemu binary",
538 Set the qemu binary that we will use.
540 The default is chosen when the library was compiled by the
543 You can also override this by setting the C<LIBGUESTFS_QEMU>
544 environment variable.
546 Setting C<qemu> to C<NULL> restores the default qemu binary.");
548 ("get_qemu", (RConstString "qemu", []), -1, [],
549 [InitNone, Always, TestRun (
551 "get the qemu binary",
553 Return the current qemu binary.
555 This is always non-NULL. If it wasn't set already, then this will
556 return the default qemu binary name.");
558 ("set_path", (RErr, [String "searchpath"]), -1, [FishAlias "path"],
560 "set the search path",
562 Set the path that libguestfs searches for kernel and initrd.img.
564 The default is C<$libdir/guestfs> unless overridden by setting
565 C<LIBGUESTFS_PATH> environment variable.
567 Setting C<path> to C<NULL> restores the default path.");
569 ("get_path", (RConstString "path", []), -1, [],
570 [InitNone, Always, TestRun (
572 "get the search path",
574 Return the current search path.
576 This is always non-NULL. If it wasn't set already, then this will
577 return the default path.");
579 ("set_append", (RErr, [OptString "append"]), -1, [FishAlias "append"],
581 "add options to kernel command line",
583 This function is used to add additional options to the
584 guest kernel command line.
586 The default is C<NULL> unless overridden by setting
587 C<LIBGUESTFS_APPEND> environment variable.
589 Setting C<append> to C<NULL> means I<no> additional options
590 are passed (libguestfs always adds a few of its own).");
592 ("get_append", (RConstOptString "append", []), -1, [],
593 (* This cannot be tested with the current framework. The
594 * function can return NULL in normal operations, which the
595 * test framework interprets as an error.
598 "get the additional kernel options",
600 Return the additional kernel options which are added to the
601 guest kernel command line.
603 If C<NULL> then no options are added.");
605 ("set_autosync", (RErr, [Bool "autosync"]), -1, [FishAlias "autosync"],
609 If C<autosync> is true, this enables autosync. Libguestfs will make a
610 best effort attempt to run C<guestfs_umount_all> followed by
611 C<guestfs_sync> when the handle is closed
612 (also if the program exits without closing handles).
614 This is disabled by default (except in guestfish where it is
615 enabled by default).");
617 ("get_autosync", (RBool "autosync", []), -1, [],
618 [InitNone, Always, TestRun (
619 [["get_autosync"]])],
622 Get the autosync flag.");
624 ("set_verbose", (RErr, [Bool "verbose"]), -1, [FishAlias "verbose"],
628 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
630 Verbose messages are disabled unless the environment variable
631 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.");
633 ("get_verbose", (RBool "verbose", []), -1, [],
637 This returns the verbose messages flag.");
639 ("is_ready", (RBool "ready", []), -1, [],
640 [InitNone, Always, TestOutputTrue (
642 "is ready to accept commands",
644 This returns true iff this handle is ready to accept commands
645 (in the C<READY> state).
647 For more information on states, see L<guestfs(3)>.");
649 ("is_config", (RBool "config", []), -1, [],
650 [InitNone, Always, TestOutputFalse (
652 "is in configuration state",
654 This returns true iff this handle is being configured
655 (in the C<CONFIG> state).
657 For more information on states, see L<guestfs(3)>.");
659 ("is_launching", (RBool "launching", []), -1, [],
660 [InitNone, Always, TestOutputFalse (
661 [["is_launching"]])],
662 "is launching subprocess",
664 This returns true iff this handle is launching the subprocess
665 (in the C<LAUNCHING> state).
667 For more information on states, see L<guestfs(3)>.");
669 ("is_busy", (RBool "busy", []), -1, [],
670 [InitNone, Always, TestOutputFalse (
672 "is busy processing a command",
674 This returns true iff this handle is busy processing a command
675 (in the C<BUSY> state).
677 For more information on states, see L<guestfs(3)>.");
679 ("get_state", (RInt "state", []), -1, [],
681 "get the current state",
683 This returns the current state as an opaque integer. This is
684 only useful for printing debug and internal error messages.
686 For more information on states, see L<guestfs(3)>.");
688 ("set_memsize", (RErr, [Int "memsize"]), -1, [FishAlias "memsize"],
689 [InitNone, Always, TestOutputInt (
690 [["set_memsize"; "500"];
691 ["get_memsize"]], 500)],
692 "set memory allocated to the qemu subprocess",
694 This sets the memory size in megabytes allocated to the
695 qemu subprocess. This only has any effect if called before
698 You can also change this by setting the environment
699 variable C<LIBGUESTFS_MEMSIZE> before the handle is
702 For more information on the architecture of libguestfs,
703 see L<guestfs(3)>.");
705 ("get_memsize", (RInt "memsize", []), -1, [],
706 [InitNone, Always, TestOutputIntOp (
707 [["get_memsize"]], ">=", 256)],
708 "get memory allocated to the qemu subprocess",
710 This gets the memory size in megabytes allocated to the
713 If C<guestfs_set_memsize> was not called
714 on this handle, and if C<LIBGUESTFS_MEMSIZE> was not set,
715 then this returns the compiled-in default value for memsize.
717 For more information on the architecture of libguestfs,
718 see L<guestfs(3)>.");
720 ("get_pid", (RInt "pid", []), -1, [FishAlias "pid"],
721 [InitNone, Always, TestOutputIntOp (
722 [["get_pid"]], ">=", 1)],
723 "get PID of qemu subprocess",
725 Return the process ID of the qemu subprocess. If there is no
726 qemu subprocess, then this will return an error.
728 This is an internal call used for debugging and testing.");
730 ("version", (RStruct ("version", "version"), []), -1, [],
731 [InitNone, Always, TestOutputStruct (
732 [["version"]], [CompareWithInt ("major", 1)])],
733 "get the library version number",
735 Return the libguestfs version number that the program is linked
738 Note that because of dynamic linking this is not necessarily
739 the version of libguestfs that you compiled against. You can
740 compile the program, and then at runtime dynamically link
741 against a completely different C<libguestfs.so> library.
743 This call was added in version C<1.0.58>. In previous
744 versions of libguestfs there was no way to get the version
745 number. From C code you can use ELF weak linking tricks to find out if
746 this symbol exists (if it doesn't, then it's an earlier version).
748 The call returns a structure with four elements. The first
749 three (C<major>, C<minor> and C<release>) are numbers and
750 correspond to the usual version triplet. The fourth element
751 (C<extra>) is a string and is normally empty, but may be
752 used for distro-specific information.
754 To construct the original version string:
755 C<$major.$minor.$release$extra>
757 I<Note:> Don't use this call to test for availability
758 of features. Distro backports makes this unreliable.");
760 ("set_selinux", (RErr, [Bool "selinux"]), -1, [FishAlias "selinux"],
761 [InitNone, Always, TestOutputTrue (
762 [["set_selinux"; "true"];
764 "set SELinux enabled or disabled at appliance boot",
766 This sets the selinux flag that is passed to the appliance
767 at boot time. The default is C<selinux=0> (disabled).
769 Note that if SELinux is enabled, it is always in
770 Permissive mode (C<enforcing=0>).
772 For more information on the architecture of libguestfs,
773 see L<guestfs(3)>.");
775 ("get_selinux", (RBool "selinux", []), -1, [],
777 "get SELinux enabled flag",
779 This returns the current setting of the selinux flag which
780 is passed to the appliance at boot time. See C<guestfs_set_selinux>.
782 For more information on the architecture of libguestfs,
783 see L<guestfs(3)>.");
785 ("set_trace", (RErr, [Bool "trace"]), -1, [FishAlias "trace"],
786 [InitNone, Always, TestOutputFalse (
787 [["set_trace"; "false"];
789 "enable or disable command traces",
791 If the command trace flag is set to 1, then commands are
792 printed on stdout before they are executed in a format
793 which is very similar to the one used by guestfish. In
794 other words, you can run a program with this enabled, and
795 you will get out a script which you can feed to guestfish
796 to perform the same set of actions.
798 If you want to trace C API calls into libguestfs (and
799 other libraries) then possibly a better way is to use
800 the external ltrace(1) command.
802 Command traces are disabled unless the environment variable
803 C<LIBGUESTFS_TRACE> is defined and set to C<1>.");
805 ("get_trace", (RBool "trace", []), -1, [],
807 "get command trace enabled flag",
809 Return the command trace flag.");
811 ("set_direct", (RErr, [Bool "direct"]), -1, [FishAlias "direct"],
812 [InitNone, Always, TestOutputFalse (
813 [["set_direct"; "false"];
815 "enable or disable direct appliance mode",
817 If the direct appliance mode flag is enabled, then stdin and
818 stdout are passed directly through to the appliance once it
821 One consequence of this is that log messages aren't caught
822 by the library and handled by C<guestfs_set_log_message_callback>,
823 but go straight to stdout.
825 You probably don't want to use this unless you know what you
828 The default is disabled.");
830 ("get_direct", (RBool "direct", []), -1, [],
832 "get direct appliance mode flag",
834 Return the direct appliance mode flag.");
838 (* daemon_functions are any functions which cause some action
839 * to take place in the daemon.
842 let daemon_functions = [
843 ("mount", (RErr, [Device "device"; String "mountpoint"]), 1, [],
844 [InitEmpty, Always, TestOutput (
845 [["sfdiskM"; "/dev/sda"; ","];
846 ["mkfs"; "ext2"; "/dev/sda1"];
847 ["mount"; "/dev/sda1"; "/"];
848 ["write_file"; "/new"; "new file contents"; "0"];
849 ["cat"; "/new"]], "new file contents")],
850 "mount a guest disk at a position in the filesystem",
852 Mount a guest disk at a position in the filesystem. Block devices
853 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
854 the guest. If those block devices contain partitions, they will have
855 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
858 The rules are the same as for L<mount(2)>: A filesystem must
859 first be mounted on C</> before others can be mounted. Other
860 filesystems can only be mounted on directories which already
863 The mounted filesystem is writable, if we have sufficient permissions
864 on the underlying device.
866 The filesystem options C<sync> and C<noatime> are set with this
867 call, in order to improve reliability.");
869 ("sync", (RErr, []), 2, [],
870 [ InitEmpty, Always, TestRun [["sync"]]],
871 "sync disks, writes are flushed through to the disk image",
873 This syncs the disk, so that any writes are flushed through to the
874 underlying disk image.
876 You should always call this if you have modified a disk image, before
877 closing the handle.");
879 ("touch", (RErr, [Pathname "path"]), 3, [],
880 [InitBasicFS, Always, TestOutputTrue (
882 ["exists"; "/new"]])],
883 "update file timestamps or create a new file",
885 Touch acts like the L<touch(1)> command. It can be used to
886 update the timestamps on a file, or, if the file does not exist,
887 to create a new zero-length file.");
889 ("cat", (RString "content", [Pathname "path"]), 4, [ProtocolLimitWarning],
890 [InitISOFS, Always, TestOutput (
891 [["cat"; "/known-2"]], "abcdef\n")],
892 "list the contents of a file",
894 Return the contents of the file named C<path>.
896 Note that this function cannot correctly handle binary files
897 (specifically, files containing C<\\0> character which is treated
898 as end of string). For those you need to use the C<guestfs_read_file>
899 or C<guestfs_download> functions which have a more complex interface.");
901 ("ll", (RString "listing", [Pathname "directory"]), 5, [],
902 [], (* XXX Tricky to test because it depends on the exact format
903 * of the 'ls -l' command, which changes between F10 and F11.
905 "list the files in a directory (long format)",
907 List the files in C<directory> (relative to the root directory,
908 there is no cwd) in the format of 'ls -la'.
910 This command is mostly useful for interactive sessions. It
911 is I<not> intended that you try to parse the output string.");
913 ("ls", (RStringList "listing", [Pathname "directory"]), 6, [],
914 [InitBasicFS, Always, TestOutputList (
917 ["touch"; "/newest"];
918 ["ls"; "/"]], ["lost+found"; "new"; "newer"; "newest"])],
919 "list the files in a directory",
921 List the files in C<directory> (relative to the root directory,
922 there is no cwd). The '.' and '..' entries are not returned, but
923 hidden files are shown.
925 This command is mostly useful for interactive sessions. Programs
926 should probably use C<guestfs_readdir> instead.");
928 ("list_devices", (RStringList "devices", []), 7, [],
929 [InitEmpty, Always, TestOutputListOfDevices (
930 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
931 "list the block devices",
933 List all the block devices.
935 The full block device names are returned, eg. C</dev/sda>");
937 ("list_partitions", (RStringList "partitions", []), 8, [],
938 [InitBasicFS, Always, TestOutputListOfDevices (
939 [["list_partitions"]], ["/dev/sda1"]);
940 InitEmpty, Always, TestOutputListOfDevices (
941 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
942 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
943 "list the partitions",
945 List all the partitions detected on all block devices.
947 The full partition device names are returned, eg. C</dev/sda1>
949 This does not return logical volumes. For that you will need to
950 call C<guestfs_lvs>.");
952 ("pvs", (RStringList "physvols", []), 9, [],
953 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
954 [["pvs"]], ["/dev/sda1"]);
955 InitEmpty, Always, TestOutputListOfDevices (
956 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
957 ["pvcreate"; "/dev/sda1"];
958 ["pvcreate"; "/dev/sda2"];
959 ["pvcreate"; "/dev/sda3"];
960 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
961 "list the LVM physical volumes (PVs)",
963 List all the physical volumes detected. This is the equivalent
964 of the L<pvs(8)> command.
966 This returns a list of just the device names that contain
967 PVs (eg. C</dev/sda2>).
969 See also C<guestfs_pvs_full>.");
971 ("vgs", (RStringList "volgroups", []), 10, [],
972 [InitBasicFSonLVM, Always, TestOutputList (
974 InitEmpty, Always, TestOutputList (
975 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
976 ["pvcreate"; "/dev/sda1"];
977 ["pvcreate"; "/dev/sda2"];
978 ["pvcreate"; "/dev/sda3"];
979 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
980 ["vgcreate"; "VG2"; "/dev/sda3"];
981 ["vgs"]], ["VG1"; "VG2"])],
982 "list the LVM volume groups (VGs)",
984 List all the volumes groups detected. This is the equivalent
985 of the L<vgs(8)> command.
987 This returns a list of just the volume group names that were
988 detected (eg. C<VolGroup00>).
990 See also C<guestfs_vgs_full>.");
992 ("lvs", (RStringList "logvols", []), 11, [],
993 [InitBasicFSonLVM, Always, TestOutputList (
994 [["lvs"]], ["/dev/VG/LV"]);
995 InitEmpty, Always, TestOutputList (
996 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
997 ["pvcreate"; "/dev/sda1"];
998 ["pvcreate"; "/dev/sda2"];
999 ["pvcreate"; "/dev/sda3"];
1000 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1001 ["vgcreate"; "VG2"; "/dev/sda3"];
1002 ["lvcreate"; "LV1"; "VG1"; "50"];
1003 ["lvcreate"; "LV2"; "VG1"; "50"];
1004 ["lvcreate"; "LV3"; "VG2"; "50"];
1005 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1006 "list the LVM logical volumes (LVs)",
1008 List all the logical volumes detected. This is the equivalent
1009 of the L<lvs(8)> command.
1011 This returns a list of the logical volume device names
1012 (eg. C</dev/VolGroup00/LogVol00>).
1014 See also C<guestfs_lvs_full>.");
1016 ("pvs_full", (RStructList ("physvols", "lvm_pv"), []), 12, [],
1017 [], (* XXX how to test? *)
1018 "list the LVM physical volumes (PVs)",
1020 List all the physical volumes detected. This is the equivalent
1021 of the L<pvs(8)> command. The \"full\" version includes all fields.");
1023 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), []), 13, [],
1024 [], (* XXX how to test? *)
1025 "list the LVM volume groups (VGs)",
1027 List all the volumes groups detected. This is the equivalent
1028 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1030 ("lvs_full", (RStructList ("logvols", "lvm_lv"), []), 14, [],
1031 [], (* XXX how to test? *)
1032 "list the LVM logical volumes (LVs)",
1034 List all the logical volumes detected. This is the equivalent
1035 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1037 ("read_lines", (RStringList "lines", [Pathname "path"]), 15, [],
1038 [InitISOFS, Always, TestOutputList (
1039 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1040 InitISOFS, Always, TestOutputList (
1041 [["read_lines"; "/empty"]], [])],
1042 "read file as lines",
1044 Return the contents of the file named C<path>.
1046 The file contents are returned as a list of lines. Trailing
1047 C<LF> and C<CRLF> character sequences are I<not> returned.
1049 Note that this function cannot correctly handle binary files
1050 (specifically, files containing C<\\0> character which is treated
1051 as end of line). For those you need to use the C<guestfs_read_file>
1052 function which has a more complex interface.");
1054 ("aug_init", (RErr, [Pathname "root"; Int "flags"]), 16, [],
1055 [], (* XXX Augeas code needs tests. *)
1056 "create a new Augeas handle",
1058 Create a new Augeas handle for editing configuration files.
1059 If there was any previous Augeas handle associated with this
1060 guestfs session, then it is closed.
1062 You must call this before using any other C<guestfs_aug_*>
1065 C<root> is the filesystem root. C<root> must not be NULL,
1068 The flags are the same as the flags defined in
1069 E<lt>augeas.hE<gt>, the logical I<or> of the following
1074 =item C<AUG_SAVE_BACKUP> = 1
1076 Keep the original file with a C<.augsave> extension.
1078 =item C<AUG_SAVE_NEWFILE> = 2
1080 Save changes into a file with extension C<.augnew>, and
1081 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1083 =item C<AUG_TYPE_CHECK> = 4
1085 Typecheck lenses (can be expensive).
1087 =item C<AUG_NO_STDINC> = 8
1089 Do not use standard load path for modules.
1091 =item C<AUG_SAVE_NOOP> = 16
1093 Make save a no-op, just record what would have been changed.
1095 =item C<AUG_NO_LOAD> = 32
1097 Do not load the tree in C<guestfs_aug_init>.
1101 To close the handle, you can call C<guestfs_aug_close>.
1103 To find out more about Augeas, see L<http://augeas.net/>.");
1105 ("aug_close", (RErr, []), 26, [],
1106 [], (* XXX Augeas code needs tests. *)
1107 "close the current Augeas handle",
1109 Close the current Augeas handle and free up any resources
1110 used by it. After calling this, you have to call
1111 C<guestfs_aug_init> again before you can use any other
1112 Augeas functions.");
1114 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"]), 17, [],
1115 [], (* XXX Augeas code needs tests. *)
1116 "define an Augeas variable",
1118 Defines an Augeas variable C<name> whose value is the result
1119 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1122 On success this returns the number of nodes in C<expr>, or
1123 C<0> if C<expr> evaluates to something which is not a nodeset.");
1125 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"]), 18, [],
1126 [], (* XXX Augeas code needs tests. *)
1127 "define an Augeas node",
1129 Defines a variable C<name> whose value is the result of
1132 If C<expr> evaluates to an empty nodeset, a node is created,
1133 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1134 C<name> will be the nodeset containing that single node.
1136 On success this returns a pair containing the
1137 number of nodes in the nodeset, and a boolean flag
1138 if a node was created.");
1140 ("aug_get", (RString "val", [String "augpath"]), 19, [],
1141 [], (* XXX Augeas code needs tests. *)
1142 "look up the value of an Augeas path",
1144 Look up the value associated with C<path>. If C<path>
1145 matches exactly one node, the C<value> is returned.");
1147 ("aug_set", (RErr, [String "augpath"; String "val"]), 20, [],
1148 [], (* XXX Augeas code needs tests. *)
1149 "set Augeas path to value",
1151 Set the value associated with C<path> to C<value>.");
1153 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"]), 21, [],
1154 [], (* XXX Augeas code needs tests. *)
1155 "insert a sibling Augeas node",
1157 Create a new sibling C<label> for C<path>, inserting it into
1158 the tree before or after C<path> (depending on the boolean
1161 C<path> must match exactly one existing node in the tree, and
1162 C<label> must be a label, ie. not contain C</>, C<*> or end
1163 with a bracketed index C<[N]>.");
1165 ("aug_rm", (RInt "nrnodes", [String "augpath"]), 22, [],
1166 [], (* XXX Augeas code needs tests. *)
1167 "remove an Augeas path",
1169 Remove C<path> and all of its children.
1171 On success this returns the number of entries which were removed.");
1173 ("aug_mv", (RErr, [String "src"; String "dest"]), 23, [],
1174 [], (* XXX Augeas code needs tests. *)
1177 Move the node C<src> to C<dest>. C<src> must match exactly
1178 one node. C<dest> is overwritten if it exists.");
1180 ("aug_match", (RStringList "matches", [String "augpath"]), 24, [],
1181 [], (* XXX Augeas code needs tests. *)
1182 "return Augeas nodes which match augpath",
1184 Returns a list of paths which match the path expression C<path>.
1185 The returned paths are sufficiently qualified so that they match
1186 exactly one node in the current tree.");
1188 ("aug_save", (RErr, []), 25, [],
1189 [], (* XXX Augeas code needs tests. *)
1190 "write all pending Augeas changes to disk",
1192 This writes all pending changes to disk.
1194 The flags which were passed to C<guestfs_aug_init> affect exactly
1195 how files are saved.");
1197 ("aug_load", (RErr, []), 27, [],
1198 [], (* XXX Augeas code needs tests. *)
1199 "load files into the tree",
1201 Load files into the tree.
1203 See C<aug_load> in the Augeas documentation for the full gory
1206 ("aug_ls", (RStringList "matches", [String "augpath"]), 28, [],
1207 [], (* XXX Augeas code needs tests. *)
1208 "list Augeas nodes under augpath",
1210 This is just a shortcut for listing C<guestfs_aug_match>
1211 C<path/*> and sorting the resulting nodes into alphabetical order.");
1213 ("rm", (RErr, [Pathname "path"]), 29, [],
1214 [InitBasicFS, Always, TestRun
1217 InitBasicFS, Always, TestLastFail
1219 InitBasicFS, Always, TestLastFail
1224 Remove the single file C<path>.");
1226 ("rmdir", (RErr, [Pathname "path"]), 30, [],
1227 [InitBasicFS, Always, TestRun
1230 InitBasicFS, Always, TestLastFail
1231 [["rmdir"; "/new"]];
1232 InitBasicFS, Always, TestLastFail
1234 ["rmdir"; "/new"]]],
1235 "remove a directory",
1237 Remove the single directory C<path>.");
1239 ("rm_rf", (RErr, [Pathname "path"]), 31, [],
1240 [InitBasicFS, Always, TestOutputFalse
1242 ["mkdir"; "/new/foo"];
1243 ["touch"; "/new/foo/bar"];
1245 ["exists"; "/new"]]],
1246 "remove a file or directory recursively",
1248 Remove the file or directory C<path>, recursively removing the
1249 contents if its a directory. This is like the C<rm -rf> shell
1252 ("mkdir", (RErr, [Pathname "path"]), 32, [],
1253 [InitBasicFS, Always, TestOutputTrue
1255 ["is_dir"; "/new"]];
1256 InitBasicFS, Always, TestLastFail
1257 [["mkdir"; "/new/foo/bar"]]],
1258 "create a directory",
1260 Create a directory named C<path>.");
1262 ("mkdir_p", (RErr, [Pathname "path"]), 33, [],
1263 [InitBasicFS, Always, TestOutputTrue
1264 [["mkdir_p"; "/new/foo/bar"];
1265 ["is_dir"; "/new/foo/bar"]];
1266 InitBasicFS, Always, TestOutputTrue
1267 [["mkdir_p"; "/new/foo/bar"];
1268 ["is_dir"; "/new/foo"]];
1269 InitBasicFS, Always, TestOutputTrue
1270 [["mkdir_p"; "/new/foo/bar"];
1271 ["is_dir"; "/new"]];
1272 (* Regression tests for RHBZ#503133: *)
1273 InitBasicFS, Always, TestRun
1275 ["mkdir_p"; "/new"]];
1276 InitBasicFS, Always, TestLastFail
1278 ["mkdir_p"; "/new"]]],
1279 "create a directory and parents",
1281 Create a directory named C<path>, creating any parent directories
1282 as necessary. This is like the C<mkdir -p> shell command.");
1284 ("chmod", (RErr, [Int "mode"; Pathname "path"]), 34, [],
1285 [], (* XXX Need stat command to test *)
1288 Change the mode (permissions) of C<path> to C<mode>. Only
1289 numeric modes are supported.");
1291 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"]), 35, [],
1292 [], (* XXX Need stat command to test *)
1293 "change file owner and group",
1295 Change the file owner to C<owner> and group to C<group>.
1297 Only numeric uid and gid are supported. If you want to use
1298 names, you will need to locate and parse the password file
1299 yourself (Augeas support makes this relatively easy).");
1301 ("exists", (RBool "existsflag", [Pathname "path"]), 36, [],
1302 [InitISOFS, Always, TestOutputTrue (
1303 [["exists"; "/empty"]]);
1304 InitISOFS, Always, TestOutputTrue (
1305 [["exists"; "/directory"]])],
1306 "test if file or directory exists",
1308 This returns C<true> if and only if there is a file, directory
1309 (or anything) with the given C<path> name.
1311 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1313 ("is_file", (RBool "fileflag", [Pathname "path"]), 37, [],
1314 [InitISOFS, Always, TestOutputTrue (
1315 [["is_file"; "/known-1"]]);
1316 InitISOFS, Always, TestOutputFalse (
1317 [["is_file"; "/directory"]])],
1318 "test if file exists",
1320 This returns C<true> if and only if there is a file
1321 with the given C<path> name. Note that it returns false for
1322 other objects like directories.
1324 See also C<guestfs_stat>.");
1326 ("is_dir", (RBool "dirflag", [Pathname "path"]), 38, [],
1327 [InitISOFS, Always, TestOutputFalse (
1328 [["is_dir"; "/known-3"]]);
1329 InitISOFS, Always, TestOutputTrue (
1330 [["is_dir"; "/directory"]])],
1331 "test if file exists",
1333 This returns C<true> if and only if there is a directory
1334 with the given C<path> name. Note that it returns false for
1335 other objects like files.
1337 See also C<guestfs_stat>.");
1339 ("pvcreate", (RErr, [Device "device"]), 39, [],
1340 [InitEmpty, Always, TestOutputListOfDevices (
1341 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1342 ["pvcreate"; "/dev/sda1"];
1343 ["pvcreate"; "/dev/sda2"];
1344 ["pvcreate"; "/dev/sda3"];
1345 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1346 "create an LVM physical volume",
1348 This creates an LVM physical volume on the named C<device>,
1349 where C<device> should usually be a partition name such
1352 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"]), 40, [],
1353 [InitEmpty, Always, TestOutputList (
1354 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1355 ["pvcreate"; "/dev/sda1"];
1356 ["pvcreate"; "/dev/sda2"];
1357 ["pvcreate"; "/dev/sda3"];
1358 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1359 ["vgcreate"; "VG2"; "/dev/sda3"];
1360 ["vgs"]], ["VG1"; "VG2"])],
1361 "create an LVM volume group",
1363 This creates an LVM volume group called C<volgroup>
1364 from the non-empty list of physical volumes C<physvols>.");
1366 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"]), 41, [],
1367 [InitEmpty, Always, TestOutputList (
1368 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1369 ["pvcreate"; "/dev/sda1"];
1370 ["pvcreate"; "/dev/sda2"];
1371 ["pvcreate"; "/dev/sda3"];
1372 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1373 ["vgcreate"; "VG2"; "/dev/sda3"];
1374 ["lvcreate"; "LV1"; "VG1"; "50"];
1375 ["lvcreate"; "LV2"; "VG1"; "50"];
1376 ["lvcreate"; "LV3"; "VG2"; "50"];
1377 ["lvcreate"; "LV4"; "VG2"; "50"];
1378 ["lvcreate"; "LV5"; "VG2"; "50"];
1380 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1381 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1382 "create an LVM volume group",
1384 This creates an LVM volume group called C<logvol>
1385 on the volume group C<volgroup>, with C<size> megabytes.");
1387 ("mkfs", (RErr, [String "fstype"; Device "device"]), 42, [],
1388 [InitEmpty, Always, TestOutput (
1389 [["sfdiskM"; "/dev/sda"; ","];
1390 ["mkfs"; "ext2"; "/dev/sda1"];
1391 ["mount"; "/dev/sda1"; "/"];
1392 ["write_file"; "/new"; "new file contents"; "0"];
1393 ["cat"; "/new"]], "new file contents")],
1394 "make a filesystem",
1396 This creates a filesystem on C<device> (usually a partition
1397 or LVM logical volume). The filesystem type is C<fstype>, for
1400 ("sfdisk", (RErr, [Device "device";
1401 Int "cyls"; Int "heads"; Int "sectors";
1402 StringList "lines"]), 43, [DangerWillRobinson],
1404 "create partitions on a block device",
1406 This is a direct interface to the L<sfdisk(8)> program for creating
1407 partitions on block devices.
1409 C<device> should be a block device, for example C</dev/sda>.
1411 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1412 and sectors on the device, which are passed directly to sfdisk as
1413 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1414 of these, then the corresponding parameter is omitted. Usually for
1415 'large' disks, you can just pass C<0> for these, but for small
1416 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1417 out the right geometry and you will need to tell it.
1419 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1420 information refer to the L<sfdisk(8)> manpage.
1422 To create a single partition occupying the whole disk, you would
1423 pass C<lines> as a single element list, when the single element being
1424 the string C<,> (comma).
1426 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>");
1428 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"]), 44, [ProtocolLimitWarning],
1429 [InitBasicFS, Always, TestOutput (
1430 [["write_file"; "/new"; "new file contents"; "0"];
1431 ["cat"; "/new"]], "new file contents");
1432 InitBasicFS, Always, TestOutput (
1433 [["write_file"; "/new"; "\nnew file contents\n"; "0"];
1434 ["cat"; "/new"]], "\nnew file contents\n");
1435 InitBasicFS, Always, TestOutput (
1436 [["write_file"; "/new"; "\n\n"; "0"];
1437 ["cat"; "/new"]], "\n\n");
1438 InitBasicFS, Always, TestOutput (
1439 [["write_file"; "/new"; ""; "0"];
1440 ["cat"; "/new"]], "");
1441 InitBasicFS, Always, TestOutput (
1442 [["write_file"; "/new"; "\n\n\n"; "0"];
1443 ["cat"; "/new"]], "\n\n\n");
1444 InitBasicFS, Always, TestOutput (
1445 [["write_file"; "/new"; "\n"; "0"];
1446 ["cat"; "/new"]], "\n")],
1449 This call creates a file called C<path>. The contents of the
1450 file is the string C<content> (which can contain any 8 bit data),
1451 with length C<size>.
1453 As a special case, if C<size> is C<0>
1454 then the length is calculated using C<strlen> (so in this case
1455 the content cannot contain embedded ASCII NULs).
1457 I<NB.> Owing to a bug, writing content containing ASCII NUL
1458 characters does I<not> work, even if the length is specified.
1459 We hope to resolve this bug in a future version. In the meantime
1460 use C<guestfs_upload>.");
1462 ("umount", (RErr, [String "pathordevice"]), 45, [FishAlias "unmount"],
1463 [InitEmpty, Always, TestOutputListOfDevices (
1464 [["sfdiskM"; "/dev/sda"; ","];
1465 ["mkfs"; "ext2"; "/dev/sda1"];
1466 ["mount"; "/dev/sda1"; "/"];
1467 ["mounts"]], ["/dev/sda1"]);
1468 InitEmpty, Always, TestOutputList (
1469 [["sfdiskM"; "/dev/sda"; ","];
1470 ["mkfs"; "ext2"; "/dev/sda1"];
1471 ["mount"; "/dev/sda1"; "/"];
1474 "unmount a filesystem",
1476 This unmounts the given filesystem. The filesystem may be
1477 specified either by its mountpoint (path) or the device which
1478 contains the filesystem.");
1480 ("mounts", (RStringList "devices", []), 46, [],
1481 [InitBasicFS, Always, TestOutputListOfDevices (
1482 [["mounts"]], ["/dev/sda1"])],
1483 "show mounted filesystems",
1485 This returns the list of currently mounted filesystems. It returns
1486 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1488 Some internal mounts are not shown.
1490 See also: C<guestfs_mountpoints>");
1492 ("umount_all", (RErr, []), 47, [FishAlias "unmount-all"],
1493 [InitBasicFS, Always, TestOutputList (
1496 (* check that umount_all can unmount nested mounts correctly: *)
1497 InitEmpty, Always, TestOutputList (
1498 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1499 ["mkfs"; "ext2"; "/dev/sda1"];
1500 ["mkfs"; "ext2"; "/dev/sda2"];
1501 ["mkfs"; "ext2"; "/dev/sda3"];
1502 ["mount"; "/dev/sda1"; "/"];
1504 ["mount"; "/dev/sda2"; "/mp1"];
1505 ["mkdir"; "/mp1/mp2"];
1506 ["mount"; "/dev/sda3"; "/mp1/mp2"];
1507 ["mkdir"; "/mp1/mp2/mp3"];
1510 "unmount all filesystems",
1512 This unmounts all mounted filesystems.
1514 Some internal mounts are not unmounted by this call.");
1516 ("lvm_remove_all", (RErr, []), 48, [DangerWillRobinson],
1518 "remove all LVM LVs, VGs and PVs",
1520 This command removes all LVM logical volumes, volume groups
1521 and physical volumes.");
1523 ("file", (RString "description", [Dev_or_Path "path"]), 49, [],
1524 [InitISOFS, Always, TestOutput (
1525 [["file"; "/empty"]], "empty");
1526 InitISOFS, Always, TestOutput (
1527 [["file"; "/known-1"]], "ASCII text");
1528 InitISOFS, Always, TestLastFail (
1529 [["file"; "/notexists"]])],
1530 "determine file type",
1532 This call uses the standard L<file(1)> command to determine
1533 the type or contents of the file. This also works on devices,
1534 for example to find out whether a partition contains a filesystem.
1536 This call will also transparently look inside various types
1539 The exact command which runs is C<file -zbsL path>. Note in
1540 particular that the filename is not prepended to the output
1541 (the C<-b> option).");
1543 ("command", (RString "output", [StringList "arguments"]), 50, [ProtocolLimitWarning],
1544 [InitBasicFS, Always, TestOutput (
1545 [["upload"; "test-command"; "/test-command"];
1546 ["chmod"; "0o755"; "/test-command"];
1547 ["command"; "/test-command 1"]], "Result1");
1548 InitBasicFS, Always, TestOutput (
1549 [["upload"; "test-command"; "/test-command"];
1550 ["chmod"; "0o755"; "/test-command"];
1551 ["command"; "/test-command 2"]], "Result2\n");
1552 InitBasicFS, Always, TestOutput (
1553 [["upload"; "test-command"; "/test-command"];
1554 ["chmod"; "0o755"; "/test-command"];
1555 ["command"; "/test-command 3"]], "\nResult3");
1556 InitBasicFS, Always, TestOutput (
1557 [["upload"; "test-command"; "/test-command"];
1558 ["chmod"; "0o755"; "/test-command"];
1559 ["command"; "/test-command 4"]], "\nResult4\n");
1560 InitBasicFS, Always, TestOutput (
1561 [["upload"; "test-command"; "/test-command"];
1562 ["chmod"; "0o755"; "/test-command"];
1563 ["command"; "/test-command 5"]], "\nResult5\n\n");
1564 InitBasicFS, Always, TestOutput (
1565 [["upload"; "test-command"; "/test-command"];
1566 ["chmod"; "0o755"; "/test-command"];
1567 ["command"; "/test-command 6"]], "\n\nResult6\n\n");
1568 InitBasicFS, Always, TestOutput (
1569 [["upload"; "test-command"; "/test-command"];
1570 ["chmod"; "0o755"; "/test-command"];
1571 ["command"; "/test-command 7"]], "");
1572 InitBasicFS, Always, TestOutput (
1573 [["upload"; "test-command"; "/test-command"];
1574 ["chmod"; "0o755"; "/test-command"];
1575 ["command"; "/test-command 8"]], "\n");
1576 InitBasicFS, Always, TestOutput (
1577 [["upload"; "test-command"; "/test-command"];
1578 ["chmod"; "0o755"; "/test-command"];
1579 ["command"; "/test-command 9"]], "\n\n");
1580 InitBasicFS, Always, TestOutput (
1581 [["upload"; "test-command"; "/test-command"];
1582 ["chmod"; "0o755"; "/test-command"];
1583 ["command"; "/test-command 10"]], "Result10-1\nResult10-2\n");
1584 InitBasicFS, Always, TestOutput (
1585 [["upload"; "test-command"; "/test-command"];
1586 ["chmod"; "0o755"; "/test-command"];
1587 ["command"; "/test-command 11"]], "Result11-1\nResult11-2");
1588 InitBasicFS, Always, TestLastFail (
1589 [["upload"; "test-command"; "/test-command"];
1590 ["chmod"; "0o755"; "/test-command"];
1591 ["command"; "/test-command"]])],
1592 "run a command from the guest filesystem",
1594 This call runs a command from the guest filesystem. The
1595 filesystem must be mounted, and must contain a compatible
1596 operating system (ie. something Linux, with the same
1597 or compatible processor architecture).
1599 The single parameter is an argv-style list of arguments.
1600 The first element is the name of the program to run.
1601 Subsequent elements are parameters. The list must be
1602 non-empty (ie. must contain a program name). Note that
1603 the command runs directly, and is I<not> invoked via
1604 the shell (see C<guestfs_sh>).
1606 The return value is anything printed to I<stdout> by
1609 If the command returns a non-zero exit status, then
1610 this function returns an error message. The error message
1611 string is the content of I<stderr> from the command.
1613 The C<$PATH> environment variable will contain at least
1614 C</usr/bin> and C</bin>. If you require a program from
1615 another location, you should provide the full path in the
1618 Shared libraries and data files required by the program
1619 must be available on filesystems which are mounted in the
1620 correct places. It is the caller's responsibility to ensure
1621 all filesystems that are needed are mounted at the right
1624 ("command_lines", (RStringList "lines", [StringList "arguments"]), 51, [ProtocolLimitWarning],
1625 [InitBasicFS, Always, TestOutputList (
1626 [["upload"; "test-command"; "/test-command"];
1627 ["chmod"; "0o755"; "/test-command"];
1628 ["command_lines"; "/test-command 1"]], ["Result1"]);
1629 InitBasicFS, Always, TestOutputList (
1630 [["upload"; "test-command"; "/test-command"];
1631 ["chmod"; "0o755"; "/test-command"];
1632 ["command_lines"; "/test-command 2"]], ["Result2"]);
1633 InitBasicFS, Always, TestOutputList (
1634 [["upload"; "test-command"; "/test-command"];
1635 ["chmod"; "0o755"; "/test-command"];
1636 ["command_lines"; "/test-command 3"]], ["";"Result3"]);
1637 InitBasicFS, Always, TestOutputList (
1638 [["upload"; "test-command"; "/test-command"];
1639 ["chmod"; "0o755"; "/test-command"];
1640 ["command_lines"; "/test-command 4"]], ["";"Result4"]);
1641 InitBasicFS, Always, TestOutputList (
1642 [["upload"; "test-command"; "/test-command"];
1643 ["chmod"; "0o755"; "/test-command"];
1644 ["command_lines"; "/test-command 5"]], ["";"Result5";""]);
1645 InitBasicFS, Always, TestOutputList (
1646 [["upload"; "test-command"; "/test-command"];
1647 ["chmod"; "0o755"; "/test-command"];
1648 ["command_lines"; "/test-command 6"]], ["";"";"Result6";""]);
1649 InitBasicFS, Always, TestOutputList (
1650 [["upload"; "test-command"; "/test-command"];
1651 ["chmod"; "0o755"; "/test-command"];
1652 ["command_lines"; "/test-command 7"]], []);
1653 InitBasicFS, Always, TestOutputList (
1654 [["upload"; "test-command"; "/test-command"];
1655 ["chmod"; "0o755"; "/test-command"];
1656 ["command_lines"; "/test-command 8"]], [""]);
1657 InitBasicFS, Always, TestOutputList (
1658 [["upload"; "test-command"; "/test-command"];
1659 ["chmod"; "0o755"; "/test-command"];
1660 ["command_lines"; "/test-command 9"]], ["";""]);
1661 InitBasicFS, Always, TestOutputList (
1662 [["upload"; "test-command"; "/test-command"];
1663 ["chmod"; "0o755"; "/test-command"];
1664 ["command_lines"; "/test-command 10"]], ["Result10-1";"Result10-2"]);
1665 InitBasicFS, Always, TestOutputList (
1666 [["upload"; "test-command"; "/test-command"];
1667 ["chmod"; "0o755"; "/test-command"];
1668 ["command_lines"; "/test-command 11"]], ["Result11-1";"Result11-2"])],
1669 "run a command, returning lines",
1671 This is the same as C<guestfs_command>, but splits the
1672 result into a list of lines.
1674 See also: C<guestfs_sh_lines>");
1676 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"]), 52, [],
1677 [InitISOFS, Always, TestOutputStruct (
1678 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
1679 "get file information",
1681 Returns file information for the given C<path>.
1683 This is the same as the C<stat(2)> system call.");
1685 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"]), 53, [],
1686 [InitISOFS, Always, TestOutputStruct (
1687 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
1688 "get file information for a symbolic link",
1690 Returns file information for the given C<path>.
1692 This is the same as C<guestfs_stat> except that if C<path>
1693 is a symbolic link, then the link is stat-ed, not the file it
1696 This is the same as the C<lstat(2)> system call.");
1698 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"]), 54, [],
1699 [InitISOFS, Always, TestOutputStruct (
1700 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
1701 "get file system statistics",
1703 Returns file system statistics for any mounted file system.
1704 C<path> should be a file or directory in the mounted file system
1705 (typically it is the mount point itself, but it doesn't need to be).
1707 This is the same as the C<statvfs(2)> system call.");
1709 ("tune2fs_l", (RHashtable "superblock", [Device "device"]), 55, [],
1711 "get ext2/ext3/ext4 superblock details",
1713 This returns the contents of the ext2, ext3 or ext4 filesystem
1714 superblock on C<device>.
1716 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1717 manpage for more details. The list of fields returned isn't
1718 clearly defined, and depends on both the version of C<tune2fs>
1719 that libguestfs was built against, and the filesystem itself.");
1721 ("blockdev_setro", (RErr, [Device "device"]), 56, [],
1722 [InitEmpty, Always, TestOutputTrue (
1723 [["blockdev_setro"; "/dev/sda"];
1724 ["blockdev_getro"; "/dev/sda"]])],
1725 "set block device to read-only",
1727 Sets the block device named C<device> to read-only.
1729 This uses the L<blockdev(8)> command.");
1731 ("blockdev_setrw", (RErr, [Device "device"]), 57, [],
1732 [InitEmpty, Always, TestOutputFalse (
1733 [["blockdev_setrw"; "/dev/sda"];
1734 ["blockdev_getro"; "/dev/sda"]])],
1735 "set block device to read-write",
1737 Sets the block device named C<device> to read-write.
1739 This uses the L<blockdev(8)> command.");
1741 ("blockdev_getro", (RBool "ro", [Device "device"]), 58, [],
1742 [InitEmpty, Always, TestOutputTrue (
1743 [["blockdev_setro"; "/dev/sda"];
1744 ["blockdev_getro"; "/dev/sda"]])],
1745 "is block device set to read-only",
1747 Returns a boolean indicating if the block device is read-only
1748 (true if read-only, false if not).
1750 This uses the L<blockdev(8)> command.");
1752 ("blockdev_getss", (RInt "sectorsize", [Device "device"]), 59, [],
1753 [InitEmpty, Always, TestOutputInt (
1754 [["blockdev_getss"; "/dev/sda"]], 512)],
1755 "get sectorsize of block device",
1757 This returns the size of sectors on a block device.
1758 Usually 512, but can be larger for modern devices.
1760 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
1763 This uses the L<blockdev(8)> command.");
1765 ("blockdev_getbsz", (RInt "blocksize", [Device "device"]), 60, [],
1766 [InitEmpty, Always, TestOutputInt (
1767 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
1768 "get blocksize of block device",
1770 This returns the block size of a device.
1772 (Note this is different from both I<size in blocks> and
1773 I<filesystem block size>).
1775 This uses the L<blockdev(8)> command.");
1777 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"]), 61, [],
1779 "set blocksize of block device",
1781 This sets the block size of a device.
1783 (Note this is different from both I<size in blocks> and
1784 I<filesystem block size>).
1786 This uses the L<blockdev(8)> command.");
1788 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"]), 62, [],
1789 [InitEmpty, Always, TestOutputInt (
1790 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
1791 "get total size of device in 512-byte sectors",
1793 This returns the size of the device in units of 512-byte sectors
1794 (even if the sectorsize isn't 512 bytes ... weird).
1796 See also C<guestfs_blockdev_getss> for the real sector size of
1797 the device, and C<guestfs_blockdev_getsize64> for the more
1798 useful I<size in bytes>.
1800 This uses the L<blockdev(8)> command.");
1802 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"]), 63, [],
1803 [InitEmpty, Always, TestOutputInt (
1804 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
1805 "get total size of device in bytes",
1807 This returns the size of the device in bytes.
1809 See also C<guestfs_blockdev_getsz>.
1811 This uses the L<blockdev(8)> command.");
1813 ("blockdev_flushbufs", (RErr, [Device "device"]), 64, [],
1814 [InitEmpty, Always, TestRun
1815 [["blockdev_flushbufs"; "/dev/sda"]]],
1816 "flush device buffers",
1818 This tells the kernel to flush internal buffers associated
1821 This uses the L<blockdev(8)> command.");
1823 ("blockdev_rereadpt", (RErr, [Device "device"]), 65, [],
1824 [InitEmpty, Always, TestRun
1825 [["blockdev_rereadpt"; "/dev/sda"]]],
1826 "reread partition table",
1828 Reread the partition table on C<device>.
1830 This uses the L<blockdev(8)> command.");
1832 ("upload", (RErr, [FileIn "filename"; String "remotefilename"]), 66, [],
1833 [InitBasicFS, Always, TestOutput (
1834 (* Pick a file from cwd which isn't likely to change. *)
1835 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1836 ["checksum"; "md5"; "/COPYING.LIB"]],
1837 Digest.to_hex (Digest.file "COPYING.LIB"))],
1838 "upload a file from the local machine",
1840 Upload local file C<filename> to C<remotefilename> on the
1843 C<filename> can also be a named pipe.
1845 See also C<guestfs_download>.");
1847 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"]), 67, [],
1848 [InitBasicFS, Always, TestOutput (
1849 (* Pick a file from cwd which isn't likely to change. *)
1850 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1851 ["download"; "/COPYING.LIB"; "testdownload.tmp"];
1852 ["upload"; "testdownload.tmp"; "/upload"];
1853 ["checksum"; "md5"; "/upload"]],
1854 Digest.to_hex (Digest.file "COPYING.LIB"))],
1855 "download a file to the local machine",
1857 Download file C<remotefilename> and save it as C<filename>
1858 on the local machine.
1860 C<filename> can also be a named pipe.
1862 See also C<guestfs_upload>, C<guestfs_cat>.");
1864 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"]), 68, [],
1865 [InitISOFS, Always, TestOutput (
1866 [["checksum"; "crc"; "/known-3"]], "2891671662");
1867 InitISOFS, Always, TestLastFail (
1868 [["checksum"; "crc"; "/notexists"]]);
1869 InitISOFS, Always, TestOutput (
1870 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
1871 InitISOFS, Always, TestOutput (
1872 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
1873 InitISOFS, Always, TestOutput (
1874 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
1875 InitISOFS, Always, TestOutput (
1876 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
1877 InitISOFS, Always, TestOutput (
1878 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
1879 InitISOFS, Always, TestOutput (
1880 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6")],
1881 "compute MD5, SHAx or CRC checksum of file",
1883 This call computes the MD5, SHAx or CRC checksum of the
1886 The type of checksum to compute is given by the C<csumtype>
1887 parameter which must have one of the following values:
1893 Compute the cyclic redundancy check (CRC) specified by POSIX
1894 for the C<cksum> command.
1898 Compute the MD5 hash (using the C<md5sum> program).
1902 Compute the SHA1 hash (using the C<sha1sum> program).
1906 Compute the SHA224 hash (using the C<sha224sum> program).
1910 Compute the SHA256 hash (using the C<sha256sum> program).
1914 Compute the SHA384 hash (using the C<sha384sum> program).
1918 Compute the SHA512 hash (using the C<sha512sum> program).
1922 The checksum is returned as a printable string.");
1924 ("tar_in", (RErr, [FileIn "tarfile"; String "directory"]), 69, [],
1925 [InitBasicFS, Always, TestOutput (
1926 [["tar_in"; "../images/helloworld.tar"; "/"];
1927 ["cat"; "/hello"]], "hello\n")],
1928 "unpack tarfile to directory",
1930 This command uploads and unpacks local file C<tarfile> (an
1931 I<uncompressed> tar file) into C<directory>.
1933 To upload a compressed tarball, use C<guestfs_tgz_in>.");
1935 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"]), 70, [],
1937 "pack directory into tarfile",
1939 This command packs the contents of C<directory> and downloads
1940 it to local file C<tarfile>.
1942 To download a compressed tarball, use C<guestfs_tgz_out>.");
1944 ("tgz_in", (RErr, [FileIn "tarball"; String "directory"]), 71, [],
1945 [InitBasicFS, Always, TestOutput (
1946 [["tgz_in"; "../images/helloworld.tar.gz"; "/"];
1947 ["cat"; "/hello"]], "hello\n")],
1948 "unpack compressed tarball to directory",
1950 This command uploads and unpacks local file C<tarball> (a
1951 I<gzip compressed> tar file) into C<directory>.
1953 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
1955 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"]), 72, [],
1957 "pack directory into compressed tarball",
1959 This command packs the contents of C<directory> and downloads
1960 it to local file C<tarball>.
1962 To download an uncompressed tarball, use C<guestfs_tar_out>.");
1964 ("mount_ro", (RErr, [Device "device"; String "mountpoint"]), 73, [],
1965 [InitBasicFS, Always, TestLastFail (
1967 ["mount_ro"; "/dev/sda1"; "/"];
1968 ["touch"; "/new"]]);
1969 InitBasicFS, Always, TestOutput (
1970 [["write_file"; "/new"; "data"; "0"];
1972 ["mount_ro"; "/dev/sda1"; "/"];
1973 ["cat"; "/new"]], "data")],
1974 "mount a guest disk, read-only",
1976 This is the same as the C<guestfs_mount> command, but it
1977 mounts the filesystem with the read-only (I<-o ro>) flag.");
1979 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"]), 74, [],
1981 "mount a guest disk with mount options",
1983 This is the same as the C<guestfs_mount> command, but it
1984 allows you to set the mount options as for the
1985 L<mount(8)> I<-o> flag.");
1987 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"]), 75, [],
1989 "mount a guest disk with mount options and vfstype",
1991 This is the same as the C<guestfs_mount> command, but it
1992 allows you to set both the mount options and the vfstype
1993 as for the L<mount(8)> I<-o> and I<-t> flags.");
1995 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"]), 76, [],
1997 "debugging and internals",
1999 The C<guestfs_debug> command exposes some internals of
2000 C<guestfsd> (the guestfs daemon) that runs inside the
2003 There is no comprehensive help for this command. You have
2004 to look at the file C<daemon/debug.c> in the libguestfs source
2005 to find out what you can do.");
2007 ("lvremove", (RErr, [Device "device"]), 77, [],
2008 [InitEmpty, Always, TestOutputList (
2009 [["sfdiskM"; "/dev/sda"; ","];
2010 ["pvcreate"; "/dev/sda1"];
2011 ["vgcreate"; "VG"; "/dev/sda1"];
2012 ["lvcreate"; "LV1"; "VG"; "50"];
2013 ["lvcreate"; "LV2"; "VG"; "50"];
2014 ["lvremove"; "/dev/VG/LV1"];
2015 ["lvs"]], ["/dev/VG/LV2"]);
2016 InitEmpty, Always, TestOutputList (
2017 [["sfdiskM"; "/dev/sda"; ","];
2018 ["pvcreate"; "/dev/sda1"];
2019 ["vgcreate"; "VG"; "/dev/sda1"];
2020 ["lvcreate"; "LV1"; "VG"; "50"];
2021 ["lvcreate"; "LV2"; "VG"; "50"];
2022 ["lvremove"; "/dev/VG"];
2024 InitEmpty, Always, TestOutputList (
2025 [["sfdiskM"; "/dev/sda"; ","];
2026 ["pvcreate"; "/dev/sda1"];
2027 ["vgcreate"; "VG"; "/dev/sda1"];
2028 ["lvcreate"; "LV1"; "VG"; "50"];
2029 ["lvcreate"; "LV2"; "VG"; "50"];
2030 ["lvremove"; "/dev/VG"];
2032 "remove an LVM logical volume",
2034 Remove an LVM logical volume C<device>, where C<device> is
2035 the path to the LV, such as C</dev/VG/LV>.
2037 You can also remove all LVs in a volume group by specifying
2038 the VG name, C</dev/VG>.");
2040 ("vgremove", (RErr, [String "vgname"]), 78, [],
2041 [InitEmpty, Always, TestOutputList (
2042 [["sfdiskM"; "/dev/sda"; ","];
2043 ["pvcreate"; "/dev/sda1"];
2044 ["vgcreate"; "VG"; "/dev/sda1"];
2045 ["lvcreate"; "LV1"; "VG"; "50"];
2046 ["lvcreate"; "LV2"; "VG"; "50"];
2049 InitEmpty, Always, TestOutputList (
2050 [["sfdiskM"; "/dev/sda"; ","];
2051 ["pvcreate"; "/dev/sda1"];
2052 ["vgcreate"; "VG"; "/dev/sda1"];
2053 ["lvcreate"; "LV1"; "VG"; "50"];
2054 ["lvcreate"; "LV2"; "VG"; "50"];
2057 "remove an LVM volume group",
2059 Remove an LVM volume group C<vgname>, (for example C<VG>).
2061 This also forcibly removes all logical volumes in the volume
2064 ("pvremove", (RErr, [Device "device"]), 79, [],
2065 [InitEmpty, Always, TestOutputListOfDevices (
2066 [["sfdiskM"; "/dev/sda"; ","];
2067 ["pvcreate"; "/dev/sda1"];
2068 ["vgcreate"; "VG"; "/dev/sda1"];
2069 ["lvcreate"; "LV1"; "VG"; "50"];
2070 ["lvcreate"; "LV2"; "VG"; "50"];
2072 ["pvremove"; "/dev/sda1"];
2074 InitEmpty, Always, TestOutputListOfDevices (
2075 [["sfdiskM"; "/dev/sda"; ","];
2076 ["pvcreate"; "/dev/sda1"];
2077 ["vgcreate"; "VG"; "/dev/sda1"];
2078 ["lvcreate"; "LV1"; "VG"; "50"];
2079 ["lvcreate"; "LV2"; "VG"; "50"];
2081 ["pvremove"; "/dev/sda1"];
2083 InitEmpty, Always, TestOutputListOfDevices (
2084 [["sfdiskM"; "/dev/sda"; ","];
2085 ["pvcreate"; "/dev/sda1"];
2086 ["vgcreate"; "VG"; "/dev/sda1"];
2087 ["lvcreate"; "LV1"; "VG"; "50"];
2088 ["lvcreate"; "LV2"; "VG"; "50"];
2090 ["pvremove"; "/dev/sda1"];
2092 "remove an LVM physical volume",
2094 This wipes a physical volume C<device> so that LVM will no longer
2097 The implementation uses the C<pvremove> command which refuses to
2098 wipe physical volumes that contain any volume groups, so you have
2099 to remove those first.");
2101 ("set_e2label", (RErr, [Device "device"; String "label"]), 80, [],
2102 [InitBasicFS, Always, TestOutput (
2103 [["set_e2label"; "/dev/sda1"; "testlabel"];
2104 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2105 "set the ext2/3/4 filesystem label",
2107 This sets the ext2/3/4 filesystem label of the filesystem on
2108 C<device> to C<label>. Filesystem labels are limited to
2111 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2112 to return the existing label on a filesystem.");
2114 ("get_e2label", (RString "label", [Device "device"]), 81, [],
2116 "get the ext2/3/4 filesystem label",
2118 This returns the ext2/3/4 filesystem label of the filesystem on
2121 ("set_e2uuid", (RErr, [Device "device"; String "uuid"]), 82, [],
2122 (let uuid = uuidgen () in
2123 [InitBasicFS, Always, TestOutput (
2124 [["set_e2uuid"; "/dev/sda1"; uuid];
2125 ["get_e2uuid"; "/dev/sda1"]], uuid);
2126 InitBasicFS, Always, TestOutput (
2127 [["set_e2uuid"; "/dev/sda1"; "clear"];
2128 ["get_e2uuid"; "/dev/sda1"]], "");
2129 (* We can't predict what UUIDs will be, so just check the commands run. *)
2130 InitBasicFS, Always, TestRun (
2131 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2132 InitBasicFS, Always, TestRun (
2133 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2134 "set the ext2/3/4 filesystem UUID",
2136 This sets the ext2/3/4 filesystem UUID of the filesystem on
2137 C<device> to C<uuid>. The format of the UUID and alternatives
2138 such as C<clear>, C<random> and C<time> are described in the
2139 L<tune2fs(8)> manpage.
2141 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2142 to return the existing UUID of a filesystem.");
2144 ("get_e2uuid", (RString "uuid", [Device "device"]), 83, [],
2146 "get the ext2/3/4 filesystem UUID",
2148 This returns the ext2/3/4 filesystem UUID of the filesystem on
2151 ("fsck", (RInt "status", [String "fstype"; Device "device"]), 84, [],
2152 [InitBasicFS, Always, TestOutputInt (
2153 [["umount"; "/dev/sda1"];
2154 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2155 InitBasicFS, Always, TestOutputInt (
2156 [["umount"; "/dev/sda1"];
2157 ["zero"; "/dev/sda1"];
2158 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2159 "run the filesystem checker",
2161 This runs the filesystem checker (fsck) on C<device> which
2162 should have filesystem type C<fstype>.
2164 The returned integer is the status. See L<fsck(8)> for the
2165 list of status codes from C<fsck>.
2173 Multiple status codes can be summed together.
2177 A non-zero return code can mean \"success\", for example if
2178 errors have been corrected on the filesystem.
2182 Checking or repairing NTFS volumes is not supported
2187 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2189 ("zero", (RErr, [Device "device"]), 85, [],
2190 [InitBasicFS, Always, TestOutput (
2191 [["umount"; "/dev/sda1"];
2192 ["zero"; "/dev/sda1"];
2193 ["file"; "/dev/sda1"]], "data")],
2194 "write zeroes to the device",
2196 This command writes zeroes over the first few blocks of C<device>.
2198 How many blocks are zeroed isn't specified (but it's I<not> enough
2199 to securely wipe the device). It should be sufficient to remove
2200 any partition tables, filesystem superblocks and so on.
2202 See also: C<guestfs_scrub_device>.");
2204 ("grub_install", (RErr, [Pathname "root"; Device "device"]), 86, [],
2205 (* Test disabled because grub-install incompatible with virtio-blk driver.
2206 * See also: https://bugzilla.redhat.com/show_bug.cgi?id=479760
2208 [InitBasicFS, Disabled, TestOutputTrue (
2209 [["grub_install"; "/"; "/dev/sda1"];
2210 ["is_dir"; "/boot"]])],
2213 This command installs GRUB (the Grand Unified Bootloader) on
2214 C<device>, with the root directory being C<root>.");
2216 ("cp", (RErr, [Pathname "src"; Pathname "dest"]), 87, [],
2217 [InitBasicFS, Always, TestOutput (
2218 [["write_file"; "/old"; "file content"; "0"];
2219 ["cp"; "/old"; "/new"];
2220 ["cat"; "/new"]], "file content");
2221 InitBasicFS, Always, TestOutputTrue (
2222 [["write_file"; "/old"; "file content"; "0"];
2223 ["cp"; "/old"; "/new"];
2224 ["is_file"; "/old"]]);
2225 InitBasicFS, Always, TestOutput (
2226 [["write_file"; "/old"; "file content"; "0"];
2228 ["cp"; "/old"; "/dir/new"];
2229 ["cat"; "/dir/new"]], "file content")],
2232 This copies a file from C<src> to C<dest> where C<dest> is
2233 either a destination filename or destination directory.");
2235 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"]), 88, [],
2236 [InitBasicFS, Always, TestOutput (
2237 [["mkdir"; "/olddir"];
2238 ["mkdir"; "/newdir"];
2239 ["write_file"; "/olddir/file"; "file content"; "0"];
2240 ["cp_a"; "/olddir"; "/newdir"];
2241 ["cat"; "/newdir/olddir/file"]], "file content")],
2242 "copy a file or directory recursively",
2244 This copies a file or directory from C<src> to C<dest>
2245 recursively using the C<cp -a> command.");
2247 ("mv", (RErr, [Pathname "src"; Pathname "dest"]), 89, [],
2248 [InitBasicFS, Always, TestOutput (
2249 [["write_file"; "/old"; "file content"; "0"];
2250 ["mv"; "/old"; "/new"];
2251 ["cat"; "/new"]], "file content");
2252 InitBasicFS, Always, TestOutputFalse (
2253 [["write_file"; "/old"; "file content"; "0"];
2254 ["mv"; "/old"; "/new"];
2255 ["is_file"; "/old"]])],
2258 This moves a file from C<src> to C<dest> where C<dest> is
2259 either a destination filename or destination directory.");
2261 ("drop_caches", (RErr, [Int "whattodrop"]), 90, [],
2262 [InitEmpty, Always, TestRun (
2263 [["drop_caches"; "3"]])],
2264 "drop kernel page cache, dentries and inodes",
2266 This instructs the guest kernel to drop its page cache,
2267 and/or dentries and inode caches. The parameter C<whattodrop>
2268 tells the kernel what precisely to drop, see
2269 L<http://linux-mm.org/Drop_Caches>
2271 Setting C<whattodrop> to 3 should drop everything.
2273 This automatically calls L<sync(2)> before the operation,
2274 so that the maximum guest memory is freed.");
2276 ("dmesg", (RString "kmsgs", []), 91, [],
2277 [InitEmpty, Always, TestRun (
2279 "return kernel messages",
2281 This returns the kernel messages (C<dmesg> output) from
2282 the guest kernel. This is sometimes useful for extended
2283 debugging of problems.
2285 Another way to get the same information is to enable
2286 verbose messages with C<guestfs_set_verbose> or by setting
2287 the environment variable C<LIBGUESTFS_DEBUG=1> before
2288 running the program.");
2290 ("ping_daemon", (RErr, []), 92, [],
2291 [InitEmpty, Always, TestRun (
2292 [["ping_daemon"]])],
2293 "ping the guest daemon",
2295 This is a test probe into the guestfs daemon running inside
2296 the qemu subprocess. Calling this function checks that the
2297 daemon responds to the ping message, without affecting the daemon
2298 or attached block device(s) in any other way.");
2300 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"]), 93, [],
2301 [InitBasicFS, Always, TestOutputTrue (
2302 [["write_file"; "/file1"; "contents of a file"; "0"];
2303 ["cp"; "/file1"; "/file2"];
2304 ["equal"; "/file1"; "/file2"]]);
2305 InitBasicFS, Always, TestOutputFalse (
2306 [["write_file"; "/file1"; "contents of a file"; "0"];
2307 ["write_file"; "/file2"; "contents of another file"; "0"];
2308 ["equal"; "/file1"; "/file2"]]);
2309 InitBasicFS, Always, TestLastFail (
2310 [["equal"; "/file1"; "/file2"]])],
2311 "test if two files have equal contents",
2313 This compares the two files C<file1> and C<file2> and returns
2314 true if their content is exactly equal, or false otherwise.
2316 The external L<cmp(1)> program is used for the comparison.");
2318 ("strings", (RStringList "stringsout", [Pathname "path"]), 94, [ProtocolLimitWarning],
2319 [InitISOFS, Always, TestOutputList (
2320 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
2321 InitISOFS, Always, TestOutputList (
2322 [["strings"; "/empty"]], [])],
2323 "print the printable strings in a file",
2325 This runs the L<strings(1)> command on a file and returns
2326 the list of printable strings found.");
2328 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"]), 95, [ProtocolLimitWarning],
2329 [InitISOFS, Always, TestOutputList (
2330 [["strings_e"; "b"; "/known-5"]], []);
2331 InitBasicFS, Disabled, TestOutputList (
2332 [["write_file"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"; "24"];
2333 ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
2334 "print the printable strings in a file",
2336 This is like the C<guestfs_strings> command, but allows you to
2337 specify the encoding.
2339 See the L<strings(1)> manpage for the full list of encodings.
2341 Commonly useful encodings are C<l> (lower case L) which will
2342 show strings inside Windows/x86 files.
2344 The returned strings are transcoded to UTF-8.");
2346 ("hexdump", (RString "dump", [Pathname "path"]), 96, [ProtocolLimitWarning],
2347 [InitISOFS, Always, TestOutput (
2348 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
2349 (* Test for RHBZ#501888c2 regression which caused large hexdump
2350 * commands to segfault.
2352 InitISOFS, Always, TestRun (
2353 [["hexdump"; "/100krandom"]])],
2354 "dump a file in hexadecimal",
2356 This runs C<hexdump -C> on the given C<path>. The result is
2357 the human-readable, canonical hex dump of the file.");
2359 ("zerofree", (RErr, [Device "device"]), 97, [],
2360 [InitNone, Always, TestOutput (
2361 [["sfdiskM"; "/dev/sda"; ","];
2362 ["mkfs"; "ext3"; "/dev/sda1"];
2363 ["mount"; "/dev/sda1"; "/"];
2364 ["write_file"; "/new"; "test file"; "0"];
2365 ["umount"; "/dev/sda1"];
2366 ["zerofree"; "/dev/sda1"];
2367 ["mount"; "/dev/sda1"; "/"];
2368 ["cat"; "/new"]], "test file")],
2369 "zero unused inodes and disk blocks on ext2/3 filesystem",
2371 This runs the I<zerofree> program on C<device>. This program
2372 claims to zero unused inodes and disk blocks on an ext2/3
2373 filesystem, thus making it possible to compress the filesystem
2376 You should B<not> run this program if the filesystem is
2379 It is possible that using this program can damage the filesystem
2380 or data on the filesystem.");
2382 ("pvresize", (RErr, [Device "device"]), 98, [],
2384 "resize an LVM physical volume",
2386 This resizes (expands or shrinks) an existing LVM physical
2387 volume to match the new size of the underlying device.");
2389 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
2390 Int "cyls"; Int "heads"; Int "sectors";
2391 String "line"]), 99, [DangerWillRobinson],
2393 "modify a single partition on a block device",
2395 This runs L<sfdisk(8)> option to modify just the single
2396 partition C<n> (note: C<n> counts from 1).
2398 For other parameters, see C<guestfs_sfdisk>. You should usually
2399 pass C<0> for the cyls/heads/sectors parameters.");
2401 ("sfdisk_l", (RString "partitions", [Device "device"]), 100, [],
2403 "display the partition table",
2405 This displays the partition table on C<device>, in the
2406 human-readable output of the L<sfdisk(8)> command. It is
2407 not intended to be parsed.");
2409 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"]), 101, [],
2411 "display the kernel geometry",
2413 This displays the kernel's idea of the geometry of C<device>.
2415 The result is in human-readable format, and not designed to
2418 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"]), 102, [],
2420 "display the disk geometry from the partition table",
2422 This displays the disk geometry of C<device> read from the
2423 partition table. Especially in the case where the underlying
2424 block device has been resized, this can be different from the
2425 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
2427 The result is in human-readable format, and not designed to
2430 ("vg_activate_all", (RErr, [Bool "activate"]), 103, [],
2432 "activate or deactivate all volume groups",
2434 This command activates or (if C<activate> is false) deactivates
2435 all logical volumes in all volume groups.
2436 If activated, then they are made known to the
2437 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2438 then those devices disappear.
2440 This command is the same as running C<vgchange -a y|n>");
2442 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"]), 104, [],
2444 "activate or deactivate some volume groups",
2446 This command activates or (if C<activate> is false) deactivates
2447 all logical volumes in the listed volume groups C<volgroups>.
2448 If activated, then they are made known to the
2449 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2450 then those devices disappear.
2452 This command is the same as running C<vgchange -a y|n volgroups...>
2454 Note that if C<volgroups> is an empty list then B<all> volume groups
2455 are activated or deactivated.");
2457 ("lvresize", (RErr, [Device "device"; Int "mbytes"]), 105, [],
2458 [InitNone, Always, TestOutput (
2459 [["sfdiskM"; "/dev/sda"; ","];
2460 ["pvcreate"; "/dev/sda1"];
2461 ["vgcreate"; "VG"; "/dev/sda1"];
2462 ["lvcreate"; "LV"; "VG"; "10"];
2463 ["mkfs"; "ext2"; "/dev/VG/LV"];
2464 ["mount"; "/dev/VG/LV"; "/"];
2465 ["write_file"; "/new"; "test content"; "0"];
2467 ["lvresize"; "/dev/VG/LV"; "20"];
2468 ["e2fsck_f"; "/dev/VG/LV"];
2469 ["resize2fs"; "/dev/VG/LV"];
2470 ["mount"; "/dev/VG/LV"; "/"];
2471 ["cat"; "/new"]], "test content")],
2472 "resize an LVM logical volume",
2474 This resizes (expands or shrinks) an existing LVM logical
2475 volume to C<mbytes>. When reducing, data in the reduced part
2478 ("resize2fs", (RErr, [Device "device"]), 106, [],
2479 [], (* lvresize tests this *)
2480 "resize an ext2/ext3 filesystem",
2482 This resizes an ext2 or ext3 filesystem to match the size of
2483 the underlying device.
2485 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
2486 on the C<device> before calling this command. For unknown reasons
2487 C<resize2fs> sometimes gives an error about this and sometimes not.
2488 In any case, it is always safe to call C<guestfs_e2fsck_f> before
2489 calling this function.");
2491 ("find", (RStringList "names", [Pathname "directory"]), 107, [],
2492 [InitBasicFS, Always, TestOutputList (
2493 [["find"; "/"]], ["lost+found"]);
2494 InitBasicFS, Always, TestOutputList (
2498 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
2499 InitBasicFS, Always, TestOutputList (
2500 [["mkdir_p"; "/a/b/c"];
2501 ["touch"; "/a/b/c/d"];
2502 ["find"; "/a/b/"]], ["c"; "c/d"])],
2503 "find all files and directories",
2505 This command lists out all files and directories, recursively,
2506 starting at C<directory>. It is essentially equivalent to
2507 running the shell command C<find directory -print> but some
2508 post-processing happens on the output, described below.
2510 This returns a list of strings I<without any prefix>. Thus
2511 if the directory structure was:
2517 then the returned list from C<guestfs_find> C</tmp> would be
2525 If C<directory> is not a directory, then this command returns
2528 The returned list is sorted.");
2530 ("e2fsck_f", (RErr, [Device "device"]), 108, [],
2531 [], (* lvresize tests this *)
2532 "check an ext2/ext3 filesystem",
2534 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
2535 filesystem checker on C<device>, noninteractively (C<-p>),
2536 even if the filesystem appears to be clean (C<-f>).
2538 This command is only needed because of C<guestfs_resize2fs>
2539 (q.v.). Normally you should use C<guestfs_fsck>.");
2541 ("sleep", (RErr, [Int "secs"]), 109, [],
2542 [InitNone, Always, TestRun (
2544 "sleep for some seconds",
2546 Sleep for C<secs> seconds.");
2548 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"]), 110, [],
2549 [InitNone, Always, TestOutputInt (
2550 [["sfdiskM"; "/dev/sda"; ","];
2551 ["mkfs"; "ntfs"; "/dev/sda1"];
2552 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
2553 InitNone, Always, TestOutputInt (
2554 [["sfdiskM"; "/dev/sda"; ","];
2555 ["mkfs"; "ext2"; "/dev/sda1"];
2556 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
2557 "probe NTFS volume",
2559 This command runs the L<ntfs-3g.probe(8)> command which probes
2560 an NTFS C<device> for mountability. (Not all NTFS volumes can
2561 be mounted read-write, and some cannot be mounted at all).
2563 C<rw> is a boolean flag. Set it to true if you want to test
2564 if the volume can be mounted read-write. Set it to false if
2565 you want to test if the volume can be mounted read-only.
2567 The return value is an integer which C<0> if the operation
2568 would succeed, or some non-zero value documented in the
2569 L<ntfs-3g.probe(8)> manual page.");
2571 ("sh", (RString "output", [String "command"]), 111, [],
2572 [], (* XXX needs tests *)
2573 "run a command via the shell",
2575 This call runs a command from the guest filesystem via the
2578 This is like C<guestfs_command>, but passes the command to:
2580 /bin/sh -c \"command\"
2582 Depending on the guest's shell, this usually results in
2583 wildcards being expanded, shell expressions being interpolated
2586 All the provisos about C<guestfs_command> apply to this call.");
2588 ("sh_lines", (RStringList "lines", [String "command"]), 112, [],
2589 [], (* XXX needs tests *)
2590 "run a command via the shell returning lines",
2592 This is the same as C<guestfs_sh>, but splits the result
2593 into a list of lines.
2595 See also: C<guestfs_command_lines>");
2597 ("glob_expand", (RStringList "paths", [Pathname "pattern"]), 113, [],
2598 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
2599 * code in stubs.c, since all valid glob patterns must start with "/".
2600 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
2602 [InitBasicFS, Always, TestOutputList (
2603 [["mkdir_p"; "/a/b/c"];
2604 ["touch"; "/a/b/c/d"];
2605 ["touch"; "/a/b/c/e"];
2606 ["glob_expand"; "/a/b/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2607 InitBasicFS, Always, TestOutputList (
2608 [["mkdir_p"; "/a/b/c"];
2609 ["touch"; "/a/b/c/d"];
2610 ["touch"; "/a/b/c/e"];
2611 ["glob_expand"; "/a/*/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2612 InitBasicFS, Always, TestOutputList (
2613 [["mkdir_p"; "/a/b/c"];
2614 ["touch"; "/a/b/c/d"];
2615 ["touch"; "/a/b/c/e"];
2616 ["glob_expand"; "/a/*/x/*"]], [])],
2617 "expand a wildcard path",
2619 This command searches for all the pathnames matching
2620 C<pattern> according to the wildcard expansion rules
2623 If no paths match, then this returns an empty list
2624 (note: not an error).
2626 It is just a wrapper around the C L<glob(3)> function
2627 with flags C<GLOB_MARK|GLOB_BRACE>.
2628 See that manual page for more details.");
2630 ("scrub_device", (RErr, [Device "device"]), 114, [DangerWillRobinson],
2631 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
2632 [["scrub_device"; "/dev/sdc"]])],
2633 "scrub (securely wipe) a device",
2635 This command writes patterns over C<device> to make data retrieval
2638 It is an interface to the L<scrub(1)> program. See that
2639 manual page for more details.");
2641 ("scrub_file", (RErr, [Pathname "file"]), 115, [],
2642 [InitBasicFS, Always, TestRun (
2643 [["write_file"; "/file"; "content"; "0"];
2644 ["scrub_file"; "/file"]])],
2645 "scrub (securely wipe) a file",
2647 This command writes patterns over a file to make data retrieval
2650 The file is I<removed> after scrubbing.
2652 It is an interface to the L<scrub(1)> program. See that
2653 manual page for more details.");
2655 ("scrub_freespace", (RErr, [Pathname "dir"]), 116, [],
2656 [], (* XXX needs testing *)
2657 "scrub (securely wipe) free space",
2659 This command creates the directory C<dir> and then fills it
2660 with files until the filesystem is full, and scrubs the files
2661 as for C<guestfs_scrub_file>, and deletes them.
2662 The intention is to scrub any free space on the partition
2665 It is an interface to the L<scrub(1)> program. See that
2666 manual page for more details.");
2668 ("mkdtemp", (RString "dir", [Pathname "template"]), 117, [],
2669 [InitBasicFS, Always, TestRun (
2671 ["mkdtemp"; "/tmp/tmpXXXXXX"]])],
2672 "create a temporary directory",
2674 This command creates a temporary directory. The
2675 C<template> parameter should be a full pathname for the
2676 temporary directory name with the final six characters being
2679 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
2680 the second one being suitable for Windows filesystems.
2682 The name of the temporary directory that was created
2685 The temporary directory is created with mode 0700
2686 and is owned by root.
2688 The caller is responsible for deleting the temporary
2689 directory and its contents after use.
2691 See also: L<mkdtemp(3)>");
2693 ("wc_l", (RInt "lines", [Pathname "path"]), 118, [],
2694 [InitISOFS, Always, TestOutputInt (
2695 [["wc_l"; "/10klines"]], 10000)],
2696 "count lines in a file",
2698 This command counts the lines in a file, using the
2699 C<wc -l> external command.");
2701 ("wc_w", (RInt "words", [Pathname "path"]), 119, [],
2702 [InitISOFS, Always, TestOutputInt (
2703 [["wc_w"; "/10klines"]], 10000)],
2704 "count words in a file",
2706 This command counts the words in a file, using the
2707 C<wc -w> external command.");
2709 ("wc_c", (RInt "chars", [Pathname "path"]), 120, [],
2710 [InitISOFS, Always, TestOutputInt (
2711 [["wc_c"; "/100kallspaces"]], 102400)],
2712 "count characters in a file",
2714 This command counts the characters in a file, using the
2715 C<wc -c> external command.");
2717 ("head", (RStringList "lines", [Pathname "path"]), 121, [ProtocolLimitWarning],
2718 [InitISOFS, Always, TestOutputList (
2719 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
2720 "return first 10 lines of a file",
2722 This command returns up to the first 10 lines of a file as
2723 a list of strings.");
2725 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"]), 122, [ProtocolLimitWarning],
2726 [InitISOFS, Always, TestOutputList (
2727 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2728 InitISOFS, Always, TestOutputList (
2729 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2730 InitISOFS, Always, TestOutputList (
2731 [["head_n"; "0"; "/10klines"]], [])],
2732 "return first N lines of a file",
2734 If the parameter C<nrlines> is a positive number, this returns the first
2735 C<nrlines> lines of the file C<path>.
2737 If the parameter C<nrlines> is a negative number, this returns lines
2738 from the file C<path>, excluding the last C<nrlines> lines.
2740 If the parameter C<nrlines> is zero, this returns an empty list.");
2742 ("tail", (RStringList "lines", [Pathname "path"]), 123, [ProtocolLimitWarning],
2743 [InitISOFS, Always, TestOutputList (
2744 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
2745 "return last 10 lines of a file",
2747 This command returns up to the last 10 lines of a file as
2748 a list of strings.");
2750 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"]), 124, [ProtocolLimitWarning],
2751 [InitISOFS, Always, TestOutputList (
2752 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2753 InitISOFS, Always, TestOutputList (
2754 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2755 InitISOFS, Always, TestOutputList (
2756 [["tail_n"; "0"; "/10klines"]], [])],
2757 "return last N lines of a file",
2759 If the parameter C<nrlines> is a positive number, this returns the last
2760 C<nrlines> lines of the file C<path>.
2762 If the parameter C<nrlines> is a negative number, this returns lines
2763 from the file C<path>, starting with the C<-nrlines>th line.
2765 If the parameter C<nrlines> is zero, this returns an empty list.");
2767 ("df", (RString "output", []), 125, [],
2768 [], (* XXX Tricky to test because it depends on the exact format
2769 * of the 'df' command and other imponderables.
2771 "report file system disk space usage",
2773 This command runs the C<df> command to report disk space used.
2775 This command is mostly useful for interactive sessions. It
2776 is I<not> intended that you try to parse the output string.
2777 Use C<statvfs> from programs.");
2779 ("df_h", (RString "output", []), 126, [],
2780 [], (* XXX Tricky to test because it depends on the exact format
2781 * of the 'df' command and other imponderables.
2783 "report file system disk space usage (human readable)",
2785 This command runs the C<df -h> command to report disk space used
2786 in human-readable format.
2788 This command is mostly useful for interactive sessions. It
2789 is I<not> intended that you try to parse the output string.
2790 Use C<statvfs> from programs.");
2792 ("du", (RInt64 "sizekb", [Pathname "path"]), 127, [],
2793 [InitISOFS, Always, TestOutputInt (
2794 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
2795 "estimate file space usage",
2797 This command runs the C<du -s> command to estimate file space
2800 C<path> can be a file or a directory. If C<path> is a directory
2801 then the estimate includes the contents of the directory and all
2802 subdirectories (recursively).
2804 The result is the estimated size in I<kilobytes>
2805 (ie. units of 1024 bytes).");
2807 ("initrd_list", (RStringList "filenames", [Pathname "path"]), 128, [],
2808 [InitISOFS, Always, TestOutputList (
2809 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
2810 "list files in an initrd",
2812 This command lists out files contained in an initrd.
2814 The files are listed without any initial C</> character. The
2815 files are listed in the order they appear (not necessarily
2816 alphabetical). Directory names are listed as separate items.
2818 Old Linux kernels (2.4 and earlier) used a compressed ext2
2819 filesystem as initrd. We I<only> support the newer initramfs
2820 format (compressed cpio files).");
2822 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"]), 129, [],
2824 "mount a file using the loop device",
2826 This command lets you mount C<file> (a filesystem image
2827 in a file) on a mount point. It is entirely equivalent to
2828 the command C<mount -o loop file mountpoint>.");
2830 ("mkswap", (RErr, [Device "device"]), 130, [],
2831 [InitEmpty, Always, TestRun (
2832 [["sfdiskM"; "/dev/sda"; ","];
2833 ["mkswap"; "/dev/sda1"]])],
2834 "create a swap partition",
2836 Create a swap partition on C<device>.");
2838 ("mkswap_L", (RErr, [String "label"; Device "device"]), 131, [],
2839 [InitEmpty, Always, TestRun (
2840 [["sfdiskM"; "/dev/sda"; ","];
2841 ["mkswap_L"; "hello"; "/dev/sda1"]])],
2842 "create a swap partition with a label",
2844 Create a swap partition on C<device> with label C<label>.
2846 Note that you cannot attach a swap label to a block device
2847 (eg. C</dev/sda>), just to a partition. This appears to be
2848 a limitation of the kernel or swap tools.");
2850 ("mkswap_U", (RErr, [String "uuid"; Device "device"]), 132, [],
2851 (let uuid = uuidgen () in
2852 [InitEmpty, Always, TestRun (
2853 [["sfdiskM"; "/dev/sda"; ","];
2854 ["mkswap_U"; uuid; "/dev/sda1"]])]),
2855 "create a swap partition with an explicit UUID",
2857 Create a swap partition on C<device> with UUID C<uuid>.");
2859 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 133, [],
2860 [InitBasicFS, Always, TestOutputStruct (
2861 [["mknod"; "0o10777"; "0"; "0"; "/node"];
2862 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
2863 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)]);
2864 InitBasicFS, Always, TestOutputStruct (
2865 [["mknod"; "0o60777"; "66"; "99"; "/node"];
2866 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
2867 "make block, character or FIFO devices",
2869 This call creates block or character special devices, or
2870 named pipes (FIFOs).
2872 The C<mode> parameter should be the mode, using the standard
2873 constants. C<devmajor> and C<devminor> are the
2874 device major and minor numbers, only used when creating block
2875 and character special devices.");
2877 ("mkfifo", (RErr, [Int "mode"; Pathname "path"]), 134, [],
2878 [InitBasicFS, Always, TestOutputStruct (
2879 [["mkfifo"; "0o777"; "/node"];
2880 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)])],
2881 "make FIFO (named pipe)",
2883 This call creates a FIFO (named pipe) called C<path> with
2884 mode C<mode>. It is just a convenient wrapper around
2885 C<guestfs_mknod>.");
2887 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 135, [],
2888 [InitBasicFS, Always, TestOutputStruct (
2889 [["mknod_b"; "0o777"; "99"; "66"; "/node"];
2890 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
2891 "make block device node",
2893 This call creates a block device node called C<path> with
2894 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
2895 It is just a convenient wrapper around C<guestfs_mknod>.");
2897 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 136, [],
2898 [InitBasicFS, Always, TestOutputStruct (
2899 [["mknod_c"; "0o777"; "99"; "66"; "/node"];
2900 ["stat"; "/node"]], [CompareWithInt ("mode", 0o20755)])],
2901 "make char device node",
2903 This call creates a char device node called C<path> with
2904 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
2905 It is just a convenient wrapper around C<guestfs_mknod>.");
2907 ("umask", (RInt "oldmask", [Int "mask"]), 137, [],
2908 [], (* XXX umask is one of those stateful things that we should
2909 * reset between each test.
2911 "set file mode creation mask (umask)",
2913 This function sets the mask used for creating new files and
2914 device nodes to C<mask & 0777>.
2916 Typical umask values would be C<022> which creates new files
2917 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
2918 C<002> which creates new files with permissions like
2919 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
2921 The default umask is C<022>. This is important because it
2922 means that directories and device nodes will be created with
2923 C<0644> or C<0755> mode even if you specify C<0777>.
2925 See also L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
2927 This call returns the previous umask.");
2929 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"]), 138, [],
2931 "read directories entries",
2933 This returns the list of directory entries in directory C<dir>.
2935 All entries in the directory are returned, including C<.> and
2936 C<..>. The entries are I<not> sorted, but returned in the same
2937 order as the underlying filesystem.
2939 Also this call returns basic file type information about each
2940 file. The C<ftyp> field will contain one of the following characters:
2978 The L<readdir(3)> returned a C<d_type> field with an
2983 This function is primarily intended for use by programs. To
2984 get a simple list of names, use C<guestfs_ls>. To get a printable
2985 directory for human consumption, use C<guestfs_ll>.");
2987 ("sfdiskM", (RErr, [Device "device"; StringList "lines"]), 139, [DangerWillRobinson],
2989 "create partitions on a block device",
2991 This is a simplified interface to the C<guestfs_sfdisk>
2992 command, where partition sizes are specified in megabytes
2993 only (rounded to the nearest cylinder) and you don't need
2994 to specify the cyls, heads and sectors parameters which
2995 were rarely if ever used anyway.
2997 See also C<guestfs_sfdisk> and the L<sfdisk(8)> manpage.");
2999 ("zfile", (RString "description", [String "meth"; Pathname "path"]), 140, [DeprecatedBy "file"],
3001 "determine file type inside a compressed file",
3003 This command runs C<file> after first decompressing C<path>
3006 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3008 Since 1.0.63, use C<guestfs_file> instead which can now
3009 process compressed files.");
3011 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"]), 141, [],
3013 "list extended attributes of a file or directory",
3015 This call lists the extended attributes of the file or directory
3018 At the system call level, this is a combination of the
3019 L<listxattr(2)> and L<getxattr(2)> calls.
3021 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3023 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"]), 142, [],
3025 "list extended attributes of a file or directory",
3027 This is the same as C<guestfs_getxattrs>, but if C<path>
3028 is a symbolic link, then it returns the extended attributes
3029 of the link itself.");
3031 ("setxattr", (RErr, [String "xattr";
3032 String "val"; Int "vallen"; (* will be BufferIn *)
3033 Pathname "path"]), 143, [],
3035 "set extended attribute of a file or directory",
3037 This call sets the extended attribute named C<xattr>
3038 of the file C<path> to the value C<val> (of length C<vallen>).
3039 The value is arbitrary 8 bit data.
3041 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3043 ("lsetxattr", (RErr, [String "xattr";
3044 String "val"; Int "vallen"; (* will be BufferIn *)
3045 Pathname "path"]), 144, [],
3047 "set extended attribute of a file or directory",
3049 This is the same as C<guestfs_setxattr>, but if C<path>
3050 is a symbolic link, then it sets an extended attribute
3051 of the link itself.");
3053 ("removexattr", (RErr, [String "xattr"; Pathname "path"]), 145, [],
3055 "remove extended attribute of a file or directory",
3057 This call removes the extended attribute named C<xattr>
3058 of the file C<path>.
3060 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3062 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"]), 146, [],
3064 "remove extended attribute of a file or directory",
3066 This is the same as C<guestfs_removexattr>, but if C<path>
3067 is a symbolic link, then it removes an extended attribute
3068 of the link itself.");
3070 ("mountpoints", (RHashtable "mps", []), 147, [],
3074 This call is similar to C<guestfs_mounts>. That call returns
3075 a list of devices. This one returns a hash table (map) of
3076 device name to directory where the device is mounted.");
3078 ("mkmountpoint", (RErr, [String "exemptpath"]), 148, [],
3079 (* This is a special case: while you would expect a parameter
3080 * of type "Pathname", that doesn't work, because it implies
3081 * NEED_ROOT in the generated calling code in stubs.c, and
3082 * this function cannot use NEED_ROOT.
3085 "create a mountpoint",
3087 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3088 specialized calls that can be used to create extra mountpoints
3089 before mounting the first filesystem.
3091 These calls are I<only> necessary in some very limited circumstances,
3092 mainly the case where you want to mount a mix of unrelated and/or
3093 read-only filesystems together.
3095 For example, live CDs often contain a \"Russian doll\" nest of
3096 filesystems, an ISO outer layer, with a squashfs image inside, with
3097 an ext2/3 image inside that. You can unpack this as follows
3100 add-ro Fedora-11-i686-Live.iso
3103 mkmountpoint /squash
3106 mount-loop /cd/LiveOS/squashfs.img /squash
3107 mount-loop /squash/LiveOS/ext3fs.img /ext3
3109 The inner filesystem is now unpacked under the /ext3 mountpoint.");
3111 ("rmmountpoint", (RErr, [String "exemptpath"]), 149, [],
3113 "remove a mountpoint",
3115 This calls removes a mountpoint that was previously created
3116 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
3117 for full details.");
3119 ("read_file", (RBufferOut "content", [Pathname "path"]), 150, [ProtocolLimitWarning],
3120 [InitISOFS, Always, TestOutputBuffer (
3121 [["read_file"; "/known-4"]], "abc\ndef\nghi")],
3124 This calls returns the contents of the file C<path> as a
3127 Unlike C<guestfs_cat>, this function can correctly
3128 handle files that contain embedded ASCII NUL characters.
3129 However unlike C<guestfs_download>, this function is limited
3130 in the total size of file that can be handled.");
3132 ("grep", (RStringList "lines", [String "regex"; Pathname "path"]), 151, [ProtocolLimitWarning],
3133 [InitISOFS, Always, TestOutputList (
3134 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3135 InitISOFS, Always, TestOutputList (
3136 [["grep"; "nomatch"; "/test-grep.txt"]], [])],
3137 "return lines matching a pattern",
3139 This calls the external C<grep> program and returns the
3142 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"]), 152, [ProtocolLimitWarning],
3143 [InitISOFS, Always, TestOutputList (
3144 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3145 "return lines matching a pattern",
3147 This calls the external C<egrep> program and returns the
3150 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"]), 153, [ProtocolLimitWarning],
3151 [InitISOFS, Always, TestOutputList (
3152 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3153 "return lines matching a pattern",
3155 This calls the external C<fgrep> program and returns the
3158 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"]), 154, [ProtocolLimitWarning],
3159 [InitISOFS, Always, TestOutputList (
3160 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3161 "return lines matching a pattern",
3163 This calls the external C<grep -i> program and returns the
3166 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 155, [ProtocolLimitWarning],
3167 [InitISOFS, Always, TestOutputList (
3168 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3169 "return lines matching a pattern",
3171 This calls the external C<egrep -i> program and returns the
3174 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"]), 156, [ProtocolLimitWarning],
3175 [InitISOFS, Always, TestOutputList (
3176 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3177 "return lines matching a pattern",
3179 This calls the external C<fgrep -i> program and returns the
3182 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"]), 157, [ProtocolLimitWarning],
3183 [InitISOFS, Always, TestOutputList (
3184 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3185 "return lines matching a pattern",
3187 This calls the external C<zgrep> program and returns the
3190 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"]), 158, [ProtocolLimitWarning],
3191 [InitISOFS, Always, TestOutputList (
3192 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3193 "return lines matching a pattern",
3195 This calls the external C<zegrep> program and returns the
3198 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"]), 159, [ProtocolLimitWarning],
3199 [InitISOFS, Always, TestOutputList (
3200 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3201 "return lines matching a pattern",
3203 This calls the external C<zfgrep> program and returns the
3206 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 160, [ProtocolLimitWarning],
3207 [InitISOFS, Always, TestOutputList (
3208 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3209 "return lines matching a pattern",
3211 This calls the external C<zgrep -i> program and returns the
3214 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 161, [ProtocolLimitWarning],
3215 [InitISOFS, Always, TestOutputList (
3216 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3217 "return lines matching a pattern",
3219 This calls the external C<zegrep -i> program and returns the
3222 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"]), 162, [ProtocolLimitWarning],
3223 [InitISOFS, Always, TestOutputList (
3224 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3225 "return lines matching a pattern",
3227 This calls the external C<zfgrep -i> program and returns the
3230 ("realpath", (RString "rpath", [Pathname "path"]), 163, [],
3231 [InitISOFS, Always, TestOutput (
3232 [["realpath"; "/../directory"]], "/directory")],
3233 "canonicalized absolute pathname",
3235 Return the canonicalized absolute pathname of C<path>. The
3236 returned path has no C<.>, C<..> or symbolic link path elements.");
3238 ("ln", (RErr, [String "target"; Pathname "linkname"]), 164, [],
3239 [InitBasicFS, Always, TestOutputStruct (
3242 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3243 "create a hard link",
3245 This command creates a hard link using the C<ln> command.");
3247 ("ln_f", (RErr, [String "target"; Pathname "linkname"]), 165, [],
3248 [InitBasicFS, Always, TestOutputStruct (
3251 ["ln_f"; "/a"; "/b"];
3252 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3253 "create a hard link",
3255 This command creates a hard link using the C<ln -f> command.
3256 The C<-f> option removes the link (C<linkname>) if it exists already.");
3258 ("ln_s", (RErr, [String "target"; Pathname "linkname"]), 166, [],
3259 [InitBasicFS, Always, TestOutputStruct (
3261 ["ln_s"; "a"; "/b"];
3262 ["lstat"; "/b"]], [CompareWithInt ("mode", 0o120777)])],
3263 "create a symbolic link",
3265 This command creates a symbolic link using the C<ln -s> command.");
3267 ("ln_sf", (RErr, [String "target"; Pathname "linkname"]), 167, [],
3268 [InitBasicFS, Always, TestOutput (
3269 [["mkdir_p"; "/a/b"];
3270 ["touch"; "/a/b/c"];
3271 ["ln_sf"; "../d"; "/a/b/c"];
3272 ["readlink"; "/a/b/c"]], "../d")],
3273 "create a symbolic link",
3275 This command creates a symbolic link using the C<ln -sf> command,
3276 The C<-f> option removes the link (C<linkname>) if it exists already.");
3278 ("readlink", (RString "link", [Pathname "path"]), 168, [],
3279 [] (* XXX tested above *),
3280 "read the target of a symbolic link",
3282 This command reads the target of a symbolic link.");
3284 ("fallocate", (RErr, [Pathname "path"; Int "len"]), 169, [],
3285 [InitBasicFS, Always, TestOutputStruct (
3286 [["fallocate"; "/a"; "1000000"];
3287 ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
3288 "preallocate a file in the guest filesystem",
3290 This command preallocates a file (containing zero bytes) named
3291 C<path> of size C<len> bytes. If the file exists already, it
3294 Do not confuse this with the guestfish-specific
3295 C<alloc> command which allocates a file in the host and
3296 attaches it as a device.");
3298 ("swapon_device", (RErr, [Device "device"]), 170, [],
3299 [InitPartition, Always, TestRun (
3300 [["mkswap"; "/dev/sda1"];
3301 ["swapon_device"; "/dev/sda1"];
3302 ["swapoff_device"; "/dev/sda1"]])],
3303 "enable swap on device",
3305 This command enables the libguestfs appliance to use the
3306 swap device or partition named C<device>. The increased
3307 memory is made available for all commands, for example
3308 those run using C<guestfs_command> or C<guestfs_sh>.
3310 Note that you should not swap to existing guest swap
3311 partitions unless you know what you are doing. They may
3312 contain hibernation information, or other information that
3313 the guest doesn't want you to trash. You also risk leaking
3314 information about the host to the guest this way. Instead,
3315 attach a new host device to the guest and swap on that.");
3317 ("swapoff_device", (RErr, [Device "device"]), 171, [],
3318 [], (* XXX tested by swapon_device *)
3319 "disable swap on device",
3321 This command disables the libguestfs appliance swap
3322 device or partition named C<device>.
3323 See C<guestfs_swapon_device>.");
3325 ("swapon_file", (RErr, [Pathname "file"]), 172, [],
3326 [InitBasicFS, Always, TestRun (
3327 [["fallocate"; "/swap"; "8388608"];
3328 ["mkswap_file"; "/swap"];
3329 ["swapon_file"; "/swap"];
3330 ["swapoff_file"; "/swap"]])],
3331 "enable swap on file",
3333 This command enables swap to a file.
3334 See C<guestfs_swapon_device> for other notes.");
3336 ("swapoff_file", (RErr, [Pathname "file"]), 173, [],
3337 [], (* XXX tested by swapon_file *)
3338 "disable swap on file",
3340 This command disables the libguestfs appliance swap on file.");
3342 ("swapon_label", (RErr, [String "label"]), 174, [],
3343 [InitEmpty, Always, TestRun (
3344 [["sfdiskM"; "/dev/sdb"; ","];
3345 ["mkswap_L"; "swapit"; "/dev/sdb1"];
3346 ["swapon_label"; "swapit"];
3347 ["swapoff_label"; "swapit"];
3348 ["zero"; "/dev/sdb"];
3349 ["blockdev_rereadpt"; "/dev/sdb"]])],
3350 "enable swap on labeled swap partition",
3352 This command enables swap to a labeled swap partition.
3353 See C<guestfs_swapon_device> for other notes.");
3355 ("swapoff_label", (RErr, [String "label"]), 175, [],
3356 [], (* XXX tested by swapon_label *)
3357 "disable swap on labeled swap partition",
3359 This command disables the libguestfs appliance swap on
3360 labeled swap partition.");
3362 ("swapon_uuid", (RErr, [String "uuid"]), 176, [],
3363 (let uuid = uuidgen () in
3364 [InitEmpty, Always, TestRun (
3365 [["mkswap_U"; uuid; "/dev/sdb"];
3366 ["swapon_uuid"; uuid];
3367 ["swapoff_uuid"; uuid]])]),
3368 "enable swap on swap partition by UUID",
3370 This command enables swap to a swap partition with the given UUID.
3371 See C<guestfs_swapon_device> for other notes.");
3373 ("swapoff_uuid", (RErr, [String "uuid"]), 177, [],
3374 [], (* XXX tested by swapon_uuid *)
3375 "disable swap on swap partition by UUID",
3377 This command disables the libguestfs appliance swap partition
3378 with the given UUID.");
3380 ("mkswap_file", (RErr, [Pathname "path"]), 178, [],
3381 [InitBasicFS, Always, TestRun (
3382 [["fallocate"; "/swap"; "8388608"];
3383 ["mkswap_file"; "/swap"]])],
3384 "create a swap file",
3388 This command just writes a swap file signature to an existing
3389 file. To create the file itself, use something like C<guestfs_fallocate>.");
3391 ("inotify_init", (RErr, [Int "maxevents"]), 179, [],
3392 [InitISOFS, Always, TestRun (
3393 [["inotify_init"; "0"]])],
3394 "create an inotify handle",
3396 This command creates a new inotify handle.
3397 The inotify subsystem can be used to notify events which happen to
3398 objects in the guest filesystem.
3400 C<maxevents> is the maximum number of events which will be
3401 queued up between calls to C<guestfs_inotify_read> or
3402 C<guestfs_inotify_files>.
3403 If this is passed as C<0>, then the kernel (or previously set)
3404 default is used. For Linux 2.6.29 the default was 16384 events.
3405 Beyond this limit, the kernel throws away events, but records
3406 the fact that it threw them away by setting a flag
3407 C<IN_Q_OVERFLOW> in the returned structure list (see
3408 C<guestfs_inotify_read>).
3410 Before any events are generated, you have to add some
3411 watches to the internal watch list. See:
3412 C<guestfs_inotify_add_watch>,
3413 C<guestfs_inotify_rm_watch> and
3414 C<guestfs_inotify_watch_all>.
3416 Queued up events should be read periodically by calling
3417 C<guestfs_inotify_read>
3418 (or C<guestfs_inotify_files> which is just a helpful
3419 wrapper around C<guestfs_inotify_read>). If you don't
3420 read the events out often enough then you risk the internal
3423 The handle should be closed after use by calling
3424 C<guestfs_inotify_close>. This also removes any
3425 watches automatically.
3427 See also L<inotify(7)> for an overview of the inotify interface
3428 as exposed by the Linux kernel, which is roughly what we expose
3429 via libguestfs. Note that there is one global inotify handle
3430 per libguestfs instance.");
3432 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"]), 180, [],
3433 [InitBasicFS, Always, TestOutputList (
3434 [["inotify_init"; "0"];
3435 ["inotify_add_watch"; "/"; "1073741823"];
3438 ["inotify_files"]], ["a"; "b"])],
3439 "add an inotify watch",
3441 Watch C<path> for the events listed in C<mask>.
3443 Note that if C<path> is a directory then events within that
3444 directory are watched, but this does I<not> happen recursively
3445 (in subdirectories).
3447 Note for non-C or non-Linux callers: the inotify events are
3448 defined by the Linux kernel ABI and are listed in
3449 C</usr/include/sys/inotify.h>.");
3451 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"]), 181, [],
3453 "remove an inotify watch",
3455 Remove a previously defined inotify watch.
3456 See C<guestfs_inotify_add_watch>.");
3458 ("inotify_read", (RStructList ("events", "inotify_event"), []), 182, [],
3460 "return list of inotify events",
3462 Return the complete queue of events that have happened
3463 since the previous read call.
3465 If no events have happened, this returns an empty list.
3467 I<Note>: In order to make sure that all events have been
3468 read, you must call this function repeatedly until it
3469 returns an empty list. The reason is that the call will
3470 read events up to the maximum appliance-to-host message
3471 size and leave remaining events in the queue.");
3473 ("inotify_files", (RStringList "paths", []), 183, [],
3475 "return list of watched files that had events",
3477 This function is a helpful wrapper around C<guestfs_inotify_read>
3478 which just returns a list of pathnames of objects that were
3479 touched. The returned pathnames are sorted and deduplicated.");
3481 ("inotify_close", (RErr, []), 184, [],
3483 "close the inotify handle",
3485 This closes the inotify handle which was previously
3486 opened by inotify_init. It removes all watches, throws
3487 away any pending events, and deallocates all resources.");
3489 ("setcon", (RErr, [String "context"]), 185, [],
3491 "set SELinux security context",
3493 This sets the SELinux security context of the daemon
3494 to the string C<context>.
3496 See the documentation about SELINUX in L<guestfs(3)>.");
3498 ("getcon", (RString "context", []), 186, [],
3500 "get SELinux security context",
3502 This gets the SELinux security context of the daemon.
3504 See the documentation about SELINUX in L<guestfs(3)>,
3505 and C<guestfs_setcon>");
3507 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"]), 187, [],
3508 [InitEmpty, Always, TestOutput (
3509 [["sfdiskM"; "/dev/sda"; ","];
3510 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
3511 ["mount"; "/dev/sda1"; "/"];
3512 ["write_file"; "/new"; "new file contents"; "0"];
3513 ["cat"; "/new"]], "new file contents")],
3514 "make a filesystem with block size",
3516 This call is similar to C<guestfs_mkfs>, but it allows you to
3517 control the block size of the resulting filesystem. Supported
3518 block sizes depend on the filesystem type, but typically they
3519 are C<1024>, C<2048> or C<4096> only.");
3521 ("mke2journal", (RErr, [Int "blocksize"; Device "device"]), 188, [],
3522 [InitEmpty, Always, TestOutput (
3523 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3524 ["mke2journal"; "4096"; "/dev/sda1"];
3525 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
3526 ["mount"; "/dev/sda2"; "/"];
3527 ["write_file"; "/new"; "new file contents"; "0"];
3528 ["cat"; "/new"]], "new file contents")],
3529 "make ext2/3/4 external journal",
3531 This creates an ext2 external journal on C<device>. It is equivalent
3534 mke2fs -O journal_dev -b blocksize device");
3536 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"]), 189, [],
3537 [InitEmpty, Always, TestOutput (
3538 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3539 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
3540 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
3541 ["mount"; "/dev/sda2"; "/"];
3542 ["write_file"; "/new"; "new file contents"; "0"];
3543 ["cat"; "/new"]], "new file contents")],
3544 "make ext2/3/4 external journal with label",
3546 This creates an ext2 external journal on C<device> with label C<label>.");
3548 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"]), 190, [],
3549 (let uuid = uuidgen () in
3550 [InitEmpty, Always, TestOutput (
3551 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3552 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
3553 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
3554 ["mount"; "/dev/sda2"; "/"];
3555 ["write_file"; "/new"; "new file contents"; "0"];
3556 ["cat"; "/new"]], "new file contents")]),
3557 "make ext2/3/4 external journal with UUID",
3559 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
3561 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"]), 191, [],
3563 "make ext2/3/4 filesystem with external journal",
3565 This creates an ext2/3/4 filesystem on C<device> with
3566 an external journal on C<journal>. It is equivalent
3569 mke2fs -t fstype -b blocksize -J device=<journal> <device>
3571 See also C<guestfs_mke2journal>.");
3573 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"]), 192, [],
3575 "make ext2/3/4 filesystem with external journal",
3577 This creates an ext2/3/4 filesystem on C<device> with
3578 an external journal on the journal labeled C<label>.
3580 See also C<guestfs_mke2journal_L>.");
3582 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"]), 193, [],
3584 "make ext2/3/4 filesystem with external journal",
3586 This creates an ext2/3/4 filesystem on C<device> with
3587 an external journal on the journal with UUID C<uuid>.
3589 See also C<guestfs_mke2journal_U>.");
3591 ("modprobe", (RErr, [String "modulename"]), 194, [],
3592 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
3593 "load a kernel module",
3595 This loads a kernel module in the appliance.
3597 The kernel module must have been whitelisted when libguestfs
3598 was built (see C<appliance/kmod.whitelist.in> in the source).");
3600 ("echo_daemon", (RString "output", [StringList "words"]), 195, [],
3601 [InitNone, Always, TestOutput (
3602 [["echo_daemon"; "This is a test"]], "This is a test"
3604 "echo arguments back to the client",
3606 This command concatenate the list of C<words> passed with single spaces between
3607 them and returns the resulting string.
3609 You can use this command to test the connection through to the daemon.
3611 See also C<guestfs_ping_daemon>.");
3615 let all_functions = non_daemon_functions @ daemon_functions
3617 (* In some places we want the functions to be displayed sorted
3618 * alphabetically, so this is useful:
3620 let all_functions_sorted =
3621 List.sort (fun (n1,_,_,_,_,_,_) (n2,_,_,_,_,_,_) ->
3622 compare n1 n2) all_functions
3624 (* Field types for structures. *)
3626 | FChar (* C 'char' (really, a 7 bit byte). *)
3627 | FString (* nul-terminated ASCII string, NOT NULL. *)
3628 | FBuffer (* opaque buffer of bytes, (char *, int) pair *)
3633 | FBytes (* Any int measure that counts bytes. *)
3634 | FUUID (* 32 bytes long, NOT nul-terminated. *)
3635 | FOptPercent (* [0..100], or -1 meaning "not present". *)
3637 (* Because we generate extra parsing code for LVM command line tools,
3638 * we have to pull out the LVM columns separately here.
3648 "pv_attr", FString (* XXX *);
3649 "pv_pe_count", FInt64;
3650 "pv_pe_alloc_count", FInt64;
3653 "pv_mda_count", FInt64;
3654 "pv_mda_free", FBytes;
3655 (* Not in Fedora 10:
3656 "pv_mda_size", FBytes;
3663 "vg_attr", FString (* XXX *);
3666 "vg_sysid", FString;
3667 "vg_extent_size", FBytes;
3668 "vg_extent_count", FInt64;
3669 "vg_free_count", FInt64;
3674 "snap_count", FInt64;
3677 "vg_mda_count", FInt64;
3678 "vg_mda_free", FBytes;
3679 (* Not in Fedora 10:
3680 "vg_mda_size", FBytes;
3686 "lv_attr", FString (* XXX *);
3689 "lv_kernel_major", FInt64;
3690 "lv_kernel_minor", FInt64;
3692 "seg_count", FInt64;
3694 "snap_percent", FOptPercent;
3695 "copy_percent", FOptPercent;
3698 "mirror_log", FString;
3702 (* Names and fields in all structures (in RStruct and RStructList)
3706 (* The old RIntBool return type, only ever used for aug_defnode. Do
3707 * not use this struct in any new code.
3710 "i", FInt32; (* for historical compatibility *)
3711 "b", FInt32; (* for historical compatibility *)
3714 (* LVM PVs, VGs, LVs. *)
3715 "lvm_pv", lvm_pv_cols;
3716 "lvm_vg", lvm_vg_cols;
3717 "lvm_lv", lvm_lv_cols;
3719 (* Column names and types from stat structures.
3720 * NB. Can't use things like 'st_atime' because glibc header files
3721 * define some of these as macros. Ugh.
3752 (* Column names in dirent structure. *)
3755 (* 'b' 'c' 'd' 'f' (FIFO) 'l' 'r' (regular file) 's' 'u' '?' *)
3760 (* Version numbers. *)
3768 (* Extended attribute. *)
3770 "attrname", FString;
3774 (* Inotify events. *)
3778 "in_cookie", FUInt32;
3781 ] (* end of structs *)
3783 (* Ugh, Java has to be different ..
3784 * These names are also used by the Haskell bindings.
3786 let java_structs = [
3787 "int_bool", "IntBool";
3792 "statvfs", "StatVFS";
3794 "version", "Version";
3796 "inotify_event", "INotifyEvent";
3799 (* What structs are actually returned. *)
3800 type rstructs_used_t = RStructOnly | RStructListOnly | RStructAndList
3802 (* Returns a list of RStruct/RStructList structs that are returned
3803 * by any function. Each element of returned list is a pair:
3805 * (structname, RStructOnly)
3806 * == there exists function which returns RStruct (_, structname)
3807 * (structname, RStructListOnly)
3808 * == there exists function which returns RStructList (_, structname)
3809 * (structname, RStructAndList)
3810 * == there are functions returning both RStruct (_, structname)
3811 * and RStructList (_, structname)
3814 (* ||| is a "logical OR" for rstructs_used_t *)
3818 | _, RStructAndList -> RStructAndList
3819 | RStructOnly, RStructListOnly
3820 | RStructListOnly, RStructOnly -> RStructAndList
3821 | RStructOnly, RStructOnly -> RStructOnly
3822 | RStructListOnly, RStructListOnly -> RStructListOnly
3825 let h = Hashtbl.create 13 in
3827 (* if elem->oldv exists, update entry using ||| operator,
3828 * else just add elem->newv to the hash
3830 let update elem newv =
3831 try let oldv = Hashtbl.find h elem in
3832 Hashtbl.replace h elem (newv ||| oldv)
3833 with Not_found -> Hashtbl.add h elem newv
3837 fun (_, style, _, _, _, _, _) ->
3838 match fst style with
3839 | RStruct (_, structname) -> update structname RStructOnly
3840 | RStructList (_, structname) -> update structname RStructListOnly
3844 (* return key->values as a list of (key,value) *)
3845 Hashtbl.fold (fun key value xs -> (key, value) :: xs) h []
3851 | sn, RStructOnly -> printf "%s RStructOnly\n" sn
3852 | sn, RStructListOnly -> printf "%s RStructListOnly\n" sn
3853 | sn, RStructAndList -> printf "%s RStructAndList\n" sn
3857 (* Used for testing language bindings. *)
3859 | CallString of string
3860 | CallOptString of string option
3861 | CallStringList of string list
3865 (* Used to memoize the result of pod2text. *)
3866 let pod2text_memo_filename = "src/.pod2text.data"
3867 let pod2text_memo : ((int * string * string), string list) Hashtbl.t =
3869 let chan = open_in pod2text_memo_filename in
3870 let v = input_value chan in
3874 _ -> Hashtbl.create 13
3875 let pod2text_memo_updated () =
3876 let chan = open_out pod2text_memo_filename in
3877 output_value chan pod2text_memo;
3880 (* Useful functions.
3881 * Note we don't want to use any external OCaml libraries which
3882 * makes this a bit harder than it should be.
3884 let failwithf fs = ksprintf failwith fs
3886 let replace_char s c1 c2 =
3887 let s2 = String.copy s in
3888 let r = ref false in
3889 for i = 0 to String.length s2 - 1 do
3890 if String.unsafe_get s2 i = c1 then (
3891 String.unsafe_set s2 i c2;
3895 if not !r then s else s2
3899 (* || c = '\f' *) || c = '\n' || c = '\r' || c = '\t' (* || c = '\v' *)
3901 let triml ?(test = isspace) str =
3903 let n = ref (String.length str) in
3904 while !n > 0 && test str.[!i]; do
3909 else String.sub str !i !n
3911 let trimr ?(test = isspace) str =
3912 let n = ref (String.length str) in
3913 while !n > 0 && test str.[!n-1]; do
3916 if !n = String.length str then str
3917 else String.sub str 0 !n
3919 let trim ?(test = isspace) str =
3920 trimr ~test (triml ~test str)
3922 let rec find s sub =
3923 let len = String.length s in
3924 let sublen = String.length sub in
3926 if i <= len-sublen then (
3928 if j < sublen then (
3929 if s.[i+j] = sub.[j] then loop2 (j+1)
3935 if r = -1 then loop (i+1) else r
3941 let rec replace_str s s1 s2 =
3942 let len = String.length s in
3943 let sublen = String.length s1 in
3944 let i = find s s1 in
3947 let s' = String.sub s 0 i in
3948 let s'' = String.sub s (i+sublen) (len-i-sublen) in
3949 s' ^ s2 ^ replace_str s'' s1 s2
3952 let rec string_split sep str =
3953 let len = String.length str in
3954 let seplen = String.length sep in
3955 let i = find str sep in
3956 if i = -1 then [str]
3958 let s' = String.sub str 0 i in
3959 let s'' = String.sub str (i+seplen) (len-i-seplen) in
3960 s' :: string_split sep s''
3963 let files_equal n1 n2 =
3964 let cmd = sprintf "cmp -s %s %s" (Filename.quote n1) (Filename.quote n2) in
3965 match Sys.command cmd with
3968 | i -> failwithf "%s: failed with error code %d" cmd i
3970 let rec filter_map f = function
3974 | Some y -> y :: filter_map f xs
3975 | None -> filter_map f xs
3977 let rec find_map f = function
3978 | [] -> raise Not_found
3982 | None -> find_map f xs
3985 let rec loop i = function
3987 | x :: xs -> f i x; loop (i+1) xs
3992 let rec loop i = function
3994 | x :: xs -> let r = f i x in r :: loop (i+1) xs
3998 let name_of_argt = function
3999 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
4000 | StringList n | DeviceList n | Bool n | Int n
4001 | FileIn n | FileOut n -> n
4003 let java_name_of_struct typ =
4004 try List.assoc typ java_structs
4007 "java_name_of_struct: no java_structs entry corresponding to %s" typ
4009 let cols_of_struct typ =
4010 try List.assoc typ structs
4012 failwithf "cols_of_struct: unknown struct %s" typ
4014 let seq_of_test = function
4015 | TestRun s | TestOutput (s, _) | TestOutputList (s, _)
4016 | TestOutputListOfDevices (s, _)
4017 | TestOutputInt (s, _) | TestOutputIntOp (s, _, _)
4018 | TestOutputTrue s | TestOutputFalse s
4019 | TestOutputLength (s, _) | TestOutputBuffer (s, _)
4020 | TestOutputStruct (s, _)
4021 | TestLastFail s -> s
4023 (* Handling for function flags. *)
4024 let protocol_limit_warning =
4025 "Because of the message protocol, there is a transfer limit
4026 of somewhere between 2MB and 4MB. To transfer large files you should use
4029 let danger_will_robinson =
4030 "B<This command is dangerous. Without careful use you
4031 can easily destroy all your data>."
4033 let deprecation_notice flags =
4036 find_map (function DeprecatedBy str -> Some str | _ -> None) flags in
4038 sprintf "This function is deprecated.
4039 In new code, use the C<%s> call instead.
4041 Deprecated functions will not be removed from the API, but the
4042 fact that they are deprecated indicates that there are problems
4043 with correct use of these functions." alt in
4048 (* Check function names etc. for consistency. *)
4049 let check_functions () =
4050 let contains_uppercase str =
4051 let len = String.length str in
4053 if i >= len then false
4056 if c >= 'A' && c <= 'Z' then true
4063 (* Check function names. *)
4065 fun (name, _, _, _, _, _, _) ->
4066 if String.length name >= 7 && String.sub name 0 7 = "guestfs" then
4067 failwithf "function name %s does not need 'guestfs' prefix" name;
4069 failwithf "function name is empty";
4070 if name.[0] < 'a' || name.[0] > 'z' then
4071 failwithf "function name %s must start with lowercase a-z" name;
4072 if String.contains name '-' then
4073 failwithf "function name %s should not contain '-', use '_' instead."
4077 (* Check function parameter/return names. *)
4079 fun (name, style, _, _, _, _, _) ->
4080 let check_arg_ret_name n =
4081 if contains_uppercase n then
4082 failwithf "%s param/ret %s should not contain uppercase chars"
4084 if String.contains n '-' || String.contains n '_' then
4085 failwithf "%s param/ret %s should not contain '-' or '_'"
4088 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;
4089 if n = "int" || n = "char" || n = "short" || n = "long" then
4090 failwithf "%s has a param/ret which conflicts with a C type (eg. 'int', 'char' etc.)" name;
4091 if n = "i" || n = "n" then
4092 failwithf "%s has a param/ret called 'i' or 'n', which will cause some conflicts in the generated code" name;
4093 if n = "argv" || n = "args" then
4094 failwithf "%s has a param/ret called 'argv' or 'args', which will cause some conflicts in the generated code" name;
4096 (* List Haskell, OCaml and C keywords here.
4097 * http://www.haskell.org/haskellwiki/Keywords
4098 * http://caml.inria.fr/pub/docs/manual-ocaml/lex.html#operator-char
4099 * http://en.wikipedia.org/wiki/C_syntax#Reserved_keywords
4100 * Formatted via: cat c haskell ocaml|sort -u|grep -vE '_|^val$' \
4101 * |perl -pe 's/(.+)/"$1";/'|fmt -70
4102 * Omitting _-containing words, since they're handled above.
4103 * Omitting the OCaml reserved word, "val", is ok,
4104 * and saves us from renaming several parameters.
4107 "and"; "as"; "asr"; "assert"; "auto"; "begin"; "break"; "case";
4108 "char"; "class"; "const"; "constraint"; "continue"; "data";
4109 "default"; "deriving"; "do"; "done"; "double"; "downto"; "else";
4110 "end"; "enum"; "exception"; "extern"; "external"; "false"; "float";
4111 "for"; "forall"; "foreign"; "fun"; "function"; "functor"; "goto";
4112 "hiding"; "if"; "import"; "in"; "include"; "infix"; "infixl";
4113 "infixr"; "inherit"; "initializer"; "inline"; "instance"; "int";
4114 "land"; "lazy"; "let"; "long"; "lor"; "lsl"; "lsr"; "lxor";
4115 "match"; "mdo"; "method"; "mod"; "module"; "mutable"; "new";
4116 "newtype"; "object"; "of"; "open"; "or"; "private"; "qualified";
4117 "rec"; "register"; "restrict"; "return"; "short"; "sig"; "signed";
4118 "sizeof"; "static"; "struct"; "switch"; "then"; "to"; "true"; "try";
4119 "type"; "typedef"; "union"; "unsigned"; "virtual"; "void";
4120 "volatile"; "when"; "where"; "while";
4122 if List.mem n reserved then
4123 failwithf "%s has param/ret using reserved word %s" name n;
4126 (match fst style with
4128 | RInt n | RInt64 n | RBool n
4129 | RConstString n | RConstOptString n | RString n
4130 | RStringList n | RStruct (n, _) | RStructList (n, _)
4131 | RHashtable n | RBufferOut n ->
4132 check_arg_ret_name n
4134 List.iter (fun arg -> check_arg_ret_name (name_of_argt arg)) (snd style)
4137 (* Check short descriptions. *)
4139 fun (name, _, _, _, _, shortdesc, _) ->
4140 if shortdesc.[0] <> Char.lowercase shortdesc.[0] then
4141 failwithf "short description of %s should begin with lowercase." name;
4142 let c = shortdesc.[String.length shortdesc-1] in
4143 if c = '\n' || c = '.' then
4144 failwithf "short description of %s should not end with . or \\n." name
4147 (* Check long dscriptions. *)
4149 fun (name, _, _, _, _, _, longdesc) ->
4150 if longdesc.[String.length longdesc-1] = '\n' then
4151 failwithf "long description of %s should not end with \\n." name
4154 (* Check proc_nrs. *)
4156 fun (name, _, proc_nr, _, _, _, _) ->
4157 if proc_nr <= 0 then
4158 failwithf "daemon function %s should have proc_nr > 0" name
4162 fun (name, _, proc_nr, _, _, _, _) ->
4163 if proc_nr <> -1 then
4164 failwithf "non-daemon function %s should have proc_nr -1" name
4165 ) non_daemon_functions;
4168 List.map (fun (name, _, proc_nr, _, _, _, _) -> name, proc_nr)
4171 List.sort (fun (_,nr1) (_,nr2) -> compare nr1 nr2) proc_nrs in
4172 let rec loop = function
4175 | (name1,nr1) :: ((name2,nr2) :: _ as rest) when nr1 < nr2 ->
4177 | (name1,nr1) :: (name2,nr2) :: _ ->
4178 failwithf "%s and %s have conflicting procedure numbers (%d, %d)"
4186 (* Ignore functions that have no tests. We generate a
4187 * warning when the user does 'make check' instead.
4189 | name, _, _, _, [], _, _ -> ()
4190 | name, _, _, _, tests, _, _ ->
4194 match seq_of_test test with
4196 failwithf "%s has a test containing an empty sequence" name
4197 | cmds -> List.map List.hd cmds
4199 let funcs = List.flatten funcs in
4201 let tested = List.mem name funcs in
4204 failwithf "function %s has tests but does not test itself" name
4207 (* 'pr' prints to the current output file. *)
4208 let chan = ref stdout
4209 let pr fs = ksprintf (output_string !chan) fs
4211 (* Generate a header block in a number of standard styles. *)
4212 type comment_style = CStyle | HashStyle | OCamlStyle | HaskellStyle
4213 type license = GPLv2 | LGPLv2
4215 let generate_header comment license =
4216 let c = match comment with
4217 | CStyle -> pr "/* "; " *"
4218 | HashStyle -> pr "# "; "#"
4219 | OCamlStyle -> pr "(* "; " *"
4220 | HaskellStyle -> pr "{- "; " " in
4221 pr "libguestfs generated file\n";
4222 pr "%s WARNING: THIS FILE IS GENERATED BY 'src/generator.ml'.\n" c;
4223 pr "%s ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.\n" c;
4225 pr "%s Copyright (C) 2009 Red Hat Inc.\n" c;
4229 pr "%s This program is free software; you can redistribute it and/or modify\n" c;
4230 pr "%s it under the terms of the GNU General Public License as published by\n" c;
4231 pr "%s the Free Software Foundation; either version 2 of the License, or\n" c;
4232 pr "%s (at your option) any later version.\n" c;
4234 pr "%s This program is distributed in the hope that it will be useful,\n" c;
4235 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
4236 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" c;
4237 pr "%s GNU General Public License for more details.\n" c;
4239 pr "%s You should have received a copy of the GNU General Public License along\n" c;
4240 pr "%s with this program; if not, write to the Free Software Foundation, Inc.,\n" c;
4241 pr "%s 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n" c;
4244 pr "%s This library is free software; you can redistribute it and/or\n" c;
4245 pr "%s modify it under the terms of the GNU Lesser General Public\n" c;
4246 pr "%s License as published by the Free Software Foundation; either\n" c;
4247 pr "%s version 2 of the License, or (at your option) any later version.\n" c;
4249 pr "%s This library is distributed in the hope that it will be useful,\n" c;
4250 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
4251 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n" c;
4252 pr "%s Lesser General Public License for more details.\n" c;
4254 pr "%s You should have received a copy of the GNU Lesser General Public\n" c;
4255 pr "%s License along with this library; if not, write to the Free Software\n" c;
4256 pr "%s Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n" c;
4259 | CStyle -> pr " */\n"
4261 | OCamlStyle -> pr " *)\n"
4262 | HaskellStyle -> pr "-}\n"
4266 (* Start of main code generation functions below this line. *)
4268 (* Generate the pod documentation for the C API. *)
4269 let rec generate_actions_pod () =
4271 fun (shortname, style, _, flags, _, _, longdesc) ->
4272 if not (List.mem NotInDocs flags) then (
4273 let name = "guestfs_" ^ shortname in
4274 pr "=head2 %s\n\n" name;
4276 generate_prototype ~extern:false ~handle:"handle" name style;
4278 pr "%s\n\n" longdesc;
4279 (match fst style with
4281 pr "This function returns 0 on success or -1 on error.\n\n"
4283 pr "On error this function returns -1.\n\n"
4285 pr "On error this function returns -1.\n\n"
4287 pr "This function returns a C truth value on success or -1 on error.\n\n"
4289 pr "This function returns a string, or NULL on error.
4290 The string is owned by the guest handle and must I<not> be freed.\n\n"
4291 | RConstOptString _ ->
4292 pr "This function returns a string which may be NULL.
4293 There is way to return an error from this function.
4294 The string is owned by the guest handle and must I<not> be freed.\n\n"
4296 pr "This function returns a string, or NULL on error.
4297 I<The caller must free the returned string after use>.\n\n"
4299 pr "This function returns a NULL-terminated array of strings
4300 (like L<environ(3)>), or NULL if there was an error.
4301 I<The caller must free the strings and the array after use>.\n\n"
4302 | RStruct (_, typ) ->
4303 pr "This function returns a C<struct guestfs_%s *>,
4304 or NULL if there was an error.
4305 I<The caller must call C<guestfs_free_%s> after use>.\n\n" typ typ
4306 | RStructList (_, typ) ->
4307 pr "This function returns a C<struct guestfs_%s_list *>
4308 (see E<lt>guestfs-structs.hE<gt>),
4309 or NULL if there was an error.
4310 I<The caller must call C<guestfs_free_%s_list> after use>.\n\n" typ typ
4312 pr "This function returns a NULL-terminated array of
4313 strings, or NULL if there was an error.
4314 The array of strings will always have length C<2n+1>, where
4315 C<n> keys and values alternate, followed by the trailing NULL entry.
4316 I<The caller must free the strings and the array after use>.\n\n"
4318 pr "This function returns a buffer, or NULL on error.
4319 The size of the returned buffer is written to C<*size_r>.
4320 I<The caller must free the returned buffer after use>.\n\n"
4322 if List.mem ProtocolLimitWarning flags then
4323 pr "%s\n\n" protocol_limit_warning;
4324 if List.mem DangerWillRobinson flags then
4325 pr "%s\n\n" danger_will_robinson;
4326 match deprecation_notice flags with
4328 | Some txt -> pr "%s\n\n" txt
4330 ) all_functions_sorted
4332 and generate_structs_pod () =
4333 (* Structs documentation. *)
4336 pr "=head2 guestfs_%s\n" typ;
4338 pr " struct guestfs_%s {\n" typ;
4341 | name, FChar -> pr " char %s;\n" name
4342 | name, FUInt32 -> pr " uint32_t %s;\n" name
4343 | name, FInt32 -> pr " int32_t %s;\n" name
4344 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
4345 | name, FInt64 -> pr " int64_t %s;\n" name
4346 | name, FString -> pr " char *%s;\n" name
4348 pr " /* The next two fields describe a byte array. */\n";
4349 pr " uint32_t %s_len;\n" name;
4350 pr " char *%s;\n" name
4352 pr " /* The next field is NOT nul-terminated, be careful when printing it: */\n";
4353 pr " char %s[32];\n" name
4354 | name, FOptPercent ->
4355 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
4356 pr " float %s;\n" name
4360 pr " struct guestfs_%s_list {\n" typ;
4361 pr " uint32_t len; /* Number of elements in list. */\n";
4362 pr " struct guestfs_%s *val; /* Elements. */\n" typ;
4365 pr " void guestfs_free_%s (struct guestfs_free_%s *);\n" typ typ;
4366 pr " void guestfs_free_%s_list (struct guestfs_free_%s_list *);\n"
4371 (* Generate the protocol (XDR) file, 'guestfs_protocol.x' and
4372 * indirectly 'guestfs_protocol.h' and 'guestfs_protocol.c'.
4374 * We have to use an underscore instead of a dash because otherwise
4375 * rpcgen generates incorrect code.
4377 * This header is NOT exported to clients, but see also generate_structs_h.
4379 and generate_xdr () =
4380 generate_header CStyle LGPLv2;
4382 (* This has to be defined to get around a limitation in Sun's rpcgen. *)
4383 pr "typedef string str<>;\n";
4386 (* Internal structures. *)
4390 pr "struct guestfs_int_%s {\n" typ;
4392 | name, FChar -> pr " char %s;\n" name
4393 | name, FString -> pr " string %s<>;\n" name
4394 | name, FBuffer -> pr " opaque %s<>;\n" name
4395 | name, FUUID -> pr " opaque %s[32];\n" name
4396 | name, (FInt32|FUInt32) -> pr " int %s;\n" name
4397 | name, (FInt64|FUInt64|FBytes) -> pr " hyper %s;\n" name
4398 | name, FOptPercent -> pr " float %s;\n" name
4402 pr "typedef struct guestfs_int_%s guestfs_int_%s_list<>;\n" typ typ;