3 * Copyright (C) 2009-2010 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 of
25 * 'daemon_functions' below), and daemon/<somefile>.c to write the
28 * After editing this file, run it (./src/generator.ml) to regenerate
29 * all the output files. 'make' will rerun this automatically when
30 * necessary. Note that if you are using a separate build directory
31 * you must run generator.ml from the _source_ directory.
33 * IMPORTANT: This script should NOT print any warnings. If it prints
34 * warnings, you should treat them as errors.
37 * (1) In emacs, install tuareg-mode to display and format OCaml code
38 * correctly. 'vim' comes with a good OCaml editing mode by default.
39 * (2) Read the resources at http://ocaml-tutorial.org/
44 #directory "+xml-light";;
45 #directory "+../pkg-lib/xml-light";; (* for GODI users *)
46 #load "xml-light.cma";;
51 type style = ret * args
53 (* "RErr" as a return value means an int used as a simple error
54 * indication, ie. 0 or -1.
58 (* "RInt" as a return value means an int which is -1 for error
59 * or any value >= 0 on success. Only use this for smallish
60 * positive ints (0 <= i < 2^30).
64 (* "RInt64" is the same as RInt, but is guaranteed to be able
65 * to return a full 64 bit value, _except_ that -1 means error
66 * (so -1 cannot be a valid, non-error return value).
70 (* "RBool" is a bool return value which can be true/false or
75 (* "RConstString" is a string that refers to a constant value.
76 * The return value must NOT be NULL (since NULL indicates
79 * Try to avoid using this. In particular you cannot use this
80 * for values returned from the daemon, because there is no
81 * thread-safe way to return them in the C API.
83 | RConstString of string
85 (* "RConstOptString" is an even more broken version of
86 * "RConstString". The returned string may be NULL and there
87 * is no way to return an error indication. Avoid using this!
89 | RConstOptString of string
91 (* "RString" is a returned string. It must NOT be NULL, since
92 * a NULL return indicates an error. The caller frees this.
96 (* "RStringList" is a list of strings. No string in the list
97 * can be NULL. The caller frees the strings and the array.
99 | RStringList of string
101 (* "RStruct" is a function which returns a single named structure
102 * or an error indication (in C, a struct, and in other languages
103 * with varying representations, but usually very efficient). See
104 * after the function list below for the structures.
106 | RStruct of string * string (* name of retval, name of struct *)
108 (* "RStructList" is a function which returns either a list/array
109 * of structures (could be zero-length), or an error indication.
111 | RStructList of string * string (* name of retval, name of struct *)
113 (* Key-value pairs of untyped strings. Turns into a hashtable or
114 * dictionary in languages which support it. DON'T use this as a
115 * general "bucket" for results. Prefer a stronger typed return
116 * value if one is available, or write a custom struct. Don't use
117 * this if the list could potentially be very long, since it is
118 * inefficient. Keys should be unique. NULLs are not permitted.
120 | RHashtable of string
122 (* "RBufferOut" is handled almost exactly like RString, but
123 * it allows the string to contain arbitrary 8 bit data including
124 * ASCII NUL. In the C API this causes an implicit extra parameter
125 * to be added of type <size_t *size_r>. The extra parameter
126 * returns the actual size of the return buffer in bytes.
128 * Other programming languages support strings with arbitrary 8 bit
131 * At the RPC layer we have to use the opaque<> type instead of
132 * string<>. Returned data is still limited to the max message
135 | RBufferOut of string
137 and args = argt list (* Function parameters, guestfs handle is implicit. *)
139 (* Note in future we should allow a "variable args" parameter as
140 * the final parameter, to allow commands like
141 * chmod mode file [file(s)...]
142 * This is not implemented yet, but many commands (such as chmod)
143 * are currently defined with the argument order keeping this future
144 * possibility in mind.
147 | String of string (* const char *name, cannot be NULL *)
148 | Device of string (* /dev device name, cannot be NULL *)
149 | Pathname of string (* file name, cannot be NULL *)
150 | Dev_or_Path of string (* /dev device name or Pathname, cannot be NULL *)
151 | OptString of string (* const char *name, may be NULL *)
152 | StringList of string(* list of strings (each string cannot be NULL) *)
153 | DeviceList of string(* list of Device names (each cannot be NULL) *)
154 | Bool of string (* boolean *)
155 | Int of string (* int (smallish ints, signed, <= 31 bits) *)
156 | Int64 of string (* any 64 bit int *)
157 (* These are treated as filenames (simple string parameters) in
158 * the C API and bindings. But in the RPC protocol, we transfer
159 * the actual file content up to or down from the daemon.
160 * FileIn: local machine -> daemon (in request)
161 * FileOut: daemon -> local machine (in reply)
162 * In guestfish (only), the special name "-" means read from
163 * stdin or write to stdout.
167 (* Opaque buffer which can contain arbitrary 8 bit data.
168 * In the C API, this is expressed as <const char *, size_t> pair.
169 * Most other languages have a string type which can contain
170 * ASCII NUL. We use whatever type is appropriate for each
172 * Buffers are limited by the total message size. To transfer
173 * large blocks of data, use FileIn/FileOut parameters instead.
174 * To return an arbitrary buffer, use RBufferOut.
177 (* Key material / passphrase. Eventually we should treat this
178 * as sensitive and mlock it into physical RAM. However this
179 * is highly complex because of all the places that XDR-encoded
180 * strings can end up. So currently the only difference from
181 * 'String' is the way that guestfish requests these parameters
187 | ProtocolLimitWarning (* display warning about protocol size limits *)
188 | DangerWillRobinson (* flags particularly dangerous commands *)
189 | FishAlias of string (* provide an alias for this cmd in guestfish *)
190 | FishOutput of fish_output_t (* how to display output in guestfish *)
191 | NotInFish (* do not export via guestfish *)
192 | NotInDocs (* do not add this function to documentation *)
193 | DeprecatedBy of string (* function is deprecated, use .. instead *)
194 | Optional of string (* function is part of an optional group *)
197 | FishOutputOctal (* for int return, print in octal *)
198 | FishOutputHexadecimal (* for int return, print in hex *)
200 (* You can supply zero or as many tests as you want per API call.
202 * Note that the test environment has 3 block devices, of size 500MB,
203 * 50MB and 10MB (respectively /dev/sda, /dev/sdb, /dev/sdc), and
204 * a fourth ISO block device with some known files on it (/dev/sdd).
206 * Note for partitioning purposes, the 500MB device has 1015 cylinders.
207 * Number of cylinders was 63 for IDE emulated disks with precisely
208 * the same size. How exactly this is calculated is a mystery.
210 * The ISO block device (/dev/sdd) comes from images/test.iso.
212 * To be able to run the tests in a reasonable amount of time,
213 * the virtual machine and block devices are reused between tests.
214 * So don't try testing kill_subprocess :-x
216 * Between each test we blockdev-setrw, umount-all, lvm-remove-all.
218 * Don't assume anything about the previous contents of the block
219 * devices. Use 'Init*' to create some initial scenarios.
221 * You can add a prerequisite clause to any individual test. This
222 * is a run-time check, which, if it fails, causes the test to be
223 * skipped. Useful if testing a command which might not work on
224 * all variations of libguestfs builds. A test that has prerequisite
225 * of 'Always' is run unconditionally.
227 * In addition, packagers can skip individual tests by setting the
228 * environment variables: eg:
229 * SKIP_TEST_<CMD>_<NUM>=1 SKIP_TEST_COMMAND_3=1 (skips test #3 of command)
230 * SKIP_TEST_<CMD>=1 SKIP_TEST_ZEROFREE=1 (skips all zerofree tests)
232 type tests = (test_init * test_prereq * test) list
234 (* Run the command sequence and just expect nothing to fail. *)
237 (* Run the command sequence and expect the output of the final
238 * command to be the string.
240 | TestOutput of seq * string
242 (* Run the command sequence and expect the output of the final
243 * command to be the list of strings.
245 | TestOutputList of seq * string list
247 (* Run the command sequence and expect the output of the final
248 * command to be the list of block devices (could be either
249 * "/dev/sd.." or "/dev/hd.." form - we don't check the 5th
250 * character of each string).
252 | TestOutputListOfDevices of seq * string list
254 (* Run the command sequence and expect the output of the final
255 * command to be the integer.
257 | TestOutputInt of seq * int
259 (* Run the command sequence and expect the output of the final
260 * command to be <op> <int>, eg. ">=", "1".
262 | TestOutputIntOp of seq * string * int
264 (* Run the command sequence and expect the output of the final
265 * command to be a true value (!= 0 or != NULL).
267 | TestOutputTrue of seq
269 (* Run the command sequence and expect the output of the final
270 * command to be a false value (== 0 or == NULL, but not an error).
272 | TestOutputFalse of seq
274 (* Run the command sequence and expect the output of the final
275 * command to be a list of the given length (but don't care about
278 | TestOutputLength of seq * int
280 (* Run the command sequence and expect the output of the final
281 * command to be a buffer (RBufferOut), ie. string + size.
283 | TestOutputBuffer of seq * string
285 (* Run the command sequence and expect the output of the final
286 * command to be a structure.
288 | TestOutputStruct of seq * test_field_compare list
290 (* Run the command sequence and expect the final command (only)
293 | TestLastFail of seq
295 and test_field_compare =
296 | CompareWithInt of string * int
297 | CompareWithIntOp of string * string * int
298 | CompareWithString of string * string
299 | CompareFieldsIntEq of string * string
300 | CompareFieldsStrEq of string * string
302 (* Test prerequisites. *)
304 (* Test always runs. *)
307 (* Test is currently disabled - eg. it fails, or it tests some
308 * unimplemented feature.
312 (* 'string' is some C code (a function body) that should return
313 * true or false. The test will run if the code returns true.
317 (* As for 'If' but the test runs _unless_ the code returns true. *)
320 (* Run the test only if 'string' is available in the daemon. *)
321 | IfAvailable of string
323 (* Some initial scenarios for testing. *)
325 (* Do nothing, block devices could contain random stuff including
326 * LVM PVs, and some filesystems might be mounted. This is usually
331 (* Block devices are empty and no filesystems are mounted. *)
334 (* /dev/sda contains a single partition /dev/sda1, with random
335 * content. /dev/sdb and /dev/sdc may have random content.
340 (* /dev/sda contains a single partition /dev/sda1, which is formatted
341 * as ext2, empty [except for lost+found] and mounted on /.
342 * /dev/sdb and /dev/sdc may have random content.
348 * /dev/sda1 (is a PV):
349 * /dev/VG/LV (size 8MB):
350 * formatted as ext2, empty [except for lost+found], mounted on /
351 * /dev/sdb and /dev/sdc may have random content.
355 (* /dev/sdd (the ISO, see images/ directory in source)
360 (* Sequence of commands for testing. *)
362 and cmd = string list
364 (* Note about long descriptions: When referring to another
365 * action, use the format C<guestfs_other> (ie. the full name of
366 * the C function). This will be replaced as appropriate in other
369 * Apart from that, long descriptions are just perldoc paragraphs.
372 (* Generate a random UUID (used in tests). *)
374 let chan = open_process_in "uuidgen" in
375 let uuid = input_line chan in
376 (match close_process_in chan with
379 failwith "uuidgen: process exited with non-zero status"
380 | WSIGNALED _ | WSTOPPED _ ->
381 failwith "uuidgen: process signalled or stopped by signal"
385 (* These test functions are used in the language binding tests. *)
387 let test_all_args = [
390 StringList "strlist";
399 let test_all_rets = [
400 (* except for RErr, which is tested thoroughly elsewhere *)
401 "test0rint", RInt "valout";
402 "test0rint64", RInt64 "valout";
403 "test0rbool", RBool "valout";
404 "test0rconststring", RConstString "valout";
405 "test0rconstoptstring", RConstOptString "valout";
406 "test0rstring", RString "valout";
407 "test0rstringlist", RStringList "valout";
408 "test0rstruct", RStruct ("valout", "lvm_pv");
409 "test0rstructlist", RStructList ("valout", "lvm_pv");
410 "test0rhashtable", RHashtable "valout";
413 let test_functions = [
414 ("test0", (RErr, test_all_args), -1, [NotInFish; NotInDocs],
416 "internal test function - do not use",
418 This is an internal test function which is used to test whether
419 the automatically generated bindings can handle every possible
420 parameter type correctly.
422 It echos the contents of each parameter to stdout.
424 You probably don't want to call this function.");
428 [(name, (ret, [String "val"]), -1, [NotInFish; NotInDocs],
430 "internal test function - do not use",
432 This is an internal test function which is used to test whether
433 the automatically generated bindings can handle every possible
434 return type correctly.
436 It converts string C<val> to the return type.
438 You probably don't want to call this function.");
439 (name ^ "err", (ret, []), -1, [NotInFish; NotInDocs],
441 "internal test function - do not use",
443 This is an internal test function which is used to test whether
444 the automatically generated bindings can handle every possible
445 return type correctly.
447 This function always returns an error.
449 You probably don't want to call this function.")]
453 (* non_daemon_functions are any functions which don't get processed
454 * in the daemon, eg. functions for setting and getting local
455 * configuration values.
458 let non_daemon_functions = test_functions @ [
459 ("launch", (RErr, []), -1, [FishAlias "run"],
461 "launch the qemu subprocess",
463 Internally libguestfs is implemented by running a virtual machine
466 You should call this after configuring the handle
467 (eg. adding drives) but before performing any actions.");
469 ("wait_ready", (RErr, []), -1, [NotInFish],
471 "wait until the qemu subprocess launches (no op)",
473 This function is a no op.
475 In versions of the API E<lt> 1.0.71 you had to call this function
476 just after calling C<guestfs_launch> to wait for the launch
477 to complete. However this is no longer necessary because
478 C<guestfs_launch> now does the waiting.
480 If you see any calls to this function in code then you can just
481 remove them, unless you want to retain compatibility with older
482 versions of the API.");
484 ("kill_subprocess", (RErr, []), -1, [],
486 "kill the qemu subprocess",
488 This kills the qemu subprocess. You should never need to call this.");
490 ("add_drive", (RErr, [String "filename"]), -1, [FishAlias "add"],
492 "add an image to examine or modify",
494 This function adds a virtual machine disk image C<filename> to the
495 guest. The first time you call this function, the disk appears as IDE
496 disk 0 (C</dev/sda>) in the guest, the second time as C</dev/sdb>, and
499 You don't necessarily need to be root when using libguestfs. However
500 you obviously do need sufficient permissions to access the filename
501 for whatever operations you want to perform (ie. read access if you
502 just want to read the image or write access if you want to modify the
505 This is equivalent to the qemu parameter
506 C<-drive file=filename,cache=off,if=...>.
508 C<cache=off> is omitted in cases where it is not supported by
509 the underlying filesystem.
511 C<if=...> is set at compile time by the configuration option
512 C<./configure --with-drive-if=...>. In the rare case where you
513 might need to change this at run time, use C<guestfs_add_drive_with_if>
514 or C<guestfs_add_drive_ro_with_if>.
516 Note that this call checks for the existence of C<filename>. This
517 stops you from specifying other types of drive which are supported
518 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
519 the general C<guestfs_config> call instead.");
521 ("add_cdrom", (RErr, [String "filename"]), -1, [FishAlias "cdrom"],
523 "add a CD-ROM disk image to examine",
525 This function adds a virtual CD-ROM disk image to the guest.
527 This is equivalent to the qemu parameter C<-cdrom filename>.
535 This call checks for the existence of C<filename>. This
536 stops you from specifying other types of drive which are supported
537 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
538 the general C<guestfs_config> call instead.
542 If you just want to add an ISO file (often you use this as an
543 efficient way to transfer large files into the guest), then you
544 should probably use C<guestfs_add_drive_ro> instead.
548 ("add_drive_ro", (RErr, [String "filename"]), -1, [FishAlias "add-ro"],
550 "add a drive in snapshot mode (read-only)",
552 This adds a drive in snapshot mode, making it effectively
555 Note that writes to the device are allowed, and will be seen for
556 the duration of the guestfs handle, but they are written
557 to a temporary file which is discarded as soon as the guestfs
558 handle is closed. We don't currently have any method to enable
559 changes to be committed, although qemu can support this.
561 This is equivalent to the qemu parameter
562 C<-drive file=filename,snapshot=on,if=...>.
564 C<if=...> is set at compile time by the configuration option
565 C<./configure --with-drive-if=...>. In the rare case where you
566 might need to change this at run time, use C<guestfs_add_drive_with_if>
567 or C<guestfs_add_drive_ro_with_if>.
569 Note that this call checks for the existence of C<filename>. This
570 stops you from specifying other types of drive which are supported
571 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
572 the general C<guestfs_config> call instead.");
574 ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"]), -1, [],
576 "add qemu parameters",
578 This can be used to add arbitrary qemu command line parameters
579 of the form C<-param value>. Actually it's not quite arbitrary - we
580 prevent you from setting some parameters which would interfere with
581 parameters that we use.
583 The first character of C<param> string must be a C<-> (dash).
585 C<value> can be NULL.");
587 ("set_qemu", (RErr, [OptString "qemu"]), -1, [FishAlias "qemu"],
589 "set the qemu binary",
591 Set the qemu binary that we will use.
593 The default is chosen when the library was compiled by the
596 You can also override this by setting the C<LIBGUESTFS_QEMU>
597 environment variable.
599 Setting C<qemu> to C<NULL> restores the default qemu binary.
601 Note that you should call this function as early as possible
602 after creating the handle. This is because some pre-launch
603 operations depend on testing qemu features (by running C<qemu -help>).
604 If the qemu binary changes, we don't retest features, and
605 so you might see inconsistent results. Using the environment
606 variable C<LIBGUESTFS_QEMU> is safest of all since that picks
607 the qemu binary at the same time as the handle is created.");
609 ("get_qemu", (RConstString "qemu", []), -1, [],
610 [InitNone, Always, TestRun (
612 "get the qemu binary",
614 Return the current qemu binary.
616 This is always non-NULL. If it wasn't set already, then this will
617 return the default qemu binary name.");
619 ("set_path", (RErr, [OptString "searchpath"]), -1, [FishAlias "path"],
621 "set the search path",
623 Set the path that libguestfs searches for kernel and initrd.img.
625 The default is C<$libdir/guestfs> unless overridden by setting
626 C<LIBGUESTFS_PATH> environment variable.
628 Setting C<path> to C<NULL> restores the default path.");
630 ("get_path", (RConstString "path", []), -1, [],
631 [InitNone, Always, TestRun (
633 "get the search path",
635 Return the current search path.
637 This is always non-NULL. If it wasn't set already, then this will
638 return the default path.");
640 ("set_append", (RErr, [OptString "append"]), -1, [FishAlias "append"],
642 "add options to kernel command line",
644 This function is used to add additional options to the
645 guest kernel command line.
647 The default is C<NULL> unless overridden by setting
648 C<LIBGUESTFS_APPEND> environment variable.
650 Setting C<append> to C<NULL> means I<no> additional options
651 are passed (libguestfs always adds a few of its own).");
653 ("get_append", (RConstOptString "append", []), -1, [],
654 (* This cannot be tested with the current framework. The
655 * function can return NULL in normal operations, which the
656 * test framework interprets as an error.
659 "get the additional kernel options",
661 Return the additional kernel options which are added to the
662 guest kernel command line.
664 If C<NULL> then no options are added.");
666 ("set_autosync", (RErr, [Bool "autosync"]), -1, [FishAlias "autosync"],
670 If C<autosync> is true, this enables autosync. Libguestfs will make a
671 best effort attempt to run C<guestfs_umount_all> followed by
672 C<guestfs_sync> when the handle is closed
673 (also if the program exits without closing handles).
675 This is disabled by default (except in guestfish where it is
676 enabled by default).");
678 ("get_autosync", (RBool "autosync", []), -1, [],
679 [InitNone, Always, TestRun (
680 [["get_autosync"]])],
683 Get the autosync flag.");
685 ("set_verbose", (RErr, [Bool "verbose"]), -1, [FishAlias "verbose"],
689 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
691 Verbose messages are disabled unless the environment variable
692 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.");
694 ("get_verbose", (RBool "verbose", []), -1, [],
698 This returns the verbose messages flag.");
700 ("is_ready", (RBool "ready", []), -1, [],
701 [InitNone, Always, TestOutputTrue (
703 "is ready to accept commands",
705 This returns true iff this handle is ready to accept commands
706 (in the C<READY> state).
708 For more information on states, see L<guestfs(3)>.");
710 ("is_config", (RBool "config", []), -1, [],
711 [InitNone, Always, TestOutputFalse (
713 "is in configuration state",
715 This returns true iff this handle is being configured
716 (in the C<CONFIG> state).
718 For more information on states, see L<guestfs(3)>.");
720 ("is_launching", (RBool "launching", []), -1, [],
721 [InitNone, Always, TestOutputFalse (
722 [["is_launching"]])],
723 "is launching subprocess",
725 This returns true iff this handle is launching the subprocess
726 (in the C<LAUNCHING> state).
728 For more information on states, see L<guestfs(3)>.");
730 ("is_busy", (RBool "busy", []), -1, [],
731 [InitNone, Always, TestOutputFalse (
733 "is busy processing a command",
735 This returns true iff this handle is busy processing a command
736 (in the C<BUSY> state).
738 For more information on states, see L<guestfs(3)>.");
740 ("get_state", (RInt "state", []), -1, [],
742 "get the current state",
744 This returns the current state as an opaque integer. This is
745 only useful for printing debug and internal error messages.
747 For more information on states, see L<guestfs(3)>.");
749 ("set_memsize", (RErr, [Int "memsize"]), -1, [FishAlias "memsize"],
750 [InitNone, Always, TestOutputInt (
751 [["set_memsize"; "500"];
752 ["get_memsize"]], 500)],
753 "set memory allocated to the qemu subprocess",
755 This sets the memory size in megabytes allocated to the
756 qemu subprocess. This only has any effect if called before
759 You can also change this by setting the environment
760 variable C<LIBGUESTFS_MEMSIZE> before the handle is
763 For more information on the architecture of libguestfs,
764 see L<guestfs(3)>.");
766 ("get_memsize", (RInt "memsize", []), -1, [],
767 [InitNone, Always, TestOutputIntOp (
768 [["get_memsize"]], ">=", 256)],
769 "get memory allocated to the qemu subprocess",
771 This gets the memory size in megabytes allocated to the
774 If C<guestfs_set_memsize> was not called
775 on this handle, and if C<LIBGUESTFS_MEMSIZE> was not set,
776 then this returns the compiled-in default value for memsize.
778 For more information on the architecture of libguestfs,
779 see L<guestfs(3)>.");
781 ("get_pid", (RInt "pid", []), -1, [FishAlias "pid"],
782 [InitNone, Always, TestOutputIntOp (
783 [["get_pid"]], ">=", 1)],
784 "get PID of qemu subprocess",
786 Return the process ID of the qemu subprocess. If there is no
787 qemu subprocess, then this will return an error.
789 This is an internal call used for debugging and testing.");
791 ("version", (RStruct ("version", "version"), []), -1, [],
792 [InitNone, Always, TestOutputStruct (
793 [["version"]], [CompareWithInt ("major", 1)])],
794 "get the library version number",
796 Return the libguestfs version number that the program is linked
799 Note that because of dynamic linking this is not necessarily
800 the version of libguestfs that you compiled against. You can
801 compile the program, and then at runtime dynamically link
802 against a completely different C<libguestfs.so> library.
804 This call was added in version C<1.0.58>. In previous
805 versions of libguestfs there was no way to get the version
806 number. From C code you can use dynamic linker functions
807 to find out if this symbol exists (if it doesn't, then
808 it's an earlier version).
810 The call returns a structure with four elements. The first
811 three (C<major>, C<minor> and C<release>) are numbers and
812 correspond to the usual version triplet. The fourth element
813 (C<extra>) is a string and is normally empty, but may be
814 used for distro-specific information.
816 To construct the original version string:
817 C<$major.$minor.$release$extra>
819 See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>.
821 I<Note:> Don't use this call to test for availability
822 of features. In enterprise distributions we backport
823 features from later versions into earlier versions,
824 making this an unreliable way to test for features.
825 Use C<guestfs_available> instead.");
827 ("set_selinux", (RErr, [Bool "selinux"]), -1, [FishAlias "selinux"],
828 [InitNone, Always, TestOutputTrue (
829 [["set_selinux"; "true"];
831 "set SELinux enabled or disabled at appliance boot",
833 This sets the selinux flag that is passed to the appliance
834 at boot time. The default is C<selinux=0> (disabled).
836 Note that if SELinux is enabled, it is always in
837 Permissive mode (C<enforcing=0>).
839 For more information on the architecture of libguestfs,
840 see L<guestfs(3)>.");
842 ("get_selinux", (RBool "selinux", []), -1, [],
844 "get SELinux enabled flag",
846 This returns the current setting of the selinux flag which
847 is passed to the appliance at boot time. See C<guestfs_set_selinux>.
849 For more information on the architecture of libguestfs,
850 see L<guestfs(3)>.");
852 ("set_trace", (RErr, [Bool "trace"]), -1, [FishAlias "trace"],
853 [InitNone, Always, TestOutputFalse (
854 [["set_trace"; "false"];
856 "enable or disable command traces",
858 If the command trace flag is set to 1, then commands are
859 printed on stderr before they are executed in a format
860 which is very similar to the one used by guestfish. In
861 other words, you can run a program with this enabled, and
862 you will get out a script which you can feed to guestfish
863 to perform the same set of actions.
865 If you want to trace C API calls into libguestfs (and
866 other libraries) then possibly a better way is to use
867 the external ltrace(1) command.
869 Command traces are disabled unless the environment variable
870 C<LIBGUESTFS_TRACE> is defined and set to C<1>.");
872 ("get_trace", (RBool "trace", []), -1, [],
874 "get command trace enabled flag",
876 Return the command trace flag.");
878 ("set_direct", (RErr, [Bool "direct"]), -1, [FishAlias "direct"],
879 [InitNone, Always, TestOutputFalse (
880 [["set_direct"; "false"];
882 "enable or disable direct appliance mode",
884 If the direct appliance mode flag is enabled, then stdin and
885 stdout are passed directly through to the appliance once it
888 One consequence of this is that log messages aren't caught
889 by the library and handled by C<guestfs_set_log_message_callback>,
890 but go straight to stdout.
892 You probably don't want to use this unless you know what you
895 The default is disabled.");
897 ("get_direct", (RBool "direct", []), -1, [],
899 "get direct appliance mode flag",
901 Return the direct appliance mode flag.");
903 ("set_recovery_proc", (RErr, [Bool "recoveryproc"]), -1, [FishAlias "recovery-proc"],
904 [InitNone, Always, TestOutputTrue (
905 [["set_recovery_proc"; "true"];
906 ["get_recovery_proc"]])],
907 "enable or disable the recovery process",
909 If this is called with the parameter C<false> then
910 C<guestfs_launch> does not create a recovery process. The
911 purpose of the recovery process is to stop runaway qemu
912 processes in the case where the main program aborts abruptly.
914 This only has any effect if called before C<guestfs_launch>,
915 and the default is true.
917 About the only time when you would want to disable this is
918 if the main process will fork itself into the background
919 (\"daemonize\" itself). In this case the recovery process
920 thinks that the main program has disappeared and so kills
921 qemu, which is not very helpful.");
923 ("get_recovery_proc", (RBool "recoveryproc", []), -1, [],
925 "get recovery process enabled flag",
927 Return the recovery process enabled flag.");
929 ("add_drive_with_if", (RErr, [String "filename"; String "iface"]), -1, [],
931 "add a drive specifying the QEMU block emulation to use",
933 This is the same as C<guestfs_add_drive> but it allows you
934 to specify the QEMU interface emulation to use at run time.");
936 ("add_drive_ro_with_if", (RErr, [String "filename"; String "iface"]), -1, [],
938 "add a drive read-only specifying the QEMU block emulation to use",
940 This is the same as C<guestfs_add_drive_ro> but it allows you
941 to specify the QEMU interface emulation to use at run time.");
943 ("file_architecture", (RString "arch", [Pathname "filename"]), -1, [],
944 [InitISOFS, Always, TestOutput (
945 [["file_architecture"; "/bin-i586-dynamic"]], "i386");
946 InitISOFS, Always, TestOutput (
947 [["file_architecture"; "/bin-sparc-dynamic"]], "sparc");
948 InitISOFS, Always, TestOutput (
949 [["file_architecture"; "/bin-win32.exe"]], "i386");
950 InitISOFS, Always, TestOutput (
951 [["file_architecture"; "/bin-win64.exe"]], "x86_64");
952 InitISOFS, Always, TestOutput (
953 [["file_architecture"; "/bin-x86_64-dynamic"]], "x86_64");
954 InitISOFS, Always, TestOutput (
955 [["file_architecture"; "/lib-i586.so"]], "i386");
956 InitISOFS, Always, TestOutput (
957 [["file_architecture"; "/lib-sparc.so"]], "sparc");
958 InitISOFS, Always, TestOutput (
959 [["file_architecture"; "/lib-win32.dll"]], "i386");
960 InitISOFS, Always, TestOutput (
961 [["file_architecture"; "/lib-win64.dll"]], "x86_64");
962 InitISOFS, Always, TestOutput (
963 [["file_architecture"; "/lib-x86_64.so"]], "x86_64");
964 InitISOFS, Always, TestOutput (
965 [["file_architecture"; "/initrd-x86_64.img"]], "x86_64");
966 InitISOFS, Always, TestOutput (
967 [["file_architecture"; "/initrd-x86_64.img.gz"]], "x86_64");],
968 "detect the architecture of a binary file",
970 This detects the architecture of the binary C<filename>,
971 and returns it if known.
973 Currently defined architectures are:
979 This string is returned for all 32 bit i386, i486, i586, i686 binaries
980 irrespective of the precise processor requirements of the binary.
992 64 bit SPARC V9 and above.
1008 Libguestfs may return other architecture strings in future.
1010 The function works on at least the following types of files:
1016 many types of Un*x and Linux binary
1020 many types of Un*x and Linux shared library
1024 Windows Win32 and Win64 binaries
1028 Windows Win32 and Win64 DLLs
1030 Win32 binaries and DLLs return C<i386>.
1032 Win64 binaries and DLLs return C<x86_64>.
1036 Linux kernel modules
1040 Linux new-style initrd images
1044 some non-x86 Linux vmlinuz kernels
1048 What it can't do currently:
1054 static libraries (libfoo.a)
1058 Linux old-style initrd as compressed ext2 filesystem (RHEL 3)
1062 x86 Linux vmlinuz kernels
1064 x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and
1065 compressed code, and are horribly hard to unpack. If you want to find
1066 the architecture of a kernel, use the architecture of the associated
1067 initrd or kernel module(s) instead.
1071 ("inspect_os", (RStringList "roots", []), -1, [],
1073 "inspect disk and return list of operating systems found",
1075 This function uses other libguestfs functions and certain
1076 heuristics to inspect the disk(s) (usually disks belonging to
1077 a virtual machine), looking for operating systems.
1079 The list returned is empty if no operating systems were found.
1081 If one operating system was found, then this returns a list with
1082 a single element, which is the name of the root filesystem of
1083 this operating system. It is also possible for this function
1084 to return a list containing more than one element, indicating
1085 a dual-boot or multi-boot virtual machine, with each element being
1086 the root filesystem of one of the operating systems.
1088 You can pass the root string(s) returned to other
1089 C<guestfs_inspect_get_*> functions in order to query further
1090 information about each operating system, such as the name
1093 This function uses other libguestfs features such as
1094 C<guestfs_mount_ro> and C<guestfs_umount_all> in order to mount
1095 and unmount filesystems and look at the contents. This should
1096 be called with no disks currently mounted. The function may also
1097 use Augeas, so any existing Augeas handle will be closed.
1099 This function cannot decrypt encrypted disks. The caller
1100 must do that first (supplying the necessary keys) if the
1103 Please read L<guestfs(3)/INSPECTION> for more details.");
1105 ("inspect_get_type", (RString "name", [Device "root"]), -1, [],
1107 "get type of inspected operating system",
1109 This function should only be called with a root device string
1110 as returned by C<guestfs_inspect_os>.
1112 This returns the type of the inspected operating system.
1113 Currently defined types are:
1119 Any Linux-based operating system.
1123 Any Microsoft Windows operating system.
1127 The operating system type could not be determined.
1131 Future versions of libguestfs may return other strings here.
1132 The caller should be prepared to handle any string.
1134 Please read L<guestfs(3)/INSPECTION> for more details.");
1136 ("inspect_get_arch", (RString "arch", [Device "root"]), -1, [],
1138 "get architecture of inspected operating system",
1140 This function should only be called with a root device string
1141 as returned by C<guestfs_inspect_os>.
1143 This returns the architecture of the inspected operating system.
1144 The possible return values are listed under
1145 C<guestfs_file_architecture>.
1147 If the architecture could not be determined, then the
1148 string C<unknown> is returned.
1150 Please read L<guestfs(3)/INSPECTION> for more details.");
1152 ("inspect_get_distro", (RString "distro", [Device "root"]), -1, [],
1154 "get distro of inspected operating system",
1156 This function should only be called with a root device string
1157 as returned by C<guestfs_inspect_os>.
1159 This returns the distro (distribution) of the inspected operating
1162 Currently defined distros are:
1168 Debian or a Debian-derived distro such as Ubuntu.
1174 =item \"redhat-based\"
1176 Some Red Hat-derived distro.
1180 Red Hat Enterprise Linux and some derivatives.
1184 Windows does not have distributions. This string is
1185 returned if the OS type is Windows.
1189 The distro could not be determined.
1193 Future versions of libguestfs may return other strings here.
1194 The caller should be prepared to handle any string.
1196 Please read L<guestfs(3)/INSPECTION> for more details.");
1198 ("inspect_get_major_version", (RInt "major", [Device "root"]), -1, [],
1200 "get major version of inspected operating system",
1202 This function should only be called with a root device string
1203 as returned by C<guestfs_inspect_os>.
1205 This returns the major version number of the inspected operating
1208 Windows uses a consistent versioning scheme which is I<not>
1209 reflected in the popular public names used by the operating system.
1210 Notably the operating system known as \"Windows 7\" is really
1211 version 6.1 (ie. major = 6, minor = 1). You can find out the
1212 real versions corresponding to releases of Windows by consulting
1215 If the version could not be determined, then C<0> is returned.
1217 Please read L<guestfs(3)/INSPECTION> for more details.");
1219 ("inspect_get_minor_version", (RInt "minor", [Device "root"]), -1, [],
1221 "get minor version of inspected operating system",
1223 This function should only be called with a root device string
1224 as returned by C<guestfs_inspect_os>.
1226 This returns the minor version number of the inspected operating
1229 If the version could not be determined, then C<0> is returned.
1231 Please read L<guestfs(3)/INSPECTION> for more details.
1232 See also C<guestfs_inspect_get_major_version>.");
1234 ("inspect_get_product_name", (RString "product", [Device "root"]), -1, [],
1236 "get product name of inspected operating system",
1238 This function should only be called with a root device string
1239 as returned by C<guestfs_inspect_os>.
1241 This returns the product name of the inspected operating
1242 system. The product name is generally some freeform string
1243 which can be displayed to the user, but should not be
1246 If the product name could not be determined, then the
1247 string C<unknown> is returned.
1249 Please read L<guestfs(3)/INSPECTION> for more details.");
1251 ("inspect_get_mountpoints", (RHashtable "mountpoints", [Device "root"]), -1, [],
1253 "get mountpoints of inspected operating system",
1255 This function should only be called with a root device string
1256 as returned by C<guestfs_inspect_os>.
1258 This returns a hash of where we think the filesystems
1259 associated with this operating system should be mounted.
1260 Callers should note that this is at best an educated guess
1261 made by reading configuration files such as C</etc/fstab>.
1263 Each element in the returned hashtable has a key which
1264 is the path of the mountpoint (eg. C</boot>) and a value
1265 which is the filesystem that would be mounted there
1268 Non-mounted devices such as swap devices are I<not>
1269 returned in this list.
1271 Please read L<guestfs(3)/INSPECTION> for more details.
1272 See also C<guestfs_inspect_get_filesystems>.");
1274 ("inspect_get_filesystems", (RStringList "filesystems", [Device "root"]), -1, [],
1276 "get filesystems associated with inspected operating system",
1278 This function should only be called with a root device string
1279 as returned by C<guestfs_inspect_os>.
1281 This returns a list of all the filesystems that we think
1282 are associated with this operating system. This includes
1283 the root filesystem, other ordinary filesystems, and
1284 non-mounted devices like swap partitions.
1286 In the case of a multi-boot virtual machine, it is possible
1287 for a filesystem to be shared between operating systems.
1289 Please read L<guestfs(3)/INSPECTION> for more details.
1290 See also C<guestfs_inspect_get_mountpoints>.");
1294 (* daemon_functions are any functions which cause some action
1295 * to take place in the daemon.
1298 let daemon_functions = [
1299 ("mount", (RErr, [Device "device"; String "mountpoint"]), 1, [],
1300 [InitEmpty, Always, TestOutput (
1301 [["part_disk"; "/dev/sda"; "mbr"];
1302 ["mkfs"; "ext2"; "/dev/sda1"];
1303 ["mount"; "/dev/sda1"; "/"];
1304 ["write"; "/new"; "new file contents"];
1305 ["cat"; "/new"]], "new file contents")],
1306 "mount a guest disk at a position in the filesystem",
1308 Mount a guest disk at a position in the filesystem. Block devices
1309 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
1310 the guest. If those block devices contain partitions, they will have
1311 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
1314 The rules are the same as for L<mount(2)>: A filesystem must
1315 first be mounted on C</> before others can be mounted. Other
1316 filesystems can only be mounted on directories which already
1319 The mounted filesystem is writable, if we have sufficient permissions
1320 on the underlying device.
1323 When you use this call, the filesystem options C<sync> and C<noatime>
1324 are set implicitly. This was originally done because we thought it
1325 would improve reliability, but it turns out that I<-o sync> has a
1326 very large negative performance impact and negligible effect on
1327 reliability. Therefore we recommend that you avoid using
1328 C<guestfs_mount> in any code that needs performance, and instead
1329 use C<guestfs_mount_options> (use an empty string for the first
1330 parameter if you don't want any options).");
1332 ("sync", (RErr, []), 2, [],
1333 [ InitEmpty, Always, TestRun [["sync"]]],
1334 "sync disks, writes are flushed through to the disk image",
1336 This syncs the disk, so that any writes are flushed through to the
1337 underlying disk image.
1339 You should always call this if you have modified a disk image, before
1340 closing the handle.");
1342 ("touch", (RErr, [Pathname "path"]), 3, [],
1343 [InitBasicFS, Always, TestOutputTrue (
1345 ["exists"; "/new"]])],
1346 "update file timestamps or create a new file",
1348 Touch acts like the L<touch(1)> command. It can be used to
1349 update the timestamps on a file, or, if the file does not exist,
1350 to create a new zero-length file.
1352 This command only works on regular files, and will fail on other
1353 file types such as directories, symbolic links, block special etc.");
1355 ("cat", (RString "content", [Pathname "path"]), 4, [ProtocolLimitWarning],
1356 [InitISOFS, Always, TestOutput (
1357 [["cat"; "/known-2"]], "abcdef\n")],
1358 "list the contents of a file",
1360 Return the contents of the file named C<path>.
1362 Note that this function cannot correctly handle binary files
1363 (specifically, files containing C<\\0> character which is treated
1364 as end of string). For those you need to use the C<guestfs_read_file>
1365 or C<guestfs_download> functions which have a more complex interface.");
1367 ("ll", (RString "listing", [Pathname "directory"]), 5, [],
1368 [], (* XXX Tricky to test because it depends on the exact format
1369 * of the 'ls -l' command, which changes between F10 and F11.
1371 "list the files in a directory (long format)",
1373 List the files in C<directory> (relative to the root directory,
1374 there is no cwd) in the format of 'ls -la'.
1376 This command is mostly useful for interactive sessions. It
1377 is I<not> intended that you try to parse the output string.");
1379 ("ls", (RStringList "listing", [Pathname "directory"]), 6, [],
1380 [InitBasicFS, Always, TestOutputList (
1382 ["touch"; "/newer"];
1383 ["touch"; "/newest"];
1384 ["ls"; "/"]], ["lost+found"; "new"; "newer"; "newest"])],
1385 "list the files in a directory",
1387 List the files in C<directory> (relative to the root directory,
1388 there is no cwd). The '.' and '..' entries are not returned, but
1389 hidden files are shown.
1391 This command is mostly useful for interactive sessions. Programs
1392 should probably use C<guestfs_readdir> instead.");
1394 ("list_devices", (RStringList "devices", []), 7, [],
1395 [InitEmpty, Always, TestOutputListOfDevices (
1396 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1397 "list the block devices",
1399 List all the block devices.
1401 The full block device names are returned, eg. C</dev/sda>");
1403 ("list_partitions", (RStringList "partitions", []), 8, [],
1404 [InitBasicFS, Always, TestOutputListOfDevices (
1405 [["list_partitions"]], ["/dev/sda1"]);
1406 InitEmpty, Always, TestOutputListOfDevices (
1407 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1408 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1409 "list the partitions",
1411 List all the partitions detected on all block devices.
1413 The full partition device names are returned, eg. C</dev/sda1>
1415 This does not return logical volumes. For that you will need to
1416 call C<guestfs_lvs>.");
1418 ("pvs", (RStringList "physvols", []), 9, [Optional "lvm2"],
1419 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1420 [["pvs"]], ["/dev/sda1"]);
1421 InitEmpty, Always, TestOutputListOfDevices (
1422 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1423 ["pvcreate"; "/dev/sda1"];
1424 ["pvcreate"; "/dev/sda2"];
1425 ["pvcreate"; "/dev/sda3"];
1426 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1427 "list the LVM physical volumes (PVs)",
1429 List all the physical volumes detected. This is the equivalent
1430 of the L<pvs(8)> command.
1432 This returns a list of just the device names that contain
1433 PVs (eg. C</dev/sda2>).
1435 See also C<guestfs_pvs_full>.");
1437 ("vgs", (RStringList "volgroups", []), 10, [Optional "lvm2"],
1438 [InitBasicFSonLVM, Always, TestOutputList (
1440 InitEmpty, Always, TestOutputList (
1441 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1442 ["pvcreate"; "/dev/sda1"];
1443 ["pvcreate"; "/dev/sda2"];
1444 ["pvcreate"; "/dev/sda3"];
1445 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1446 ["vgcreate"; "VG2"; "/dev/sda3"];
1447 ["vgs"]], ["VG1"; "VG2"])],
1448 "list the LVM volume groups (VGs)",
1450 List all the volumes groups detected. This is the equivalent
1451 of the L<vgs(8)> command.
1453 This returns a list of just the volume group names that were
1454 detected (eg. C<VolGroup00>).
1456 See also C<guestfs_vgs_full>.");
1458 ("lvs", (RStringList "logvols", []), 11, [Optional "lvm2"],
1459 [InitBasicFSonLVM, Always, TestOutputList (
1460 [["lvs"]], ["/dev/VG/LV"]);
1461 InitEmpty, Always, TestOutputList (
1462 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1463 ["pvcreate"; "/dev/sda1"];
1464 ["pvcreate"; "/dev/sda2"];
1465 ["pvcreate"; "/dev/sda3"];
1466 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1467 ["vgcreate"; "VG2"; "/dev/sda3"];
1468 ["lvcreate"; "LV1"; "VG1"; "50"];
1469 ["lvcreate"; "LV2"; "VG1"; "50"];
1470 ["lvcreate"; "LV3"; "VG2"; "50"];
1471 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1472 "list the LVM logical volumes (LVs)",
1474 List all the logical volumes detected. This is the equivalent
1475 of the L<lvs(8)> command.
1477 This returns a list of the logical volume device names
1478 (eg. C</dev/VolGroup00/LogVol00>).
1480 See also C<guestfs_lvs_full>.");
1482 ("pvs_full", (RStructList ("physvols", "lvm_pv"), []), 12, [Optional "lvm2"],
1483 [], (* XXX how to test? *)
1484 "list the LVM physical volumes (PVs)",
1486 List all the physical volumes detected. This is the equivalent
1487 of the L<pvs(8)> command. The \"full\" version includes all fields.");
1489 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), []), 13, [Optional "lvm2"],
1490 [], (* XXX how to test? *)
1491 "list the LVM volume groups (VGs)",
1493 List all the volumes groups detected. This is the equivalent
1494 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1496 ("lvs_full", (RStructList ("logvols", "lvm_lv"), []), 14, [Optional "lvm2"],
1497 [], (* XXX how to test? *)
1498 "list the LVM logical volumes (LVs)",
1500 List all the logical volumes detected. This is the equivalent
1501 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1503 ("read_lines", (RStringList "lines", [Pathname "path"]), 15, [],
1504 [InitISOFS, Always, TestOutputList (
1505 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1506 InitISOFS, Always, TestOutputList (
1507 [["read_lines"; "/empty"]], [])],
1508 "read file as lines",
1510 Return the contents of the file named C<path>.
1512 The file contents are returned as a list of lines. Trailing
1513 C<LF> and C<CRLF> character sequences are I<not> returned.
1515 Note that this function cannot correctly handle binary files
1516 (specifically, files containing C<\\0> character which is treated
1517 as end of line). For those you need to use the C<guestfs_read_file>
1518 function which has a more complex interface.");
1520 ("aug_init", (RErr, [Pathname "root"; Int "flags"]), 16, [Optional "augeas"],
1521 [], (* XXX Augeas code needs tests. *)
1522 "create a new Augeas handle",
1524 Create a new Augeas handle for editing configuration files.
1525 If there was any previous Augeas handle associated with this
1526 guestfs session, then it is closed.
1528 You must call this before using any other C<guestfs_aug_*>
1531 C<root> is the filesystem root. C<root> must not be NULL,
1534 The flags are the same as the flags defined in
1535 E<lt>augeas.hE<gt>, the logical I<or> of the following
1540 =item C<AUG_SAVE_BACKUP> = 1
1542 Keep the original file with a C<.augsave> extension.
1544 =item C<AUG_SAVE_NEWFILE> = 2
1546 Save changes into a file with extension C<.augnew>, and
1547 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1549 =item C<AUG_TYPE_CHECK> = 4
1551 Typecheck lenses (can be expensive).
1553 =item C<AUG_NO_STDINC> = 8
1555 Do not use standard load path for modules.
1557 =item C<AUG_SAVE_NOOP> = 16
1559 Make save a no-op, just record what would have been changed.
1561 =item C<AUG_NO_LOAD> = 32
1563 Do not load the tree in C<guestfs_aug_init>.
1567 To close the handle, you can call C<guestfs_aug_close>.
1569 To find out more about Augeas, see L<http://augeas.net/>.");
1571 ("aug_close", (RErr, []), 26, [Optional "augeas"],
1572 [], (* XXX Augeas code needs tests. *)
1573 "close the current Augeas handle",
1575 Close the current Augeas handle and free up any resources
1576 used by it. After calling this, you have to call
1577 C<guestfs_aug_init> again before you can use any other
1578 Augeas functions.");
1580 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"]), 17, [Optional "augeas"],
1581 [], (* XXX Augeas code needs tests. *)
1582 "define an Augeas variable",
1584 Defines an Augeas variable C<name> whose value is the result
1585 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1588 On success this returns the number of nodes in C<expr>, or
1589 C<0> if C<expr> evaluates to something which is not a nodeset.");
1591 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"]), 18, [Optional "augeas"],
1592 [], (* XXX Augeas code needs tests. *)
1593 "define an Augeas node",
1595 Defines a variable C<name> whose value is the result of
1598 If C<expr> evaluates to an empty nodeset, a node is created,
1599 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1600 C<name> will be the nodeset containing that single node.
1602 On success this returns a pair containing the
1603 number of nodes in the nodeset, and a boolean flag
1604 if a node was created.");
1606 ("aug_get", (RString "val", [String "augpath"]), 19, [Optional "augeas"],
1607 [], (* XXX Augeas code needs tests. *)
1608 "look up the value of an Augeas path",
1610 Look up the value associated with C<path>. If C<path>
1611 matches exactly one node, the C<value> is returned.");
1613 ("aug_set", (RErr, [String "augpath"; String "val"]), 20, [Optional "augeas"],
1614 [], (* XXX Augeas code needs tests. *)
1615 "set Augeas path to value",
1617 Set the value associated with C<path> to C<val>.
1619 In the Augeas API, it is possible to clear a node by setting
1620 the value to NULL. Due to an oversight in the libguestfs API
1621 you cannot do that with this call. Instead you must use the
1622 C<guestfs_aug_clear> call.");
1624 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"]), 21, [Optional "augeas"],
1625 [], (* XXX Augeas code needs tests. *)
1626 "insert a sibling Augeas node",
1628 Create a new sibling C<label> for C<path>, inserting it into
1629 the tree before or after C<path> (depending on the boolean
1632 C<path> must match exactly one existing node in the tree, and
1633 C<label> must be a label, ie. not contain C</>, C<*> or end
1634 with a bracketed index C<[N]>.");
1636 ("aug_rm", (RInt "nrnodes", [String "augpath"]), 22, [Optional "augeas"],
1637 [], (* XXX Augeas code needs tests. *)
1638 "remove an Augeas path",
1640 Remove C<path> and all of its children.
1642 On success this returns the number of entries which were removed.");
1644 ("aug_mv", (RErr, [String "src"; String "dest"]), 23, [Optional "augeas"],
1645 [], (* XXX Augeas code needs tests. *)
1648 Move the node C<src> to C<dest>. C<src> must match exactly
1649 one node. C<dest> is overwritten if it exists.");
1651 ("aug_match", (RStringList "matches", [String "augpath"]), 24, [Optional "augeas"],
1652 [], (* XXX Augeas code needs tests. *)
1653 "return Augeas nodes which match augpath",
1655 Returns a list of paths which match the path expression C<path>.
1656 The returned paths are sufficiently qualified so that they match
1657 exactly one node in the current tree.");
1659 ("aug_save", (RErr, []), 25, [Optional "augeas"],
1660 [], (* XXX Augeas code needs tests. *)
1661 "write all pending Augeas changes to disk",
1663 This writes all pending changes to disk.
1665 The flags which were passed to C<guestfs_aug_init> affect exactly
1666 how files are saved.");
1668 ("aug_load", (RErr, []), 27, [Optional "augeas"],
1669 [], (* XXX Augeas code needs tests. *)
1670 "load files into the tree",
1672 Load files into the tree.
1674 See C<aug_load> in the Augeas documentation for the full gory
1677 ("aug_ls", (RStringList "matches", [String "augpath"]), 28, [Optional "augeas"],
1678 [], (* XXX Augeas code needs tests. *)
1679 "list Augeas nodes under augpath",
1681 This is just a shortcut for listing C<guestfs_aug_match>
1682 C<path/*> and sorting the resulting nodes into alphabetical order.");
1684 ("rm", (RErr, [Pathname "path"]), 29, [],
1685 [InitBasicFS, Always, TestRun
1688 InitBasicFS, Always, TestLastFail
1690 InitBasicFS, Always, TestLastFail
1695 Remove the single file C<path>.");
1697 ("rmdir", (RErr, [Pathname "path"]), 30, [],
1698 [InitBasicFS, Always, TestRun
1701 InitBasicFS, Always, TestLastFail
1702 [["rmdir"; "/new"]];
1703 InitBasicFS, Always, TestLastFail
1705 ["rmdir"; "/new"]]],
1706 "remove a directory",
1708 Remove the single directory C<path>.");
1710 ("rm_rf", (RErr, [Pathname "path"]), 31, [],
1711 [InitBasicFS, Always, TestOutputFalse
1713 ["mkdir"; "/new/foo"];
1714 ["touch"; "/new/foo/bar"];
1716 ["exists"; "/new"]]],
1717 "remove a file or directory recursively",
1719 Remove the file or directory C<path>, recursively removing the
1720 contents if its a directory. This is like the C<rm -rf> shell
1723 ("mkdir", (RErr, [Pathname "path"]), 32, [],
1724 [InitBasicFS, Always, TestOutputTrue
1726 ["is_dir"; "/new"]];
1727 InitBasicFS, Always, TestLastFail
1728 [["mkdir"; "/new/foo/bar"]]],
1729 "create a directory",
1731 Create a directory named C<path>.");
1733 ("mkdir_p", (RErr, [Pathname "path"]), 33, [],
1734 [InitBasicFS, Always, TestOutputTrue
1735 [["mkdir_p"; "/new/foo/bar"];
1736 ["is_dir"; "/new/foo/bar"]];
1737 InitBasicFS, Always, TestOutputTrue
1738 [["mkdir_p"; "/new/foo/bar"];
1739 ["is_dir"; "/new/foo"]];
1740 InitBasicFS, Always, TestOutputTrue
1741 [["mkdir_p"; "/new/foo/bar"];
1742 ["is_dir"; "/new"]];
1743 (* Regression tests for RHBZ#503133: *)
1744 InitBasicFS, Always, TestRun
1746 ["mkdir_p"; "/new"]];
1747 InitBasicFS, Always, TestLastFail
1749 ["mkdir_p"; "/new"]]],
1750 "create a directory and parents",
1752 Create a directory named C<path>, creating any parent directories
1753 as necessary. This is like the C<mkdir -p> shell command.");
1755 ("chmod", (RErr, [Int "mode"; Pathname "path"]), 34, [],
1756 [], (* XXX Need stat command to test *)
1759 Change the mode (permissions) of C<path> to C<mode>. Only
1760 numeric modes are supported.
1762 I<Note>: When using this command from guestfish, C<mode>
1763 by default would be decimal, unless you prefix it with
1764 C<0> to get octal, ie. use C<0700> not C<700>.
1766 The mode actually set is affected by the umask.");
1768 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"]), 35, [],
1769 [], (* XXX Need stat command to test *)
1770 "change file owner and group",
1772 Change the file owner to C<owner> and group to C<group>.
1774 Only numeric uid and gid are supported. If you want to use
1775 names, you will need to locate and parse the password file
1776 yourself (Augeas support makes this relatively easy).");
1778 ("exists", (RBool "existsflag", [Pathname "path"]), 36, [],
1779 [InitISOFS, Always, TestOutputTrue (
1780 [["exists"; "/empty"]]);
1781 InitISOFS, Always, TestOutputTrue (
1782 [["exists"; "/directory"]])],
1783 "test if file or directory exists",
1785 This returns C<true> if and only if there is a file, directory
1786 (or anything) with the given C<path> name.
1788 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1790 ("is_file", (RBool "fileflag", [Pathname "path"]), 37, [],
1791 [InitISOFS, Always, TestOutputTrue (
1792 [["is_file"; "/known-1"]]);
1793 InitISOFS, Always, TestOutputFalse (
1794 [["is_file"; "/directory"]])],
1795 "test if file exists",
1797 This returns C<true> if and only if there is a file
1798 with the given C<path> name. Note that it returns false for
1799 other objects like directories.
1801 See also C<guestfs_stat>.");
1803 ("is_dir", (RBool "dirflag", [Pathname "path"]), 38, [],
1804 [InitISOFS, Always, TestOutputFalse (
1805 [["is_dir"; "/known-3"]]);
1806 InitISOFS, Always, TestOutputTrue (
1807 [["is_dir"; "/directory"]])],
1808 "test if file exists",
1810 This returns C<true> if and only if there is a directory
1811 with the given C<path> name. Note that it returns false for
1812 other objects like files.
1814 See also C<guestfs_stat>.");
1816 ("pvcreate", (RErr, [Device "device"]), 39, [Optional "lvm2"],
1817 [InitEmpty, Always, TestOutputListOfDevices (
1818 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1819 ["pvcreate"; "/dev/sda1"];
1820 ["pvcreate"; "/dev/sda2"];
1821 ["pvcreate"; "/dev/sda3"];
1822 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1823 "create an LVM physical volume",
1825 This creates an LVM physical volume on the named C<device>,
1826 where C<device> should usually be a partition name such
1829 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"]), 40, [Optional "lvm2"],
1830 [InitEmpty, Always, TestOutputList (
1831 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1832 ["pvcreate"; "/dev/sda1"];
1833 ["pvcreate"; "/dev/sda2"];
1834 ["pvcreate"; "/dev/sda3"];
1835 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1836 ["vgcreate"; "VG2"; "/dev/sda3"];
1837 ["vgs"]], ["VG1"; "VG2"])],
1838 "create an LVM volume group",
1840 This creates an LVM volume group called C<volgroup>
1841 from the non-empty list of physical volumes C<physvols>.");
1843 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"]), 41, [Optional "lvm2"],
1844 [InitEmpty, Always, TestOutputList (
1845 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1846 ["pvcreate"; "/dev/sda1"];
1847 ["pvcreate"; "/dev/sda2"];
1848 ["pvcreate"; "/dev/sda3"];
1849 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1850 ["vgcreate"; "VG2"; "/dev/sda3"];
1851 ["lvcreate"; "LV1"; "VG1"; "50"];
1852 ["lvcreate"; "LV2"; "VG1"; "50"];
1853 ["lvcreate"; "LV3"; "VG2"; "50"];
1854 ["lvcreate"; "LV4"; "VG2"; "50"];
1855 ["lvcreate"; "LV5"; "VG2"; "50"];
1857 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1858 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1859 "create an LVM logical volume",
1861 This creates an LVM logical volume called C<logvol>
1862 on the volume group C<volgroup>, with C<size> megabytes.");
1864 ("mkfs", (RErr, [String "fstype"; Device "device"]), 42, [],
1865 [InitEmpty, Always, TestOutput (
1866 [["part_disk"; "/dev/sda"; "mbr"];
1867 ["mkfs"; "ext2"; "/dev/sda1"];
1868 ["mount_options"; ""; "/dev/sda1"; "/"];
1869 ["write"; "/new"; "new file contents"];
1870 ["cat"; "/new"]], "new file contents")],
1871 "make a filesystem",
1873 This creates a filesystem on C<device> (usually a partition
1874 or LVM logical volume). The filesystem type is C<fstype>, for
1877 ("sfdisk", (RErr, [Device "device";
1878 Int "cyls"; Int "heads"; Int "sectors";
1879 StringList "lines"]), 43, [DangerWillRobinson],
1881 "create partitions on a block device",
1883 This is a direct interface to the L<sfdisk(8)> program for creating
1884 partitions on block devices.
1886 C<device> should be a block device, for example C</dev/sda>.
1888 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1889 and sectors on the device, which are passed directly to sfdisk as
1890 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1891 of these, then the corresponding parameter is omitted. Usually for
1892 'large' disks, you can just pass C<0> for these, but for small
1893 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1894 out the right geometry and you will need to tell it.
1896 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1897 information refer to the L<sfdisk(8)> manpage.
1899 To create a single partition occupying the whole disk, you would
1900 pass C<lines> as a single element list, when the single element being
1901 the string C<,> (comma).
1903 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
1904 C<guestfs_part_init>");
1906 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"]), 44, [ProtocolLimitWarning; DeprecatedBy "write"],
1907 (* Regression test for RHBZ#597135. *)
1908 [InitBasicFS, Always, TestLastFail
1909 [["write_file"; "/new"; "abc"; "10000"]]],
1912 This call creates a file called C<path>. The contents of the
1913 file is the string C<content> (which can contain any 8 bit data),
1914 with length C<size>.
1916 As a special case, if C<size> is C<0>
1917 then the length is calculated using C<strlen> (so in this case
1918 the content cannot contain embedded ASCII NULs).
1920 I<NB.> Owing to a bug, writing content containing ASCII NUL
1921 characters does I<not> work, even if the length is specified.");
1923 ("umount", (RErr, [String "pathordevice"]), 45, [FishAlias "unmount"],
1924 [InitEmpty, Always, TestOutputListOfDevices (
1925 [["part_disk"; "/dev/sda"; "mbr"];
1926 ["mkfs"; "ext2"; "/dev/sda1"];
1927 ["mount_options"; ""; "/dev/sda1"; "/"];
1928 ["mounts"]], ["/dev/sda1"]);
1929 InitEmpty, Always, TestOutputList (
1930 [["part_disk"; "/dev/sda"; "mbr"];
1931 ["mkfs"; "ext2"; "/dev/sda1"];
1932 ["mount_options"; ""; "/dev/sda1"; "/"];
1935 "unmount a filesystem",
1937 This unmounts the given filesystem. The filesystem may be
1938 specified either by its mountpoint (path) or the device which
1939 contains the filesystem.");
1941 ("mounts", (RStringList "devices", []), 46, [],
1942 [InitBasicFS, Always, TestOutputListOfDevices (
1943 [["mounts"]], ["/dev/sda1"])],
1944 "show mounted filesystems",
1946 This returns the list of currently mounted filesystems. It returns
1947 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1949 Some internal mounts are not shown.
1951 See also: C<guestfs_mountpoints>");
1953 ("umount_all", (RErr, []), 47, [FishAlias "unmount-all"],
1954 [InitBasicFS, Always, TestOutputList (
1957 (* check that umount_all can unmount nested mounts correctly: *)
1958 InitEmpty, Always, TestOutputList (
1959 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1960 ["mkfs"; "ext2"; "/dev/sda1"];
1961 ["mkfs"; "ext2"; "/dev/sda2"];
1962 ["mkfs"; "ext2"; "/dev/sda3"];
1963 ["mount_options"; ""; "/dev/sda1"; "/"];
1965 ["mount_options"; ""; "/dev/sda2"; "/mp1"];
1966 ["mkdir"; "/mp1/mp2"];
1967 ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
1968 ["mkdir"; "/mp1/mp2/mp3"];
1971 "unmount all filesystems",
1973 This unmounts all mounted filesystems.
1975 Some internal mounts are not unmounted by this call.");
1977 ("lvm_remove_all", (RErr, []), 48, [DangerWillRobinson; Optional "lvm2"],
1979 "remove all LVM LVs, VGs and PVs",
1981 This command removes all LVM logical volumes, volume groups
1982 and physical volumes.");
1984 ("file", (RString "description", [Dev_or_Path "path"]), 49, [],
1985 [InitISOFS, Always, TestOutput (
1986 [["file"; "/empty"]], "empty");
1987 InitISOFS, Always, TestOutput (
1988 [["file"; "/known-1"]], "ASCII text");
1989 InitISOFS, Always, TestLastFail (
1990 [["file"; "/notexists"]]);
1991 InitISOFS, Always, TestOutput (
1992 [["file"; "/abssymlink"]], "symbolic link");
1993 InitISOFS, Always, TestOutput (
1994 [["file"; "/directory"]], "directory")],
1995 "determine file type",
1997 This call uses the standard L<file(1)> command to determine
1998 the type or contents of the file.
2000 This call will also transparently look inside various types
2003 The exact command which runs is C<file -zb path>. Note in
2004 particular that the filename is not prepended to the output
2007 This command can also be used on C</dev/> devices
2008 (and partitions, LV names). You can for example use this
2009 to determine if a device contains a filesystem, although
2010 it's usually better to use C<guestfs_vfs_type>.
2012 If the C<path> does not begin with C</dev/> then
2013 this command only works for the content of regular files.
2014 For other file types (directory, symbolic link etc) it
2015 will just return the string C<directory> etc.");
2017 ("command", (RString "output", [StringList "arguments"]), 50, [ProtocolLimitWarning],
2018 [InitBasicFS, Always, TestOutput (
2019 [["upload"; "test-command"; "/test-command"];
2020 ["chmod"; "0o755"; "/test-command"];
2021 ["command"; "/test-command 1"]], "Result1");
2022 InitBasicFS, Always, TestOutput (
2023 [["upload"; "test-command"; "/test-command"];
2024 ["chmod"; "0o755"; "/test-command"];
2025 ["command"; "/test-command 2"]], "Result2\n");
2026 InitBasicFS, Always, TestOutput (
2027 [["upload"; "test-command"; "/test-command"];
2028 ["chmod"; "0o755"; "/test-command"];
2029 ["command"; "/test-command 3"]], "\nResult3");
2030 InitBasicFS, Always, TestOutput (
2031 [["upload"; "test-command"; "/test-command"];
2032 ["chmod"; "0o755"; "/test-command"];
2033 ["command"; "/test-command 4"]], "\nResult4\n");
2034 InitBasicFS, Always, TestOutput (
2035 [["upload"; "test-command"; "/test-command"];
2036 ["chmod"; "0o755"; "/test-command"];
2037 ["command"; "/test-command 5"]], "\nResult5\n\n");
2038 InitBasicFS, Always, TestOutput (
2039 [["upload"; "test-command"; "/test-command"];
2040 ["chmod"; "0o755"; "/test-command"];
2041 ["command"; "/test-command 6"]], "\n\nResult6\n\n");
2042 InitBasicFS, Always, TestOutput (
2043 [["upload"; "test-command"; "/test-command"];
2044 ["chmod"; "0o755"; "/test-command"];
2045 ["command"; "/test-command 7"]], "");
2046 InitBasicFS, Always, TestOutput (
2047 [["upload"; "test-command"; "/test-command"];
2048 ["chmod"; "0o755"; "/test-command"];
2049 ["command"; "/test-command 8"]], "\n");
2050 InitBasicFS, Always, TestOutput (
2051 [["upload"; "test-command"; "/test-command"];
2052 ["chmod"; "0o755"; "/test-command"];
2053 ["command"; "/test-command 9"]], "\n\n");
2054 InitBasicFS, Always, TestOutput (
2055 [["upload"; "test-command"; "/test-command"];
2056 ["chmod"; "0o755"; "/test-command"];
2057 ["command"; "/test-command 10"]], "Result10-1\nResult10-2\n");
2058 InitBasicFS, Always, TestOutput (
2059 [["upload"; "test-command"; "/test-command"];
2060 ["chmod"; "0o755"; "/test-command"];
2061 ["command"; "/test-command 11"]], "Result11-1\nResult11-2");
2062 InitBasicFS, Always, TestLastFail (
2063 [["upload"; "test-command"; "/test-command"];
2064 ["chmod"; "0o755"; "/test-command"];
2065 ["command"; "/test-command"]])],
2066 "run a command from the guest filesystem",
2068 This call runs a command from the guest filesystem. The
2069 filesystem must be mounted, and must contain a compatible
2070 operating system (ie. something Linux, with the same
2071 or compatible processor architecture).
2073 The single parameter is an argv-style list of arguments.
2074 The first element is the name of the program to run.
2075 Subsequent elements are parameters. The list must be
2076 non-empty (ie. must contain a program name). Note that
2077 the command runs directly, and is I<not> invoked via
2078 the shell (see C<guestfs_sh>).
2080 The return value is anything printed to I<stdout> by
2083 If the command returns a non-zero exit status, then
2084 this function returns an error message. The error message
2085 string is the content of I<stderr> from the command.
2087 The C<$PATH> environment variable will contain at least
2088 C</usr/bin> and C</bin>. If you require a program from
2089 another location, you should provide the full path in the
2092 Shared libraries and data files required by the program
2093 must be available on filesystems which are mounted in the
2094 correct places. It is the caller's responsibility to ensure
2095 all filesystems that are needed are mounted at the right
2098 ("command_lines", (RStringList "lines", [StringList "arguments"]), 51, [ProtocolLimitWarning],
2099 [InitBasicFS, Always, TestOutputList (
2100 [["upload"; "test-command"; "/test-command"];
2101 ["chmod"; "0o755"; "/test-command"];
2102 ["command_lines"; "/test-command 1"]], ["Result1"]);
2103 InitBasicFS, Always, TestOutputList (
2104 [["upload"; "test-command"; "/test-command"];
2105 ["chmod"; "0o755"; "/test-command"];
2106 ["command_lines"; "/test-command 2"]], ["Result2"]);
2107 InitBasicFS, Always, TestOutputList (
2108 [["upload"; "test-command"; "/test-command"];
2109 ["chmod"; "0o755"; "/test-command"];
2110 ["command_lines"; "/test-command 3"]], ["";"Result3"]);
2111 InitBasicFS, Always, TestOutputList (
2112 [["upload"; "test-command"; "/test-command"];
2113 ["chmod"; "0o755"; "/test-command"];
2114 ["command_lines"; "/test-command 4"]], ["";"Result4"]);
2115 InitBasicFS, Always, TestOutputList (
2116 [["upload"; "test-command"; "/test-command"];
2117 ["chmod"; "0o755"; "/test-command"];
2118 ["command_lines"; "/test-command 5"]], ["";"Result5";""]);
2119 InitBasicFS, Always, TestOutputList (
2120 [["upload"; "test-command"; "/test-command"];
2121 ["chmod"; "0o755"; "/test-command"];
2122 ["command_lines"; "/test-command 6"]], ["";"";"Result6";""]);
2123 InitBasicFS, Always, TestOutputList (
2124 [["upload"; "test-command"; "/test-command"];
2125 ["chmod"; "0o755"; "/test-command"];
2126 ["command_lines"; "/test-command 7"]], []);
2127 InitBasicFS, Always, TestOutputList (
2128 [["upload"; "test-command"; "/test-command"];
2129 ["chmod"; "0o755"; "/test-command"];
2130 ["command_lines"; "/test-command 8"]], [""]);
2131 InitBasicFS, Always, TestOutputList (
2132 [["upload"; "test-command"; "/test-command"];
2133 ["chmod"; "0o755"; "/test-command"];
2134 ["command_lines"; "/test-command 9"]], ["";""]);
2135 InitBasicFS, Always, TestOutputList (
2136 [["upload"; "test-command"; "/test-command"];
2137 ["chmod"; "0o755"; "/test-command"];
2138 ["command_lines"; "/test-command 10"]], ["Result10-1";"Result10-2"]);
2139 InitBasicFS, Always, TestOutputList (
2140 [["upload"; "test-command"; "/test-command"];
2141 ["chmod"; "0o755"; "/test-command"];
2142 ["command_lines"; "/test-command 11"]], ["Result11-1";"Result11-2"])],
2143 "run a command, returning lines",
2145 This is the same as C<guestfs_command>, but splits the
2146 result into a list of lines.
2148 See also: C<guestfs_sh_lines>");
2150 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"]), 52, [],
2151 [InitISOFS, Always, TestOutputStruct (
2152 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
2153 "get file information",
2155 Returns file information for the given C<path>.
2157 This is the same as the C<stat(2)> system call.");
2159 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"]), 53, [],
2160 [InitISOFS, Always, TestOutputStruct (
2161 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
2162 "get file information for a symbolic link",
2164 Returns file information for the given C<path>.
2166 This is the same as C<guestfs_stat> except that if C<path>
2167 is a symbolic link, then the link is stat-ed, not the file it
2170 This is the same as the C<lstat(2)> system call.");
2172 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"]), 54, [],
2173 [InitISOFS, Always, TestOutputStruct (
2174 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
2175 "get file system statistics",
2177 Returns file system statistics for any mounted file system.
2178 C<path> should be a file or directory in the mounted file system
2179 (typically it is the mount point itself, but it doesn't need to be).
2181 This is the same as the C<statvfs(2)> system call.");
2183 ("tune2fs_l", (RHashtable "superblock", [Device "device"]), 55, [],
2185 "get ext2/ext3/ext4 superblock details",
2187 This returns the contents of the ext2, ext3 or ext4 filesystem
2188 superblock on C<device>.
2190 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
2191 manpage for more details. The list of fields returned isn't
2192 clearly defined, and depends on both the version of C<tune2fs>
2193 that libguestfs was built against, and the filesystem itself.");
2195 ("blockdev_setro", (RErr, [Device "device"]), 56, [],
2196 [InitEmpty, Always, TestOutputTrue (
2197 [["blockdev_setro"; "/dev/sda"];
2198 ["blockdev_getro"; "/dev/sda"]])],
2199 "set block device to read-only",
2201 Sets the block device named C<device> to read-only.
2203 This uses the L<blockdev(8)> command.");
2205 ("blockdev_setrw", (RErr, [Device "device"]), 57, [],
2206 [InitEmpty, Always, TestOutputFalse (
2207 [["blockdev_setrw"; "/dev/sda"];
2208 ["blockdev_getro"; "/dev/sda"]])],
2209 "set block device to read-write",
2211 Sets the block device named C<device> to read-write.
2213 This uses the L<blockdev(8)> command.");
2215 ("blockdev_getro", (RBool "ro", [Device "device"]), 58, [],
2216 [InitEmpty, Always, TestOutputTrue (
2217 [["blockdev_setro"; "/dev/sda"];
2218 ["blockdev_getro"; "/dev/sda"]])],
2219 "is block device set to read-only",
2221 Returns a boolean indicating if the block device is read-only
2222 (true if read-only, false if not).
2224 This uses the L<blockdev(8)> command.");
2226 ("blockdev_getss", (RInt "sectorsize", [Device "device"]), 59, [],
2227 [InitEmpty, Always, TestOutputInt (
2228 [["blockdev_getss"; "/dev/sda"]], 512)],
2229 "get sectorsize of block device",
2231 This returns the size of sectors on a block device.
2232 Usually 512, but can be larger for modern devices.
2234 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
2237 This uses the L<blockdev(8)> command.");
2239 ("blockdev_getbsz", (RInt "blocksize", [Device "device"]), 60, [],
2240 [InitEmpty, Always, TestOutputInt (
2241 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
2242 "get blocksize of block device",
2244 This returns the block size of a device.
2246 (Note this is different from both I<size in blocks> and
2247 I<filesystem block size>).
2249 This uses the L<blockdev(8)> command.");
2251 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"]), 61, [],
2253 "set blocksize of block device",
2255 This sets the block size of a device.
2257 (Note this is different from both I<size in blocks> and
2258 I<filesystem block size>).
2260 This uses the L<blockdev(8)> command.");
2262 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"]), 62, [],
2263 [InitEmpty, Always, TestOutputInt (
2264 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
2265 "get total size of device in 512-byte sectors",
2267 This returns the size of the device in units of 512-byte sectors
2268 (even if the sectorsize isn't 512 bytes ... weird).
2270 See also C<guestfs_blockdev_getss> for the real sector size of
2271 the device, and C<guestfs_blockdev_getsize64> for the more
2272 useful I<size in bytes>.
2274 This uses the L<blockdev(8)> command.");
2276 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"]), 63, [],
2277 [InitEmpty, Always, TestOutputInt (
2278 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
2279 "get total size of device in bytes",
2281 This returns the size of the device in bytes.
2283 See also C<guestfs_blockdev_getsz>.
2285 This uses the L<blockdev(8)> command.");
2287 ("blockdev_flushbufs", (RErr, [Device "device"]), 64, [],
2288 [InitEmpty, Always, TestRun
2289 [["blockdev_flushbufs"; "/dev/sda"]]],
2290 "flush device buffers",
2292 This tells the kernel to flush internal buffers associated
2295 This uses the L<blockdev(8)> command.");
2297 ("blockdev_rereadpt", (RErr, [Device "device"]), 65, [],
2298 [InitEmpty, Always, TestRun
2299 [["blockdev_rereadpt"; "/dev/sda"]]],
2300 "reread partition table",
2302 Reread the partition table on C<device>.
2304 This uses the L<blockdev(8)> command.");
2306 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"]), 66, [],
2307 [InitBasicFS, Always, TestOutput (
2308 (* Pick a file from cwd which isn't likely to change. *)
2309 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
2310 ["checksum"; "md5"; "/COPYING.LIB"]],
2311 Digest.to_hex (Digest.file "COPYING.LIB"))],
2312 "upload a file from the local machine",
2314 Upload local file C<filename> to C<remotefilename> on the
2317 C<filename> can also be a named pipe.
2319 See also C<guestfs_download>.");
2321 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"]), 67, [],
2322 [InitBasicFS, Always, TestOutput (
2323 (* Pick a file from cwd which isn't likely to change. *)
2324 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
2325 ["download"; "/COPYING.LIB"; "testdownload.tmp"];
2326 ["upload"; "testdownload.tmp"; "/upload"];
2327 ["checksum"; "md5"; "/upload"]],
2328 Digest.to_hex (Digest.file "COPYING.LIB"))],
2329 "download a file to the local machine",
2331 Download file C<remotefilename> and save it as C<filename>
2332 on the local machine.
2334 C<filename> can also be a named pipe.
2336 See also C<guestfs_upload>, C<guestfs_cat>.");
2338 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"]), 68, [],
2339 [InitISOFS, Always, TestOutput (
2340 [["checksum"; "crc"; "/known-3"]], "2891671662");
2341 InitISOFS, Always, TestLastFail (
2342 [["checksum"; "crc"; "/notexists"]]);
2343 InitISOFS, Always, TestOutput (
2344 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
2345 InitISOFS, Always, TestOutput (
2346 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
2347 InitISOFS, Always, TestOutput (
2348 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
2349 InitISOFS, Always, TestOutput (
2350 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
2351 InitISOFS, Always, TestOutput (
2352 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
2353 InitISOFS, Always, TestOutput (
2354 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
2355 (* Test for RHBZ#579608, absolute symbolic links. *)
2356 InitISOFS, Always, TestOutput (
2357 [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
2358 "compute MD5, SHAx or CRC checksum of file",
2360 This call computes the MD5, SHAx or CRC checksum of the
2363 The type of checksum to compute is given by the C<csumtype>
2364 parameter which must have one of the following values:
2370 Compute the cyclic redundancy check (CRC) specified by POSIX
2371 for the C<cksum> command.
2375 Compute the MD5 hash (using the C<md5sum> program).
2379 Compute the SHA1 hash (using the C<sha1sum> program).
2383 Compute the SHA224 hash (using the C<sha224sum> program).
2387 Compute the SHA256 hash (using the C<sha256sum> program).
2391 Compute the SHA384 hash (using the C<sha384sum> program).
2395 Compute the SHA512 hash (using the C<sha512sum> program).
2399 The checksum is returned as a printable string.
2401 To get the checksum for a device, use C<guestfs_checksum_device>.
2403 To get the checksums for many files, use C<guestfs_checksums_out>.");
2405 ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"]), 69, [],
2406 [InitBasicFS, Always, TestOutput (
2407 [["tar_in"; "../images/helloworld.tar"; "/"];
2408 ["cat"; "/hello"]], "hello\n")],
2409 "unpack tarfile to directory",
2411 This command uploads and unpacks local file C<tarfile> (an
2412 I<uncompressed> tar file) into C<directory>.
2414 To upload a compressed tarball, use C<guestfs_tgz_in>
2415 or C<guestfs_txz_in>.");
2417 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"]), 70, [],
2419 "pack directory into tarfile",
2421 This command packs the contents of C<directory> and downloads
2422 it to local file C<tarfile>.
2424 To download a compressed tarball, use C<guestfs_tgz_out>
2425 or C<guestfs_txz_out>.");
2427 ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"]), 71, [],
2428 [InitBasicFS, Always, TestOutput (
2429 [["tgz_in"; "../images/helloworld.tar.gz"; "/"];
2430 ["cat"; "/hello"]], "hello\n")],
2431 "unpack compressed tarball to directory",
2433 This command uploads and unpacks local file C<tarball> (a
2434 I<gzip compressed> tar file) into C<directory>.
2436 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2438 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"]), 72, [],
2440 "pack directory into compressed tarball",
2442 This command packs the contents of C<directory> and downloads
2443 it to local file C<tarball>.
2445 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2447 ("mount_ro", (RErr, [Device "device"; String "mountpoint"]), 73, [],
2448 [InitBasicFS, Always, TestLastFail (
2450 ["mount_ro"; "/dev/sda1"; "/"];
2451 ["touch"; "/new"]]);
2452 InitBasicFS, Always, TestOutput (
2453 [["write"; "/new"; "data"];
2455 ["mount_ro"; "/dev/sda1"; "/"];
2456 ["cat"; "/new"]], "data")],
2457 "mount a guest disk, read-only",
2459 This is the same as the C<guestfs_mount> command, but it
2460 mounts the filesystem with the read-only (I<-o ro>) flag.");
2462 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"]), 74, [],
2464 "mount a guest disk with mount options",
2466 This is the same as the C<guestfs_mount> command, but it
2467 allows you to set the mount options as for the
2468 L<mount(8)> I<-o> flag.
2470 If the C<options> parameter is an empty string, then
2471 no options are passed (all options default to whatever
2472 the filesystem uses).");
2474 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"]), 75, [],
2476 "mount a guest disk with mount options and vfstype",
2478 This is the same as the C<guestfs_mount> command, but it
2479 allows you to set both the mount options and the vfstype
2480 as for the L<mount(8)> I<-o> and I<-t> flags.");
2482 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"]), 76, [],
2484 "debugging and internals",
2486 The C<guestfs_debug> command exposes some internals of
2487 C<guestfsd> (the guestfs daemon) that runs inside the
2490 There is no comprehensive help for this command. You have
2491 to look at the file C<daemon/debug.c> in the libguestfs source
2492 to find out what you can do.");
2494 ("lvremove", (RErr, [Device "device"]), 77, [Optional "lvm2"],
2495 [InitEmpty, Always, TestOutputList (
2496 [["part_disk"; "/dev/sda"; "mbr"];
2497 ["pvcreate"; "/dev/sda1"];
2498 ["vgcreate"; "VG"; "/dev/sda1"];
2499 ["lvcreate"; "LV1"; "VG"; "50"];
2500 ["lvcreate"; "LV2"; "VG"; "50"];
2501 ["lvremove"; "/dev/VG/LV1"];
2502 ["lvs"]], ["/dev/VG/LV2"]);
2503 InitEmpty, Always, TestOutputList (
2504 [["part_disk"; "/dev/sda"; "mbr"];
2505 ["pvcreate"; "/dev/sda1"];
2506 ["vgcreate"; "VG"; "/dev/sda1"];
2507 ["lvcreate"; "LV1"; "VG"; "50"];
2508 ["lvcreate"; "LV2"; "VG"; "50"];
2509 ["lvremove"; "/dev/VG"];
2511 InitEmpty, Always, TestOutputList (
2512 [["part_disk"; "/dev/sda"; "mbr"];
2513 ["pvcreate"; "/dev/sda1"];
2514 ["vgcreate"; "VG"; "/dev/sda1"];
2515 ["lvcreate"; "LV1"; "VG"; "50"];
2516 ["lvcreate"; "LV2"; "VG"; "50"];
2517 ["lvremove"; "/dev/VG"];
2519 "remove an LVM logical volume",
2521 Remove an LVM logical volume C<device>, where C<device> is
2522 the path to the LV, such as C</dev/VG/LV>.
2524 You can also remove all LVs in a volume group by specifying
2525 the VG name, C</dev/VG>.");
2527 ("vgremove", (RErr, [String "vgname"]), 78, [Optional "lvm2"],
2528 [InitEmpty, Always, TestOutputList (
2529 [["part_disk"; "/dev/sda"; "mbr"];
2530 ["pvcreate"; "/dev/sda1"];
2531 ["vgcreate"; "VG"; "/dev/sda1"];
2532 ["lvcreate"; "LV1"; "VG"; "50"];
2533 ["lvcreate"; "LV2"; "VG"; "50"];
2536 InitEmpty, Always, TestOutputList (
2537 [["part_disk"; "/dev/sda"; "mbr"];
2538 ["pvcreate"; "/dev/sda1"];
2539 ["vgcreate"; "VG"; "/dev/sda1"];
2540 ["lvcreate"; "LV1"; "VG"; "50"];
2541 ["lvcreate"; "LV2"; "VG"; "50"];
2544 "remove an LVM volume group",
2546 Remove an LVM volume group C<vgname>, (for example C<VG>).
2548 This also forcibly removes all logical volumes in the volume
2551 ("pvremove", (RErr, [Device "device"]), 79, [Optional "lvm2"],
2552 [InitEmpty, Always, TestOutputListOfDevices (
2553 [["part_disk"; "/dev/sda"; "mbr"];
2554 ["pvcreate"; "/dev/sda1"];
2555 ["vgcreate"; "VG"; "/dev/sda1"];
2556 ["lvcreate"; "LV1"; "VG"; "50"];
2557 ["lvcreate"; "LV2"; "VG"; "50"];
2559 ["pvremove"; "/dev/sda1"];
2561 InitEmpty, Always, TestOutputListOfDevices (
2562 [["part_disk"; "/dev/sda"; "mbr"];
2563 ["pvcreate"; "/dev/sda1"];
2564 ["vgcreate"; "VG"; "/dev/sda1"];
2565 ["lvcreate"; "LV1"; "VG"; "50"];
2566 ["lvcreate"; "LV2"; "VG"; "50"];
2568 ["pvremove"; "/dev/sda1"];
2570 InitEmpty, Always, TestOutputListOfDevices (
2571 [["part_disk"; "/dev/sda"; "mbr"];
2572 ["pvcreate"; "/dev/sda1"];
2573 ["vgcreate"; "VG"; "/dev/sda1"];
2574 ["lvcreate"; "LV1"; "VG"; "50"];
2575 ["lvcreate"; "LV2"; "VG"; "50"];
2577 ["pvremove"; "/dev/sda1"];
2579 "remove an LVM physical volume",
2581 This wipes a physical volume C<device> so that LVM will no longer
2584 The implementation uses the C<pvremove> command which refuses to
2585 wipe physical volumes that contain any volume groups, so you have
2586 to remove those first.");
2588 ("set_e2label", (RErr, [Device "device"; String "label"]), 80, [],
2589 [InitBasicFS, Always, TestOutput (
2590 [["set_e2label"; "/dev/sda1"; "testlabel"];
2591 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2592 "set the ext2/3/4 filesystem label",
2594 This sets the ext2/3/4 filesystem label of the filesystem on
2595 C<device> to C<label>. Filesystem labels are limited to
2598 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2599 to return the existing label on a filesystem.");
2601 ("get_e2label", (RString "label", [Device "device"]), 81, [DeprecatedBy "vfs_label"],
2603 "get the ext2/3/4 filesystem label",
2605 This returns the ext2/3/4 filesystem label of the filesystem on
2608 ("set_e2uuid", (RErr, [Device "device"; String "uuid"]), 82, [],
2609 (let uuid = uuidgen () in
2610 [InitBasicFS, Always, TestOutput (
2611 [["set_e2uuid"; "/dev/sda1"; uuid];
2612 ["get_e2uuid"; "/dev/sda1"]], uuid);
2613 InitBasicFS, Always, TestOutput (
2614 [["set_e2uuid"; "/dev/sda1"; "clear"];
2615 ["get_e2uuid"; "/dev/sda1"]], "");
2616 (* We can't predict what UUIDs will be, so just check the commands run. *)
2617 InitBasicFS, Always, TestRun (
2618 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2619 InitBasicFS, Always, TestRun (
2620 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2621 "set the ext2/3/4 filesystem UUID",
2623 This sets the ext2/3/4 filesystem UUID of the filesystem on
2624 C<device> to C<uuid>. The format of the UUID and alternatives
2625 such as C<clear>, C<random> and C<time> are described in the
2626 L<tune2fs(8)> manpage.
2628 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2629 to return the existing UUID of a filesystem.");
2631 ("get_e2uuid", (RString "uuid", [Device "device"]), 83, [DeprecatedBy "vfs_uuid"],
2632 (* Regression test for RHBZ#597112. *)
2633 (let uuid = uuidgen () in
2634 [InitBasicFS, Always, TestOutput (
2635 [["mke2journal"; "1024"; "/dev/sdb"];
2636 ["set_e2uuid"; "/dev/sdb"; uuid];
2637 ["get_e2uuid"; "/dev/sdb"]], uuid)]),
2638 "get the ext2/3/4 filesystem UUID",
2640 This returns the ext2/3/4 filesystem UUID of the filesystem on
2643 ("fsck", (RInt "status", [String "fstype"; Device "device"]), 84, [FishOutput FishOutputHexadecimal],
2644 [InitBasicFS, Always, TestOutputInt (
2645 [["umount"; "/dev/sda1"];
2646 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2647 InitBasicFS, Always, TestOutputInt (
2648 [["umount"; "/dev/sda1"];
2649 ["zero"; "/dev/sda1"];
2650 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2651 "run the filesystem checker",
2653 This runs the filesystem checker (fsck) on C<device> which
2654 should have filesystem type C<fstype>.
2656 The returned integer is the status. See L<fsck(8)> for the
2657 list of status codes from C<fsck>.
2665 Multiple status codes can be summed together.
2669 A non-zero return code can mean \"success\", for example if
2670 errors have been corrected on the filesystem.
2674 Checking or repairing NTFS volumes is not supported
2679 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2681 ("zero", (RErr, [Device "device"]), 85, [],
2682 [InitBasicFS, Always, TestOutput (
2683 [["umount"; "/dev/sda1"];
2684 ["zero"; "/dev/sda1"];
2685 ["file"; "/dev/sda1"]], "data")],
2686 "write zeroes to the device",
2688 This command writes zeroes over the first few blocks of C<device>.
2690 How many blocks are zeroed isn't specified (but it's I<not> enough
2691 to securely wipe the device). It should be sufficient to remove
2692 any partition tables, filesystem superblocks and so on.
2694 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>.");
2696 ("grub_install", (RErr, [Pathname "root"; Device "device"]), 86, [],
2698 * https://bugzilla.redhat.com/show_bug.cgi?id=484986
2699 * https://bugzilla.redhat.com/show_bug.cgi?id=479760
2701 [InitBasicFS, Always, TestOutputTrue (
2702 [["mkdir_p"; "/boot/grub"];
2703 ["write"; "/boot/grub/device.map"; "(hd0) /dev/vda"];
2704 ["grub_install"; "/"; "/dev/vda"];
2705 ["is_dir"; "/boot"]])],
2708 This command installs GRUB (the Grand Unified Bootloader) on
2709 C<device>, with the root directory being C<root>.
2711 Note: If grub-install reports the error
2712 \"No suitable drive was found in the generated device map.\"
2713 it may be that you need to create a C</boot/grub/device.map>
2714 file first that contains the mapping between grub device names
2715 and Linux device names. It is usually sufficient to create
2720 replacing C</dev/vda> with the name of the installation device.");
2722 ("cp", (RErr, [Pathname "src"; Pathname "dest"]), 87, [],
2723 [InitBasicFS, Always, TestOutput (
2724 [["write"; "/old"; "file content"];
2725 ["cp"; "/old"; "/new"];
2726 ["cat"; "/new"]], "file content");
2727 InitBasicFS, Always, TestOutputTrue (
2728 [["write"; "/old"; "file content"];
2729 ["cp"; "/old"; "/new"];
2730 ["is_file"; "/old"]]);
2731 InitBasicFS, Always, TestOutput (
2732 [["write"; "/old"; "file content"];
2734 ["cp"; "/old"; "/dir/new"];
2735 ["cat"; "/dir/new"]], "file content")],
2738 This copies a file from C<src> to C<dest> where C<dest> is
2739 either a destination filename or destination directory.");
2741 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"]), 88, [],
2742 [InitBasicFS, Always, TestOutput (
2743 [["mkdir"; "/olddir"];
2744 ["mkdir"; "/newdir"];
2745 ["write"; "/olddir/file"; "file content"];
2746 ["cp_a"; "/olddir"; "/newdir"];
2747 ["cat"; "/newdir/olddir/file"]], "file content")],
2748 "copy a file or directory recursively",
2750 This copies a file or directory from C<src> to C<dest>
2751 recursively using the C<cp -a> command.");
2753 ("mv", (RErr, [Pathname "src"; Pathname "dest"]), 89, [],
2754 [InitBasicFS, Always, TestOutput (
2755 [["write"; "/old"; "file content"];
2756 ["mv"; "/old"; "/new"];
2757 ["cat"; "/new"]], "file content");
2758 InitBasicFS, Always, TestOutputFalse (
2759 [["write"; "/old"; "file content"];
2760 ["mv"; "/old"; "/new"];
2761 ["is_file"; "/old"]])],
2764 This moves a file from C<src> to C<dest> where C<dest> is
2765 either a destination filename or destination directory.");
2767 ("drop_caches", (RErr, [Int "whattodrop"]), 90, [],
2768 [InitEmpty, Always, TestRun (
2769 [["drop_caches"; "3"]])],
2770 "drop kernel page cache, dentries and inodes",
2772 This instructs the guest kernel to drop its page cache,
2773 and/or dentries and inode caches. The parameter C<whattodrop>
2774 tells the kernel what precisely to drop, see
2775 L<http://linux-mm.org/Drop_Caches>
2777 Setting C<whattodrop> to 3 should drop everything.
2779 This automatically calls L<sync(2)> before the operation,
2780 so that the maximum guest memory is freed.");
2782 ("dmesg", (RString "kmsgs", []), 91, [],
2783 [InitEmpty, Always, TestRun (
2785 "return kernel messages",
2787 This returns the kernel messages (C<dmesg> output) from
2788 the guest kernel. This is sometimes useful for extended
2789 debugging of problems.
2791 Another way to get the same information is to enable
2792 verbose messages with C<guestfs_set_verbose> or by setting
2793 the environment variable C<LIBGUESTFS_DEBUG=1> before
2794 running the program.");
2796 ("ping_daemon", (RErr, []), 92, [],
2797 [InitEmpty, Always, TestRun (
2798 [["ping_daemon"]])],
2799 "ping the guest daemon",
2801 This is a test probe into the guestfs daemon running inside
2802 the qemu subprocess. Calling this function checks that the
2803 daemon responds to the ping message, without affecting the daemon
2804 or attached block device(s) in any other way.");
2806 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"]), 93, [],
2807 [InitBasicFS, Always, TestOutputTrue (
2808 [["write"; "/file1"; "contents of a file"];
2809 ["cp"; "/file1"; "/file2"];
2810 ["equal"; "/file1"; "/file2"]]);
2811 InitBasicFS, Always, TestOutputFalse (
2812 [["write"; "/file1"; "contents of a file"];
2813 ["write"; "/file2"; "contents of another file"];
2814 ["equal"; "/file1"; "/file2"]]);
2815 InitBasicFS, Always, TestLastFail (
2816 [["equal"; "/file1"; "/file2"]])],
2817 "test if two files have equal contents",
2819 This compares the two files C<file1> and C<file2> and returns
2820 true if their content is exactly equal, or false otherwise.
2822 The external L<cmp(1)> program is used for the comparison.");
2824 ("strings", (RStringList "stringsout", [Pathname "path"]), 94, [ProtocolLimitWarning],
2825 [InitISOFS, Always, TestOutputList (
2826 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
2827 InitISOFS, Always, TestOutputList (
2828 [["strings"; "/empty"]], []);
2829 (* Test for RHBZ#579608, absolute symbolic links. *)
2830 InitISOFS, Always, TestRun (
2831 [["strings"; "/abssymlink"]])],
2832 "print the printable strings in a file",
2834 This runs the L<strings(1)> command on a file and returns
2835 the list of printable strings found.");
2837 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"]), 95, [ProtocolLimitWarning],
2838 [InitISOFS, Always, TestOutputList (
2839 [["strings_e"; "b"; "/known-5"]], []);
2840 InitBasicFS, Always, TestOutputList (
2841 [["write"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
2842 ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
2843 "print the printable strings in a file",
2845 This is like the C<guestfs_strings> command, but allows you to
2846 specify the encoding of strings that are looked for in
2847 the source file C<path>.
2849 Allowed encodings are:
2855 Single 7-bit-byte characters like ASCII and the ASCII-compatible
2856 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
2860 Single 8-bit-byte characters.
2864 16-bit big endian strings such as those encoded in
2865 UTF-16BE or UCS-2BE.
2867 =item l (lower case letter L)
2869 16-bit little endian such as UTF-16LE and UCS-2LE.
2870 This is useful for examining binaries in Windows guests.
2874 32-bit big endian such as UCS-4BE.
2878 32-bit little endian such as UCS-4LE.
2882 The returned strings are transcoded to UTF-8.");
2884 ("hexdump", (RString "dump", [Pathname "path"]), 96, [ProtocolLimitWarning],
2885 [InitISOFS, Always, TestOutput (
2886 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
2887 (* Test for RHBZ#501888c2 regression which caused large hexdump
2888 * commands to segfault.
2890 InitISOFS, Always, TestRun (
2891 [["hexdump"; "/100krandom"]]);
2892 (* Test for RHBZ#579608, absolute symbolic links. *)
2893 InitISOFS, Always, TestRun (
2894 [["hexdump"; "/abssymlink"]])],
2895 "dump a file in hexadecimal",
2897 This runs C<hexdump -C> on the given C<path>. The result is
2898 the human-readable, canonical hex dump of the file.");
2900 ("zerofree", (RErr, [Device "device"]), 97, [Optional "zerofree"],
2901 [InitNone, Always, TestOutput (
2902 [["part_disk"; "/dev/sda"; "mbr"];
2903 ["mkfs"; "ext3"; "/dev/sda1"];
2904 ["mount_options"; ""; "/dev/sda1"; "/"];
2905 ["write"; "/new"; "test file"];
2906 ["umount"; "/dev/sda1"];
2907 ["zerofree"; "/dev/sda1"];
2908 ["mount_options"; ""; "/dev/sda1"; "/"];
2909 ["cat"; "/new"]], "test file")],
2910 "zero unused inodes and disk blocks on ext2/3 filesystem",
2912 This runs the I<zerofree> program on C<device>. This program
2913 claims to zero unused inodes and disk blocks on an ext2/3
2914 filesystem, thus making it possible to compress the filesystem
2917 You should B<not> run this program if the filesystem is
2920 It is possible that using this program can damage the filesystem
2921 or data on the filesystem.");
2923 ("pvresize", (RErr, [Device "device"]), 98, [Optional "lvm2"],
2925 "resize an LVM physical volume",
2927 This resizes (expands or shrinks) an existing LVM physical
2928 volume to match the new size of the underlying device.");
2930 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
2931 Int "cyls"; Int "heads"; Int "sectors";
2932 String "line"]), 99, [DangerWillRobinson],
2934 "modify a single partition on a block device",
2936 This runs L<sfdisk(8)> option to modify just the single
2937 partition C<n> (note: C<n> counts from 1).
2939 For other parameters, see C<guestfs_sfdisk>. You should usually
2940 pass C<0> for the cyls/heads/sectors parameters.
2942 See also: C<guestfs_part_add>");
2944 ("sfdisk_l", (RString "partitions", [Device "device"]), 100, [],
2946 "display the partition table",
2948 This displays the partition table on C<device>, in the
2949 human-readable output of the L<sfdisk(8)> command. It is
2950 not intended to be parsed.
2952 See also: C<guestfs_part_list>");
2954 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"]), 101, [],
2956 "display the kernel geometry",
2958 This displays the kernel's idea of the geometry of C<device>.
2960 The result is in human-readable format, and not designed to
2963 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"]), 102, [],
2965 "display the disk geometry from the partition table",
2967 This displays the disk geometry of C<device> read from the
2968 partition table. Especially in the case where the underlying
2969 block device has been resized, this can be different from the
2970 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
2972 The result is in human-readable format, and not designed to
2975 ("vg_activate_all", (RErr, [Bool "activate"]), 103, [Optional "lvm2"],
2977 "activate or deactivate all volume groups",
2979 This command activates or (if C<activate> is false) deactivates
2980 all logical volumes in all volume groups.
2981 If activated, then they are made known to the
2982 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2983 then those devices disappear.
2985 This command is the same as running C<vgchange -a y|n>");
2987 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"]), 104, [Optional "lvm2"],
2989 "activate or deactivate some volume groups",
2991 This command activates or (if C<activate> is false) deactivates
2992 all logical volumes in the listed volume groups C<volgroups>.
2993 If activated, then they are made known to the
2994 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2995 then those devices disappear.
2997 This command is the same as running C<vgchange -a y|n volgroups...>
2999 Note that if C<volgroups> is an empty list then B<all> volume groups
3000 are activated or deactivated.");
3002 ("lvresize", (RErr, [Device "device"; Int "mbytes"]), 105, [Optional "lvm2"],
3003 [InitNone, Always, TestOutput (
3004 [["part_disk"; "/dev/sda"; "mbr"];
3005 ["pvcreate"; "/dev/sda1"];
3006 ["vgcreate"; "VG"; "/dev/sda1"];
3007 ["lvcreate"; "LV"; "VG"; "10"];
3008 ["mkfs"; "ext2"; "/dev/VG/LV"];
3009 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3010 ["write"; "/new"; "test content"];
3012 ["lvresize"; "/dev/VG/LV"; "20"];
3013 ["e2fsck_f"; "/dev/VG/LV"];
3014 ["resize2fs"; "/dev/VG/LV"];
3015 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3016 ["cat"; "/new"]], "test content");
3017 InitNone, Always, TestRun (
3018 (* Make an LV smaller to test RHBZ#587484. *)
3019 [["part_disk"; "/dev/sda"; "mbr"];
3020 ["pvcreate"; "/dev/sda1"];
3021 ["vgcreate"; "VG"; "/dev/sda1"];
3022 ["lvcreate"; "LV"; "VG"; "20"];
3023 ["lvresize"; "/dev/VG/LV"; "10"]])],
3024 "resize an LVM logical volume",
3026 This resizes (expands or shrinks) an existing LVM logical
3027 volume to C<mbytes>. When reducing, data in the reduced part
3030 ("resize2fs", (RErr, [Device "device"]), 106, [],
3031 [], (* lvresize tests this *)
3032 "resize an ext2, ext3 or ext4 filesystem",
3034 This resizes an ext2, ext3 or ext4 filesystem to match the size of
3035 the underlying device.
3037 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
3038 on the C<device> before calling this command. For unknown reasons
3039 C<resize2fs> sometimes gives an error about this and sometimes not.
3040 In any case, it is always safe to call C<guestfs_e2fsck_f> before
3041 calling this function.");
3043 ("find", (RStringList "names", [Pathname "directory"]), 107, [ProtocolLimitWarning],
3044 [InitBasicFS, Always, TestOutputList (
3045 [["find"; "/"]], ["lost+found"]);
3046 InitBasicFS, Always, TestOutputList (
3050 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
3051 InitBasicFS, Always, TestOutputList (
3052 [["mkdir_p"; "/a/b/c"];
3053 ["touch"; "/a/b/c/d"];
3054 ["find"; "/a/b/"]], ["c"; "c/d"])],
3055 "find all files and directories",
3057 This command lists out all files and directories, recursively,
3058 starting at C<directory>. It is essentially equivalent to
3059 running the shell command C<find directory -print> but some
3060 post-processing happens on the output, described below.
3062 This returns a list of strings I<without any prefix>. Thus
3063 if the directory structure was:
3069 then the returned list from C<guestfs_find> C</tmp> would be
3077 If C<directory> is not a directory, then this command returns
3080 The returned list is sorted.
3082 See also C<guestfs_find0>.");
3084 ("e2fsck_f", (RErr, [Device "device"]), 108, [],
3085 [], (* lvresize tests this *)
3086 "check an ext2/ext3 filesystem",
3088 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
3089 filesystem checker on C<device>, noninteractively (C<-p>),
3090 even if the filesystem appears to be clean (C<-f>).
3092 This command is only needed because of C<guestfs_resize2fs>
3093 (q.v.). Normally you should use C<guestfs_fsck>.");
3095 ("sleep", (RErr, [Int "secs"]), 109, [],
3096 [InitNone, Always, TestRun (
3098 "sleep for some seconds",
3100 Sleep for C<secs> seconds.");
3102 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"]), 110, [Optional "ntfs3g"],
3103 [InitNone, Always, TestOutputInt (
3104 [["part_disk"; "/dev/sda"; "mbr"];
3105 ["mkfs"; "ntfs"; "/dev/sda1"];
3106 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
3107 InitNone, Always, TestOutputInt (
3108 [["part_disk"; "/dev/sda"; "mbr"];
3109 ["mkfs"; "ext2"; "/dev/sda1"];
3110 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
3111 "probe NTFS volume",
3113 This command runs the L<ntfs-3g.probe(8)> command which probes
3114 an NTFS C<device> for mountability. (Not all NTFS volumes can
3115 be mounted read-write, and some cannot be mounted at all).
3117 C<rw> is a boolean flag. Set it to true if you want to test
3118 if the volume can be mounted read-write. Set it to false if
3119 you want to test if the volume can be mounted read-only.
3121 The return value is an integer which C<0> if the operation
3122 would succeed, or some non-zero value documented in the
3123 L<ntfs-3g.probe(8)> manual page.");
3125 ("sh", (RString "output", [String "command"]), 111, [],
3126 [], (* XXX needs tests *)
3127 "run a command via the shell",
3129 This call runs a command from the guest filesystem via the
3132 This is like C<guestfs_command>, but passes the command to:
3134 /bin/sh -c \"command\"
3136 Depending on the guest's shell, this usually results in
3137 wildcards being expanded, shell expressions being interpolated
3140 All the provisos about C<guestfs_command> apply to this call.");
3142 ("sh_lines", (RStringList "lines", [String "command"]), 112, [],
3143 [], (* XXX needs tests *)
3144 "run a command via the shell returning lines",
3146 This is the same as C<guestfs_sh>, but splits the result
3147 into a list of lines.
3149 See also: C<guestfs_command_lines>");
3151 ("glob_expand", (RStringList "paths", [Pathname "pattern"]), 113, [],
3152 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
3153 * code in stubs.c, since all valid glob patterns must start with "/".
3154 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
3156 [InitBasicFS, Always, TestOutputList (
3157 [["mkdir_p"; "/a/b/c"];
3158 ["touch"; "/a/b/c/d"];
3159 ["touch"; "/a/b/c/e"];
3160 ["glob_expand"; "/a/b/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
3161 InitBasicFS, Always, TestOutputList (
3162 [["mkdir_p"; "/a/b/c"];
3163 ["touch"; "/a/b/c/d"];
3164 ["touch"; "/a/b/c/e"];
3165 ["glob_expand"; "/a/*/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
3166 InitBasicFS, Always, TestOutputList (
3167 [["mkdir_p"; "/a/b/c"];
3168 ["touch"; "/a/b/c/d"];
3169 ["touch"; "/a/b/c/e"];
3170 ["glob_expand"; "/a/*/x/*"]], [])],
3171 "expand a wildcard path",
3173 This command searches for all the pathnames matching
3174 C<pattern> according to the wildcard expansion rules
3177 If no paths match, then this returns an empty list
3178 (note: not an error).
3180 It is just a wrapper around the C L<glob(3)> function
3181 with flags C<GLOB_MARK|GLOB_BRACE>.
3182 See that manual page for more details.");
3184 ("scrub_device", (RErr, [Device "device"]), 114, [DangerWillRobinson; Optional "scrub"],
3185 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
3186 [["scrub_device"; "/dev/sdc"]])],
3187 "scrub (securely wipe) a device",
3189 This command writes patterns over C<device> to make data retrieval
3192 It is an interface to the L<scrub(1)> program. See that
3193 manual page for more details.");
3195 ("scrub_file", (RErr, [Pathname "file"]), 115, [Optional "scrub"],
3196 [InitBasicFS, Always, TestRun (
3197 [["write"; "/file"; "content"];
3198 ["scrub_file"; "/file"]])],
3199 "scrub (securely wipe) a file",
3201 This command writes patterns over a file to make data retrieval
3204 The file is I<removed> after scrubbing.
3206 It is an interface to the L<scrub(1)> program. See that
3207 manual page for more details.");
3209 ("scrub_freespace", (RErr, [Pathname "dir"]), 116, [Optional "scrub"],
3210 [], (* XXX needs testing *)
3211 "scrub (securely wipe) free space",
3213 This command creates the directory C<dir> and then fills it
3214 with files until the filesystem is full, and scrubs the files
3215 as for C<guestfs_scrub_file>, and deletes them.
3216 The intention is to scrub any free space on the partition
3219 It is an interface to the L<scrub(1)> program. See that
3220 manual page for more details.");
3222 ("mkdtemp", (RString "dir", [Pathname "template"]), 117, [],
3223 [InitBasicFS, Always, TestRun (
3225 ["mkdtemp"; "/tmp/tmpXXXXXX"]])],
3226 "create a temporary directory",
3228 This command creates a temporary directory. The
3229 C<template> parameter should be a full pathname for the
3230 temporary directory name with the final six characters being
3233 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
3234 the second one being suitable for Windows filesystems.
3236 The name of the temporary directory that was created
3239 The temporary directory is created with mode 0700
3240 and is owned by root.
3242 The caller is responsible for deleting the temporary
3243 directory and its contents after use.
3245 See also: L<mkdtemp(3)>");
3247 ("wc_l", (RInt "lines", [Pathname "path"]), 118, [],
3248 [InitISOFS, Always, TestOutputInt (
3249 [["wc_l"; "/10klines"]], 10000);
3250 (* Test for RHBZ#579608, absolute symbolic links. *)
3251 InitISOFS, Always, TestOutputInt (
3252 [["wc_l"; "/abssymlink"]], 10000)],
3253 "count lines in a file",
3255 This command counts the lines in a file, using the
3256 C<wc -l> external command.");
3258 ("wc_w", (RInt "words", [Pathname "path"]), 119, [],
3259 [InitISOFS, Always, TestOutputInt (
3260 [["wc_w"; "/10klines"]], 10000)],
3261 "count words in a file",
3263 This command counts the words in a file, using the
3264 C<wc -w> external command.");
3266 ("wc_c", (RInt "chars", [Pathname "path"]), 120, [],
3267 [InitISOFS, Always, TestOutputInt (
3268 [["wc_c"; "/100kallspaces"]], 102400)],
3269 "count characters in a file",
3271 This command counts the characters in a file, using the
3272 C<wc -c> external command.");
3274 ("head", (RStringList "lines", [Pathname "path"]), 121, [ProtocolLimitWarning],
3275 [InitISOFS, Always, TestOutputList (
3276 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"]);
3277 (* Test for RHBZ#579608, absolute symbolic links. *)
3278 InitISOFS, Always, TestOutputList (
3279 [["head"; "/abssymlink"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
3280 "return first 10 lines of a file",
3282 This command returns up to the first 10 lines of a file as
3283 a list of strings.");
3285 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"]), 122, [ProtocolLimitWarning],
3286 [InitISOFS, Always, TestOutputList (
3287 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3288 InitISOFS, Always, TestOutputList (
3289 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3290 InitISOFS, Always, TestOutputList (
3291 [["head_n"; "0"; "/10klines"]], [])],
3292 "return first N lines of a file",
3294 If the parameter C<nrlines> is a positive number, this returns the first
3295 C<nrlines> lines of the file C<path>.
3297 If the parameter C<nrlines> is a negative number, this returns lines
3298 from the file C<path>, excluding the last C<nrlines> lines.
3300 If the parameter C<nrlines> is zero, this returns an empty list.");
3302 ("tail", (RStringList "lines", [Pathname "path"]), 123, [ProtocolLimitWarning],
3303 [InitISOFS, Always, TestOutputList (
3304 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
3305 "return last 10 lines of a file",
3307 This command returns up to the last 10 lines of a file as
3308 a list of strings.");
3310 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"]), 124, [ProtocolLimitWarning],
3311 [InitISOFS, Always, TestOutputList (
3312 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3313 InitISOFS, Always, TestOutputList (
3314 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3315 InitISOFS, Always, TestOutputList (
3316 [["tail_n"; "0"; "/10klines"]], [])],
3317 "return last N lines of a file",
3319 If the parameter C<nrlines> is a positive number, this returns the last
3320 C<nrlines> lines of the file C<path>.
3322 If the parameter C<nrlines> is a negative number, this returns lines
3323 from the file C<path>, starting with the C<-nrlines>th line.
3325 If the parameter C<nrlines> is zero, this returns an empty list.");
3327 ("df", (RString "output", []), 125, [],
3328 [], (* XXX Tricky to test because it depends on the exact format
3329 * of the 'df' command and other imponderables.
3331 "report file system disk space usage",
3333 This command runs the C<df> command to report disk space used.
3335 This command is mostly useful for interactive sessions. It
3336 is I<not> intended that you try to parse the output string.
3337 Use C<statvfs> from programs.");
3339 ("df_h", (RString "output", []), 126, [],
3340 [], (* XXX Tricky to test because it depends on the exact format
3341 * of the 'df' command and other imponderables.
3343 "report file system disk space usage (human readable)",
3345 This command runs the C<df -h> command to report disk space used
3346 in human-readable format.
3348 This command is mostly useful for interactive sessions. It
3349 is I<not> intended that you try to parse the output string.
3350 Use C<statvfs> from programs.");
3352 ("du", (RInt64 "sizekb", [Pathname "path"]), 127, [],
3353 [InitISOFS, Always, TestOutputInt (
3354 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
3355 "estimate file space usage",
3357 This command runs the C<du -s> command to estimate file space
3360 C<path> can be a file or a directory. If C<path> is a directory
3361 then the estimate includes the contents of the directory and all
3362 subdirectories (recursively).
3364 The result is the estimated size in I<kilobytes>
3365 (ie. units of 1024 bytes).");
3367 ("initrd_list", (RStringList "filenames", [Pathname "path"]), 128, [],
3368 [InitISOFS, Always, TestOutputList (
3369 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
3370 "list files in an initrd",
3372 This command lists out files contained in an initrd.
3374 The files are listed without any initial C</> character. The
3375 files are listed in the order they appear (not necessarily
3376 alphabetical). Directory names are listed as separate items.
3378 Old Linux kernels (2.4 and earlier) used a compressed ext2
3379 filesystem as initrd. We I<only> support the newer initramfs
3380 format (compressed cpio files).");
3382 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"]), 129, [],
3384 "mount a file using the loop device",
3386 This command lets you mount C<file> (a filesystem image
3387 in a file) on a mount point. It is entirely equivalent to
3388 the command C<mount -o loop file mountpoint>.");
3390 ("mkswap", (RErr, [Device "device"]), 130, [],
3391 [InitEmpty, Always, TestRun (
3392 [["part_disk"; "/dev/sda"; "mbr"];
3393 ["mkswap"; "/dev/sda1"]])],
3394 "create a swap partition",
3396 Create a swap partition on C<device>.");
3398 ("mkswap_L", (RErr, [String "label"; Device "device"]), 131, [],
3399 [InitEmpty, Always, TestRun (
3400 [["part_disk"; "/dev/sda"; "mbr"];
3401 ["mkswap_L"; "hello"; "/dev/sda1"]])],
3402 "create a swap partition with a label",
3404 Create a swap partition on C<device> with label C<label>.
3406 Note that you cannot attach a swap label to a block device
3407 (eg. C</dev/sda>), just to a partition. This appears to be
3408 a limitation of the kernel or swap tools.");
3410 ("mkswap_U", (RErr, [String "uuid"; Device "device"]), 132, [Optional "linuxfsuuid"],
3411 (let uuid = uuidgen () in
3412 [InitEmpty, Always, TestRun (
3413 [["part_disk"; "/dev/sda"; "mbr"];
3414 ["mkswap_U"; uuid; "/dev/sda1"]])]),
3415 "create a swap partition with an explicit UUID",
3417 Create a swap partition on C<device> with UUID C<uuid>.");
3419 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 133, [Optional "mknod"],
3420 [InitBasicFS, Always, TestOutputStruct (
3421 [["mknod"; "0o10777"; "0"; "0"; "/node"];
3422 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3423 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)]);
3424 InitBasicFS, Always, TestOutputStruct (
3425 [["mknod"; "0o60777"; "66"; "99"; "/node"];
3426 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3427 "make block, character or FIFO devices",
3429 This call creates block or character special devices, or
3430 named pipes (FIFOs).
3432 The C<mode> parameter should be the mode, using the standard
3433 constants. C<devmajor> and C<devminor> are the
3434 device major and minor numbers, only used when creating block
3435 and character special devices.
3437 Note that, just like L<mknod(2)>, the mode must be bitwise
3438 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3439 just creates a regular file). These constants are
3440 available in the standard Linux header files, or you can use
3441 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3442 which are wrappers around this command which bitwise OR
3443 in the appropriate constant for you.
3445 The mode actually set is affected by the umask.");
3447 ("mkfifo", (RErr, [Int "mode"; Pathname "path"]), 134, [Optional "mknod"],
3448 [InitBasicFS, Always, TestOutputStruct (
3449 [["mkfifo"; "0o777"; "/node"];
3450 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)])],
3451 "make FIFO (named pipe)",
3453 This call creates a FIFO (named pipe) called C<path> with
3454 mode C<mode>. It is just a convenient wrapper around
3457 The mode actually set is affected by the umask.");
3459 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 135, [Optional "mknod"],
3460 [InitBasicFS, Always, TestOutputStruct (
3461 [["mknod_b"; "0o777"; "99"; "66"; "/node"];
3462 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3463 "make block device node",
3465 This call creates a block device node called C<path> with
3466 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3467 It is just a convenient wrapper around C<guestfs_mknod>.
3469 The mode actually set is affected by the umask.");
3471 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 136, [Optional "mknod"],
3472 [InitBasicFS, Always, TestOutputStruct (
3473 [["mknod_c"; "0o777"; "99"; "66"; "/node"];
3474 ["stat"; "/node"]], [CompareWithInt ("mode", 0o20755)])],
3475 "make char device node",
3477 This call creates a char device node called C<path> with
3478 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3479 It is just a convenient wrapper around C<guestfs_mknod>.
3481 The mode actually set is affected by the umask.");
3483 ("umask", (RInt "oldmask", [Int "mask"]), 137, [FishOutput FishOutputOctal],
3484 [InitEmpty, Always, TestOutputInt (
3485 [["umask"; "0o22"]], 0o22)],
3486 "set file mode creation mask (umask)",
3488 This function sets the mask used for creating new files and
3489 device nodes to C<mask & 0777>.
3491 Typical umask values would be C<022> which creates new files
3492 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3493 C<002> which creates new files with permissions like
3494 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3496 The default umask is C<022>. This is important because it
3497 means that directories and device nodes will be created with
3498 C<0644> or C<0755> mode even if you specify C<0777>.
3500 See also C<guestfs_get_umask>,
3501 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3503 This call returns the previous umask.");
3505 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"]), 138, [],
3507 "read directories entries",
3509 This returns the list of directory entries in directory C<dir>.
3511 All entries in the directory are returned, including C<.> and
3512 C<..>. The entries are I<not> sorted, but returned in the same
3513 order as the underlying filesystem.
3515 Also this call returns basic file type information about each
3516 file. The C<ftyp> field will contain one of the following characters:
3554 The L<readdir(3)> call returned a C<d_type> field with an
3559 This function is primarily intended for use by programs. To
3560 get a simple list of names, use C<guestfs_ls>. To get a printable
3561 directory for human consumption, use C<guestfs_ll>.");
3563 ("sfdiskM", (RErr, [Device "device"; StringList "lines"]), 139, [DangerWillRobinson],
3565 "create partitions on a block device",
3567 This is a simplified interface to the C<guestfs_sfdisk>
3568 command, where partition sizes are specified in megabytes
3569 only (rounded to the nearest cylinder) and you don't need
3570 to specify the cyls, heads and sectors parameters which
3571 were rarely if ever used anyway.
3573 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3574 and C<guestfs_part_disk>");
3576 ("zfile", (RString "description", [String "meth"; Pathname "path"]), 140, [DeprecatedBy "file"],
3578 "determine file type inside a compressed file",
3580 This command runs C<file> after first decompressing C<path>
3583 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3585 Since 1.0.63, use C<guestfs_file> instead which can now
3586 process compressed files.");
3588 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"]), 141, [Optional "linuxxattrs"],
3590 "list extended attributes of a file or directory",
3592 This call lists the extended attributes of the file or directory
3595 At the system call level, this is a combination of the
3596 L<listxattr(2)> and L<getxattr(2)> calls.
3598 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3600 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"]), 142, [Optional "linuxxattrs"],
3602 "list extended attributes of a file or directory",
3604 This is the same as C<guestfs_getxattrs>, but if C<path>
3605 is a symbolic link, then it returns the extended attributes
3606 of the link itself.");
3608 ("setxattr", (RErr, [String "xattr";
3609 String "val"; Int "vallen"; (* will be BufferIn *)
3610 Pathname "path"]), 143, [Optional "linuxxattrs"],
3612 "set extended attribute of a file or directory",
3614 This call sets the extended attribute named C<xattr>
3615 of the file C<path> to the value C<val> (of length C<vallen>).
3616 The value is arbitrary 8 bit data.
3618 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3620 ("lsetxattr", (RErr, [String "xattr";
3621 String "val"; Int "vallen"; (* will be BufferIn *)
3622 Pathname "path"]), 144, [Optional "linuxxattrs"],
3624 "set extended attribute of a file or directory",
3626 This is the same as C<guestfs_setxattr>, but if C<path>
3627 is a symbolic link, then it sets an extended attribute
3628 of the link itself.");
3630 ("removexattr", (RErr, [String "xattr"; Pathname "path"]), 145, [Optional "linuxxattrs"],
3632 "remove extended attribute of a file or directory",
3634 This call removes the extended attribute named C<xattr>
3635 of the file C<path>.
3637 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3639 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"]), 146, [Optional "linuxxattrs"],
3641 "remove extended attribute of a file or directory",
3643 This is the same as C<guestfs_removexattr>, but if C<path>
3644 is a symbolic link, then it removes an extended attribute
3645 of the link itself.");
3647 ("mountpoints", (RHashtable "mps", []), 147, [],
3651 This call is similar to C<guestfs_mounts>. That call returns
3652 a list of devices. This one returns a hash table (map) of
3653 device name to directory where the device is mounted.");
3655 ("mkmountpoint", (RErr, [String "exemptpath"]), 148, [],
3656 (* This is a special case: while you would expect a parameter
3657 * of type "Pathname", that doesn't work, because it implies
3658 * NEED_ROOT in the generated calling code in stubs.c, and
3659 * this function cannot use NEED_ROOT.
3662 "create a mountpoint",
3664 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3665 specialized calls that can be used to create extra mountpoints
3666 before mounting the first filesystem.
3668 These calls are I<only> necessary in some very limited circumstances,
3669 mainly the case where you want to mount a mix of unrelated and/or
3670 read-only filesystems together.
3672 For example, live CDs often contain a \"Russian doll\" nest of
3673 filesystems, an ISO outer layer, with a squashfs image inside, with
3674 an ext2/3 image inside that. You can unpack this as follows
3677 add-ro Fedora-11-i686-Live.iso
3680 mkmountpoint /squash
3683 mount-loop /cd/LiveOS/squashfs.img /squash
3684 mount-loop /squash/LiveOS/ext3fs.img /ext3
3686 The inner filesystem is now unpacked under the /ext3 mountpoint.");
3688 ("rmmountpoint", (RErr, [String "exemptpath"]), 149, [],
3690 "remove a mountpoint",
3692 This calls removes a mountpoint that was previously created
3693 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
3694 for full details.");
3696 ("read_file", (RBufferOut "content", [Pathname "path"]), 150, [ProtocolLimitWarning],
3697 [InitISOFS, Always, TestOutputBuffer (
3698 [["read_file"; "/known-4"]], "abc\ndef\nghi");
3699 (* Test various near large, large and too large files (RHBZ#589039). *)
3700 InitBasicFS, Always, TestLastFail (
3702 ["truncate_size"; "/a"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
3703 ["read_file"; "/a"]]);
3704 InitBasicFS, Always, TestLastFail (
3706 ["truncate_size"; "/a"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
3707 ["read_file"; "/a"]]);
3708 InitBasicFS, Always, TestLastFail (
3710 ["truncate_size"; "/a"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
3711 ["read_file"; "/a"]])],
3714 This calls returns the contents of the file C<path> as a
3717 Unlike C<guestfs_cat>, this function can correctly
3718 handle files that contain embedded ASCII NUL characters.
3719 However unlike C<guestfs_download>, this function is limited
3720 in the total size of file that can be handled.");
3722 ("grep", (RStringList "lines", [String "regex"; Pathname "path"]), 151, [ProtocolLimitWarning],
3723 [InitISOFS, Always, TestOutputList (
3724 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3725 InitISOFS, Always, TestOutputList (
3726 [["grep"; "nomatch"; "/test-grep.txt"]], []);
3727 (* Test for RHBZ#579608, absolute symbolic links. *)
3728 InitISOFS, Always, TestOutputList (
3729 [["grep"; "nomatch"; "/abssymlink"]], [])],
3730 "return lines matching a pattern",
3732 This calls the external C<grep> program and returns the
3735 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"]), 152, [ProtocolLimitWarning],
3736 [InitISOFS, Always, TestOutputList (
3737 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3738 "return lines matching a pattern",
3740 This calls the external C<egrep> program and returns the
3743 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"]), 153, [ProtocolLimitWarning],
3744 [InitISOFS, Always, TestOutputList (
3745 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3746 "return lines matching a pattern",
3748 This calls the external C<fgrep> program and returns the
3751 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"]), 154, [ProtocolLimitWarning],
3752 [InitISOFS, Always, TestOutputList (
3753 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3754 "return lines matching a pattern",
3756 This calls the external C<grep -i> program and returns the
3759 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 155, [ProtocolLimitWarning],
3760 [InitISOFS, Always, TestOutputList (
3761 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3762 "return lines matching a pattern",
3764 This calls the external C<egrep -i> program and returns the
3767 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"]), 156, [ProtocolLimitWarning],
3768 [InitISOFS, Always, TestOutputList (
3769 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3770 "return lines matching a pattern",
3772 This calls the external C<fgrep -i> program and returns the
3775 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"]), 157, [ProtocolLimitWarning],
3776 [InitISOFS, Always, TestOutputList (
3777 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3778 "return lines matching a pattern",
3780 This calls the external C<zgrep> program and returns the
3783 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"]), 158, [ProtocolLimitWarning],
3784 [InitISOFS, Always, TestOutputList (
3785 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3786 "return lines matching a pattern",
3788 This calls the external C<zegrep> program and returns the
3791 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"]), 159, [ProtocolLimitWarning],
3792 [InitISOFS, Always, TestOutputList (
3793 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3794 "return lines matching a pattern",
3796 This calls the external C<zfgrep> program and returns the
3799 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 160, [ProtocolLimitWarning],
3800 [InitISOFS, Always, TestOutputList (
3801 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3802 "return lines matching a pattern",
3804 This calls the external C<zgrep -i> program and returns the
3807 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 161, [ProtocolLimitWarning],
3808 [InitISOFS, Always, TestOutputList (
3809 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3810 "return lines matching a pattern",
3812 This calls the external C<zegrep -i> program and returns the
3815 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"]), 162, [ProtocolLimitWarning],
3816 [InitISOFS, Always, TestOutputList (
3817 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3818 "return lines matching a pattern",
3820 This calls the external C<zfgrep -i> program and returns the
3823 ("realpath", (RString "rpath", [Pathname "path"]), 163, [Optional "realpath"],
3824 [InitISOFS, Always, TestOutput (
3825 [["realpath"; "/../directory"]], "/directory")],
3826 "canonicalized absolute pathname",
3828 Return the canonicalized absolute pathname of C<path>. The
3829 returned path has no C<.>, C<..> or symbolic link path elements.");
3831 ("ln", (RErr, [String "target"; Pathname "linkname"]), 164, [],
3832 [InitBasicFS, Always, TestOutputStruct (
3835 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3836 "create a hard link",
3838 This command creates a hard link using the C<ln> command.");
3840 ("ln_f", (RErr, [String "target"; Pathname "linkname"]), 165, [],
3841 [InitBasicFS, Always, TestOutputStruct (
3844 ["ln_f"; "/a"; "/b"];
3845 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3846 "create a hard link",
3848 This command creates a hard link using the C<ln -f> command.
3849 The C<-f> option removes the link (C<linkname>) if it exists already.");
3851 ("ln_s", (RErr, [String "target"; Pathname "linkname"]), 166, [],
3852 [InitBasicFS, Always, TestOutputStruct (
3854 ["ln_s"; "a"; "/b"];
3855 ["lstat"; "/b"]], [CompareWithInt ("mode", 0o120777)])],
3856 "create a symbolic link",
3858 This command creates a symbolic link using the C<ln -s> command.");
3860 ("ln_sf", (RErr, [String "target"; Pathname "linkname"]), 167, [],
3861 [InitBasicFS, Always, TestOutput (
3862 [["mkdir_p"; "/a/b"];
3863 ["touch"; "/a/b/c"];
3864 ["ln_sf"; "../d"; "/a/b/c"];
3865 ["readlink"; "/a/b/c"]], "../d")],
3866 "create a symbolic link",
3868 This command creates a symbolic link using the C<ln -sf> command,
3869 The C<-f> option removes the link (C<linkname>) if it exists already.");
3871 ("readlink", (RString "link", [Pathname "path"]), 168, [],
3872 [] (* XXX tested above *),
3873 "read the target of a symbolic link",
3875 This command reads the target of a symbolic link.");
3877 ("fallocate", (RErr, [Pathname "path"; Int "len"]), 169, [DeprecatedBy "fallocate64"],
3878 [InitBasicFS, Always, TestOutputStruct (
3879 [["fallocate"; "/a"; "1000000"];
3880 ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
3881 "preallocate a file in the guest filesystem",
3883 This command preallocates a file (containing zero bytes) named
3884 C<path> of size C<len> bytes. If the file exists already, it
3887 Do not confuse this with the guestfish-specific
3888 C<alloc> command which allocates a file in the host and
3889 attaches it as a device.");
3891 ("swapon_device", (RErr, [Device "device"]), 170, [],
3892 [InitPartition, Always, TestRun (
3893 [["mkswap"; "/dev/sda1"];
3894 ["swapon_device"; "/dev/sda1"];
3895 ["swapoff_device"; "/dev/sda1"]])],
3896 "enable swap on device",
3898 This command enables the libguestfs appliance to use the
3899 swap device or partition named C<device>. The increased
3900 memory is made available for all commands, for example
3901 those run using C<guestfs_command> or C<guestfs_sh>.
3903 Note that you should not swap to existing guest swap
3904 partitions unless you know what you are doing. They may
3905 contain hibernation information, or other information that
3906 the guest doesn't want you to trash. You also risk leaking
3907 information about the host to the guest this way. Instead,
3908 attach a new host device to the guest and swap on that.");
3910 ("swapoff_device", (RErr, [Device "device"]), 171, [],
3911 [], (* XXX tested by swapon_device *)
3912 "disable swap on device",
3914 This command disables the libguestfs appliance swap
3915 device or partition named C<device>.
3916 See C<guestfs_swapon_device>.");
3918 ("swapon_file", (RErr, [Pathname "file"]), 172, [],
3919 [InitBasicFS, Always, TestRun (
3920 [["fallocate"; "/swap"; "8388608"];
3921 ["mkswap_file"; "/swap"];
3922 ["swapon_file"; "/swap"];
3923 ["swapoff_file"; "/swap"]])],
3924 "enable swap on file",
3926 This command enables swap to a file.
3927 See C<guestfs_swapon_device> for other notes.");
3929 ("swapoff_file", (RErr, [Pathname "file"]), 173, [],
3930 [], (* XXX tested by swapon_file *)
3931 "disable swap on file",
3933 This command disables the libguestfs appliance swap on file.");
3935 ("swapon_label", (RErr, [String "label"]), 174, [],
3936 [InitEmpty, Always, TestRun (
3937 [["part_disk"; "/dev/sdb"; "mbr"];
3938 ["mkswap_L"; "swapit"; "/dev/sdb1"];
3939 ["swapon_label"; "swapit"];
3940 ["swapoff_label"; "swapit"];
3941 ["zero"; "/dev/sdb"];
3942 ["blockdev_rereadpt"; "/dev/sdb"]])],
3943 "enable swap on labeled swap partition",
3945 This command enables swap to a labeled swap partition.
3946 See C<guestfs_swapon_device> for other notes.");
3948 ("swapoff_label", (RErr, [String "label"]), 175, [],
3949 [], (* XXX tested by swapon_label *)
3950 "disable swap on labeled swap partition",
3952 This command disables the libguestfs appliance swap on
3953 labeled swap partition.");
3955 ("swapon_uuid", (RErr, [String "uuid"]), 176, [Optional "linuxfsuuid"],
3956 (let uuid = uuidgen () in
3957 [InitEmpty, Always, TestRun (
3958 [["mkswap_U"; uuid; "/dev/sdb"];
3959 ["swapon_uuid"; uuid];
3960 ["swapoff_uuid"; uuid]])]),
3961 "enable swap on swap partition by UUID",
3963 This command enables swap to a swap partition with the given UUID.
3964 See C<guestfs_swapon_device> for other notes.");
3966 ("swapoff_uuid", (RErr, [String "uuid"]), 177, [Optional "linuxfsuuid"],
3967 [], (* XXX tested by swapon_uuid *)
3968 "disable swap on swap partition by UUID",
3970 This command disables the libguestfs appliance swap partition
3971 with the given UUID.");
3973 ("mkswap_file", (RErr, [Pathname "path"]), 178, [],
3974 [InitBasicFS, Always, TestRun (
3975 [["fallocate"; "/swap"; "8388608"];
3976 ["mkswap_file"; "/swap"]])],
3977 "create a swap file",
3981 This command just writes a swap file signature to an existing
3982 file. To create the file itself, use something like C<guestfs_fallocate>.");
3984 ("inotify_init", (RErr, [Int "maxevents"]), 179, [Optional "inotify"],
3985 [InitISOFS, Always, TestRun (
3986 [["inotify_init"; "0"]])],
3987 "create an inotify handle",
3989 This command creates a new inotify handle.
3990 The inotify subsystem can be used to notify events which happen to
3991 objects in the guest filesystem.
3993 C<maxevents> is the maximum number of events which will be
3994 queued up between calls to C<guestfs_inotify_read> or
3995 C<guestfs_inotify_files>.
3996 If this is passed as C<0>, then the kernel (or previously set)
3997 default is used. For Linux 2.6.29 the default was 16384 events.
3998 Beyond this limit, the kernel throws away events, but records
3999 the fact that it threw them away by setting a flag
4000 C<IN_Q_OVERFLOW> in the returned structure list (see
4001 C<guestfs_inotify_read>).
4003 Before any events are generated, you have to add some
4004 watches to the internal watch list. See:
4005 C<guestfs_inotify_add_watch>,
4006 C<guestfs_inotify_rm_watch> and
4007 C<guestfs_inotify_watch_all>.
4009 Queued up events should be read periodically by calling
4010 C<guestfs_inotify_read>
4011 (or C<guestfs_inotify_files> which is just a helpful
4012 wrapper around C<guestfs_inotify_read>). If you don't
4013 read the events out often enough then you risk the internal
4016 The handle should be closed after use by calling
4017 C<guestfs_inotify_close>. This also removes any
4018 watches automatically.
4020 See also L<inotify(7)> for an overview of the inotify interface
4021 as exposed by the Linux kernel, which is roughly what we expose
4022 via libguestfs. Note that there is one global inotify handle
4023 per libguestfs instance.");
4025 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"]), 180, [Optional "inotify"],
4026 [InitBasicFS, Always, TestOutputList (
4027 [["inotify_init"; "0"];
4028 ["inotify_add_watch"; "/"; "1073741823"];
4031 ["inotify_files"]], ["a"; "b"])],
4032 "add an inotify watch",
4034 Watch C<path> for the events listed in C<mask>.
4036 Note that if C<path> is a directory then events within that
4037 directory are watched, but this does I<not> happen recursively
4038 (in subdirectories).
4040 Note for non-C or non-Linux callers: the inotify events are
4041 defined by the Linux kernel ABI and are listed in
4042 C</usr/include/sys/inotify.h>.");
4044 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"]), 181, [Optional "inotify"],
4046 "remove an inotify watch",
4048 Remove a previously defined inotify watch.
4049 See C<guestfs_inotify_add_watch>.");
4051 ("inotify_read", (RStructList ("events", "inotify_event"), []), 182, [Optional "inotify"],
4053 "return list of inotify events",
4055 Return the complete queue of events that have happened
4056 since the previous read call.
4058 If no events have happened, this returns an empty list.
4060 I<Note>: In order to make sure that all events have been
4061 read, you must call this function repeatedly until it
4062 returns an empty list. The reason is that the call will
4063 read events up to the maximum appliance-to-host message
4064 size and leave remaining events in the queue.");
4066 ("inotify_files", (RStringList "paths", []), 183, [Optional "inotify"],
4068 "return list of watched files that had events",
4070 This function is a helpful wrapper around C<guestfs_inotify_read>
4071 which just returns a list of pathnames of objects that were
4072 touched. The returned pathnames are sorted and deduplicated.");
4074 ("inotify_close", (RErr, []), 184, [Optional "inotify"],
4076 "close the inotify handle",
4078 This closes the inotify handle which was previously
4079 opened by inotify_init. It removes all watches, throws
4080 away any pending events, and deallocates all resources.");
4082 ("setcon", (RErr, [String "context"]), 185, [Optional "selinux"],
4084 "set SELinux security context",
4086 This sets the SELinux security context of the daemon
4087 to the string C<context>.
4089 See the documentation about SELINUX in L<guestfs(3)>.");
4091 ("getcon", (RString "context", []), 186, [Optional "selinux"],
4093 "get SELinux security context",
4095 This gets the SELinux security context of the daemon.
4097 See the documentation about SELINUX in L<guestfs(3)>,
4098 and C<guestfs_setcon>");
4100 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"]), 187, [],
4101 [InitEmpty, Always, TestOutput (
4102 [["part_disk"; "/dev/sda"; "mbr"];
4103 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
4104 ["mount_options"; ""; "/dev/sda1"; "/"];
4105 ["write"; "/new"; "new file contents"];
4106 ["cat"; "/new"]], "new file contents");
4107 InitEmpty, Always, TestRun (
4108 [["part_disk"; "/dev/sda"; "mbr"];
4109 ["mkfs_b"; "vfat"; "32768"; "/dev/sda1"]]);
4110 InitEmpty, Always, TestLastFail (
4111 [["part_disk"; "/dev/sda"; "mbr"];
4112 ["mkfs_b"; "vfat"; "32769"; "/dev/sda1"]]);
4113 InitEmpty, Always, TestLastFail (
4114 [["part_disk"; "/dev/sda"; "mbr"];
4115 ["mkfs_b"; "vfat"; "33280"; "/dev/sda1"]]);
4116 InitEmpty, IfAvailable "ntfsprogs", TestRun (
4117 [["part_disk"; "/dev/sda"; "mbr"];
4118 ["mkfs_b"; "ntfs"; "32768"; "/dev/sda1"]])],
4119 "make a filesystem with block size",
4121 This call is similar to C<guestfs_mkfs>, but it allows you to
4122 control the block size of the resulting filesystem. Supported
4123 block sizes depend on the filesystem type, but typically they
4124 are C<1024>, C<2048> or C<4096> only.
4126 For VFAT and NTFS the C<blocksize> parameter is treated as
4127 the requested cluster size.");
4129 ("mke2journal", (RErr, [Int "blocksize"; Device "device"]), 188, [],
4130 [InitEmpty, Always, TestOutput (
4131 [["sfdiskM"; "/dev/sda"; ",100 ,"];
4132 ["mke2journal"; "4096"; "/dev/sda1"];
4133 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
4134 ["mount_options"; ""; "/dev/sda2"; "/"];
4135 ["write"; "/new"; "new file contents"];
4136 ["cat"; "/new"]], "new file contents")],
4137 "make ext2/3/4 external journal",
4139 This creates an ext2 external journal on C<device>. It is equivalent
4142 mke2fs -O journal_dev -b blocksize device");
4144 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"]), 189, [],
4145 [InitEmpty, Always, TestOutput (
4146 [["sfdiskM"; "/dev/sda"; ",100 ,"];
4147 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
4148 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
4149 ["mount_options"; ""; "/dev/sda2"; "/"];
4150 ["write"; "/new"; "new file contents"];
4151 ["cat"; "/new"]], "new file contents")],
4152 "make ext2/3/4 external journal with label",
4154 This creates an ext2 external journal on C<device> with label C<label>.");
4156 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"]), 190, [Optional "linuxfsuuid"],
4157 (let uuid = uuidgen () in
4158 [InitEmpty, Always, TestOutput (
4159 [["sfdiskM"; "/dev/sda"; ",100 ,"];
4160 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
4161 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
4162 ["mount_options"; ""; "/dev/sda2"; "/"];
4163 ["write"; "/new"; "new file contents"];
4164 ["cat"; "/new"]], "new file contents")]),
4165 "make ext2/3/4 external journal with UUID",
4167 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
4169 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"]), 191, [],
4171 "make ext2/3/4 filesystem with external journal",
4173 This creates an ext2/3/4 filesystem on C<device> with
4174 an external journal on C<journal>. It is equivalent
4177 mke2fs -t fstype -b blocksize -J device=<journal> <device>
4179 See also C<guestfs_mke2journal>.");
4181 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"]), 192, [],
4183 "make ext2/3/4 filesystem with external journal",
4185 This creates an ext2/3/4 filesystem on C<device> with
4186 an external journal on the journal labeled C<label>.
4188 See also C<guestfs_mke2journal_L>.");
4190 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"]), 193, [Optional "linuxfsuuid"],
4192 "make ext2/3/4 filesystem with external journal",
4194 This creates an ext2/3/4 filesystem on C<device> with
4195 an external journal on the journal with UUID C<uuid>.
4197 See also C<guestfs_mke2journal_U>.");
4199 ("modprobe", (RErr, [String "modulename"]), 194, [Optional "linuxmodules"],
4200 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
4201 "load a kernel module",
4203 This loads a kernel module in the appliance.
4205 The kernel module must have been whitelisted when libguestfs
4206 was built (see C<appliance/kmod.whitelist.in> in the source).");
4208 ("echo_daemon", (RString "output", [StringList "words"]), 195, [],
4209 [InitNone, Always, TestOutput (
4210 [["echo_daemon"; "This is a test"]], "This is a test"
4212 "echo arguments back to the client",
4214 This command concatenates the list of C<words> passed with single spaces
4215 between them and returns the resulting string.
4217 You can use this command to test the connection through to the daemon.
4219 See also C<guestfs_ping_daemon>.");
4221 ("find0", (RErr, [Pathname "directory"; FileOut "files"]), 196, [],
4222 [], (* There is a regression test for this. *)
4223 "find all files and directories, returning NUL-separated list",
4225 This command lists out all files and directories, recursively,
4226 starting at C<directory>, placing the resulting list in the
4227 external file called C<files>.
4229 This command works the same way as C<guestfs_find> with the
4230 following exceptions:
4236 The resulting list is written to an external file.
4240 Items (filenames) in the result are separated
4241 by C<\\0> characters. See L<find(1)> option I<-print0>.
4245 This command is not limited in the number of names that it
4250 The result list is not sorted.
4254 ("case_sensitive_path", (RString "rpath", [Pathname "path"]), 197, [],
4255 [InitISOFS, Always, TestOutput (
4256 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
4257 InitISOFS, Always, TestOutput (
4258 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
4259 InitISOFS, Always, TestOutput (
4260 [["case_sensitive_path"; "/Known-1"]], "/known-1");
4261 InitISOFS, Always, TestLastFail (
4262 [["case_sensitive_path"; "/Known-1/"]]);
4263 InitBasicFS, Always, TestOutput (
4265 ["mkdir"; "/a/bbb"];
4266 ["touch"; "/a/bbb/c"];
4267 ["case_sensitive_path"; "/A/bbB/C"]], "/a/bbb/c");
4268 InitBasicFS, Always, TestOutput (
4270 ["mkdir"; "/a/bbb"];
4271 ["touch"; "/a/bbb/c"];
4272 ["case_sensitive_path"; "/A////bbB/C"]], "/a/bbb/c");
4273 InitBasicFS, Always, TestLastFail (
4275 ["mkdir"; "/a/bbb"];
4276 ["touch"; "/a/bbb/c"];
4277 ["case_sensitive_path"; "/A/bbb/../bbb/C"]])],
4278 "return true path on case-insensitive filesystem",
4280 This can be used to resolve case insensitive paths on
4281 a filesystem which is case sensitive. The use case is
4282 to resolve paths which you have read from Windows configuration
4283 files or the Windows Registry, to the true path.
4285 The command handles a peculiarity of the Linux ntfs-3g
4286 filesystem driver (and probably others), which is that although
4287 the underlying filesystem is case-insensitive, the driver
4288 exports the filesystem to Linux as case-sensitive.
4290 One consequence of this is that special directories such
4291 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
4292 (or other things) depending on the precise details of how
4293 they were created. In Windows itself this would not be
4296 Bug or feature? You decide:
4297 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
4299 This function resolves the true case of each element in the
4300 path and returns the case-sensitive path.
4302 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
4303 might return C<\"/WINDOWS/system32\"> (the exact return value
4304 would depend on details of how the directories were originally
4305 created under Windows).
4308 This function does not handle drive names, backslashes etc.
4310 See also C<guestfs_realpath>.");
4312 ("vfs_type", (RString "fstype", [Device "device"]), 198, [],
4313 [InitBasicFS, Always, TestOutput (
4314 [["vfs_type"; "/dev/sda1"]], "ext2")],
4315 "get the Linux VFS type corresponding to a mounted device",
4317 This command gets the filesystem type corresponding to
4318 the filesystem on C<device>.
4320 For most filesystems, the result is the name of the Linux
4321 VFS module which would be used to mount this filesystem
4322 if you mounted it without specifying the filesystem type.
4323 For example a string such as C<ext3> or C<ntfs>.");
4325 ("truncate", (RErr, [Pathname "path"]), 199, [],
4326 [InitBasicFS, Always, TestOutputStruct (
4327 [["write"; "/test"; "some stuff so size is not zero"];
4328 ["truncate"; "/test"];
4329 ["stat"; "/test"]], [CompareWithInt ("size", 0)])],
4330 "truncate a file to zero size",
4332 This command truncates C<path> to a zero-length file. The
4333 file must exist already.");
4335 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"]), 200, [],
4336 [InitBasicFS, Always, TestOutputStruct (
4337 [["touch"; "/test"];
4338 ["truncate_size"; "/test"; "1000"];
4339 ["stat"; "/test"]], [CompareWithInt ("size", 1000)])],
4340 "truncate a file to a particular size",
4342 This command truncates C<path> to size C<size> bytes. The file
4345 If the current file size is less than C<size> then
4346 the file is extended to the required size with zero bytes.
4347 This creates a sparse file (ie. disk blocks are not allocated
4348 for the file until you write to it). To create a non-sparse
4349 file of zeroes, use C<guestfs_fallocate64> instead.");
4351 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"]), 201, [],
4352 [InitBasicFS, Always, TestOutputStruct (
4353 [["touch"; "/test"];
4354 ["utimens"; "/test"; "12345"; "67890"; "9876"; "5432"];
4355 ["stat"; "/test"]], [CompareWithInt ("mtime", 9876)])],
4356 "set timestamp of a file with nanosecond precision",
4358 This command sets the timestamps of a file with nanosecond
4361 C<atsecs, atnsecs> are the last access time (atime) in secs and
4362 nanoseconds from the epoch.
4364 C<mtsecs, mtnsecs> are the last modification time (mtime) in
4365 secs and nanoseconds from the epoch.
4367 If the C<*nsecs> field contains the special value C<-1> then
4368 the corresponding timestamp is set to the current time. (The
4369 C<*secs> field is ignored in this case).
4371 If the C<*nsecs> field contains the special value C<-2> then
4372 the corresponding timestamp is left unchanged. (The
4373 C<*secs> field is ignored in this case).");
4375 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"]), 202, [],
4376 [InitBasicFS, Always, TestOutputStruct (
4377 [["mkdir_mode"; "/test"; "0o111"];
4378 ["stat"; "/test"]], [CompareWithInt ("mode", 0o40111)])],
4379 "create a directory with a particular mode",
4381 This command creates a directory, setting the initial permissions
4382 of the directory to C<mode>.
4384 For common Linux filesystems, the actual mode which is set will
4385 be C<mode & ~umask & 01777>. Non-native-Linux filesystems may
4386 interpret the mode in other ways.
4388 See also C<guestfs_mkdir>, C<guestfs_umask>");
4390 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"]), 203, [],
4392 "change file owner and group",
4394 Change the file owner to C<owner> and group to C<group>.
4395 This is like C<guestfs_chown> but if C<path> is a symlink then
4396 the link itself is changed, not the target.
4398 Only numeric uid and gid are supported. If you want to use
4399 names, you will need to locate and parse the password file
4400 yourself (Augeas support makes this relatively easy).");
4402 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"]), 204, [],
4404 "lstat on multiple files",
4406 This call allows you to perform the C<guestfs_lstat> operation
4407 on multiple files, where all files are in the directory C<path>.
4408 C<names> is the list of files from this directory.
4410 On return you get a list of stat structs, with a one-to-one
4411 correspondence to the C<names> list. If any name did not exist
4412 or could not be lstat'd, then the C<ino> field of that structure
4415 This call is intended for programs that want to efficiently
4416 list a directory contents without making many round-trips.
4417 See also C<guestfs_lxattrlist> for a similarly efficient call
4418 for getting extended attributes. Very long directory listings
4419 might cause the protocol message size to be exceeded, causing
4420 this call to fail. The caller must split up such requests
4421 into smaller groups of names.");
4423 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"]), 205, [Optional "linuxxattrs"],
4425 "lgetxattr on multiple files",
4427 This call allows you to get the extended attributes
4428 of multiple files, where all files are in the directory C<path>.
4429 C<names> is the list of files from this directory.
4431 On return you get a flat list of xattr structs which must be
4432 interpreted sequentially. The first xattr struct always has a zero-length
4433 C<attrname>. C<attrval> in this struct is zero-length
4434 to indicate there was an error doing C<lgetxattr> for this
4435 file, I<or> is a C string which is a decimal number
4436 (the number of following attributes for this file, which could
4437 be C<\"0\">). Then after the first xattr struct are the
4438 zero or more attributes for the first named file.
4439 This repeats for the second and subsequent files.
4441 This call is intended for programs that want to efficiently
4442 list a directory contents without making many round-trips.
4443 See also C<guestfs_lstatlist> for a similarly efficient call
4444 for getting standard stats. Very long directory listings
4445 might cause the protocol message size to be exceeded, causing
4446 this call to fail. The caller must split up such requests
4447 into smaller groups of names.");
4449 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"]), 206, [],
4451 "readlink on multiple files",
4453 This call allows you to do a C<readlink> operation
4454 on multiple files, where all files are in the directory C<path>.
4455 C<names> is the list of files from this directory.
4457 On return you get a list of strings, with a one-to-one
4458 correspondence to the C<names> list. Each string is the
4459 value of the symbolic link.
4461 If the C<readlink(2)> operation fails on any name, then
4462 the corresponding result string is the empty string C<\"\">.
4463 However the whole operation is completed even if there
4464 were C<readlink(2)> errors, and so you can call this
4465 function with names where you don't know if they are
4466 symbolic links already (albeit slightly less efficient).
4468 This call is intended for programs that want to efficiently
4469 list a directory contents without making many round-trips.
4470 Very long directory listings might cause the protocol
4471 message size to be exceeded, causing
4472 this call to fail. The caller must split up such requests
4473 into smaller groups of names.");
4475 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"]), 207, [ProtocolLimitWarning],
4476 [InitISOFS, Always, TestOutputBuffer (
4477 [["pread"; "/known-4"; "1"; "3"]], "\n");
4478 InitISOFS, Always, TestOutputBuffer (
4479 [["pread"; "/empty"; "0"; "100"]], "")],
4480 "read part of a file",
4482 This command lets you read part of a file. It reads C<count>
4483 bytes of the file, starting at C<offset>, from file C<path>.
4485 This may read fewer bytes than requested. For further details
4486 see the L<pread(2)> system call.
4488 See also C<guestfs_pwrite>.");
4490 ("part_init", (RErr, [Device "device"; String "parttype"]), 208, [],
4491 [InitEmpty, Always, TestRun (
4492 [["part_init"; "/dev/sda"; "gpt"]])],
4493 "create an empty partition table",
4495 This creates an empty partition table on C<device> of one of the
4496 partition types listed below. Usually C<parttype> should be
4497 either C<msdos> or C<gpt> (for large disks).
4499 Initially there are no partitions. Following this, you should
4500 call C<guestfs_part_add> for each partition required.
4502 Possible values for C<parttype> are:
4506 =item B<efi> | B<gpt>
4508 Intel EFI / GPT partition table.
4510 This is recommended for >= 2 TB partitions that will be accessed
4511 from Linux and Intel-based Mac OS X. It also has limited backwards
4512 compatibility with the C<mbr> format.
4514 =item B<mbr> | B<msdos>
4516 The standard PC \"Master Boot Record\" (MBR) format used
4517 by MS-DOS and Windows. This partition type will B<only> work
4518 for device sizes up to 2 TB. For large disks we recommend
4523 Other partition table types that may work but are not
4532 =item B<amiga> | B<rdb>
4534 Amiga \"Rigid Disk Block\" format.
4542 DASD, used on IBM mainframes.
4550 Old Mac partition format. Modern Macs use C<gpt>.
4554 NEC PC-98 format, common in Japan apparently.
4562 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"]), 209, [],
4563 [InitEmpty, Always, TestRun (
4564 [["part_init"; "/dev/sda"; "mbr"];
4565 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
4566 InitEmpty, Always, TestRun (
4567 [["part_init"; "/dev/sda"; "gpt"];
4568 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
4569 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4570 InitEmpty, Always, TestRun (
4571 [["part_init"; "/dev/sda"; "mbr"];
4572 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4573 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4574 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4575 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4576 "add a partition to the device",
4578 This command adds a partition to C<device>. If there is no partition
4579 table on the device, call C<guestfs_part_init> first.
4581 The C<prlogex> parameter is the type of partition. Normally you
4582 should pass C<p> or C<primary> here, but MBR partition tables also
4583 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4586 C<startsect> and C<endsect> are the start and end of the partition
4587 in I<sectors>. C<endsect> may be negative, which means it counts
4588 backwards from the end of the disk (C<-1> is the last sector).
4590 Creating a partition which covers the whole disk is not so easy.
4591 Use C<guestfs_part_disk> to do that.");
4593 ("part_disk", (RErr, [Device "device"; String "parttype"]), 210, [DangerWillRobinson],
4594 [InitEmpty, Always, TestRun (
4595 [["part_disk"; "/dev/sda"; "mbr"]]);
4596 InitEmpty, Always, TestRun (
4597 [["part_disk"; "/dev/sda"; "gpt"]])],
4598 "partition whole disk with a single primary partition",
4600 This command is simply a combination of C<guestfs_part_init>
4601 followed by C<guestfs_part_add> to create a single primary partition
4602 covering the whole disk.
4604 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
4605 but other possible values are described in C<guestfs_part_init>.");
4607 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"]), 211, [],
4608 [InitEmpty, Always, TestRun (
4609 [["part_disk"; "/dev/sda"; "mbr"];
4610 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
4611 "make a partition bootable",
4613 This sets the bootable flag on partition numbered C<partnum> on
4614 device C<device>. Note that partitions are numbered from 1.
4616 The bootable flag is used by some operating systems (notably
4617 Windows) to determine which partition to boot from. It is by
4618 no means universally recognized.");
4620 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"]), 212, [],
4621 [InitEmpty, Always, TestRun (
4622 [["part_disk"; "/dev/sda"; "gpt"];
4623 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
4624 "set partition name",
4626 This sets the partition name on partition numbered C<partnum> on
4627 device C<device>. Note that partitions are numbered from 1.
4629 The partition name can only be set on certain types of partition
4630 table. This works on C<gpt> but not on C<mbr> partitions.");
4632 ("part_list", (RStructList ("partitions", "partition"), [Device "device"]), 213, [],
4633 [], (* XXX Add a regression test for this. *)
4634 "list partitions on a device",
4636 This command parses the partition table on C<device> and
4637 returns the list of partitions found.
4639 The fields in the returned structure are:
4645 Partition number, counting from 1.
4649 Start of the partition I<in bytes>. To get sectors you have to
4650 divide by the device's sector size, see C<guestfs_blockdev_getss>.
4654 End of the partition in bytes.
4658 Size of the partition in bytes.
4662 ("part_get_parttype", (RString "parttype", [Device "device"]), 214, [],
4663 [InitEmpty, Always, TestOutput (
4664 [["part_disk"; "/dev/sda"; "gpt"];
4665 ["part_get_parttype"; "/dev/sda"]], "gpt")],
4666 "get the partition table type",
4668 This command examines the partition table on C<device> and
4669 returns the partition table type (format) being used.
4671 Common return values include: C<msdos> (a DOS/Windows style MBR
4672 partition table), C<gpt> (a GPT/EFI-style partition table). Other
4673 values are possible, although unusual. See C<guestfs_part_init>
4676 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"]), 215, [],
4677 [InitBasicFS, Always, TestOutputBuffer (
4678 [["fill"; "0x63"; "10"; "/test"];
4679 ["read_file"; "/test"]], "cccccccccc")],
4680 "fill a file with octets",
4682 This command creates a new file called C<path>. The initial
4683 content of the file is C<len> octets of C<c>, where C<c>
4684 must be a number in the range C<[0..255]>.
4686 To fill a file with zero bytes (sparsely), it is
4687 much more efficient to use C<guestfs_truncate_size>.
4688 To create a file with a pattern of repeating bytes
4689 use C<guestfs_fill_pattern>.");
4691 ("available", (RErr, [StringList "groups"]), 216, [],
4692 [InitNone, Always, TestRun [["available"; ""]]],
4693 "test availability of some parts of the API",
4695 This command is used to check the availability of some
4696 groups of functionality in the appliance, which not all builds of
4697 the libguestfs appliance will be able to provide.
4699 The libguestfs groups, and the functions that those
4700 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
4701 You can also fetch this list at runtime by calling
4702 C<guestfs_available_all_groups>.
4704 The argument C<groups> is a list of group names, eg:
4705 C<[\"inotify\", \"augeas\"]> would check for the availability of
4706 the Linux inotify functions and Augeas (configuration file
4709 The command returns no error if I<all> requested groups are available.
4711 It fails with an error if one or more of the requested
4712 groups is unavailable in the appliance.
4714 If an unknown group name is included in the
4715 list of groups then an error is always returned.
4723 You must call C<guestfs_launch> before calling this function.
4725 The reason is because we don't know what groups are
4726 supported by the appliance/daemon until it is running and can
4731 If a group of functions is available, this does not necessarily
4732 mean that they will work. You still have to check for errors
4733 when calling individual API functions even if they are
4738 It is usually the job of distro packagers to build
4739 complete functionality into the libguestfs appliance.
4740 Upstream libguestfs, if built from source with all
4741 requirements satisfied, will support everything.
4745 This call was added in version C<1.0.80>. In previous
4746 versions of libguestfs all you could do would be to speculatively
4747 execute a command to find out if the daemon implemented it.
4748 See also C<guestfs_version>.
4752 ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"]), 217, [],
4753 [InitBasicFS, Always, TestOutputBuffer (
4754 [["write"; "/src"; "hello, world"];
4755 ["dd"; "/src"; "/dest"];
4756 ["read_file"; "/dest"]], "hello, world")],
4757 "copy from source to destination using dd",
4759 This command copies from one source device or file C<src>
4760 to another destination device or file C<dest>. Normally you
4761 would use this to copy to or from a device or partition, for
4762 example to duplicate a filesystem.
4764 If the destination is a device, it must be as large or larger
4765 than the source file or device, otherwise the copy will fail.
4766 This command cannot do partial copies (see C<guestfs_copy_size>).");
4768 ("filesize", (RInt64 "size", [Pathname "file"]), 218, [],
4769 [InitBasicFS, Always, TestOutputInt (
4770 [["write"; "/file"; "hello, world"];
4771 ["filesize"; "/file"]], 12)],
4772 "return the size of the file in bytes",
4774 This command returns the size of C<file> in bytes.
4776 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
4777 C<guestfs_is_dir>, C<guestfs_is_file> etc.
4778 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
4780 ("lvrename", (RErr, [String "logvol"; String "newlogvol"]), 219, [],
4781 [InitBasicFSonLVM, Always, TestOutputList (
4782 [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
4783 ["lvs"]], ["/dev/VG/LV2"])],
4784 "rename an LVM logical volume",
4786 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
4788 ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"]), 220, [],
4789 [InitBasicFSonLVM, Always, TestOutputList (
4791 ["vg_activate"; "false"; "VG"];
4792 ["vgrename"; "VG"; "VG2"];
4793 ["vg_activate"; "true"; "VG2"];
4794 ["mount_options"; ""; "/dev/VG2/LV"; "/"];
4795 ["vgs"]], ["VG2"])],
4796 "rename an LVM volume group",
4798 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
4800 ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"]), 221, [ProtocolLimitWarning],
4801 [InitISOFS, Always, TestOutputBuffer (
4802 [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
4803 "list the contents of a single file in an initrd",
4805 This command unpacks the file C<filename> from the initrd file
4806 called C<initrdpath>. The filename must be given I<without> the
4807 initial C</> character.
4809 For example, in guestfish you could use the following command
4810 to examine the boot script (usually called C</init>)
4811 contained in a Linux initrd or initramfs image:
4813 initrd-cat /boot/initrd-<version>.img init
4815 See also C<guestfs_initrd_list>.");
4817 ("pvuuid", (RString "uuid", [Device "device"]), 222, [],
4819 "get the UUID of a physical volume",
4821 This command returns the UUID of the LVM PV C<device>.");
4823 ("vguuid", (RString "uuid", [String "vgname"]), 223, [],
4825 "get the UUID of a volume group",
4827 This command returns the UUID of the LVM VG named C<vgname>.");
4829 ("lvuuid", (RString "uuid", [Device "device"]), 224, [],
4831 "get the UUID of a logical volume",
4833 This command returns the UUID of the LVM LV C<device>.");
4835 ("vgpvuuids", (RStringList "uuids", [String "vgname"]), 225, [],
4837 "get the PV UUIDs containing the volume group",
4839 Given a VG called C<vgname>, this returns the UUIDs of all
4840 the physical volumes that this volume group resides on.
4842 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
4843 calls to associate physical volumes and volume groups.
4845 See also C<guestfs_vglvuuids>.");
4847 ("vglvuuids", (RStringList "uuids", [String "vgname"]), 226, [],
4849 "get the LV UUIDs of all LVs in the volume group",
4851 Given a VG called C<vgname>, this returns the UUIDs of all
4852 the logical volumes created in this volume group.
4854 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
4855 calls to associate logical volumes and volume groups.
4857 See also C<guestfs_vgpvuuids>.");
4859 ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"]), 227, [],
4860 [InitBasicFS, Always, TestOutputBuffer (
4861 [["write"; "/src"; "hello, world"];
4862 ["copy_size"; "/src"; "/dest"; "5"];
4863 ["read_file"; "/dest"]], "hello")],
4864 "copy size bytes from source to destination using dd",
4866 This command copies exactly C<size> bytes from one source device
4867 or file C<src> to another destination device or file C<dest>.
4869 Note this will fail if the source is too short or if the destination
4870 is not large enough.");
4872 ("zero_device", (RErr, [Device "device"]), 228, [DangerWillRobinson],
4873 [InitBasicFSonLVM, Always, TestRun (
4874 [["zero_device"; "/dev/VG/LV"]])],
4875 "write zeroes to an entire device",
4877 This command writes zeroes over the entire C<device>. Compare
4878 with C<guestfs_zero> which just zeroes the first few blocks of
4881 ("txz_in", (RErr, [FileIn "tarball"; Pathname "directory"]), 229, [Optional "xz"],
4882 [InitBasicFS, Always, TestOutput (
4883 [["txz_in"; "../images/helloworld.tar.xz"; "/"];
4884 ["cat"; "/hello"]], "hello\n")],
4885 "unpack compressed tarball to directory",
4887 This command uploads and unpacks local file C<tarball> (an
4888 I<xz compressed> tar file) into C<directory>.");
4890 ("txz_out", (RErr, [Pathname "directory"; FileOut "tarball"]), 230, [Optional "xz"],
4892 "pack directory into compressed tarball",
4894 This command packs the contents of C<directory> and downloads
4895 it to local file C<tarball> (as an xz compressed tar archive).");
4897 ("ntfsresize", (RErr, [Device "device"]), 231, [Optional "ntfsprogs"],
4899 "resize an NTFS filesystem",
4901 This command resizes an NTFS filesystem, expanding or
4902 shrinking it to the size of the underlying device.
4903 See also L<ntfsresize(8)>.");
4905 ("vgscan", (RErr, []), 232, [],
4906 [InitEmpty, Always, TestRun (
4908 "rescan for LVM physical volumes, volume groups and logical volumes",
4910 This rescans all block devices and rebuilds the list of LVM
4911 physical volumes, volume groups and logical volumes.");
4913 ("part_del", (RErr, [Device "device"; Int "partnum"]), 233, [],
4914 [InitEmpty, Always, TestRun (
4915 [["part_init"; "/dev/sda"; "mbr"];
4916 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4917 ["part_del"; "/dev/sda"; "1"]])],
4918 "delete a partition",
4920 This command deletes the partition numbered C<partnum> on C<device>.
4922 Note that in the case of MBR partitioning, deleting an
4923 extended partition also deletes any logical partitions
4926 ("part_get_bootable", (RBool "bootable", [Device "device"; Int "partnum"]), 234, [],
4927 [InitEmpty, Always, TestOutputTrue (
4928 [["part_init"; "/dev/sda"; "mbr"];
4929 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4930 ["part_set_bootable"; "/dev/sda"; "1"; "true"];
4931 ["part_get_bootable"; "/dev/sda"; "1"]])],
4932 "return true if a partition is bootable",
4934 This command returns true if the partition C<partnum> on
4935 C<device> has the bootable flag set.
4937 See also C<guestfs_part_set_bootable>.");
4939 ("part_get_mbr_id", (RInt "idbyte", [Device "device"; Int "partnum"]), 235, [FishOutput FishOutputHexadecimal],
4940 [InitEmpty, Always, TestOutputInt (
4941 [["part_init"; "/dev/sda"; "mbr"];
4942 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4943 ["part_set_mbr_id"; "/dev/sda"; "1"; "0x7f"];
4944 ["part_get_mbr_id"; "/dev/sda"; "1"]], 0x7f)],
4945 "get the MBR type byte (ID byte) from a partition",
4947 Returns the MBR type byte (also known as the ID byte) from
4948 the numbered partition C<partnum>.
4950 Note that only MBR (old DOS-style) partitions have type bytes.
4951 You will get undefined results for other partition table
4952 types (see C<guestfs_part_get_parttype>).");
4954 ("part_set_mbr_id", (RErr, [Device "device"; Int "partnum"; Int "idbyte"]), 236, [],
4955 [], (* tested by part_get_mbr_id *)
4956 "set the MBR type byte (ID byte) of a partition",
4958 Sets the MBR type byte (also known as the ID byte) of
4959 the numbered partition C<partnum> to C<idbyte>. Note
4960 that the type bytes quoted in most documentation are
4961 in fact hexadecimal numbers, but usually documented
4962 without any leading \"0x\" which might be confusing.
4964 Note that only MBR (old DOS-style) partitions have type bytes.
4965 You will get undefined results for other partition table
4966 types (see C<guestfs_part_get_parttype>).");
4968 ("checksum_device", (RString "checksum", [String "csumtype"; Device "device"]), 237, [],
4969 [InitISOFS, Always, TestOutput (
4970 [["checksum_device"; "md5"; "/dev/sdd"]],
4971 (Digest.to_hex (Digest.file "images/test.iso")))],
4972 "compute MD5, SHAx or CRC checksum of the contents of a device",
4974 This call computes the MD5, SHAx or CRC checksum of the
4975 contents of the device named C<device>. For the types of
4976 checksums supported see the C<guestfs_checksum> command.");
4978 ("lvresize_free", (RErr, [Device "lv"; Int "percent"]), 238, [Optional "lvm2"],
4979 [InitNone, Always, TestRun (
4980 [["part_disk"; "/dev/sda"; "mbr"];
4981 ["pvcreate"; "/dev/sda1"];
4982 ["vgcreate"; "VG"; "/dev/sda1"];
4983 ["lvcreate"; "LV"; "VG"; "10"];
4984 ["lvresize_free"; "/dev/VG/LV"; "100"]])],
4985 "expand an LV to fill free space",
4987 This expands an existing logical volume C<lv> so that it fills
4988 C<pc>% of the remaining free space in the volume group. Commonly
4989 you would call this with pc = 100 which expands the logical volume
4990 as much as possible, using all remaining free space in the volume
4993 ("aug_clear", (RErr, [String "augpath"]), 239, [Optional "augeas"],
4994 [], (* XXX Augeas code needs tests. *)
4995 "clear Augeas path",
4997 Set the value associated with C<path> to C<NULL>. This
4998 is the same as the L<augtool(1)> C<clear> command.");
5000 ("get_umask", (RInt "mask", []), 240, [FishOutput FishOutputOctal],
5001 [InitEmpty, Always, TestOutputInt (
5002 [["get_umask"]], 0o22)],
5003 "get the current umask",
5005 Return the current umask. By default the umask is C<022>
5006 unless it has been set by calling C<guestfs_umask>.");
5008 ("debug_upload", (RErr, [FileIn "filename"; String "tmpname"; Int "mode"]), 241, [],
5010 "upload a file to the appliance (internal use only)",
5012 The C<guestfs_debug_upload> command uploads a file to
5013 the libguestfs appliance.
5015 There is no comprehensive help for this command. You have
5016 to look at the file C<daemon/debug.c> in the libguestfs source
5017 to find out what it is for.");
5019 ("base64_in", (RErr, [FileIn "base64file"; Pathname "filename"]), 242, [],
5020 [InitBasicFS, Always, TestOutput (
5021 [["base64_in"; "../images/hello.b64"; "/hello"];
5022 ["cat"; "/hello"]], "hello\n")],
5023 "upload base64-encoded data to file",
5025 This command uploads base64-encoded data from C<base64file>
5028 ("base64_out", (RErr, [Pathname "filename"; FileOut "base64file"]), 243, [],
5030 "download file and encode as base64",
5032 This command downloads the contents of C<filename>, writing
5033 it out to local file C<base64file> encoded as base64.");
5035 ("checksums_out", (RErr, [String "csumtype"; Pathname "directory"; FileOut "sumsfile"]), 244, [],
5037 "compute MD5, SHAx or CRC checksum of files in a directory",
5039 This command computes the checksums of all regular files in
5040 C<directory> and then emits a list of those checksums to
5041 the local output file C<sumsfile>.
5043 This can be used for verifying the integrity of a virtual
5044 machine. However to be properly secure you should pay
5045 attention to the output of the checksum command (it uses
5046 the ones from GNU coreutils). In particular when the
5047 filename is not printable, coreutils uses a special
5048 backslash syntax. For more information, see the GNU
5049 coreutils info file.");
5051 ("fill_pattern", (RErr, [String "pattern"; Int "len"; Pathname "path"]), 245, [],
5052 [InitBasicFS, Always, TestOutputBuffer (
5053 [["fill_pattern"; "abcdefghijklmnopqrstuvwxyz"; "28"; "/test"];
5054 ["read_file"; "/test"]], "abcdefghijklmnopqrstuvwxyzab")],
5055 "fill a file with a repeating pattern of bytes",
5057 This function is like C<guestfs_fill> except that it creates
5058 a new file of length C<len> containing the repeating pattern
5059 of bytes in C<pattern>. The pattern is truncated if necessary
5060 to ensure the length of the file is exactly C<len> bytes.");
5062 ("write", (RErr, [Pathname "path"; BufferIn "content"]), 246, [ProtocolLimitWarning],
5063 [InitBasicFS, Always, TestOutput (
5064 [["write"; "/new"; "new file contents"];
5065 ["cat"; "/new"]], "new file contents");
5066 InitBasicFS, Always, TestOutput (
5067 [["write"; "/new"; "\nnew file contents\n"];
5068 ["cat"; "/new"]], "\nnew file contents\n");
5069 InitBasicFS, Always, TestOutput (
5070 [["write"; "/new"; "\n\n"];
5071 ["cat"; "/new"]], "\n\n");
5072 InitBasicFS, Always, TestOutput (
5073 [["write"; "/new"; ""];
5074 ["cat"; "/new"]], "");
5075 InitBasicFS, Always, TestOutput (
5076 [["write"; "/new"; "\n\n\n"];
5077 ["cat"; "/new"]], "\n\n\n");
5078 InitBasicFS, Always, TestOutput (
5079 [["write"; "/new"; "\n"];
5080 ["cat"; "/new"]], "\n")],
5081 "create a new file",
5083 This call creates a file called C<path>. The content of the
5084 file is the string C<content> (which can contain any 8 bit data).");
5086 ("pwrite", (RInt "nbytes", [Pathname "path"; BufferIn "content"; Int64 "offset"]), 247, [ProtocolLimitWarning],
5087 [InitBasicFS, Always, TestOutput (
5088 [["write"; "/new"; "new file contents"];
5089 ["pwrite"; "/new"; "data"; "4"];
5090 ["cat"; "/new"]], "new data contents");
5091 InitBasicFS, Always, TestOutput (
5092 [["write"; "/new"; "new file contents"];
5093 ["pwrite"; "/new"; "is extended"; "9"];
5094 ["cat"; "/new"]], "new file is extended");
5095 InitBasicFS, Always, TestOutput (
5096 [["write"; "/new"; "new file contents"];
5097 ["pwrite"; "/new"; ""; "4"];
5098 ["cat"; "/new"]], "new file contents")],
5099 "write to part of a file",
5101 This command writes to part of a file. It writes the data
5102 buffer C<content> to the file C<path> starting at offset C<offset>.
5104 This command implements the L<pwrite(2)> system call, and like
5105 that system call it may not write the full data requested. The
5106 return value is the number of bytes that were actually written
5107 to the file. This could even be 0, although short writes are
5108 unlikely for regular files in ordinary circumstances.
5110 See also C<guestfs_pread>.");
5112 ("resize2fs_size", (RErr, [Device "device"; Int64 "size"]), 248, [],
5114 "resize an ext2, ext3 or ext4 filesystem (with size)",
5116 This command is the same as C<guestfs_resize2fs> except that it
5117 allows you to specify the new size (in bytes) explicitly.");
5119 ("pvresize_size", (RErr, [Device "device"; Int64 "size"]), 249, [Optional "lvm2"],
5121 "resize an LVM physical volume (with size)",
5123 This command is the same as C<guestfs_pvresize> except that it
5124 allows you to specify the new size (in bytes) explicitly.");
5126 ("ntfsresize_size", (RErr, [Device "device"; Int64 "size"]), 250, [Optional "ntfsprogs"],
5128 "resize an NTFS filesystem (with size)",
5130 This command is the same as C<guestfs_ntfsresize> except that it
5131 allows you to specify the new size (in bytes) explicitly.");
5133 ("available_all_groups", (RStringList "groups", []), 251, [],
5134 [InitNone, Always, TestRun [["available_all_groups"]]],
5135 "return a list of all optional groups",
5137 This command returns a list of all optional groups that this
5138 daemon knows about. Note this returns both supported and unsupported
5139 groups. To find out which ones the daemon can actually support
5140 you have to call C<guestfs_available> on each member of the
5143 See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>.");
5145 ("fallocate64", (RErr, [Pathname "path"; Int64 "len"]), 252, [],
5146 [InitBasicFS, Always, TestOutputStruct (
5147 [["fallocate64"; "/a"; "1000000"];
5148 ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
5149 "preallocate a file in the guest filesystem",
5151 This command preallocates a file (containing zero bytes) named
5152 C<path> of size C<len> bytes. If the file exists already, it
5155 Note that this call allocates disk blocks for the file.
5156 To create a sparse file use C<guestfs_truncate_size> instead.
5158 The deprecated call C<guestfs_fallocate> does the same,
5159 but owing to an oversight it only allowed 30 bit lengths
5160 to be specified, effectively limiting the maximum size
5161 of files created through that call to 1GB.
5163 Do not confuse this with the guestfish-specific
5164 C<alloc> and C<sparse> commands which create
5165 a file in the host and attach it as a device.");
5167 ("vfs_label", (RString "label", [Device "device"]), 253, [],
5168 [InitBasicFS, Always, TestOutput (
5169 [["set_e2label"; "/dev/sda1"; "LTEST"];
5170 ["vfs_label"; "/dev/sda1"]], "LTEST")],
5171 "get the filesystem label",
5173 This returns the filesystem label of the filesystem on
5176 If the filesystem is unlabeled, this returns the empty string.
5178 To find a filesystem from the label, use C<guestfs_findfs_label>.");
5180 ("vfs_uuid", (RString "uuid", [Device "device"]), 254, [],
5181 (let uuid = uuidgen () in
5182 [InitBasicFS, Always, TestOutput (
5183 [["set_e2uuid"; "/dev/sda1"; uuid];
5184 ["vfs_uuid"; "/dev/sda1"]], uuid)]),
5185 "get the filesystem UUID",
5187 This returns the filesystem UUID of the filesystem on
5190 If the filesystem does not have a UUID, this returns the empty string.
5192 To find a filesystem from the UUID, use C<guestfs_findfs_uuid>.");
5194 ("lvm_set_filter", (RErr, [DeviceList "devices"]), 255, [Optional "lvm2"],
5195 (* Can't be tested with the current framework because
5196 * the VG is being used by the mounted filesystem, so
5197 * the vgchange -an command we do first will fail.
5200 "set LVM device filter",
5202 This sets the LVM device filter so that LVM will only be
5203 able to \"see\" the block devices in the list C<devices>,
5204 and will ignore all other attached block devices.
5206 Where disk image(s) contain duplicate PVs or VGs, this
5207 command is useful to get LVM to ignore the duplicates, otherwise
5208 LVM can get confused. Note also there are two types
5209 of duplication possible: either cloned PVs/VGs which have
5210 identical UUIDs; or VGs that are not cloned but just happen
5211 to have the same name. In normal operation you cannot
5212 create this situation, but you can do it outside LVM, eg.
5213 by cloning disk images or by bit twiddling inside the LVM
5216 This command also clears the LVM cache and performs a volume
5219 You can filter whole block devices or individual partitions.
5221 You cannot use this if any VG is currently in use (eg.
5222 contains a mounted filesystem), even if you are not
5223 filtering out that VG.");
5225 ("lvm_clear_filter", (RErr, []), 256, [],
5226 [], (* see note on lvm_set_filter *)
5227 "clear LVM device filter",
5229 This undoes the effect of C<guestfs_lvm_set_filter>. LVM
5230 will be able to see every block device.
5232 This command also clears the LVM cache and performs a volume
5235 ("luks_open", (RErr, [Device "device"; Key "key"; String "mapname"]), 257, [Optional "luks"],
5237 "open a LUKS-encrypted block device",
5239 This command opens a block device which has been encrypted
5240 according to the Linux Unified Key Setup (LUKS) standard.
5242 C<device> is the encrypted block device or partition.
5244 The caller must supply one of the keys associated with the
5245 LUKS block device, in the C<key> parameter.
5247 This creates a new block device called C</dev/mapper/mapname>.
5248 Reads and writes to this block device are decrypted from and
5249 encrypted to the underlying C<device> respectively.
5251 If this block device contains LVM volume groups, then
5252 calling C<guestfs_vgscan> followed by C<guestfs_vg_activate_all>
5253 will make them visible.");
5255 ("luks_open_ro", (RErr, [Device "device"; Key "key"; String "mapname"]), 258, [Optional "luks"],
5257 "open a LUKS-encrypted block device read-only",
5259 This is the same as C<guestfs_luks_open> except that a read-only
5260 mapping is created.");
5262 ("luks_close", (RErr, [Device "device"]), 259, [Optional "luks"],
5264 "close a LUKS device",
5266 This closes a LUKS device that was created earlier by
5267 C<guestfs_luks_open> or C<guestfs_luks_open_ro>. The
5268 C<device> parameter must be the name of the LUKS mapping
5269 device (ie. C</dev/mapper/mapname>) and I<not> the name
5270 of the underlying block device.");
5272 ("luks_format", (RErr, [Device "device"; Key "key"; Int "keyslot"]), 260, [Optional "luks"; DangerWillRobinson],
5274 "format a block device as a LUKS encrypted device",
5276 This command erases existing data on C<device> and formats
5277 the device as a LUKS encrypted device. C<key> is the
5278 initial key, which is added to key slot C<slot>. (LUKS
5279 supports 8 key slots, numbered 0-7).");
5281 ("luks_format_cipher", (RErr, [Device "device"; Key "key"; Int "keyslot"; String "cipher"]), 261, [Optional "luks"; DangerWillRobinson],
5283 "format a block device as a LUKS encrypted device",
5285 This command is the same as C<guestfs_luks_format> but
5286 it also allows you to set the C<cipher> used.");
5288 ("luks_add_key", (RErr, [Device "device"; Key "key"; Key "newkey"; Int "keyslot"]), 262, [Optional "luks"],
5290 "add a key on a LUKS encrypted device",
5292 This command adds a new key on LUKS device C<device>.
5293 C<key> is any existing key, and is used to access the device.
5294 C<newkey> is the new key to add. C<keyslot> is the key slot
5295 that will be replaced.
5297 Note that if C<keyslot> already contains a key, then this
5298 command will fail. You have to use C<guestfs_luks_kill_slot>
5299 first to remove that key.");
5301 ("luks_kill_slot", (RErr, [Device "device"; Key "key"; Int "keyslot"]), 263, [Optional "luks"],
5303 "remove a key from a LUKS encrypted device",
5305 This command deletes the key in key slot C<keyslot> from the
5306 encrypted LUKS device C<device>. C<key> must be one of the
5309 ("is_lv", (RBool "lvflag", [Device "device"]), 264, [Optional "lvm2"],
5310 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutputTrue (
5311 [["is_lv"; "/dev/VG/LV"]]);
5312 InitBasicFSonLVM, IfAvailable "lvm2", TestOutputFalse (
5313 [["is_lv"; "/dev/sda1"]])],
5314 "test if device is a logical volume",
5316 This command tests whether C<device> is a logical volume, and
5317 returns true iff this is the case.");
5319 ("findfs_uuid", (RString "device", [String "uuid"]), 265, [],
5321 "find a filesystem by UUID",
5323 This command searches the filesystems and returns the one
5324 which has the given UUID. An error is returned if no such
5325 filesystem can be found.
5327 To find the UUID of a filesystem, use C<guestfs_vfs_uuid>.");
5329 ("findfs_label", (RString "device", [String "label"]), 266, [],
5331 "find a filesystem by label",
5333 This command searches the filesystems and returns the one
5334 which has the given label. An error is returned if no such
5335 filesystem can be found.
5337 To find the label of a filesystem, use C<guestfs_vfs_label>.");
5341 let all_functions = non_daemon_functions @ daemon_functions
5343 (* In some places we want the functions to be displayed sorted
5344 * alphabetically, so this is useful:
5346 let all_functions_sorted =
5347 List.sort (fun (n1,_,_,_,_,_,_) (n2,_,_,_,_,_,_) ->
5348 compare n1 n2) all_functions
5350 (* This is used to generate the src/MAX_PROC_NR file which
5351 * contains the maximum procedure number, a surrogate for the
5352 * ABI version number. See src/Makefile.am for the details.
5355 let proc_nrs = List.map (
5356 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
5357 ) daemon_functions in
5358 List.fold_left max 0 proc_nrs
5360 (* Field types for structures. *)
5362 | FChar (* C 'char' (really, a 7 bit byte). *)
5363 | FString (* nul-terminated ASCII string, NOT NULL. *)
5364 | FBuffer (* opaque buffer of bytes, (char *, int) pair *)
5369 | FBytes (* Any int measure that counts bytes. *)
5370 | FUUID (* 32 bytes long, NOT nul-terminated. *)
5371 | FOptPercent (* [0..100], or -1 meaning "not present". *)
5373 (* Because we generate extra parsing code for LVM command line tools,
5374 * we have to pull out the LVM columns separately here.
5384 "pv_attr", FString (* XXX *);
5385 "pv_pe_count", FInt64;
5386 "pv_pe_alloc_count", FInt64;
5389 "pv_mda_count", FInt64;
5390 "pv_mda_free", FBytes;
5391 (* Not in Fedora 10:
5392 "pv_mda_size", FBytes;
5399 "vg_attr", FString (* XXX *);
5402 "vg_sysid", FString;
5403 "vg_extent_size", FBytes;
5404 "vg_extent_count", FInt64;
5405 "vg_free_count", FInt64;
5410 "snap_count", FInt64;
5413 "vg_mda_count", FInt64;
5414 "vg_mda_free", FBytes;
5415 (* Not in Fedora 10:
5416 "vg_mda_size", FBytes;
5422 "lv_attr", FString (* XXX *);
5425 "lv_kernel_major", FInt64;
5426 "lv_kernel_minor", FInt64;
5428 "seg_count", FInt64;
5430 "snap_percent", FOptPercent;
5431 "copy_percent", FOptPercent;
5434 "mirror_log", FString;
5438 (* Names and fields in all structures (in RStruct and RStructList)
5442 (* The old RIntBool return type, only ever used for aug_defnode. Do
5443 * not use this struct in any new code.
5446 "i", FInt32; (* for historical compatibility *)
5447 "b", FInt32; (* for historical compatibility *)
5450 (* LVM PVs, VGs, LVs. *)
5451 "lvm_pv", lvm_pv_cols;
5452 "lvm_vg", lvm_vg_cols;
5453 "lvm_lv", lvm_lv_cols;
5455 (* Column names and types from stat structures.
5456 * NB. Can't use things like 'st_atime' because glibc header files
5457 * define some of these as macros. Ugh.
5488 (* Column names in dirent structure. *)
5491 (* 'b' 'c' 'd' 'f' (FIFO) 'l' 'r' (regular file) 's' 'u' '?' *)
5496 (* Version numbers. *)
5504 (* Extended attribute. *)
5506 "attrname", FString;
5510 (* Inotify events. *)
5514 "in_cookie", FUInt32;
5518 (* Partition table entry. *)
5521 "part_start", FBytes;
5523 "part_size", FBytes;
5525 ] (* end of structs *)
5527 (* Ugh, Java has to be different ..
5528 * These names are also used by the Haskell bindings.
5530 let java_structs = [
5531 "int_bool", "IntBool";
5536 "statvfs", "StatVFS";
5538 "version", "Version";
5540 "inotify_event", "INotifyEvent";
5541 "partition", "Partition";
5544 (* What structs are actually returned. *)
5545 type rstructs_used_t = RStructOnly | RStructListOnly | RStructAndList
5547 (* Returns a list of RStruct/RStructList structs that are returned
5548 * by any function. Each element of returned list is a pair:
5550 * (structname, RStructOnly)
5551 * == there exists function which returns RStruct (_, structname)
5552 * (structname, RStructListOnly)
5553 * == there exists function which returns RStructList (_, structname)
5554 * (structname, RStructAndList)
5555 * == there are functions returning both RStruct (_, structname)
5556 * and RStructList (_, structname)
5558 let rstructs_used_by functions =
5559 (* ||| is a "logical OR" for rstructs_used_t *)
5563 | _, RStructAndList -> RStructAndList
5564 | RStructOnly, RStructListOnly
5565 | RStructListOnly, RStructOnly -> RStructAndList
5566 | RStructOnly, RStructOnly -> RStructOnly
5567 | RStructListOnly, RStructListOnly -> RStructListOnly
5570 let h = Hashtbl.create 13 in
5572 (* if elem->oldv exists, update entry using ||| operator,
5573 * else just add elem->newv to the hash
5575 let update elem newv =
5576 try let oldv = Hashtbl.find h elem in
5577 Hashtbl.replace h elem (newv ||| oldv)
5578 with Not_found -> Hashtbl.add h elem newv
5582 fun (_, style, _, _, _, _, _) ->
5583 match fst style with
5584 | RStruct (_, structname) -> update structname RStructOnly
5585 | RStructList (_, structname) -> update structname RStructListOnly
5589 (* return key->values as a list of (key,value) *)
5590 Hashtbl.fold (fun key value xs -> (key, value) :: xs) h []
5592 (* Used for testing language bindings. *)
5594 | CallString of string
5595 | CallOptString of string option
5596 | CallStringList of string list
5598 | CallInt64 of int64
5600 | CallBuffer of string
5602 (* Used to memoize the result of pod2text. *)
5603 let pod2text_memo_filename = "src/.pod2text.data"
5604 let pod2text_memo : ((int * string * string), string list) Hashtbl.t =
5606 let chan = open_in pod2text_memo_filename in
5607 let v = input_value chan in
5611 _ -> Hashtbl.create 13
5612 let pod2text_memo_updated () =
5613 let chan = open_out pod2text_memo_filename in
5614 output_value chan pod2text_memo;
5617 (* Useful functions.
5618 * Note we don't want to use any external OCaml libraries which
5619 * makes this a bit harder than it should be.
5621 module StringMap = Map.Make (String)
5623 let failwithf fs = ksprintf failwith fs
5625 let unique = let i = ref 0 in fun () -> incr i; !i
5627 let replace_char s c1 c2 =
5628 let s2 = String.copy s in
5629 let r = ref false in
5630 for i = 0 to String.length s2 - 1 do
5631 if String.unsafe_get s2 i = c1 then (
5632 String.unsafe_set s2 i c2;
5636 if not !r then s else s2
5640 (* || c = '\f' *) || c = '\n' || c = '\r' || c = '\t' (* || c = '\v' *)
5642 let triml ?(test = isspace) str =
5644 let n = ref (String.length str) in
5645 while !n > 0 && test str.[!i]; do
5650 else String.sub str !i !n
5652 let trimr ?(test = isspace) str =
5653 let n = ref (String.length str) in
5654 while !n > 0 && test str.[!n-1]; do
5657 if !n = String.length str then str
5658 else String.sub str 0 !n
5660 let trim ?(test = isspace) str =
5661 trimr ~test (triml ~test str)
5663 let rec find s sub =
5664 let len = String.length s in
5665 let sublen = String.length sub in
5667 if i <= len-sublen then (
5669 if j < sublen then (
5670 if s.[i+j] = sub.[j] then loop2 (j+1)
5676 if r = -1 then loop (i+1) else r
5682 let rec replace_str s s1 s2 =
5683 let len = String.length s in
5684 let sublen = String.length s1 in
5685 let i = find s s1 in
5688 let s' = String.sub s 0 i in
5689 let s'' = String.sub s (i+sublen) (len-i-sublen) in
5690 s' ^ s2 ^ replace_str s'' s1 s2
5693 let rec string_split sep str =
5694 let len = String.length str in
5695 let seplen = String.length sep in
5696 let i = find str sep in
5697 if i = -1 then [str]
5699 let s' = String.sub str 0 i in
5700 let s'' = String.sub str (i+seplen) (len-i-seplen) in
5701 s' :: string_split sep s''
5704 let files_equal n1 n2 =
5705 let cmd = sprintf "cmp -s %s %s" (Filename.quote n1) (Filename.quote n2) in
5706 match Sys.command cmd with
5709 | i -> failwithf "%s: failed with error code %d" cmd i
5711 let rec filter_map f = function
5715 | Some y -> y :: filter_map f xs
5716 | None -> filter_map f xs
5718 let rec find_map f = function
5719 | [] -> raise Not_found
5723 | None -> find_map f xs
5726 let rec loop i = function
5728 | x :: xs -> f i x; loop (i+1) xs
5733 let rec loop i = function
5735 | x :: xs -> let r = f i x in r :: loop (i+1) xs
5739 let count_chars c str =
5740 let count = ref 0 in
5741 for i = 0 to String.length str - 1 do
5742 if c = String.unsafe_get str i then incr count
5748 for i = 0 to String.length str - 1 do
5749 let c = String.unsafe_get str i in
5754 let map_chars f str =
5755 List.map f (explode str)
5757 let name_of_argt = function
5758 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
5759 | StringList n | DeviceList n | Bool n | Int n | Int64 n
5760 | FileIn n | FileOut n | BufferIn n | Key n -> n
5762 let java_name_of_struct typ =
5763 try List.assoc typ java_structs
5766 "java_name_of_struct: no java_structs entry corresponding to %s" typ
5768 let cols_of_struct typ =
5769 try List.assoc typ structs
5771 failwithf "cols_of_struct: unknown struct %s" typ
5773 let seq_of_test = function
5774 | TestRun s | TestOutput (s, _) | TestOutputList (s, _)
5775 | TestOutputListOfDevices (s, _)
5776 | TestOutputInt (s, _) | TestOutputIntOp (s, _, _)
5777 | TestOutputTrue s | TestOutputFalse s
5778 | TestOutputLength (s, _) | TestOutputBuffer (s, _)
5779 | TestOutputStruct (s, _)
5780 | TestLastFail s -> s
5782 (* Handling for function flags. *)
5783 let protocol_limit_warning =
5784 "Because of the message protocol, there is a transfer limit
5785 of somewhere between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
5787 let danger_will_robinson =
5788 "B<This command is dangerous. Without careful use you
5789 can easily destroy all your data>."
5791 let deprecation_notice flags =
5794 find_map (function DeprecatedBy str -> Some str | _ -> None) flags in
5796 sprintf "This function is deprecated.
5797 In new code, use the C<%s> call instead.
5799 Deprecated functions will not be removed from the API, but the
5800 fact that they are deprecated indicates that there are problems
5801 with correct use of these functions." alt in
5806 (* Create list of optional groups. *)
5808 let h = Hashtbl.create 13 in
5810 fun (name, _, _, flags, _, _, _) ->
5814 let names = try Hashtbl.find h group with Not_found -> [] in
5815 Hashtbl.replace h group (name :: names)
5819 let groups = Hashtbl.fold (fun k _ ks -> k :: ks) h [] in
5822 fun group -> group, List.sort compare (Hashtbl.find h group)
5824 List.sort (fun x y -> compare (fst x) (fst y)) groups
5826 (* Check function names etc. for consistency. *)
5827 let check_functions () =
5828 let contains_uppercase str =
5829 let len = String.length str in
5831 if i >= len then false
5834 if c >= 'A' && c <= 'Z' then true
5841 (* Check function names. *)
5843 fun (name, _, _, _, _, _, _) ->
5844 if String.length name >= 7 && String.sub name 0 7 = "guestfs" then
5845 failwithf "function name %s does not need 'guestfs' prefix" name;
5847 failwithf "function name is empty";
5848 if name.[0] < 'a' || name.[0] > 'z' then
5849 failwithf "function name %s must start with lowercase a-z" name;
5850 if String.contains name '-' then
5851 failwithf "function name %s should not contain '-', use '_' instead."
5855 (* Check function parameter/return names. *)
5857 fun (name, style, _, _, _, _, _) ->
5858 let check_arg_ret_name n =
5859 if contains_uppercase n then
5860 failwithf "%s param/ret %s should not contain uppercase chars"
5862 if String.contains n '-' || String.contains n '_' then
5863 failwithf "%s param/ret %s should not contain '-' or '_'"
5866 failwithf "%s has a param/ret called 'value', which causes conflicts in the OCaml bindings, use something like 'val' or a more descriptive name" name;
5867 if n = "int" || n = "char" || n = "short" || n = "long" then
5868 failwithf "%s has a param/ret which conflicts with a C type (eg. 'int', 'char' etc.)" name;
5869 if n = "i" || n = "n" then
5870 failwithf "%s has a param/ret called 'i' or 'n', which will cause some conflicts in the generated code" name;
5871 if n = "argv" || n = "args" then
5872 failwithf "%s has a param/ret called 'argv' or 'args', which will cause some conflicts in the generated code" name;
5874 (* List Haskell, OCaml and C keywords here.
5875 * http://www.haskell.org/haskellwiki/Keywords
5876 * http://caml.inria.fr/pub/docs/manual-ocaml/lex.html#operator-char
5877 * http://en.wikipedia.org/wiki/C_syntax#Reserved_keywords
5878 * Formatted via: cat c haskell ocaml|sort -u|grep -vE '_|^val$' \
5879 * |perl -pe 's/(.+)/"$1";/'|fmt -70
5880 * Omitting _-containing words, since they're handled above.
5881 * Omitting the OCaml reserved word, "val", is ok,
5882 * and saves us from renaming several parameters.
5885 "and"; "as"; "asr"; "assert"; "auto"; "begin"; "break"; "case";
5886 "char"; "class"; "const"; "constraint"; "continue"; "data";
5887 "default"; "deriving"; "do"; "done"; "double"; "downto"; "else";
5888 "end"; "enum"; "exception"; "extern"; "external"; "false"; "float";
5889 "for"; "forall"; "foreign"; "fun"; "function"; "functor"; "goto";
5890 "hiding"; "if"; "import"; "in"; "include"; "infix"; "infixl";
5891 "infixr"; "inherit"; "initializer"; "inline"; "instance"; "int";
5893 "land"; "lazy"; "let"; "long"; "lor"; "lsl"; "lsr"; "lxor";
5894 "match"; "mdo"; "method"; "mod"; "module"; "mutable"; "new";
5895 "newtype"; "object"; "of"; "open"; "or"; "private"; "qualified";
5896 "rec"; "register"; "restrict"; "return"; "short"; "sig"; "signed";
5897 "sizeof"; "static"; "struct"; "switch"; "then"; "to"; "true"; "try";
5898 "type"; "typedef"; "union"; "unsigned"; "virtual"; "void";
5899 "volatile"; "when"; "where"; "while";
5901 if List.mem n reserved then
5902 failwithf "%s has param/ret using reserved word %s" name n;
5905 (match fst style with
5907 | RInt n | RInt64 n | RBool n
5908 | RConstString n | RConstOptString n | RString n
5909 | RStringList n | RStruct (n, _) | RStructList (n, _)
5910 | RHashtable n | RBufferOut n ->
5911 check_arg_ret_name n
5913 List.iter (fun arg -> check_arg_ret_name (name_of_argt arg)) (snd style)
5916 (* Check short descriptions. *)
5918 fun (name, _, _, _, _, shortdesc, _) ->
5919 if shortdesc.[0] <> Char.lowercase shortdesc.[0] then
5920 failwithf "short description of %s should begin with lowercase." name;
5921 let c = shortdesc.[String.length shortdesc-1] in
5922 if c = '\n' || c = '.' then
5923 failwithf "short description of %s should not end with . or \\n." name
5926 (* Check long descriptions. *)
5928 fun (name, _, _, _, _, _, longdesc) ->
5929 if longdesc.[String.length longdesc-1] = '\n' then
5930 failwithf "long description of %s should not end with \\n." name
5933 (* Check proc_nrs. *)
5935 fun (name, _, proc_nr, _, _, _, _) ->
5936 if proc_nr <= 0 then
5937 failwithf "daemon function %s should have proc_nr > 0" name
5941 fun (name, _, proc_nr, _, _, _, _) ->
5942 if proc_nr <> -1 then
5943 failwithf "non-daemon function %s should have proc_nr -1" name
5944 ) non_daemon_functions;
5947 List.map (fun (name, _, proc_nr, _, _, _, _) -> name, proc_nr)
5950 List.sort (fun (_,nr1) (_,nr2) -> compare nr1 nr2) proc_nrs in
5951 let rec loop = function
5954 | (name1,nr1) :: ((name2,nr2) :: _ as rest) when nr1 < nr2 ->
5956 | (name1,nr1) :: (name2,nr2) :: _ ->
5957 failwithf "%s and %s have conflicting procedure numbers (%d, %d)"
5965 (* Ignore functions that have no tests. We generate a
5966 * warning when the user does 'make check' instead.
5968 | name, _, _, _, [], _, _ -> ()
5969 | name, _, _, _, tests, _, _ ->
5973 match seq_of_test test with
5975 failwithf "%s has a test containing an empty sequence" name
5976 | cmds -> List.map List.hd cmds
5978 let funcs = List.flatten funcs in
5980 let tested = List.mem name funcs in
5983 failwithf "function %s has tests but does not test itself" name
5986 (* 'pr' prints to the current output file. *)
5987 let chan = ref Pervasives.stdout
5992 let i = count_chars '\n' str in
5993 lines := !lines + i;
5994 output_string !chan str
5997 let copyright_years =
5998 let this_year = 1900 + (localtime (time ())).tm_year in
5999 if this_year > 2009 then sprintf "2009-%04d" this_year else "2009"
6001 (* Generate a header block in a number of standard styles. *)
6002 type comment_style =
6003 CStyle | CPlusPlusStyle | HashStyle | OCamlStyle | HaskellStyle
6004 type license = GPLv2plus | LGPLv2plus
6006 let generate_header ?(extra_inputs = []) comment license =
6007 let inputs = "src/generator.ml" :: extra_inputs in
6008 let c = match comment with
6009 | CStyle -> pr "/* "; " *"
6010 | CPlusPlusStyle -> pr "// "; "//"
6011 | HashStyle -> pr "# "; "#"
6012 | OCamlStyle -> pr "(* "; " *"
6013 | HaskellStyle -> pr "{- "; " " in
6014 pr "libguestfs generated file\n";
6015 pr "%s WARNING: THIS FILE IS GENERATED FROM:\n" c;
6016 List.iter (pr "%s %s\n" c) inputs;
6017 pr "%s ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.\n" c;
6019 pr "%s Copyright (C) %s Red Hat Inc.\n" c copyright_years;
6023 pr "%s This program is free software; you can redistribute it and/or modify\n" c;
6024 pr "%s it under the terms of the GNU General Public License as published by\n" c;
6025 pr "%s the Free Software Foundation; either version 2 of the License, or\n" c;
6026 pr "%s (at your option) any later version.\n" c;
6028 pr "%s This program is distributed in the hope that it will be useful,\n" c;
6029 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
6030 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" c;
6031 pr "%s GNU General Public License for more details.\n" c;
6033 pr "%s You should have received a copy of the GNU General Public License along\n" c;
6034 pr "%s with this program; if not, write to the Free Software Foundation, Inc.,\n" c;
6035 pr "%s 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n" c;
6038 pr "%s This library is free software; you can redistribute it and/or\n" c;
6039 pr "%s modify it under the terms of the GNU Lesser General Public\n" c;
6040 pr "%s License as published by the Free Software Foundation; either\n" c;
6041 pr "%s version 2 of the License, or (at your option) any later version.\n" c;
6043 pr "%s This library is distributed in the hope that it will be useful,\n" c;
6044 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
6045 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n" c;
6046 pr "%s Lesser General Public License for more details.\n" c;
6048 pr "%s You should have received a copy of the GNU Lesser General Public\n" c;
6049 pr "%s License along with this library; if not, write to the Free Software\n" c;
6050 pr "%s Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n" c;
6053 | CStyle -> pr " */\n"
6056 | OCamlStyle -> pr " *)\n"
6057 | HaskellStyle -> pr "-}\n"
6061 (* Start of main code generation functions below this line. *)
6063 (* Generate the pod documentation for the C API. *)
6064 let rec generate_actions_pod () =
6066 fun (shortname, style, _, flags, _, _, longdesc) ->
6067 if not (List.mem NotInDocs flags) then (
6068 let name = "guestfs_" ^ shortname in
6069 pr "=head2 %s\n\n" name;
6071 generate_prototype ~extern:false ~handle:"g" name style;
6073 pr "%s\n\n" longdesc;
6074 (match fst style with
6076 pr "This function returns 0 on success or -1 on error.\n\n"
6078 pr "On error this function returns -1.\n\n"
6080 pr "On error this function returns -1.\n\n"
6082 pr "This function returns a C truth value on success or -1 on error.\n\n"
6084 pr "This function returns a string, or NULL on error.
6085 The string is owned by the guest handle and must I<not> be freed.\n\n"
6086 | RConstOptString _ ->
6087 pr "This function returns a string which may be NULL.
6088 There is no way to return an error from this function.
6089 The string is owned by the guest handle and must I<not> be freed.\n\n"
6091 pr "This function returns a string, or NULL on error.
6092 I<The caller must free the returned string after use>.\n\n"
6094 pr "This function returns a NULL-terminated array of strings
6095 (like L<environ(3)>), or NULL if there was an error.
6096 I<The caller must free the strings and the array after use>.\n\n"
6097 | RStruct (_, typ) ->
6098 pr "This function returns a C<struct guestfs_%s *>,
6099 or NULL if there was an error.
6100 I<The caller must call C<guestfs_free_%s> after use>.\n\n" typ typ
6101 | RStructList (_, typ) ->
6102 pr "This function returns a C<struct guestfs_%s_list *>
6103 (see E<lt>guestfs-structs.hE<gt>),
6104 or NULL if there was an error.
6105 I<The caller must call C<guestfs_free_%s_list> after use>.\n\n" typ typ
6107 pr "This function returns a NULL-terminated array of
6108 strings, or NULL if there was an error.
6109 The array of strings will always have length C<2n+1>, where
6110 C<n> keys and values alternate, followed by the trailing NULL entry.
6111 I<The caller must free the strings and the array after use>.\n\n"
6113 pr "This function returns a buffer, or NULL on error.
6114 The size of the returned buffer is written to C<*size_r>.
6115 I<The caller must free the returned buffer after use>.\n\n"
6117 if List.mem ProtocolLimitWarning flags then
6118 pr "%s\n\n" protocol_limit_warning;
6119 if List.mem DangerWillRobinson flags then
6120 pr "%s\n\n" danger_will_robinson;
6121 if List.exists (function Key _ -> true | _ -> false) (snd style) then
6122 pr "This function takes a key or passphrase parameter which
6123 could contain sensitive material. Read the section
6124 L</KEYS AND PASSPHRASES> for more information.\n\n";
6125 match deprecation_notice flags with
6127 | Some txt -> pr "%s\n\n" txt
6129 ) all_functions_sorted
6131 and generate_structs_pod () =
6132 (* Structs documentation. *)
6135 pr "=head2 guestfs_%s\n" typ;
6137 pr " struct guestfs_%s {\n" typ;
6140 | name, FChar -> pr " char %s;\n" name
6141 | name, FUInt32 -> pr " uint32_t %s;\n" name
6142 | name, FInt32 -> pr " int32_t %s;\n" name
6143 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
6144 | name, FInt64 -> pr " int64_t %s;\n" name
6145 | name, FString -> pr " char *%s;\n" name
6147 pr " /* The next two fields describe a byte array. */\n";
6148 pr " uint32_t %s_len;\n" name;
6149 pr " char *%s;\n" name
6151 pr " /* The next field is NOT nul-terminated, be careful when printing it: */\n";
6152 pr " char %s[32];\n" name
6153 | name, FOptPercent ->
6154 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
6155 pr " float %s;\n" name
6159 pr " struct guestfs_%s_list {\n" typ;
6160 pr " uint32_t len; /* Number of elements in list. */\n";
6161 pr " struct guestfs_%s *val; /* Elements. */\n" typ;
6164 pr " void guestfs_free_%s (struct guestfs_free_%s *);\n" typ typ;
6165 pr " void guestfs_free_%s_list (struct guestfs_free_%s_list *);\n"
6170 and generate_availability_pod () =
6171 (* Availability documentation. *)
6175 fun (group, functions) ->
6176 pr "=item B<%s>\n" group;
6178 pr "The following functions:\n";
6179 List.iter (pr "L</guestfs_%s>\n") functions;
6185 (* Generate the protocol (XDR) file, 'guestfs_protocol.x' and
6186 * indirectly 'guestfs_protocol.h' and 'guestfs_protocol.c'.
6188 * We have to use an underscore instead of a dash because otherwise
6189 * rpcgen generates incorrect code.
6191 * This header is NOT exported to clients, but see also generate_structs_h.
6193 and generate_xdr () =
6194 generate_header CStyle LGPLv2plus;
6196 (* This has to be defined to get around a limitation in Sun's rpcgen. *)
6197 pr "typedef string str<>;\n";
6200 (* Internal structures. *)
6204 pr "struct guestfs_int_%s {\n" typ;
6206 | name, FChar -> pr " char %s;\n" name
6207 | name, FString -> pr " string %s<>;\n" name
6208 | name, FBuffer -> pr " opaque %s<>;\n" name
6209 | name, FUUID -> pr " opaque %s[32];\n" name
6210 | name, (FInt32|FUInt32) -> pr " int %s;\n" name
6211 | name, (FInt64|FUInt64|FBytes) -> pr " hyper %s;\n" name
6212 | name, FOptPercent -> pr " float %s;\n" name
6216 pr "typedef struct guestfs_int_%s guestfs_int_%s_list<>;\n" typ typ;
6221 fun (shortname, style, _, _, _, _, _) ->
6222 let name = "guestfs_" ^ shortname in
6224 (match snd style with
6227 pr "struct %s_args {\n" name;
6230 | Pathname n | Device n | Dev_or_Path n | String n | Key n ->
6231 pr " string %s<>;\n" n
6232 | OptString n -> pr " str *%s;\n" n
6233 | StringList n | DeviceList n -> pr " str %s<>;\n" n
6234 | Bool n -> pr " bool %s;\n" n
6235 | Int n -> pr " int %s;\n" n
6236 | Int64 n -> pr " hyper %s;\n" n
6238 pr " opaque %s<>;\n" n
6239 | FileIn _ | FileOut _ -> ()
6243 (match fst style with
6246 pr "struct %s_ret {\n" name;
6250 pr "struct %s_ret {\n" name;
6251 pr " hyper %s;\n" n;
6254 pr "struct %s_ret {\n" name;
6257 | RConstString _ | RConstOptString _ ->
6258 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
6260 pr "struct %s_ret {\n" name;
6261 pr " string %s<>;\n" n;
6264 pr "struct %s_ret {\n" name;
6265 pr " str %s<>;\n" n;
6267 | RStruct (n, typ) ->
6268 pr "struct %s_ret {\n" name;
6269 pr " guestfs_int_%s %s;\n" typ n;
6271 | RStructList (n, typ) ->
6272 pr "struct %s_ret {\n" name;
6273 pr " guestfs_int_%s_list %s;\n" typ n;
6276 pr "struct %s_ret {\n" name;
6277 pr " str %s<>;\n" n;
6280 pr "struct %s_ret {\n" name;
6281 pr " opaque %s<>;\n" n;
6286 (* Table of procedure numbers. *)
6287 pr "enum guestfs_procedure {\n";
6289 fun (shortname, _, proc_nr, _, _, _, _) ->
6290 pr " GUESTFS_PROC_%s = %d,\n" (String.uppercase shortname) proc_nr
6292 pr " GUESTFS_PROC_NR_PROCS\n";
6296 (* Having to choose a maximum message size is annoying for several
6297 * reasons (it limits what we can do in the API), but it (a) makes
6298 * the protocol a lot simpler, and (b) provides a bound on the size
6299 * of the daemon which operates in limited memory space.
6301 pr "const GUESTFS_MESSAGE_MAX = %d;\n" (4 * 1024 * 1024);
6304 (* Message header, etc. *)
6306 /* The communication protocol is now documented in the guestfs(3)
6310 const GUESTFS_PROGRAM = 0x2000F5F5;
6311 const GUESTFS_PROTOCOL_VERSION = 1;
6313 /* These constants must be larger than any possible message length. */
6314 const GUESTFS_LAUNCH_FLAG = 0xf5f55ff5;
6315 const GUESTFS_CANCEL_FLAG = 0xffffeeee;
6317 enum guestfs_message_direction {
6318 GUESTFS_DIRECTION_CALL = 0, /* client -> daemon */
6319 GUESTFS_DIRECTION_REPLY = 1 /* daemon -> client */
6322 enum guestfs_message_status {
6323 GUESTFS_STATUS_OK = 0,
6324 GUESTFS_STATUS_ERROR = 1
6329 pr "const GUESTFS_ERROR_LEN = %d;\n" (64 * 1024);
6333 struct guestfs_message_error {
6334 int linux_errno; /* Linux errno if available. */
6335 string error_message<GUESTFS_ERROR_LEN>;
6338 struct guestfs_message_header {
6339 unsigned prog; /* GUESTFS_PROGRAM */
6340 unsigned vers; /* GUESTFS_PROTOCOL_VERSION */
6341 guestfs_procedure proc; /* GUESTFS_PROC_x */
6342 guestfs_message_direction direction;
6343 unsigned serial; /* message serial number */
6344 guestfs_message_status status;
6347 const GUESTFS_MAX_CHUNK_SIZE = 8192;
6349 struct guestfs_chunk {
6350 int cancel; /* if non-zero, transfer is cancelled */
6351 /* data size is 0 bytes if the transfer has finished successfully */
6352 opaque data<GUESTFS_MAX_CHUNK_SIZE>;
6356 (* Generate the guestfs-structs.h file. *)
6357 and generate_structs_h () =
6358 generate_header CStyle LGPLv2plus;
6360 (* This is a public exported header file containing various
6361 * structures. The structures are carefully written to have
6362 * exactly the same in-memory format as the XDR structures that
6363 * we use on the wire to the daemon. The reason for creating
6364 * copies of these structures here is just so we don't have to
6365 * export the whole of guestfs_protocol.h (which includes much
6366 * unrelated and XDR-dependent stuff that we don't want to be
6367 * public, or required by clients).
6369 * To reiterate, we will pass these structures to and from the
6370 * client with a simple assignment or memcpy, so the format
6371 * must be identical to what rpcgen / the RFC defines.
6374 (* Public structures. *)
6377 pr "struct guestfs_%s {\n" typ;
6380 | name, FChar -> pr " char %s;\n" name
6381 | name, FString -> pr " char *%s;\n" name
6383 pr " uint32_t %s_len;\n" name;
6384 pr " char *%s;\n" name
6385 | name, FUUID -> pr " char %s[32]; /* this is NOT nul-terminated, be careful when printing */\n" name
6386 | name, FUInt32 -> pr " uint32_t %s;\n" name
6387 | name, FInt32 -> pr " int32_t %s;\n" name
6388 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
6389 | name, FInt64 -> pr " int64_t %s;\n" name
6390 | name, FOptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
6394 pr "struct guestfs_%s_list {\n" typ;
6395 pr " uint32_t len;\n";
6396 pr " struct guestfs_%s *val;\n" typ;
6399 pr "extern void guestfs_free_%s (struct guestfs_%s *);\n" typ typ;
6400 pr "extern void guestfs_free_%s_list (struct guestfs_%s_list *);\n" typ typ;
6404 (* Generate the guestfs-actions.h file. *)
6405 and generate_actions_h () =
6406 generate_header CStyle LGPLv2plus;
6408 fun (shortname, style, _, _, _, _, _) ->
6409 let name = "guestfs_" ^ shortname in
6410 generate_prototype ~single_line:true ~newline:true ~handle:"g"
6414 (* Generate the guestfs-internal-actions.h file. *)
6415 and generate_internal_actions_h () =
6416 generate_header CStyle LGPLv2plus;
6418 fun (shortname, style, _, _, _, _, _) ->
6419 let name = "guestfs__" ^ shortname in
6420 generate_prototype ~single_line:true ~newline:true ~handle:"g"
6422 ) non_daemon_functions
6424 (* Generate the client-side dispatch stubs. *)
6425 and generate_client_actions () =
6426 generate_header CStyle LGPLv2plus;
6433 #include <inttypes.h>
6435 #include \"guestfs.h\"
6436 #include \"guestfs-internal.h\"
6437 #include \"guestfs-internal-actions.h\"
6438 #include \"guestfs_protocol.h\"
6440 /* Check the return message from a call for validity. */
6442 check_reply_header (guestfs_h *g,
6443 const struct guestfs_message_header *hdr,
6444 unsigned int proc_nr, unsigned int serial)
6446 if (hdr->prog != GUESTFS_PROGRAM) {
6447 error (g, \"wrong program (%%d/%%d)\", hdr->prog, GUESTFS_PROGRAM);
6450 if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
6451 error (g, \"wrong protocol version (%%d/%%d)\",
6452 hdr->vers, GUESTFS_PROTOCOL_VERSION);
6455 if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
6456 error (g, \"unexpected message direction (%%d/%%d)\",
6457 hdr->direction, GUESTFS_DIRECTION_REPLY);
6460 if (hdr->proc != proc_nr) {
6461 error (g, \"unexpected procedure number (%%d/%%d)\", hdr->proc, proc_nr);
6464 if (hdr->serial != serial) {
6465 error (g, \"unexpected serial (%%d/%%d)\", hdr->serial, serial);
6472 /* Check we are in the right state to run a high-level action. */
6474 check_state (guestfs_h *g, const char *caller)
6476 if (!guestfs__is_ready (g)) {
6477 if (guestfs__is_config (g) || guestfs__is_launching (g))
6478 error (g, \"%%s: call launch before using this function\\n(in guestfish, don't forget to use the 'run' command)\",
6481 error (g, \"%%s called from the wrong state, %%d != READY\",
6482 caller, guestfs__get_state (g));
6490 let error_code_of = function
6491 | RErr | RInt _ | RInt64 _ | RBool _ -> "-1"
6492 | RConstString _ | RConstOptString _
6493 | RString _ | RStringList _
6494 | RStruct _ | RStructList _
6495 | RHashtable _ | RBufferOut _ -> "NULL"
6498 (* Generate code to check String-like parameters are not passed in
6499 * as NULL (returning an error if they are).
6501 let check_null_strings shortname style =
6502 let pr_newline = ref false in
6505 (* parameters which should not be NULL *)
6516 pr " if (%s == NULL) {\n" n;
6517 pr " error (g, \"%%s: %%s: parameter cannot be NULL\",\n";
6518 pr " \"%s\", \"%s\");\n" shortname n;
6519 pr " return %s;\n" (error_code_of (fst style));
6526 (* not applicable *)
6532 if !pr_newline then pr "\n";
6535 (* Generate code to generate guestfish call traces. *)
6536 let trace_call shortname style =
6537 pr " if (guestfs__get_trace (g)) {\n";
6540 List.exists (function
6541 | StringList _ | DeviceList _ -> true
6542 | _ -> false) (snd style) in
6548 pr " fprintf (stderr, \"%s\");\n" shortname;
6551 | String n (* strings *)
6559 (* guestfish doesn't support string escaping, so neither do we *)
6560 pr " fprintf (stderr, \" \\\"%%s\\\"\", %s);\n" n
6561 | OptString n -> (* string option *)
6562 pr " if (%s) fprintf (stderr, \" \\\"%%s\\\"\", %s);\n" n n;
6563 pr " else fprintf (stderr, \" null\");\n"
6565 | DeviceList n -> (* string list *)
6566 pr " fputc (' ', stderr);\n";
6567 pr " fputc ('\"', stderr);\n";
6568 pr " for (i = 0; %s[i]; ++i) {\n" n;
6569 pr " if (i > 0) fputc (' ', stderr);\n";
6570 pr " fputs (%s[i], stderr);\n" n;
6572 pr " fputc ('\"', stderr);\n";
6573 | Bool n -> (* boolean *)
6574 pr " fputs (%s ? \" true\" : \" false\", stderr);\n" n
6575 | Int n -> (* int *)
6576 pr " fprintf (stderr, \" %%d\", %s);\n" n
6578 pr " fprintf (stderr, \" %%\" PRIi64, %s);\n" n
6580 pr " fputc ('\\n', stderr);\n";
6585 (* For non-daemon functions, generate a wrapper around each function. *)
6587 fun (shortname, style, _, _, _, _, _) ->
6588 let name = "guestfs_" ^ shortname in
6590 generate_prototype ~extern:false ~semicolon:false ~newline:true
6591 ~handle:"g" name style;
6593 check_null_strings shortname style;
6594 trace_call shortname style;
6595 pr " return guestfs__%s " shortname;
6596 generate_c_call_args ~handle:"g" style;
6600 ) non_daemon_functions;
6602 (* Client-side stubs for each function. *)
6604 fun (shortname, style, _, _, _, _, _) ->
6605 let name = "guestfs_" ^ shortname in
6606 let error_code = error_code_of (fst style) in
6608 (* Generate the action stub. *)
6609 generate_prototype ~extern:false ~semicolon:false ~newline:true
6610 ~handle:"g" name style;
6614 (match snd style with
6616 | _ -> pr " struct %s_args args;\n" name
6619 pr " guestfs_message_header hdr;\n";
6620 pr " guestfs_message_error err;\n";
6622 match fst style with
6624 | RConstString _ | RConstOptString _ ->
6625 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
6627 | RBool _ | RString _ | RStringList _
6628 | RStruct _ | RStructList _
6629 | RHashtable _ | RBufferOut _ ->
6630 pr " struct %s_ret ret;\n" name;
6633 pr " int serial;\n";
6636 check_null_strings shortname style;
6637 trace_call shortname style;
6638 pr " if (check_state (g, \"%s\") == -1) return %s;\n"
6639 shortname error_code;
6640 pr " guestfs___set_busy (g);\n";
6643 (* Send the main header and arguments. *)
6644 (match snd style with
6646 pr " serial = guestfs___send (g, GUESTFS_PROC_%s, NULL, NULL);\n"
6647 (String.uppercase shortname)
6651 | Pathname n | Device n | Dev_or_Path n | String n | Key n ->
6652 pr " args.%s = (char *) %s;\n" n n
6654 pr " args.%s = %s ? (char **) &%s : NULL;\n" n n n
6655 | StringList n | DeviceList n ->
6656 pr " args.%s.%s_val = (char **) %s;\n" n n n;
6657 pr " for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n;
6659 pr " args.%s = %s;\n" n n
6661 pr " args.%s = %s;\n" n n
6663 pr " args.%s = %s;\n" n n
6664 | FileIn _ | FileOut _ -> ()
6666 pr " /* Just catch grossly large sizes. XDR encoding will make this precise. */\n";
6667 pr " if (%s_size >= GUESTFS_MESSAGE_MAX) {\n" n;
6668 pr " error (g, \"%%s: size of input buffer too large\", \"%s\");\n"
6670 pr " guestfs___end_busy (g);\n";
6671 pr " return %s;\n" error_code;
6673 pr " args.%s.%s_val = (char *) %s;\n" n n n;
6674 pr " args.%s.%s_len = %s_size;\n" n n n
6676 pr " serial = guestfs___send (g, GUESTFS_PROC_%s,\n"
6677 (String.uppercase shortname);
6678 pr " (xdrproc_t) xdr_%s_args, (char *) &args);\n"
6681 pr " if (serial == -1) {\n";
6682 pr " guestfs___end_busy (g);\n";
6683 pr " return %s;\n" error_code;
6687 (* Send any additional files (FileIn) requested. *)
6688 let need_read_reply_label = ref false in
6692 pr " r = guestfs___send_file (g, %s);\n" n;
6693 pr " if (r == -1) {\n";
6694 pr " guestfs___end_busy (g);\n";
6695 pr " return %s;\n" error_code;
6697 pr " if (r == -2) /* daemon cancelled */\n";
6698 pr " goto read_reply;\n";
6699 need_read_reply_label := true;
6704 (* Wait for the reply from the remote end. *)
6705 if !need_read_reply_label then pr " read_reply:\n";
6706 pr " memset (&hdr, 0, sizeof hdr);\n";
6707 pr " memset (&err, 0, sizeof err);\n";
6708 if has_ret then pr " memset (&ret, 0, sizeof ret);\n";
6710 pr " r = guestfs___recv (g, \"%s\", &hdr, &err,\n " shortname;
6714 pr "(xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret" shortname;
6717 pr " if (r == -1) {\n";
6718 pr " guestfs___end_busy (g);\n";
6719 pr " return %s;\n" error_code;
6723 pr " if (check_reply_header (g, &hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
6724 (String.uppercase shortname);
6725 pr " guestfs___end_busy (g);\n";
6726 pr " return %s;\n" error_code;
6730 pr " if (hdr.status == GUESTFS_STATUS_ERROR) {\n";
6731 pr " error (g, \"%%s: %%s\", \"%s\", err.error_message);\n" shortname;
6732 pr " free (err.error_message);\n";
6733 pr " guestfs___end_busy (g);\n";
6734 pr " return %s;\n" error_code;
6738 (* Expecting to receive further files (FileOut)? *)
6742 pr " if (guestfs___recv_file (g, %s) == -1) {\n" n;
6743 pr " guestfs___end_busy (g);\n";
6744 pr " return %s;\n" error_code;
6750 pr " guestfs___end_busy (g);\n";
6752 (match fst style with
6753 | RErr -> pr " return 0;\n"
6754 | RInt n | RInt64 n | RBool n ->
6755 pr " return ret.%s;\n" n
6756 | RConstString _ | RConstOptString _ ->
6757 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
6759 pr " return ret.%s; /* caller will free */\n" n
6760 | RStringList n | RHashtable n ->
6761 pr " /* caller will free this, but we need to add a NULL entry */\n";
6762 pr " ret.%s.%s_val =\n" n n;
6763 pr " safe_realloc (g, ret.%s.%s_val,\n" n n;
6764 pr " sizeof (char *) * (ret.%s.%s_len + 1));\n"
6766 pr " ret.%s.%s_val[ret.%s.%s_len] = NULL;\n" n n n n;
6767 pr " return ret.%s.%s_val;\n" n n
6769 pr " /* caller will free this */\n";
6770 pr " return safe_memdup (g, &ret.%s, sizeof (ret.%s));\n" n n
6771 | RStructList (n, _) ->
6772 pr " /* caller will free this */\n";
6773 pr " return safe_memdup (g, &ret.%s, sizeof (ret.%s));\n" n n
6775 pr " /* RBufferOut is tricky: If the buffer is zero-length, then\n";
6776 pr " * _val might be NULL here. To make the API saner for\n";
6777 pr " * callers, we turn this case into a unique pointer (using\n";
6778 pr " * malloc(1)).\n";
6780 pr " if (ret.%s.%s_len > 0) {\n" n n;
6781 pr " *size_r = ret.%s.%s_len;\n" n n;
6782 pr " return ret.%s.%s_val; /* caller will free */\n" n n;
6784 pr " free (ret.%s.%s_val);\n" n n;
6785 pr " char *p = safe_malloc (g, 1);\n";
6786 pr " *size_r = ret.%s.%s_len;\n" n n;
6794 (* Functions to free structures. *)
6795 pr "/* Structure-freeing functions. These rely on the fact that the\n";
6796 pr " * structure format is identical to the XDR format. See note in\n";
6797 pr " * generator.ml.\n";
6804 pr "guestfs_free_%s (struct guestfs_%s *x)\n" typ typ;
6806 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s, (char *) x);\n" typ;
6812 pr "guestfs_free_%s_list (struct guestfs_%s_list *x)\n" typ typ;
6814 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s_list, (char *) x);\n" typ;
6821 (* Generate daemon/actions.h. *)
6822 and generate_daemon_actions_h () =
6823 generate_header CStyle GPLv2plus;
6825 pr "#include \"../src/guestfs_protocol.h\"\n";
6829 fun (name, style, _, _, _, _, _) ->
6831 ~single_line:true ~newline:true ~in_daemon:true ~prefix:"do_"
6835 (* Generate the linker script which controls the visibility of
6836 * symbols in the public ABI and ensures no other symbols get
6837 * exported accidentally.
6839 and generate_linker_script () =
6840 generate_header HashStyle GPLv2plus;
6845 "guestfs_get_error_handler";
6846 "guestfs_get_out_of_memory_handler";
6847 "guestfs_last_error";
6848 "guestfs_set_close_callback";
6849 "guestfs_set_error_handler";
6850 "guestfs_set_launch_done_callback";
6851 "guestfs_set_log_message_callback";
6852 "guestfs_set_out_of_memory_handler";
6853 "guestfs_set_subprocess_quit_callback";
6855 (* Unofficial parts of the API: the bindings code use these
6856 * functions, so it is useful to export them.
6858 "guestfs_safe_calloc";
6859 "guestfs_safe_malloc";
6860 "guestfs_safe_strdup";
6861 "guestfs_safe_memdup";
6864 List.map (fun (name, _, _, _, _, _, _) -> "guestfs_" ^ name)
6868 List.map (fun (typ, _) ->
6869 ["guestfs_free_" ^ typ; "guestfs_free_" ^ typ ^ "_list"])
6872 let globals = List.sort compare (globals @ functions @ structs) in
6876 List.iter (pr " %s;\n") globals;
6883 (* Generate the server-side stubs. *)
6884 and generate_daemon_actions () =
6885 generate_header CStyle GPLv2plus;
6887 pr "#include <config.h>\n";
6889 pr "#include <stdio.h>\n";
6890 pr "#include <stdlib.h>\n";
6891 pr "#include <string.h>\n";
6892 pr "#include <inttypes.h>\n";
6893 pr "#include <rpc/types.h>\n";
6894 pr "#include <rpc/xdr.h>\n";
6896 pr "#include \"daemon.h\"\n";
6897 pr "#include \"c-ctype.h\"\n";
6898 pr "#include \"../src/guestfs_protocol.h\"\n";
6899 pr "#include \"actions.h\"\n";
6903 fun (name, style, _, _, _, _, _) ->
6904 (* Generate server-side stubs. *)
6905 pr "static void %s_stub (XDR *xdr_in)\n" name;
6908 match fst style with
6909 | RErr | RInt _ -> pr " int r;\n"; "-1"
6910 | RInt64 _ -> pr " int64_t r;\n"; "-1"
6911 | RBool _ -> pr " int r;\n"; "-1"
6912 | RConstString _ | RConstOptString _ ->
6913 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
6914 | RString _ -> pr " char *r;\n"; "NULL"
6915 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
6916 | RStruct (_, typ) -> pr " guestfs_int_%s *r;\n" typ; "NULL"
6917 | RStructList (_, typ) -> pr " guestfs_int_%s_list *r;\n" typ; "NULL"
6919 pr " size_t size = 1;\n";
6923 (match snd style with
6926 pr " struct guestfs_%s_args args;\n" name;
6929 | Device n | Dev_or_Path n
6933 | OptString n -> pr " char *%s;\n" n
6934 | StringList n | DeviceList n -> pr " char **%s;\n" n
6935 | Bool n -> pr " int %s;\n" n
6936 | Int n -> pr " int %s;\n" n
6937 | Int64 n -> pr " int64_t %s;\n" n
6938 | FileIn _ | FileOut _ -> ()
6940 pr " const char *%s;\n" n;
6941 pr " size_t %s_size;\n" n
6947 List.exists (function FileIn _ -> true | _ -> false) (snd style) in
6949 (match snd style with
6952 pr " memset (&args, 0, sizeof args);\n";
6954 pr " if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name;
6956 pr " if (cancel_receive () != -2)\n";
6957 pr " reply_with_error (\"daemon failed to decode procedure arguments\");\n";
6961 pr " char *%s = args.%s;\n" n n
6963 let pr_list_handling_code n =
6964 pr " %s = realloc (args.%s.%s_val,\n" n n n;
6965 pr " sizeof (char *) * (args.%s.%s_len+1));\n" n n;
6966 pr " if (%s == NULL) {\n" n;
6968 pr " if (cancel_receive () != -2)\n";
6969 pr " reply_with_perror (\"realloc\");\n";
6972 pr " %s[args.%s.%s_len] = NULL;\n" n n n;
6973 pr " args.%s.%s_val = %s;\n" n n n;
6979 pr " ABS_PATH (%s, %s, goto done);\n"
6980 n (if is_filein then "cancel_receive ()" else "0");
6983 pr " RESOLVE_DEVICE (%s, %s, goto done);\n"
6984 n (if is_filein then "cancel_receive ()" else "0");
6987 pr " REQUIRE_ROOT_OR_RESOLVE_DEVICE (%s, %s, goto done);\n"
6988 n (if is_filein then "cancel_receive ()" else "0");
6989 | String n | Key n -> pr_args n
6990 | OptString n -> pr " %s = args.%s ? *args.%s : NULL;\n" n n n
6992 pr_list_handling_code n;
6994 pr_list_handling_code n;
6995 pr " /* Ensure that each is a device,\n";
6996 pr " * and perform device name translation.\n";
7000 pr " for (i = 0; %s[i] != NULL; ++i)\n" n;
7001 pr " RESOLVE_DEVICE (%s[i], %s, goto done);\n" n
7002 (if is_filein then "cancel_receive ()" else "0");
7004 | Bool n -> pr " %s = args.%s;\n" n n
7005 | Int n -> pr " %s = args.%s;\n" n n
7006 | Int64 n -> pr " %s = args.%s;\n" n n
7007 | FileIn _ | FileOut _ -> ()
7009 pr " %s = args.%s.%s_val;\n" n n n;
7010 pr " %s_size = args.%s.%s_len;\n" n n n
7015 (* this is used at least for do_equal *)
7016 if List.exists (function Pathname _ -> true | _ -> false) (snd style) then (
7017 (* Emit NEED_ROOT just once, even when there are two or
7018 more Pathname args *)
7019 pr " NEED_ROOT (%s, goto done);\n"
7020 (if is_filein then "cancel_receive ()" else "0");
7023 (* Don't want to call the impl with any FileIn or FileOut
7024 * parameters, since these go "outside" the RPC protocol.
7027 List.filter (function FileIn _ | FileOut _ -> false | _ -> true)
7029 pr " r = do_%s " name;
7030 generate_c_call_args (fst style, args');
7033 (match fst style with
7034 | RErr | RInt _ | RInt64 _ | RBool _
7035 | RConstString _ | RConstOptString _
7036 | RString _ | RStringList _ | RHashtable _
7037 | RStruct (_, _) | RStructList (_, _) ->
7038 pr " if (r == %s)\n" error_code;
7039 pr " /* do_%s has already called reply_with_error */\n" name;
7043 pr " /* size == 0 && r == NULL could be a non-error case (just\n";
7044 pr " * an ordinary zero-length buffer), so be careful ...\n";
7046 pr " if (size == 1 && r == %s)\n" error_code;
7047 pr " /* do_%s has already called reply_with_error */\n" name;
7052 (* If there are any FileOut parameters, then the impl must
7053 * send its own reply.
7056 List.exists (function FileOut _ -> true | _ -> false) (snd style) in
7058 pr " /* do_%s has already sent a reply */\n" name
7060 match fst style with
7061 | RErr -> pr " reply (NULL, NULL);\n"
7062 | RInt n | RInt64 n | RBool n ->
7063 pr " struct guestfs_%s_ret ret;\n" name;
7064 pr " ret.%s = r;\n" n;
7065 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
7067 | RConstString _ | RConstOptString _ ->
7068 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
7070 pr " struct guestfs_%s_ret ret;\n" name;
7071 pr " ret.%s = r;\n" n;
7072 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
7075 | RStringList n | RHashtable n ->
7076 pr " struct guestfs_%s_ret ret;\n" name;
7077 pr " ret.%s.%s_len = count_strings (r);\n" n n;
7078 pr " ret.%s.%s_val = r;\n" n n;
7079 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
7081 pr " free_strings (r);\n"
7083 pr " struct guestfs_%s_ret ret;\n" name;
7084 pr " ret.%s = *r;\n" n;
7085 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
7087 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
7089 | RStructList (n, _) ->
7090 pr " struct guestfs_%s_ret ret;\n" name;
7091 pr " ret.%s = *r;\n" n;
7092 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
7094 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
7097 pr " struct guestfs_%s_ret ret;\n" name;
7098 pr " ret.%s.%s_val = r;\n" n n;
7099 pr " ret.%s.%s_len = size;\n" n n;
7100 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
7105 (* Free the args. *)
7107 (match snd style with
7110 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_args, (char *) &args);\n"
7117 (* Dispatch function. *)
7118 pr "void dispatch_incoming_message (XDR *xdr_in)\n";
7120 pr " switch (proc_nr) {\n";
7123 fun (name, style, _, _, _, _, _) ->
7124 pr " case GUESTFS_PROC_%s:\n" (String.uppercase name);
7125 pr " %s_stub (xdr_in);\n" name;
7130 pr " reply_with_error (\"dispatch_incoming_message: unknown procedure number %%d, set LIBGUESTFS_PATH to point to the matching libguestfs appliance directory\", proc_nr);\n";
7135 (* LVM columns and tokenization functions. *)
7136 (* XXX This generates crap code. We should rethink how we
7142 pr "static const char *lvm_%s_cols = \"%s\";\n"
7143 typ (String.concat "," (List.map fst cols));
7146 pr "static int lvm_tokenize_%s (char *str, guestfs_int_lvm_%s *r)\n" typ typ;
7148 pr " char *tok, *p, *next;\n";
7149 pr " size_t i, j;\n";
7152 pr " fprintf (stderr, \"%%s: <<%%s>>\\n\", __func__, str);\n";
7155 pr " if (!str) {\n";
7156 pr " fprintf (stderr, \"%%s: failed: passed a NULL string\\n\", __func__);\n";
7159 pr " if (!*str || c_isspace (*str)) {\n";
7160 pr " fprintf (stderr, \"%%s: failed: passed a empty string or one beginning with whitespace\\n\", __func__);\n";
7165 fun (name, coltype) ->
7166 pr " if (!tok) {\n";
7167 pr " fprintf (stderr, \"%%s: failed: string finished early, around token %%s\\n\", __func__, \"%s\");\n" name;
7170 pr " p = strchrnul (tok, ',');\n";
7171 pr " if (*p) next = p+1; else next = NULL;\n";
7172 pr " *p = '\\0';\n";
7175 pr " r->%s = strdup (tok);\n" name;
7176 pr " if (r->%s == NULL) {\n" name;
7177 pr " perror (\"strdup\");\n";
7181 pr " for (i = j = 0; i < 32; ++j) {\n";
7182 pr " if (tok[j] == '\\0') {\n";
7183 pr " fprintf (stderr, \"%%s: failed to parse UUID from '%%s'\\n\", __func__, tok);\n";
7185 pr " } else if (tok[j] != '-')\n";
7186 pr " r->%s[i++] = tok[j];\n" name;
7189 pr " if (sscanf (tok, \"%%\"SCNu64, &r->%s) != 1) {\n" name;
7190 pr " fprintf (stderr, \"%%s: failed to parse size '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
7194 pr " if (sscanf (tok, \"%%\"SCNi64, &r->%s) != 1) {\n" name;
7195 pr " fprintf (stderr, \"%%s: failed to parse int '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
7199 pr " if (tok[0] == '\\0')\n";
7200 pr " r->%s = -1;\n" name;
7201 pr " else if (sscanf (tok, \"%%f\", &r->%s) != 1) {\n" name;
7202 pr " fprintf (stderr, \"%%s: failed to parse float '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
7205 | FBuffer | FInt32 | FUInt32 | FUInt64 | FChar ->
7206 assert false (* can never be an LVM column *)
7208 pr " tok = next;\n";
7211 pr " if (tok != NULL) {\n";
7212 pr " fprintf (stderr, \"%%s: failed: extra tokens at end of string\\n\", __func__);\n";
7219 pr "guestfs_int_lvm_%s_list *\n" typ;
7220 pr "parse_command_line_%ss (void)\n" typ;
7222 pr " char *out, *err;\n";
7223 pr " char *p, *pend;\n";
7225 pr " guestfs_int_lvm_%s_list *ret;\n" typ;
7226 pr " void *newp;\n";
7228 pr " ret = malloc (sizeof *ret);\n";
7229 pr " if (!ret) {\n";
7230 pr " reply_with_perror (\"malloc\");\n";
7231 pr " return NULL;\n";
7234 pr " ret->guestfs_int_lvm_%s_list_len = 0;\n" typ;
7235 pr " ret->guestfs_int_lvm_%s_list_val = NULL;\n" typ;
7237 pr " r = command (&out, &err,\n";
7238 pr " \"lvm\", \"%ss\",\n" typ;
7239 pr " \"-o\", lvm_%s_cols, \"--unbuffered\", \"--noheadings\",\n" typ;
7240 pr " \"--nosuffix\", \"--separator\", \",\", \"--units\", \"b\", NULL);\n";
7241 pr " if (r == -1) {\n";
7242 pr " reply_with_error (\"%%s\", err);\n";
7243 pr " free (out);\n";
7244 pr " free (err);\n";
7245 pr " free (ret);\n";
7246 pr " return NULL;\n";
7249 pr " free (err);\n";
7251 pr " /* Tokenize each line of the output. */\n";
7254 pr " while (p) {\n";
7255 pr " pend = strchr (p, '\\n'); /* Get the next line of output. */\n";
7256 pr " if (pend) {\n";
7257 pr " *pend = '\\0';\n";
7261 pr " while (*p && c_isspace (*p)) /* Skip any leading whitespace. */\n";
7264 pr " if (!*p) { /* Empty line? Skip it. */\n";
7269 pr " /* Allocate some space to store this next entry. */\n";
7270 pr " newp = realloc (ret->guestfs_int_lvm_%s_list_val,\n" typ;
7271 pr " sizeof (guestfs_int_lvm_%s) * (i+1));\n" typ;
7272 pr " if (newp == NULL) {\n";
7273 pr " reply_with_perror (\"realloc\");\n";
7274 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
7275 pr " free (ret);\n";
7276 pr " free (out);\n";
7277 pr " return NULL;\n";
7279 pr " ret->guestfs_int_lvm_%s_list_val = newp;\n" typ;
7281 pr " /* Tokenize the next entry. */\n";
7282 pr " r = lvm_tokenize_%s (p, &ret->guestfs_int_lvm_%s_list_val[i]);\n" typ typ;
7283 pr " if (r == -1) {\n";
7284 pr " reply_with_error (\"failed to parse output of '%ss' command\");\n" typ;
7285 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
7286 pr " free (ret);\n";
7287 pr " free (out);\n";
7288 pr " return NULL;\n";
7295 pr " ret->guestfs_int_lvm_%s_list_len = i;\n" typ;
7297 pr " free (out);\n";
7298 pr " return ret;\n";
7301 ) ["pv", lvm_pv_cols; "vg", lvm_vg_cols; "lv", lvm_lv_cols]
7303 (* Generate a list of function names, for debugging in the daemon.. *)
7304 and generate_daemon_names () =
7305 generate_header CStyle GPLv2plus;
7307 pr "#include <config.h>\n";
7309 pr "#include \"daemon.h\"\n";
7312 pr "/* This array is indexed by proc_nr. See guestfs_protocol.x. */\n";
7313 pr "const char *function_names[] = {\n";
7315 fun (name, _, proc_nr, _, _, _, _) -> pr " [%d] = \"%s\",\n" proc_nr name
7319 (* Generate the optional groups for the daemon to implement
7320 * guestfs_available.
7322 and generate_daemon_optgroups_c () =
7323 generate_header CStyle GPLv2plus;
7325 pr "#include <config.h>\n";
7327 pr "#include \"daemon.h\"\n";
7328 pr "#include \"optgroups.h\"\n";
7331 pr "struct optgroup optgroups[] = {\n";
7334 pr " { \"%s\", optgroup_%s_available },\n" group group
7336 pr " { NULL, NULL }\n";
7339 and generate_daemon_optgroups_h () =
7340 generate_header CStyle GPLv2plus;
7344 pr "extern int optgroup_%s_available (void);\n" group
7347 (* Generate the tests. *)
7348 and generate_tests () =
7349 generate_header CStyle GPLv2plus;
7356 #include <sys/types.h>
7359 #include \"guestfs.h\"
7360 #include \"guestfs-internal.h\"
7362 static guestfs_h *g;
7363 static int suppress_error = 0;
7365 static void print_error (guestfs_h *g, void *data, const char *msg)
7367 if (!suppress_error)
7368 fprintf (stderr, \"%%s\\n\", msg);
7371 /* FIXME: nearly identical code appears in fish.c */
7372 static void print_strings (char *const *argv)
7376 for (argc = 0; argv[argc] != NULL; ++argc)
7377 printf (\"\\t%%s\\n\", argv[argc]);
7381 static void print_table (char const *const *argv)
7385 for (i = 0; argv[i] != NULL; i += 2)
7386 printf (\"%%s: %%s\\n\", argv[i], argv[i+1]);
7391 is_available (const char *group)
7393 const char *groups[] = { group, NULL };
7397 r = guestfs_available (g, (char **) groups);
7404 incr (guestfs_h *g, void *iv)
7406 int *i = (int *) iv;
7412 (* Generate a list of commands which are not tested anywhere. *)
7413 pr "static void no_test_warnings (void)\n";
7416 let hash : (string, bool) Hashtbl.t = Hashtbl.create 13 in
7418 fun (_, _, _, _, tests, _, _) ->
7419 let tests = filter_map (
7421 | (_, (Always|If _|Unless _|IfAvailable _), test) -> Some test
7422 | (_, Disabled, _) -> None
7424 let seq = List.concat (List.map seq_of_test tests) in
7425 let cmds_tested = List.map List.hd seq in
7426 List.iter (fun cmd -> Hashtbl.replace hash cmd true) cmds_tested
7430 fun (name, _, _, _, _, _, _) ->
7431 if not (Hashtbl.mem hash name) then
7432 pr " fprintf (stderr, \"warning: \\\"guestfs_%s\\\" has no tests\\n\");\n" name
7438 (* Generate the actual tests. Note that we generate the tests
7439 * in reverse order, deliberately, so that (in general) the
7440 * newest tests run first. This makes it quicker and easier to
7445 fun (name, _, _, flags, tests, _, _) ->
7446 mapi (generate_one_test name flags) tests
7447 ) (List.rev all_functions) in
7448 let test_names = List.concat test_names in
7449 let nr_tests = List.length test_names in
7452 int main (int argc, char *argv[])
7455 unsigned long int n_failed = 0;
7456 const char *filename;
7458 int nr_tests, test_num = 0;
7460 setbuf (stdout, NULL);
7462 no_test_warnings ();
7464 g = guestfs_create ();
7466 printf (\"guestfs_create FAILED\\n\");
7467 exit (EXIT_FAILURE);
7470 guestfs_set_error_handler (g, print_error, NULL);
7472 guestfs_set_path (g, \"../appliance\");
7474 filename = \"test1.img\";
7475 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
7478 exit (EXIT_FAILURE);
7480 if (lseek (fd, %d, SEEK_SET) == -1) {
7484 exit (EXIT_FAILURE);
7486 if (write (fd, &c, 1) == -1) {
7490 exit (EXIT_FAILURE);
7492 if (close (fd) == -1) {
7495 exit (EXIT_FAILURE);
7497 if (guestfs_add_drive (g, filename) == -1) {
7498 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
7499 exit (EXIT_FAILURE);
7502 filename = \"test2.img\";
7503 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
7506 exit (EXIT_FAILURE);
7508 if (lseek (fd, %d, SEEK_SET) == -1) {
7512 exit (EXIT_FAILURE);
7514 if (write (fd, &c, 1) == -1) {
7518 exit (EXIT_FAILURE);
7520 if (close (fd) == -1) {
7523 exit (EXIT_FAILURE);
7525 if (guestfs_add_drive (g, filename) == -1) {
7526 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
7527 exit (EXIT_FAILURE);
7530 filename = \"test3.img\";
7531 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
7534 exit (EXIT_FAILURE);
7536 if (lseek (fd, %d, SEEK_SET) == -1) {
7540 exit (EXIT_FAILURE);
7542 if (write (fd, &c, 1) == -1) {
7546 exit (EXIT_FAILURE);
7548 if (close (fd) == -1) {
7551 exit (EXIT_FAILURE);
7553 if (guestfs_add_drive (g, filename) == -1) {
7554 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
7555 exit (EXIT_FAILURE);
7558 if (guestfs_add_drive_ro (g, \"../images/test.iso\") == -1) {
7559 printf (\"guestfs_add_drive_ro ../images/test.iso FAILED\\n\");
7560 exit (EXIT_FAILURE);
7563 /* Set a timeout in case qemu hangs during launch (RHBZ#505329). */
7566 if (guestfs_launch (g) == -1) {
7567 printf (\"guestfs_launch FAILED\\n\");
7568 exit (EXIT_FAILURE);
7571 /* Cancel previous alarm. */
7576 " (500 * 1024 * 1024) (50 * 1024 * 1024) (10 * 1024 * 1024) nr_tests;
7580 pr " test_num++;\n";
7581 pr " if (guestfs_get_verbose (g))\n";
7582 pr " printf (\"-------------------------------------------------------------------------------\\n\");\n";
7583 pr " printf (\"%%3d/%%3d %s\\n\", test_num, nr_tests);\n" test_name;
7584 pr " if (%s () == -1) {\n" test_name;
7585 pr " printf (\"%s FAILED\\n\");\n" test_name;
7586 pr " n_failed++;\n";
7591 pr " /* Check close callback is called. */
7592 int close_sentinel = 1;
7593 guestfs_set_close_callback (g, incr, &close_sentinel);
7597 if (close_sentinel != 2) {
7598 fprintf (stderr, \"close callback was not called\\n\");
7599 exit (EXIT_FAILURE);
7602 unlink (\"test1.img\");
7603 unlink (\"test2.img\");
7604 unlink (\"test3.img\");
7608 pr " if (n_failed > 0) {\n";
7609 pr " printf (\"***** %%lu / %%d tests FAILED *****\\n\", n_failed, nr_tests);\n";
7610 pr " exit (EXIT_FAILURE);\n";
7614 pr " exit (EXIT_SUCCESS);\n";
7617 and generate_one_test name flags i (init, prereq, test) =
7618 let test_name = sprintf "test_%s_%d" name i in
7621 static int %s_skip (void)
7625 str = getenv (\"TEST_ONLY\");
7627 return strstr (str, \"%s\") == NULL;
7628 str = getenv (\"SKIP_%s\");
7629 if (str && STREQ (str, \"1\")) return 1;
7630 str = getenv (\"SKIP_TEST_%s\");
7631 if (str && STREQ (str, \"1\")) return 1;
7635 " test_name name (String.uppercase test_name) (String.uppercase name);
7638 | Disabled | Always | IfAvailable _ -> ()
7639 | If code | Unless code ->
7640 pr "static int %s_prereq (void)\n" test_name;
7648 static int %s (void)
7651 printf (\" %%s skipped (reason: environment variable set)\\n\", \"%s\");
7655 " test_name test_name test_name;
7657 (* Optional functions should only be tested if the relevant
7658 * support is available in the daemon.
7663 pr " if (!is_available (\"%s\")) {\n" group;
7664 pr " printf (\" %%s skipped (reason: group %%s not available in daemon)\\n\", \"%s\", \"%s\");\n" test_name group;
7672 pr " printf (\" %%s skipped (reason: test disabled in generator)\\n\", \"%s\");\n" test_name
7674 pr " if (! %s_prereq ()) {\n" test_name;
7675 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
7679 generate_one_test_body name i test_name init test;
7681 pr " if (%s_prereq ()) {\n" test_name;
7682 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
7686 generate_one_test_body name i test_name init test;
7687 | IfAvailable group ->
7688 pr " if (!is_available (\"%s\")) {\n" group;
7689 pr " printf (\" %%s skipped (reason: %%s not available)\\n\", \"%s\", \"%s\");\n" test_name group;
7693 generate_one_test_body name i test_name init test;
7695 generate_one_test_body name i test_name init test
7703 and generate_one_test_body name i test_name init test =
7705 | InitNone (* XXX at some point, InitNone and InitEmpty became
7706 * folded together as the same thing. Really we should
7707 * make InitNone do nothing at all, but the tests may
7708 * need to be checked to make sure this is OK.
7711 pr " /* InitNone|InitEmpty for %s */\n" test_name;
7712 List.iter (generate_test_command_call test_name)
7713 [["blockdev_setrw"; "/dev/sda"];
7717 pr " /* InitPartition for %s: create /dev/sda1 */\n" test_name;
7718 List.iter (generate_test_command_call test_name)
7719 [["blockdev_setrw"; "/dev/sda"];
7722 ["part_disk"; "/dev/sda"; "mbr"]]
7724 pr " /* InitBasicFS for %s: create ext2 on /dev/sda1 */\n" test_name;
7725 List.iter (generate_test_command_call test_name)
7726 [["blockdev_setrw"; "/dev/sda"];
7729 ["part_disk"; "/dev/sda"; "mbr"];
7730 ["mkfs"; "ext2"; "/dev/sda1"];
7731 ["mount_options"; ""; "/dev/sda1"; "/"]]
7732 | InitBasicFSonLVM ->
7733 pr " /* InitBasicFSonLVM for %s: create ext2 on /dev/VG/LV */\n"
7735 List.iter (generate_test_command_call test_name)
7736 [["blockdev_setrw"; "/dev/sda"];
7739 ["part_disk"; "/dev/sda"; "mbr"];
7740 ["pvcreate"; "/dev/sda1"];
7741 ["vgcreate"; "VG"; "/dev/sda1"];
7742 ["lvcreate"; "LV"; "VG"; "8"];
7743 ["mkfs"; "ext2"; "/dev/VG/LV"];
7744 ["mount_options"; ""; "/dev/VG/LV"; "/"]]
7746 pr " /* InitISOFS for %s */\n" test_name;
7747 List.iter (generate_test_command_call test_name)
7748 [["blockdev_setrw"; "/dev/sda"];
7751 ["mount_ro"; "/dev/sdd"; "/"]]
7754 let get_seq_last = function
7756 failwithf "%s: you cannot use [] (empty list) when expecting a command"
7759 let seq = List.rev seq in
7760 List.rev (List.tl seq), List.hd seq
7765 pr " /* TestRun for %s (%d) */\n" name i;
7766 List.iter (generate_test_command_call test_name) seq
7767 | TestOutput (seq, expected) ->
7768 pr " /* TestOutput for %s (%d) */\n" name i;
7769 pr " const char *expected = \"%s\";\n" (c_quote expected);
7770 let seq, last = get_seq_last seq in
7772 pr " if (STRNEQ (r, expected)) {\n";
7773 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
7777 List.iter (generate_test_command_call test_name) seq;
7778 generate_test_command_call ~test test_name last
7779 | TestOutputList (seq, expected) ->
7780 pr " /* TestOutputList for %s (%d) */\n" name i;
7781 let seq, last = get_seq_last seq in
7785 pr " if (!r[%d]) {\n" i;
7786 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
7787 pr " print_strings (r);\n";
7791 pr " const char *expected = \"%s\";\n" (c_quote str);
7792 pr " if (STRNEQ (r[%d], expected)) {\n" i;
7793 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
7798 pr " if (r[%d] != NULL) {\n" (List.length expected);
7799 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
7801 pr " print_strings (r);\n";
7805 List.iter (generate_test_command_call test_name) seq;
7806 generate_test_command_call ~test test_name last
7807 | TestOutputListOfDevices (seq, expected) ->
7808 pr " /* TestOutputListOfDevices for %s (%d) */\n" name i;
7809 let seq, last = get_seq_last seq in
7813 pr " if (!r[%d]) {\n" i;
7814 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
7815 pr " print_strings (r);\n";
7819 pr " const char *expected = \"%s\";\n" (c_quote str);
7820 pr " r[%d][5] = 's';\n" i;
7821 pr " if (STRNEQ (r[%d], expected)) {\n" i;
7822 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
7827 pr " if (r[%d] != NULL) {\n" (List.length expected);
7828 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
7830 pr " print_strings (r);\n";
7834 List.iter (generate_test_command_call test_name) seq;
7835 generate_test_command_call ~test test_name last
7836 | TestOutputInt (seq, expected) ->
7837 pr " /* TestOutputInt for %s (%d) */\n" name i;
7838 let seq, last = get_seq_last seq in
7840 pr " if (r != %d) {\n" expected;
7841 pr " fprintf (stderr, \"%s: expected %d but got %%d\\n\","
7847 List.iter (generate_test_command_call test_name) seq;
7848 generate_test_command_call ~test test_name last
7849 | TestOutputIntOp (seq, op, expected) ->
7850 pr " /* TestOutputIntOp for %s (%d) */\n" name i;
7851 let seq, last = get_seq_last seq in
7853 pr " if (! (r %s %d)) {\n" op expected;
7854 pr " fprintf (stderr, \"%s: expected %s %d but got %%d\\n\","
7855 test_name op expected;
7860 List.iter (generate_test_command_call test_name) seq;
7861 generate_test_command_call ~test test_name last
7862 | TestOutputTrue seq ->
7863 pr " /* TestOutputTrue for %s (%d) */\n" name i;
7864 let seq, last = get_seq_last seq in
7867 pr " fprintf (stderr, \"%s: expected true, got false\\n\");\n"
7872 List.iter (generate_test_command_call test_name) seq;
7873 generate_test_command_call ~test test_name last
7874 | TestOutputFalse seq ->
7875 pr " /* TestOutputFalse for %s (%d) */\n" name i;
7876 let seq, last = get_seq_last seq in
7879 pr " fprintf (stderr, \"%s: expected false, got true\\n\");\n"
7884 List.iter (generate_test_command_call test_name) seq;
7885 generate_test_command_call ~test test_name last
7886 | TestOutputLength (seq, expected) ->
7887 pr " /* TestOutputLength for %s (%d) */\n" name i;
7888 let seq, last = get_seq_last seq in
7891 pr " for (j = 0; j < %d; ++j)\n" expected;
7892 pr " if (r[j] == NULL) {\n";
7893 pr " fprintf (stderr, \"%s: short list returned\\n\");\n"
7895 pr " print_strings (r);\n";
7898 pr " if (r[j] != NULL) {\n";
7899 pr " fprintf (stderr, \"%s: long list returned\\n\");\n"
7901 pr " print_strings (r);\n";
7905 List.iter (generate_test_command_call test_name) seq;
7906 generate_test_command_call ~test test_name last
7907 | TestOutputBuffer (seq, expected) ->
7908 pr " /* TestOutputBuffer for %s (%d) */\n" name i;
7909 pr " const char *expected = \"%s\";\n" (c_quote expected);
7910 let seq, last = get_seq_last seq in
7911 let len = String.length expected in
7913 pr " if (size != %d) {\n" len;
7914 pr " fprintf (stderr, \"%s: returned size of buffer wrong, expected %d but got %%zu\\n\", size);\n" test_name len;
7917 pr " if (STRNEQLEN (r, expected, size)) {\n";
7918 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
7922 List.iter (generate_test_command_call test_name) seq;
7923 generate_test_command_call ~test test_name last
7924 | TestOutputStruct (seq, checks) ->
7925 pr " /* TestOutputStruct for %s (%d) */\n" name i;
7926 let seq, last = get_seq_last seq in
7930 | CompareWithInt (field, expected) ->
7931 pr " if (r->%s != %d) {\n" field expected;
7932 pr " fprintf (stderr, \"%s: %s was %%d, expected %d\\n\",\n"
7933 test_name field expected;
7934 pr " (int) r->%s);\n" field;
7937 | CompareWithIntOp (field, op, expected) ->
7938 pr " if (!(r->%s %s %d)) {\n" field op expected;
7939 pr " fprintf (stderr, \"%s: %s was %%d, expected %s %d\\n\",\n"
7940 test_name field op expected;
7941 pr " (int) r->%s);\n" field;
7944 | CompareWithString (field, expected) ->
7945 pr " if (STRNEQ (r->%s, \"%s\")) {\n" field expected;
7946 pr " fprintf (stderr, \"%s: %s was \"%%s\", expected \"%s\"\\n\",\n"
7947 test_name field expected;
7948 pr " r->%s);\n" field;
7951 | CompareFieldsIntEq (field1, field2) ->
7952 pr " if (r->%s != r->%s) {\n" field1 field2;
7953 pr " fprintf (stderr, \"%s: %s (%%d) <> %s (%%d)\\n\",\n"
7954 test_name field1 field2;
7955 pr " (int) r->%s, (int) r->%s);\n" field1 field2;
7958 | CompareFieldsStrEq (field1, field2) ->
7959 pr " if (STRNEQ (r->%s, r->%s)) {\n" field1 field2;
7960 pr " fprintf (stderr, \"%s: %s (\"%%s\") <> %s (\"%%s\")\\n\",\n"
7961 test_name field1 field2;
7962 pr " r->%s, r->%s);\n" field1 field2;
7967 List.iter (generate_test_command_call test_name) seq;
7968 generate_test_command_call ~test test_name last
7969 | TestLastFail seq ->
7970 pr " /* TestLastFail for %s (%d) */\n" name i;
7971 let seq, last = get_seq_last seq in
7972 List.iter (generate_test_command_call test_name) seq;
7973 generate_test_command_call test_name ~expect_error:true last
7975 (* Generate the code to run a command, leaving the result in 'r'.
7976 * If you expect to get an error then you should set expect_error:true.
7978 and generate_test_command_call ?(expect_error = false) ?test test_name cmd =
7980 | [] -> assert false
7982 (* Look up the command to find out what args/ret it has. *)
7985 let _, style, _, _, _, _, _ =
7986 List.find (fun (n, _, _, _, _, _, _) -> n = name) all_functions in
7989 failwithf "%s: in test, command %s was not found" test_name name in
7991 if List.length (snd style) <> List.length args then
7992 failwithf "%s: in test, wrong number of args given to %s"
7999 | OptString n, "NULL" -> ()
8002 | Dev_or_Path n, arg
8006 pr " const char *%s = \"%s\";\n" n (c_quote arg);
8007 | BufferIn n, arg ->
8008 pr " const char *%s = \"%s\";\n" n (c_quote arg);
8009 pr " size_t %s_size = %d;\n" n (String.length arg)
8013 | FileIn _, _ | FileOut _, _ -> ()
8014 | StringList n, "" | DeviceList n, "" ->
8015 pr " const char *const %s[1] = { NULL };\n" n
8016 | StringList n, arg | DeviceList n, arg ->
8017 let strs = string_split " " arg in
8020 pr " const char *%s_%d = \"%s\";\n" n i (c_quote str);
8022 pr " const char *const %s[] = {\n" n;
8024 fun i _ -> pr " %s_%d,\n" n i
8028 ) (List.combine (snd style) args);
8031 match fst style with
8032 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
8033 | RInt64 _ -> pr " int64_t r;\n"; "-1"
8034 | RConstString _ | RConstOptString _ ->
8035 pr " const char *r;\n"; "NULL"
8036 | RString _ -> pr " char *r;\n"; "NULL"
8037 | RStringList _ | RHashtable _ ->
8041 | RStruct (_, typ) ->
8042 pr " struct guestfs_%s *r;\n" typ; "NULL"
8043 | RStructList (_, typ) ->
8044 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
8047 pr " size_t size;\n";
8050 pr " suppress_error = %d;\n" (if expect_error then 1 else 0);
8051 pr " r = guestfs_%s (g" name;
8053 (* Generate the parameters. *)
8056 | OptString _, "NULL" -> pr ", NULL"
8058 | Device n, _ | Dev_or_Path n, _
8064 pr ", %s, %s_size" n n
8065 | FileIn _, arg | FileOut _, arg ->
8066 pr ", \"%s\"" (c_quote arg)
8067 | StringList n, _ | DeviceList n, _ ->
8068 pr ", (char **) %s" n
8071 try int_of_string arg
8072 with Failure "int_of_string" ->
8073 failwithf "%s: expecting an int, but got '%s'" test_name arg in
8077 try Int64.of_string arg
8078 with Failure "int_of_string" ->
8079 failwithf "%s: expecting an int64, but got '%s'" test_name arg in
8082 let b = bool_of_string arg in pr ", %d" (if b then 1 else 0)
8083 ) (List.combine (snd style) args);
8085 (match fst style with
8086 | RBufferOut _ -> pr ", &size"
8092 if not expect_error then
8093 pr " if (r == %s)\n" error_code
8095 pr " if (r != %s)\n" error_code;
8098 (* Insert the test code. *)
8104 (match fst style with
8105 | RErr | RInt _ | RInt64 _ | RBool _
8106 | RConstString _ | RConstOptString _ -> ()
8107 | RString _ | RBufferOut _ -> pr " free (r);\n"
8108 | RStringList _ | RHashtable _ ->
8109 pr " for (i = 0; r[i] != NULL; ++i)\n";
8110 pr " free (r[i]);\n";
8112 | RStruct (_, typ) ->
8113 pr " guestfs_free_%s (r);\n" typ
8114 | RStructList (_, typ) ->
8115 pr " guestfs_free_%s_list (r);\n" typ
8121 let str = replace_str str "\r" "\\r" in
8122 let str = replace_str str "\n" "\\n" in
8123 let str = replace_str str "\t" "\\t" in
8124 let str = replace_str str "\000" "\\0" in
8127 (* Generate a lot of different functions for guestfish. *)
8128 and generate_fish_cmds () =
8129 generate_header CStyle GPLv2plus;
8133 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
8135 let all_functions_sorted =
8137 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
8138 ) all_functions_sorted in
8140 pr "#include <config.h>\n";
8142 pr "#include <stdio.h>\n";
8143 pr "#include <stdlib.h>\n";
8144 pr "#include <string.h>\n";
8145 pr "#include <inttypes.h>\n";
8147 pr "#include <guestfs.h>\n";
8148 pr "#include \"c-ctype.h\"\n";
8149 pr "#include \"full-write.h\"\n";
8150 pr "#include \"xstrtol.h\"\n";
8151 pr "#include \"fish.h\"\n";
8153 pr "/* Valid suffixes allowed for numbers. See Gnulib xstrtol function. */\n";
8154 pr "static const char *xstrtol_suffixes = \"0kKMGTPEZY\";\n";
8157 (* list_commands function, which implements guestfish -h *)
8158 pr "void list_commands (void)\n";
8160 pr " printf (\" %%-16s %%s\\n\", _(\"Command\"), _(\"Description\"));\n";
8161 pr " list_builtin_commands ();\n";
8163 fun (name, _, _, flags, _, shortdesc, _) ->
8164 let name = replace_char name '_' '-' in
8165 pr " printf (\"%%-20s %%s\\n\", \"%s\", _(\"%s\"));\n"
8167 ) all_functions_sorted;
8168 pr " printf (\" %%s\\n\",";
8169 pr " _(\"Use -h <cmd> / help <cmd> to show detailed help for a command.\"));\n";
8173 (* display_command function, which implements guestfish -h cmd *)
8174 pr "int display_command (const char *cmd)\n";
8177 fun (name, style, _, flags, _, shortdesc, longdesc) ->
8178 let name2 = replace_char name '_' '-' in
8180 try find_map (function FishAlias n -> Some n | _ -> None) flags
8181 with Not_found -> name in
8182 let longdesc = replace_str longdesc "C<guestfs_" "C<" in
8184 match snd style with
8187 let args = List.filter (function Key _ -> false | _ -> true) args in
8189 name2 (String.concat " " (List.map name_of_argt args)) in
8192 if List.exists (function Key _ -> true | _ -> false) (snd style) then
8193 "\n\nThis command has one or more key or passphrase parameters.
8194 Guestfish will prompt for these separately."
8199 if List.mem ProtocolLimitWarning flags then
8200 ("\n\n" ^ protocol_limit_warning)
8203 (* For DangerWillRobinson commands, we should probably have
8204 * guestfish prompt before allowing you to use them (especially
8205 * in interactive mode). XXX
8209 if List.mem DangerWillRobinson flags then
8210 ("\n\n" ^ danger_will_robinson)
8215 match deprecation_notice flags with
8217 | Some txt -> "\n\n" ^ txt in
8219 let describe_alias =
8220 if name <> alias then
8221 sprintf "\n\nYou can use '%s' as an alias for this command." alias
8225 pr "STRCASEEQ (cmd, \"%s\")" name;
8226 if name <> name2 then
8227 pr " || STRCASEEQ (cmd, \"%s\")" name2;
8228 if name <> alias then
8229 pr " || STRCASEEQ (cmd, \"%s\")" alias;
8231 pr " pod2text (\"%s\", _(\"%s\"), %S);\n"
8233 ("=head1 SYNOPSIS\n\n " ^ synopsis ^ "\n\n" ^
8234 "=head1 DESCRIPTION\n\n" ^
8235 longdesc ^ warnings ^ describe_alias);
8240 pr " return display_builtin_command (cmd);\n";
8244 let emit_print_list_function typ =
8245 pr "static void print_%s_list (struct guestfs_%s_list *%ss)\n"
8248 pr " unsigned int i;\n";
8250 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
8251 pr " printf (\"[%%d] = {\\n\", i);\n";
8252 pr " print_%s_indent (&%ss->val[i], \" \");\n" typ typ;
8253 pr " printf (\"}\\n\");\n";
8259 (* print_* functions *)
8263 List.exists (function (_, (FUUID|FBuffer)) -> true | _ -> false) cols in
8265 pr "static void print_%s_indent (struct guestfs_%s *%s, const char *indent)\n" typ typ typ;
8268 pr " unsigned int i;\n";
8274 pr " printf (\"%%s%s: %%s\\n\", indent, %s->%s);\n" name typ name
8276 pr " printf (\"%%s%s: \", indent);\n" name;
8277 pr " for (i = 0; i < 32; ++i)\n";
8278 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
8279 pr " printf (\"\\n\");\n"
8281 pr " printf (\"%%s%s: \", indent);\n" name;
8282 pr " for (i = 0; i < %s->%s_len; ++i)\n" typ name;
8283 pr " if (c_isprint (%s->%s[i]))\n" typ name;
8284 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
8286 pr " printf (\"\\\\x%%02x\", %s->%s[i]);\n" typ name;
8287 pr " printf (\"\\n\");\n"
8288 | name, (FUInt64|FBytes) ->
8289 pr " printf (\"%%s%s: %%\" PRIu64 \"\\n\", indent, %s->%s);\n"
8292 pr " printf (\"%%s%s: %%\" PRIi64 \"\\n\", indent, %s->%s);\n"
8295 pr " printf (\"%%s%s: %%\" PRIu32 \"\\n\", indent, %s->%s);\n"
8298 pr " printf (\"%%s%s: %%\" PRIi32 \"\\n\", indent, %s->%s);\n"
8301 pr " printf (\"%%s%s: %%c\\n\", indent, %s->%s);\n"
8303 | name, FOptPercent ->
8304 pr " if (%s->%s >= 0) printf (\"%%s%s: %%g %%%%\\n\", indent, %s->%s);\n"
8305 typ name name typ name;
8306 pr " else printf (\"%%s%s: \\n\", indent);\n" name
8312 (* Emit a print_TYPE_list function definition only if that function is used. *)
8315 | typ, (RStructListOnly | RStructAndList) ->
8316 (* generate the function for typ *)
8317 emit_print_list_function typ
8318 | typ, _ -> () (* empty *)
8319 ) (rstructs_used_by all_functions);
8321 (* Emit a print_TYPE function definition only if that function is used. *)
8324 | typ, (RStructOnly | RStructAndList) ->
8325 pr "static void print_%s (struct guestfs_%s *%s)\n" typ typ typ;
8327 pr " print_%s_indent (%s, \"\");\n" typ typ;
8330 | typ, _ -> () (* empty *)
8331 ) (rstructs_used_by all_functions);
8333 (* run_<action> actions *)
8335 fun (name, style, _, flags, _, _, _) ->
8336 pr "static int run_%s (const char *cmd, int argc, char *argv[])\n" name;
8338 (match fst style with
8341 | RBool _ -> pr " int r;\n"
8342 | RInt64 _ -> pr " int64_t r;\n"
8343 | RConstString _ | RConstOptString _ -> pr " const char *r;\n"
8344 | RString _ -> pr " char *r;\n"
8345 | RStringList _ | RHashtable _ -> pr " char **r;\n"
8346 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ
8347 | RStructList (_, typ) -> pr " struct guestfs_%s_list *r;\n" typ
8350 pr " size_t size;\n";
8356 | OptString n -> pr " const char *%s;\n" n
8361 | Key n -> pr " char *%s;\n" n
8363 pr " const char *%s;\n" n;
8364 pr " size_t %s_size;\n" n
8365 | StringList n | DeviceList n -> pr " char **%s;\n" n
8366 | Bool n -> pr " int %s;\n" n
8367 | Int n -> pr " int %s;\n" n
8368 | Int64 n -> pr " int64_t %s;\n" n
8371 (* Check and convert parameters. *)
8374 List.filter (function Key _ -> false | _ -> true) (snd style) in
8375 List.length args_no_keys in
8376 pr " if (argc != %d) {\n" argc_expected;
8377 pr " fprintf (stderr, _(\"%%s should have %%d parameter(s)\\n\"), cmd, %d);\n"
8379 pr " fprintf (stderr, _(\"type 'help %%s' for help on %%s\\n\"), cmd, cmd);\n";
8383 let parse_integer fn fntyp rtyp range name =
8385 pr " strtol_error xerr;\n";
8386 pr " %s r;\n" fntyp;
8388 pr " xerr = %s (argv[i++], NULL, 0, &r, xstrtol_suffixes);\n" fn;
8389 pr " if (xerr != LONGINT_OK) {\n";
8390 pr " fprintf (stderr,\n";
8391 pr " _(\"%%s: %%s: invalid integer parameter (%%s returned %%d)\\n\"),\n";
8392 pr " cmd, \"%s\", \"%s\", xerr);\n" name fn;
8397 | Some (min, max, comment) ->
8398 pr " /* %s */\n" comment;
8399 pr " if (r < %s || r > %s) {\n" min max;
8400 pr " fprintf (stderr, _(\"%%s: %%s: integer out of range\\n\"), cmd, \"%s\");\n"
8404 pr " /* The check above should ensure this assignment does not overflow. */\n";
8406 pr " %s = r;\n" name;
8410 if snd style <> [] then
8411 pr " size_t i = 0;\n";
8417 pr " %s = argv[i++];\n" name
8419 | Dev_or_Path name ->
8420 pr " %s = resolve_win_path (argv[i++]);\n" name;
8421 pr " if (%s == NULL) return -1;\n" name
8423 pr " %s = STRNEQ (argv[i], \"\") ? argv[i] : NULL;\n" name;
8426 pr " %s = argv[i];\n" name;
8427 pr " %s_size = strlen (argv[i]);\n" name;
8430 pr " %s = file_in (argv[i++]);\n" name;
8431 pr " if (%s == NULL) return -1;\n" name
8433 pr " %s = file_out (argv[i++]);\n" name;
8434 pr " if (%s == NULL) return -1;\n" name
8435 | StringList name | DeviceList name ->
8436 pr " %s = parse_string_list (argv[i++]);\n" name;
8437 pr " if (%s == NULL) return -1;\n" name
8439 pr " %s = read_key (\"%s\");\n" name name;
8440 pr " if (%s == NULL) return -1;\n" name
8442 pr " %s = is_true (argv[i++]) ? 1 : 0;\n" name
8445 let min = "(-(2LL<<30))"
8446 and max = "((2LL<<30)-1)"
8448 "The Int type in the generator is a signed 31 bit int." in
8449 Some (min, max, comment) in
8450 parse_integer "xstrtoll" "long long" "int" range name
8452 parse_integer "xstrtoll" "long long" "int64_t" None name
8455 (* Call C API function. *)
8456 pr " r = guestfs_%s " name;
8457 generate_c_call_args ~handle:"g" style;
8462 | Device _ | String _
8463 | OptString _ | Bool _
8466 | Pathname name | Dev_or_Path name | FileOut name
8468 pr " free (%s);\n" name
8470 pr " free_file_in (%s);\n" name
8471 | StringList name | DeviceList name ->
8472 pr " free_strings (%s);\n" name
8475 (* Any output flags? *)
8477 let flags = filter_map (
8478 function FishOutput flag -> Some flag | _ -> None
8484 failwithf "%s: more than one FishOutput flag is not allowed" name in
8486 (* Check return value for errors and display command results. *)
8487 (match fst style with
8488 | RErr -> pr " return r;\n"
8490 pr " if (r == -1) return -1;\n";
8491 (match fish_output with
8493 pr " printf (\"%%d\\n\", r);\n";
8494 | Some FishOutputOctal ->
8495 pr " printf (\"%%s%%o\\n\", r != 0 ? \"0\" : \"\", r);\n";
8496 | Some FishOutputHexadecimal ->
8497 pr " printf (\"%%s%%x\\n\", r != 0 ? \"0x\" : \"\", r);\n");
8500 pr " if (r == -1) return -1;\n";
8501 (match fish_output with
8503 pr " printf (\"%%\" PRIi64 \"\\n\", r);\n";
8504 | Some FishOutputOctal ->
8505 pr " printf (\"%%s%%\" PRIo64 \"\\n\", r != 0 ? \"0\" : \"\", r);\n";
8506 | Some FishOutputHexadecimal ->
8507 pr " printf (\"%%s%%\" PRIx64 \"\\n\", r != 0 ? \"0x\" : \"\", r);\n");
8510 pr " if (r == -1) return -1;\n";
8511 pr " if (r) printf (\"true\\n\"); else printf (\"false\\n\");\n";
8514 pr " if (r == NULL) return -1;\n";
8515 pr " printf (\"%%s\\n\", r);\n";
8517 | RConstOptString _ ->
8518 pr " printf (\"%%s\\n\", r ? : \"(null)\");\n";
8521 pr " if (r == NULL) return -1;\n";
8522 pr " printf (\"%%s\\n\", r);\n";
8526 pr " if (r == NULL) return -1;\n";
8527 pr " print_strings (r);\n";
8528 pr " free_strings (r);\n";
8530 | RStruct (_, typ) ->
8531 pr " if (r == NULL) return -1;\n";
8532 pr " print_%s (r);\n" typ;
8533 pr " guestfs_free_%s (r);\n" typ;
8535 | RStructList (_, typ) ->
8536 pr " if (r == NULL) return -1;\n";
8537 pr " print_%s_list (r);\n" typ;
8538 pr " guestfs_free_%s_list (r);\n" typ;
8541 pr " if (r == NULL) return -1;\n";
8542 pr " print_table (r);\n";
8543 pr " free_strings (r);\n";
8546 pr " if (r == NULL) return -1;\n";
8547 pr " if (full_write (1, r, size) != size) {\n";
8548 pr " perror (\"write\");\n";
8559 (* run_action function *)
8560 pr "int run_action (const char *cmd, int argc, char *argv[])\n";
8563 fun (name, _, _, flags, _, _, _) ->
8564 let name2 = replace_char name '_' '-' in
8566 try find_map (function FishAlias n -> Some n | _ -> None) flags
8567 with Not_found -> name in
8569 pr "STRCASEEQ (cmd, \"%s\")" name;
8570 if name <> name2 then
8571 pr " || STRCASEEQ (cmd, \"%s\")" name2;
8572 if name <> alias then
8573 pr " || STRCASEEQ (cmd, \"%s\")" alias;
8575 pr " return run_%s (cmd, argc, argv);\n" name;
8579 pr " fprintf (stderr, _(\"%%s: unknown command\\n\"), cmd);\n";
8580 pr " if (command_num == 1)\n";
8581 pr " extended_help_message ();\n";
8588 (* Readline completion for guestfish. *)
8589 and generate_fish_completion () =
8590 generate_header CStyle GPLv2plus;
8594 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
8604 #ifdef HAVE_LIBREADLINE
8605 #include <readline/readline.h>
8610 #ifdef HAVE_LIBREADLINE
8612 static const char *const commands[] = {
8613 BUILTIN_COMMANDS_FOR_COMPLETION,
8616 (* Get the commands, including the aliases. They don't need to be
8617 * sorted - the generator() function just does a dumb linear search.
8621 fun (name, _, _, flags, _, _, _) ->
8622 let name2 = replace_char name '_' '-' in
8624 try find_map (function FishAlias n -> Some n | _ -> None) flags
8625 with Not_found -> name in
8627 if name <> alias then [name2; alias] else [name2]
8629 let commands = List.flatten commands in
8631 List.iter (pr " \"%s\",\n") commands;
8637 generator (const char *text, int state)
8639 static size_t index, len;
8644 len = strlen (text);
8647 rl_attempted_completion_over = 1;
8649 while ((name = commands[index]) != NULL) {
8651 if (STRCASEEQLEN (name, text, len))
8652 return strdup (name);
8658 #endif /* HAVE_LIBREADLINE */
8660 #ifdef HAVE_RL_COMPLETION_MATCHES
8661 #define RL_COMPLETION_MATCHES rl_completion_matches
8663 #ifdef HAVE_COMPLETION_MATCHES
8664 #define RL_COMPLETION_MATCHES completion_matches
8666 #endif /* else just fail if we don't have either symbol */
8669 do_completion (const char *text, int start, int end)
8671 char **matches = NULL;
8673 #ifdef HAVE_LIBREADLINE
8674 rl_completion_append_character = ' ';
8677 matches = RL_COMPLETION_MATCHES (text, generator);
8678 else if (complete_dest_paths)
8679 matches = RL_COMPLETION_MATCHES (text, complete_dest_paths_generator);
8686 (* Generate the POD documentation for guestfish. *)
8687 and generate_fish_actions_pod () =
8688 let all_functions_sorted =
8690 fun (_, _, _, flags, _, _, _) ->
8691 not (List.mem NotInFish flags || List.mem NotInDocs flags)
8692 ) all_functions_sorted in
8694 let rex = Str.regexp "C<guestfs_\\([^>]+\\)>" in
8697 fun (name, style, _, flags, _, _, longdesc) ->
8699 Str.global_substitute rex (
8702 try Str.matched_group 1 s
8704 failwithf "error substituting C<guestfs_...> in longdesc of function %s" name in
8705 "C<" ^ replace_char sub '_' '-' ^ ">"
8707 let name = replace_char name '_' '-' in
8709 try find_map (function FishAlias n -> Some n | _ -> None) flags
8710 with Not_found -> name in
8712 pr "=head2 %s" name;
8713 if name <> alias then
8720 | Pathname n | Device n | Dev_or_Path n | String n ->
8722 | OptString n -> pr " %s" n
8723 | StringList n | DeviceList n -> pr " '%s ...'" n
8724 | Bool _ -> pr " true|false"
8725 | Int n -> pr " %s" n
8726 | Int64 n -> pr " %s" n
8727 | FileIn n | FileOut n -> pr " (%s|-)" n
8728 | BufferIn n -> pr " %s" n
8729 | Key _ -> () (* keys are entered at a prompt *)
8733 pr "%s\n\n" longdesc;
8735 if List.exists (function FileIn _ | FileOut _ -> true
8736 | _ -> false) (snd style) then
8737 pr "Use C<-> instead of a filename to read/write from stdin/stdout.\n\n";
8739 if List.exists (function Key _ -> true | _ -> false) (snd style) then
8740 pr "This command has one or more key or passphrase parameters.
8741 Guestfish will prompt for these separately.\n\n";
8743 if List.mem ProtocolLimitWarning flags then
8744 pr "%s\n\n" protocol_limit_warning;
8746 if List.mem DangerWillRobinson flags then
8747 pr "%s\n\n" danger_will_robinson;
8749 match deprecation_notice flags with
8751 | Some txt -> pr "%s\n\n" txt
8752 ) all_functions_sorted
8754 (* Generate a C function prototype. *)
8755 and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true)
8756 ?(single_line = false) ?(newline = false) ?(in_daemon = false)
8758 ?handle name style =
8759 if extern then pr "extern ";
8760 if static then pr "static ";
8761 (match fst style with
8763 | RInt _ -> pr "int "
8764 | RInt64 _ -> pr "int64_t "
8765 | RBool _ -> pr "int "
8766 | RConstString _ | RConstOptString _ -> pr "const char *"
8767 | RString _ | RBufferOut _ -> pr "char *"
8768 | RStringList _ | RHashtable _ -> pr "char **"
8769 | RStruct (_, typ) ->
8770 if not in_daemon then pr "struct guestfs_%s *" typ
8771 else pr "guestfs_int_%s *" typ
8772 | RStructList (_, typ) ->
8773 if not in_daemon then pr "struct guestfs_%s_list *" typ
8774 else pr "guestfs_int_%s_list *" typ
8776 let is_RBufferOut = match fst style with RBufferOut _ -> true | _ -> false in
8777 pr "%s%s (" prefix name;
8778 if handle = None && List.length (snd style) = 0 && not is_RBufferOut then
8781 let comma = ref false in
8784 | Some handle -> pr "guestfs_h *%s" handle; comma := true
8788 if single_line then pr ", " else pr ",\n\t\t"
8795 | Device n | Dev_or_Path n
8800 pr "const char *%s" n
8801 | StringList n | DeviceList n ->
8803 pr "char *const *%s" n
8804 | Bool n -> next (); pr "int %s" n
8805 | Int n -> next (); pr "int %s" n
8806 | Int64 n -> next (); pr "int64_t %s" n
8809 if not in_daemon then (next (); pr "const char *%s" n)
8812 pr "const char *%s" n;
8814 pr "size_t %s_size" n
8816 if is_RBufferOut then (next (); pr "size_t *size_r");
8819 if semicolon then pr ";";
8820 if newline then pr "\n"
8822 (* Generate C call arguments, eg "(handle, foo, bar)" *)
8823 and generate_c_call_args ?handle ?(decl = false) style =
8825 let comma = ref false in
8827 if !comma then pr ", ";
8832 | Some handle -> pr "%s" handle; comma := true
8838 pr "%s, %s_size" n n
8841 pr "%s" (name_of_argt arg)
8843 (* For RBufferOut calls, add implicit &size parameter. *)
8845 match fst style with
8853 (* Generate the OCaml bindings interface. *)
8854 and generate_ocaml_mli () =
8855 generate_header OCamlStyle LGPLv2plus;
8858 (** For API documentation you should refer to the C API
8859 in the guestfs(3) manual page. The OCaml API uses almost
8860 exactly the same calls. *)
8863 (** A [guestfs_h] handle. *)
8865 exception Error of string
8866 (** This exception is raised when there is an error. *)
8868 exception Handle_closed of string
8869 (** This exception is raised if you use a {!Guestfs.t} handle
8870 after calling {!close} on it. The string is the name of
8873 val create : unit -> t
8874 (** Create a {!Guestfs.t} handle. *)
8876 val close : t -> unit
8877 (** Close the {!Guestfs.t} handle and free up all resources used
8880 Handles are closed by the garbage collector when they become
8881 unreferenced, but callers can call this in order to provide
8882 predictable cleanup. *)
8885 generate_ocaml_structure_decls ();
8889 fun (name, style, _, _, _, shortdesc, _) ->
8890 generate_ocaml_prototype name style;
8891 pr "(** %s *)\n" shortdesc;
8893 ) all_functions_sorted
8895 (* Generate the OCaml bindings implementation. *)
8896 and generate_ocaml_ml () =
8897 generate_header OCamlStyle LGPLv2plus;
8902 exception Error of string
8903 exception Handle_closed of string
8905 external create : unit -> t = \"ocaml_guestfs_create\"
8906 external close : t -> unit = \"ocaml_guestfs_close\"
8908 (* Give the exceptions names, so they can be raised from the C code. *)
8910 Callback.register_exception \"ocaml_guestfs_error\" (Error \"\");
8911 Callback.register_exception \"ocaml_guestfs_closed\" (Handle_closed \"\")
8915 generate_ocaml_structure_decls ();
8919 fun (name, style, _, _, _, shortdesc, _) ->
8920 generate_ocaml_prototype ~is_external:true name style;
8921 ) all_functions_sorted
8923 (* Generate the OCaml bindings C implementation. *)
8924 and generate_ocaml_c () =
8925 generate_header CStyle LGPLv2plus;
8932 #include <caml/config.h>
8933 #include <caml/alloc.h>
8934 #include <caml/callback.h>
8935 #include <caml/fail.h>
8936 #include <caml/memory.h>
8937 #include <caml/mlvalues.h>
8938 #include <caml/signals.h>
8940 #include \"guestfs.h\"
8942 #include \"guestfs_c.h\"
8944 /* Copy a hashtable of string pairs into an assoc-list. We return
8945 * the list in reverse order, but hashtables aren't supposed to be
8948 static CAMLprim value
8949 copy_table (char * const * argv)
8952 CAMLlocal5 (rv, pairv, kv, vv, cons);
8956 for (i = 0; argv[i] != NULL; i += 2) {
8957 kv = caml_copy_string (argv[i]);
8958 vv = caml_copy_string (argv[i+1]);
8959 pairv = caml_alloc (2, 0);
8960 Store_field (pairv, 0, kv);
8961 Store_field (pairv, 1, vv);
8962 cons = caml_alloc (2, 0);
8963 Store_field (cons, 1, rv);
8965 Store_field (cons, 0, pairv);
8973 (* Struct copy functions. *)
8975 let emit_ocaml_copy_list_function typ =
8976 pr "static CAMLprim value\n";
8977 pr "copy_%s_list (const struct guestfs_%s_list *%ss)\n" typ typ typ;
8979 pr " CAMLparam0 ();\n";
8980 pr " CAMLlocal2 (rv, v);\n";
8981 pr " unsigned int i;\n";
8983 pr " if (%ss->len == 0)\n" typ;
8984 pr " CAMLreturn (Atom (0));\n";
8986 pr " rv = caml_alloc (%ss->len, 0);\n" typ;
8987 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
8988 pr " v = copy_%s (&%ss->val[i]);\n" typ typ;
8989 pr " caml_modify (&Field (rv, i), v);\n";
8991 pr " CAMLreturn (rv);\n";
8999 let has_optpercent_col =
9000 List.exists (function (_, FOptPercent) -> true | _ -> false) cols in
9002 pr "static CAMLprim value\n";
9003 pr "copy_%s (const struct guestfs_%s *%s)\n" typ typ typ;
9005 pr " CAMLparam0 ();\n";
9006 if has_optpercent_col then
9007 pr " CAMLlocal3 (rv, v, v2);\n"
9009 pr " CAMLlocal2 (rv, v);\n";
9011 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
9016 pr " v = caml_copy_string (%s->%s);\n" typ name
9018 pr " v = caml_alloc_string (%s->%s_len);\n" typ name;
9019 pr " memcpy (String_val (v), %s->%s, %s->%s_len);\n"
9022 pr " v = caml_alloc_string (32);\n";
9023 pr " memcpy (String_val (v), %s->%s, 32);\n" typ name
9024 | name, (FBytes|FInt64|FUInt64) ->
9025 pr " v = caml_copy_int64 (%s->%s);\n" typ name
9026 | name, (FInt32|FUInt32) ->
9027 pr " v = caml_copy_int32 (%s->%s);\n" typ name
9028 | name, FOptPercent ->
9029 pr " if (%s->%s >= 0) { /* Some %s */\n" typ name name;
9030 pr " v2 = caml_copy_double (%s->%s);\n" typ name;
9031 pr " v = caml_alloc (1, 0);\n";
9032 pr " Store_field (v, 0, v2);\n";
9033 pr " } else /* None */\n";
9034 pr " v = Val_int (0);\n";
9036 pr " v = Val_int (%s->%s);\n" typ name
9038 pr " Store_field (rv, %d, v);\n" i
9040 pr " CAMLreturn (rv);\n";
9045 (* Emit a copy_TYPE_list function definition only if that function is used. *)
9048 | typ, (RStructListOnly | RStructAndList) ->
9049 (* generate the function for typ *)
9050 emit_ocaml_copy_list_function typ
9051 | typ, _ -> () (* empty *)
9052 ) (rstructs_used_by all_functions);
9056 fun (name, style, _, _, _, _, _) ->
9057 pr "/* Automatically generated wrapper for function\n";
9059 generate_ocaml_prototype name style;
9064 "gv" :: List.map (fun arg -> name_of_argt arg ^ "v") (snd style) in
9066 let needs_extra_vs =
9067 match fst style with RConstOptString _ -> true | _ -> false in
9069 pr "/* Emit prototype to appease gcc's -Wmissing-prototypes. */\n";
9070 pr "CAMLprim value ocaml_guestfs_%s (value %s" name (List.hd params);
9071 List.iter (pr ", value %s") (List.tl params); pr ");\n";
9074 pr "CAMLprim value\n";
9075 pr "ocaml_guestfs_%s (value %s" name (List.hd params);
9076 List.iter (pr ", value %s") (List.tl params);
9081 | [p1; p2; p3; p4; p5] ->
9082 pr " CAMLparam5 (%s);\n" (String.concat ", " params)
9083 | p1 :: p2 :: p3 :: p4 :: p5 :: rest ->
9084 pr " CAMLparam5 (%s);\n" (String.concat ", " [p1; p2; p3; p4; p5]);
9085 pr " CAMLxparam%d (%s);\n"
9086 (List.length rest) (String.concat ", " rest)
9088 pr " CAMLparam%d (%s);\n" (List.length ps) (String.concat ", " ps)
9090 if not needs_extra_vs then
9091 pr " CAMLlocal1 (rv);\n"
9093 pr " CAMLlocal3 (rv, v, v2);\n";
9096 pr " guestfs_h *g = Guestfs_val (gv);\n";
9097 pr " if (g == NULL)\n";
9098 pr " ocaml_guestfs_raise_closed (\"%s\");\n" name;
9104 | Device n | Dev_or_Path n
9109 (* Copy strings in case the GC moves them: RHBZ#604691 *)
9110 pr " char *%s = guestfs_safe_strdup (g, String_val (%sv));\n" n n
9112 pr " char *%s =\n" n;
9113 pr " %sv != Val_int (0) ?" n;
9114 pr " guestfs_safe_strdup (g, String_val (Field (%sv, 0))) : NULL;\n" n
9116 pr " size_t %s_size = caml_string_length (%sv);\n" n n;
9117 pr " char *%s = guestfs_safe_memdup (g, String_val (%sv), %s_size);\n" n n n
9118 | StringList n | DeviceList n ->
9119 pr " char **%s = ocaml_guestfs_strings_val (g, %sv);\n" n n
9121 pr " int %s = Bool_val (%sv);\n" n n
9123 pr " int %s = Int_val (%sv);\n" n n
9125 pr " int64_t %s = Int64_val (%sv);\n" n n
9128 match fst style with
9129 | RErr -> pr " int r;\n"; "-1"
9130 | RInt _ -> pr " int r;\n"; "-1"
9131 | RInt64 _ -> pr " int64_t r;\n"; "-1"
9132 | RBool _ -> pr " int r;\n"; "-1"
9133 | RConstString _ | RConstOptString _ ->
9134 pr " const char *r;\n"; "NULL"
9135 | RString _ -> pr " char *r;\n"; "NULL"
9140 | RStruct (_, typ) ->
9141 pr " struct guestfs_%s *r;\n" typ; "NULL"
9142 | RStructList (_, typ) ->
9143 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
9150 pr " size_t size;\n";
9154 pr " caml_enter_blocking_section ();\n";
9155 pr " r = guestfs_%s " name;
9156 generate_c_call_args ~handle:"g" style;
9158 pr " caml_leave_blocking_section ();\n";
9160 (* Free strings if we copied them above. *)
9163 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
9164 | FileIn n | FileOut n | BufferIn n | Key n ->
9165 pr " free (%s);\n" n
9166 | StringList n | DeviceList n ->
9167 pr " ocaml_guestfs_free_strings (%s);\n" n;
9168 | Bool _ | Int _ | Int64 _ -> ()
9171 pr " if (r == %s)\n" error_code;
9172 pr " ocaml_guestfs_raise_error (g, \"%s\");\n" name;
9175 (match fst style with
9176 | RErr -> pr " rv = Val_unit;\n"
9177 | RInt _ -> pr " rv = Val_int (r);\n"
9179 pr " rv = caml_copy_int64 (r);\n"
9180 | RBool _ -> pr " rv = Val_bool (r);\n"
9182 pr " rv = caml_copy_string (r);\n"
9183 | RConstOptString _ ->
9184 pr " if (r) { /* Some string */\n";
9185 pr " v = caml_alloc (1, 0);\n";
9186 pr " v2 = caml_copy_string (r);\n";
9187 pr " Store_field (v, 0, v2);\n";
9188 pr " } else /* None */\n";
9189 pr " v = Val_int (0);\n";
9191 pr " rv = caml_copy_string (r);\n";
9194 pr " rv = caml_copy_string_array ((const char **) r);\n";
9195 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
9197 | RStruct (_, typ) ->
9198 pr " rv = copy_%s (r);\n" typ;
9199 pr " guestfs_free_%s (r);\n" typ;
9200 | RStructList (_, typ) ->
9201 pr " rv = copy_%s_list (r);\n" typ;
9202 pr " guestfs_free_%s_list (r);\n" typ;
9204 pr " rv = copy_table (r);\n";
9205 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
9208 pr " rv = caml_alloc_string (size);\n";
9209 pr " memcpy (String_val (rv), r, size);\n";
9212 pr " CAMLreturn (rv);\n";
9216 if List.length params > 5 then (
9217 pr "/* Emit prototype to appease gcc's -Wmissing-prototypes. */\n";
9218 pr "CAMLprim value ";
9219 pr "ocaml_guestfs_%s_byte (value *argv, int argn);\n" name;
9220 pr "CAMLprim value\n";
9221 pr "ocaml_guestfs_%s_byte (value *argv, int argn)\n" name;
9223 pr " return ocaml_guestfs_%s (argv[0]" name;
9224 iteri (fun i _ -> pr ", argv[%d]" i) (List.tl params);
9229 ) all_functions_sorted
9231 and generate_ocaml_structure_decls () =
9234 pr "type %s = {\n" typ;
9237 | name, FString -> pr " %s : string;\n" name
9238 | name, FBuffer -> pr " %s : string;\n" name
9239 | name, FUUID -> pr " %s : string;\n" name
9240 | name, (FBytes|FInt64|FUInt64) -> pr " %s : int64;\n" name
9241 | name, (FInt32|FUInt32) -> pr " %s : int32;\n" name
9242 | name, FChar -> pr " %s : char;\n" name
9243 | name, FOptPercent -> pr " %s : float option;\n" name
9249 and generate_ocaml_prototype ?(is_external = false) name style =
9250 if is_external then pr "external " else pr "val ";
9251 pr "%s : t -> " name;
9254 | Pathname _ | Device _ | Dev_or_Path _ | String _ | FileIn _ | FileOut _
9255 | BufferIn _ | Key _ -> pr "string -> "
9256 | OptString _ -> pr "string option -> "
9257 | StringList _ | DeviceList _ -> pr "string array -> "
9258 | Bool _ -> pr "bool -> "
9259 | Int _ -> pr "int -> "
9260 | Int64 _ -> pr "int64 -> "
9262 (match fst style with
9263 | RErr -> pr "unit" (* all errors are turned into exceptions *)
9264 | RInt _ -> pr "int"
9265 | RInt64 _ -> pr "int64"
9266 | RBool _ -> pr "bool"
9267 | RConstString _ -> pr "string"
9268 | RConstOptString _ -> pr "string option"
9269 | RString _ | RBufferOut _ -> pr "string"
9270 | RStringList _ -> pr "string array"
9271 | RStruct (_, typ) -> pr "%s" typ
9272 | RStructList (_, typ) -> pr "%s array" typ
9273 | RHashtable _ -> pr "(string * string) list"
9275 if is_external then (
9277 if List.length (snd style) + 1 > 5 then
9278 pr "\"ocaml_guestfs_%s_byte\" " name;
9279 pr "\"ocaml_guestfs_%s\"" name
9283 (* Generate Perl xs code, a sort of crazy variation of C with macros. *)
9284 and generate_perl_xs () =
9285 generate_header CStyle LGPLv2plus;
9288 #include \"EXTERN.h\"
9292 #include <guestfs.h>
9295 #define PRId64 \"lld\"
9299 my_newSVll(long long val) {
9300 #ifdef USE_64_BIT_ALL
9301 return newSViv(val);
9305 len = snprintf(buf, 100, \"%%\" PRId64, val);
9306 return newSVpv(buf, len);
9311 #define PRIu64 \"llu\"
9315 my_newSVull(unsigned long long val) {
9316 #ifdef USE_64_BIT_ALL
9317 return newSVuv(val);
9321 len = snprintf(buf, 100, \"%%\" PRIu64, val);
9322 return newSVpv(buf, len);
9326 /* http://www.perlmonks.org/?node_id=680842 */
9328 XS_unpack_charPtrPtr (SV *arg) {
9333 if (!arg || !SvOK (arg) || !SvROK (arg) || SvTYPE (SvRV (arg)) != SVt_PVAV)
9334 croak (\"array reference expected\");
9336 av = (AV *)SvRV (arg);
9337 ret = malloc ((av_len (av) + 1 + 1) * sizeof (char *));
9339 croak (\"malloc failed\");
9341 for (i = 0; i <= av_len (av); i++) {
9342 SV **elem = av_fetch (av, i, 0);
9344 if (!elem || !*elem)
9345 croak (\"missing element in list\");
9347 ret[i] = SvPV_nolen (*elem);
9355 MODULE = Sys::Guestfs PACKAGE = Sys::Guestfs
9362 RETVAL = guestfs_create ();
9364 croak (\"could not create guestfs handle\");
9365 guestfs_set_error_handler (RETVAL, NULL, NULL);
9373 /* For the 'g' argument above we do the conversion explicitly and
9374 * don't rely on the typemap, because if the handle has been
9375 * explicitly closed we don't want the typemap conversion to
9378 HV *hv = (HV *) SvRV (sv);
9379 SV **svp = hv_fetch (hv, \"_g\", 2, 0);
9381 guestfs_h *g = (guestfs_h *) SvIV (*svp);
9391 /* Avoid double-free in DESTROY method. */
9392 HV *hv = (HV *) SvRV (ST(0));
9393 (void) hv_delete (hv, \"_g\", 2, G_DISCARD);
9398 fun (name, style, _, _, _, _, _) ->
9399 (match fst style with
9400 | RErr -> pr "void\n"
9401 | RInt _ -> pr "SV *\n"
9402 | RInt64 _ -> pr "SV *\n"
9403 | RBool _ -> pr "SV *\n"
9404 | RConstString _ -> pr "SV *\n"
9405 | RConstOptString _ -> pr "SV *\n"
9406 | RString _ -> pr "SV *\n"
9407 | RBufferOut _ -> pr "SV *\n"
9409 | RStruct _ | RStructList _
9411 pr "void\n" (* all lists returned implictly on the stack *)
9413 (* Call and arguments. *)
9416 fun arg -> pr ", %s" (name_of_argt arg)
9419 pr " guestfs_h *g;\n";
9423 | Pathname n | Device n | Dev_or_Path n | String n
9424 | FileIn n | FileOut n | Key n ->
9427 pr " char *%s;\n" n;
9428 pr " size_t %s_size = SvCUR (ST(%d));\n" n (i+1)
9430 (* http://www.perlmonks.org/?node_id=554277
9431 * Note that the implicit handle argument means we have
9432 * to add 1 to the ST(x) operator.
9434 pr " char *%s = SvOK(ST(%d)) ? SvPV_nolen(ST(%d)) : NULL;\n" n (i+1) (i+1)
9435 | StringList n | DeviceList n -> pr " char **%s;\n" n
9436 | Bool n -> pr " int %s;\n" n
9437 | Int n -> pr " int %s;\n" n
9438 | Int64 n -> pr " int64_t %s;\n" n
9441 let do_cleanups () =
9444 | Pathname _ | Device _ | Dev_or_Path _ | String _ | OptString _
9445 | Bool _ | Int _ | Int64 _
9446 | FileIn _ | FileOut _
9447 | BufferIn _ | Key _ -> ()
9448 | StringList n | DeviceList n -> pr " free (%s);\n" n
9453 (match fst style with
9458 pr " r = guestfs_%s " name;
9459 generate_c_call_args ~handle:"g" style;
9462 pr " if (r == -1)\n";
9463 pr " croak (\"%%s\", guestfs_last_error (g));\n";
9469 pr " %s = guestfs_%s " n name;
9470 generate_c_call_args ~handle:"g" style;
9473 pr " if (%s == -1)\n" n;
9474 pr " croak (\"%%s\", guestfs_last_error (g));\n";
9475 pr " RETVAL = newSViv (%s);\n" n;
9480 pr " int64_t %s;\n" n;
9482 pr " %s = guestfs_%s " n name;
9483 generate_c_call_args ~handle:"g" style;
9486 pr " if (%s == -1)\n" n;
9487 pr " croak (\"%%s\", guestfs_last_error (g));\n";
9488 pr " RETVAL = my_newSVll (%s);\n" n;
9493 pr " const char *%s;\n" n;
9495 pr " %s = guestfs_%s " n name;
9496 generate_c_call_args ~handle:"g" style;
9499 pr " if (%s == NULL)\n" n;
9500 pr " croak (\"%%s\", guestfs_last_error (g));\n";
9501 pr " RETVAL = newSVpv (%s, 0);\n" n;
9504 | RConstOptString n ->
9506 pr " const char *%s;\n" n;
9508 pr " %s = guestfs_%s " n name;
9509 generate_c_call_args ~handle:"g" style;
9512 pr " if (%s == NULL)\n" n;
9513 pr " RETVAL = &PL_sv_undef;\n";
9515 pr " RETVAL = newSVpv (%s, 0);\n" n;
9520 pr " char *%s;\n" n;
9522 pr " %s = guestfs_%s " n name;
9523 generate_c_call_args ~handle:"g" style;
9526 pr " if (%s == NULL)\n" n;
9527 pr " croak (\"%%s\", guestfs_last_error (g));\n";
9528 pr " RETVAL = newSVpv (%s, 0);\n" n;
9529 pr " free (%s);\n" n;
9532 | RStringList n | RHashtable n ->
9534 pr " char **%s;\n" n;
9535 pr " size_t i, n;\n";
9537 pr " %s = guestfs_%s " n name;
9538 generate_c_call_args ~handle:"g" style;
9541 pr " if (%s == NULL)\n" n;
9542 pr " croak (\"%%s\", guestfs_last_error (g));\n";
9543 pr " for (n = 0; %s[n] != NULL; ++n) /**/;\n" n;
9544 pr " EXTEND (SP, n);\n";
9545 pr " for (i = 0; i < n; ++i) {\n";
9546 pr " PUSHs (sv_2mortal (newSVpv (%s[i], 0)));\n" n;
9547 pr " free (%s[i]);\n" n;
9549 pr " free (%s);\n" n;
9550 | RStruct (n, typ) ->
9551 let cols = cols_of_struct typ in
9552 generate_perl_struct_code typ cols name style n do_cleanups
9553 | RStructList (n, typ) ->
9554 let cols = cols_of_struct typ in
9555 generate_perl_struct_list_code typ cols name style n do_cleanups
9558 pr " char *%s;\n" n;
9559 pr " size_t size;\n";
9561 pr " %s = guestfs_%s " n name;
9562 generate_c_call_args ~handle:"g" style;
9565 pr " if (%s == NULL)\n" n;
9566 pr " croak (\"%%s\", guestfs_last_error (g));\n";
9567 pr " RETVAL = newSVpvn (%s, size);\n" n;
9568 pr " free (%s);\n" n;
9576 and generate_perl_struct_list_code typ cols name style n do_cleanups =
9578 pr " struct guestfs_%s_list *%s;\n" typ n;
9582 pr " %s = guestfs_%s " n name;
9583 generate_c_call_args ~handle:"g" style;
9586 pr " if (%s == NULL)\n" n;
9587 pr " croak (\"%%s\", guestfs_last_error (g));\n";
9588 pr " EXTEND (SP, %s->len);\n" n;
9589 pr " for (i = 0; i < %s->len; ++i) {\n" n;
9590 pr " hv = newHV ();\n";
9594 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 0), 0);\n"
9595 name (String.length name) n name
9597 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 32), 0);\n"
9598 name (String.length name) n name
9600 pr " (void) hv_store (hv, \"%s\", %d, newSVpvn (%s->val[i].%s, %s->val[i].%s_len), 0);\n"
9601 name (String.length name) n name n name
9602 | name, (FBytes|FUInt64) ->
9603 pr " (void) hv_store (hv, \"%s\", %d, my_newSVull (%s->val[i].%s), 0);\n"
9604 name (String.length name) n name
9606 pr " (void) hv_store (hv, \"%s\", %d, my_newSVll (%s->val[i].%s), 0);\n"
9607 name (String.length name) n name
9608 | name, (FInt32|FUInt32) ->
9609 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
9610 name (String.length name) n name
9612 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (&%s->val[i].%s, 1), 0);\n"
9613 name (String.length name) n name
9614 | name, FOptPercent ->
9615 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
9616 name (String.length name) n name
9618 pr " PUSHs (sv_2mortal (newRV ((SV *) hv)));\n";
9620 pr " guestfs_free_%s_list (%s);\n" typ n
9622 and generate_perl_struct_code typ cols name style n do_cleanups =
9624 pr " struct guestfs_%s *%s;\n" typ n;
9626 pr " %s = guestfs_%s " n name;
9627 generate_c_call_args ~handle:"g" style;
9630 pr " if (%s == NULL)\n" n;
9631 pr " croak (\"%%s\", guestfs_last_error (g));\n";
9632 pr " EXTEND (SP, 2 * %d);\n" (List.length cols);
9634 fun ((name, _) as col) ->
9635 pr " PUSHs (sv_2mortal (newSVpv (\"%s\", 0)));\n" name;
9639 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 0)));\n"
9642 pr " PUSHs (sv_2mortal (newSVpvn (%s->%s, %s->%s_len)));\n"
9645 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 32)));\n"
9647 | name, (FBytes|FUInt64) ->
9648 pr " PUSHs (sv_2mortal (my_newSVull (%s->%s)));\n"
9651 pr " PUSHs (sv_2mortal (my_newSVll (%s->%s)));\n"
9653 | name, (FInt32|FUInt32) ->
9654 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
9657 pr " PUSHs (sv_2mortal (newSVpv (&%s->%s, 1)));\n"
9659 | name, FOptPercent ->
9660 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
9663 pr " free (%s);\n" n
9665 (* Generate Sys/Guestfs.pm. *)
9666 and generate_perl_pm () =
9667 generate_header HashStyle LGPLv2plus;
9674 Sys::Guestfs - Perl bindings for libguestfs
9680 my $h = Sys::Guestfs->new ();
9681 $h->add_drive ('guest.img');
9683 $h->mount ('/dev/sda1', '/');
9684 $h->touch ('/hello');
9689 The C<Sys::Guestfs> module provides a Perl XS binding to the
9690 libguestfs API for examining and modifying virtual machine
9693 Amongst the things this is good for: making batch configuration
9694 changes to guests, getting disk used/free statistics (see also:
9695 virt-df), migrating between virtualization systems (see also:
9696 virt-p2v), performing partial backups, performing partial guest
9697 clones, cloning guests and changing registry/UUID/hostname info, and
9700 Libguestfs uses Linux kernel and qemu code, and can access any type of
9701 guest filesystem that Linux and qemu can, including but not limited
9702 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
9703 schemes, qcow, qcow2, vmdk.
9705 Libguestfs provides ways to enumerate guest storage (eg. partitions,
9706 LVs, what filesystem is in each LV, etc.). It can also run commands
9707 in the context of the guest. Also you can access filesystems over
9710 See also L<Sys::Guestfs::Lib(3)> for a set of useful library
9711 functions for using libguestfs from Perl, including integration
9716 All errors turn into calls to C<croak> (see L<Carp(3)>).
9724 package Sys::Guestfs;
9729 # This version number changes whenever a new function
9730 # is added to the libguestfs API. It is not directly
9731 # related to the libguestfs version number.
9732 use vars qw($VERSION);
9736 XSLoader::load ('Sys::Guestfs');
9738 =item $h = Sys::Guestfs->new ();
9740 Create a new guestfs handle.
9746 my $class = ref ($proto) || $proto;
9748 my $g = Sys::Guestfs::_create ();
9749 my $self = { _g => $g };
9750 bless $self, $class;
9756 Explicitly close the guestfs handle.
9758 B<Note:> You should not usually call this function. The handle will
9759 be closed implicitly when its reference count goes to zero (eg.
9760 when it goes out of scope or the program ends). This call is
9761 only required in some exceptional cases, such as where the program
9762 may contain cached references to the handle 'somewhere' and you
9763 really have to have the close happen right away. After calling
9764 C<close> the program must not call any method (including C<close>)
9765 on the handle (but the implicit call to C<DESTROY> that happens
9766 when the final reference is cleaned up is OK).
9772 (* Actions. We only need to print documentation for these as
9773 * they are pulled in from the XS code automatically.
9776 fun (name, style, _, flags, _, _, longdesc) ->
9777 if not (List.mem NotInDocs flags) then (
9778 let longdesc = replace_str longdesc "C<guestfs_" "C<$h-E<gt>" in
9780 generate_perl_prototype name style;
9782 pr "%s\n\n" longdesc;
9783 if List.mem ProtocolLimitWarning flags then
9784 pr "%s\n\n" protocol_limit_warning;
9785 if List.mem DangerWillRobinson flags then
9786 pr "%s\n\n" danger_will_robinson;
9787 match deprecation_notice flags with
9789 | Some txt -> pr "%s\n\n" txt
9791 ) all_functions_sorted;
9803 Copyright (C) %s Red Hat Inc.
9807 Please see the file COPYING.LIB for the full license.
9813 L<http://libguestfs.org>,
9814 L<Sys::Guestfs::Lib(3)>.
9819 and generate_perl_prototype name style =
9820 (match fst style with
9828 | RBufferOut n -> pr "$%s = " n
9830 | RHashtable n -> pr "%%%s = " n
9832 | RStructList (n,_) -> pr "@%s = " n
9835 let comma = ref false in
9838 if !comma then pr ", ";
9841 | Pathname n | Device n | Dev_or_Path n | String n
9842 | OptString n | Bool n | Int n | Int64 n | FileIn n | FileOut n
9843 | BufferIn n | Key n ->
9845 | StringList n | DeviceList n ->
9850 (* Generate Python C module. *)
9851 and generate_python_c () =
9852 generate_header CStyle LGPLv2plus;
9855 #define PY_SSIZE_T_CLEAN 1
9858 #if PY_VERSION_HEX < 0x02050000
9859 typedef int Py_ssize_t;
9860 #define PY_SSIZE_T_MAX INT_MAX
9861 #define PY_SSIZE_T_MIN INT_MIN
9868 #include \"guestfs.h\"
9870 #ifndef HAVE_PYCAPSULE_NEW
9878 get_handle (PyObject *obj)
9881 assert (obj != Py_None);
9882 #ifndef HAVE_PYCAPSULE_NEW
9883 return ((Pyguestfs_Object *) obj)->g;
9885 return (guestfs_h*) PyCapsule_GetPointer(obj, \"guestfs_h\");
9890 put_handle (guestfs_h *g)
9893 #ifndef HAVE_PYCAPSULE_NEW
9895 PyCObject_FromVoidPtrAndDesc ((void *) g, (char *) \"guestfs_h\", NULL);
9897 return PyCapsule_New ((void *) g, \"guestfs_h\", NULL);
9901 /* This list should be freed (but not the strings) after use. */
9903 get_string_list (PyObject *obj)
9910 if (!PyList_Check (obj)) {
9911 PyErr_SetString (PyExc_RuntimeError, \"expecting a list parameter\");
9915 Py_ssize_t slen = PyList_Size (obj);
9917 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: PyList_Size failure\");
9920 len = (size_t) slen;
9921 r = malloc (sizeof (char *) * (len+1));
9923 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: out of memory\");
9927 for (i = 0; i < len; ++i)
9928 r[i] = PyString_AsString (PyList_GetItem (obj, i));
9935 put_string_list (char * const * const argv)
9940 for (argc = 0; argv[argc] != NULL; ++argc)
9943 list = PyList_New (argc);
9944 for (i = 0; i < argc; ++i)
9945 PyList_SetItem (list, i, PyString_FromString (argv[i]));
9951 put_table (char * const * const argv)
9953 PyObject *list, *item;
9956 for (argc = 0; argv[argc] != NULL; ++argc)
9959 list = PyList_New (argc >> 1);
9960 for (i = 0; i < argc; i += 2) {
9961 item = PyTuple_New (2);
9962 PyTuple_SetItem (item, 0, PyString_FromString (argv[i]));
9963 PyTuple_SetItem (item, 1, PyString_FromString (argv[i+1]));
9964 PyList_SetItem (list, i >> 1, item);
9971 free_strings (char **argv)
9975 for (argc = 0; argv[argc] != NULL; ++argc)
9981 py_guestfs_create (PyObject *self, PyObject *args)
9985 g = guestfs_create ();
9987 PyErr_SetString (PyExc_RuntimeError,
9988 \"guestfs.create: failed to allocate handle\");
9991 guestfs_set_error_handler (g, NULL, NULL);
9992 /* This can return NULL, but in that case put_handle will have
9993 * set the Python error string.
9995 return put_handle (g);
9999 py_guestfs_close (PyObject *self, PyObject *args)
10004 if (!PyArg_ParseTuple (args, (char *) \"O:guestfs_close\", &py_g))
10006 g = get_handle (py_g);
10010 Py_INCREF (Py_None);
10016 let emit_put_list_function typ =
10017 pr "static PyObject *\n";
10018 pr "put_%s_list (struct guestfs_%s_list *%ss)\n" typ typ typ;
10020 pr " PyObject *list;\n";
10023 pr " list = PyList_New (%ss->len);\n" typ;
10024 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
10025 pr " PyList_SetItem (list, i, put_%s (&%ss->val[i]));\n" typ typ;
10026 pr " return list;\n";
10031 (* Structures, turned into Python dictionaries. *)
10034 pr "static PyObject *\n";
10035 pr "put_%s (struct guestfs_%s *%s)\n" typ typ typ;
10037 pr " PyObject *dict;\n";
10039 pr " dict = PyDict_New ();\n";
10043 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
10044 pr " PyString_FromString (%s->%s));\n"
10047 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
10048 pr " PyString_FromStringAndSize (%s->%s, %s->%s_len));\n"
10051 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
10052 pr " PyString_FromStringAndSize (%s->%s, 32));\n"
10054 | name, (FBytes|FUInt64) ->
10055 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
10056 pr " PyLong_FromUnsignedLongLong (%s->%s));\n"
10059 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
10060 pr " PyLong_FromLongLong (%s->%s));\n"
10063 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
10064 pr " PyLong_FromUnsignedLong (%s->%s));\n"
10067 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
10068 pr " PyLong_FromLong (%s->%s));\n"
10070 | name, FOptPercent ->
10071 pr " if (%s->%s >= 0)\n" typ name;
10072 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
10073 pr " PyFloat_FromDouble ((double) %s->%s));\n"
10076 pr " Py_INCREF (Py_None);\n";
10077 pr " PyDict_SetItemString (dict, \"%s\", Py_None);\n" name;
10080 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
10081 pr " PyString_FromStringAndSize (&dirent->%s, 1));\n" name
10083 pr " return dict;\n";
10089 (* Emit a put_TYPE_list function definition only if that function is used. *)
10092 | typ, (RStructListOnly | RStructAndList) ->
10093 (* generate the function for typ *)
10094 emit_put_list_function typ
10095 | typ, _ -> () (* empty *)
10096 ) (rstructs_used_by all_functions);
10098 (* Python wrapper functions. *)
10100 fun (name, style, _, _, _, _, _) ->
10101 pr "static PyObject *\n";
10102 pr "py_guestfs_%s (PyObject *self, PyObject *args)\n" name;
10105 pr " PyObject *py_g;\n";
10106 pr " guestfs_h *g;\n";
10107 pr " PyObject *py_r;\n";
10110 match fst style with
10111 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
10112 | RInt64 _ -> pr " int64_t r;\n"; "-1"
10113 | RConstString _ | RConstOptString _ ->
10114 pr " const char *r;\n"; "NULL"
10115 | RString _ -> pr " char *r;\n"; "NULL"
10116 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
10117 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
10118 | RStructList (_, typ) ->
10119 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
10122 pr " size_t size;\n";
10127 | Pathname n | Device n | Dev_or_Path n | String n | Key n
10128 | FileIn n | FileOut n ->
10129 pr " const char *%s;\n" n
10130 | OptString n -> pr " const char *%s;\n" n
10132 pr " const char *%s;\n" n;
10133 pr " Py_ssize_t %s_size;\n" n
10134 | StringList n | DeviceList n ->
10135 pr " PyObject *py_%s;\n" n;
10136 pr " char **%s;\n" n
10137 | Bool n -> pr " int %s;\n" n
10138 | Int n -> pr " int %s;\n" n
10139 | Int64 n -> pr " long long %s;\n" n
10144 (* Convert the parameters. *)
10145 pr " if (!PyArg_ParseTuple (args, (char *) \"O";
10148 | Pathname _ | Device _ | Dev_or_Path _ | String _ | Key _
10149 | FileIn _ | FileOut _ -> pr "s"
10150 | OptString _ -> pr "z"
10151 | StringList _ | DeviceList _ -> pr "O"
10152 | Bool _ -> pr "i" (* XXX Python has booleans? *)
10154 | Int64 _ -> pr "L" (* XXX Whoever thought it was a good idea to
10155 * emulate C's int/long/long long in Python?
10157 | BufferIn _ -> pr "s#"
10159 pr ":guestfs_%s\",\n" name;
10163 | Pathname n | Device n | Dev_or_Path n | String n | Key n
10164 | FileIn n | FileOut n -> pr ", &%s" n
10165 | OptString n -> pr ", &%s" n
10166 | StringList n | DeviceList n -> pr ", &py_%s" n
10167 | Bool n -> pr ", &%s" n
10168 | Int n -> pr ", &%s" n
10169 | Int64 n -> pr ", &%s" n
10170 | BufferIn n -> pr ", &%s, &%s_size" n n
10174 pr " return NULL;\n";
10176 pr " g = get_handle (py_g);\n";
10179 | Pathname _ | Device _ | Dev_or_Path _ | String _ | Key _
10180 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _
10182 | StringList n | DeviceList n ->
10183 pr " %s = get_string_list (py_%s);\n" n n;
10184 pr " if (!%s) return NULL;\n" n
10189 pr " r = guestfs_%s " name;
10190 generate_c_call_args ~handle:"g" style;
10195 | Pathname _ | Device _ | Dev_or_Path _ | String _ | Key _
10196 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _
10198 | StringList n | DeviceList n ->
10199 pr " free (%s);\n" n
10202 pr " if (r == %s) {\n" error_code;
10203 pr " PyErr_SetString (PyExc_RuntimeError, guestfs_last_error (g));\n";
10204 pr " return NULL;\n";
10208 (match fst style with
10210 pr " Py_INCREF (Py_None);\n";
10211 pr " py_r = Py_None;\n"
10213 | RBool _ -> pr " py_r = PyInt_FromLong ((long) r);\n"
10214 | RInt64 _ -> pr " py_r = PyLong_FromLongLong (r);\n"
10215 | RConstString _ -> pr " py_r = PyString_FromString (r);\n"
10216 | RConstOptString _ ->
10218 pr " py_r = PyString_FromString (r);\n";
10220 pr " Py_INCREF (Py_None);\n";
10221 pr " py_r = Py_None;\n";
10224 pr " py_r = PyString_FromString (r);\n";
10227 pr " py_r = put_string_list (r);\n";
10228 pr " free_strings (r);\n"
10229 | RStruct (_, typ) ->
10230 pr " py_r = put_%s (r);\n" typ;
10231 pr " guestfs_free_%s (r);\n" typ
10232 | RStructList (_, typ) ->
10233 pr " py_r = put_%s_list (r);\n" typ;
10234 pr " guestfs_free_%s_list (r);\n" typ
10236 pr " py_r = put_table (r);\n";
10237 pr " free_strings (r);\n"
10239 pr " py_r = PyString_FromStringAndSize (r, size);\n";
10243 pr " return py_r;\n";
10248 (* Table of functions. *)
10249 pr "static PyMethodDef methods[] = {\n";
10250 pr " { (char *) \"create\", py_guestfs_create, METH_VARARGS, NULL },\n";
10251 pr " { (char *) \"close\", py_guestfs_close, METH_VARARGS, NULL },\n";
10253 fun (name, _, _, _, _, _, _) ->
10254 pr " { (char *) \"%s\", py_guestfs_%s, METH_VARARGS, NULL },\n"
10257 pr " { NULL, NULL, 0, NULL }\n";
10261 (* Init function. *)
10264 initlibguestfsmod (void)
10266 static int initialized = 0;
10268 if (initialized) return;
10269 Py_InitModule ((char *) \"libguestfsmod\", methods);
10274 (* Generate Python module. *)
10275 and generate_python_py () =
10276 generate_header HashStyle LGPLv2plus;
10279 u\"\"\"Python bindings for libguestfs
10282 g = guestfs.GuestFS ()
10283 g.add_drive (\"guest.img\")
10285 parts = g.list_partitions ()
10287 The guestfs module provides a Python binding to the libguestfs API
10288 for examining and modifying virtual machine disk images.
10290 Amongst the things this is good for: making batch configuration
10291 changes to guests, getting disk used/free statistics (see also:
10292 virt-df), migrating between virtualization systems (see also:
10293 virt-p2v), performing partial backups, performing partial guest
10294 clones, cloning guests and changing registry/UUID/hostname info, and
10297 Libguestfs uses Linux kernel and qemu code, and can access any type of
10298 guest filesystem that Linux and qemu can, including but not limited
10299 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
10300 schemes, qcow, qcow2, vmdk.
10302 Libguestfs provides ways to enumerate guest storage (eg. partitions,
10303 LVs, what filesystem is in each LV, etc.). It can also run commands
10304 in the context of the guest. Also you can access filesystems over
10307 Errors which happen while using the API are turned into Python
10308 RuntimeError exceptions.
10310 To create a guestfs handle you usually have to perform the following
10313 # Create the handle, call add_drive at least once, and possibly
10314 # several times if the guest has multiple block devices:
10315 g = guestfs.GuestFS ()
10316 g.add_drive (\"guest.img\")
10318 # Launch the qemu subprocess and wait for it to become ready:
10321 # Now you can issue commands, for example:
10326 import libguestfsmod
10329 \"\"\"Instances of this class are libguestfs API handles.\"\"\"
10331 def __init__ (self):
10332 \"\"\"Create a new libguestfs handle.\"\"\"
10333 self._o = libguestfsmod.create ()
10335 def __del__ (self):
10336 libguestfsmod.close (self._o)
10341 fun (name, style, _, flags, _, _, longdesc) ->
10342 pr " def %s " name;
10343 generate_py_call_args ~handle:"self" (snd style);
10346 if not (List.mem NotInDocs flags) then (
10347 let doc = replace_str longdesc "C<guestfs_" "C<g." in
10349 match fst style with
10350 | RErr | RInt _ | RInt64 _ | RBool _
10351 | RConstOptString _ | RConstString _
10352 | RString _ | RBufferOut _ -> doc
10354 doc ^ "\n\nThis function returns a list of strings."
10355 | RStruct (_, typ) ->
10356 doc ^ sprintf "\n\nThis function returns a dictionary, with keys matching the various fields in the guestfs_%s structure." typ
10357 | RStructList (_, typ) ->
10358 doc ^ sprintf "\n\nThis function returns a list of %ss. Each %s is represented as a dictionary." typ typ
10360 doc ^ "\n\nThis function returns a dictionary." in
10362 if List.mem ProtocolLimitWarning flags then
10363 doc ^ "\n\n" ^ protocol_limit_warning
10366 if List.mem DangerWillRobinson flags then
10367 doc ^ "\n\n" ^ danger_will_robinson
10370 match deprecation_notice flags with
10372 | Some txt -> doc ^ "\n\n" ^ txt in
10373 let doc = pod2text ~width:60 name doc in
10374 let doc = List.map (fun line -> replace_str line "\\" "\\\\") doc in
10375 let doc = String.concat "\n " doc in
10376 pr " u\"\"\"%s\"\"\"\n" doc;
10378 pr " return libguestfsmod.%s " name;
10379 generate_py_call_args ~handle:"self._o" (snd style);
10384 (* Generate Python call arguments, eg "(handle, foo, bar)" *)
10385 and generate_py_call_args ~handle args =
10387 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
10390 (* Useful if you need the longdesc POD text as plain text. Returns a
10393 * Because this is very slow (the slowest part of autogeneration),
10394 * we memoize the results.
10396 and pod2text ~width name longdesc =
10397 let key = width, name, longdesc in
10398 try Hashtbl.find pod2text_memo key
10400 let filename, chan = Filename.open_temp_file "gen" ".tmp" in
10401 fprintf chan "=head1 %s\n\n%s\n" name longdesc;
10403 let cmd = sprintf "pod2text -w %d %s" width (Filename.quote filename) in
10404 let chan = open_process_in cmd in
10405 let lines = ref [] in
10407 let line = input_line chan in
10408 if i = 1 then (* discard the first line of output *)
10411 let line = triml line in
10412 lines := line :: !lines;
10415 let lines = try loop 1 with End_of_file -> List.rev !lines in
10417 (match close_process_in chan with
10420 failwithf "pod2text: process exited with non-zero status (%d)" i
10421 | WSIGNALED i | WSTOPPED i ->
10422 failwithf "pod2text: process signalled or stopped by signal %d" i
10424 Hashtbl.add pod2text_memo key lines;
10425 pod2text_memo_updated ();
10428 (* Generate ruby bindings. *)
10429 and generate_ruby_c () =
10430 generate_header CStyle LGPLv2plus;
10434 #include <stdlib.h>
10438 #include \"guestfs.h\"
10440 #include \"extconf.h\"
10442 /* For Ruby < 1.9 */
10444 #define RARRAY_LEN(r) (RARRAY((r))->len)
10447 static VALUE m_guestfs; /* guestfs module */
10448 static VALUE c_guestfs; /* guestfs_h handle */
10449 static VALUE e_Error; /* used for all errors */
10451 static void ruby_guestfs_free (void *p)
10454 guestfs_close ((guestfs_h *) p);
10457 static VALUE ruby_guestfs_create (VALUE m)
10461 g = guestfs_create ();
10463 rb_raise (e_Error, \"failed to create guestfs handle\");
10465 /* Don't print error messages to stderr by default. */
10466 guestfs_set_error_handler (g, NULL, NULL);
10468 /* Wrap it, and make sure the close function is called when the
10469 * handle goes away.
10471 return Data_Wrap_Struct (c_guestfs, NULL, ruby_guestfs_free, g);
10474 static VALUE ruby_guestfs_close (VALUE gv)
10477 Data_Get_Struct (gv, guestfs_h, g);
10479 ruby_guestfs_free (g);
10480 DATA_PTR (gv) = NULL;
10488 fun (name, style, _, _, _, _, _) ->
10489 pr "static VALUE ruby_guestfs_%s (VALUE gv" name;
10490 List.iter (fun arg -> pr ", VALUE %sv" (name_of_argt arg)) (snd style);
10493 pr " guestfs_h *g;\n";
10494 pr " Data_Get_Struct (gv, guestfs_h, g);\n";
10496 pr " rb_raise (rb_eArgError, \"%%s: used handle after closing it\", \"%s\");\n"
10502 | Pathname n | Device n | Dev_or_Path n | String n | Key n
10503 | FileIn n | FileOut n ->
10504 pr " Check_Type (%sv, T_STRING);\n" n;
10505 pr " const char *%s = StringValueCStr (%sv);\n" n n;
10506 pr " if (!%s)\n" n;
10507 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
10508 pr " \"%s\", \"%s\");\n" n name
10510 pr " Check_Type (%sv, T_STRING);\n" n;
10511 pr " const char *%s = RSTRING (%sv)->ptr;\n" n n;
10512 pr " if (!%s)\n" n;
10513 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
10514 pr " \"%s\", \"%s\");\n" n name;
10515 pr " size_t %s_size = RSTRING (%sv)->len;\n" n n
10517 pr " const char *%s = !NIL_P (%sv) ? StringValueCStr (%sv) : NULL;\n" n n n
10518 | StringList n | DeviceList n ->
10519 pr " char **%s;\n" n;
10520 pr " Check_Type (%sv, T_ARRAY);\n" n;
10522 pr " size_t i, len;\n";
10523 pr " len = RARRAY_LEN (%sv);\n" n;
10524 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (len+1));\n"
10526 pr " for (i = 0; i < len; ++i) {\n";
10527 pr " VALUE v = rb_ary_entry (%sv, i);\n" n;
10528 pr " %s[i] = StringValueCStr (v);\n" n;
10530 pr " %s[len] = NULL;\n" n;
10533 pr " int %s = RTEST (%sv);\n" n n
10535 pr " int %s = NUM2INT (%sv);\n" n n
10537 pr " long long %s = NUM2LL (%sv);\n" n n
10542 match fst style with
10543 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
10544 | RInt64 _ -> pr " int64_t r;\n"; "-1"
10545 | RConstString _ | RConstOptString _ ->
10546 pr " const char *r;\n"; "NULL"
10547 | RString _ -> pr " char *r;\n"; "NULL"
10548 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
10549 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
10550 | RStructList (_, typ) ->
10551 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
10554 pr " size_t size;\n";
10558 pr " r = guestfs_%s " name;
10559 generate_c_call_args ~handle:"g" style;
10564 | Pathname _ | Device _ | Dev_or_Path _ | String _ | Key _
10565 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _
10567 | StringList n | DeviceList n ->
10568 pr " free (%s);\n" n
10571 pr " if (r == %s)\n" error_code;
10572 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n";
10575 (match fst style with
10577 pr " return Qnil;\n"
10578 | RInt _ | RBool _ ->
10579 pr " return INT2NUM (r);\n"
10581 pr " return ULL2NUM (r);\n"
10582 | RConstString _ ->
10583 pr " return rb_str_new2 (r);\n";
10584 | RConstOptString _ ->
10586 pr " return rb_str_new2 (r);\n";
10588 pr " return Qnil;\n";
10590 pr " VALUE rv = rb_str_new2 (r);\n";
10592 pr " return rv;\n";
10594 pr " size_t i, len = 0;\n";
10595 pr " for (i = 0; r[i] != NULL; ++i) len++;\n";
10596 pr " VALUE rv = rb_ary_new2 (len);\n";
10597 pr " for (i = 0; r[i] != NULL; ++i) {\n";
10598 pr " rb_ary_push (rv, rb_str_new2 (r[i]));\n";
10599 pr " free (r[i]);\n";
10603 | RStruct (_, typ) ->
10604 let cols = cols_of_struct typ in
10605 generate_ruby_struct_code typ cols
10606 | RStructList (_, typ) ->
10607 let cols = cols_of_struct typ in
10608 generate_ruby_struct_list_code typ cols
10610 pr " VALUE rv = rb_hash_new ();\n";
10612 pr " for (i = 0; r[i] != NULL; i+=2) {\n";
10613 pr " rb_hash_aset (rv, rb_str_new2 (r[i]), rb_str_new2 (r[i+1]));\n";
10614 pr " free (r[i]);\n";
10615 pr " free (r[i+1]);\n";
10620 pr " VALUE rv = rb_str_new (r, size);\n";
10622 pr " return rv;\n";
10630 /* Initialize the module. */
10631 void Init__guestfs ()
10633 m_guestfs = rb_define_module (\"Guestfs\");
10634 c_guestfs = rb_define_class_under (m_guestfs, \"Guestfs\", rb_cObject);
10635 e_Error = rb_define_class_under (m_guestfs, \"Error\", rb_eStandardError);
10637 rb_define_module_function (m_guestfs, \"create\", ruby_guestfs_create, 0);
10638 rb_define_method (c_guestfs, \"close\", ruby_guestfs_close, 0);
10641 (* Define the rest of the methods. *)
10643 fun (name, style, _, _, _, _, _) ->
10644 pr " rb_define_method (c_guestfs, \"%s\",\n" name;
10645 pr " ruby_guestfs_%s, %d);\n" name (List.length (snd style))
10650 (* Ruby code to return a struct. *)
10651 and generate_ruby_struct_code typ cols =
10652 pr " VALUE rv = rb_hash_new ();\n";
10656 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new2 (r->%s));\n" name name
10658 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, r->%s_len));\n" name name name
10660 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, 32));\n" name name
10661 | name, (FBytes|FUInt64) ->
10662 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
10664 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), LL2NUM (r->%s));\n" name name
10666 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), UINT2NUM (r->%s));\n" name name
10668 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), INT2NUM (r->%s));\n" name name
10669 | name, FOptPercent ->
10670 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_dbl2big (r->%s));\n" name name
10671 | name, FChar -> (* XXX wrong? *)
10672 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
10674 pr " guestfs_free_%s (r);\n" typ;
10677 (* Ruby code to return a struct list. *)
10678 and generate_ruby_struct_list_code typ cols =
10679 pr " VALUE rv = rb_ary_new2 (r->len);\n";
10681 pr " for (i = 0; i < r->len; ++i) {\n";
10682 pr " VALUE hv = rb_hash_new ();\n";
10686 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new2 (r->val[i].%s));\n" name name
10688 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, r->val[i].%s_len));\n" name name name
10690 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, 32));\n" name name
10691 | name, (FBytes|FUInt64) ->
10692 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
10694 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), LL2NUM (r->val[i].%s));\n" name name
10696 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), UINT2NUM (r->val[i].%s));\n" name name
10698 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), INT2NUM (r->val[i].%s));\n" name name
10699 | name, FOptPercent ->
10700 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_dbl2big (r->val[i].%s));\n" name name
10701 | name, FChar -> (* XXX wrong? *)
10702 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
10704 pr " rb_ary_push (rv, hv);\n";
10706 pr " guestfs_free_%s_list (r);\n" typ;
10709 (* Generate Java bindings GuestFS.java file. *)
10710 and generate_java_java () =
10711 generate_header CStyle LGPLv2plus;
10714 package com.redhat.et.libguestfs;
10716 import java.util.HashMap;
10717 import com.redhat.et.libguestfs.LibGuestFSException;
10718 import com.redhat.et.libguestfs.PV;
10719 import com.redhat.et.libguestfs.VG;
10720 import com.redhat.et.libguestfs.LV;
10721 import com.redhat.et.libguestfs.Stat;
10722 import com.redhat.et.libguestfs.StatVFS;
10723 import com.redhat.et.libguestfs.IntBool;
10724 import com.redhat.et.libguestfs.Dirent;
10727 * The GuestFS object is a libguestfs handle.
10731 public class GuestFS {
10732 // Load the native code.
10734 System.loadLibrary (\"guestfs_jni\");
10738 * The native guestfs_h pointer.
10743 * Create a libguestfs handle.
10745 * @throws LibGuestFSException
10747 public GuestFS () throws LibGuestFSException
10751 private native long _create () throws LibGuestFSException;
10754 * Close a libguestfs handle.
10756 * You can also leave handles to be collected by the garbage
10757 * collector, but this method ensures that the resources used
10758 * by the handle are freed up immediately. If you call any
10759 * other methods after closing the handle, you will get an
10762 * @throws LibGuestFSException
10764 public void close () throws LibGuestFSException
10770 private native void _close (long g) throws LibGuestFSException;
10772 public void finalize () throws LibGuestFSException
10780 fun (name, style, _, flags, _, shortdesc, longdesc) ->
10781 if not (List.mem NotInDocs flags); then (
10782 let doc = replace_str longdesc "C<guestfs_" "C<g." in
10784 if List.mem ProtocolLimitWarning flags then
10785 doc ^ "\n\n" ^ protocol_limit_warning
10788 if List.mem DangerWillRobinson flags then
10789 doc ^ "\n\n" ^ danger_will_robinson
10792 match deprecation_notice flags with
10794 | Some txt -> doc ^ "\n\n" ^ txt in
10795 let doc = pod2text ~width:60 name doc in
10796 let doc = List.map ( (* RHBZ#501883 *)
10799 | nonempty -> nonempty
10801 let doc = String.concat "\n * " doc in
10804 pr " * %s\n" shortdesc;
10807 pr " * @throws LibGuestFSException\n";
10811 generate_java_prototype ~public:true ~semicolon:false name style;
10814 pr " if (g == 0)\n";
10815 pr " throw new LibGuestFSException (\"%s: handle is closed\");\n"
10818 if fst style <> RErr then pr "return ";
10820 generate_java_call_args ~handle:"g" (snd style);
10824 generate_java_prototype ~privat:true ~native:true name style;
10831 (* Generate Java call arguments, eg "(handle, foo, bar)" *)
10832 and generate_java_call_args ~handle args =
10834 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
10837 and generate_java_prototype ?(public=false) ?(privat=false) ?(native=false)
10838 ?(semicolon=true) name style =
10839 if privat then pr "private ";
10840 if public then pr "public ";
10841 if native then pr "native ";
10844 (match fst style with
10845 | RErr -> pr "void ";
10846 | RInt _ -> pr "int ";
10847 | RInt64 _ -> pr "long ";
10848 | RBool _ -> pr "boolean ";
10849 | RConstString _ | RConstOptString _ | RString _
10850 | RBufferOut _ -> pr "String ";
10851 | RStringList _ -> pr "String[] ";
10852 | RStruct (_, typ) ->
10853 let name = java_name_of_struct typ in
10855 | RStructList (_, typ) ->
10856 let name = java_name_of_struct typ in
10858 | RHashtable _ -> pr "HashMap<String,String> ";
10861 if native then pr "_%s " name else pr "%s " name;
10863 let needs_comma = ref false in
10866 needs_comma := true
10872 if !needs_comma then pr ", ";
10873 needs_comma := true;
10877 | Device n | Dev_or_Path n
10886 | StringList n | DeviceList n ->
10897 pr " throws LibGuestFSException";
10898 if semicolon then pr ";"
10900 and generate_java_struct jtyp cols () =
10901 generate_header CStyle LGPLv2plus;
10904 package com.redhat.et.libguestfs;
10907 * Libguestfs %s structure.
10919 | name, FBuffer -> pr " public String %s;\n" name
10920 | name, (FBytes|FUInt64|FInt64) -> pr " public long %s;\n" name
10921 | name, (FUInt32|FInt32) -> pr " public int %s;\n" name
10922 | name, FChar -> pr " public char %s;\n" name
10923 | name, FOptPercent ->
10924 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
10925 pr " public float %s;\n" name
10930 and generate_java_c () =
10931 generate_header CStyle LGPLv2plus;
10935 #include <stdlib.h>
10936 #include <string.h>
10938 #include \"com_redhat_et_libguestfs_GuestFS.h\"
10939 #include \"guestfs.h\"
10941 /* Note that this function returns. The exception is not thrown
10942 * until after the wrapper function returns.
10945 throw_exception (JNIEnv *env, const char *msg)
10948 cl = (*env)->FindClass (env,
10949 \"com/redhat/et/libguestfs/LibGuestFSException\");
10950 (*env)->ThrowNew (env, cl, msg);
10953 JNIEXPORT jlong JNICALL
10954 Java_com_redhat_et_libguestfs_GuestFS__1create
10955 (JNIEnv *env, jobject obj)
10959 g = guestfs_create ();
10961 throw_exception (env, \"GuestFS.create: failed to allocate handle\");
10964 guestfs_set_error_handler (g, NULL, NULL);
10965 return (jlong) (long) g;
10968 JNIEXPORT void JNICALL
10969 Java_com_redhat_et_libguestfs_GuestFS__1close
10970 (JNIEnv *env, jobject obj, jlong jg)
10972 guestfs_h *g = (guestfs_h *) (long) jg;
10979 fun (name, style, _, _, _, _, _) ->
10981 (match fst style with
10982 | RErr -> pr "void ";
10983 | RInt _ -> pr "jint ";
10984 | RInt64 _ -> pr "jlong ";
10985 | RBool _ -> pr "jboolean ";
10986 | RConstString _ | RConstOptString _ | RString _
10987 | RBufferOut _ -> pr "jstring ";
10988 | RStruct _ | RHashtable _ ->
10990 | RStringList _ | RStructList _ ->
10991 pr "jobjectArray ";
10994 pr "Java_com_redhat_et_libguestfs_GuestFS_";
10995 pr "%s" (replace_str ("_" ^ name) "_" "_1");
10997 pr " (JNIEnv *env, jobject obj, jlong jg";
11001 | Device n | Dev_or_Path n
11007 pr ", jstring j%s" n
11009 pr ", jbyteArray j%s" n
11010 | StringList n | DeviceList n ->
11011 pr ", jobjectArray j%s" n
11013 pr ", jboolean j%s" n
11021 pr " guestfs_h *g = (guestfs_h *) (long) jg;\n";
11022 let error_code, no_ret =
11023 match fst style with
11024 | RErr -> pr " int r;\n"; "-1", ""
11026 | RInt _ -> pr " int r;\n"; "-1", "0"
11027 | RInt64 _ -> pr " int64_t r;\n"; "-1", "0"
11028 | RConstString _ -> pr " const char *r;\n"; "NULL", "NULL"
11029 | RConstOptString _ -> pr " const char *r;\n"; "NULL", "NULL"
11031 pr " jstring jr;\n";
11032 pr " char *r;\n"; "NULL", "NULL"
11034 pr " jobjectArray jr;\n";
11035 pr " int r_len;\n";
11036 pr " jclass cl;\n";
11037 pr " jstring jstr;\n";
11038 pr " char **r;\n"; "NULL", "NULL"
11039 | RStruct (_, typ) ->
11040 pr " jobject jr;\n";
11041 pr " jclass cl;\n";
11042 pr " jfieldID fl;\n";
11043 pr " struct guestfs_%s *r;\n" typ; "NULL", "NULL"
11044 | RStructList (_, typ) ->
11045 pr " jobjectArray jr;\n";
11046 pr " jclass cl;\n";
11047 pr " jfieldID fl;\n";
11048 pr " jobject jfl;\n";
11049 pr " struct guestfs_%s_list *r;\n" typ; "NULL", "NULL"
11050 | RHashtable _ -> pr " char **r;\n"; "NULL", "NULL"
11052 pr " jstring jr;\n";
11054 pr " size_t size;\n";
11059 | Device n | Dev_or_Path n
11065 pr " const char *%s;\n" n
11067 pr " jbyte *%s;\n" n;
11068 pr " size_t %s_size;\n" n
11069 | StringList n | DeviceList n ->
11070 pr " int %s_len;\n" n;
11071 pr " const char **%s;\n" n
11076 pr " int64_t %s;\n" n
11080 (match fst style with
11081 | RStringList _ | RStructList _ -> true
11082 | RErr | RBool _ | RInt _ | RInt64 _ | RConstString _
11083 | RConstOptString _
11084 | RString _ | RBufferOut _ | RStruct _ | RHashtable _ -> false) ||
11085 List.exists (function
11086 | StringList _ -> true
11087 | DeviceList _ -> true
11088 | _ -> false) (snd style) in
11094 (* Get the parameters. *)
11098 | Device n | Dev_or_Path n
11103 pr " %s = (*env)->GetStringUTFChars (env, j%s, NULL);\n" n n
11105 (* This is completely undocumented, but Java null becomes
11106 * a NULL parameter.
11108 pr " %s = j%s ? (*env)->GetStringUTFChars (env, j%s, NULL) : NULL;\n" n n n
11110 pr " %s = (*env)->GetByteArrayElements (env, j%s, NULL);\n" n n;
11111 pr " %s_size = (*env)->GetArrayLength (env, j%s);\n" n n
11112 | StringList n | DeviceList n ->
11113 pr " %s_len = (*env)->GetArrayLength (env, j%s);\n" n n;
11114 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (%s_len+1));\n" n n;
11115 pr " for (i = 0; i < %s_len; ++i) {\n" n;
11116 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
11118 pr " %s[i] = (*env)->GetStringUTFChars (env, o, NULL);\n" n;
11120 pr " %s[%s_len] = NULL;\n" n n;
11124 pr " %s = j%s;\n" n n
11127 (* Make the call. *)
11128 pr " r = guestfs_%s " name;
11129 generate_c_call_args ~handle:"g" style;
11132 (* Release the parameters. *)
11136 | Device n | Dev_or_Path n
11141 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
11143 pr " if (j%s)\n" n;
11144 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
11146 pr " (*env)->ReleaseByteArrayElements (env, j%s, %s, 0);\n" n n
11147 | StringList n | DeviceList n ->
11148 pr " for (i = 0; i < %s_len; ++i) {\n" n;
11149 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
11151 pr " (*env)->ReleaseStringUTFChars (env, o, %s[i]);\n" n;
11153 pr " free (%s);\n" n
11159 (* Check for errors. *)
11160 pr " if (r == %s) {\n" error_code;
11161 pr " throw_exception (env, guestfs_last_error (g));\n";
11162 pr " return %s;\n" no_ret;
11165 (* Return value. *)
11166 (match fst style with
11168 | RInt _ -> pr " return (jint) r;\n"
11169 | RBool _ -> pr " return (jboolean) r;\n"
11170 | RInt64 _ -> pr " return (jlong) r;\n"
11171 | RConstString _ -> pr " return (*env)->NewStringUTF (env, r);\n"
11172 | RConstOptString _ ->
11173 pr " return (*env)->NewStringUTF (env, r); /* XXX r NULL? */\n"
11175 pr " jr = (*env)->NewStringUTF (env, r);\n";
11179 pr " for (r_len = 0; r[r_len] != NULL; ++r_len) ;\n";
11180 pr " cl = (*env)->FindClass (env, \"java/lang/String\");\n";
11181 pr " jstr = (*env)->NewStringUTF (env, \"\");\n";
11182 pr " jr = (*env)->NewObjectArray (env, r_len, cl, jstr);\n";
11183 pr " for (i = 0; i < r_len; ++i) {\n";
11184 pr " jstr = (*env)->NewStringUTF (env, r[i]);\n";
11185 pr " (*env)->SetObjectArrayElement (env, jr, i, jstr);\n";
11186 pr " free (r[i]);\n";
11190 | RStruct (_, typ) ->
11191 let jtyp = java_name_of_struct typ in
11192 let cols = cols_of_struct typ in
11193 generate_java_struct_return typ jtyp cols
11194 | RStructList (_, typ) ->
11195 let jtyp = java_name_of_struct typ in
11196 let cols = cols_of_struct typ in
11197 generate_java_struct_list_return typ jtyp cols
11200 pr " throw_exception (env, \"%s: internal error: please let us know how to make a Java HashMap from JNI bindings!\");\n" name;
11201 pr " return NULL;\n"
11203 pr " jr = (*env)->NewStringUTF (env, r); /* XXX size */\n";
11212 and generate_java_struct_return typ jtyp cols =
11213 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
11214 pr " jr = (*env)->AllocObject (env, cl);\n";
11218 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
11219 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, r->%s));\n" name;
11222 pr " char s[33];\n";
11223 pr " memcpy (s, r->%s, 32);\n" name;
11224 pr " s[32] = 0;\n";
11225 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
11226 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
11230 pr " int len = r->%s_len;\n" name;
11231 pr " char s[len+1];\n";
11232 pr " memcpy (s, r->%s, len);\n" name;
11233 pr " s[len] = 0;\n";
11234 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
11235 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
11237 | name, (FBytes|FUInt64|FInt64) ->
11238 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
11239 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
11240 | name, (FUInt32|FInt32) ->
11241 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
11242 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
11243 | name, FOptPercent ->
11244 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
11245 pr " (*env)->SetFloatField (env, jr, fl, r->%s);\n" name;
11247 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
11248 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
11253 and generate_java_struct_list_return typ jtyp cols =
11254 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
11255 pr " jr = (*env)->NewObjectArray (env, r->len, cl, NULL);\n";
11256 pr " for (i = 0; i < r->len; ++i) {\n";
11257 pr " jfl = (*env)->AllocObject (env, cl);\n";
11261 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
11262 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, r->val[i].%s));\n" name;
11265 pr " char s[33];\n";
11266 pr " memcpy (s, r->val[i].%s, 32);\n" name;
11267 pr " s[32] = 0;\n";
11268 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
11269 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
11273 pr " int len = r->val[i].%s_len;\n" name;
11274 pr " char s[len+1];\n";
11275 pr " memcpy (s, r->val[i].%s, len);\n" name;
11276 pr " s[len] = 0;\n";
11277 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
11278 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
11280 | name, (FBytes|FUInt64|FInt64) ->
11281 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
11282 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
11283 | name, (FUInt32|FInt32) ->
11284 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
11285 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
11286 | name, FOptPercent ->
11287 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
11288 pr " (*env)->SetFloatField (env, jfl, fl, r->val[i].%s);\n" name;
11290 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
11291 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
11293 pr " (*env)->SetObjectArrayElement (env, jfl, i, jfl);\n";
11295 pr " guestfs_free_%s_list (r);\n" typ;
11298 and generate_java_makefile_inc () =
11299 generate_header HashStyle GPLv2plus;
11301 pr "java_built_sources = \\\n";
11304 pr "\tcom/redhat/et/libguestfs/%s.java \\\n" jtyp;
11306 pr "\tcom/redhat/et/libguestfs/GuestFS.java\n"
11308 and generate_haskell_hs () =
11309 generate_header HaskellStyle LGPLv2plus;
11311 (* XXX We only know how to generate partial FFI for Haskell
11312 * at the moment. Please help out!
11314 let can_generate style =
11318 | RInt64 _, _ -> true
11320 | RConstString _, _
11321 | RConstOptString _, _
11327 | RBufferOut _, _ -> false in
11330 {-# INCLUDE <guestfs.h> #-}
11331 {-# LANGUAGE ForeignFunctionInterface #-}
11336 (* List out the names of the actions we want to export. *)
11338 fun (name, style, _, _, _, _, _) ->
11339 if can_generate style then pr ",\n %s" name
11345 -- Unfortunately some symbols duplicate ones already present
11346 -- in Prelude. We don't know which, so we hard-code a list
11348 import Prelude hiding (truncate)
11352 import Foreign.C.Types
11354 import Control.Exception
11355 import Data.Typeable
11357 data GuestfsS = GuestfsS -- represents the opaque C struct
11358 type GuestfsP = Ptr GuestfsS -- guestfs_h *
11359 type GuestfsH = ForeignPtr GuestfsS -- guestfs_h * with attached finalizer
11361 -- XXX define properly later XXX
11365 data IntBool = IntBool
11367 data StatVFS = StatVFS
11368 data Hashtable = Hashtable
11370 foreign import ccall unsafe \"guestfs_create\" c_create
11372 foreign import ccall unsafe \"&guestfs_close\" c_close
11373 :: FunPtr (GuestfsP -> IO ())
11374 foreign import ccall unsafe \"guestfs_set_error_handler\" c_set_error_handler
11375 :: GuestfsP -> Ptr CInt -> Ptr CInt -> IO ()
11377 create :: IO GuestfsH
11380 c_set_error_handler p nullPtr nullPtr
11381 h <- newForeignPtr c_close p
11384 foreign import ccall unsafe \"guestfs_last_error\" c_last_error
11385 :: GuestfsP -> IO CString
11387 -- last_error :: GuestfsH -> IO (Maybe String)
11388 -- last_error h = do
11389 -- str <- withForeignPtr h (\\p -> c_last_error p)
11390 -- maybePeek peekCString str
11392 last_error :: GuestfsH -> IO (String)
11394 str <- withForeignPtr h (\\p -> c_last_error p)
11395 if (str == nullPtr)
11396 then return \"no error\"
11397 else peekCString str
11401 (* Generate wrappers for each foreign function. *)
11403 fun (name, style, _, _, _, _, _) ->
11404 if can_generate style then (
11405 pr "foreign import ccall unsafe \"guestfs_%s\" c_%s\n" name name;
11407 generate_haskell_prototype ~handle:"GuestfsP" style;
11411 generate_haskell_prototype ~handle:"GuestfsH" ~hs:true style;
11413 pr "%s %s = do\n" name
11414 (String.concat " " ("h" :: List.map name_of_argt (snd style)));
11416 (* Convert pointer arguments using with* functions. *)
11421 | Pathname n | Device n | Dev_or_Path n | String n | Key n ->
11422 pr "withCString %s $ \\%s -> " n n
11424 pr "withCStringLen %s $ \\(%s, %s_size) -> " n n n
11425 | OptString n -> pr "maybeWith withCString %s $ \\%s -> " n n
11426 | StringList n | DeviceList n -> pr "withMany withCString %s $ \\%s -> withArray0 nullPtr %s $ \\%s -> " n n n n
11427 | Bool _ | Int _ | Int64 _ -> ()
11429 (* Convert integer arguments. *)
11433 | Bool n -> sprintf "(fromBool %s)" n
11434 | Int n -> sprintf "(fromIntegral %s)" n
11435 | Int64 n -> sprintf "(fromIntegral %s)" n
11436 | FileIn n | FileOut n
11437 | Pathname n | Device n | Dev_or_Path n
11438 | String n | OptString n
11439 | StringList n | DeviceList n
11441 | BufferIn n -> sprintf "%s (fromIntegral %s_size)" n n
11443 pr "withForeignPtr h (\\p -> c_%s %s)\n" name
11444 (String.concat " " ("p" :: args));
11445 (match fst style with
11446 | RErr | RInt _ | RInt64 _ | RBool _ ->
11447 pr " if (r == -1)\n";
11449 pr " err <- last_error h\n";
11451 | RConstString _ | RConstOptString _ | RString _
11452 | RStringList _ | RStruct _
11453 | RStructList _ | RHashtable _ | RBufferOut _ ->
11454 pr " if (r == nullPtr)\n";
11456 pr " err <- last_error h\n";
11459 (match fst style with
11461 pr " else return ()\n"
11463 pr " else return (fromIntegral r)\n"
11465 pr " else return (fromIntegral r)\n"
11467 pr " else return (toBool r)\n"
11469 | RConstOptString _
11476 pr " else return ()\n" (* XXXXXXXXXXXXXXXXXXXX *)
11482 and generate_haskell_prototype ~handle ?(hs = false) style =
11483 pr "%s -> " handle;
11484 let string = if hs then "String" else "CString" in
11485 let int = if hs then "Int" else "CInt" in
11486 let bool = if hs then "Bool" else "CInt" in
11487 let int64 = if hs then "Integer" else "Int64" in
11491 | Pathname _ | Device _ | Dev_or_Path _ | String _ | Key _ ->
11494 if hs then pr "String"
11495 else pr "CString -> CInt"
11496 | OptString _ -> if hs then pr "Maybe String" else pr "CString"
11497 | StringList _ | DeviceList _ -> if hs then pr "[String]" else pr "Ptr CString"
11498 | Bool _ -> pr "%s" bool
11499 | Int _ -> pr "%s" int
11500 | Int64 _ -> pr "%s" int
11501 | FileIn _ -> pr "%s" string
11502 | FileOut _ -> pr "%s" string
11507 (match fst style with
11508 | RErr -> if not hs then pr "CInt"
11509 | RInt _ -> pr "%s" int
11510 | RInt64 _ -> pr "%s" int64
11511 | RBool _ -> pr "%s" bool
11512 | RConstString _ -> pr "%s" string
11513 | RConstOptString _ -> pr "Maybe %s" string
11514 | RString _ -> pr "%s" string
11515 | RStringList _ -> pr "[%s]" string
11516 | RStruct (_, typ) ->
11517 let name = java_name_of_struct typ in
11519 | RStructList (_, typ) ->
11520 let name = java_name_of_struct typ in
11522 | RHashtable _ -> pr "Hashtable"
11523 | RBufferOut _ -> pr "%s" string
11527 and generate_csharp () =
11528 generate_header CPlusPlusStyle LGPLv2plus;
11530 (* XXX Make this configurable by the C# assembly users. *)
11531 let library = "libguestfs.so.0" in
11534 // These C# bindings are highly experimental at present.
11536 // Firstly they only work on Linux (ie. Mono). In order to get them
11537 // to work on Windows (ie. .Net) you would need to port the library
11538 // itself to Windows first.
11540 // The second issue is that some calls are known to be incorrect and
11541 // can cause Mono to segfault. Particularly: calls which pass or
11542 // return string[], or return any structure value. This is because
11543 // we haven't worked out the correct way to do this from C#.
11545 // The third issue is that when compiling you get a lot of warnings.
11546 // We are not sure whether the warnings are important or not.
11548 // Fourthly we do not routinely build or test these bindings as part
11549 // of the make && make check cycle, which means that regressions might
11552 // Suggestions and patches are welcome.
11556 // gmcs Libguestfs.cs
11557 // mono Libguestfs.exe
11559 // (You'll probably want to add a Test class / static main function
11560 // otherwise this won't do anything useful).
11564 using System.Runtime.InteropServices;
11565 using System.Runtime.Serialization;
11566 using System.Collections;
11570 class Error : System.ApplicationException
11572 public Error (string message) : base (message) {}
11573 protected Error (SerializationInfo info, StreamingContext context) {}
11580 [DllImport (\"%s\")]
11581 static extern IntPtr guestfs_create ();
11585 _handle = guestfs_create ();
11586 if (_handle == IntPtr.Zero)
11587 throw new Error (\"could not create guestfs handle\");
11590 [DllImport (\"%s\")]
11591 static extern void guestfs_close (IntPtr h);
11595 guestfs_close (_handle);
11598 [DllImport (\"%s\")]
11599 static extern string guestfs_last_error (IntPtr h);
11601 " library library library;
11603 (* Generate C# structure bindings. We prefix struct names with
11604 * underscore because C# cannot have conflicting struct names and
11605 * method names (eg. "class stat" and "stat").
11609 pr " [StructLayout (LayoutKind.Sequential)]\n";
11610 pr " public class _%s {\n" typ;
11613 | name, FChar -> pr " char %s;\n" name
11614 | name, FString -> pr " string %s;\n" name
11616 pr " uint %s_len;\n" name;
11617 pr " string %s;\n" name
11619 pr " [MarshalAs (UnmanagedType.ByValTStr, SizeConst=16)]\n";
11620 pr " string %s;\n" name
11621 | name, FUInt32 -> pr " uint %s;\n" name
11622 | name, FInt32 -> pr " int %s;\n" name
11623 | name, (FUInt64|FBytes) -> pr " ulong %s;\n" name
11624 | name, FInt64 -> pr " long %s;\n" name
11625 | name, FOptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
11631 (* Generate C# function bindings. *)
11633 fun (name, style, _, _, _, shortdesc, _) ->
11634 let rec csharp_return_type () =
11635 match fst style with
11637 | RBool n -> "bool"
11639 | RInt64 n -> "long"
11641 | RConstOptString n
11643 | RBufferOut n -> "string"
11644 | RStruct (_,n) -> "_" ^ n
11645 | RHashtable n -> "Hashtable"
11646 | RStringList n -> "string[]"
11647 | RStructList (_,n) -> sprintf "_%s[]" n
11649 and c_return_type () =
11650 match fst style with
11654 | RInt64 _ -> "long"
11656 | RConstOptString _
11658 | RBufferOut _ -> "string"
11659 | RStruct (_,n) -> "_" ^ n
11661 | RStringList _ -> "string[]"
11662 | RStructList (_,n) -> sprintf "_%s[]" n
11664 and c_error_comparison () =
11665 match fst style with
11669 | RInt64 _ -> "== -1"
11671 | RConstOptString _
11677 | RStructList (_,_) -> "== null"
11679 and generate_extern_prototype () =
11680 pr " static extern %s guestfs_%s (IntPtr h"
11681 (c_return_type ()) name;
11684 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
11685 | FileIn n | FileOut n
11688 pr ", [In] string %s" n
11689 | StringList n | DeviceList n ->
11690 pr ", [In] string[] %s" n
11700 and generate_public_prototype () =
11701 pr " public %s %s (" (csharp_return_type ()) name;
11702 let comma = ref false in
11704 if !comma then pr ", ";
11709 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
11710 | FileIn n | FileOut n
11713 next (); pr "string %s" n
11714 | StringList n | DeviceList n ->
11715 next (); pr "string[] %s" n
11717 next (); pr "bool %s" n
11719 next (); pr "int %s" n
11721 next (); pr "long %s" n
11725 and generate_call () =
11726 pr "guestfs_%s (_handle" name;
11727 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) (snd style);
11731 pr " [DllImport (\"%s\")]\n" library;
11732 generate_extern_prototype ();
11734 pr " /// <summary>\n";
11735 pr " /// %s\n" shortdesc;
11736 pr " /// </summary>\n";
11737 generate_public_prototype ();
11739 pr " %s r;\n" (c_return_type ());
11742 pr " if (r %s)\n" (c_error_comparison ());
11743 pr " throw new Error (guestfs_last_error (_handle));\n";
11744 (match fst style with
11747 pr " return r != 0 ? true : false;\n"
11749 pr " Hashtable rr = new Hashtable ();\n";
11750 pr " for (size_t i = 0; i < r.Length; i += 2)\n";
11751 pr " rr.Add (r[i], r[i+1]);\n";
11753 | RInt _ | RInt64 _ | RConstString _ | RConstOptString _
11754 | RString _ | RBufferOut _ | RStruct _ | RStringList _
11760 ) all_functions_sorted;
11766 and generate_bindtests () =
11767 generate_header CStyle LGPLv2plus;
11771 #include <stdlib.h>
11772 #include <inttypes.h>
11773 #include <string.h>
11775 #include \"guestfs.h\"
11776 #include \"guestfs-internal.h\"
11777 #include \"guestfs-internal-actions.h\"
11778 #include \"guestfs_protocol.h\"
11780 #define error guestfs_error
11781 #define safe_calloc guestfs_safe_calloc
11782 #define safe_malloc guestfs_safe_malloc
11785 print_strings (char *const *argv)
11790 for (argc = 0; argv[argc] != NULL; ++argc) {
11791 if (argc > 0) printf (\", \");
11792 printf (\"\\\"%%s\\\"\", argv[argc]);
11797 /* The test0 function prints its parameters to stdout. */
11801 match test_functions with
11802 | [] -> assert false
11803 | test0 :: tests -> test0, tests in
11806 let (name, style, _, _, _, _, _) = test0 in
11807 generate_prototype ~extern:false ~semicolon:false ~newline:true
11808 ~handle:"g" ~prefix:"guestfs__" name style;
11813 | Device n | Dev_or_Path n
11817 | Key n -> pr " printf (\"%%s\\n\", %s);\n" n
11821 pr " for (i = 0; i < %s_size; ++i)\n" n;
11822 pr " printf (\"<%%02x>\", %s[i]);\n" n;
11823 pr " printf (\"\\n\");\n";
11825 | OptString n -> pr " printf (\"%%s\\n\", %s ? %s : \"null\");\n" n n
11826 | StringList n | DeviceList n -> pr " print_strings (%s);\n" n
11827 | Bool n -> pr " printf (\"%%s\\n\", %s ? \"true\" : \"false\");\n" n
11828 | Int n -> pr " printf (\"%%d\\n\", %s);\n" n
11829 | Int64 n -> pr " printf (\"%%\" PRIi64 \"\\n\", %s);\n" n
11831 pr " /* Java changes stdout line buffering so we need this: */\n";
11832 pr " fflush (stdout);\n";
11838 fun (name, style, _, _, _, _, _) ->
11839 if String.sub name (String.length name - 3) 3 <> "err" then (
11840 pr "/* Test normal return. */\n";
11841 generate_prototype ~extern:false ~semicolon:false ~newline:true
11842 ~handle:"g" ~prefix:"guestfs__" name style;
11844 (match fst style with
11849 pr " sscanf (val, \"%%d\", &r);\n";
11852 pr " int64_t r;\n";
11853 pr " sscanf (val, \"%%\" SCNi64, &r);\n";
11856 pr " return STREQ (val, \"true\");\n"
11858 | RConstOptString _ ->
11859 (* Can't return the input string here. Return a static
11860 * string so we ensure we get a segfault if the caller
11861 * tries to free it.
11863 pr " return \"static string\";\n"
11865 pr " return strdup (val);\n"
11867 pr " char **strs;\n";
11869 pr " sscanf (val, \"%%d\", &n);\n";
11870 pr " strs = safe_malloc (g, (n+1) * sizeof (char *));\n";
11871 pr " for (i = 0; i < n; ++i) {\n";
11872 pr " strs[i] = safe_malloc (g, 16);\n";
11873 pr " snprintf (strs[i], 16, \"%%d\", i);\n";
11875 pr " strs[n] = NULL;\n";
11876 pr " return strs;\n"
11877 | RStruct (_, typ) ->
11878 pr " struct guestfs_%s *r;\n" typ;
11879 pr " r = safe_calloc (g, sizeof *r, 1);\n";
11881 | RStructList (_, typ) ->
11882 pr " struct guestfs_%s_list *r;\n" typ;
11883 pr " r = safe_calloc (g, sizeof *r, 1);\n";
11884 pr " sscanf (val, \"%%d\", &r->len);\n";
11885 pr " r->val = safe_calloc (g, r->len, sizeof *r->val);\n";
11888 pr " char **strs;\n";
11890 pr " sscanf (val, \"%%d\", &n);\n";
11891 pr " strs = safe_malloc (g, (n*2+1) * sizeof (*strs));\n";
11892 pr " for (i = 0; i < n; ++i) {\n";
11893 pr " strs[i*2] = safe_malloc (g, 16);\n";
11894 pr " strs[i*2+1] = safe_malloc (g, 16);\n";
11895 pr " snprintf (strs[i*2], 16, \"%%d\", i);\n";
11896 pr " snprintf (strs[i*2+1], 16, \"%%d\", i);\n";
11898 pr " strs[n*2] = NULL;\n";
11899 pr " return strs;\n"
11901 pr " return strdup (val);\n"
11906 pr "/* Test error return. */\n";
11907 generate_prototype ~extern:false ~semicolon:false ~newline:true
11908 ~handle:"g" ~prefix:"guestfs__" name style;
11910 pr " error (g, \"error\");\n";
11911 (match fst style with
11912 | RErr | RInt _ | RInt64 _ | RBool _ ->
11914 | RConstString _ | RConstOptString _
11915 | RString _ | RStringList _ | RStruct _
11919 pr " return NULL;\n"
11926 and generate_ocaml_bindtests () =
11927 generate_header OCamlStyle GPLv2plus;
11931 let g = Guestfs.create () in
11935 String.concat " " (
11938 | CallString s -> "\"" ^ s ^ "\""
11939 | CallOptString None -> "None"
11940 | CallOptString (Some s) -> sprintf "(Some \"%s\")" s
11941 | CallStringList xs ->
11942 "[|" ^ String.concat ";" (List.map (sprintf "\"%s\"") xs) ^ "|]"
11943 | CallInt i when i >= 0 -> string_of_int i
11944 | CallInt i (* when i < 0 *) -> "(" ^ string_of_int i ^ ")"
11945 | CallInt64 i when i >= 0L -> Int64.to_string i ^ "L"
11946 | CallInt64 i (* when i < 0L *) -> "(" ^ Int64.to_string i ^ "L)"
11947 | CallBool b -> string_of_bool b
11948 | CallBuffer s -> sprintf "%S" s
11953 generate_lang_bindtests (
11954 fun f args -> pr " Guestfs.%s g %s;\n" f (mkargs args)
11957 pr "print_endline \"EOF\"\n"
11959 and generate_perl_bindtests () =
11960 pr "#!/usr/bin/perl -w\n";
11961 generate_header HashStyle GPLv2plus;
11968 my $g = Sys::Guestfs->new ();
11972 String.concat ", " (
11975 | CallString s -> "\"" ^ s ^ "\""
11976 | CallOptString None -> "undef"
11977 | CallOptString (Some s) -> sprintf "\"%s\"" s
11978 | CallStringList xs ->
11979 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
11980 | CallInt i -> string_of_int i
11981 | CallInt64 i -> Int64.to_string i
11982 | CallBool b -> if b then "1" else "0"
11983 | CallBuffer s -> "\"" ^ c_quote s ^ "\""
11988 generate_lang_bindtests (
11989 fun f args -> pr "$g->%s (%s);\n" f (mkargs args)
11992 pr "print \"EOF\\n\"\n"
11994 and generate_python_bindtests () =
11995 generate_header HashStyle GPLv2plus;
12000 g = guestfs.GuestFS ()
12004 String.concat ", " (
12007 | CallString s -> "\"" ^ s ^ "\""
12008 | CallOptString None -> "None"
12009 | CallOptString (Some s) -> sprintf "\"%s\"" s
12010 | CallStringList xs ->
12011 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
12012 | CallInt i -> string_of_int i
12013 | CallInt64 i -> Int64.to_string i
12014 | CallBool b -> if b then "1" else "0"
12015 | CallBuffer s -> "\"" ^ c_quote s ^ "\""
12020 generate_lang_bindtests (
12021 fun f args -> pr "g.%s (%s)\n" f (mkargs args)
12024 pr "print \"EOF\"\n"
12026 and generate_ruby_bindtests () =
12027 generate_header HashStyle GPLv2plus;
12032 g = Guestfs::create()
12036 String.concat ", " (
12039 | CallString s -> "\"" ^ s ^ "\""
12040 | CallOptString None -> "nil"
12041 | CallOptString (Some s) -> sprintf "\"%s\"" s
12042 | CallStringList xs ->
12043 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
12044 | CallInt i -> string_of_int i
12045 | CallInt64 i -> Int64.to_string i
12046 | CallBool b -> string_of_bool b
12047 | CallBuffer s -> "\"" ^ c_quote s ^ "\""
12052 generate_lang_bindtests (
12053 fun f args -> pr "g.%s(%s)\n" f (mkargs args)
12056 pr "print \"EOF\\n\"\n"
12058 and generate_java_bindtests () =
12059 generate_header CStyle GPLv2plus;
12062 import com.redhat.et.libguestfs.*;
12064 public class Bindtests {
12065 public static void main (String[] argv)
12068 GuestFS g = new GuestFS ();
12072 String.concat ", " (
12075 | CallString s -> "\"" ^ s ^ "\""
12076 | CallOptString None -> "null"
12077 | CallOptString (Some s) -> sprintf "\"%s\"" s
12078 | CallStringList xs ->
12080 String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "}"
12081 | CallInt i -> string_of_int i
12082 | CallInt64 i -> Int64.to_string i
12083 | CallBool b -> string_of_bool b
12085 "new byte[] { " ^ String.concat "," (
12086 map_chars (fun c -> string_of_int (Char.code c)) s
12092 generate_lang_bindtests (
12093 fun f args -> pr " g.%s (%s);\n" f (mkargs args)
12097 System.out.println (\"EOF\");
12099 catch (Exception exn) {
12100 System.err.println (exn);
12107 and generate_haskell_bindtests () =
12108 generate_header HaskellStyle GPLv2plus;
12111 module Bindtests where
12112 import qualified Guestfs
12115 g <- Guestfs.create
12119 String.concat " " (
12122 | CallString s -> "\"" ^ s ^ "\""
12123 | CallOptString None -> "Nothing"
12124 | CallOptString (Some s) -> sprintf "(Just \"%s\")" s
12125 | CallStringList xs ->
12126 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
12127 | CallInt i when i < 0 -> "(" ^ string_of_int i ^ ")"
12128 | CallInt i -> string_of_int i
12129 | CallInt64 i when i < 0L -> "(" ^ Int64.to_string i ^ ")"
12130 | CallInt64 i -> Int64.to_string i
12131 | CallBool true -> "True"
12132 | CallBool false -> "False"
12133 | CallBuffer s -> "\"" ^ c_quote s ^ "\""
12138 generate_lang_bindtests (
12139 fun f args -> pr " Guestfs.%s g %s\n" f (mkargs args)
12142 pr " putStrLn \"EOF\"\n"
12144 (* Language-independent bindings tests - we do it this way to
12145 * ensure there is parity in testing bindings across all languages.
12147 and generate_lang_bindtests call =
12148 call "test0" [CallString "abc"; CallOptString (Some "def");
12149 CallStringList []; CallBool false;
12150 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
12151 CallBuffer "abc\000abc"];
12152 call "test0" [CallString "abc"; CallOptString None;
12153 CallStringList []; CallBool false;
12154 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
12155 CallBuffer "abc\000abc"];
12156 call "test0" [CallString ""; CallOptString (Some "def");
12157 CallStringList []; CallBool false;
12158 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
12159 CallBuffer "abc\000abc"];
12160 call "test0" [CallString ""; CallOptString (Some "");
12161 CallStringList []; CallBool false;
12162 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
12163 CallBuffer "abc\000abc"];
12164 call "test0" [CallString "abc"; CallOptString (Some "def");
12165 CallStringList ["1"]; CallBool false;
12166 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
12167 CallBuffer "abc\000abc"];
12168 call "test0" [CallString "abc"; CallOptString (Some "def");
12169 CallStringList ["1"; "2"]; CallBool false;
12170 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
12171 CallBuffer "abc\000abc"];
12172 call "test0" [CallString "abc"; CallOptString (Some "def");
12173 CallStringList ["1"]; CallBool true;
12174 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
12175 CallBuffer "abc\000abc"];
12176 call "test0" [CallString "abc"; CallOptString (Some "def");
12177 CallStringList ["1"]; CallBool false;
12178 CallInt (-1); CallInt64 (-1L); CallString "123"; CallString "456";
12179 CallBuffer "abc\000abc"];
12180 call "test0" [CallString "abc"; CallOptString (Some "def");
12181 CallStringList ["1"]; CallBool false;
12182 CallInt (-2); CallInt64 (-2L); CallString "123"; CallString "456";
12183 CallBuffer "abc\000abc"];
12184 call "test0" [CallString "abc"; CallOptString (Some "def");
12185 CallStringList ["1"]; CallBool false;
12186 CallInt 1; CallInt64 1L; CallString "123"; CallString "456";
12187 CallBuffer "abc\000abc"];
12188 call "test0" [CallString "abc"; CallOptString (Some "def");
12189 CallStringList ["1"]; CallBool false;
12190 CallInt 2; CallInt64 2L; CallString "123"; CallString "456";
12191 CallBuffer "abc\000abc"];
12192 call "test0" [CallString "abc"; CallOptString (Some "def");
12193 CallStringList ["1"]; CallBool false;
12194 CallInt 4095; CallInt64 4095L; CallString "123"; CallString "456";
12195 CallBuffer "abc\000abc"];
12196 call "test0" [CallString "abc"; CallOptString (Some "def");
12197 CallStringList ["1"]; CallBool false;
12198 CallInt 0; CallInt64 0L; CallString ""; CallString "";
12199 CallBuffer "abc\000abc"]
12201 (* XXX Add here tests of the return and error functions. *)
12203 and generate_max_proc_nr () =
12204 pr "%d\n" max_proc_nr
12206 let output_to filename k =
12207 let filename_new = filename ^ ".new" in
12208 chan := open_out filename_new;
12211 chan := Pervasives.stdout;
12213 (* Is the new file different from the current file? *)
12214 if Sys.file_exists filename && files_equal filename filename_new then
12215 unlink filename_new (* same, so skip it *)
12217 (* different, overwrite old one *)
12218 (try chmod filename 0o644 with Unix_error _ -> ());
12219 rename filename_new filename;
12220 chmod filename 0o444;
12221 printf "written %s\n%!" filename;
12224 let perror msg = function
12225 | Unix_error (err, _, _) ->
12226 eprintf "%s: %s\n" msg (error_message err)
12228 eprintf "%s: %s\n" msg (Printexc.to_string exn)
12230 (* Main program. *)
12233 try openfile "HACKING" [O_RDWR] 0
12235 | Unix_error (ENOENT, _, _) ->
12237 You are probably running this from the wrong directory.
12238 Run it from the top source directory using the command
12243 perror "open: HACKING" exn;
12246 (* Acquire a lock so parallel builds won't try to run the generator
12247 * twice at the same time. Subsequent builds will wait for the first
12248 * one to finish. Note the lock is released implicitly when the
12251 (try lockf lock_fd F_LOCK 1
12253 perror "lock: HACKING" exn;
12256 check_functions ();
12258 output_to "src/guestfs_protocol.x" generate_xdr;
12259 output_to "src/guestfs-structs.h" generate_structs_h;
12260 output_to "src/guestfs-actions.h" generate_actions_h;
12261 output_to "src/guestfs-internal-actions.h" generate_internal_actions_h;
12262 output_to "src/actions.c" generate_client_actions;
12263 output_to "src/bindtests.c" generate_bindtests;
12264 output_to "src/guestfs-structs.pod" generate_structs_pod;
12265 output_to "src/guestfs-actions.pod" generate_actions_pod;
12266 output_to "src/guestfs-availability.pod" generate_availability_pod;
12267 output_to "src/MAX_PROC_NR" generate_max_proc_nr;
12268 output_to "src/libguestfs.syms" generate_linker_script;
12269 output_to "daemon/actions.h" generate_daemon_actions_h;
12270 output_to "daemon/stubs.c" generate_daemon_actions;
12271 output_to "daemon/names.c" generate_daemon_names;
12272 output_to "daemon/optgroups.c" generate_daemon_optgroups_c;
12273 output_to "daemon/optgroups.h" generate_daemon_optgroups_h;
12274 output_to "capitests/tests.c" generate_tests;
12275 output_to "fish/cmds.c" generate_fish_cmds;
12276 output_to "fish/completion.c" generate_fish_completion;
12277 output_to "fish/guestfish-actions.pod" generate_fish_actions_pod;
12278 output_to "ocaml/guestfs.mli" generate_ocaml_mli;
12279 output_to "ocaml/guestfs.ml" generate_ocaml_ml;
12280 output_to "ocaml/guestfs_c_actions.c" generate_ocaml_c;
12281 output_to "ocaml/bindtests.ml" generate_ocaml_bindtests;
12282 output_to "perl/Guestfs.xs" generate_perl_xs;
12283 output_to "perl/lib/Sys/Guestfs.pm" generate_perl_pm;
12284 output_to "perl/bindtests.pl" generate_perl_bindtests;
12285 output_to "python/guestfs-py.c" generate_python_c;
12286 output_to "python/guestfs.py" generate_python_py;
12287 output_to "python/bindtests.py" generate_python_bindtests;
12288 output_to "ruby/ext/guestfs/_guestfs.c" generate_ruby_c;
12289 output_to "ruby/bindtests.rb" generate_ruby_bindtests;
12290 output_to "java/com/redhat/et/libguestfs/GuestFS.java" generate_java_java;
12294 let cols = cols_of_struct typ in
12295 let filename = sprintf "java/com/redhat/et/libguestfs/%s.java" jtyp in
12296 output_to filename (generate_java_struct jtyp cols);
12299 output_to "java/Makefile.inc" generate_java_makefile_inc;
12300 output_to "java/com_redhat_et_libguestfs_GuestFS.c" generate_java_c;
12301 output_to "java/Bindtests.java" generate_java_bindtests;
12302 output_to "haskell/Guestfs.hs" generate_haskell_hs;
12303 output_to "haskell/Bindtests.hs" generate_haskell_bindtests;
12304 output_to "csharp/Libguestfs.cs" generate_csharp;
12306 (* Always generate this file last, and unconditionally. It's used
12307 * by the Makefile to know when we must re-run the generator.
12309 let chan = open_out "src/stamp-generator" in
12310 fprintf chan "1\n";
12313 printf "generated %d lines of code\n" !lines