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 | Int64 of string (* any 64 bit int *)
146 (* These are treated as filenames (simple string parameters) in
147 * the C API and bindings. But in the RPC protocol, we transfer
148 * the actual file content up to or down from the daemon.
149 * FileIn: local machine -> daemon (in request)
150 * FileOut: daemon -> local machine (in reply)
151 * In guestfish (only), the special name "-" means read from
152 * stdin or write to stdout.
157 (* Opaque buffer which can contain arbitrary 8 bit data.
158 * In the C API, this is expressed as <char *, int> pair.
159 * Most other languages have a string type which can contain
160 * ASCII NUL. We use whatever type is appropriate for each
162 * Buffers are limited by the total message size. To transfer
163 * large blocks of data, use FileIn/FileOut parameters instead.
164 * To return an arbitrary buffer, use RBufferOut.
170 | ProtocolLimitWarning (* display warning about protocol size limits *)
171 | DangerWillRobinson (* flags particularly dangerous commands *)
172 | FishAlias of string (* provide an alias for this cmd in guestfish *)
173 | FishAction of string (* call this function in guestfish *)
174 | NotInFish (* do not export via guestfish *)
175 | NotInDocs (* do not add this function to documentation *)
176 | DeprecatedBy of string (* function is deprecated, use .. instead *)
178 (* You can supply zero or as many tests as you want per API call.
180 * Note that the test environment has 3 block devices, of size 500MB,
181 * 50MB and 10MB (respectively /dev/sda, /dev/sdb, /dev/sdc), and
182 * a fourth ISO block device with some known files on it (/dev/sdd).
184 * Note for partitioning purposes, the 500MB device has 1015 cylinders.
185 * Number of cylinders was 63 for IDE emulated disks with precisely
186 * the same size. How exactly this is calculated is a mystery.
188 * The ISO block device (/dev/sdd) comes from images/test.iso.
190 * To be able to run the tests in a reasonable amount of time,
191 * the virtual machine and block devices are reused between tests.
192 * So don't try testing kill_subprocess :-x
194 * Between each test we blockdev-setrw, umount-all, lvm-remove-all.
196 * Don't assume anything about the previous contents of the block
197 * devices. Use 'Init*' to create some initial scenarios.
199 * You can add a prerequisite clause to any individual test. This
200 * is a run-time check, which, if it fails, causes the test to be
201 * skipped. Useful if testing a command which might not work on
202 * all variations of libguestfs builds. A test that has prerequisite
203 * of 'Always' is run unconditionally.
205 * In addition, packagers can skip individual tests by setting the
206 * environment variables: eg:
207 * SKIP_TEST_<CMD>_<NUM>=1 SKIP_TEST_COMMAND_3=1 (skips test #3 of command)
208 * SKIP_TEST_<CMD>=1 SKIP_TEST_ZEROFREE=1 (skips all zerofree tests)
210 type tests = (test_init * test_prereq * test) list
212 (* Run the command sequence and just expect nothing to fail. *)
215 (* Run the command sequence and expect the output of the final
216 * command to be the string.
218 | TestOutput of seq * string
220 (* Run the command sequence and expect the output of the final
221 * command to be the list of strings.
223 | TestOutputList of seq * string list
225 (* Run the command sequence and expect the output of the final
226 * command to be the list of block devices (could be either
227 * "/dev/sd.." or "/dev/hd.." form - we don't check the 5th
228 * character of each string).
230 | TestOutputListOfDevices of seq * string list
232 (* Run the command sequence and expect the output of the final
233 * command to be the integer.
235 | TestOutputInt of seq * int
237 (* Run the command sequence and expect the output of the final
238 * command to be <op> <int>, eg. ">=", "1".
240 | TestOutputIntOp of seq * string * int
242 (* Run the command sequence and expect the output of the final
243 * command to be a true value (!= 0 or != NULL).
245 | TestOutputTrue of seq
247 (* Run the command sequence and expect the output of the final
248 * command to be a false value (== 0 or == NULL, but not an error).
250 | TestOutputFalse of seq
252 (* Run the command sequence and expect the output of the final
253 * command to be a list of the given length (but don't care about
256 | TestOutputLength of seq * int
258 (* Run the command sequence and expect the output of the final
259 * command to be a buffer (RBufferOut), ie. string + size.
261 | TestOutputBuffer of seq * string
263 (* Run the command sequence and expect the output of the final
264 * command to be a structure.
266 | TestOutputStruct of seq * test_field_compare list
268 (* Run the command sequence and expect the final command (only)
271 | TestLastFail of seq
273 and test_field_compare =
274 | CompareWithInt of string * int
275 | CompareWithIntOp of string * string * int
276 | CompareWithString of string * string
277 | CompareFieldsIntEq of string * string
278 | CompareFieldsStrEq of string * string
280 (* Test prerequisites. *)
282 (* Test always runs. *)
285 (* Test is currently disabled - eg. it fails, or it tests some
286 * unimplemented feature.
290 (* 'string' is some C code (a function body) that should return
291 * true or false. The test will run if the code returns true.
295 (* As for 'If' but the test runs _unless_ the code returns true. *)
298 (* Some initial scenarios for testing. *)
300 (* Do nothing, block devices could contain random stuff including
301 * LVM PVs, and some filesystems might be mounted. This is usually
306 (* Block devices are empty and no filesystems are mounted. *)
309 (* /dev/sda contains a single partition /dev/sda1, with random
310 * content. /dev/sdb and /dev/sdc may have random content.
315 (* /dev/sda contains a single partition /dev/sda1, which is formatted
316 * as ext2, empty [except for lost+found] and mounted on /.
317 * /dev/sdb and /dev/sdc may have random content.
323 * /dev/sda1 (is a PV):
324 * /dev/VG/LV (size 8MB):
325 * formatted as ext2, empty [except for lost+found], mounted on /
326 * /dev/sdb and /dev/sdc may have random content.
330 (* /dev/sdd (the ISO, see images/ directory in source)
335 (* Sequence of commands for testing. *)
337 and cmd = string list
339 (* Note about long descriptions: When referring to another
340 * action, use the format C<guestfs_other> (ie. the full name of
341 * the C function). This will be replaced as appropriate in other
344 * Apart from that, long descriptions are just perldoc paragraphs.
347 (* Generate a random UUID (used in tests). *)
349 let chan = Unix.open_process_in "uuidgen" in
350 let uuid = input_line chan in
351 (match Unix.close_process_in chan with
352 | Unix.WEXITED 0 -> ()
354 failwith "uuidgen: process exited with non-zero status"
355 | Unix.WSIGNALED _ | Unix.WSTOPPED _ ->
356 failwith "uuidgen: process signalled or stopped by signal"
360 (* These test functions are used in the language binding tests. *)
362 let test_all_args = [
365 StringList "strlist";
373 let test_all_rets = [
374 (* except for RErr, which is tested thoroughly elsewhere *)
375 "test0rint", RInt "valout";
376 "test0rint64", RInt64 "valout";
377 "test0rbool", RBool "valout";
378 "test0rconststring", RConstString "valout";
379 "test0rconstoptstring", RConstOptString "valout";
380 "test0rstring", RString "valout";
381 "test0rstringlist", RStringList "valout";
382 "test0rstruct", RStruct ("valout", "lvm_pv");
383 "test0rstructlist", RStructList ("valout", "lvm_pv");
384 "test0rhashtable", RHashtable "valout";
387 let test_functions = [
388 ("test0", (RErr, test_all_args), -1, [NotInFish; NotInDocs],
390 "internal test function - do not use",
392 This is an internal test function which is used to test whether
393 the automatically generated bindings can handle every possible
394 parameter type correctly.
396 It echos the contents of each parameter to stdout.
398 You probably don't want to call this function.");
402 [(name, (ret, [String "val"]), -1, [NotInFish; NotInDocs],
404 "internal test function - do not use",
406 This is an internal test function which is used to test whether
407 the automatically generated bindings can handle every possible
408 return type correctly.
410 It converts string C<val> to the return type.
412 You probably don't want to call this function.");
413 (name ^ "err", (ret, []), -1, [NotInFish; NotInDocs],
415 "internal test function - do not use",
417 This is an internal test function which is used to test whether
418 the automatically generated bindings can handle every possible
419 return type correctly.
421 This function always returns an error.
423 You probably don't want to call this function.")]
427 (* non_daemon_functions are any functions which don't get processed
428 * in the daemon, eg. functions for setting and getting local
429 * configuration values.
432 let non_daemon_functions = test_functions @ [
433 ("launch", (RErr, []), -1, [FishAlias "run"; FishAction "launch"],
435 "launch the qemu subprocess",
437 Internally libguestfs is implemented by running a virtual machine
440 You should call this after configuring the handle
441 (eg. adding drives) but before performing any actions.");
443 ("wait_ready", (RErr, []), -1, [NotInFish],
445 "wait until the qemu subprocess launches (no op)",
447 This function is a no op.
449 In versions of the API E<lt> 1.0.71 you had to call this function
450 just after calling C<guestfs_launch> to wait for the launch
451 to complete. However this is no longer necessary because
452 C<guestfs_launch> now does the waiting.
454 If you see any calls to this function in code then you can just
455 remove them, unless you want to retain compatibility with older
456 versions of the API.");
458 ("kill_subprocess", (RErr, []), -1, [],
460 "kill the qemu subprocess",
462 This kills the qemu subprocess. You should never need to call this.");
464 ("add_drive", (RErr, [String "filename"]), -1, [FishAlias "add"],
466 "add an image to examine or modify",
468 This function adds a virtual machine disk image C<filename> to the
469 guest. The first time you call this function, the disk appears as IDE
470 disk 0 (C</dev/sda>) in the guest, the second time as C</dev/sdb>, and
473 You don't necessarily need to be root when using libguestfs. However
474 you obviously do need sufficient permissions to access the filename
475 for whatever operations you want to perform (ie. read access if you
476 just want to read the image or write access if you want to modify the
479 This is equivalent to the qemu parameter
480 C<-drive file=filename,cache=off,if=...>.
481 C<cache=off> is omitted in cases where it is not supported by
482 the underlying filesystem.
484 Note that this call checks for the existence of C<filename>. This
485 stops you from specifying other types of drive which are supported
486 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
487 the general C<guestfs_config> call instead.");
489 ("add_cdrom", (RErr, [String "filename"]), -1, [FishAlias "cdrom"],
491 "add a CD-ROM disk image to examine",
493 This function adds a virtual CD-ROM disk image to the guest.
495 This is equivalent to the qemu parameter C<-cdrom filename>.
497 Note that this call checks for the existence of C<filename>. This
498 stops you from specifying other types of drive which are supported
499 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
500 the general C<guestfs_config> call instead.");
502 ("add_drive_ro", (RErr, [String "filename"]), -1, [FishAlias "add-ro"],
504 "add a drive in snapshot mode (read-only)",
506 This adds a drive in snapshot mode, making it effectively
509 Note that writes to the device are allowed, and will be seen for
510 the duration of the guestfs handle, but they are written
511 to a temporary file which is discarded as soon as the guestfs
512 handle is closed. We don't currently have any method to enable
513 changes to be committed, although qemu can support this.
515 This is equivalent to the qemu parameter
516 C<-drive file=filename,snapshot=on,if=...>.
518 Note that this call checks for the existence of C<filename>. This
519 stops you from specifying other types of drive which are supported
520 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
521 the general C<guestfs_config> call instead.");
523 ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"]), -1, [],
525 "add qemu parameters",
527 This can be used to add arbitrary qemu command line parameters
528 of the form C<-param value>. Actually it's not quite arbitrary - we
529 prevent you from setting some parameters which would interfere with
530 parameters that we use.
532 The first character of C<param> string must be a C<-> (dash).
534 C<value> can be NULL.");
536 ("set_qemu", (RErr, [String "qemu"]), -1, [FishAlias "qemu"],
538 "set the qemu binary",
540 Set the qemu binary that we will use.
542 The default is chosen when the library was compiled by the
545 You can also override this by setting the C<LIBGUESTFS_QEMU>
546 environment variable.
548 Setting C<qemu> to C<NULL> restores the default qemu binary.");
550 ("get_qemu", (RConstString "qemu", []), -1, [],
551 [InitNone, Always, TestRun (
553 "get the qemu binary",
555 Return the current qemu binary.
557 This is always non-NULL. If it wasn't set already, then this will
558 return the default qemu binary name.");
560 ("set_path", (RErr, [String "searchpath"]), -1, [FishAlias "path"],
562 "set the search path",
564 Set the path that libguestfs searches for kernel and initrd.img.
566 The default is C<$libdir/guestfs> unless overridden by setting
567 C<LIBGUESTFS_PATH> environment variable.
569 Setting C<path> to C<NULL> restores the default path.");
571 ("get_path", (RConstString "path", []), -1, [],
572 [InitNone, Always, TestRun (
574 "get the search path",
576 Return the current search path.
578 This is always non-NULL. If it wasn't set already, then this will
579 return the default path.");
581 ("set_append", (RErr, [OptString "append"]), -1, [FishAlias "append"],
583 "add options to kernel command line",
585 This function is used to add additional options to the
586 guest kernel command line.
588 The default is C<NULL> unless overridden by setting
589 C<LIBGUESTFS_APPEND> environment variable.
591 Setting C<append> to C<NULL> means I<no> additional options
592 are passed (libguestfs always adds a few of its own).");
594 ("get_append", (RConstOptString "append", []), -1, [],
595 (* This cannot be tested with the current framework. The
596 * function can return NULL in normal operations, which the
597 * test framework interprets as an error.
600 "get the additional kernel options",
602 Return the additional kernel options which are added to the
603 guest kernel command line.
605 If C<NULL> then no options are added.");
607 ("set_autosync", (RErr, [Bool "autosync"]), -1, [FishAlias "autosync"],
611 If C<autosync> is true, this enables autosync. Libguestfs will make a
612 best effort attempt to run C<guestfs_umount_all> followed by
613 C<guestfs_sync> when the handle is closed
614 (also if the program exits without closing handles).
616 This is disabled by default (except in guestfish where it is
617 enabled by default).");
619 ("get_autosync", (RBool "autosync", []), -1, [],
620 [InitNone, Always, TestRun (
621 [["get_autosync"]])],
624 Get the autosync flag.");
626 ("set_verbose", (RErr, [Bool "verbose"]), -1, [FishAlias "verbose"],
630 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
632 Verbose messages are disabled unless the environment variable
633 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.");
635 ("get_verbose", (RBool "verbose", []), -1, [],
639 This returns the verbose messages flag.");
641 ("is_ready", (RBool "ready", []), -1, [],
642 [InitNone, Always, TestOutputTrue (
644 "is ready to accept commands",
646 This returns true iff this handle is ready to accept commands
647 (in the C<READY> state).
649 For more information on states, see L<guestfs(3)>.");
651 ("is_config", (RBool "config", []), -1, [],
652 [InitNone, Always, TestOutputFalse (
654 "is in configuration state",
656 This returns true iff this handle is being configured
657 (in the C<CONFIG> state).
659 For more information on states, see L<guestfs(3)>.");
661 ("is_launching", (RBool "launching", []), -1, [],
662 [InitNone, Always, TestOutputFalse (
663 [["is_launching"]])],
664 "is launching subprocess",
666 This returns true iff this handle is launching the subprocess
667 (in the C<LAUNCHING> state).
669 For more information on states, see L<guestfs(3)>.");
671 ("is_busy", (RBool "busy", []), -1, [],
672 [InitNone, Always, TestOutputFalse (
674 "is busy processing a command",
676 This returns true iff this handle is busy processing a command
677 (in the C<BUSY> state).
679 For more information on states, see L<guestfs(3)>.");
681 ("get_state", (RInt "state", []), -1, [],
683 "get the current state",
685 This returns the current state as an opaque integer. This is
686 only useful for printing debug and internal error messages.
688 For more information on states, see L<guestfs(3)>.");
690 ("set_memsize", (RErr, [Int "memsize"]), -1, [FishAlias "memsize"],
691 [InitNone, Always, TestOutputInt (
692 [["set_memsize"; "500"];
693 ["get_memsize"]], 500)],
694 "set memory allocated to the qemu subprocess",
696 This sets the memory size in megabytes allocated to the
697 qemu subprocess. This only has any effect if called before
700 You can also change this by setting the environment
701 variable C<LIBGUESTFS_MEMSIZE> before the handle is
704 For more information on the architecture of libguestfs,
705 see L<guestfs(3)>.");
707 ("get_memsize", (RInt "memsize", []), -1, [],
708 [InitNone, Always, TestOutputIntOp (
709 [["get_memsize"]], ">=", 256)],
710 "get memory allocated to the qemu subprocess",
712 This gets the memory size in megabytes allocated to the
715 If C<guestfs_set_memsize> was not called
716 on this handle, and if C<LIBGUESTFS_MEMSIZE> was not set,
717 then this returns the compiled-in default value for memsize.
719 For more information on the architecture of libguestfs,
720 see L<guestfs(3)>.");
722 ("get_pid", (RInt "pid", []), -1, [FishAlias "pid"],
723 [InitNone, Always, TestOutputIntOp (
724 [["get_pid"]], ">=", 1)],
725 "get PID of qemu subprocess",
727 Return the process ID of the qemu subprocess. If there is no
728 qemu subprocess, then this will return an error.
730 This is an internal call used for debugging and testing.");
732 ("version", (RStruct ("version", "version"), []), -1, [],
733 [InitNone, Always, TestOutputStruct (
734 [["version"]], [CompareWithInt ("major", 1)])],
735 "get the library version number",
737 Return the libguestfs version number that the program is linked
740 Note that because of dynamic linking this is not necessarily
741 the version of libguestfs that you compiled against. You can
742 compile the program, and then at runtime dynamically link
743 against a completely different C<libguestfs.so> library.
745 This call was added in version C<1.0.58>. In previous
746 versions of libguestfs there was no way to get the version
747 number. From C code you can use ELF weak linking tricks to find out if
748 this symbol exists (if it doesn't, then it's an earlier version).
750 The call returns a structure with four elements. The first
751 three (C<major>, C<minor> and C<release>) are numbers and
752 correspond to the usual version triplet. The fourth element
753 (C<extra>) is a string and is normally empty, but may be
754 used for distro-specific information.
756 To construct the original version string:
757 C<$major.$minor.$release$extra>
759 I<Note:> Don't use this call to test for availability
760 of features. Distro backports makes this unreliable.");
762 ("set_selinux", (RErr, [Bool "selinux"]), -1, [FishAlias "selinux"],
763 [InitNone, Always, TestOutputTrue (
764 [["set_selinux"; "true"];
766 "set SELinux enabled or disabled at appliance boot",
768 This sets the selinux flag that is passed to the appliance
769 at boot time. The default is C<selinux=0> (disabled).
771 Note that if SELinux is enabled, it is always in
772 Permissive mode (C<enforcing=0>).
774 For more information on the architecture of libguestfs,
775 see L<guestfs(3)>.");
777 ("get_selinux", (RBool "selinux", []), -1, [],
779 "get SELinux enabled flag",
781 This returns the current setting of the selinux flag which
782 is passed to the appliance at boot time. See C<guestfs_set_selinux>.
784 For more information on the architecture of libguestfs,
785 see L<guestfs(3)>.");
787 ("set_trace", (RErr, [Bool "trace"]), -1, [FishAlias "trace"],
788 [InitNone, Always, TestOutputFalse (
789 [["set_trace"; "false"];
791 "enable or disable command traces",
793 If the command trace flag is set to 1, then commands are
794 printed on stdout before they are executed in a format
795 which is very similar to the one used by guestfish. In
796 other words, you can run a program with this enabled, and
797 you will get out a script which you can feed to guestfish
798 to perform the same set of actions.
800 If you want to trace C API calls into libguestfs (and
801 other libraries) then possibly a better way is to use
802 the external ltrace(1) command.
804 Command traces are disabled unless the environment variable
805 C<LIBGUESTFS_TRACE> is defined and set to C<1>.");
807 ("get_trace", (RBool "trace", []), -1, [],
809 "get command trace enabled flag",
811 Return the command trace flag.");
813 ("set_direct", (RErr, [Bool "direct"]), -1, [FishAlias "direct"],
814 [InitNone, Always, TestOutputFalse (
815 [["set_direct"; "false"];
817 "enable or disable direct appliance mode",
819 If the direct appliance mode flag is enabled, then stdin and
820 stdout are passed directly through to the appliance once it
823 One consequence of this is that log messages aren't caught
824 by the library and handled by C<guestfs_set_log_message_callback>,
825 but go straight to stdout.
827 You probably don't want to use this unless you know what you
830 The default is disabled.");
832 ("get_direct", (RBool "direct", []), -1, [],
834 "get direct appliance mode flag",
836 Return the direct appliance mode flag.");
838 ("set_recovery_proc", (RErr, [Bool "recoveryproc"]), -1, [FishAlias "recovery-proc"],
839 [InitNone, Always, TestOutputTrue (
840 [["set_recovery_proc"; "true"];
841 ["get_recovery_proc"]])],
842 "enable or disable the recovery process",
844 If this is called with the parameter C<false> then
845 C<guestfs_launch> does not create a recovery process. The
846 purpose of the recovery process is to stop runaway qemu
847 processes in the case where the main program aborts abruptly.
849 This only has any effect if called before C<guestfs_launch>,
850 and the default is true.
852 About the only time when you would want to disable this is
853 if the main process will fork itself into the background
854 (\"daemonize\" itself). In this case the recovery process
855 thinks that the main program has disappeared and so kills
856 qemu, which is not very helpful.");
858 ("get_recovery_proc", (RBool "recoveryproc", []), -1, [],
860 "get recovery process enabled flag",
862 Return the recovery process enabled flag.");
866 (* daemon_functions are any functions which cause some action
867 * to take place in the daemon.
870 let daemon_functions = [
871 ("mount", (RErr, [Device "device"; String "mountpoint"]), 1, [],
872 [InitEmpty, Always, TestOutput (
873 [["part_disk"; "/dev/sda"; "mbr"];
874 ["mkfs"; "ext2"; "/dev/sda1"];
875 ["mount"; "/dev/sda1"; "/"];
876 ["write_file"; "/new"; "new file contents"; "0"];
877 ["cat"; "/new"]], "new file contents")],
878 "mount a guest disk at a position in the filesystem",
880 Mount a guest disk at a position in the filesystem. Block devices
881 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
882 the guest. If those block devices contain partitions, they will have
883 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
886 The rules are the same as for L<mount(2)>: A filesystem must
887 first be mounted on C</> before others can be mounted. Other
888 filesystems can only be mounted on directories which already
891 The mounted filesystem is writable, if we have sufficient permissions
892 on the underlying device.
894 The filesystem options C<sync> and C<noatime> are set with this
895 call, in order to improve reliability.");
897 ("sync", (RErr, []), 2, [],
898 [ InitEmpty, Always, TestRun [["sync"]]],
899 "sync disks, writes are flushed through to the disk image",
901 This syncs the disk, so that any writes are flushed through to the
902 underlying disk image.
904 You should always call this if you have modified a disk image, before
905 closing the handle.");
907 ("touch", (RErr, [Pathname "path"]), 3, [],
908 [InitBasicFS, Always, TestOutputTrue (
910 ["exists"; "/new"]])],
911 "update file timestamps or create a new file",
913 Touch acts like the L<touch(1)> command. It can be used to
914 update the timestamps on a file, or, if the file does not exist,
915 to create a new zero-length file.");
917 ("cat", (RString "content", [Pathname "path"]), 4, [ProtocolLimitWarning],
918 [InitISOFS, Always, TestOutput (
919 [["cat"; "/known-2"]], "abcdef\n")],
920 "list the contents of a file",
922 Return the contents of the file named C<path>.
924 Note that this function cannot correctly handle binary files
925 (specifically, files containing C<\\0> character which is treated
926 as end of string). For those you need to use the C<guestfs_read_file>
927 or C<guestfs_download> functions which have a more complex interface.");
929 ("ll", (RString "listing", [Pathname "directory"]), 5, [],
930 [], (* XXX Tricky to test because it depends on the exact format
931 * of the 'ls -l' command, which changes between F10 and F11.
933 "list the files in a directory (long format)",
935 List the files in C<directory> (relative to the root directory,
936 there is no cwd) in the format of 'ls -la'.
938 This command is mostly useful for interactive sessions. It
939 is I<not> intended that you try to parse the output string.");
941 ("ls", (RStringList "listing", [Pathname "directory"]), 6, [],
942 [InitBasicFS, Always, TestOutputList (
945 ["touch"; "/newest"];
946 ["ls"; "/"]], ["lost+found"; "new"; "newer"; "newest"])],
947 "list the files in a directory",
949 List the files in C<directory> (relative to the root directory,
950 there is no cwd). The '.' and '..' entries are not returned, but
951 hidden files are shown.
953 This command is mostly useful for interactive sessions. Programs
954 should probably use C<guestfs_readdir> instead.");
956 ("list_devices", (RStringList "devices", []), 7, [],
957 [InitEmpty, Always, TestOutputListOfDevices (
958 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
959 "list the block devices",
961 List all the block devices.
963 The full block device names are returned, eg. C</dev/sda>");
965 ("list_partitions", (RStringList "partitions", []), 8, [],
966 [InitBasicFS, Always, TestOutputListOfDevices (
967 [["list_partitions"]], ["/dev/sda1"]);
968 InitEmpty, Always, TestOutputListOfDevices (
969 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
970 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
971 "list the partitions",
973 List all the partitions detected on all block devices.
975 The full partition device names are returned, eg. C</dev/sda1>
977 This does not return logical volumes. For that you will need to
978 call C<guestfs_lvs>.");
980 ("pvs", (RStringList "physvols", []), 9, [],
981 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
982 [["pvs"]], ["/dev/sda1"]);
983 InitEmpty, Always, TestOutputListOfDevices (
984 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
985 ["pvcreate"; "/dev/sda1"];
986 ["pvcreate"; "/dev/sda2"];
987 ["pvcreate"; "/dev/sda3"];
988 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
989 "list the LVM physical volumes (PVs)",
991 List all the physical volumes detected. This is the equivalent
992 of the L<pvs(8)> command.
994 This returns a list of just the device names that contain
995 PVs (eg. C</dev/sda2>).
997 See also C<guestfs_pvs_full>.");
999 ("vgs", (RStringList "volgroups", []), 10, [],
1000 [InitBasicFSonLVM, Always, TestOutputList (
1002 InitEmpty, Always, TestOutputList (
1003 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1004 ["pvcreate"; "/dev/sda1"];
1005 ["pvcreate"; "/dev/sda2"];
1006 ["pvcreate"; "/dev/sda3"];
1007 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1008 ["vgcreate"; "VG2"; "/dev/sda3"];
1009 ["vgs"]], ["VG1"; "VG2"])],
1010 "list the LVM volume groups (VGs)",
1012 List all the volumes groups detected. This is the equivalent
1013 of the L<vgs(8)> command.
1015 This returns a list of just the volume group names that were
1016 detected (eg. C<VolGroup00>).
1018 See also C<guestfs_vgs_full>.");
1020 ("lvs", (RStringList "logvols", []), 11, [],
1021 [InitBasicFSonLVM, Always, TestOutputList (
1022 [["lvs"]], ["/dev/VG/LV"]);
1023 InitEmpty, Always, TestOutputList (
1024 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1025 ["pvcreate"; "/dev/sda1"];
1026 ["pvcreate"; "/dev/sda2"];
1027 ["pvcreate"; "/dev/sda3"];
1028 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1029 ["vgcreate"; "VG2"; "/dev/sda3"];
1030 ["lvcreate"; "LV1"; "VG1"; "50"];
1031 ["lvcreate"; "LV2"; "VG1"; "50"];
1032 ["lvcreate"; "LV3"; "VG2"; "50"];
1033 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1034 "list the LVM logical volumes (LVs)",
1036 List all the logical volumes detected. This is the equivalent
1037 of the L<lvs(8)> command.
1039 This returns a list of the logical volume device names
1040 (eg. C</dev/VolGroup00/LogVol00>).
1042 See also C<guestfs_lvs_full>.");
1044 ("pvs_full", (RStructList ("physvols", "lvm_pv"), []), 12, [],
1045 [], (* XXX how to test? *)
1046 "list the LVM physical volumes (PVs)",
1048 List all the physical volumes detected. This is the equivalent
1049 of the L<pvs(8)> command. The \"full\" version includes all fields.");
1051 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), []), 13, [],
1052 [], (* XXX how to test? *)
1053 "list the LVM volume groups (VGs)",
1055 List all the volumes groups detected. This is the equivalent
1056 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1058 ("lvs_full", (RStructList ("logvols", "lvm_lv"), []), 14, [],
1059 [], (* XXX how to test? *)
1060 "list the LVM logical volumes (LVs)",
1062 List all the logical volumes detected. This is the equivalent
1063 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1065 ("read_lines", (RStringList "lines", [Pathname "path"]), 15, [],
1066 [InitISOFS, Always, TestOutputList (
1067 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1068 InitISOFS, Always, TestOutputList (
1069 [["read_lines"; "/empty"]], [])],
1070 "read file as lines",
1072 Return the contents of the file named C<path>.
1074 The file contents are returned as a list of lines. Trailing
1075 C<LF> and C<CRLF> character sequences are I<not> returned.
1077 Note that this function cannot correctly handle binary files
1078 (specifically, files containing C<\\0> character which is treated
1079 as end of line). For those you need to use the C<guestfs_read_file>
1080 function which has a more complex interface.");
1082 ("aug_init", (RErr, [Pathname "root"; Int "flags"]), 16, [],
1083 [], (* XXX Augeas code needs tests. *)
1084 "create a new Augeas handle",
1086 Create a new Augeas handle for editing configuration files.
1087 If there was any previous Augeas handle associated with this
1088 guestfs session, then it is closed.
1090 You must call this before using any other C<guestfs_aug_*>
1093 C<root> is the filesystem root. C<root> must not be NULL,
1096 The flags are the same as the flags defined in
1097 E<lt>augeas.hE<gt>, the logical I<or> of the following
1102 =item C<AUG_SAVE_BACKUP> = 1
1104 Keep the original file with a C<.augsave> extension.
1106 =item C<AUG_SAVE_NEWFILE> = 2
1108 Save changes into a file with extension C<.augnew>, and
1109 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1111 =item C<AUG_TYPE_CHECK> = 4
1113 Typecheck lenses (can be expensive).
1115 =item C<AUG_NO_STDINC> = 8
1117 Do not use standard load path for modules.
1119 =item C<AUG_SAVE_NOOP> = 16
1121 Make save a no-op, just record what would have been changed.
1123 =item C<AUG_NO_LOAD> = 32
1125 Do not load the tree in C<guestfs_aug_init>.
1129 To close the handle, you can call C<guestfs_aug_close>.
1131 To find out more about Augeas, see L<http://augeas.net/>.");
1133 ("aug_close", (RErr, []), 26, [],
1134 [], (* XXX Augeas code needs tests. *)
1135 "close the current Augeas handle",
1137 Close the current Augeas handle and free up any resources
1138 used by it. After calling this, you have to call
1139 C<guestfs_aug_init> again before you can use any other
1140 Augeas functions.");
1142 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"]), 17, [],
1143 [], (* XXX Augeas code needs tests. *)
1144 "define an Augeas variable",
1146 Defines an Augeas variable C<name> whose value is the result
1147 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1150 On success this returns the number of nodes in C<expr>, or
1151 C<0> if C<expr> evaluates to something which is not a nodeset.");
1153 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"]), 18, [],
1154 [], (* XXX Augeas code needs tests. *)
1155 "define an Augeas node",
1157 Defines a variable C<name> whose value is the result of
1160 If C<expr> evaluates to an empty nodeset, a node is created,
1161 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1162 C<name> will be the nodeset containing that single node.
1164 On success this returns a pair containing the
1165 number of nodes in the nodeset, and a boolean flag
1166 if a node was created.");
1168 ("aug_get", (RString "val", [String "augpath"]), 19, [],
1169 [], (* XXX Augeas code needs tests. *)
1170 "look up the value of an Augeas path",
1172 Look up the value associated with C<path>. If C<path>
1173 matches exactly one node, the C<value> is returned.");
1175 ("aug_set", (RErr, [String "augpath"; String "val"]), 20, [],
1176 [], (* XXX Augeas code needs tests. *)
1177 "set Augeas path to value",
1179 Set the value associated with C<path> to C<value>.");
1181 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"]), 21, [],
1182 [], (* XXX Augeas code needs tests. *)
1183 "insert a sibling Augeas node",
1185 Create a new sibling C<label> for C<path>, inserting it into
1186 the tree before or after C<path> (depending on the boolean
1189 C<path> must match exactly one existing node in the tree, and
1190 C<label> must be a label, ie. not contain C</>, C<*> or end
1191 with a bracketed index C<[N]>.");
1193 ("aug_rm", (RInt "nrnodes", [String "augpath"]), 22, [],
1194 [], (* XXX Augeas code needs tests. *)
1195 "remove an Augeas path",
1197 Remove C<path> and all of its children.
1199 On success this returns the number of entries which were removed.");
1201 ("aug_mv", (RErr, [String "src"; String "dest"]), 23, [],
1202 [], (* XXX Augeas code needs tests. *)
1205 Move the node C<src> to C<dest>. C<src> must match exactly
1206 one node. C<dest> is overwritten if it exists.");
1208 ("aug_match", (RStringList "matches", [String "augpath"]), 24, [],
1209 [], (* XXX Augeas code needs tests. *)
1210 "return Augeas nodes which match augpath",
1212 Returns a list of paths which match the path expression C<path>.
1213 The returned paths are sufficiently qualified so that they match
1214 exactly one node in the current tree.");
1216 ("aug_save", (RErr, []), 25, [],
1217 [], (* XXX Augeas code needs tests. *)
1218 "write all pending Augeas changes to disk",
1220 This writes all pending changes to disk.
1222 The flags which were passed to C<guestfs_aug_init> affect exactly
1223 how files are saved.");
1225 ("aug_load", (RErr, []), 27, [],
1226 [], (* XXX Augeas code needs tests. *)
1227 "load files into the tree",
1229 Load files into the tree.
1231 See C<aug_load> in the Augeas documentation for the full gory
1234 ("aug_ls", (RStringList "matches", [String "augpath"]), 28, [],
1235 [], (* XXX Augeas code needs tests. *)
1236 "list Augeas nodes under augpath",
1238 This is just a shortcut for listing C<guestfs_aug_match>
1239 C<path/*> and sorting the resulting nodes into alphabetical order.");
1241 ("rm", (RErr, [Pathname "path"]), 29, [],
1242 [InitBasicFS, Always, TestRun
1245 InitBasicFS, Always, TestLastFail
1247 InitBasicFS, Always, TestLastFail
1252 Remove the single file C<path>.");
1254 ("rmdir", (RErr, [Pathname "path"]), 30, [],
1255 [InitBasicFS, Always, TestRun
1258 InitBasicFS, Always, TestLastFail
1259 [["rmdir"; "/new"]];
1260 InitBasicFS, Always, TestLastFail
1262 ["rmdir"; "/new"]]],
1263 "remove a directory",
1265 Remove the single directory C<path>.");
1267 ("rm_rf", (RErr, [Pathname "path"]), 31, [],
1268 [InitBasicFS, Always, TestOutputFalse
1270 ["mkdir"; "/new/foo"];
1271 ["touch"; "/new/foo/bar"];
1273 ["exists"; "/new"]]],
1274 "remove a file or directory recursively",
1276 Remove the file or directory C<path>, recursively removing the
1277 contents if its a directory. This is like the C<rm -rf> shell
1280 ("mkdir", (RErr, [Pathname "path"]), 32, [],
1281 [InitBasicFS, Always, TestOutputTrue
1283 ["is_dir"; "/new"]];
1284 InitBasicFS, Always, TestLastFail
1285 [["mkdir"; "/new/foo/bar"]]],
1286 "create a directory",
1288 Create a directory named C<path>.");
1290 ("mkdir_p", (RErr, [Pathname "path"]), 33, [],
1291 [InitBasicFS, Always, TestOutputTrue
1292 [["mkdir_p"; "/new/foo/bar"];
1293 ["is_dir"; "/new/foo/bar"]];
1294 InitBasicFS, Always, TestOutputTrue
1295 [["mkdir_p"; "/new/foo/bar"];
1296 ["is_dir"; "/new/foo"]];
1297 InitBasicFS, Always, TestOutputTrue
1298 [["mkdir_p"; "/new/foo/bar"];
1299 ["is_dir"; "/new"]];
1300 (* Regression tests for RHBZ#503133: *)
1301 InitBasicFS, Always, TestRun
1303 ["mkdir_p"; "/new"]];
1304 InitBasicFS, Always, TestLastFail
1306 ["mkdir_p"; "/new"]]],
1307 "create a directory and parents",
1309 Create a directory named C<path>, creating any parent directories
1310 as necessary. This is like the C<mkdir -p> shell command.");
1312 ("chmod", (RErr, [Int "mode"; Pathname "path"]), 34, [],
1313 [], (* XXX Need stat command to test *)
1316 Change the mode (permissions) of C<path> to C<mode>. Only
1317 numeric modes are supported.");
1319 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"]), 35, [],
1320 [], (* XXX Need stat command to test *)
1321 "change file owner and group",
1323 Change the file owner to C<owner> and group to C<group>.
1325 Only numeric uid and gid are supported. If you want to use
1326 names, you will need to locate and parse the password file
1327 yourself (Augeas support makes this relatively easy).");
1329 ("exists", (RBool "existsflag", [Pathname "path"]), 36, [],
1330 [InitISOFS, Always, TestOutputTrue (
1331 [["exists"; "/empty"]]);
1332 InitISOFS, Always, TestOutputTrue (
1333 [["exists"; "/directory"]])],
1334 "test if file or directory exists",
1336 This returns C<true> if and only if there is a file, directory
1337 (or anything) with the given C<path> name.
1339 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1341 ("is_file", (RBool "fileflag", [Pathname "path"]), 37, [],
1342 [InitISOFS, Always, TestOutputTrue (
1343 [["is_file"; "/known-1"]]);
1344 InitISOFS, Always, TestOutputFalse (
1345 [["is_file"; "/directory"]])],
1346 "test if file exists",
1348 This returns C<true> if and only if there is a file
1349 with the given C<path> name. Note that it returns false for
1350 other objects like directories.
1352 See also C<guestfs_stat>.");
1354 ("is_dir", (RBool "dirflag", [Pathname "path"]), 38, [],
1355 [InitISOFS, Always, TestOutputFalse (
1356 [["is_dir"; "/known-3"]]);
1357 InitISOFS, Always, TestOutputTrue (
1358 [["is_dir"; "/directory"]])],
1359 "test if file exists",
1361 This returns C<true> if and only if there is a directory
1362 with the given C<path> name. Note that it returns false for
1363 other objects like files.
1365 See also C<guestfs_stat>.");
1367 ("pvcreate", (RErr, [Device "device"]), 39, [],
1368 [InitEmpty, Always, TestOutputListOfDevices (
1369 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1370 ["pvcreate"; "/dev/sda1"];
1371 ["pvcreate"; "/dev/sda2"];
1372 ["pvcreate"; "/dev/sda3"];
1373 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1374 "create an LVM physical volume",
1376 This creates an LVM physical volume on the named C<device>,
1377 where C<device> should usually be a partition name such
1380 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"]), 40, [],
1381 [InitEmpty, Always, TestOutputList (
1382 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1383 ["pvcreate"; "/dev/sda1"];
1384 ["pvcreate"; "/dev/sda2"];
1385 ["pvcreate"; "/dev/sda3"];
1386 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1387 ["vgcreate"; "VG2"; "/dev/sda3"];
1388 ["vgs"]], ["VG1"; "VG2"])],
1389 "create an LVM volume group",
1391 This creates an LVM volume group called C<volgroup>
1392 from the non-empty list of physical volumes C<physvols>.");
1394 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"]), 41, [],
1395 [InitEmpty, Always, TestOutputList (
1396 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1397 ["pvcreate"; "/dev/sda1"];
1398 ["pvcreate"; "/dev/sda2"];
1399 ["pvcreate"; "/dev/sda3"];
1400 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1401 ["vgcreate"; "VG2"; "/dev/sda3"];
1402 ["lvcreate"; "LV1"; "VG1"; "50"];
1403 ["lvcreate"; "LV2"; "VG1"; "50"];
1404 ["lvcreate"; "LV3"; "VG2"; "50"];
1405 ["lvcreate"; "LV4"; "VG2"; "50"];
1406 ["lvcreate"; "LV5"; "VG2"; "50"];
1408 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1409 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1410 "create an LVM volume group",
1412 This creates an LVM volume group called C<logvol>
1413 on the volume group C<volgroup>, with C<size> megabytes.");
1415 ("mkfs", (RErr, [String "fstype"; Device "device"]), 42, [],
1416 [InitEmpty, Always, TestOutput (
1417 [["part_disk"; "/dev/sda"; "mbr"];
1418 ["mkfs"; "ext2"; "/dev/sda1"];
1419 ["mount"; "/dev/sda1"; "/"];
1420 ["write_file"; "/new"; "new file contents"; "0"];
1421 ["cat"; "/new"]], "new file contents")],
1422 "make a filesystem",
1424 This creates a filesystem on C<device> (usually a partition
1425 or LVM logical volume). The filesystem type is C<fstype>, for
1428 ("sfdisk", (RErr, [Device "device";
1429 Int "cyls"; Int "heads"; Int "sectors";
1430 StringList "lines"]), 43, [DangerWillRobinson],
1432 "create partitions on a block device",
1434 This is a direct interface to the L<sfdisk(8)> program for creating
1435 partitions on block devices.
1437 C<device> should be a block device, for example C</dev/sda>.
1439 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1440 and sectors on the device, which are passed directly to sfdisk as
1441 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1442 of these, then the corresponding parameter is omitted. Usually for
1443 'large' disks, you can just pass C<0> for these, but for small
1444 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1445 out the right geometry and you will need to tell it.
1447 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1448 information refer to the L<sfdisk(8)> manpage.
1450 To create a single partition occupying the whole disk, you would
1451 pass C<lines> as a single element list, when the single element being
1452 the string C<,> (comma).
1454 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
1455 C<guestfs_part_init>");
1457 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"]), 44, [ProtocolLimitWarning],
1458 [InitBasicFS, Always, TestOutput (
1459 [["write_file"; "/new"; "new file contents"; "0"];
1460 ["cat"; "/new"]], "new file contents");
1461 InitBasicFS, Always, TestOutput (
1462 [["write_file"; "/new"; "\nnew file contents\n"; "0"];
1463 ["cat"; "/new"]], "\nnew file contents\n");
1464 InitBasicFS, Always, TestOutput (
1465 [["write_file"; "/new"; "\n\n"; "0"];
1466 ["cat"; "/new"]], "\n\n");
1467 InitBasicFS, Always, TestOutput (
1468 [["write_file"; "/new"; ""; "0"];
1469 ["cat"; "/new"]], "");
1470 InitBasicFS, Always, TestOutput (
1471 [["write_file"; "/new"; "\n\n\n"; "0"];
1472 ["cat"; "/new"]], "\n\n\n");
1473 InitBasicFS, Always, TestOutput (
1474 [["write_file"; "/new"; "\n"; "0"];
1475 ["cat"; "/new"]], "\n")],
1478 This call creates a file called C<path>. The contents of the
1479 file is the string C<content> (which can contain any 8 bit data),
1480 with length C<size>.
1482 As a special case, if C<size> is C<0>
1483 then the length is calculated using C<strlen> (so in this case
1484 the content cannot contain embedded ASCII NULs).
1486 I<NB.> Owing to a bug, writing content containing ASCII NUL
1487 characters does I<not> work, even if the length is specified.
1488 We hope to resolve this bug in a future version. In the meantime
1489 use C<guestfs_upload>.");
1491 ("umount", (RErr, [String "pathordevice"]), 45, [FishAlias "unmount"],
1492 [InitEmpty, Always, TestOutputListOfDevices (
1493 [["part_disk"; "/dev/sda"; "mbr"];
1494 ["mkfs"; "ext2"; "/dev/sda1"];
1495 ["mount"; "/dev/sda1"; "/"];
1496 ["mounts"]], ["/dev/sda1"]);
1497 InitEmpty, Always, TestOutputList (
1498 [["part_disk"; "/dev/sda"; "mbr"];
1499 ["mkfs"; "ext2"; "/dev/sda1"];
1500 ["mount"; "/dev/sda1"; "/"];
1503 "unmount a filesystem",
1505 This unmounts the given filesystem. The filesystem may be
1506 specified either by its mountpoint (path) or the device which
1507 contains the filesystem.");
1509 ("mounts", (RStringList "devices", []), 46, [],
1510 [InitBasicFS, Always, TestOutputListOfDevices (
1511 [["mounts"]], ["/dev/sda1"])],
1512 "show mounted filesystems",
1514 This returns the list of currently mounted filesystems. It returns
1515 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1517 Some internal mounts are not shown.
1519 See also: C<guestfs_mountpoints>");
1521 ("umount_all", (RErr, []), 47, [FishAlias "unmount-all"],
1522 [InitBasicFS, Always, TestOutputList (
1525 (* check that umount_all can unmount nested mounts correctly: *)
1526 InitEmpty, Always, TestOutputList (
1527 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1528 ["mkfs"; "ext2"; "/dev/sda1"];
1529 ["mkfs"; "ext2"; "/dev/sda2"];
1530 ["mkfs"; "ext2"; "/dev/sda3"];
1531 ["mount"; "/dev/sda1"; "/"];
1533 ["mount"; "/dev/sda2"; "/mp1"];
1534 ["mkdir"; "/mp1/mp2"];
1535 ["mount"; "/dev/sda3"; "/mp1/mp2"];
1536 ["mkdir"; "/mp1/mp2/mp3"];
1539 "unmount all filesystems",
1541 This unmounts all mounted filesystems.
1543 Some internal mounts are not unmounted by this call.");
1545 ("lvm_remove_all", (RErr, []), 48, [DangerWillRobinson],
1547 "remove all LVM LVs, VGs and PVs",
1549 This command removes all LVM logical volumes, volume groups
1550 and physical volumes.");
1552 ("file", (RString "description", [Dev_or_Path "path"]), 49, [],
1553 [InitISOFS, Always, TestOutput (
1554 [["file"; "/empty"]], "empty");
1555 InitISOFS, Always, TestOutput (
1556 [["file"; "/known-1"]], "ASCII text");
1557 InitISOFS, Always, TestLastFail (
1558 [["file"; "/notexists"]])],
1559 "determine file type",
1561 This call uses the standard L<file(1)> command to determine
1562 the type or contents of the file. This also works on devices,
1563 for example to find out whether a partition contains a filesystem.
1565 This call will also transparently look inside various types
1568 The exact command which runs is C<file -zbsL path>. Note in
1569 particular that the filename is not prepended to the output
1570 (the C<-b> option).");
1572 ("command", (RString "output", [StringList "arguments"]), 50, [ProtocolLimitWarning],
1573 [InitBasicFS, Always, TestOutput (
1574 [["upload"; "test-command"; "/test-command"];
1575 ["chmod"; "0o755"; "/test-command"];
1576 ["command"; "/test-command 1"]], "Result1");
1577 InitBasicFS, Always, TestOutput (
1578 [["upload"; "test-command"; "/test-command"];
1579 ["chmod"; "0o755"; "/test-command"];
1580 ["command"; "/test-command 2"]], "Result2\n");
1581 InitBasicFS, Always, TestOutput (
1582 [["upload"; "test-command"; "/test-command"];
1583 ["chmod"; "0o755"; "/test-command"];
1584 ["command"; "/test-command 3"]], "\nResult3");
1585 InitBasicFS, Always, TestOutput (
1586 [["upload"; "test-command"; "/test-command"];
1587 ["chmod"; "0o755"; "/test-command"];
1588 ["command"; "/test-command 4"]], "\nResult4\n");
1589 InitBasicFS, Always, TestOutput (
1590 [["upload"; "test-command"; "/test-command"];
1591 ["chmod"; "0o755"; "/test-command"];
1592 ["command"; "/test-command 5"]], "\nResult5\n\n");
1593 InitBasicFS, Always, TestOutput (
1594 [["upload"; "test-command"; "/test-command"];
1595 ["chmod"; "0o755"; "/test-command"];
1596 ["command"; "/test-command 6"]], "\n\nResult6\n\n");
1597 InitBasicFS, Always, TestOutput (
1598 [["upload"; "test-command"; "/test-command"];
1599 ["chmod"; "0o755"; "/test-command"];
1600 ["command"; "/test-command 7"]], "");
1601 InitBasicFS, Always, TestOutput (
1602 [["upload"; "test-command"; "/test-command"];
1603 ["chmod"; "0o755"; "/test-command"];
1604 ["command"; "/test-command 8"]], "\n");
1605 InitBasicFS, Always, TestOutput (
1606 [["upload"; "test-command"; "/test-command"];
1607 ["chmod"; "0o755"; "/test-command"];
1608 ["command"; "/test-command 9"]], "\n\n");
1609 InitBasicFS, Always, TestOutput (
1610 [["upload"; "test-command"; "/test-command"];
1611 ["chmod"; "0o755"; "/test-command"];
1612 ["command"; "/test-command 10"]], "Result10-1\nResult10-2\n");
1613 InitBasicFS, Always, TestOutput (
1614 [["upload"; "test-command"; "/test-command"];
1615 ["chmod"; "0o755"; "/test-command"];
1616 ["command"; "/test-command 11"]], "Result11-1\nResult11-2");
1617 InitBasicFS, Always, TestLastFail (
1618 [["upload"; "test-command"; "/test-command"];
1619 ["chmod"; "0o755"; "/test-command"];
1620 ["command"; "/test-command"]])],
1621 "run a command from the guest filesystem",
1623 This call runs a command from the guest filesystem. The
1624 filesystem must be mounted, and must contain a compatible
1625 operating system (ie. something Linux, with the same
1626 or compatible processor architecture).
1628 The single parameter is an argv-style list of arguments.
1629 The first element is the name of the program to run.
1630 Subsequent elements are parameters. The list must be
1631 non-empty (ie. must contain a program name). Note that
1632 the command runs directly, and is I<not> invoked via
1633 the shell (see C<guestfs_sh>).
1635 The return value is anything printed to I<stdout> by
1638 If the command returns a non-zero exit status, then
1639 this function returns an error message. The error message
1640 string is the content of I<stderr> from the command.
1642 The C<$PATH> environment variable will contain at least
1643 C</usr/bin> and C</bin>. If you require a program from
1644 another location, you should provide the full path in the
1647 Shared libraries and data files required by the program
1648 must be available on filesystems which are mounted in the
1649 correct places. It is the caller's responsibility to ensure
1650 all filesystems that are needed are mounted at the right
1653 ("command_lines", (RStringList "lines", [StringList "arguments"]), 51, [ProtocolLimitWarning],
1654 [InitBasicFS, Always, TestOutputList (
1655 [["upload"; "test-command"; "/test-command"];
1656 ["chmod"; "0o755"; "/test-command"];
1657 ["command_lines"; "/test-command 1"]], ["Result1"]);
1658 InitBasicFS, Always, TestOutputList (
1659 [["upload"; "test-command"; "/test-command"];
1660 ["chmod"; "0o755"; "/test-command"];
1661 ["command_lines"; "/test-command 2"]], ["Result2"]);
1662 InitBasicFS, Always, TestOutputList (
1663 [["upload"; "test-command"; "/test-command"];
1664 ["chmod"; "0o755"; "/test-command"];
1665 ["command_lines"; "/test-command 3"]], ["";"Result3"]);
1666 InitBasicFS, Always, TestOutputList (
1667 [["upload"; "test-command"; "/test-command"];
1668 ["chmod"; "0o755"; "/test-command"];
1669 ["command_lines"; "/test-command 4"]], ["";"Result4"]);
1670 InitBasicFS, Always, TestOutputList (
1671 [["upload"; "test-command"; "/test-command"];
1672 ["chmod"; "0o755"; "/test-command"];
1673 ["command_lines"; "/test-command 5"]], ["";"Result5";""]);
1674 InitBasicFS, Always, TestOutputList (
1675 [["upload"; "test-command"; "/test-command"];
1676 ["chmod"; "0o755"; "/test-command"];
1677 ["command_lines"; "/test-command 6"]], ["";"";"Result6";""]);
1678 InitBasicFS, Always, TestOutputList (
1679 [["upload"; "test-command"; "/test-command"];
1680 ["chmod"; "0o755"; "/test-command"];
1681 ["command_lines"; "/test-command 7"]], []);
1682 InitBasicFS, Always, TestOutputList (
1683 [["upload"; "test-command"; "/test-command"];
1684 ["chmod"; "0o755"; "/test-command"];
1685 ["command_lines"; "/test-command 8"]], [""]);
1686 InitBasicFS, Always, TestOutputList (
1687 [["upload"; "test-command"; "/test-command"];
1688 ["chmod"; "0o755"; "/test-command"];
1689 ["command_lines"; "/test-command 9"]], ["";""]);
1690 InitBasicFS, Always, TestOutputList (
1691 [["upload"; "test-command"; "/test-command"];
1692 ["chmod"; "0o755"; "/test-command"];
1693 ["command_lines"; "/test-command 10"]], ["Result10-1";"Result10-2"]);
1694 InitBasicFS, Always, TestOutputList (
1695 [["upload"; "test-command"; "/test-command"];
1696 ["chmod"; "0o755"; "/test-command"];
1697 ["command_lines"; "/test-command 11"]], ["Result11-1";"Result11-2"])],
1698 "run a command, returning lines",
1700 This is the same as C<guestfs_command>, but splits the
1701 result into a list of lines.
1703 See also: C<guestfs_sh_lines>");
1705 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"]), 52, [],
1706 [InitISOFS, Always, TestOutputStruct (
1707 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
1708 "get file information",
1710 Returns file information for the given C<path>.
1712 This is the same as the C<stat(2)> system call.");
1714 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"]), 53, [],
1715 [InitISOFS, Always, TestOutputStruct (
1716 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
1717 "get file information for a symbolic link",
1719 Returns file information for the given C<path>.
1721 This is the same as C<guestfs_stat> except that if C<path>
1722 is a symbolic link, then the link is stat-ed, not the file it
1725 This is the same as the C<lstat(2)> system call.");
1727 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"]), 54, [],
1728 [InitISOFS, Always, TestOutputStruct (
1729 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
1730 "get file system statistics",
1732 Returns file system statistics for any mounted file system.
1733 C<path> should be a file or directory in the mounted file system
1734 (typically it is the mount point itself, but it doesn't need to be).
1736 This is the same as the C<statvfs(2)> system call.");
1738 ("tune2fs_l", (RHashtable "superblock", [Device "device"]), 55, [],
1740 "get ext2/ext3/ext4 superblock details",
1742 This returns the contents of the ext2, ext3 or ext4 filesystem
1743 superblock on C<device>.
1745 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1746 manpage for more details. The list of fields returned isn't
1747 clearly defined, and depends on both the version of C<tune2fs>
1748 that libguestfs was built against, and the filesystem itself.");
1750 ("blockdev_setro", (RErr, [Device "device"]), 56, [],
1751 [InitEmpty, Always, TestOutputTrue (
1752 [["blockdev_setro"; "/dev/sda"];
1753 ["blockdev_getro"; "/dev/sda"]])],
1754 "set block device to read-only",
1756 Sets the block device named C<device> to read-only.
1758 This uses the L<blockdev(8)> command.");
1760 ("blockdev_setrw", (RErr, [Device "device"]), 57, [],
1761 [InitEmpty, Always, TestOutputFalse (
1762 [["blockdev_setrw"; "/dev/sda"];
1763 ["blockdev_getro"; "/dev/sda"]])],
1764 "set block device to read-write",
1766 Sets the block device named C<device> to read-write.
1768 This uses the L<blockdev(8)> command.");
1770 ("blockdev_getro", (RBool "ro", [Device "device"]), 58, [],
1771 [InitEmpty, Always, TestOutputTrue (
1772 [["blockdev_setro"; "/dev/sda"];
1773 ["blockdev_getro"; "/dev/sda"]])],
1774 "is block device set to read-only",
1776 Returns a boolean indicating if the block device is read-only
1777 (true if read-only, false if not).
1779 This uses the L<blockdev(8)> command.");
1781 ("blockdev_getss", (RInt "sectorsize", [Device "device"]), 59, [],
1782 [InitEmpty, Always, TestOutputInt (
1783 [["blockdev_getss"; "/dev/sda"]], 512)],
1784 "get sectorsize of block device",
1786 This returns the size of sectors on a block device.
1787 Usually 512, but can be larger for modern devices.
1789 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
1792 This uses the L<blockdev(8)> command.");
1794 ("blockdev_getbsz", (RInt "blocksize", [Device "device"]), 60, [],
1795 [InitEmpty, Always, TestOutputInt (
1796 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
1797 "get blocksize of block device",
1799 This returns the block size of a device.
1801 (Note this is different from both I<size in blocks> and
1802 I<filesystem block size>).
1804 This uses the L<blockdev(8)> command.");
1806 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"]), 61, [],
1808 "set blocksize of block device",
1810 This sets the block size of a device.
1812 (Note this is different from both I<size in blocks> and
1813 I<filesystem block size>).
1815 This uses the L<blockdev(8)> command.");
1817 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"]), 62, [],
1818 [InitEmpty, Always, TestOutputInt (
1819 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
1820 "get total size of device in 512-byte sectors",
1822 This returns the size of the device in units of 512-byte sectors
1823 (even if the sectorsize isn't 512 bytes ... weird).
1825 See also C<guestfs_blockdev_getss> for the real sector size of
1826 the device, and C<guestfs_blockdev_getsize64> for the more
1827 useful I<size in bytes>.
1829 This uses the L<blockdev(8)> command.");
1831 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"]), 63, [],
1832 [InitEmpty, Always, TestOutputInt (
1833 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
1834 "get total size of device in bytes",
1836 This returns the size of the device in bytes.
1838 See also C<guestfs_blockdev_getsz>.
1840 This uses the L<blockdev(8)> command.");
1842 ("blockdev_flushbufs", (RErr, [Device "device"]), 64, [],
1843 [InitEmpty, Always, TestRun
1844 [["blockdev_flushbufs"; "/dev/sda"]]],
1845 "flush device buffers",
1847 This tells the kernel to flush internal buffers associated
1850 This uses the L<blockdev(8)> command.");
1852 ("blockdev_rereadpt", (RErr, [Device "device"]), 65, [],
1853 [InitEmpty, Always, TestRun
1854 [["blockdev_rereadpt"; "/dev/sda"]]],
1855 "reread partition table",
1857 Reread the partition table on C<device>.
1859 This uses the L<blockdev(8)> command.");
1861 ("upload", (RErr, [FileIn "filename"; String "remotefilename"]), 66, [],
1862 [InitBasicFS, Always, TestOutput (
1863 (* Pick a file from cwd which isn't likely to change. *)
1864 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1865 ["checksum"; "md5"; "/COPYING.LIB"]],
1866 Digest.to_hex (Digest.file "COPYING.LIB"))],
1867 "upload a file from the local machine",
1869 Upload local file C<filename> to C<remotefilename> on the
1872 C<filename> can also be a named pipe.
1874 See also C<guestfs_download>.");
1876 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"]), 67, [],
1877 [InitBasicFS, Always, TestOutput (
1878 (* Pick a file from cwd which isn't likely to change. *)
1879 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1880 ["download"; "/COPYING.LIB"; "testdownload.tmp"];
1881 ["upload"; "testdownload.tmp"; "/upload"];
1882 ["checksum"; "md5"; "/upload"]],
1883 Digest.to_hex (Digest.file "COPYING.LIB"))],
1884 "download a file to the local machine",
1886 Download file C<remotefilename> and save it as C<filename>
1887 on the local machine.
1889 C<filename> can also be a named pipe.
1891 See also C<guestfs_upload>, C<guestfs_cat>.");
1893 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"]), 68, [],
1894 [InitISOFS, Always, TestOutput (
1895 [["checksum"; "crc"; "/known-3"]], "2891671662");
1896 InitISOFS, Always, TestLastFail (
1897 [["checksum"; "crc"; "/notexists"]]);
1898 InitISOFS, Always, TestOutput (
1899 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
1900 InitISOFS, Always, TestOutput (
1901 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
1902 InitISOFS, Always, TestOutput (
1903 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
1904 InitISOFS, Always, TestOutput (
1905 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
1906 InitISOFS, Always, TestOutput (
1907 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
1908 InitISOFS, Always, TestOutput (
1909 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6")],
1910 "compute MD5, SHAx or CRC checksum of file",
1912 This call computes the MD5, SHAx or CRC checksum of the
1915 The type of checksum to compute is given by the C<csumtype>
1916 parameter which must have one of the following values:
1922 Compute the cyclic redundancy check (CRC) specified by POSIX
1923 for the C<cksum> command.
1927 Compute the MD5 hash (using the C<md5sum> program).
1931 Compute the SHA1 hash (using the C<sha1sum> program).
1935 Compute the SHA224 hash (using the C<sha224sum> program).
1939 Compute the SHA256 hash (using the C<sha256sum> program).
1943 Compute the SHA384 hash (using the C<sha384sum> program).
1947 Compute the SHA512 hash (using the C<sha512sum> program).
1951 The checksum is returned as a printable string.");
1953 ("tar_in", (RErr, [FileIn "tarfile"; String "directory"]), 69, [],
1954 [InitBasicFS, Always, TestOutput (
1955 [["tar_in"; "../images/helloworld.tar"; "/"];
1956 ["cat"; "/hello"]], "hello\n")],
1957 "unpack tarfile to directory",
1959 This command uploads and unpacks local file C<tarfile> (an
1960 I<uncompressed> tar file) into C<directory>.
1962 To upload a compressed tarball, use C<guestfs_tgz_in>.");
1964 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"]), 70, [],
1966 "pack directory into tarfile",
1968 This command packs the contents of C<directory> and downloads
1969 it to local file C<tarfile>.
1971 To download a compressed tarball, use C<guestfs_tgz_out>.");
1973 ("tgz_in", (RErr, [FileIn "tarball"; String "directory"]), 71, [],
1974 [InitBasicFS, Always, TestOutput (
1975 [["tgz_in"; "../images/helloworld.tar.gz"; "/"];
1976 ["cat"; "/hello"]], "hello\n")],
1977 "unpack compressed tarball to directory",
1979 This command uploads and unpacks local file C<tarball> (a
1980 I<gzip compressed> tar file) into C<directory>.
1982 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
1984 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"]), 72, [],
1986 "pack directory into compressed tarball",
1988 This command packs the contents of C<directory> and downloads
1989 it to local file C<tarball>.
1991 To download an uncompressed tarball, use C<guestfs_tar_out>.");
1993 ("mount_ro", (RErr, [Device "device"; String "mountpoint"]), 73, [],
1994 [InitBasicFS, Always, TestLastFail (
1996 ["mount_ro"; "/dev/sda1"; "/"];
1997 ["touch"; "/new"]]);
1998 InitBasicFS, Always, TestOutput (
1999 [["write_file"; "/new"; "data"; "0"];
2001 ["mount_ro"; "/dev/sda1"; "/"];
2002 ["cat"; "/new"]], "data")],
2003 "mount a guest disk, read-only",
2005 This is the same as the C<guestfs_mount> command, but it
2006 mounts the filesystem with the read-only (I<-o ro>) flag.");
2008 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"]), 74, [],
2010 "mount a guest disk with mount options",
2012 This is the same as the C<guestfs_mount> command, but it
2013 allows you to set the mount options as for the
2014 L<mount(8)> I<-o> flag.");
2016 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"]), 75, [],
2018 "mount a guest disk with mount options and vfstype",
2020 This is the same as the C<guestfs_mount> command, but it
2021 allows you to set both the mount options and the vfstype
2022 as for the L<mount(8)> I<-o> and I<-t> flags.");
2024 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"]), 76, [],
2026 "debugging and internals",
2028 The C<guestfs_debug> command exposes some internals of
2029 C<guestfsd> (the guestfs daemon) that runs inside the
2032 There is no comprehensive help for this command. You have
2033 to look at the file C<daemon/debug.c> in the libguestfs source
2034 to find out what you can do.");
2036 ("lvremove", (RErr, [Device "device"]), 77, [],
2037 [InitEmpty, Always, TestOutputList (
2038 [["part_disk"; "/dev/sda"; "mbr"];
2039 ["pvcreate"; "/dev/sda1"];
2040 ["vgcreate"; "VG"; "/dev/sda1"];
2041 ["lvcreate"; "LV1"; "VG"; "50"];
2042 ["lvcreate"; "LV2"; "VG"; "50"];
2043 ["lvremove"; "/dev/VG/LV1"];
2044 ["lvs"]], ["/dev/VG/LV2"]);
2045 InitEmpty, Always, TestOutputList (
2046 [["part_disk"; "/dev/sda"; "mbr"];
2047 ["pvcreate"; "/dev/sda1"];
2048 ["vgcreate"; "VG"; "/dev/sda1"];
2049 ["lvcreate"; "LV1"; "VG"; "50"];
2050 ["lvcreate"; "LV2"; "VG"; "50"];
2051 ["lvremove"; "/dev/VG"];
2053 InitEmpty, Always, TestOutputList (
2054 [["part_disk"; "/dev/sda"; "mbr"];
2055 ["pvcreate"; "/dev/sda1"];
2056 ["vgcreate"; "VG"; "/dev/sda1"];
2057 ["lvcreate"; "LV1"; "VG"; "50"];
2058 ["lvcreate"; "LV2"; "VG"; "50"];
2059 ["lvremove"; "/dev/VG"];
2061 "remove an LVM logical volume",
2063 Remove an LVM logical volume C<device>, where C<device> is
2064 the path to the LV, such as C</dev/VG/LV>.
2066 You can also remove all LVs in a volume group by specifying
2067 the VG name, C</dev/VG>.");
2069 ("vgremove", (RErr, [String "vgname"]), 78, [],
2070 [InitEmpty, Always, TestOutputList (
2071 [["part_disk"; "/dev/sda"; "mbr"];
2072 ["pvcreate"; "/dev/sda1"];
2073 ["vgcreate"; "VG"; "/dev/sda1"];
2074 ["lvcreate"; "LV1"; "VG"; "50"];
2075 ["lvcreate"; "LV2"; "VG"; "50"];
2078 InitEmpty, Always, TestOutputList (
2079 [["part_disk"; "/dev/sda"; "mbr"];
2080 ["pvcreate"; "/dev/sda1"];
2081 ["vgcreate"; "VG"; "/dev/sda1"];
2082 ["lvcreate"; "LV1"; "VG"; "50"];
2083 ["lvcreate"; "LV2"; "VG"; "50"];
2086 "remove an LVM volume group",
2088 Remove an LVM volume group C<vgname>, (for example C<VG>).
2090 This also forcibly removes all logical volumes in the volume
2093 ("pvremove", (RErr, [Device "device"]), 79, [],
2094 [InitEmpty, Always, TestOutputListOfDevices (
2095 [["part_disk"; "/dev/sda"; "mbr"];
2096 ["pvcreate"; "/dev/sda1"];
2097 ["vgcreate"; "VG"; "/dev/sda1"];
2098 ["lvcreate"; "LV1"; "VG"; "50"];
2099 ["lvcreate"; "LV2"; "VG"; "50"];
2101 ["pvremove"; "/dev/sda1"];
2103 InitEmpty, Always, TestOutputListOfDevices (
2104 [["part_disk"; "/dev/sda"; "mbr"];
2105 ["pvcreate"; "/dev/sda1"];
2106 ["vgcreate"; "VG"; "/dev/sda1"];
2107 ["lvcreate"; "LV1"; "VG"; "50"];
2108 ["lvcreate"; "LV2"; "VG"; "50"];
2110 ["pvremove"; "/dev/sda1"];
2112 InitEmpty, Always, TestOutputListOfDevices (
2113 [["part_disk"; "/dev/sda"; "mbr"];
2114 ["pvcreate"; "/dev/sda1"];
2115 ["vgcreate"; "VG"; "/dev/sda1"];
2116 ["lvcreate"; "LV1"; "VG"; "50"];
2117 ["lvcreate"; "LV2"; "VG"; "50"];
2119 ["pvremove"; "/dev/sda1"];
2121 "remove an LVM physical volume",
2123 This wipes a physical volume C<device> so that LVM will no longer
2126 The implementation uses the C<pvremove> command which refuses to
2127 wipe physical volumes that contain any volume groups, so you have
2128 to remove those first.");
2130 ("set_e2label", (RErr, [Device "device"; String "label"]), 80, [],
2131 [InitBasicFS, Always, TestOutput (
2132 [["set_e2label"; "/dev/sda1"; "testlabel"];
2133 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2134 "set the ext2/3/4 filesystem label",
2136 This sets the ext2/3/4 filesystem label of the filesystem on
2137 C<device> to C<label>. Filesystem labels are limited to
2140 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2141 to return the existing label on a filesystem.");
2143 ("get_e2label", (RString "label", [Device "device"]), 81, [],
2145 "get the ext2/3/4 filesystem label",
2147 This returns the ext2/3/4 filesystem label of the filesystem on
2150 ("set_e2uuid", (RErr, [Device "device"; String "uuid"]), 82, [],
2151 (let uuid = uuidgen () in
2152 [InitBasicFS, Always, TestOutput (
2153 [["set_e2uuid"; "/dev/sda1"; uuid];
2154 ["get_e2uuid"; "/dev/sda1"]], uuid);
2155 InitBasicFS, Always, TestOutput (
2156 [["set_e2uuid"; "/dev/sda1"; "clear"];
2157 ["get_e2uuid"; "/dev/sda1"]], "");
2158 (* We can't predict what UUIDs will be, so just check the commands run. *)
2159 InitBasicFS, Always, TestRun (
2160 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2161 InitBasicFS, Always, TestRun (
2162 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2163 "set the ext2/3/4 filesystem UUID",
2165 This sets the ext2/3/4 filesystem UUID of the filesystem on
2166 C<device> to C<uuid>. The format of the UUID and alternatives
2167 such as C<clear>, C<random> and C<time> are described in the
2168 L<tune2fs(8)> manpage.
2170 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2171 to return the existing UUID of a filesystem.");
2173 ("get_e2uuid", (RString "uuid", [Device "device"]), 83, [],
2175 "get the ext2/3/4 filesystem UUID",
2177 This returns the ext2/3/4 filesystem UUID of the filesystem on
2180 ("fsck", (RInt "status", [String "fstype"; Device "device"]), 84, [],
2181 [InitBasicFS, Always, TestOutputInt (
2182 [["umount"; "/dev/sda1"];
2183 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2184 InitBasicFS, Always, TestOutputInt (
2185 [["umount"; "/dev/sda1"];
2186 ["zero"; "/dev/sda1"];
2187 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2188 "run the filesystem checker",
2190 This runs the filesystem checker (fsck) on C<device> which
2191 should have filesystem type C<fstype>.
2193 The returned integer is the status. See L<fsck(8)> for the
2194 list of status codes from C<fsck>.
2202 Multiple status codes can be summed together.
2206 A non-zero return code can mean \"success\", for example if
2207 errors have been corrected on the filesystem.
2211 Checking or repairing NTFS volumes is not supported
2216 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2218 ("zero", (RErr, [Device "device"]), 85, [],
2219 [InitBasicFS, Always, TestOutput (
2220 [["umount"; "/dev/sda1"];
2221 ["zero"; "/dev/sda1"];
2222 ["file"; "/dev/sda1"]], "data")],
2223 "write zeroes to the device",
2225 This command writes zeroes over the first few blocks of C<device>.
2227 How many blocks are zeroed isn't specified (but it's I<not> enough
2228 to securely wipe the device). It should be sufficient to remove
2229 any partition tables, filesystem superblocks and so on.
2231 See also: C<guestfs_scrub_device>.");
2233 ("grub_install", (RErr, [Pathname "root"; Device "device"]), 86, [],
2234 (* Test disabled because grub-install incompatible with virtio-blk driver.
2235 * See also: https://bugzilla.redhat.com/show_bug.cgi?id=479760
2237 [InitBasicFS, Disabled, TestOutputTrue (
2238 [["grub_install"; "/"; "/dev/sda1"];
2239 ["is_dir"; "/boot"]])],
2242 This command installs GRUB (the Grand Unified Bootloader) on
2243 C<device>, with the root directory being C<root>.");
2245 ("cp", (RErr, [Pathname "src"; Pathname "dest"]), 87, [],
2246 [InitBasicFS, Always, TestOutput (
2247 [["write_file"; "/old"; "file content"; "0"];
2248 ["cp"; "/old"; "/new"];
2249 ["cat"; "/new"]], "file content");
2250 InitBasicFS, Always, TestOutputTrue (
2251 [["write_file"; "/old"; "file content"; "0"];
2252 ["cp"; "/old"; "/new"];
2253 ["is_file"; "/old"]]);
2254 InitBasicFS, Always, TestOutput (
2255 [["write_file"; "/old"; "file content"; "0"];
2257 ["cp"; "/old"; "/dir/new"];
2258 ["cat"; "/dir/new"]], "file content")],
2261 This copies a file from C<src> to C<dest> where C<dest> is
2262 either a destination filename or destination directory.");
2264 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"]), 88, [],
2265 [InitBasicFS, Always, TestOutput (
2266 [["mkdir"; "/olddir"];
2267 ["mkdir"; "/newdir"];
2268 ["write_file"; "/olddir/file"; "file content"; "0"];
2269 ["cp_a"; "/olddir"; "/newdir"];
2270 ["cat"; "/newdir/olddir/file"]], "file content")],
2271 "copy a file or directory recursively",
2273 This copies a file or directory from C<src> to C<dest>
2274 recursively using the C<cp -a> command.");
2276 ("mv", (RErr, [Pathname "src"; Pathname "dest"]), 89, [],
2277 [InitBasicFS, Always, TestOutput (
2278 [["write_file"; "/old"; "file content"; "0"];
2279 ["mv"; "/old"; "/new"];
2280 ["cat"; "/new"]], "file content");
2281 InitBasicFS, Always, TestOutputFalse (
2282 [["write_file"; "/old"; "file content"; "0"];
2283 ["mv"; "/old"; "/new"];
2284 ["is_file"; "/old"]])],
2287 This moves a file from C<src> to C<dest> where C<dest> is
2288 either a destination filename or destination directory.");
2290 ("drop_caches", (RErr, [Int "whattodrop"]), 90, [],
2291 [InitEmpty, Always, TestRun (
2292 [["drop_caches"; "3"]])],
2293 "drop kernel page cache, dentries and inodes",
2295 This instructs the guest kernel to drop its page cache,
2296 and/or dentries and inode caches. The parameter C<whattodrop>
2297 tells the kernel what precisely to drop, see
2298 L<http://linux-mm.org/Drop_Caches>
2300 Setting C<whattodrop> to 3 should drop everything.
2302 This automatically calls L<sync(2)> before the operation,
2303 so that the maximum guest memory is freed.");
2305 ("dmesg", (RString "kmsgs", []), 91, [],
2306 [InitEmpty, Always, TestRun (
2308 "return kernel messages",
2310 This returns the kernel messages (C<dmesg> output) from
2311 the guest kernel. This is sometimes useful for extended
2312 debugging of problems.
2314 Another way to get the same information is to enable
2315 verbose messages with C<guestfs_set_verbose> or by setting
2316 the environment variable C<LIBGUESTFS_DEBUG=1> before
2317 running the program.");
2319 ("ping_daemon", (RErr, []), 92, [],
2320 [InitEmpty, Always, TestRun (
2321 [["ping_daemon"]])],
2322 "ping the guest daemon",
2324 This is a test probe into the guestfs daemon running inside
2325 the qemu subprocess. Calling this function checks that the
2326 daemon responds to the ping message, without affecting the daemon
2327 or attached block device(s) in any other way.");
2329 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"]), 93, [],
2330 [InitBasicFS, Always, TestOutputTrue (
2331 [["write_file"; "/file1"; "contents of a file"; "0"];
2332 ["cp"; "/file1"; "/file2"];
2333 ["equal"; "/file1"; "/file2"]]);
2334 InitBasicFS, Always, TestOutputFalse (
2335 [["write_file"; "/file1"; "contents of a file"; "0"];
2336 ["write_file"; "/file2"; "contents of another file"; "0"];
2337 ["equal"; "/file1"; "/file2"]]);
2338 InitBasicFS, Always, TestLastFail (
2339 [["equal"; "/file1"; "/file2"]])],
2340 "test if two files have equal contents",
2342 This compares the two files C<file1> and C<file2> and returns
2343 true if their content is exactly equal, or false otherwise.
2345 The external L<cmp(1)> program is used for the comparison.");
2347 ("strings", (RStringList "stringsout", [Pathname "path"]), 94, [ProtocolLimitWarning],
2348 [InitISOFS, Always, TestOutputList (
2349 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
2350 InitISOFS, Always, TestOutputList (
2351 [["strings"; "/empty"]], [])],
2352 "print the printable strings in a file",
2354 This runs the L<strings(1)> command on a file and returns
2355 the list of printable strings found.");
2357 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"]), 95, [ProtocolLimitWarning],
2358 [InitISOFS, Always, TestOutputList (
2359 [["strings_e"; "b"; "/known-5"]], []);
2360 InitBasicFS, Disabled, TestOutputList (
2361 [["write_file"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"; "24"];
2362 ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
2363 "print the printable strings in a file",
2365 This is like the C<guestfs_strings> command, but allows you to
2366 specify the encoding.
2368 See the L<strings(1)> manpage for the full list of encodings.
2370 Commonly useful encodings are C<l> (lower case L) which will
2371 show strings inside Windows/x86 files.
2373 The returned strings are transcoded to UTF-8.");
2375 ("hexdump", (RString "dump", [Pathname "path"]), 96, [ProtocolLimitWarning],
2376 [InitISOFS, Always, TestOutput (
2377 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
2378 (* Test for RHBZ#501888c2 regression which caused large hexdump
2379 * commands to segfault.
2381 InitISOFS, Always, TestRun (
2382 [["hexdump"; "/100krandom"]])],
2383 "dump a file in hexadecimal",
2385 This runs C<hexdump -C> on the given C<path>. The result is
2386 the human-readable, canonical hex dump of the file.");
2388 ("zerofree", (RErr, [Device "device"]), 97, [],
2389 [InitNone, Always, TestOutput (
2390 [["part_disk"; "/dev/sda"; "mbr"];
2391 ["mkfs"; "ext3"; "/dev/sda1"];
2392 ["mount"; "/dev/sda1"; "/"];
2393 ["write_file"; "/new"; "test file"; "0"];
2394 ["umount"; "/dev/sda1"];
2395 ["zerofree"; "/dev/sda1"];
2396 ["mount"; "/dev/sda1"; "/"];
2397 ["cat"; "/new"]], "test file")],
2398 "zero unused inodes and disk blocks on ext2/3 filesystem",
2400 This runs the I<zerofree> program on C<device>. This program
2401 claims to zero unused inodes and disk blocks on an ext2/3
2402 filesystem, thus making it possible to compress the filesystem
2405 You should B<not> run this program if the filesystem is
2408 It is possible that using this program can damage the filesystem
2409 or data on the filesystem.");
2411 ("pvresize", (RErr, [Device "device"]), 98, [],
2413 "resize an LVM physical volume",
2415 This resizes (expands or shrinks) an existing LVM physical
2416 volume to match the new size of the underlying device.");
2418 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
2419 Int "cyls"; Int "heads"; Int "sectors";
2420 String "line"]), 99, [DangerWillRobinson],
2422 "modify a single partition on a block device",
2424 This runs L<sfdisk(8)> option to modify just the single
2425 partition C<n> (note: C<n> counts from 1).
2427 For other parameters, see C<guestfs_sfdisk>. You should usually
2428 pass C<0> for the cyls/heads/sectors parameters.
2430 See also: C<guestfs_part_add>");
2432 ("sfdisk_l", (RString "partitions", [Device "device"]), 100, [],
2434 "display the partition table",
2436 This displays the partition table on C<device>, in the
2437 human-readable output of the L<sfdisk(8)> command. It is
2438 not intended to be parsed.
2440 See also: C<guestfs_part_list>");
2442 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"]), 101, [],
2444 "display the kernel geometry",
2446 This displays the kernel's idea of the geometry of C<device>.
2448 The result is in human-readable format, and not designed to
2451 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"]), 102, [],
2453 "display the disk geometry from the partition table",
2455 This displays the disk geometry of C<device> read from the
2456 partition table. Especially in the case where the underlying
2457 block device has been resized, this can be different from the
2458 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
2460 The result is in human-readable format, and not designed to
2463 ("vg_activate_all", (RErr, [Bool "activate"]), 103, [],
2465 "activate or deactivate all volume groups",
2467 This command activates or (if C<activate> is false) deactivates
2468 all logical volumes in all volume groups.
2469 If activated, then they are made known to the
2470 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2471 then those devices disappear.
2473 This command is the same as running C<vgchange -a y|n>");
2475 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"]), 104, [],
2477 "activate or deactivate some volume groups",
2479 This command activates or (if C<activate> is false) deactivates
2480 all logical volumes in the listed volume groups C<volgroups>.
2481 If activated, then they are made known to the
2482 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2483 then those devices disappear.
2485 This command is the same as running C<vgchange -a y|n volgroups...>
2487 Note that if C<volgroups> is an empty list then B<all> volume groups
2488 are activated or deactivated.");
2490 ("lvresize", (RErr, [Device "device"; Int "mbytes"]), 105, [],
2491 [InitNone, Always, TestOutput (
2492 [["part_disk"; "/dev/sda"; "mbr"];
2493 ["pvcreate"; "/dev/sda1"];
2494 ["vgcreate"; "VG"; "/dev/sda1"];
2495 ["lvcreate"; "LV"; "VG"; "10"];
2496 ["mkfs"; "ext2"; "/dev/VG/LV"];
2497 ["mount"; "/dev/VG/LV"; "/"];
2498 ["write_file"; "/new"; "test content"; "0"];
2500 ["lvresize"; "/dev/VG/LV"; "20"];
2501 ["e2fsck_f"; "/dev/VG/LV"];
2502 ["resize2fs"; "/dev/VG/LV"];
2503 ["mount"; "/dev/VG/LV"; "/"];
2504 ["cat"; "/new"]], "test content")],
2505 "resize an LVM logical volume",
2507 This resizes (expands or shrinks) an existing LVM logical
2508 volume to C<mbytes>. When reducing, data in the reduced part
2511 ("resize2fs", (RErr, [Device "device"]), 106, [],
2512 [], (* lvresize tests this *)
2513 "resize an ext2/ext3 filesystem",
2515 This resizes an ext2 or ext3 filesystem to match the size of
2516 the underlying device.
2518 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
2519 on the C<device> before calling this command. For unknown reasons
2520 C<resize2fs> sometimes gives an error about this and sometimes not.
2521 In any case, it is always safe to call C<guestfs_e2fsck_f> before
2522 calling this function.");
2524 ("find", (RStringList "names", [Pathname "directory"]), 107, [ProtocolLimitWarning],
2525 [InitBasicFS, Always, TestOutputList (
2526 [["find"; "/"]], ["lost+found"]);
2527 InitBasicFS, Always, TestOutputList (
2531 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
2532 InitBasicFS, Always, TestOutputList (
2533 [["mkdir_p"; "/a/b/c"];
2534 ["touch"; "/a/b/c/d"];
2535 ["find"; "/a/b/"]], ["c"; "c/d"])],
2536 "find all files and directories",
2538 This command lists out all files and directories, recursively,
2539 starting at C<directory>. It is essentially equivalent to
2540 running the shell command C<find directory -print> but some
2541 post-processing happens on the output, described below.
2543 This returns a list of strings I<without any prefix>. Thus
2544 if the directory structure was:
2550 then the returned list from C<guestfs_find> C</tmp> would be
2558 If C<directory> is not a directory, then this command returns
2561 The returned list is sorted.
2563 See also C<guestfs_find0>.");
2565 ("e2fsck_f", (RErr, [Device "device"]), 108, [],
2566 [], (* lvresize tests this *)
2567 "check an ext2/ext3 filesystem",
2569 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
2570 filesystem checker on C<device>, noninteractively (C<-p>),
2571 even if the filesystem appears to be clean (C<-f>).
2573 This command is only needed because of C<guestfs_resize2fs>
2574 (q.v.). Normally you should use C<guestfs_fsck>.");
2576 ("sleep", (RErr, [Int "secs"]), 109, [],
2577 [InitNone, Always, TestRun (
2579 "sleep for some seconds",
2581 Sleep for C<secs> seconds.");
2583 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"]), 110, [],
2584 [InitNone, Always, TestOutputInt (
2585 [["part_disk"; "/dev/sda"; "mbr"];
2586 ["mkfs"; "ntfs"; "/dev/sda1"];
2587 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
2588 InitNone, Always, TestOutputInt (
2589 [["part_disk"; "/dev/sda"; "mbr"];
2590 ["mkfs"; "ext2"; "/dev/sda1"];
2591 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
2592 "probe NTFS volume",
2594 This command runs the L<ntfs-3g.probe(8)> command which probes
2595 an NTFS C<device> for mountability. (Not all NTFS volumes can
2596 be mounted read-write, and some cannot be mounted at all).
2598 C<rw> is a boolean flag. Set it to true if you want to test
2599 if the volume can be mounted read-write. Set it to false if
2600 you want to test if the volume can be mounted read-only.
2602 The return value is an integer which C<0> if the operation
2603 would succeed, or some non-zero value documented in the
2604 L<ntfs-3g.probe(8)> manual page.");
2606 ("sh", (RString "output", [String "command"]), 111, [],
2607 [], (* XXX needs tests *)
2608 "run a command via the shell",
2610 This call runs a command from the guest filesystem via the
2613 This is like C<guestfs_command>, but passes the command to:
2615 /bin/sh -c \"command\"
2617 Depending on the guest's shell, this usually results in
2618 wildcards being expanded, shell expressions being interpolated
2621 All the provisos about C<guestfs_command> apply to this call.");
2623 ("sh_lines", (RStringList "lines", [String "command"]), 112, [],
2624 [], (* XXX needs tests *)
2625 "run a command via the shell returning lines",
2627 This is the same as C<guestfs_sh>, but splits the result
2628 into a list of lines.
2630 See also: C<guestfs_command_lines>");
2632 ("glob_expand", (RStringList "paths", [Pathname "pattern"]), 113, [],
2633 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
2634 * code in stubs.c, since all valid glob patterns must start with "/".
2635 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
2637 [InitBasicFS, Always, TestOutputList (
2638 [["mkdir_p"; "/a/b/c"];
2639 ["touch"; "/a/b/c/d"];
2640 ["touch"; "/a/b/c/e"];
2641 ["glob_expand"; "/a/b/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2642 InitBasicFS, Always, TestOutputList (
2643 [["mkdir_p"; "/a/b/c"];
2644 ["touch"; "/a/b/c/d"];
2645 ["touch"; "/a/b/c/e"];
2646 ["glob_expand"; "/a/*/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2647 InitBasicFS, Always, TestOutputList (
2648 [["mkdir_p"; "/a/b/c"];
2649 ["touch"; "/a/b/c/d"];
2650 ["touch"; "/a/b/c/e"];
2651 ["glob_expand"; "/a/*/x/*"]], [])],
2652 "expand a wildcard path",
2654 This command searches for all the pathnames matching
2655 C<pattern> according to the wildcard expansion rules
2658 If no paths match, then this returns an empty list
2659 (note: not an error).
2661 It is just a wrapper around the C L<glob(3)> function
2662 with flags C<GLOB_MARK|GLOB_BRACE>.
2663 See that manual page for more details.");
2665 ("scrub_device", (RErr, [Device "device"]), 114, [DangerWillRobinson],
2666 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
2667 [["scrub_device"; "/dev/sdc"]])],
2668 "scrub (securely wipe) a device",
2670 This command writes patterns over C<device> to make data retrieval
2673 It is an interface to the L<scrub(1)> program. See that
2674 manual page for more details.");
2676 ("scrub_file", (RErr, [Pathname "file"]), 115, [],
2677 [InitBasicFS, Always, TestRun (
2678 [["write_file"; "/file"; "content"; "0"];
2679 ["scrub_file"; "/file"]])],
2680 "scrub (securely wipe) a file",
2682 This command writes patterns over a file to make data retrieval
2685 The file is I<removed> after scrubbing.
2687 It is an interface to the L<scrub(1)> program. See that
2688 manual page for more details.");
2690 ("scrub_freespace", (RErr, [Pathname "dir"]), 116, [],
2691 [], (* XXX needs testing *)
2692 "scrub (securely wipe) free space",
2694 This command creates the directory C<dir> and then fills it
2695 with files until the filesystem is full, and scrubs the files
2696 as for C<guestfs_scrub_file>, and deletes them.
2697 The intention is to scrub any free space on the partition
2700 It is an interface to the L<scrub(1)> program. See that
2701 manual page for more details.");
2703 ("mkdtemp", (RString "dir", [Pathname "template"]), 117, [],
2704 [InitBasicFS, Always, TestRun (
2706 ["mkdtemp"; "/tmp/tmpXXXXXX"]])],
2707 "create a temporary directory",
2709 This command creates a temporary directory. The
2710 C<template> parameter should be a full pathname for the
2711 temporary directory name with the final six characters being
2714 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
2715 the second one being suitable for Windows filesystems.
2717 The name of the temporary directory that was created
2720 The temporary directory is created with mode 0700
2721 and is owned by root.
2723 The caller is responsible for deleting the temporary
2724 directory and its contents after use.
2726 See also: L<mkdtemp(3)>");
2728 ("wc_l", (RInt "lines", [Pathname "path"]), 118, [],
2729 [InitISOFS, Always, TestOutputInt (
2730 [["wc_l"; "/10klines"]], 10000)],
2731 "count lines in a file",
2733 This command counts the lines in a file, using the
2734 C<wc -l> external command.");
2736 ("wc_w", (RInt "words", [Pathname "path"]), 119, [],
2737 [InitISOFS, Always, TestOutputInt (
2738 [["wc_w"; "/10klines"]], 10000)],
2739 "count words in a file",
2741 This command counts the words in a file, using the
2742 C<wc -w> external command.");
2744 ("wc_c", (RInt "chars", [Pathname "path"]), 120, [],
2745 [InitISOFS, Always, TestOutputInt (
2746 [["wc_c"; "/100kallspaces"]], 102400)],
2747 "count characters in a file",
2749 This command counts the characters in a file, using the
2750 C<wc -c> external command.");
2752 ("head", (RStringList "lines", [Pathname "path"]), 121, [ProtocolLimitWarning],
2753 [InitISOFS, Always, TestOutputList (
2754 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
2755 "return first 10 lines of a file",
2757 This command returns up to the first 10 lines of a file as
2758 a list of strings.");
2760 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"]), 122, [ProtocolLimitWarning],
2761 [InitISOFS, Always, TestOutputList (
2762 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2763 InitISOFS, Always, TestOutputList (
2764 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2765 InitISOFS, Always, TestOutputList (
2766 [["head_n"; "0"; "/10klines"]], [])],
2767 "return first N lines of a file",
2769 If the parameter C<nrlines> is a positive number, this returns the first
2770 C<nrlines> lines of the file C<path>.
2772 If the parameter C<nrlines> is a negative number, this returns lines
2773 from the file C<path>, excluding the last C<nrlines> lines.
2775 If the parameter C<nrlines> is zero, this returns an empty list.");
2777 ("tail", (RStringList "lines", [Pathname "path"]), 123, [ProtocolLimitWarning],
2778 [InitISOFS, Always, TestOutputList (
2779 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
2780 "return last 10 lines of a file",
2782 This command returns up to the last 10 lines of a file as
2783 a list of strings.");
2785 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"]), 124, [ProtocolLimitWarning],
2786 [InitISOFS, Always, TestOutputList (
2787 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2788 InitISOFS, Always, TestOutputList (
2789 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2790 InitISOFS, Always, TestOutputList (
2791 [["tail_n"; "0"; "/10klines"]], [])],
2792 "return last N lines of a file",
2794 If the parameter C<nrlines> is a positive number, this returns the last
2795 C<nrlines> lines of the file C<path>.
2797 If the parameter C<nrlines> is a negative number, this returns lines
2798 from the file C<path>, starting with the C<-nrlines>th line.
2800 If the parameter C<nrlines> is zero, this returns an empty list.");
2802 ("df", (RString "output", []), 125, [],
2803 [], (* XXX Tricky to test because it depends on the exact format
2804 * of the 'df' command and other imponderables.
2806 "report file system disk space usage",
2808 This command runs the C<df> command to report disk space used.
2810 This command is mostly useful for interactive sessions. It
2811 is I<not> intended that you try to parse the output string.
2812 Use C<statvfs> from programs.");
2814 ("df_h", (RString "output", []), 126, [],
2815 [], (* XXX Tricky to test because it depends on the exact format
2816 * of the 'df' command and other imponderables.
2818 "report file system disk space usage (human readable)",
2820 This command runs the C<df -h> command to report disk space used
2821 in human-readable format.
2823 This command is mostly useful for interactive sessions. It
2824 is I<not> intended that you try to parse the output string.
2825 Use C<statvfs> from programs.");
2827 ("du", (RInt64 "sizekb", [Pathname "path"]), 127, [],
2828 [InitISOFS, Always, TestOutputInt (
2829 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
2830 "estimate file space usage",
2832 This command runs the C<du -s> command to estimate file space
2835 C<path> can be a file or a directory. If C<path> is a directory
2836 then the estimate includes the contents of the directory and all
2837 subdirectories (recursively).
2839 The result is the estimated size in I<kilobytes>
2840 (ie. units of 1024 bytes).");
2842 ("initrd_list", (RStringList "filenames", [Pathname "path"]), 128, [],
2843 [InitISOFS, Always, TestOutputList (
2844 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
2845 "list files in an initrd",
2847 This command lists out files contained in an initrd.
2849 The files are listed without any initial C</> character. The
2850 files are listed in the order they appear (not necessarily
2851 alphabetical). Directory names are listed as separate items.
2853 Old Linux kernels (2.4 and earlier) used a compressed ext2
2854 filesystem as initrd. We I<only> support the newer initramfs
2855 format (compressed cpio files).");
2857 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"]), 129, [],
2859 "mount a file using the loop device",
2861 This command lets you mount C<file> (a filesystem image
2862 in a file) on a mount point. It is entirely equivalent to
2863 the command C<mount -o loop file mountpoint>.");
2865 ("mkswap", (RErr, [Device "device"]), 130, [],
2866 [InitEmpty, Always, TestRun (
2867 [["part_disk"; "/dev/sda"; "mbr"];
2868 ["mkswap"; "/dev/sda1"]])],
2869 "create a swap partition",
2871 Create a swap partition on C<device>.");
2873 ("mkswap_L", (RErr, [String "label"; Device "device"]), 131, [],
2874 [InitEmpty, Always, TestRun (
2875 [["part_disk"; "/dev/sda"; "mbr"];
2876 ["mkswap_L"; "hello"; "/dev/sda1"]])],
2877 "create a swap partition with a label",
2879 Create a swap partition on C<device> with label C<label>.
2881 Note that you cannot attach a swap label to a block device
2882 (eg. C</dev/sda>), just to a partition. This appears to be
2883 a limitation of the kernel or swap tools.");
2885 ("mkswap_U", (RErr, [String "uuid"; Device "device"]), 132, [],
2886 (let uuid = uuidgen () in
2887 [InitEmpty, Always, TestRun (
2888 [["part_disk"; "/dev/sda"; "mbr"];
2889 ["mkswap_U"; uuid; "/dev/sda1"]])]),
2890 "create a swap partition with an explicit UUID",
2892 Create a swap partition on C<device> with UUID C<uuid>.");
2894 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 133, [],
2895 [InitBasicFS, Always, TestOutputStruct (
2896 [["mknod"; "0o10777"; "0"; "0"; "/node"];
2897 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
2898 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)]);
2899 InitBasicFS, Always, TestOutputStruct (
2900 [["mknod"; "0o60777"; "66"; "99"; "/node"];
2901 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
2902 "make block, character or FIFO devices",
2904 This call creates block or character special devices, or
2905 named pipes (FIFOs).
2907 The C<mode> parameter should be the mode, using the standard
2908 constants. C<devmajor> and C<devminor> are the
2909 device major and minor numbers, only used when creating block
2910 and character special devices.");
2912 ("mkfifo", (RErr, [Int "mode"; Pathname "path"]), 134, [],
2913 [InitBasicFS, Always, TestOutputStruct (
2914 [["mkfifo"; "0o777"; "/node"];
2915 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)])],
2916 "make FIFO (named pipe)",
2918 This call creates a FIFO (named pipe) called C<path> with
2919 mode C<mode>. It is just a convenient wrapper around
2920 C<guestfs_mknod>.");
2922 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 135, [],
2923 [InitBasicFS, Always, TestOutputStruct (
2924 [["mknod_b"; "0o777"; "99"; "66"; "/node"];
2925 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
2926 "make block device node",
2928 This call creates a block device node called C<path> with
2929 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
2930 It is just a convenient wrapper around C<guestfs_mknod>.");
2932 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 136, [],
2933 [InitBasicFS, Always, TestOutputStruct (
2934 [["mknod_c"; "0o777"; "99"; "66"; "/node"];
2935 ["stat"; "/node"]], [CompareWithInt ("mode", 0o20755)])],
2936 "make char device node",
2938 This call creates a char device node called C<path> with
2939 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
2940 It is just a convenient wrapper around C<guestfs_mknod>.");
2942 ("umask", (RInt "oldmask", [Int "mask"]), 137, [],
2943 [], (* XXX umask is one of those stateful things that we should
2944 * reset between each test.
2946 "set file mode creation mask (umask)",
2948 This function sets the mask used for creating new files and
2949 device nodes to C<mask & 0777>.
2951 Typical umask values would be C<022> which creates new files
2952 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
2953 C<002> which creates new files with permissions like
2954 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
2956 The default umask is C<022>. This is important because it
2957 means that directories and device nodes will be created with
2958 C<0644> or C<0755> mode even if you specify C<0777>.
2960 See also L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
2962 This call returns the previous umask.");
2964 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"]), 138, [],
2966 "read directories entries",
2968 This returns the list of directory entries in directory C<dir>.
2970 All entries in the directory are returned, including C<.> and
2971 C<..>. The entries are I<not> sorted, but returned in the same
2972 order as the underlying filesystem.
2974 Also this call returns basic file type information about each
2975 file. The C<ftyp> field will contain one of the following characters:
3013 The L<readdir(3)> returned a C<d_type> field with an
3018 This function is primarily intended for use by programs. To
3019 get a simple list of names, use C<guestfs_ls>. To get a printable
3020 directory for human consumption, use C<guestfs_ll>.");
3022 ("sfdiskM", (RErr, [Device "device"; StringList "lines"]), 139, [DangerWillRobinson],
3024 "create partitions on a block device",
3026 This is a simplified interface to the C<guestfs_sfdisk>
3027 command, where partition sizes are specified in megabytes
3028 only (rounded to the nearest cylinder) and you don't need
3029 to specify the cyls, heads and sectors parameters which
3030 were rarely if ever used anyway.
3032 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3033 and C<guestfs_part_disk>");
3035 ("zfile", (RString "description", [String "meth"; Pathname "path"]), 140, [DeprecatedBy "file"],
3037 "determine file type inside a compressed file",
3039 This command runs C<file> after first decompressing C<path>
3042 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3044 Since 1.0.63, use C<guestfs_file> instead which can now
3045 process compressed files.");
3047 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"]), 141, [],
3049 "list extended attributes of a file or directory",
3051 This call lists the extended attributes of the file or directory
3054 At the system call level, this is a combination of the
3055 L<listxattr(2)> and L<getxattr(2)> calls.
3057 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3059 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"]), 142, [],
3061 "list extended attributes of a file or directory",
3063 This is the same as C<guestfs_getxattrs>, but if C<path>
3064 is a symbolic link, then it returns the extended attributes
3065 of the link itself.");
3067 ("setxattr", (RErr, [String "xattr";
3068 String "val"; Int "vallen"; (* will be BufferIn *)
3069 Pathname "path"]), 143, [],
3071 "set extended attribute of a file or directory",
3073 This call sets the extended attribute named C<xattr>
3074 of the file C<path> to the value C<val> (of length C<vallen>).
3075 The value is arbitrary 8 bit data.
3077 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3079 ("lsetxattr", (RErr, [String "xattr";
3080 String "val"; Int "vallen"; (* will be BufferIn *)
3081 Pathname "path"]), 144, [],
3083 "set extended attribute of a file or directory",
3085 This is the same as C<guestfs_setxattr>, but if C<path>
3086 is a symbolic link, then it sets an extended attribute
3087 of the link itself.");
3089 ("removexattr", (RErr, [String "xattr"; Pathname "path"]), 145, [],
3091 "remove extended attribute of a file or directory",
3093 This call removes the extended attribute named C<xattr>
3094 of the file C<path>.
3096 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3098 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"]), 146, [],
3100 "remove extended attribute of a file or directory",
3102 This is the same as C<guestfs_removexattr>, but if C<path>
3103 is a symbolic link, then it removes an extended attribute
3104 of the link itself.");
3106 ("mountpoints", (RHashtable "mps", []), 147, [],
3110 This call is similar to C<guestfs_mounts>. That call returns
3111 a list of devices. This one returns a hash table (map) of
3112 device name to directory where the device is mounted.");
3114 ("mkmountpoint", (RErr, [String "exemptpath"]), 148, [],
3115 (* This is a special case: while you would expect a parameter
3116 * of type "Pathname", that doesn't work, because it implies
3117 * NEED_ROOT in the generated calling code in stubs.c, and
3118 * this function cannot use NEED_ROOT.
3121 "create a mountpoint",
3123 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3124 specialized calls that can be used to create extra mountpoints
3125 before mounting the first filesystem.
3127 These calls are I<only> necessary in some very limited circumstances,
3128 mainly the case where you want to mount a mix of unrelated and/or
3129 read-only filesystems together.
3131 For example, live CDs often contain a \"Russian doll\" nest of
3132 filesystems, an ISO outer layer, with a squashfs image inside, with
3133 an ext2/3 image inside that. You can unpack this as follows
3136 add-ro Fedora-11-i686-Live.iso
3139 mkmountpoint /squash
3142 mount-loop /cd/LiveOS/squashfs.img /squash
3143 mount-loop /squash/LiveOS/ext3fs.img /ext3
3145 The inner filesystem is now unpacked under the /ext3 mountpoint.");
3147 ("rmmountpoint", (RErr, [String "exemptpath"]), 149, [],
3149 "remove a mountpoint",
3151 This calls removes a mountpoint that was previously created
3152 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
3153 for full details.");
3155 ("read_file", (RBufferOut "content", [Pathname "path"]), 150, [ProtocolLimitWarning],
3156 [InitISOFS, Always, TestOutputBuffer (
3157 [["read_file"; "/known-4"]], "abc\ndef\nghi")],
3160 This calls returns the contents of the file C<path> as a
3163 Unlike C<guestfs_cat>, this function can correctly
3164 handle files that contain embedded ASCII NUL characters.
3165 However unlike C<guestfs_download>, this function is limited
3166 in the total size of file that can be handled.");
3168 ("grep", (RStringList "lines", [String "regex"; Pathname "path"]), 151, [ProtocolLimitWarning],
3169 [InitISOFS, Always, TestOutputList (
3170 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3171 InitISOFS, Always, TestOutputList (
3172 [["grep"; "nomatch"; "/test-grep.txt"]], [])],
3173 "return lines matching a pattern",
3175 This calls the external C<grep> program and returns the
3178 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"]), 152, [ProtocolLimitWarning],
3179 [InitISOFS, Always, TestOutputList (
3180 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3181 "return lines matching a pattern",
3183 This calls the external C<egrep> program and returns the
3186 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"]), 153, [ProtocolLimitWarning],
3187 [InitISOFS, Always, TestOutputList (
3188 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3189 "return lines matching a pattern",
3191 This calls the external C<fgrep> program and returns the
3194 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"]), 154, [ProtocolLimitWarning],
3195 [InitISOFS, Always, TestOutputList (
3196 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3197 "return lines matching a pattern",
3199 This calls the external C<grep -i> program and returns the
3202 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 155, [ProtocolLimitWarning],
3203 [InitISOFS, Always, TestOutputList (
3204 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3205 "return lines matching a pattern",
3207 This calls the external C<egrep -i> program and returns the
3210 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"]), 156, [ProtocolLimitWarning],
3211 [InitISOFS, Always, TestOutputList (
3212 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3213 "return lines matching a pattern",
3215 This calls the external C<fgrep -i> program and returns the
3218 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"]), 157, [ProtocolLimitWarning],
3219 [InitISOFS, Always, TestOutputList (
3220 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3221 "return lines matching a pattern",
3223 This calls the external C<zgrep> program and returns the
3226 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"]), 158, [ProtocolLimitWarning],
3227 [InitISOFS, Always, TestOutputList (
3228 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3229 "return lines matching a pattern",
3231 This calls the external C<zegrep> program and returns the
3234 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"]), 159, [ProtocolLimitWarning],
3235 [InitISOFS, Always, TestOutputList (
3236 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3237 "return lines matching a pattern",
3239 This calls the external C<zfgrep> program and returns the
3242 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 160, [ProtocolLimitWarning],
3243 [InitISOFS, Always, TestOutputList (
3244 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3245 "return lines matching a pattern",
3247 This calls the external C<zgrep -i> program and returns the
3250 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 161, [ProtocolLimitWarning],
3251 [InitISOFS, Always, TestOutputList (
3252 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3253 "return lines matching a pattern",
3255 This calls the external C<zegrep -i> program and returns the
3258 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"]), 162, [ProtocolLimitWarning],
3259 [InitISOFS, Always, TestOutputList (
3260 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3261 "return lines matching a pattern",
3263 This calls the external C<zfgrep -i> program and returns the
3266 ("realpath", (RString "rpath", [Pathname "path"]), 163, [],
3267 [InitISOFS, Always, TestOutput (
3268 [["realpath"; "/../directory"]], "/directory")],
3269 "canonicalized absolute pathname",
3271 Return the canonicalized absolute pathname of C<path>. The
3272 returned path has no C<.>, C<..> or symbolic link path elements.");
3274 ("ln", (RErr, [String "target"; Pathname "linkname"]), 164, [],
3275 [InitBasicFS, Always, TestOutputStruct (
3278 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3279 "create a hard link",
3281 This command creates a hard link using the C<ln> command.");
3283 ("ln_f", (RErr, [String "target"; Pathname "linkname"]), 165, [],
3284 [InitBasicFS, Always, TestOutputStruct (
3287 ["ln_f"; "/a"; "/b"];
3288 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3289 "create a hard link",
3291 This command creates a hard link using the C<ln -f> command.
3292 The C<-f> option removes the link (C<linkname>) if it exists already.");
3294 ("ln_s", (RErr, [String "target"; Pathname "linkname"]), 166, [],
3295 [InitBasicFS, Always, TestOutputStruct (
3297 ["ln_s"; "a"; "/b"];
3298 ["lstat"; "/b"]], [CompareWithInt ("mode", 0o120777)])],
3299 "create a symbolic link",
3301 This command creates a symbolic link using the C<ln -s> command.");
3303 ("ln_sf", (RErr, [String "target"; Pathname "linkname"]), 167, [],
3304 [InitBasicFS, Always, TestOutput (
3305 [["mkdir_p"; "/a/b"];
3306 ["touch"; "/a/b/c"];
3307 ["ln_sf"; "../d"; "/a/b/c"];
3308 ["readlink"; "/a/b/c"]], "../d")],
3309 "create a symbolic link",
3311 This command creates a symbolic link using the C<ln -sf> command,
3312 The C<-f> option removes the link (C<linkname>) if it exists already.");
3314 ("readlink", (RString "link", [Pathname "path"]), 168, [],
3315 [] (* XXX tested above *),
3316 "read the target of a symbolic link",
3318 This command reads the target of a symbolic link.");
3320 ("fallocate", (RErr, [Pathname "path"; Int "len"]), 169, [],
3321 [InitBasicFS, Always, TestOutputStruct (
3322 [["fallocate"; "/a"; "1000000"];
3323 ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
3324 "preallocate a file in the guest filesystem",
3326 This command preallocates a file (containing zero bytes) named
3327 C<path> of size C<len> bytes. If the file exists already, it
3330 Do not confuse this with the guestfish-specific
3331 C<alloc> command which allocates a file in the host and
3332 attaches it as a device.");
3334 ("swapon_device", (RErr, [Device "device"]), 170, [],
3335 [InitPartition, Always, TestRun (
3336 [["mkswap"; "/dev/sda1"];
3337 ["swapon_device"; "/dev/sda1"];
3338 ["swapoff_device"; "/dev/sda1"]])],
3339 "enable swap on device",
3341 This command enables the libguestfs appliance to use the
3342 swap device or partition named C<device>. The increased
3343 memory is made available for all commands, for example
3344 those run using C<guestfs_command> or C<guestfs_sh>.
3346 Note that you should not swap to existing guest swap
3347 partitions unless you know what you are doing. They may
3348 contain hibernation information, or other information that
3349 the guest doesn't want you to trash. You also risk leaking
3350 information about the host to the guest this way. Instead,
3351 attach a new host device to the guest and swap on that.");
3353 ("swapoff_device", (RErr, [Device "device"]), 171, [],
3354 [], (* XXX tested by swapon_device *)
3355 "disable swap on device",
3357 This command disables the libguestfs appliance swap
3358 device or partition named C<device>.
3359 See C<guestfs_swapon_device>.");
3361 ("swapon_file", (RErr, [Pathname "file"]), 172, [],
3362 [InitBasicFS, Always, TestRun (
3363 [["fallocate"; "/swap"; "8388608"];
3364 ["mkswap_file"; "/swap"];
3365 ["swapon_file"; "/swap"];
3366 ["swapoff_file"; "/swap"]])],
3367 "enable swap on file",
3369 This command enables swap to a file.
3370 See C<guestfs_swapon_device> for other notes.");
3372 ("swapoff_file", (RErr, [Pathname "file"]), 173, [],
3373 [], (* XXX tested by swapon_file *)
3374 "disable swap on file",
3376 This command disables the libguestfs appliance swap on file.");
3378 ("swapon_label", (RErr, [String "label"]), 174, [],
3379 [InitEmpty, Always, TestRun (
3380 [["part_disk"; "/dev/sdb"; "mbr"];
3381 ["mkswap_L"; "swapit"; "/dev/sdb1"];
3382 ["swapon_label"; "swapit"];
3383 ["swapoff_label"; "swapit"];
3384 ["zero"; "/dev/sdb"];
3385 ["blockdev_rereadpt"; "/dev/sdb"]])],
3386 "enable swap on labeled swap partition",
3388 This command enables swap to a labeled swap partition.
3389 See C<guestfs_swapon_device> for other notes.");
3391 ("swapoff_label", (RErr, [String "label"]), 175, [],
3392 [], (* XXX tested by swapon_label *)
3393 "disable swap on labeled swap partition",
3395 This command disables the libguestfs appliance swap on
3396 labeled swap partition.");
3398 ("swapon_uuid", (RErr, [String "uuid"]), 176, [],
3399 (let uuid = uuidgen () in
3400 [InitEmpty, Always, TestRun (
3401 [["mkswap_U"; uuid; "/dev/sdb"];
3402 ["swapon_uuid"; uuid];
3403 ["swapoff_uuid"; uuid]])]),
3404 "enable swap on swap partition by UUID",
3406 This command enables swap to a swap partition with the given UUID.
3407 See C<guestfs_swapon_device> for other notes.");
3409 ("swapoff_uuid", (RErr, [String "uuid"]), 177, [],
3410 [], (* XXX tested by swapon_uuid *)
3411 "disable swap on swap partition by UUID",
3413 This command disables the libguestfs appliance swap partition
3414 with the given UUID.");
3416 ("mkswap_file", (RErr, [Pathname "path"]), 178, [],
3417 [InitBasicFS, Always, TestRun (
3418 [["fallocate"; "/swap"; "8388608"];
3419 ["mkswap_file"; "/swap"]])],
3420 "create a swap file",
3424 This command just writes a swap file signature to an existing
3425 file. To create the file itself, use something like C<guestfs_fallocate>.");
3427 ("inotify_init", (RErr, [Int "maxevents"]), 179, [],
3428 [InitISOFS, Always, TestRun (
3429 [["inotify_init"; "0"]])],
3430 "create an inotify handle",
3432 This command creates a new inotify handle.
3433 The inotify subsystem can be used to notify events which happen to
3434 objects in the guest filesystem.
3436 C<maxevents> is the maximum number of events which will be
3437 queued up between calls to C<guestfs_inotify_read> or
3438 C<guestfs_inotify_files>.
3439 If this is passed as C<0>, then the kernel (or previously set)
3440 default is used. For Linux 2.6.29 the default was 16384 events.
3441 Beyond this limit, the kernel throws away events, but records
3442 the fact that it threw them away by setting a flag
3443 C<IN_Q_OVERFLOW> in the returned structure list (see
3444 C<guestfs_inotify_read>).
3446 Before any events are generated, you have to add some
3447 watches to the internal watch list. See:
3448 C<guestfs_inotify_add_watch>,
3449 C<guestfs_inotify_rm_watch> and
3450 C<guestfs_inotify_watch_all>.
3452 Queued up events should be read periodically by calling
3453 C<guestfs_inotify_read>
3454 (or C<guestfs_inotify_files> which is just a helpful
3455 wrapper around C<guestfs_inotify_read>). If you don't
3456 read the events out often enough then you risk the internal
3459 The handle should be closed after use by calling
3460 C<guestfs_inotify_close>. This also removes any
3461 watches automatically.
3463 See also L<inotify(7)> for an overview of the inotify interface
3464 as exposed by the Linux kernel, which is roughly what we expose
3465 via libguestfs. Note that there is one global inotify handle
3466 per libguestfs instance.");
3468 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"]), 180, [],
3469 [InitBasicFS, Always, TestOutputList (
3470 [["inotify_init"; "0"];
3471 ["inotify_add_watch"; "/"; "1073741823"];
3474 ["inotify_files"]], ["a"; "b"])],
3475 "add an inotify watch",
3477 Watch C<path> for the events listed in C<mask>.
3479 Note that if C<path> is a directory then events within that
3480 directory are watched, but this does I<not> happen recursively
3481 (in subdirectories).
3483 Note for non-C or non-Linux callers: the inotify events are
3484 defined by the Linux kernel ABI and are listed in
3485 C</usr/include/sys/inotify.h>.");
3487 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"]), 181, [],
3489 "remove an inotify watch",
3491 Remove a previously defined inotify watch.
3492 See C<guestfs_inotify_add_watch>.");
3494 ("inotify_read", (RStructList ("events", "inotify_event"), []), 182, [],
3496 "return list of inotify events",
3498 Return the complete queue of events that have happened
3499 since the previous read call.
3501 If no events have happened, this returns an empty list.
3503 I<Note>: In order to make sure that all events have been
3504 read, you must call this function repeatedly until it
3505 returns an empty list. The reason is that the call will
3506 read events up to the maximum appliance-to-host message
3507 size and leave remaining events in the queue.");
3509 ("inotify_files", (RStringList "paths", []), 183, [],
3511 "return list of watched files that had events",
3513 This function is a helpful wrapper around C<guestfs_inotify_read>
3514 which just returns a list of pathnames of objects that were
3515 touched. The returned pathnames are sorted and deduplicated.");
3517 ("inotify_close", (RErr, []), 184, [],
3519 "close the inotify handle",
3521 This closes the inotify handle which was previously
3522 opened by inotify_init. It removes all watches, throws
3523 away any pending events, and deallocates all resources.");
3525 ("setcon", (RErr, [String "context"]), 185, [],
3527 "set SELinux security context",
3529 This sets the SELinux security context of the daemon
3530 to the string C<context>.
3532 See the documentation about SELINUX in L<guestfs(3)>.");
3534 ("getcon", (RString "context", []), 186, [],
3536 "get SELinux security context",
3538 This gets the SELinux security context of the daemon.
3540 See the documentation about SELINUX in L<guestfs(3)>,
3541 and C<guestfs_setcon>");
3543 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"]), 187, [],
3544 [InitEmpty, Always, TestOutput (
3545 [["part_disk"; "/dev/sda"; "mbr"];
3546 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
3547 ["mount"; "/dev/sda1"; "/"];
3548 ["write_file"; "/new"; "new file contents"; "0"];
3549 ["cat"; "/new"]], "new file contents")],
3550 "make a filesystem with block size",
3552 This call is similar to C<guestfs_mkfs>, but it allows you to
3553 control the block size of the resulting filesystem. Supported
3554 block sizes depend on the filesystem type, but typically they
3555 are C<1024>, C<2048> or C<4096> only.");
3557 ("mke2journal", (RErr, [Int "blocksize"; Device "device"]), 188, [],
3558 [InitEmpty, Always, TestOutput (
3559 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3560 ["mke2journal"; "4096"; "/dev/sda1"];
3561 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
3562 ["mount"; "/dev/sda2"; "/"];
3563 ["write_file"; "/new"; "new file contents"; "0"];
3564 ["cat"; "/new"]], "new file contents")],
3565 "make ext2/3/4 external journal",
3567 This creates an ext2 external journal on C<device>. It is equivalent
3570 mke2fs -O journal_dev -b blocksize device");
3572 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"]), 189, [],
3573 [InitEmpty, Always, TestOutput (
3574 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3575 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
3576 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
3577 ["mount"; "/dev/sda2"; "/"];
3578 ["write_file"; "/new"; "new file contents"; "0"];
3579 ["cat"; "/new"]], "new file contents")],
3580 "make ext2/3/4 external journal with label",
3582 This creates an ext2 external journal on C<device> with label C<label>.");
3584 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"]), 190, [],
3585 (let uuid = uuidgen () in
3586 [InitEmpty, Always, TestOutput (
3587 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3588 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
3589 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
3590 ["mount"; "/dev/sda2"; "/"];
3591 ["write_file"; "/new"; "new file contents"; "0"];
3592 ["cat"; "/new"]], "new file contents")]),
3593 "make ext2/3/4 external journal with UUID",
3595 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
3597 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"]), 191, [],
3599 "make ext2/3/4 filesystem with external journal",
3601 This creates an ext2/3/4 filesystem on C<device> with
3602 an external journal on C<journal>. It is equivalent
3605 mke2fs -t fstype -b blocksize -J device=<journal> <device>
3607 See also C<guestfs_mke2journal>.");
3609 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"]), 192, [],
3611 "make ext2/3/4 filesystem with external journal",
3613 This creates an ext2/3/4 filesystem on C<device> with
3614 an external journal on the journal labeled C<label>.
3616 See also C<guestfs_mke2journal_L>.");
3618 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"]), 193, [],
3620 "make ext2/3/4 filesystem with external journal",
3622 This creates an ext2/3/4 filesystem on C<device> with
3623 an external journal on the journal with UUID C<uuid>.
3625 See also C<guestfs_mke2journal_U>.");
3627 ("modprobe", (RErr, [String "modulename"]), 194, [],
3628 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
3629 "load a kernel module",
3631 This loads a kernel module in the appliance.
3633 The kernel module must have been whitelisted when libguestfs
3634 was built (see C<appliance/kmod.whitelist.in> in the source).");
3636 ("echo_daemon", (RString "output", [StringList "words"]), 195, [],
3637 [InitNone, Always, TestOutput (
3638 [["echo_daemon"; "This is a test"]], "This is a test"
3640 "echo arguments back to the client",
3642 This command concatenate the list of C<words> passed with single spaces between
3643 them and returns the resulting string.
3645 You can use this command to test the connection through to the daemon.
3647 See also C<guestfs_ping_daemon>.");
3649 ("find0", (RErr, [Pathname "directory"; FileOut "files"]), 196, [],
3650 [], (* There is a regression test for this. *)
3651 "find all files and directories, returning NUL-separated list",
3653 This command lists out all files and directories, recursively,
3654 starting at C<directory>, placing the resulting list in the
3655 external file called C<files>.
3657 This command works the same way as C<guestfs_find> with the
3658 following exceptions:
3664 The resulting list is written to an external file.
3668 Items (filenames) in the result are separated
3669 by C<\\0> characters. See L<find(1)> option I<-print0>.
3673 This command is not limited in the number of names that it
3678 The result list is not sorted.
3682 ("case_sensitive_path", (RString "rpath", [Pathname "path"]), 197, [],
3683 [InitISOFS, Always, TestOutput (
3684 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
3685 InitISOFS, Always, TestOutput (
3686 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
3687 InitISOFS, Always, TestOutput (
3688 [["case_sensitive_path"; "/Known-1"]], "/known-1");
3689 InitISOFS, Always, TestLastFail (
3690 [["case_sensitive_path"; "/Known-1/"]]);
3691 InitBasicFS, Always, TestOutput (
3693 ["mkdir"; "/a/bbb"];
3694 ["touch"; "/a/bbb/c"];
3695 ["case_sensitive_path"; "/A/bbB/C"]], "/a/bbb/c");
3696 InitBasicFS, Always, TestOutput (
3698 ["mkdir"; "/a/bbb"];
3699 ["touch"; "/a/bbb/c"];
3700 ["case_sensitive_path"; "/A////bbB/C"]], "/a/bbb/c");
3701 InitBasicFS, Always, TestLastFail (
3703 ["mkdir"; "/a/bbb"];
3704 ["touch"; "/a/bbb/c"];
3705 ["case_sensitive_path"; "/A/bbb/../bbb/C"]])],
3706 "return true path on case-insensitive filesystem",
3708 This can be used to resolve case insensitive paths on
3709 a filesystem which is case sensitive. The use case is
3710 to resolve paths which you have read from Windows configuration
3711 files or the Windows Registry, to the true path.
3713 The command handles a peculiarity of the Linux ntfs-3g
3714 filesystem driver (and probably others), which is that although
3715 the underlying filesystem is case-insensitive, the driver
3716 exports the filesystem to Linux as case-sensitive.
3718 One consequence of this is that special directories such
3719 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
3720 (or other things) depending on the precise details of how
3721 they were created. In Windows itself this would not be
3724 Bug or feature? You decide:
3725 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
3727 This function resolves the true case of each element in the
3728 path and returns the case-sensitive path.
3730 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
3731 might return C<\"/WINDOWS/system32\"> (the exact return value
3732 would depend on details of how the directories were originally
3733 created under Windows).
3736 This function does not handle drive names, backslashes etc.
3738 See also C<guestfs_realpath>.");
3740 ("vfs_type", (RString "fstype", [Device "device"]), 198, [],
3741 [InitBasicFS, Always, TestOutput (
3742 [["vfs_type"; "/dev/sda1"]], "ext2")],
3743 "get the Linux VFS type corresponding to a mounted device",
3745 This command gets the block device type corresponding to
3746 a mounted device called C<device>.
3748 Usually the result is the name of the Linux VFS module that
3749 is used to mount this device (probably determined automatically
3750 if you used the C<guestfs_mount> call).");
3752 ("truncate", (RErr, [Pathname "path"]), 199, [],
3753 [InitBasicFS, Always, TestOutputStruct (
3754 [["write_file"; "/test"; "some stuff so size is not zero"; "0"];
3755 ["truncate"; "/test"];
3756 ["stat"; "/test"]], [CompareWithInt ("size", 0)])],
3757 "truncate a file to zero size",
3759 This command truncates C<path> to a zero-length file. The
3760 file must exist already.");
3762 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"]), 200, [],
3763 [InitBasicFS, Always, TestOutputStruct (
3764 [["touch"; "/test"];
3765 ["truncate_size"; "/test"; "1000"];
3766 ["stat"; "/test"]], [CompareWithInt ("size", 1000)])],
3767 "truncate a file to a particular size",
3769 This command truncates C<path> to size C<size> bytes. The file
3770 must exist already. If the file is smaller than C<size> then
3771 the file is extended to the required size with null bytes.");
3773 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"]), 201, [],
3774 [InitBasicFS, Always, TestOutputStruct (
3775 [["touch"; "/test"];
3776 ["utimens"; "/test"; "12345"; "67890"; "9876"; "5432"];
3777 ["stat"; "/test"]], [CompareWithInt ("mtime", 9876)])],
3778 "set timestamp of a file with nanosecond precision",
3780 This command sets the timestamps of a file with nanosecond
3783 C<atsecs, atnsecs> are the last access time (atime) in secs and
3784 nanoseconds from the epoch.
3786 C<mtsecs, mtnsecs> are the last modification time (mtime) in
3787 secs and nanoseconds from the epoch.
3789 If the C<*nsecs> field contains the special value C<-1> then
3790 the corresponding timestamp is set to the current time. (The
3791 C<*secs> field is ignored in this case).
3793 If the C<*nsecs> field contains the special value C<-2> then
3794 the corresponding timestamp is left unchanged. (The
3795 C<*secs> field is ignored in this case).");
3797 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"]), 202, [],
3798 [InitBasicFS, Always, TestOutputStruct (
3799 [["mkdir_mode"; "/test"; "0o111"];
3800 ["stat"; "/test"]], [CompareWithInt ("mode", 0o40111)])],
3801 "create a directory with a particular mode",
3803 This command creates a directory, setting the initial permissions
3804 of the directory to C<mode>. See also C<guestfs_mkdir>.");
3806 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"]), 203, [],
3808 "change file owner and group",
3810 Change the file owner to C<owner> and group to C<group>.
3811 This is like C<guestfs_chown> but if C<path> is a symlink then
3812 the link itself is changed, not the target.
3814 Only numeric uid and gid are supported. If you want to use
3815 names, you will need to locate and parse the password file
3816 yourself (Augeas support makes this relatively easy).");
3818 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"]), 204, [],
3820 "lstat on multiple files",
3822 This call allows you to perform the C<guestfs_lstat> operation
3823 on multiple files, where all files are in the directory C<path>.
3824 C<names> is the list of files from this directory.
3826 On return you get a list of stat structs, with a one-to-one
3827 correspondence to the C<names> list. If any name did not exist
3828 or could not be lstat'd, then the C<ino> field of that structure
3831 This call is intended for programs that want to efficiently
3832 list a directory contents without making many round-trips.
3833 See also C<guestfs_lxattrlist> for a similarly efficient call
3834 for getting extended attributes. Very long directory listings
3835 might cause the protocol message size to be exceeded, causing
3836 this call to fail. The caller must split up such requests
3837 into smaller groups of names.");
3839 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"]), 205, [],
3841 "lgetxattr on multiple files",
3843 This call allows you to get the extended attributes
3844 of multiple files, where all files are in the directory C<path>.
3845 C<names> is the list of files from this directory.
3847 On return you get a flat list of xattr structs which must be
3848 interpreted sequentially. The first xattr struct always has a zero-length
3849 C<attrname>. C<attrval> in this struct is zero-length
3850 to indicate there was an error doing C<lgetxattr> for this
3851 file, I<or> is a C string which is a decimal number
3852 (the number of following attributes for this file, which could
3853 be C<\"0\">). Then after the first xattr struct are the
3854 zero or more attributes for the first named file.
3855 This repeats for the second and subsequent files.
3857 This call is intended for programs that want to efficiently
3858 list a directory contents without making many round-trips.
3859 See also C<guestfs_lstatlist> for a similarly efficient call
3860 for getting standard stats. Very long directory listings
3861 might cause the protocol message size to be exceeded, causing
3862 this call to fail. The caller must split up such requests
3863 into smaller groups of names.");
3865 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"]), 206, [],
3867 "readlink on multiple files",
3869 This call allows you to do a C<readlink> operation
3870 on multiple files, where all files are in the directory C<path>.
3871 C<names> is the list of files from this directory.
3873 On return you get a list of strings, with a one-to-one
3874 correspondence to the C<names> list. Each string is the
3875 value of the symbol link.
3877 If the C<readlink(2)> operation fails on any name, then
3878 the corresponding result string is the empty string C<\"\">.
3879 However the whole operation is completed even if there
3880 were C<readlink(2)> errors, and so you can call this
3881 function with names where you don't know if they are
3882 symbolic links already (albeit slightly less efficient).
3884 This call is intended for programs that want to efficiently
3885 list a directory contents without making many round-trips.
3886 Very long directory listings might cause the protocol
3887 message size to be exceeded, causing
3888 this call to fail. The caller must split up such requests
3889 into smaller groups of names.");
3891 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"]), 207, [ProtocolLimitWarning],
3892 [InitISOFS, Always, TestOutputBuffer (
3893 [["pread"; "/known-4"; "1"; "3"]], "\n")],
3894 "read part of a file",
3896 This command lets you read part of a file. It reads C<count>
3897 bytes of the file, starting at C<offset>, from file C<path>.
3899 This may read fewer bytes than requested. For further details
3900 see the L<pread(2)> system call.");
3902 ("part_init", (RErr, [Device "device"; String "parttype"]), 208, [],
3903 [InitEmpty, Always, TestRun (
3904 [["part_init"; "/dev/sda"; "gpt"]])],
3905 "create an empty partition table",
3907 This creates an empty partition table on C<device> of one of the
3908 partition types listed below. Usually C<parttype> should be
3909 either C<msdos> or C<gpt> (for large disks).
3911 Initially there are no partitions. Following this, you should
3912 call C<guestfs_part_add> for each partition required.
3914 Possible values for C<parttype> are:
3918 =item B<efi> | B<gpt>
3920 Intel EFI / GPT partition table.
3922 This is recommended for >= 2 TB partitions that will be accessed
3923 from Linux and Intel-based Mac OS X. It also has limited backwards
3924 compatibility with the C<mbr> format.
3926 =item B<mbr> | B<msdos>
3928 The standard PC \"Master Boot Record\" (MBR) format used
3929 by MS-DOS and Windows. This partition type will B<only> work
3930 for device sizes up to 2 TB. For large disks we recommend
3935 Other partition table types that may work but are not
3944 =item B<amiga> | B<rdb>
3946 Amiga \"Rigid Disk Block\" format.
3954 DASD, used on IBM mainframes.
3962 Old Mac partition format. Modern Macs use C<gpt>.
3966 NEC PC-98 format, common in Japan apparently.
3974 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"]), 209, [],
3975 [InitEmpty, Always, TestRun (
3976 [["part_init"; "/dev/sda"; "mbr"];
3977 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
3978 InitEmpty, Always, TestRun (
3979 [["part_init"; "/dev/sda"; "gpt"];
3980 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
3981 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
3982 InitEmpty, Always, TestRun (
3983 [["part_init"; "/dev/sda"; "mbr"];
3984 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
3985 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
3986 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
3987 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
3988 "add a partition to the device",
3990 This command adds a partition to C<device>. If there is no partition
3991 table on the device, call C<guestfs_part_init> first.
3993 The C<prlogex> parameter is the type of partition. Normally you
3994 should pass C<p> or C<primary> here, but MBR partition tables also
3995 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
3998 C<startsect> and C<endsect> are the start and end of the partition
3999 in I<sectors>. C<endsect> may be negative, which means it counts
4000 backwards from the end of the disk (C<-1> is the last sector).
4002 Creating a partition which covers the whole disk is not so easy.
4003 Use C<guestfs_part_disk> to do that.");
4005 ("part_disk", (RErr, [Device "device"; String "parttype"]), 210, [DangerWillRobinson],
4006 [InitEmpty, Always, TestRun (
4007 [["part_disk"; "/dev/sda"; "mbr"]]);
4008 InitEmpty, Always, TestRun (
4009 [["part_disk"; "/dev/sda"; "gpt"]])],
4010 "partition whole disk with a single primary partition",
4012 This command is simply a combination of C<guestfs_part_init>
4013 followed by C<guestfs_part_add> to create a single primary partition
4014 covering the whole disk.
4016 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
4017 but other possible values are described in C<guestfs_part_init>.");
4019 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"]), 211, [],
4020 [InitEmpty, Always, TestRun (
4021 [["part_disk"; "/dev/sda"; "mbr"];
4022 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
4023 "make a partition bootable",
4025 This sets the bootable flag on partition numbered C<partnum> on
4026 device C<device>. Note that partitions are numbered from 1.
4028 The bootable flag is used by some PC BIOSes to determine which
4029 partition to boot from. It is by no means universally recognized,
4030 and in any case if your operating system installed a boot
4031 sector on the device itself, then that takes precedence.");
4033 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"]), 212, [],
4034 [InitEmpty, Always, TestRun (
4035 [["part_disk"; "/dev/sda"; "gpt"];
4036 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
4037 "set partition name",
4039 This sets the partition name on partition numbered C<partnum> on
4040 device C<device>. Note that partitions are numbered from 1.
4042 The partition name can only be set on certain types of partition
4043 table. This works on C<gpt> but not on C<mbr> partitions.");
4045 ("part_list", (RStructList ("partitions", "partition"), [Device "device"]), 213, [],
4046 [], (* XXX Add a regression test for this. *)
4047 "list partitions on a device",
4049 This command parses the partition table on C<device> and
4050 returns the list of partitions found.
4052 The fields in the returned structure are:
4058 Partition number, counting from 1.
4062 Start of the partition I<in bytes>. To get sectors you have to
4063 divide by the device's sector size, see C<guestfs_blockdev_getss>.
4067 End of the partition in bytes.
4071 Size of the partition in bytes.
4075 ("part_get_parttype", (RString "parttype", [Device "device"]), 214, [],
4076 [InitEmpty, Always, TestOutput (
4077 [["part_disk"; "/dev/sda"; "gpt"];
4078 ["part_get_parttype"; "/dev/sda"]], "gpt")],
4079 "get the partition table type",
4081 This command examines the partition table on C<device> and
4082 returns the partition table type (format) being used.
4084 Common return values include: C<msdos> (a DOS/Windows style MBR
4085 partition table), C<gpt> (a GPT/EFI-style partition table). Other
4086 values are possible, although unusual. See C<guestfs_part_init>
4089 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"]), 215, [],
4090 [InitBasicFS, Always, TestOutputBuffer (
4091 [["fill"; "0x63"; "10"; "/test"];
4092 ["read_file"; "/test"]], "cccccccccc")],
4093 "fill a file with octets",
4095 This command creates a new file called C<path>. The initial
4096 content of the file is C<len> octets of C<c>, where C<c>
4097 must be a number in the range C<[0..255]>.
4099 To fill a file with zero bytes (sparsely), it is
4100 much more efficient to use C<guestfs_truncate_size>.");
4104 let all_functions = non_daemon_functions @ daemon_functions
4106 (* In some places we want the functions to be displayed sorted
4107 * alphabetically, so this is useful:
4109 let all_functions_sorted =
4110 List.sort (fun (n1,_,_,_,_,_,_) (n2,_,_,_,_,_,_) ->
4111 compare n1 n2) all_functions
4113 (* Field types for structures. *)
4115 | FChar (* C 'char' (really, a 7 bit byte). *)
4116 | FString (* nul-terminated ASCII string, NOT NULL. *)
4117 | FBuffer (* opaque buffer of bytes, (char *, int) pair *)
4122 | FBytes (* Any int measure that counts bytes. *)
4123 | FUUID (* 32 bytes long, NOT nul-terminated. *)
4124 | FOptPercent (* [0..100], or -1 meaning "not present". *)
4126 (* Because we generate extra parsing code for LVM command line tools,
4127 * we have to pull out the LVM columns separately here.
4137 "pv_attr", FString (* XXX *);
4138 "pv_pe_count", FInt64;
4139 "pv_pe_alloc_count", FInt64;
4142 "pv_mda_count", FInt64;
4143 "pv_mda_free", FBytes;
4144 (* Not in Fedora 10:
4145 "pv_mda_size", FBytes;
4152 "vg_attr", FString (* XXX *);
4155 "vg_sysid", FString;
4156 "vg_extent_size", FBytes;
4157 "vg_extent_count", FInt64;
4158 "vg_free_count", FInt64;
4163 "snap_count", FInt64;
4166 "vg_mda_count", FInt64;
4167 "vg_mda_free", FBytes;
4168 (* Not in Fedora 10:
4169 "vg_mda_size", FBytes;
4175 "lv_attr", FString (* XXX *);
4178 "lv_kernel_major", FInt64;
4179 "lv_kernel_minor", FInt64;
4181 "seg_count", FInt64;
4183 "snap_percent", FOptPercent;
4184 "copy_percent", FOptPercent;
4187 "mirror_log", FString;
4191 (* Names and fields in all structures (in RStruct and RStructList)
4195 (* The old RIntBool return type, only ever used for aug_defnode. Do
4196 * not use this struct in any new code.
4199 "i", FInt32; (* for historical compatibility *)
4200 "b", FInt32; (* for historical compatibility *)
4203 (* LVM PVs, VGs, LVs. *)
4204 "lvm_pv", lvm_pv_cols;
4205 "lvm_vg", lvm_vg_cols;
4206 "lvm_lv", lvm_lv_cols;
4208 (* Column names and types from stat structures.
4209 * NB. Can't use things like 'st_atime' because glibc header files
4210 * define some of these as macros. Ugh.
4241 (* Column names in dirent structure. *)
4244 (* 'b' 'c' 'd' 'f' (FIFO) 'l' 'r' (regular file) 's' 'u' '?' *)
4249 (* Version numbers. *)
4257 (* Extended attribute. *)
4259 "attrname", FString;
4263 (* Inotify events. *)
4267 "in_cookie", FUInt32;
4271 (* Partition table entry. *)
4274 "part_start", FBytes;
4276 "part_size", FBytes;
4278 ] (* end of structs *)
4280 (* Ugh, Java has to be different ..
4281 * These names are also used by the Haskell bindings.
4283 let java_structs = [
4284 "int_bool", "IntBool";
4289 "statvfs", "StatVFS";
4291 "version", "Version";
4293 "inotify_event", "INotifyEvent";
4294 "partition", "Partition";
4297 (* What structs are actually returned. *)
4298 type rstructs_used_t = RStructOnly | RStructListOnly | RStructAndList
4300 (* Returns a list of RStruct/RStructList structs that are returned
4301 * by any function. Each element of returned list is a pair:
4303 * (structname, RStructOnly)
4304 * == there exists function which returns RStruct (_, structname)
4305 * (structname, RStructListOnly)
4306 * == there exists function which returns RStructList (_, structname)
4307 * (structname, RStructAndList)
4308 * == there are functions returning both RStruct (_, structname)
4309 * and RStructList (_, structname)
4311 let rstructs_used_by functions =
4312 (* ||| is a "logical OR" for rstructs_used_t *)
4316 | _, RStructAndList -> RStructAndList
4317 | RStructOnly, RStructListOnly
4318 | RStructListOnly, RStructOnly -> RStructAndList
4319 | RStructOnly, RStructOnly -> RStructOnly
4320 | RStructListOnly, RStructListOnly -> RStructListOnly
4323 let h = Hashtbl.create 13 in
4325 (* if elem->oldv exists, update entry using ||| operator,
4326 * else just add elem->newv to the hash
4328 let update elem newv =
4329 try let oldv = Hashtbl.find h elem in
4330 Hashtbl.replace h elem (newv ||| oldv)
4331 with Not_found -> Hashtbl.add h elem newv
4335 fun (_, style, _, _, _, _, _) ->
4336 match fst style with
4337 | RStruct (_, structname) -> update structname RStructOnly
4338 | RStructList (_, structname) -> update structname RStructListOnly
4342 (* return key->values as a list of (key,value) *)
4343 Hashtbl.fold (fun key value xs -> (key, value) :: xs) h []
4345 (* Used for testing language bindings. *)
4347 | CallString of string
4348 | CallOptString of string option
4349 | CallStringList of string list
4351 | CallInt64 of int64
4354 (* Used to memoize the result of pod2text. *)
4355 let pod2text_memo_filename = "src/.pod2text.data"
4356 let pod2text_memo : ((int * string * string), string list) Hashtbl.t =
4358 let chan = open_in pod2text_memo_filename in
4359 let v = input_value chan in
4363 _ -> Hashtbl.create 13
4364 let pod2text_memo_updated () =
4365 let chan = open_out pod2text_memo_filename in
4366 output_value chan pod2text_memo;
4369 (* Useful functions.
4370 * Note we don't want to use any external OCaml libraries which
4371 * makes this a bit harder than it should be.
4373 let failwithf fs = ksprintf failwith fs
4375 let replace_char s c1 c2 =
4376 let s2 = String.copy s in
4377 let r = ref false in
4378 for i = 0 to String.length s2 - 1 do
4379 if String.unsafe_get s2 i = c1 then (
4380 String.unsafe_set s2 i c2;
4384 if not !r then s else s2
4388 (* || c = '\f' *) || c = '\n' || c = '\r' || c = '\t' (* || c = '\v' *)
4390 let triml ?(test = isspace) str =
4392 let n = ref (String.length str) in
4393 while !n > 0 && test str.[!i]; do
4398 else String.sub str !i !n
4400 let trimr ?(test = isspace) str =
4401 let n = ref (String.length str) in
4402 while !n > 0 && test str.[!n-1]; do
4405 if !n = String.length str then str
4406 else String.sub str 0 !n
4408 let trim ?(test = isspace) str =
4409 trimr ~test (triml ~test str)
4411 let rec find s sub =
4412 let len = String.length s in
4413 let sublen = String.length sub in
4415 if i <= len-sublen then (
4417 if j < sublen then (
4418 if s.[i+j] = sub.[j] then loop2 (j+1)
4424 if r = -1 then loop (i+1) else r
4430 let rec replace_str s s1 s2 =
4431 let len = String.length s in
4432 let sublen = String.length s1 in
4433 let i = find s s1 in
4436 let s' = String.sub s 0 i in
4437 let s'' = String.sub s (i+sublen) (len-i-sublen) in
4438 s' ^ s2 ^ replace_str s'' s1 s2
4441 let rec string_split sep str =
4442 let len = String.length str in
4443 let seplen = String.length sep in
4444 let i = find str sep in
4445 if i = -1 then [str]
4447 let s' = String.sub str 0 i in
4448 let s'' = String.sub str (i+seplen) (len-i-seplen) in
4449 s' :: string_split sep s''
4452 let files_equal n1 n2 =
4453 let cmd = sprintf "cmp -s %s %s" (Filename.quote n1) (Filename.quote n2) in
4454 match Sys.command cmd with