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.
179 | ProtocolLimitWarning (* display warning about protocol size limits *)
180 | DangerWillRobinson (* flags particularly dangerous commands *)
181 | FishAlias of string (* provide an alias for this cmd in guestfish *)
182 | FishOutput of fish_output_t (* how to display output in guestfish *)
183 | NotInFish (* do not export via guestfish *)
184 | NotInDocs (* do not add this function to documentation *)
185 | DeprecatedBy of string (* function is deprecated, use .. instead *)
186 | Optional of string (* function is part of an optional group *)
189 | FishOutputOctal (* for int return, print in octal *)
190 | FishOutputHexadecimal (* for int return, print in hex *)
192 (* You can supply zero or as many tests as you want per API call.
194 * Note that the test environment has 3 block devices, of size 500MB,
195 * 50MB and 10MB (respectively /dev/sda, /dev/sdb, /dev/sdc), and
196 * a fourth ISO block device with some known files on it (/dev/sdd).
198 * Note for partitioning purposes, the 500MB device has 1015 cylinders.
199 * Number of cylinders was 63 for IDE emulated disks with precisely
200 * the same size. How exactly this is calculated is a mystery.
202 * The ISO block device (/dev/sdd) comes from images/test.iso.
204 * To be able to run the tests in a reasonable amount of time,
205 * the virtual machine and block devices are reused between tests.
206 * So don't try testing kill_subprocess :-x
208 * Between each test we blockdev-setrw, umount-all, lvm-remove-all.
210 * Don't assume anything about the previous contents of the block
211 * devices. Use 'Init*' to create some initial scenarios.
213 * You can add a prerequisite clause to any individual test. This
214 * is a run-time check, which, if it fails, causes the test to be
215 * skipped. Useful if testing a command which might not work on
216 * all variations of libguestfs builds. A test that has prerequisite
217 * of 'Always' is run unconditionally.
219 * In addition, packagers can skip individual tests by setting the
220 * environment variables: eg:
221 * SKIP_TEST_<CMD>_<NUM>=1 SKIP_TEST_COMMAND_3=1 (skips test #3 of command)
222 * SKIP_TEST_<CMD>=1 SKIP_TEST_ZEROFREE=1 (skips all zerofree tests)
224 type tests = (test_init * test_prereq * test) list
226 (* Run the command sequence and just expect nothing to fail. *)
229 (* Run the command sequence and expect the output of the final
230 * command to be the string.
232 | TestOutput of seq * string
234 (* Run the command sequence and expect the output of the final
235 * command to be the list of strings.
237 | TestOutputList of seq * string list
239 (* Run the command sequence and expect the output of the final
240 * command to be the list of block devices (could be either
241 * "/dev/sd.." or "/dev/hd.." form - we don't check the 5th
242 * character of each string).
244 | TestOutputListOfDevices of seq * string list
246 (* Run the command sequence and expect the output of the final
247 * command to be the integer.
249 | TestOutputInt of seq * int
251 (* Run the command sequence and expect the output of the final
252 * command to be <op> <int>, eg. ">=", "1".
254 | TestOutputIntOp of seq * string * int
256 (* Run the command sequence and expect the output of the final
257 * command to be a true value (!= 0 or != NULL).
259 | TestOutputTrue of seq
261 (* Run the command sequence and expect the output of the final
262 * command to be a false value (== 0 or == NULL, but not an error).
264 | TestOutputFalse of seq
266 (* Run the command sequence and expect the output of the final
267 * command to be a list of the given length (but don't care about
270 | TestOutputLength of seq * int
272 (* Run the command sequence and expect the output of the final
273 * command to be a buffer (RBufferOut), ie. string + size.
275 | TestOutputBuffer of seq * string
277 (* Run the command sequence and expect the output of the final
278 * command to be a structure.
280 | TestOutputStruct of seq * test_field_compare list
282 (* Run the command sequence and expect the final command (only)
285 | TestLastFail of seq
287 and test_field_compare =
288 | CompareWithInt of string * int
289 | CompareWithIntOp of string * string * int
290 | CompareWithString of string * string
291 | CompareFieldsIntEq of string * string
292 | CompareFieldsStrEq of string * string
294 (* Test prerequisites. *)
296 (* Test always runs. *)
299 (* Test is currently disabled - eg. it fails, or it tests some
300 * unimplemented feature.
304 (* 'string' is some C code (a function body) that should return
305 * true or false. The test will run if the code returns true.
309 (* As for 'If' but the test runs _unless_ the code returns true. *)
312 (* Some initial scenarios for testing. *)
314 (* Do nothing, block devices could contain random stuff including
315 * LVM PVs, and some filesystems might be mounted. This is usually
320 (* Block devices are empty and no filesystems are mounted. *)
323 (* /dev/sda contains a single partition /dev/sda1, with random
324 * content. /dev/sdb and /dev/sdc may have random content.
329 (* /dev/sda contains a single partition /dev/sda1, which is formatted
330 * as ext2, empty [except for lost+found] and mounted on /.
331 * /dev/sdb and /dev/sdc may have random content.
337 * /dev/sda1 (is a PV):
338 * /dev/VG/LV (size 8MB):
339 * formatted as ext2, empty [except for lost+found], mounted on /
340 * /dev/sdb and /dev/sdc may have random content.
344 (* /dev/sdd (the ISO, see images/ directory in source)
349 (* Sequence of commands for testing. *)
351 and cmd = string list
353 (* Note about long descriptions: When referring to another
354 * action, use the format C<guestfs_other> (ie. the full name of
355 * the C function). This will be replaced as appropriate in other
358 * Apart from that, long descriptions are just perldoc paragraphs.
361 (* Generate a random UUID (used in tests). *)
363 let chan = open_process_in "uuidgen" in
364 let uuid = input_line chan in
365 (match close_process_in chan with
368 failwith "uuidgen: process exited with non-zero status"
369 | WSIGNALED _ | WSTOPPED _ ->
370 failwith "uuidgen: process signalled or stopped by signal"
374 (* These test functions are used in the language binding tests. *)
376 let test_all_args = [
379 StringList "strlist";
388 let test_all_rets = [
389 (* except for RErr, which is tested thoroughly elsewhere *)
390 "test0rint", RInt "valout";
391 "test0rint64", RInt64 "valout";
392 "test0rbool", RBool "valout";
393 "test0rconststring", RConstString "valout";
394 "test0rconstoptstring", RConstOptString "valout";
395 "test0rstring", RString "valout";
396 "test0rstringlist", RStringList "valout";
397 "test0rstruct", RStruct ("valout", "lvm_pv");
398 "test0rstructlist", RStructList ("valout", "lvm_pv");
399 "test0rhashtable", RHashtable "valout";
402 let test_functions = [
403 ("test0", (RErr, test_all_args), -1, [NotInFish; NotInDocs],
405 "internal test function - do not use",
407 This is an internal test function which is used to test whether
408 the automatically generated bindings can handle every possible
409 parameter type correctly.
411 It echos the contents of each parameter to stdout.
413 You probably don't want to call this function.");
417 [(name, (ret, [String "val"]), -1, [NotInFish; NotInDocs],
419 "internal test function - do not use",
421 This is an internal test function which is used to test whether
422 the automatically generated bindings can handle every possible
423 return type correctly.
425 It converts string C<val> to the return type.
427 You probably don't want to call this function.");
428 (name ^ "err", (ret, []), -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 This function always returns an error.
438 You probably don't want to call this function.")]
442 (* non_daemon_functions are any functions which don't get processed
443 * in the daemon, eg. functions for setting and getting local
444 * configuration values.
447 let non_daemon_functions = test_functions @ [
448 ("launch", (RErr, []), -1, [FishAlias "run"],
450 "launch the qemu subprocess",
452 Internally libguestfs is implemented by running a virtual machine
455 You should call this after configuring the handle
456 (eg. adding drives) but before performing any actions.");
458 ("wait_ready", (RErr, []), -1, [NotInFish],
460 "wait until the qemu subprocess launches (no op)",
462 This function is a no op.
464 In versions of the API E<lt> 1.0.71 you had to call this function
465 just after calling C<guestfs_launch> to wait for the launch
466 to complete. However this is no longer necessary because
467 C<guestfs_launch> now does the waiting.
469 If you see any calls to this function in code then you can just
470 remove them, unless you want to retain compatibility with older
471 versions of the API.");
473 ("kill_subprocess", (RErr, []), -1, [],
475 "kill the qemu subprocess",
477 This kills the qemu subprocess. You should never need to call this.");
479 ("add_drive", (RErr, [String "filename"]), -1, [FishAlias "add"],
481 "add an image to examine or modify",
483 This function adds a virtual machine disk image C<filename> to the
484 guest. The first time you call this function, the disk appears as IDE
485 disk 0 (C</dev/sda>) in the guest, the second time as C</dev/sdb>, and
488 You don't necessarily need to be root when using libguestfs. However
489 you obviously do need sufficient permissions to access the filename
490 for whatever operations you want to perform (ie. read access if you
491 just want to read the image or write access if you want to modify the
494 This is equivalent to the qemu parameter
495 C<-drive file=filename,cache=off,if=...>.
497 C<cache=off> is omitted in cases where it is not supported by
498 the underlying filesystem.
500 C<if=...> is set at compile time by the configuration option
501 C<./configure --with-drive-if=...>. In the rare case where you
502 might need to change this at run time, use C<guestfs_add_drive_with_if>
503 or C<guestfs_add_drive_ro_with_if>.
505 Note that this call checks for the existence of C<filename>. This
506 stops you from specifying other types of drive which are supported
507 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
508 the general C<guestfs_config> call instead.");
510 ("add_cdrom", (RErr, [String "filename"]), -1, [FishAlias "cdrom"],
512 "add a CD-ROM disk image to examine",
514 This function adds a virtual CD-ROM disk image to the guest.
516 This is equivalent to the qemu parameter C<-cdrom filename>.
524 This call checks for the existence of C<filename>. This
525 stops you from specifying other types of drive which are supported
526 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
527 the general C<guestfs_config> call instead.
531 If you just want to add an ISO file (often you use this as an
532 efficient way to transfer large files into the guest), then you
533 should probably use C<guestfs_add_drive_ro> instead.
537 ("add_drive_ro", (RErr, [String "filename"]), -1, [FishAlias "add-ro"],
539 "add a drive in snapshot mode (read-only)",
541 This adds a drive in snapshot mode, making it effectively
544 Note that writes to the device are allowed, and will be seen for
545 the duration of the guestfs handle, but they are written
546 to a temporary file which is discarded as soon as the guestfs
547 handle is closed. We don't currently have any method to enable
548 changes to be committed, although qemu can support this.
550 This is equivalent to the qemu parameter
551 C<-drive file=filename,snapshot=on,readonly=on,if=...>.
553 C<if=...> is set at compile time by the configuration option
554 C<./configure --with-drive-if=...>. In the rare case where you
555 might need to change this at run time, use C<guestfs_add_drive_with_if>
556 or C<guestfs_add_drive_ro_with_if>.
558 C<readonly=on> is only added where qemu supports this option.
560 Note that this call checks for the existence of C<filename>. This
561 stops you from specifying other types of drive which are supported
562 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
563 the general C<guestfs_config> call instead.");
565 ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"]), -1, [],
567 "add qemu parameters",
569 This can be used to add arbitrary qemu command line parameters
570 of the form C<-param value>. Actually it's not quite arbitrary - we
571 prevent you from setting some parameters which would interfere with
572 parameters that we use.
574 The first character of C<param> string must be a C<-> (dash).
576 C<value> can be NULL.");
578 ("set_qemu", (RErr, [OptString "qemu"]), -1, [FishAlias "qemu"],
580 "set the qemu binary",
582 Set the qemu binary that we will use.
584 The default is chosen when the library was compiled by the
587 You can also override this by setting the C<LIBGUESTFS_QEMU>
588 environment variable.
590 Setting C<qemu> to C<NULL> restores the default qemu binary.
592 Note that you should call this function as early as possible
593 after creating the handle. This is because some pre-launch
594 operations depend on testing qemu features (by running C<qemu -help>).
595 If the qemu binary changes, we don't retest features, and
596 so you might see inconsistent results. Using the environment
597 variable C<LIBGUESTFS_QEMU> is safest of all since that picks
598 the qemu binary at the same time as the handle is created.");
600 ("get_qemu", (RConstString "qemu", []), -1, [],
601 [InitNone, Always, TestRun (
603 "get the qemu binary",
605 Return the current qemu binary.
607 This is always non-NULL. If it wasn't set already, then this will
608 return the default qemu binary name.");
610 ("set_path", (RErr, [OptString "searchpath"]), -1, [FishAlias "path"],
612 "set the search path",
614 Set the path that libguestfs searches for kernel and initrd.img.
616 The default is C<$libdir/guestfs> unless overridden by setting
617 C<LIBGUESTFS_PATH> environment variable.
619 Setting C<path> to C<NULL> restores the default path.");
621 ("get_path", (RConstString "path", []), -1, [],
622 [InitNone, Always, TestRun (
624 "get the search path",
626 Return the current search path.
628 This is always non-NULL. If it wasn't set already, then this will
629 return the default path.");
631 ("set_append", (RErr, [OptString "append"]), -1, [FishAlias "append"],
633 "add options to kernel command line",
635 This function is used to add additional options to the
636 guest kernel command line.
638 The default is C<NULL> unless overridden by setting
639 C<LIBGUESTFS_APPEND> environment variable.
641 Setting C<append> to C<NULL> means I<no> additional options
642 are passed (libguestfs always adds a few of its own).");
644 ("get_append", (RConstOptString "append", []), -1, [],
645 (* This cannot be tested with the current framework. The
646 * function can return NULL in normal operations, which the
647 * test framework interprets as an error.
650 "get the additional kernel options",
652 Return the additional kernel options which are added to the
653 guest kernel command line.
655 If C<NULL> then no options are added.");
657 ("set_autosync", (RErr, [Bool "autosync"]), -1, [FishAlias "autosync"],
661 If C<autosync> is true, this enables autosync. Libguestfs will make a
662 best effort attempt to run C<guestfs_umount_all> followed by
663 C<guestfs_sync> when the handle is closed
664 (also if the program exits without closing handles).
666 This is disabled by default (except in guestfish where it is
667 enabled by default).");
669 ("get_autosync", (RBool "autosync", []), -1, [],
670 [InitNone, Always, TestRun (
671 [["get_autosync"]])],
674 Get the autosync flag.");
676 ("set_verbose", (RErr, [Bool "verbose"]), -1, [FishAlias "verbose"],
680 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
682 Verbose messages are disabled unless the environment variable
683 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.");
685 ("get_verbose", (RBool "verbose", []), -1, [],
689 This returns the verbose messages flag.");
691 ("is_ready", (RBool "ready", []), -1, [],
692 [InitNone, Always, TestOutputTrue (
694 "is ready to accept commands",
696 This returns true iff this handle is ready to accept commands
697 (in the C<READY> state).
699 For more information on states, see L<guestfs(3)>.");
701 ("is_config", (RBool "config", []), -1, [],
702 [InitNone, Always, TestOutputFalse (
704 "is in configuration state",
706 This returns true iff this handle is being configured
707 (in the C<CONFIG> state).
709 For more information on states, see L<guestfs(3)>.");
711 ("is_launching", (RBool "launching", []), -1, [],
712 [InitNone, Always, TestOutputFalse (
713 [["is_launching"]])],
714 "is launching subprocess",
716 This returns true iff this handle is launching the subprocess
717 (in the C<LAUNCHING> state).
719 For more information on states, see L<guestfs(3)>.");
721 ("is_busy", (RBool "busy", []), -1, [],
722 [InitNone, Always, TestOutputFalse (
724 "is busy processing a command",
726 This returns true iff this handle is busy processing a command
727 (in the C<BUSY> state).
729 For more information on states, see L<guestfs(3)>.");
731 ("get_state", (RInt "state", []), -1, [],
733 "get the current state",
735 This returns the current state as an opaque integer. This is
736 only useful for printing debug and internal error messages.
738 For more information on states, see L<guestfs(3)>.");
740 ("set_memsize", (RErr, [Int "memsize"]), -1, [FishAlias "memsize"],
741 [InitNone, Always, TestOutputInt (
742 [["set_memsize"; "500"];
743 ["get_memsize"]], 500)],
744 "set memory allocated to the qemu subprocess",
746 This sets the memory size in megabytes allocated to the
747 qemu subprocess. This only has any effect if called before
750 You can also change this by setting the environment
751 variable C<LIBGUESTFS_MEMSIZE> before the handle is
754 For more information on the architecture of libguestfs,
755 see L<guestfs(3)>.");
757 ("get_memsize", (RInt "memsize", []), -1, [],
758 [InitNone, Always, TestOutputIntOp (
759 [["get_memsize"]], ">=", 256)],
760 "get memory allocated to the qemu subprocess",
762 This gets the memory size in megabytes allocated to the
765 If C<guestfs_set_memsize> was not called
766 on this handle, and if C<LIBGUESTFS_MEMSIZE> was not set,
767 then this returns the compiled-in default value for memsize.
769 For more information on the architecture of libguestfs,
770 see L<guestfs(3)>.");
772 ("get_pid", (RInt "pid", []), -1, [FishAlias "pid"],
773 [InitNone, Always, TestOutputIntOp (
774 [["get_pid"]], ">=", 1)],
775 "get PID of qemu subprocess",
777 Return the process ID of the qemu subprocess. If there is no
778 qemu subprocess, then this will return an error.
780 This is an internal call used for debugging and testing.");
782 ("version", (RStruct ("version", "version"), []), -1, [],
783 [InitNone, Always, TestOutputStruct (
784 [["version"]], [CompareWithInt ("major", 1)])],
785 "get the library version number",
787 Return the libguestfs version number that the program is linked
790 Note that because of dynamic linking this is not necessarily
791 the version of libguestfs that you compiled against. You can
792 compile the program, and then at runtime dynamically link
793 against a completely different C<libguestfs.so> library.
795 This call was added in version C<1.0.58>. In previous
796 versions of libguestfs there was no way to get the version
797 number. From C code you can use dynamic linker functions
798 to find out if this symbol exists (if it doesn't, then
799 it's an earlier version).
801 The call returns a structure with four elements. The first
802 three (C<major>, C<minor> and C<release>) are numbers and
803 correspond to the usual version triplet. The fourth element
804 (C<extra>) is a string and is normally empty, but may be
805 used for distro-specific information.
807 To construct the original version string:
808 C<$major.$minor.$release$extra>
810 See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>.
812 I<Note:> Don't use this call to test for availability
813 of features. In enterprise distributions we backport
814 features from later versions into earlier versions,
815 making this an unreliable way to test for features.
816 Use C<guestfs_available> instead.");
818 ("set_selinux", (RErr, [Bool "selinux"]), -1, [FishAlias "selinux"],
819 [InitNone, Always, TestOutputTrue (
820 [["set_selinux"; "true"];
822 "set SELinux enabled or disabled at appliance boot",
824 This sets the selinux flag that is passed to the appliance
825 at boot time. The default is C<selinux=0> (disabled).
827 Note that if SELinux is enabled, it is always in
828 Permissive mode (C<enforcing=0>).
830 For more information on the architecture of libguestfs,
831 see L<guestfs(3)>.");
833 ("get_selinux", (RBool "selinux", []), -1, [],
835 "get SELinux enabled flag",
837 This returns the current setting of the selinux flag which
838 is passed to the appliance at boot time. See C<guestfs_set_selinux>.
840 For more information on the architecture of libguestfs,
841 see L<guestfs(3)>.");
843 ("set_trace", (RErr, [Bool "trace"]), -1, [FishAlias "trace"],
844 [InitNone, Always, TestOutputFalse (
845 [["set_trace"; "false"];
847 "enable or disable command traces",
849 If the command trace flag is set to 1, then commands are
850 printed on stdout before they are executed in a format
851 which is very similar to the one used by guestfish. In
852 other words, you can run a program with this enabled, and
853 you will get out a script which you can feed to guestfish
854 to perform the same set of actions.
856 If you want to trace C API calls into libguestfs (and
857 other libraries) then possibly a better way is to use
858 the external ltrace(1) command.
860 Command traces are disabled unless the environment variable
861 C<LIBGUESTFS_TRACE> is defined and set to C<1>.");
863 ("get_trace", (RBool "trace", []), -1, [],
865 "get command trace enabled flag",
867 Return the command trace flag.");
869 ("set_direct", (RErr, [Bool "direct"]), -1, [FishAlias "direct"],
870 [InitNone, Always, TestOutputFalse (
871 [["set_direct"; "false"];
873 "enable or disable direct appliance mode",
875 If the direct appliance mode flag is enabled, then stdin and
876 stdout are passed directly through to the appliance once it
879 One consequence of this is that log messages aren't caught
880 by the library and handled by C<guestfs_set_log_message_callback>,
881 but go straight to stdout.
883 You probably don't want to use this unless you know what you
886 The default is disabled.");
888 ("get_direct", (RBool "direct", []), -1, [],
890 "get direct appliance mode flag",
892 Return the direct appliance mode flag.");
894 ("set_recovery_proc", (RErr, [Bool "recoveryproc"]), -1, [FishAlias "recovery-proc"],
895 [InitNone, Always, TestOutputTrue (
896 [["set_recovery_proc"; "true"];
897 ["get_recovery_proc"]])],
898 "enable or disable the recovery process",
900 If this is called with the parameter C<false> then
901 C<guestfs_launch> does not create a recovery process. The
902 purpose of the recovery process is to stop runaway qemu
903 processes in the case where the main program aborts abruptly.
905 This only has any effect if called before C<guestfs_launch>,
906 and the default is true.
908 About the only time when you would want to disable this is
909 if the main process will fork itself into the background
910 (\"daemonize\" itself). In this case the recovery process
911 thinks that the main program has disappeared and so kills
912 qemu, which is not very helpful.");
914 ("get_recovery_proc", (RBool "recoveryproc", []), -1, [],
916 "get recovery process enabled flag",
918 Return the recovery process enabled flag.");
920 ("add_drive_with_if", (RErr, [String "filename"; String "iface"]), -1, [],
922 "add a drive specifying the QEMU block emulation to use",
924 This is the same as C<guestfs_add_drive> but it allows you
925 to specify the QEMU interface emulation to use at run time.");
927 ("add_drive_ro_with_if", (RErr, [String "filename"; String "iface"]), -1, [],
929 "add a drive read-only specifying the QEMU block emulation to use",
931 This is the same as C<guestfs_add_drive_ro> but it allows you
932 to specify the QEMU interface emulation to use at run time.");
936 (* daemon_functions are any functions which cause some action
937 * to take place in the daemon.
940 let daemon_functions = [
941 ("mount", (RErr, [Device "device"; String "mountpoint"]), 1, [],
942 [InitEmpty, Always, TestOutput (
943 [["part_disk"; "/dev/sda"; "mbr"];
944 ["mkfs"; "ext2"; "/dev/sda1"];
945 ["mount"; "/dev/sda1"; "/"];
946 ["write"; "/new"; "new file contents"];
947 ["cat"; "/new"]], "new file contents")],
948 "mount a guest disk at a position in the filesystem",
950 Mount a guest disk at a position in the filesystem. Block devices
951 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
952 the guest. If those block devices contain partitions, they will have
953 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
956 The rules are the same as for L<mount(2)>: A filesystem must
957 first be mounted on C</> before others can be mounted. Other
958 filesystems can only be mounted on directories which already
961 The mounted filesystem is writable, if we have sufficient permissions
962 on the underlying device.
965 When you use this call, the filesystem options C<sync> and C<noatime>
966 are set implicitly. This was originally done because we thought it
967 would improve reliability, but it turns out that I<-o sync> has a
968 very large negative performance impact and negligible effect on
969 reliability. Therefore we recommend that you avoid using
970 C<guestfs_mount> in any code that needs performance, and instead
971 use C<guestfs_mount_options> (use an empty string for the first
972 parameter if you don't want any options).");
974 ("sync", (RErr, []), 2, [],
975 [ InitEmpty, Always, TestRun [["sync"]]],
976 "sync disks, writes are flushed through to the disk image",
978 This syncs the disk, so that any writes are flushed through to the
979 underlying disk image.
981 You should always call this if you have modified a disk image, before
982 closing the handle.");
984 ("touch", (RErr, [Pathname "path"]), 3, [],
985 [InitBasicFS, Always, TestOutputTrue (
987 ["exists"; "/new"]])],
988 "update file timestamps or create a new file",
990 Touch acts like the L<touch(1)> command. It can be used to
991 update the timestamps on a file, or, if the file does not exist,
992 to create a new zero-length file.");
994 ("cat", (RString "content", [Pathname "path"]), 4, [ProtocolLimitWarning],
995 [InitISOFS, Always, TestOutput (
996 [["cat"; "/known-2"]], "abcdef\n")],
997 "list the contents of a file",
999 Return the contents of the file named C<path>.
1001 Note that this function cannot correctly handle binary files
1002 (specifically, files containing C<\\0> character which is treated
1003 as end of string). For those you need to use the C<guestfs_read_file>
1004 or C<guestfs_download> functions which have a more complex interface.");
1006 ("ll", (RString "listing", [Pathname "directory"]), 5, [],
1007 [], (* XXX Tricky to test because it depends on the exact format
1008 * of the 'ls -l' command, which changes between F10 and F11.
1010 "list the files in a directory (long format)",
1012 List the files in C<directory> (relative to the root directory,
1013 there is no cwd) in the format of 'ls -la'.
1015 This command is mostly useful for interactive sessions. It
1016 is I<not> intended that you try to parse the output string.");
1018 ("ls", (RStringList "listing", [Pathname "directory"]), 6, [],
1019 [InitBasicFS, Always, TestOutputList (
1021 ["touch"; "/newer"];
1022 ["touch"; "/newest"];
1023 ["ls"; "/"]], ["lost+found"; "new"; "newer"; "newest"])],
1024 "list the files in a directory",
1026 List the files in C<directory> (relative to the root directory,
1027 there is no cwd). The '.' and '..' entries are not returned, but
1028 hidden files are shown.
1030 This command is mostly useful for interactive sessions. Programs
1031 should probably use C<guestfs_readdir> instead.");
1033 ("list_devices", (RStringList "devices", []), 7, [],
1034 [InitEmpty, Always, TestOutputListOfDevices (
1035 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1036 "list the block devices",
1038 List all the block devices.
1040 The full block device names are returned, eg. C</dev/sda>");
1042 ("list_partitions", (RStringList "partitions", []), 8, [],
1043 [InitBasicFS, Always, TestOutputListOfDevices (
1044 [["list_partitions"]], ["/dev/sda1"]);
1045 InitEmpty, Always, TestOutputListOfDevices (
1046 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1047 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1048 "list the partitions",
1050 List all the partitions detected on all block devices.
1052 The full partition device names are returned, eg. C</dev/sda1>
1054 This does not return logical volumes. For that you will need to
1055 call C<guestfs_lvs>.");
1057 ("pvs", (RStringList "physvols", []), 9, [Optional "lvm2"],
1058 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1059 [["pvs"]], ["/dev/sda1"]);
1060 InitEmpty, Always, TestOutputListOfDevices (
1061 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1062 ["pvcreate"; "/dev/sda1"];
1063 ["pvcreate"; "/dev/sda2"];
1064 ["pvcreate"; "/dev/sda3"];
1065 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1066 "list the LVM physical volumes (PVs)",
1068 List all the physical volumes detected. This is the equivalent
1069 of the L<pvs(8)> command.
1071 This returns a list of just the device names that contain
1072 PVs (eg. C</dev/sda2>).
1074 See also C<guestfs_pvs_full>.");
1076 ("vgs", (RStringList "volgroups", []), 10, [Optional "lvm2"],
1077 [InitBasicFSonLVM, Always, TestOutputList (
1079 InitEmpty, Always, TestOutputList (
1080 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1081 ["pvcreate"; "/dev/sda1"];
1082 ["pvcreate"; "/dev/sda2"];
1083 ["pvcreate"; "/dev/sda3"];
1084 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1085 ["vgcreate"; "VG2"; "/dev/sda3"];
1086 ["vgs"]], ["VG1"; "VG2"])],
1087 "list the LVM volume groups (VGs)",
1089 List all the volumes groups detected. This is the equivalent
1090 of the L<vgs(8)> command.
1092 This returns a list of just the volume group names that were
1093 detected (eg. C<VolGroup00>).
1095 See also C<guestfs_vgs_full>.");
1097 ("lvs", (RStringList "logvols", []), 11, [Optional "lvm2"],
1098 [InitBasicFSonLVM, Always, TestOutputList (
1099 [["lvs"]], ["/dev/VG/LV"]);
1100 InitEmpty, Always, TestOutputList (
1101 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1102 ["pvcreate"; "/dev/sda1"];
1103 ["pvcreate"; "/dev/sda2"];
1104 ["pvcreate"; "/dev/sda3"];
1105 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1106 ["vgcreate"; "VG2"; "/dev/sda3"];
1107 ["lvcreate"; "LV1"; "VG1"; "50"];
1108 ["lvcreate"; "LV2"; "VG1"; "50"];
1109 ["lvcreate"; "LV3"; "VG2"; "50"];
1110 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1111 "list the LVM logical volumes (LVs)",
1113 List all the logical volumes detected. This is the equivalent
1114 of the L<lvs(8)> command.
1116 This returns a list of the logical volume device names
1117 (eg. C</dev/VolGroup00/LogVol00>).
1119 See also C<guestfs_lvs_full>.");
1121 ("pvs_full", (RStructList ("physvols", "lvm_pv"), []), 12, [Optional "lvm2"],
1122 [], (* XXX how to test? *)
1123 "list the LVM physical volumes (PVs)",
1125 List all the physical volumes detected. This is the equivalent
1126 of the L<pvs(8)> command. The \"full\" version includes all fields.");
1128 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), []), 13, [Optional "lvm2"],
1129 [], (* XXX how to test? *)
1130 "list the LVM volume groups (VGs)",
1132 List all the volumes groups detected. This is the equivalent
1133 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1135 ("lvs_full", (RStructList ("logvols", "lvm_lv"), []), 14, [Optional "lvm2"],
1136 [], (* XXX how to test? *)
1137 "list the LVM logical volumes (LVs)",
1139 List all the logical volumes detected. This is the equivalent
1140 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1142 ("read_lines", (RStringList "lines", [Pathname "path"]), 15, [],
1143 [InitISOFS, Always, TestOutputList (
1144 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1145 InitISOFS, Always, TestOutputList (
1146 [["read_lines"; "/empty"]], [])],
1147 "read file as lines",
1149 Return the contents of the file named C<path>.
1151 The file contents are returned as a list of lines. Trailing
1152 C<LF> and C<CRLF> character sequences are I<not> returned.
1154 Note that this function cannot correctly handle binary files
1155 (specifically, files containing C<\\0> character which is treated
1156 as end of line). For those you need to use the C<guestfs_read_file>
1157 function which has a more complex interface.");
1159 ("aug_init", (RErr, [Pathname "root"; Int "flags"]), 16, [Optional "augeas"],
1160 [], (* XXX Augeas code needs tests. *)
1161 "create a new Augeas handle",
1163 Create a new Augeas handle for editing configuration files.
1164 If there was any previous Augeas handle associated with this
1165 guestfs session, then it is closed.
1167 You must call this before using any other C<guestfs_aug_*>
1170 C<root> is the filesystem root. C<root> must not be NULL,
1173 The flags are the same as the flags defined in
1174 E<lt>augeas.hE<gt>, the logical I<or> of the following
1179 =item C<AUG_SAVE_BACKUP> = 1
1181 Keep the original file with a C<.augsave> extension.
1183 =item C<AUG_SAVE_NEWFILE> = 2
1185 Save changes into a file with extension C<.augnew>, and
1186 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1188 =item C<AUG_TYPE_CHECK> = 4
1190 Typecheck lenses (can be expensive).
1192 =item C<AUG_NO_STDINC> = 8
1194 Do not use standard load path for modules.
1196 =item C<AUG_SAVE_NOOP> = 16
1198 Make save a no-op, just record what would have been changed.
1200 =item C<AUG_NO_LOAD> = 32
1202 Do not load the tree in C<guestfs_aug_init>.
1206 To close the handle, you can call C<guestfs_aug_close>.
1208 To find out more about Augeas, see L<http://augeas.net/>.");
1210 ("aug_close", (RErr, []), 26, [Optional "augeas"],
1211 [], (* XXX Augeas code needs tests. *)
1212 "close the current Augeas handle",
1214 Close the current Augeas handle and free up any resources
1215 used by it. After calling this, you have to call
1216 C<guestfs_aug_init> again before you can use any other
1217 Augeas functions.");
1219 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"]), 17, [Optional "augeas"],
1220 [], (* XXX Augeas code needs tests. *)
1221 "define an Augeas variable",
1223 Defines an Augeas variable C<name> whose value is the result
1224 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1227 On success this returns the number of nodes in C<expr>, or
1228 C<0> if C<expr> evaluates to something which is not a nodeset.");
1230 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"]), 18, [Optional "augeas"],
1231 [], (* XXX Augeas code needs tests. *)
1232 "define an Augeas node",
1234 Defines a variable C<name> whose value is the result of
1237 If C<expr> evaluates to an empty nodeset, a node is created,
1238 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1239 C<name> will be the nodeset containing that single node.
1241 On success this returns a pair containing the
1242 number of nodes in the nodeset, and a boolean flag
1243 if a node was created.");
1245 ("aug_get", (RString "val", [String "augpath"]), 19, [Optional "augeas"],
1246 [], (* XXX Augeas code needs tests. *)
1247 "look up the value of an Augeas path",
1249 Look up the value associated with C<path>. If C<path>
1250 matches exactly one node, the C<value> is returned.");
1252 ("aug_set", (RErr, [String "augpath"; String "val"]), 20, [Optional "augeas"],
1253 [], (* XXX Augeas code needs tests. *)
1254 "set Augeas path to value",
1256 Set the value associated with C<path> to C<val>.
1258 In the Augeas API, it is possible to clear a node by setting
1259 the value to NULL. Due to an oversight in the libguestfs API
1260 you cannot do that with this call. Instead you must use the
1261 C<guestfs_aug_clear> call.");
1263 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"]), 21, [Optional "augeas"],
1264 [], (* XXX Augeas code needs tests. *)
1265 "insert a sibling Augeas node",
1267 Create a new sibling C<label> for C<path>, inserting it into
1268 the tree before or after C<path> (depending on the boolean
1271 C<path> must match exactly one existing node in the tree, and
1272 C<label> must be a label, ie. not contain C</>, C<*> or end
1273 with a bracketed index C<[N]>.");
1275 ("aug_rm", (RInt "nrnodes", [String "augpath"]), 22, [Optional "augeas"],
1276 [], (* XXX Augeas code needs tests. *)
1277 "remove an Augeas path",
1279 Remove C<path> and all of its children.
1281 On success this returns the number of entries which were removed.");
1283 ("aug_mv", (RErr, [String "src"; String "dest"]), 23, [Optional "augeas"],
1284 [], (* XXX Augeas code needs tests. *)
1287 Move the node C<src> to C<dest>. C<src> must match exactly
1288 one node. C<dest> is overwritten if it exists.");
1290 ("aug_match", (RStringList "matches", [String "augpath"]), 24, [Optional "augeas"],
1291 [], (* XXX Augeas code needs tests. *)
1292 "return Augeas nodes which match augpath",
1294 Returns a list of paths which match the path expression C<path>.
1295 The returned paths are sufficiently qualified so that they match
1296 exactly one node in the current tree.");
1298 ("aug_save", (RErr, []), 25, [Optional "augeas"],
1299 [], (* XXX Augeas code needs tests. *)
1300 "write all pending Augeas changes to disk",
1302 This writes all pending changes to disk.
1304 The flags which were passed to C<guestfs_aug_init> affect exactly
1305 how files are saved.");
1307 ("aug_load", (RErr, []), 27, [Optional "augeas"],
1308 [], (* XXX Augeas code needs tests. *)
1309 "load files into the tree",
1311 Load files into the tree.
1313 See C<aug_load> in the Augeas documentation for the full gory
1316 ("aug_ls", (RStringList "matches", [String "augpath"]), 28, [Optional "augeas"],
1317 [], (* XXX Augeas code needs tests. *)
1318 "list Augeas nodes under augpath",
1320 This is just a shortcut for listing C<guestfs_aug_match>
1321 C<path/*> and sorting the resulting nodes into alphabetical order.");
1323 ("rm", (RErr, [Pathname "path"]), 29, [],
1324 [InitBasicFS, Always, TestRun
1327 InitBasicFS, Always, TestLastFail
1329 InitBasicFS, Always, TestLastFail
1334 Remove the single file C<path>.");
1336 ("rmdir", (RErr, [Pathname "path"]), 30, [],
1337 [InitBasicFS, Always, TestRun
1340 InitBasicFS, Always, TestLastFail
1341 [["rmdir"; "/new"]];
1342 InitBasicFS, Always, TestLastFail
1344 ["rmdir"; "/new"]]],
1345 "remove a directory",
1347 Remove the single directory C<path>.");
1349 ("rm_rf", (RErr, [Pathname "path"]), 31, [],
1350 [InitBasicFS, Always, TestOutputFalse
1352 ["mkdir"; "/new/foo"];
1353 ["touch"; "/new/foo/bar"];
1355 ["exists"; "/new"]]],
1356 "remove a file or directory recursively",
1358 Remove the file or directory C<path>, recursively removing the
1359 contents if its a directory. This is like the C<rm -rf> shell
1362 ("mkdir", (RErr, [Pathname "path"]), 32, [],
1363 [InitBasicFS, Always, TestOutputTrue
1365 ["is_dir"; "/new"]];
1366 InitBasicFS, Always, TestLastFail
1367 [["mkdir"; "/new/foo/bar"]]],
1368 "create a directory",
1370 Create a directory named C<path>.");
1372 ("mkdir_p", (RErr, [Pathname "path"]), 33, [],
1373 [InitBasicFS, Always, TestOutputTrue
1374 [["mkdir_p"; "/new/foo/bar"];
1375 ["is_dir"; "/new/foo/bar"]];
1376 InitBasicFS, Always, TestOutputTrue
1377 [["mkdir_p"; "/new/foo/bar"];
1378 ["is_dir"; "/new/foo"]];
1379 InitBasicFS, Always, TestOutputTrue
1380 [["mkdir_p"; "/new/foo/bar"];
1381 ["is_dir"; "/new"]];
1382 (* Regression tests for RHBZ#503133: *)
1383 InitBasicFS, Always, TestRun
1385 ["mkdir_p"; "/new"]];
1386 InitBasicFS, Always, TestLastFail
1388 ["mkdir_p"; "/new"]]],
1389 "create a directory and parents",
1391 Create a directory named C<path>, creating any parent directories
1392 as necessary. This is like the C<mkdir -p> shell command.");
1394 ("chmod", (RErr, [Int "mode"; Pathname "path"]), 34, [],
1395 [], (* XXX Need stat command to test *)
1398 Change the mode (permissions) of C<path> to C<mode>. Only
1399 numeric modes are supported.
1401 I<Note>: When using this command from guestfish, C<mode>
1402 by default would be decimal, unless you prefix it with
1403 C<0> to get octal, ie. use C<0700> not C<700>.
1405 The mode actually set is affected by the umask.");
1407 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"]), 35, [],
1408 [], (* XXX Need stat command to test *)
1409 "change file owner and group",
1411 Change the file owner to C<owner> and group to C<group>.
1413 Only numeric uid and gid are supported. If you want to use
1414 names, you will need to locate and parse the password file
1415 yourself (Augeas support makes this relatively easy).");
1417 ("exists", (RBool "existsflag", [Pathname "path"]), 36, [],
1418 [InitISOFS, Always, TestOutputTrue (
1419 [["exists"; "/empty"]]);
1420 InitISOFS, Always, TestOutputTrue (
1421 [["exists"; "/directory"]])],
1422 "test if file or directory exists",
1424 This returns C<true> if and only if there is a file, directory
1425 (or anything) with the given C<path> name.
1427 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1429 ("is_file", (RBool "fileflag", [Pathname "path"]), 37, [],
1430 [InitISOFS, Always, TestOutputTrue (
1431 [["is_file"; "/known-1"]]);
1432 InitISOFS, Always, TestOutputFalse (
1433 [["is_file"; "/directory"]])],
1434 "test if file exists",
1436 This returns C<true> if and only if there is a file
1437 with the given C<path> name. Note that it returns false for
1438 other objects like directories.
1440 See also C<guestfs_stat>.");
1442 ("is_dir", (RBool "dirflag", [Pathname "path"]), 38, [],
1443 [InitISOFS, Always, TestOutputFalse (
1444 [["is_dir"; "/known-3"]]);
1445 InitISOFS, Always, TestOutputTrue (
1446 [["is_dir"; "/directory"]])],
1447 "test if file exists",
1449 This returns C<true> if and only if there is a directory
1450 with the given C<path> name. Note that it returns false for
1451 other objects like files.
1453 See also C<guestfs_stat>.");
1455 ("pvcreate", (RErr, [Device "device"]), 39, [Optional "lvm2"],
1456 [InitEmpty, Always, TestOutputListOfDevices (
1457 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1458 ["pvcreate"; "/dev/sda1"];
1459 ["pvcreate"; "/dev/sda2"];
1460 ["pvcreate"; "/dev/sda3"];
1461 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1462 "create an LVM physical volume",
1464 This creates an LVM physical volume on the named C<device>,
1465 where C<device> should usually be a partition name such
1468 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"]), 40, [Optional "lvm2"],
1469 [InitEmpty, Always, TestOutputList (
1470 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1471 ["pvcreate"; "/dev/sda1"];
1472 ["pvcreate"; "/dev/sda2"];
1473 ["pvcreate"; "/dev/sda3"];
1474 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1475 ["vgcreate"; "VG2"; "/dev/sda3"];
1476 ["vgs"]], ["VG1"; "VG2"])],
1477 "create an LVM volume group",
1479 This creates an LVM volume group called C<volgroup>
1480 from the non-empty list of physical volumes C<physvols>.");
1482 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"]), 41, [Optional "lvm2"],
1483 [InitEmpty, Always, TestOutputList (
1484 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1485 ["pvcreate"; "/dev/sda1"];
1486 ["pvcreate"; "/dev/sda2"];
1487 ["pvcreate"; "/dev/sda3"];
1488 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1489 ["vgcreate"; "VG2"; "/dev/sda3"];
1490 ["lvcreate"; "LV1"; "VG1"; "50"];
1491 ["lvcreate"; "LV2"; "VG1"; "50"];
1492 ["lvcreate"; "LV3"; "VG2"; "50"];
1493 ["lvcreate"; "LV4"; "VG2"; "50"];
1494 ["lvcreate"; "LV5"; "VG2"; "50"];
1496 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1497 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1498 "create an LVM logical volume",
1500 This creates an LVM logical volume called C<logvol>
1501 on the volume group C<volgroup>, with C<size> megabytes.");
1503 ("mkfs", (RErr, [String "fstype"; Device "device"]), 42, [],
1504 [InitEmpty, Always, TestOutput (
1505 [["part_disk"; "/dev/sda"; "mbr"];
1506 ["mkfs"; "ext2"; "/dev/sda1"];
1507 ["mount_options"; ""; "/dev/sda1"; "/"];
1508 ["write"; "/new"; "new file contents"];
1509 ["cat"; "/new"]], "new file contents")],
1510 "make a filesystem",
1512 This creates a filesystem on C<device> (usually a partition
1513 or LVM logical volume). The filesystem type is C<fstype>, for
1516 ("sfdisk", (RErr, [Device "device";
1517 Int "cyls"; Int "heads"; Int "sectors";
1518 StringList "lines"]), 43, [DangerWillRobinson],
1520 "create partitions on a block device",
1522 This is a direct interface to the L<sfdisk(8)> program for creating
1523 partitions on block devices.
1525 C<device> should be a block device, for example C</dev/sda>.
1527 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1528 and sectors on the device, which are passed directly to sfdisk as
1529 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1530 of these, then the corresponding parameter is omitted. Usually for
1531 'large' disks, you can just pass C<0> for these, but for small
1532 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1533 out the right geometry and you will need to tell it.
1535 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1536 information refer to the L<sfdisk(8)> manpage.
1538 To create a single partition occupying the whole disk, you would
1539 pass C<lines> as a single element list, when the single element being
1540 the string C<,> (comma).
1542 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
1543 C<guestfs_part_init>");
1545 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"]), 44, [ProtocolLimitWarning; DeprecatedBy "write"],
1546 (* Regression test for RHBZ#597135. *)
1547 [InitBasicFS, Always, TestLastFail
1548 [["write_file"; "/new"; "abc"; "10000"]]],
1551 This call creates a file called C<path>. The contents of the
1552 file is the string C<content> (which can contain any 8 bit data),
1553 with length C<size>.
1555 As a special case, if C<size> is C<0>
1556 then the length is calculated using C<strlen> (so in this case
1557 the content cannot contain embedded ASCII NULs).
1559 I<NB.> Owing to a bug, writing content containing ASCII NUL
1560 characters does I<not> work, even if the length is specified.");
1562 ("umount", (RErr, [String "pathordevice"]), 45, [FishAlias "unmount"],
1563 [InitEmpty, Always, TestOutputListOfDevices (
1564 [["part_disk"; "/dev/sda"; "mbr"];
1565 ["mkfs"; "ext2"; "/dev/sda1"];
1566 ["mount_options"; ""; "/dev/sda1"; "/"];
1567 ["mounts"]], ["/dev/sda1"]);
1568 InitEmpty, Always, TestOutputList (
1569 [["part_disk"; "/dev/sda"; "mbr"];
1570 ["mkfs"; "ext2"; "/dev/sda1"];
1571 ["mount_options"; ""; "/dev/sda1"; "/"];
1574 "unmount a filesystem",
1576 This unmounts the given filesystem. The filesystem may be
1577 specified either by its mountpoint (path) or the device which
1578 contains the filesystem.");
1580 ("mounts", (RStringList "devices", []), 46, [],
1581 [InitBasicFS, Always, TestOutputListOfDevices (
1582 [["mounts"]], ["/dev/sda1"])],
1583 "show mounted filesystems",
1585 This returns the list of currently mounted filesystems. It returns
1586 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1588 Some internal mounts are not shown.
1590 See also: C<guestfs_mountpoints>");
1592 ("umount_all", (RErr, []), 47, [FishAlias "unmount-all"],
1593 [InitBasicFS, Always, TestOutputList (
1596 (* check that umount_all can unmount nested mounts correctly: *)
1597 InitEmpty, Always, TestOutputList (
1598 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1599 ["mkfs"; "ext2"; "/dev/sda1"];
1600 ["mkfs"; "ext2"; "/dev/sda2"];
1601 ["mkfs"; "ext2"; "/dev/sda3"];
1602 ["mount_options"; ""; "/dev/sda1"; "/"];
1604 ["mount_options"; ""; "/dev/sda2"; "/mp1"];
1605 ["mkdir"; "/mp1/mp2"];
1606 ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
1607 ["mkdir"; "/mp1/mp2/mp3"];
1610 "unmount all filesystems",
1612 This unmounts all mounted filesystems.
1614 Some internal mounts are not unmounted by this call.");
1616 ("lvm_remove_all", (RErr, []), 48, [DangerWillRobinson; Optional "lvm2"],
1618 "remove all LVM LVs, VGs and PVs",
1620 This command removes all LVM logical volumes, volume groups
1621 and physical volumes.");
1623 ("file", (RString "description", [Dev_or_Path "path"]), 49, [],
1624 [InitISOFS, Always, TestOutput (
1625 [["file"; "/empty"]], "empty");
1626 InitISOFS, Always, TestOutput (
1627 [["file"; "/known-1"]], "ASCII text");
1628 InitISOFS, Always, TestLastFail (
1629 [["file"; "/notexists"]])],
1630 "determine file type",
1632 This call uses the standard L<file(1)> command to determine
1633 the type or contents of the file. This also works on devices,
1634 for example to find out whether a partition contains a filesystem.
1636 This call will also transparently look inside various types
1639 The exact command which runs is C<file -zbsL path>. Note in
1640 particular that the filename is not prepended to the output
1641 (the C<-b> option).");
1643 ("command", (RString "output", [StringList "arguments"]), 50, [ProtocolLimitWarning],
1644 [InitBasicFS, Always, TestOutput (
1645 [["upload"; "test-command"; "/test-command"];
1646 ["chmod"; "0o755"; "/test-command"];
1647 ["command"; "/test-command 1"]], "Result1");
1648 InitBasicFS, Always, TestOutput (
1649 [["upload"; "test-command"; "/test-command"];
1650 ["chmod"; "0o755"; "/test-command"];
1651 ["command"; "/test-command 2"]], "Result2\n");
1652 InitBasicFS, Always, TestOutput (
1653 [["upload"; "test-command"; "/test-command"];
1654 ["chmod"; "0o755"; "/test-command"];
1655 ["command"; "/test-command 3"]], "\nResult3");
1656 InitBasicFS, Always, TestOutput (
1657 [["upload"; "test-command"; "/test-command"];
1658 ["chmod"; "0o755"; "/test-command"];
1659 ["command"; "/test-command 4"]], "\nResult4\n");
1660 InitBasicFS, Always, TestOutput (
1661 [["upload"; "test-command"; "/test-command"];
1662 ["chmod"; "0o755"; "/test-command"];
1663 ["command"; "/test-command 5"]], "\nResult5\n\n");
1664 InitBasicFS, Always, TestOutput (
1665 [["upload"; "test-command"; "/test-command"];
1666 ["chmod"; "0o755"; "/test-command"];
1667 ["command"; "/test-command 6"]], "\n\nResult6\n\n");
1668 InitBasicFS, Always, TestOutput (
1669 [["upload"; "test-command"; "/test-command"];
1670 ["chmod"; "0o755"; "/test-command"];
1671 ["command"; "/test-command 7"]], "");
1672 InitBasicFS, Always, TestOutput (
1673 [["upload"; "test-command"; "/test-command"];
1674 ["chmod"; "0o755"; "/test-command"];
1675 ["command"; "/test-command 8"]], "\n");
1676 InitBasicFS, Always, TestOutput (
1677 [["upload"; "test-command"; "/test-command"];
1678 ["chmod"; "0o755"; "/test-command"];
1679 ["command"; "/test-command 9"]], "\n\n");
1680 InitBasicFS, Always, TestOutput (
1681 [["upload"; "test-command"; "/test-command"];
1682 ["chmod"; "0o755"; "/test-command"];
1683 ["command"; "/test-command 10"]], "Result10-1\nResult10-2\n");
1684 InitBasicFS, Always, TestOutput (
1685 [["upload"; "test-command"; "/test-command"];
1686 ["chmod"; "0o755"; "/test-command"];
1687 ["command"; "/test-command 11"]], "Result11-1\nResult11-2");
1688 InitBasicFS, Always, TestLastFail (
1689 [["upload"; "test-command"; "/test-command"];
1690 ["chmod"; "0o755"; "/test-command"];
1691 ["command"; "/test-command"]])],
1692 "run a command from the guest filesystem",
1694 This call runs a command from the guest filesystem. The
1695 filesystem must be mounted, and must contain a compatible
1696 operating system (ie. something Linux, with the same
1697 or compatible processor architecture).
1699 The single parameter is an argv-style list of arguments.
1700 The first element is the name of the program to run.
1701 Subsequent elements are parameters. The list must be
1702 non-empty (ie. must contain a program name). Note that
1703 the command runs directly, and is I<not> invoked via
1704 the shell (see C<guestfs_sh>).
1706 The return value is anything printed to I<stdout> by
1709 If the command returns a non-zero exit status, then
1710 this function returns an error message. The error message
1711 string is the content of I<stderr> from the command.
1713 The C<$PATH> environment variable will contain at least
1714 C</usr/bin> and C</bin>. If you require a program from
1715 another location, you should provide the full path in the
1718 Shared libraries and data files required by the program
1719 must be available on filesystems which are mounted in the
1720 correct places. It is the caller's responsibility to ensure
1721 all filesystems that are needed are mounted at the right
1724 ("command_lines", (RStringList "lines", [StringList "arguments"]), 51, [ProtocolLimitWarning],
1725 [InitBasicFS, Always, TestOutputList (
1726 [["upload"; "test-command"; "/test-command"];
1727 ["chmod"; "0o755"; "/test-command"];
1728 ["command_lines"; "/test-command 1"]], ["Result1"]);
1729 InitBasicFS, Always, TestOutputList (
1730 [["upload"; "test-command"; "/test-command"];
1731 ["chmod"; "0o755"; "/test-command"];
1732 ["command_lines"; "/test-command 2"]], ["Result2"]);
1733 InitBasicFS, Always, TestOutputList (
1734 [["upload"; "test-command"; "/test-command"];
1735 ["chmod"; "0o755"; "/test-command"];
1736 ["command_lines"; "/test-command 3"]], ["";"Result3"]);
1737 InitBasicFS, Always, TestOutputList (
1738 [["upload"; "test-command"; "/test-command"];
1739 ["chmod"; "0o755"; "/test-command"];
1740 ["command_lines"; "/test-command 4"]], ["";"Result4"]);
1741 InitBasicFS, Always, TestOutputList (
1742 [["upload"; "test-command"; "/test-command"];
1743 ["chmod"; "0o755"; "/test-command"];
1744 ["command_lines"; "/test-command 5"]], ["";"Result5";""]);
1745 InitBasicFS, Always, TestOutputList (
1746 [["upload"; "test-command"; "/test-command"];
1747 ["chmod"; "0o755"; "/test-command"];
1748 ["command_lines"; "/test-command 6"]], ["";"";"Result6";""]);
1749 InitBasicFS, Always, TestOutputList (
1750 [["upload"; "test-command"; "/test-command"];
1751 ["chmod"; "0o755"; "/test-command"];
1752 ["command_lines"; "/test-command 7"]], []);
1753 InitBasicFS, Always, TestOutputList (
1754 [["upload"; "test-command"; "/test-command"];
1755 ["chmod"; "0o755"; "/test-command"];
1756 ["command_lines"; "/test-command 8"]], [""]);
1757 InitBasicFS, Always, TestOutputList (
1758 [["upload"; "test-command"; "/test-command"];
1759 ["chmod"; "0o755"; "/test-command"];
1760 ["command_lines"; "/test-command 9"]], ["";""]);
1761 InitBasicFS, Always, TestOutputList (
1762 [["upload"; "test-command"; "/test-command"];
1763 ["chmod"; "0o755"; "/test-command"];
1764 ["command_lines"; "/test-command 10"]], ["Result10-1";"Result10-2"]);
1765 InitBasicFS, Always, TestOutputList (
1766 [["upload"; "test-command"; "/test-command"];
1767 ["chmod"; "0o755"; "/test-command"];
1768 ["command_lines"; "/test-command 11"]], ["Result11-1";"Result11-2"])],
1769 "run a command, returning lines",
1771 This is the same as C<guestfs_command>, but splits the
1772 result into a list of lines.
1774 See also: C<guestfs_sh_lines>");
1776 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"]), 52, [],
1777 [InitISOFS, Always, TestOutputStruct (
1778 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
1779 "get file information",
1781 Returns file information for the given C<path>.
1783 This is the same as the C<stat(2)> system call.");
1785 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"]), 53, [],
1786 [InitISOFS, Always, TestOutputStruct (
1787 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
1788 "get file information for a symbolic link",
1790 Returns file information for the given C<path>.
1792 This is the same as C<guestfs_stat> except that if C<path>
1793 is a symbolic link, then the link is stat-ed, not the file it
1796 This is the same as the C<lstat(2)> system call.");
1798 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"]), 54, [],
1799 [InitISOFS, Always, TestOutputStruct (
1800 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
1801 "get file system statistics",
1803 Returns file system statistics for any mounted file system.
1804 C<path> should be a file or directory in the mounted file system
1805 (typically it is the mount point itself, but it doesn't need to be).
1807 This is the same as the C<statvfs(2)> system call.");
1809 ("tune2fs_l", (RHashtable "superblock", [Device "device"]), 55, [],
1811 "get ext2/ext3/ext4 superblock details",
1813 This returns the contents of the ext2, ext3 or ext4 filesystem
1814 superblock on C<device>.
1816 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1817 manpage for more details. The list of fields returned isn't
1818 clearly defined, and depends on both the version of C<tune2fs>
1819 that libguestfs was built against, and the filesystem itself.");
1821 ("blockdev_setro", (RErr, [Device "device"]), 56, [],
1822 [InitEmpty, Always, TestOutputTrue (
1823 [["blockdev_setro"; "/dev/sda"];
1824 ["blockdev_getro"; "/dev/sda"]])],
1825 "set block device to read-only",
1827 Sets the block device named C<device> to read-only.
1829 This uses the L<blockdev(8)> command.");
1831 ("blockdev_setrw", (RErr, [Device "device"]), 57, [],
1832 [InitEmpty, Always, TestOutputFalse (
1833 [["blockdev_setrw"; "/dev/sda"];
1834 ["blockdev_getro"; "/dev/sda"]])],
1835 "set block device to read-write",
1837 Sets the block device named C<device> to read-write.
1839 This uses the L<blockdev(8)> command.");
1841 ("blockdev_getro", (RBool "ro", [Device "device"]), 58, [],
1842 [InitEmpty, Always, TestOutputTrue (
1843 [["blockdev_setro"; "/dev/sda"];
1844 ["blockdev_getro"; "/dev/sda"]])],
1845 "is block device set to read-only",
1847 Returns a boolean indicating if the block device is read-only
1848 (true if read-only, false if not).
1850 This uses the L<blockdev(8)> command.");
1852 ("blockdev_getss", (RInt "sectorsize", [Device "device"]), 59, [],
1853 [InitEmpty, Always, TestOutputInt (
1854 [["blockdev_getss"; "/dev/sda"]], 512)],
1855 "get sectorsize of block device",
1857 This returns the size of sectors on a block device.
1858 Usually 512, but can be larger for modern devices.
1860 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
1863 This uses the L<blockdev(8)> command.");
1865 ("blockdev_getbsz", (RInt "blocksize", [Device "device"]), 60, [],
1866 [InitEmpty, Always, TestOutputInt (
1867 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
1868 "get blocksize of block device",
1870 This returns the block size of a device.
1872 (Note this is different from both I<size in blocks> and
1873 I<filesystem block size>).
1875 This uses the L<blockdev(8)> command.");
1877 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"]), 61, [],
1879 "set blocksize of block device",
1881 This sets the block size of a device.
1883 (Note this is different from both I<size in blocks> and
1884 I<filesystem block size>).
1886 This uses the L<blockdev(8)> command.");
1888 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"]), 62, [],
1889 [InitEmpty, Always, TestOutputInt (
1890 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
1891 "get total size of device in 512-byte sectors",
1893 This returns the size of the device in units of 512-byte sectors
1894 (even if the sectorsize isn't 512 bytes ... weird).
1896 See also C<guestfs_blockdev_getss> for the real sector size of
1897 the device, and C<guestfs_blockdev_getsize64> for the more
1898 useful I<size in bytes>.
1900 This uses the L<blockdev(8)> command.");
1902 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"]), 63, [],
1903 [InitEmpty, Always, TestOutputInt (
1904 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
1905 "get total size of device in bytes",
1907 This returns the size of the device in bytes.
1909 See also C<guestfs_blockdev_getsz>.
1911 This uses the L<blockdev(8)> command.");
1913 ("blockdev_flushbufs", (RErr, [Device "device"]), 64, [],
1914 [InitEmpty, Always, TestRun
1915 [["blockdev_flushbufs"; "/dev/sda"]]],
1916 "flush device buffers",
1918 This tells the kernel to flush internal buffers associated
1921 This uses the L<blockdev(8)> command.");
1923 ("blockdev_rereadpt", (RErr, [Device "device"]), 65, [],
1924 [InitEmpty, Always, TestRun
1925 [["blockdev_rereadpt"; "/dev/sda"]]],
1926 "reread partition table",
1928 Reread the partition table on C<device>.
1930 This uses the L<blockdev(8)> command.");
1932 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"]), 66, [],
1933 [InitBasicFS, Always, TestOutput (
1934 (* Pick a file from cwd which isn't likely to change. *)
1935 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1936 ["checksum"; "md5"; "/COPYING.LIB"]],
1937 Digest.to_hex (Digest.file "COPYING.LIB"))],
1938 "upload a file from the local machine",
1940 Upload local file C<filename> to C<remotefilename> on the
1943 C<filename> can also be a named pipe.
1945 See also C<guestfs_download>.");
1947 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"]), 67, [],
1948 [InitBasicFS, Always, TestOutput (
1949 (* Pick a file from cwd which isn't likely to change. *)
1950 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1951 ["download"; "/COPYING.LIB"; "testdownload.tmp"];
1952 ["upload"; "testdownload.tmp"; "/upload"];
1953 ["checksum"; "md5"; "/upload"]],
1954 Digest.to_hex (Digest.file "COPYING.LIB"))],
1955 "download a file to the local machine",
1957 Download file C<remotefilename> and save it as C<filename>
1958 on the local machine.
1960 C<filename> can also be a named pipe.
1962 See also C<guestfs_upload>, C<guestfs_cat>.");
1964 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"]), 68, [],
1965 [InitISOFS, Always, TestOutput (
1966 [["checksum"; "crc"; "/known-3"]], "2891671662");
1967 InitISOFS, Always, TestLastFail (
1968 [["checksum"; "crc"; "/notexists"]]);
1969 InitISOFS, Always, TestOutput (
1970 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
1971 InitISOFS, Always, TestOutput (
1972 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
1973 InitISOFS, Always, TestOutput (
1974 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
1975 InitISOFS, Always, TestOutput (
1976 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
1977 InitISOFS, Always, TestOutput (
1978 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
1979 InitISOFS, Always, TestOutput (
1980 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
1981 (* Test for RHBZ#579608, absolute symbolic links. *)
1982 InitISOFS, Always, TestOutput (
1983 [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
1984 "compute MD5, SHAx or CRC checksum of file",
1986 This call computes the MD5, SHAx or CRC checksum of the
1989 The type of checksum to compute is given by the C<csumtype>
1990 parameter which must have one of the following values:
1996 Compute the cyclic redundancy check (CRC) specified by POSIX
1997 for the C<cksum> command.
2001 Compute the MD5 hash (using the C<md5sum> program).
2005 Compute the SHA1 hash (using the C<sha1sum> program).
2009 Compute the SHA224 hash (using the C<sha224sum> program).
2013 Compute the SHA256 hash (using the C<sha256sum> program).
2017 Compute the SHA384 hash (using the C<sha384sum> program).
2021 Compute the SHA512 hash (using the C<sha512sum> program).
2025 The checksum is returned as a printable string.
2027 To get the checksum for a device, use C<guestfs_checksum_device>.
2029 To get the checksums for many files, use C<guestfs_checksums_out>.");
2031 ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"]), 69, [],
2032 [InitBasicFS, Always, TestOutput (
2033 [["tar_in"; "../images/helloworld.tar"; "/"];
2034 ["cat"; "/hello"]], "hello\n")],
2035 "unpack tarfile to directory",
2037 This command uploads and unpacks local file C<tarfile> (an
2038 I<uncompressed> tar file) into C<directory>.
2040 To upload a compressed tarball, use C<guestfs_tgz_in>
2041 or C<guestfs_txz_in>.");
2043 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"]), 70, [],
2045 "pack directory into tarfile",
2047 This command packs the contents of C<directory> and downloads
2048 it to local file C<tarfile>.
2050 To download a compressed tarball, use C<guestfs_tgz_out>
2051 or C<guestfs_txz_out>.");
2053 ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"]), 71, [],
2054 [InitBasicFS, Always, TestOutput (
2055 [["tgz_in"; "../images/helloworld.tar.gz"; "/"];
2056 ["cat"; "/hello"]], "hello\n")],
2057 "unpack compressed tarball to directory",
2059 This command uploads and unpacks local file C<tarball> (a
2060 I<gzip compressed> tar file) into C<directory>.
2062 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2064 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"]), 72, [],
2066 "pack directory into compressed tarball",
2068 This command packs the contents of C<directory> and downloads
2069 it to local file C<tarball>.
2071 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2073 ("mount_ro", (RErr, [Device "device"; String "mountpoint"]), 73, [],
2074 [InitBasicFS, Always, TestLastFail (
2076 ["mount_ro"; "/dev/sda1"; "/"];
2077 ["touch"; "/new"]]);
2078 InitBasicFS, Always, TestOutput (
2079 [["write"; "/new"; "data"];
2081 ["mount_ro"; "/dev/sda1"; "/"];
2082 ["cat"; "/new"]], "data")],
2083 "mount a guest disk, read-only",
2085 This is the same as the C<guestfs_mount> command, but it
2086 mounts the filesystem with the read-only (I<-o ro>) flag.");
2088 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"]), 74, [],
2090 "mount a guest disk with mount options",
2092 This is the same as the C<guestfs_mount> command, but it
2093 allows you to set the mount options as for the
2094 L<mount(8)> I<-o> flag.
2096 If the C<options> parameter is an empty string, then
2097 no options are passed (all options default to whatever
2098 the filesystem uses).");
2100 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"]), 75, [],
2102 "mount a guest disk with mount options and vfstype",
2104 This is the same as the C<guestfs_mount> command, but it
2105 allows you to set both the mount options and the vfstype
2106 as for the L<mount(8)> I<-o> and I<-t> flags.");
2108 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"]), 76, [],
2110 "debugging and internals",
2112 The C<guestfs_debug> command exposes some internals of
2113 C<guestfsd> (the guestfs daemon) that runs inside the
2116 There is no comprehensive help for this command. You have
2117 to look at the file C<daemon/debug.c> in the libguestfs source
2118 to find out what you can do.");
2120 ("lvremove", (RErr, [Device "device"]), 77, [Optional "lvm2"],
2121 [InitEmpty, Always, TestOutputList (
2122 [["part_disk"; "/dev/sda"; "mbr"];
2123 ["pvcreate"; "/dev/sda1"];
2124 ["vgcreate"; "VG"; "/dev/sda1"];
2125 ["lvcreate"; "LV1"; "VG"; "50"];
2126 ["lvcreate"; "LV2"; "VG"; "50"];
2127 ["lvremove"; "/dev/VG/LV1"];
2128 ["lvs"]], ["/dev/VG/LV2"]);
2129 InitEmpty, Always, TestOutputList (
2130 [["part_disk"; "/dev/sda"; "mbr"];
2131 ["pvcreate"; "/dev/sda1"];
2132 ["vgcreate"; "VG"; "/dev/sda1"];
2133 ["lvcreate"; "LV1"; "VG"; "50"];
2134 ["lvcreate"; "LV2"; "VG"; "50"];
2135 ["lvremove"; "/dev/VG"];
2137 InitEmpty, Always, TestOutputList (
2138 [["part_disk"; "/dev/sda"; "mbr"];
2139 ["pvcreate"; "/dev/sda1"];
2140 ["vgcreate"; "VG"; "/dev/sda1"];
2141 ["lvcreate"; "LV1"; "VG"; "50"];
2142 ["lvcreate"; "LV2"; "VG"; "50"];
2143 ["lvremove"; "/dev/VG"];
2145 "remove an LVM logical volume",
2147 Remove an LVM logical volume C<device>, where C<device> is
2148 the path to the LV, such as C</dev/VG/LV>.
2150 You can also remove all LVs in a volume group by specifying
2151 the VG name, C</dev/VG>.");
2153 ("vgremove", (RErr, [String "vgname"]), 78, [Optional "lvm2"],
2154 [InitEmpty, Always, TestOutputList (
2155 [["part_disk"; "/dev/sda"; "mbr"];
2156 ["pvcreate"; "/dev/sda1"];
2157 ["vgcreate"; "VG"; "/dev/sda1"];
2158 ["lvcreate"; "LV1"; "VG"; "50"];
2159 ["lvcreate"; "LV2"; "VG"; "50"];
2162 InitEmpty, Always, TestOutputList (
2163 [["part_disk"; "/dev/sda"; "mbr"];
2164 ["pvcreate"; "/dev/sda1"];
2165 ["vgcreate"; "VG"; "/dev/sda1"];
2166 ["lvcreate"; "LV1"; "VG"; "50"];
2167 ["lvcreate"; "LV2"; "VG"; "50"];
2170 "remove an LVM volume group",
2172 Remove an LVM volume group C<vgname>, (for example C<VG>).
2174 This also forcibly removes all logical volumes in the volume
2177 ("pvremove", (RErr, [Device "device"]), 79, [Optional "lvm2"],
2178 [InitEmpty, Always, TestOutputListOfDevices (
2179 [["part_disk"; "/dev/sda"; "mbr"];
2180 ["pvcreate"; "/dev/sda1"];
2181 ["vgcreate"; "VG"; "/dev/sda1"];
2182 ["lvcreate"; "LV1"; "VG"; "50"];
2183 ["lvcreate"; "LV2"; "VG"; "50"];
2185 ["pvremove"; "/dev/sda1"];
2187 InitEmpty, Always, TestOutputListOfDevices (
2188 [["part_disk"; "/dev/sda"; "mbr"];
2189 ["pvcreate"; "/dev/sda1"];
2190 ["vgcreate"; "VG"; "/dev/sda1"];
2191 ["lvcreate"; "LV1"; "VG"; "50"];
2192 ["lvcreate"; "LV2"; "VG"; "50"];
2194 ["pvremove"; "/dev/sda1"];
2196 InitEmpty, Always, TestOutputListOfDevices (
2197 [["part_disk"; "/dev/sda"; "mbr"];
2198 ["pvcreate"; "/dev/sda1"];
2199 ["vgcreate"; "VG"; "/dev/sda1"];
2200 ["lvcreate"; "LV1"; "VG"; "50"];
2201 ["lvcreate"; "LV2"; "VG"; "50"];
2203 ["pvremove"; "/dev/sda1"];
2205 "remove an LVM physical volume",
2207 This wipes a physical volume C<device> so that LVM will no longer
2210 The implementation uses the C<pvremove> command which refuses to
2211 wipe physical volumes that contain any volume groups, so you have
2212 to remove those first.");
2214 ("set_e2label", (RErr, [Device "device"; String "label"]), 80, [],
2215 [InitBasicFS, Always, TestOutput (
2216 [["set_e2label"; "/dev/sda1"; "testlabel"];
2217 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2218 "set the ext2/3/4 filesystem label",
2220 This sets the ext2/3/4 filesystem label of the filesystem on
2221 C<device> to C<label>. Filesystem labels are limited to
2224 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2225 to return the existing label on a filesystem.");
2227 ("get_e2label", (RString "label", [Device "device"]), 81, [DeprecatedBy "vfs_label"],
2229 "get the ext2/3/4 filesystem label",
2231 This returns the ext2/3/4 filesystem label of the filesystem on
2234 ("set_e2uuid", (RErr, [Device "device"; String "uuid"]), 82, [],
2235 (let uuid = uuidgen () in
2236 [InitBasicFS, Always, TestOutput (
2237 [["set_e2uuid"; "/dev/sda1"; uuid];
2238 ["get_e2uuid"; "/dev/sda1"]], uuid);
2239 InitBasicFS, Always, TestOutput (
2240 [["set_e2uuid"; "/dev/sda1"; "clear"];
2241 ["get_e2uuid"; "/dev/sda1"]], "");
2242 (* We can't predict what UUIDs will be, so just check the commands run. *)
2243 InitBasicFS, Always, TestRun (
2244 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2245 InitBasicFS, Always, TestRun (
2246 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2247 "set the ext2/3/4 filesystem UUID",
2249 This sets the ext2/3/4 filesystem UUID of the filesystem on
2250 C<device> to C<uuid>. The format of the UUID and alternatives
2251 such as C<clear>, C<random> and C<time> are described in the
2252 L<tune2fs(8)> manpage.
2254 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2255 to return the existing UUID of a filesystem.");
2257 ("get_e2uuid", (RString "uuid", [Device "device"]), 83, [DeprecatedBy "vfs_uuid"],
2258 (* Regression test for RHBZ#597112. *)
2259 (let uuid = uuidgen () in
2260 [InitBasicFS, Always, TestOutput (
2261 [["mke2journal"; "1024"; "/dev/sdb"];
2262 ["set_e2uuid"; "/dev/sdb"; uuid];
2263 ["get_e2uuid"; "/dev/sdb"]], uuid)]),
2264 "get the ext2/3/4 filesystem UUID",
2266 This returns the ext2/3/4 filesystem UUID of the filesystem on
2269 ("fsck", (RInt "status", [String "fstype"; Device "device"]), 84, [FishOutput FishOutputHexadecimal],
2270 [InitBasicFS, Always, TestOutputInt (
2271 [["umount"; "/dev/sda1"];
2272 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2273 InitBasicFS, Always, TestOutputInt (
2274 [["umount"; "/dev/sda1"];
2275 ["zero"; "/dev/sda1"];
2276 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2277 "run the filesystem checker",
2279 This runs the filesystem checker (fsck) on C<device> which
2280 should have filesystem type C<fstype>.
2282 The returned integer is the status. See L<fsck(8)> for the
2283 list of status codes from C<fsck>.
2291 Multiple status codes can be summed together.
2295 A non-zero return code can mean \"success\", for example if
2296 errors have been corrected on the filesystem.
2300 Checking or repairing NTFS volumes is not supported
2305 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2307 ("zero", (RErr, [Device "device"]), 85, [],
2308 [InitBasicFS, Always, TestOutput (
2309 [["umount"; "/dev/sda1"];
2310 ["zero"; "/dev/sda1"];
2311 ["file"; "/dev/sda1"]], "data")],
2312 "write zeroes to the device",
2314 This command writes zeroes over the first few blocks of C<device>.
2316 How many blocks are zeroed isn't specified (but it's I<not> enough
2317 to securely wipe the device). It should be sufficient to remove
2318 any partition tables, filesystem superblocks and so on.
2320 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>.");
2322 ("grub_install", (RErr, [Pathname "root"; Device "device"]), 86, [],
2323 (* Test disabled because grub-install incompatible with virtio-blk driver.
2324 * See also: https://bugzilla.redhat.com/show_bug.cgi?id=479760
2326 [InitBasicFS, Disabled, TestOutputTrue (
2327 [["grub_install"; "/"; "/dev/sda1"];
2328 ["is_dir"; "/boot"]])],
2331 This command installs GRUB (the Grand Unified Bootloader) on
2332 C<device>, with the root directory being C<root>.
2334 Note: If grub-install reports the error
2335 \"No suitable drive was found in the generated device map.\"
2336 it may be that you need to create a C</boot/grub/device.map>
2337 file first that contains the mapping between grub device names
2338 and Linux device names. It is usually sufficient to create
2343 replacing C</dev/vda> with the name of the installation device.");
2345 ("cp", (RErr, [Pathname "src"; Pathname "dest"]), 87, [],
2346 [InitBasicFS, Always, TestOutput (
2347 [["write"; "/old"; "file content"];
2348 ["cp"; "/old"; "/new"];
2349 ["cat"; "/new"]], "file content");
2350 InitBasicFS, Always, TestOutputTrue (
2351 [["write"; "/old"; "file content"];
2352 ["cp"; "/old"; "/new"];
2353 ["is_file"; "/old"]]);
2354 InitBasicFS, Always, TestOutput (
2355 [["write"; "/old"; "file content"];
2357 ["cp"; "/old"; "/dir/new"];
2358 ["cat"; "/dir/new"]], "file content")],
2361 This copies a file from C<src> to C<dest> where C<dest> is
2362 either a destination filename or destination directory.");
2364 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"]), 88, [],
2365 [InitBasicFS, Always, TestOutput (
2366 [["mkdir"; "/olddir"];
2367 ["mkdir"; "/newdir"];
2368 ["write"; "/olddir/file"; "file content"];
2369 ["cp_a"; "/olddir"; "/newdir"];
2370 ["cat"; "/newdir/olddir/file"]], "file content")],
2371 "copy a file or directory recursively",
2373 This copies a file or directory from C<src> to C<dest>
2374 recursively using the C<cp -a> command.");
2376 ("mv", (RErr, [Pathname "src"; Pathname "dest"]), 89, [],
2377 [InitBasicFS, Always, TestOutput (
2378 [["write"; "/old"; "file content"];
2379 ["mv"; "/old"; "/new"];
2380 ["cat"; "/new"]], "file content");
2381 InitBasicFS, Always, TestOutputFalse (
2382 [["write"; "/old"; "file content"];
2383 ["mv"; "/old"; "/new"];
2384 ["is_file"; "/old"]])],
2387 This moves a file from C<src> to C<dest> where C<dest> is
2388 either a destination filename or destination directory.");
2390 ("drop_caches", (RErr, [Int "whattodrop"]), 90, [],
2391 [InitEmpty, Always, TestRun (
2392 [["drop_caches"; "3"]])],
2393 "drop kernel page cache, dentries and inodes",
2395 This instructs the guest kernel to drop its page cache,
2396 and/or dentries and inode caches. The parameter C<whattodrop>
2397 tells the kernel what precisely to drop, see
2398 L<http://linux-mm.org/Drop_Caches>
2400 Setting C<whattodrop> to 3 should drop everything.
2402 This automatically calls L<sync(2)> before the operation,
2403 so that the maximum guest memory is freed.");
2405 ("dmesg", (RString "kmsgs", []), 91, [],
2406 [InitEmpty, Always, TestRun (
2408 "return kernel messages",
2410 This returns the kernel messages (C<dmesg> output) from
2411 the guest kernel. This is sometimes useful for extended
2412 debugging of problems.
2414 Another way to get the same information is to enable
2415 verbose messages with C<guestfs_set_verbose> or by setting
2416 the environment variable C<LIBGUESTFS_DEBUG=1> before
2417 running the program.");
2419 ("ping_daemon", (RErr, []), 92, [],
2420 [InitEmpty, Always, TestRun (
2421 [["ping_daemon"]])],
2422 "ping the guest daemon",
2424 This is a test probe into the guestfs daemon running inside
2425 the qemu subprocess. Calling this function checks that the
2426 daemon responds to the ping message, without affecting the daemon
2427 or attached block device(s) in any other way.");
2429 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"]), 93, [],
2430 [InitBasicFS, Always, TestOutputTrue (
2431 [["write"; "/file1"; "contents of a file"];
2432 ["cp"; "/file1"; "/file2"];
2433 ["equal"; "/file1"; "/file2"]]);
2434 InitBasicFS, Always, TestOutputFalse (
2435 [["write"; "/file1"; "contents of a file"];
2436 ["write"; "/file2"; "contents of another file"];
2437 ["equal"; "/file1"; "/file2"]]);
2438 InitBasicFS, Always, TestLastFail (
2439 [["equal"; "/file1"; "/file2"]])],
2440 "test if two files have equal contents",
2442 This compares the two files C<file1> and C<file2> and returns
2443 true if their content is exactly equal, or false otherwise.
2445 The external L<cmp(1)> program is used for the comparison.");
2447 ("strings", (RStringList "stringsout", [Pathname "path"]), 94, [ProtocolLimitWarning],
2448 [InitISOFS, Always, TestOutputList (
2449 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
2450 InitISOFS, Always, TestOutputList (
2451 [["strings"; "/empty"]], []);
2452 (* Test for RHBZ#579608, absolute symbolic links. *)
2453 InitISOFS, Always, TestRun (
2454 [["strings"; "/abssymlink"]])],
2455 "print the printable strings in a file",
2457 This runs the L<strings(1)> command on a file and returns
2458 the list of printable strings found.");
2460 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"]), 95, [ProtocolLimitWarning],
2461 [InitISOFS, Always, TestOutputList (
2462 [["strings_e"; "b"; "/known-5"]], []);
2463 InitBasicFS, Always, TestOutputList (
2464 [["write"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
2465 ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
2466 "print the printable strings in a file",
2468 This is like the C<guestfs_strings> command, but allows you to
2469 specify the encoding of strings that are looked for in
2470 the source file C<path>.
2472 Allowed encodings are:
2478 Single 7-bit-byte characters like ASCII and the ASCII-compatible
2479 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
2483 Single 8-bit-byte characters.
2487 16-bit big endian strings such as those encoded in
2488 UTF-16BE or UCS-2BE.
2490 =item l (lower case letter L)
2492 16-bit little endian such as UTF-16LE and UCS-2LE.
2493 This is useful for examining binaries in Windows guests.
2497 32-bit big endian such as UCS-4BE.
2501 32-bit little endian such as UCS-4LE.
2505 The returned strings are transcoded to UTF-8.");
2507 ("hexdump", (RString "dump", [Pathname "path"]), 96, [ProtocolLimitWarning],
2508 [InitISOFS, Always, TestOutput (
2509 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
2510 (* Test for RHBZ#501888c2 regression which caused large hexdump
2511 * commands to segfault.
2513 InitISOFS, Always, TestRun (
2514 [["hexdump"; "/100krandom"]]);
2515 (* Test for RHBZ#579608, absolute symbolic links. *)
2516 InitISOFS, Always, TestRun (
2517 [["hexdump"; "/abssymlink"]])],
2518 "dump a file in hexadecimal",
2520 This runs C<hexdump -C> on the given C<path>. The result is
2521 the human-readable, canonical hex dump of the file.");
2523 ("zerofree", (RErr, [Device "device"]), 97, [Optional "zerofree"],
2524 [InitNone, Always, TestOutput (
2525 [["part_disk"; "/dev/sda"; "mbr"];
2526 ["mkfs"; "ext3"; "/dev/sda1"];
2527 ["mount_options"; ""; "/dev/sda1"; "/"];
2528 ["write"; "/new"; "test file"];
2529 ["umount"; "/dev/sda1"];
2530 ["zerofree"; "/dev/sda1"];
2531 ["mount_options"; ""; "/dev/sda1"; "/"];
2532 ["cat"; "/new"]], "test file")],
2533 "zero unused inodes and disk blocks on ext2/3 filesystem",
2535 This runs the I<zerofree> program on C<device>. This program
2536 claims to zero unused inodes and disk blocks on an ext2/3
2537 filesystem, thus making it possible to compress the filesystem
2540 You should B<not> run this program if the filesystem is
2543 It is possible that using this program can damage the filesystem
2544 or data on the filesystem.");
2546 ("pvresize", (RErr, [Device "device"]), 98, [Optional "lvm2"],
2548 "resize an LVM physical volume",
2550 This resizes (expands or shrinks) an existing LVM physical
2551 volume to match the new size of the underlying device.");
2553 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
2554 Int "cyls"; Int "heads"; Int "sectors";
2555 String "line"]), 99, [DangerWillRobinson],
2557 "modify a single partition on a block device",
2559 This runs L<sfdisk(8)> option to modify just the single
2560 partition C<n> (note: C<n> counts from 1).
2562 For other parameters, see C<guestfs_sfdisk>. You should usually
2563 pass C<0> for the cyls/heads/sectors parameters.
2565 See also: C<guestfs_part_add>");
2567 ("sfdisk_l", (RString "partitions", [Device "device"]), 100, [],
2569 "display the partition table",
2571 This displays the partition table on C<device>, in the
2572 human-readable output of the L<sfdisk(8)> command. It is
2573 not intended to be parsed.
2575 See also: C<guestfs_part_list>");
2577 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"]), 101, [],
2579 "display the kernel geometry",
2581 This displays the kernel's idea of the geometry of C<device>.
2583 The result is in human-readable format, and not designed to
2586 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"]), 102, [],
2588 "display the disk geometry from the partition table",
2590 This displays the disk geometry of C<device> read from the
2591 partition table. Especially in the case where the underlying
2592 block device has been resized, this can be different from the
2593 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
2595 The result is in human-readable format, and not designed to
2598 ("vg_activate_all", (RErr, [Bool "activate"]), 103, [Optional "lvm2"],
2600 "activate or deactivate all volume groups",
2602 This command activates or (if C<activate> is false) deactivates
2603 all logical volumes in all volume groups.
2604 If activated, then they are made known to the
2605 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2606 then those devices disappear.
2608 This command is the same as running C<vgchange -a y|n>");
2610 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"]), 104, [Optional "lvm2"],
2612 "activate or deactivate some volume groups",
2614 This command activates or (if C<activate> is false) deactivates
2615 all logical volumes in the listed volume groups C<volgroups>.
2616 If activated, then they are made known to the
2617 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2618 then those devices disappear.
2620 This command is the same as running C<vgchange -a y|n volgroups...>
2622 Note that if C<volgroups> is an empty list then B<all> volume groups
2623 are activated or deactivated.");
2625 ("lvresize", (RErr, [Device "device"; Int "mbytes"]), 105, [Optional "lvm2"],
2626 [InitNone, Always, TestOutput (
2627 [["part_disk"; "/dev/sda"; "mbr"];
2628 ["pvcreate"; "/dev/sda1"];
2629 ["vgcreate"; "VG"; "/dev/sda1"];
2630 ["lvcreate"; "LV"; "VG"; "10"];
2631 ["mkfs"; "ext2"; "/dev/VG/LV"];
2632 ["mount_options"; ""; "/dev/VG/LV"; "/"];
2633 ["write"; "/new"; "test content"];
2635 ["lvresize"; "/dev/VG/LV"; "20"];
2636 ["e2fsck_f"; "/dev/VG/LV"];
2637 ["resize2fs"; "/dev/VG/LV"];
2638 ["mount_options"; ""; "/dev/VG/LV"; "/"];
2639 ["cat"; "/new"]], "test content");
2640 InitNone, Always, TestRun (
2641 (* Make an LV smaller to test RHBZ#587484. *)
2642 [["part_disk"; "/dev/sda"; "mbr"];
2643 ["pvcreate"; "/dev/sda1"];
2644 ["vgcreate"; "VG"; "/dev/sda1"];
2645 ["lvcreate"; "LV"; "VG"; "20"];
2646 ["lvresize"; "/dev/VG/LV"; "10"]])],
2647 "resize an LVM logical volume",
2649 This resizes (expands or shrinks) an existing LVM logical
2650 volume to C<mbytes>. When reducing, data in the reduced part
2653 ("resize2fs", (RErr, [Device "device"]), 106, [],
2654 [], (* lvresize tests this *)
2655 "resize an ext2, ext3 or ext4 filesystem",
2657 This resizes an ext2, ext3 or ext4 filesystem to match the size of
2658 the underlying device.
2660 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
2661 on the C<device> before calling this command. For unknown reasons
2662 C<resize2fs> sometimes gives an error about this and sometimes not.
2663 In any case, it is always safe to call C<guestfs_e2fsck_f> before
2664 calling this function.");
2666 ("find", (RStringList "names", [Pathname "directory"]), 107, [ProtocolLimitWarning],
2667 [InitBasicFS, Always, TestOutputList (
2668 [["find"; "/"]], ["lost+found"]);
2669 InitBasicFS, Always, TestOutputList (
2673 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
2674 InitBasicFS, Always, TestOutputList (
2675 [["mkdir_p"; "/a/b/c"];
2676 ["touch"; "/a/b/c/d"];
2677 ["find"; "/a/b/"]], ["c"; "c/d"])],
2678 "find all files and directories",
2680 This command lists out all files and directories, recursively,
2681 starting at C<directory>. It is essentially equivalent to
2682 running the shell command C<find directory -print> but some
2683 post-processing happens on the output, described below.
2685 This returns a list of strings I<without any prefix>. Thus
2686 if the directory structure was:
2692 then the returned list from C<guestfs_find> C</tmp> would be
2700 If C<directory> is not a directory, then this command returns
2703 The returned list is sorted.
2705 See also C<guestfs_find0>.");
2707 ("e2fsck_f", (RErr, [Device "device"]), 108, [],
2708 [], (* lvresize tests this *)
2709 "check an ext2/ext3 filesystem",
2711 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
2712 filesystem checker on C<device>, noninteractively (C<-p>),
2713 even if the filesystem appears to be clean (C<-f>).
2715 This command is only needed because of C<guestfs_resize2fs>
2716 (q.v.). Normally you should use C<guestfs_fsck>.");
2718 ("sleep", (RErr, [Int "secs"]), 109, [],
2719 [InitNone, Always, TestRun (
2721 "sleep for some seconds",
2723 Sleep for C<secs> seconds.");
2725 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"]), 110, [Optional "ntfs3g"],
2726 [InitNone, Always, TestOutputInt (
2727 [["part_disk"; "/dev/sda"; "mbr"];
2728 ["mkfs"; "ntfs"; "/dev/sda1"];
2729 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
2730 InitNone, Always, TestOutputInt (
2731 [["part_disk"; "/dev/sda"; "mbr"];
2732 ["mkfs"; "ext2"; "/dev/sda1"];
2733 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
2734 "probe NTFS volume",
2736 This command runs the L<ntfs-3g.probe(8)> command which probes
2737 an NTFS C<device> for mountability. (Not all NTFS volumes can
2738 be mounted read-write, and some cannot be mounted at all).
2740 C<rw> is a boolean flag. Set it to true if you want to test
2741 if the volume can be mounted read-write. Set it to false if
2742 you want to test if the volume can be mounted read-only.
2744 The return value is an integer which C<0> if the operation
2745 would succeed, or some non-zero value documented in the
2746 L<ntfs-3g.probe(8)> manual page.");
2748 ("sh", (RString "output", [String "command"]), 111, [],
2749 [], (* XXX needs tests *)
2750 "run a command via the shell",
2752 This call runs a command from the guest filesystem via the
2755 This is like C<guestfs_command>, but passes the command to:
2757 /bin/sh -c \"command\"
2759 Depending on the guest's shell, this usually results in
2760 wildcards being expanded, shell expressions being interpolated
2763 All the provisos about C<guestfs_command> apply to this call.");
2765 ("sh_lines", (RStringList "lines", [String "command"]), 112, [],
2766 [], (* XXX needs tests *)
2767 "run a command via the shell returning lines",
2769 This is the same as C<guestfs_sh>, but splits the result
2770 into a list of lines.
2772 See also: C<guestfs_command_lines>");
2774 ("glob_expand", (RStringList "paths", [Pathname "pattern"]), 113, [],
2775 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
2776 * code in stubs.c, since all valid glob patterns must start with "/".
2777 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
2779 [InitBasicFS, Always, TestOutputList (
2780 [["mkdir_p"; "/a/b/c"];
2781 ["touch"; "/a/b/c/d"];
2782 ["touch"; "/a/b/c/e"];
2783 ["glob_expand"; "/a/b/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2784 InitBasicFS, Always, TestOutputList (
2785 [["mkdir_p"; "/a/b/c"];
2786 ["touch"; "/a/b/c/d"];
2787 ["touch"; "/a/b/c/e"];
2788 ["glob_expand"; "/a/*/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2789 InitBasicFS, Always, TestOutputList (
2790 [["mkdir_p"; "/a/b/c"];
2791 ["touch"; "/a/b/c/d"];
2792 ["touch"; "/a/b/c/e"];
2793 ["glob_expand"; "/a/*/x/*"]], [])],
2794 "expand a wildcard path",
2796 This command searches for all the pathnames matching
2797 C<pattern> according to the wildcard expansion rules
2800 If no paths match, then this returns an empty list
2801 (note: not an error).
2803 It is just a wrapper around the C L<glob(3)> function
2804 with flags C<GLOB_MARK|GLOB_BRACE>.
2805 See that manual page for more details.");
2807 ("scrub_device", (RErr, [Device "device"]), 114, [DangerWillRobinson; Optional "scrub"],
2808 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
2809 [["scrub_device"; "/dev/sdc"]])],
2810 "scrub (securely wipe) a device",
2812 This command writes patterns over C<device> to make data retrieval
2815 It is an interface to the L<scrub(1)> program. See that
2816 manual page for more details.");
2818 ("scrub_file", (RErr, [Pathname "file"]), 115, [Optional "scrub"],
2819 [InitBasicFS, Always, TestRun (
2820 [["write"; "/file"; "content"];
2821 ["scrub_file"; "/file"]])],
2822 "scrub (securely wipe) a file",
2824 This command writes patterns over a file to make data retrieval
2827 The file is I<removed> after scrubbing.
2829 It is an interface to the L<scrub(1)> program. See that
2830 manual page for more details.");
2832 ("scrub_freespace", (RErr, [Pathname "dir"]), 116, [Optional "scrub"],
2833 [], (* XXX needs testing *)
2834 "scrub (securely wipe) free space",
2836 This command creates the directory C<dir> and then fills it
2837 with files until the filesystem is full, and scrubs the files
2838 as for C<guestfs_scrub_file>, and deletes them.
2839 The intention is to scrub any free space on the partition
2842 It is an interface to the L<scrub(1)> program. See that
2843 manual page for more details.");
2845 ("mkdtemp", (RString "dir", [Pathname "template"]), 117, [],
2846 [InitBasicFS, Always, TestRun (
2848 ["mkdtemp"; "/tmp/tmpXXXXXX"]])],
2849 "create a temporary directory",
2851 This command creates a temporary directory. The
2852 C<template> parameter should be a full pathname for the
2853 temporary directory name with the final six characters being
2856 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
2857 the second one being suitable for Windows filesystems.
2859 The name of the temporary directory that was created
2862 The temporary directory is created with mode 0700
2863 and is owned by root.
2865 The caller is responsible for deleting the temporary
2866 directory and its contents after use.
2868 See also: L<mkdtemp(3)>");
2870 ("wc_l", (RInt "lines", [Pathname "path"]), 118, [],
2871 [InitISOFS, Always, TestOutputInt (
2872 [["wc_l"; "/10klines"]], 10000);
2873 (* Test for RHBZ#579608, absolute symbolic links. *)
2874 InitISOFS, Always, TestOutputInt (
2875 [["wc_l"; "/abssymlink"]], 10000)],
2876 "count lines in a file",
2878 This command counts the lines in a file, using the
2879 C<wc -l> external command.");
2881 ("wc_w", (RInt "words", [Pathname "path"]), 119, [],
2882 [InitISOFS, Always, TestOutputInt (
2883 [["wc_w"; "/10klines"]], 10000)],
2884 "count words in a file",
2886 This command counts the words in a file, using the
2887 C<wc -w> external command.");
2889 ("wc_c", (RInt "chars", [Pathname "path"]), 120, [],
2890 [InitISOFS, Always, TestOutputInt (
2891 [["wc_c"; "/100kallspaces"]], 102400)],
2892 "count characters in a file",
2894 This command counts the characters in a file, using the
2895 C<wc -c> external command.");
2897 ("head", (RStringList "lines", [Pathname "path"]), 121, [ProtocolLimitWarning],
2898 [InitISOFS, Always, TestOutputList (
2899 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"]);
2900 (* Test for RHBZ#579608, absolute symbolic links. *)
2901 InitISOFS, Always, TestOutputList (
2902 [["head"; "/abssymlink"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
2903 "return first 10 lines of a file",
2905 This command returns up to the first 10 lines of a file as
2906 a list of strings.");
2908 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"]), 122, [ProtocolLimitWarning],
2909 [InitISOFS, Always, TestOutputList (
2910 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2911 InitISOFS, Always, TestOutputList (
2912 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2913 InitISOFS, Always, TestOutputList (
2914 [["head_n"; "0"; "/10klines"]], [])],
2915 "return first N lines of a file",
2917 If the parameter C<nrlines> is a positive number, this returns the first
2918 C<nrlines> lines of the file C<path>.
2920 If the parameter C<nrlines> is a negative number, this returns lines
2921 from the file C<path>, excluding the last C<nrlines> lines.
2923 If the parameter C<nrlines> is zero, this returns an empty list.");
2925 ("tail", (RStringList "lines", [Pathname "path"]), 123, [ProtocolLimitWarning],
2926 [InitISOFS, Always, TestOutputList (
2927 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
2928 "return last 10 lines of a file",
2930 This command returns up to the last 10 lines of a file as
2931 a list of strings.");
2933 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"]), 124, [ProtocolLimitWarning],
2934 [InitISOFS, Always, TestOutputList (
2935 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2936 InitISOFS, Always, TestOutputList (
2937 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2938 InitISOFS, Always, TestOutputList (
2939 [["tail_n"; "0"; "/10klines"]], [])],
2940 "return last N lines of a file",
2942 If the parameter C<nrlines> is a positive number, this returns the last
2943 C<nrlines> lines of the file C<path>.
2945 If the parameter C<nrlines> is a negative number, this returns lines
2946 from the file C<path>, starting with the C<-nrlines>th line.
2948 If the parameter C<nrlines> is zero, this returns an empty list.");
2950 ("df", (RString "output", []), 125, [],
2951 [], (* XXX Tricky to test because it depends on the exact format
2952 * of the 'df' command and other imponderables.
2954 "report file system disk space usage",
2956 This command runs the C<df> command to report disk space used.
2958 This command is mostly useful for interactive sessions. It
2959 is I<not> intended that you try to parse the output string.
2960 Use C<statvfs> from programs.");
2962 ("df_h", (RString "output", []), 126, [],
2963 [], (* XXX Tricky to test because it depends on the exact format
2964 * of the 'df' command and other imponderables.
2966 "report file system disk space usage (human readable)",
2968 This command runs the C<df -h> command to report disk space used
2969 in human-readable format.
2971 This command is mostly useful for interactive sessions. It
2972 is I<not> intended that you try to parse the output string.
2973 Use C<statvfs> from programs.");
2975 ("du", (RInt64 "sizekb", [Pathname "path"]), 127, [],
2976 [InitISOFS, Always, TestOutputInt (
2977 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
2978 "estimate file space usage",
2980 This command runs the C<du -s> command to estimate file space
2983 C<path> can be a file or a directory. If C<path> is a directory
2984 then the estimate includes the contents of the directory and all
2985 subdirectories (recursively).
2987 The result is the estimated size in I<kilobytes>
2988 (ie. units of 1024 bytes).");
2990 ("initrd_list", (RStringList "filenames", [Pathname "path"]), 128, [],
2991 [InitISOFS, Always, TestOutputList (
2992 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
2993 "list files in an initrd",
2995 This command lists out files contained in an initrd.
2997 The files are listed without any initial C</> character. The
2998 files are listed in the order they appear (not necessarily
2999 alphabetical). Directory names are listed as separate items.
3001 Old Linux kernels (2.4 and earlier) used a compressed ext2
3002 filesystem as initrd. We I<only> support the newer initramfs
3003 format (compressed cpio files).");
3005 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"]), 129, [],
3007 "mount a file using the loop device",
3009 This command lets you mount C<file> (a filesystem image
3010 in a file) on a mount point. It is entirely equivalent to
3011 the command C<mount -o loop file mountpoint>.");
3013 ("mkswap", (RErr, [Device "device"]), 130, [],
3014 [InitEmpty, Always, TestRun (
3015 [["part_disk"; "/dev/sda"; "mbr"];
3016 ["mkswap"; "/dev/sda1"]])],
3017 "create a swap partition",
3019 Create a swap partition on C<device>.");
3021 ("mkswap_L", (RErr, [String "label"; Device "device"]), 131, [],
3022 [InitEmpty, Always, TestRun (
3023 [["part_disk"; "/dev/sda"; "mbr"];
3024 ["mkswap_L"; "hello"; "/dev/sda1"]])],
3025 "create a swap partition with a label",
3027 Create a swap partition on C<device> with label C<label>.
3029 Note that you cannot attach a swap label to a block device
3030 (eg. C</dev/sda>), just to a partition. This appears to be
3031 a limitation of the kernel or swap tools.");
3033 ("mkswap_U", (RErr, [String "uuid"; Device "device"]), 132, [Optional "linuxfsuuid"],
3034 (let uuid = uuidgen () in
3035 [InitEmpty, Always, TestRun (
3036 [["part_disk"; "/dev/sda"; "mbr"];
3037 ["mkswap_U"; uuid; "/dev/sda1"]])]),
3038 "create a swap partition with an explicit UUID",
3040 Create a swap partition on C<device> with UUID C<uuid>.");
3042 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 133, [Optional "mknod"],
3043 [InitBasicFS, Always, TestOutputStruct (
3044 [["mknod"; "0o10777"; "0"; "0"; "/node"];
3045 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3046 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)]);
3047 InitBasicFS, Always, TestOutputStruct (
3048 [["mknod"; "0o60777"; "66"; "99"; "/node"];
3049 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3050 "make block, character or FIFO devices",
3052 This call creates block or character special devices, or
3053 named pipes (FIFOs).
3055 The C<mode> parameter should be the mode, using the standard
3056 constants. C<devmajor> and C<devminor> are the
3057 device major and minor numbers, only used when creating block
3058 and character special devices.
3060 Note that, just like L<mknod(2)>, the mode must be bitwise
3061 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3062 just creates a regular file). These constants are
3063 available in the standard Linux header files, or you can use
3064 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3065 which are wrappers around this command which bitwise OR
3066 in the appropriate constant for you.
3068 The mode actually set is affected by the umask.");
3070 ("mkfifo", (RErr, [Int "mode"; Pathname "path"]), 134, [Optional "mknod"],
3071 [InitBasicFS, Always, TestOutputStruct (
3072 [["mkfifo"; "0o777"; "/node"];
3073 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)])],
3074 "make FIFO (named pipe)",
3076 This call creates a FIFO (named pipe) called C<path> with
3077 mode C<mode>. It is just a convenient wrapper around
3080 The mode actually set is affected by the umask.");
3082 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 135, [Optional "mknod"],
3083 [InitBasicFS, Always, TestOutputStruct (
3084 [["mknod_b"; "0o777"; "99"; "66"; "/node"];
3085 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3086 "make block device node",
3088 This call creates a block device node called C<path> with
3089 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3090 It is just a convenient wrapper around C<guestfs_mknod>.
3092 The mode actually set is affected by the umask.");
3094 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 136, [Optional "mknod"],
3095 [InitBasicFS, Always, TestOutputStruct (
3096 [["mknod_c"; "0o777"; "99"; "66"; "/node"];
3097 ["stat"; "/node"]], [CompareWithInt ("mode", 0o20755)])],
3098 "make char device node",
3100 This call creates a char device node called C<path> with
3101 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3102 It is just a convenient wrapper around C<guestfs_mknod>.
3104 The mode actually set is affected by the umask.");
3106 ("umask", (RInt "oldmask", [Int "mask"]), 137, [FishOutput FishOutputOctal],
3107 [InitEmpty, Always, TestOutputInt (
3108 [["umask"; "0o22"]], 0o22)],
3109 "set file mode creation mask (umask)",
3111 This function sets the mask used for creating new files and
3112 device nodes to C<mask & 0777>.
3114 Typical umask values would be C<022> which creates new files
3115 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3116 C<002> which creates new files with permissions like
3117 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3119 The default umask is C<022>. This is important because it
3120 means that directories and device nodes will be created with
3121 C<0644> or C<0755> mode even if you specify C<0777>.
3123 See also C<guestfs_get_umask>,
3124 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3126 This call returns the previous umask.");
3128 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"]), 138, [],
3130 "read directories entries",
3132 This returns the list of directory entries in directory C<dir>.
3134 All entries in the directory are returned, including C<.> and
3135 C<..>. The entries are I<not> sorted, but returned in the same
3136 order as the underlying filesystem.
3138 Also this call returns basic file type information about each
3139 file. The C<ftyp> field will contain one of the following characters:
3177 The L<readdir(3)> call returned a C<d_type> field with an
3182 This function is primarily intended for use by programs. To
3183 get a simple list of names, use C<guestfs_ls>. To get a printable
3184 directory for human consumption, use C<guestfs_ll>.");
3186 ("sfdiskM", (RErr, [Device "device"; StringList "lines"]), 139, [DangerWillRobinson],
3188 "create partitions on a block device",
3190 This is a simplified interface to the C<guestfs_sfdisk>
3191 command, where partition sizes are specified in megabytes
3192 only (rounded to the nearest cylinder) and you don't need
3193 to specify the cyls, heads and sectors parameters which
3194 were rarely if ever used anyway.
3196 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3197 and C<guestfs_part_disk>");
3199 ("zfile", (RString "description", [String "meth"; Pathname "path"]), 140, [DeprecatedBy "file"],
3201 "determine file type inside a compressed file",
3203 This command runs C<file> after first decompressing C<path>
3206 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3208 Since 1.0.63, use C<guestfs_file> instead which can now
3209 process compressed files.");
3211 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"]), 141, [Optional "linuxxattrs"],
3213 "list extended attributes of a file or directory",
3215 This call lists the extended attributes of the file or directory
3218 At the system call level, this is a combination of the
3219 L<listxattr(2)> and L<getxattr(2)> calls.
3221 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3223 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"]), 142, [Optional "linuxxattrs"],
3225 "list extended attributes of a file or directory",
3227 This is the same as C<guestfs_getxattrs>, but if C<path>
3228 is a symbolic link, then it returns the extended attributes
3229 of the link itself.");
3231 ("setxattr", (RErr, [String "xattr";
3232 String "val"; Int "vallen"; (* will be BufferIn *)
3233 Pathname "path"]), 143, [Optional "linuxxattrs"],
3235 "set extended attribute of a file or directory",
3237 This call sets the extended attribute named C<xattr>
3238 of the file C<path> to the value C<val> (of length C<vallen>).
3239 The value is arbitrary 8 bit data.
3241 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3243 ("lsetxattr", (RErr, [String "xattr";
3244 String "val"; Int "vallen"; (* will be BufferIn *)
3245 Pathname "path"]), 144, [Optional "linuxxattrs"],
3247 "set extended attribute of a file or directory",
3249 This is the same as C<guestfs_setxattr>, but if C<path>
3250 is a symbolic link, then it sets an extended attribute
3251 of the link itself.");
3253 ("removexattr", (RErr, [String "xattr"; Pathname "path"]), 145, [Optional "linuxxattrs"],
3255 "remove extended attribute of a file or directory",
3257 This call removes the extended attribute named C<xattr>
3258 of the file C<path>.
3260 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3262 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"]), 146, [Optional "linuxxattrs"],
3264 "remove extended attribute of a file or directory",
3266 This is the same as C<guestfs_removexattr>, but if C<path>
3267 is a symbolic link, then it removes an extended attribute
3268 of the link itself.");
3270 ("mountpoints", (RHashtable "mps", []), 147, [],
3274 This call is similar to C<guestfs_mounts>. That call returns
3275 a list of devices. This one returns a hash table (map) of
3276 device name to directory where the device is mounted.");
3278 ("mkmountpoint", (RErr, [String "exemptpath"]), 148, [],
3279 (* This is a special case: while you would expect a parameter
3280 * of type "Pathname", that doesn't work, because it implies
3281 * NEED_ROOT in the generated calling code in stubs.c, and
3282 * this function cannot use NEED_ROOT.
3285 "create a mountpoint",
3287 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3288 specialized calls that can be used to create extra mountpoints
3289 before mounting the first filesystem.
3291 These calls are I<only> necessary in some very limited circumstances,
3292 mainly the case where you want to mount a mix of unrelated and/or
3293 read-only filesystems together.
3295 For example, live CDs often contain a \"Russian doll\" nest of
3296 filesystems, an ISO outer layer, with a squashfs image inside, with
3297 an ext2/3 image inside that. You can unpack this as follows
3300 add-ro Fedora-11-i686-Live.iso
3303 mkmountpoint /squash
3306 mount-loop /cd/LiveOS/squashfs.img /squash
3307 mount-loop /squash/LiveOS/ext3fs.img /ext3
3309 The inner filesystem is now unpacked under the /ext3 mountpoint.");
3311 ("rmmountpoint", (RErr, [String "exemptpath"]), 149, [],
3313 "remove a mountpoint",
3315 This calls removes a mountpoint that was previously created
3316 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
3317 for full details.");
3319 ("read_file", (RBufferOut "content", [Pathname "path"]), 150, [ProtocolLimitWarning],
3320 [InitISOFS, Always, TestOutputBuffer (
3321 [["read_file"; "/known-4"]], "abc\ndef\nghi");
3322 (* Test various near large, large and too large files (RHBZ#589039). *)
3323 InitBasicFS, Always, TestLastFail (
3325 ["truncate_size"; "/a"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
3326 ["read_file"; "/a"]]);
3327 InitBasicFS, Always, TestLastFail (
3329 ["truncate_size"; "/a"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
3330 ["read_file"; "/a"]]);
3331 InitBasicFS, Always, TestLastFail (
3333 ["truncate_size"; "/a"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
3334 ["read_file"; "/a"]])],
3337 This calls returns the contents of the file C<path> as a
3340 Unlike C<guestfs_cat>, this function can correctly
3341 handle files that contain embedded ASCII NUL characters.
3342 However unlike C<guestfs_download>, this function is limited
3343 in the total size of file that can be handled.");
3345 ("grep", (RStringList "lines", [String "regex"; Pathname "path"]), 151, [ProtocolLimitWarning],
3346 [InitISOFS, Always, TestOutputList (
3347 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3348 InitISOFS, Always, TestOutputList (
3349 [["grep"; "nomatch"; "/test-grep.txt"]], []);
3350 (* Test for RHBZ#579608, absolute symbolic links. *)
3351 InitISOFS, Always, TestOutputList (
3352 [["grep"; "nomatch"; "/abssymlink"]], [])],
3353 "return lines matching a pattern",
3355 This calls the external C<grep> program and returns the
3358 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"]), 152, [ProtocolLimitWarning],
3359 [InitISOFS, Always, TestOutputList (
3360 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3361 "return lines matching a pattern",
3363 This calls the external C<egrep> program and returns the
3366 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"]), 153, [ProtocolLimitWarning],
3367 [InitISOFS, Always, TestOutputList (
3368 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3369 "return lines matching a pattern",
3371 This calls the external C<fgrep> program and returns the
3374 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"]), 154, [ProtocolLimitWarning],
3375 [InitISOFS, Always, TestOutputList (
3376 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3377 "return lines matching a pattern",
3379 This calls the external C<grep -i> program and returns the
3382 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 155, [ProtocolLimitWarning],
3383 [InitISOFS, Always, TestOutputList (
3384 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3385 "return lines matching a pattern",
3387 This calls the external C<egrep -i> program and returns the
3390 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"]), 156, [ProtocolLimitWarning],
3391 [InitISOFS, Always, TestOutputList (
3392 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3393 "return lines matching a pattern",
3395 This calls the external C<fgrep -i> program and returns the
3398 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"]), 157, [ProtocolLimitWarning],
3399 [InitISOFS, Always, TestOutputList (
3400 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3401 "return lines matching a pattern",
3403 This calls the external C<zgrep> program and returns the
3406 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"]), 158, [ProtocolLimitWarning],
3407 [InitISOFS, Always, TestOutputList (
3408 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3409 "return lines matching a pattern",
3411 This calls the external C<zegrep> program and returns the
3414 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"]), 159, [ProtocolLimitWarning],
3415 [InitISOFS, Always, TestOutputList (
3416 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3417 "return lines matching a pattern",
3419 This calls the external C<zfgrep> program and returns the
3422 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 160, [ProtocolLimitWarning],
3423 [InitISOFS, Always, TestOutputList (
3424 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3425 "return lines matching a pattern",
3427 This calls the external C<zgrep -i> program and returns the
3430 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 161, [ProtocolLimitWarning],
3431 [InitISOFS, Always, TestOutputList (
3432 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3433 "return lines matching a pattern",
3435 This calls the external C<zegrep -i> program and returns the
3438 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"]), 162, [ProtocolLimitWarning],
3439 [InitISOFS, Always, TestOutputList (
3440 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3441 "return lines matching a pattern",
3443 This calls the external C<zfgrep -i> program and returns the
3446 ("realpath", (RString "rpath", [Pathname "path"]), 163, [Optional "realpath"],
3447 [InitISOFS, Always, TestOutput (
3448 [["realpath"; "/../directory"]], "/directory")],
3449 "canonicalized absolute pathname",
3451 Return the canonicalized absolute pathname of C<path>. The
3452 returned path has no C<.>, C<..> or symbolic link path elements.");
3454 ("ln", (RErr, [String "target"; Pathname "linkname"]), 164, [],
3455 [InitBasicFS, Always, TestOutputStruct (
3458 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3459 "create a hard link",
3461 This command creates a hard link using the C<ln> command.");
3463 ("ln_f", (RErr, [String "target"; Pathname "linkname"]), 165, [],
3464 [InitBasicFS, Always, TestOutputStruct (
3467 ["ln_f"; "/a"; "/b"];
3468 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3469 "create a hard link",
3471 This command creates a hard link using the C<ln -f> command.
3472 The C<-f> option removes the link (C<linkname>) if it exists already.");
3474 ("ln_s", (RErr, [String "target"; Pathname "linkname"]), 166, [],
3475 [InitBasicFS, Always, TestOutputStruct (
3477 ["ln_s"; "a"; "/b"];
3478 ["lstat"; "/b"]], [CompareWithInt ("mode", 0o120777)])],
3479 "create a symbolic link",
3481 This command creates a symbolic link using the C<ln -s> command.");
3483 ("ln_sf", (RErr, [String "target"; Pathname "linkname"]), 167, [],
3484 [InitBasicFS, Always, TestOutput (
3485 [["mkdir_p"; "/a/b"];
3486 ["touch"; "/a/b/c"];
3487 ["ln_sf"; "../d"; "/a/b/c"];
3488 ["readlink"; "/a/b/c"]], "../d")],
3489 "create a symbolic link",
3491 This command creates a symbolic link using the C<ln -sf> command,
3492 The C<-f> option removes the link (C<linkname>) if it exists already.");
3494 ("readlink", (RString "link", [Pathname "path"]), 168, [],
3495 [] (* XXX tested above *),
3496 "read the target of a symbolic link",
3498 This command reads the target of a symbolic link.");
3500 ("fallocate", (RErr, [Pathname "path"; Int "len"]), 169, [DeprecatedBy "fallocate64"],
3501 [InitBasicFS, Always, TestOutputStruct (
3502 [["fallocate"; "/a"; "1000000"];
3503 ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
3504 "preallocate a file in the guest filesystem",
3506 This command preallocates a file (containing zero bytes) named
3507 C<path> of size C<len> bytes. If the file exists already, it
3510 Do not confuse this with the guestfish-specific
3511 C<alloc> command which allocates a file in the host and
3512 attaches it as a device.");
3514 ("swapon_device", (RErr, [Device "device"]), 170, [],
3515 [InitPartition, Always, TestRun (
3516 [["mkswap"; "/dev/sda1"];
3517 ["swapon_device"; "/dev/sda1"];
3518 ["swapoff_device"; "/dev/sda1"]])],
3519 "enable swap on device",
3521 This command enables the libguestfs appliance to use the
3522 swap device or partition named C<device>. The increased
3523 memory is made available for all commands, for example
3524 those run using C<guestfs_command> or C<guestfs_sh>.
3526 Note that you should not swap to existing guest swap
3527 partitions unless you know what you are doing. They may
3528 contain hibernation information, or other information that
3529 the guest doesn't want you to trash. You also risk leaking
3530 information about the host to the guest this way. Instead,
3531 attach a new host device to the guest and swap on that.");
3533 ("swapoff_device", (RErr, [Device "device"]), 171, [],
3534 [], (* XXX tested by swapon_device *)
3535 "disable swap on device",
3537 This command disables the libguestfs appliance swap
3538 device or partition named C<device>.
3539 See C<guestfs_swapon_device>.");
3541 ("swapon_file", (RErr, [Pathname "file"]), 172, [],
3542 [InitBasicFS, Always, TestRun (
3543 [["fallocate"; "/swap"; "8388608"];
3544 ["mkswap_file"; "/swap"];
3545 ["swapon_file"; "/swap"];
3546 ["swapoff_file"; "/swap"]])],
3547 "enable swap on file",
3549 This command enables swap to a file.
3550 See C<guestfs_swapon_device> for other notes.");
3552 ("swapoff_file", (RErr, [Pathname "file"]), 173, [],
3553 [], (* XXX tested by swapon_file *)
3554 "disable swap on file",
3556 This command disables the libguestfs appliance swap on file.");
3558 ("swapon_label", (RErr, [String "label"]), 174, [],
3559 [InitEmpty, Always, TestRun (
3560 [["part_disk"; "/dev/sdb"; "mbr"];
3561 ["mkswap_L"; "swapit"; "/dev/sdb1"];
3562 ["swapon_label"; "swapit"];
3563 ["swapoff_label"; "swapit"];
3564 ["zero"; "/dev/sdb"];
3565 ["blockdev_rereadpt"; "/dev/sdb"]])],
3566 "enable swap on labeled swap partition",
3568 This command enables swap to a labeled swap partition.
3569 See C<guestfs_swapon_device> for other notes.");
3571 ("swapoff_label", (RErr, [String "label"]), 175, [],
3572 [], (* XXX tested by swapon_label *)
3573 "disable swap on labeled swap partition",
3575 This command disables the libguestfs appliance swap on
3576 labeled swap partition.");
3578 ("swapon_uuid", (RErr, [String "uuid"]), 176, [Optional "linuxfsuuid"],
3579 (let uuid = uuidgen () in
3580 [InitEmpty, Always, TestRun (
3581 [["mkswap_U"; uuid; "/dev/sdb"];
3582 ["swapon_uuid"; uuid];
3583 ["swapoff_uuid"; uuid]])]),
3584 "enable swap on swap partition by UUID",
3586 This command enables swap to a swap partition with the given UUID.
3587 See C<guestfs_swapon_device> for other notes.");
3589 ("swapoff_uuid", (RErr, [String "uuid"]), 177, [Optional "linuxfsuuid"],
3590 [], (* XXX tested by swapon_uuid *)
3591 "disable swap on swap partition by UUID",
3593 This command disables the libguestfs appliance swap partition
3594 with the given UUID.");
3596 ("mkswap_file", (RErr, [Pathname "path"]), 178, [],
3597 [InitBasicFS, Always, TestRun (
3598 [["fallocate"; "/swap"; "8388608"];
3599 ["mkswap_file"; "/swap"]])],
3600 "create a swap file",
3604 This command just writes a swap file signature to an existing
3605 file. To create the file itself, use something like C<guestfs_fallocate>.");
3607 ("inotify_init", (RErr, [Int "maxevents"]), 179, [Optional "inotify"],
3608 [InitISOFS, Always, TestRun (
3609 [["inotify_init"; "0"]])],
3610 "create an inotify handle",
3612 This command creates a new inotify handle.
3613 The inotify subsystem can be used to notify events which happen to
3614 objects in the guest filesystem.
3616 C<maxevents> is the maximum number of events which will be
3617 queued up between calls to C<guestfs_inotify_read> or
3618 C<guestfs_inotify_files>.
3619 If this is passed as C<0>, then the kernel (or previously set)
3620 default is used. For Linux 2.6.29 the default was 16384 events.
3621 Beyond this limit, the kernel throws away events, but records
3622 the fact that it threw them away by setting a flag
3623 C<IN_Q_OVERFLOW> in the returned structure list (see
3624 C<guestfs_inotify_read>).
3626 Before any events are generated, you have to add some
3627 watches to the internal watch list. See:
3628 C<guestfs_inotify_add_watch>,
3629 C<guestfs_inotify_rm_watch> and
3630 C<guestfs_inotify_watch_all>.
3632 Queued up events should be read periodically by calling
3633 C<guestfs_inotify_read>
3634 (or C<guestfs_inotify_files> which is just a helpful
3635 wrapper around C<guestfs_inotify_read>). If you don't
3636 read the events out often enough then you risk the internal
3639 The handle should be closed after use by calling
3640 C<guestfs_inotify_close>. This also removes any
3641 watches automatically.
3643 See also L<inotify(7)> for an overview of the inotify interface
3644 as exposed by the Linux kernel, which is roughly what we expose
3645 via libguestfs. Note that there is one global inotify handle
3646 per libguestfs instance.");
3648 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"]), 180, [Optional "inotify"],
3649 [InitBasicFS, Always, TestOutputList (
3650 [["inotify_init"; "0"];
3651 ["inotify_add_watch"; "/"; "1073741823"];
3654 ["inotify_files"]], ["a"; "b"])],
3655 "add an inotify watch",
3657 Watch C<path> for the events listed in C<mask>.
3659 Note that if C<path> is a directory then events within that
3660 directory are watched, but this does I<not> happen recursively
3661 (in subdirectories).
3663 Note for non-C or non-Linux callers: the inotify events are
3664 defined by the Linux kernel ABI and are listed in
3665 C</usr/include/sys/inotify.h>.");
3667 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"]), 181, [Optional "inotify"],
3669 "remove an inotify watch",
3671 Remove a previously defined inotify watch.
3672 See C<guestfs_inotify_add_watch>.");
3674 ("inotify_read", (RStructList ("events", "inotify_event"), []), 182, [Optional "inotify"],
3676 "return list of inotify events",
3678 Return the complete queue of events that have happened
3679 since the previous read call.
3681 If no events have happened, this returns an empty list.
3683 I<Note>: In order to make sure that all events have been
3684 read, you must call this function repeatedly until it
3685 returns an empty list. The reason is that the call will
3686 read events up to the maximum appliance-to-host message
3687 size and leave remaining events in the queue.");
3689 ("inotify_files", (RStringList "paths", []), 183, [Optional "inotify"],
3691 "return list of watched files that had events",
3693 This function is a helpful wrapper around C<guestfs_inotify_read>
3694 which just returns a list of pathnames of objects that were
3695 touched. The returned pathnames are sorted and deduplicated.");
3697 ("inotify_close", (RErr, []), 184, [Optional "inotify"],
3699 "close the inotify handle",
3701 This closes the inotify handle which was previously
3702 opened by inotify_init. It removes all watches, throws
3703 away any pending events, and deallocates all resources.");
3705 ("setcon", (RErr, [String "context"]), 185, [Optional "selinux"],
3707 "set SELinux security context",
3709 This sets the SELinux security context of the daemon
3710 to the string C<context>.
3712 See the documentation about SELINUX in L<guestfs(3)>.");
3714 ("getcon", (RString "context", []), 186, [Optional "selinux"],
3716 "get SELinux security context",
3718 This gets the SELinux security context of the daemon.
3720 See the documentation about SELINUX in L<guestfs(3)>,
3721 and C<guestfs_setcon>");
3723 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"]), 187, [],
3724 [InitEmpty, Always, TestOutput (
3725 [["part_disk"; "/dev/sda"; "mbr"];
3726 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
3727 ["mount_options"; ""; "/dev/sda1"; "/"];
3728 ["write"; "/new"; "new file contents"];
3729 ["cat"; "/new"]], "new file contents")],
3730 "make a filesystem with block size",
3732 This call is similar to C<guestfs_mkfs>, but it allows you to
3733 control the block size of the resulting filesystem. Supported
3734 block sizes depend on the filesystem type, but typically they
3735 are C<1024>, C<2048> or C<4096> only.");
3737 ("mke2journal", (RErr, [Int "blocksize"; Device "device"]), 188, [],
3738 [InitEmpty, Always, TestOutput (
3739 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3740 ["mke2journal"; "4096"; "/dev/sda1"];
3741 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
3742 ["mount_options"; ""; "/dev/sda2"; "/"];
3743 ["write"; "/new"; "new file contents"];
3744 ["cat"; "/new"]], "new file contents")],
3745 "make ext2/3/4 external journal",
3747 This creates an ext2 external journal on C<device>. It is equivalent
3750 mke2fs -O journal_dev -b blocksize device");
3752 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"]), 189, [],
3753 [InitEmpty, Always, TestOutput (
3754 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3755 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
3756 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
3757 ["mount_options"; ""; "/dev/sda2"; "/"];
3758 ["write"; "/new"; "new file contents"];
3759 ["cat"; "/new"]], "new file contents")],
3760 "make ext2/3/4 external journal with label",
3762 This creates an ext2 external journal on C<device> with label C<label>.");
3764 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"]), 190, [Optional "linuxfsuuid"],
3765 (let uuid = uuidgen () in
3766 [InitEmpty, Always, TestOutput (
3767 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3768 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
3769 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
3770 ["mount_options"; ""; "/dev/sda2"; "/"];
3771 ["write"; "/new"; "new file contents"];
3772 ["cat"; "/new"]], "new file contents")]),
3773 "make ext2/3/4 external journal with UUID",
3775 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
3777 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"]), 191, [],
3779 "make ext2/3/4 filesystem with external journal",
3781 This creates an ext2/3/4 filesystem on C<device> with
3782 an external journal on C<journal>. It is equivalent
3785 mke2fs -t fstype -b blocksize -J device=<journal> <device>
3787 See also C<guestfs_mke2journal>.");
3789 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"]), 192, [],
3791 "make ext2/3/4 filesystem with external journal",
3793 This creates an ext2/3/4 filesystem on C<device> with
3794 an external journal on the journal labeled C<label>.
3796 See also C<guestfs_mke2journal_L>.");
3798 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"]), 193, [Optional "linuxfsuuid"],
3800 "make ext2/3/4 filesystem with external journal",
3802 This creates an ext2/3/4 filesystem on C<device> with
3803 an external journal on the journal with UUID C<uuid>.
3805 See also C<guestfs_mke2journal_U>.");
3807 ("modprobe", (RErr, [String "modulename"]), 194, [Optional "linuxmodules"],
3808 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
3809 "load a kernel module",
3811 This loads a kernel module in the appliance.
3813 The kernel module must have been whitelisted when libguestfs
3814 was built (see C<appliance/kmod.whitelist.in> in the source).");
3816 ("echo_daemon", (RString "output", [StringList "words"]), 195, [],
3817 [InitNone, Always, TestOutput (
3818 [["echo_daemon"; "This is a test"]], "This is a test"
3820 "echo arguments back to the client",
3822 This command concatenates the list of C<words> passed with single spaces
3823 between them and returns the resulting string.
3825 You can use this command to test the connection through to the daemon.
3827 See also C<guestfs_ping_daemon>.");
3829 ("find0", (RErr, [Pathname "directory"; FileOut "files"]), 196, [],
3830 [], (* There is a regression test for this. *)
3831 "find all files and directories, returning NUL-separated list",
3833 This command lists out all files and directories, recursively,
3834 starting at C<directory>, placing the resulting list in the
3835 external file called C<files>.
3837 This command works the same way as C<guestfs_find> with the
3838 following exceptions:
3844 The resulting list is written to an external file.
3848 Items (filenames) in the result are separated
3849 by C<\\0> characters. See L<find(1)> option I<-print0>.
3853 This command is not limited in the number of names that it
3858 The result list is not sorted.
3862 ("case_sensitive_path", (RString "rpath", [Pathname "path"]), 197, [],
3863 [InitISOFS, Always, TestOutput (
3864 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
3865 InitISOFS, Always, TestOutput (
3866 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
3867 InitISOFS, Always, TestOutput (
3868 [["case_sensitive_path"; "/Known-1"]], "/known-1");
3869 InitISOFS, Always, TestLastFail (
3870 [["case_sensitive_path"; "/Known-1/"]]);
3871 InitBasicFS, Always, TestOutput (
3873 ["mkdir"; "/a/bbb"];
3874 ["touch"; "/a/bbb/c"];
3875 ["case_sensitive_path"; "/A/bbB/C"]], "/a/bbb/c");
3876 InitBasicFS, Always, TestOutput (
3878 ["mkdir"; "/a/bbb"];
3879 ["touch"; "/a/bbb/c"];
3880 ["case_sensitive_path"; "/A////bbB/C"]], "/a/bbb/c");
3881 InitBasicFS, Always, TestLastFail (
3883 ["mkdir"; "/a/bbb"];
3884 ["touch"; "/a/bbb/c"];
3885 ["case_sensitive_path"; "/A/bbb/../bbb/C"]])],
3886 "return true path on case-insensitive filesystem",
3888 This can be used to resolve case insensitive paths on
3889 a filesystem which is case sensitive. The use case is
3890 to resolve paths which you have read from Windows configuration
3891 files or the Windows Registry, to the true path.
3893 The command handles a peculiarity of the Linux ntfs-3g
3894 filesystem driver (and probably others), which is that although
3895 the underlying filesystem is case-insensitive, the driver
3896 exports the filesystem to Linux as case-sensitive.
3898 One consequence of this is that special directories such
3899 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
3900 (or other things) depending on the precise details of how
3901 they were created. In Windows itself this would not be
3904 Bug or feature? You decide:
3905 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
3907 This function resolves the true case of each element in the
3908 path and returns the case-sensitive path.
3910 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
3911 might return C<\"/WINDOWS/system32\"> (the exact return value
3912 would depend on details of how the directories were originally
3913 created under Windows).
3916 This function does not handle drive names, backslashes etc.
3918 See also C<guestfs_realpath>.");
3920 ("vfs_type", (RString "fstype", [Device "device"]), 198, [],
3921 [InitBasicFS, Always, TestOutput (
3922 [["vfs_type"; "/dev/sda1"]], "ext2")],
3923 "get the Linux VFS type corresponding to a mounted device",
3925 This command gets the filesystem type corresponding to
3926 the filesystem on C<device>.
3928 For most filesystems, the result is the name of the Linux
3929 VFS module which would be used to mount this filesystem
3930 if you mounted it without specifying the filesystem type.
3931 For example a string such as C<ext3> or C<ntfs>.");
3933 ("truncate", (RErr, [Pathname "path"]), 199, [],
3934 [InitBasicFS, Always, TestOutputStruct (
3935 [["write"; "/test"; "some stuff so size is not zero"];
3936 ["truncate"; "/test"];
3937 ["stat"; "/test"]], [CompareWithInt ("size", 0)])],
3938 "truncate a file to zero size",
3940 This command truncates C<path> to a zero-length file. The
3941 file must exist already.");
3943 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"]), 200, [],
3944 [InitBasicFS, Always, TestOutputStruct (
3945 [["touch"; "/test"];
3946 ["truncate_size"; "/test"; "1000"];
3947 ["stat"; "/test"]], [CompareWithInt ("size", 1000)])],
3948 "truncate a file to a particular size",
3950 This command truncates C<path> to size C<size> bytes. The file
3953 If the current file size is less than C<size> then
3954 the file is extended to the required size with zero bytes.
3955 This creates a sparse file (ie. disk blocks are not allocated
3956 for the file until you write to it). To create a non-sparse
3957 file of zeroes, use C<guestfs_fallocate64> instead.");
3959 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"]), 201, [],
3960 [InitBasicFS, Always, TestOutputStruct (
3961 [["touch"; "/test"];
3962 ["utimens"; "/test"; "12345"; "67890"; "9876"; "5432"];
3963 ["stat"; "/test"]], [CompareWithInt ("mtime", 9876)])],
3964 "set timestamp of a file with nanosecond precision",
3966 This command sets the timestamps of a file with nanosecond
3969 C<atsecs, atnsecs> are the last access time (atime) in secs and
3970 nanoseconds from the epoch.
3972 C<mtsecs, mtnsecs> are the last modification time (mtime) in
3973 secs and nanoseconds from the epoch.
3975 If the C<*nsecs> field contains the special value C<-1> then
3976 the corresponding timestamp is set to the current time. (The
3977 C<*secs> field is ignored in this case).
3979 If the C<*nsecs> field contains the special value C<-2> then
3980 the corresponding timestamp is left unchanged. (The
3981 C<*secs> field is ignored in this case).");
3983 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"]), 202, [],
3984 [InitBasicFS, Always, TestOutputStruct (
3985 [["mkdir_mode"; "/test"; "0o111"];
3986 ["stat"; "/test"]], [CompareWithInt ("mode", 0o40111)])],
3987 "create a directory with a particular mode",
3989 This command creates a directory, setting the initial permissions
3990 of the directory to C<mode>.
3992 For common Linux filesystems, the actual mode which is set will
3993 be C<mode & ~umask & 01777>. Non-native-Linux filesystems may
3994 interpret the mode in other ways.
3996 See also C<guestfs_mkdir>, C<guestfs_umask>");
3998 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"]), 203, [],
4000 "change file owner and group",
4002 Change the file owner to C<owner> and group to C<group>.
4003 This is like C<guestfs_chown> but if C<path> is a symlink then
4004 the link itself is changed, not the target.
4006 Only numeric uid and gid are supported. If you want to use
4007 names, you will need to locate and parse the password file
4008 yourself (Augeas support makes this relatively easy).");
4010 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"]), 204, [],
4012 "lstat on multiple files",
4014 This call allows you to perform the C<guestfs_lstat> operation
4015 on multiple files, where all files are in the directory C<path>.
4016 C<names> is the list of files from this directory.
4018 On return you get a list of stat structs, with a one-to-one
4019 correspondence to the C<names> list. If any name did not exist
4020 or could not be lstat'd, then the C<ino> field of that structure
4023 This call is intended for programs that want to efficiently
4024 list a directory contents without making many round-trips.
4025 See also C<guestfs_lxattrlist> for a similarly efficient call
4026 for getting extended attributes. Very long directory listings
4027 might cause the protocol message size to be exceeded, causing
4028 this call to fail. The caller must split up such requests
4029 into smaller groups of names.");
4031 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"]), 205, [Optional "linuxxattrs"],
4033 "lgetxattr on multiple files",
4035 This call allows you to get the extended attributes
4036 of multiple files, where all files are in the directory C<path>.
4037 C<names> is the list of files from this directory.
4039 On return you get a flat list of xattr structs which must be
4040 interpreted sequentially. The first xattr struct always has a zero-length
4041 C<attrname>. C<attrval> in this struct is zero-length
4042 to indicate there was an error doing C<lgetxattr> for this
4043 file, I<or> is a C string which is a decimal number
4044 (the number of following attributes for this file, which could
4045 be C<\"0\">). Then after the first xattr struct are the
4046 zero or more attributes for the first named file.
4047 This repeats for the second and subsequent files.
4049 This call is intended for programs that want to efficiently
4050 list a directory contents without making many round-trips.
4051 See also C<guestfs_lstatlist> for a similarly efficient call
4052 for getting standard stats. Very long directory listings
4053 might cause the protocol message size to be exceeded, causing
4054 this call to fail. The caller must split up such requests
4055 into smaller groups of names.");
4057 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"]), 206, [],
4059 "readlink on multiple files",
4061 This call allows you to do a C<readlink> operation
4062 on multiple files, where all files are in the directory C<path>.
4063 C<names> is the list of files from this directory.
4065 On return you get a list of strings, with a one-to-one
4066 correspondence to the C<names> list. Each string is the
4067 value of the symbolic link.
4069 If the C<readlink(2)> operation fails on any name, then
4070 the corresponding result string is the empty string C<\"\">.
4071 However the whole operation is completed even if there
4072 were C<readlink(2)> errors, and so you can call this
4073 function with names where you don't know if they are
4074 symbolic links already (albeit slightly less efficient).
4076 This call is intended for programs that want to efficiently
4077 list a directory contents without making many round-trips.
4078 Very long directory listings might cause the protocol
4079 message size to be exceeded, causing
4080 this call to fail. The caller must split up such requests
4081 into smaller groups of names.");
4083 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"]), 207, [ProtocolLimitWarning],
4084 [InitISOFS, Always, TestOutputBuffer (
4085 [["pread"; "/known-4"; "1"; "3"]], "\n");
4086 InitISOFS, Always, TestOutputBuffer (
4087 [["pread"; "/empty"; "0"; "100"]], "")],
4088 "read part of a file",
4090 This command lets you read part of a file. It reads C<count>
4091 bytes of the file, starting at C<offset>, from file C<path>.
4093 This may read fewer bytes than requested. For further details
4094 see the L<pread(2)> system call.
4096 See also C<guestfs_pwrite>.");
4098 ("part_init", (RErr, [Device "device"; String "parttype"]), 208, [],
4099 [InitEmpty, Always, TestRun (
4100 [["part_init"; "/dev/sda"; "gpt"]])],
4101 "create an empty partition table",
4103 This creates an empty partition table on C<device> of one of the
4104 partition types listed below. Usually C<parttype> should be
4105 either C<msdos> or C<gpt> (for large disks).
4107 Initially there are no partitions. Following this, you should
4108 call C<guestfs_part_add> for each partition required.
4110 Possible values for C<parttype> are:
4114 =item B<efi> | B<gpt>
4116 Intel EFI / GPT partition table.
4118 This is recommended for >= 2 TB partitions that will be accessed
4119 from Linux and Intel-based Mac OS X. It also has limited backwards
4120 compatibility with the C<mbr> format.
4122 =item B<mbr> | B<msdos>
4124 The standard PC \"Master Boot Record\" (MBR) format used
4125 by MS-DOS and Windows. This partition type will B<only> work
4126 for device sizes up to 2 TB. For large disks we recommend
4131 Other partition table types that may work but are not
4140 =item B<amiga> | B<rdb>
4142 Amiga \"Rigid Disk Block\" format.
4150 DASD, used on IBM mainframes.
4158 Old Mac partition format. Modern Macs use C<gpt>.
4162 NEC PC-98 format, common in Japan apparently.
4170 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"]), 209, [],
4171 [InitEmpty, Always, TestRun (
4172 [["part_init"; "/dev/sda"; "mbr"];
4173 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
4174 InitEmpty, Always, TestRun (
4175 [["part_init"; "/dev/sda"; "gpt"];
4176 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
4177 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4178 InitEmpty, Always, TestRun (
4179 [["part_init"; "/dev/sda"; "mbr"];
4180 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4181 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4182 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4183 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4184 "add a partition to the device",
4186 This command adds a partition to C<device>. If there is no partition
4187 table on the device, call C<guestfs_part_init> first.
4189 The C<prlogex> parameter is the type of partition. Normally you
4190 should pass C<p> or C<primary> here, but MBR partition tables also
4191 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4194 C<startsect> and C<endsect> are the start and end of the partition
4195 in I<sectors>. C<endsect> may be negative, which means it counts
4196 backwards from the end of the disk (C<-1> is the last sector).
4198 Creating a partition which covers the whole disk is not so easy.
4199 Use C<guestfs_part_disk> to do that.");
4201 ("part_disk", (RErr, [Device "device"; String "parttype"]), 210, [DangerWillRobinson],
4202 [InitEmpty, Always, TestRun (
4203 [["part_disk"; "/dev/sda"; "mbr"]]);
4204 InitEmpty, Always, TestRun (
4205 [["part_disk"; "/dev/sda"; "gpt"]])],
4206 "partition whole disk with a single primary partition",
4208 This command is simply a combination of C<guestfs_part_init>
4209 followed by C<guestfs_part_add> to create a single primary partition
4210 covering the whole disk.
4212 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
4213 but other possible values are described in C<guestfs_part_init>.");
4215 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"]), 211, [],
4216 [InitEmpty, Always, TestRun (
4217 [["part_disk"; "/dev/sda"; "mbr"];
4218 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
4219 "make a partition bootable",
4221 This sets the bootable flag on partition numbered C<partnum> on
4222 device C<device>. Note that partitions are numbered from 1.
4224 The bootable flag is used by some operating systems (notably
4225 Windows) to determine which partition to boot from. It is by
4226 no means universally recognized.");
4228 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"]), 212, [],
4229 [InitEmpty, Always, TestRun (
4230 [["part_disk"; "/dev/sda"; "gpt"];
4231 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
4232 "set partition name",
4234 This sets the partition name on partition numbered C<partnum> on
4235 device C<device>. Note that partitions are numbered from 1.
4237 The partition name can only be set on certain types of partition
4238 table. This works on C<gpt> but not on C<mbr> partitions.");
4240 ("part_list", (RStructList ("partitions", "partition"), [Device "device"]), 213, [],
4241 [], (* XXX Add a regression test for this. *)
4242 "list partitions on a device",
4244 This command parses the partition table on C<device> and
4245 returns the list of partitions found.
4247 The fields in the returned structure are:
4253 Partition number, counting from 1.
4257 Start of the partition I<in bytes>. To get sectors you have to
4258 divide by the device's sector size, see C<guestfs_blockdev_getss>.
4262 End of the partition in bytes.
4266 Size of the partition in bytes.
4270 ("part_get_parttype", (RString "parttype", [Device "device"]), 214, [],
4271 [InitEmpty, Always, TestOutput (
4272 [["part_disk"; "/dev/sda"; "gpt"];
4273 ["part_get_parttype"; "/dev/sda"]], "gpt")],
4274 "get the partition table type",
4276 This command examines the partition table on C<device> and
4277 returns the partition table type (format) being used.
4279 Common return values include: C<msdos> (a DOS/Windows style MBR
4280 partition table), C<gpt> (a GPT/EFI-style partition table). Other
4281 values are possible, although unusual. See C<guestfs_part_init>
4284 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"]), 215, [],
4285 [InitBasicFS, Always, TestOutputBuffer (
4286 [["fill"; "0x63"; "10"; "/test"];
4287 ["read_file"; "/test"]], "cccccccccc")],
4288 "fill a file with octets",
4290 This command creates a new file called C<path>. The initial
4291 content of the file is C<len> octets of C<c>, where C<c>
4292 must be a number in the range C<[0..255]>.
4294 To fill a file with zero bytes (sparsely), it is
4295 much more efficient to use C<guestfs_truncate_size>.
4296 To create a file with a pattern of repeating bytes
4297 use C<guestfs_fill_pattern>.");
4299 ("available", (RErr, [StringList "groups"]), 216, [],
4300 [InitNone, Always, TestRun [["available"; ""]]],
4301 "test availability of some parts of the API",
4303 This command is used to check the availability of some
4304 groups of functionality in the appliance, which not all builds of
4305 the libguestfs appliance will be able to provide.
4307 The libguestfs groups, and the functions that those
4308 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
4309 You can also fetch this list at runtime by calling
4310 C<guestfs_available_all_groups>.
4312 The argument C<groups> is a list of group names, eg:
4313 C<[\"inotify\", \"augeas\"]> would check for the availability of
4314 the Linux inotify functions and Augeas (configuration file
4317 The command returns no error if I<all> requested groups are available.
4319 It fails with an error if one or more of the requested
4320 groups is unavailable in the appliance.
4322 If an unknown group name is included in the
4323 list of groups then an error is always returned.
4331 You must call C<guestfs_launch> before calling this function.
4333 The reason is because we don't know what groups are
4334 supported by the appliance/daemon until it is running and can
4339 If a group of functions is available, this does not necessarily
4340 mean that they will work. You still have to check for errors
4341 when calling individual API functions even if they are
4346 It is usually the job of distro packagers to build
4347 complete functionality into the libguestfs appliance.
4348 Upstream libguestfs, if built from source with all
4349 requirements satisfied, will support everything.
4353 This call was added in version C<1.0.80>. In previous
4354 versions of libguestfs all you could do would be to speculatively
4355 execute a command to find out if the daemon implemented it.
4356 See also C<guestfs_version>.
4360 ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"]), 217, [],
4361 [InitBasicFS, Always, TestOutputBuffer (
4362 [["write"; "/src"; "hello, world"];
4363 ["dd"; "/src"; "/dest"];
4364 ["read_file"; "/dest"]], "hello, world")],
4365 "copy from source to destination using dd",
4367 This command copies from one source device or file C<src>
4368 to another destination device or file C<dest>. Normally you
4369 would use this to copy to or from a device or partition, for
4370 example to duplicate a filesystem.
4372 If the destination is a device, it must be as large or larger
4373 than the source file or device, otherwise the copy will fail.
4374 This command cannot do partial copies (see C<guestfs_copy_size>).");
4376 ("filesize", (RInt64 "size", [Pathname "file"]), 218, [],
4377 [InitBasicFS, Always, TestOutputInt (
4378 [["write"; "/file"; "hello, world"];
4379 ["filesize"; "/file"]], 12)],
4380 "return the size of the file in bytes",
4382 This command returns the size of C<file> in bytes.
4384 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
4385 C<guestfs_is_dir>, C<guestfs_is_file> etc.
4386 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
4388 ("lvrename", (RErr, [String "logvol"; String "newlogvol"]), 219, [],
4389 [InitBasicFSonLVM, Always, TestOutputList (
4390 [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
4391 ["lvs"]], ["/dev/VG/LV2"])],
4392 "rename an LVM logical volume",
4394 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
4396 ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"]), 220, [],
4397 [InitBasicFSonLVM, Always, TestOutputList (
4399 ["vg_activate"; "false"; "VG"];
4400 ["vgrename"; "VG"; "VG2"];
4401 ["vg_activate"; "true"; "VG2"];
4402 ["mount_options"; ""; "/dev/VG2/LV"; "/"];
4403 ["vgs"]], ["VG2"])],
4404 "rename an LVM volume group",
4406 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
4408 ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"]), 221, [ProtocolLimitWarning],
4409 [InitISOFS, Always, TestOutputBuffer (
4410 [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
4411 "list the contents of a single file in an initrd",
4413 This command unpacks the file C<filename> from the initrd file
4414 called C<initrdpath>. The filename must be given I<without> the
4415 initial C</> character.
4417 For example, in guestfish you could use the following command
4418 to examine the boot script (usually called C</init>)
4419 contained in a Linux initrd or initramfs image:
4421 initrd-cat /boot/initrd-<version>.img init
4423 See also C<guestfs_initrd_list>.");
4425 ("pvuuid", (RString "uuid", [Device "device"]), 222, [],
4427 "get the UUID of a physical volume",
4429 This command returns the UUID of the LVM PV C<device>.");
4431 ("vguuid", (RString "uuid", [String "vgname"]), 223, [],
4433 "get the UUID of a volume group",
4435 This command returns the UUID of the LVM VG named C<vgname>.");
4437 ("lvuuid", (RString "uuid", [Device "device"]), 224, [],
4439 "get the UUID of a logical volume",
4441 This command returns the UUID of the LVM LV C<device>.");
4443 ("vgpvuuids", (RStringList "uuids", [String "vgname"]), 225, [],
4445 "get the PV UUIDs containing the volume group",
4447 Given a VG called C<vgname>, this returns the UUIDs of all
4448 the physical volumes that this volume group resides on.
4450 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
4451 calls to associate physical volumes and volume groups.
4453 See also C<guestfs_vglvuuids>.");
4455 ("vglvuuids", (RStringList "uuids", [String "vgname"]), 226, [],
4457 "get the LV UUIDs of all LVs in the volume group",
4459 Given a VG called C<vgname>, this returns the UUIDs of all
4460 the logical volumes created in this volume group.
4462 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
4463 calls to associate logical volumes and volume groups.
4465 See also C<guestfs_vgpvuuids>.");
4467 ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"]), 227, [],
4468 [InitBasicFS, Always, TestOutputBuffer (
4469 [["write"; "/src"; "hello, world"];
4470 ["copy_size"; "/src"; "/dest"; "5"];
4471 ["read_file"; "/dest"]], "hello")],
4472 "copy size bytes from source to destination using dd",
4474 This command copies exactly C<size> bytes from one source device
4475 or file C<src> to another destination device or file C<dest>.
4477 Note this will fail if the source is too short or if the destination
4478 is not large enough.");
4480 ("zero_device", (RErr, [Device "device"]), 228, [DangerWillRobinson],
4481 [InitBasicFSonLVM, Always, TestRun (
4482 [["zero_device"; "/dev/VG/LV"]])],
4483 "write zeroes to an entire device",
4485 This command writes zeroes over the entire C<device>. Compare
4486 with C<guestfs_zero> which just zeroes the first few blocks of
4489 ("txz_in", (RErr, [FileIn "tarball"; Pathname "directory"]), 229, [Optional "xz"],
4490 [InitBasicFS, Always, TestOutput (
4491 [["txz_in"; "../images/helloworld.tar.xz"; "/"];
4492 ["cat"; "/hello"]], "hello\n")],
4493 "unpack compressed tarball to directory",
4495 This command uploads and unpacks local file C<tarball> (an
4496 I<xz compressed> tar file) into C<directory>.");
4498 ("txz_out", (RErr, [Pathname "directory"; FileOut "tarball"]), 230, [Optional "xz"],
4500 "pack directory into compressed tarball",
4502 This command packs the contents of C<directory> and downloads
4503 it to local file C<tarball> (as an xz compressed tar archive).");
4505 ("ntfsresize", (RErr, [Device "device"]), 231, [Optional "ntfsprogs"],
4507 "resize an NTFS filesystem",
4509 This command resizes an NTFS filesystem, expanding or
4510 shrinking it to the size of the underlying device.
4511 See also L<ntfsresize(8)>.");
4513 ("vgscan", (RErr, []), 232, [],
4514 [InitEmpty, Always, TestRun (
4516 "rescan for LVM physical volumes, volume groups and logical volumes",
4518 This rescans all block devices and rebuilds the list of LVM
4519 physical volumes, volume groups and logical volumes.");
4521 ("part_del", (RErr, [Device "device"; Int "partnum"]), 233, [],
4522 [InitEmpty, Always, TestRun (
4523 [["part_init"; "/dev/sda"; "mbr"];
4524 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4525 ["part_del"; "/dev/sda"; "1"]])],
4526 "delete a partition",
4528 This command deletes the partition numbered C<partnum> on C<device>.
4530 Note that in the case of MBR partitioning, deleting an
4531 extended partition also deletes any logical partitions
4534 ("part_get_bootable", (RBool "bootable", [Device "device"; Int "partnum"]), 234, [],
4535 [InitEmpty, Always, TestOutputTrue (
4536 [["part_init"; "/dev/sda"; "mbr"];
4537 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4538 ["part_set_bootable"; "/dev/sda"; "1"; "true"];
4539 ["part_get_bootable"; "/dev/sda"; "1"]])],
4540 "return true if a partition is bootable",
4542 This command returns true if the partition C<partnum> on
4543 C<device> has the bootable flag set.
4545 See also C<guestfs_part_set_bootable>.");
4547 ("part_get_mbr_id", (RInt "idbyte", [Device "device"; Int "partnum"]), 235, [FishOutput FishOutputHexadecimal],
4548 [InitEmpty, Always, TestOutputInt (
4549 [["part_init"; "/dev/sda"; "mbr"];
4550 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4551 ["part_set_mbr_id"; "/dev/sda"; "1"; "0x7f"];
4552 ["part_get_mbr_id"; "/dev/sda"; "1"]], 0x7f)],
4553 "get the MBR type byte (ID byte) from a partition",
4555 Returns the MBR type byte (also known as the ID byte) from
4556 the numbered partition C<partnum>.
4558 Note that only MBR (old DOS-style) partitions have type bytes.
4559 You will get undefined results for other partition table
4560 types (see C<guestfs_part_get_parttype>).");
4562 ("part_set_mbr_id", (RErr, [Device "device"; Int "partnum"; Int "idbyte"]), 236, [],
4563 [], (* tested by part_get_mbr_id *)
4564 "set the MBR type byte (ID byte) of a partition",
4566 Sets the MBR type byte (also known as the ID byte) of
4567 the numbered partition C<partnum> to C<idbyte>. Note
4568 that the type bytes quoted in most documentation are
4569 in fact hexadecimal numbers, but usually documented
4570 without any leading \"0x\" which might be confusing.
4572 Note that only MBR (old DOS-style) partitions have type bytes.
4573 You will get undefined results for other partition table
4574 types (see C<guestfs_part_get_parttype>).");
4576 ("checksum_device", (RString "checksum", [String "csumtype"; Device "device"]), 237, [],
4577 [InitISOFS, Always, TestOutput (
4578 [["checksum_device"; "md5"; "/dev/sdd"]],
4579 (Digest.to_hex (Digest.file "images/test.iso")))],
4580 "compute MD5, SHAx or CRC checksum of the contents of a device",
4582 This call computes the MD5, SHAx or CRC checksum of the
4583 contents of the device named C<device>. For the types of
4584 checksums supported see the C<guestfs_checksum> command.");
4586 ("lvresize_free", (RErr, [Device "lv"; Int "percent"]), 238, [Optional "lvm2"],
4587 [InitNone, Always, TestRun (
4588 [["part_disk"; "/dev/sda"; "mbr"];
4589 ["pvcreate"; "/dev/sda1"];
4590 ["vgcreate"; "VG"; "/dev/sda1"];
4591 ["lvcreate"; "LV"; "VG"; "10"];
4592 ["lvresize_free"; "/dev/VG/LV"; "100"]])],
4593 "expand an LV to fill free space",
4595 This expands an existing logical volume C<lv> so that it fills
4596 C<pc>% of the remaining free space in the volume group. Commonly
4597 you would call this with pc = 100 which expands the logical volume
4598 as much as possible, using all remaining free space in the volume
4601 ("aug_clear", (RErr, [String "augpath"]), 239, [Optional "augeas"],
4602 [], (* XXX Augeas code needs tests. *)
4603 "clear Augeas path",
4605 Set the value associated with C<path> to C<NULL>. This
4606 is the same as the L<augtool(1)> C<clear> command.");
4608 ("get_umask", (RInt "mask", []), 240, [FishOutput FishOutputOctal],
4609 [InitEmpty, Always, TestOutputInt (
4610 [["get_umask"]], 0o22)],
4611 "get the current umask",
4613 Return the current umask. By default the umask is C<022>
4614 unless it has been set by calling C<guestfs_umask>.");
4616 ("debug_upload", (RErr, [FileIn "filename"; String "tmpname"; Int "mode"]), 241, [],
4618 "upload a file to the appliance (internal use only)",
4620 The C<guestfs_debug_upload> command uploads a file to
4621 the libguestfs appliance.
4623 There is no comprehensive help for this command. You have
4624 to look at the file C<daemon/debug.c> in the libguestfs source
4625 to find out what it is for.");
4627 ("base64_in", (RErr, [FileIn "base64file"; Pathname "filename"]), 242, [],
4628 [InitBasicFS, Always, TestOutput (
4629 [["base64_in"; "../images/hello.b64"; "/hello"];
4630 ["cat"; "/hello"]], "hello\n")],
4631 "upload base64-encoded data to file",
4633 This command uploads base64-encoded data from C<base64file>
4636 ("base64_out", (RErr, [Pathname "filename"; FileOut "base64file"]), 243, [],
4638 "download file and encode as base64",
4640 This command downloads the contents of C<filename>, writing
4641 it out to local file C<base64file> encoded as base64.");
4643 ("checksums_out", (RErr, [String "csumtype"; Pathname "directory"; FileOut "sumsfile"]), 244, [],
4645 "compute MD5, SHAx or CRC checksum of files in a directory",
4647 This command computes the checksums of all regular files in
4648 C<directory> and then emits a list of those checksums to
4649 the local output file C<sumsfile>.
4651 This can be used for verifying the integrity of a virtual
4652 machine. However to be properly secure you should pay
4653 attention to the output of the checksum command (it uses
4654 the ones from GNU coreutils). In particular when the
4655 filename is not printable, coreutils uses a special
4656 backslash syntax. For more information, see the GNU
4657 coreutils info file.");
4659 ("fill_pattern", (RErr, [String "pattern"; Int "len"; Pathname "path"]), 245, [],
4660 [InitBasicFS, Always, TestOutputBuffer (
4661 [["fill_pattern"; "abcdefghijklmnopqrstuvwxyz"; "28"; "/test"];
4662 ["read_file"; "/test"]], "abcdefghijklmnopqrstuvwxyzab")],
4663 "fill a file with a repeating pattern of bytes",
4665 This function is like C<guestfs_fill> except that it creates
4666 a new file of length C<len> containing the repeating pattern
4667 of bytes in C<pattern>. The pattern is truncated if necessary
4668 to ensure the length of the file is exactly C<len> bytes.");
4670 ("write", (RErr, [Pathname "path"; BufferIn "content"]), 246, [ProtocolLimitWarning],
4671 [InitBasicFS, Always, TestOutput (
4672 [["write"; "/new"; "new file contents"];
4673 ["cat"; "/new"]], "new file contents");
4674 InitBasicFS, Always, TestOutput (
4675 [["write"; "/new"; "\nnew file contents\n"];
4676 ["cat"; "/new"]], "\nnew file contents\n");
4677 InitBasicFS, Always, TestOutput (
4678 [["write"; "/new"; "\n\n"];
4679 ["cat"; "/new"]], "\n\n");
4680 InitBasicFS, Always, TestOutput (
4681 [["write"; "/new"; ""];
4682 ["cat"; "/new"]], "");
4683 InitBasicFS, Always, TestOutput (
4684 [["write"; "/new"; "\n\n\n"];
4685 ["cat"; "/new"]], "\n\n\n");
4686 InitBasicFS, Always, TestOutput (
4687 [["write"; "/new"; "\n"];
4688 ["cat"; "/new"]], "\n")],
4689 "create a new file",
4691 This call creates a file called C<path>. The content of the
4692 file is the string C<content> (which can contain any 8 bit data).");
4694 ("pwrite", (RInt "nbytes", [Pathname "path"; BufferIn "content"; Int64 "offset"]), 247, [ProtocolLimitWarning],
4695 [InitBasicFS, Always, TestOutput (
4696 [["write"; "/new"; "new file contents"];
4697 ["pwrite"; "/new"; "data"; "4"];
4698 ["cat"; "/new"]], "new data contents");
4699 InitBasicFS, Always, TestOutput (
4700 [["write"; "/new"; "new file contents"];
4701 ["pwrite"; "/new"; "is extended"; "9"];
4702 ["cat"; "/new"]], "new file is extended");
4703 InitBasicFS, Always, TestOutput (
4704 [["write"; "/new"; "new file contents"];
4705 ["pwrite"; "/new"; ""; "4"];
4706 ["cat"; "/new"]], "new file contents")],
4707 "write to part of a file",
4709 This command writes to part of a file. It writes the data
4710 buffer C<content> to the file C<path> starting at offset C<offset>.
4712 This command implements the L<pwrite(2)> system call, and like
4713 that system call it may not write the full data requested. The
4714 return value is the number of bytes that were actually written
4715 to the file. This could even be 0, although short writes are
4716 unlikely for regular files in ordinary circumstances.
4718 See also C<guestfs_pread>.");
4720 ("resize2fs_size", (RErr, [Device "device"; Int64 "size"]), 248, [],
4722 "resize an ext2, ext3 or ext4 filesystem (with size)",
4724 This command is the same as C<guestfs_resize2fs> except that it
4725 allows you to specify the new size (in bytes) explicitly.");
4727 ("pvresize_size", (RErr, [Device "device"; Int64 "size"]), 249, [Optional "lvm2"],
4729 "resize an LVM physical volume (with size)",
4731 This command is the same as C<guestfs_pvresize> except that it
4732 allows you to specify the new size (in bytes) explicitly.");
4734 ("ntfsresize_size", (RErr, [Device "device"; Int64 "size"]), 250, [Optional "ntfsprogs"],
4736 "resize an NTFS filesystem (with size)",
4738 This command is the same as C<guestfs_ntfsresize> except that it
4739 allows you to specify the new size (in bytes) explicitly.");
4741 ("available_all_groups", (RStringList "groups", []), 251, [],
4742 [InitNone, Always, TestRun [["available_all_groups"]]],
4743 "return a list of all optional groups",
4745 This command returns a list of all optional groups that this
4746 daemon knows about. Note this returns both supported and unsupported
4747 groups. To find out which ones the daemon can actually support
4748 you have to call C<guestfs_available> on each member of the
4751 See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>.");
4753 ("fallocate64", (RErr, [Pathname "path"; Int64 "len"]), 252, [],
4754 [InitBasicFS, Always, TestOutputStruct (
4755 [["fallocate64"; "/a"; "1000000"];
4756 ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
4757 "preallocate a file in the guest filesystem",
4759 This command preallocates a file (containing zero bytes) named
4760 C<path> of size C<len> bytes. If the file exists already, it
4763 Note that this call allocates disk blocks for the file.
4764 To create a sparse file use C<guestfs_truncate_size> instead.
4766 The deprecated call C<guestfs_fallocate> does the same,
4767 but owing to an oversight it only allowed 30 bit lengths
4768 to be specified, effectively limiting the maximum size
4769 of files created through that call to 1GB.
4771 Do not confuse this with the guestfish-specific
4772 C<alloc> and C<sparse> commands which create
4773 a file in the host and attach it as a device.");
4775 ("vfs_label", (RString "label", [Device "device"]), 253, [],
4776 [InitBasicFS, Always, TestOutput (
4777 [["set_e2label"; "/dev/sda1"; "LTEST"];
4778 ["vfs_label"; "/dev/sda1"]], "LTEST")],
4779 "get the filesystem label",
4781 This returns the filesystem label of the filesystem on
4784 If the filesystem is unlabeled, this returns the empty string.");
4786 ("vfs_uuid", (RString "uuid", [Device "device"]), 254, [],
4787 (let uuid = uuidgen () in
4788 [InitBasicFS, Always, TestOutput (
4789 [["set_e2uuid"; "/dev/sda1"; uuid];
4790 ["vfs_uuid"; "/dev/sda1"]], uuid)]),
4791 "get the filesystem UUID",
4793 This returns the filesystem UUID of the filesystem on
4796 If the filesystem does not have a UUID, this returns the empty string.");
4800 let all_functions = non_daemon_functions @ daemon_functions
4802 (* In some places we want the functions to be displayed sorted
4803 * alphabetically, so this is useful:
4805 let all_functions_sorted =
4806 List.sort (fun (n1,_,_,_,_,_,_) (n2,_,_,_,_,_,_) ->
4807 compare n1 n2) all_functions
4809 (* This is used to generate the src/MAX_PROC_NR file which
4810 * contains the maximum procedure number, a surrogate for the
4811 * ABI version number. See src/Makefile.am for the details.
4814 let proc_nrs = List.map (
4815 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
4816 ) daemon_functions in
4817 List.fold_left max 0 proc_nrs
4819 (* Field types for structures. *)
4821 | FChar (* C 'char' (really, a 7 bit byte). *)
4822 | FString (* nul-terminated ASCII string, NOT NULL. *)
4823 | FBuffer (* opaque buffer of bytes, (char *, int) pair *)
4828 | FBytes (* Any int measure that counts bytes. *)
4829 | FUUID (* 32 bytes long, NOT nul-terminated. *)
4830 | FOptPercent (* [0..100], or -1 meaning "not present". *)
4832 (* Because we generate extra parsing code for LVM command line tools,
4833 * we have to pull out the LVM columns separately here.
4843 "pv_attr", FString (* XXX *);
4844 "pv_pe_count", FInt64;
4845 "pv_pe_alloc_count", FInt64;
4848 "pv_mda_count", FInt64;
4849 "pv_mda_free", FBytes;
4850 (* Not in Fedora 10:
4851 "pv_mda_size", FBytes;
4858 "vg_attr", FString (* XXX *);
4861 "vg_sysid", FString;
4862 "vg_extent_size", FBytes;
4863 "vg_extent_count", FInt64;
4864 "vg_free_count", FInt64;
4869 "snap_count", FInt64;
4872 "vg_mda_count", FInt64;
4873 "vg_mda_free", FBytes;
4874 (* Not in Fedora 10:
4875 "vg_mda_size", FBytes;
4881 "lv_attr", FString (* XXX *);
4884 "lv_kernel_major", FInt64;
4885 "lv_kernel_minor", FInt64;
4887 "seg_count", FInt64;
4889 "snap_percent", FOptPercent;
4890 "copy_percent", FOptPercent;
4893 "mirror_log", FString;
4897 (* Names and fields in all structures (in RStruct and RStructList)
4901 (* The old RIntBool return type, only ever used for aug_defnode. Do
4902 * not use this struct in any new code.
4905 "i", FInt32; (* for historical compatibility *)
4906 "b", FInt32; (* for historical compatibility *)
4909 (* LVM PVs, VGs, LVs. *)
4910 "lvm_pv", lvm_pv_cols;
4911 "lvm_vg", lvm_vg_cols;
4912 "lvm_lv", lvm_lv_cols;
4914 (* Column names and types from stat structures.
4915 * NB. Can't use things like 'st_atime' because glibc header files
4916 * define some of these as macros. Ugh.
4947 (* Column names in dirent structure. *)
4950 (* 'b' 'c' 'd' 'f' (FIFO) 'l' 'r' (regular file) 's' 'u' '?' *)
4955 (* Version numbers. *)
4963 (* Extended attribute. *)
4965 "attrname", FString;
4969 (* Inotify events. *)
4973 "in_cookie", FUInt32;
4977 (* Partition table entry. *)
4980 "part_start", FBytes;
4982 "part_size", FBytes;
4984 ] (* end of structs *)
4986 (* Ugh, Java has to be different ..
4987 * These names are also used by the Haskell bindings.
4989 let java_structs = [
4990 "int_bool", "IntBool";
4995 "statvfs", "StatVFS";
4997 "version", "Version";
4999 "inotify_event", "INotifyEvent";
5000 "partition", "Partition";
5003 (* What structs are actually returned. *)
5004 type rstructs_used_t = RStructOnly | RStructListOnly | RStructAndList
5006 (* Returns a list of RStruct/RStructList structs that are returned
5007 * by any function. Each element of returned list is a pair:
5009 * (structname, RStructOnly)
5010 * == there exists function which returns RStruct (_, structname)
5011 * (structname, RStructListOnly)
5012 * == there exists function which returns RStructList (_, structname)
5013 * (structname, RStructAndList)
5014 * == there are functions returning both RStruct (_, structname)
5015 * and RStructList (_, structname)
5017 let rstructs_used_by functions =
5018 (* ||| is a "logical OR" for rstructs_used_t *)
5022 | _, RStructAndList -> RStructAndList
5023 | RStructOnly, RStructListOnly
5024 | RStructListOnly, RStructOnly -> RStructAndList
5025 | RStructOnly, RStructOnly -> RStructOnly
5026 | RStructListOnly, RStructListOnly -> RStructListOnly
5029 let h = Hashtbl.create 13 in
5031 (* if elem->oldv exists, update entry using ||| operator,
5032 * else just add elem->newv to the hash
5034 let update elem newv =
5035 try let oldv = Hashtbl.find h elem in
5036 Hashtbl.replace h elem (newv ||| oldv)
5037 with Not_found -> Hashtbl.add h elem newv
5041 fun (_, style, _, _, _, _, _) ->
5042 match fst style with
5043 | RStruct (_, structname) -> update structname RStructOnly
5044 | RStructList (_, structname) -> update structname RStructListOnly
5048 (* return key->values as a list of (key,value) *)
5049 Hashtbl.fold (fun key value xs -> (key, value) :: xs) h []
5051 (* Used for testing language bindings. *)
5053 | CallString of string
5054 | CallOptString of string option
5055 | CallStringList of string list
5057 | CallInt64 of int64
5059 | CallBuffer of string
5061 (* Used to memoize the result of pod2text. *)
5062 let pod2text_memo_filename = "src/.pod2text.data"
5063 let pod2text_memo : ((int * string * string), string list) Hashtbl.t =
5065 let chan = open_in pod2text_memo_filename in
5066 let v = input_value chan in
5070 _ -> Hashtbl.create 13
5071 let pod2text_memo_updated () =
5072 let chan = open_out pod2text_memo_filename in
5073 output_value chan pod2text_memo;
5076 (* Useful functions.
5077 * Note we don't want to use any external OCaml libraries which
5078 * makes this a bit harder than it should be.
5080 module StringMap = Map.Make (String)
5082 let failwithf fs = ksprintf failwith fs
5084 let unique = let i = ref 0 in fun () -> incr i; !i
5086 let replace_char s c1 c2 =
5087 let s2 = String.copy s in
5088 let r = ref false in
5089 for i = 0 to String.length s2 - 1 do
5090 if String.unsafe_get s2 i = c1 then (
5091 String.unsafe_set s2 i c2;
5095 if not !r then s else s2
5099 (* || c = '\f' *) || c = '\n' || c = '\r' || c = '\t' (* || c = '\v' *)
5101 let triml ?(test = isspace) str =
5103 let n = ref (String.length str) in
5104 while !n > 0 && test str.[!i]; do
5109 else String.sub str !i !n
5111 let trimr ?(test = isspace) str =
5112 let n = ref (String.length str) in
5113 while !n > 0 && test str.[!n-1]; do
5116 if !n = String.length str then str
5117 else String.sub str 0 !n
5119 let trim ?(test = isspace) str =
5120 trimr ~test (triml ~test str)
5122 let rec find s sub =
5123 let len = String.length s in
5124 let sublen = String.length sub in
5126 if i <= len-sublen then (
5128 if j < sublen then (
5129 if s.[i+j] = sub.[j] then loop2 (j+1)
5135 if r = -1 then loop (i+1) else r
5141 let rec replace_str s s1 s2 =
5142 let len = String.length s in
5143 let sublen = String.length s1 in
5144 let i = find s s1 in
5147 let s' = String.sub s 0 i in
5148 let s'' = String.sub s (i+sublen) (len-i-sublen) in
5149 s' ^ s2 ^ replace_str s'' s1 s2
5152 let rec string_split sep str =
5153 let len = String.length str in
5154 let seplen = String.length sep in
5155 let i = find str sep in
5156 if i = -1 then [str]
5158 let s' = String.sub str 0 i in
5159 let s'' = String.sub str (i+seplen) (len-i-seplen) in
5160 s' :: string_split sep s''
5163 let files_equal n1 n2 =
5164 let cmd = sprintf "cmp -s %s %s" (Filename.quote n1) (Filename.quote n2) in
5165 match Sys.command cmd with
5168 | i -> failwithf "%s: failed with error code %d" cmd i
5170 let rec filter_map f = function
5174 | Some y -> y :: filter_map f xs
5175 | None -> filter_map f xs
5177 let rec find_map f = function
5178 | [] -> raise Not_found
5182 | None -> find_map f xs
5185 let rec loop i = function
5187 | x :: xs -> f i x; loop (i+1) xs
5192 let rec loop i = function
5194 | x :: xs -> let r = f i x in r :: loop (i+1) xs
5198 let count_chars c str =
5199 let count = ref 0 in
5200 for i = 0 to String.length str - 1 do
5201 if c = String.unsafe_get str i then incr count
5207 for i = 0 to String.length str - 1 do
5208 let c = String.unsafe_get str i in
5213 let map_chars f str =
5214 List.map f (explode str)
5216 let name_of_argt = function
5217 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
5218 | StringList n | DeviceList n | Bool n | Int n | Int64 n
5219 | FileIn n | FileOut n | BufferIn n -> n
5221 let java_name_of_struct typ =
5222 try List.assoc typ java_structs
5225 "java_name_of_struct: no java_structs entry corresponding to %s" typ
5227 let cols_of_struct typ =
5228 try List.assoc typ structs
5230 failwithf "cols_of_struct: unknown struct %s" typ
5232 let seq_of_test = function
5233 | TestRun s | TestOutput (s, _) | TestOutputList (s, _)
5234 | TestOutputListOfDevices (s, _)
5235 | TestOutputInt (s, _) | TestOutputIntOp (s, _, _)
5236 | TestOutputTrue s | TestOutputFalse s
5237 | TestOutputLength (s, _) | TestOutputBuffer (s, _)
5238 | TestOutputStruct (s, _)
5239 | TestLastFail s -> s
5241 (* Handling for function flags. *)
5242 let protocol_limit_warning =
5243 "Because of the message protocol, there is a transfer limit
5244 of somewhere between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
5246 let danger_will_robinson =
5247 "B<This command is dangerous. Without careful use you
5248 can easily destroy all your data>."
5250 let deprecation_notice flags =
5253 find_map (function DeprecatedBy str -> Some str | _ -> None) flags in
5255 sprintf "This function is deprecated.
5256 In new code, use the C<%s> call instead.
5258 Deprecated functions will not be removed from the API, but the
5259 fact that they are deprecated indicates that there are problems
5260 with correct use of these functions." alt in
5265 (* Create list of optional groups. *)
5267 let h = Hashtbl.create 13 in
5269 fun (name, _, _, flags, _, _, _) ->
5273 let names = try Hashtbl.find h group with Not_found -> [] in
5274 Hashtbl.replace h group (name :: names)
5278 let groups = Hashtbl.fold (fun k _ ks -> k :: ks) h [] in
5281 fun group -> group, List.sort compare (Hashtbl.find h group)
5283 List.sort (fun x y -> compare (fst x) (fst y)) groups
5285 (* Check function names etc. for consistency. *)
5286 let check_functions () =
5287 let contains_uppercase str =
5288 let len = String.length str in
5290 if i >= len then false
5293 if c >= 'A' && c <= 'Z' then true
5300 (* Check function names. *)
5302 fun (name, _, _, _, _, _, _) ->
5303 if String.length name >= 7 && String.sub name 0 7 = "guestfs" then
5304 failwithf "function name %s does not need 'guestfs' prefix" name;
5306 failwithf "function name is empty";
5307 if name.[0] < 'a' || name.[0] > 'z' then
5308 failwithf "function name %s must start with lowercase a-z" name;
5309 if String.contains name '-' then
5310 failwithf "function name %s should not contain '-', use '_' instead."
5314 (* Check function parameter/return names. *)
5316 fun (name, style, _, _, _, _, _) ->
5317 let check_arg_ret_name n =
5318 if contains_uppercase n then
5319 failwithf "%s param/ret %s should not contain uppercase chars"
5321 if String.contains n '-' || String.contains n '_' then
5322 failwithf "%s param/ret %s should not contain '-' or '_'"
5325 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;
5326 if n = "int" || n = "char" || n = "short" || n = "long" then
5327 failwithf "%s has a param/ret which conflicts with a C type (eg. 'int', 'char' etc.)" name;
5328 if n = "i" || n = "n" then
5329 failwithf "%s has a param/ret called 'i' or 'n', which will cause some conflicts in the generated code" name;
5330 if n = "argv" || n = "args" then
5331 failwithf "%s has a param/ret called 'argv' or 'args', which will cause some conflicts in the generated code" name;
5333 (* List Haskell, OCaml and C keywords here.
5334 * http://www.haskell.org/haskellwiki/Keywords
5335 * http://caml.inria.fr/pub/docs/manual-ocaml/lex.html#operator-char
5336 * http://en.wikipedia.org/wiki/C_syntax#Reserved_keywords
5337 * Formatted via: cat c haskell ocaml|sort -u|grep -vE '_|^val$' \
5338 * |perl -pe 's/(.+)/"$1";/'|fmt -70
5339 * Omitting _-containing words, since they're handled above.
5340 * Omitting the OCaml reserved word, "val", is ok,
5341 * and saves us from renaming several parameters.
5344 "and"; "as"; "asr"; "assert"; "auto"; "begin"; "break"; "case";
5345 "char"; "class"; "const"; "constraint"; "continue"; "data";
5346 "default"; "deriving"; "do"; "done"; "double"; "downto"; "else";
5347 "end"; "enum"; "exception"; "extern"; "external"; "false"; "float";
5348 "for"; "forall"; "foreign"; "fun"; "function"; "functor"; "goto";
5349 "hiding"; "if"; "import"; "in"; "include"; "infix"; "infixl";
5350 "infixr"; "inherit"; "initializer"; "inline"; "instance"; "int";
5352 "land"; "lazy"; "let"; "long"; "lor"; "lsl"; "lsr"; "lxor";
5353 "match"; "mdo"; "method"; "mod"; "module"; "mutable"; "new";
5354 "newtype"; "object"; "of"; "open"; "or"; "private"; "qualified";
5355 "rec"; "register"; "restrict"; "return"; "short"; "sig"; "signed";
5356 "sizeof"; "static"; "struct"; "switch"; "then"; "to"; "true"; "try";
5357 "type"; "typedef"; "union"; "unsigned"; "virtual"; "void";
5358 "volatile"; "when"; "where"; "while";
5360 if List.mem n reserved then
5361 failwithf "%s has param/ret using reserved word %s" name n;
5364 (match fst style with
5366 | RInt n | RInt64 n | RBool n
5367 | RConstString n | RConstOptString n | RString n
5368 | RStringList n | RStruct (n, _) | RStructList (n, _)
5369 | RHashtable n | RBufferOut n ->
5370 check_arg_ret_name n
5372 List.iter (fun arg -> check_arg_ret_name (name_of_argt arg)) (snd style)
5375 (* Check short descriptions. *)
5377 fun (name, _, _, _, _, shortdesc, _) ->
5378 if shortdesc.[0] <> Char.lowercase shortdesc.[0] then
5379 failwithf "short description of %s should begin with lowercase." name;
5380 let c = shortdesc.[String.length shortdesc-1] in
5381 if c = '\n' || c = '.' then
5382 failwithf "short description of %s should not end with . or \\n." name
5385 (* Check long descriptions. *)
5387 fun (name, _, _, _, _, _, longdesc) ->
5388 if longdesc.[String.length longdesc-1] = '\n' then
5389 failwithf "long description of %s should not end with \\n." name
5392 (* Check proc_nrs. *)
5394 fun (name, _, proc_nr, _, _, _, _) ->
5395 if proc_nr <= 0 then
5396 failwithf "daemon function %s should have proc_nr > 0" name
5400 fun (name, _, proc_nr, _, _, _, _) ->
5401 if proc_nr <> -1 then
5402 failwithf "non-daemon function %s should have proc_nr -1" name
5403 ) non_daemon_functions;
5406 List.map (fun (name, _, proc_nr, _, _, _, _) -> name, proc_nr)
5409 List.sort (fun (_,nr1) (_,nr2) -> compare nr1 nr2) proc_nrs in
5410 let rec loop = function
5413 | (name1,nr1) :: ((name2,nr2) :: _ as rest) when nr1 < nr2 ->
5415 | (name1,nr1) :: (name2,nr2) :: _ ->
5416 failwithf "%s and %s have conflicting procedure numbers (%d, %d)"
5424 (* Ignore functions that have no tests. We generate a
5425 * warning when the user does 'make check' instead.
5427 | name, _, _, _, [], _, _ -> ()
5428 | name, _, _, _, tests, _, _ ->
5432 match seq_of_test test with
5434 failwithf "%s has a test containing an empty sequence" name
5435 | cmds -> List.map List.hd cmds
5437 let funcs = List.flatten funcs in
5439 let tested = List.mem name funcs in
5442 failwithf "function %s has tests but does not test itself" name
5445 (* 'pr' prints to the current output file. *)
5446 let chan = ref Pervasives.stdout
5451 let i = count_chars '\n' str in
5452 lines := !lines + i;
5453 output_string !chan str
5456 let copyright_years =
5457 let this_year = 1900 + (localtime (time ())).tm_year in
5458 if this_year > 2009 then sprintf "2009-%04d" this_year else "2009"
5460 (* Generate a header block in a number of standard styles. *)
5461 type comment_style =
5462 CStyle | CPlusPlusStyle | HashStyle | OCamlStyle | HaskellStyle
5463 type license = GPLv2plus | LGPLv2plus
5465 let generate_header ?(extra_inputs = []) comment license =
5466 let inputs = "src/generator.ml" :: extra_inputs in
5467 let c = match comment with
5468 | CStyle -> pr "/* "; " *"
5469 | CPlusPlusStyle -> pr "// "; "//"
5470 | HashStyle -> pr "# "; "#"
5471 | OCamlStyle -> pr "(* "; " *"
5472 | HaskellStyle -> pr "{- "; " " in
5473 pr "libguestfs generated file\n";
5474 pr "%s WARNING: THIS FILE IS GENERATED FROM:\n" c;
5475 List.iter (pr "%s %s\n" c) inputs;
5476 pr "%s ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.\n" c;
5478 pr "%s Copyright (C) %s Red Hat Inc.\n" c copyright_years;
5482 pr "%s This program is free software; you can redistribute it and/or modify\n" c;
5483 pr "%s it under the terms of the GNU General Public License as published by\n" c;
5484 pr "%s the Free Software Foundation; either version 2 of the License, or\n" c;
5485 pr "%s (at your option) any later version.\n" c;
5487 pr "%s This program is distributed in the hope that it will be useful,\n" c;
5488 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
5489 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" c;
5490 pr "%s GNU General Public License for more details.\n" c;
5492 pr "%s You should have received a copy of the GNU General Public License along\n" c;
5493 pr "%s with this program; if not, write to the Free Software Foundation, Inc.,\n" c;
5494 pr "%s 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n" c;
5497 pr "%s This library is free software; you can redistribute it and/or\n" c;
5498 pr "%s modify it under the terms of the GNU Lesser General Public\n" c;
5499 pr "%s License as published by the Free Software Foundation; either\n" c;
5500 pr "%s version 2 of the License, or (at your option) any later version.\n" c;
5502 pr "%s This library is distributed in the hope that it will be useful,\n" c;
5503 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
5504 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n" c;
5505 pr "%s Lesser General Public License for more details.\n" c;
5507 pr "%s You should have received a copy of the GNU Lesser General Public\n" c;
5508 pr "%s License along with this library; if not, write to the Free Software\n" c;
5509 pr "%s Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n" c;
5512 | CStyle -> pr " */\n"
5515 | OCamlStyle -> pr " *)\n"
5516 | HaskellStyle -> pr "-}\n"
5520 (* Start of main code generation functions below this line. *)
5522 (* Generate the pod documentation for the C API. *)
5523 let rec generate_actions_pod () =
5525 fun (shortname, style, _, flags, _, _, longdesc) ->
5526 if not (List.mem NotInDocs flags) then (
5527 let name = "guestfs_" ^ shortname in
5528 pr "=head2 %s\n\n" name;
5530 generate_prototype ~extern:false ~handle:"g" name style;
5532 pr "%s\n\n" longdesc;
5533 (match fst style with
5535 pr "This function returns 0 on success or -1 on error.\n\n"
5537 pr "On error this function returns -1.\n\n"
5539 pr "On error this function returns -1.\n\n"
5541 pr "This function returns a C truth value on success or -1 on error.\n\n"
5543 pr "This function returns a string, or NULL on error.
5544 The string is owned by the guest handle and must I<not> be freed.\n\n"
5545 | RConstOptString _ ->
5546 pr "This function returns a string which may be NULL.
5547 There is way to return an error from this function.
5548 The string is owned by the guest handle and must I<not> be freed.\n\n"
5550 pr "This function returns a string, or NULL on error.
5551 I<The caller must free the returned string after use>.\n\n"
5553 pr "This function returns a NULL-terminated array of strings
5554 (like L<environ(3)>), or NULL if there was an error.
5555 I<The caller must free the strings and the array after use>.\n\n"
5556 | RStruct (_, typ) ->
5557 pr "This function returns a C<struct guestfs_%s *>,
5558 or NULL if there was an error.
5559 I<The caller must call C<guestfs_free_%s> after use>.\n\n" typ typ
5560 | RStructList (_, typ) ->
5561 pr "This function returns a C<struct guestfs_%s_list *>
5562 (see E<lt>guestfs-structs.hE<gt>),
5563 or NULL if there was an error.
5564 I<The caller must call C<guestfs_free_%s_list> after use>.\n\n" typ typ
5566 pr "This function returns a NULL-terminated array of
5567 strings, or NULL if there was an error.
5568 The array of strings will always have length C<2n+1>, where
5569 C<n> keys and values alternate, followed by the trailing NULL entry.
5570 I<The caller must free the strings and the array after use>.\n\n"
5572 pr "This function returns a buffer, or NULL on error.
5573 The size of the returned buffer is written to C<*size_r>.
5574 I<The caller must free the returned buffer after use>.\n\n"
5576 if List.mem ProtocolLimitWarning flags then
5577 pr "%s\n\n" protocol_limit_warning;
5578 if List.mem DangerWillRobinson flags then
5579 pr "%s\n\n" danger_will_robinson;
5580 match deprecation_notice flags with
5582 | Some txt -> pr "%s\n\n" txt
5584 ) all_functions_sorted
5586 and generate_structs_pod () =
5587 (* Structs documentation. *)
5590 pr "=head2 guestfs_%s\n" typ;
5592 pr " struct guestfs_%s {\n" typ;
5595 | name, FChar -> pr " char %s;\n" name
5596 | name, FUInt32 -> pr " uint32_t %s;\n" name
5597 | name, FInt32 -> pr " int32_t %s;\n" name
5598 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
5599 | name, FInt64 -> pr " int64_t %s;\n" name
5600 | name, FString -> pr " char *%s;\n" name
5602 pr " /* The next two fields describe a byte array. */\n";
5603 pr " uint32_t %s_len;\n" name;
5604 pr " char *%s;\n" name
5606 pr " /* The next field is NOT nul-terminated, be careful when printing it: */\n";
5607 pr " char %s[32];\n" name
5608 | name, FOptPercent ->
5609 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
5610 pr " float %s;\n" name
5614 pr " struct guestfs_%s_list {\n" typ;
5615 pr " uint32_t len; /* Number of elements in list. */\n";
5616 pr " struct guestfs_%s *val; /* Elements. */\n" typ;
5619 pr " void guestfs_free_%s (struct guestfs_free_%s *);\n" typ typ;
5620 pr " void guestfs_free_%s_list (struct guestfs_free_%s_list *);\n"
5625 and generate_availability_pod () =
5626 (* Availability documentation. *)
5630 fun (group, functions) ->
5631 pr "=item B<%s>\n" group;
5633 pr "The following functions:\n";
5634 List.iter (pr "L</guestfs_%s>\n") functions;
5640 (* Generate the protocol (XDR) file, 'guestfs_protocol.x' and
5641 * indirectly 'guestfs_protocol.h' and 'guestfs_protocol.c'.
5643 * We have to use an underscore instead of a dash because otherwise
5644 * rpcgen generates incorrect code.
5646 * This header is NOT exported to clients, but see also generate_structs_h.
5648 and generate_xdr () =
5649 generate_header CStyle LGPLv2plus;
5651 (* This has to be defined to get around a limitation in Sun's rpcgen. *)
5652 pr "typedef string str<>;\n";
5655 (* Internal structures. *)
5659 pr "struct guestfs_int_%s {\n" typ;
5661 | name, FChar -> pr " char %s;\n" name
5662 | name, FString -> pr " string %s<>;\n" name
5663 | name, FBuffer -> pr " opaque %s<>;\n" name
5664 | name, FUUID -> pr " opaque %s[32];\n" name
5665 | name, (FInt32|FUInt32) -> pr " int %s;\n" name
5666 | name, (FInt64|FUInt64|FBytes) -> pr " hyper %s;\n" name
5667 | name, FOptPercent -> pr " float %s;\n" name
5671 pr "typedef struct guestfs_int_%s guestfs_int_%s_list<>;\n" typ typ;
5676 fun (shortname, style, _, _, _, _, _) ->
5677 let name = "guestfs_" ^ shortname in
5679 (match snd style with
5682 pr "struct %s_args {\n" name;
5685 | Pathname n | Device n | Dev_or_Path n | String n ->
5686 pr " string %s<>;\n" n
5687 | OptString n -> pr " str *%s;\n" n
5688 | StringList n | DeviceList n -> pr " str %s<>;\n" n
5689 | Bool n -> pr " bool %s;\n" n
5690 | Int n -> pr " int %s;\n" n
5691 | Int64 n -> pr " hyper %s;\n" n
5693 pr " opaque %s<>;\n" n
5694 | FileIn _ | FileOut _ -> ()
5698 (match fst style with
5701 pr "struct %s_ret {\n" name;
5705 pr "struct %s_ret {\n" name;
5706 pr " hyper %s;\n" n;
5709 pr "struct %s_ret {\n" name;
5712 | RConstString _ | RConstOptString _ ->
5713 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5715 pr "struct %s_ret {\n" name;
5716 pr " string %s<>;\n" n;
5719 pr "struct %s_ret {\n" name;
5720 pr " str %s<>;\n" n;
5722 | RStruct (n, typ) ->
5723 pr "struct %s_ret {\n" name;
5724 pr " guestfs_int_%s %s;\n" typ n;
5726 | RStructList (n, typ) ->
5727 pr "struct %s_ret {\n" name;
5728 pr " guestfs_int_%s_list %s;\n" typ n;
5731 pr "struct %s_ret {\n" name;
5732 pr " str %s<>;\n" n;
5735 pr "struct %s_ret {\n" name;
5736 pr " opaque %s<>;\n" n;
5741 (* Table of procedure numbers. *)
5742 pr "enum guestfs_procedure {\n";
5744 fun (shortname, _, proc_nr, _, _, _, _) ->
5745 pr " GUESTFS_PROC_%s = %d,\n" (String.uppercase shortname) proc_nr
5747 pr " GUESTFS_PROC_NR_PROCS\n";
5751 (* Having to choose a maximum message size is annoying for several
5752 * reasons (it limits what we can do in the API), but it (a) makes
5753 * the protocol a lot simpler, and (b) provides a bound on the size
5754 * of the daemon which operates in limited memory space.
5756 pr "const GUESTFS_MESSAGE_MAX = %d;\n" (4 * 1024 * 1024);
5759 (* Message header, etc. *)
5761 /* The communication protocol is now documented in the guestfs(3)
5765 const GUESTFS_PROGRAM = 0x2000F5F5;
5766 const GUESTFS_PROTOCOL_VERSION = 1;
5768 /* These constants must be larger than any possible message length. */
5769 const GUESTFS_LAUNCH_FLAG = 0xf5f55ff5;
5770 const GUESTFS_CANCEL_FLAG = 0xffffeeee;
5772 enum guestfs_message_direction {
5773 GUESTFS_DIRECTION_CALL = 0, /* client -> daemon */
5774 GUESTFS_DIRECTION_REPLY = 1 /* daemon -> client */
5777 enum guestfs_message_status {
5778 GUESTFS_STATUS_OK = 0,
5779 GUESTFS_STATUS_ERROR = 1
5782 const GUESTFS_ERROR_LEN = 256;
5784 struct guestfs_message_error {
5785 string error_message<GUESTFS_ERROR_LEN>;
5788 struct guestfs_message_header {
5789 unsigned prog; /* GUESTFS_PROGRAM */
5790 unsigned vers; /* GUESTFS_PROTOCOL_VERSION */
5791 guestfs_procedure proc; /* GUESTFS_PROC_x */
5792 guestfs_message_direction direction;
5793 unsigned serial; /* message serial number */
5794 guestfs_message_status status;
5797 const GUESTFS_MAX_CHUNK_SIZE = 8192;
5799 struct guestfs_chunk {
5800 int cancel; /* if non-zero, transfer is cancelled */
5801 /* data size is 0 bytes if the transfer has finished successfully */
5802 opaque data<GUESTFS_MAX_CHUNK_SIZE>;
5806 (* Generate the guestfs-structs.h file. *)
5807 and generate_structs_h () =
5808 generate_header CStyle LGPLv2plus;
5810 (* This is a public exported header file containing various
5811 * structures. The structures are carefully written to have
5812 * exactly the same in-memory format as the XDR structures that
5813 * we use on the wire to the daemon. The reason for creating
5814 * copies of these structures here is just so we don't have to
5815 * export the whole of guestfs_protocol.h (which includes much
5816 * unrelated and XDR-dependent stuff that we don't want to be
5817 * public, or required by clients).
5819 * To reiterate, we will pass these structures to and from the
5820 * client with a simple assignment or memcpy, so the format
5821 * must be identical to what rpcgen / the RFC defines.
5824 (* Public structures. *)
5827 pr "struct guestfs_%s {\n" typ;
5830 | name, FChar -> pr " char %s;\n" name
5831 | name, FString -> pr " char *%s;\n" name
5833 pr " uint32_t %s_len;\n" name;
5834 pr " char *%s;\n" name
5835 | name, FUUID -> pr " char %s[32]; /* this is NOT nul-terminated, be careful when printing */\n" name
5836 | name, FUInt32 -> pr " uint32_t %s;\n" name
5837 | name, FInt32 -> pr " int32_t %s;\n" name
5838 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
5839 | name, FInt64 -> pr " int64_t %s;\n" name
5840 | name, FOptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
5844 pr "struct guestfs_%s_list {\n" typ;
5845 pr " uint32_t len;\n";
5846 pr " struct guestfs_%s *val;\n" typ;
5849 pr "extern void guestfs_free_%s (struct guestfs_%s *);\n" typ typ;
5850 pr "extern void guestfs_free_%s_list (struct guestfs_%s_list *);\n" typ typ;
5854 (* Generate the guestfs-actions.h file. *)
5855 and generate_actions_h () =
5856 generate_header CStyle LGPLv2plus;
5858 fun (shortname, style, _, _, _, _, _) ->
5859 let name = "guestfs_" ^ shortname in
5860 generate_prototype ~single_line:true ~newline:true ~handle:"g"
5864 (* Generate the guestfs-internal-actions.h file. *)
5865 and generate_internal_actions_h () =
5866 generate_header CStyle LGPLv2plus;
5868 fun (shortname, style, _, _, _, _, _) ->
5869 let name = "guestfs__" ^ shortname in
5870 generate_prototype ~single_line:true ~newline:true ~handle:"g"
5872 ) non_daemon_functions
5874 (* Generate the client-side dispatch stubs. *)
5875 and generate_client_actions () =
5876 generate_header CStyle LGPLv2plus;
5883 #include <inttypes.h>
5885 #include \"guestfs.h\"
5886 #include \"guestfs-internal.h\"
5887 #include \"guestfs-internal-actions.h\"
5888 #include \"guestfs_protocol.h\"
5890 #define error guestfs_error
5891 //#define perrorf guestfs_perrorf
5892 #define safe_malloc guestfs_safe_malloc
5893 #define safe_realloc guestfs_safe_realloc
5894 //#define safe_strdup guestfs_safe_strdup
5895 #define safe_memdup guestfs_safe_memdup
5897 /* Check the return message from a call for validity. */
5899 check_reply_header (guestfs_h *g,
5900 const struct guestfs_message_header *hdr,
5901 unsigned int proc_nr, unsigned int serial)
5903 if (hdr->prog != GUESTFS_PROGRAM) {
5904 error (g, \"wrong program (%%d/%%d)\", hdr->prog, GUESTFS_PROGRAM);
5907 if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
5908 error (g, \"wrong protocol version (%%d/%%d)\",
5909 hdr->vers, GUESTFS_PROTOCOL_VERSION);
5912 if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
5913 error (g, \"unexpected message direction (%%d/%%d)\",
5914 hdr->direction, GUESTFS_DIRECTION_REPLY);
5917 if (hdr->proc != proc_nr) {
5918 error (g, \"unexpected procedure number (%%d/%%d)\", hdr->proc, proc_nr);
5921 if (hdr->serial != serial) {
5922 error (g, \"unexpected serial (%%d/%%d)\", hdr->serial, serial);
5929 /* Check we are in the right state to run a high-level action. */
5931 check_state (guestfs_h *g, const char *caller)
5933 if (!guestfs__is_ready (g)) {
5934 if (guestfs__is_config (g) || guestfs__is_launching (g))
5935 error (g, \"%%s: call launch before using this function\\n(in guestfish, don't forget to use the 'run' command)\",
5938 error (g, \"%%s called from the wrong state, %%d != READY\",
5939 caller, guestfs__get_state (g));
5947 let error_code_of = function
5948 | RErr | RInt _ | RInt64 _ | RBool _ -> "-1"
5949 | RConstString _ | RConstOptString _
5950 | RString _ | RStringList _
5951 | RStruct _ | RStructList _
5952 | RHashtable _ | RBufferOut _ -> "NULL"
5955 (* Generate code to check String-like parameters are not passed in
5956 * as NULL (returning an error if they are).
5958 let check_null_strings shortname style =
5959 let pr_newline = ref false in
5962 (* parameters which should not be NULL *)
5972 pr " if (%s == NULL) {\n" n;
5973 pr " error (g, \"%%s: %%s: parameter cannot be NULL\",\n";
5974 pr " \"%s\", \"%s\");\n" shortname n;
5975 pr " return %s;\n" (error_code_of (fst style));
5982 (* not applicable *)
5988 if !pr_newline then pr "\n";
5991 (* Generate code to generate guestfish call traces. *)
5992 let trace_call shortname style =
5993 pr " if (guestfs__get_trace (g)) {\n";
5996 List.exists (function
5997 | StringList _ | DeviceList _ -> true
5998 | _ -> false) (snd style) in
6004 pr " printf (\"%s\");\n" shortname;
6007 | String n (* strings *)
6014 (* guestfish doesn't support string escaping, so neither do we *)
6015 pr " printf (\" \\\"%%s\\\"\", %s);\n" n
6016 | OptString n -> (* string option *)
6017 pr " if (%s) printf (\" \\\"%%s\\\"\", %s);\n" n n;
6018 pr " else printf (\" null\");\n"
6020 | DeviceList n -> (* string list *)
6021 pr " putchar (' ');\n";
6022 pr " putchar ('\"');\n";
6023 pr " for (i = 0; %s[i]; ++i) {\n" n;
6024 pr " if (i > 0) putchar (' ');\n";
6025 pr " fputs (%s[i], stdout);\n" n;
6027 pr " putchar ('\"');\n";
6028 | Bool n -> (* boolean *)
6029 pr " fputs (%s ? \" true\" : \" false\", stdout);\n" n
6030 | Int n -> (* int *)
6031 pr " printf (\" %%d\", %s);\n" n
6033 pr " printf (\" %%\" PRIi64, %s);\n" n
6035 pr " putchar ('\\n');\n";
6040 (* For non-daemon functions, generate a wrapper around each function. *)
6042 fun (shortname, style, _, _, _, _, _) ->
6043 let name = "guestfs_" ^ shortname in
6045 generate_prototype ~extern:false ~semicolon:false ~newline:true
6046 ~handle:"g" name style;
6048 check_null_strings shortname style;
6049 trace_call shortname style;
6050 pr " return guestfs__%s " shortname;
6051 generate_c_call_args ~handle:"g" style;
6055 ) non_daemon_functions;
6057 (* Client-side stubs for each function. *)
6059 fun (shortname, style, _, _, _, _, _) ->
6060 let name = "guestfs_" ^ shortname in
6061 let error_code = error_code_of (fst style) in
6063 (* Generate the action stub. *)
6064 generate_prototype ~extern:false ~semicolon:false ~newline:true
6065 ~handle:"g" name style;
6069 (match snd style with
6071 | _ -> pr " struct %s_args args;\n" name
6074 pr " guestfs_message_header hdr;\n";
6075 pr " guestfs_message_error err;\n";
6077 match fst style with
6079 | RConstString _ | RConstOptString _ ->
6080 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
6082 | RBool _ | RString _ | RStringList _
6083 | RStruct _ | RStructList _
6084 | RHashtable _ | RBufferOut _ ->
6085 pr " struct %s_ret ret;\n" name;
6088 pr " int serial;\n";
6091 check_null_strings shortname style;
6092 trace_call shortname style;
6093 pr " if (check_state (g, \"%s\") == -1) return %s;\n"
6094 shortname error_code;
6095 pr " guestfs___set_busy (g);\n";
6098 (* Send the main header and arguments. *)
6099 (match snd style with
6101 pr " serial = guestfs___send (g, GUESTFS_PROC_%s, NULL, NULL);\n"
6102 (String.uppercase shortname)
6106 | Pathname n | Device n | Dev_or_Path n | String n ->
6107 pr " args.%s = (char *) %s;\n" n n
6109 pr " args.%s = %s ? (char **) &%s : NULL;\n" n n n
6110 | StringList n | DeviceList n ->
6111 pr " args.%s.%s_val = (char **) %s;\n" n n n;
6112 pr " for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n;
6114 pr " args.%s = %s;\n" n n
6116 pr " args.%s = %s;\n" n n
6118 pr " args.%s = %s;\n" n n
6119 | FileIn _ | FileOut _ -> ()
6121 pr " /* Just catch grossly large sizes. XDR encoding will make this precise. */\n";
6122 pr " if (%s_size >= GUESTFS_MESSAGE_MAX) {\n" n;
6123 pr " error (g, \"%%s: size of input buffer too large\", \"%s\");\n"
6125 pr " guestfs___end_busy (g);\n";
6126 pr " return %s;\n" error_code;
6128 pr " args.%s.%s_val = (char *) %s;\n" n n n;
6129 pr " args.%s.%s_len = %s_size;\n" n n n
6131 pr " serial = guestfs___send (g, GUESTFS_PROC_%s,\n"
6132 (String.uppercase shortname);
6133 pr " (xdrproc_t) xdr_%s_args, (char *) &args);\n"
6136 pr " if (serial == -1) {\n";
6137 pr " guestfs___end_busy (g);\n";
6138 pr " return %s;\n" error_code;
6142 (* Send any additional files (FileIn) requested. *)
6143 let need_read_reply_label = ref false in
6147 pr " r = guestfs___send_file (g, %s);\n" n;
6148 pr " if (r == -1) {\n";
6149 pr " guestfs___end_busy (g);\n";
6150 pr " return %s;\n" error_code;
6152 pr " if (r == -2) /* daemon cancelled */\n";
6153 pr " goto read_reply;\n";
6154 need_read_reply_label := true;
6159 (* Wait for the reply from the remote end. *)
6160 if !need_read_reply_label then pr " read_reply:\n";
6161 pr " memset (&hdr, 0, sizeof hdr);\n";
6162 pr " memset (&err, 0, sizeof err);\n";
6163 if has_ret then pr " memset (&ret, 0, sizeof ret);\n";
6165 pr " r = guestfs___recv (g, \"%s\", &hdr, &err,\n " shortname;
6169 pr "(xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret" shortname;
6172 pr " if (r == -1) {\n";
6173 pr " guestfs___end_busy (g);\n";
6174 pr " return %s;\n" error_code;
6178 pr " if (check_reply_header (g, &hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
6179 (String.uppercase shortname);
6180 pr " guestfs___end_busy (g);\n";
6181 pr " return %s;\n" error_code;
6185 pr " if (hdr.status == GUESTFS_STATUS_ERROR) {\n";
6186 pr " error (g, \"%%s: %%s\", \"%s\", err.error_message);\n" shortname;
6187 pr " free (err.error_message);\n";
6188 pr " guestfs___end_busy (g);\n";
6189 pr " return %s;\n" error_code;
6193 (* Expecting to receive further files (FileOut)? *)
6197 pr " if (guestfs___recv_file (g, %s) == -1) {\n" n;
6198 pr " guestfs___end_busy (g);\n";
6199 pr " return %s;\n" error_code;
6205 pr " guestfs___end_busy (g);\n";
6207 (match fst style with
6208 | RErr -> pr " return 0;\n"
6209 | RInt n | RInt64 n | RBool n ->
6210 pr " return ret.%s;\n" n
6211 | RConstString _ | RConstOptString _ ->
6212 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
6214 pr " return ret.%s; /* caller will free */\n" n
6215 | RStringList n | RHashtable n ->
6216 pr " /* caller will free this, but we need to add a NULL entry */\n";
6217 pr " ret.%s.%s_val =\n" n n;
6218 pr " safe_realloc (g, ret.%s.%s_val,\n" n n;
6219 pr " sizeof (char *) * (ret.%s.%s_len + 1));\n"
6221 pr " ret.%s.%s_val[ret.%s.%s_len] = NULL;\n" n n n n;
6222 pr " return ret.%s.%s_val;\n" n n
6224 pr " /* caller will free this */\n";
6225 pr " return safe_memdup (g, &ret.%s, sizeof (ret.%s));\n" n n
6226 | RStructList (n, _) ->
6227 pr " /* caller will free this */\n";
6228 pr " return safe_memdup (g, &ret.%s, sizeof (ret.%s));\n" n n
6230 pr " /* RBufferOut is tricky: If the buffer is zero-length, then\n";
6231 pr " * _val might be NULL here. To make the API saner for\n";
6232 pr " * callers, we turn this case into a unique pointer (using\n";
6233 pr " * malloc(1)).\n";
6235 pr " if (ret.%s.%s_len > 0) {\n" n n;
6236 pr " *size_r = ret.%s.%s_len;\n" n n;
6237 pr " return ret.%s.%s_val; /* caller will free */\n" n n;
6239 pr " free (ret.%s.%s_val);\n" n n;
6240 pr " char *p = safe_malloc (g, 1);\n";
6241 pr " *size_r = ret.%s.%s_len;\n" n n;
6249 (* Functions to free structures. *)
6250 pr "/* Structure-freeing functions. These rely on the fact that the\n";
6251 pr " * structure format is identical to the XDR format. See note in\n";
6252 pr " * generator.ml.\n";
6259 pr "guestfs_free_%s (struct guestfs_%s *x)\n" typ typ;
6261 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s, (char *) x);\n" typ;
6267 pr "guestfs_free_%s_list (struct guestfs_%s_list *x)\n" typ typ;
6269 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s_list, (char *) x);\n" typ;
6276 (* Generate daemon/actions.h. *)
6277 and generate_daemon_actions_h () =
6278 generate_header CStyle GPLv2plus;
6280 pr "#include \"../src/guestfs_protocol.h\"\n";
6284 fun (name, style, _, _, _, _, _) ->
6286 ~single_line:true ~newline:true ~in_daemon:true ~prefix:"do_"
6290 (* Generate the linker script which controls the visibility of
6291 * symbols in the public ABI and ensures no other symbols get
6292 * exported accidentally.
6294 and generate_linker_script () =
6295 generate_header HashStyle GPLv2plus;
6300 "guestfs_get_error_handler";
6301 "guestfs_get_out_of_memory_handler";
6302 "guestfs_last_error";
6303 "guestfs_set_error_handler";
6304 "guestfs_set_launch_done_callback";
6305 "guestfs_set_log_message_callback";
6306 "guestfs_set_out_of_memory_handler";
6307 "guestfs_set_subprocess_quit_callback";
6309 (* Unofficial parts of the API: the bindings code use these
6310 * functions, so it is useful to export them.
6312 "guestfs_safe_calloc";
6313 "guestfs_safe_malloc";
6316 List.map (fun (name, _, _, _, _, _, _) -> "guestfs_" ^ name)
6320 List.map (fun (typ, _) ->
6321 ["guestfs_free_" ^ typ; "guestfs_free_" ^ typ ^ "_list"])
6324 let globals = List.sort compare (globals @ functions @ structs) in
6328 List.iter (pr " %s;\n") globals;
6335 (* Generate the server-side stubs. *)
6336 and generate_daemon_actions () =
6337 generate_header CStyle GPLv2plus;
6339 pr "#include <config.h>\n";
6341 pr "#include <stdio.h>\n";
6342 pr "#include <stdlib.h>\n";
6343 pr "#include <string.h>\n";
6344 pr "#include <inttypes.h>\n";
6345 pr "#include <rpc/types.h>\n";
6346 pr "#include <rpc/xdr.h>\n";
6348 pr "#include \"daemon.h\"\n";
6349 pr "#include \"c-ctype.h\"\n";
6350 pr "#include \"../src/guestfs_protocol.h\"\n";
6351 pr "#include \"actions.h\"\n";
6355 fun (name, style, _, _, _, _, _) ->
6356 (* Generate server-side stubs. *)
6357 pr "static void %s_stub (XDR *xdr_in)\n" name;
6360 match fst style with
6361 | RErr | RInt _ -> pr " int r;\n"; "-1"
6362 | RInt64 _ -> pr " int64_t r;\n"; "-1"
6363 | RBool _ -> pr " int r;\n"; "-1"
6364 | RConstString _ | RConstOptString _ ->
6365 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
6366 | RString _ -> pr " char *r;\n"; "NULL"
6367 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
6368 | RStruct (_, typ) -> pr " guestfs_int_%s *r;\n" typ; "NULL"
6369 | RStructList (_, typ) -> pr " guestfs_int_%s_list *r;\n" typ; "NULL"
6371 pr " size_t size = 1;\n";
6375 (match snd style with
6378 pr " struct guestfs_%s_args args;\n" name;
6381 | Device n | Dev_or_Path n
6384 | OptString n -> pr " char *%s;\n" n
6385 | StringList n | DeviceList n -> pr " char **%s;\n" n
6386 | Bool n -> pr " int %s;\n" n
6387 | Int n -> pr " int %s;\n" n
6388 | Int64 n -> pr " int64_t %s;\n" n
6389 | FileIn _ | FileOut _ -> ()
6391 pr " const char *%s;\n" n;
6392 pr " size_t %s_size;\n" n
6398 List.exists (function FileIn _ -> true | _ -> false) (snd style) in
6400 (match snd style with
6403 pr " memset (&args, 0, sizeof args);\n";
6405 pr " if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name;
6407 pr " if (cancel_receive () != -2)\n";
6408 pr " reply_with_error (\"daemon failed to decode procedure arguments\");\n";
6412 pr " char *%s = args.%s;\n" n n
6414 let pr_list_handling_code n =
6415 pr " %s = realloc (args.%s.%s_val,\n" n n n;
6416 pr " sizeof (char *) * (args.%s.%s_len+1));\n" n n;
6417 pr " if (%s == NULL) {\n" n;
6419 pr " if (cancel_receive () != -2)\n";
6420 pr " reply_with_perror (\"realloc\");\n";
6423 pr " %s[args.%s.%s_len] = NULL;\n" n n n;
6424 pr " args.%s.%s_val = %s;\n" n n n;
6430 pr " ABS_PATH (%s, %s, goto done);\n"
6431 n (if is_filein then "cancel_receive ()" else "0");
6434 pr " RESOLVE_DEVICE (%s, %s, goto done);\n"
6435 n (if is_filein then "cancel_receive ()" else "0");
6438 pr " REQUIRE_ROOT_OR_RESOLVE_DEVICE (%s, %s, goto done);\n"
6439 n (if is_filein then "cancel_receive ()" else "0");
6440 | String n -> pr_args n
6441 | OptString n -> pr " %s = args.%s ? *args.%s : NULL;\n" n n n
6443 pr_list_handling_code n;
6445 pr_list_handling_code n;
6446 pr " /* Ensure that each is a device,\n";
6447 pr " * and perform device name translation. */\n";
6448 pr " { int pvi; for (pvi = 0; physvols[pvi] != NULL; ++pvi)\n";
6449 pr " RESOLVE_DEVICE (physvols[pvi], %s, goto done);\n"
6450 (if is_filein then "cancel_receive ()" else "0");
6452 | Bool n -> pr " %s = args.%s;\n" n n
6453 | Int n -> pr " %s = args.%s;\n" n n
6454 | Int64 n -> pr " %s = args.%s;\n" n n
6455 | FileIn _ | FileOut _ -> ()
6457 pr " %s = args.%s.%s_val;\n" n n n;
6458 pr " %s_size = args.%s.%s_len;\n" n n n
6463 (* this is used at least for do_equal *)
6464 if List.exists (function Pathname _ -> true | _ -> false) (snd style) then (
6465 (* Emit NEED_ROOT just once, even when there are two or
6466 more Pathname args *)
6467 pr " NEED_ROOT (%s, goto done);\n"
6468 (if is_filein then "cancel_receive ()" else "0");
6471 (* Don't want to call the impl with any FileIn or FileOut
6472 * parameters, since these go "outside" the RPC protocol.
6475 List.filter (function FileIn _ | FileOut _ -> false | _ -> true)
6477 pr " r = do_%s " name;
6478 generate_c_call_args (fst style, args');
6481 (match fst style with
6482 | RErr | RInt _ | RInt64 _ | RBool _
6483 | RConstString _ | RConstOptString _
6484 | RString _ | RStringList _ | RHashtable _
6485 | RStruct (_, _) | RStructList (_, _) ->
6486 pr " if (r == %s)\n" error_code;
6487 pr " /* do_%s has already called reply_with_error */\n" name;
6491 pr " /* size == 0 && r == NULL could be a non-error case (just\n";
6492 pr " * an ordinary zero-length buffer), so be careful ...\n";
6494 pr " if (size == 1 && r == %s)\n" error_code;
6495 pr " /* do_%s has already called reply_with_error */\n" name;
6500 (* If there are any FileOut parameters, then the impl must
6501 * send its own reply.
6504 List.exists (function FileOut _ -> true | _ -> false) (snd style) in
6506 pr " /* do_%s has already sent a reply */\n" name
6508 match fst style with
6509 | RErr -> pr " reply (NULL, NULL);\n"
6510 | RInt n | RInt64 n | RBool n ->
6511 pr " struct guestfs_%s_ret ret;\n" name;
6512 pr " ret.%s = r;\n" n;
6513 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6515 | RConstString _ | RConstOptString _ ->
6516 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
6518 pr " struct guestfs_%s_ret ret;\n" name;
6519 pr " ret.%s = r;\n" n;
6520 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6523 | RStringList n | RHashtable n ->
6524 pr " struct guestfs_%s_ret ret;\n" name;
6525 pr " ret.%s.%s_len = count_strings (r);\n" n n;
6526 pr " ret.%s.%s_val = r;\n" n n;
6527 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6529 pr " free_strings (r);\n"
6531 pr " struct guestfs_%s_ret ret;\n" name;
6532 pr " ret.%s = *r;\n" n;
6533 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6535 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6537 | RStructList (n, _) ->
6538 pr " struct guestfs_%s_ret ret;\n" name;
6539 pr " ret.%s = *r;\n" n;
6540 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6542 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6545 pr " struct guestfs_%s_ret ret;\n" name;
6546 pr " ret.%s.%s_val = r;\n" n n;
6547 pr " ret.%s.%s_len = size;\n" n n;
6548 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6553 (* Free the args. *)
6555 (match snd style with
6558 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_args, (char *) &args);\n"
6565 (* Dispatch function. *)
6566 pr "void dispatch_incoming_message (XDR *xdr_in)\n";
6568 pr " switch (proc_nr) {\n";
6571 fun (name, style, _, _, _, _, _) ->
6572 pr " case GUESTFS_PROC_%s:\n" (String.uppercase name);
6573 pr " %s_stub (xdr_in);\n" name;
6578 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";
6583 (* LVM columns and tokenization functions. *)
6584 (* XXX This generates crap code. We should rethink how we
6590 pr "static const char *lvm_%s_cols = \"%s\";\n"
6591 typ (String.concat "," (List.map fst cols));
6594 pr "static int lvm_tokenize_%s (char *str, guestfs_int_lvm_%s *r)\n" typ typ;
6596 pr " char *tok, *p, *next;\n";
6600 pr " fprintf (stderr, \"%%s: <<%%s>>\\n\", __func__, str);\n";
6603 pr " if (!str) {\n";
6604 pr " fprintf (stderr, \"%%s: failed: passed a NULL string\\n\", __func__);\n";
6607 pr " if (!*str || c_isspace (*str)) {\n";
6608 pr " fprintf (stderr, \"%%s: failed: passed a empty string or one beginning with whitespace\\n\", __func__);\n";
6613 fun (name, coltype) ->
6614 pr " if (!tok) {\n";
6615 pr " fprintf (stderr, \"%%s: failed: string finished early, around token %%s\\n\", __func__, \"%s\");\n" name;
6618 pr " p = strchrnul (tok, ',');\n";
6619 pr " if (*p) next = p+1; else next = NULL;\n";
6620 pr " *p = '\\0';\n";
6623 pr " r->%s = strdup (tok);\n" name;
6624 pr " if (r->%s == NULL) {\n" name;
6625 pr " perror (\"strdup\");\n";
6629 pr " for (i = j = 0; i < 32; ++j) {\n";
6630 pr " if (tok[j] == '\\0') {\n";
6631 pr " fprintf (stderr, \"%%s: failed to parse UUID from '%%s'\\n\", __func__, tok);\n";
6633 pr " } else if (tok[j] != '-')\n";
6634 pr " r->%s[i++] = tok[j];\n" name;
6637 pr " if (sscanf (tok, \"%%\"SCNu64, &r->%s) != 1) {\n" name;
6638 pr " fprintf (stderr, \"%%s: failed to parse size '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
6642 pr " if (sscanf (tok, \"%%\"SCNi64, &r->%s) != 1) {\n" name;
6643 pr " fprintf (stderr, \"%%s: failed to parse int '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
6647 pr " if (tok[0] == '\\0')\n";
6648 pr " r->%s = -1;\n" name;
6649 pr " else if (sscanf (tok, \"%%f\", &r->%s) != 1) {\n" name;
6650 pr " fprintf (stderr, \"%%s: failed to parse float '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
6653 | FBuffer | FInt32 | FUInt32 | FUInt64 | FChar ->
6654 assert false (* can never be an LVM column *)
6656 pr " tok = next;\n";
6659 pr " if (tok != NULL) {\n";
6660 pr " fprintf (stderr, \"%%s: failed: extra tokens at end of string\\n\", __func__);\n";
6667 pr "guestfs_int_lvm_%s_list *\n" typ;
6668 pr "parse_command_line_%ss (void)\n" typ;
6670 pr " char *out, *err;\n";
6671 pr " char *p, *pend;\n";
6673 pr " guestfs_int_lvm_%s_list *ret;\n" typ;
6674 pr " void *newp;\n";
6676 pr " ret = malloc (sizeof *ret);\n";
6677 pr " if (!ret) {\n";
6678 pr " reply_with_perror (\"malloc\");\n";
6679 pr " return NULL;\n";
6682 pr " ret->guestfs_int_lvm_%s_list_len = 0;\n" typ;
6683 pr " ret->guestfs_int_lvm_%s_list_val = NULL;\n" typ;
6685 pr " r = command (&out, &err,\n";
6686 pr " \"lvm\", \"%ss\",\n" typ;
6687 pr " \"-o\", lvm_%s_cols, \"--unbuffered\", \"--noheadings\",\n" typ;
6688 pr " \"--nosuffix\", \"--separator\", \",\", \"--units\", \"b\", NULL);\n";
6689 pr " if (r == -1) {\n";
6690 pr " reply_with_error (\"%%s\", err);\n";
6691 pr " free (out);\n";
6692 pr " free (err);\n";
6693 pr " free (ret);\n";
6694 pr " return NULL;\n";
6697 pr " free (err);\n";
6699 pr " /* Tokenize each line of the output. */\n";
6702 pr " while (p) {\n";
6703 pr " pend = strchr (p, '\\n'); /* Get the next line of output. */\n";
6704 pr " if (pend) {\n";
6705 pr " *pend = '\\0';\n";
6709 pr " while (*p && c_isspace (*p)) /* Skip any leading whitespace. */\n";
6712 pr " if (!*p) { /* Empty line? Skip it. */\n";
6717 pr " /* Allocate some space to store this next entry. */\n";
6718 pr " newp = realloc (ret->guestfs_int_lvm_%s_list_val,\n" typ;
6719 pr " sizeof (guestfs_int_lvm_%s) * (i+1));\n" typ;
6720 pr " if (newp == NULL) {\n";
6721 pr " reply_with_perror (\"realloc\");\n";
6722 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
6723 pr " free (ret);\n";
6724 pr " free (out);\n";
6725 pr " return NULL;\n";
6727 pr " ret->guestfs_int_lvm_%s_list_val = newp;\n" typ;
6729 pr " /* Tokenize the next entry. */\n";
6730 pr " r = lvm_tokenize_%s (p, &ret->guestfs_int_lvm_%s_list_val[i]);\n" typ typ;
6731 pr " if (r == -1) {\n";
6732 pr " reply_with_error (\"failed to parse output of '%ss' command\");\n" typ;
6733 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
6734 pr " free (ret);\n";
6735 pr " free (out);\n";
6736 pr " return NULL;\n";
6743 pr " ret->guestfs_int_lvm_%s_list_len = i;\n" typ;
6745 pr " free (out);\n";
6746 pr " return ret;\n";
6749 ) ["pv", lvm_pv_cols; "vg", lvm_vg_cols; "lv", lvm_lv_cols]
6751 (* Generate a list of function names, for debugging in the daemon.. *)
6752 and generate_daemon_names () =
6753 generate_header CStyle GPLv2plus;
6755 pr "#include <config.h>\n";
6757 pr "#include \"daemon.h\"\n";
6760 pr "/* This array is indexed by proc_nr. See guestfs_protocol.x. */\n";
6761 pr "const char *function_names[] = {\n";
6763 fun (name, _, proc_nr, _, _, _, _) -> pr " [%d] = \"%s\",\n" proc_nr name
6767 (* Generate the optional groups for the daemon to implement
6768 * guestfs_available.
6770 and generate_daemon_optgroups_c () =
6771 generate_header CStyle GPLv2plus;
6773 pr "#include <config.h>\n";
6775 pr "#include \"daemon.h\"\n";
6776 pr "#include \"optgroups.h\"\n";
6779 pr "struct optgroup optgroups[] = {\n";
6782 pr " { \"%s\", optgroup_%s_available },\n" group group
6784 pr " { NULL, NULL }\n";
6787 and generate_daemon_optgroups_h () =
6788 generate_header CStyle GPLv2plus;
6792 pr "extern int optgroup_%s_available (void);\n" group
6795 (* Generate the tests. *)
6796 and generate_tests () =
6797 generate_header CStyle GPLv2plus;
6804 #include <sys/types.h>
6807 #include \"guestfs.h\"
6808 #include \"guestfs-internal.h\"
6810 static guestfs_h *g;
6811 static int suppress_error = 0;
6813 static void print_error (guestfs_h *g, void *data, const char *msg)
6815 if (!suppress_error)
6816 fprintf (stderr, \"%%s\\n\", msg);
6819 /* FIXME: nearly identical code appears in fish.c */
6820 static void print_strings (char *const *argv)
6824 for (argc = 0; argv[argc] != NULL; ++argc)
6825 printf (\"\\t%%s\\n\", argv[argc]);
6829 static void print_table (char const *const *argv)
6833 for (i = 0; argv[i] != NULL; i += 2)
6834 printf (\"%%s: %%s\\n\", argv[i], argv[i+1]);
6840 (* Generate a list of commands which are not tested anywhere. *)
6841 pr "static void no_test_warnings (void)\n";
6844 let hash : (string, bool) Hashtbl.t = Hashtbl.create 13 in
6846 fun (_, _, _, _, tests, _, _) ->
6847 let tests = filter_map (
6849 | (_, (Always|If _|Unless _), test) -> Some test
6850 | (_, Disabled, _) -> None
6852 let seq = List.concat (List.map seq_of_test tests) in
6853 let cmds_tested = List.map List.hd seq in
6854 List.iter (fun cmd -> Hashtbl.replace hash cmd true) cmds_tested
6858 fun (name, _, _, _, _, _, _) ->
6859 if not (Hashtbl.mem hash name) then
6860 pr " fprintf (stderr, \"warning: \\\"guestfs_%s\\\" has no tests\\n\");\n" name
6866 (* Generate the actual tests. Note that we generate the tests
6867 * in reverse order, deliberately, so that (in general) the
6868 * newest tests run first. This makes it quicker and easier to
6873 fun (name, _, _, flags, tests, _, _) ->
6874 mapi (generate_one_test name flags) tests
6875 ) (List.rev all_functions) in
6876 let test_names = List.concat test_names in
6877 let nr_tests = List.length test_names in
6880 int main (int argc, char *argv[])
6883 unsigned long int n_failed = 0;
6884 const char *filename;
6886 int nr_tests, test_num = 0;
6888 setbuf (stdout, NULL);
6890 no_test_warnings ();
6892 g = guestfs_create ();
6894 printf (\"guestfs_create FAILED\\n\");
6895 exit (EXIT_FAILURE);
6898 guestfs_set_error_handler (g, print_error, NULL);
6900 guestfs_set_path (g, \"../appliance\");
6902 filename = \"test1.img\";
6903 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
6906 exit (EXIT_FAILURE);
6908 if (lseek (fd, %d, SEEK_SET) == -1) {
6912 exit (EXIT_FAILURE);
6914 if (write (fd, &c, 1) == -1) {
6918 exit (EXIT_FAILURE);
6920 if (close (fd) == -1) {
6923 exit (EXIT_FAILURE);
6925 if (guestfs_add_drive (g, filename) == -1) {
6926 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
6927 exit (EXIT_FAILURE);
6930 filename = \"test2.img\";
6931 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
6934 exit (EXIT_FAILURE);
6936 if (lseek (fd, %d, SEEK_SET) == -1) {
6940 exit (EXIT_FAILURE);
6942 if (write (fd, &c, 1) == -1) {
6946 exit (EXIT_FAILURE);
6948 if (close (fd) == -1) {
6951 exit (EXIT_FAILURE);
6953 if (guestfs_add_drive (g, filename) == -1) {
6954 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
6955 exit (EXIT_FAILURE);
6958 filename = \"test3.img\";
6959 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
6962 exit (EXIT_FAILURE);
6964 if (lseek (fd, %d, SEEK_SET) == -1) {
6968 exit (EXIT_FAILURE);
6970 if (write (fd, &c, 1) == -1) {
6974 exit (EXIT_FAILURE);
6976 if (close (fd) == -1) {
6979 exit (EXIT_FAILURE);
6981 if (guestfs_add_drive (g, filename) == -1) {
6982 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
6983 exit (EXIT_FAILURE);
6986 if (guestfs_add_drive_ro (g, \"../images/test.iso\") == -1) {
6987 printf (\"guestfs_add_drive_ro ../images/test.iso FAILED\\n\");
6988 exit (EXIT_FAILURE);
6991 /* Set a timeout in case qemu hangs during launch (RHBZ#505329). */
6994 if (guestfs_launch (g) == -1) {
6995 printf (\"guestfs_launch FAILED\\n\");
6996 exit (EXIT_FAILURE);
6999 /* Cancel previous alarm. */
7004 " (500 * 1024 * 1024) (50 * 1024 * 1024) (10 * 1024 * 1024) nr_tests;
7008 pr " test_num++;\n";
7009 pr " if (guestfs_get_verbose (g))\n";
7010 pr " printf (\"-------------------------------------------------------------------------------\\n\");\n";
7011 pr " printf (\"%%3d/%%3d %s\\n\", test_num, nr_tests);\n" test_name;
7012 pr " if (%s () == -1) {\n" test_name;
7013 pr " printf (\"%s FAILED\\n\");\n" test_name;
7014 pr " n_failed++;\n";
7019 pr " guestfs_close (g);\n";
7020 pr " unlink (\"test1.img\");\n";
7021 pr " unlink (\"test2.img\");\n";
7022 pr " unlink (\"test3.img\");\n";
7025 pr " if (n_failed > 0) {\n";
7026 pr " printf (\"***** %%lu / %%d tests FAILED *****\\n\", n_failed, nr_tests);\n";
7027 pr " exit (EXIT_FAILURE);\n";
7031 pr " exit (EXIT_SUCCESS);\n";
7034 and generate_one_test name flags i (init, prereq, test) =
7035 let test_name = sprintf "test_%s_%d" name i in
7038 static int %s_skip (void)
7042 str = getenv (\"TEST_ONLY\");
7044 return strstr (str, \"%s\") == NULL;
7045 str = getenv (\"SKIP_%s\");
7046 if (str && STREQ (str, \"1\")) return 1;
7047 str = getenv (\"SKIP_TEST_%s\");
7048 if (str && STREQ (str, \"1\")) return 1;
7052 " test_name name (String.uppercase test_name) (String.uppercase name);
7055 | Disabled | Always -> ()
7056 | If code | Unless code ->
7057 pr "static int %s_prereq (void)\n" test_name;
7065 static int %s (void)
7068 printf (\" %%s skipped (reason: environment variable set)\\n\", \"%s\");
7072 " test_name test_name test_name;
7074 (* Optional functions should only be tested if the relevant
7075 * support is available in the daemon.
7081 pr " const char *groups[] = { \"%s\", NULL };\n" group;
7083 pr " suppress_error = 1;\n";
7084 pr " r = guestfs_available (g, (char **) groups);\n";
7085 pr " suppress_error = 0;\n";
7086 pr " if (r == -1) {\n";
7087 pr " printf (\" %%s skipped (reason: group %%s not available in daemon)\\n\", \"%s\", groups[0]);\n" test_name;
7096 pr " printf (\" %%s skipped (reason: test disabled in generator)\\n\", \"%s\");\n" test_name
7098 pr " if (! %s_prereq ()) {\n" test_name;
7099 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
7103 generate_one_test_body name i test_name init test;
7105 pr " if (%s_prereq ()) {\n" test_name;
7106 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
7110 generate_one_test_body name i test_name init test;
7112 generate_one_test_body name i test_name init test
7120 and generate_one_test_body name i test_name init test =
7122 | InitNone (* XXX at some point, InitNone and InitEmpty became
7123 * folded together as the same thing. Really we should
7124 * make InitNone do nothing at all, but the tests may
7125 * need to be checked to make sure this is OK.
7128 pr " /* InitNone|InitEmpty for %s */\n" test_name;
7129 List.iter (generate_test_command_call test_name)
7130 [["blockdev_setrw"; "/dev/sda"];
7134 pr " /* InitPartition for %s: create /dev/sda1 */\n" test_name;
7135 List.iter (generate_test_command_call test_name)
7136 [["blockdev_setrw"; "/dev/sda"];
7139 ["part_disk"; "/dev/sda"; "mbr"]]
7141 pr " /* InitBasicFS for %s: create ext2 on /dev/sda1 */\n" test_name;
7142 List.iter (generate_test_command_call test_name)
7143 [["blockdev_setrw"; "/dev/sda"];
7146 ["part_disk"; "/dev/sda"; "mbr"];
7147 ["mkfs"; "ext2"; "/dev/sda1"];
7148 ["mount_options"; ""; "/dev/sda1"; "/"]]
7149 | InitBasicFSonLVM ->
7150 pr " /* InitBasicFSonLVM for %s: create ext2 on /dev/VG/LV */\n"
7152 List.iter (generate_test_command_call test_name)
7153 [["blockdev_setrw"; "/dev/sda"];
7156 ["part_disk"; "/dev/sda"; "mbr"];
7157 ["pvcreate"; "/dev/sda1"];
7158 ["vgcreate"; "VG"; "/dev/sda1"];
7159 ["lvcreate"; "LV"; "VG"; "8"];
7160 ["mkfs"; "ext2"; "/dev/VG/LV"];
7161 ["mount_options"; ""; "/dev/VG/LV"; "/"]]
7163 pr " /* InitISOFS for %s */\n" test_name;
7164 List.iter (generate_test_command_call test_name)
7165 [["blockdev_setrw"; "/dev/sda"];
7168 ["mount_ro"; "/dev/sdd"; "/"]]
7171 let get_seq_last = function
7173 failwithf "%s: you cannot use [] (empty list) when expecting a command"
7176 let seq = List.rev seq in
7177 List.rev (List.tl seq), List.hd seq
7182 pr " /* TestRun for %s (%d) */\n" name i;
7183 List.iter (generate_test_command_call test_name) seq
7184 | TestOutput (seq, expected) ->
7185 pr " /* TestOutput for %s (%d) */\n" name i;
7186 pr " const char *expected = \"%s\";\n" (c_quote expected);
7187 let seq, last = get_seq_last seq in
7189 pr " if (STRNEQ (r, expected)) {\n";
7190 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
7194 List.iter (generate_test_command_call test_name) seq;
7195 generate_test_command_call ~test test_name last
7196 | TestOutputList (seq, expected) ->
7197 pr " /* TestOutputList for %s (%d) */\n" name i;
7198 let seq, last = get_seq_last seq in
7202 pr " if (!r[%d]) {\n" i;
7203 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
7204 pr " print_strings (r);\n";
7208 pr " const char *expected = \"%s\";\n" (c_quote str);
7209 pr " if (STRNEQ (r[%d], expected)) {\n" i;
7210 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
7215 pr " if (r[%d] != NULL) {\n" (List.length expected);
7216 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
7218 pr " print_strings (r);\n";
7222 List.iter (generate_test_command_call test_name) seq;
7223 generate_test_command_call ~test test_name last
7224 | TestOutputListOfDevices (seq, expected) ->
7225 pr " /* TestOutputListOfDevices for %s (%d) */\n" name i;
7226 let seq, last = get_seq_last seq in
7230 pr " if (!r[%d]) {\n" i;
7231 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
7232 pr " print_strings (r);\n";
7236 pr " const char *expected = \"%s\";\n" (c_quote str);
7237 pr " r[%d][5] = 's';\n" i;
7238 pr " if (STRNEQ (r[%d], expected)) {\n" i;
7239 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
7244 pr " if (r[%d] != NULL) {\n" (List.length expected);
7245 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
7247 pr " print_strings (r);\n";
7251 List.iter (generate_test_command_call test_name) seq;
7252 generate_test_command_call ~test test_name last
7253 | TestOutputInt (seq, expected) ->
7254 pr " /* TestOutputInt for %s (%d) */\n" name i;
7255 let seq, last = get_seq_last seq in
7257 pr " if (r != %d) {\n" expected;
7258 pr " fprintf (stderr, \"%s: expected %d but got %%d\\n\","
7264 List.iter (generate_test_command_call test_name) seq;
7265 generate_test_command_call ~test test_name last
7266 | TestOutputIntOp (seq, op, expected) ->
7267 pr " /* TestOutputIntOp for %s (%d) */\n" name i;
7268 let seq, last = get_seq_last seq in
7270 pr " if (! (r %s %d)) {\n" op expected;
7271 pr " fprintf (stderr, \"%s: expected %s %d but got %%d\\n\","
7272 test_name op expected;
7277 List.iter (generate_test_command_call test_name) seq;
7278 generate_test_command_call ~test test_name last
7279 | TestOutputTrue seq ->
7280 pr " /* TestOutputTrue for %s (%d) */\n" name i;
7281 let seq, last = get_seq_last seq in
7284 pr " fprintf (stderr, \"%s: expected true, got false\\n\");\n"
7289 List.iter (generate_test_command_call test_name) seq;
7290 generate_test_command_call ~test test_name last
7291 | TestOutputFalse seq ->
7292 pr " /* TestOutputFalse for %s (%d) */\n" name i;
7293 let seq, last = get_seq_last seq in
7296 pr " fprintf (stderr, \"%s: expected false, got true\\n\");\n"
7301 List.iter (generate_test_command_call test_name) seq;
7302 generate_test_command_call ~test test_name last
7303 | TestOutputLength (seq, expected) ->
7304 pr " /* TestOutputLength for %s (%d) */\n" name i;
7305 let seq, last = get_seq_last seq in
7308 pr " for (j = 0; j < %d; ++j)\n" expected;
7309 pr " if (r[j] == NULL) {\n";
7310 pr " fprintf (stderr, \"%s: short list returned\\n\");\n"
7312 pr " print_strings (r);\n";
7315 pr " if (r[j] != NULL) {\n";
7316 pr " fprintf (stderr, \"%s: long list returned\\n\");\n"
7318 pr " print_strings (r);\n";
7322 List.iter (generate_test_command_call test_name) seq;
7323 generate_test_command_call ~test test_name last
7324 | TestOutputBuffer (seq, expected) ->
7325 pr " /* TestOutputBuffer for %s (%d) */\n" name i;
7326 pr " const char *expected = \"%s\";\n" (c_quote expected);
7327 let seq, last = get_seq_last seq in
7328 let len = String.length expected in
7330 pr " if (size != %d) {\n" len;
7331 pr " fprintf (stderr, \"%s: returned size of buffer wrong, expected %d but got %%zu\\n\", size);\n" test_name len;
7334 pr " if (STRNEQLEN (r, expected, size)) {\n";
7335 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
7339 List.iter (generate_test_command_call test_name) seq;
7340 generate_test_command_call ~test test_name last
7341 | TestOutputStruct (seq, checks) ->
7342 pr " /* TestOutputStruct for %s (%d) */\n" name i;
7343 let seq, last = get_seq_last seq in
7347 | CompareWithInt (field, expected) ->
7348 pr " if (r->%s != %d) {\n" field expected;
7349 pr " fprintf (stderr, \"%s: %s was %%d, expected %d\\n\",\n"
7350 test_name field expected;
7351 pr " (int) r->%s);\n" field;
7354 | CompareWithIntOp (field, op, expected) ->
7355 pr " if (!(r->%s %s %d)) {\n" field op expected;
7356 pr " fprintf (stderr, \"%s: %s was %%d, expected %s %d\\n\",\n"
7357 test_name field op expected;
7358 pr " (int) r->%s);\n" field;
7361 | CompareWithString (field, expected) ->
7362 pr " if (STRNEQ (r->%s, \"%s\")) {\n" field expected;
7363 pr " fprintf (stderr, \"%s: %s was \"%%s\", expected \"%s\"\\n\",\n"
7364 test_name field expected;
7365 pr " r->%s);\n" field;
7368 | CompareFieldsIntEq (field1, field2) ->
7369 pr " if (r->%s != r->%s) {\n" field1 field2;
7370 pr " fprintf (stderr, \"%s: %s (%%d) <> %s (%%d)\\n\",\n"
7371 test_name field1 field2;
7372 pr " (int) r->%s, (int) r->%s);\n" field1 field2;
7375 | CompareFieldsStrEq (field1, field2) ->
7376 pr " if (STRNEQ (r->%s, r->%s)) {\n" field1 field2;
7377 pr " fprintf (stderr, \"%s: %s (\"%%s\") <> %s (\"%%s\")\\n\",\n"
7378 test_name field1 field2;
7379 pr " r->%s, r->%s);\n" field1 field2;
7384 List.iter (generate_test_command_call test_name) seq;
7385 generate_test_command_call ~test test_name last
7386 | TestLastFail seq ->
7387 pr " /* TestLastFail for %s (%d) */\n" name i;
7388 let seq, last = get_seq_last seq in
7389 List.iter (generate_test_command_call test_name) seq;
7390 generate_test_command_call test_name ~expect_error:true last
7392 (* Generate the code to run a command, leaving the result in 'r'.
7393 * If you expect to get an error then you should set expect_error:true.
7395 and generate_test_command_call ?(expect_error = false) ?test test_name cmd =
7397 | [] -> assert false
7399 (* Look up the command to find out what args/ret it has. *)
7402 let _, style, _, _, _, _, _ =
7403 List.find (fun (n, _, _, _, _, _, _) -> n = name) all_functions in
7406 failwithf "%s: in test, command %s was not found" test_name name in
7408 if List.length (snd style) <> List.length args then
7409 failwithf "%s: in test, wrong number of args given to %s"
7416 | OptString n, "NULL" -> ()
7419 | Dev_or_Path n, arg
7421 | OptString n, arg ->
7422 pr " const char *%s = \"%s\";\n" n (c_quote arg);
7423 | BufferIn n, arg ->
7424 pr " const char *%s = \"%s\";\n" n (c_quote arg);
7425 pr " size_t %s_size = %d;\n" n (String.length arg)
7429 | FileIn _, _ | FileOut _, _ -> ()
7430 | StringList n, "" | DeviceList n, "" ->
7431 pr " const char *const %s[1] = { NULL };\n" n
7432 | StringList n, arg | DeviceList n, arg ->
7433 let strs = string_split " " arg in
7436 pr " const char *%s_%d = \"%s\";\n" n i (c_quote str);
7438 pr " const char *const %s[] = {\n" n;
7440 fun i _ -> pr " %s_%d,\n" n i
7444 ) (List.combine (snd style) args);
7447 match fst style with
7448 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
7449 | RInt64 _ -> pr " int64_t r;\n"; "-1"
7450 | RConstString _ | RConstOptString _ ->
7451 pr " const char *r;\n"; "NULL"
7452 | RString _ -> pr " char *r;\n"; "NULL"
7453 | RStringList _ | RHashtable _ ->
7457 | RStruct (_, typ) ->
7458 pr " struct guestfs_%s *r;\n" typ; "NULL"
7459 | RStructList (_, typ) ->
7460 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
7463 pr " size_t size;\n";
7466 pr " suppress_error = %d;\n" (if expect_error then 1 else 0);
7467 pr " r = guestfs_%s (g" name;
7469 (* Generate the parameters. *)
7472 | OptString _, "NULL" -> pr ", NULL"
7474 | Device n, _ | Dev_or_Path n, _
7479 pr ", %s, %s_size" n n
7480 | FileIn _, arg | FileOut _, arg ->
7481 pr ", \"%s\"" (c_quote arg)
7482 | StringList n, _ | DeviceList n, _ ->
7483 pr ", (char **) %s" n
7486 try int_of_string arg
7487 with Failure "int_of_string" ->
7488 failwithf "%s: expecting an int, but got '%s'" test_name arg in
7492 try Int64.of_string arg
7493 with Failure "int_of_string" ->
7494 failwithf "%s: expecting an int64, but got '%s'" test_name arg in
7497 let b = bool_of_string arg in pr ", %d" (if b then 1 else 0)
7498 ) (List.combine (snd style) args);
7500 (match fst style with
7501 | RBufferOut _ -> pr ", &size"
7507 if not expect_error then
7508 pr " if (r == %s)\n" error_code
7510 pr " if (r != %s)\n" error_code;
7513 (* Insert the test code. *)
7519 (match fst style with
7520 | RErr | RInt _ | RInt64 _ | RBool _
7521 | RConstString _ | RConstOptString _ -> ()
7522 | RString _ | RBufferOut _ -> pr " free (r);\n"
7523 | RStringList _ | RHashtable _ ->
7524 pr " for (i = 0; r[i] != NULL; ++i)\n";
7525 pr " free (r[i]);\n";
7527 | RStruct (_, typ) ->
7528 pr " guestfs_free_%s (r);\n" typ
7529 | RStructList (_, typ) ->
7530 pr " guestfs_free_%s_list (r);\n" typ
7536 let str = replace_str str "\r" "\\r" in
7537 let str = replace_str str "\n" "\\n" in
7538 let str = replace_str str "\t" "\\t" in
7539 let str = replace_str str "\000" "\\0" in
7542 (* Generate a lot of different functions for guestfish. *)
7543 and generate_fish_cmds () =
7544 generate_header CStyle GPLv2plus;
7548 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
7550 let all_functions_sorted =
7552 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
7553 ) all_functions_sorted in
7555 pr "#include <config.h>\n";
7557 pr "#include <stdio.h>\n";
7558 pr "#include <stdlib.h>\n";
7559 pr "#include <string.h>\n";
7560 pr "#include <inttypes.h>\n";
7562 pr "#include <guestfs.h>\n";
7563 pr "#include \"c-ctype.h\"\n";
7564 pr "#include \"full-write.h\"\n";
7565 pr "#include \"xstrtol.h\"\n";
7566 pr "#include \"fish.h\"\n";
7568 pr "/* Valid suffixes allowed for numbers. See Gnulib xstrtol function. */\n";
7569 pr "static const char *xstrtol_suffixes = \"0kKMGTPEZY\";\n";
7572 (* list_commands function, which implements guestfish -h *)
7573 pr "void list_commands (void)\n";
7575 pr " printf (\" %%-16s %%s\\n\", _(\"Command\"), _(\"Description\"));\n";
7576 pr " list_builtin_commands ();\n";
7578 fun (name, _, _, flags, _, shortdesc, _) ->
7579 let name = replace_char name '_' '-' in
7580 pr " printf (\"%%-20s %%s\\n\", \"%s\", _(\"%s\"));\n"
7582 ) all_functions_sorted;
7583 pr " printf (\" %%s\\n\",";
7584 pr " _(\"Use -h <cmd> / help <cmd> to show detailed help for a command.\"));\n";
7588 (* display_command function, which implements guestfish -h cmd *)
7589 pr "int display_command (const char *cmd)\n";
7592 fun (name, style, _, flags, _, shortdesc, longdesc) ->
7593 let name2 = replace_char name '_' '-' in
7595 try find_map (function FishAlias n -> Some n | _ -> None) flags
7596 with Not_found -> name in
7597 let longdesc = replace_str longdesc "C<guestfs_" "C<" in
7599 match snd style with
7603 name2 (String.concat " " (List.map name_of_argt args)) in
7606 if List.mem ProtocolLimitWarning flags then
7607 ("\n\n" ^ protocol_limit_warning)
7610 (* For DangerWillRobinson commands, we should probably have
7611 * guestfish prompt before allowing you to use them (especially
7612 * in interactive mode). XXX
7616 if List.mem DangerWillRobinson flags then
7617 ("\n\n" ^ danger_will_robinson)
7622 match deprecation_notice flags with
7624 | Some txt -> "\n\n" ^ txt in
7626 let describe_alias =
7627 if name <> alias then
7628 sprintf "\n\nYou can use '%s' as an alias for this command." alias
7632 pr "STRCASEEQ (cmd, \"%s\")" name;
7633 if name <> name2 then
7634 pr " || STRCASEEQ (cmd, \"%s\")" name2;
7635 if name <> alias then
7636 pr " || STRCASEEQ (cmd, \"%s\")" alias;
7638 pr " pod2text (\"%s\", _(\"%s\"), %S);\n"
7640 ("=head1 SYNOPSIS\n\n " ^ synopsis ^ "\n\n" ^
7641 "=head1 DESCRIPTION\n\n" ^
7642 longdesc ^ warnings ^ describe_alias);
7647 pr " return display_builtin_command (cmd);\n";
7651 let emit_print_list_function typ =
7652 pr "static void print_%s_list (struct guestfs_%s_list *%ss)\n"
7655 pr " unsigned int i;\n";
7657 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
7658 pr " printf (\"[%%d] = {\\n\", i);\n";
7659 pr " print_%s_indent (&%ss->val[i], \" \");\n" typ typ;
7660 pr " printf (\"}\\n\");\n";
7666 (* print_* functions *)
7670 List.exists (function (_, (FUUID|FBuffer)) -> true | _ -> false) cols in
7672 pr "static void print_%s_indent (struct guestfs_%s *%s, const char *indent)\n" typ typ typ;
7675 pr " unsigned int i;\n";
7681 pr " printf (\"%%s%s: %%s\\n\", indent, %s->%s);\n" name typ name
7683 pr " printf (\"%%s%s: \", indent);\n" name;
7684 pr " for (i = 0; i < 32; ++i)\n";
7685 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
7686 pr " printf (\"\\n\");\n"
7688 pr " printf (\"%%s%s: \", indent);\n" name;
7689 pr " for (i = 0; i < %s->%s_len; ++i)\n" typ name;
7690 pr " if (c_isprint (%s->%s[i]))\n" typ name;
7691 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
7693 pr " printf (\"\\\\x%%02x\", %s->%s[i]);\n" typ name;
7694 pr " printf (\"\\n\");\n"
7695 | name, (FUInt64|FBytes) ->
7696 pr " printf (\"%%s%s: %%\" PRIu64 \"\\n\", indent, %s->%s);\n"
7699 pr " printf (\"%%s%s: %%\" PRIi64 \"\\n\", indent, %s->%s);\n"
7702 pr " printf (\"%%s%s: %%\" PRIu32 \"\\n\", indent, %s->%s);\n"
7705 pr " printf (\"%%s%s: %%\" PRIi32 \"\\n\", indent, %s->%s);\n"
7708 pr " printf (\"%%s%s: %%c\\n\", indent, %s->%s);\n"
7710 | name, FOptPercent ->
7711 pr " if (%s->%s >= 0) printf (\"%%s%s: %%g %%%%\\n\", indent, %s->%s);\n"
7712 typ name name typ name;
7713 pr " else printf (\"%%s%s: \\n\", indent);\n" name
7719 (* Emit a print_TYPE_list function definition only if that function is used. *)
7722 | typ, (RStructListOnly | RStructAndList) ->
7723 (* generate the function for typ *)
7724 emit_print_list_function typ
7725 | typ, _ -> () (* empty *)
7726 ) (rstructs_used_by all_functions);
7728 (* Emit a print_TYPE function definition only if that function is used. *)
7731 | typ, (RStructOnly | RStructAndList) ->
7732 pr "static void print_%s (struct guestfs_%s *%s)\n" typ typ typ;
7734 pr " print_%s_indent (%s, \"\");\n" typ typ;
7737 | typ, _ -> () (* empty *)
7738 ) (rstructs_used_by all_functions);
7740 (* run_<action> actions *)
7742 fun (name, style, _, flags, _, _, _) ->
7743 pr "static int run_%s (const char *cmd, int argc, char *argv[])\n" name;
7745 (match fst style with
7748 | RBool _ -> pr " int r;\n"
7749 | RInt64 _ -> pr " int64_t r;\n"
7750 | RConstString _ | RConstOptString _ -> pr " const char *r;\n"
7751 | RString _ -> pr " char *r;\n"
7752 | RStringList _ | RHashtable _ -> pr " char **r;\n"
7753 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ
7754 | RStructList (_, typ) -> pr " struct guestfs_%s_list *r;\n" typ
7757 pr " size_t size;\n";
7763 | OptString n -> pr " const char *%s;\n" n
7767 | FileOut n -> pr " char *%s;\n" n
7769 pr " const char *%s;\n" n;
7770 pr " size_t %s_size;\n" n
7771 | StringList n | DeviceList n -> pr " char **%s;\n" n
7772 | Bool n -> pr " int %s;\n" n
7773 | Int n -> pr " int %s;\n" n
7774 | Int64 n -> pr " int64_t %s;\n" n
7777 (* Check and convert parameters. *)
7778 let argc_expected = List.length (snd style) in
7779 pr " if (argc != %d) {\n" argc_expected;
7780 pr " fprintf (stderr, _(\"%%s should have %%d parameter(s)\\n\"), cmd, %d);\n"
7782 pr " fprintf (stderr, _(\"type 'help %%s' for help on %%s\\n\"), cmd, cmd);\n";
7786 let parse_integer fn fntyp rtyp range name i =
7788 pr " strtol_error xerr;\n";
7789 pr " %s r;\n" fntyp;
7791 pr " xerr = %s (argv[%d], NULL, 0, &r, xstrtol_suffixes);\n" fn i;
7792 pr " if (xerr != LONGINT_OK) {\n";
7793 pr " fprintf (stderr,\n";
7794 pr " _(\"%%s: %%s: invalid integer parameter (%%s returned %%d)\\n\"),\n";
7795 pr " cmd, \"%s\", \"%s\", xerr);\n" name fn;
7800 | Some (min, max, comment) ->
7801 pr " /* %s */\n" comment;
7802 pr " if (r < %s || r > %s) {\n" min max;
7803 pr " fprintf (stderr, _(\"%%s: %%s: integer out of range\\n\"), cmd, \"%s\");\n"
7807 pr " /* The check above should ensure this assignment does not overflow. */\n";
7809 pr " %s = r;\n" name;
7818 pr " %s = argv[%d];\n" name i
7820 | Dev_or_Path name ->
7821 pr " %s = resolve_win_path (argv[%d]);\n" name i;
7822 pr " if (%s == NULL) return -1;\n" name
7824 pr " %s = STRNEQ (argv[%d], \"\") ? argv[%d] : NULL;\n"
7827 pr " %s = argv[%d];\n" name i;
7828 pr " %s_size = strlen (argv[%d]);\n" name i
7830 pr " %s = file_in (argv[%d]);\n" name i;
7831 pr " if (%s == NULL) return -1;\n" name
7833 pr " %s = file_out (argv[%d]);\n" name i;
7834 pr " if (%s == NULL) return -1;\n" name
7835 | StringList name | DeviceList name ->
7836 pr " %s = parse_string_list (argv[%d]);\n" name i;
7837 pr " if (%s == NULL) return -1;\n" name;
7839 pr " %s = is_true (argv[%d]) ? 1 : 0;\n" name i
7842 let min = "(-(2LL<<30))"
7843 and max = "((2LL<<30)-1)"
7845 "The Int type in the generator is a signed 31 bit int." in
7846 Some (min, max, comment) in
7847 parse_integer "xstrtoll" "long long" "int" range name i
7849 parse_integer "xstrtoll" "long long" "int64_t" None name i
7852 (* Call C API function. *)
7853 pr " r = guestfs_%s " name;
7854 generate_c_call_args ~handle:"g" style;
7859 | Device name | String name
7860 | OptString name | Bool name
7861 | Int name | Int64 name
7862 | BufferIn name -> ()
7863 | Pathname name | Dev_or_Path name | FileOut name ->
7864 pr " free (%s);\n" name
7866 pr " free_file_in (%s);\n" name
7867 | StringList name | DeviceList name ->
7868 pr " free_strings (%s);\n" name
7871 (* Any output flags? *)
7873 let flags = filter_map (
7874 function FishOutput flag -> Some flag | _ -> None
7880 failwithf "%s: more than one FishOutput flag is not allowed" name in
7882 (* Check return value for errors and display command results. *)
7883 (match fst style with
7884 | RErr -> pr " return r;\n"
7886 pr " if (r == -1) return -1;\n";
7887 (match fish_output with
7889 pr " printf (\"%%d\\n\", r);\n";
7890 | Some FishOutputOctal ->
7891 pr " printf (\"%%s%%o\\n\", r != 0 ? \"0\" : \"\", r);\n";
7892 | Some FishOutputHexadecimal ->
7893 pr " printf (\"%%s%%x\\n\", r != 0 ? \"0x\" : \"\", r);\n");
7896 pr " if (r == -1) return -1;\n";
7897 (match fish_output with
7899 pr " printf (\"%%\" PRIi64 \"\\n\", r);\n";
7900 | Some FishOutputOctal ->
7901 pr " printf (\"%%s%%\" PRIo64 \"\\n\", r != 0 ? \"0\" : \"\", r);\n";
7902 | Some FishOutputHexadecimal ->
7903 pr " printf (\"%%s%%\" PRIx64 \"\\n\", r != 0 ? \"0x\" : \"\", r);\n");
7906 pr " if (r == -1) return -1;\n";
7907 pr " if (r) printf (\"true\\n\"); else printf (\"false\\n\");\n";
7910 pr " if (r == NULL) return -1;\n";
7911 pr " printf (\"%%s\\n\", r);\n";
7913 | RConstOptString _ ->
7914 pr " printf (\"%%s\\n\", r ? : \"(null)\");\n";
7917 pr " if (r == NULL) return -1;\n";
7918 pr " printf (\"%%s\\n\", r);\n";
7922 pr " if (r == NULL) return -1;\n";
7923 pr " print_strings (r);\n";
7924 pr " free_strings (r);\n";
7926 | RStruct (_, typ) ->
7927 pr " if (r == NULL) return -1;\n";
7928 pr " print_%s (r);\n" typ;
7929 pr " guestfs_free_%s (r);\n" typ;
7931 | RStructList (_, typ) ->
7932 pr " if (r == NULL) return -1;\n";
7933 pr " print_%s_list (r);\n" typ;
7934 pr " guestfs_free_%s_list (r);\n" typ;
7937 pr " if (r == NULL) return -1;\n";
7938 pr " print_table (r);\n";
7939 pr " free_strings (r);\n";
7942 pr " if (r == NULL) return -1;\n";
7943 pr " if (full_write (1, r, size) != size) {\n";
7944 pr " perror (\"write\");\n";
7955 (* run_action function *)
7956 pr "int run_action (const char *cmd, int argc, char *argv[])\n";
7959 fun (name, _, _, flags, _, _, _) ->
7960 let name2 = replace_char name '_' '-' in
7962 try find_map (function FishAlias n -> Some n | _ -> None) flags
7963 with Not_found -> name in
7965 pr "STRCASEEQ (cmd, \"%s\")" name;
7966 if name <> name2 then
7967 pr " || STRCASEEQ (cmd, \"%s\")" name2;
7968 if name <> alias then
7969 pr " || STRCASEEQ (cmd, \"%s\")" alias;
7971 pr " return run_%s (cmd, argc, argv);\n" name;
7975 pr " fprintf (stderr, _(\"%%s: unknown command\\n\"), cmd);\n";
7976 pr " if (command_num == 1)\n";
7977 pr " extended_help_message ();\n";
7984 (* Readline completion for guestfish. *)
7985 and generate_fish_completion () =
7986 generate_header CStyle GPLv2plus;
7990 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
8000 #ifdef HAVE_LIBREADLINE
8001 #include <readline/readline.h>
8006 #ifdef HAVE_LIBREADLINE
8008 static const char *const commands[] = {
8009 BUILTIN_COMMANDS_FOR_COMPLETION,
8012 (* Get the commands, including the aliases. They don't need to be
8013 * sorted - the generator() function just does a dumb linear search.
8017 fun (name, _, _, flags, _, _, _) ->
8018 let name2 = replace_char name '_' '-' in
8020 try find_map (function FishAlias n -> Some n | _ -> None) flags
8021 with Not_found -> name in
8023 if name <> alias then [name2; alias] else [name2]
8025 let commands = List.flatten commands in
8027 List.iter (pr " \"%s\",\n") commands;
8033 generator (const char *text, int state)
8035 static int index, len;
8040 len = strlen (text);
8043 rl_attempted_completion_over = 1;
8045 while ((name = commands[index]) != NULL) {
8047 if (STRCASEEQLEN (name, text, len))
8048 return strdup (name);
8054 #endif /* HAVE_LIBREADLINE */
8056 #ifdef HAVE_RL_COMPLETION_MATCHES
8057 #define RL_COMPLETION_MATCHES rl_completion_matches
8059 #ifdef HAVE_COMPLETION_MATCHES
8060 #define RL_COMPLETION_MATCHES completion_matches
8062 #endif /* else just fail if we don't have either symbol */
8065 do_completion (const char *text, int start, int end)
8067 char **matches = NULL;
8069 #ifdef HAVE_LIBREADLINE
8070 rl_completion_append_character = ' ';
8073 matches = RL_COMPLETION_MATCHES (text, generator);
8074 else if (complete_dest_paths)
8075 matches = RL_COMPLETION_MATCHES (text, complete_dest_paths_generator);
8082 (* Generate the POD documentation for guestfish. *)
8083 and generate_fish_actions_pod () =
8084 let all_functions_sorted =
8086 fun (_, _, _, flags, _, _, _) ->
8087 not (List.mem NotInFish flags || List.mem NotInDocs flags)
8088 ) all_functions_sorted in
8090 let rex = Str.regexp "C<guestfs_\\([^>]+\\)>" in
8093 fun (name, style, _, flags, _, _, longdesc) ->
8095 Str.global_substitute rex (
8098 try Str.matched_group 1 s
8100 failwithf "error substituting C<guestfs_...> in longdesc of function %s" name in
8101 "C<" ^ replace_char sub '_' '-' ^ ">"
8103 let name = replace_char name '_' '-' in
8105 try find_map (function FishAlias n -> Some n | _ -> None) flags
8106 with Not_found -> name in
8108 pr "=head2 %s" name;
8109 if name <> alias then
8116 | Pathname n | Device n | Dev_or_Path n | String n -> pr " %s" n
8117 | OptString n -> pr " %s" n
8118 | StringList n | DeviceList n -> pr " '%s ...'" n
8119 | Bool _ -> pr " true|false"
8120 | Int n -> pr " %s" n
8121 | Int64 n -> pr " %s" n
8122 | FileIn n | FileOut n -> pr " (%s|-)" n
8123 | BufferIn n -> pr " %s" n
8127 pr "%s\n\n" longdesc;
8129 if List.exists (function FileIn _ | FileOut _ -> true
8130 | _ -> false) (snd style) then
8131 pr "Use C<-> instead of a filename to read/write from stdin/stdout.\n\n";
8133 if List.mem ProtocolLimitWarning flags then
8134 pr "%s\n\n" protocol_limit_warning;
8136 if List.mem DangerWillRobinson flags then
8137 pr "%s\n\n" danger_will_robinson;
8139 match deprecation_notice flags with
8141 | Some txt -> pr "%s\n\n" txt
8142 ) all_functions_sorted
8144 (* Generate a C function prototype. *)
8145 and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true)
8146 ?(single_line = false) ?(newline = false) ?(in_daemon = false)
8148 ?handle name style =
8149 if extern then pr "extern ";
8150 if static then pr "static ";
8151 (match fst style with
8153 | RInt _ -> pr "int "
8154 | RInt64 _ -> pr "int64_t "
8155 | RBool _ -> pr "int "
8156 | RConstString _ | RConstOptString _ -> pr "const char *"
8157 | RString _ | RBufferOut _ -> pr "char *"
8158 | RStringList _ | RHashtable _ -> pr "char **"
8159 | RStruct (_, typ) ->
8160 if not in_daemon then pr "struct guestfs_%s *" typ
8161 else pr "guestfs_int_%s *" typ
8162 | RStructList (_, typ) ->
8163 if not in_daemon then pr "struct guestfs_%s_list *" typ
8164 else pr "guestfs_int_%s_list *" typ
8166 let is_RBufferOut = match fst style with RBufferOut _ -> true | _ -> false in
8167 pr "%s%s (" prefix name;
8168 if handle = None && List.length (snd style) = 0 && not is_RBufferOut then
8171 let comma = ref false in
8174 | Some handle -> pr "guestfs_h *%s" handle; comma := true
8178 if single_line then pr ", " else pr ",\n\t\t"
8185 | Device n | Dev_or_Path n
8189 pr "const char *%s" n
8190 | StringList n | DeviceList n ->
8192 pr "char *const *%s" n
8193 | Bool n -> next (); pr "int %s" n
8194 | Int n -> next (); pr "int %s" n
8195 | Int64 n -> next (); pr "int64_t %s" n
8198 if not in_daemon then (next (); pr "const char *%s" n)
8201 pr "const char *%s" n;
8203 pr "size_t %s_size" n
8205 if is_RBufferOut then (next (); pr "size_t *size_r");
8208 if semicolon then pr ";";
8209 if newline then pr "\n"
8211 (* Generate C call arguments, eg "(handle, foo, bar)" *)
8212 and generate_c_call_args ?handle ?(decl = false) style =
8214 let comma = ref false in
8216 if !comma then pr ", ";
8221 | Some handle -> pr "%s" handle; comma := true
8227 pr "%s, %s_size" n n
8230 pr "%s" (name_of_argt arg)
8232 (* For RBufferOut calls, add implicit &size parameter. *)
8234 match fst style with
8242 (* Generate the OCaml bindings interface. *)
8243 and generate_ocaml_mli () =
8244 generate_header OCamlStyle LGPLv2plus;
8247 (** For API documentation you should refer to the C API
8248 in the guestfs(3) manual page. The OCaml API uses almost
8249 exactly the same calls. *)
8252 (** A [guestfs_h] handle. *)
8254 exception Error of string
8255 (** This exception is raised when there is an error. *)
8257 exception Handle_closed of string
8258 (** This exception is raised if you use a {!Guestfs.t} handle
8259 after calling {!close} on it. The string is the name of
8262 val create : unit -> t
8263 (** Create a {!Guestfs.t} handle. *)
8265 val close : t -> unit
8266 (** Close the {!Guestfs.t} handle and free up all resources used
8269 Handles are closed by the garbage collector when they become
8270 unreferenced, but callers can call this in order to provide
8271 predictable cleanup. *)
8274 generate_ocaml_structure_decls ();
8278 fun (name, style, _, _, _, shortdesc, _) ->
8279 generate_ocaml_prototype name style;
8280 pr "(** %s *)\n" shortdesc;
8282 ) all_functions_sorted
8284 (* Generate the OCaml bindings implementation. *)
8285 and generate_ocaml_ml () =
8286 generate_header OCamlStyle LGPLv2plus;
8291 exception Error of string
8292 exception Handle_closed of string
8294 external create : unit -> t = \"ocaml_guestfs_create\"
8295 external close : t -> unit = \"ocaml_guestfs_close\"
8297 (* Give the exceptions names, so they can be raised from the C code. *)
8299 Callback.register_exception \"ocaml_guestfs_error\" (Error \"\");
8300 Callback.register_exception \"ocaml_guestfs_closed\" (Handle_closed \"\")
8304 generate_ocaml_structure_decls ();
8308 fun (name, style, _, _, _, shortdesc, _) ->
8309 generate_ocaml_prototype ~is_external:true name style;
8310 ) all_functions_sorted
8312 (* Generate the OCaml bindings C implementation. *)
8313 and generate_ocaml_c () =
8314 generate_header CStyle LGPLv2plus;
8321 #include <caml/config.h>
8322 #include <caml/alloc.h>
8323 #include <caml/callback.h>
8324 #include <caml/fail.h>
8325 #include <caml/memory.h>
8326 #include <caml/mlvalues.h>
8327 #include <caml/signals.h>
8329 #include <guestfs.h>
8331 #include \"guestfs_c.h\"
8333 /* Copy a hashtable of string pairs into an assoc-list. We return
8334 * the list in reverse order, but hashtables aren't supposed to be
8337 static CAMLprim value
8338 copy_table (char * const * argv)
8341 CAMLlocal5 (rv, pairv, kv, vv, cons);
8345 for (i = 0; argv[i] != NULL; i += 2) {
8346 kv = caml_copy_string (argv[i]);
8347 vv = caml_copy_string (argv[i+1]);
8348 pairv = caml_alloc (2, 0);
8349 Store_field (pairv, 0, kv);
8350 Store_field (pairv, 1, vv);
8351 cons = caml_alloc (2, 0);
8352 Store_field (cons, 1, rv);
8354 Store_field (cons, 0, pairv);
8362 (* Struct copy functions. *)
8364 let emit_ocaml_copy_list_function typ =
8365 pr "static CAMLprim value\n";
8366 pr "copy_%s_list (const struct guestfs_%s_list *%ss)\n" typ typ typ;
8368 pr " CAMLparam0 ();\n";
8369 pr " CAMLlocal2 (rv, v);\n";
8370 pr " unsigned int i;\n";
8372 pr " if (%ss->len == 0)\n" typ;
8373 pr " CAMLreturn (Atom (0));\n";
8375 pr " rv = caml_alloc (%ss->len, 0);\n" typ;
8376 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
8377 pr " v = copy_%s (&%ss->val[i]);\n" typ typ;
8378 pr " caml_modify (&Field (rv, i), v);\n";
8380 pr " CAMLreturn (rv);\n";
8388 let has_optpercent_col =
8389 List.exists (function (_, FOptPercent) -> true | _ -> false) cols in
8391 pr "static CAMLprim value\n";
8392 pr "copy_%s (const struct guestfs_%s *%s)\n" typ typ typ;
8394 pr " CAMLparam0 ();\n";
8395 if has_optpercent_col then
8396 pr " CAMLlocal3 (rv, v, v2);\n"
8398 pr " CAMLlocal2 (rv, v);\n";
8400 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
8405 pr " v = caml_copy_string (%s->%s);\n" typ name
8407 pr " v = caml_alloc_string (%s->%s_len);\n" typ name;
8408 pr " memcpy (String_val (v), %s->%s, %s->%s_len);\n"
8411 pr " v = caml_alloc_string (32);\n";
8412 pr " memcpy (String_val (v), %s->%s, 32);\n" typ name
8413 | name, (FBytes|FInt64|FUInt64) ->
8414 pr " v = caml_copy_int64 (%s->%s);\n" typ name
8415 | name, (FInt32|FUInt32) ->
8416 pr " v = caml_copy_int32 (%s->%s);\n" typ name
8417 | name, FOptPercent ->
8418 pr " if (%s->%s >= 0) { /* Some %s */\n" typ name name;
8419 pr " v2 = caml_copy_double (%s->%s);\n" typ name;
8420 pr " v = caml_alloc (1, 0);\n";
8421 pr " Store_field (v, 0, v2);\n";
8422 pr " } else /* None */\n";
8423 pr " v = Val_int (0);\n";
8425 pr " v = Val_int (%s->%s);\n" typ name
8427 pr " Store_field (rv, %d, v);\n" i
8429 pr " CAMLreturn (rv);\n";
8434 (* Emit a copy_TYPE_list function definition only if that function is used. *)
8437 | typ, (RStructListOnly | RStructAndList) ->
8438 (* generate the function for typ *)
8439 emit_ocaml_copy_list_function typ
8440 | typ, _ -> () (* empty *)
8441 ) (rstructs_used_by all_functions);
8445 fun (name, style, _, _, _, _, _) ->
8446 pr "/* Automatically generated wrapper for function\n";
8448 generate_ocaml_prototype name style;
8453 "gv" :: List.map (fun arg -> name_of_argt arg ^ "v") (snd style) in
8455 let needs_extra_vs =
8456 match fst style with RConstOptString _ -> true | _ -> false in
8458 pr "/* Emit prototype to appease gcc's -Wmissing-prototypes. */\n";
8459 pr "CAMLprim value ocaml_guestfs_%s (value %s" name (List.hd params);
8460 List.iter (pr ", value %s") (List.tl params); pr ");\n";
8463 pr "CAMLprim value\n";
8464 pr "ocaml_guestfs_%s (value %s" name (List.hd params);
8465 List.iter (pr ", value %s") (List.tl params);
8470 | [p1; p2; p3; p4; p5] ->
8471 pr " CAMLparam5 (%s);\n" (String.concat ", " params)
8472 | p1 :: p2 :: p3 :: p4 :: p5 :: rest ->
8473 pr " CAMLparam5 (%s);\n" (String.concat ", " [p1; p2; p3; p4; p5]);
8474 pr " CAMLxparam%d (%s);\n"
8475 (List.length rest) (String.concat ", " rest)
8477 pr " CAMLparam%d (%s);\n" (List.length ps) (String.concat ", " ps)
8479 if not needs_extra_vs then
8480 pr " CAMLlocal1 (rv);\n"
8482 pr " CAMLlocal3 (rv, v, v2);\n";
8485 pr " guestfs_h *g = Guestfs_val (gv);\n";
8486 pr " if (g == NULL)\n";
8487 pr " ocaml_guestfs_raise_closed (\"%s\");\n" name;
8493 | Device n | Dev_or_Path n
8497 pr " const char *%s = String_val (%sv);\n" n n
8499 pr " const char *%s =\n" n;
8500 pr " %sv != Val_int (0) ? String_val (Field (%sv, 0)) : NULL;\n"
8503 pr " const char *%s = String_val (%sv);\n" n n;
8504 pr " size_t %s_size = caml_string_length (%sv);\n" n n
8505 | StringList n | DeviceList n ->
8506 pr " char **%s = ocaml_guestfs_strings_val (g, %sv);\n" n n
8508 pr " int %s = Bool_val (%sv);\n" n n
8510 pr " int %s = Int_val (%sv);\n" n n
8512 pr " int64_t %s = Int64_val (%sv);\n" n n
8515 match fst style with
8516 | RErr -> pr " int r;\n"; "-1"
8517 | RInt _ -> pr " int r;\n"; "-1"
8518 | RInt64 _ -> pr " int64_t r;\n"; "-1"
8519 | RBool _ -> pr " int r;\n"; "-1"
8520 | RConstString _ | RConstOptString _ ->
8521 pr " const char *r;\n"; "NULL"
8522 | RString _ -> pr " char *r;\n"; "NULL"
8527 | RStruct (_, typ) ->
8528 pr " struct guestfs_%s *r;\n" typ; "NULL"
8529 | RStructList (_, typ) ->
8530 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
8537 pr " size_t size;\n";
8541 pr " caml_enter_blocking_section ();\n";
8542 pr " r = guestfs_%s " name;
8543 generate_c_call_args ~handle:"g" style;
8545 pr " caml_leave_blocking_section ();\n";
8549 | StringList n | DeviceList n ->
8550 pr " ocaml_guestfs_free_strings (%s);\n" n;
8551 | Pathname _ | Device _ | Dev_or_Path _ | String _ | OptString _
8552 | Bool _ | Int _ | Int64 _
8553 | FileIn _ | FileOut _ | BufferIn _ -> ()
8556 pr " if (r == %s)\n" error_code;
8557 pr " ocaml_guestfs_raise_error (g, \"%s\");\n" name;
8560 (match fst style with
8561 | RErr -> pr " rv = Val_unit;\n"
8562 | RInt _ -> pr " rv = Val_int (r);\n"
8564 pr " rv = caml_copy_int64 (r);\n"
8565 | RBool _ -> pr " rv = Val_bool (r);\n"
8567 pr " rv = caml_copy_string (r);\n"
8568 | RConstOptString _ ->
8569 pr " if (r) { /* Some string */\n";
8570 pr " v = caml_alloc (1, 0);\n";
8571 pr " v2 = caml_copy_string (r);\n";
8572 pr " Store_field (v, 0, v2);\n";
8573 pr " } else /* None */\n";
8574 pr " v = Val_int (0);\n";
8576 pr " rv = caml_copy_string (r);\n";
8579 pr " rv = caml_copy_string_array ((const char **) r);\n";
8580 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
8582 | RStruct (_, typ) ->
8583 pr " rv = copy_%s (r);\n" typ;
8584 pr " guestfs_free_%s (r);\n" typ;
8585 | RStructList (_, typ) ->
8586 pr " rv = copy_%s_list (r);\n" typ;
8587 pr " guestfs_free_%s_list (r);\n" typ;
8589 pr " rv = copy_table (r);\n";
8590 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
8593 pr " rv = caml_alloc_string (size);\n";
8594 pr " memcpy (String_val (rv), r, size);\n";
8597 pr " CAMLreturn (rv);\n";
8601 if List.length params > 5 then (
8602 pr "/* Emit prototype to appease gcc's -Wmissing-prototypes. */\n";
8603 pr "CAMLprim value ";
8604 pr "ocaml_guestfs_%s_byte (value *argv, int argn);\n" name;
8605 pr "CAMLprim value\n";
8606 pr "ocaml_guestfs_%s_byte (value *argv, int argn)\n" name;
8608 pr " return ocaml_guestfs_%s (argv[0]" name;
8609 iteri (fun i _ -> pr ", argv[%d]" i) (List.tl params);
8614 ) all_functions_sorted
8616 and generate_ocaml_structure_decls () =
8619 pr "type %s = {\n" typ;
8622 | name, FString -> pr " %s : string;\n" name
8623 | name, FBuffer -> pr " %s : string;\n" name
8624 | name, FUUID -> pr " %s : string;\n" name
8625 | name, (FBytes|FInt64|FUInt64) -> pr " %s : int64;\n" name
8626 | name, (FInt32|FUInt32) -> pr " %s : int32;\n" name
8627 | name, FChar -> pr " %s : char;\n" name
8628 | name, FOptPercent -> pr " %s : float option;\n" name
8634 and generate_ocaml_prototype ?(is_external = false) name style =
8635 if is_external then pr "external " else pr "val ";
8636 pr "%s : t -> " name;
8639 | Pathname _ | Device _ | Dev_or_Path _ | String _ | FileIn _ | FileOut _
8640 | BufferIn _ -> pr "string -> "
8641 | OptString _ -> pr "string option -> "
8642 | StringList _ | DeviceList _ -> pr "string array -> "
8643 | Bool _ -> pr "bool -> "
8644 | Int _ -> pr "int -> "
8645 | Int64 _ -> pr "int64 -> "
8647 (match fst style with
8648 | RErr -> pr "unit" (* all errors are turned into exceptions *)
8649 | RInt _ -> pr "int"
8650 | RInt64 _ -> pr "int64"
8651 | RBool _ -> pr "bool"
8652 | RConstString _ -> pr "string"
8653 | RConstOptString _ -> pr "string option"
8654 | RString _ | RBufferOut _ -> pr "string"
8655 | RStringList _ -> pr "string array"
8656 | RStruct (_, typ) -> pr "%s" typ
8657 | RStructList (_, typ) -> pr "%s array" typ
8658 | RHashtable _ -> pr "(string * string) list"
8660 if is_external then (
8662 if List.length (snd style) + 1 > 5 then
8663 pr "\"ocaml_guestfs_%s_byte\" " name;
8664 pr "\"ocaml_guestfs_%s\"" name
8668 (* Generate Perl xs code, a sort of crazy variation of C with macros. *)
8669 and generate_perl_xs () =
8670 generate_header CStyle LGPLv2plus;
8673 #include \"EXTERN.h\"
8677 #include <guestfs.h>
8680 #define PRId64 \"lld\"
8684 my_newSVll(long long val) {
8685 #ifdef USE_64_BIT_ALL
8686 return newSViv(val);
8690 len = snprintf(buf, 100, \"%%\" PRId64, val);
8691 return newSVpv(buf, len);
8696 #define PRIu64 \"llu\"
8700 my_newSVull(unsigned long long val) {
8701 #ifdef USE_64_BIT_ALL
8702 return newSVuv(val);
8706 len = snprintf(buf, 100, \"%%\" PRIu64, val);
8707 return newSVpv(buf, len);
8711 /* http://www.perlmonks.org/?node_id=680842 */
8713 XS_unpack_charPtrPtr (SV *arg) {
8718 if (!arg || !SvOK (arg) || !SvROK (arg) || SvTYPE (SvRV (arg)) != SVt_PVAV)
8719 croak (\"array reference expected\");
8721 av = (AV *)SvRV (arg);
8722 ret = malloc ((av_len (av) + 1 + 1) * sizeof (char *));
8724 croak (\"malloc failed\");
8726 for (i = 0; i <= av_len (av); i++) {
8727 SV **elem = av_fetch (av, i, 0);
8729 if (!elem || !*elem)
8730 croak (\"missing element in list\");
8732 ret[i] = SvPV_nolen (*elem);
8740 MODULE = Sys::Guestfs PACKAGE = Sys::Guestfs
8747 RETVAL = guestfs_create ();
8749 croak (\"could not create guestfs handle\");
8750 guestfs_set_error_handler (RETVAL, NULL, NULL);
8763 fun (name, style, _, _, _, _, _) ->
8764 (match fst style with
8765 | RErr -> pr "void\n"
8766 | RInt _ -> pr "SV *\n"
8767 | RInt64 _ -> pr "SV *\n"
8768 | RBool _ -> pr "SV *\n"
8769 | RConstString _ -> pr "SV *\n"
8770 | RConstOptString _ -> pr "SV *\n"
8771 | RString _ -> pr "SV *\n"
8772 | RBufferOut _ -> pr "SV *\n"
8774 | RStruct _ | RStructList _
8776 pr "void\n" (* all lists returned implictly on the stack *)
8778 (* Call and arguments. *)
8781 fun arg -> pr ", %s" (name_of_argt arg)
8784 pr " guestfs_h *g;\n";
8788 | Pathname n | Device n | Dev_or_Path n | String n
8789 | FileIn n | FileOut n ->
8792 pr " char *%s;\n" n;
8793 pr " size_t %s_size = SvCUR (ST(%d));\n" n (i+1)
8795 (* http://www.perlmonks.org/?node_id=554277
8796 * Note that the implicit handle argument means we have
8797 * to add 1 to the ST(x) operator.
8799 pr " char *%s = SvOK(ST(%d)) ? SvPV_nolen(ST(%d)) : NULL;\n" n (i+1) (i+1)
8800 | StringList n | DeviceList n -> pr " char **%s;\n" n
8801 | Bool n -> pr " int %s;\n" n
8802 | Int n -> pr " int %s;\n" n
8803 | Int64 n -> pr " int64_t %s;\n" n
8806 let do_cleanups () =
8809 | Pathname _ | Device _ | Dev_or_Path _ | String _ | OptString _
8810 | Bool _ | Int _ | Int64 _
8811 | FileIn _ | FileOut _
8813 | StringList n | DeviceList n -> pr " free (%s);\n" n
8818 (match fst style with
8823 pr " r = guestfs_%s " name;
8824 generate_c_call_args ~handle:"g" style;
8827 pr " if (r == -1)\n";
8828 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8834 pr " %s = guestfs_%s " n name;
8835 generate_c_call_args ~handle:"g" style;
8838 pr " if (%s == -1)\n" n;
8839 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8840 pr " RETVAL = newSViv (%s);\n" n;
8845 pr " int64_t %s;\n" n;
8847 pr " %s = guestfs_%s " n name;
8848 generate_c_call_args ~handle:"g" style;
8851 pr " if (%s == -1)\n" n;
8852 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8853 pr " RETVAL = my_newSVll (%s);\n" n;
8858 pr " const char *%s;\n" n;
8860 pr " %s = guestfs_%s " n name;
8861 generate_c_call_args ~handle:"g" style;
8864 pr " if (%s == NULL)\n" n;
8865 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8866 pr " RETVAL = newSVpv (%s, 0);\n" n;
8869 | RConstOptString n ->
8871 pr " const char *%s;\n" n;
8873 pr " %s = guestfs_%s " n name;
8874 generate_c_call_args ~handle:"g" style;
8877 pr " if (%s == NULL)\n" n;
8878 pr " RETVAL = &PL_sv_undef;\n";
8880 pr " RETVAL = newSVpv (%s, 0);\n" n;
8885 pr " char *%s;\n" n;
8887 pr " %s = guestfs_%s " n name;
8888 generate_c_call_args ~handle:"g" style;
8891 pr " if (%s == NULL)\n" n;
8892 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8893 pr " RETVAL = newSVpv (%s, 0);\n" n;
8894 pr " free (%s);\n" n;
8897 | RStringList n | RHashtable n ->
8899 pr " char **%s;\n" n;
8902 pr " %s = guestfs_%s " n name;
8903 generate_c_call_args ~handle:"g" style;
8906 pr " if (%s == NULL)\n" n;
8907 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8908 pr " for (n = 0; %s[n] != NULL; ++n) /**/;\n" n;
8909 pr " EXTEND (SP, n);\n";
8910 pr " for (i = 0; i < n; ++i) {\n";
8911 pr " PUSHs (sv_2mortal (newSVpv (%s[i], 0)));\n" n;
8912 pr " free (%s[i]);\n" n;
8914 pr " free (%s);\n" n;
8915 | RStruct (n, typ) ->
8916 let cols = cols_of_struct typ in
8917 generate_perl_struct_code typ cols name style n do_cleanups
8918 | RStructList (n, typ) ->
8919 let cols = cols_of_struct typ in
8920 generate_perl_struct_list_code typ cols name style n do_cleanups
8923 pr " char *%s;\n" n;
8924 pr " size_t size;\n";
8926 pr " %s = guestfs_%s " n name;
8927 generate_c_call_args ~handle:"g" style;
8930 pr " if (%s == NULL)\n" n;
8931 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8932 pr " RETVAL = newSVpvn (%s, size);\n" n;
8933 pr " free (%s);\n" n;
8941 and generate_perl_struct_list_code typ cols name style n do_cleanups =
8943 pr " struct guestfs_%s_list *%s;\n" typ n;
8947 pr " %s = guestfs_%s " n name;
8948 generate_c_call_args ~handle:"g" style;
8951 pr " if (%s == NULL)\n" n;
8952 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8953 pr " EXTEND (SP, %s->len);\n" n;
8954 pr " for (i = 0; i < %s->len; ++i) {\n" n;
8955 pr " hv = newHV ();\n";
8959 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 0), 0);\n"
8960 name (String.length name) n name
8962 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 32), 0);\n"
8963 name (String.length name) n name
8965 pr " (void) hv_store (hv, \"%s\", %d, newSVpvn (%s->val[i].%s, %s->val[i].%s_len), 0);\n"
8966 name (String.length name) n name n name
8967 | name, (FBytes|FUInt64) ->
8968 pr " (void) hv_store (hv, \"%s\", %d, my_newSVull (%s->val[i].%s), 0);\n"
8969 name (String.length name) n name
8971 pr " (void) hv_store (hv, \"%s\", %d, my_newSVll (%s->val[i].%s), 0);\n"
8972 name (String.length name) n name
8973 | name, (FInt32|FUInt32) ->
8974 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
8975 name (String.length name) n name
8977 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (&%s->val[i].%s, 1), 0);\n"
8978 name (String.length name) n name
8979 | name, FOptPercent ->
8980 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
8981 name (String.length name) n name
8983 pr " PUSHs (sv_2mortal (newRV ((SV *) hv)));\n";
8985 pr " guestfs_free_%s_list (%s);\n" typ n
8987 and generate_perl_struct_code typ cols name style n do_cleanups =
8989 pr " struct guestfs_%s *%s;\n" typ n;
8991 pr " %s = guestfs_%s " n name;
8992 generate_c_call_args ~handle:"g" style;
8995 pr " if (%s == NULL)\n" n;
8996 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8997 pr " EXTEND (SP, 2 * %d);\n" (List.length cols);
8999 fun ((name, _) as col) ->
9000 pr " PUSHs (sv_2mortal (newSVpv (\"%s\", 0)));\n" name;
9004 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 0)));\n"
9007 pr " PUSHs (sv_2mortal (newSVpvn (%s->%s, %s->%s_len)));\n"
9010 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 32)));\n"
9012 | name, (FBytes|FUInt64) ->
9013 pr " PUSHs (sv_2mortal (my_newSVull (%s->%s)));\n"
9016 pr " PUSHs (sv_2mortal (my_newSVll (%s->%s)));\n"
9018 | name, (FInt32|FUInt32) ->
9019 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
9022 pr " PUSHs (sv_2mortal (newSVpv (&%s->%s, 1)));\n"
9024 | name, FOptPercent ->
9025 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
9028 pr " free (%s);\n" n
9030 (* Generate Sys/Guestfs.pm. *)
9031 and generate_perl_pm () =
9032 generate_header HashStyle LGPLv2plus;
9039 Sys::Guestfs - Perl bindings for libguestfs
9045 my $h = Sys::Guestfs->new ();
9046 $h->add_drive ('guest.img');
9048 $h->mount ('/dev/sda1', '/');
9049 $h->touch ('/hello');
9054 The C<Sys::Guestfs> module provides a Perl XS binding to the
9055 libguestfs API for examining and modifying virtual machine
9058 Amongst the things this is good for: making batch configuration
9059 changes to guests, getting disk used/free statistics (see also:
9060 virt-df), migrating between virtualization systems (see also:
9061 virt-p2v), performing partial backups, performing partial guest
9062 clones, cloning guests and changing registry/UUID/hostname info, and
9065 Libguestfs uses Linux kernel and qemu code, and can access any type of
9066 guest filesystem that Linux and qemu can, including but not limited
9067 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
9068 schemes, qcow, qcow2, vmdk.
9070 Libguestfs provides ways to enumerate guest storage (eg. partitions,
9071 LVs, what filesystem is in each LV, etc.). It can also run commands
9072 in the context of the guest. Also you can access filesystems over
9075 See also L<Sys::Guestfs::Lib(3)> for a set of useful library
9076 functions for using libguestfs from Perl, including integration
9081 All errors turn into calls to C<croak> (see L<Carp(3)>).
9089 package Sys::Guestfs;
9094 # This version number changes whenever a new function
9095 # is added to the libguestfs API. It is not directly
9096 # related to the libguestfs version number.
9097 use vars qw($VERSION);
9101 XSLoader::load ('Sys::Guestfs');
9103 =item $h = Sys::Guestfs->new ();
9105 Create a new guestfs handle.
9111 my $class = ref ($proto) || $proto;
9113 my $self = Sys::Guestfs::_create ();
9114 bless $self, $class;
9120 (* Actions. We only need to print documentation for these as
9121 * they are pulled in from the XS code automatically.
9124 fun (name, style, _, flags, _, _, longdesc) ->
9125 if not (List.mem NotInDocs flags) then (
9126 let longdesc = replace_str longdesc "C<guestfs_" "C<$h-E<gt>" in
9128 generate_perl_prototype name style;
9130 pr "%s\n\n" longdesc;
9131 if List.mem ProtocolLimitWarning flags then
9132 pr "%s\n\n" protocol_limit_warning;
9133 if List.mem DangerWillRobinson flags then
9134 pr "%s\n\n" danger_will_robinson;
9135 match deprecation_notice flags with
9137 | Some txt -> pr "%s\n\n" txt
9139 ) all_functions_sorted;
9151 Copyright (C) %s Red Hat Inc.
9155 Please see the file COPYING.LIB for the full license.
9161 L<http://libguestfs.org>,
9162 L<Sys::Guestfs::Lib(3)>.
9167 and generate_perl_prototype name style =
9168 (match fst style with
9176 | RBufferOut n -> pr "$%s = " n
9178 | RHashtable n -> pr "%%%s = " n
9180 | RStructList (n,_) -> pr "@%s = " n
9183 let comma = ref false in
9186 if !comma then pr ", ";
9189 | Pathname n | Device n | Dev_or_Path n | String n
9190 | OptString n | Bool n | Int n | Int64 n | FileIn n | FileOut n
9193 | StringList n | DeviceList n ->
9198 (* Generate Python C module. *)
9199 and generate_python_c () =
9200 generate_header CStyle LGPLv2plus;
9203 #define PY_SSIZE_T_CLEAN 1
9206 #if PY_VERSION_HEX < 0x02050000
9207 typedef int Py_ssize_t;
9208 #define PY_SSIZE_T_MAX INT_MAX
9209 #define PY_SSIZE_T_MIN INT_MIN
9216 #include \"guestfs.h\"
9224 get_handle (PyObject *obj)
9227 assert (obj != Py_None);
9228 return ((Pyguestfs_Object *) obj)->g;
9232 put_handle (guestfs_h *g)
9236 PyCObject_FromVoidPtrAndDesc ((void *) g, (char *) \"guestfs_h\", NULL);
9239 /* This list should be freed (but not the strings) after use. */
9241 get_string_list (PyObject *obj)
9248 if (!PyList_Check (obj)) {
9249 PyErr_SetString (PyExc_RuntimeError, \"expecting a list parameter\");
9253 len = PyList_Size (obj);
9254 r = malloc (sizeof (char *) * (len+1));
9256 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: out of memory\");
9260 for (i = 0; i < len; ++i)
9261 r[i] = PyString_AsString (PyList_GetItem (obj, i));
9268 put_string_list (char * const * const argv)
9273 for (argc = 0; argv[argc] != NULL; ++argc)
9276 list = PyList_New (argc);
9277 for (i = 0; i < argc; ++i)
9278 PyList_SetItem (list, i, PyString_FromString (argv[i]));
9284 put_table (char * const * const argv)
9286 PyObject *list, *item;
9289 for (argc = 0; argv[argc] != NULL; ++argc)
9292 list = PyList_New (argc >> 1);
9293 for (i = 0; i < argc; i += 2) {
9294 item = PyTuple_New (2);
9295 PyTuple_SetItem (item, 0, PyString_FromString (argv[i]));
9296 PyTuple_SetItem (item, 1, PyString_FromString (argv[i+1]));
9297 PyList_SetItem (list, i >> 1, item);
9304 free_strings (char **argv)
9308 for (argc = 0; argv[argc] != NULL; ++argc)
9314 py_guestfs_create (PyObject *self, PyObject *args)
9318 g = guestfs_create ();
9320 PyErr_SetString (PyExc_RuntimeError,
9321 \"guestfs.create: failed to allocate handle\");
9324 guestfs_set_error_handler (g, NULL, NULL);
9325 return put_handle (g);
9329 py_guestfs_close (PyObject *self, PyObject *args)
9334 if (!PyArg_ParseTuple (args, (char *) \"O:guestfs_close\", &py_g))
9336 g = get_handle (py_g);
9340 Py_INCREF (Py_None);
9346 let emit_put_list_function typ =
9347 pr "static PyObject *\n";
9348 pr "put_%s_list (struct guestfs_%s_list *%ss)\n" typ typ typ;
9350 pr " PyObject *list;\n";
9353 pr " list = PyList_New (%ss->len);\n" typ;
9354 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
9355 pr " PyList_SetItem (list, i, put_%s (&%ss->val[i]));\n" typ typ;
9356 pr " return list;\n";
9361 (* Structures, turned into Python dictionaries. *)
9364 pr "static PyObject *\n";
9365 pr "put_%s (struct guestfs_%s *%s)\n" typ typ typ;
9367 pr " PyObject *dict;\n";
9369 pr " dict = PyDict_New ();\n";
9373 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9374 pr " PyString_FromString (%s->%s));\n"
9377 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9378 pr " PyString_FromStringAndSize (%s->%s, %s->%s_len));\n"
9381 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9382 pr " PyString_FromStringAndSize (%s->%s, 32));\n"
9384 | name, (FBytes|FUInt64) ->
9385 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9386 pr " PyLong_FromUnsignedLongLong (%s->%s));\n"
9389 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9390 pr " PyLong_FromLongLong (%s->%s));\n"
9393 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9394 pr " PyLong_FromUnsignedLong (%s->%s));\n"
9397 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9398 pr " PyLong_FromLong (%s->%s));\n"
9400 | name, FOptPercent ->
9401 pr " if (%s->%s >= 0)\n" typ name;
9402 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9403 pr " PyFloat_FromDouble ((double) %s->%s));\n"
9406 pr " Py_INCREF (Py_None);\n";
9407 pr " PyDict_SetItemString (dict, \"%s\", Py_None);\n" name;
9410 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9411 pr " PyString_FromStringAndSize (&dirent->%s, 1));\n" name
9413 pr " return dict;\n";
9419 (* Emit a put_TYPE_list function definition only if that function is used. *)
9422 | typ, (RStructListOnly | RStructAndList) ->
9423 (* generate the function for typ *)
9424 emit_put_list_function typ
9425 | typ, _ -> () (* empty *)
9426 ) (rstructs_used_by all_functions);
9428 (* Python wrapper functions. *)
9430 fun (name, style, _, _, _, _, _) ->
9431 pr "static PyObject *\n";
9432 pr "py_guestfs_%s (PyObject *self, PyObject *args)\n" name;
9435 pr " PyObject *py_g;\n";
9436 pr " guestfs_h *g;\n";
9437 pr " PyObject *py_r;\n";
9440 match fst style with
9441 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
9442 | RInt64 _ -> pr " int64_t r;\n"; "-1"
9443 | RConstString _ | RConstOptString _ ->
9444 pr " const char *r;\n"; "NULL"
9445 | RString _ -> pr " char *r;\n"; "NULL"
9446 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
9447 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
9448 | RStructList (_, typ) ->
9449 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
9452 pr " size_t size;\n";
9457 | Pathname n | Device n | Dev_or_Path n | String n
9458 | FileIn n | FileOut n ->
9459 pr " const char *%s;\n" n
9460 | OptString n -> pr " const char *%s;\n" n
9462 pr " const char *%s;\n" n;
9463 pr " Py_ssize_t %s_size;\n" n
9464 | StringList n | DeviceList n ->
9465 pr " PyObject *py_%s;\n" n;
9466 pr " char **%s;\n" n
9467 | Bool n -> pr " int %s;\n" n
9468 | Int n -> pr " int %s;\n" n
9469 | Int64 n -> pr " long long %s;\n" n
9474 (* Convert the parameters. *)
9475 pr " if (!PyArg_ParseTuple (args, (char *) \"O";
9478 | Pathname _ | Device _ | Dev_or_Path _ | String _ | FileIn _ | FileOut _ -> pr "s"
9479 | OptString _ -> pr "z"
9480 | StringList _ | DeviceList _ -> pr "O"
9481 | Bool _ -> pr "i" (* XXX Python has booleans? *)
9483 | Int64 _ -> pr "L" (* XXX Whoever thought it was a good idea to
9484 * emulate C's int/long/long long in Python?
9486 | BufferIn _ -> pr "s#"
9488 pr ":guestfs_%s\",\n" name;
9492 | Pathname n | Device n | Dev_or_Path n | String n | FileIn n | FileOut n -> pr ", &%s" n
9493 | OptString n -> pr ", &%s" n
9494 | StringList n | DeviceList n -> pr ", &py_%s" n
9495 | Bool n -> pr ", &%s" n
9496 | Int n -> pr ", &%s" n
9497 | Int64 n -> pr ", &%s" n
9498 | BufferIn n -> pr ", &%s, &%s_size" n n
9502 pr " return NULL;\n";
9504 pr " g = get_handle (py_g);\n";
9507 | Pathname _ | Device _ | Dev_or_Path _ | String _
9508 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _
9510 | StringList n | DeviceList n ->
9511 pr " %s = get_string_list (py_%s);\n" n n;
9512 pr " if (!%s) return NULL;\n" n
9517 pr " r = guestfs_%s " name;
9518 generate_c_call_args ~handle:"g" style;
9523 | Pathname _ | Device _ | Dev_or_Path _ | String _
9524 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _
9526 | StringList n | DeviceList n ->
9527 pr " free (%s);\n" n
9530 pr " if (r == %s) {\n" error_code;
9531 pr " PyErr_SetString (PyExc_RuntimeError, guestfs_last_error (g));\n";
9532 pr " return NULL;\n";
9536 (match fst style with
9538 pr " Py_INCREF (Py_None);\n";
9539 pr " py_r = Py_None;\n"
9541 | RBool _ -> pr " py_r = PyInt_FromLong ((long) r);\n"
9542 | RInt64 _ -> pr " py_r = PyLong_FromLongLong (r);\n"
9543 | RConstString _ -> pr " py_r = PyString_FromString (r);\n"
9544 | RConstOptString _ ->
9546 pr " py_r = PyString_FromString (r);\n";
9548 pr " Py_INCREF (Py_None);\n";
9549 pr " py_r = Py_None;\n";
9552 pr " py_r = PyString_FromString (r);\n";
9555 pr " py_r = put_string_list (r);\n";
9556 pr " free_strings (r);\n"
9557 | RStruct (_, typ) ->
9558 pr " py_r = put_%s (r);\n" typ;
9559 pr " guestfs_free_%s (r);\n" typ
9560 | RStructList (_, typ) ->
9561 pr " py_r = put_%s_list (r);\n" typ;
9562 pr " guestfs_free_%s_list (r);\n" typ
9564 pr " py_r = put_table (r);\n";
9565 pr " free_strings (r);\n"
9567 pr " py_r = PyString_FromStringAndSize (r, size);\n";
9571 pr " return py_r;\n";
9576 (* Table of functions. *)
9577 pr "static PyMethodDef methods[] = {\n";
9578 pr " { (char *) \"create\", py_guestfs_create, METH_VARARGS, NULL },\n";
9579 pr " { (char *) \"close\", py_guestfs_close, METH_VARARGS, NULL },\n";
9581 fun (name, _, _, _, _, _, _) ->
9582 pr " { (char *) \"%s\", py_guestfs_%s, METH_VARARGS, NULL },\n"
9585 pr " { NULL, NULL, 0, NULL }\n";
9589 (* Init function. *)
9592 initlibguestfsmod (void)
9594 static int initialized = 0;
9596 if (initialized) return;
9597 Py_InitModule ((char *) \"libguestfsmod\", methods);
9602 (* Generate Python module. *)
9603 and generate_python_py () =
9604 generate_header HashStyle LGPLv2plus;
9607 u\"\"\"Python bindings for libguestfs
9610 g = guestfs.GuestFS ()
9611 g.add_drive (\"guest.img\")
9613 parts = g.list_partitions ()
9615 The guestfs module provides a Python binding to the libguestfs API
9616 for examining and modifying virtual machine disk images.
9618 Amongst the things this is good for: making batch configuration
9619 changes to guests, getting disk used/free statistics (see also:
9620 virt-df), migrating between virtualization systems (see also:
9621 virt-p2v), performing partial backups, performing partial guest
9622 clones, cloning guests and changing registry/UUID/hostname info, and
9625 Libguestfs uses Linux kernel and qemu code, and can access any type of
9626 guest filesystem that Linux and qemu can, including but not limited
9627 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
9628 schemes, qcow, qcow2, vmdk.
9630 Libguestfs provides ways to enumerate guest storage (eg. partitions,
9631 LVs, what filesystem is in each LV, etc.). It can also run commands
9632 in the context of the guest. Also you can access filesystems over
9635 Errors which happen while using the API are turned into Python
9636 RuntimeError exceptions.
9638 To create a guestfs handle you usually have to perform the following
9641 # Create the handle, call add_drive at least once, and possibly
9642 # several times if the guest has multiple block devices:
9643 g = guestfs.GuestFS ()
9644 g.add_drive (\"guest.img\")
9646 # Launch the qemu subprocess and wait for it to become ready:
9649 # Now you can issue commands, for example:
9654 import libguestfsmod
9657 \"\"\"Instances of this class are libguestfs API handles.\"\"\"
9659 def __init__ (self):
9660 \"\"\"Create a new libguestfs handle.\"\"\"
9661 self._o = libguestfsmod.create ()
9664 libguestfsmod.close (self._o)
9669 fun (name, style, _, flags, _, _, longdesc) ->
9671 generate_py_call_args ~handle:"self" (snd style);
9674 if not (List.mem NotInDocs flags) then (
9675 let doc = replace_str longdesc "C<guestfs_" "C<g." in
9677 match fst style with
9678 | RErr | RInt _ | RInt64 _ | RBool _
9679 | RConstOptString _ | RConstString _
9680 | RString _ | RBufferOut _ -> doc
9682 doc ^ "\n\nThis function returns a list of strings."
9683 | RStruct (_, typ) ->
9684 doc ^ sprintf "\n\nThis function returns a dictionary, with keys matching the various fields in the guestfs_%s structure." typ
9685 | RStructList (_, typ) ->
9686 doc ^ sprintf "\n\nThis function returns a list of %ss. Each %s is represented as a dictionary." typ typ
9688 doc ^ "\n\nThis function returns a dictionary." in
9690 if List.mem ProtocolLimitWarning flags then
9691 doc ^ "\n\n" ^ protocol_limit_warning
9694 if List.mem DangerWillRobinson flags then
9695 doc ^ "\n\n" ^ danger_will_robinson
9698 match deprecation_notice flags with
9700 | Some txt -> doc ^ "\n\n" ^ txt in
9701 let doc = pod2text ~width:60 name doc in
9702 let doc = List.map (fun line -> replace_str line "\\" "\\\\") doc in
9703 let doc = String.concat "\n " doc in
9704 pr " u\"\"\"%s\"\"\"\n" doc;
9706 pr " return libguestfsmod.%s " name;
9707 generate_py_call_args ~handle:"self._o" (snd style);
9712 (* Generate Python call arguments, eg "(handle, foo, bar)" *)
9713 and generate_py_call_args ~handle args =
9715 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
9718 (* Useful if you need the longdesc POD text as plain text. Returns a
9721 * Because this is very slow (the slowest part of autogeneration),
9722 * we memoize the results.
9724 and pod2text ~width name longdesc =
9725 let key = width, name, longdesc in
9726 try Hashtbl.find pod2text_memo key
9728 let filename, chan = Filename.open_temp_file "gen" ".tmp" in
9729 fprintf chan "=head1 %s\n\n%s\n" name longdesc;
9731 let cmd = sprintf "pod2text -w %d %s" width (Filename.quote filename) in
9732 let chan = open_process_in cmd in
9733 let lines = ref [] in
9735 let line = input_line chan in
9736 if i = 1 then (* discard the first line of output *)
9739 let line = triml line in
9740 lines := line :: !lines;
9743 let lines = try loop 1 with End_of_file -> List.rev !lines in
9745 (match close_process_in chan with
9748 failwithf "pod2text: process exited with non-zero status (%d)" i
9749 | WSIGNALED i | WSTOPPED i ->
9750 failwithf "pod2text: process signalled or stopped by signal %d" i
9752 Hashtbl.add pod2text_memo key lines;
9753 pod2text_memo_updated ();
9756 (* Generate ruby bindings. *)
9757 and generate_ruby_c () =
9758 generate_header CStyle LGPLv2plus;
9766 #include \"guestfs.h\"
9768 #include \"extconf.h\"
9770 /* For Ruby < 1.9 */
9772 #define RARRAY_LEN(r) (RARRAY((r))->len)
9775 static VALUE m_guestfs; /* guestfs module */
9776 static VALUE c_guestfs; /* guestfs_h handle */
9777 static VALUE e_Error; /* used for all errors */
9779 static void ruby_guestfs_free (void *p)
9782 guestfs_close ((guestfs_h *) p);
9785 static VALUE ruby_guestfs_create (VALUE m)
9789 g = guestfs_create ();
9791 rb_raise (e_Error, \"failed to create guestfs handle\");
9793 /* Don't print error messages to stderr by default. */
9794 guestfs_set_error_handler (g, NULL, NULL);
9796 /* Wrap it, and make sure the close function is called when the
9799 return Data_Wrap_Struct (c_guestfs, NULL, ruby_guestfs_free, g);
9802 static VALUE ruby_guestfs_close (VALUE gv)
9805 Data_Get_Struct (gv, guestfs_h, g);
9807 ruby_guestfs_free (g);
9808 DATA_PTR (gv) = NULL;
9816 fun (name, style, _, _, _, _, _) ->
9817 pr "static VALUE ruby_guestfs_%s (VALUE gv" name;
9818 List.iter (fun arg -> pr ", VALUE %sv" (name_of_argt arg)) (snd style);
9821 pr " guestfs_h *g;\n";
9822 pr " Data_Get_Struct (gv, guestfs_h, g);\n";
9824 pr " rb_raise (rb_eArgError, \"%%s: used handle after closing it\", \"%s\");\n"
9830 | Pathname n | Device n | Dev_or_Path n | String n | FileIn n | FileOut n ->
9831 pr " Check_Type (%sv, T_STRING);\n" n;
9832 pr " const char *%s = StringValueCStr (%sv);\n" n n;
9834 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
9835 pr " \"%s\", \"%s\");\n" n name
9837 pr " Check_Type (%sv, T_STRING);\n" n;
9838 pr " const char *%s = RSTRING (%sv)->ptr;\n" n n;
9840 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
9841 pr " \"%s\", \"%s\");\n" n name;
9842 pr " size_t %s_size = RSTRING (%sv)->len;\n" n n
9844 pr " const char *%s = !NIL_P (%sv) ? StringValueCStr (%sv) : NULL;\n" n n n
9845 | StringList n | DeviceList n ->
9846 pr " char **%s;\n" n;
9847 pr " Check_Type (%sv, T_ARRAY);\n" n;
9849 pr " int i, len;\n";
9850 pr " len = RARRAY_LEN (%sv);\n" n;
9851 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (len+1));\n"
9853 pr " for (i = 0; i < len; ++i) {\n";
9854 pr " VALUE v = rb_ary_entry (%sv, i);\n" n;
9855 pr " %s[i] = StringValueCStr (v);\n" n;
9857 pr " %s[len] = NULL;\n" n;
9860 pr " int %s = RTEST (%sv);\n" n n
9862 pr " int %s = NUM2INT (%sv);\n" n n
9864 pr " long long %s = NUM2LL (%sv);\n" n n
9869 match fst style with
9870 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
9871 | RInt64 _ -> pr " int64_t r;\n"; "-1"
9872 | RConstString _ | RConstOptString _ ->
9873 pr " const char *r;\n"; "NULL"
9874 | RString _ -> pr " char *r;\n"; "NULL"
9875 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
9876 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
9877 | RStructList (_, typ) ->
9878 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
9881 pr " size_t size;\n";
9885 pr " r = guestfs_%s " name;
9886 generate_c_call_args ~handle:"g" style;
9891 | Pathname _ | Device _ | Dev_or_Path _ | String _
9892 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _
9894 | StringList n | DeviceList n ->
9895 pr " free (%s);\n" n
9898 pr " if (r == %s)\n" error_code;
9899 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n";
9902 (match fst style with
9904 pr " return Qnil;\n"
9905 | RInt _ | RBool _ ->
9906 pr " return INT2NUM (r);\n"
9908 pr " return ULL2NUM (r);\n"
9910 pr " return rb_str_new2 (r);\n";
9911 | RConstOptString _ ->
9913 pr " return rb_str_new2 (r);\n";
9915 pr " return Qnil;\n";
9917 pr " VALUE rv = rb_str_new2 (r);\n";
9921 pr " int i, len = 0;\n";
9922 pr " for (i = 0; r[i] != NULL; ++i) len++;\n";
9923 pr " VALUE rv = rb_ary_new2 (len);\n";
9924 pr " for (i = 0; r[i] != NULL; ++i) {\n";
9925 pr " rb_ary_push (rv, rb_str_new2 (r[i]));\n";
9926 pr " free (r[i]);\n";
9930 | RStruct (_, typ) ->
9931 let cols = cols_of_struct typ in
9932 generate_ruby_struct_code typ cols
9933 | RStructList (_, typ) ->
9934 let cols = cols_of_struct typ in
9935 generate_ruby_struct_list_code typ cols
9937 pr " VALUE rv = rb_hash_new ();\n";
9939 pr " for (i = 0; r[i] != NULL; i+=2) {\n";
9940 pr " rb_hash_aset (rv, rb_str_new2 (r[i]), rb_str_new2 (r[i+1]));\n";
9941 pr " free (r[i]);\n";
9942 pr " free (r[i+1]);\n";
9947 pr " VALUE rv = rb_str_new (r, size);\n";
9957 /* Initialize the module. */
9958 void Init__guestfs ()
9960 m_guestfs = rb_define_module (\"Guestfs\");
9961 c_guestfs = rb_define_class_under (m_guestfs, \"Guestfs\", rb_cObject);
9962 e_Error = rb_define_class_under (m_guestfs, \"Error\", rb_eStandardError);
9964 rb_define_module_function (m_guestfs, \"create\", ruby_guestfs_create, 0);
9965 rb_define_method (c_guestfs, \"close\", ruby_guestfs_close, 0);
9968 (* Define the rest of the methods. *)
9970 fun (name, style, _, _, _, _, _) ->
9971 pr " rb_define_method (c_guestfs, \"%s\",\n" name;
9972 pr " ruby_guestfs_%s, %d);\n" name (List.length (snd style))
9977 (* Ruby code to return a struct. *)
9978 and generate_ruby_struct_code typ cols =
9979 pr " VALUE rv = rb_hash_new ();\n";
9983 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new2 (r->%s));\n" name name
9985 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, r->%s_len));\n" name name name
9987 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, 32));\n" name name
9988 | name, (FBytes|FUInt64) ->
9989 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
9991 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), LL2NUM (r->%s));\n" name name
9993 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), UINT2NUM (r->%s));\n" name name
9995 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), INT2NUM (r->%s));\n" name name
9996 | name, FOptPercent ->
9997 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_dbl2big (r->%s));\n" name name
9998 | name, FChar -> (* XXX wrong? *)
9999 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
10001 pr " guestfs_free_%s (r);\n" typ;
10004 (* Ruby code to return a struct list. *)
10005 and generate_ruby_struct_list_code typ cols =
10006 pr " VALUE rv = rb_ary_new2 (r->len);\n";
10008 pr " for (i = 0; i < r->len; ++i) {\n";
10009 pr " VALUE hv = rb_hash_new ();\n";
10013 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new2 (r->val[i].%s));\n" name name
10015 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
10017 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, 32));\n" name name
10018 | name, (FBytes|FUInt64) ->
10019 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
10021 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), LL2NUM (r->val[i].%s));\n" name name
10023 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), UINT2NUM (r->val[i].%s));\n" name name
10025 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), INT2NUM (r->val[i].%s));\n" name name
10026 | name, FOptPercent ->
10027 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_dbl2big (r->val[i].%s));\n" name name
10028 | name, FChar -> (* XXX wrong? *)
10029 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
10031 pr " rb_ary_push (rv, hv);\n";
10033 pr " guestfs_free_%s_list (r);\n" typ;
10036 (* Generate Java bindings GuestFS.java file. *)
10037 and generate_java_java () =
10038 generate_header CStyle LGPLv2plus;
10041 package com.redhat.et.libguestfs;
10043 import java.util.HashMap;
10044 import com.redhat.et.libguestfs.LibGuestFSException;
10045 import com.redhat.et.libguestfs.PV;
10046 import com.redhat.et.libguestfs.VG;
10047 import com.redhat.et.libguestfs.LV;
10048 import com.redhat.et.libguestfs.Stat;
10049 import com.redhat.et.libguestfs.StatVFS;
10050 import com.redhat.et.libguestfs.IntBool;
10051 import com.redhat.et.libguestfs.Dirent;
10054 * The GuestFS object is a libguestfs handle.
10058 public class GuestFS {
10059 // Load the native code.
10061 System.loadLibrary (\"guestfs_jni\");
10065 * The native guestfs_h pointer.
10070 * Create a libguestfs handle.
10072 * @throws LibGuestFSException
10074 public GuestFS () throws LibGuestFSException
10078 private native long _create () throws LibGuestFSException;
10081 * Close a libguestfs handle.
10083 * You can also leave handles to be collected by the garbage
10084 * collector, but this method ensures that the resources used
10085 * by the handle are freed up immediately. If you call any
10086 * other methods after closing the handle, you will get an
10089 * @throws LibGuestFSException
10091 public void close () throws LibGuestFSException
10097 private native void _close (long g) throws LibGuestFSException;
10099 public void finalize () throws LibGuestFSException
10107 fun (name, style, _, flags, _, shortdesc, longdesc) ->
10108 if not (List.mem NotInDocs flags); then (
10109 let doc = replace_str longdesc "C<guestfs_" "C<g." in
10111 if List.mem ProtocolLimitWarning flags then
10112 doc ^ "\n\n" ^ protocol_limit_warning
10115 if List.mem DangerWillRobinson flags then
10116 doc ^ "\n\n" ^ danger_will_robinson
10119 match deprecation_notice flags with
10121 | Some txt -> doc ^ "\n\n" ^ txt in
10122 let doc = pod2text ~width:60 name doc in
10123 let doc = List.map ( (* RHBZ#501883 *)
10126 | nonempty -> nonempty
10128 let doc = String.concat "\n * " doc in
10131 pr " * %s\n" shortdesc;
10134 pr " * @throws LibGuestFSException\n";
10138 generate_java_prototype ~public:true ~semicolon:false name style;
10141 pr " if (g == 0)\n";
10142 pr " throw new LibGuestFSException (\"%s: handle is closed\");\n"
10145 if fst style <> RErr then pr "return ";
10147 generate_java_call_args ~handle:"g" (snd style);
10151 generate_java_prototype ~privat:true ~native:true name style;
10158 (* Generate Java call arguments, eg "(handle, foo, bar)" *)
10159 and generate_java_call_args ~handle args =
10161 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
10164 and generate_java_prototype ?(public=false) ?(privat=false) ?(native=false)
10165 ?(semicolon=true) name style =
10166 if privat then pr "private ";
10167 if public then pr "public ";
10168 if native then pr "native ";
10171 (match fst style with
10172 | RErr -> pr "void ";
10173 | RInt _ -> pr "int ";
10174 | RInt64 _ -> pr "long ";
10175 | RBool _ -> pr "boolean ";
10176 | RConstString _ | RConstOptString _ | RString _
10177 | RBufferOut _ -> pr "String ";
10178 | RStringList _ -> pr "String[] ";
10179 | RStruct (_, typ) ->
10180 let name = java_name_of_struct typ in
10182 | RStructList (_, typ) ->
10183 let name = java_name_of_struct typ in
10185 | RHashtable _ -> pr "HashMap<String,String> ";
10188 if native then pr "_%s " name else pr "%s " name;
10190 let needs_comma = ref false in
10193 needs_comma := true
10199 if !needs_comma then pr ", ";
10200 needs_comma := true;
10204 | Device n | Dev_or_Path n
10212 | StringList n | DeviceList n ->
10223 pr " throws LibGuestFSException";
10224 if semicolon then pr ";"
10226 and generate_java_struct jtyp cols () =
10227 generate_header CStyle LGPLv2plus;
10230 package com.redhat.et.libguestfs;
10233 * Libguestfs %s structure.
10245 | name, FBuffer -> pr " public String %s;\n" name
10246 | name, (FBytes|FUInt64|FInt64) -> pr " public long %s;\n" name
10247 | name, (FUInt32|FInt32) -> pr " public int %s;\n" name
10248 | name, FChar -> pr " public char %s;\n" name
10249 | name, FOptPercent ->
10250 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
10251 pr " public float %s;\n" name
10256 and generate_java_c () =
10257 generate_header CStyle LGPLv2plus;
10261 #include <stdlib.h>
10262 #include <string.h>
10264 #include \"com_redhat_et_libguestfs_GuestFS.h\"
10265 #include \"guestfs.h\"
10267 /* Note that this function returns. The exception is not thrown
10268 * until after the wrapper function returns.
10271 throw_exception (JNIEnv *env, const char *msg)
10274 cl = (*env)->FindClass (env,
10275 \"com/redhat/et/libguestfs/LibGuestFSException\");
10276 (*env)->ThrowNew (env, cl, msg);
10279 JNIEXPORT jlong JNICALL
10280 Java_com_redhat_et_libguestfs_GuestFS__1create
10281 (JNIEnv *env, jobject obj)
10285 g = guestfs_create ();
10287 throw_exception (env, \"GuestFS.create: failed to allocate handle\");
10290 guestfs_set_error_handler (g, NULL, NULL);
10291 return (jlong) (long) g;
10294 JNIEXPORT void JNICALL
10295 Java_com_redhat_et_libguestfs_GuestFS__1close
10296 (JNIEnv *env, jobject obj, jlong jg)
10298 guestfs_h *g = (guestfs_h *) (long) jg;
10305 fun (name, style, _, _, _, _, _) ->
10307 (match fst style with
10308 | RErr -> pr "void ";
10309 | RInt _ -> pr "jint ";
10310 | RInt64 _ -> pr "jlong ";
10311 | RBool _ -> pr "jboolean ";
10312 | RConstString _ | RConstOptString _ | RString _
10313 | RBufferOut _ -> pr "jstring ";
10314 | RStruct _ | RHashtable _ ->
10316 | RStringList _ | RStructList _ ->
10317 pr "jobjectArray ";
10320 pr "Java_com_redhat_et_libguestfs_GuestFS_";
10321 pr "%s" (replace_str ("_" ^ name) "_" "_1");
10323 pr " (JNIEnv *env, jobject obj, jlong jg";
10327 | Device n | Dev_or_Path n
10332 pr ", jstring j%s" n
10334 pr ", jbyteArray j%s" n
10335 | StringList n | DeviceList n ->
10336 pr ", jobjectArray j%s" n
10338 pr ", jboolean j%s" n
10346 pr " guestfs_h *g = (guestfs_h *) (long) jg;\n";
10347 let error_code, no_ret =
10348 match fst style with
10349 | RErr -> pr " int r;\n"; "-1", ""
10351 | RInt _ -> pr " int r;\n"; "-1", "0"
10352 | RInt64 _ -> pr " int64_t r;\n"; "-1", "0"
10353 | RConstString _ -> pr " const char *r;\n"; "NULL", "NULL"
10354 | RConstOptString _ -> pr " const char *r;\n"; "NULL", "NULL"
10356 pr " jstring jr;\n";
10357 pr " char *r;\n"; "NULL", "NULL"
10359 pr " jobjectArray jr;\n";
10360 pr " int r_len;\n";
10361 pr " jclass cl;\n";
10362 pr " jstring jstr;\n";
10363 pr " char **r;\n"; "NULL", "NULL"
10364 | RStruct (_, typ) ->
10365 pr " jobject jr;\n";
10366 pr " jclass cl;\n";
10367 pr " jfieldID fl;\n";
10368 pr " struct guestfs_%s *r;\n" typ; "NULL", "NULL"
10369 | RStructList (_, typ) ->
10370 pr " jobjectArray jr;\n";
10371 pr " jclass cl;\n";
10372 pr " jfieldID fl;\n";
10373 pr " jobject jfl;\n";
10374 pr " struct guestfs_%s_list *r;\n" typ; "NULL", "NULL"
10375 | RHashtable _ -> pr " char **r;\n"; "NULL", "NULL"
10377 pr " jstring jr;\n";
10379 pr " size_t size;\n";
10384 | Device n | Dev_or_Path n
10389 pr " const char *%s;\n" n
10391 pr " jbyte *%s;\n" n;
10392 pr " size_t %s_size;\n" n
10393 | StringList n | DeviceList n ->
10394 pr " int %s_len;\n" n;
10395 pr " const char **%s;\n" n
10400 pr " int64_t %s;\n" n
10404 (match fst style with
10405 | RStringList _ | RStructList _ -> true
10406 | RErr | RBool _ | RInt _ | RInt64 _ | RConstString _
10407 | RConstOptString _
10408 | RString _ | RBufferOut _ | RStruct _ | RHashtable _ -> false) ||
10409 List.exists (function
10410 | StringList _ -> true
10411 | DeviceList _ -> true
10412 | _ -> false) (snd style) in
10418 (* Get the parameters. *)
10422 | Device n | Dev_or_Path n
10426 pr " %s = (*env)->GetStringUTFChars (env, j%s, NULL);\n" n n
10428 (* This is completely undocumented, but Java null becomes
10429 * a NULL parameter.
10431 pr " %s = j%s ? (*env)->GetStringUTFChars (env, j%s, NULL) : NULL;\n" n n n
10433 pr " %s = (*env)->GetByteArrayElements (env, j%s, NULL);\n" n n;
10434 pr " %s_size = (*env)->GetArrayLength (env, j%s);\n" n n
10435 | StringList n | DeviceList n ->
10436 pr " %s_len = (*env)->GetArrayLength (env, j%s);\n" n n;
10437 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (%s_len+1));\n" n n;
10438 pr " for (i = 0; i < %s_len; ++i) {\n" n;
10439 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
10441 pr " %s[i] = (*env)->GetStringUTFChars (env, o, NULL);\n" n;
10443 pr " %s[%s_len] = NULL;\n" n n;
10447 pr " %s = j%s;\n" n n
10450 (* Make the call. *)
10451 pr " r = guestfs_%s " name;
10452 generate_c_call_args ~handle:"g" style;
10455 (* Release the parameters. *)
10459 | Device n | Dev_or_Path n
10463 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
10465 pr " if (j%s)\n" n;
10466 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
10468 pr " (*env)->ReleaseByteArrayElements (env, j%s, %s, 0);\n" n n
10469 | StringList n | DeviceList n ->
10470 pr " for (i = 0; i < %s_len; ++i) {\n" n;
10471 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
10473 pr " (*env)->ReleaseStringUTFChars (env, o, %s[i]);\n" n;
10475 pr " free (%s);\n" n
10481 (* Check for errors. *)
10482 pr " if (r == %s) {\n" error_code;
10483 pr " throw_exception (env, guestfs_last_error (g));\n";
10484 pr " return %s;\n" no_ret;
10487 (* Return value. *)
10488 (match fst style with
10490 | RInt _ -> pr " return (jint) r;\n"
10491 | RBool _ -> pr " return (jboolean) r;\n"
10492 | RInt64 _ -> pr " return (jlong) r;\n"
10493 | RConstString _ -> pr " return (*env)->NewStringUTF (env, r);\n"
10494 | RConstOptString _ ->
10495 pr " return (*env)->NewStringUTF (env, r); /* XXX r NULL? */\n"
10497 pr " jr = (*env)->NewStringUTF (env, r);\n";
10501 pr " for (r_len = 0; r[r_len] != NULL; ++r_len) ;\n";
10502 pr " cl = (*env)->FindClass (env, \"java/lang/String\");\n";
10503 pr " jstr = (*env)->NewStringUTF (env, \"\");\n";
10504 pr " jr = (*env)->NewObjectArray (env, r_len, cl, jstr);\n";
10505 pr " for (i = 0; i < r_len; ++i) {\n";
10506 pr " jstr = (*env)->NewStringUTF (env, r[i]);\n";
10507 pr " (*env)->SetObjectArrayElement (env, jr, i, jstr);\n";
10508 pr " free (r[i]);\n";
10512 | RStruct (_, typ) ->
10513 let jtyp = java_name_of_struct typ in
10514 let cols = cols_of_struct typ in
10515 generate_java_struct_return typ jtyp cols
10516 | RStructList (_, typ) ->
10517 let jtyp = java_name_of_struct typ in
10518 let cols = cols_of_struct typ in
10519 generate_java_struct_list_return typ jtyp cols
10522 pr " throw_exception (env, \"%s: internal error: please let us know how to make a Java HashMap from JNI bindings!\");\n" name;
10523 pr " return NULL;\n"
10525 pr " jr = (*env)->NewStringUTF (env, r); /* XXX size */\n";
10534 and generate_java_struct_return typ jtyp cols =
10535 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
10536 pr " jr = (*env)->AllocObject (env, cl);\n";
10540 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10541 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, r->%s));\n" name;
10544 pr " char s[33];\n";
10545 pr " memcpy (s, r->%s, 32);\n" name;
10546 pr " s[32] = 0;\n";
10547 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10548 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
10552 pr " int len = r->%s_len;\n" name;
10553 pr " char s[len+1];\n";
10554 pr " memcpy (s, r->%s, len);\n" name;
10555 pr " s[len] = 0;\n";
10556 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10557 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
10559 | name, (FBytes|FUInt64|FInt64) ->
10560 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
10561 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
10562 | name, (FUInt32|FInt32) ->
10563 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
10564 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
10565 | name, FOptPercent ->
10566 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
10567 pr " (*env)->SetFloatField (env, jr, fl, r->%s);\n" name;
10569 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
10570 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
10575 and generate_java_struct_list_return typ jtyp cols =
10576 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
10577 pr " jr = (*env)->NewObjectArray (env, r->len, cl, NULL);\n";
10578 pr " for (i = 0; i < r->len; ++i) {\n";
10579 pr " jfl = (*env)->AllocObject (env, cl);\n";
10583 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10584 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, r->val[i].%s));\n" name;
10587 pr " char s[33];\n";
10588 pr " memcpy (s, r->val[i].%s, 32);\n" name;
10589 pr " s[32] = 0;\n";
10590 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10591 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
10595 pr " int len = r->val[i].%s_len;\n" name;
10596 pr " char s[len+1];\n";
10597 pr " memcpy (s, r->val[i].%s, len);\n" name;
10598 pr " s[len] = 0;\n";
10599 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10600 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
10602 | name, (FBytes|FUInt64|FInt64) ->
10603 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
10604 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
10605 | name, (FUInt32|FInt32) ->
10606 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
10607 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
10608 | name, FOptPercent ->
10609 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
10610 pr " (*env)->SetFloatField (env, jfl, fl, r->val[i].%s);\n" name;
10612 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
10613 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
10615 pr " (*env)->SetObjectArrayElement (env, jfl, i, jfl);\n";
10617 pr " guestfs_free_%s_list (r);\n" typ;
10620 and generate_java_makefile_inc () =
10621 generate_header HashStyle GPLv2plus;
10623 pr "java_built_sources = \\\n";
10626 pr "\tcom/redhat/et/libguestfs/%s.java \\\n" jtyp;
10628 pr "\tcom/redhat/et/libguestfs/GuestFS.java\n"
10630 and generate_haskell_hs () =
10631 generate_header HaskellStyle LGPLv2plus;
10633 (* XXX We only know how to generate partial FFI for Haskell
10634 * at the moment. Please help out!
10636 let can_generate style =
10640 | RInt64 _, _ -> true
10642 | RConstString _, _
10643 | RConstOptString _, _
10649 | RBufferOut _, _ -> false in
10652 {-# INCLUDE <guestfs.h> #-}
10653 {-# LANGUAGE ForeignFunctionInterface #-}
10658 (* List out the names of the actions we want to export. *)
10660 fun (name, style, _, _, _, _, _) ->
10661 if can_generate style then pr ",\n %s" name
10667 -- Unfortunately some symbols duplicate ones already present
10668 -- in Prelude. We don't know which, so we hard-code a list
10670 import Prelude hiding (truncate)
10674 import Foreign.C.Types
10676 import Control.Exception
10677 import Data.Typeable
10679 data GuestfsS = GuestfsS -- represents the opaque C struct
10680 type GuestfsP = Ptr GuestfsS -- guestfs_h *
10681 type GuestfsH = ForeignPtr GuestfsS -- guestfs_h * with attached finalizer
10683 -- XXX define properly later XXX
10687 data IntBool = IntBool
10689 data StatVFS = StatVFS
10690 data Hashtable = Hashtable
10692 foreign import ccall unsafe \"guestfs_create\" c_create
10694 foreign import ccall unsafe \"&guestfs_close\" c_close
10695 :: FunPtr (GuestfsP -> IO ())
10696 foreign import ccall unsafe \"guestfs_set_error_handler\" c_set_error_handler
10697 :: GuestfsP -> Ptr CInt -> Ptr CInt -> IO ()
10699 create :: IO GuestfsH
10702 c_set_error_handler p nullPtr nullPtr
10703 h <- newForeignPtr c_close p
10706 foreign import ccall unsafe \"guestfs_last_error\" c_last_error
10707 :: GuestfsP -> IO CString
10709 -- last_error :: GuestfsH -> IO (Maybe String)
10710 -- last_error h = do
10711 -- str <- withForeignPtr h (\\p -> c_last_error p)
10712 -- maybePeek peekCString str
10714 last_error :: GuestfsH -> IO (String)
10716 str <- withForeignPtr h (\\p -> c_last_error p)
10717 if (str == nullPtr)
10718 then return \"no error\"
10719 else peekCString str
10723 (* Generate wrappers for each foreign function. *)
10725 fun (name, style, _, _, _, _, _) ->
10726 if can_generate style then (
10727 pr "foreign import ccall unsafe \"guestfs_%s\" c_%s\n" name name;
10729 generate_haskell_prototype ~handle:"GuestfsP" style;
10733 generate_haskell_prototype ~handle:"GuestfsH" ~hs:true style;
10735 pr "%s %s = do\n" name
10736 (String.concat " " ("h" :: List.map name_of_argt (snd style)));
10738 (* Convert pointer arguments using with* functions. *)
10743 | Pathname n | Device n | Dev_or_Path n | String n ->
10744 pr "withCString %s $ \\%s -> " n n
10746 pr "withCStringLen %s $ \\(%s, %s_size) -> " n n n
10747 | OptString n -> pr "maybeWith withCString %s $ \\%s -> " n n
10748 | StringList n | DeviceList n -> pr "withMany withCString %s $ \\%s -> withArray0 nullPtr %s $ \\%s -> " n n n n
10749 | Bool _ | Int _ | Int64 _ -> ()
10751 (* Convert integer arguments. *)
10755 | Bool n -> sprintf "(fromBool %s)" n
10756 | Int n -> sprintf "(fromIntegral %s)" n
10757 | Int64 n -> sprintf "(fromIntegral %s)" n
10758 | FileIn n | FileOut n
10759 | Pathname n | Device n | Dev_or_Path n | String n | OptString n | StringList n | DeviceList n -> n
10760 | BufferIn n -> sprintf "%s (fromIntegral %s_size)" n n
10762 pr "withForeignPtr h (\\p -> c_%s %s)\n" name
10763 (String.concat " " ("p" :: args));
10764 (match fst style with
10765 | RErr | RInt _ | RInt64 _ | RBool _ ->
10766 pr " if (r == -1)\n";
10768 pr " err <- last_error h\n";
10770 | RConstString _ | RConstOptString _ | RString _
10771 | RStringList _ | RStruct _
10772 | RStructList _ | RHashtable _ | RBufferOut _ ->
10773 pr " if (r == nullPtr)\n";
10775 pr " err <- last_error h\n";
10778 (match fst style with
10780 pr " else return ()\n"
10782 pr " else return (fromIntegral r)\n"
10784 pr " else return (fromIntegral r)\n"
10786 pr " else return (toBool r)\n"
10788 | RConstOptString _
10795 pr " else return ()\n" (* XXXXXXXXXXXXXXXXXXXX *)
10801 and generate_haskell_prototype ~handle ?(hs = false) style =
10802 pr "%s -> " handle;
10803 let string = if hs then "String" else "CString" in
10804 let int = if hs then "Int" else "CInt" in
10805 let bool = if hs then "Bool" else "CInt" in
10806 let int64 = if hs then "Integer" else "Int64" in
10810 | Pathname _ | Device _ | Dev_or_Path _ | String _ -> pr "%s" string
10812 if hs then pr "String"
10813 else pr "CString -> CInt"
10814 | OptString _ -> if hs then pr "Maybe String" else pr "CString"
10815 | StringList _ | DeviceList _ -> if hs then pr "[String]" else pr "Ptr CString"
10816 | Bool _ -> pr "%s" bool
10817 | Int _ -> pr "%s" int
10818 | Int64 _ -> pr "%s" int
10819 | FileIn _ -> pr "%s" string
10820 | FileOut _ -> pr "%s" string
10825 (match fst style with
10826 | RErr -> if not hs then pr "CInt"
10827 | RInt _ -> pr "%s" int
10828 | RInt64 _ -> pr "%s" int64
10829 | RBool _ -> pr "%s" bool
10830 | RConstString _ -> pr "%s" string
10831 | RConstOptString _ -> pr "Maybe %s" string
10832 | RString _ -> pr "%s" string
10833 | RStringList _ -> pr "[%s]" string
10834 | RStruct (_, typ) ->
10835 let name = java_name_of_struct typ in
10837 | RStructList (_, typ) ->
10838 let name = java_name_of_struct typ in
10840 | RHashtable _ -> pr "Hashtable"
10841 | RBufferOut _ -> pr "%s" string
10845 and generate_csharp () =
10846 generate_header CPlusPlusStyle LGPLv2plus;
10848 (* XXX Make this configurable by the C# assembly users. *)
10849 let library = "libguestfs.so.0" in
10852 // These C# bindings are highly experimental at present.
10854 // Firstly they only work on Linux (ie. Mono). In order to get them
10855 // to work on Windows (ie. .Net) you would need to port the library
10856 // itself to Windows first.
10858 // The second issue is that some calls are known to be incorrect and
10859 // can cause Mono to segfault. Particularly: calls which pass or
10860 // return string[], or return any structure value. This is because
10861 // we haven't worked out the correct way to do this from C#.
10863 // The third issue is that when compiling you get a lot of warnings.
10864 // We are not sure whether the warnings are important or not.
10866 // Fourthly we do not routinely build or test these bindings as part
10867 // of the make && make check cycle, which means that regressions might
10870 // Suggestions and patches are welcome.
10874 // gmcs Libguestfs.cs
10875 // mono Libguestfs.exe
10877 // (You'll probably want to add a Test class / static main function
10878 // otherwise this won't do anything useful).
10882 using System.Runtime.InteropServices;
10883 using System.Runtime.Serialization;
10884 using System.Collections;
10888 class Error : System.ApplicationException
10890 public Error (string message) : base (message) {}
10891 protected Error (SerializationInfo info, StreamingContext context) {}
10898 [DllImport (\"%s\")]
10899 static extern IntPtr guestfs_create ();
10903 _handle = guestfs_create ();
10904 if (_handle == IntPtr.Zero)
10905 throw new Error (\"could not create guestfs handle\");
10908 [DllImport (\"%s\")]
10909 static extern void guestfs_close (IntPtr h);
10913 guestfs_close (_handle);
10916 [DllImport (\"%s\")]
10917 static extern string guestfs_last_error (IntPtr h);
10919 " library library library;
10921 (* Generate C# structure bindings. We prefix struct names with
10922 * underscore because C# cannot have conflicting struct names and
10923 * method names (eg. "class stat" and "stat").
10927 pr " [StructLayout (LayoutKind.Sequential)]\n";
10928 pr " public class _%s {\n" typ;
10931 | name, FChar -> pr " char %s;\n" name
10932 | name, FString -> pr " string %s;\n" name
10934 pr " uint %s_len;\n" name;
10935 pr " string %s;\n" name
10937 pr " [MarshalAs (UnmanagedType.ByValTStr, SizeConst=16)]\n";
10938 pr " string %s;\n" name
10939 | name, FUInt32 -> pr " uint %s;\n" name
10940 | name, FInt32 -> pr " int %s;\n" name
10941 | name, (FUInt64|FBytes) -> pr " ulong %s;\n" name
10942 | name, FInt64 -> pr " long %s;\n" name
10943 | name, FOptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
10949 (* Generate C# function bindings. *)
10951 fun (name, style, _, _, _, shortdesc, _) ->
10952 let rec csharp_return_type () =
10953 match fst style with
10955 | RBool n -> "bool"
10957 | RInt64 n -> "long"
10959 | RConstOptString n
10961 | RBufferOut n -> "string"
10962 | RStruct (_,n) -> "_" ^ n
10963 | RHashtable n -> "Hashtable"
10964 | RStringList n -> "string[]"
10965 | RStructList (_,n) -> sprintf "_%s[]" n
10967 and c_return_type () =
10968 match fst style with
10972 | RInt64 _ -> "long"
10974 | RConstOptString _
10976 | RBufferOut _ -> "string"
10977 | RStruct (_,n) -> "_" ^ n
10979 | RStringList _ -> "string[]"
10980 | RStructList (_,n) -> sprintf "_%s[]" n
10982 and c_error_comparison () =
10983 match fst style with
10987 | RInt64 _ -> "== -1"
10989 | RConstOptString _
10995 | RStructList (_,_) -> "== null"
10997 and generate_extern_prototype () =
10998 pr " static extern %s guestfs_%s (IntPtr h"
10999 (c_return_type ()) name;
11002 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
11003 | FileIn n | FileOut n
11005 pr ", [In] string %s" n
11006 | StringList n | DeviceList n ->
11007 pr ", [In] string[] %s" n
11017 and generate_public_prototype () =
11018 pr " public %s %s (" (csharp_return_type ()) name;
11019 let comma = ref false in
11021 if !comma then pr ", ";
11026 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
11027 | FileIn n | FileOut n
11029 next (); pr "string %s" n
11030 | StringList n | DeviceList n ->
11031 next (); pr "string[] %s" n
11033 next (); pr "bool %s" n
11035 next (); pr "int %s" n
11037 next (); pr "long %s" n
11041 and generate_call () =
11042 pr "guestfs_%s (_handle" name;
11043 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) (snd style);
11047 pr " [DllImport (\"%s\")]\n" library;
11048 generate_extern_prototype ();
11050 pr " /// <summary>\n";
11051 pr " /// %s\n" shortdesc;
11052 pr " /// </summary>\n";
11053 generate_public_prototype ();
11055 pr " %s r;\n" (c_return_type ());
11058 pr " if (r %s)\n" (c_error_comparison ());
11059 pr " throw new Error (guestfs_last_error (_handle));\n";
11060 (match fst style with
11063 pr " return r != 0 ? true : false;\n"
11065 pr " Hashtable rr = new Hashtable ();\n";
11066 pr " for (int i = 0; i < r.Length; i += 2)\n";
11067 pr " rr.Add (r[i], r[i+1]);\n";
11069 | RInt _ | RInt64 _ | RConstString _ | RConstOptString _
11070 | RString _ | RBufferOut _ | RStruct _ | RStringList _
11076 ) all_functions_sorted;
11082 and generate_bindtests () =
11083 generate_header CStyle LGPLv2plus;
11087 #include <stdlib.h>
11088 #include <inttypes.h>
11089 #include <string.h>
11091 #include \"guestfs.h\"
11092 #include \"guestfs-internal.h\"
11093 #include \"guestfs-internal-actions.h\"
11094 #include \"guestfs_protocol.h\"
11096 #define error guestfs_error
11097 #define safe_calloc guestfs_safe_calloc
11098 #define safe_malloc guestfs_safe_malloc
11101 print_strings (char *const *argv)
11106 for (argc = 0; argv[argc] != NULL; ++argc) {
11107 if (argc > 0) printf (\", \");
11108 printf (\"\\\"%%s\\\"\", argv[argc]);
11113 /* The test0 function prints its parameters to stdout. */
11117 match test_functions with
11118 | [] -> assert false
11119 | test0 :: tests -> test0, tests in
11122 let (name, style, _, _, _, _, _) = test0 in
11123 generate_prototype ~extern:false ~semicolon:false ~newline:true
11124 ~handle:"g" ~prefix:"guestfs__" name style;
11129 | Device n | Dev_or_Path n
11132 | FileOut n -> pr " printf (\"%%s\\n\", %s);\n" n
11136 pr " for (i = 0; i < %s_size; ++i)\n" n;
11137 pr " printf (\"<%%02x>\", %s[i]);\n" n;
11138 pr " printf (\"\\n\");\n";
11140 | OptString n -> pr " printf (\"%%s\\n\", %s ? %s : \"null\");\n" n n
11141 | StringList n | DeviceList n -> pr " print_strings (%s);\n" n
11142 | Bool n -> pr " printf (\"%%s\\n\", %s ? \"true\" : \"false\");\n" n
11143 | Int n -> pr " printf (\"%%d\\n\", %s);\n" n
11144 | Int64 n -> pr " printf (\"%%\" PRIi64 \"\\n\", %s);\n" n
11146 pr " /* Java changes stdout line buffering so we need this: */\n";
11147 pr " fflush (stdout);\n";
11153 fun (name, style, _, _, _, _, _) ->
11154 if String.sub name (String.length name - 3) 3 <> "err" then (
11155 pr "/* Test normal return. */\n";
11156 generate_prototype ~extern:false ~semicolon:false ~newline:true
11157 ~handle:"g" ~prefix:"guestfs__" name style;
11159 (match fst style with
11164 pr " sscanf (val, \"%%d\", &r);\n";
11167 pr " int64_t r;\n";
11168 pr " sscanf (val, \"%%\" SCNi64, &r);\n";
11171 pr " return STREQ (val, \"true\");\n"
11173 | RConstOptString _ ->
11174 (* Can't return the input string here. Return a static
11175 * string so we ensure we get a segfault if the caller
11176 * tries to free it.
11178 pr " return \"static string\";\n"
11180 pr " return strdup (val);\n"
11182 pr " char **strs;\n";
11184 pr " sscanf (val, \"%%d\", &n);\n";
11185 pr " strs = safe_malloc (g, (n+1) * sizeof (char *));\n";
11186 pr " for (i = 0; i < n; ++i) {\n";
11187 pr " strs[i] = safe_malloc (g, 16);\n";
11188 pr " snprintf (strs[i], 16, \"%%d\", i);\n";
11190 pr " strs[n] = NULL;\n";
11191 pr " return strs;\n"
11192 | RStruct (_, typ) ->
11193 pr " struct guestfs_%s *r;\n" typ;
11194 pr " r = safe_calloc (g, sizeof *r, 1);\n";
11196 | RStructList (_, typ) ->
11197 pr " struct guestfs_%s_list *r;\n" typ;
11198 pr " r = safe_calloc (g, sizeof *r, 1);\n";
11199 pr " sscanf (val, \"%%d\", &r->len);\n";
11200 pr " r->val = safe_calloc (g, r->len, sizeof *r->val);\n";
11203 pr " char **strs;\n";
11205 pr " sscanf (val, \"%%d\", &n);\n";
11206 pr " strs = safe_malloc (g, (n*2+1) * sizeof (*strs));\n";
11207 pr " for (i = 0; i < n; ++i) {\n";
11208 pr " strs[i*2] = safe_malloc (g, 16);\n";
11209 pr " strs[i*2+1] = safe_malloc (g, 16);\n";
11210 pr " snprintf (strs[i*2], 16, \"%%d\", i);\n";
11211 pr " snprintf (strs[i*2+1], 16, \"%%d\", i);\n";
11213 pr " strs[n*2] = NULL;\n";
11214 pr " return strs;\n"
11216 pr " return strdup (val);\n"
11221 pr "/* Test error return. */\n";
11222 generate_prototype ~extern:false ~semicolon:false ~newline:true
11223 ~handle:"g" ~prefix:"guestfs__" name style;
11225 pr " error (g, \"error\");\n";
11226 (match fst style with
11227 | RErr | RInt _ | RInt64 _ | RBool _ ->
11229 | RConstString _ | RConstOptString _
11230 | RString _ | RStringList _ | RStruct _
11234 pr " return NULL;\n"
11241 and generate_ocaml_bindtests () =
11242 generate_header OCamlStyle GPLv2plus;
11246 let g = Guestfs.create () in
11250 String.concat " " (
11253 | CallString s -> "\"" ^ s ^ "\""
11254 | CallOptString None -> "None"
11255 | CallOptString (Some s) -> sprintf "(Some \"%s\")" s
11256 | CallStringList xs ->
11257 "[|" ^ String.concat ";" (List.map (sprintf "\"%s\"") xs) ^ "|]"
11258 | CallInt i when i >= 0 -> string_of_int i
11259 | CallInt i (* when i < 0 *) -> "(" ^ string_of_int i ^ ")"
11260 | CallInt64 i when i >= 0L -> Int64.to_string i ^ "L"
11261 | CallInt64 i (* when i < 0L *) -> "(" ^ Int64.to_string i ^ "L)"
11262 | CallBool b -> string_of_bool b
11263 | CallBuffer s -> sprintf "%S" s
11268 generate_lang_bindtests (
11269 fun f args -> pr " Guestfs.%s g %s;\n" f (mkargs args)
11272 pr "print_endline \"EOF\"\n"
11274 and generate_perl_bindtests () =
11275 pr "#!/usr/bin/perl -w\n";
11276 generate_header HashStyle GPLv2plus;
11283 my $g = Sys::Guestfs->new ();
11287 String.concat ", " (
11290 | CallString s -> "\"" ^ s ^ "\""
11291 | CallOptString None -> "undef"
11292 | CallOptString (Some s) -> sprintf "\"%s\"" s
11293 | CallStringList xs ->
11294 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
11295 | CallInt i -> string_of_int i
11296 | CallInt64 i -> Int64.to_string i
11297 | CallBool b -> if b then "1" else "0"
11298 | CallBuffer s -> "\"" ^ c_quote s ^ "\""
11303 generate_lang_bindtests (
11304 fun f args -> pr "$g->%s (%s);\n" f (mkargs args)
11307 pr "print \"EOF\\n\"\n"
11309 and generate_python_bindtests () =
11310 generate_header HashStyle GPLv2plus;
11315 g = guestfs.GuestFS ()
11319 String.concat ", " (
11322 | CallString s -> "\"" ^ s ^ "\""
11323 | CallOptString None -> "None"
11324 | CallOptString (Some s) -> sprintf "\"%s\"" s
11325 | CallStringList xs ->
11326 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
11327 | CallInt i -> string_of_int i
11328 | CallInt64 i -> Int64.to_string i
11329 | CallBool b -> if b then "1" else "0"
11330 | CallBuffer s -> "\"" ^ c_quote s ^ "\""
11335 generate_lang_bindtests (
11336 fun f args -> pr "g.%s (%s)\n" f (mkargs args)
11339 pr "print \"EOF\"\n"
11341 and generate_ruby_bindtests () =
11342 generate_header HashStyle GPLv2plus;
11347 g = Guestfs::create()
11351 String.concat ", " (
11354 | CallString s -> "\"" ^ s ^ "\""
11355 | CallOptString None -> "nil"
11356 | CallOptString (Some s) -> sprintf "\"%s\"" s
11357 | CallStringList xs ->
11358 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
11359 | CallInt i -> string_of_int i
11360 | CallInt64 i -> Int64.to_string i
11361 | CallBool b -> string_of_bool b
11362 | CallBuffer s -> "\"" ^ c_quote s ^ "\""
11367 generate_lang_bindtests (
11368 fun f args -> pr "g.%s(%s)\n" f (mkargs args)
11371 pr "print \"EOF\\n\"\n"
11373 and generate_java_bindtests () =
11374 generate_header CStyle GPLv2plus;
11377 import com.redhat.et.libguestfs.*;
11379 public class Bindtests {
11380 public static void main (String[] argv)
11383 GuestFS g = new GuestFS ();
11387 String.concat ", " (
11390 | CallString s -> "\"" ^ s ^ "\""
11391 | CallOptString None -> "null"
11392 | CallOptString (Some s) -> sprintf "\"%s\"" s
11393 | CallStringList xs ->
11395 String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "}"
11396 | CallInt i -> string_of_int i
11397 | CallInt64 i -> Int64.to_string i
11398 | CallBool b -> string_of_bool b
11400 "new byte[] { " ^ String.concat "," (
11401 map_chars (fun c -> string_of_int (Char.code c)) s
11407 generate_lang_bindtests (
11408 fun f args -> pr " g.%s (%s);\n" f (mkargs args)
11412 System.out.println (\"EOF\");
11414 catch (Exception exn) {
11415 System.err.println (exn);
11422 and generate_haskell_bindtests () =
11423 generate_header HaskellStyle GPLv2plus;
11426 module Bindtests where
11427 import qualified Guestfs
11430 g <- Guestfs.create
11434 String.concat " " (
11437 | CallString s -> "\"" ^ s ^ "\""
11438 | CallOptString None -> "Nothing"
11439 | CallOptString (Some s) -> sprintf "(Just \"%s\")" s
11440 | CallStringList xs ->
11441 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
11442 | CallInt i when i < 0 -> "(" ^ string_of_int i ^ ")"
11443 | CallInt i -> string_of_int i
11444 | CallInt64 i when i < 0L -> "(" ^ Int64.to_string i ^ ")"
11445 | CallInt64 i -> Int64.to_string i
11446 | CallBool true -> "True"
11447 | CallBool false -> "False"
11448 | CallBuffer s -> "\"" ^ c_quote s ^ "\""
11453 generate_lang_bindtests (
11454 fun f args -> pr " Guestfs.%s g %s\n" f (mkargs args)
11457 pr " putStrLn \"EOF\"\n"
11459 (* Language-independent bindings tests - we do it this way to
11460 * ensure there is parity in testing bindings across all languages.
11462 and generate_lang_bindtests call =
11463 call "test0" [CallString "abc"; CallOptString (Some "def");
11464 CallStringList []; CallBool false;
11465 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11466 CallBuffer "abc\000abc"];
11467 call "test0" [CallString "abc"; CallOptString None;
11468 CallStringList []; CallBool false;
11469 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11470 CallBuffer "abc\000abc"];
11471 call "test0" [CallString ""; CallOptString (Some "def");
11472 CallStringList []; CallBool false;
11473 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11474 CallBuffer "abc\000abc"];
11475 call "test0" [CallString ""; CallOptString (Some "");
11476 CallStringList []; CallBool false;
11477 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11478 CallBuffer "abc\000abc"];
11479 call "test0" [CallString "abc"; CallOptString (Some "def");
11480 CallStringList ["1"]; CallBool false;
11481 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11482 CallBuffer "abc\000abc"];
11483 call "test0" [CallString "abc"; CallOptString (Some "def");
11484 CallStringList ["1"; "2"]; CallBool false;
11485 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11486 CallBuffer "abc\000abc"];
11487 call "test0" [CallString "abc"; CallOptString (Some "def");
11488 CallStringList ["1"]; CallBool true;
11489 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11490 CallBuffer "abc\000abc"];
11491 call "test0" [CallString "abc"; CallOptString (Some "def");
11492 CallStringList ["1"]; CallBool false;
11493 CallInt (-1); CallInt64 (-1L); CallString "123"; CallString "456";
11494 CallBuffer "abc\000abc"];
11495 call "test0" [CallString "abc"; CallOptString (Some "def");
11496 CallStringList ["1"]; CallBool false;
11497 CallInt (-2); CallInt64 (-2L); CallString "123"; CallString "456";
11498 CallBuffer "abc\000abc"];
11499 call "test0" [CallString "abc"; CallOptString (Some "def");
11500 CallStringList ["1"]; CallBool false;
11501 CallInt 1; CallInt64 1L; CallString "123"; CallString "456";
11502 CallBuffer "abc\000abc"];
11503 call "test0" [CallString "abc"; CallOptString (Some "def");
11504 CallStringList ["1"]; CallBool false;
11505 CallInt 2; CallInt64 2L; CallString "123"; CallString "456";
11506 CallBuffer "abc\000abc"];
11507 call "test0" [CallString "abc"; CallOptString (Some "def");
11508 CallStringList ["1"]; CallBool false;
11509 CallInt 4095; CallInt64 4095L; CallString "123"; CallString "456";
11510 CallBuffer "abc\000abc"];
11511 call "test0" [CallString "abc"; CallOptString (Some "def");
11512 CallStringList ["1"]; CallBool false;
11513 CallInt 0; CallInt64 0L; CallString ""; CallString "";
11514 CallBuffer "abc\000abc"]
11516 (* XXX Add here tests of the return and error functions. *)
11518 (* Code to generator bindings for virt-inspector. Currently only
11519 * implemented for OCaml code (for virt-p2v 2.0).
11521 let rng_input = "inspector/virt-inspector.rng"
11523 (* Read the input file and parse it into internal structures. This is
11524 * by no means a complete RELAX NG parser, but is just enough to be
11525 * able to parse the specific input file.
11528 | Element of string * rng list (* <element name=name/> *)
11529 | Attribute of string * rng list (* <attribute name=name/> *)
11530 | Interleave of rng list (* <interleave/> *)
11531 | ZeroOrMore of rng (* <zeroOrMore/> *)
11532 | OneOrMore of rng (* <oneOrMore/> *)
11533 | Optional of rng (* <optional/> *)
11534 | Choice of string list (* <choice><value/>*</choice> *)
11535 | Value of string (* <value>str</value> *)
11536 | Text (* <text/> *)
11538 let rec string_of_rng = function
11539 | Element (name, xs) ->
11540 "Element (\"" ^ name ^ "\", (" ^ string_of_rng_list xs ^ "))"
11541 | Attribute (name, xs) ->
11542 "Attribute (\"" ^ name ^ "\", (" ^ string_of_rng_list xs ^ "))"
11543 | Interleave xs -> "Interleave (" ^ string_of_rng_list xs ^ ")"
11544 | ZeroOrMore rng -> "ZeroOrMore (" ^ string_of_rng rng ^ ")"
11545 | OneOrMore rng -> "OneOrMore (" ^ string_of_rng rng ^ ")"
11546 | Optional rng -> "Optional (" ^ string_of_rng rng ^ ")"
11547 | Choice values -> "Choice [" ^ String.concat ", " values ^ "]"
11548 | Value value -> "Value \"" ^ value ^ "\""
11551 and string_of_rng_list xs =
11552 String.concat ", " (List.map string_of_rng xs)
11554 let rec parse_rng ?defines context = function
11556 | Xml.Element ("element", ["name", name], children) :: rest ->
11557 Element (name, parse_rng ?defines context children)
11558 :: parse_rng ?defines context rest
11559 | Xml.Element ("attribute", ["name", name], children) :: rest ->
11560 Attribute (name, parse_rng ?defines context children)
11561 :: parse_rng ?defines context rest
11562 | Xml.Element ("interleave", [], children) :: rest ->
11563 Interleave (parse_rng ?defines context children)
11564 :: parse_rng ?defines context rest
11565 | Xml.Element ("zeroOrMore", [], [child]) :: rest ->
11566 let rng = parse_rng ?defines context [child] in
11568 | [child] -> ZeroOrMore child :: parse_rng ?defines context rest
11570 failwithf "%s: <zeroOrMore> contains more than one child element"
11573 | Xml.Element ("oneOrMore", [], [child]) :: rest ->
11574 let rng = parse_rng ?defines context [child] in
11576 | [child] -> OneOrMore child :: parse_rng ?defines context rest
11578 failwithf "%s: <oneOrMore> contains more than one child element"
11581 | Xml.Element ("optional", [], [child]) :: rest ->
11582 let rng = parse_rng ?defines context [child] in
11584 | [child] -> Optional child :: parse_rng ?defines context rest
11586 failwithf "%s: <optional> contains more than one child element"
11589 | Xml.Element ("choice", [], children) :: rest ->
11590 let values = List.map (
11591 function Xml.Element ("value", [], [Xml.PCData value]) -> value
11593 failwithf "%s: can't handle anything except <value> in <choice>"
11597 :: parse_rng ?defines context rest
11598 | Xml.Element ("value", [], [Xml.PCData value]) :: rest ->
11599 Value value :: parse_rng ?defines context rest
11600 | Xml.Element ("text", [], []) :: rest ->
11601 Text :: parse_rng ?defines context rest
11602 | Xml.Element ("ref", ["name", name], []) :: rest ->
11603 (* Look up the reference. Because of limitations in this parser,
11604 * we can't handle arbitrarily nested <ref> yet. You can only
11605 * use <ref> from inside <start>.
11607 (match defines with
11609 failwithf "%s: contains <ref>, but no refs are defined yet" context
11611 let rng = StringMap.find name map in
11612 rng @ parse_rng ?defines context rest
11615 failwithf "%s: can't handle '%s' in schema" context (Xml.to_string x)
11618 let xml = Xml.parse_file rng_input in
11620 | Xml.Element ("grammar", _,
11621 Xml.Element ("start", _, gram) :: defines) ->
11622 (* The <define/> elements are referenced in the <start> section,
11623 * so build a map of those first.
11625 let defines = List.fold_left (
11627 function Xml.Element ("define", ["name", name], defn) ->
11628 StringMap.add name defn map
11630 failwithf "%s: expected <define name=name/>" rng_input
11631 ) StringMap.empty defines in
11632 let defines = StringMap.mapi parse_rng defines in
11634 (* Parse the <start> clause, passing the defines. *)
11635 parse_rng ~defines "<start>" gram
11637 failwithf "%s: input is not <grammar><start/><define>*</grammar>"
11640 let name_of_field = function
11641 | Element (name, _) | Attribute (name, _)
11642 | ZeroOrMore (Element (name, _))
11643 | OneOrMore (Element (name, _))
11644 | Optional (Element (name, _)) -> name
11645 | Optional (Attribute (name, _)) -> name
11646 | Text -> (* an unnamed field in an element *)
11649 failwithf "name_of_field failed at: %s" (string_of_rng rng)
11651 (* At the moment this function only generates OCaml types. However we
11652 * should parameterize it later so it can generate types/structs in a
11653 * variety of languages.
11655 let generate_types xs =
11656 (* A simple type is one that can be printed out directly, eg.
11657 * "string option". A complex type is one which has a name and has
11658 * to be defined via another toplevel definition, eg. a struct.
11660 * generate_type generates code for either simple or complex types.
11661 * In the simple case, it returns the string ("string option"). In
11662 * the complex case, it returns the name ("mountpoint"). In the
11663 * complex case it has to print out the definition before returning,
11664 * so it should only be called when we are at the beginning of a
11665 * new line (BOL context).
11667 let rec generate_type = function
11668 | Text -> (* string *)
11670 | Choice values -> (* [`val1|`val2|...] *)
11671 "[" ^ String.concat "|" (List.map ((^)"`") values) ^ "]", true
11672 | ZeroOrMore rng -> (* <rng> list *)
11673 let t, is_simple = generate_type rng in
11674 t ^ " list (* 0 or more *)", is_simple
11675 | OneOrMore rng -> (* <rng> list *)
11676 let t, is_simple = generate_type rng in
11677 t ^ " list (* 1 or more *)", is_simple
11678 (* virt-inspector hack: bool *)
11679 | Optional (Attribute (name, [Value "1"])) ->
11681 | Optional rng -> (* <rng> list *)
11682 let t, is_simple = generate_type rng in
11683 t ^ " option", is_simple
11684 (* type name = { fields ... } *)
11685 | Element (name, fields) when is_attrs_interleave fields ->
11686 generate_type_struct name (get_attrs_interleave fields)
11687 | Element (name, [field]) (* type name = field *)
11688 | Attribute (name, [field]) ->
11689 let t, is_simple = generate_type field in
11690 if is_simple then (t, true)
11692 pr "type %s = %s\n" name t;
11695 | Element (name, fields) -> (* type name = { fields ... } *)
11696 generate_type_struct name fields
11698 failwithf "generate_type failed at: %s" (string_of_rng rng)
11700 and is_attrs_interleave = function
11701 | [Interleave _] -> true
11702 | Attribute _ :: fields -> is_attrs_interleave fields
11703 | Optional (Attribute _) :: fields -> is_attrs_interleave fields
11706 and get_attrs_interleave = function
11707 | [Interleave fields] -> fields
11708 | ((Attribute _) as field) :: fields
11709 | ((Optional (Attribute _)) as field) :: fields ->
11710 field :: get_attrs_interleave fields
11711 | _ -> assert false
11713 and generate_types xs =
11714 List.iter (fun x -> ignore (generate_type x)) xs
11716 and generate_type_struct name fields =
11717 (* Calculate the types of the fields first. We have to do this
11718 * before printing anything so we are still in BOL context.
11720 let types = List.map fst (List.map generate_type fields) in
11722 (* Special case of a struct containing just a string and another
11723 * field. Turn it into an assoc list.
11726 | ["string"; other] ->
11727 let fname1, fname2 =
11729 | [f1; f2] -> name_of_field f1, name_of_field f2
11730 | _ -> assert false in
11731 pr "type %s = string * %s (* %s -> %s *)\n" name other fname1 fname2;
11735 pr "type %s = {\n" name;
11737 fun (field, ftype) ->
11738 let fname = name_of_field field in
11739 pr " %s_%s : %s;\n" name fname ftype
11740 ) (List.combine fields types);
11742 (* Return the name of this type, and
11743 * false because it's not a simple type.
11750 let generate_parsers xs =
11751 (* As for generate_type above, generate_parser makes a parser for
11752 * some type, and returns the name of the parser it has generated.
11753 * Because it (may) need to print something, it should always be
11754 * called in BOL context.
11756 let rec generate_parser = function
11757 | Text -> (* string *)
11758 "string_child_or_empty"
11759 | Choice values -> (* [`val1|`val2|...] *)
11760 sprintf "(fun x -> match Xml.pcdata (first_child x) with %s | str -> failwith (\"unexpected field value: \" ^ str))"
11762 (List.map (fun v -> sprintf "%S -> `%s" v v) values))
11763 | ZeroOrMore rng -> (* <rng> list *)
11764 let pa = generate_parser rng in
11765 sprintf "(fun x -> List.map %s (Xml.children x))" pa
11766 | OneOrMore rng -> (* <rng> list *)
11767 let pa = generate_parser rng in
11768 sprintf "(fun x -> List.map %s (Xml.children x))" pa
11769 (* virt-inspector hack: bool *)
11770 | Optional (Attribute (name, [Value "1"])) ->
11771 sprintf "(fun x -> try ignore (Xml.attrib x %S); true with Xml.No_attribute _ -> false)" name
11772 | Optional rng -> (* <rng> list *)
11773 let pa = generate_parser rng in
11774 sprintf "(function None -> None | Some x -> Some (%s x))" pa
11775 (* type name = { fields ... } *)
11776 | Element (name, fields) when is_attrs_interleave fields ->
11777 generate_parser_struct name (get_attrs_interleave fields)
11778 | Element (name, [field]) -> (* type name = field *)
11779 let pa = generate_parser field in
11780 let parser_name = sprintf "parse_%s_%d" name (unique ()) in
11781 pr "let %s =\n" parser_name;
11783 pr "let parse_%s = %s\n" name parser_name;
11785 | Attribute (name, [field]) ->
11786 let pa = generate_parser field in
11787 let parser_name = sprintf "parse_%s_%d" name (unique ()) in
11788 pr "let %s =\n" parser_name;
11790 pr "let parse_%s = %s\n" name parser_name;
11792 | Element (name, fields) -> (* type name = { fields ... } *)
11793 generate_parser_struct name ([], fields)
11795 failwithf "generate_parser failed at: %s" (string_of_rng rng)
11797 and is_attrs_interleave = function
11798 | [Interleave _] -> true
11799 | Attribute _ :: fields -> is_attrs_interleave fields
11800 | Optional (Attribute _) :: fields -> is_attrs_interleave fields
11803 and get_attrs_interleave = function
11804 | [Interleave fields] -> [], fields
11805 | ((Attribute _) as field) :: fields
11806 | ((Optional (Attribute _)) as field) :: fields ->
11807 let attrs, interleaves = get_attrs_interleave fields in
11808 (field :: attrs), interleaves
11809 | _ -> assert false
11811 and generate_parsers xs =
11812 List.iter (fun x -> ignore (generate_parser x)) xs
11814 and generate_parser_struct name (attrs, interleaves) =
11815 (* Generate parsers for the fields first. We have to do this
11816 * before printing anything so we are still in BOL context.
11818 let fields = attrs @ interleaves in
11819 let pas = List.map generate_parser fields in
11821 (* Generate an intermediate tuple from all the fields first.
11822 * If the type is just a string + another field, then we will
11823 * return this directly, otherwise it is turned into a record.
11825 * RELAX NG note: This code treats <interleave> and plain lists of
11826 * fields the same. In other words, it doesn't bother enforcing
11827 * any ordering of fields in the XML.
11829 pr "let parse_%s x =\n" name;
11830 pr " let t = (\n ";
11831 let comma = ref false in
11834 if !comma then pr ",\n ";
11837 | Optional (Attribute (fname, [field])), pa ->
11839 | Optional (Element (fname, [field])), pa ->
11840 pr "%s (optional_child %S x)" pa fname
11841 | Attribute (fname, [Text]), _ ->
11842 pr "attribute %S x" fname
11843 | (ZeroOrMore _ | OneOrMore _), pa ->
11848 let fname = name_of_field field in
11849 pr "%s (child %S x)" pa fname
11850 ) (List.combine fields pas);
11854 | [Element (_, [Text]) | Attribute (_, [Text]); _] ->
11858 pr " (Obj.magic t : %s)\n" name
11862 | (Optional (Attribute (fname, [field])), pa) ->
11863 pr " %s_%s =\n" name fname;
11865 | (Optional (Element (fname, [field])), pa) ->
11866 pr " %s_%s =\n" name fname;
11867 pr " (let x = optional_child %S x in\n" fname;
11870 let fname = name_of_field field in
11871 pr " %s_%s =\n" name fname;
11872 pr " (let x = child %S x in\n" fname;
11874 ) (List.combine fields pas);
11878 sprintf "parse_%s" name
11881 generate_parsers xs
11883 (* Generate ocaml/guestfs_inspector.mli. *)
11884 let generate_ocaml_inspector_mli () =
11885 generate_header ~extra_inputs:[rng_input] OCamlStyle LGPLv2plus;
11888 (** This is an OCaml language binding to the external [virt-inspector]
11891 For more information, please read the man page [virt-inspector(1)].
11896 generate_types grammar;
11897 pr "(** The nested information returned from the {!inspect} function. *)\n";
11901 val inspect : ?connect:string -> ?xml:string -> string list -> operatingsystems
11902 (** To inspect a libvirt domain called [name], pass a singleton
11903 list: [inspect [name]]. When using libvirt only, you may
11904 optionally pass a libvirt URI using [inspect ~connect:uri ...].
11906 To inspect a disk image or images, pass a list of the filenames
11907 of the disk images: [inspect filenames]
11909 This function inspects the given guest or disk images and
11910 returns a list of operating system(s) found and a large amount
11911 of information about them. In the vast majority of cases,
11912 a virtual machine only contains a single operating system.
11914 If the optional [~xml] parameter is given, then this function
11915 skips running the external virt-inspector program and just
11916 parses the given XML directly (which is expected to be XML
11917 produced from a previous run of virt-inspector). The list of
11918 names and connect URI are ignored in this case.
11920 This function can throw a wide variety of exceptions, for example
11921 if the external virt-inspector program cannot be found, or if
11922 it doesn't generate valid XML.
11926 (* Generate ocaml/guestfs_inspector.ml. *)
11927 let generate_ocaml_inspector_ml () =
11928 generate_header ~extra_inputs:[rng_input] OCamlStyle LGPLv2plus;
11933 generate_types grammar;
11937 (* Misc functions which are used by the parser code below. *)
11938 let first_child = function
11939 | Xml.Element (_, _, c::_) -> c
11940 | Xml.Element (name, _, []) ->
11941 failwith (\"expected <\" ^ name ^ \"/> to have a child node\")
11942 | Xml.PCData str ->
11943 failwith (\"expected XML tag, but read PCDATA '\" ^ str ^ \"' instead\")
11945 let string_child_or_empty = function
11946 | Xml.Element (_, _, [Xml.PCData s]) -> s
11947 | Xml.Element (_, _, []) -> \"\"
11948 | Xml.Element (x, _, _) ->
11949 failwith (\"expected XML tag with a single PCDATA child, but got \" ^
11951 | Xml.PCData str ->
11952 failwith (\"expected XML tag, but read PCDATA '\" ^ str ^ \"' instead\")
11954 let optional_child name xml =
11955 let children = Xml.children xml in
11957 Some (List.find (function
11958 | Xml.Element (n, _, _) when n = name -> true
11959 | _ -> false) children)
11963 let child name xml =
11964 match optional_child name xml with
11967 failwith (\"mandatory field <\" ^ name ^ \"/> missing in XML output\")
11969 let attribute name xml =
11970 try Xml.attrib xml name
11971 with Xml.No_attribute _ ->
11972 failwith (\"mandatory attribute \" ^ name ^ \" missing in XML output\")
11976 generate_parsers grammar;
11980 (* Run external virt-inspector, then use parser to parse the XML. *)
11981 let inspect ?connect ?xml names =
11985 if names = [] then invalid_arg \"inspect: no names given\";
11986 let cmd = [ \"virt-inspector\"; \"--xml\" ] @
11987 (match connect with None -> [] | Some uri -> [ \"--connect\"; uri ]) @
11989 let cmd = List.map Filename.quote cmd in
11990 let cmd = String.concat \" \" cmd in
11991 let chan = open_process_in cmd in
11992 let xml = Xml.parse_in chan in
11993 (match close_process_in chan with
11995 | WEXITED _ -> failwith \"external virt-inspector command failed\"
11996 | WSIGNALED i | WSTOPPED i ->
11997 failwith (\"external virt-inspector command died or stopped on sig \" ^
12002 Xml.parse_string doc in
12003 parse_operatingsystems xml
12006 and generate_max_proc_nr () =
12007 pr "%d\n" max_proc_nr
12009 let output_to filename k =
12010 let filename_new = filename ^ ".new" in
12011 chan := open_out filename_new;
12014 chan := Pervasives.stdout;
12016 (* Is the new file different from the current file? *)
12017 if Sys.file_exists filename && files_equal filename filename_new then
12018 unlink filename_new (* same, so skip it *)
12020 (* different, overwrite old one *)
12021 (try chmod filename 0o644 with Unix_error _ -> ());
12022 rename filename_new filename;
12023 chmod filename 0o444;
12024 printf "written %s\n%!" filename;
12027 let perror msg = function
12028 | Unix_error (err, _, _) ->
12029 eprintf "%s: %s\n" msg (error_message err)
12031 eprintf "%s: %s\n" msg (Printexc.to_string exn)
12033 (* Main program. *)
12036 try openfile "HACKING" [O_RDWR] 0
12038 | Unix_error (ENOENT, _, _) ->
12040 You are probably running this from the wrong directory.
12041 Run it from the top source directory using the command
12046 perror "open: HACKING" exn;
12049 (* Acquire a lock so parallel builds won't try to run the generator
12050 * twice at the same time. Subsequent builds will wait for the first
12051 * one to finish. Note the lock is released implicitly when the
12054 (try lockf lock_fd F_LOCK 1
12056 perror "lock: HACKING" exn;
12059 check_functions ();
12061 output_to "src/guestfs_protocol.x" generate_xdr;
12062 output_to "src/guestfs-structs.h" generate_structs_h;
12063 output_to "src/guestfs-actions.h" generate_actions_h;
12064 output_to "src/guestfs-internal-actions.h" generate_internal_actions_h;
12065 output_to "src/guestfs-actions.c" generate_client_actions;
12066 output_to "src/guestfs-bindtests.c" generate_bindtests;
12067 output_to "src/guestfs-structs.pod" generate_structs_pod;
12068 output_to "src/guestfs-actions.pod" generate_actions_pod;
12069 output_to "src/guestfs-availability.pod" generate_availability_pod;
12070 output_to "src/MAX_PROC_NR" generate_max_proc_nr;
12071 output_to "src/libguestfs.syms" generate_linker_script;
12072 output_to "daemon/actions.h" generate_daemon_actions_h;
12073 output_to "daemon/stubs.c" generate_daemon_actions;
12074 output_to "daemon/names.c" generate_daemon_names;
12075 output_to "daemon/optgroups.c" generate_daemon_optgroups_c;
12076 output_to "daemon/optgroups.h" generate_daemon_optgroups_h;
12077 output_to "capitests/tests.c" generate_tests;
12078 output_to "fish/cmds.c" generate_fish_cmds;
12079 output_to "fish/completion.c" generate_fish_completion;
12080 output_to "fish/guestfish-actions.pod" generate_fish_actions_pod;
12081 output_to "ocaml/guestfs.mli" generate_ocaml_mli;
12082 output_to "ocaml/guestfs.ml" generate_ocaml_ml;
12083 output_to "ocaml/guestfs_c_actions.c" generate_ocaml_c;
12084 output_to "ocaml/bindtests.ml" generate_ocaml_bindtests;
12085 output_to "ocaml/guestfs_inspector.mli" generate_ocaml_inspector_mli;
12086 output_to "ocaml/guestfs_inspector.ml" generate_ocaml_inspector_ml;
12087 output_to "perl/Guestfs.xs" generate_perl_xs;
12088 output_to "perl/lib/Sys/Guestfs.pm" generate_perl_pm;
12089 output_to "perl/bindtests.pl" generate_perl_bindtests;
12090 output_to "python/guestfs-py.c" generate_python_c;
12091 output_to "python/guestfs.py" generate_python_py;
12092 output_to "python/bindtests.py" generate_python_bindtests;
12093 output_to "ruby/ext/guestfs/_guestfs.c" generate_ruby_c;
12094 output_to "ruby/bindtests.rb" generate_ruby_bindtests;
12095 output_to "java/com/redhat/et/libguestfs/GuestFS.java" generate_java_java;
12099 let cols = cols_of_struct typ in
12100 let filename = sprintf "java/com/redhat/et/libguestfs/%s.java" jtyp in
12101 output_to filename (generate_java_struct jtyp cols);
12104 output_to "java/Makefile.inc" generate_java_makefile_inc;
12105 output_to "java/com_redhat_et_libguestfs_GuestFS.c" generate_java_c;
12106 output_to "java/Bindtests.java" generate_java_bindtests;
12107 output_to "haskell/Guestfs.hs" generate_haskell_hs;
12108 output_to "haskell/Bindtests.hs" generate_haskell_bindtests;
12109 output_to "csharp/Libguestfs.cs" generate_csharp;
12111 (* Always generate this file last, and unconditionally. It's used
12112 * by the Makefile to know when we must re-run the generator.
12114 let chan = open_out "src/stamp-generator" in
12115 fprintf chan "1\n";
12118 printf "generated %d lines of code\n" !lines